@kanmon/sdk 2.0.0

package/src/openapi/models/PaymentOrder.ts

@@ -0,0 +1,198 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { PaymentOrderStatus } from '../models/PaymentOrderStatus';
+import { HttpFile } from '../http/http';
+
+export class PaymentOrder {
+    /**
+    * The UUID representing the payment order in Kanmon.
+    */
+    'id': string;
+    /**
+    * The UUID representing the issued product in Kanmon.
+    */
+    'issuedProductId': string;
+    /**
+    * The UUID representing the draw request in Kanmon. (only present for Line of Credit).
+    */
+    'drawRequestId': string | null;
+    /**
+    * The UUID representing the invoice in Kanmon. (only present for Invoice Financing).
+    */
+    'invoiceId': string | null;
+    /**
+    * Your platform’s unique ID for the invoice. (only present for Invoice Financing).
+    */
+    'platformInvoiceId': string | null;
+    /**
+    * The effective UTC ISO 8601 date that the payment will process.
+    */
+    'effectiveDate': string;
+    /**
+    * The UTC ISO 8601 date that the payment was settled.
+    */
+    'settledDate': string | null;
+    /**
+    * The total payment amount - in cents.
+    */
+    'totalPaymentAmountCents': number;
+    /**
+    * The principal payment amount - in cents. (null for disbursements).
+    */
+    'principalPaymentAmountCents': number | null;
+    /**
+    * The interest payment amount - in cents. (null for disbursements).
+    */
+    'interestPaymentAmountCents': number | null;
+    /**
+    * The fee payment amount - in cents. (null for disbursements).
+    */
+    'feePaymentAmountCents': number | null;
+    /**
+    * The type of the fee that was charged. (only present when `feePaymentAmountCents` is not 0 or null).
+    */
+    'feeType': PaymentOrderFeeTypeEnum | null;
+    /**
+    * The direction of the payment.
+    */
+    'direction': PaymentOrderDirectionEnum;
+    'status': PaymentOrderStatus;
+    /**
+    * Creation UTC ISO 8601 timestamp of the payment order.
+    */
+    'createdAt': Date;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the payment order.
+    */
+    'updatedAt': Date;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "issuedProductId",
+            "baseName": "issuedProductId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "drawRequestId",
+            "baseName": "drawRequestId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "invoiceId",
+            "baseName": "invoiceId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformInvoiceId",
+            "baseName": "platformInvoiceId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "effectiveDate",
+            "baseName": "effectiveDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "settledDate",
+            "baseName": "settledDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "totalPaymentAmountCents",
+            "baseName": "totalPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "principalPaymentAmountCents",
+            "baseName": "principalPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "interestPaymentAmountCents",
+            "baseName": "interestPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feePaymentAmountCents",
+            "baseName": "feePaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feeType",
+            "baseName": "feeType",
+            "type": "PaymentOrderFeeTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "direction",
+            "baseName": "direction",
+            "type": "PaymentOrderDirectionEnum",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "PaymentOrderStatus",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date",
+            "format": "date-time"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentOrder.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum PaymentOrderFeeTypeEnum {
+    LatePayment = 'LATE_PAYMENT',
+    InsufficientFunds = 'INSUFFICIENT_FUNDS',
+    TransactionFee = 'TRANSACTION_FEE',
+    Maintenance = 'MAINTENANCE'
+}
+export enum PaymentOrderDirectionEnum {
+    Disbursement = 'DISBURSEMENT',
+    Repayment = 'REPAYMENT'
+}
+

package/src/openapi/models/PaymentOrderNotFoundException.ts

@@ -0,0 +1,63 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class PaymentOrderNotFoundException {
+    /**
+    * Safe for programmatic use.
+    */
+    'errorCode': PaymentOrderNotFoundExceptionErrorCodeEnum;
+    /**
+    * The human readable description of the error.
+    */
+    'message': string;
+    /**
+    * When the error occurred - ISO 8601 format.
+    */
+    'timestamp': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "errorCode",
+            "baseName": "errorCode",
+            "type": "PaymentOrderNotFoundExceptionErrorCodeEnum",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "timestamp",
+            "baseName": "timestamp",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentOrderNotFoundException.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum PaymentOrderNotFoundExceptionErrorCodeEnum {
+    PaymentOrderNotFoundException = 'PaymentOrderNotFoundException'
+}
+

package/src/openapi/models/PaymentOrderStatus.ts

@@ -0,0 +1,19 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export enum PaymentOrderStatus {
+    Failed = 'FAILED',
+    Paid = 'PAID',
+    Pending = 'PENDING'
+}

package/src/openapi/models/PaymentPlanRepaymentSchedule.ts

@@ -0,0 +1,39 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { PaymentPlanRepaymentScheduleItem } from '../models/PaymentPlanRepaymentScheduleItem';
+import { HttpFile } from '../http/http';
+
+export class PaymentPlanRepaymentSchedule {
+    /**
+    * An array of repayment schedule items that represents how the invoice will be paid back over multiple repayments.
+    */
+    'schedule': Array<PaymentPlanRepaymentScheduleItem>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "schedule",
+            "baseName": "schedule",
+            "type": "Array<PaymentPlanRepaymentScheduleItem>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentPlanRepaymentSchedule.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/PaymentPlanRepaymentScheduleItem.ts

@@ -0,0 +1,48 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class PaymentPlanRepaymentScheduleItem {
+    /**
+    * This amount of days after which the repayment duration is due.
+    */
+    'repaymentDurationDays': number;
+    /**
+    * The percentage of the payment that is due for this repayment. E.g. a value of `50` means 50%.
+    */
+    'repaymentPercentage': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "repaymentDurationDays",
+            "baseName": "repaymentDurationDays",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentPercentage",
+            "baseName": "repaymentPercentage",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentPlanRepaymentScheduleItem.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/PaymentScheduleItem.ts

@@ -0,0 +1,56 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { PaymentScheduleItemPaymentOrder } from '../models/PaymentScheduleItemPaymentOrder';
+import { HttpFile } from '../http/http';
+
+export class PaymentScheduleItem {
+    /**
+    * The effective UTC ISO 8601 date that the payment will process.
+    */
+    'effectiveDate': string;
+    /**
+    * The total payment amount - in cents.
+    */
+    'totalPaymentAmountCents': number;
+    'paymentOrder': PaymentScheduleItemPaymentOrder | null;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "effectiveDate",
+            "baseName": "effectiveDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "totalPaymentAmountCents",
+            "baseName": "totalPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "paymentOrder",
+            "baseName": "paymentOrder",
+            "type": "PaymentScheduleItemPaymentOrder",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentScheduleItem.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/PaymentScheduleItemPaymentOrder.ts

@@ -0,0 +1,201 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { PaymentOrderStatus } from '../models/PaymentOrderStatus';
+import { HttpFile } from '../http/http';
+
+/**
+* The payment order for this schedule item
+*/
+export class PaymentScheduleItemPaymentOrder {
+    /**
+    * The UUID representing the payment order in Kanmon.
+    */
+    'id': string;
+    /**
+    * The UUID representing the issued product in Kanmon.
+    */
+    'issuedProductId': string;
+    /**
+    * The UUID representing the draw request in Kanmon. (only present for Line of Credit).
+    */
+    'drawRequestId': string | null;
+    /**
+    * The UUID representing the invoice in Kanmon. (only present for Invoice Financing).
+    */
+    'invoiceId': string | null;
+    /**
+    * Your platform’s unique ID for the invoice. (only present for Invoice Financing).
+    */
+    'platformInvoiceId': string | null;
+    /**
+    * The effective UTC ISO 8601 date that the payment will process.
+    */
+    'effectiveDate': string;
+    /**
+    * The UTC ISO 8601 date that the payment was settled.
+    */
+    'settledDate': string | null;
+    /**
+    * The total payment amount - in cents.
+    */
+    'totalPaymentAmountCents': number;
+    /**
+    * The principal payment amount - in cents. (null for disbursements).
+    */
+    'principalPaymentAmountCents': number | null;
+    /**
+    * The interest payment amount - in cents. (null for disbursements).
+    */
+    'interestPaymentAmountCents': number | null;
+    /**
+    * The fee payment amount - in cents. (null for disbursements).
+    */
+    'feePaymentAmountCents': number | null;
+    /**
+    * The type of the fee that was charged. (only present when `feePaymentAmountCents` is not 0 or null).
+    */
+    'feeType': PaymentScheduleItemPaymentOrderFeeTypeEnum | null;
+    /**
+    * The direction of the payment.
+    */
+    'direction': PaymentScheduleItemPaymentOrderDirectionEnum;
+    'status': PaymentOrderStatus;
+    /**
+    * Creation UTC ISO 8601 timestamp of the payment order.
+    */
+    'createdAt': Date;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the payment order.
+    */
+    'updatedAt': Date;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "id",
+            "baseName": "id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "issuedProductId",
+            "baseName": "issuedProductId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "drawRequestId",
+            "baseName": "drawRequestId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "invoiceId",
+            "baseName": "invoiceId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformInvoiceId",
+            "baseName": "platformInvoiceId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "effectiveDate",
+            "baseName": "effectiveDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "settledDate",
+            "baseName": "settledDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "totalPaymentAmountCents",
+            "baseName": "totalPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "principalPaymentAmountCents",
+            "baseName": "principalPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "interestPaymentAmountCents",
+            "baseName": "interestPaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feePaymentAmountCents",
+            "baseName": "feePaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feeType",
+            "baseName": "feeType",
+            "type": "PaymentScheduleItemPaymentOrderFeeTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "direction",
+            "baseName": "direction",
+            "type": "PaymentScheduleItemPaymentOrderDirectionEnum",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "PaymentOrderStatus",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date",
+            "format": "date-time"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaymentScheduleItemPaymentOrder.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum PaymentScheduleItemPaymentOrderFeeTypeEnum {
+    LatePayment = 'LATE_PAYMENT',
+    InsufficientFunds = 'INSUFFICIENT_FUNDS',
+    TransactionFee = 'TRANSACTION_FEE',
+    Maintenance = 'MAINTENANCE'
+}
+export enum PaymentScheduleItemPaymentOrderDirectionEnum {
+    Disbursement = 'DISBURSEMENT',
+    Repayment = 'REPAYMENT'
+}
+

package/src/openapi/models/PlaidAssetReportsInvalidException.ts

@@ -0,0 +1,63 @@
+/**
+ * Kanmon Public V2 API
+ * Kanmon\'s public api. Contains all of the endpoints for both capital providers and platforms
+ *
+ * OpenAPI spec version: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class PlaidAssetReportsInvalidException {
+    /**
+    * Safe for programmatic use.
+    */
+    'errorCode': PlaidAssetReportsInvalidExceptionErrorCodeEnum;
+    /**
+    * The human readable description of the error.
+    */
+    'message': string;
+    /**
+    * When the error occurred - ISO 8601 format.
+    */
+    'timestamp': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "errorCode",
+            "baseName": "errorCode",
+            "type": "PlaidAssetReportsInvalidExceptionErrorCodeEnum",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "timestamp",
+            "baseName": "timestamp",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PlaidAssetReportsInvalidException.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum PlaidAssetReportsInvalidExceptionErrorCodeEnum {
+    PlaidAssetReportsInvalidException = 'PlaidAssetReportsInvalidException'
+}
+