@metronome/sdk 0.3.0 → 2.0.0

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

@@ -26,15 +26,15 @@ export {
   type ContractScheduleProServicesInvoiceParams,
   type ContractSetUsageFilterParams,
   type ContractUpdateEndDateParams,
-} from "./contracts.js";
+  type ContractListBalancesResponsesBodyCursorPage,
+} from './contracts';
 export {
   NamedSchedules,
   type NamedScheduleRetrieveResponse,
   type NamedScheduleRetrieveParams,
   type NamedScheduleUpdateParams,
-} from "./named-schedules.js";
+} from './named-schedules';
 export {
-  ProductListResponsesCursorPage,
   Products,
   type ProductListItemState,
   type QuantityConversion,
@@ -49,9 +49,9 @@ export {
   type ProductUpdateParams,
   type ProductListParams,
   type ProductArchiveParams,
-} from "./products.js";
+  type ProductListResponsesCursorPage,
+} from './products';
 export {
-  RateCardListResponsesCursorPage,
   RateCards,
   type RateCardCreateResponse,
   type RateCardRetrieveResponse,
@@ -65,4 +65,5 @@ export {
   type RateCardListParams,
   type RateCardArchiveParams,
   type RateCardRetrieveRateScheduleParams,
-} from "./rate-cards/index.js";
+  type RateCardListResponsesCursorPage,
+} from './rate-cards/index';

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

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class NamedSchedules extends APIResource {
   /**
@@ -20,8 +22,8 @@ export class NamedSchedules extends APIResource {
    */
   retrieve(
     body: NamedScheduleRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<NamedScheduleRetrieveResponse> {
+    options?: RequestOptions,
+  ): APIPromise<NamedScheduleRetrieveResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/getNamedSchedule', { body, ...options });
   }
 
@@ -40,11 +42,11 @@ export class NamedSchedules extends APIResource {
    * });
    * ```
    */
-  update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }

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

@@ -1,15 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-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";
+import { APIResource } from '../../../core/resource';
+import * as ProductsAPI from './products';
+import * as Shared from '../../shared';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Products extends APIResource {
   /**
-   * Create a new product
+   * Create a new product object. Products in Metronome represent your company's
+   * individual product or service offerings. A Product can be thought of as the
+   * basic unit of a line item on the invoice. This is analogous to SKUs or items in
+   * an ERP system. Give the product a meaningful name as they will appear on
+   * customer invoices.
    *
    * @example
    * ```ts
@@ -21,12 +25,12 @@ export class Products extends APIResource {
    * });
    * ```
    */
-  create(body: ProductCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProductCreateResponse> {
+  create(body: ProductCreateParams, options?: RequestOptions): APIPromise<ProductCreateResponse> {
     return this._client.post('/v1/contract-pricing/products/create', { body, ...options });
   }
 
   /**
-   * Get a specific product
+   * Retrieve a product by its ID, including all metadata and historical changes.
    *
    * @example
    * ```ts
@@ -35,15 +39,22 @@ export class Products extends APIResource {
    * );
    * ```
    */
-  retrieve(
-    body: ProductRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProductRetrieveResponse> {
+  retrieve(body: ProductRetrieveParams, options?: RequestOptions): APIPromise<ProductRetrieveResponse> {
     return this._client.post('/v1/contract-pricing/products/get', { body, ...options });
   }
 
   /**
-   * Update a product
+   * Updates a product's configuration while maintaining billing continuity for
+   * active customers. Use this endpoint to modify product names, metrics, pricing
+   * rules, and composite settings without disrupting ongoing billing cycles. Changes
+   * are scheduled using the starting_at timestamp, which must be on an hour
+   * boundary—set future dates to schedule updates ahead of time, or past dates for
+   * retroactive changes. Returns the updated product ID upon success.
+   *
+   * ### Usage guidance:
+   *
+   * - Product type cannot be changed after creation. For incorrect product types,
+   *   create a new product and archive the original instead.
    *
    * @example
    * ```ts
@@ -54,12 +65,14 @@ export class Products extends APIResource {
    * });
    * ```
    */
-  update(body: ProductUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ProductUpdateResponse> {
+  update(body: ProductUpdateParams, options?: RequestOptions): APIPromise<ProductUpdateResponse> {
     return this._client.post('/v1/contract-pricing/products/update', { body, ...options });
   }
 
   /**
-   * List products
+   * Get a paginated list of all products in your organization with their complete
+   * configuration, version history, and metadata. By default excludes archived
+   * products unless explicitly requested via the `archive_filter` parameter.
    *
    * @example
    * ```ts
@@ -72,19 +85,11 @@ export class Products extends APIResource {
    * ```
    */
   list(
-    params?: ProductListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ProductListResponsesCursorPage, ProductListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ProductListResponsesCursorPage, ProductListResponse>;
-  list(
-    params: ProductListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ProductListResponsesCursorPage, ProductListResponse> {
-    if (isRequestOptions(params)) {
-      return this.list({}, params);
-    }
-    const { limit, next_page, ...body } = params;
-    return this._client.getAPIList('/v1/contract-pricing/products/list', ProductListResponsesCursorPage, {
+    params: ProductListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProductListResponsesCursorPage, ProductListResponse> {
+    const { limit, next_page, ...body } = params ?? {};
+    return this._client.getAPIList('/v1/contract-pricing/products/list', CursorPage<ProductListResponse>, {
       query: { limit, next_page },
       body,
       method: 'post',
@@ -93,7 +98,10 @@ export class Products extends APIResource {
   }
 
   /**
-   * Archive a product
+   * Archive a product. Any current rate cards associated with this product will
+   * continue to function as normal. However, it will no longer be available as an
+   * option for newly created rates. Once you archive a product, you can still
+   * retrieve it in the UI and API, but you cannot unarchive it.
    *
    * @example
    * ```ts
@@ -102,15 +110,12 @@ export class Products extends APIResource {
    * );
    * ```
    */
-  archive(
-    body: ProductArchiveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProductArchiveResponse> {
+  archive(body: ProductArchiveParams, options?: RequestOptions): APIPromise<ProductArchiveResponse> {
     return this._client.post('/v1/contract-pricing/products/archive', { body, ...options });
   }
 }
 
-export class ProductListResponsesCursorPage extends CursorPage<ProductListResponse> {}
+export type ProductListResponsesCursorPage = CursorPage<ProductListResponse>;
 
 export interface ProductListItemState {
   created_at: string;
@@ -241,6 +246,9 @@ export namespace ProductRetrieveResponse {
 
     archived_at?: string | null;
 
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
     custom_fields?: { [key: string]: string };
   }
 
@@ -330,6 +338,9 @@ export interface ProductListResponse {
 
   archived_at?: string | null;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields?: { [key: string]: string };
 }
 
@@ -428,6 +439,9 @@ export interface ProductCreateParams {
    */
   composite_tags?: Array<string>;
 
+  /**
+   * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+   */
   custom_fields?: { [key: string]: string };
 
   /**
@@ -608,8 +622,6 @@ export interface ProductArchiveParams {
   product_id: string;
 }
 
-Products.ProductListResponsesCursorPage = ProductListResponsesCursorPage;
-
 export declare namespace Products {
   export {
     type ProductListItemState as ProductListItemState,
@@ -620,7 +632,7 @@ export declare namespace Products {
     type ProductUpdateResponse as ProductUpdateResponse,
     type ProductListResponse as ProductListResponse,
     type ProductArchiveResponse as ProductArchiveResponse,
-    ProductListResponsesCursorPage as ProductListResponsesCursorPage,
+    type ProductListResponsesCursorPage as ProductListResponsesCursorPage,
     type ProductCreateParams as ProductCreateParams,
     type ProductRetrieveParams as ProductRetrieveParams,
     type ProductUpdateParams as ProductUpdateParams,

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

@@ -5,16 +5,15 @@ export {
   type NamedScheduleRetrieveResponse,
   type NamedScheduleRetrieveParams,
   type NamedScheduleUpdateParams,
-} from "./named-schedules.js";
+} from './named-schedules';
 export {
   ProductOrders,
   type ProductOrderUpdateResponse,
   type ProductOrderSetResponse,
   type ProductOrderUpdateParams,
   type ProductOrderSetParams,
-} from "./product-orders.js";
+} from './product-orders';
 export {
-  RateCardListResponsesCursorPage,
   RateCards,
   type RateCardCreateResponse,
   type RateCardRetrieveResponse,
@@ -28,9 +27,9 @@ export {
   type RateCardListParams,
   type RateCardArchiveParams,
   type RateCardRetrieveRateScheduleParams,
-} from "./rate-cards.js";
+  type RateCardListResponsesCursorPage,
+} from './rate-cards';
 export {
-  RateListResponsesCursorPage,
   Rates,
   type RateListResponse,
   type RateAddResponse,
@@ -38,4 +37,5 @@ export {
   type RateListParams,
   type RateAddParams,
   type RateAddManyParams,
-} from "./rates.js";
+  type RateListResponsesCursorPage,
+} from './rates';

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

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../../resource.js";
-import * as Core from "../../../../core.js";
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
 
 export class NamedSchedules extends APIResource {
   /**
@@ -23,8 +25,8 @@ export class NamedSchedules extends APIResource {
    */
   retrieve(
     body: NamedScheduleRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<NamedScheduleRetrieveResponse> {
+    options?: RequestOptions,
+  ): APIPromise<NamedScheduleRetrieveResponse> {
     return this._client.post('/v1/contracts/getNamedSchedule', { body, ...options });
   }
 
@@ -44,11 +46,11 @@ export class NamedSchedules extends APIResource {
    * });
    * ```
    */
-  update(body: NamedScheduleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  update(body: NamedScheduleUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/v1/contracts/updateNamedSchedule', {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }

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

@@ -1,12 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../../resource.js";
-import * as Core from "../../../../core.js";
-import * as Shared from "../../../shared.js";
+import { APIResource } from '../../../../core/resource';
+import * as Shared from '../../../shared';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
 
 export class ProductOrders extends APIResource {
   /**
-   * Updates ordering of specified products
+   * The ordering of products on a rate card determines the order in which the
+   * products will appear on customers' invoices. Use this endpoint to set the order
+   * of specific products on the rate card by moving them relative to their current
+   * location.
    *
    * @example
    * ```ts
@@ -26,15 +30,14 @@ export class ProductOrders extends APIResource {
    *   });
    * ```
    */
-  update(
-    body: ProductOrderUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProductOrderUpdateResponse> {
+  update(body: ProductOrderUpdateParams, options?: RequestOptions): APIPromise<ProductOrderUpdateResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/moveRateCardProducts', { body, ...options });
   }
 
   /**
-   * Sets the ordering of products within a rate card
+   * The ordering of products on a rate card determines the order in which the
+   * products will appear on customers' invoices. Use this endpoint to set the order
+   * of products on the rate card.
    *
    * @example
    * ```ts
@@ -48,7 +51,7 @@ export class ProductOrders extends APIResource {
    *   });
    * ```
    */
-  set(body: ProductOrderSetParams, options?: Core.RequestOptions): Core.APIPromise<ProductOrderSetResponse> {
+  set(body: ProductOrderSetParams, options?: RequestOptions): APIPromise<ProductOrderSetResponse> {
     return this._client.post('/v1/contract-pricing/rate-cards/setRateCardProductsOrder', {
       body,
       ...options,