@metronome/sdk 0.1.0-beta.8 → 0.1.0

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

@@ -1,6 +1,6 @@
-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";
 import * as AlertsAPI from "./alerts.js";
 import { AlertListParams, AlertListResponse, AlertResetParams, AlertRetrieveParams, AlertRetrieveResponse, Alerts, CustomerAlert } from "./alerts.js";
 import * as BillingConfigAPI from "./billing-config.js";
@@ -15,7 +15,7 @@ import * as NamedSchedulesAPI from "./named-schedules.js";
 import { NamedScheduleRetrieveParams, NamedScheduleRetrieveResponse, NamedScheduleUpdateParams, NamedSchedules } from "./named-schedules.js";
 import * as PlansAPI from "./plans.js";
 import { PlanAddParams, PlanAddResponse, PlanEndParams, PlanEndResponse, PlanListParams, PlanListPriceAdjustmentsParams, PlanListPriceAdjustmentsResponse, PlanListPriceAdjustmentsResponsesCursorPage, PlanListResponse, PlanListResponsesCursorPage, Plans } from "./plans.js";
-import { CursorPage, type CursorPageParams } from "../../pagination.js";
+import { CursorPage, type CursorPageParams } from "../../../pagination.js";
 export declare class Customers extends APIResource {
     alerts: AlertsAPI.Alerts;
     plans: PlansAPI.Plans;
@@ -26,43 +26,153 @@ export declare class Customers extends APIResource {
     namedSchedules: NamedSchedulesAPI.NamedSchedules;
     /**
      * Create a new customer
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.create({
+     *   name: 'Example, Inc.',
+     *   customer_billing_provider_configurations: [
+     *     {
+     *       billing_provider: 'stripe',
+     *       delivery_method: 'direct_to_billing_provider',
+     *       configuration: {
+     *         stripe_customer_id: 'cus_123',
+     *         stripe_collection_method: 'charge_automatically',
+     *       },
+     *     },
+     *   ],
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
      */
     create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse>;
     /**
      * Get a customer by Metronome ID.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.retrieve({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
      */
     retrieve(params: CustomerRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<CustomerRetrieveResponse>;
     /**
      * List all customers.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerDetail of client.v1.customers.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query?: CustomerListParams, options?: Core.RequestOptions): Core.PagePromise<CustomerDetailsCursorPage, CustomerDetail>;
     list(options?: Core.RequestOptions): Core.PagePromise<CustomerDetailsCursorPage, CustomerDetail>;
     /**
-     * Archive a customer
+     * Archive a customer Note: any alerts associated with the customer will not be
+     * triggered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.archive({
+     *   id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+     * });
+     * ```
      */
     archive(body: CustomerArchiveParams, options?: Core.RequestOptions): Core.APIPromise<CustomerArchiveResponse>;
     /**
      * Get all billable metrics for a given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListBillableMetricsResponse of client.v1.customers.listBillableMetrics(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listBillableMetrics(params: CustomerListBillableMetricsParams, options?: Core.RequestOptions): Core.PagePromise<CustomerListBillableMetricsResponsesCursorPage, CustomerListBillableMetricsResponse>;
     /**
      * Fetch daily pending costs for the specified customer, broken down by credit type
      * and line items. Note: this is not supported for customers whose plan includes a
      * UNIQUE-type billable metric.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListCostsResponse of client.v1.customers.listCosts(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     ending_before: '2019-12-27T18:11:19.117Z',
+     *     starting_on: '2019-12-27T18:11:19.117Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listCosts(params: CustomerListCostsParams, options?: Core.RequestOptions): Core.PagePromise<CustomerListCostsResponsesCursorPage, CustomerListCostsResponse>;
+    /**
+     * Preview how a set of events will affect a customer's invoice. Generates a draft
+     * invoice for a customer using their current contract configuration and the
+     * provided events. This is useful for testing how new events will affect the
+     * customer's invoice before they are actually processed.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.previewEvents({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   events: [
+     *     {
+     *       event_type: 'heartbeat',
+     *       timestamp: '2021-01-01T00:00:00Z',
+     *       properties: { cpu_hours: 100, memory_gb_hours: 200 },
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    previewEvents(params: CustomerPreviewEventsParams, options?: Core.RequestOptions): Core.APIPromise<CustomerPreviewEventsResponse>;
     /**
      * Sets the ingest aliases for a customer. Ingest aliases can be used in the
      * `customer_id` field when sending usage events to Metronome. This call is
      * idempotent. It fully replaces the set of ingest aliases for the given customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.setIngestAliases({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
      */
     setIngestAliases(params: CustomerSetIngestAliasesParams, options?: Core.RequestOptions): Core.APIPromise<void>;
     /**
      * Updates the specified customer's name.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.setName({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   name: 'Example, Inc.',
+     * });
+     * ```
      */
     setName(params: CustomerSetNameParams, options?: Core.RequestOptions): Core.APIPromise<CustomerSetNameResponse>;
     /**
      * Updates the specified customer's config.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.updateConfig({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   salesforce_account_id: '0015500001WO1ZiABL',
+     * });
+     * ```
      */
     updateConfig(params: CustomerUpdateConfigParams, options?: Core.RequestOptions): Core.APIPromise<void>;
 }
@@ -88,14 +198,22 @@ export interface Customer {
      */
     ingest_aliases: Array<string>;
     name: string;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
 }
 export interface CustomerDetail {
     /**
      * the Metronome ID of the customer
      */
     id: string;
-    custom_fields: Record<string, string>;
+    /**
+     * RFC 3339 timestamp indicating when the customer was created.
+     */
+    created_at: string;
+    custom_fields: {
+        [key: string]: string;
+    };
     customer_config: CustomerDetail.CustomerConfig;
     /**
      * (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
@@ -108,6 +226,11 @@ export interface CustomerDetail {
      */
     ingest_aliases: Array<string>;
     name: string;
+    /**
+     * RFC 3339 timestamp indicating when the customer was archived. Null if the
+     * customer is active.
+     */
+    archived_at?: string | null;
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -163,7 +286,9 @@ export interface CustomerListBillableMetricsResponse {
      * provided, the billable metric is not archived.
      */
     archived_at?: string;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     /**
      * An optional filtering rule to match the 'event_type' property of an event.
      */
@@ -171,7 +296,9 @@ export interface CustomerListBillableMetricsResponse {
     /**
      * (DEPRECATED) use property_filters & event_type_filter instead
      */
-    filter?: Record<string, unknown>;
+    filter?: {
+        [key: string]: unknown;
+    };
     /**
      * (DEPRECATED) use group_keys instead
      */
@@ -193,7 +320,9 @@ export interface CustomerListBillableMetricsResponse {
     sql?: string;
 }
 export interface CustomerListCostsResponse {
-    credit_types: Record<string, CustomerListCostsResponse.CreditTypes>;
+    credit_types: {
+        [key: string]: CustomerListCostsResponse.CreditTypes;
+    };
     end_timestamp: string;
     start_timestamp: string;
 }
@@ -212,6 +341,9 @@ export declare namespace CustomerListCostsResponse {
         }
     }
 }
+export interface CustomerPreviewEventsResponse {
+    data: InvoicesAPI.Invoice;
+}
 export interface CustomerSetNameResponse {
     data: Customer;
 }
@@ -221,7 +353,9 @@ export interface CustomerCreateParams {
      */
     name: string;
     billing_config?: CustomerCreateParams.BillingConfig;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     customer_billing_provider_configurations?: Array<CustomerCreateParams.CustomerBillingProviderConfiguration>;
     /**
      * (deprecated, use ingest_aliases instead) an alias that can be used to refer to
@@ -256,7 +390,9 @@ export declare namespace CustomerCreateParams {
          * object, however, for most billing provider + delivery method combinations, it
          * will not be a valid configuration.
          */
-        configuration?: Record<string, unknown>;
+        configuration?: {
+            [key: string]: unknown;
+        };
         /**
          * The method to use for delivering invoices to this customer. If not provided, the
          * `delivery_method_id` must be provided.
@@ -282,7 +418,8 @@ export interface CustomerListParams extends CursorPageParams {
      */
     ingest_alias?: string;
     /**
-     * Filter the customer list by only archived customers.
+     * Filter the customer list to only return archived customers. By default, only
+     * active customers are returned.
      */
     only_archived?: boolean;
     /**
@@ -323,6 +460,52 @@ export interface CustomerListCostsParams extends CursorPageParams {
      */
     starting_on: string;
 }
+export interface CustomerPreviewEventsParams {
+    /**
+     * Path param:
+     */
+    customer_id: string;
+    /**
+     * Body param:
+     */
+    events: Array<CustomerPreviewEventsParams.Event>;
+    /**
+     * Body param: If set to "replace", the preview will be generated as if those were
+     * the only events for the specified customer. If set to "merge", the events will
+     * be merged with any existing events for the specified customer. Defaults to
+     * "replace".
+     */
+    mode?: 'replace' | 'merge';
+    /**
+     * Body param: If set, all zero quantity line items will be filtered out of the
+     * response.
+     */
+    skip_zero_qty_line_items?: boolean;
+}
+export declare namespace CustomerPreviewEventsParams {
+    interface Event {
+        event_type: string;
+        /**
+         * This has no effect for preview events, but may be set for consistency with Event
+         * objects. They will be processed even if they do not match the customer's ID or
+         * ingest aliases.
+         */
+        customer_id?: string;
+        properties?: {
+            [key: string]: unknown;
+        };
+        /**
+         * RFC 3339 formatted. If not provided, the current time will be used.
+         */
+        timestamp?: string;
+        /**
+         * This has no effect for preview events, but may be set for consistency with Event
+         * objects. Duplicate transaction_ids are NOT filtered out, even within the same
+         * request.
+         */
+        transaction_id?: string;
+    }
+}
 export interface CustomerSetIngestAliasesParams {
     /**
      * Path param:
@@ -360,7 +543,7 @@ export interface CustomerUpdateConfigParams {
     salesforce_account_id?: string | null;
 }
 export declare namespace Customers {
-    export { type Customer as Customer, type CustomerDetail as CustomerDetail, type CustomerCreateResponse as CustomerCreateResponse, type CustomerRetrieveResponse as CustomerRetrieveResponse, type CustomerArchiveResponse as CustomerArchiveResponse, type CustomerListBillableMetricsResponse as CustomerListBillableMetricsResponse, type CustomerListCostsResponse as CustomerListCostsResponse, type CustomerSetNameResponse as CustomerSetNameResponse, CustomerDetailsCursorPage as CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage as CustomerListCostsResponsesCursorPage, type CustomerCreateParams as CustomerCreateParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerListParams as CustomerListParams, type CustomerArchiveParams as CustomerArchiveParams, type CustomerListBillableMetricsParams as CustomerListBillableMetricsParams, type CustomerListCostsParams as CustomerListCostsParams, type CustomerSetIngestAliasesParams as CustomerSetIngestAliasesParams, type CustomerSetNameParams as CustomerSetNameParams, type CustomerUpdateConfigParams as CustomerUpdateConfigParams, };
+    export { type Customer as Customer, type CustomerDetail as CustomerDetail, type CustomerCreateResponse as CustomerCreateResponse, type CustomerRetrieveResponse as CustomerRetrieveResponse, type CustomerArchiveResponse as CustomerArchiveResponse, type CustomerListBillableMetricsResponse as CustomerListBillableMetricsResponse, type CustomerListCostsResponse as CustomerListCostsResponse, type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse, type CustomerSetNameResponse as CustomerSetNameResponse, CustomerDetailsCursorPage as CustomerDetailsCursorPage, CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage, CustomerListCostsResponsesCursorPage as CustomerListCostsResponsesCursorPage, type CustomerCreateParams as CustomerCreateParams, type CustomerRetrieveParams as CustomerRetrieveParams, type CustomerListParams as CustomerListParams, type CustomerArchiveParams as CustomerArchiveParams, type CustomerListBillableMetricsParams as CustomerListBillableMetricsParams, type CustomerListCostsParams as CustomerListCostsParams, type CustomerPreviewEventsParams as CustomerPreviewEventsParams, type CustomerSetIngestAliasesParams as CustomerSetIngestAliasesParams, type CustomerSetNameParams as CustomerSetNameParams, type CustomerUpdateConfigParams as CustomerUpdateConfigParams, };
     export { Alerts as Alerts, type CustomerAlert as CustomerAlert, type AlertRetrieveResponse as AlertRetrieveResponse, type AlertListResponse as AlertListResponse, type AlertRetrieveParams as AlertRetrieveParams, type AlertListParams as AlertListParams, type AlertResetParams as AlertResetParams, };
     export { Plans as Plans, type PlanListResponse as PlanListResponse, type PlanAddResponse as PlanAddResponse, type PlanEndResponse as PlanEndResponse, type PlanListPriceAdjustmentsResponse as PlanListPriceAdjustmentsResponse, PlanListResponsesCursorPage as PlanListResponsesCursorPage, PlanListPriceAdjustmentsResponsesCursorPage as PlanListPriceAdjustmentsResponsesCursorPage, type PlanListParams as PlanListParams, type PlanAddParams as PlanAddParams, type PlanEndParams as PlanEndParams, type PlanListPriceAdjustmentsParams as PlanListPriceAdjustmentsParams, };
     export { Invoices as Invoices, type Invoice as Invoice, type InvoiceRetrieveResponse as InvoiceRetrieveResponse, type InvoiceAddChargeResponse as InvoiceAddChargeResponse, type InvoiceListBreakdownsResponse as InvoiceListBreakdownsResponse, InvoicesCursorPage as InvoicesCursorPage, InvoiceListBreakdownsResponsesCursorPage as InvoiceListBreakdownsResponsesCursorPage, type InvoiceRetrieveParams as InvoiceRetrieveParams, type InvoiceListParams as InvoiceListParams, type InvoiceAddChargeParams as InvoiceAddChargeParams, type InvoiceListBreakdownsParams as InvoiceListBreakdownsParams, };

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/customers/customers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,MAAM,EACN,aAAa,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,aAAa,IAAI,6BAA6B,EAC9C,yBAAyB,EACzB,yBAAyB,EACzB,2BAA2B,EAC3B,6BAA6B,EAC9B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,yBAAyB,EACzB,2BAA2B,EAC3B,OAAO,EACR,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,UAAU,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,yBAAyB,EACzB,2BAA2B,EAC3B,OAAO,EACR,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,OAAO,EACP,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,6BAA6B,EAC7B,wCAAwC,EACxC,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,QAAQ,EACR,kBAAkB,EACnB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,iBAAiB,MAAM,mBAAmB,CAAC;AACvD,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,aAAa,EACb,eAAe,EACf,aAAa,EACb,eAAe,EACf,cAAc,EACd,8BAA8B,EAC9B,gCAAgC,EAChC,2CAA2C,EAC3C,gBAAgB,EAChB,2BAA2B,EAC3B,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAExE,qBAAa,SAAU,SAAQ,WAAW;IACxC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IACnE,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAsD;IAEtG;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G;;;;;;;;;OASG;IACH,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAK5C;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,cAAc,CAAC;IAC9D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,cAAc,CAAC;IAWhG;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAI3C;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAM,EAAE,iCAAiC,EACzC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,8CAA8C,EAAE,mCAAmC,CAAC;IASxG;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IASpF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;IAKjD;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IASxB;;;;;;;;;;OAUG;IACH,OAAO,CACL,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAK3C;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAQvG;AAED,qBAAa,yBAA0B,SAAQ,UAAU,CAAC,cAAc,CAAC;CAAG;AAE5E,qBAAa,8CAA+C,SAAQ,UAAU,CAAC,mCAAmC,CAAC;CAAG;AAEtH,qBAAa,oCAAqC,SAAQ,UAAU,CAAC,yBAAyB,CAAC;CAAG;AAElG,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3C;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,eAAe,EAAE,cAAc,CAAC,cAAc,CAAC;IAE/C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,uBAAuB,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC;CAChE;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,cAAc;QAC7B;;WAEG;QACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;KACtC;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC,KAAK,EAAE,UAAU,GAAG,YAAY,CAAC;QAEjC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,mCAAmC;IAClD,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;IAEjE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC;IAE3C;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAElC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAEhD;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,yBAAyB,CAAC,WAAW,CAAA;KAAE,CAAC;IAEvE,aAAa,EAAE,MAAM,CAAC;IAEtB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,mBAAmB,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAE3D,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW,CAAC;QAC3B,UAAiB,iBAAiB;YAChC,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,MAAM,CAAC;YAEb,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,cAAc,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC;IAEpD,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE1C,wCAAwC,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,oCAAoC,CAAC,CAAC;IAE5G;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,aAAa;QAC5B,4BAA4B,EAAE,MAAM,CAAC;QAErC,qBAAqB,EACjB,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,mBAAmB,GACnB,SAAS,GACT,iBAAiB,CAAC;QAEtB;;WAEG;QACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;QAEtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,UAAU,CAAC,EACP,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,eAAe,GACf,WAAW,GACX,WAAW,CAAC;QAEhB,wBAAwB,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;KACpE;IAED,UAAiB,oCAAoC;QACnD;;WAEG;QACH,gBAAgB,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEtG;;;;;WAKG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C;;;WAGG;QACH,eAAe,CAAC,EAAE,4BAA4B,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;QAElF;;;WAGG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAExC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,8BAA8B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAiBD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,yBAAyB,IAAI,yBAAyB,EACtD,8CAA8C,IAAI,8CAA8C,EAChG,oCAAoC,IAAI,oCAAoC,EAC5E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,2BAA2B,IAAI,2BAA2B,EAC1D,2CAA2C,IAAI,2CAA2C,EAC1F,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,kBAAkB,IAAI,kBAAkB,EACxC,wCAAwC,IAAI,wCAAwC,EACpF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,6BAA6B,IAAI,aAAa,EAC9C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,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;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,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;IAEF,OAAO,EACL,cAAc,IAAI,cAAc,EAChC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/{customers → v1/customers}/customers.js

@@ -25,8 +25,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomerListCostsResponsesCursorPage = exports.CustomerListBillableMetricsResponsesCursorPage = exports.CustomerDetailsCursorPage = exports.Customers = 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");
 const AlertsAPI = __importStar(require("./alerts.js"));
 const alerts_1 = require("./alerts.js");
 const BillingConfigAPI = __importStar(require("./billing-config.js"));
@@ -41,7 +41,7 @@ const NamedSchedulesAPI = __importStar(require("./named-schedules.js"));
 const named_schedules_1 = require("./named-schedules.js");
 const PlansAPI = __importStar(require("./plans.js"));
 const plans_1 = require("./plans.js");
-const pagination_1 = require("../../pagination.js");
+const pagination_1 = require("../../../pagination.js");
 class Customers extends resource_1.APIResource {
     constructor() {
         super(...arguments);
@@ -55,56 +55,142 @@ class Customers extends resource_1.APIResource {
     }
     /**
      * Create a new customer
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.create({
+     *   name: 'Example, Inc.',
+     *   customer_billing_provider_configurations: [
+     *     {
+     *       billing_provider: 'stripe',
+     *       delivery_method: 'direct_to_billing_provider',
+     *       configuration: {
+     *         stripe_customer_id: 'cus_123',
+     *         stripe_collection_method: 'charge_automatically',
+     *       },
+     *     },
+     *   ],
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
      */
     create(body, options) {
-        return this._client.post('/customers', { body, ...options });
+        return this._client.post('/v1/customers', { body, ...options });
     }
     /**
      * Get a customer by Metronome ID.
+     *
+     * @example
+     * ```ts
+     * const customer = await client.v1.customers.retrieve({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     * });
+     * ```
      */
     retrieve(params, options) {
         const { customer_id } = params;
-        return this._client.get(`/customers/${customer_id}`, options);
+        return this._client.get(`/v1/customers/${customer_id}`, options);
     }
     list(query = {}, options) {
         if ((0, core_1.isRequestOptions)(query)) {
             return this.list({}, query);
         }
-        return this._client.getAPIList('/customers', CustomerDetailsCursorPage, { query, ...options });
+        return this._client.getAPIList('/v1/customers', CustomerDetailsCursorPage, { query, ...options });
     }
     /**
-     * Archive a customer
+     * Archive a customer Note: any alerts associated with the customer will not be
+     * triggered.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.archive({
+     *   id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+     * });
+     * ```
      */
     archive(body, options) {
-        return this._client.post('/customers/archive', { body, ...options });
+        return this._client.post('/v1/customers/archive', { body, ...options });
     }
     /**
      * Get all billable metrics for a given customer.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListBillableMetricsResponse of client.v1.customers.listBillableMetrics(
+     *   { customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc' },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listBillableMetrics(params, options) {
         const { customer_id, ...query } = params;
-        return this._client.getAPIList(`/customers/${customer_id}/billable-metrics`, CustomerListBillableMetricsResponsesCursorPage, { query, ...options });
+        return this._client.getAPIList(`/v1/customers/${customer_id}/billable-metrics`, CustomerListBillableMetricsResponsesCursorPage, { query, ...options });
     }
     /**
      * Fetch daily pending costs for the specified customer, broken down by credit type
      * and line items. Note: this is not supported for customers whose plan includes a
      * UNIQUE-type billable metric.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const customerListCostsResponse of client.v1.customers.listCosts(
+     *   {
+     *     customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *     ending_before: '2019-12-27T18:11:19.117Z',
+     *     starting_on: '2019-12-27T18:11:19.117Z',
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listCosts(params, options) {
         const { customer_id, ...query } = params;
-        return this._client.getAPIList(`/customers/${customer_id}/costs`, CustomerListCostsResponsesCursorPage, {
-            query,
-            ...options,
-        });
+        return this._client.getAPIList(`/v1/customers/${customer_id}/costs`, CustomerListCostsResponsesCursorPage, { query, ...options });
+    }
+    /**
+     * Preview how a set of events will affect a customer's invoice. Generates a draft
+     * invoice for a customer using their current contract configuration and the
+     * provided events. This is useful for testing how new events will affect the
+     * customer's invoice before they are actually processed.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.previewEvents({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   events: [
+     *     {
+     *       event_type: 'heartbeat',
+     *       timestamp: '2021-01-01T00:00:00Z',
+     *       properties: { cpu_hours: 100, memory_gb_hours: 200 },
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    previewEvents(params, options) {
+        const { customer_id, ...body } = params;
+        return this._client.post(`/v1/customers/${customer_id}/previewEvents`, { body, ...options });
     }
     /**
      * Sets the ingest aliases for a customer. Ingest aliases can be used in the
      * `customer_id` field when sending usage events to Metronome. This call is
      * idempotent. It fully replaces the set of ingest aliases for the given customer.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.setIngestAliases({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   ingest_aliases: ['team@example.com'],
+     * });
+     * ```
      */
     setIngestAliases(params, options) {
         const { customer_id, ...body } = params;
-        return this._client.post(`/customers/${customer_id}/setIngestAliases`, {
+        return this._client.post(`/v1/customers/${customer_id}/setIngestAliases`, {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },
@@ -112,17 +198,33 @@ class Customers extends resource_1.APIResource {
     }
     /**
      * Updates the specified customer's name.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.customers.setName({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   name: 'Example, Inc.',
+     * });
+     * ```
      */
     setName(params, options) {
         const { customer_id, ...body } = params;
-        return this._client.post(`/customers/${customer_id}/setName`, { body, ...options });
+        return this._client.post(`/v1/customers/${customer_id}/setName`, { body, ...options });
     }
     /**
      * Updates the specified customer's config.
+     *
+     * @example
+     * ```ts
+     * await client.v1.customers.updateConfig({
+     *   customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
+     *   salesforce_account_id: '0015500001WO1ZiABL',
+     * });
+     * ```
      */
     updateConfig(params, options) {
         const { customer_id, ...body } = params;
-        return this._client.post(`/customers/${customer_id}/updateConfig`, {
+        return this._client.post(`/v1/customers/${customer_id}/updateConfig`, {
             body,
             ...options,
             headers: { Accept: '*/*', ...options?.headers },

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

@@ -0,0 +1 @@
+{"version":3,"file":"customers.js","sourceRoot":"","sources":["../../../src/resources/v1/customers/customers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,mDAAgD;AAChD,2CAAiD;AAGjD,uDAAsC;AACtC,wCAQkB;AAClB,sEAAqD;AACrD,wDAM0B;AAC1B,yDAAwC;AACxC,0CAQmB;AACnB,yDAAwC;AACxC,0CAQmB;AACnB,2DAA0C;AAC1C,4CAYoB;AACpB,wEAAuD;AACvD,0DAK2B;AAC3B,qDAAoC;AACpC,sCAYiB;AACjB,uDAAwE;AAExE,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,mBAAc,GAAqC,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA4OxG,CAAC;IA1OC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,MAA8B,EAC9B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAkBD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,yBAAyB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mBAAmB,CACjB,MAAyC,EACzC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,mBAAmB,EAC/C,8CAA8C,EAC9C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,MAA+B,EAC/B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,iBAAiB,WAAW,QAAQ,EACpC,oCAAoC,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,MAAmC,EACnC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,MAAsC,EACtC,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,mBAAmB,EAAE;YACxE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CACL,MAA6B,EAC7B,OAA6B;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,MAAkC,EAAE,OAA6B;QAC5E,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,WAAW,eAAe,EAAE;YACpE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAnPD,8BAmPC;AAED,MAAa,yBAA0B,SAAQ,uBAA0B;CAAG;AAA5E,8DAA4E;AAE5E,MAAa,8CAA+C,SAAQ,uBAA+C;CAAG;AAAtH,wGAAsH;AAEtH,MAAa,oCAAqC,SAAQ,uBAAqC;CAAG;AAAlG,oFAAkG;AAqdlG,SAAS,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAChE,SAAS,CAAC,8CAA8C,GAAG,8CAA8C,CAAC;AAC1G,SAAS,CAAC,oCAAoC,GAAG,oCAAoC,CAAC;AACtF,SAAS,CAAC,MAAM,GAAG,eAAM,CAAC;AAC1B,SAAS,CAAC,KAAK,GAAG,aAAK,CAAC;AACxB,SAAS,CAAC,2BAA2B,GAAG,mCAA2B,CAAC;AACpE,SAAS,CAAC,2CAA2C,GAAG,mDAA2C,CAAC;AACpG,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC9B,SAAS,CAAC,kBAAkB,GAAG,6BAAkB,CAAC;AAClD,SAAS,CAAC,wCAAwC,GAAG,mDAAwC,CAAC;AAC9F,SAAS,CAAC,aAAa,GAAG,8BAA6B,CAAC;AACxD,SAAS,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC5B,SAAS,CAAC,OAAO,GAAG,iBAAO,CAAC;AAC5B,SAAS,CAAC,cAAc,GAAG,gCAAc,CAAC"}