@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/src/resources/{contracts → 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/{contracts → v1/contracts}/named-schedules.ts

@@ -1,26 +1,47 @@
 // 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,
     options?: Core.RequestOptions,
   ): Core.APIPromise<NamedScheduleRetrieveResponse> {
-    return this._client.post('/contract-pricing/rate-cards/getNamedSchedule', { body, ...options });
+    return this._client.post('/v1/contract-pricing/rate-cards/getNamedSchedule', { body, ...options });
   }
 
   /**
    * 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('/contract-pricing/rate-cards/updateNamedSchedule', {
+    return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },

package/src/resources/{contracts → v1/contracts}/products.ts

@@ -1,39 +1,75 @@
 // 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('/contract-pricing/products/create', { body, ...options });
+    return this._client.post('/v1/contract-pricing/products/create', { body, ...options });
   }
 
   /**
    * Get a specific product
+   *
+   * @example
+   * ```ts
+   * const product = await client.v1.contracts.products.retrieve(
+   *   { id: 'd84e7f4e-7a70-4fe4-be02-7a5027beffcc' },
+   * );
+   * ```
    */
   retrieve(
     body: ProductRetrieveParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ProductRetrieveResponse> {
-    return this._client.post('/contract-pricing/products/get', { body, ...options });
+    return this._client.post('/v1/contract-pricing/products/get', { body, ...options });
   }
 
   /**
    * 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('/contract-pricing/products/update', { body, ...options });
+    return this._client.post('/v1/contract-pricing/products/update', { body, ...options });
   }
 
   /**
    * 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,
@@ -48,7 +84,7 @@ export class Products extends APIResource {
       return this.list({}, params);
     }
     const { limit, next_page, ...body } = params;
-    return this._client.getAPIList('/contract-pricing/products/list', ProductListResponsesCursorPage, {
+    return this._client.getAPIList('/v1/contract-pricing/products/list', ProductListResponsesCursorPage, {
       query: { limit, next_page },
       body,
       method: 'post',
@@ -58,12 +94,19 @@ 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,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ProductArchiveResponse> {
-    return this._client.post('/contract-pricing/products/archive', { body, ...options });
+    return this._client.post('/v1/contract-pricing/products/archive', { body, ...options });
   }
 }
 
@@ -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/{contracts → 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/{contracts → v1/contracts}/rate-cards/named-schedules.ts

@@ -1,26 +1,51 @@
 // 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,
     options?: Core.RequestOptions,
   ): Core.APIPromise<NamedScheduleRetrieveResponse> {
-    return this._client.post('/contracts/getNamedSchedule', { body, ...options });
+    return this._client.post('/v1/contracts/getNamedSchedule', { body, ...options });
   }
 
   /**
    * 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('/contracts/updateNamedSchedule', {
+    return this._client.post('/v1/contracts/updateNamedSchedule', {
       body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },

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

@@ -1,25 +1,58 @@
 // 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,
     options?: Core.RequestOptions,
   ): Core.APIPromise<ProductOrderUpdateResponse> {
-    return this._client.post('/contract-pricing/rate-cards/moveRateCardProducts', { body, ...options });
+    return this._client.post('/v1/contract-pricing/rate-cards/moveRateCardProducts', { body, ...options });
   }
 
   /**
    * 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('/contract-pricing/rate-cards/setRateCardProductsOrder', { body, ...options });
+    return this._client.post('/v1/contract-pricing/rate-cards/setRateCardProductsOrder', {
+      body,
+      ...options,
+    });
   }
 }