/* tslint:disable */
/* eslint-disable */
/**
 * loans/schedule
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

// May contain unused imports in some cases
// @ts-ignore
import type { PeriodicPaymentForSchedulePreview } from './periodic-payment-for-schedule-preview';

/**
 * The schedule settings, holds all schedule properties needed for schedule preview request.
 */
export interface ScheduleSettingsForSchedulePreview {
  /**
   * The PMT is calculated as the loan would have [amortizationPeriod] installments.
   */
  amortizationPeriod?: number;
  /**
   * Specifies the days of the month when the repayment due dates should be. Only available if the Repayment Methodology is FIXED_DAYS_OF_MONTH.
   */
  fixedDaysOfMonth?: Array<number>;
  /**
   * The grace period. Represents the grace period for loan repayment - in number of installments.
   */
  gracePeriod?: number;
  /**
   * A list of periodic payments for the current loan account.
   */
  paymentPlan?: Array<PeriodicPaymentForSchedulePreview>;
  /**
   * The periodic payment amount for the accounts which have balloon payments or Reduce Number of Installments and Optimized Payments
   */
  periodicPayment?: number;
  /**
   * The principal repayment interval. Indicates the interval of repayments that the principal has to be paid.
   */
  principalRepaymentInterval?: number;
  /**
   * The repayment installments. Represents how many installments are required to pay back the loan.
   */
  repaymentInstallments?: number;
  /**
   * The repayment period count. Represents how often the loan is to be repaid: stored based on the type repayment option.
   */
  repaymentPeriodCount?: number;
  /**
   * The frequency of the loan repayment.
   */
  repaymentPeriodUnit?: ScheduleSettingsForSchedulePreviewRepaymentPeriodUnitEnum;
}

export const ScheduleSettingsForSchedulePreviewRepaymentPeriodUnitEnum = {
  Days: 'DAYS',
  Weeks: 'WEEKS',
  Months: 'MONTHS',
  Years: 'YEARS',
} as const;

export type ScheduleSettingsForSchedulePreviewRepaymentPeriodUnitEnum =
  (typeof ScheduleSettingsForSchedulePreviewRepaymentPeriodUnitEnum)[keyof typeof ScheduleSettingsForSchedulePreviewRepaymentPeriodUnitEnum];