@metronome/sdk 2.0.0 → 2.2.0

package/src/resources/v1/settings/settings.ts

@@ -0,0 +1,94 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as BillingProvidersAPI from './billing-providers';
+import {
+  BillingProviderCreateParams,
+  BillingProviderCreateResponse,
+  BillingProviderListParams,
+  BillingProviderListResponse,
+  BillingProviders,
+} from './billing-providers';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Settings extends APIResource {
+  billingProviders: BillingProvidersAPI.BillingProviders = new BillingProvidersAPI.BillingProviders(
+    this._client,
+  );
+
+  /**
+   * Set the Avalara credentials for some specified `delivery_method_ids`, which can
+   * be found in the `/listConfiguredBillingProviders` response. This maps the
+   * Avalara credentials to the appropriate billing entity. These credentials are
+   * only used for PLG Invoicing today.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.settings.upsertAvalaraCredentials({
+   *     avalara_environment: 'PRODUCTION',
+   *     avalara_password: 'my_password_123',
+   *     avalara_username: 'test@metronome.com',
+   *     delivery_method_ids: [
+   *       '9a906ebb-fbc7-42e8-8e29-53bfd2db3aca',
+   *     ],
+   *     commit_transactions: true,
+   *   });
+   * ```
+   */
+  upsertAvalaraCredentials(
+    body: SettingUpsertAvalaraCredentialsParams,
+    options?: RequestOptions,
+  ): APIPromise<SettingUpsertAvalaraCredentialsResponse> {
+    return this._client.post('/v1/upsertAvalaraCredentials', { body, ...options });
+  }
+}
+
+export interface SettingUpsertAvalaraCredentialsResponse {}
+
+export interface SettingUpsertAvalaraCredentialsParams {
+  /**
+   * The Avalara environment to use (SANDBOX or PRODUCTION).
+   */
+  avalara_environment: 'PRODUCTION' | 'SANDBOX';
+
+  /**
+   * The password for the Avalara account.
+   */
+  avalara_password: string;
+
+  /**
+   * The username for the Avalara account.
+   */
+  avalara_username: string;
+
+  /**
+   * The delivery method IDs of the billing provider configurations to update, can be
+   * found in the response of the `/listConfiguredBillingProviders` endpoint.
+   */
+  delivery_method_ids: Array<string>;
+
+  /**
+   * Commit transactions if you want Metronome tax calculations used for reporting
+   * and tax filings.
+   */
+  commit_transactions?: boolean;
+}
+
+Settings.BillingProviders = BillingProviders;
+
+export declare namespace Settings {
+  export {
+    type SettingUpsertAvalaraCredentialsResponse as SettingUpsertAvalaraCredentialsResponse,
+    type SettingUpsertAvalaraCredentialsParams as SettingUpsertAvalaraCredentialsParams,
+  };
+
+  export {
+    BillingProviders as BillingProviders,
+    type BillingProviderCreateResponse as BillingProviderCreateResponse,
+    type BillingProviderListResponse as BillingProviderListResponse,
+    type BillingProviderCreateParams as BillingProviderCreateParams,
+    type BillingProviderListParams as BillingProviderListParams,
+  };
+}

package/src/resources/v1/settings.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './settings/index';

package/src/resources/v1/usage.ts

@@ -388,9 +388,10 @@ export namespace UsageSearchResponse {
       aggregation_key?: string;
 
       /**
-       * Specifies the type of aggregation performed on matching events.
+       * Specifies the type of aggregation performed on matching events. Includes
+       * "custom_sql" for events search endpoint responses.
        */
-      aggregation_type?: 'COUNT' | 'LATEST' | 'MAX' | 'SUM' | 'UNIQUE';
+      aggregation_type?: 'COUNT' | 'LATEST' | 'MAX' | 'SUM' | 'UNIQUE' | 'custom_sql';
 
       /**
        * RFC 3339 timestamp indicating when the billable metric was archived. If not

package/src/resources/v1/v1.ts

@@ -171,12 +171,19 @@ import {
   CustomerRetrieveParams,
   CustomerRetrieveResponse,
   CustomerSetBillingConfigurationsParams,
+  CustomerSetBillingConfigurationsResponse,
   CustomerSetIngestAliasesParams,
   CustomerSetNameParams,
   CustomerSetNameResponse,
   CustomerUpdateConfigParams,
   Customers,
 } from './customers/customers';
+import * as SettingsAPI from './settings/settings';
+import {
+  SettingUpsertAvalaraCredentialsParams,
+  SettingUpsertAvalaraCredentialsResponse,
+  Settings,
+} from './settings/settings';
 
 export class V1 extends APIResource {
   alerts: AlertsAPI.Alerts = new AlertsAPI.Alerts(this._client);
@@ -193,6 +200,7 @@ export class V1 extends APIResource {
   invoices: InvoicesAPI.Invoices = new InvoicesAPI.Invoices(this._client);
   contracts: ContractsAPI.Contracts = new ContractsAPI.Contracts(this._client);
   payments: PaymentsAPI.Payments = new PaymentsAPI.Payments(this._client);
+  settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
 }
 
 V1.Alerts = Alerts;
@@ -209,6 +217,7 @@ V1.Services = Services;
 V1.Invoices = Invoices;
 V1.Contracts = Contracts;
 V1.Payments = Payments;
+V1.Settings = Settings;
 
 export declare namespace V1 {
   export {
@@ -272,6 +281,7 @@ export declare namespace V1 {
     type CustomerListCostsResponse as CustomerListCostsResponse,
     type CustomerPreviewEventsResponse as CustomerPreviewEventsResponse,
     type CustomerRetrieveBillingConfigurationsResponse as CustomerRetrieveBillingConfigurationsResponse,
+    type CustomerSetBillingConfigurationsResponse as CustomerSetBillingConfigurationsResponse,
     type CustomerSetNameResponse as CustomerSetNameResponse,
     type CustomerDetailsCursorPage as CustomerDetailsCursorPage,
     type CustomerListBillableMetricsResponsesCursorPage as CustomerListBillableMetricsResponsesCursorPage,
@@ -390,4 +400,10 @@ export declare namespace V1 {
     type PaymentAttemptParams as PaymentAttemptParams,
     type PaymentCancelParams as PaymentCancelParams,
   };
+
+  export {
+    Settings as Settings,
+    type SettingUpsertAvalaraCredentialsResponse as SettingUpsertAvalaraCredentialsResponse,
+    type SettingUpsertAvalaraCredentialsParams as SettingUpsertAvalaraCredentialsParams,
+  };
 }

package/src/resources/v2/contracts.ts

@@ -987,6 +987,8 @@ export namespace ContractGetEditHistoryResponse {
        */
       applicable_product_tags?: Array<string> | null;
 
+      description?: string;
+
       /**
        * Optional configuration for commit hierarchy access control
        */
@@ -1111,6 +1113,8 @@ export namespace ContractGetEditHistoryResponse {
 
       access_schedule?: UpdateCredit.AccessSchedule;
 
+      description?: string;
+
       /**
        * Optional configuration for credit hierarchy access control
        */
@@ -1480,6 +1484,11 @@ export namespace ContractGetEditHistoryResponse {
       ending_before?: string;
 
       quantity_updates?: Array<UpdateSubscription.QuantityUpdate>;
+
+      /**
+       * Manage subscription seats for subscriptions in SEAT_BASED mode.
+       */
+      seat_updates?: UpdateSubscription.SeatUpdates;
     }
 
     export namespace UpdateSubscription {
@@ -1490,6 +1499,84 @@ export namespace ContractGetEditHistoryResponse {
 
         quantity_delta?: number;
       }
+
+      /**
+       * Manage subscription seats for subscriptions in SEAT_BASED mode.
+       */
+      export interface SeatUpdates {
+        /**
+         * Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+         * IDs will fill these unassigned seats and not increase the total subscription
+         * quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
+         * total subscription quantity will increase.
+         */
+        add_seat_ids?: Array<SeatUpdates.AddSeatID>;
+
+        /**
+         * Adds unassigned seats to the subscription. This will increase the total
+         * subscription quantity.
+         */
+        add_unassigned_seats?: Array<SeatUpdates.AddUnassignedSeat>;
+
+        /**
+         * Removes seat IDs from the subscription, if possible. If a seat ID is removed,
+         * the total subscription quantity will decrease. Otherwise, if the seat ID is not
+         * found on the subscription, this is a no-op.
+         */
+        remove_seat_ids?: Array<SeatUpdates.RemoveSeatID>;
+
+        /**
+         * Removes unassigned seats from the subscription. This will decrease the total
+         * subscription quantity if there are are unassigned seats.
+         */
+        remove_unassigned_seats?: Array<SeatUpdates.RemoveUnassignedSeat>;
+      }
+
+      export namespace SeatUpdates {
+        export interface AddSeatID {
+          seat_ids: Array<string>;
+
+          /**
+           * Assigned seats will be added/removed starting at this date.
+           */
+          starting_at: string;
+        }
+
+        export interface AddUnassignedSeat {
+          /**
+           * The number of unassigned seats on the subscription will increase/decrease by
+           * this delta. Must be greater than 0.
+           */
+          quantity: number;
+
+          /**
+           * Unassigned seats will be updated starting at this date.
+           */
+          starting_at: string;
+        }
+
+        export interface RemoveSeatID {
+          seat_ids: Array<string>;
+
+          /**
+           * Assigned seats will be added/removed starting at this date.
+           */
+          starting_at: string;
+        }
+
+        export interface RemoveUnassignedSeat {
+          /**
+           * The number of unassigned seats on the subscription will increase/decrease by
+           * this delta. Must be greater than 0.
+           */
+          quantity: number;
+
+          /**
+           * Unassigned seats will be updated starting at this date.
+           */
+          starting_at: string;
+        }
+      }
     }
   }
 }
@@ -1701,7 +1788,8 @@ export namespace ContractEditParams {
         | 'azure_marketplace'
         | 'quickbooks_online'
         | 'workday'
-        | 'gcp_marketplace';
+        | 'gcp_marketplace'
+        | 'metronome';
 
       billing_provider_configuration_id?: string;
 
@@ -2610,7 +2698,8 @@ export namespace ContractEditParams {
       subscription_id: string;
 
       /**
-       * If set to POOLED, allocation added per seat is pooled across the account.
+       * If set to POOLED, allocation added per seat is pooled across the account. If set
+       * to INDIVIDUAL, each seat in the subscription will have its own allocation.
        */
       allocation?: 'POOLED' | 'INDIVIDUAL';
     }
@@ -2773,7 +2862,8 @@ export namespace ContractEditParams {
       subscription_id: string;
 
       /**
-       * If set to POOLED, allocation added per seat is pooled across the account.
+       * If set to POOLED, allocation added per seat is pooled across the account. If set
+       * to INDIVIDUAL, each seat in the subscription will have its own allocation.
        */
       allocation?: 'POOLED' | 'INDIVIDUAL';
     }
@@ -2994,9 +3084,16 @@ export namespace ContractEditParams {
      * QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
      * directly on the subscription. `initial_quantity` must be provided with this
      * option. Compatible with recurring commits/credits that use POOLED allocation.
+     * **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+     * user_123) to increment and decrement a subscription quantity, rather than
+     * directly providing the quantity. You must use a **SEAT_BASED** subscription to
+     * use a linked recurring credit with an allocation per seat. `seat_config` must be
+     * provided with this option.
      */
     quantity_management_mode?: 'SEAT_BASED' | 'QUANTITY_ONLY';
 
+    seat_config?: AddSubscription.SeatConfig;
+
     /**
      * Inclusive start time for the subscription. If not provided, defaults to contract
      * start date
@@ -3039,6 +3136,28 @@ export namespace ContractEditParams {
        */
       product_id: string;
     }
+
+    export interface SeatConfig {
+      /**
+       * The initial assigned seats on this subscription.
+       */
+      initial_seat_ids: Array<string>;
+
+      /**
+       * The property name, sent on usage events, that identifies the seat ID associated
+       * with the usage event. For example, the property name might be seat_id or
+       * user_id. The property must be set as a group key on billable metrics and a
+       * presentation/pricing group key on contract products. This allows linked
+       * recurring credits with an allocation per seat to be consumed by only one seat's
+       * usage.
+       */
+      seat_group_key: string;
+
+      /**
+       * The initial amount of unassigned seats on this subscription.
+       */
+      initial_unassigned_seats?: number;
+    }
   }
 
   export interface ArchiveCommit {
@@ -3076,6 +3195,8 @@ export namespace ContractEditParams {
      */
     applicable_product_tags?: Array<string> | null;
 
+    description?: string;
+
     /**
      * Optional configuration for commit hierarchy access control
      */
@@ -3083,6 +3204,8 @@ export namespace ContractEditParams {
 
     invoice_schedule?: UpdateCommit.InvoiceSchedule;
 
+    name?: string;
+
     netsuite_sales_order_id?: string | null;
 
     priority?: number | null;
@@ -3188,11 +3311,15 @@ export namespace ContractEditParams {
      */
     applicable_product_tags?: Array<string> | null;
 
+    description?: string;
+
     /**
      * Optional configuration for commit hierarchy access control
      */
     hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
 
+    name?: string;
+
     netsuite_sales_order_id?: string | null;
 
     priority?: number | null;
@@ -3420,15 +3547,39 @@ export namespace ContractEditParams {
 
     ending_before?: string | null;
 
+    /**
+     * Update the subscription's quantity management mode from QUANTITY_ONLY to
+     * SEAT_BASED with the provided seat_group_key.
+     */
+    quantity_management_mode_update?: UpdateSubscription.QuantityManagementModeUpdate;
+
     /**
      * Quantity changes are applied on the effective date based on the order which they
      * are sent. For example, if I scheduled the quantity to be 12 on May 21 and then
      * scheduled a quantity delta change of -1, the result from that day would be 11.
      */
     quantity_updates?: Array<UpdateSubscription.QuantityUpdate>;
+
+    seat_updates?: UpdateSubscription.SeatUpdates;
   }
 
   export namespace UpdateSubscription {
+    /**
+     * Update the subscription's quantity management mode from QUANTITY_ONLY to
+     * SEAT_BASED with the provided seat_group_key.
+     */
+    export interface QuantityManagementModeUpdate {
+      quantity_management_mode: 'SEAT_BASED';
+
+      seat_config: QuantityManagementModeUpdate.SeatConfig;
+    }
+
+    export namespace QuantityManagementModeUpdate {
+      export interface SeatConfig {
+        seat_group_key: string;
+      }
+    }
+
     export interface QuantityUpdate {
       starting_at: string;
 
@@ -3445,6 +3596,81 @@ export namespace ContractEditParams {
        */
       quantity_delta?: number;
     }
+
+    export interface SeatUpdates {
+      /**
+       * Adds seat IDs to the subscription. If there are unassigned seats, the new seat
+       * IDs will fill these unassigned seats and not increase the total subscription
+       * quantity. Otherwise, if there are more new seat IDs than unassigned seats, the
+       * total subscription quantity will increase.
+       */
+      add_seat_ids?: Array<SeatUpdates.AddSeatID>;
+
+      /**
+       * Adds unassigned seats to the subscription. This will increase the total
+       * subscription quantity.
+       */
+      add_unassigned_seats?: Array<SeatUpdates.AddUnassignedSeat>;
+
+      /**
+       * Removes seat IDs from the subscription, if possible. If a seat ID is removed,
+       * the total subscription quantity will decrease. Otherwise, if the seat ID is not
+       * found on the subscription, this is a no-op.
+       */
+      remove_seat_ids?: Array<SeatUpdates.RemoveSeatID>;
+
+      /**
+       * Removes unassigned seats from the subscription. This will decrease the total
+       * subscription quantity if there are are unassigned seats.
+       */
+      remove_unassigned_seats?: Array<SeatUpdates.RemoveUnassignedSeat>;
+    }
+
+    export namespace SeatUpdates {
+      export interface AddSeatID {
+        seat_ids: Array<string>;
+
+        /**
+         * Assigned seats will be added/removed starting at this date.
+         */
+        starting_at: string;
+      }
+
+      export interface AddUnassignedSeat {
+        /**
+         * The number of unassigned seats on the subscription will increase/decrease by
+         * this delta. Must be greater than 0.
+         */
+        quantity: number;
+
+        /**
+         * Unassigned seats will be updated starting at this date.
+         */
+        starting_at: string;
+      }
+
+      export interface RemoveSeatID {
+        seat_ids: Array<string>;
+
+        /**
+         * Assigned seats will be added/removed starting at this date.
+         */
+        starting_at: string;
+      }
+
+      export interface RemoveUnassignedSeat {
+        /**
+         * The number of unassigned seats on the subscription will increase/decrease by
+         * this delta. Must be greater than 0.
+         */
+        quantity: number;
+
+        /**
+         * Unassigned seats will be updated starting at this date.
+         */
+        starting_at: string;
+      }
+    }
   }
 }
 
@@ -3475,6 +3701,11 @@ export interface ContractEditCommitParams {
    */
   applicable_product_tags?: Array<string> | null;
 
+  /**
+   * Updated description for the commit
+   */
+  description?: string;
+
   /**
    * Optional configuration for commit hierarchy access control
    */
@@ -3487,6 +3718,11 @@ export interface ContractEditCommitParams {
 
   invoice_schedule?: ContractEditCommitParams.InvoiceSchedule;
 
+  /**
+   * Updated name for the commit
+   */
+  name?: string;
+
   /**
    * If multiple commits are applicable, the one with the lower priority will apply
    * first.
@@ -3608,11 +3844,21 @@ export interface ContractEditCreditParams {
    */
   applicable_product_tags?: Array<string> | null;
 
+  /**
+   * Updated description for the credit
+   */
+  description?: string;
+
   /**
    * Optional configuration for credit hierarchy access control
    */
   hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
 
+  /**
+   * Updated name for the credit
+   */
+  name?: string;
+
   /**
    * If multiple commits are applicable, the one with the lower priority will apply
    * first.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.0.0'; // x-release-please-version
+export const VERSION = '2.2.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.0.0";
+export declare const VERSION = "2.2.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.0.0";
+export declare const VERSION = "2.2.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.0.0'; // x-release-please-version
+exports.VERSION = '2.2.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.0.0'; // x-release-please-version
+export const VERSION = '2.2.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map