@metronome/sdk 0.1.0-beta.9 → 0.1.0

package/src/resources/v1/contracts/index.ts

@@ -10,6 +10,7 @@ export {
   type ContractCreateHistoricalInvoicesResponse,
   type ContractListBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
+  type ContractRetrieveSubscriptionQuantityHistoryResponse,
   type ContractScheduleProServicesInvoiceResponse,
   type ContractUpdateEndDateResponse,
   type ContractCreateParams,
@@ -21,16 +22,17 @@ export {
   type ContractCreateHistoricalInvoicesParams,
   type ContractListBalancesParams,
   type ContractRetrieveRateScheduleParams,
+  type ContractRetrieveSubscriptionQuantityHistoryParams,
   type ContractScheduleProServicesInvoiceParams,
   type ContractSetUsageFilterParams,
   type ContractUpdateEndDateParams,
-} from './contracts';
+} from "./contracts.js";
 export {
   NamedSchedules,
   type NamedScheduleRetrieveResponse,
   type NamedScheduleRetrieveParams,
   type NamedScheduleUpdateParams,
-} from './named-schedules';
+} from "./named-schedules.js";
 export {
   ProductListResponsesCursorPage,
   Products,
@@ -47,7 +49,7 @@ export {
   type ProductUpdateParams,
   type ProductListParams,
   type ProductArchiveParams,
-} from './products';
+} from "./products.js";
 export {
   RateCardListResponsesCursorPage,
   RateCards,
@@ -55,10 +57,12 @@ export {
   type RateCardRetrieveResponse,
   type RateCardUpdateResponse,
   type RateCardListResponse,
+  type RateCardArchiveResponse,
   type RateCardRetrieveRateScheduleResponse,
   type RateCardCreateParams,
   type RateCardRetrieveParams,
   type RateCardUpdateParams,
   type RateCardListParams,
+  type RateCardArchiveParams,
   type RateCardRetrieveRateScheduleParams,
-} from './rate-cards/index';
+} from "./rate-cards/index.js";

package/src/resources/v1/contracts/named-schedules.ts

@@ -1,12 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
 
 export class NamedSchedules extends APIResource {
   /**
    * Get a named schedule for the given rate card. This endpoint's availability is
    * dependent on your client's configuration.
+   *
+   * @example
+   * ```ts
+   * const namedSchedule =
+   *   await client.v1.contracts.namedSchedules.retrieve({
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *     schedule_name: 'my-schedule',
+   *     covering_date: '2022-02-15T00:00:00Z',
+   *   });
+   * ```
    */
   retrieve(
     body: NamedScheduleRetrieveParams,
@@ -18,6 +28,17 @@ export class NamedSchedules extends APIResource {
   /**
    * Update a named schedule for the given rate card. This endpoint's availability is
    * dependent on your client's configuration.
+   *
+   * @example
+   * ```ts
+   * await client.v1.contracts.namedSchedules.update({
+   *   rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   schedule_name: 'my-schedule',
+   *   starting_at: '2022-02-01T00:00:00Z',
+   *   value: { my_key: 'my_value' },
+   *   ending_before: '2022-02-15T00:00:00Z',
+   * });
+   * ```
    */
   update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {

package/src/resources/v1/contracts/products.ts

@@ -1,15 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { isRequestOptions } from '../../../core';
-import * as Core from '../../../core';
-import * as ProductsAPI from './products';
-import * as Shared from '../../shared';
-import { CursorPage, type CursorPageParams } from '../../../pagination';
+import { APIResource } from "../../../resource.js";
+import { isRequestOptions } from "../../../core.js";
+import * as Core from "../../../core.js";
+import * as ProductsAPI from "./products.js";
+import * as Shared from "../../shared.js";
+import { CursorPage, type CursorPageParams } from "../../../pagination.js";
 
 export class Products extends APIResource {
   /**
    * Create a new product
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.contracts.products.create({
+   *   name: 'My Product',
+   *   type: 'USAGE',
+   *   billable_metric_id:
+   *     '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   * });
+   * ```
    */
   create(body: ProductCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProductCreateResponse> {
     return this._client.post('/v1/contract-pricing/products/create', { body, ...options });
@@ -17,6 +27,13 @@ export class Products extends APIResource {
 
   /**
    * Get a specific product
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.contracts.products.retrieve(
+   *   { id: 'd84e7f4e-7a70-4fe4-be02-7a5027beffcc' },
+   * );
+   * ```
    */
   retrieve(
     body: ProductRetrieveParams,
@@ -27,6 +44,15 @@ export class Products extends APIResource {
 
   /**
    * Update a product
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.contracts.products.update({
+   *   product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   starting_at: '2020-01-01T00:00:00.000Z',
+   *   name: 'My Updated Product',
+   * });
+   * ```
    */
   update(body: ProductUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ProductUpdateResponse> {
     return this._client.post('/v1/contract-pricing/products/update', { body, ...options });
@@ -34,6 +60,16 @@ export class Products extends APIResource {
 
   /**
    * List products
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const productListResponse of client.v1.contracts.products.list(
+   *   { archive_filter: 'NOT_ARCHIVED' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params?: ProductListParams,
@@ -58,6 +94,13 @@ export class Products extends APIResource {
 
   /**
    * Archive a product
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.contracts.products.archive(
+   *   { product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+   * );
+   * ```
    */
   archive(
     body: ProductArchiveParams,
@@ -198,7 +241,7 @@ export namespace ProductRetrieveResponse {
 
     archived_at?: string | null;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
   }
 
   export namespace Data {
@@ -287,7 +330,7 @@ export interface ProductListResponse {
 
   archived_at?: string | null;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 }
 
 export namespace ProductListResponse {
@@ -550,7 +593,8 @@ export interface ProductUpdateParams {
 
 export interface ProductListParams extends CursorPageParams {
   /**
-   * Body param: Filter options for the product list
+   * Body param: Filter options for the product list. If not provided, defaults to
+   * not archived.
    */
   archive_filter?: 'ARCHIVED' | 'NOT_ARCHIVED' | 'ALL';
 }

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

@@ -5,14 +5,14 @@ export {
   type NamedScheduleRetrieveResponse,
   type NamedScheduleRetrieveParams,
   type NamedScheduleUpdateParams,
-} from './named-schedules';
+} from "./named-schedules.js";
 export {
   ProductOrders,
   type ProductOrderUpdateResponse,
   type ProductOrderSetResponse,
   type ProductOrderUpdateParams,
   type ProductOrderSetParams,
-} from './product-orders';
+} from "./product-orders.js";
 export {
   RateCardListResponsesCursorPage,
   RateCards,
@@ -20,13 +20,15 @@ export {
   type RateCardRetrieveResponse,
   type RateCardUpdateResponse,
   type RateCardListResponse,
+  type RateCardArchiveResponse,
   type RateCardRetrieveRateScheduleResponse,
   type RateCardCreateParams,
   type RateCardRetrieveParams,
   type RateCardUpdateParams,
   type RateCardListParams,
+  type RateCardArchiveParams,
   type RateCardRetrieveRateScheduleParams,
-} from './rate-cards';
+} from "./rate-cards.js";
 export {
   RateListResponsesCursorPage,
   Rates,
@@ -36,4 +38,4 @@ export {
   type RateListParams,
   type RateAddParams,
   type RateAddManyParams,
-} from './rates';
+} from "./rates.js";

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

@@ -1,12 +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 { APIResource } from "../../../../resource.js";
+import * as Core from "../../../../core.js";
 
 export class NamedSchedules extends APIResource {
   /**
    * Get a named schedule for the given contract. This endpoint's availability is
    * dependent on your client's configuration.
+   *
+   * @example
+   * ```ts
+   * const namedSchedule =
+   *   await client.v1.contracts.rateCards.namedSchedules.retrieve(
+   *     {
+   *       contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *       customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *       schedule_name: 'my-schedule',
+   *       covering_date: '2022-02-15T00:00:00Z',
+   *     },
+   *   );
+   * ```
    */
   retrieve(
     body: NamedScheduleRetrieveParams,
@@ -18,6 +31,18 @@ export class NamedSchedules extends APIResource {
   /**
    * Update a named schedule for the given contract. This endpoint's availability is
    * dependent on your client's configuration.
+   *
+   * @example
+   * ```ts
+   * await client.v1.contracts.rateCards.namedSchedules.update({
+   *   contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+   *   schedule_name: 'my-schedule',
+   *   starting_at: '2022-02-01T00:00:00Z',
+   *   value: { my_key: 'my_value' },
+   *   ending_before: '2022-02-15T00:00:00Z',
+   * });
+   * ```
    */
   update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/contracts/updateNamedSchedule', {

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

@@ -1,12 +1,30 @@
 // 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 { APIResource } from "../../../../resource.js";
+import * as Core from "../../../../core.js";
+import * as Shared from "../../../shared.js";
 
 export class ProductOrders extends APIResource {
   /**
    * Updates ordering of specified products
+   *
+   * @example
+   * ```ts
+   * const productOrder =
+   *   await client.v1.contracts.rateCards.productOrders.update({
+   *     product_moves: [
+   *       {
+   *         product_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *         position: 0,
+   *       },
+   *       {
+   *         product_id: 'b086f2f4-9851-4466-9ca0-30d53e6a42ac',
+   *         position: 1,
+   *       },
+   *     ],
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   });
+   * ```
    */
   update(
     body: ProductOrderUpdateParams,
@@ -17,6 +35,18 @@ export class ProductOrders extends APIResource {
 
   /**
    * Sets the ordering of products within a rate card
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.contracts.rateCards.productOrders.set({
+   *     product_order: [
+   *       '13117714-3f05-48e5-a6e9-a66093f13b4d',
+   *       'b086f2f4-9851-4466-9ca0-30d53e6a42ac',
+   *     ],
+   *     rate_card_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+   *   });
+   * ```
    */
   set(body: ProductOrderSetParams, options?: Core.RequestOptions): Core.APIPromise<ProductOrderSetResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/setRateCardProductsOrder', {

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

@@ -1,25 +1,25 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../../resource';
-import { isRequestOptions } from '../../../../core';
-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,
@@ -29,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);
@@ -39,6 +39,26 @@ 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('/v1/contract-pricing/rate-cards/create', { body, ...options });
@@ -47,6 +67,14 @@ export class RateCards extends APIResource {
   /**
    * 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,
@@ -57,6 +85,17 @@ export class RateCards extends APIResource {
 
   /**
    * 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('/v1/contract-pricing/rate-cards/update', { body, ...options });
@@ -65,6 +104,14 @@ export class RateCards extends APIResource {
   /**
    * 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,
@@ -89,9 +136,45 @@ 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,
@@ -130,7 +213,7 @@ export namespace RateCardRetrieveResponse {
 
     credit_type_conversions?: Array<Data.CreditTypeConversion>;
 
-    custom_fields?: Record<string, string>;
+    custom_fields?: { [key: string]: string };
 
     description?: string;
 
@@ -171,7 +254,7 @@ export interface RateCardListResponse {
 
   credit_type_conversions?: Array<RateCardListResponse.CreditTypeConversion>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
@@ -194,6 +277,10 @@ export namespace RateCardListResponse {
   }
 }
 
+export interface RateCardArchiveResponse {
+  data: Shared.ID;
+}
+
 export interface RateCardRetrieveRateScheduleResponse {
   data: Array<RateCardRetrieveRateScheduleResponse.Data>;
 
@@ -204,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;
 
@@ -216,7 +303,7 @@ export namespace RateCardRetrieveRateScheduleResponse {
 
     starting_at: string;
 
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * A distinct rate on the rate card. You can choose to use this rate rather than
@@ -226,7 +313,7 @@ export namespace RateCardRetrieveRateScheduleResponse {
 
     ending_before?: string;
 
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
   }
 
   export namespace Data {
@@ -268,7 +355,7 @@ export interface RateCardCreateParams {
    */
   credit_type_conversions?: Array<RateCardCreateParams.CreditTypeConversion>;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
@@ -337,6 +424,10 @@ export interface RateCardListParams extends CursorPageParams {
   body?: unknown;
 }
 
+export interface RateCardArchiveParams {
+  id: string;
+}
+
 export interface RateCardRetrieveRateScheduleParams {
   /**
    * Body param: ID of the rate card to get the schedule for
@@ -378,19 +469,19 @@ export namespace RateCardRetrieveRateScheduleParams {
      * Subscription rates matching the billing frequency will be included in the
      * response.
      */
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    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.
@@ -411,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,
   };