@financeable/aggregation 0.10.0 → 0.11.0-alpha.1

package/docs/sdks/customeraddresses/README.md

@@ -0,0 +1,469 @@
+# CustomerAddresses
+(*customerAddresses*)
+
+## Overview
+
+### Available Operations
+
+* [customerAddressesList](#customeraddresseslist) - Get all addresses for a customer.
+* [customerAddressesCreate](#customeraddressescreate) - Create a new address for a customer.
+* [customerAddressesGet](#customeraddressesget) - Get an address by its ID.
+* [customerAddressesUpdate](#customeraddressesupdate) - Update an address.
+* [customerAddressesDelete](#customeraddressesdelete) - Delete an address.
+
+## customerAddressesList
+
+Get all addresses for a customer.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CustomerAddresses_list" method="get" path="/customers/{customerId}/addresses" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.customerAddresses.customerAddressesList({
+    customerId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { customerAddressesCustomerAddressesList } from "@financeable/aggregation/funcs/customerAddressesCustomerAddressesList.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await customerAddressesCustomerAddressesList(financeable, {
+    customerId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("customerAddressesCustomerAddressesList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CustomerAddressesListRequest](../../models/operations/customeraddresseslistrequest.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.CustomerAddressesListResponse](../../models/operations/customeraddresseslistresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## customerAddressesCreate
+
+Create a new address for a customer.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CustomerAddresses_create" method="post" path="/customers/{customerId}/addresses" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.customerAddresses.customerAddressesCreate({
+    customerId: "<id>",
+    requestBody: {
+      data: {
+        type: "addresses",
+        attributes: {
+          id: "12345678901",
+          addressType: "residential",
+          fullAddress: "42 Wallaby Way, Sydney NSW 2000",
+          city: "Sydney",
+          postCode: "2000",
+          streetAddress: "42 Wallaby Way",
+          addressLine2: "",
+          streetNumber: "42",
+          streetType: "Way",
+          street: "Wallaby",
+          state: "NSW",
+          country: "Australia",
+          status: "current",
+          monthsAt: 24,
+          yearsAt: 2,
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { customerAddressesCustomerAddressesCreate } from "@financeable/aggregation/funcs/customerAddressesCustomerAddressesCreate.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await customerAddressesCustomerAddressesCreate(financeable, {
+    customerId: "<id>",
+    requestBody: {
+      data: {
+        type: "addresses",
+        attributes: {
+          id: "12345678901",
+          addressType: "residential",
+          fullAddress: "42 Wallaby Way, Sydney NSW 2000",
+          city: "Sydney",
+          postCode: "2000",
+          streetAddress: "42 Wallaby Way",
+          addressLine2: "",
+          streetNumber: "42",
+          streetType: "Way",
+          street: "Wallaby",
+          state: "NSW",
+          country: "Australia",
+          status: "current",
+          monthsAt: 24,
+          yearsAt: 2,
+        },
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("customerAddressesCustomerAddressesCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CustomerAddressesCreateRequest](../../models/operations/customeraddressescreaterequest.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.CustomerAddressesCreateResponse](../../models/operations/customeraddressescreateresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## customerAddressesGet
+
+Get an address by its ID.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CustomerAddresses_get" method="get" path="/customers/{customerId}/addresses/{addressId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.customerAddresses.customerAddressesGet({
+    customerId: "<id>",
+    addressId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { customerAddressesCustomerAddressesGet } from "@financeable/aggregation/funcs/customerAddressesCustomerAddressesGet.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await customerAddressesCustomerAddressesGet(financeable, {
+    customerId: "<id>",
+    addressId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("customerAddressesCustomerAddressesGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CustomerAddressesGetRequest](../../models/operations/customeraddressesgetrequest.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.CustomerAddressesGetResponse](../../models/operations/customeraddressesgetresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## customerAddressesUpdate
+
+Update an address.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CustomerAddresses_update" method="patch" path="/customers/{customerId}/addresses/{addressId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.customerAddresses.customerAddressesUpdate({
+    customerId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      data: {
+        attributes: {
+          id: "12345678901",
+          addressType: "residential",
+          fullAddress: "42 Wallaby Way, Sydney NSW 2000",
+          city: "Sydney",
+          postCode: "2000",
+          streetAddress: "42 Wallaby Way",
+          addressLine2: "",
+          streetNumber: "42",
+          streetType: "Way",
+          street: "Wallaby",
+          state: "NSW",
+          country: "Australia",
+          status: "current",
+          monthsAt: 24,
+          yearsAt: 2,
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { customerAddressesCustomerAddressesUpdate } from "@financeable/aggregation/funcs/customerAddressesCustomerAddressesUpdate.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await customerAddressesCustomerAddressesUpdate(financeable, {
+    customerId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      data: {
+        attributes: {
+          id: "12345678901",
+          addressType: "residential",
+          fullAddress: "42 Wallaby Way, Sydney NSW 2000",
+          city: "Sydney",
+          postCode: "2000",
+          streetAddress: "42 Wallaby Way",
+          addressLine2: "",
+          streetNumber: "42",
+          streetType: "Way",
+          street: "Wallaby",
+          state: "NSW",
+          country: "Australia",
+          status: "current",
+          monthsAt: 24,
+          yearsAt: 2,
+        },
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("customerAddressesCustomerAddressesUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CustomerAddressesUpdateRequest](../../models/operations/customeraddressesupdaterequest.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.CustomerAddressesUpdateResponse](../../models/operations/customeraddressesupdateresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## customerAddressesDelete
+
+Delete an address.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="CustomerAddresses_delete" method="delete" path="/customers/{customerId}/addresses/{addressId}" -->
+```typescript
+import { Financeable } from "@financeable/aggregation";
+
+const financeable = new Financeable({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const result = await financeable.customerAddresses.customerAddressesDelete({
+    customerId: "<id>",
+    addressId: "<id>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { FinanceableCore } from "@financeable/aggregation/core.js";
+import { customerAddressesCustomerAddressesDelete } from "@financeable/aggregation/funcs/customerAddressesCustomerAddressesDelete.js";
+
+// Use `FinanceableCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const financeable = new FinanceableCore({
+  clientCredentials: process.env["FINANCEABLE_CLIENT_CREDENTIALS"] ?? "",
+});
+
+async function run() {
+  const res = await customerAddressesCustomerAddressesDelete(financeable, {
+    customerId: "<id>",
+    addressId: "<id>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("customerAddressesCustomerAddressesDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CustomerAddressesDeleteRequest](../../models/operations/customeraddressesdeleterequest.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.CustomerAddressesDeleteResponseBody](../../models/operations/customeraddressesdeleteresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |