@metronome/sdk 0.1.0-beta.8 → 0.1.0

package/resources/{credit-grants.d.ts → v1/credit-grants.d.ts}

@@ -1,31 +1,98 @@
-import { APIResource } from "../resource.js";
-import * as Core from "../core.js";
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
 import * as CreditGrantsAPI from "./credit-grants.js";
-import * as Shared from "./shared.js";
-import { CursorPage, type CursorPageParams } from "../pagination.js";
+import * as Shared from "../shared.js";
+import { CursorPage, type CursorPageParams } from "../../pagination.js";
 export declare class CreditGrants extends APIResource {
     /**
      * Create a new credit grant
+     *
+     * @example
+     * ```ts
+     * const creditGrant = await client.v1.creditGrants.create({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   grant_amount: {
+     *     amount: 1000,
+     *     credit_type_id: '5ae401dc-a648-4b49-9ac3-391bb5bc4d7b',
+     *   },
+     *   name: 'Acme Corp Promotional Credit Grant',
+     *   paid_amount: {
+     *     amount: 5000,
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     *   priority: 0.5,
+     *   credit_grant_type: 'trial',
+     *   effective_at: '2022-02-01T00:00:00Z',
+     *   reason: 'Incentivize new customer',
+     * });
+     * ```
      */
     create(body: CreditGrantCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantCreateResponse>;
     /**
      * List credit grants. This list does not included voided grants.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const creditGrantListResponse of client.v1.creditGrants.list(
+     *   {
+     *     credit_type_ids: [
+     *       '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *     ],
+     *     customer_ids: [
+     *       'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *       '0e5b8609-d901-4992-b394-c3c2e3f37b1c',
+     *     ],
+     *     effective_before: '2022-02-01T00:00:00Z',
+     *     not_expiring_before: '2022-02-01T00:00:00Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(params?: CreditGrantListParams, options?: Core.RequestOptions): Core.PagePromise<CreditGrantListResponsesCursorPage, CreditGrantListResponse>;
     list(options?: Core.RequestOptions): Core.PagePromise<CreditGrantListResponsesCursorPage, CreditGrantListResponse>;
     /**
      * Edit an existing credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.edit({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   name: 'Acme Corp Promotional Credit Grant',
+     * });
+     * ```
      */
     edit(body: CreditGrantEditParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantEditResponse>;
     /**
      * Fetches a list of credit ledger entries. Returns lists of ledgers per customer.
      * Ledger entries are returned in chronological order. Ledger entries associated
      * with voided credit grants are not included.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.listEntries({
+     *   credit_type_ids: ['2714e483-4ff1-48e4-9e25-ac732e8f24f2'],
+     *   customer_ids: ['6a37bb88-8538-48c5-b37b-a41c836328bd'],
+     *   ending_before: '2021-02-01T00:00:00Z',
+     *   starting_on: '2021-01-01T00:00:00Z',
+     * });
+     * ```
      */
     listEntries(params?: CreditGrantListEntriesParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantListEntriesResponse>;
     listEntries(options?: Core.RequestOptions): Core.APIPromise<CreditGrantListEntriesResponse>;
     /**
      * Void a credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.void({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
      */
     void(body: CreditGrantVoidParams, options?: Core.RequestOptions): Core.APIPromise<CreditGrantVoidResponse>;
 }
@@ -89,7 +156,9 @@ export interface CreditGrantListResponse {
      * before the end of the current billing period.
      */
     balance: CreditGrantListResponse.Balance;
-    custom_fields: Record<string, string>;
+    custom_fields: {
+        [key: string]: string;
+    };
     /**
      * the Metronome ID of the customer
      */
@@ -269,7 +338,9 @@ export interface CreditGrantCreateParams {
     /**
      * Custom fields to attach to the credit grant.
      */
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     /**
      * The credit grant will only apply to usage or charges dated on or after this
      * timestamp
@@ -391,6 +462,10 @@ export interface CreditGrantListEntriesParams {
      * Query param: Cursor that indicates where the next page of results should start.
      */
     next_page?: string;
+    /**
+     * Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
+     */
+    sort?: 'asc' | 'desc';
     /**
      * Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
      * absent, ledger entries for all credit types will be returned.

package/resources/v1/credit-grants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.d.ts","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,eAAe,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI7C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAChF,IAAI,CACF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;IAiBhF;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI1G;;;;;;;;;;;;;;OAcG;IACH,WAAW,CACT,MAAM,CAAC,EAAE,4BAA4B,EACrC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAClD,WAAW,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC;IAY3F;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG3G;AAED,qBAAa,kCAAmC,SAAQ,UAAU,CAAC,uBAAuB,CAAC;CAAG;AAE9F,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC;IAEzC,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAElD,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD,kBAAkB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE7C,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAElD,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;OAIG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;KACpC;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;KACpC;IAED,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAEjD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,IAAI;QACnB,WAAW,EAAE,MAAM,CAAC;QAEpB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,WAAW,EAAE,MAAM,CAAC,cAAc,CAAC;YAEnC;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC;YAErC,OAAO,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAElD,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;YAE1D,gBAAgB,EAAE,MAAM,CAAC,eAAe,CAAC;SAC1C;QAED,UAAiB,MAAM,CAAC;YACtB;;eAEG;YACH,UAAiB,aAAa;gBAC5B;;;mBAGG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;;;mBAIG;gBACH,iBAAiB,EAAE,MAAM,CAAC;gBAE1B;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;aAC3B;YAED,UAAiB,eAAe;gBAC9B;;;mBAGG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;gBAE1B;;;mBAGG;gBACH,iBAAiB,EAAE,MAAM,CAAC;aAC3B;SACF;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,WAAW,CAAC;IAElD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD,QAAQ,EAAE,MAAM,CAAC;IAEjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,gBAAgB,CAAC;IAE7D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,WAAW;QAC1B,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB;IAED;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,eAAe,CAAC,2BAA2B,GAAG,eAAe,CAAC,uBAAuB,CAAC;KACxG;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACxC;AAID,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,kCAAkC,IAAI,kCAAkC,EACxE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/v1/credit-grants.js

@@ -0,0 +1,89 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreditGrantListResponsesCursorPage = exports.CreditGrants = void 0;
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
+const pagination_1 = require("../../pagination.js");
+class CreditGrants extends resource_1.APIResource {
+    /**
+     * Create a new credit grant
+     *
+     * @example
+     * ```ts
+     * const creditGrant = await client.v1.creditGrants.create({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   grant_amount: {
+     *     amount: 1000,
+     *     credit_type_id: '5ae401dc-a648-4b49-9ac3-391bb5bc4d7b',
+     *   },
+     *   name: 'Acme Corp Promotional Credit Grant',
+     *   paid_amount: {
+     *     amount: 5000,
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     *   priority: 0.5,
+     *   credit_grant_type: 'trial',
+     *   effective_at: '2022-02-01T00:00:00Z',
+     *   reason: 'Incentivize new customer',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/credits/createGrant', { body, ...options });
+    }
+    list(params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.list({}, params);
+        }
+        const { limit, next_page, ...body } = params;
+        return this._client.getAPIList('/v1/credits/listGrants', CreditGrantListResponsesCursorPage, {
+            query: { limit, next_page },
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Edit an existing credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.edit({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   name: 'Acme Corp Promotional Credit Grant',
+     * });
+     * ```
+     */
+    edit(body, options) {
+        return this._client.post('/v1/credits/editGrant', { body, ...options });
+    }
+    listEntries(params = {}, options) {
+        if ((0, core_1.isRequestOptions)(params)) {
+            return this.listEntries({}, params);
+        }
+        const { next_page, sort, ...body } = params;
+        return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
+    }
+    /**
+     * Void a credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.void({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
+     */
+    void(body, options) {
+        return this._client.post('/v1/credits/voidGrant', { body, ...options });
+    }
+}
+exports.CreditGrants = CreditGrants;
+class CreditGrantListResponsesCursorPage extends pagination_1.CursorPage {
+}
+exports.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
+CreditGrants.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
+//# sourceMappingURL=credit-grants.js.map

package/resources/v1/credit-grants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.js","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAI9C,oDAAqE;AAErE,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAgCD,IAAI,CACF,SAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,kCAAkC,EAAE;YAC3F,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAsBD,WAAW,CACT,SAA6D,EAAE,EAC/D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AA1ID,oCA0IC;AAED,MAAa,kCAAmC,SAAQ,uBAAmC;CAAG;AAA9F,gFAA8F;AA8e9F,YAAY,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}

package/resources/v1/credit-grants.mjs

@@ -0,0 +1,84 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
+import { CursorPage } from "../../pagination.mjs";
+export class CreditGrants extends APIResource {
+    /**
+     * Create a new credit grant
+     *
+     * @example
+     * ```ts
+     * const creditGrant = await client.v1.creditGrants.create({
+     *   customer_id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   grant_amount: {
+     *     amount: 1000,
+     *     credit_type_id: '5ae401dc-a648-4b49-9ac3-391bb5bc4d7b',
+     *   },
+     *   name: 'Acme Corp Promotional Credit Grant',
+     *   paid_amount: {
+     *     amount: 5000,
+     *     credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
+     *   },
+     *   priority: 0.5,
+     *   credit_grant_type: 'trial',
+     *   effective_at: '2022-02-01T00:00:00Z',
+     *   reason: 'Incentivize new customer',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/credits/createGrant', { body, ...options });
+    }
+    list(params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.list({}, params);
+        }
+        const { limit, next_page, ...body } = params;
+        return this._client.getAPIList('/v1/credits/listGrants', CreditGrantListResponsesCursorPage, {
+            query: { limit, next_page },
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
+    /**
+     * Edit an existing credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.edit({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     *   expires_at: '2022-04-01T00:00:00Z',
+     *   name: 'Acme Corp Promotional Credit Grant',
+     * });
+     * ```
+     */
+    edit(body, options) {
+        return this._client.post('/v1/credits/editGrant', { body, ...options });
+    }
+    listEntries(params = {}, options) {
+        if (isRequestOptions(params)) {
+            return this.listEntries({}, params);
+        }
+        const { next_page, sort, ...body } = params;
+        return this._client.post('/v1/credits/listEntries', { query: { next_page, sort }, body, ...options });
+    }
+    /**
+     * Void a credit grant
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.creditGrants.void({
+     *   id: '9b85c1c1-5238-4f2a-a409-61412905e1e1',
+     * });
+     * ```
+     */
+    void(body, options) {
+        return this._client.post('/v1/credits/voidGrant', { body, ...options });
+    }
+}
+export class CreditGrantListResponsesCursorPage extends CursorPage {
+}
+CreditGrants.CreditGrantListResponsesCursorPage = CreditGrantListResponsesCursorPage;
+//# sourceMappingURL=credit-grants.mjs.map

package/resources/v1/credit-grants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"credit-grants.mjs","sourceRoot":"","sources":["../../src/resources/v1/credit-grants.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,UAAU,EAAyB;AAE5C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAgCD,IAAI,CACF,SAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAC9B;QACD,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,kCAAkC,EAAE;YAC3F,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE;YAC3B,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAsBD,WAAW,CACT,SAA6D,EAAE,EAC/D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SACrC;QACD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,IAA2B,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAED,MAAM,OAAO,kCAAmC,SAAQ,UAAmC;CAAG;AA8e9F,YAAY,CAAC,kCAAkC,GAAG,kCAAkC,CAAC"}

package/resources/{custom-fields.d.ts → v1/custom-fields.d.ts}

@@ -1,22 +1,55 @@
-import { APIResource } from "../resource.js";
-import * as Core from "../core.js";
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
 export declare class CustomFields extends APIResource {
     /**
      * Add a key to the allow list for a given entity. There is a 100 character limit
      * on custom field keys.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.addKey({
+     *   enforce_uniqueness: true,
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     addKey(body: CustomFieldAddKeyParams, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
      * Deletes one or more custom fields on an instance of a Metronome entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.deleteValues({
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     *   keys: ['x_account_id'],
+     * });
+     * ```
      */
     deleteValues(body: CustomFieldDeleteValuesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
      * List all active custom field keys, optionally filtered by entity type.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customFields.listKeys({
+     *   entities: ['customer'],
+     * });
+     * ```
      */
     listKeys(params?: CustomFieldListKeysParams, options?: Core.RequestOptions): Core.APIPromise<CustomFieldListKeysResponse>;
     listKeys(options?: Core.RequestOptions): Core.APIPromise<CustomFieldListKeysResponse>;
     /**
      * Remove a key from the allow list for a given entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.removeKey({
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     removeKey(body: CustomFieldRemoveKeyParams, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
@@ -27,6 +60,15 @@ export declare class CustomFields extends APIResource {
      * transactional and will update all key/value pairs or no key/value pairs. Partial
      * updates are not supported. There is a 200 character limit on custom field
      * values.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.setValues({
+     *   custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     * });
+     * ```
      */
     setValues(body: CustomFieldSetValuesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
 }
@@ -37,17 +79,17 @@ export interface CustomFieldListKeysResponse {
 export declare namespace CustomFieldListKeysResponse {
     interface Data {
         enforce_uniqueness: boolean;
-        entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+        entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
         key: string;
     }
 }
 export interface CustomFieldAddKeyParams {
     enforce_uniqueness: boolean;
-    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
     key: string;
 }
 export interface CustomFieldDeleteValuesParams {
-    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
     entity_id: string;
     keys: Array<string>;
 }
@@ -59,15 +101,17 @@ export interface CustomFieldListKeysParams {
     /**
      * Body param: Optional list of entity types to return keys for
      */
-    entities?: Array<'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge'>;
+    entities?: Array<'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription'>;
 }
 export interface CustomFieldRemoveKeyParams {
-    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
     key: string;
 }
 export interface CustomFieldSetValuesParams {
-    custom_fields: Record<string, string>;
-    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge';
+    custom_fields: {
+        [key: string]: string;
+    };
+    entity: 'alert' | 'billable_metric' | 'charge' | 'commit' | 'contract_credit' | 'contract_product' | 'contract' | 'credit_grant' | 'customer_plan' | 'customer' | 'discount' | 'invoice' | 'plan' | 'professional_service' | 'product' | 'rate_card' | 'scheduled_charge' | 'subscription';
     entity_id: string;
 }
 export declare namespace CustomFields {

package/resources/v1/custom-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../../src/resources/v1/custom-fields.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQ3F;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,IAAI,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQvG;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAC/C,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAYrF;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQjG;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAOlG;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,KAAK,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;IAE9C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,IAAI;QACnB,kBAAkB,EAAE,OAAO,CAAC;QAE5B,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;QAEnB,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC,kBAAkB,EAAE,OAAO,CAAC;IAE5B,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CACZ,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CACjB,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,0BAA0B;IACzC,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,MAAM,EACF,OAAO,GACP,iBAAiB,GACjB,QAAQ,GACR,QAAQ,GACR,iBAAiB,GACjB,kBAAkB,GAClB,UAAU,GACV,cAAc,GACd,eAAe,GACf,UAAU,GACV,UAAU,GACV,SAAS,GACT,MAAM,GACN,sBAAsB,GACtB,SAAS,GACT,WAAW,GACX,kBAAkB,GAClB,cAAc,CAAC;IAEnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/{custom-fields.js → v1/custom-fields.js}

@@ -2,15 +2,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomFields = void 0;
-const resource_1 = require("../resource.js");
-const core_1 = require("../core.js");
+const resource_1 = require("../../resource.js");
+const core_1 = require("../../core.js");
 class CustomFields extends resource_1.APIResource {
     /**
      * Add a key to the allow list for a given entity. There is a 100 character limit
      * on custom field keys.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.addKey({
+     *   enforce_uniqueness: true,
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     addKey(body, options) {
-        return this._client.post('/customFields/addKey', {
+        return this._client.post('/v1/customFields/addKey', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -18,9 +27,18 @@ class CustomFields extends resource_1.APIResource {
     }
     /**
      * Deletes one or more custom fields on an instance of a Metronome entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.deleteValues({
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     *   keys: ['x_account_id'],
+     * });
+     * ```
      */
     deleteValues(body, options) {
-        return this._client.post('/customFields/deleteValues', {
+        return this._client.post('/v1/customFields/deleteValues', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -31,13 +49,21 @@ class CustomFields extends resource_1.APIResource {
             return this.listKeys({}, params);
         }
         const { next_page, ...body } = params;
-        return this._client.post('/customFields/listKeys', { query: { next_page }, body, ...options });
+        return this._client.post('/v1/customFields/listKeys', { query: { next_page }, body, ...options });
     }
     /**
      * Remove a key from the allow list for a given entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.removeKey({
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     removeKey(body, options) {
-        return this._client.post('/customFields/removeKey', {
+        return this._client.post('/v1/customFields/removeKey', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -51,9 +77,18 @@ class CustomFields extends resource_1.APIResource {
      * transactional and will update all key/value pairs or no key/value pairs. Partial
      * updates are not supported. There is a 200 character limit on custom field
      * values.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.setValues({
+     *   custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     * });
+     * ```
      */
     setValues(body, options) {
-        return this._client.post('/customFields/setValues', {
+        return this._client.post('/v1/customFields/setValues', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },

package/resources/v1/custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../../src/resources/v1/custom-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,IAAmC,EAAE,OAA6B;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAiBD,QAAQ,CACN,SAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAClC;QACD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAAgC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,IAAgC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAhHD,oCAgHC"}

package/resources/{custom-fields.mjs → v1/custom-fields.mjs}

@@ -1,13 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../resource.mjs";
-import { isRequestOptions } from "../core.mjs";
+import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
 export class CustomFields extends APIResource {
     /**
      * Add a key to the allow list for a given entity. There is a 100 character limit
      * on custom field keys.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.addKey({
+     *   enforce_uniqueness: true,
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     addKey(body, options) {
-        return this._client.post('/customFields/addKey', {
+        return this._client.post('/v1/customFields/addKey', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -15,9 +24,18 @@ export class CustomFields extends APIResource {
     }
     /**
      * Deletes one or more custom fields on an instance of a Metronome entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.deleteValues({
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     *   keys: ['x_account_id'],
+     * });
+     * ```
      */
     deleteValues(body, options) {
-        return this._client.post('/customFields/deleteValues', {
+        return this._client.post('/v1/customFields/deleteValues', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -28,13 +46,21 @@ export class CustomFields extends APIResource {
             return this.listKeys({}, params);
         }
         const { next_page, ...body } = params;
-        return this._client.post('/customFields/listKeys', { query: { next_page }, body, ...options });
+        return this._client.post('/v1/customFields/listKeys', { query: { next_page }, body, ...options });
     }
     /**
      * Remove a key from the allow list for a given entity.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.removeKey({
+     *   entity: 'customer',
+     *   key: 'x_account_id',
+     * });
+     * ```
      */
     removeKey(body, options) {
-        return this._client.post('/customFields/removeKey', {
+        return this._client.post('/v1/customFields/removeKey', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -48,9 +74,18 @@ export class CustomFields extends APIResource {
      * transactional and will update all key/value pairs or no key/value pairs. Partial
      * updates are not supported. There is a 200 character limit on custom field
      * values.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customFields.setValues({
+     *   custom_fields: { x_account_id: 'KyVnHhSBWl7eY2bl' },
+     *   entity: 'customer',
+     *   entity_id: '99594816-e8a5-4bca-be21-8d1de0f45120',
+     * });
+     * ```
      */
     setValues(body, options) {
-        return this._client.post('/customFields/setValues', {
+        return this._client.post('/v1/customFields/setValues', {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },

package/resources/v1/custom-fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.mjs","sourceRoot":"","sources":["../../src/resources/v1/custom-fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;AAG3B,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,IAAmC,EAAE,OAA6B;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE;YACxD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAiBD,QAAQ,CACN,SAA0D,EAAE,EAC5D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SAClC;QACD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAAgC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,IAAgC,EAAE,OAA6B;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE;YACrD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}