orb-billing 1.19.2 → 1.20.0

package/docs/sdks/priceinterval/README.md

@@ -63,115 +63,72 @@ be specified to add additional transitions. The existing list of transitions can
 
 ```typescript
 import { Orb } from "orb-billing";
-import { AddEditPriceIntervalsResponse } from "orb-billing/dist/sdk/models/operations";
+import { AddEditPriceIntervalsRequest } from "orb-billing/dist/sdk/models/operations";
 import {
-  AddPriceIntervalParamsEndDateEndDate,
-  AddPriceIntervalParamsStartDateStartDate,
-  AmountDiscountCreationParamsDiscountType,
-  EditPriceIntervalParamsEndDateEndDate,
-  EditPriceIntervalParamsStartDateStartDate,
-  NewBpsPriceCadence,
-  NewBpsPriceModelType,
-  NewBulkBpsPriceCadence,
-  NewBulkBpsPriceModelType,
-  NewBulkPriceCadence,
-  NewBulkPriceModelType,
-  NewMatrixPriceCadence,
-  NewMatrixPriceModelType,
-  NewPackagePriceCadence,
-  NewPackagePriceModelType,
-  NewPackageWithAllocationPriceCadence,
-  NewPackageWithAllocationPriceModelType,
-  NewThresholdTotalAmountPriceCadence,
-  NewThresholdTotalAmountPriceModelType,
-  NewTieredBpsPriceCadence,
-  NewTieredBpsPriceModelType,
-  NewTieredPackagePriceCadence,
-  NewTieredPackagePriceModelType,
-  NewTieredPriceCadence,
-  NewTieredPriceModelType,
-  NewTieredWithMinimumPriceCadence,
-  NewTieredWithMinimumPriceModelType,
-  NewUnitPriceCadence,
-  NewUnitPriceModelType,
-  PercentageDiscountCreationParamsDiscountType,
-  UsageDiscountCreationParamsDiscountType,
+  AddEditPriceIntervalParams,
+  AddPriceIntervalParams,
+  EditPriceIntervalParams,
+  PriceIntervalFixedFeeQuantityTransitionParams,
 } from "orb-billing/dist/sdk/models/shared";
 
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
-});
-
-sdk.priceInterval.addEditPriceIntervals({
-  addEditPriceIntervalParams: {
-    add: [
-      {
-        discounts: [
-          {
-            amountDiscount: "10.00",
-            discountType: AmountDiscountCreationParamsDiscountType.Amount,
-          },
-        ],
-        endDate: AddPriceIntervalParamsEndDateEndDate.StartOfTerm,
-        externalPriceId: "external_price_id",
-        fixedFeeQuantityTransitions: [
-          {
-            effectiveDate: new Date("2023-05-01"),
-            quantity: 5,
-          },
-        ],
-        maximumAmount: 1.23,
-        minimumAmount: 1.23,
-        price: {
-          billableMetricId: "New",
-          billedInAdvance: false,
-          cadence: NewPackagePriceCadence.Annual,
-          currency: "Lempira",
-          externalPriceId: "Luxurious",
-          fixedPriceQuantity: 9728.4,
-          invoiceGroupingKey: "which Refined Account",
-          itemId: "microchip Program compressing",
-          modelType: NewPackagePriceModelType.Package,
-          name: "Annual fee",
-          packageConfig: {
-            packageAmount: "male systems Internal",
-            packageSize: 937142,
-          },
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+const subscriptionId: string = "Shoes";
+const addEditPriceIntervalParams: AddEditPriceIntervalParams = {
+  add: [
+    {
+      discounts: [
+        "watt",
+      ],
+      endDate: "2023-07-10",
+      externalPriceId: "external_price_id",
+      fixedFeeQuantityTransitions: [
+        {
+          effectiveDate: new Date("2023-05-01"),
+          quantity: 5,
         },
-        priceId: "h74gfhdjvn7ujokd",
-        startDate: AddPriceIntervalParamsStartDateStartDate.EndOfTerm,
-      },
-    ],
-    edit: [
-      {
-        endDate: new Date("2023-07-10"),
-        fixedFeeQuantityTransitions: [
-          {
-            effectiveDate: new Date("2023-05-01"),
-            quantity: 5,
-          },
-        ],
-        priceIntervalId: "sdfs6wdjvn7ujokd",
-        startDate: EditPriceIntervalParamsStartDateStartDate.StartOfTerm,
-      },
-    ],
-  },
-  subscriptionId: "users Analyst",
-}).then((res: AddEditPriceIntervalsResponse) => {
+      ],
+      maximumAmount: 1.23,
+      minimumAmount: 1.23,
+      price: "North",
+      priceId: "h74gfhdjvn7ujokd",
+      startDate: "2023-05-01",
+    },
+  ],
+  edit: [
+    {
+      endDate: "2023-07-10",
+      fixedFeeQuantityTransitions: [
+        {
+          effectiveDate: new Date("2023-05-01"),
+          quantity: 5,
+        },
+      ],
+      priceIntervalId: "sdfs6wdjvn7ujokd",
+      startDate: "2023-05-01",
+    },
+  ],
+};
+
+  const res = await sdk.priceInterval.addEditPriceIntervals(subscriptionId, addEditPriceIntervalParams);
+
   if (res.statusCode == 200) {
     // handle response
   }
-});
+})();
 ```
 
 ### Parameters
 
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.AddEditPriceIntervalsRequest](../../models/operations/addeditpriceintervalsrequest.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                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `subscriptionId`                                                                       | *string*                                                                               | :heavy_check_mark:                                                                     | N/A                                                                                    |
+| `addEditPriceIntervalParams`                                                           | [shared.AddEditPriceIntervalParams](../../models/shared/addeditpriceintervalparams.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