@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/resources/v1/customers/commits.mjs

@@ -0,0 +1,78 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../resource.mjs";
+export class Commits extends APIResource {
+    /**
+     * Create a new commit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const commit = await client.v1.customers.commits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   type: 'prepaid',
+     *   invoice_contract_id:
+     *     'e57d6929-c2f1-4796-a9a8-63cedefe848d',
+     *   invoice_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         unit_price: 10000000,
+     *         quantity: 1,
+     *         timestamp: '2020-03-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   name: 'My Commit',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/contracts/customerCommits/create', { body, ...options });
+    }
+    /**
+     * List commits.
+     *
+     * @example
+     * ```ts
+     * const commits = await client.v1.customers.commits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
+     */
+    list(body, options) {
+        return this._client.post('/v1/contracts/customerCommits/list', { body, ...options });
+    }
+    /**
+     * Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+     * to extend the end date of a prepaid commit, or to make other edits to the
+     * commit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.commits.updateEndDate({
+     *     commit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     invoices_ending_before: '2020-01-01T00:00:00.000Z',
+     *   });
+     * ```
+     */
+    updateEndDate(body, options) {
+        return this._client.post('/v1/contracts/customerCommits/updateEndDate', { body, ...options });
+    }
+}
+//# sourceMappingURL=commits.mjs.map

package/resources/v1/customers/commits.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"commits.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/commits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF"}

package/resources/{customers → v1/customers}/credits.d.ts

@@ -1,17 +1,57 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
-import * as Shared from "../shared.js";
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 export declare class Credits extends APIResource {
     /**
      * Create a new credit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const credit = await client.v1.customers.credits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   name: 'My Credit',
+     * });
+     * ```
      */
     create(body: CreditCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditCreateResponse>;
     /**
      * List credits.
+     *
+     * @example
+     * ```ts
+     * const credits = await client.v1.customers.credits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
      */
     list(body: CreditListParams, options?: Core.RequestOptions): Core.APIPromise<CreditListResponse>;
     /**
-     * Update the end date of a credit
+     * Pull forward the end date of a credit. Use the "edit a credit" endpoint to
+     * extend the end date of a credit, or to make other edits to the credit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.credits.updateEndDate({
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   });
+     * ```
      */
     updateEndDate(body: CreditUpdateEndDateParams, options?: Core.RequestOptions): Core.APIPromise<CreditUpdateEndDateResponse>;
 }
@@ -52,7 +92,9 @@ export interface CreditCreateParams {
      * applicable_product_tags are not provided, the credit applies to all products.
      */
     applicable_product_tags?: Array<string>;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     /**
      * Used only in UI/API. It is not exposed to end customers.
      */
@@ -70,6 +112,13 @@ export interface CreditCreateParams {
      * This field's availability is dependent on your client's configuration.
      */
     salesforce_opportunity_id?: string;
+    /**
+     * List of filters that determine what kind of customer usage draws down a commit
+     * or credit. A customer's usage needs to meet the condition of at least one of the
+     * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+     * be used together with `applicable_product_ids` or `applicable_product_tags`.
+     */
+    specifiers?: Array<CreditCreateParams.Specifier>;
     /**
      * Prevents the creation of duplicates. If a request to create a commit or credit
      * is made with a uniqueness key that was previously used to create a commit or
@@ -102,6 +151,23 @@ export declare namespace CreditCreateParams {
             starting_at: string;
         }
     }
+    interface Specifier {
+        presentation_group_values?: {
+            [key: string]: string;
+        };
+        pricing_group_values?: {
+            [key: string]: string;
+        };
+        /**
+         * If provided, the specifier will only apply to the product with the specified ID.
+         */
+        product_id?: string;
+        /**
+         * If provided, the specifier will only apply to products with all the specified
+         * tags.
+         */
+        product_tags?: Array<string>;
+    }
 }
 export interface CreditListParams {
     customer_id: string;
@@ -115,7 +181,7 @@ export interface CreditListParams {
      */
     effective_before?: string;
     /**
-     * Include credits from archived contracts.
+     * Include archived credits and credits from archived contracts.
      */
     include_archived?: boolean;
     /**
@@ -132,6 +198,10 @@ export interface CreditListParams {
      * be slower.
      */
     include_ledgers?: boolean;
+    /**
+     * The maximum number of commits to return. Defaults to 25.
+     */
+    limit?: number;
     /**
      * The next page token from a previous response.
      */

package/resources/v1/customers/credits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AAEvC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAIhG;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAE3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,SAAS,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;IAExC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,cAAc;QAC7B,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAEnD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,cAAc,CAAC;QAC9B,UAAiB,YAAY;YAC3B,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;IAED,UAAiB,SAAS;QACxB,yBAAyB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEtD,oBAAoB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/v1/customers/credits.js

@@ -0,0 +1,67 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Credits = void 0;
+const resource_1 = require("../../../resource.js");
+class Credits extends resource_1.APIResource {
+    /**
+     * Create a new credit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const credit = await client.v1.customers.credits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   name: 'My Credit',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/create', { body, ...options });
+    }
+    /**
+     * List credits.
+     *
+     * @example
+     * ```ts
+     * const credits = await client.v1.customers.credits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
+     */
+    list(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/list', { body, ...options });
+    }
+    /**
+     * Pull forward the end date of a credit. Use the "edit a credit" endpoint to
+     * extend the end date of a credit, or to make other edits to the credit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.credits.updateEndDate({
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   });
+     * ```
+     */
+    updateEndDate(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/updateEndDate', { body, ...options });
+    }
+}
+exports.Credits = Credits;
+//# sourceMappingURL=credits.js.map

package/resources/v1/customers/credits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,mDAAgD;AAIhD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF;AAhED,0BAgEC"}

package/resources/v1/customers/credits.mjs

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../resource.mjs";
+export class Credits extends APIResource {
+    /**
+     * Create a new credit at the customer level.
+     *
+     * @example
+     * ```ts
+     * const credit = await client.v1.customers.credits.create({
+     *   access_schedule: {
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     schedule_items: [
+     *       {
+     *         amount: 1000,
+     *         starting_at: '2020-01-01T00:00:00.000Z',
+     *         ending_before: '2020-02-01T00:00:00.000Z',
+     *       },
+     *     ],
+     *   },
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   priority: 100,
+     *   product_id: 'f14d6729-6a44-4b13-9908-9387f1918790',
+     *   name: 'My Credit',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/create', { body, ...options });
+    }
+    /**
+     * List credits.
+     *
+     * @example
+     * ```ts
+     * const credits = await client.v1.customers.credits.list({
+     *   customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *   include_ledgers: true,
+     * });
+     * ```
+     */
+    list(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/list', { body, ...options });
+    }
+    /**
+     * Pull forward the end date of a credit. Use the "edit a credit" endpoint to
+     * extend the end date of a credit, or to make other edits to the credit.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.v1.customers.credits.updateEndDate({
+     *     access_ending_before: '2020-01-01T00:00:00.000Z',
+     *     credit_id: '6162d87b-e5db-4a33-b7f2-76ce6ead4e85',
+     *     customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
+     *   });
+     * ```
+     */
+    updateEndDate(body, options) {
+        return this._client.post('/v1/contracts/customerCredits/updateEndDate', { body, ...options });
+    }
+}
+//# sourceMappingURL=credits.mjs.map

package/resources/v1/customers/credits.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../../../src/resources/v1/customers/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAsB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;CACF"}