@metronome/sdk 0.1.0-beta.8 → 0.1.0

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

@@ -1,24 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
-import * as NamedSchedulesAPI from './named-schedules';
+import { APIResource } from "../../../../resource.js";
+import { isRequestOptions } from "../../../../core.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';
-import * as ProductOrdersAPI from './product-orders';
+} from "./named-schedules.js";
+import * as ProductOrdersAPI from "./product-orders.js";
 import {
   ProductOrderSetParams,
   ProductOrderSetResponse,
   ProductOrderUpdateParams,
   ProductOrderUpdateResponse,
   ProductOrders,
-} from './product-orders';
-import * as RatesAPI from './rates';
+} from "./product-orders.js";
+import * as RatesAPI from "./rates.js";
 import {
   RateAddManyParams,
   RateAddManyResponse,
@@ -28,8 +29,8 @@ import {
   RateListResponse,
   RateListResponsesCursorPage,
   Rates,
-} from './rates';
-import { CursorPage, type CursorPageParams } from '../../../pagination';
+} from "./rates.js";
+import { CursorPage, type CursorPageParams } from "../../../../pagination.js";
 
 export class RateCards extends APIResource {
   productOrders: ProductOrdersAPI.ProductOrders = new ProductOrdersAPI.ProductOrders(this._client);
@@ -38,39 +39,96 @@ export class RateCards extends 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: RateCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardCreateResponse> {
-    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: RateCardRetrieveParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RateCardRetrieveResponse> {
-    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: RateCardUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RateCardUpdateResponse> {
-    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.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const rateCardListResponse of client.v1.contracts.rateCards.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
-    params: RateCardListParams,
+    params?: RateCardListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse>;
+  list(
+    params?: RateCardListParams | Core.RequestOptions,
     options?: Core.RequestOptions,
   ): Core.PagePromise<RateCardListResponsesCursorPage, RateCardListResponse> {
-    const { body, limit, next_page } = params;
-    return this._client.getAPIList('/contract-pricing/rate-cards/list', RateCardListResponsesCursorPage, {
+    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',
@@ -78,16 +136,52 @@ export class RateCards extends APIResource {
     });
   }
 
+  /**
+   * 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> {
+    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: RateCardRetrieveRateScheduleParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RateCardRetrieveRateScheduleResponse> {
     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,
@@ -119,7 +213,7 @@ export namespace RateCardRetrieveResponse {
 
     credit_type_conversions?: Array<Data.CreditTypeConversion>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     description?: string;
 
@@ -160,7 +254,7 @@ export interface RateCardListResponse {
 
   credit_type_conversions?: Array<RateCardListResponse.CreditTypeConversion>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
@@ -183,6 +277,10 @@ export namespace RateCardListResponse {
   }
 }
 
+export interface RateCardArchiveResponse {
+  data: Shared.ID;
+}
+
 export interface RateCardRetrieveRateScheduleResponse {
   data: Array<RateCardRetrieveRateScheduleResponse.Data>;
 
@@ -193,7 +291,7 @@ export namespace RateCardRetrieveRateScheduleResponse {
   export interface Data {
     entitled: boolean;
 
-    product_custom_fields: Record<string, string>;
+    product_custom_fields: { [key: string]: string };
 
     product_id: string;
 
@@ -205,6 +303,8 @@ export namespace RateCardRetrieveRateScheduleResponse {
 
     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.
@@ -213,7 +313,7 @@ export namespace RateCardRetrieveRateScheduleResponse {
 
     ending_before?: string;
 
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
   }
 
   export namespace Data {
@@ -255,7 +355,7 @@ export interface RateCardCreateParams {
    */
   credit_type_conversions?: Array<RateCardCreateParams.CreditTypeConversion>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
@@ -321,7 +421,11 @@ export interface RateCardListParams extends CursorPageParams {
   /**
    * Body param:
    */
-  body: unknown;
+  body?: unknown;
+}
+
+export interface RateCardArchiveParams {
+  id: string;
 }
 
 export interface RateCardRetrieveRateScheduleParams {
@@ -361,17 +465,23 @@ export interface RateCardRetrieveRateScheduleParams {
 
 export namespace RateCardRetrieveRateScheduleParams {
   export 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.
@@ -392,12 +502,14 @@ export declare namespace RateCards {
     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,
   };
 

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

@@ -1,20 +1,42 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
-import { CursorPage, type CursorPageParams } from '../../../pagination';
+import { APIResource } from "../../../../resource.js";
+import * as Core from "../../../../core.js";
+import * as Shared from "../../../shared.js";
+import { CursorPage, type CursorPageParams } from "../../../../pagination.js";
 
 export class Rates extends APIResource {
   /**
    * Get all rates for a rate card at a point in time
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const rateListResponse of client.v1.contracts.rateCards.rates.list(
+   *   {
+   *     at: '2024-01-01T00:00:00.000Z',
+   *     rate_card_id: 'f3d51ae8-f283-44e1-9933-a3cf9ad7a6fe',
+   *     selectors: [
+   *       {
+   *         product_id: 'd6300dbb-882e-4d2d-8dec-5125d16b65d0',
+   *         partial_pricing_group_values: {
+   *           region: 'us-west-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *     ],
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: RateListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<RateListResponsesCursorPage, RateListResponse> {
     const { limit, next_page, ...body } = params;
-    return this._client.getAPIList('/contract-pricing/rate-cards/getRates', RateListResponsesCursorPage, {
+    return this._client.getAPIList('/v1/contract-pricing/rate-cards/getRates', RateListResponsesCursorPage, {
       query: { limit, next_page },
       body,
       method: 'post',
@@ -24,16 +46,62 @@ export class Rates extends APIResource {
 
   /**
    * Add a new rate
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.rateCards.rates.add({
+   *     entitled: true,
+   *     product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     rate_type: 'FLAT',
+   *     starting_at: '2020-01-01T00:00:00.000Z',
+   *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+   *     price: 100,
+   *   });
+   * ```
    */
   add(body: RateAddParams, options?: Core.RequestOptions): Core.APIPromise<RateAddResponse> {
-    return this._client.post('/contract-pricing/rate-cards/addRate', { body, ...options });
+    return this._client.post('/v1/contract-pricing/rate-cards/addRate', { body, ...options });
   }
 
   /**
    * Add new rates
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.rateCards.rates.addMany({
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     rates: [
+   *       {
+   *         product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         starting_at: '2020-01-01T00:00:00.000Z',
+   *         entitled: true,
+   *         rate_type: 'FLAT',
+   *         price: 100,
+   *         pricing_group_values: {
+   *           region: 'us-west-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *       {
+   *         product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         starting_at: '2020-01-01T00:00:00.000Z',
+   *         entitled: true,
+   *         rate_type: 'FLAT',
+   *         price: 120,
+   *         pricing_group_values: {
+   *           region: 'us-east-2',
+   *           cloud: 'aws',
+   *         },
+   *       },
+   *     ],
+   *   });
+   * ```
    */
   addMany(body: RateAddManyParams, options?: Core.RequestOptions): Core.APIPromise<RateAddManyResponse> {
-    return this._client.post('/contract-pricing/rate-cards/addRates', { body, ...options });
+    return this._client.post('/v1/contract-pricing/rate-cards/addRates', { body, ...options });
   }
 }
 
@@ -42,7 +110,7 @@ export class RateListResponsesCursorPage extends CursorPage<RateListResponse> {}
 export interface RateListResponse {
   entitled: boolean;
 
-  product_custom_fields: Record<string, string>;
+  product_custom_fields: { [key: string]: string };
 
   product_id: string;
 
@@ -54,6 +122,8 @@ export interface RateListResponse {
 
   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.
@@ -62,7 +132,7 @@ export interface RateListResponse {
 
   ending_before?: string;
 
-  pricing_group_values?: Record<string, string>;
+  pricing_group_values?: { [key: string]: string };
 }
 
 export namespace RateListResponse {
@@ -105,7 +175,7 @@ export namespace RateAddResponse {
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
      * processors.
      */
-    custom_rate?: Record<string, unknown>;
+    custom_rate?: { [key: string]: unknown };
 
     /**
      * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -123,7 +193,7 @@ export namespace RateAddResponse {
      * if pricing groups are used, this will contain the values used to calculate the
      * price
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
@@ -192,17 +262,23 @@ export interface RateListParams extends CursorPageParams {
 
 export namespace RateListParams {
   export 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.
@@ -237,6 +313,12 @@ export interface RateAddParams {
    */
   starting_at: string;
 
+  /**
+   * Optional. Frequency to bill subscriptions with. Required for subscription type
+   * products with Flat rate.
+   */
+  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.
@@ -254,7 +336,7 @@ export interface RateAddParams {
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
    * processors.
    */
-  custom_rate?: Record<string, unknown>;
+  custom_rate?: { [key: string]: unknown };
 
   /**
    * exclusive end date
@@ -278,7 +360,7 @@ export interface RateAddParams {
    * Optional. List of pricing group key value pairs which will be used to calculate
    * the price.
    */
-  pricing_group_values?: Record<string, string>;
+  pricing_group_values?: { [key: string]: string };
 
   /**
    * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
@@ -340,6 +422,12 @@ export namespace RateAddManyParams {
      */
     starting_at: string;
 
+    /**
+     * Optional. Frequency to bill subscriptions with. Required for subscription type
+     * products with Flat rate.
+     */
+    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.
@@ -357,7 +445,7 @@ export namespace RateAddManyParams {
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
      * processors.
      */
-    custom_rate?: Record<string, unknown>;
+    custom_rate?: { [key: string]: unknown };
 
     /**
      * exclusive end date
@@ -381,7 +469,7 @@ export namespace RateAddManyParams {
      * Optional. List of pricing group key value pairs which will be used to calculate
      * the price.
      */
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     /**
      * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

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

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from "./rate-cards/index.js";

package/src/resources/v1/contracts.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from "./contracts/index.js";