@metronome/sdk 0.3.0 → 2.0.0

package/resources/v1/contracts/named-schedules.js

@@ -2,7 +2,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NamedSchedules = void 0;
-const resource_1 = require("../../../resource.js");
+const resource_1 = require("../../../core/resource.js");
+const headers_1 = require("../../../internal/headers.js");
 class NamedSchedules extends resource_1.APIResource {
     /**
      * Get a named schedule for the given rate card. This endpoint's availability is
@@ -40,7 +41,7 @@ class NamedSchedules extends resource_1.APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {
             body,
             ...options,
-            headers: { Accept: '*/*', ...options?.headers },
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
 }

package/resources/v1/contracts/named-schedules.js.map

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAGhD,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA5CD,wCA4CC"}
+{"version":3,"file":"named-schedules.js","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAGzD,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA5CD,wCA4CC"}

package/resources/v1/contracts/named-schedules.mjs

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../resource.mjs";
+import { APIResource } from "../../../core/resource.mjs";
+import { buildHeaders } from "../../../internal/headers.mjs";
 export class NamedSchedules extends APIResource {
     /**
      * Get a named schedule for the given rate card. This endpoint's availability is
@@ -37,7 +38,7 @@ export class NamedSchedules extends APIResource {
         return this._client.post('/v1/contract-pricing/rate-cards/updateNamedSchedule', {
             body,
             ...options,
-            headers: { Accept: '*/*', ...options?.headers },
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
 }

package/resources/v1/contracts/named-schedules.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"named-schedules.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAA6B;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"named-schedules.mjs","sourceRoot":"","sources":["../../../src/resources/v1/contracts/named-schedules.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA+B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qDAAqD,EAAE;YAC9E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/v1/contracts/products.d.mts

@@ -0,0 +1,502 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ProductsAPI from "./products.mjs";
+import * as Shared from "../../shared.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Products extends APIResource {
+    /**
+     * 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
+     * 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?: RequestOptions): APIPromise<ProductCreateResponse>;
+    /**
+     * Retrieve a product by its ID, including all metadata and historical changes.
+     *
+     * @example
+     * ```ts
+     * const product = await client.v1.contracts.products.retrieve(
+     *   { id: 'd84e7f4e-7a70-4fe4-be02-7a5027beffcc' },
+     * );
+     * ```
+     */
+    retrieve(body: ProductRetrieveParams, options?: RequestOptions): APIPromise<ProductRetrieveResponse>;
+    /**
+     * 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
+     * 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?: RequestOptions): APIPromise<ProductUpdateResponse>;
+    /**
+     * 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
+     * // Automatically fetches more pages as needed.
+     * for await (const productListResponse of client.v1.contracts.products.list(
+     *   { archive_filter: 'NOT_ARCHIVED' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(params?: ProductListParams | null | undefined, options?: RequestOptions): PagePromise<ProductListResponsesCursorPage, ProductListResponse>;
+    /**
+     * 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
+     * const response = await client.v1.contracts.products.archive(
+     *   { product_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * );
+     * ```
+     */
+    archive(body: ProductArchiveParams, options?: RequestOptions): APIPromise<ProductArchiveResponse>;
+}
+export type ProductListResponsesCursorPage = CursorPage<ProductListResponse>;
+export interface ProductListItemState {
+    created_at: string;
+    created_by: string;
+    name: string;
+    billable_metric_id?: string;
+    composite_product_ids?: Array<string>;
+    composite_tags?: Array<string>;
+    exclude_free_usage?: boolean;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    is_refundable?: boolean;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_internal_item_id?: string;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_overage_item_id?: string;
+    /**
+     * For USAGE products only. Groups usage line items on invoices. The superset of
+     * values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    presentation_group_key?: Array<string>;
+    /**
+     * For USAGE products only. If set, pricing for this product will be determined for
+     * each pricing_group_key value, as opposed to the product as a whole. The superset
+     * of values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    pricing_group_key?: Array<string>;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * converted using the provided conversion factor and operation. For example, if
+     * the operation is "multiply" and the conversion factor is 100, then the quantity
+     * will be multiplied by 100. This can be used in cases where data is sent in one
+     * unit and priced in another. For example, data could be sent in MB and priced in
+     * GB. In this case, the conversion factor would be 1024 and the operation would be
+     * "divide".
+     */
+    quantity_conversion?: QuantityConversion | null;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * rounded using the provided rounding method and decimal places. For example, if
+     * the method is "round up" and the decimal places is 0, then the quantity will be
+     * rounded up to the nearest integer.
+     */
+    quantity_rounding?: QuantityRounding | null;
+    starting_at?: string;
+    tags?: Array<string>;
+}
+/**
+ * Optional. Only valid for USAGE products. If provided, the quantity will be
+ * converted using the provided conversion factor and operation. For example, if
+ * the operation is "multiply" and the conversion factor is 100, then the quantity
+ * will be multiplied by 100. This can be used in cases where data is sent in one
+ * unit and priced in another. For example, data could be sent in MB and priced in
+ * GB. In this case, the conversion factor would be 1024 and the operation would be
+ * "divide".
+ */
+export interface QuantityConversion {
+    /**
+     * The factor to multiply or divide the quantity by.
+     */
+    conversion_factor: number;
+    /**
+     * The operation to perform on the quantity
+     */
+    operation: 'MULTIPLY' | 'DIVIDE';
+    /**
+     * Optional name for this conversion.
+     */
+    name?: string;
+}
+/**
+ * Optional. Only valid for USAGE products. If provided, the quantity will be
+ * rounded using the provided rounding method and decimal places. For example, if
+ * the method is "round up" and the decimal places is 0, then the quantity will be
+ * rounded up to the nearest integer.
+ */
+export interface QuantityRounding {
+    decimal_places: number;
+    rounding_method: 'ROUND_UP' | 'ROUND_DOWN' | 'ROUND_HALF_UP';
+}
+export interface ProductCreateResponse {
+    data: Shared.ID;
+}
+export interface ProductRetrieveResponse {
+    data: ProductRetrieveResponse.Data;
+}
+export declare namespace ProductRetrieveResponse {
+    interface Data {
+        id: string;
+        current: ProductsAPI.ProductListItemState;
+        initial: ProductsAPI.ProductListItemState;
+        type: 'USAGE' | 'SUBSCRIPTION' | 'COMPOSITE' | 'FIXED' | 'PRO_SERVICE';
+        updates: Array<Data.Update>;
+        archived_at?: string | null;
+        /**
+         * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+         */
+        custom_fields?: {
+            [key: string]: string;
+        };
+    }
+    namespace Data {
+        interface Update {
+            created_at: string;
+            created_by: string;
+            billable_metric_id?: string;
+            composite_product_ids?: Array<string>;
+            composite_tags?: Array<string>;
+            exclude_free_usage?: boolean;
+            is_refundable?: boolean;
+            name?: string;
+            /**
+             * This field's availability is dependent on your client's configuration.
+             */
+            netsuite_internal_item_id?: string;
+            /**
+             * This field's availability is dependent on your client's configuration.
+             */
+            netsuite_overage_item_id?: string;
+            /**
+             * For USAGE products only. Groups usage line items on invoices. The superset of
+             * values in the pricing group key and presentation group key must be set as one
+             * compound group key on the billable metric.
+             */
+            presentation_group_key?: Array<string>;
+            /**
+             * For USAGE products only. If set, pricing for this product will be determined for
+             * each pricing_group_key value, as opposed to the product as a whole. The superset
+             * of values in the pricing group key and presentation group key must be set as one
+             * compound group key on the billable metric.
+             */
+            pricing_group_key?: Array<string>;
+            /**
+             * Optional. Only valid for USAGE products. If provided, the quantity will be
+             * converted using the provided conversion factor and operation. For example, if
+             * the operation is "multiply" and the conversion factor is 100, then the quantity
+             * will be multiplied by 100. This can be used in cases where data is sent in one
+             * unit and priced in another. For example, data could be sent in MB and priced in
+             * GB. In this case, the conversion factor would be 1024 and the operation would be
+             * "divide".
+             */
+            quantity_conversion?: ProductsAPI.QuantityConversion | null;
+            /**
+             * Optional. Only valid for USAGE products. If provided, the quantity will be
+             * rounded using the provided rounding method and decimal places. For example, if
+             * the method is "round up" and the decimal places is 0, then the quantity will be
+             * rounded up to the nearest integer.
+             */
+            quantity_rounding?: ProductsAPI.QuantityRounding | null;
+            starting_at?: string;
+            tags?: Array<string>;
+        }
+    }
+}
+export interface ProductUpdateResponse {
+    data: Shared.ID;
+}
+export interface ProductListResponse {
+    id: string;
+    current: ProductListItemState;
+    initial: ProductListItemState;
+    type: 'USAGE' | 'SUBSCRIPTION' | 'COMPOSITE' | 'FIXED' | 'PRO_SERVICE';
+    updates: Array<ProductListResponse.Update>;
+    archived_at?: string | null;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+}
+export declare namespace ProductListResponse {
+    interface Update {
+        created_at: string;
+        created_by: string;
+        billable_metric_id?: string;
+        composite_product_ids?: Array<string>;
+        composite_tags?: Array<string>;
+        exclude_free_usage?: boolean;
+        is_refundable?: boolean;
+        name?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_internal_item_id?: string;
+        /**
+         * This field's availability is dependent on your client's configuration.
+         */
+        netsuite_overage_item_id?: string;
+        /**
+         * For USAGE products only. Groups usage line items on invoices. The superset of
+         * values in the pricing group key and presentation group key must be set as one
+         * compound group key on the billable metric.
+         */
+        presentation_group_key?: Array<string>;
+        /**
+         * For USAGE products only. If set, pricing for this product will be determined for
+         * each pricing_group_key value, as opposed to the product as a whole. The superset
+         * of values in the pricing group key and presentation group key must be set as one
+         * compound group key on the billable metric.
+         */
+        pricing_group_key?: Array<string>;
+        /**
+         * Optional. Only valid for USAGE products. If provided, the quantity will be
+         * converted using the provided conversion factor and operation. For example, if
+         * the operation is "multiply" and the conversion factor is 100, then the quantity
+         * will be multiplied by 100. This can be used in cases where data is sent in one
+         * unit and priced in another. For example, data could be sent in MB and priced in
+         * GB. In this case, the conversion factor would be 1024 and the operation would be
+         * "divide".
+         */
+        quantity_conversion?: ProductsAPI.QuantityConversion | null;
+        /**
+         * Optional. Only valid for USAGE products. If provided, the quantity will be
+         * rounded using the provided rounding method and decimal places. For example, if
+         * the method is "round up" and the decimal places is 0, then the quantity will be
+         * rounded up to the nearest integer.
+         */
+        quantity_rounding?: ProductsAPI.QuantityRounding | null;
+        starting_at?: string;
+        tags?: Array<string>;
+    }
+}
+export interface ProductArchiveResponse {
+    data: Shared.ID;
+}
+export interface ProductCreateParams {
+    /**
+     * displayed on invoices
+     */
+    name: string;
+    type: 'FIXED' | 'USAGE' | 'COMPOSITE' | 'SUBSCRIPTION' | 'PROFESSIONAL_SERVICE' | 'PRO_SERVICE';
+    /**
+     * Required for USAGE products
+     */
+    billable_metric_id?: string;
+    /**
+     * Required for COMPOSITE products
+     */
+    composite_product_ids?: Array<string>;
+    /**
+     * Required for COMPOSITE products
+     */
+    composite_tags?: Array<string>;
+    /**
+     * Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+     */
+    custom_fields?: {
+        [key: string]: string;
+    };
+    /**
+     * Beta feature only available for composite products. If true, products with $0
+     * will not be included when computing composite usage. Defaults to false
+     */
+    exclude_free_usage?: boolean;
+    /**
+     * This field's availability is dependent on your client's configuration. Defaults
+     * to true.
+     */
+    is_refundable?: boolean;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_internal_item_id?: string;
+    /**
+     * This field's availability is dependent on your client's configuration.
+     */
+    netsuite_overage_item_id?: string;
+    /**
+     * For USAGE products only. Groups usage line items on invoices. The superset of
+     * values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    presentation_group_key?: Array<string>;
+    /**
+     * For USAGE products only. If set, pricing for this product will be determined for
+     * each pricing_group_key value, as opposed to the product as a whole. The superset
+     * of values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    pricing_group_key?: Array<string>;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * converted using the provided conversion factor and operation. For example, if
+     * the operation is "multiply" and the conversion factor is 100, then the quantity
+     * will be multiplied by 100. This can be used in cases where data is sent in one
+     * unit and priced in another. For example, data could be sent in MB and priced in
+     * GB. In this case, the conversion factor would be 1024 and the operation would be
+     * "divide".
+     */
+    quantity_conversion?: QuantityConversion | null;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * rounded using the provided rounding method and decimal places. For example, if
+     * the method is "round up" and the decimal places is 0, then the quantity will be
+     * rounded up to the nearest integer.
+     */
+    quantity_rounding?: QuantityRounding | null;
+    tags?: Array<string>;
+}
+export interface ProductRetrieveParams {
+    id: string;
+}
+export interface ProductUpdateParams {
+    /**
+     * ID of the product to update
+     */
+    product_id: string;
+    /**
+     * Timestamp representing when the update should go into effect. It must be on an
+     * hour boundary (e.g. 1:00, not 1:30).
+     */
+    starting_at: string;
+    /**
+     * Available for USAGE products only. If not provided, defaults to product's
+     * current billable metric.
+     */
+    billable_metric_id?: string;
+    /**
+     * Available for COMPOSITE products only. If not provided, defaults to product's
+     * current composite_product_ids.
+     */
+    composite_product_ids?: Array<string>;
+    /**
+     * Available for COMPOSITE products only. If not provided, defaults to product's
+     * current composite_tags.
+     */
+    composite_tags?: Array<string>;
+    /**
+     * Beta feature only available for composite products. If true, products with $0
+     * will not be included when computing composite usage. Defaults to false
+     */
+    exclude_free_usage?: boolean;
+    /**
+     * Defaults to product's current refundability status. This field's availability is
+     * dependent on your client's configuration.
+     */
+    is_refundable?: boolean;
+    /**
+     * displayed on invoices. If not provided, defaults to product's current name.
+     */
+    name?: string;
+    /**
+     * If not provided, defaults to product's current netsuite_internal_item_id. This
+     * field's availability is dependent on your client's configuration.
+     */
+    netsuite_internal_item_id?: string;
+    /**
+     * Available for USAGE and COMPOSITE products only. If not provided, defaults to
+     * product's current netsuite_overage_item_id. This field's availability is
+     * dependent on your client's configuration.
+     */
+    netsuite_overage_item_id?: string;
+    /**
+     * For USAGE products only. Groups usage line items on invoices. The superset of
+     * values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    presentation_group_key?: Array<string>;
+    /**
+     * For USAGE products only. If set, pricing for this product will be determined for
+     * each pricing_group_key value, as opposed to the product as a whole. The superset
+     * of values in the pricing group key and presentation group key must be set as one
+     * compound group key on the billable metric.
+     */
+    pricing_group_key?: Array<string>;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * converted using the provided conversion factor and operation. For example, if
+     * the operation is "multiply" and the conversion factor is 100, then the quantity
+     * will be multiplied by 100. This can be used in cases where data is sent in one
+     * unit and priced in another. For example, data could be sent in MB and priced in
+     * GB. In this case, the conversion factor would be 1024 and the operation would be
+     * "divide".
+     */
+    quantity_conversion?: QuantityConversion | null;
+    /**
+     * Optional. Only valid for USAGE products. If provided, the quantity will be
+     * rounded using the provided rounding method and decimal places. For example, if
+     * the method is "round up" and the decimal places is 0, then the quantity will be
+     * rounded up to the nearest integer.
+     */
+    quantity_rounding?: QuantityRounding | null;
+    /**
+     * If not provided, defaults to product's current tags
+     */
+    tags?: Array<string>;
+}
+export interface ProductListParams extends CursorPageParams {
+    /**
+     * Body param: Filter options for the product list. If not provided, defaults to
+     * not archived.
+     */
+    archive_filter?: 'ARCHIVED' | 'NOT_ARCHIVED' | 'ALL';
+}
+export interface ProductArchiveParams {
+    /**
+     * ID of the product to be archived
+     */
+    product_id: string;
+}
+export declare namespace Products {
+    export { type ProductListItemState as ProductListItemState, type QuantityConversion as QuantityConversion, type QuantityRounding as QuantityRounding, type ProductCreateResponse as ProductCreateResponse, type ProductRetrieveResponse as ProductRetrieveResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductArchiveResponse as ProductArchiveResponse, type ProductListResponsesCursorPage as ProductListResponsesCursorPage, type ProductCreateParams as ProductCreateParams, type ProductRetrieveParams as ProductRetrieveParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, type ProductArchiveParams as ProductArchiveParams, };
+}
+//# sourceMappingURL=products.d.mts.map

package/resources/v1/contracts/products.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/contracts/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIpG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,MAAM,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAUnE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGlG;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,UAAU,GAAG,QAAQ,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IAEvB,eAAe,EAAE,UAAU,GAAG,YAAY,GAAG,eAAe,CAAC;CAC9D;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,OAAO,EAAE,WAAW,CAAC,oBAAoB,CAAC;QAE1C,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;QAEvE,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KAC3C;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,UAAU,EAAE,MAAM,CAAC;YAEnB,UAAU,EAAE,MAAM,CAAC;YAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;YAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;YAElC;;;;eAIG;YACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEvC;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAElC;;;;;;;;eAQG;YACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;YAE5D;;;;;eAKG;YACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;YAExD,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,oBAAoB,CAAC;IAE9B,OAAO,EAAE,oBAAoB,CAAC;IAE9B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,WAAW,GAAG,OAAO,GAAG,aAAa,CAAC;IAEvE,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAE3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,MAAM;QACrB,UAAU,EAAE,MAAM,CAAC;QAEnB,UAAU,EAAE,MAAM,CAAC;QAEnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtC,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;WAEG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAElC;;;;WAIG;QACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvC;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAElC;;;;;;;;WAQG;QACH,mBAAmB,CAAC,EAAE,WAAW,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAE5D;;;;;WAKG;QACH,iBAAiB,CAAC,EAAE,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAExD,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,GAAG,sBAAsB,GAAG,aAAa,CAAC;IAEhG;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;;OAGG;IACH,cAAc,CAAC,EAAE,UAAU,GAAG,cAAc,GAAG,KAAK,CAAC;CACtD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}