@codat/lending 3.2.0 → 3.3.0

package/dist/sdk/models/operations/getaccountinginvoice.d.ts

@@ -2,9 +2,12 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingInvoiceRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
-     * Unique identifier for an invoice
+     * Unique identifier for an invoice.
      */
     invoiceId: string;
 }
@@ -13,11 +16,20 @@ export declare class GetAccountingInvoiceResponse extends SpeakeasyBase {
      * Success
      */
     accountingInvoice?: shared.AccountingInvoice;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountinginvoiceattachment.d.ts

@@ -3,13 +3,19 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingInvoiceAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
-     * Unique identifier for an invoice
+     * Unique identifier for an invoice.
      */
     invoiceId: string;
 }
@@ -18,11 +24,20 @@ export declare class GetAccountingInvoiceAttachmentResponse extends SpeakeasyBas
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingjournal.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingJournalRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a journal.
+     */
     journalId: string;
 }
 export declare class GetAccountingJournalResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingJournalResponse extends SpeakeasyBase {
      * Success
      */
     accountingJournal?: shared.AccountingJournal;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingjournalentry.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingJournalEntryRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a journal entry.
+     */
     journalEntryId: string;
 }
 export declare class GetAccountingJournalEntryResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingJournalEntryResponse extends SpeakeasyBase {
      * Success
      */
     accountingJournalEntry?: shared.AccountingJournalEntry;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingpayment.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingPaymentRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a payment.
+     */
     paymentId: string;
 }
 export declare class GetAccountingPaymentResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingPaymentResponse extends SpeakeasyBase {
      * Success
      */
     accountingPayment?: shared.AccountingPayment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingprofile.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingProfileRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
 }
 export declare class GetAccountingProfileResponse extends SpeakeasyBase {
@@ -9,11 +12,20 @@ export declare class GetAccountingProfileResponse extends SpeakeasyBase {
      * Success
      */
     accountingCompanyInfo?: shared.AccountingCompanyInfo;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingprofitandloss.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingProfitAndLossRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Number of months defining the period of interest.
@@ -11,6 +14,9 @@ export declare class GetAccountingProfitAndLossRequest extends SpeakeasyBase {
      * Number of periods with `periodLength` to compare.
      */
     periodsToCompare: number;
+    /**
+     * The month the report starts from.
+     */
     startMonth?: string;
 }
 export declare class GetAccountingProfitAndLossResponse extends SpeakeasyBase {
@@ -18,11 +24,20 @@ export declare class GetAccountingProfitAndLossResponse extends SpeakeasyBase {
      * Success
      */
     accountingProfitAndLossReport?: shared.AccountingProfitAndLossReport;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingsupplier.d.ts

@@ -2,9 +2,12 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingSupplierRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
-     * Unique identifier for a supplier
+     * Unique identifier for a supplier.
      */
     supplierId: string;
 }
@@ -13,11 +16,20 @@ export declare class GetAccountingSupplierResponse extends SpeakeasyBase {
      * Success
      */
     accountingSupplier?: shared.AccountingSupplier;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingsupplierattachment.d.ts

@@ -3,13 +3,19 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingSupplierAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
-     * Unique identifier for a supplier
+     * Unique identifier for a supplier.
      */
     supplierId: string;
 }
@@ -18,11 +24,20 @@ export declare class GetAccountingSupplierAttachmentResponse extends SpeakeasyBa
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingtransfer.d.ts

@@ -2,8 +2,17 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingTransferRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
+    /**
+     * Unique identifier for a transfer.
+     */
     transferId: string;
 }
 export declare class GetAccountingTransferResponse extends SpeakeasyBase {
@@ -11,11 +20,20 @@ export declare class GetAccountingTransferResponse extends SpeakeasyBase {
      * Success
      */
     accountingTransfer?: shared.AccountingTransfer;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getbankingaccount.d.ts

@@ -3,10 +3,16 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetBankingAccountRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an account
+     * Unique identifier for an account.
      */
     accountId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
 }
 export declare class GetBankingAccountResponse extends SpeakeasyBase {
@@ -14,7 +20,16 @@ export declare class GetBankingAccountResponse extends SpeakeasyBase {
      * Success
      */
     bankingAccount?: shared.BankingAccount;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getbankingtransaction.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetBankingTransactionRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * The unique identifier for a transaction
@@ -14,7 +20,16 @@ export declare class GetBankingTransactionResponse extends SpeakeasyBase {
      * Success
      */
     bankingTransaction?: shared.BankingTransaction;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getbankingtransactioncategory.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetBankingTransactionCategoryRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * The unique identifier for a banking transaction category
@@ -14,7 +20,16 @@ export declare class GetBankingTransactionCategoryResponse extends SpeakeasyBase
      * Success
      */
     bankingTransactionCategory?: shared.BankingTransactionCategory;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcategorizedbalancesheetstatement.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCategorizedBalanceSheetStatementRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * The number of periods to return. If not provided, 12 periods will be used as the default value.
@@ -13,6 +16,9 @@ export declare class GetCategorizedBalanceSheetStatementRequest extends Speakeas
     reportDate: string;
 }
 export declare class GetCategorizedBalanceSheetStatementResponse extends SpeakeasyBase {
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * OK
@@ -22,6 +28,12 @@ export declare class GetCategorizedBalanceSheetStatementResponse extends Speakea
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcategorizedbankstatement.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCategorizedBankStatementRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Page number. [Read more](https://docs.codat.io/using-the-api/paging).
@@ -17,6 +20,9 @@ export declare class GetCategorizedBankStatementRequest extends SpeakeasyBase {
     query?: string;
 }
 export declare class GetCategorizedBankStatementResponse extends SpeakeasyBase {
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * OK
@@ -26,6 +32,12 @@ export declare class GetCategorizedBankStatementResponse extends SpeakeasyBase {
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcategorizedprofitandlossstatement.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCategorizedProfitAndLossStatementRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * The number of periods to return. If not provided, 12 periods will be used as the default value.
@@ -10,9 +13,12 @@ export declare class GetCategorizedProfitAndLossStatementRequest extends Speakea
     /**
      * The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.
      */
-    reportDate: string;
+    reportDate?: string;
 }
 export declare class GetCategorizedProfitAndLossStatementResponse extends SpeakeasyBase {
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * OK
@@ -22,6 +28,12 @@ export declare class GetCategorizedProfitAndLossStatementResponse extends Speake
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcommercecustomer.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceCustomerRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a customer.
@@ -14,11 +20,20 @@ export declare class GetCommerceCustomerResponse extends SpeakeasyBase {
      * OK
      */
     commerceCustomer?: shared.CommerceCustomer;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcommercecustomerretentionmetrics.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceCustomerRetentionMetricsRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.
@@ -30,11 +36,20 @@ export declare class GetCommerceCustomerRetentionMetricsResponse extends Speakea
      * OK
      */
     commerceReport?: shared.CommerceReport;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getcommercedispute.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceDisputeRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a dispute.
@@ -14,11 +20,20 @@ export declare class GetCommerceDisputeResponse extends SpeakeasyBase {
      * OK
      */
     commerceDispute?: shared.CommerceDispute;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }