@kanmon/sdk 2.0.0

package/src/openapi/models/Offer.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 { OfferTerms } from '../models/OfferTerms';
+import { HttpFile } from '../http/http';
+
+export class Offer {
+    /**
+    * A unique id representing the offer object.
+    */
+    'id': string;
+    /**
+    * The UUID representing the business in Kanmon.
+    */
+    'businessId': string;
+    /**
+    * Your platform’s unique ID for the business.
+    */
+    'platformBusinessId': string | null;
+    'terms': OfferTerms;
+    /**
+    * The ISO 8601 timestamp for when the offer expires.
+    */
+    'expiredAt': string | null;
+    /**
+    * If the offer has been selected by the business, the ISO 8601 timestamp for when it was selected.
+    */
+    'selectedAt': string | null;
+    /**
+    * Creation ISO 8601 timestamp of the offer.
+    */
+    'createdAt': string;
+    /**
+    * Last updated ISO 8601 timestamp of the offer.
+    */
+    '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": "businessId",
+            "baseName": "businessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformBusinessId",
+            "baseName": "platformBusinessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "terms",
+            "baseName": "terms",
+            "type": "OfferTerms",
+            "format": ""
+        },
+        {
+            "name": "expiredAt",
+            "baseName": "expiredAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "selectedAt",
+            "baseName": "selectedAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Offer.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

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

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

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

package/src/openapi/models/OfferTerms.ts

@@ -0,0 +1,184 @@
+/**
+ * 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 { InvoiceFinancingOfferTerms } from '../models/InvoiceFinancingOfferTerms';
+import { InvoicePaymentPlan } from '../models/InvoicePaymentPlan';
+import { LineOfCreditOfferTerms } from '../models/LineOfCreditOfferTerms';
+import { McaOfferTerms } from '../models/McaOfferTerms';
+import { TermLoanOfferTerms } from '../models/TermLoanOfferTerms';
+import { HttpFile } from '../http/http';
+
+/**
+* Terms of the offer.
+*/
+export class OfferTerms {
+    'productType': OfferTermsProductTypeEnum;
+    /**
+    * The maximum loan amount - in cents.
+    */
+    'maxLoanAmountCents': number;
+    /**
+    * The loan amount - in cents. This defaults to `maxLoanAmountCents`. However, the business can select a smaller amount.
+    */
+    'loanAmountCents': number;
+    /**
+    * The rate of interest on the loan. E.g. a value of `10` means 10%.
+    */
+    'interestRatePercentage': number;
+    /**
+    * The duration of the loan - in months.
+    */
+    'durationMonths': 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 total limit allowed for this offer - in cents.
+    */
+    'totalLimitCents': number;
+    /**
+    * The pricing plans available for this offer.
+    */
+    'pricingPlans': Array<InvoicePaymentPlan>;
+    /**
+    * 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 repayment frequency of the loan. E.g. biweekly repayment occurs every 14 days, weekly repayment occurs every 7 days, etc.
+    */
+    'repaymentFrequency': OfferTermsRepaymentFrequencyEnum;
+    /**
+    * 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 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": "OfferTermsProductTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "maxLoanAmountCents",
+            "baseName": "maxLoanAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "loanAmountCents",
+            "baseName": "loanAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "interestRatePercentage",
+            "baseName": "interestRatePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "durationMonths",
+            "baseName": "durationMonths",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feePercentage",
+            "baseName": "feePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "totalLimitCents",
+            "baseName": "totalLimitCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pricingPlans",
+            "baseName": "pricingPlans",
+            "type": "Array<InvoicePaymentPlan>",
+            "format": ""
+        },
+        {
+            "name": "advanceAmountCents",
+            "baseName": "advanceAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentPercentage",
+            "baseName": "repaymentPercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feeFactor",
+            "baseName": "feeFactor",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentFrequency",
+            "baseName": "repaymentFrequency",
+            "type": "OfferTermsRepaymentFrequencyEnum",
+            "format": ""
+        },
+        {
+            "name": "totalRepaymentCents",
+            "baseName": "totalRepaymentCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentDurationMonths",
+            "baseName": "repaymentDurationMonths",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return OfferTerms.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum OfferTermsProductTypeEnum {
+    LineOfCredit = 'LINE_OF_CREDIT'
+}
+export enum OfferTermsRepaymentFrequencyEnum {
+    Daily = 'DAILY',
+    Weekly = 'WEEKLY',
+    Biweekly = 'BIWEEKLY',
+    Monthly = 'MONTHLY'
+}
+

package/src/openapi/models/PaginationResult.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 PaginationResult {
+    /**
+    * The number of records to limit when performing pagination.
+    */
+    'limit': number;
+    /**
+    * The number of records to skip when performing pagination.
+    */
+    'offset': number;
+    /**
+    * The total number of records that matched the query.
+    */
+    'totalCount': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "limit",
+            "baseName": "limit",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "offset",
+            "baseName": "offset",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "totalCount",
+            "baseName": "totalCount",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return PaginationResult.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+