@kanmon/sdk 2.0.0

package/src/openapi/models/CreateUserRequestBody.ts

@@ -0,0 +1,125 @@
+/**
+ * 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 { Address } from '../models/Address';
+import { HttpFile } from '../http/http';
+
+export class CreateUserRequestBody {
+    /**
+    * Your platform’s unique ID for the user.
+    */
+    'platformUserId': string;
+    /**
+    * Your platform’s unique business ID for the business. Either `platformBusinessId` or `businessId` is required.
+    */
+    'platformBusinessId'?: string;
+    /**
+    * The UUID representing the user’s business in Kanmon. Either `platformBusinessId` or `businessId` is required.
+    */
+    'businessId'?: string;
+    /**
+    * The user’s email.
+    */
+    'email'?: string;
+    /**
+    * The user’s first name.
+    */
+    'firstName'?: string;
+    /**
+    * The user’s last name.
+    */
+    'lastName'?: string;
+    /**
+    * The user’s address.
+    */
+    'address'?: Address;
+    /**
+    * The user’s roles. If no roles are defined, the user will be prompted to select a role within Kanmon. <br/><br/>A primary owner is a user with the authority to issue debt on behalf of the business. <br/>This means the user can complete onboarding, receive offers, choose to accept offers, <br/>sign financing agreements, and service an active issued product. <br/><br/>An operator is a user with permission to service an active issued product. Examples are uploading invoices on <br/>behalf of the business, checking the status of payments, etc. <br /><br/>Please note Kanmon supports an additional user role called secondary owners. <br/>Secondary owners are beneficial owners of a business, like primary owners, and Kanmon <br/>must perform KYC checks for these users. Kanmon will handle creating and managing <br/>these users for KYC purposes through a separate process. <br/>
+    */
+    'roles'?: Array<CreateUserRequestBodyRolesEnum>;
+    /**
+    * Metadata from your system that you want to associate the user with.
+    */
+    'metadata'?: any;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "platformUserId",
+            "baseName": "platformUserId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "platformBusinessId",
+            "baseName": "platformBusinessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "businessId",
+            "baseName": "businessId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "email",
+            "baseName": "email",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "firstName",
+            "baseName": "firstName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "lastName",
+            "baseName": "lastName",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "address",
+            "baseName": "address",
+            "type": "Address",
+            "format": ""
+        },
+        {
+            "name": "roles",
+            "baseName": "roles",
+            "type": "Array<CreateUserRequestBodyRolesEnum>",
+            "format": ""
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "any",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return CreateUserRequestBody.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum CreateUserRequestBodyRolesEnum {
+    PrimaryOwner = 'PRIMARY_OWNER',
+    Operator = 'OPERATOR'
+}
+

package/src/openapi/models/DrawRequest.ts

@@ -0,0 +1,138 @@
+/**
+ * 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 { DrawRequestState } from '../models/DrawRequestState';
+import { HttpFile } from '../http/http';
+
+export class DrawRequest {
+    /**
+    * Kanmon’s unique ID for the draw request.
+    */
+    'id': string;
+    /**
+    * The UUID representing the issued product in Kanmon.
+    */
+    'issuedProductId': string;
+    /**
+    * The total draw request amount - in cents.
+    */
+    'amountCents': number;
+    /**
+    * The total draw request amount, less the fees - in cents. This is the amount disbursed to the business if the draw request is approved.
+    */
+    'disbursementAmountCents': number;
+    /**
+    * The fee amount - in cents.
+    */
+    'feeAmountCents': number;
+    'status': DrawRequestState;
+    /**
+    * The interest rate for the draw request. E.g. a value of `10` means 10%.
+    */
+    'interestRatePercentage': number;
+    /**
+    * The fee percentage charged as the borrowing cost of the draw request. E.g. a value of `2` means a 2% fee.
+    */
+    'feePercentage': number;
+    /**
+    * The duration of the repayment for the draw request - in months.
+    */
+    'repaymentDurationMonths': number;
+    /**
+    * Creation UTC ISO 8601 timestamp of the draw request.
+    */
+    'createdAt': string;
+    /**
+    * Last updated UTC ISO 8601 timestamp of the draw request.
+    */
+    '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": "issuedProductId",
+            "baseName": "issuedProductId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "amountCents",
+            "baseName": "amountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "disbursementAmountCents",
+            "baseName": "disbursementAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feeAmountCents",
+            "baseName": "feeAmountCents",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "DrawRequestState",
+            "format": ""
+        },
+        {
+            "name": "interestRatePercentage",
+            "baseName": "interestRatePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "feePercentage",
+            "baseName": "feePercentage",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "repaymentDurationMonths",
+            "baseName": "repaymentDurationMonths",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "createdAt",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "updatedAt",
+            "baseName": "updatedAt",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return DrawRequest.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+

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

package/src/openapi/models/DrawRequestState.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 DrawRequestState {
+    DrawRequestCreated = 'DRAW_REQUEST_CREATED',
+    DrawRequestFunded = 'DRAW_REQUEST_FUNDED',
+    DrawRequestPaidInFull = 'DRAW_REQUEST_PAID_IN_FULL',
+    Rejected = 'REJECTED',
+    Defaulted = 'DEFAULTED'
+}

package/src/openapi/models/EmbeddedSession.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 EmbeddedSession {
+    /**
+    * The session token used to launch an embedded session.
+    */
+    'sessionToken': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "sessionToken",
+            "baseName": "sessionToken",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return EmbeddedSession.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/FixedDateInvoiceRepaymentWindow.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 FixedDateInvoiceRepaymentWindow {
+    'repaymentType': FixedDateInvoiceRepaymentWindowRepaymentTypeEnum;
+    /**
+    * The day on which the repayment is due. E.g. a value of `15` means the repayment is due on the 15th.
+    */
+    'monthlyRepaymentDay': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "repaymentType",
+            "baseName": "repaymentType",
+            "type": "FixedDateInvoiceRepaymentWindowRepaymentTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "monthlyRepaymentDay",
+            "baseName": "monthlyRepaymentDay",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return FixedDateInvoiceRepaymentWindow.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum FixedDateInvoiceRepaymentWindowRepaymentTypeEnum {
+    FixedDate = 'FIXED_DATE'
+}
+

package/src/openapi/models/FixedDurationInvoiceRepaymentWindow.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 FixedDurationInvoiceRepaymentWindow {
+    'repaymentType': FixedDurationInvoiceRepaymentWindowRepaymentTypeEnum;
+    /**
+    * This amount of days after which the repayment duration is due.
+    */
+    'repaymentDurationDays': number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "repaymentType",
+            "baseName": "repaymentType",
+            "type": "FixedDurationInvoiceRepaymentWindowRepaymentTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "repaymentDurationDays",
+            "baseName": "repaymentDurationDays",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return FixedDurationInvoiceRepaymentWindow.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export enum FixedDurationInvoiceRepaymentWindowRepaymentTypeEnum {
+    FixedDuration = 'FIXED_DURATION'
+}
+

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

package/src/openapi/models/GetActivityLogsResponse.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { ActivityLog } from '../models/ActivityLog';
+import { PaginationResult } from '../models/PaginationResult';
+import { HttpFile } from '../http/http';
+
+export class GetActivityLogsResponse {
+    /**
+    * An array of activity logs.
+    */
+    'activityLogs': Array<ActivityLog>;
+    /**
+    * Pagination metadata.
+    */
+    'pagination': PaginationResult;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "activityLogs",
+            "baseName": "activityLogs",
+            "type": "Array<ActivityLog>",
+            "format": ""
+        },
+        {
+            "name": "pagination",
+            "baseName": "pagination",
+            "type": "PaginationResult",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetActivityLogsResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/src/openapi/models/GetBusinessBankAccountsResponse.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { BusinessBankAccount } from '../models/BusinessBankAccount';
+import { PaginationResult } from '../models/PaginationResult';
+import { HttpFile } from '../http/http';
+
+export class GetBusinessBankAccountsResponse {
+    /**
+    * Array of business bank accounts.
+    */
+    'bankAccounts': Array<BusinessBankAccount>;
+    /**
+    * Pagination metadata.
+    */
+    'pagination': PaginationResult;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "bankAccounts",
+            "baseName": "bankAccounts",
+            "type": "Array<BusinessBankAccount>",
+            "format": ""
+        },
+        {
+            "name": "pagination",
+            "baseName": "pagination",
+            "type": "PaginationResult",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetBusinessBankAccountsResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+