@kanmon/sdk 2.0.0

package/src/openapi/models/InvoicePayorAddress.ts

@@ -0,0 +1,143 @@
+/**
+ * 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';
+
+/**
+* The address of the payor.
+*/
+export class InvoicePayorAddress {
+    'addressLineOne': string;
+    'addressLineTwo'?: string | null;
+    'city': string;
+    /**
+    * The 2 character abbreviated state
+    */
+    'state': InvoicePayorAddressStateEnum;
+    /**
+    * Zip code can be 5 digits, 9 digits, or 5+4 including a hyphen or plus sign, e.g. 90210, 902101234, 90210-1234 or 90210+1234
+    */
+    'zipcode': string;
+    /**
+    * USA
+    */
+    'country': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "addressLineOne",
+            "baseName": "addressLineOne",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "addressLineTwo",
+            "baseName": "addressLineTwo",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "city",
+            "baseName": "city",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "state",
+            "baseName": "state",
+            "type": "InvoicePayorAddressStateEnum",
+            "format": ""
+        },
+        {
+            "name": "zipcode",
+            "baseName": "zipcode",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "country",
+            "baseName": "country",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoicePayorAddress.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum InvoicePayorAddressStateEnum {
+    Al = 'AL',
+    Ky = 'KY',
+    Oh = 'OH',
+    Ak = 'AK',
+    La = 'LA',
+    Ok = 'OK',
+    Az = 'AZ',
+    Me = 'ME',
+    Or = 'OR',
+    Ar = 'AR',
+    Md = 'MD',
+    Pa = 'PA',
+    As = 'AS',
+    Ma = 'MA',
+    Pr = 'PR',
+    Ca = 'CA',
+    Mi = 'MI',
+    Ri = 'RI',
+    Co = 'CO',
+    Mn = 'MN',
+    Sc = 'SC',
+    Ct = 'CT',
+    Ms = 'MS',
+    Sd = 'SD',
+    De = 'DE',
+    Mo = 'MO',
+    Tn = 'TN',
+    Dc = 'DC',
+    Mt = 'MT',
+    Tx = 'TX',
+    Fl = 'FL',
+    Ne = 'NE',
+    Tt = 'TT',
+    Ga = 'GA',
+    Nv = 'NV',
+    Ut = 'UT',
+    Gu = 'GU',
+    Nh = 'NH',
+    Vt = 'VT',
+    Hi = 'HI',
+    Nj = 'NJ',
+    Va = 'VA',
+    Id = 'ID',
+    Nm = 'NM',
+    Vi = 'VI',
+    Il = 'IL',
+    Ny = 'NY',
+    Wa = 'WA',
+    In = 'IN',
+    Nc = 'NC',
+    Wv = 'WV',
+    Ia = 'IA',
+    Nd = 'ND',
+    Wi = 'WI',
+    Ks = 'KS',
+    Mp = 'MP',
+    Wy = 'WY'
+}
+

package/src/openapi/models/InvoiceRepaymentSchedule.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 { InvoiceRepaymentScheduleItem } from '../models/InvoiceRepaymentScheduleItem';
+import { HttpFile } from '../http/http';
+
+export class InvoiceRepaymentSchedule {
+    /**
+    * The invoice repayment schedule items.
+    */
+    'schedule': Array<InvoiceRepaymentScheduleItem>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "schedule",
+            "baseName": "schedule",
+            "type": "Array<InvoiceRepaymentScheduleItem>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceRepaymentSchedule.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/InvoiceRepaymentScheduleItem.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 InvoiceRepaymentScheduleItem {
+    /**
+    * The date on which an installment of the invoice is to be repaid - ISO 8601 format.
+    */
+    'repaymentDate': string;
+    /**
+    * The amount to be paid as installment - in cents.
+    */
+    'repaymentAmountCents': number;
+    /**
+    * The fee amount to be paid as installment - in cents.
+    */
+    'repaymentFeeAmountCents': number;
+    /**
+    * The principal amount to be paid as installment - in cents.
+    */
+    'repaymentPrincipalAmountCents': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "repaymentDate",
+            "baseName": "repaymentDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "repaymentAmountCents",
+            "baseName": "repaymentAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentFeeAmountCents",
+            "baseName": "repaymentFeeAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentPrincipalAmountCents",
+            "baseName": "repaymentPrincipalAmountCents",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return InvoiceRepaymentScheduleItem.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/InvoiceStatus.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 InvoiceStatus {
+    InvoiceCreated = 'INVOICE_CREATED',
+    InvoiceFunded = 'INVOICE_FUNDED',
+    InvoicePaidInFull = 'INVOICE_PAID_IN_FULL',
+    Rejected = 'REJECTED',
+    Defaulted = 'DEFAULTED',
+    Late = 'LATE'
+}

package/src/openapi/models/IssuedProduct.ts

@@ -0,0 +1,115 @@
+/**
+ * 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 { IssuedProductServicingData } from '../models/IssuedProductServicingData';
+import { HttpFile } from '../http/http';
+
+export class IssuedProduct {
+    /**
+    * The UUID representing the issued product in Kanmon.
+    */
+    'id': string;
+    /**
+    * The UUID representing the offer tied to this issued product in Kanmon.
+    */
+    'offerId': string;
+    /**
+    * The UUID representing the business in Kanmon.
+    */
+    'businessId': string;
+    /**
+    * Your platform’s unique ID for the business.
+    */
+    'platformBusinessId': string | null;
+    /**
+    * The current status of the loan.
+    */
+    'loanStatus': IssuedProductLoanStatusEnum;
+    'servicingData': IssuedProductServicingData;
+    /**
+    * Creation UTC ISO 8601 timestamp of the prequalification.
+    */
+    'createdAt': Date;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the prequalification.
+    */
+    '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": "offerId",
+            "baseName": "offerId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "businessId",
+            "baseName": "businessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformBusinessId",
+            "baseName": "platformBusinessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "loanStatus",
+            "baseName": "loanStatus",
+            "type": "IssuedProductLoanStatusEnum",
+            "format": ""
+        },
+        {
+            "name": "servicingData",
+            "baseName": "servicingData",
+            "type": "IssuedProductServicingData",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "Date",
+            "format": "date-time"
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "Date",
+            "format": "date-time"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return IssuedProduct.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum IssuedProductLoanStatusEnum {
+    Current = 'CURRENT',
+    Late = 'LATE',
+    FullyPaid = 'FULLY_PAID',
+    Refinanced = 'REFINANCED',
+    Defaulted = 'DEFAULTED'
+}
+

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

package/src/openapi/models/IssuedProductServicingData.ts

@@ -0,0 +1,234 @@
+/**
+ * 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 { InvoiceFinancingServicingData } from '../models/InvoiceFinancingServicingData';
+import { InvoicePaymentPlan } from '../models/InvoicePaymentPlan';
+import { LineOfCreditServicingData } from '../models/LineOfCreditServicingData';
+import { McaServicingData } from '../models/McaServicingData';
+import { TermLoanServicingData } from '../models/TermLoanServicingData';
+import { HttpFile } from '../http/http';
+
+/**
+* The data needed to service this specific type of issued product
+*/
+export class IssuedProductServicingData {
+    'productType': IssuedProductServicingDataProductTypeEnum;
+    /**
+    * The total loan amount - in cents.
+    */
+    'loanAmountCents': number;
+    /**
+    * The total origination fee amount - in cents.
+    */
+    'originationFeeCents': number;
+    /**
+    * The principal remaining on the loan - in cents.
+    */
+    'principalBalanceCents': number;
+    /**
+    * The monthly payment amount - in cents.
+    */
+    'monthlyPaymentCents': number;
+    /**
+    * The interest rate of the loan. E.g. a value of `10` means 10%.
+    */
+    'interestRate': number;
+    /**
+    * The next scheduled payment date - ISO 8601 date format.
+    */
+    'nextPaymentDate': string | null;
+    /**
+    * The total credit limit - 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;
+    /**
+    * The loan amount - in cents.
+    */
+    'advanceAmountCents': number;
+    /**
+    * The repayment percentage for calculating repayment amounts. E.g. a value of a `20` means 20%. If a business has $100 of income over a repayment period, the repayment amount would be $20.
+    */
+    'repaymentPercentage': number;
+    /**
+    * The fee percentage charged as the borrowing cost of the loan. E.g. a value of `1.3` means a 30% fee.
+    */
+    'feeFactor': number;
+    /**
+    * The total repayment amount in cents required to settle and close the debt. E.g. for a $10,000 loan with a fee factor of 1.3, the repayment amount equates to $13,000.
+    */
+    'totalRepaymentCents': number;
+    /**
+    * The repayment frequency of the loan. E.g. biweekly repayment occurs every 14 days, weekly repayment occurs every 7 days, etc.
+    */
+    'repaymentFrequency': IssuedProductServicingDataRepaymentFrequencyEnum;
+    /**
+    * The total repayment amount less the amount repaid - in cents.
+    */
+    'advanceBalanceCents': number;
+    /**
+    * The rate of interest on the loan. E.g. a value of `10` means 10%.
+    */
+    'interestRatePercentage': number;
+    /**
+    * The fee percentage charged as the borrowing cost of the loan. E.g. a value of `2` means a 2% fee.
+    */
+    'feePercentage': number;
+    /**
+    * The duration of the repayment for each draw - in months.
+    */
+    'repaymentDurationMonths': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "productType",
+            "baseName": "productType",
+            "type": "IssuedProductServicingDataProductTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "loanAmountCents",
+            "baseName": "loanAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "originationFeeCents",
+            "baseName": "originationFeeCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "principalBalanceCents",
+            "baseName": "principalBalanceCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "monthlyPaymentCents",
+            "baseName": "monthlyPaymentCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "interestRate",
+            "baseName": "interestRate",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "nextPaymentDate",
+            "baseName": "nextPaymentDate",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "totalLimitCents",
+            "baseName": "totalLimitCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pricingPlans",
+            "baseName": "pricingPlans",
+            "type": "Array<InvoicePaymentPlan>",
+            "format": ""
+        },
+        {
+            "name": "availableLimitCents",
+            "baseName": "availableLimitCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "advanceAmountCents",
+            "baseName": "advanceAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentPercentage",
+            "baseName": "repaymentPercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feeFactor",
+            "baseName": "feeFactor",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "totalRepaymentCents",
+            "baseName": "totalRepaymentCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentFrequency",
+            "baseName": "repaymentFrequency",
+            "type": "IssuedProductServicingDataRepaymentFrequencyEnum",
+            "format": ""
+        },
+        {
+            "name": "advanceBalanceCents",
+            "baseName": "advanceBalanceCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "interestRatePercentage",
+            "baseName": "interestRatePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feePercentage",
+            "baseName": "feePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentDurationMonths",
+            "baseName": "repaymentDurationMonths",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return IssuedProductServicingData.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum IssuedProductServicingDataProductTypeEnum {
+    LineOfCredit = 'LINE_OF_CREDIT'
+}
+export enum IssuedProductServicingDataRepaymentFrequencyEnum {
+    Daily = 'DAILY',
+    Weekly = 'WEEKLY',
+    Biweekly = 'BIWEEKLY',
+    Monthly = 'MONTHLY'
+}
+