@apideck/unify 0.29.8 → 0.30.0

package/docs/sdks/bankaccounts/README.md

@@ -0,0 +1,564 @@
+# BankAccounts
+(*accounting.bankAccounts*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List Bank Accounts
+* [create](#create) - Create Bank Account
+* [get](#get) - Get Bank Account
+* [update](#update) - Update Bank Account
+* [delete](#delete) - Delete Bank Account
+
+## list
+
+List Bank Accounts
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="accounting.bankAccountsAll" method="get" path="/accounting/bank-accounts" -->
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await apideck.accounting.bankAccounts.list({
+    serviceId: "salesforce",
+    filter: {
+      name: "Main Operating",
+      status: "active",
+    },
+    sort: {},
+    passThrough: {
+      "search": "San Francisco",
+    },
+    fields: "id,updated_at",
+  });
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { accountingBankAccountsList } from "@apideck/unify/funcs/accountingBankAccountsList.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await accountingBankAccountsList(apideck, {
+    serviceId: "salesforce",
+    filter: {
+      name: "Main Operating",
+      status: "active",
+    },
+    sort: {},
+    passThrough: {
+      "search": "San Francisco",
+    },
+    fields: "id,updated_at",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
+    console.log(page);
+  }
+  } else {
+    console.log("accountingBankAccountsList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingBankAccountsAllRequest](../../models/operations/accountingbankaccountsallrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingBankAccountsAllResponse](../../models/operations/accountingbankaccountsallresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## create
+
+Create Bank Account
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="accounting.bankAccountsAdd" method="post" path="/accounting/bank-accounts" -->
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await apideck.accounting.bankAccounts.create({
+    serviceId: "salesforce",
+    accountingBankAccount: {
+      displayId: "BA-001",
+      name: "Main Operating Account",
+      accountNumber: "1234567890",
+      accountType: "checking",
+      bankName: "Chase Bank",
+      currency: "USD",
+      balance: 25000,
+      availableBalance: 24500,
+      overdraftLimit: 5000,
+      routingNumber: "021000021",
+      iban: "GB33BUKB20201555555555",
+      bic: "CHASUS33",
+      bsbNumber: "062-001",
+      branchIdentifier: "001",
+      bankCode: "BNH",
+      country: "US",
+      status: "active",
+      description: "Primary operating account for daily transactions",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { accountingBankAccountsCreate } from "@apideck/unify/funcs/accountingBankAccountsCreate.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await accountingBankAccountsCreate(apideck, {
+    serviceId: "salesforce",
+    accountingBankAccount: {
+      displayId: "BA-001",
+      name: "Main Operating Account",
+      accountNumber: "1234567890",
+      accountType: "checking",
+      bankName: "Chase Bank",
+      currency: "USD",
+      balance: 25000,
+      availableBalance: 24500,
+      overdraftLimit: 5000,
+      routingNumber: "021000021",
+      iban: "GB33BUKB20201555555555",
+      bic: "CHASUS33",
+      bsbNumber: "062-001",
+      branchIdentifier: "001",
+      bankCode: "BNH",
+      country: "US",
+      status: "active",
+      description: "Primary operating account for daily transactions",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accountingBankAccountsCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingBankAccountsAddRequest](../../models/operations/accountingbankaccountsaddrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingBankAccountsAddResponse](../../models/operations/accountingbankaccountsaddresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## get
+
+Get Bank Account
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="accounting.bankAccountsOne" method="get" path="/accounting/bank-accounts/{id}" -->
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await apideck.accounting.bankAccounts.get({
+    id: "<id>",
+    serviceId: "salesforce",
+    fields: "id,updated_at",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { accountingBankAccountsGet } from "@apideck/unify/funcs/accountingBankAccountsGet.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await accountingBankAccountsGet(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+    fields: "id,updated_at",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accountingBankAccountsGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingBankAccountsOneRequest](../../models/operations/accountingbankaccountsonerequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingBankAccountsOneResponse](../../models/operations/accountingbankaccountsoneresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## update
+
+Update Bank Account
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="accounting.bankAccountsUpdate" method="patch" path="/accounting/bank-accounts/{id}" -->
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await apideck.accounting.bankAccounts.update({
+    id: "<id>",
+    serviceId: "salesforce",
+    accountingBankAccount: {
+      displayId: "BA-001",
+      name: "Main Operating Account",
+      accountNumber: "1234567890",
+      accountType: "checking",
+      bankName: "Chase Bank",
+      currency: "USD",
+      balance: 25000,
+      availableBalance: 24500,
+      overdraftLimit: 5000,
+      routingNumber: "021000021",
+      iban: "GB33BUKB20201555555555",
+      bic: "CHASUS33",
+      bsbNumber: "062-001",
+      branchIdentifier: "001",
+      bankCode: "BNH",
+      country: "US",
+      status: "active",
+      description: "Primary operating account for daily transactions",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { accountingBankAccountsUpdate } from "@apideck/unify/funcs/accountingBankAccountsUpdate.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await accountingBankAccountsUpdate(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+    accountingBankAccount: {
+      displayId: "BA-001",
+      name: "Main Operating Account",
+      accountNumber: "1234567890",
+      accountType: "checking",
+      bankName: "Chase Bank",
+      currency: "USD",
+      balance: 25000,
+      availableBalance: 24500,
+      overdraftLimit: 5000,
+      routingNumber: "021000021",
+      iban: "GB33BUKB20201555555555",
+      bic: "CHASUS33",
+      bsbNumber: "062-001",
+      branchIdentifier: "001",
+      bankCode: "BNH",
+      country: "US",
+      status: "active",
+      description: "Primary operating account for daily transactions",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accountingBankAccountsUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingBankAccountsUpdateRequest](../../models/operations/accountingbankaccountsupdaterequest.md)                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingBankAccountsUpdateResponse](../../models/operations/accountingbankaccountsupdateresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## delete
+
+Delete Bank Account
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="accounting.bankAccountsDelete" method="delete" path="/accounting/bank-accounts/{id}" -->
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await apideck.accounting.bankAccounts.delete({
+    id: "<id>",
+    serviceId: "salesforce",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { ApideckCore } from "@apideck/unify/core.js";
+import { accountingBankAccountsDelete } from "@apideck/unify/funcs/accountingBankAccountsDelete.js";
+
+// Use `ApideckCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const apideck = new ApideckCore({
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await accountingBankAccountsDelete(apideck, {
+    id: "<id>",
+    serviceId: "salesforce",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accountingBankAccountsDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingBankAccountsDeleteRequest](../../models/operations/accountingbankaccountsdeleterequest.md)                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingBankAccountsDeleteResponse](../../models/operations/accountingbankaccountsdeleteresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |