@metronome/sdk 0.1.0-beta.9 → 0.1.0

package/src/resources/v1/customers/commits.ts

@@ -1,12 +1,45 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 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: CommitCreateParams, options?: Core.RequestOptions): Core.APIPromise<CommitCreateResponse> {
     return this._client.post('/v1/contracts/customerCommits/create', { body, ...options });
@@ -14,13 +47,35 @@ export class Commits extends APIResource {
 
   /**
    * 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: CommitListParams, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse> {
     return this._client.post('/v1/contracts/customerCommits/list', { body, ...options });
   }
 
   /**
-   * Update the end date of a PREPAID commit
+   * 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: CommitUpdateEndDateParams,
@@ -74,18 +129,20 @@ export interface CommitCreateParams {
   applicable_contract_ids?: Array<string>;
 
   /**
-   * Which products the commit applies to. If both applicable_product_ids and
-   * applicable_product_tags are not provided, the commit applies to all products.
+   * Which products the commit applies to. If applicable_product_ids,
+   * applicable_product_tags or specifiers are not provided, the commit applies to
+   * all products.
    */
   applicable_product_ids?: Array<string>;
 
   /**
-   * Which tags the commit applies to. If both applicable_product_ids and
-   * applicable_product_tags are not provided, the commit applies to all products.
+   * Which tags the commit applies to. If applicable_product_ids,
+   * applicable_product_tags or specifiers are not provided, the commit 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.
@@ -124,6 +181,14 @@ export interface CommitCreateParams {
    */
   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<CommitCreateParams.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
@@ -259,6 +324,23 @@ export namespace CommitCreateParams {
       unit_price?: number;
     }
   }
+
+  export 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 CommitListParams {
@@ -277,7 +359,7 @@ export interface CommitListParams {
   effective_before?: string;
 
   /**
-   * Include commits from archived contracts.
+   * Include archived commits and commits from archived contracts.
    */
   include_archived?: boolean;
 
@@ -298,6 +380,11 @@ export interface CommitListParams {
    */
   include_ledgers?: boolean;
 
+  /**
+   * The maximum number of commits to return. Defaults to 25.
+   */
+  limit?: number;
+
   /**
    * The next page token from a previous response.
    */

package/src/resources/v1/customers/credits.ts

@@ -1,12 +1,32 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 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: CreditCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditCreateResponse> {
     return this._client.post('/v1/contracts/customerCredits/create', { body, ...options });
@@ -14,13 +34,33 @@ export class Credits extends APIResource {
 
   /**
    * 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> {
     return this._client.post('/v1/contracts/customerCredits/list', { body, ...options });
   }
 
   /**
-   * 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,
@@ -78,7 +118,7 @@ export interface CreditCreateParams {
    */
   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.
@@ -102,6 +142,14 @@ export interface CreditCreateParams {
    */
   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
@@ -139,6 +187,23 @@ export namespace CreditCreateParams {
       starting_at: string;
     }
   }
+
+  export 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 {
@@ -157,7 +222,7 @@ export interface CreditListParams {
   effective_before?: string;
 
   /**
-   * Include credits from archived contracts.
+   * Include archived credits and credits from archived contracts.
    */
   include_archived?: boolean;
 
@@ -178,6 +243,11 @@ export interface CreditListParams {
    */
   include_ledgers?: boolean;
 
+  /**
+   * The maximum number of commits to return. Defaults to 25.
+   */
+  limit?: number;
+
   /**
    * The next page token from a previous response.
    */