@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/resources/{contracts → v1/contracts}/rate-cards/rate-cards.d.ts

@@ -1,38 +1,116 @@
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
-import * as Shared from "../../shared.js";
+import { APIResource } from "../../../../resource.js";
+import * as Core from "../../../../core.js";
+import * as Shared from "../../../shared.js";
 import * as NamedSchedulesAPI from "./named-schedules.js";
 import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.js";
 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 { CursorPage, type CursorPageParams } from "../../../../pagination.js";
 export declare class RateCards extends APIResource {
     productOrders: ProductOrdersAPI.ProductOrders;
     rates: RatesAPI.Rates;
     namedSchedules: NamedSchedulesAPI.NamedSchedules;
     /**
      * Create a new rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.create(
+     *   {
+     *     name: 'My Rate Card',
+     *     aliases: [{ name: 'my-rate-card' }],
+     *     credit_type_conversions: [
+     *       {
+     *         custom_credit_type_id:
+     *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *         fiat_per_custom_credit: 2,
+     *       },
+     *     ],
+     *     description: 'My Rate Card Description',
+     *     fiat_credit_type_id:
+     *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     * );
+     * ```
      */
     create(body: RateCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardCreateResponse>;
     /**
      * Get a specific rate card NOTE: Use `/contract-pricing/rate-cards/getRates` to
      * retrieve rate card rates.
+     *
+     * @example
+     * ```ts
+     * const rateCard =
+     *   await client.v1.contracts.rateCards.retrieve({
+     *     id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *   });
+     * ```
      */
     retrieve(body: RateCardRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<RateCardRetrieveResponse>;
     /**
      * Update a rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.update(
+     *   {
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     description: 'My Updated Rate Card Description',
+     *     name: 'My Updated Rate Card',
+     *   },
+     * );
+     * ```
      */
     update(body: RateCardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardUpdateResponse>;
     /**
      * List rate cards NOTE: Use `/contract-pricing/rate-cards/getRates` to retrieve
      * rate card rates.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const rateCardListResponse of client.v1.contracts.rateCards.list()) {
+     *   // ...
+     * }
+     * ```
      */
-    list(params: RateCardListParams, options?: Core.RequestOptions): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+    list(params?: RateCardListParams, options?: Core.RequestOptions): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+    list(options?: Core.RequestOptions): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+    /**
+     * Archive a rate card
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.archive({
+     *     id: '12b21470-4570-40df-8998-449d0b0bc52f',
+     *   });
+     * ```
+     */
+    archive(body: RateCardArchiveParams, options?: Core.RequestOptions): Core.APIPromise<RateCardArchiveResponse>;
     /**
      * Get all rates for a rate card from starting_at (either in perpetuity or until
      * ending_before, if provided)
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.retrieveRateSchedule({
+     *     rate_card_id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *     starting_at: '2024-01-01T00:00:00.000Z',
+     *     selectors: [
+     *       {
+     *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+     *         partial_pricing_group_values: {
+     *           region: 'us-west-2',
+     *           cloud: 'aws',
+     *         },
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     retrieveRateSchedule(params: RateCardRetrieveRateScheduleParams, options?: Core.RequestOptions): Core.APIPromise<RateCardRetrieveRateScheduleResponse>;
 }
@@ -52,7 +130,9 @@ export declare namespace RateCardRetrieveResponse {
         name: string;
         aliases?: Array<Data.Alias>;
         credit_type_conversions?: Array<Data.CreditTypeConversion>;
-        custom_fields?: Record<string, string>;
+        custom_fields?: {
+            [key: string]: string;
+        };
         description?: string;
         fiat_credit_type?: Shared.CreditTypeData;
     }
@@ -78,7 +158,9 @@ export interface RateCardListResponse {
     name: string;
     aliases?: Array<RateCardListResponse.Alias>;
     credit_type_conversions?: Array<RateCardListResponse.CreditTypeConversion>;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     description?: string;
     fiat_credit_type?: Shared.CreditTypeData;
 }
@@ -93,6 +175,9 @@ export declare namespace RateCardListResponse {
         fiat_per_custom_credit: string;
     }
 }
+export interface RateCardArchiveResponse {
+    data: Shared.ID;
+}
 export interface RateCardRetrieveRateScheduleResponse {
     data: Array<RateCardRetrieveRateScheduleResponse.Data>;
     next_page?: string | null;
@@ -100,19 +185,24 @@ export interface RateCardRetrieveRateScheduleResponse {
 export declare namespace RateCardRetrieveRateScheduleResponse {
     interface Data {
         entitled: boolean;
-        product_custom_fields: Record<string, string>;
+        product_custom_fields: {
+            [key: string]: string;
+        };
         product_id: string;
         product_name: string;
         product_tags: Array<string>;
         rate: Shared.Rate;
         starting_at: string;
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
         /**
          * 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;
         ending_before?: string;
-        pricing_group_values?: Record<string, string>;
+        pricing_group_values?: {
+            [key: string]: string;
+        };
     }
     namespace Data {
         /**
@@ -147,7 +237,9 @@ export interface RateCardCreateParams {
      * Required when using custom pricing units in rates.
      */
     credit_type_conversions?: Array<RateCardCreateParams.CreditTypeConversion>;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     description?: string;
     /**
      * The Metronome ID of the credit type to associate with the rate card, defaults to
@@ -197,7 +289,10 @@ export interface RateCardListParams extends CursorPageParams {
     /**
      * Body param:
      */
-    body: unknown;
+    body?: unknown;
+}
+export interface RateCardArchiveParams {
+    id: string;
 }
 export interface RateCardRetrieveRateScheduleParams {
     /**
@@ -230,16 +325,25 @@ export interface RateCardRetrieveRateScheduleParams {
 }
 export declare namespace RateCardRetrieveRateScheduleParams {
     interface Selector {
+        /**
+         * Subscription rates matching the billing frequency will be included in the
+         * response.
+         */
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
         /**
          * List of pricing group key value pairs, rates containing the matching key / value
          * pairs will be included in the response.
          */
-        partial_pricing_group_values?: Record<string, string>;
+        partial_pricing_group_values?: {
+            [key: string]: string;
+        };
         /**
          * List of pricing group key value pairs, rates matching all of the key / value
          * pairs will be included in the response.
          */
-        pricing_group_values?: Record<string, string>;
+        pricing_group_values?: {
+            [key: string]: string;
+        };
         /**
          * Rates matching the product id will be included in the response.
          */
@@ -247,7 +351,7 @@ 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 RateCardRetrieveRateScheduleResponse as RateCardRetrieveRateScheduleResponse, RateCardListResponsesCursorPage as RateCardListResponsesCursorPage, type RateCardCreateParams as RateCardCreateParams, type RateCardRetrieveParams as RateCardRetrieveParams, type RateCardUpdateParams as RateCardUpdateParams, type RateCardListParams as RateCardListParams, 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, 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 { NamedSchedules as NamedSchedules, type NamedScheduleRetrieveResponse as NamedScheduleRetrieveResponse, type NamedScheduleRetrieveParams as NamedScheduleRetrieveParams, type NamedScheduleUpdateParams as NamedScheduleUpdateParams, };

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

@@ -0,0 +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"}

package/resources/{contracts → v1/contracts}/rate-cards/rate-cards.js

@@ -25,14 +25,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RateCardListResponsesCursorPage = exports.RateCards = void 0;
-const resource_1 = require("../../../resource.js");
+const resource_1 = require("../../../../resource.js");
+const core_1 = require("../../../../core.js");
 const NamedSchedulesAPI = __importStar(require("./named-schedules.js"));
 const named_schedules_1 = require("./named-schedules.js");
 const ProductOrdersAPI = __importStar(require("./product-orders.js"));
 const product_orders_1 = require("./product-orders.js");
 const RatesAPI = __importStar(require("./rates.js"));
 const rates_1 = require("./rates.js");
-const pagination_1 = require("../../../pagination.js");
+const pagination_1 = require("../../../../pagination.js");
 class RateCards extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -42,43 +43,113 @@ class RateCards extends resource_1.APIResource {
     }
     /**
      * Create a new rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.create(
+     *   {
+     *     name: 'My Rate Card',
+     *     aliases: [{ name: 'my-rate-card' }],
+     *     credit_type_conversions: [
+     *       {
+     *         custom_credit_type_id:
+     *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *         fiat_per_custom_credit: 2,
+     *       },
+     *     ],
+     *     description: 'My Rate Card Description',
+     *     fiat_credit_type_id:
+     *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     * );
+     * ```
      */
     create(body, options) {
-        return this._client.post('/contract-pricing/rate-cards/create', { body, ...options });
+        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.
+     *
+     * @example
+     * ```ts
+     * const rateCard =
+     *   await client.v1.contracts.rateCards.retrieve({
+     *     id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *   });
+     * ```
      */
     retrieve(body, options) {
-        return this._client.post('/contract-pricing/rate-cards/get', { body, ...options });
+        return this._client.post('/v1/contract-pricing/rate-cards/get', { body, ...options });
     }
     /**
      * Update a rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.update(
+     *   {
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     description: 'My Updated Rate Card Description',
+     *     name: 'My Updated Rate Card',
+     *   },
+     * );
+     * ```
      */
     update(body, options) {
-        return this._client.post('/contract-pricing/rate-cards/update', { body, ...options });
+        return this._client.post('/v1/contract-pricing/rate-cards/update', { body, ...options });
     }
-    /**
-     * List rate cards NOTE: Use `/contract-pricing/rate-cards/getRates` to retrieve
-     * rate card rates.
-     */
     list(params, options) {
-        const { body, limit, next_page } = params;
-        return this._client.getAPIList('/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.list(undefined, params);
+        }
+        const { limit, next_page, body } = params ?? {};
+        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
             query: { limit, next_page },
             body: body,
             method: 'post',
             ...options,
         });
     }
+    /**
+     * Archive a rate card
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.archive({
+     *     id: '12b21470-4570-40df-8998-449d0b0bc52f',
+     *   });
+     * ```
+     */
+    archive(body, options) {
+        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)
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.retrieveRateSchedule({
+     *     rate_card_id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *     starting_at: '2024-01-01T00:00:00.000Z',
+     *     selectors: [
+     *       {
+     *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+     *         partial_pricing_group_values: {
+     *           region: 'us-west-2',
+     *           cloud: 'aws',
+     *         },
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     retrieveRateSchedule(params, options) {
         const { limit, next_page, ...body } = params;
-        return this._client.post('/contract-pricing/rate-cards/getRateSchedule', {
+        return this._client.post('/v1/contract-pricing/rate-cards/getRateSchedule', {
             query: { limit, next_page },
             body,
             ...options,

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

@@ -0,0 +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"}

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

@@ -0,0 +1,140 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../../resource.mjs";
+import { isRequestOptions } from "../../../../core.mjs";
+import * as NamedSchedulesAPI from "./named-schedules.mjs";
+import { NamedSchedules, } from "./named-schedules.mjs";
+import * as ProductOrdersAPI from "./product-orders.mjs";
+import { ProductOrders, } from "./product-orders.mjs";
+import * as RatesAPI from "./rates.mjs";
+import { RateListResponsesCursorPage, Rates, } from "./rates.mjs";
+import { CursorPage } from "../../../../pagination.mjs";
+export class RateCards extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.productOrders = new ProductOrdersAPI.ProductOrders(this._client);
+        this.rates = new RatesAPI.Rates(this._client);
+        this.namedSchedules = new NamedSchedulesAPI.NamedSchedules(this._client);
+    }
+    /**
+     * Create a new rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.create(
+     *   {
+     *     name: 'My Rate Card',
+     *     aliases: [{ name: 'my-rate-card' }],
+     *     credit_type_conversions: [
+     *       {
+     *         custom_credit_type_id:
+     *           '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *         fiat_per_custom_credit: 2,
+     *       },
+     *     ],
+     *     description: 'My Rate Card Description',
+     *     fiat_credit_type_id:
+     *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     * );
+     * ```
+     */
+    create(body, options) {
+        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.
+     *
+     * @example
+     * ```ts
+     * const rateCard =
+     *   await client.v1.contracts.rateCards.retrieve({
+     *     id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *   });
+     * ```
+     */
+    retrieve(body, options) {
+        return this._client.post('/v1/contract-pricing/rate-cards/get', { body, ...options });
+    }
+    /**
+     * Update a rate card
+     *
+     * @example
+     * ```ts
+     * const rateCard = await client.v1.contracts.rateCards.update(
+     *   {
+     *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     description: 'My Updated Rate Card Description',
+     *     name: 'My Updated Rate Card',
+     *   },
+     * );
+     * ```
+     */
+    update(body, options) {
+        return this._client.post('/v1/contract-pricing/rate-cards/update', { body, ...options });
+    }
+    list(params, options) {
+        if (isRequestOptions(params)) {
+            return this.list(undefined, params);
+        }
+        const { limit, next_page, body } = params ?? {};
+        return this._client.getAPIList('/v1/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
+            query: { limit, next_page },
+            body: body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Archive a rate card
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.archive({
+     *     id: '12b21470-4570-40df-8998-449d0b0bc52f',
+     *   });
+     * ```
+     */
+    archive(body, options) {
+        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)
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.contracts.rateCards.retrieveRateSchedule({
+     *     rate_card_id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+     *     starting_at: '2024-01-01T00:00:00.000Z',
+     *     selectors: [
+     *       {
+     *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+     *         partial_pricing_group_values: {
+     *           region: 'us-west-2',
+     *           cloud: 'aws',
+     *         },
+     *       },
+     *     ],
+     *   });
+     * ```
+     */
+    retrieveRateSchedule(params, options) {
+        const { limit, next_page, ...body } = params;
+        return this._client.post('/v1/contract-pricing/rate-cards/getRateSchedule', {
+            query: { limit, next_page },
+            body,
+            ...options,
+        });
+    }
+}
+export class RateCardListResponsesCursorPage extends CursorPage {
+}
+RateCards.RateCardListResponsesCursorPage = RateCardListResponsesCursorPage;
+RateCards.ProductOrders = ProductOrders;
+RateCards.Rates = Rates;
+RateCards.RateListResponsesCursorPage = RateListResponsesCursorPage;
+RateCards.NamedSchedules = NamedSchedules;
+//# sourceMappingURL=rate-cards.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rate-cards.mjs","sourceRoot":"","sources":["../../../../src/resources/v1/contracts/rate-cards/rate-cards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,KAAK,iBAAiB;OACtB,EAIL,cAAc,GACf;OACM,KAAK,gBAAgB;OACrB,EAKL,aAAa,GACd;OACM,KAAK,QAAQ;OACb,EAOL,2BAA2B,EAC3B,KAAK,GACN;OACM,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,SAAU,SAAQ,WAAW;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,gBAAgB,CAAC,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;AAED,MAAM,OAAO,+BAAgC,SAAQ,UAAgC;CAAG;AA6SxF,SAAS,CAAC,+BAA+B,GAAG,+BAA+B,CAAC;AAC5E,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC;AACxC,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;AACxB,SAAS,CAAC,2BAA2B,GAAG,2BAA2B,CAAC;AACpE,SAAS,CAAC,cAAc,GAAG,cAAc,CAAC"}