@kanmon/sdk 2.0.0

package/src/openapi/models/Invoice.ts

@@ -0,0 +1,281 @@
+/**
+ * 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 { InvoicePayorAddress } from '../models/InvoicePayorAddress';
+import { InvoiceRepaymentSchedule } from '../models/InvoiceRepaymentSchedule';
+import { InvoiceStatus } from '../models/InvoiceStatus';
+import { HttpFile } from '../http/http';
+
+export class Invoice {
+    /**
+    * Kanmon’s unique ID for the invoice.
+    */
+    'id': string;
+    /**
+    * Your platform’s unique ID for the invoice.
+    */
+    'platformInvoiceId': string | null;
+    /**
+    * Your user-facing identifier for the invoice. This does not need to be unique. This may or may not be the same as your `platformInvoiceId`.
+    */
+    'platformInvoiceNumber': string | null;
+    /**
+    * The invoice amount - in cents.
+    */
+    'invoiceAmountCents': number;
+    /**
+    * The date when the invoice will be paid by the payor. ISO 8601 date format.
+    */
+    'invoiceDueDate': string | null;
+    /**
+    * The date when the payee issued the invoice. ISO 8601 date format.
+    */
+    'invoiceIssuedDate': string | null;
+    /**
+    * The email of the payor.
+    */
+    'payorEmail': string | null;
+    'payorAddress': InvoicePayorAddress | null;
+    /**
+    * `INDIVIDUAL` if the payor is a person and `BUSINESS` if the payor is a company.
+    */
+    'payorType': InvoicePayorTypeEnum | null;
+    /**
+    * The registered name of the payor business when the payor is a business and not an individual.
+    */
+    'payorBusinessName': string | null;
+    /**
+    * The first name of the payor when the payor is an individual and not a business.
+    */
+    'payorFirstName': string | null;
+    /**
+    * The middle name of the payor when the payor is an individual and not a business.
+    */
+    'payorMiddleName': string | null;
+    /**
+    * The last name of the payor when the payor is an individual and not a business.
+    */
+    'payorLastName': string | null;
+    'status': InvoiceStatus;
+    /**
+    * The unique identifier for the issued product in Kanmon′s system.
+    */
+    'issuedProductId': string;
+    /**
+    * The total fee amount - in cents.
+    */
+    'feeAmountCents': number;
+    /**
+    * The total principal amount - in cents.
+    */
+    'principalAmountCents': number;
+    /**
+    * The amount after fees the business will receive - in cents.
+    */
+    'invoiceAdvanceAmountCents': number;
+    /**
+    * The total amount that the business will repay - in cents.
+    */
+    'repaymentAmountCents': number;
+    /**
+    * The invoice repayment schedule.
+    */
+    'repaymentSchedule': InvoiceRepaymentSchedule;
+    /**
+    * The percentage of the invoice that is allowed for advances. E.g. a value of `80` would mean that $800 would be advanced on a $1,000 invoice.
+    */
+    'advanceRatePercentage': number;
+    /**
+    * The percentage of the transaction that is charged as a fee. E.g. a value of `5` means 5%.
+    */
+    'transactionFeePercentage': number;
+    /**
+    * The portion of the invoice amount that the business requests to be financed - in cents.
+    */
+    'amountRequestedForFinancingCents': number;
+    /**
+    * Creation UTC ISO 8601 timestamp of the invoice.
+    */
+    'createdAt': string;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the invoice.
+    */
+    'updatedAt': string;
+
+    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": "platformInvoiceId",
+            "baseName": "platformInvoiceId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformInvoiceNumber",
+            "baseName": "platformInvoiceNumber",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "invoiceAmountCents",
+            "baseName": "invoiceAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "invoiceDueDate",
+            "baseName": "invoiceDueDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "invoiceIssuedDate",
+            "baseName": "invoiceIssuedDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payorEmail",
+            "baseName": "payorEmail",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payorAddress",
+            "baseName": "payorAddress",
+            "type": "InvoicePayorAddress",
+            "format": ""
+        },
+        {
+            "name": "payorType",
+            "baseName": "payorType",
+            "type": "InvoicePayorTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "payorBusinessName",
+            "baseName": "payorBusinessName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payorFirstName",
+            "baseName": "payorFirstName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payorMiddleName",
+            "baseName": "payorMiddleName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "payorLastName",
+            "baseName": "payorLastName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "InvoiceStatus",
+            "format": ""
+        },
+        {
+            "name": "issuedProductId",
+            "baseName": "issuedProductId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "feeAmountCents",
+            "baseName": "feeAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "principalAmountCents",
+            "baseName": "principalAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "invoiceAdvanceAmountCents",
+            "baseName": "invoiceAdvanceAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentAmountCents",
+            "baseName": "repaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentSchedule",
+            "baseName": "repaymentSchedule",
+            "type": "InvoiceRepaymentSchedule",
+            "format": ""
+        },
+        {
+            "name": "advanceRatePercentage",
+            "baseName": "advanceRatePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "transactionFeePercentage",
+            "baseName": "transactionFeePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "amountRequestedForFinancingCents",
+            "baseName": "amountRequestedForFinancingCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Invoice.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoicePayorTypeEnum {
+    Business = 'BUSINESS',
+    Individual = 'INDIVIDUAL'
+}
+

package/src/openapi/models/InvoiceFinancingOfferTerms.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { InvoicePaymentPlan } from '../models/InvoicePaymentPlan';
+import { HttpFile } from '../http/http';
+
+export class InvoiceFinancingOfferTerms {
+    'productType': InvoiceFinancingOfferTermsProductTypeEnum;
+    /**
+    * The total limit allowed for this offer - in cents.
+    */
+    'totalLimitCents': number;
+    /**
+    * The pricing plans available for this offer.
+    */
+    'pricingPlans': Array<InvoicePaymentPlan>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "productType",
+            "baseName": "productType",
+            "type": "InvoiceFinancingOfferTermsProductTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "totalLimitCents",
+            "baseName": "totalLimitCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pricingPlans",
+            "baseName": "pricingPlans",
+            "type": "Array<InvoicePaymentPlan>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceFinancingOfferTerms.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoiceFinancingOfferTermsProductTypeEnum {
+    InvoiceFinancing = 'INVOICE_FINANCING'
+}
+

package/src/openapi/models/InvoiceFinancingServicingData.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 { InvoicePaymentPlan } from '../models/InvoicePaymentPlan';
+import { HttpFile } from '../http/http';
+
+export class InvoiceFinancingServicingData {
+    'productType': InvoiceFinancingServicingDataProductTypeEnum;
+    /**
+    * The total limit allowed - in cents.
+    */
+    'totalLimitCents': number;
+    /**
+    * The pricing plans available for this issued product.
+    */
+    'pricingPlans': Array<InvoicePaymentPlan>;
+    /**
+    * The total limit less the amount of balance outstanding - in cents.
+    */
+    'availableLimitCents': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "productType",
+            "baseName": "productType",
+            "type": "InvoiceFinancingServicingDataProductTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "totalLimitCents",
+            "baseName": "totalLimitCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pricingPlans",
+            "baseName": "pricingPlans",
+            "type": "Array<InvoicePaymentPlan>",
+            "format": ""
+        },
+        {
+            "name": "availableLimitCents",
+            "baseName": "availableLimitCents",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceFinancingServicingData.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoiceFinancingServicingDataProductTypeEnum {
+    InvoiceFinancing = 'INVOICE_FINANCING'
+}
+

package/src/openapi/models/InvoiceFlowSessionTokenData.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { SessionInvoice } from '../models/SessionInvoice';
+import { HttpFile } from '../http/http';
+
+export class InvoiceFlowSessionTokenData {
+    'component': InvoiceFlowSessionTokenDataComponentEnum;
+    /**
+    * Details about the list of invoices which are to be created.
+    */
+    'invoices': Array<SessionInvoice>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "component",
+            "baseName": "component",
+            "type": "InvoiceFlowSessionTokenDataComponentEnum",
+            "format": ""
+        },
+        {
+            "name": "invoices",
+            "baseName": "invoices",
+            "type": "Array<SessionInvoice>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceFlowSessionTokenData.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoiceFlowSessionTokenDataComponentEnum {
+    SessionInvoiceFlow = 'SESSION_INVOICE_FLOW'
+}
+

package/src/openapi/models/InvoiceFlowWithInvoiceFileSessionTokenData.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { SessionInvoiceWithInvoiceFile } from '../models/SessionInvoiceWithInvoiceFile';
+import { HttpFile } from '../http/http';
+
+export class InvoiceFlowWithInvoiceFileSessionTokenData {
+    'component': InvoiceFlowWithInvoiceFileSessionTokenDataComponentEnum;
+    /**
+    * Details about the list of invoices which are to be created.
+    */
+    'invoices': Array<SessionInvoiceWithInvoiceFile>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "component",
+            "baseName": "component",
+            "type": "InvoiceFlowWithInvoiceFileSessionTokenDataComponentEnum",
+            "format": ""
+        },
+        {
+            "name": "invoices",
+            "baseName": "invoices",
+            "type": "Array<SessionInvoiceWithInvoiceFile>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceFlowWithInvoiceFileSessionTokenData.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoiceFlowWithInvoiceFileSessionTokenDataComponentEnum {
+    SessionInvoiceFlowWithInvoiceFile = 'SESSION_INVOICE_FLOW_WITH_INVOICE_FILE'
+}
+

package/src/openapi/models/InvoiceNotFoundException.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 InvoiceNotFoundException {
+    /**
+    * Safe for programmatic use.
+    */
+    'errorCode': InvoiceNotFoundExceptionErrorCodeEnum;
+    /**
+    * 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": "InvoiceNotFoundExceptionErrorCodeEnum",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "timestamp",
+            "baseName": "timestamp",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceNotFoundException.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoiceNotFoundExceptionErrorCodeEnum {
+    InvoiceNotFoundException = 'InvoiceNotFoundException'
+}
+

package/src/openapi/models/InvoicePaymentPlan.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 InvoicePaymentPlan {
+    /**
+    * The percentage of the invoice that is allowed for advances. E.g. a value of `80` would mean that $800 would be advanced on a $1,000 invoice.
+    */
+    'advanceRatePercentage': number;
+    /**
+    * The percentage of the transaction that is charged as a fee. E.g. a value of `5` means 5%.
+    */
+    'transactionFeePercentage': number;
+    /**
+    * The repayment window
+    */
+    'repaymentWindow': Array<any>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "advanceRatePercentage",
+            "baseName": "advanceRatePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "transactionFeePercentage",
+            "baseName": "transactionFeePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentWindow",
+            "baseName": "repaymentWindow",
+            "type": "Array<any>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoicePaymentPlan.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+