orb-billing 1.19.5 → 1.20.0

package/docs/sdks/plan/README.md

@@ -24,29 +24,27 @@ This endpoint allows creation of plans including their prices.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreatePlanResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.plan.create({
-  currency: "Lithuanian Litas",
-  defaultInvoiceMemo: "Configuration Money",
-  externalPlanId: "Cambridgeshire grey technology",
-  metadata: {},
-  name: "deposit",
-  netTerms: 301510,
-  prices: [
-    {},
-  ],
-}).then((res: CreatePlanResponse) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.plan.create({
+    currency: "Lithuanian Litas",
+    metadata: {},
+    name: "Configuration Money",
+    prices: [
+      {},
+    ],
+  });
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -82,29 +80,30 @@ all prices across all phases.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchPlanResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchPlanRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const planId: string = "grateful";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.plan.fetch(planId);
 
-sdk.plan.fetch({
-  planId: "Total Honda Southeast",
-}).then((res: FetchPlanResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                  | Type                                                                       | Required                                                                   | Description                                                                |
-| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
-| `request`                                                                  | [operations.FetchPlanRequest](../../models/operations/fetchplanrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `planId`                                                     | *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
@@ -128,29 +127,30 @@ of price types can be found in the [Price schema](../guides/concepts#plan-and-pr
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchPlanExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchPlanExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalPlanId: string = "Technician";
+
+  const res = await sdk.plan.fetchByExternalId(externalPlanId);
 
-sdk.plan.fetchByExternalId({
-  externalPlanId: "Loan Gasoline ping",
-}).then((res: FetchPlanExternalIdResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.FetchPlanExternalIdRequest](../../models/operations/fetchplanexternalidrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalPlanId`                                             | *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
@@ -169,27 +169,21 @@ which lets the caller retrieve the next page of results if they exist.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListPlansResponse, ListPlansStatusStatus } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.plan.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,
-  status: ListPlansStatusStatus.Active,
-}).then((res: ListPlansResponse) => {
+import { ListPlansStatusStatus } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.plan.list({});
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -215,33 +209,35 @@ Other fields on a customer are currently immutable.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UpdatePlanResponse } from "orb-billing/dist/sdk/models/operations";
+import { UpdatePlanRequest } from "orb-billing/dist/sdk/models/operations";
+import { EditPlan, EditPlanMetadata } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const planId: string = "hie";
+const editPlan: EditPlan = {
+  metadata: {},
+};
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.plan.updatePlan(planId, editPlan);
 
-sdk.plan.updatePlan({
-  editPlan: {
-    externalPlanId: "Credit Nihonium virtual",
-    metadata: {},
-  },
-  planId: "until up",
-}).then((res: UpdatePlanResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `request`                                                                    | [operations.UpdatePlanRequest](../../models/operations/updateplanrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `planId`                                                     | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `editPlan`                                                   | [shared.EditPlan](../../models/shared/editplan.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
@@ -265,33 +261,35 @@ A detailed explanation of price types can be found in the [Price schema](../guid
 
 ```typescript
 import { Orb } from "orb-billing";
-import { UpdatePlanExternalResponse } from "orb-billing/dist/sdk/models/operations";
+import { UpdatePlanExternalRequest } from "orb-billing/dist/sdk/models/operations";
+import { EditPlan, EditPlanMetadata } from "orb-billing/dist/sdk/models/shared";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalPlanId: string = "morph";
+const editPlan: EditPlan = {
+  metadata: {},
+};
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.plan.updatePlanExternal(externalPlanId, editPlan);
 
-sdk.plan.updatePlanExternal({
-  editPlan: {
-    externalPlanId: "Modern",
-    metadata: {},
-  },
-  externalPlanId: "Bedfordshire Rap",
-}).then((res: UpdatePlanExternalResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                    | Type                                                                                         | Required                                                                                     | Description                                                                                  |
-| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| `request`                                                                                    | [operations.UpdatePlanExternalRequest](../../models/operations/updateplanexternalrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalPlanId`                                             | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `editPlan`                                                   | [shared.EditPlan](../../models/shared/editplan.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

package/docs/sdks/price/README.md

@@ -225,60 +225,20 @@ different price model configurations possible in this endpoint.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { CreatePriceResponse } from "orb-billing/dist/sdk/models/operations";
-import {
-  NewBpsPriceCadence,
-  NewBpsPriceModelType,
-  NewBulkBpsPriceCadence,
-  NewBulkBpsPriceModelType,
-  NewBulkPriceCadence,
-  NewBulkPriceModelType,
-  NewMatrixPriceCadence,
-  NewMatrixPriceModelType,
-  NewPackagePriceCadence,
-  NewPackagePriceModelType,
-  NewPackageWithAllocationPriceCadence,
-  NewPackageWithAllocationPriceModelType,
-  NewThresholdTotalAmountPriceCadence,
-  NewThresholdTotalAmountPriceModelType,
-  NewTieredBpsPriceCadence,
-  NewTieredBpsPriceModelType,
-  NewTieredPackagePriceCadence,
-  NewTieredPackagePriceModelType,
-  NewTieredPriceCadence,
-  NewTieredPriceModelType,
-  NewTieredWithMinimumPriceCadence,
-  NewTieredWithMinimumPriceModelType,
-  NewUnitPriceCadence,
-  NewUnitPriceModelType,
-} from "orb-billing/dist/sdk/models/shared";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.price.create({
-  billableMetricId: "Configuration Money",
-  billedInAdvance: false,
-  bpsConfig: {
-    bps: "shred",
-    perUnitMaximum: "technology East",
-  },
-  cadence: NewBpsPriceCadence.Annual,
-  currency: "Guinea Franc",
-  externalPriceId: "male",
-  fixedPriceQuantity: "quantify Polestar mobile",
-  invoiceGroupingKey: "Ameliorated Fresh",
-  itemId: "overriding",
-  modelType: NewBpsPriceModelType.Bps,
-  name: "Annual fee",
-}).then((res: CreatePriceResponse) => {
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.price.create("online");
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
@@ -302,29 +262,30 @@ This endpoint returns a price given an identifier.
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchPriceResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchPriceRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const priceId: string = "grateful";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.price.fetch(priceId);
 
-sdk.price.fetch({
-  priceId: "Total Honda Southeast",
-}).then((res: FetchPriceResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `request`                                                                    | [operations.FetchPriceRequest](../../models/operations/fetchpricerequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `priceId`                                                    | *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
@@ -341,29 +302,30 @@ See the [price creation API](../reference/create-price) for more information abo
 
 ```typescript
 import { Orb } from "orb-billing";
-import { FetchPriceExternalIdResponse } from "orb-billing/dist/sdk/models/operations";
+import { FetchPriceExternalIdRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const externalPriceId: string = "Technician";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
+  const res = await sdk.price.fetchByExternalId(externalPriceId);
 
-sdk.price.fetchByExternalId({
-  externalPriceId: "Loan Gasoline ping",
-}).then((res: FetchPriceExternalIdResponse) => {
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.FetchPriceExternalIdRequest](../../models/operations/fetchpriceexternalidrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `externalPriceId`                                            | *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
@@ -379,30 +341,32 @@ This endpoint is used to list all add-on prices created using the [price creatio
 
 ```typescript
 import { Orb } from "orb-billing";
-import { ListPricesResponse } from "orb-billing/dist/sdk/models/operations";
-
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.price.list({
-  cursor: "Northeast Metal Canada",
-  limit: 917416,
-}).then((res: ListPricesResponse) => {
+import { ListPricesRequest } from "orb-billing/dist/sdk/models/operations";
+
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const cursor: string = "Bicycle";
+const limit: number = 257649;
+
+  const res = await sdk.price.list(cursor, limit);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                    | Type                                                                         | Required                                                                     | Description                                                                  |
-| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
-| `request`                                                                    | [operations.ListPricesRequest](../../models/operations/listpricesrequest.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                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `cursor`                                                     | *string*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `limit`                                                      | *number*                                                     | :heavy_minus_sign:                                           | N/A                                                          |
+| `config`                                                     | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign:                                           | Available config options for making requests.                |
 
 
 ### Response