@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/contracts/rate-cards/rate-cards.d.ts

@@ -1,5 +1,4 @@
-import { APIResource } from "../../../../resource.js";
-import * as Core from "../../../../core.js";
+import { APIResource } from "../../../../core/resource.js";
 import * as Shared from "../../../shared.js";
 import * as NamedSchedulesAPI from "./named-schedules.js";
 import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.js";
@@ -7,13 +6,47 @@ import * as ProductOrdersAPI from "./product-orders.js";
 import { ProductOrderSetParams, ProductOrderSetResponse, ProductOrderUpdateParams, ProductOrderUpdateResponse, ProductOrders } from "./product-orders.js";
 import * as RatesAPI from "./rates.js";
 import { RateAddManyParams, RateAddManyResponse, RateAddParams, RateAddResponse, RateListParams, RateListResponse, RateListResponsesCursorPage, Rates } from "./rates.js";
-import { CursorPage, type CursorPageParams } from "../../../../pagination.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../../../core/pagination.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
 export declare class RateCards extends APIResource {
     productOrders: ProductOrdersAPI.ProductOrders;
     rates: RatesAPI.Rates;
     namedSchedules: NamedSchedulesAPI.NamedSchedules;
     /**
-     * Create a new rate card
+     * In Metronome, the rate card is the central location for your pricing. Rate cards
+     * were built with new product launches and pricing changes in mind - you can
+     * update your products and pricing in one place, and that change will be
+     * automatically propagated across your customer cohorts. Most clients need only
+     * maintain one or a few rate cards within Metronome.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Create a rate card with a name and description
+     * - Define the rate card's single underlying fiat currency, and any number of
+     *   conversion rates between that fiat currency and custom pricing units. You can
+     *   then add products and associated rates in the fiat currency or custom pricing
+     *   unit for which you have defined a conversion rate.
+     * - Set aliases for the rate card. Aliases are human-readable names that you can
+     *   use in the place of the id of the rate card when provisioning a customer's
+     *   contract. By using an alias, you can easily create a contract and provision a
+     *   customer by choosing the paygo rate card, without storing the rate card id in
+     *   your internal systems. This is helpful when launching a new rate card for
+     *   paygo customers, you can update the alias for paygo to be scheduled to be
+     *   assigned to the new rate card without updating your code.
+     *
+     * ### Key response fields:
+     *
+     * - The ID of the rate card you just created
+     *
+     * ### Usage guidelines:
+     *
+     * - After creating a rate card, you can now use the addRate or addRates endpoints
+     *   to add products and their prices to it
+     * - A rate card alias can only be used by one rate card at a time. If you create a
+     *   contract with a rate card alias that is already in use by another rate card,
+     *   the original rate card's alias schedule will be updated. The alias will
+     *   reference the rate card to which it was most recently assigned.
      *
      * @example
      * ```ts
@@ -35,10 +68,11 @@ export declare class RateCards extends APIResource {
      * );
      * ```
      */
-    create(body: RateCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardCreateResponse>;
+    create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardCreateResponse>;
     /**
-     * Get a specific rate card NOTE: Use `/contract-pricing/rate-cards/getRates` to
-     * retrieve rate card rates.
+     * Return details for a specific rate card including name, description, and
+     * aliases. This endpoint does not return rates - use the dedicated getRates or
+     * getRateSchedule endpoints to understand the rates on a rate card.
      *
      * @example
      * ```ts
@@ -48,9 +82,60 @@ export declare class RateCards extends APIResource {
      *   });
      * ```
      */
-    retrieve(body: RateCardRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<RateCardRetrieveResponse>;
+    retrieve(body: RateCardRetrieveParams, options?: RequestOptions): APIPromise<RateCardRetrieveResponse>;
     /**
-     * Update a rate card
+     * Update the metadata properties of an existing rate card, including its name,
+     * description, and aliases. This endpoint is designed for managing rate card
+     * identity and reference aliases rather than modifying pricing rates.
+     *
+     * Modifies the descriptive properties and alias configuration of a rate card
+     * without affecting the underlying pricing rates or schedules. This allows you to
+     * update how a rate card is identified and referenced throughout your system.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Rate card renaming: Update display names or descriptions for organizational
+     *   clarity
+     * - Alias management: Add, modify, or schedule alias transitions for seamless rate
+     *   card migrations
+     * - Documentation updates: Keep rate card descriptions current with business
+     *   context
+     * - Self-serve provisioning setup: Configure aliases to enable code-free rate card
+     *   transitions
+     *
+     * #### Active contract impact:
+     *
+     * - Alias changes: Already-created contracts continue using their originally
+     *   assigned rate cards.
+     * - Other changes made using this endpoint will only impact the Metronome UI.
+     *
+     * #### Grandfathering existing PLG customer pricing:
+     *
+     * - Rate card aliases support scheduled transitions, enabling seamless rate card
+     *   migrations for new customers, allowing existing customers to be grandfathered
+     *   into their existing prices without code. Note that there are multiple
+     *   mechanisms to support grandfathering in Metronome.
+     *
+     * #### How scheduled aliases work for PLG grandfathering:
+     *
+     * Initial setup:
+     *
+     * - Add alias to current rate card: Assign a stable alias (e.g.,
+     *   "standard-pricing") to your active rate card
+     * - Reference alias during contract creation: Configure your self-serve workflow
+     *   to create contracts using `rate_card_alias` instead of direct `rate_card_id`
+     * - Automatic resolution: New contracts referencing the alias automatically
+     *   resolve to the rate card associated with the alias at the point in time of
+     *   provisioning
+     *
+     * #### Grandfathering process:
+     *
+     * - Create new rate card: Build your new rate card with updated pricing structure
+     * - Schedule alias transition: Add the same alias to the new rate card with a
+     *   `starting_at` timestamp
+     * - Automatic cutover: Starting at the scheduled time, new contracts created in
+     *   your PLG workflow using that alias will automatically reference the new rate
+     *   card
      *
      * @example
      * ```ts
@@ -63,10 +148,11 @@ export declare class RateCards extends APIResource {
      * );
      * ```
      */
-    update(body: RateCardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardUpdateResponse>;
+    update(body: RateCardUpdateParams, options?: RequestOptions): APIPromise<RateCardUpdateResponse>;
     /**
-     * List rate cards NOTE: Use `/contract-pricing/rate-cards/getRates` to retrieve
-     * rate card rates.
+     * List all rate cards. Returns rate card IDs, names, descriptions, aliases, and
+     * other details. To view the rates associated with a given rate card, use the
+     * getRates or getRateSchedule endpoints.
      *
      * @example
      * ```ts
@@ -76,10 +162,13 @@ export declare class RateCards extends APIResource {
      * }
      * ```
      */
-    list(params?: RateCardListParams, options?: Core.RequestOptions): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
-    list(options?: Core.RequestOptions): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+    list(params?: RateCardListParams | null | undefined, options?: RequestOptions): PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
     /**
-     * Archive a rate card
+     * Permanently disable a rate card by archiving it, preventing use in new contracts
+     * while preserving existing contract pricing. Use this when retiring old pricing
+     * models, consolidating rate cards, or removing outdated pricing structures.
+     * Returns the archived rate card ID and stops the rate card from appearing in
+     * contract creation workflows.
      *
      * @example
      * ```ts
@@ -89,10 +178,20 @@ export declare class RateCards extends APIResource {
      *   });
      * ```
      */
-    archive(body: RateCardArchiveParams, options?: Core.RequestOptions): Core.APIPromise<RateCardArchiveResponse>;
+    archive(body: RateCardArchiveParams, options?: RequestOptions): APIPromise<RateCardArchiveResponse>;
     /**
-     * Get all rates for a rate card from starting_at (either in perpetuity or until
-     * ending_before, if provided)
+     * A rate card defines the prices that you charge for your products. Rate cards
+     * support scheduled changes over time, to allow you to easily roll out pricing
+     * changes and new product launches across your customer base. Use this endpoint to
+     * understand the rate schedule `starting_at` a given date, optionally filtering
+     * the list of rates returned based on product id or pricing group values. For
+     * example, you may want to display a schedule of upcoming price changes for a
+     * given product in your product experience - use this endpoint to fetch that
+     * information from its source of truth in Metronome.
+     *
+     * If you want to understand the rates for a specific customer's contract,
+     * inclusive of contract-level overrides, use the `getContractRateSchedule`
+     * endpoint.
      *
      * @example
      * ```ts
@@ -112,10 +211,9 @@ export declare class RateCards extends APIResource {
      *   });
      * ```
      */
-    retrieveRateSchedule(params: RateCardRetrieveRateScheduleParams, options?: Core.RequestOptions): Core.APIPromise<RateCardRetrieveRateScheduleResponse>;
-}
-export declare class RateCardListResponsesCursorPage extends CursorPage<RateCardListResponse> {
+    retrieveRateSchedule(params: RateCardRetrieveRateScheduleParams, options?: RequestOptions): APIPromise<RateCardRetrieveRateScheduleResponse>;
 }
+export type RateCardListResponsesCursorPage = CursorPage<RateCardListResponse>;
 export interface RateCardCreateResponse {
     data: Shared.ID;
 }
@@ -130,6 +228,9 @@ export declare namespace RateCardRetrieveResponse {
         name: string;
         aliases?: Array<Data.Alias>;
         credit_type_conversions?: Array<Data.CreditTypeConversion>;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         custom_fields?: {
             [key: string]: string;
         };
@@ -158,6 +259,9 @@ export interface RateCardListResponse {
     name: string;
     aliases?: Array<RateCardListResponse.Alias>;
     credit_type_conversions?: Array<RateCardListResponse.CreditTypeConversion>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: {
         [key: string]: string;
     };
@@ -185,6 +289,9 @@ export interface RateCardRetrieveRateScheduleResponse {
 export declare namespace RateCardRetrieveRateScheduleResponse {
     interface Data {
         entitled: boolean;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
         product_custom_fields: {
             [key: string]: string;
         };
@@ -198,29 +305,12 @@ export declare namespace RateCardRetrieveRateScheduleResponse {
          * A distinct rate on the rate card. You can choose to use this rate rather than
          * list rate when consuming a credit or commit.
          */
-        commit_rate?: Data.CommitRate;
+        commit_rate?: Shared.CommitRate;
         ending_before?: string;
         pricing_group_values?: {
             [key: string]: string;
         };
     }
-    namespace Data {
-        /**
-         * A distinct rate on the rate card. You can choose to use this rate rather than
-         * list rate when consuming a credit or commit.
-         */
-        interface CommitRate {
-            rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
-            /**
-             * Commit rate price. For FLAT rate_type, this must be >=0.
-             */
-            price?: number;
-            /**
-             * Only set for TIERED rate_type.
-             */
-            tiers?: Array<Shared.Tier>;
-        }
-    }
 }
 export interface RateCardCreateParams {
     /**
@@ -237,6 +327,9 @@ export interface RateCardCreateParams {
      * Required when using custom pricing units in rates.
      */
     credit_type_conversions?: Array<RateCardCreateParams.CreditTypeConversion>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: {
         [key: string]: string;
     };
@@ -351,9 +444,9 @@ export declare namespace RateCardRetrieveRateScheduleParams {
     }
 }
 export declare namespace RateCards {
-    export { type RateCardCreateResponse as RateCardCreateResponse, type RateCardRetrieveResponse as RateCardRetrieveResponse, type RateCardUpdateResponse as RateCardUpdateResponse, type RateCardListResponse as RateCardListResponse, type RateCardArchiveResponse as RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse, RateCardListResponsesCursorPage as RateCardListResponsesCursorPage, type RateCardCreateParams as RateCardCreateParams, type RateCardRetrieveParams as RateCardRetrieveParams, type RateCardUpdateParams as RateCardUpdateParams, type RateCardListParams as RateCardListParams, type RateCardArchiveParams as RateCardArchiveParams, type RateCardRetrieveRateScheduleParams as RateCardRetrieveRateScheduleParams, };
+    export { type RateCardCreateResponse as RateCardCreateResponse, type RateCardRetrieveResponse as RateCardRetrieveResponse, type RateCardUpdateResponse as RateCardUpdateResponse, type RateCardListResponse as RateCardListResponse, type RateCardArchiveResponse as RateCardArchiveResponse, type RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse, type RateCardListResponsesCursorPage as RateCardListResponsesCursorPage, type RateCardCreateParams as RateCardCreateParams, type RateCardRetrieveParams as RateCardRetrieveParams, type RateCardUpdateParams as RateCardUpdateParams, type RateCardListParams as RateCardListParams, type RateCardArchiveParams as RateCardArchiveParams, type RateCardRetrieveRateScheduleParams as RateCardRetrieveRateScheduleParams, };
     export { ProductOrders as ProductOrders, type ProductOrderUpdateResponse as ProductOrderUpdateResponse, type ProductOrderSetResponse as ProductOrderSetResponse, type ProductOrderUpdateParams as ProductOrderUpdateParams, type ProductOrderSetParams as ProductOrderSetParams, };
-    export { Rates as Rates, type RateListResponse as RateListResponse, type RateAddResponse as RateAddResponse, type RateAddManyResponse as RateAddManyResponse, RateListResponsesCursorPage as RateListResponsesCursorPage, type RateListParams as RateListParams, type RateAddParams as RateAddParams, type RateAddManyParams as RateAddManyParams, };
+    export { Rates as Rates, type RateListResponse as RateListResponse, type RateAddResponse as RateAddResponse, type RateAddManyResponse as RateAddManyResponse, type RateListResponsesCursorPage as RateListResponsesCursorPage, type RateListParams as RateListParams, type RateAddParams as RateAddParams, type RateAddManyParams as RateAddManyParams, };
     export { NamedSchedules as NamedSchedules, type NamedScheduleRetrieveResponse as NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams as NamedScheduleRetrieveParams, type NamedScheduleUpdateParams as NamedScheduleUpdateParams, };
 }
 //# sourceMappingURL=rate-cards.d.ts.map

package/resources/v1/contracts/rate-cards/rate-cards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rate-cards.d.ts","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,iBAAiB,MAAM,mBAAmB,CAAC;AACvD,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE3E,qBAAa,SAAU,SAAQ,WAAW;IACxC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IAEtG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;;;;OAWG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAC1E,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAiB1E;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,CAClB,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oCAAoC,CAAC;CAQzD;AAED,qBAAa,+BAAgC,SAAQ,UAAU,CAAC,oBAAoB,CAAC;CAAG;AAExF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5B,uBAAuB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE3D,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;KAC1C;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,IAAI,EAAE,MAAM,CAAC;YAEb,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,oBAAoB;YACnC,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC;YAE1C,sBAAsB,EAAE,MAAM,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C,uBAAuB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAE3E,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;CAC1C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,oBAAoB;QACnC,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE1C,sBAAsB,EAAE,MAAM,CAAC;KAChC;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,KAAK,CAAC,oCAAoC,CAAC,IAAI,CAAC,CAAC;IAEvD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,IAAI;QACnB,QAAQ,EAAE,OAAO,CAAC;QAElB,qBAAqB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD,UAAU,EAAE,MAAM,CAAC;QAEnB,YAAY,EAAE,MAAM,CAAC;QAErB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,WAAW,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE9B,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KAClD;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,UAAU;YACzB,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;YAExE;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC5B;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAE3E,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,oBAAoB;QACnC,qBAAqB,EAAE,MAAM,CAAC;QAE9B,sBAAsB,EAAE,MAAM,CAAC;KAChC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC;CAChE;AAED,yBAAiB,kCAAkC,CAAC;IAClD,UAAiB,QAAQ;QACvB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,4BAA4B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzD;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAQD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,+BAA+B,IAAI,+BAA+B,EAClE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"rate-cards.d.ts","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,iBAAiB;OACtB,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,cAAc,EACf;OACM,KAAK,gBAAgB;OACrB,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,aAAa,EACd;OACM,KAAK,QAAQ;OACb,EACL,iBAAiB,EACjB,mBAAmB,EACnB,aAAa,EACb,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,KAAK,EACN;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IAEtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAItG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAqB,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAUrE;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,MAAM,EAAE,kCAAkC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAQpD;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5B,uBAAuB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE3D;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;KAC1C;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,KAAK;YACpB,IAAI,EAAE,MAAM,CAAC;YAEb,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,oBAAoB;YACnC,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC;YAE1C,sBAAsB,EAAE,MAAM,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C,uBAAuB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAE3E;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,gBAAgB,CAAC,EAAE,MAAM,CAAC,cAAc,CAAC;CAC1C;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,oBAAoB;QACnC,kBAAkB,EAAE,MAAM,CAAC,cAAc,CAAC;QAE1C,sBAAsB,EAAE,MAAM,CAAC;KAChC;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,oCAAoC;IACnD,IAAI,EAAE,KAAK,CAAC,oCAAoC,CAAC,IAAI,CAAC,CAAC;IAEvD,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,IAAI;QACnB,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,qBAAqB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD,UAAU,EAAE,MAAM,CAAC;QAEnB,YAAY,EAAE,MAAM,CAAC;QAErB,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;QAElB,WAAW,EAAE,MAAM,CAAC;QAEpB,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;QAEhC,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KAClD;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;IAE3E;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,oBAAoB;QACnC,qBAAqB,EAAE,MAAM,CAAC;QAE9B,sBAAsB,EAAE,MAAM,CAAC;KAChC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QAEb,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC;CAChE;AAED,yBAAiB,kCAAkC,CAAC;IAClD,UAAiB,QAAQ;QACvB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAElE;;;WAGG;QACH,4BAA4B,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEzD;;;WAGG;QACH,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAMD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/v1/contracts/rate-cards/rate-cards.js

@@ -1,39 +1,16 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RateCardListResponsesCursorPage = exports.RateCards = void 0;
-const resource_1 = require("../../../../resource.js");
-const core_1 = require("../../../../core.js");
-const NamedSchedulesAPI = __importStar(require("./named-schedules.js"));
+exports.RateCards = void 0;
+const tslib_1 = require("../../../../internal/tslib.js");
+const resource_1 = require("../../../../core/resource.js");
+const NamedSchedulesAPI = tslib_1.__importStar(require("./named-schedules.js"));
 const named_schedules_1 = require("./named-schedules.js");
-const ProductOrdersAPI = __importStar(require("./product-orders.js"));
+const ProductOrdersAPI = tslib_1.__importStar(require("./product-orders.js"));
 const product_orders_1 = require("./product-orders.js");
-const RatesAPI = __importStar(require("./rates.js"));
+const RatesAPI = tslib_1.__importStar(require("./rates.js"));
 const rates_1 = require("./rates.js");
-const pagination_1 = require("../../../../pagination.js");
+const pagination_1 = require("../../../../core/pagination.js");
 class RateCards extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -42,7 +19,39 @@ class RateCards extends resource_1.APIResource {
         this.namedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
     }
     /**
-     * Create a new rate card
+     * In Metronome, the rate card is the central location for your pricing. Rate cards
+     * were built with new product launches and pricing changes in mind - you can
+     * update your products and pricing in one place, and that change will be
+     * automatically propagated across your customer cohorts. Most clients need only
+     * maintain one or a few rate cards within Metronome.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Create a rate card with a name and description
+     * - Define the rate card's single underlying fiat currency, and any number of
+     *   conversion rates between that fiat currency and custom pricing units. You can
+     *   then add products and associated rates in the fiat currency or custom pricing
+     *   unit for which you have defined a conversion rate.
+     * - Set aliases for the rate card. Aliases are human-readable names that you can
+     *   use in the place of the id of the rate card when provisioning a customer's
+     *   contract. By using an alias, you can easily create a contract and provision a
+     *   customer by choosing the paygo rate card, without storing the rate card id in
+     *   your internal systems. This is helpful when launching a new rate card for
+     *   paygo customers, you can update the alias for paygo to be scheduled to be
+     *   assigned to the new rate card without updating your code.
+     *
+     * ### Key response fields:
+     *
+     * - The ID of the rate card you just created
+     *
+     * ### Usage guidelines:
+     *
+     * - After creating a rate card, you can now use the addRate or addRates endpoints
+     *   to add products and their prices to it
+     * - A rate card alias can only be used by one rate card at a time. If you create a
+     *   contract with a rate card alias that is already in use by another rate card,
+     *   the original rate card's alias schedule will be updated. The alias will
+     *   reference the rate card to which it was most recently assigned.
      *
      * @example
      * ```ts
@@ -68,8 +77,9 @@ class RateCards extends resource_1.APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/create', { body, ...options });
     }
     /**
-     * Get a specific rate card NOTE: Use `/contract-pricing/rate-cards/getRates` to
-     * retrieve rate card rates.
+     * Return details for a specific rate card including name, description, and
+     * aliases. This endpoint does not return rates - use the dedicated getRates or
+     * getRateSchedule endpoints to understand the rates on a rate card.
      *
      * @example
      * ```ts
@@ -83,7 +93,58 @@ class RateCards extends resource_1.APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/get', { body, ...options });
     }
     /**
-     * Update a rate card
+     * Update the metadata properties of an existing rate card, including its name,
+     * description, and aliases. This endpoint is designed for managing rate card
+     * identity and reference aliases rather than modifying pricing rates.
+     *
+     * Modifies the descriptive properties and alias configuration of a rate card
+     * without affecting the underlying pricing rates or schedules. This allows you to
+     * update how a rate card is identified and referenced throughout your system.
+     *
+     * ### Use this endpoint to:
+     *
+     * - Rate card renaming: Update display names or descriptions for organizational
+     *   clarity
+     * - Alias management: Add, modify, or schedule alias transitions for seamless rate
+     *   card migrations
+     * - Documentation updates: Keep rate card descriptions current with business
+     *   context
+     * - Self-serve provisioning setup: Configure aliases to enable code-free rate card
+     *   transitions
+     *
+     * #### Active contract impact:
+     *
+     * - Alias changes: Already-created contracts continue using their originally
+     *   assigned rate cards.
+     * - Other changes made using this endpoint will only impact the Metronome UI.
+     *
+     * #### Grandfathering existing PLG customer pricing:
+     *
+     * - Rate card aliases support scheduled transitions, enabling seamless rate card
+     *   migrations for new customers, allowing existing customers to be grandfathered
+     *   into their existing prices without code. Note that there are multiple
+     *   mechanisms to support grandfathering in Metronome.
+     *
+     * #### How scheduled aliases work for PLG grandfathering:
+     *
+     * Initial setup:
+     *
+     * - Add alias to current rate card: Assign a stable alias (e.g.,
+     *   "standard-pricing") to your active rate card
+     * - Reference alias during contract creation: Configure your self-serve workflow
+     *   to create contracts using `rate_card_alias` instead of direct `rate_card_id`
+     * - Automatic resolution: New contracts referencing the alias automatically
+     *   resolve to the rate card associated with the alias at the point in time of
+     *   provisioning
+     *
+     * #### Grandfathering process:
+     *
+     * - Create new rate card: Build your new rate card with updated pricing structure
+     * - Schedule alias transition: Add the same alias to the new rate card with a
+     *   `starting_at` timestamp
+     * - Automatic cutover: Starting at the scheduled time, new contracts created in
+     *   your PLG workflow using that alias will automatically reference the new rate
+     *   card
      *
      * @example
      * ```ts
@@ -99,12 +160,22 @@ class RateCards extends resource_1.APIResource {
     update(body, options) {
         return this._client.post('/v1/contract-pricing/rate-cards/update', { body, ...options });
     }
-    list(params, options) {
-        if ((0, core_1.isRequestOptions)(params)) {
-            return this.list(undefined, params);
-        }
+    /**
+     * List all rate cards. Returns rate card IDs, names, descriptions, aliases, and
+     * other details. To view the rates associated with a given rate card, use the
+     * getRates or getRateSchedule endpoints.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const rateCardListResponse of client.v1.contracts.rateCards.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params = undefined, options) {
         const { limit, next_page, body } = params ?? {};
-        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
+        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', (pagination_1.CursorPage), {
             query: { limit, next_page },
             body: body,
             method: 'post',
@@ -112,7 +183,11 @@ class RateCards extends resource_1.APIResource {
         });
     }
     /**
-     * Archive a rate card
+     * Permanently disable a rate card by archiving it, preventing use in new contracts
+     * while preserving existing contract pricing. Use this when retiring old pricing
+     * models, consolidating rate cards, or removing outdated pricing structures.
+     * Returns the archived rate card ID and stops the rate card from appearing in
+     * contract creation workflows.
      *
      * @example
      * ```ts
@@ -126,8 +201,18 @@ class RateCards extends resource_1.APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/archive', { body, ...options });
     }
     /**
-     * Get all rates for a rate card from starting_at (either in perpetuity or until
-     * ending_before, if provided)
+     * A rate card defines the prices that you charge for your products. Rate cards
+     * support scheduled changes over time, to allow you to easily roll out pricing
+     * changes and new product launches across your customer base. Use this endpoint to
+     * understand the rate schedule `starting_at` a given date, optionally filtering
+     * the list of rates returned based on product id or pricing group values. For
+     * example, you may want to display a schedule of upcoming price changes for a
+     * given product in your product experience - use this endpoint to fetch that
+     * information from its source of truth in Metronome.
+     *
+     * If you want to understand the rates for a specific customer's contract,
+     * inclusive of contract-level overrides, use the `getContractRateSchedule`
+     * endpoint.
      *
      * @example
      * ```ts
@@ -157,12 +242,7 @@ class RateCards extends resource_1.APIResource {
     }
 }
 exports.RateCards = RateCards;
-class RateCardListResponsesCursorPage extends pagination_1.CursorPage {
-}
-exports.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
-RateCards.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
 RateCards.ProductOrders = product_orders_1.ProductOrders;
 RateCards.Rates = rates_1.Rates;
-RateCards.RateListResponsesCursorPage = rates_1.RateListResponsesCursorPage;
 RateCards.NamedSchedules = named_schedules_1.NamedSchedules;
 //# sourceMappingURL=rate-cards.js.map

package/resources/v1/contracts/rate-cards/rate-cards.js.map

@@ -1 +1 @@
-{"version":3,"file":"rate-cards.js","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,sDAAmD;AACnD,8CAAoD;AAGpD,wEAAuD;AACvD,0DAK2B;AAC3B,sEAAqD;AACrD,wDAM0B;AAC1B,qDAAoC;AACpC,sCASiB;AACjB,0DAA2E;AAE3E,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwJxG,CAAC;IAtJC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAqBD,IAAI,CACF,MAAiD,EACjD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sCAAsC,EAAE,+BAA+B,EAAE;YACtG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAA6B;QAE7B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE;YAC1E,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3JD,8BA2JC;AAED,MAAa,+BAAgC,SAAQ,uBAAgC;CAAG;AAAxF,0EAAwF;AA6SxF,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAC5E,SAAS,CAAC,aAAa,GAAG,8BAAa,CAAC;AACxC,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,2BAA2B,GAAG,mCAA2B,CAAC;AACpE,SAAS,CAAC,cAAc,GAAG,gCAAc,CAAC"}
+{"version":3,"file":"rate-cards.js","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,2DAAwD;AAExD,gFAAuD;AACvD,0DAK2B;AAC3B,8EAAqD;AACrD,wDAM0B;AAC1B,6DAAoC;AACpC,sCASiB;AAEjB,+DAA6F;AAG7F,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2OxG,CAAC;IAzOC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,IAA4B,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAgD,SAAS,EACzD,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sCAAsC,EAAE,CAAA,uBAAgC,CAAA,EAAE;YACvG,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,oBAAoB,CAClB,MAA0C,EAC1C,OAAwB;QAExB,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE;YAC1E,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9OD,8BA8OC;AAuSD,SAAS,CAAC,aAAa,GAAG,8BAAa,CAAC;AACxC,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,cAAc,GAAG,gCAAc,CAAC"}