@metronome/sdk 1.0.0 → 2.1.0

package/src/resources/v1/settings/billing-providers.ts

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class BillingProviders extends APIResource {
+  /**
+   * Set up account-level configuration for a billing provider. Once configured,
+   * individual contracts across customers can be mapped to this configuration using
+   * the returned delivery_method_id.
+   *
+   * @example
+   * ```ts
+   * const billingProvider =
+   *   await client.v1.settings.billingProviders.create({
+   *     billing_provider: 'aws_marketplace',
+   *     configuration: {
+   *       aws_external_id:
+   *         '47b4f6b7-e297-42e8-b175-331d933b402c',
+   *       aws_iam_role_arn: 'arn:aws:iam::test',
+   *     },
+   *     delivery_method: 'direct_to_billing_provider',
+   *   });
+   * ```
+   */
+  create(
+    body: BillingProviderCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<BillingProviderCreateResponse> {
+    return this._client.post('/v1/setUpBillingProvider', { body, ...options });
+  }
+
+  /**
+   * Lists all configured billing providers and their delivery method configurations
+   * for your account. Returns provider details, delivery method IDs, and
+   * configuration settings needed for mapping individual customer contracts to
+   * billing integrations.
+   *
+   * @example
+   * ```ts
+   * const billingProviders =
+   *   await client.v1.settings.billingProviders.list({
+   *     next_page: 'af26878a-de62-4a0d-9b77-3936f7c2b6d6',
+   *   });
+   * ```
+   */
+  list(
+    body: BillingProviderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<BillingProviderListResponse> {
+    return this._client.post('/v1/listConfiguredBillingProviders', { body, ...options });
+  }
+}
+
+export interface BillingProviderCreateResponse {
+  data: BillingProviderCreateResponse.Data;
+}
+
+export namespace BillingProviderCreateResponse {
+  export interface Data {
+    delivery_method_id: string;
+  }
+}
+
+export interface BillingProviderListResponse {
+  data: Array<BillingProviderListResponse.Data>;
+
+  next_page?: string | null;
+}
+
+export namespace BillingProviderListResponse {
+  export interface Data {
+    /**
+     * The billing provider set for this configuration.
+     */
+    billing_provider:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace'
+      | 'metronome';
+
+    /**
+     * The method to use for delivering invoices to this customer.
+     */
+    delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+
+    /**
+     * Configuration for the delivery method. The structure of this object is specific
+     * to the delivery method. Some configuration may be omitted for security reasons.
+     */
+    delivery_method_configuration: { [key: string]: unknown };
+
+    /**
+     * ID of the delivery method to use for this customer.
+     */
+    delivery_method_id: string;
+  }
+}
+
+export interface BillingProviderCreateParams {
+  /**
+   * The billing provider set for this configuration.
+   */
+  billing_provider: 'aws_marketplace' | 'azure_marketplace';
+
+  /**
+   * Account-level configuration for the billing provider. The structure of this
+   * object is specific to the billing provider and delivery provider combination.
+   * See examples below.
+   */
+  configuration: { [key: string]: unknown };
+
+  /**
+   * The method to use for delivering invoices for this configuration.
+   */
+  delivery_method: 'direct_to_billing_provider' | 'aws_sqs' | 'aws_sns';
+}
+
+export interface BillingProviderListParams {
+  /**
+   * The cursor to the next page of results
+   */
+  next_page?: string | null;
+}
+
+export declare namespace BillingProviders {
+  export {
+    type BillingProviderCreateResponse as BillingProviderCreateResponse,
+    type BillingProviderListResponse as BillingProviderListResponse,
+    type BillingProviderCreateParams as BillingProviderCreateParams,
+    type BillingProviderListParams as BillingProviderListParams,
+  };
+}

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

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  BillingProviders,
+  type BillingProviderCreateResponse,
+  type BillingProviderListResponse,
+  type BillingProviderCreateParams,
+  type BillingProviderListParams,
+} from './billing-providers';
+export {
+  Settings,
+  type SettingUpsertAvalaraCredentialsResponse,
+  type SettingUpsertAvalaraCredentialsParams,
+} from './settings';

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

@@ -0,0 +1,87 @@
+// 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',
+   *     ],
+   *   });
+   * ```
+   */
+  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>;
+}
+
+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

@@ -81,8 +81,7 @@ export class Usage extends APIResource {
    * ingestion, supports backdating 34 days, and is built to handle mission-critical
    * usage data with enterprise-grade reliability. Metronome supports 100,000 events
    * per second without requiring pre-aggregation or rollups and can scale up from
-   * there. See
-   * [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to
+   * there. See the [Send usage events](/guides/events/send-usage-events) guide to
    * learn more about usage events.
    *
    * ### Use this endpoint to:
@@ -125,6 +124,9 @@ export class Usage extends APIResource {
    * }
    * ```
    *
+   * Learn more about
+   * [usage event structure definitions](/guides/events/design-usage-events).
+   *
    * #### Transaction ID
    *
    * The transaction_id serves as your idempotency key, ensuring events are processed

package/src/resources/v1/v1.ts

@@ -69,6 +69,18 @@ import {
   InvoiceVoidResponse,
   Invoices,
 } from './invoices';
+import * as PaymentsAPI from './payments';
+import {
+  Payment,
+  PaymentAttemptParams,
+  PaymentAttemptResponse,
+  PaymentCancelParams,
+  PaymentCancelResponse,
+  PaymentListParams,
+  PaymentStatus,
+  Payments,
+  PaymentsBodyCursorPage,
+} from './payments';
 import * as PlansAPI from './plans';
 import {
   PlanDetail,
@@ -165,6 +177,12 @@ import {
   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);
@@ -180,6 +198,8 @@ export class V1 extends APIResource {
   services: ServicesAPI.Services = new ServicesAPI.Services(this._client);
   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;
@@ -195,6 +215,8 @@ V1.BillableMetrics = BillableMetrics;
 V1.Services = Services;
 V1.Invoices = Invoices;
 V1.Contracts = Contracts;
+V1.Payments = Payments;
+V1.Settings = Settings;
 
 export declare namespace V1 {
   export {
@@ -364,4 +386,22 @@ export declare namespace V1 {
     type ContractSetUsageFilterParams as ContractSetUsageFilterParams,
     type ContractUpdateEndDateParams as ContractUpdateEndDateParams,
   };
+
+  export {
+    Payments as Payments,
+    type Payment as Payment,
+    type PaymentStatus as PaymentStatus,
+    type PaymentAttemptResponse as PaymentAttemptResponse,
+    type PaymentCancelResponse as PaymentCancelResponse,
+    type PaymentsBodyCursorPage as PaymentsBodyCursorPage,
+    type PaymentListParams as PaymentListParams,
+    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

@@ -373,7 +373,7 @@ export namespace ContractGetEditHistoryResponse {
       /**
        * The schedule that the customer will be invoiced for this commit.
        */
-      invoice_schedule?: Shared.SchedulePointInTime;
+      invoice_schedule?: AddCommit.InvoiceSchedule;
 
       name?: string;
 
@@ -414,6 +414,36 @@ export namespace ContractGetEditHistoryResponse {
 
         name: string;
       }
+
+      /**
+       * The schedule that the customer will be invoiced for this commit.
+       */
+      export interface InvoiceSchedule {
+        credit_type?: Shared.CreditTypeData;
+
+        /**
+         * If true, this schedule will not generate an invoice.
+         */
+        do_not_invoice?: boolean;
+
+        schedule_items?: Array<InvoiceSchedule.ScheduleItem>;
+      }
+
+      export namespace InvoiceSchedule {
+        export interface ScheduleItem {
+          id: string;
+
+          timestamp: string;
+
+          amount?: number;
+
+          invoice_id?: string | null;
+
+          quantity?: number;
+
+          unit_price?: number;
+        }
+      }
     }
 
     export interface AddCredit {
@@ -495,7 +525,7 @@ export namespace ContractGetEditHistoryResponse {
 
       override_tiers?: Array<Shared.OverrideTier>;
 
-      overwrite_rate?: Shared.OverwriteRate;
+      overwrite_rate?: AddOverride.OverwriteRate;
 
       priority?: number;
 
@@ -525,6 +555,40 @@ export namespace ContractGetEditHistoryResponse {
         recurring_credit_ids?: Array<string>;
       }
 
+      export interface OverwriteRate {
+        rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
+
+        credit_type?: Shared.CreditTypeData;
+
+        /**
+         * Only set for CUSTOM rate_type. This field is interpreted by custom rate
+         * processors.
+         */
+        custom_rate?: { [key: string]: unknown };
+
+        /**
+         * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+         * set to true.
+         */
+        is_prorated?: boolean;
+
+        /**
+         * Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+         * this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+         */
+        price?: number;
+
+        /**
+         * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+         */
+        quantity?: number;
+
+        /**
+         * Only set for TIERED rate_type.
+         */
+        tiers?: Array<Shared.Tier>;
+      }
+
       export interface Product {
         id: string;
 
@@ -1301,6 +1365,8 @@ export namespace ContractGetEditHistoryResponse {
       ending_before?: string;
 
       invoice_amount?: UpdateRecurringCommit.InvoiceAmount;
+
+      rate_type?: 'LIST_RATE' | 'COMMIT_RATE';
     }
 
     export namespace UpdateRecurringCommit {
@@ -1323,6 +1389,8 @@ export namespace ContractGetEditHistoryResponse {
       access_amount?: UpdateRecurringCredit.AccessAmount;
 
       ending_before?: string;
+
+      rate_type?: 'LIST_RATE' | 'COMMIT_RATE';
     }
 
     export namespace UpdateRecurringCredit {
@@ -1494,6 +1562,13 @@ export interface ContractEditParams {
    */
   customer_id: string;
 
+  /**
+   * Update the billing provider configuration on the contract. Currently only
+   * supports adding a billing provider configuration to a contract that does not
+   * already have one.
+   */
+  add_billing_provider_configuration_update?: ContractEditParams.AddBillingProviderConfigurationUpdate;
+
   add_commits?: Array<ContractEditParams.AddCommit>;
 
   add_credits?: Array<ContractEditParams.AddCredit>;
@@ -1601,6 +1676,51 @@ export interface ContractEditParams {
 }
 
 export namespace ContractEditParams {
+  /**
+   * Update the billing provider configuration on the contract. Currently only
+   * supports adding a billing provider configuration to a contract that does not
+   * already have one.
+   */
+  export interface AddBillingProviderConfigurationUpdate {
+    billing_provider_configuration: AddBillingProviderConfigurationUpdate.BillingProviderConfiguration;
+
+    /**
+     * Indicates when the billing provider will be active on the contract. Any charges
+     * accrued during the schedule will be billed to the indicated billing provider.
+     */
+    schedule: AddBillingProviderConfigurationUpdate.Schedule;
+  }
+
+  export namespace AddBillingProviderConfigurationUpdate {
+    export interface BillingProviderConfiguration {
+      billing_provider?:
+        | 'aws_marketplace'
+        | 'stripe'
+        | 'netsuite'
+        | 'custom'
+        | 'azure_marketplace'
+        | 'quickbooks_online'
+        | 'workday'
+        | 'gcp_marketplace'
+        | 'metronome';
+
+      billing_provider_configuration_id?: string;
+
+      delivery_method?: 'direct_to_billing_provider' | 'aws_sqs' | 'tackle' | 'aws_sns';
+    }
+
+    /**
+     * Indicates when the billing provider will be active on the contract. Any charges
+     * accrued during the schedule will be billed to the indicated billing provider.
+     */
+    export interface Schedule {
+      /**
+       * When the billing provider update will take effect.
+       */
+      effective_at: 'START_OF_CURRENT_PERIOD';
+    }
+  }
+
   export interface AddCommit {
     product_id: string;
 
@@ -1858,7 +1978,7 @@ export namespace ContractEditParams {
        * not wish Metronome to calculate tax on your behalf. Leaving this field blank
        * will default to NONE.
        */
-      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'AVALARA' | 'PRECALCULATED';
     }
 
     export namespace PaymentGateConfig {
@@ -2491,7 +2611,9 @@ 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. (BETA)
+       * If set to INDIVIDUAL, each seat in the subscription will have its own
+       * allocation.
        */
       allocation?: 'POOLED' | 'INDIVIDUAL';
     }
@@ -2654,7 +2776,9 @@ 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. (BETA)
+       * If set to INDIVIDUAL, each seat in the subscription will have its own
+       * allocation.
        */
       allocation?: 'POOLED' | 'INDIVIDUAL';
     }
@@ -2875,6 +2999,11 @@ 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**: (BETA) 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';
 
@@ -3187,6 +3316,12 @@ export namespace ContractEditParams {
     ending_before?: string | null;
 
     invoice_amount?: UpdateRecurringCommit.InvoiceAmount;
+
+    /**
+     * If provided, updates the recurring commit to use the specified rate type when
+     * generating future commits.
+     */
+    rate_type?: 'LIST_RATE' | 'COMMIT_RATE';
   }
 
   export namespace UpdateRecurringCommit {
@@ -3209,6 +3344,12 @@ export namespace ContractEditParams {
     access_amount?: UpdateRecurringCredit.AccessAmount;
 
     ending_before?: string | null;
+
+    /**
+     * If provided, updates the recurring credit to use the specified rate type when
+     * generating future credits.
+     */
+    rate_type?: 'LIST_RATE' | 'COMMIT_RATE';
   }
 
   export namespace UpdateRecurringCredit {
@@ -3344,6 +3485,11 @@ export interface ContractEditCommitParams {
    */
   applicable_product_tags?: Array<string> | null;
 
+  /**
+   * Optional configuration for commit hierarchy access control
+   */
+  hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+
   /**
    * ID of contract to use for invoicing
    */
@@ -3472,6 +3618,11 @@ export interface ContractEditCreditParams {
    */
   applicable_product_tags?: Array<string> | null;
 
+  /**
+   * Optional configuration for credit hierarchy access control
+   */
+  hierarchy_configuration?: Shared.CommitHierarchyConfiguration;
+
   /**
    * If multiple commits are applicable, the one with the lower priority will apply
    * first.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.0.0'; // x-release-please-version
+export const VERSION = '2.1.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0";
+export declare const VERSION = "2.1.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 = '1.0.0'; // x-release-please-version
+exports.VERSION = '2.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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