@codat/lending 3.1.0 → 3.3.0

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;
 }

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

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceLifetimeValueMetricsRequest 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 GetCommerceLifetimeValueMetricsResponse extends SpeakeasyBa
      * 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/getcommercelocation.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceLocationRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a location.
@@ -14,11 +20,20 @@ export declare class GetCommerceLocationResponse extends SpeakeasyBase {
      * OK
      */
     commerceLocation?: shared.CommerceLocation;
+    /**
+     * 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/getcommerceorder.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceOrderRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for an order.
@@ -14,11 +20,20 @@ export declare class GetCommerceOrderResponse extends SpeakeasyBase {
      * OK
      */
     commerceOrder?: shared.CommerceOrder;
+    /**
+     * 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/getcommerceordersreport.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceOrdersReportRequest 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 GetCommerceOrdersReportResponse extends SpeakeasyBase {
      * 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/getcommercepayment.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommercePaymentRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a payment.
@@ -14,11 +20,20 @@ export declare class GetCommercePaymentResponse extends SpeakeasyBase {
      * OK
      */
     commercePayment?: shared.CommercePayment;
+    /**
+     * 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/getcommercepaymentmethod.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommercePaymentMethodRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a payment method.
@@ -14,11 +20,20 @@ export declare class GetCommercePaymentMethodResponse extends SpeakeasyBase {
      * OK
      */
     commercePaymentMethod?: shared.CommercePaymentMethod;
+    /**
+     * 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/getcommerceproduct.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceProductRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a product.
@@ -14,11 +20,20 @@ export declare class GetCommerceProductResponse extends SpeakeasyBase {
      * OK
      */
     commerceProduct?: shared.CommerceProduct;
+    /**
+     * 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/getcommerceproductcategory.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceProductCategoryRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
      * Unique identifier for a product.
@@ -14,11 +20,20 @@ export declare class GetCommerceProductCategoryResponse extends SpeakeasyBase {
      * OK
      */
     commerceProductCategory?: shared.CommerceProductCategory;
+    /**
+     * 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/getcommerceprofile.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceProfileRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
 }
 export declare class GetCommerceProfileResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetCommerceProfileResponse extends SpeakeasyBase {
      * OK
      */
     commerceCompanyInfo?: shared.CommerceCompanyInfo;
+    /**
+     * 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/getcommercerefundsreport.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceRefundsReportRequest 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 GetCommerceRefundsReportResponse extends SpeakeasyBase {
      * 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/getcommercerevenuemetrics.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetCommerceRevenueMetricsRequest 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 GetCommerceRevenueMetricsResponse extends SpeakeasyBase {
      * 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;
 }