orb-billing 1.19.2 → 1.20.0

package/docs/sdks/customer/README.md

@@ -117,38 +117,41 @@ In order to overwrite timeframes with a very large number of events, we suggest
 
 ```typescript
 import { Orb } from "orb-billing";
-import { AmendUsageResponse } from "orb-billing/dist/sdk/models/operations";
+import { AmendUsageRequest } from "orb-billing/dist/sdk/models/operations";
+import { UpdateEvent, UpdateEventProperties } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "Steel";
+const updateEvent: UpdateEvent = {
+  eventName: "channels",
+  properties: {},
+  timestamp: new Date("2020-12-09T16:09:53Z"),
+};
+const timeframeEnd: Date = new Date("2022-10-24T01:13:02.226Z");
+const timeframeStart: Date = new Date("2022-08-07T07:39:12.946Z");
+
+  const res = await sdk.customer.amend(customerId, updateEvent, timeframeEnd, timeframeStart);
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.amend({
-  updateEvent: {
-    customerId: "driver",
-    eventName: "bypass",
-    externalCustomerId: "Kids",
-    properties: {},
-    timestamp: new Date("2020-12-09T16:09:53Z"),
-  },
-  customerId: "previous enchanting",
-  timeframeEnd: new Date("2021-03-06T03:20:54.516Z"),
-  timeframeStart: new Date("2022-10-30T03:17:34.038Z"),
-}).then((res: AmendUsageResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `request`                                                                    | [operations.AmendUsageRequest](../../models/operations/amendusagerequest.md) | :heavy_check_mark:                                                           | The request object to use for the request.                                   |
-| `config`                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                 | :heavy_minus_sign:                                                           | Available config options for making requests.                                |
+| Parameter                                                                                     | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                  | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `updateEvent`                                                                                 | [shared.UpdateEvent](../../models/shared/updateevent.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `timeframeEnd`                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `timeframeStart`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `config`                                                                                      | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                  | :heavy_minus_sign:                                                                            | Available config options for making requests.                                                 |
 
 
 ### Response
@@ -239,38 +242,41 @@ In order to overwrite timeframes with a very large number of events, we suggest
 
 ```typescript
 import { Orb } from "orb-billing";
-import { AmendUsageExternalCustomerIdResponse } from "orb-billing/dist/sdk/models/operations";
+import { AmendUsageExternalCustomerIdRequest } from "orb-billing/dist/sdk/models/operations";
+import { UpdateEvent, UpdateEventProperties } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalCustomerId: string = "Awesome";
+const updateEvent: UpdateEvent = {
+  eventName: "Assurance Highway Gloves",
+  properties: {},
+  timestamp: new Date("2020-12-09T16:09:53Z"),
+};
+const timeframeEnd: Date = new Date("2022-11-04T12:23:37.450Z");
+const timeframeStart: Date = new Date("2021-02-05T19:10:39.767Z");
+
+  const res = await sdk.customer.amendByExternalId(externalCustomerId, updateEvent, timeframeEnd, timeframeStart);
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.amendByExternalId({
-  updateEvent: {
-    customerId: "woman",
-    eventName: "Orchestrator",
-    externalCustomerId: "Highway Gloves Androgynous",
-    properties: {},
-    timestamp: new Date("2020-12-09T16:09:53Z"),
-  },
-  externalCustomerId: "Hatchback Gloves powerless",
-  timeframeEnd: new Date("2021-05-18T15:51:03.859Z"),
-  timeframeStart: new Date("2022-10-03T18:15:53.258Z"),
-}).then((res: AmendUsageExternalCustomerIdResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                        | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                        | [operations.AmendUsageExternalCustomerIdRequest](../../models/operations/amendusageexternalcustomeridrequest.md) | :heavy_check_mark:                                                                                               | The request object to use for the request.                                                                       |
-| `config`                                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                     | :heavy_minus_sign:                                                                                               | Available config options for making requests.                                                                    |
+| Parameter                                                                                     | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `externalCustomerId`                                                                          | *string*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `updateEvent`                                                                                 | [shared.UpdateEvent](../../models/shared/updateevent.md)                                      | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `timeframeEnd`                                                                                | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `timeframeStart`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign:                                                                            | N/A                                                                                           |
+| `config`                                                                                      | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                  | :heavy_minus_sign:                                                                            | Available config options for making requests.                                                 |
 
 
 ### Response
@@ -295,67 +301,46 @@ This endpoint is critical in the following Orb functionality:
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateCustomerResponse } from "orb-billing/dist/sdk/models/operations";
 import { NewCustomerPaymentProvider } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
 
-sdk.customer.create({
-  accountingSyncConfiguration: {
-    accountingProviders: [
-      {
-        externalProviderId: "bluetooth Extended",
-        providerType: "blue",
-      },
+  const res = await sdk.customer.create({
+    accountingSyncConfiguration: {
+      accountingProviders: [
+        {
+          externalProviderId: "bluetooth Extended",
+          providerType: "blue",
+        },
+      ],
+    },
+    additionalEmails: [
+      "shred",
     ],
-    excluded: false,
-  },
-  additionalEmails: [
-    "shred",
-  ],
-  autoCollection: false,
-  billingAddress: {
-    city: "Fort Silas",
-    country: "Afghanistan",
-    line1: "orange Northwest",
-    line2: "SUV quantify Polestar",
-    postalCode: "96302",
-    state: "South Intelligent Fish",
-  },
-  currency: "Barbados Dollar",
-  email: "Enoch41@hotmail.com",
-  emailDelivery: false,
-  externalCustomerId: "Metal",
-  metadata: {},
-  name: "Direct metrics",
-  paymentProvider: NewCustomerPaymentProvider.Quickbooks,
-  paymentProviderId: "Interactions Senior Mouse",
-  reportingConfiguration: {
-    exempt: false,
-  },
-  shippingAddress: {
-    city: "Fort Juddborough",
-    country: "Anguilla",
-    line1: "Investor",
-    line2: "azure Dollar",
-    postalCode: "72679",
-    state: "Sausages",
-  },
-  taxId: {
-    country: "Sao Tome and Principe",
-    type: "City meanwhile incompatible",
-    value: "Folk South digital",
-  },
-  timezone: "Europe/Ljubljana",
-}).then((res: CreateCustomerResponse) => {
+    billingAddress: {},
+    email: "Valerie45@yahoo.com",
+    metadata: {},
+    name: "evolve",
+    reportingConfiguration: {
+      exempt: false,
+    },
+    shippingAddress: {},
+    taxId: {
+      country: "Portugal",
+      type: "SUV quantify Polestar",
+      value: "physical Ameliorated",
+    },
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -380,35 +365,36 @@ transaction.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreateCustomerBalanceTransactionResponse } from "orb-billing/dist/sdk/models/operations";
-import { NewCustomerBalanceTransactionType } from "orb-billing/dist/sdk/models/shared";
+import { CreateCustomerBalanceTransactionRequest } from "orb-billing/dist/sdk/models/operations";
+import { NewCustomerBalanceTransaction, NewCustomerBalanceTransactionType } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "Intelligent";
+const newCustomerBalanceTransaction: NewCustomerBalanceTransaction = {
+  amount: "233.83",
+  type: NewCustomerBalanceTransactionType.Decrement,
+};
+
+  const res = await sdk.customer.createBalanceTransaction(customerId, newCustomerBalanceTransaction);
 
-sdk.customer.createBalanceTransaction({
-  newCustomerBalanceTransaction: {
-    amount: "221.39",
-    description: "Diverse contextually-based website",
-    type: NewCustomerBalanceTransactionType.Increment,
-  },
-  customerId: "Northwest",
-}).then((res: CreateCustomerBalanceTransactionResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                                | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              |
-| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                | [operations.CreateCustomerBalanceTransactionRequest](../../models/operations/createcustomerbalancetransactionrequest.md) | :heavy_check_mark:                                                                                                       | The request object to use for the request.                                                                               |
-| `config`                                                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                             | :heavy_minus_sign:                                                                                                       | Available config options for making requests.                                                                            |
+| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `customerId`                                                                                 | *string*                                                                                     | :heavy_check_mark:                                                                           | N/A                                                                                          |
+| `newCustomerBalanceTransaction`                                                              | [shared.NewCustomerBalanceTransaction](../../models/shared/newcustomerbalancetransaction.md) | :heavy_minus_sign:                                                                           | N/A                                                                                          |
+| `config`                                                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                 | :heavy_minus_sign:                                                                           | Available config options for making requests.                                                |
 
 
 ### Response
@@ -436,29 +422,30 @@ On successful processing, this returns an empty dictionary (`{}`) in the API.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { DeleteCustomerResponse } from "orb-billing/dist/sdk/models/operations";
+import { DeleteCustomerRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "program";
+
+  const res = await sdk.customer.delete(customerId);
 
-sdk.customer.delete({
-  customerId: "Van complexity",
-}).then((res: DeleteCustomerResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                            | Type                                                                                 | Required                                                                             | Description                                                                          |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `request`                                                                            | [operations.DeleteCustomerRequest](../../models/operations/deletecustomerrequest.md) | :heavy_check_mark:                                                                   | The request object to use for the request.                                           |
-| `config`                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                         | :heavy_minus_sign:                                                                   | Available config options for making requests.                                        |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `customerId`                                                 | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -477,29 +464,30 @@ See the [Customer resource](../guides/core-concepts.mdx#customer) for a full dis
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCustomerResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchCustomerRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const customerId: string = "grateful";
+
+  const res = await sdk.customer.fetch(customerId);
 
-sdk.customer.fetch({
-  customerId: "Total Honda Southeast",
-}).then((res: FetchCustomerResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                          | Type                                                                               | Required                                                                           | Description                                                                        |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `request`                                                                          | [operations.FetchCustomerRequest](../../models/operations/fetchcustomerrequest.md) | :heavy_check_mark:                                                                 | The request object to use for the request.                                         |
-| `config`                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                       | :heavy_minus_sign:                                                                 | Available config options for making requests.                                      |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `customerId`                                                 | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -518,29 +506,30 @@ Note that the resource and semantics of this endpoint exactly mirror [Get Custom
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCustomerExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchCustomerExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalCustomerId: string = "Technician";
+
+  const res = await sdk.customer.fetchByExternalId(externalCustomerId);
 
-sdk.customer.fetchByExternalId({
-  externalCustomerId: "Loan Gasoline ping",
-}).then((res: FetchCustomerExternalIdResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.FetchCustomerExternalIdRequest](../../models/operations/fetchcustomerexternalidrequest.md) | :heavy_check_mark:                                                                                     | The request object to use for the request.                                                             |
-| `config`                                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                           | :heavy_minus_sign:                                                                                     | Available config options for making requests.                                                          |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalCustomerId`                                         | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -658,25 +647,25 @@ When a price uses matrix pricing, it's important to view costs grouped by those
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchCustomerCostsResponse, FetchCustomerCostsViewModeViewMode } from "orb-billing/dist/sdk/models/operations";
+import { FetchCustomerCostsViewModeViewMode } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.customer.fetchCosts({
+    customerId: "disintermediate",
+    timeframeEnd: new Date("2022-03-01T05:00:00Z"),
+    timeframeStart: new Date("2022-02-01T05:00:00Z"),
+  });
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.fetchCosts({
-  customerId: "disintermediate",
-  groupBy: "Coupe North Handmade",
-  timeframeEnd: new Date("2022-03-01T05:00:00Z"),
-  timeframeStart: new Date("2022-02-01T05:00:00Z"),
-  viewMode: FetchCustomerCostsViewModeViewMode.Periodic,
-}).then((res: FetchCustomerCostsResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -802,28 +791,25 @@ When a price uses matrix pricing, it's important to view costs grouped by those
 
 ```typescript
 import { Orb } from "orb-billing";
-import {
-  FetchCustomerCostsExternalIdResponse,
-  FetchCustomerCostsExternalIdViewModeViewMode,
-} from "orb-billing/dist/sdk/models/operations";
+import { FetchCustomerCostsExternalIdViewModeViewMode } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.customer.fetchCostsByExternalId({
+    externalCustomerId: "TLS Gadolinium Music",
+    timeframeEnd: new Date("2022-03-01T05:00:00Z"),
+    timeframeStart: new Date("2022-02-01T05:00:00Z"),
+  });
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.fetchCostsByExternalId({
-  externalCustomerId: "TLS Gadolinium Music",
-  groupBy: "Sedan Tuna",
-  timeframeEnd: new Date("2022-03-01T05:00:00Z"),
-  timeframeStart: new Date("2022-02-01T05:00:00Z"),
-  viewMode: FetchCustomerCostsExternalIdViewModeViewMode.Periodic,
-}).then((res: FetchCustomerCostsExternalIdResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -851,26 +837,20 @@ See [Customer](../guides/concepts#customer) for an overview of the customer mode
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListCustomersResponse } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.list({
-  createdAtGt: new Date("2023-04-22T14:13:10.937Z"),
-  createdAtGte: new Date("2021-04-20T09:15:20.369Z"),
-  createdAtLt: new Date("2022-08-23T06:18:16.401Z"),
-  createdAtLte: new Date("2021-10-10T03:01:48.624Z"),
-  cursor: "Canada that orchid",
-  limit: 282238,
-}).then((res: ListCustomersResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.customer.list({});
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -915,27 +895,22 @@ forwarding payment to the gateway.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListBalanceTransactionsResponse } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.listBalanceTransactions({
-  cursor: "than",
-  customerId: "Facilitator extension",
-  limit: 717443,
-  operationTimeGt: new Date("2021-01-05T14:12:58.642Z"),
-  operationTimeGte: new Date("2021-07-29T02:13:45.075Z"),
-  operationTimeLt: new Date("2021-01-31T23:25:30.251Z"),
-  operationTimeLte: new Date("2023-04-23T18:28:37.185Z"),
-}).then((res: ListBalanceTransactionsResponse) => {
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.customer.listBalanceTransactions({
+    customerId: "than",
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -962,77 +937,65 @@ endpoint exactly mirror [Update Customer](update-customer).
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UpdateCustomerExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
-import { EditCustomerPaymentProvider } from "orb-billing/dist/sdk/models/shared";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.updateByExternalId({
-  editCustomer: {
-    accountingSyncConfiguration: {
-      accountingProviders: [
-        {
-          externalProviderId: "Concrete Extended Rock",
-          providerType: "Rap showboat",
-        },
-      ],
-      excluded: false,
+import { UpdateCustomerExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
+import {
+  AccountingProviderConfig,
+  AddressInput,
+  CustomerTaxId,
+  EditCustomer,
+  EditCustomerMetadata,
+  EditCustomerPaymentProvider,
+  NewAccountingSyncConfiguration,
+  NewReportingConfiguration,
+} from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
     },
-    additionalEmails: [
-      "Peso",
+  });
+const externalCustomerId: string = "Bicycle";
+const editCustomer: EditCustomer = {
+  accountingSyncConfiguration: {
+    accountingProviders: [
+      {
+        externalProviderId: "Roselyn",
+        providerType: "Lesotho Rap",
+      },
     ],
-    autoCollection: false,
-    billingAddress: {
-      city: "Biankafurt",
-      country: "Northern Mariana Islands",
-      line1: "invoice",
-      line2: "invoice web",
-      postalCode: "37946-8361",
-      state: "Wagon",
-    },
-    currency: "Namibia Dollar",
-    email: "Van84@hotmail.com",
-    emailDelivery: false,
-    externalCustomerId: "Home",
-    metadata: {},
-    name: "grey",
-    paymentProvider: EditCustomerPaymentProvider.BillCom,
-    paymentProviderId: "composite",
-    reportingConfiguration: {
-      exempt: false,
-    },
-    shippingAddress: {
-      city: "East Kenna",
-      country: "Monaco",
-      line1: "Investment",
-      line2: "bypass Tactics",
-      postalCode: "39092",
-      state: "Steel",
-    },
-    taxId: {
-      country: "Heard Island and McDonald Islands",
-      type: "Producer",
-      value: "Jannie",
-    },
   },
-  externalCustomerId: "mobile",
-}).then((res: UpdateCustomerExternalIdResponse) => {
+  additionalEmails: [
+    "showboat",
+  ],
+  billingAddress: {},
+  metadata: {},
+  reportingConfiguration: {
+    exempt: false,
+  },
+  shippingAddress: {},
+  taxId: {
+    country: "Isle of Man",
+    type: "tesla",
+    value: "Branding",
+  },
+};
+
+  const res = await sdk.customer.updateByExternalId(externalCustomerId, editCustomer);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                                | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                | [operations.UpdateCustomerExternalIdRequest](../../models/operations/updatecustomerexternalidrequest.md) | :heavy_check_mark:                                                                                       | The request object to use for the request.                                                               |
-| `config`                                                                                                 | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                             | :heavy_minus_sign:                                                                                       | Available config options for making requests.                                                            |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalCustomerId`                                         | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `editCustomer`                                               | [shared.EditCustomer](../../models/shared/editcustomer.md)   | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response
@@ -1050,77 +1013,65 @@ This endpoint can be used to update the `payment_provider`, `payment_provider_id
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UpdateCustomerResponse } from "orb-billing/dist/sdk/models/operations";
-import { EditCustomerPaymentProvider } from "orb-billing/dist/sdk/models/shared";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.customer.updateCustomer({
-  editCustomer: {
-    accountingSyncConfiguration: {
-      accountingProviders: [
-        {
-          externalProviderId: "Electric",
-          providerType: "Mobility whitewash",
-        },
-      ],
-      excluded: false,
+import { UpdateCustomerRequest } from "orb-billing/dist/sdk/models/operations";
+import {
+  AccountingProviderConfig,
+  AddressInput,
+  CustomerTaxId,
+  EditCustomer,
+  EditCustomerMetadata,
+  EditCustomerPaymentProvider,
+  NewAccountingSyncConfiguration,
+  NewReportingConfiguration,
+} from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
     },
-    additionalEmails: [
-      "Southeast",
+  });
+const customerId: string = "Gibraltar";
+const editCustomer: EditCustomer = {
+  accountingSyncConfiguration: {
+    accountingProviders: [
+      {
+        externalProviderId: "Electric",
+        providerType: "Mobility whitewash",
+      },
     ],
-    autoCollection: false,
-    billingAddress: {
-      city: "Daynastad",
-      country: "Dominican Republic",
-      line1: "Car Rufiyaa",
-      line2: "deposit synergize",
-      postalCode: "02403",
-      state: "oblong reckless Molybdenum",
-    },
-    currency: "UIC-Franc",
-    email: "Taryn87@gmail.com",
-    emailDelivery: false,
-    externalCustomerId: "circuit Account",
-    metadata: {},
-    name: "South circumstance Corporate",
-    paymentProvider: EditCustomerPaymentProvider.Quickbooks,
-    paymentProviderId: "GB female well",
-    reportingConfiguration: {
-      exempt: false,
-    },
-    shippingAddress: {
-      city: "New Estelleburgh",
-      country: "Cape Verde",
-      line1: "dole payment",
-      line2: "Durham Funk",
-      postalCode: "54768-2343",
-      state: "plum bus Tuna",
-    },
-    taxId: {
-      country: "Italy",
-      type: "wherever Molybdenum",
-      value: "SUV Lesotho",
-    },
   },
-  customerId: "Global Hop Pine",
-}).then((res: UpdateCustomerResponse) => {
+  additionalEmails: [
+    "Southeast",
+  ],
+  billingAddress: {},
+  metadata: {},
+  reportingConfiguration: {
+    exempt: false,
+  },
+  shippingAddress: {},
+  taxId: {
+    country: "Luxembourg",
+    type: "program",
+    value: "Car Rufiyaa",
+  },
+};
+
+  const res = await sdk.customer.updateCustomer(customerId, editCustomer);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                            | Type                                                                                 | Required                                                                             | Description                                                                          |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `request`                                                                            | [operations.UpdateCustomerRequest](../../models/operations/updatecustomerrequest.md) | :heavy_check_mark:                                                                   | The request object to use for the request.                                           |
-| `config`                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                         | :heavy_minus_sign:                                                                   | Available config options for making requests.                                        |
+| Parameter                                                    | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `customerId`                                                 | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `editCustomer`                                               | [shared.EditCustomer](../../models/shared/editcustomer.md)   | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response