From 2722bce30a0fa20c65fb3f9a076bf07cd2ea7be2 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 21 Aug 2024 09:37:21 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.377.0 --- .speakeasy/workflow.lock | 6 ++-- lending/.speakeasy/gen.lock | 8 ++--- lending/RELEASES.md | 12 ++++++- lending/docs/sdks/accountbalances/README.md | 6 ++-- lending/docs/sdks/accounts/README.md | 11 +++--- lending/docs/sdks/accountspayable/README.md | 5 +-- .../docs/sdks/accountsreceivable/README.md | 5 +-- .../docs/sdks/accounttransactions/README.md | 11 +++--- lending/docs/sdks/balancesheet/README.md | 11 +++--- lending/docs/sdks/bankaccounts/README.md | 11 +++--- lending/docs/sdks/banking/README.md | 5 +-- lending/docs/sdks/bankstatements/README.md | 20 ++++------- lending/docs/sdks/banktransactions/README.md | 11 +++--- lending/docs/sdks/billcreditnotes/README.md | 11 +++--- lending/docs/sdks/billpayments/README.md | 11 +++--- lending/docs/sdks/bills/README.md | 26 ++++++-------- lending/docs/sdks/cashflow/README.md | 6 ++-- .../docs/sdks/categorizedstatement/README.md | 6 ++-- lending/docs/sdks/codatlending/README.md | 6 +--- .../codatlendingaccountingbankdata/README.md | 4 +-- .../docs/sdks/codatlendingaccounts/README.md | 11 +++--- .../codatlendingbankingtransactions/README.md | 11 +++--- .../docs/sdks/codatlendingcustomers/README.md | 11 +++--- .../sdks/codatlendingdirectcosts/README.md | 26 ++++++-------- .../README.md | 11 +++--- .../README.md | 11 +++--- .../docs/sdks/codatlendingpayments/README.md | 11 +++--- .../docs/sdks/codatlendingreports/README.md | 11 +++--- .../sdks/codatlendingsalespayments/README.md | 11 +++--- .../docs/sdks/codatlendingsuppliers/README.md | 11 +++--- .../sdks/codatlendingtransactions/README.md | 11 +++--- .../docs/sdks/codatlendingtransfers/README.md | 11 +++--- lending/docs/sdks/companies/README.md | 22 +++++------- lending/docs/sdks/companyinfo/README.md | 9 ++--- lending/docs/sdks/connections/README.md | 22 +++++------- lending/docs/sdks/createoperations/README.md | 11 +++--- lending/docs/sdks/creditnotes/README.md | 11 +++--- lending/docs/sdks/customers/README.md | 26 ++++++-------- lending/docs/sdks/dataintegrity/README.md | 14 +++----- lending/docs/sdks/directcosts/README.md | 11 +++--- lending/docs/sdks/directincomes/README.md | 26 ++++++-------- lending/docs/sdks/disputes/README.md | 11 +++--- lending/docs/sdks/excelreports/README.md | 14 +++----- lending/docs/sdks/fileupload/README.md | 12 +++---- .../docs/sdks/financialstatements/README.md | 5 +-- lending/docs/sdks/invoices/README.md | 36 ++++++++----------- lending/docs/sdks/journalentries/README.md | 11 +++--- lending/docs/sdks/journals/README.md | 11 +++--- lending/docs/sdks/liabilities/README.md | 15 +++----- lending/docs/sdks/loanwriteback/README.md | 5 +-- lending/docs/sdks/locations/README.md | 11 +++--- lending/docs/sdks/managedata/README.md | 6 ++-- lending/docs/sdks/metrics/README.md | 16 ++++----- lending/docs/sdks/orders/README.md | 11 +++--- lending/docs/sdks/paymentmethods/README.md | 11 +++--- lending/docs/sdks/payments/README.md | 11 +++--- lending/docs/sdks/productcategories/README.md | 11 +++--- lending/docs/sdks/products/README.md | 11 +++--- lending/docs/sdks/profitandloss/README.md | 11 +++--- lending/docs/sdks/pulloperations/README.md | 11 +++--- lending/docs/sdks/refresh/README.md | 9 +++-- lending/docs/sdks/reports/README.md | 21 +++++------ lending/docs/sdks/sales/README.md | 5 +-- lending/docs/sdks/suppliers/README.md | 26 ++++++-------- .../docs/sdks/transactioncategories/README.md | 11 +++--- lending/docs/sdks/transactions/README.md | 5 +-- lending/docs/sdks/transfers/README.md | 11 +++--- lending/gen.yaml | 7 ++-- lending/poetry.lock | 8 ++--- lending/pyproject.toml | 4 +-- lending/src/codat_lending/sdkconfiguration.py | 6 ++-- 71 files changed, 356 insertions(+), 478 deletions(-) diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 21de5a14c..1afb5672a 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,8 +1,8 @@ -speakeasyVersion: 1.376.0 +speakeasyVersion: 1.377.0 sources: lending-source: sourceNamespace: lending-source - sourceRevisionDigest: sha256:427764465a99a087e8ddb6115be2b23255a3f0003c5bea2a153870b7f5bf0b26 + sourceRevisionDigest: sha256:e9279793fec15674c2c6ff77d11be16f6945b43d47b8005e68d7300da68a24a4 sourceBlobDigest: sha256:7ca97cfd4c993bac385e1da2ed1a467acb50d0bf3893fffd0a811d2f1ea49e91 tags: - latest @@ -11,7 +11,7 @@ targets: lending-library: source: lending-source sourceNamespace: lending-source - sourceRevisionDigest: sha256:427764465a99a087e8ddb6115be2b23255a3f0003c5bea2a153870b7f5bf0b26 + sourceRevisionDigest: sha256:e9279793fec15674c2c6ff77d11be16f6945b43d47b8005e68d7300da68a24a4 sourceBlobDigest: sha256:7ca97cfd4c993bac385e1da2ed1a467acb50d0bf3893fffd0a811d2f1ea49e91 outLocation: lending workflow: diff --git a/lending/.speakeasy/gen.lock b/lending/.speakeasy/gen.lock index f1ba42130..7157ee904 100755 --- a/lending/.speakeasy/gen.lock +++ b/lending/.speakeasy/gen.lock @@ -3,10 +3,10 @@ id: c22ee3eb-abe5-40e9-bcf6-8be944e72a7b management: docChecksum: 1f639539f1378e6b0f8843acc1f63ea7 docVersion: 3.0.0 - speakeasyVersion: 1.376.0 - generationVersion: 2.402.5 - releaseVersion: 7.0.0 - configChecksum: 2d5def522f9e50c9b4d27fbd79cac268 + speakeasyVersion: 1.377.0 + generationVersion: 2.404.0 + releaseVersion: 7.0.1 + configChecksum: fac6722acde54431b9939d27e44b94ea repoURL: https://github.com/codatio/client-sdk-python.git repoSubDirectory: lending installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=lending diff --git a/lending/RELEASES.md b/lending/RELEASES.md index dee1a8650..374be4828 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -108,4 +108,14 @@ Based on: ### Generated - [python v7.0.0] lending ### Releases -- [PyPI v7.0.0] https://pypi.org/project/codat-lending/7.0.0 - lending \ No newline at end of file +- [PyPI v7.0.0] https://pypi.org/project/codat-lending/7.0.0 - lending + +## 2024-08-21 09:35:27 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.377.0 (2.404.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v7.0.1] lending +### Releases +- [PyPI v7.0.1] https://pypi.org/project/codat-lending/7.0.1 - lending \ No newline at end of file diff --git a/lending/docs/sdks/accountbalances/README.md b/lending/docs/sdks/accountbalances/README.md index 39864b147..578dd025e 100644 --- a/lending/docs/sdks/accountbalances/README.md +++ b/lending/docs/sdks/accountbalances/README.md @@ -1,6 +1,8 @@ # AccountBalances (*banking.account_balances*) +## Overview + ### Available Operations * [list](#list) - List account balances @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.ListBankingAccountBalancesRequest](../../models/operations/listbankingaccountbalancesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingAccountBalances](../../models/shared/bankingaccountbalances.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/accounts/README.md b/lending/docs/sdks/accounts/README.md index 540d13738..7080af659 100644 --- a/lending/docs/sdks/accounts/README.md +++ b/lending/docs/sdks/accounts/README.md @@ -1,6 +1,8 @@ # Accounts (*accounting_bank_data.accounts*) +## Overview + ### Available Operations * [get](#get) - Get bank account @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetAccountingBankAccountRequest](../../models/operations/getaccountingbankaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBankAccount](../../models/shared/accountingbankaccount.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListAccountingBankAccountsRequest](../../models/operations/listaccountingbankaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBankAccounts](../../models/shared/accountingbankaccounts.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/accountspayable/README.md b/lending/docs/sdks/accountspayable/README.md index d05bada40..4b7e86a4a 100644 --- a/lending/docs/sdks/accountspayable/README.md +++ b/lending/docs/sdks/accountspayable/README.md @@ -1,5 +1,2 @@ # AccountsPayable -(*accounts_payable*) - -### Available Operations - +(*accounts_payable*) \ No newline at end of file diff --git a/lending/docs/sdks/accountsreceivable/README.md b/lending/docs/sdks/accountsreceivable/README.md index 995d24ec1..e09c69e35 100644 --- a/lending/docs/sdks/accountsreceivable/README.md +++ b/lending/docs/sdks/accountsreceivable/README.md @@ -1,5 +1,2 @@ # AccountsReceivable -(*accounts_receivable*) - -### Available Operations - +(*accounts_receivable*) \ No newline at end of file diff --git a/lending/docs/sdks/accounttransactions/README.md b/lending/docs/sdks/accounttransactions/README.md index d5229c922..143f70821 100644 --- a/lending/docs/sdks/accounttransactions/README.md +++ b/lending/docs/sdks/accounttransactions/README.md @@ -1,6 +1,8 @@ # AccountTransactions (*transactions.account_transactions*) +## Overview + ### Available Operations * [get](#get) - Get account transaction @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetAccountingAccountTransactionRequest](../../models/operations/getaccountingaccounttransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAccountTransaction](../../models/shared/accountingaccounttransaction.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListAccountingAccountTransactionsRequest](../../models/operations/listaccountingaccounttransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAccountTransactions](../../models/shared/accountingaccounttransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/balancesheet/README.md b/lending/docs/sdks/balancesheet/README.md index 339dce0f2..6829268d3 100644 --- a/lending/docs/sdks/balancesheet/README.md +++ b/lending/docs/sdks/balancesheet/README.md @@ -1,6 +1,8 @@ # BalanceSheet (*financial_statements.balance_sheet*) +## Overview + ### Available Operations * [get](#get) - Get balance sheet @@ -36,8 +38,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -45,10 +45,10 @@ if res is not None: | `request` | [operations.GetAccountingBalanceSheetRequest](../../models/operations/getaccountingbalancesheetrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBalanceSheet](../../models/shared/accountingbalancesheet.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -56,6 +56,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_categorized_accounts The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. @@ -86,8 +87,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -95,10 +94,10 @@ if res is not None: | `request` | [operations.GetCategorizedBalanceSheetStatementRequest](../../models/operations/getcategorizedbalancesheetstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.EnhancedFinancialReport](../../models/shared/enhancedfinancialreport.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/bankaccounts/README.md b/lending/docs/sdks/bankaccounts/README.md index 5c300a2d9..bc4402a6d 100644 --- a/lending/docs/sdks/bankaccounts/README.md +++ b/lending/docs/sdks/bankaccounts/README.md @@ -1,6 +1,8 @@ # BankAccounts (*loan_writeback.bank_accounts*) +## Overview + ### Available Operations * [create](#create) - Create bank account @@ -48,8 +50,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -57,10 +57,10 @@ if res is not None: | `request` | [operations.CreateBankAccountRequest](../../models/operations/createbankaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateBankAccountResponse](../../models/shared/accountingcreatebankaccountresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -68,6 +68,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_update_model The *Get create/update bank account model* endpoint returns the expected data for the request payload when creating and updating a [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company and integration. @@ -105,8 +106,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -114,10 +113,10 @@ if res is not None: | `request` | [operations.GetCreateUpdateBankAccountsModelRequest](../../models/operations/getcreateupdatebankaccountsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/banking/README.md b/lending/docs/sdks/banking/README.md index bca4e10c5..520ce4856 100644 --- a/lending/docs/sdks/banking/README.md +++ b/lending/docs/sdks/banking/README.md @@ -1,5 +1,2 @@ # Banking -(*banking*) - -### Available Operations - +(*banking*) \ No newline at end of file diff --git a/lending/docs/sdks/bankstatements/README.md b/lending/docs/sdks/bankstatements/README.md index 673668a2e..aceae761b 100644 --- a/lending/docs/sdks/bankstatements/README.md +++ b/lending/docs/sdks/bankstatements/README.md @@ -42,8 +42,6 @@ s.bank_statements.end_upload_session(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -58,6 +56,7 @@ s.bank_statements.end_upload_session(request={ | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_upload_configuration Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection. @@ -90,8 +89,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -99,10 +96,10 @@ if res is not None: | `request` | [operations.GetBankStatementUploadConfigurationRequest](../../models/operations/getbankstatementuploadconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankStatementUploadConfiguration](../../models/shared/bankstatementuploadconfiguration.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -110,6 +107,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## set_upload_configuration Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection. @@ -146,8 +144,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -155,10 +151,10 @@ if res is not None: | `request` | [operations.SetBankStatementUploadConfigurationRequest](../../models/operations/setbankstatementuploadconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankStatementUploadConfiguration](../../models/shared/bankstatementuploadconfiguration.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -166,6 +162,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## start_upload_session Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company. @@ -198,8 +195,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -207,10 +202,10 @@ if res is not None: | `request` | [operations.StartBankStatementUploadSessionRequest](../../models/operations/startbankstatementuploadsessionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PullOperation](../../models/shared/pulloperation.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -218,6 +213,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## upload_bank_statement_data During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session. @@ -260,8 +256,6 @@ s.bank_statements.upload_bank_statement_data(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | diff --git a/lending/docs/sdks/banktransactions/README.md b/lending/docs/sdks/banktransactions/README.md index 70aca5ad0..11b9c5dbd 100644 --- a/lending/docs/sdks/banktransactions/README.md +++ b/lending/docs/sdks/banktransactions/README.md @@ -1,6 +1,8 @@ # BankTransactions (*loan_writeback.bank_transactions*) +## Overview + ### Available Operations * [create](#create) - Create bank account transactions @@ -52,8 +54,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -61,10 +61,10 @@ if res is not None: | `request` | [operations.CreateBankTransactionsRequest](../../models/operations/createbanktransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateBankTransactionsResponse](../../models/shared/accountingcreatebanktransactionsresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -72,6 +72,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_model The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. @@ -110,8 +111,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -119,10 +118,10 @@ if res is not None: | `request` | [operations.GetCreateBankTransactionsModelRequest](../../models/operations/getcreatebanktransactionsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/billcreditnotes/README.md b/lending/docs/sdks/billcreditnotes/README.md index 874044d3f..13496e229 100644 --- a/lending/docs/sdks/billcreditnotes/README.md +++ b/lending/docs/sdks/billcreditnotes/README.md @@ -1,6 +1,8 @@ # BillCreditNotes (*accounts_payable.bill_credit_notes*) +## Overview + ### Available Operations * [get](#get) - Get bill credit note @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingBillCreditNoteRequest](../../models/operations/getaccountingbillcreditnoterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBillCreditNote](../../models/shared/accountingbillcreditnote.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingBillCreditNotesRequest](../../models/operations/listaccountingbillcreditnotesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBillCreditNotes](../../models/shared/accountingbillcreditnotes.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/billpayments/README.md b/lending/docs/sdks/billpayments/README.md index a72697b93..74d7f404c 100644 --- a/lending/docs/sdks/billpayments/README.md +++ b/lending/docs/sdks/billpayments/README.md @@ -1,6 +1,8 @@ # BillPayments (*accounts_payable.bill_payments*) +## Overview + ### Available Operations * [get](#get) - Get bill payment @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingBillPaymentRequest](../../models/operations/getaccountingbillpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBillPayment](../../models/shared/accountingbillpayment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingBillPaymentsRequest](../../models/operations/listaccountingbillpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBillPayments](../../models/shared/accountingbillpayments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/bills/README.md b/lending/docs/sdks/bills/README.md index 814ea062b..6d2af2096 100644 --- a/lending/docs/sdks/bills/README.md +++ b/lending/docs/sdks/bills/README.md @@ -1,6 +1,8 @@ # Bills (*accounts_payable.bills*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download bill attachment @@ -44,8 +46,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -53,10 +53,10 @@ if res is not None: | `request` | [operations.DownloadAccountingBillAttachmentRequest](../../models/operations/downloadaccountingbillattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -64,6 +64,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get bill* endpoint returns a single bill for a given billId. @@ -104,8 +105,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -113,10 +112,10 @@ if res is not None: | `request` | [operations.GetAccountingBillRequest](../../models/operations/getaccountingbillrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBill](../../models/shared/accountingbill.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -124,6 +123,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. @@ -159,8 +159,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -168,10 +166,10 @@ if res is not None: | `request` | [operations.GetAccountingBillAttachmentRequest](../../models/operations/getaccountingbillattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -179,6 +177,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. @@ -219,8 +218,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -228,10 +225,10 @@ if res is not None: | `request` | [operations.ListAccountingBillsRequest](../../models/operations/listaccountingbillsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBills](../../models/shared/accountingbills.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -239,6 +236,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. @@ -273,8 +271,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -282,10 +278,10 @@ if res is not None: | `request` | [operations.ListAccountingBillAttachmentsRequest](../../models/operations/listaccountingbillattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/cashflow/README.md b/lending/docs/sdks/cashflow/README.md index 2120e505e..f48d2d9bb 100644 --- a/lending/docs/sdks/cashflow/README.md +++ b/lending/docs/sdks/cashflow/README.md @@ -1,6 +1,8 @@ # CashFlow (*financial_statements.cash_flow*) +## Overview + ### Available Operations * [get](#get) - Get cash flow statement @@ -35,8 +37,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -44,10 +44,10 @@ if res is not None: | `request` | [operations.GetAccountingCashFlowStatementRequest](../../models/operations/getaccountingcashflowstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCashFlowStatement](../../models/shared/accountingcashflowstatement.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/categorizedstatement/README.md b/lending/docs/sdks/categorizedstatement/README.md index 9424e266c..419d2b71d 100644 --- a/lending/docs/sdks/categorizedstatement/README.md +++ b/lending/docs/sdks/categorizedstatement/README.md @@ -1,6 +1,8 @@ # CategorizedStatement (*banking.categorized_statement*) +## Overview + ### Available Operations * [get](#get) - Get categorized bank statement @@ -39,8 +41,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -48,10 +48,10 @@ if res is not None: | `request` | [operations.GetCategorizedBankStatementRequest](../../models/operations/getcategorizedbankstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.EnhancedCashFlowTransactions](../../models/shared/enhancedcashflowtransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlending/README.md b/lending/docs/sdks/codatlending/README.md index d9dcfb68a..211cf594a 100644 --- a/lending/docs/sdks/codatlending/README.md +++ b/lending/docs/sdks/codatlending/README.md @@ -1,6 +1,5 @@ # CodatLending SDK - ## Overview Lending API: Our Lending API helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. @@ -29,7 +28,4 @@ The Lending API is built on top of the latest accounting, commerce, and banking | Manage data | Control how data is retrieved from an integration. | | File upload | Endpoints to manage uploaded files. | | Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. | - - -### Available Operations - + \ No newline at end of file diff --git a/lending/docs/sdks/codatlendingaccountingbankdata/README.md b/lending/docs/sdks/codatlendingaccountingbankdata/README.md index 544e525a8..d909345fc 100644 --- a/lending/docs/sdks/codatlendingaccountingbankdata/README.md +++ b/lending/docs/sdks/codatlendingaccountingbankdata/README.md @@ -49,8 +49,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -58,10 +56,10 @@ if res is not None: | `request` | [operations.ListAccountingBankAccountTransactionsRequest](../../models/operations/listaccountingbankaccounttransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingBankTransactions](../../models/shared/accountingbanktransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingaccounts/README.md b/lending/docs/sdks/codatlendingaccounts/README.md index 53e526406..f524208a4 100644 --- a/lending/docs/sdks/codatlendingaccounts/README.md +++ b/lending/docs/sdks/codatlendingaccounts/README.md @@ -1,6 +1,8 @@ # CodatLendingAccounts (*banking.accounts*) +## Overview + ### Available Operations * [get](#get) - Get account @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetBankingAccountRequest](../../models/operations/getbankingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingAccount](../../models/shared/bankingaccount.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListBankingAccountsRequest](../../models/operations/listbankingaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingAccounts](../../models/shared/bankingaccounts.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingbankingtransactions/README.md b/lending/docs/sdks/codatlendingbankingtransactions/README.md index cef931f0d..279f1ea89 100644 --- a/lending/docs/sdks/codatlendingbankingtransactions/README.md +++ b/lending/docs/sdks/codatlendingbankingtransactions/README.md @@ -1,6 +1,8 @@ # CodatLendingBankingTransactions (*banking.transactions*) +## Overview + ### Available Operations * [get](#get) - Get bank transaction @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetBankingTransactionRequest](../../models/operations/getbankingtransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingTransaction](../../models/shared/bankingtransaction.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListBankingTransactionsRequest](../../models/operations/listbankingtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingTransactions](../../models/shared/bankingtransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingcustomers/README.md b/lending/docs/sdks/codatlendingcustomers/README.md index 736c00825..257d62131 100644 --- a/lending/docs/sdks/codatlendingcustomers/README.md +++ b/lending/docs/sdks/codatlendingcustomers/README.md @@ -1,6 +1,8 @@ # CodatLendingCustomers (*sales.customers*) +## Overview + ### Available Operations * [get](#get) - Get customer @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceCustomerRequest](../../models/operations/getcommercecustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceCustomer](../../models/shared/commercecustomer.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceCustomersRequest](../../models/operations/listcommercecustomersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceCustomers](../../models/shared/commercecustomers.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingdirectcosts/README.md b/lending/docs/sdks/codatlendingdirectcosts/README.md index 6a8e7e3e8..57b47d313 100644 --- a/lending/docs/sdks/codatlendingdirectcosts/README.md +++ b/lending/docs/sdks/codatlendingdirectcosts/README.md @@ -1,6 +1,8 @@ # CodatLendingDirectCosts (*transactions.direct_costs*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download direct cost attachment @@ -44,8 +46,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -53,10 +53,10 @@ if res is not None: | `request` | [operations.DownloadAccountingDirectCostAttachmentRequest](../../models/operations/downloadaccountingdirectcostattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -64,6 +64,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get direct cost* endpoint returns a single direct cost for a given directCostId. @@ -100,8 +101,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -109,10 +108,10 @@ if res is not None: | `request` | [operations.GetAccountingDirectCostRequest](../../models/operations/getaccountingdirectcostrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingDirectCost](../../models/shared/accountingdirectcost.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -120,6 +119,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. @@ -155,8 +155,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -164,10 +162,10 @@ if res is not None: | `request` | [operations.GetAccountingDirectCostAttachmentRequest](../../models/operations/getaccountingdirectcostattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -175,6 +173,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. @@ -212,8 +211,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -221,10 +218,10 @@ if res is not None: | `request` | [operations.ListAccountingDirectCostsRequest](../../models/operations/listaccountingdirectcostsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingDirectCosts](../../models/shared/accountingdirectcosts.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -232,6 +229,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. @@ -266,8 +264,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -275,10 +271,10 @@ if res is not None: | `request` | [operations.ListAccountingDirectCostAttachmentsRequest](../../models/operations/listaccountingdirectcostattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md b/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md index 9aaa79557..0354e3479 100644 --- a/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md +++ b/lending/docs/sdks/codatlendingfinancialstatementsaccounts/README.md @@ -1,6 +1,8 @@ # CodatLendingFinancialStatementsAccounts (*financial_statements.accounts*) +## Overview + ### Available Operations * [get](#get) - Get account @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingAccountRequest](../../models/operations/getaccountingaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAccount](../../models/shared/accountingaccount.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. @@ -96,8 +97,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -105,10 +104,10 @@ if res is not None: | `request` | [operations.ListAccountingAccountsRequest](../../models/operations/listaccountingaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAccounts](../../models/shared/accountingaccounts.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md index d6633a757..af0049f20 100644 --- a/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md +++ b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md @@ -1,6 +1,8 @@ # CodatLendingLoanWritebackAccounts (*loan_writeback.accounts*) +## Overview + ### Available Operations * [create](#create) - Create account @@ -55,8 +57,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -64,10 +64,10 @@ if res is not None: | `request` | [operations.CreateAccountRequest](../../models/operations/createaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateAccountResponse](../../models/shared/accountingcreateaccountresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -75,6 +75,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_model The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. @@ -112,8 +113,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -121,10 +120,10 @@ if res is not None: | `request` | [operations.GetCreateChartOfAccountsModelRequest](../../models/operations/getcreatechartofaccountsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingpayments/README.md b/lending/docs/sdks/codatlendingpayments/README.md index ad03d60f7..6d229b6c3 100644 --- a/lending/docs/sdks/codatlendingpayments/README.md +++ b/lending/docs/sdks/codatlendingpayments/README.md @@ -1,6 +1,8 @@ # CodatLendingPayments (*loan_writeback.payments*) +## Overview + ### Available Operations * [create](#create) - Create payment @@ -80,8 +82,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -89,10 +89,10 @@ if res is not None: | `request` | [operations.CreatePaymentRequest](../../models/operations/createpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreatePaymentResponse](../../models/shared/accountingcreatepaymentresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -100,6 +100,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_model The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. @@ -137,8 +138,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -146,10 +145,10 @@ if res is not None: | `request` | [operations.GetCreatePaymentModelRequest](../../models/operations/getcreatepaymentmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingreports/README.md b/lending/docs/sdks/codatlendingreports/README.md index 7c0a7d4e5..bf346495b 100644 --- a/lending/docs/sdks/codatlendingreports/README.md +++ b/lending/docs/sdks/codatlendingreports/README.md @@ -1,6 +1,8 @@ # CodatLendingReports (*sales.reports*) +## Overview + ### Available Operations * [get_orders](#get_orders) - Get orders report @@ -61,8 +63,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -70,10 +70,10 @@ if res is not None: | `request` | [operations.GetCommerceOrdersReportRequest](../../models/operations/getcommerceordersreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceReport](../../models/shared/commercereport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -81,6 +81,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_refunds The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time. @@ -137,8 +138,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -146,10 +145,10 @@ if res is not None: | `request` | [operations.GetCommerceRefundsReportRequest](../../models/operations/getcommercerefundsreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceReport](../../models/shared/commercereport.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingsalespayments/README.md b/lending/docs/sdks/codatlendingsalespayments/README.md index 1fa70be37..414c319f8 100644 --- a/lending/docs/sdks/codatlendingsalespayments/README.md +++ b/lending/docs/sdks/codatlendingsalespayments/README.md @@ -1,6 +1,8 @@ # CodatLendingSalesPayments (*sales.payments*) +## Overview + ### Available Operations * [get](#get) - Get payment @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommercePaymentRequest](../../models/operations/getcommercepaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommercePayment](../../models/shared/commercepayment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommercePaymentsRequest](../../models/operations/listcommercepaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommercePayments](../../models/shared/commercepayments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingsuppliers/README.md b/lending/docs/sdks/codatlendingsuppliers/README.md index 7e52ae599..8347aa74f 100644 --- a/lending/docs/sdks/codatlendingsuppliers/README.md +++ b/lending/docs/sdks/codatlendingsuppliers/README.md @@ -1,6 +1,8 @@ # CodatLendingSuppliers (*loan_writeback.suppliers*) +## Overview + ### Available Operations * [create](#create) - Create supplier @@ -52,8 +54,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -61,10 +61,10 @@ if res is not None: | `request` | [operations.CreateSupplierRequest](../../models/operations/createsupplierrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateSupplierResponse](../../models/shared/accountingcreatesupplierresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -72,6 +72,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_update_model The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration. @@ -109,8 +110,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -118,10 +117,10 @@ if res is not None: | `request` | [operations.GetCreateUpdateSuppliersModelRequest](../../models/operations/getcreateupdatesuppliersmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingtransactions/README.md b/lending/docs/sdks/codatlendingtransactions/README.md index 826b828c8..64fbca67e 100644 --- a/lending/docs/sdks/codatlendingtransactions/README.md +++ b/lending/docs/sdks/codatlendingtransactions/README.md @@ -1,6 +1,8 @@ # CodatLendingTransactions (*sales.transactions*) +## Overview + ### Available Operations * [get](#get) - Get transaction @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceTransactionRequest](../../models/operations/getcommercetransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceTransaction](../../models/shared/commercetransaction.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceTransactionsRequest](../../models/operations/listcommercetransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceTransactions](../../models/shared/commercetransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/codatlendingtransfers/README.md b/lending/docs/sdks/codatlendingtransfers/README.md index ca1e1553a..8ff0867fc 100644 --- a/lending/docs/sdks/codatlendingtransfers/README.md +++ b/lending/docs/sdks/codatlendingtransfers/README.md @@ -1,6 +1,8 @@ # CodatLendingTransfers (*transactions.transfers*) +## Overview + ### Available Operations * [get](#get) - Get transfer @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetAccountingTransferRequest](../../models/operations/getaccountingtransferrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingTransfer](../../models/shared/accountingtransfer.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListAccountingTransfersRequest](../../models/operations/listaccountingtransfersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingTransfers](../../models/shared/accountingtransfers.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/companies/README.md b/lending/docs/sdks/companies/README.md index b8c44ed89..1f5a769e6 100644 --- a/lending/docs/sdks/companies/README.md +++ b/lending/docs/sdks/companies/README.md @@ -51,8 +51,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -60,10 +58,10 @@ if res is not None: | `request` | [shared.CompanyRequestBody](../../models/shared/companyrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Company](../../models/shared/company.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -71,6 +69,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## delete The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible. @@ -100,8 +99,6 @@ s.companies.delete(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -116,6 +113,7 @@ s.companies.delete(request={ | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get company* endpoint returns a single company for a given `companyId`. @@ -147,8 +145,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -156,10 +152,10 @@ if res is not None: | `request` | [operations.GetCompanyRequest](../../models/operations/getcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Company](../../models/shared/company.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -167,6 +163,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List companies* endpoint returns a list of [companies] associated to your instances. @@ -200,8 +197,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -209,10 +204,10 @@ if res is not None: | `request` | [operations.ListCompaniesRequest](../../models/operations/listcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Companies](../../models/shared/companies.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -220,6 +215,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## update Use the *Update company* endpoint to update both the name and description of the company. @@ -260,8 +256,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -269,10 +263,10 @@ if res is not None: | `request` | [operations.UpdateCompanyRequest](../../models/operations/updatecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Company](../../models/shared/company.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/companyinfo/README.md b/lending/docs/sdks/companyinfo/README.md index d5cf06535..8cd9fd657 100644 --- a/lending/docs/sdks/companyinfo/README.md +++ b/lending/docs/sdks/companyinfo/README.md @@ -37,8 +37,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -46,10 +44,10 @@ if res is not None: | `request` | [operations.GetAccountingProfileRequest](../../models/operations/getaccountingprofilerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCompanyInfo](../../models/shared/accountingcompanyinfo.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -57,6 +55,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_commerce_profile Retrieve information about the company, as seen in the commerce @@ -89,8 +88,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -98,10 +95,10 @@ if res is not None: | `request` | [operations.GetCommerceProfileRequest](../../models/operations/getcommerceprofilerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceCompanyInfo](../../models/shared/commercecompanyinfo.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/connections/README.md b/lending/docs/sdks/connections/README.md index ebb824aeb..85f4d4663 100644 --- a/lending/docs/sdks/connections/README.md +++ b/lending/docs/sdks/connections/README.md @@ -45,8 +45,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -54,10 +52,10 @@ if res is not None: | `request` | [operations.CreateConnectionRequest](../../models/operations/createconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Connection](../../models/shared/connection.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -65,6 +63,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## delete Revoke and remove a connection from a company. @@ -92,8 +91,6 @@ s.connections.delete(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,6 +105,7 @@ s.connections.delete(request={ | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. @@ -136,8 +134,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -145,10 +141,10 @@ if res is not None: | `request` | [operations.GetConnectionRequest](../../models/operations/getconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Connection](../../models/shared/connection.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -156,6 +152,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list List the connections for a company. @@ -187,8 +184,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -196,10 +191,10 @@ if res is not None: | `request` | [operations.ListConnectionsRequest](../../models/operations/listconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Connections](../../models/shared/connections.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -207,6 +202,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## unlink This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. @@ -238,8 +234,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -247,10 +241,10 @@ if res is not None: | `request` | [operations.UnlinkConnectionRequest](../../models/operations/unlinkconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Connection](../../models/shared/connection.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/createoperations/README.md b/lending/docs/sdks/createoperations/README.md index b2a63cf2c..2cac95a51 100644 --- a/lending/docs/sdks/createoperations/README.md +++ b/lending/docs/sdks/createoperations/README.md @@ -1,6 +1,8 @@ # CreateOperations (*loan_writeback.create_operations*) +## Overview + ### Available Operations * [get](#get) - Get create operation @@ -34,8 +36,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -43,10 +43,10 @@ if res is not None: | `request` | [operations.GetCreateOperationRequest](../../models/operations/getcreateoperationrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOperation](../../models/shared/pushoperation.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -54,6 +54,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list List create operations. @@ -85,8 +86,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -94,10 +93,10 @@ if res is not None: | `request` | [operations.ListCreateOperationsRequest](../../models/operations/listcreateoperationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOperations](../../models/shared/pushoperations.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/creditnotes/README.md b/lending/docs/sdks/creditnotes/README.md index 6cffadc34..0e24a48a0 100644 --- a/lending/docs/sdks/creditnotes/README.md +++ b/lending/docs/sdks/creditnotes/README.md @@ -1,6 +1,8 @@ # CreditNotes (*accounts_receivable.credit_notes*) +## Overview + ### Available Operations * [get](#get) - Get credit note @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingCreditNoteRequest](../../models/operations/getaccountingcreditnoterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreditNote](../../models/shared/accountingcreditnote.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingCreditNotesRequest](../../models/operations/listaccountingcreditnotesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreditNotes](../../models/shared/accountingcreditnotes.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/customers/README.md b/lending/docs/sdks/customers/README.md index 8c9214c0e..6995ecb4c 100644 --- a/lending/docs/sdks/customers/README.md +++ b/lending/docs/sdks/customers/README.md @@ -1,6 +1,8 @@ # Customers (*accounts_receivable.customers*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download customer attachment @@ -44,8 +46,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -53,10 +53,10 @@ if res is not None: | `request` | [operations.DownloadAccountingCustomerAttachmentRequest](../../models/operations/downloadaccountingcustomerattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -64,6 +64,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get customer* endpoint returns a single customer for a given customerId. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.GetAccountingCustomerRequest](../../models/operations/getaccountingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCustomer](../../models/shared/accountingcustomer.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -119,6 +118,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. @@ -154,8 +154,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -163,10 +161,10 @@ if res is not None: | `request` | [operations.GetAccountingCustomerAttachmentRequest](../../models/operations/getaccountingcustomerattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -174,6 +172,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. @@ -210,8 +209,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -219,10 +216,10 @@ if res is not None: | `request` | [operations.ListAccountingCustomersRequest](../../models/operations/listaccountingcustomersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCustomers](../../models/shared/accountingcustomers.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -230,6 +227,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. @@ -264,8 +262,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -273,10 +269,10 @@ if res is not None: | `request` | [operations.ListAccountingCustomerAttachmentsRequest](../../models/operations/listaccountingcustomerattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/dataintegrity/README.md b/lending/docs/sdks/dataintegrity/README.md index 46943c36a..c07b997e4 100644 --- a/lending/docs/sdks/dataintegrity/README.md +++ b/lending/docs/sdks/dataintegrity/README.md @@ -45,8 +45,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -54,10 +52,10 @@ if res is not None: | `request` | [operations.ListDataIntegrityDetailsRequest](../../models/operations/listdataintegritydetailsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.DataIntegrityDetails](../../models/shared/dataintegritydetails.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -65,6 +63,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## status The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. @@ -100,8 +99,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -109,10 +106,10 @@ if res is not None: | `request` | [operations.GetDataIntegrityStatusRequest](../../models/operations/getdataintegritystatusrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.DataIntegrityStatuses](../../models/shared/dataintegritystatuses.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -120,6 +117,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## summaries The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). @@ -153,8 +151,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -162,10 +158,10 @@ if res is not None: | `request` | [operations.GetDataIntegritySummariesRequest](../../models/operations/getdataintegritysummariesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.DataIntegritySummaries](../../models/shared/dataintegritysummaries.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/directcosts/README.md b/lending/docs/sdks/directcosts/README.md index 2a1989464..596a4c4e5 100644 --- a/lending/docs/sdks/directcosts/README.md +++ b/lending/docs/sdks/directcosts/README.md @@ -1,6 +1,8 @@ # DirectCosts (*loan_writeback.direct_costs*) +## Overview + ### Available Operations * [create](#create) - Create direct cost @@ -114,8 +116,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -123,10 +123,10 @@ if res is not None: | `request` | [operations.CreateDirectCostRequest](../../models/operations/createdirectcostrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateDirectCostResponse](../../models/shared/accountingcreatedirectcostresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -134,6 +134,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_model The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. @@ -171,8 +172,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -180,10 +179,10 @@ if res is not None: | `request` | [operations.GetCreateDirectCostsModelRequest](../../models/operations/getcreatedirectcostsmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/directincomes/README.md b/lending/docs/sdks/directincomes/README.md index 0e5306192..a112608d5 100644 --- a/lending/docs/sdks/directincomes/README.md +++ b/lending/docs/sdks/directincomes/README.md @@ -1,6 +1,8 @@ # DirectIncomes (*accounts_receivable.direct_incomes*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download direct income attachment @@ -44,8 +46,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -53,10 +53,10 @@ if res is not None: | `request` | [operations.DownloadAccountingDirectIncomeAttachmentRequest](../../models/operations/downloadaccountingdirectincomeattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -64,6 +64,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get direct income* endpoint returns a single direct income for a given directIncomeId. @@ -100,8 +101,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -109,10 +108,10 @@ if res is not None: | `request` | [operations.GetAccountingDirectIncomeRequest](../../models/operations/getaccountingdirectincomerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingDirectIncome](../../models/shared/accountingdirectincome.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -120,6 +119,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. @@ -155,8 +155,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -164,10 +162,10 @@ if res is not None: | `request` | [operations.GetAccountingDirectIncomeAttachmentRequest](../../models/operations/getaccountingdirectincomeattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -175,6 +173,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection. @@ -212,8 +211,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -221,10 +218,10 @@ if res is not None: | `request` | [operations.ListAccountingDirectIncomesRequest](../../models/operations/listaccountingdirectincomesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingDirectIncomes](../../models/shared/accountingdirectincomes.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -232,6 +229,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. @@ -266,8 +264,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -275,10 +271,10 @@ if res is not None: | `request` | [operations.ListAccountingDirectIncomeAttachmentsRequest](../../models/operations/listaccountingdirectincomeattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/disputes/README.md b/lending/docs/sdks/disputes/README.md index 272f6e968..0bfbc27f3 100644 --- a/lending/docs/sdks/disputes/README.md +++ b/lending/docs/sdks/disputes/README.md @@ -1,6 +1,8 @@ # Disputes (*sales.disputes*) +## Overview + ### Available Operations * [get](#get) - Get dispute @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceDisputeRequest](../../models/operations/getcommercedisputerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceDispute](../../models/shared/commercedispute.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceDisputesRequest](../../models/operations/listcommercedisputesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceDisputes](../../models/shared/commercedisputes.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/excelreports/README.md b/lending/docs/sdks/excelreports/README.md index a685af79f..ff948b821 100644 --- a/lending/docs/sdks/excelreports/README.md +++ b/lending/docs/sdks/excelreports/README.md @@ -43,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -52,10 +50,10 @@ if res is not None: | `request` | [operations.DownloadExcelReportRequest](../../models/operations/downloadexcelreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[bytes](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -63,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## generate The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. @@ -107,8 +106,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -116,10 +113,10 @@ if res is not None: | `request` | [operations.GenerateExcelReportRequest](../../models/operations/generateexcelreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.ExcelStatus](../../models/shared/excelstatus.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -127,6 +124,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_status The *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests. @@ -159,8 +157,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -168,10 +164,10 @@ if res is not None: | `request` | [operations.GetExcelReportGenerationStatusRequest](../../models/operations/getexcelreportgenerationstatusrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.ExcelStatus](../../models/shared/excelstatus.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/fileupload/README.md b/lending/docs/sdks/fileupload/README.md index 7e75e8bbc..95529ef47 100644 --- a/lending/docs/sdks/fileupload/README.md +++ b/lending/docs/sdks/fileupload/README.md @@ -39,8 +39,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -48,10 +46,10 @@ if res is not None: | `request` | [operations.DownloadFilesRequest](../../models/operations/downloadfilesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -59,6 +57,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_uploaded The *List files* endpoint returns a list of all files uploaded to Codat by the SMB. @@ -86,8 +85,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -95,10 +92,10 @@ if res is not None: | `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[List[shared.File]](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -106,6 +103,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## upload The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. @@ -138,8 +136,6 @@ s.file_upload.upload(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | diff --git a/lending/docs/sdks/financialstatements/README.md b/lending/docs/sdks/financialstatements/README.md index 810c9bcfe..ea3c79385 100644 --- a/lending/docs/sdks/financialstatements/README.md +++ b/lending/docs/sdks/financialstatements/README.md @@ -1,5 +1,2 @@ # FinancialStatements -(*financial_statements*) - -### Available Operations - +(*financial_statements*) \ No newline at end of file diff --git a/lending/docs/sdks/invoices/README.md b/lending/docs/sdks/invoices/README.md index 499d78ce5..7ac3a1bc5 100644 --- a/lending/docs/sdks/invoices/README.md +++ b/lending/docs/sdks/invoices/README.md @@ -1,6 +1,8 @@ # Invoices (*accounts_receivable.invoices*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download invoice attachment @@ -46,8 +48,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -55,10 +55,10 @@ if res is not None: | `request` | [operations.DownloadAccountingInvoiceAttachmentRequest](../../models/operations/downloadaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -66,6 +66,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## download_pdf Download invoice as a pdf. @@ -94,8 +95,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -103,10 +102,10 @@ if res is not None: | `request` | [operations.DownloadAccountingInvoicePdfRequest](../../models/operations/downloadaccountinginvoicepdfrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -114,6 +113,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get invoice* endpoint returns a single invoice for a given invoiceId. @@ -153,8 +153,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -162,10 +160,10 @@ if res is not None: | `request` | [operations.GetAccountingInvoiceRequest](../../models/operations/getaccountinginvoicerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingInvoice](../../models/shared/accountinginvoice.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -173,6 +171,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. @@ -208,8 +207,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -217,10 +214,10 @@ if res is not None: | `request` | [operations.GetAccountingInvoiceAttachmentRequest](../../models/operations/getaccountinginvoiceattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -228,6 +225,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection. @@ -275,8 +273,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -284,10 +280,10 @@ if res is not None: | `request` | [operations.ListAccountingInvoicesRequest](../../models/operations/listaccountinginvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingInvoices](../../models/shared/accountinginvoices.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -295,6 +291,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. @@ -329,8 +326,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -338,10 +333,10 @@ if res is not None: | `request` | [operations.ListAccountingInvoiceAttachmentsRequest](../../models/operations/listaccountinginvoiceattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -349,6 +344,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_reconciled Gets a list of invoices linked to the corresponding banking transaction @@ -379,8 +375,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -388,10 +382,10 @@ if res is not None: | `request` | [operations.ListReconciledInvoicesRequest](../../models/operations/listreconciledinvoicesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.EnhancedInvoicesReport](../../models/shared/enhancedinvoicesreport.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/journalentries/README.md b/lending/docs/sdks/journalentries/README.md index aa6160b8a..777d6ce15 100644 --- a/lending/docs/sdks/journalentries/README.md +++ b/lending/docs/sdks/journalentries/README.md @@ -1,6 +1,8 @@ # JournalEntries (*transactions.journal_entries*) +## Overview + ### Available Operations * [get](#get) - Get journal entry @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingJournalEntryRequest](../../models/operations/getaccountingjournalentryrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingJournalEntry](../../models/shared/accountingjournalentry.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingJournalEntriesRequest](../../models/operations/listaccountingjournalentriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingJournalEntries](../../models/shared/accountingjournalentries.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/journals/README.md b/lending/docs/sdks/journals/README.md index acc5fa7f3..2d1ea89ed 100644 --- a/lending/docs/sdks/journals/README.md +++ b/lending/docs/sdks/journals/README.md @@ -1,6 +1,8 @@ # Journals (*transactions.journals*) +## Overview + ### Available Operations * [get](#get) - Get journal @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingJournalRequest](../../models/operations/getaccountingjournalrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingJournal](../../models/shared/accountingjournal.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingJournalsRequest](../../models/operations/listaccountingjournalsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingJournals](../../models/shared/accountingjournals.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/liabilities/README.md b/lending/docs/sdks/liabilities/README.md index 4e02d2761..02682624e 100644 --- a/lending/docs/sdks/liabilities/README.md +++ b/lending/docs/sdks/liabilities/README.md @@ -43,8 +43,6 @@ s.liabilities.generate_loan_summary(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -59,6 +57,7 @@ s.liabilities.generate_loan_summary(request={ | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## generate_loan_transactions The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. @@ -90,8 +89,6 @@ s.liabilities.generate_loan_transactions(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,6 +103,7 @@ s.liabilities.generate_loan_transactions(request={ | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_loan_summary The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. @@ -139,8 +137,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -148,10 +144,10 @@ if res is not None: | `request` | [operations.GetLoanSummaryRequest](../../models/operations/getloansummaryrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.LoanSummary](../../models/shared/loansummary.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -159,6 +155,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_loan_transactions The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. @@ -192,8 +189,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -201,10 +196,10 @@ if res is not None: | `request` | [operations.ListLoanTransactionsRequest](../../models/operations/listloantransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.LoanTransactions](../../models/shared/loantransactions.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/loanwriteback/README.md b/lending/docs/sdks/loanwriteback/README.md index 2d4a785a2..26d8b4686 100644 --- a/lending/docs/sdks/loanwriteback/README.md +++ b/lending/docs/sdks/loanwriteback/README.md @@ -1,5 +1,2 @@ # LoanWriteback -(*loan_writeback*) - -### Available Operations - +(*loan_writeback*) \ No newline at end of file diff --git a/lending/docs/sdks/locations/README.md b/lending/docs/sdks/locations/README.md index 519a24e88..85ab70672 100644 --- a/lending/docs/sdks/locations/README.md +++ b/lending/docs/sdks/locations/README.md @@ -1,6 +1,8 @@ # Locations (*sales.locations*) +## Overview + ### Available Operations * [get](#get) - Get location @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceLocationRequest](../../models/operations/getcommercelocationrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceLocation](../../models/shared/commercelocation.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection. @@ -95,8 +96,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -104,10 +103,10 @@ if res is not None: | `request` | [operations.ListCommerceLocationsRequest](../../models/operations/listcommercelocationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceLocations](../../models/shared/commercelocations.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/managedata/README.md b/lending/docs/sdks/managedata/README.md index 0d340c0c5..08a0fabcc 100644 --- a/lending/docs/sdks/managedata/README.md +++ b/lending/docs/sdks/managedata/README.md @@ -1,6 +1,8 @@ # ManageData (*manage_data*) +## Overview + ### Available Operations * [get_status](#get_status) - Get data status @@ -32,8 +34,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -41,10 +41,10 @@ if res is not None: | `request` | [operations.GetDataStatusRequest](../../models/operations/getdatastatusrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[operations.GetDataStatusDataStatuses](../../models/operations/getdatastatusdatastatuses.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/metrics/README.md b/lending/docs/sdks/metrics/README.md index 58a9eca97..a2b0dbae9 100644 --- a/lending/docs/sdks/metrics/README.md +++ b/lending/docs/sdks/metrics/README.md @@ -1,6 +1,8 @@ # Metrics (*sales.metrics*) +## Overview + ### Available Operations * [get_customer_retention](#get_customer_retention) - Get customer retention metrics @@ -67,8 +69,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -76,10 +76,10 @@ if res is not None: | `request` | [operations.GetCommerceCustomerRetentionMetricsRequest](../../models/operations/getcommercecustomerretentionmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceReport](../../models/shared/commercereport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -87,6 +87,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_lifetime_value The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. @@ -141,8 +142,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -150,10 +149,10 @@ if res is not None: | `request` | [operations.GetCommerceLifetimeValueMetricsRequest](../../models/operations/getcommercelifetimevaluemetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceReport](../../models/shared/commercereport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -161,6 +160,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_revenue The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time. @@ -216,8 +216,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -225,10 +223,10 @@ if res is not None: | `request` | [operations.GetCommerceRevenueMetricsRequest](../../models/operations/getcommercerevenuemetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceReport](../../models/shared/commercereport.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/orders/README.md b/lending/docs/sdks/orders/README.md index da66ca5c2..14c82ed3c 100644 --- a/lending/docs/sdks/orders/README.md +++ b/lending/docs/sdks/orders/README.md @@ -1,6 +1,8 @@ # Orders (*sales.orders*) +## Overview + ### Available Operations * [get](#get) - Get order @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceOrderRequest](../../models/operations/getcommerceorderrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceOrder](../../models/shared/commerceorder.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceOrdersRequest](../../models/operations/listcommerceordersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceOrders](../../models/shared/commerceorders.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/paymentmethods/README.md b/lending/docs/sdks/paymentmethods/README.md index 666dd4fae..e5660c9b2 100644 --- a/lending/docs/sdks/paymentmethods/README.md +++ b/lending/docs/sdks/paymentmethods/README.md @@ -1,6 +1,8 @@ # PaymentMethods (*sales.payment_methods*) +## Overview + ### Available Operations * [get](#get) - Get payment method @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommercePaymentMethodRequest](../../models/operations/getcommercepaymentmethodrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommercePaymentMethod](../../models/shared/commercepaymentmethod.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommercePaymentMethodsRequest](../../models/operations/listcommercepaymentmethodsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommercePaymentMethods](../../models/shared/commercepaymentmethods.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/payments/README.md b/lending/docs/sdks/payments/README.md index 0b97115bf..fa4ffcbcb 100644 --- a/lending/docs/sdks/payments/README.md +++ b/lending/docs/sdks/payments/README.md @@ -1,6 +1,8 @@ # Payments (*accounts_receivable.payments*) +## Overview + ### Available Operations * [get](#get) - Get payment @@ -41,8 +43,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -50,10 +50,10 @@ if res is not None: | `request` | [operations.GetAccountingPaymentRequest](../../models/operations/getaccountingpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingPayment](../../models/shared/accountingpayment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -61,6 +61,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. @@ -97,8 +98,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -106,10 +105,10 @@ if res is not None: | `request` | [operations.ListAccountingPaymentsRequest](../../models/operations/listaccountingpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingPayments](../../models/shared/accountingpayments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/productcategories/README.md b/lending/docs/sdks/productcategories/README.md index 4e778d938..dfc46e4e8 100644 --- a/lending/docs/sdks/productcategories/README.md +++ b/lending/docs/sdks/productcategories/README.md @@ -1,6 +1,8 @@ # ProductCategories (*sales.product_categories*) +## Overview + ### Available Operations * [get](#get) - Get product category @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceProductCategoryRequest](../../models/operations/getcommerceproductcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceProductCategory](../../models/shared/commerceproductcategory.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceProductCategoriesRequest](../../models/operations/listcommerceproductcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceProductCategories](../../models/shared/commerceproductcategories.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/products/README.md b/lending/docs/sdks/products/README.md index a5a487d92..693918842 100644 --- a/lending/docs/sdks/products/README.md +++ b/lending/docs/sdks/products/README.md @@ -1,6 +1,8 @@ # Products (*sales.products*) +## Overview + ### Available Operations * [get](#get) - Get product @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetCommerceProductRequest](../../models/operations/getcommerceproductrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceProduct](../../models/shared/commerceproduct.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListCommerceProductsRequest](../../models/operations/listcommerceproductsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.CommerceProducts](../../models/shared/commerceproducts.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/profitandloss/README.md b/lending/docs/sdks/profitandloss/README.md index 2093659a1..2accbe461 100644 --- a/lending/docs/sdks/profitandloss/README.md +++ b/lending/docs/sdks/profitandloss/README.md @@ -1,6 +1,8 @@ # ProfitAndLoss (*financial_statements.profit_and_loss*) +## Overview + ### Available Operations * [get](#get) - Get profit and loss @@ -36,8 +38,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -45,10 +45,10 @@ if res is not None: | `request` | [operations.GetAccountingProfitAndLossRequest](../../models/operations/getaccountingprofitandlossrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingProfitAndLossReport](../../models/shared/accountingprofitandlossreport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -56,6 +56,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_categorized_accounts The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. @@ -86,8 +87,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -95,10 +94,10 @@ if res is not None: | `request` | [operations.GetCategorizedProfitAndLossStatementRequest](../../models/operations/getcategorizedprofitandlossstatementrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.EnhancedFinancialReport](../../models/shared/enhancedfinancialreport.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/pulloperations/README.md b/lending/docs/sdks/pulloperations/README.md index 4c8af76ad..3a99e02be 100644 --- a/lending/docs/sdks/pulloperations/README.md +++ b/lending/docs/sdks/pulloperations/README.md @@ -1,6 +1,8 @@ # PullOperations (*manage_data.pull_operations*) +## Overview + ### Available Operations * [get](#get) - Get pull operation @@ -34,8 +36,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -43,10 +43,10 @@ if res is not None: | `request` | [operations.GetPullOperationRequest](../../models/operations/getpulloperationrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PullOperation](../../models/shared/pulloperation.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -54,6 +54,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list Gets the pull operation history (datasets) for a given company. @@ -85,8 +86,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -94,10 +93,10 @@ if res is not None: | `request` | [operations.ListPullOperationsRequest](../../models/operations/listpulloperationsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PullOperations](../../models/shared/pulloperations.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/refresh/README.md b/lending/docs/sdks/refresh/README.md index 67cefe1cd..41173b41c 100644 --- a/lending/docs/sdks/refresh/README.md +++ b/lending/docs/sdks/refresh/README.md @@ -1,6 +1,8 @@ # Refresh (*manage_data.refresh*) +## Overview + ### Available Operations * [all_data_types](#all_data_types) - Refresh all data @@ -35,8 +37,6 @@ s.manage_data.refresh.all_data_types(request={ ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,6 +51,7 @@ s.manage_data.refresh.all_data_types(request={ | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## data_type Refreshes a given data type for a given company. @@ -81,8 +82,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -90,10 +89,10 @@ if res is not None: | `request` | [operations.RefreshDataTypeRequest](../../models/operations/refreshdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PullOperation](../../models/shared/pulloperation.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/reports/README.md b/lending/docs/sdks/reports/README.md index ca5cbc509..e7353bf99 100644 --- a/lending/docs/sdks/reports/README.md +++ b/lending/docs/sdks/reports/README.md @@ -1,6 +1,8 @@ # Reports (*accounts_receivable.reports*) +## Overview + ### Available Operations * [get_aged_creditors](#get_aged_creditors) - Aged creditors report @@ -39,8 +41,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -48,10 +48,10 @@ if res is not None: | `request` | [operations.GetAccountingAgedCreditorsReportRequest](../../models/operations/getaccountingagedcreditorsreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAgedCreditorReport](../../models/shared/accountingagedcreditorreport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -59,6 +59,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_aged_debtors Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. @@ -90,8 +91,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -99,10 +98,10 @@ if res is not None: | `request` | [operations.GetAccountingAgedDebtorsReportRequest](../../models/operations/getaccountingageddebtorsreportrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAgedDebtorReport](../../models/shared/accountingageddebtorreport.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -110,6 +109,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## is_aged_creditors_available Indicates whether the aged creditor report is available for the company. @@ -137,8 +137,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -146,10 +144,10 @@ if res is not None: | `request` | [operations.IsAgedCreditorsReportAvailableRequest](../../models/operations/isagedcreditorsreportavailablerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[bool](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -157,6 +155,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## is_aged_debtors_available Indicates whether the aged debtors report is available for the company. @@ -184,8 +183,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -193,10 +190,10 @@ if res is not None: | `request` | [operations.IsAgedDebtorsReportAvailableRequest](../../models/operations/isageddebtorsreportavailablerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[bool](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/sales/README.md b/lending/docs/sdks/sales/README.md index 3bba63af8..a6fae76b0 100644 --- a/lending/docs/sdks/sales/README.md +++ b/lending/docs/sdks/sales/README.md @@ -1,5 +1,2 @@ # Sales -(*sales*) - -### Available Operations - +(*sales*) \ No newline at end of file diff --git a/lending/docs/sdks/suppliers/README.md b/lending/docs/sdks/suppliers/README.md index 8e0f7684c..c5d281c71 100644 --- a/lending/docs/sdks/suppliers/README.md +++ b/lending/docs/sdks/suppliers/README.md @@ -1,6 +1,8 @@ # Suppliers (*accounts_payable.suppliers*) +## Overview + ### Available Operations * [download_attachment](#download_attachment) - Download supplier attachment @@ -44,8 +46,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -53,10 +53,10 @@ if res is not None: | `request` | [operations.DownloadAccountingSupplierAttachmentRequest](../../models/operations/downloadaccountingsupplierattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[httpx.Response](../../models/.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -64,6 +64,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get The *Get supplier* endpoint returns a single supplier for a given supplierId. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.GetAccountingSupplierRequest](../../models/operations/getaccountingsupplierrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingSupplier](../../models/shared/accountingsupplier.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -119,6 +118,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_attachment The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. @@ -154,8 +154,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -163,10 +161,10 @@ if res is not None: | `request` | [operations.GetAccountingSupplierAttachmentRequest](../../models/operations/getaccountingsupplierattachmentrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingAttachment](../../models/shared/accountingattachment.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -174,6 +172,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. @@ -210,8 +209,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -219,10 +216,10 @@ if res is not None: | `request` | [operations.ListAccountingSuppliersRequest](../../models/operations/listaccountingsuppliersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingSuppliers](../../models/shared/accountingsuppliers.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -230,6 +227,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list_attachments The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. @@ -264,8 +262,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -273,10 +269,10 @@ if res is not None: | `request` | [operations.ListAccountingSupplierAttachmentsRequest](../../models/operations/listaccountingsupplierattachmentsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.Attachments](../../models/shared/attachments.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/transactioncategories/README.md b/lending/docs/sdks/transactioncategories/README.md index c7d485381..f21f084cb 100644 --- a/lending/docs/sdks/transactioncategories/README.md +++ b/lending/docs/sdks/transactioncategories/README.md @@ -1,6 +1,8 @@ # TransactionCategories (*banking.transaction_categories*) +## Overview + ### Available Operations * [get](#get) - Get transaction category @@ -42,8 +44,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -51,10 +51,10 @@ if res is not None: | `request` | [operations.GetBankingTransactionCategoryRequest](../../models/operations/getbankingtransactioncategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingTransactionCategory](../../models/shared/bankingtransactioncategory.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -62,6 +62,7 @@ if res is not None: | errors.ErrorMessage | 401,402,403,404,409,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## list The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection. @@ -99,8 +100,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -108,10 +107,10 @@ if res is not None: | `request` | [operations.ListBankingTransactionCategoriesRequest](../../models/operations/listbankingtransactioncategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.BankingTransactionCategories](../../models/shared/bankingtransactioncategories.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/docs/sdks/transactions/README.md b/lending/docs/sdks/transactions/README.md index a82638fed..5b9729247 100644 --- a/lending/docs/sdks/transactions/README.md +++ b/lending/docs/sdks/transactions/README.md @@ -1,5 +1,2 @@ # Transactions -(*transactions*) - -### Available Operations - +(*transactions*) \ No newline at end of file diff --git a/lending/docs/sdks/transfers/README.md b/lending/docs/sdks/transfers/README.md index 74c0a7be8..69cac24d7 100644 --- a/lending/docs/sdks/transfers/README.md +++ b/lending/docs/sdks/transfers/README.md @@ -1,6 +1,8 @@ # Transfers (*loan_writeback.transfers*) +## Overview + ### Available Operations * [create](#create) - Create transfer @@ -82,8 +84,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -91,10 +91,10 @@ if res is not None: | `request` | [operations.CreateTransferRequest](../../models/operations/createtransferrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.AccountingCreateTransferResponse](../../models/shared/accountingcreatetransferresponse.md)** + ### Errors | Error Object | Status Code | Content Type | @@ -102,6 +102,7 @@ if res is not None: | errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | | errors.SDKError | 4xx-5xx | */* | + ## get_create_model The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. @@ -139,8 +140,6 @@ if res is not None: ``` - - ### Parameters | Parameter | Type | Required | Description | @@ -148,10 +147,10 @@ if res is not None: | `request` | [operations.GetCreateTransfersModelRequest](../../models/operations/getcreatetransfersmodelrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - ### Response **[shared.PushOption](../../models/shared/pushoption.md)** + ### Errors | Error Object | Status Code | Content Type | diff --git a/lending/gen.yaml b/lending/gen.yaml index 8450defb6..04f03d337 100644 --- a/lending/gen.yaml +++ b/lending/gen.yaml @@ -11,12 +11,11 @@ generation: oAuth2ClientCredentialsEnabled: false telemetryEnabled: true python: - version: 7.0.0 + version: 7.0.1 additionalDependencies: dev: {} - main: { - "python-dateutil": "2.9.0.post0" - } + main: + python-dateutil: 2.9.0.post0 author: Codat authors: - Speakeasy diff --git a/lending/poetry.lock b/lending/poetry.lock index 7d18ec6cc..b36c73e30 100644 --- a/lending/poetry.lock +++ b/lending/poetry.lock @@ -476,13 +476,13 @@ dev = ["twine (>=3.4.1)"] [[package]] name = "python-dateutil" -version = "2.8.2" +version = "2.9.0.post0" description = "Extensions to the standard Python datetime module" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" files = [ - {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, - {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, ] [package.dependencies] @@ -572,4 +572,4 @@ typing-extensions = ">=3.7.4" [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "47ddda92eccffe312633b78cc926be3fae0cfb283d29cc7b53adcdf224504721" +content-hash = "8241499b4043d68b62bfce97af2ee0a72dc3afcf679ccc2cc7f551f547d9d46f" diff --git a/lending/pyproject.toml b/lending/pyproject.toml index 296123f40..014cdbf69 100644 --- a/lending/pyproject.toml +++ b/lending/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "codat-lending" -version = "7.0.0" +version = "7.0.1" description = "Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features." authors = ["Speakeasy",] readme = "README-PYPI.md" @@ -22,7 +22,7 @@ eval-type-backport = "^0.2.0" httpx = "^0.27.0" jsonpath-python = "^1.0.6" pydantic = "~2.8.2" -python-dateutil = "2.8.2" +python-dateutil = "2.9.0.post0" typing-inspect = "^0.9.0" [tool.poetry.group.dev.dependencies] diff --git a/lending/src/codat_lending/sdkconfiguration.py b/lending/src/codat_lending/sdkconfiguration.py index 414484cc9..b447063f5 100644 --- a/lending/src/codat_lending/sdkconfiguration.py +++ b/lending/src/codat_lending/sdkconfiguration.py @@ -27,9 +27,9 @@ class SDKConfiguration: server_idx: Optional[int] = 0 language: str = "python" openapi_doc_version: str = "3.0.0" - sdk_version: str = "7.0.0" - gen_version: str = "2.402.5" - user_agent: str = "speakeasy-sdk/python 7.0.0 2.402.5 3.0.0 codat-lending" + sdk_version: str = "7.0.1" + gen_version: str = "2.404.0" + user_agent: str = "speakeasy-sdk/python 7.0.1 2.404.0 3.0.0 codat-lending" retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) timeout_ms: Optional[int] = None