orb-billing - npm Package Compare versions

Comparing version 3.2.0 to 4.0.0

CHANGELOG.md

 # Changelog
 
+## 4.0.0 (2024-08-14)
+
+Full Changelog: [v3.2.0...v4.0.0](https://github.com/orbcorp/orb-node/compare/v3.2.0...v4.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** remove methods 'customers.usage.create' and 'customers.usage.update_by_external_id' ([#249](https://github.com/orbcorp/orb-node/issues/249))
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#251](https://github.com/orbcorp/orb-node/issues/251)) ([6dc3dfe](https://github.com/orbcorp/orb-node/commit/6dc3dfe0910a57311e92c5f6bcb40e0f8d0f2768))
+* **api:** remove methods 'customers.usage.create' and 'customers.usage.update_by_external_id' ([#249](https://github.com/orbcorp/orb-node/issues/249)) ([2c10956](https://github.com/orbcorp/orb-node/commit/2c1095665ad03abe2977b2fc848ea005de34d06d))
+
 ## 3.2.0 (2024-08-02)
@@ -4,0 +17,0 @@

package.json

 {
   "name": "orb-billing",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "The official TypeScript library for the Orb API",
@@ -22,3 +22,3 @@ "author": "Orb <[e-mail]>",
     "lint": "./scripts/lint",
-    "fix": "eslint --fix --ext ts,js ."
+    "fix": "./scripts/format"
   },
@@ -25,0 +25,0 @@ "dependencies": {

resources/alerts.d.ts

@@ -168,7 +168,7 @@ import { APIResource } from "../resource.js";
     /**
-     * The thresholds that define the values at which the alert will be triggered.
+     * The type of alert to create. This must be a valid alert type.
      */
-    type: string;
+    type: 'usage_exceeded' | 'cost_exceeded' | 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered';
     /**
-     * The thresholds for the alert.
+     * The thresholds that define the values at which the alert will be triggered.
      */
@@ -197,7 +197,7 @@ thresholds?: Array<AlertCreateForCustomerParams.Threshold> | null;
     /**
-     * The thresholds that define the values at which the alert will be triggered.
+     * The type of alert to create. This must be a valid alert type.
      */
-    type: string;
+    type: 'usage_exceeded' | 'cost_exceeded' | 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered';
     /**
-     * The thresholds for the alert.
+     * The thresholds that define the values at which the alert will be triggered.
      */
@@ -222,9 +222,9 @@ thresholds?: Array<AlertCreateForExternalCustomerParams.Threshold> | null;
     /**
-     * The thresholds for the alert.
+     * The thresholds that define the values at which the alert will be triggered.
      */
     thresholds: Array<AlertCreateForSubscriptionParams.Threshold>;
     /**
-     * The thresholds that define the values at which the alert will be triggered.
+     * The type of alert to create. This must be a valid alert type.
      */
-    type: string;
+    type: 'usage_exceeded' | 'cost_exceeded' | 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered';
     /**
@@ -231,0 +231,0 @@ * The metric to track usage for.

resources/customers/customers.js

@@ -33,3 +33,2 @@ "use strict";
 const CostsAPI = __importStar(require("./costs.js"));
-const UsageAPI = __importStar(require("./usage.js"));
 const CreditsAPI = __importStar(require("./credits/credits.js"));
@@ -41,3 +40,2 @@ const pagination_1 = require("../../pagination.js");
         this.costs = new CostsAPI.Costs(this._client);
-        this.usage = new UsageAPI.Usage(this._client);
         this.credits = new CreditsAPI.Credits(this._client);
@@ -130,3 +128,2 @@ this.balanceTransactions = new BalanceTransactionsAPI.BalanceTransactions(this._client);
     Customers.Costs = CostsAPI.Costs;
-    Customers.Usage = UsageAPI.Usage;
     Customers.Credits = CreditsAPI.Credits;
@@ -133,0 +130,0 @@ Customers.CreditListResponsesPage = CreditsAPI.CreditListResponsesPage;

resources/customers/index.d.ts

@@ -5,3 +5,2 @@ export { BalanceTransactionCreateResponse, BalanceTransactionListResponse, BalanceTransactionCreateParams, BalanceTransactionListParams, BalanceTransactionListResponsesPage, BalanceTransactions, } from "./balance-transactions.js";
 export { Customer, CustomerCreateParams, CustomerUpdateParams, CustomerListParams, CustomerUpdateByExternalIDParams, CustomersPage, Customers, } from "./customers.js";
-export { UsageUpdateResponse, UsageUpdateByExternalIDResponse, UsageUpdateParams, UsageUpdateByExternalIDParams, Usage, } from "./usage.js";
 //# sourceMappingURL=index.d.ts.map

resources/customers/index.js

 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Usage = exports.Customers = exports.CustomersPage = exports.Credits = exports.CreditListByExternalIDResponsesPage = exports.CreditListResponsesPage = exports.Costs = exports.BalanceTransactions = exports.BalanceTransactionListResponsesPage = void 0;
+exports.Customers = exports.CustomersPage = exports.Credits = exports.CreditListByExternalIDResponsesPage = exports.CreditListResponsesPage = exports.Costs = exports.BalanceTransactions = exports.BalanceTransactionListResponsesPage = void 0;
 var balance_transactions_1 = require("./balance-transactions.js");
@@ -17,4 +17,2 @@ Object.defineProperty(exports, "BalanceTransactionListResponsesPage", { enumerable: true, get: function () { return balance_transactions_1.BalanceTransactionListResponsesPage; } });
 Object.defineProperty(exports, "Customers", { enumerable: true, get: function () { return customers_1.Customers; } });
-var usage_1 = require("./usage.js");
-Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return usage_1.Usage; } });
 //# sourceMappingURL=index.js.map

resources/events/events.d.ts

@@ -15,4 +15,3 @@ import { APIResource } from "../../resource.js";
      * `event_id`. Note that a single event can be amended any number of times, so the
-     * same event can be overwritten in subsequent calls to this endpoint, or
-     * overwritten using the [Amend customer usage](amend-usage) endpoint. Only a
+     * same event can be overwritten in subsequent calls to this endpoint. Only a
      * single event with a given `event_id` will be considered the source of truth at
@@ -52,2 +51,5 @@ * any given time.
      *   subscription's previous billing period.
+     * - By default, no more than 100 events can be amended for a single customer in a
+     *   100 day period. For higher volume updates, consider using the
+     *   [event backfill](create-backfill) endpoint.
      */
@@ -93,2 +95,5 @@ update(eventId: string, body: EventUpdateParams, options?: Core.RequestOptions): Core.APIPromise<EventUpdateResponse>;
      *   deprecating events for customers not in the Orb system.
+     * - By default, no more than 100 events can be deprecated for a single customer in
+     *   a 100 day period. For higher volume updates, consider using the
+     *   [event backfill](create-backfill) endpoint.
      */
@@ -209,2 +214,6 @@ deprecate(eventId: string, options?: Core.RequestOptions): Core.APIPromise<EventDeprecateResponse>;
      *
+     * In general, Orb does not expect events with future dated timestamps. In cases
+     * where the timestamp is at least 24 hours ahead of the current time, the event
+     * will not be accepted as a valid event, and will throw validation errors.
+     *
      * ## Event validation
@@ -211,0 +220,0 @@ *

resources/events/events.js

@@ -43,4 +43,3 @@ "use strict";
      * `event_id`. Note that a single event can be amended any number of times, so the
-     * same event can be overwritten in subsequent calls to this endpoint, or
-     * overwritten using the [Amend customer usage](amend-usage) endpoint. Only a
+     * same event can be overwritten in subsequent calls to this endpoint. Only a
      * single event with a given `event_id` will be considered the source of truth at
@@ -80,2 +79,5 @@ * any given time.
      *   subscription's previous billing period.
+     * - By default, no more than 100 events can be amended for a single customer in a
+     *   100 day period. For higher volume updates, consider using the
+     *   [event backfill](create-backfill) endpoint.
      */
@@ -123,2 +125,5 @@ update(eventId, body, options) {
      *   deprecating events for customers not in the Orb system.
+     * - By default, no more than 100 events can be deprecated for a single customer in
+     *   a 100 day period. For higher volume updates, consider using the
+     *   [event backfill](create-backfill) endpoint.
      */
@@ -241,2 +246,6 @@ deprecate(eventId, options) {
      *
+     * In general, Orb does not expect events with future dated timestamps. In cases
+     * where the timestamp is at least 24 hours ahead of the current time, the event
+     * will not be accepted as a valid event, and will throw validation errors.
+     *
      * ## Event validation
@@ -243,0 +252,0 @@ *

resources/plans/plans.d.ts

@@ -250,3 +250,3 @@ import { APIResource } from "../../resource.js";
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -313,3 +313,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -381,3 +381,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -466,3 +466,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -545,3 +545,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -630,3 +630,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -697,3 +697,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -777,3 +777,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -851,3 +851,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -906,3 +906,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -961,3 +961,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -1016,3 +1016,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -1071,3 +1071,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -1126,3 +1126,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -1181,3 +1181,3 @@ * The id of the item the plan will be associated with.
          */
-        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
         /**
@@ -1184,0 +1184,0 @@ * The id of the item the plan will be associated with.

src/resources/alerts.ts

@@ -236,8 +236,13 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   /**
-   * The thresholds that define the values at which the alert will be triggered.
+   * The type of alert to create. This must be a valid alert type.
    */
-  type: string;
+  type:
+    | 'usage_exceeded'
+    | 'cost_exceeded'
+    | 'credit_balance_depleted'
+    | 'credit_balance_dropped'
+    | 'credit_balance_recovered';
 
   /**
-   * The thresholds for the alert.
+   * The thresholds that define the values at which the alert will be triggered.
    */
@@ -269,8 +274,13 @@ thresholds?: Array<AlertCreateForCustomerParams.Threshold> | null;
   /**
-   * The thresholds that define the values at which the alert will be triggered.
+   * The type of alert to create. This must be a valid alert type.
    */
-  type: string;
+  type:
+    | 'usage_exceeded'
+    | 'cost_exceeded'
+    | 'credit_balance_depleted'
+    | 'credit_balance_dropped'
+    | 'credit_balance_recovered';
 
   /**
-   * The thresholds for the alert.
+   * The thresholds that define the values at which the alert will be triggered.
    */
@@ -297,3 +307,3 @@ thresholds?: Array<AlertCreateForExternalCustomerParams.Threshold> | null;
   /**
-   * The thresholds for the alert.
+   * The thresholds that define the values at which the alert will be triggered.
    */
@@ -303,5 +313,10 @@ thresholds: Array<AlertCreateForSubscriptionParams.Threshold>;
   /**
-   * The thresholds that define the values at which the alert will be triggered.
+   * The type of alert to create. This must be a valid alert type.
    */
-  type: string;
+  type:
+    | 'usage_exceeded'
+    | 'cost_exceeded'
+    | 'credit_balance_depleted'
+    | 'credit_balance_dropped'
+    | 'credit_balance_recovered';
 
@@ -308,0 +323,0 @@ /**

src/resources/customers/index.ts

@@ -36,8 +36,1 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 } from './customers';
-export {
-  UsageUpdateResponse,
-  UsageUpdateByExternalIDResponse,
-  UsageUpdateParams,
-  UsageUpdateByExternalIDParams,
-  Usage,
-} from './usage';

src/resources/events/events.ts

@@ -19,4 +19,3 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
    * `event_id`. Note that a single event can be amended any number of times, so the
-   * same event can be overwritten in subsequent calls to this endpoint, or
-   * overwritten using the [Amend customer usage](amend-usage) endpoint. Only a
+   * same event can be overwritten in subsequent calls to this endpoint. Only a
    * single event with a given `event_id` will be considered the source of truth at
@@ -56,2 +55,5 @@ * any given time.
    *   subscription's previous billing period.
+   * - By default, no more than 100 events can be amended for a single customer in a
+   *   100 day period. For higher volume updates, consider using the
+   *   [event backfill](create-backfill) endpoint.
    */
@@ -104,2 +106,5 @@ update(
    *   deprecating events for customers not in the Orb system.
+   * - By default, no more than 100 events can be deprecated for a single customer in
+   *   a 100 day period. For higher volume updates, consider using the
+   *   [event backfill](create-backfill) endpoint.
    */
@@ -223,2 +228,6 @@ deprecate(eventId: string, options?: Core.RequestOptions): Core.APIPromise<EventDeprecateResponse> {
    *
+   * In general, Orb does not expect events with future dated timestamps. In cases
+   * where the timestamp is at least 24 hours ahead of the current time, the event
+   * will not be accepted as a valid event, and will throw validation errors.
+   *
    * ## Event validation
@@ -225,0 +234,0 @@ *

src/resources/plans/plans.ts

@@ -356,3 +356,3 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -433,3 +433,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -516,3 +516,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -619,3 +619,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -715,3 +715,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -819,3 +819,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -901,3 +901,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -998,3 +998,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1087,3 +1087,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1155,3 +1155,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1223,3 +1223,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1291,3 +1291,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1359,3 +1359,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1427,3 +1427,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1495,3 +1495,3 @@ /**
      */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time';
+    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -1498,0 +1498,0 @@ /**

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '3.2.0'; // x-release-please-version
+export const VERSION = '4.0.0'; // x-release-please-version

version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "3.2.0";
+export declare const VERSION = "4.0.0";
 //# sourceMappingURL=version.d.ts.map

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.2.0'; // x-release-please-version
+exports.VERSION = '4.0.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

2781665

decreased by-1.48%

Number of package files

382

decreased by-1.8%

Lines of code

51015

decreased by-1.81%

No dependency changes