@metronome/sdk 2.2.0 → 3.0.0

package/src/resources/shared.ts

@@ -138,6 +138,12 @@ export interface Commit {
 
   rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
 
+  /**
+   * The ID of the recurring commit that this commit was generated from, if
+   * applicable.
+   */
+  recurring_commit_id?: string;
+
   rolled_over_from?: Commit.RolledOverFrom;
 
   rollover_fraction?: number;
@@ -154,6 +160,12 @@ export interface Commit {
    */
   specifiers?: Array<CommitSpecifier>;
 
+  /**
+   * The subscription configuration for this commit, if it was generated from a
+   * recurring commit with a subscription attached.
+   */
+  subscription_config?: Commit.SubscriptionConfig;
+
   /**
    * 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
@@ -344,6 +356,27 @@ export namespace Commit {
 
     contract_id: string;
   }
+
+  /**
+   * The subscription configuration for this commit, if it was generated from a
+   * recurring commit with a subscription attached.
+   */
+  export interface SubscriptionConfig {
+    allocation?: 'INDIVIDUAL' | 'POOLED';
+
+    apply_seat_increase_config?: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+    subscription_id?: string;
+  }
+
+  export namespace SubscriptionConfig {
+    export interface ApplySeatIncreaseConfig {
+      /**
+       * Indicates whether a mid-period seat increase should be prorated.
+       */
+      is_prorated: boolean;
+    }
+  }
 }
 
 export interface CommitHierarchyConfiguration {
@@ -808,6 +841,11 @@ export namespace ContractV2 {
 
     rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
 
+    /**
+     * The ID of the recurring commit that created this commit
+     */
+    recurring_commit_id?: string;
+
     rolled_over_from?: Commit.RolledOverFrom;
 
     rollover_fraction?: number;
@@ -1217,6 +1255,11 @@ export namespace ContractV2 {
      */
     priority?: number;
 
+    /**
+     * The ID of the recurring credit that created this credit
+     */
+    recurring_credit_id?: string;
+
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -2265,6 +2308,12 @@ export interface Credit {
 
   rate_type?: 'COMMIT_RATE' | 'LIST_RATE';
 
+  /**
+   * The ID of the recurring credit that this credit was generated from, if
+   * applicable.
+   */
+  recurring_credit_id?: string;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -2277,6 +2326,12 @@ export interface Credit {
    */
   specifiers?: Array<CommitSpecifier>;
 
+  /**
+   * The subscription configuration for this credit, if it was generated from a
+   * recurring credit with a subscription attached.
+   */
+  subscription_config?: Credit.SubscriptionConfig;
+
   /**
    * 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
@@ -2378,6 +2433,27 @@ export namespace Credit {
 
     type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
   }
+
+  /**
+   * The subscription configuration for this credit, if it was generated from a
+   * recurring credit with a subscription attached.
+   */
+  export interface SubscriptionConfig {
+    allocation?: 'INDIVIDUAL' | 'POOLED';
+
+    apply_seat_increase_config?: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+    subscription_id?: string;
+  }
+
+  export namespace SubscriptionConfig {
+    export interface ApplySeatIncreaseConfig {
+      /**
+       * Indicates whether a mid-period seat increase should be prorated.
+       */
+      is_prorated: boolean;
+    }
+  }
 }
 
 export interface CreditTypeData {
@@ -2987,13 +3063,6 @@ export interface Rate {
    * Only set for TIERED rate_type.
    */
   tiers?: Array<Tier>;
-
-  /**
-   * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-   * using list prices rather than the standard rates for this product on the
-   * contract.
-   */
-  use_list_prices?: boolean;
 }
 
 export interface RecurringCommitSubscriptionConfig {

package/src/resources/v1/contracts/rate-cards/rate-cards.ts

@@ -494,7 +494,7 @@ export namespace RateCardUpdateParams {
 
 export interface RateCardListParams extends CursorPageParams {
   /**
-   * Body param:
+   * Body param
    */
   body?: unknown;
 }

package/src/resources/v1/contracts/rate-cards/rates.ts

@@ -196,13 +196,6 @@ export namespace RateAddResponse {
      * Only set for TIERED rate_type.
      */
     tiers?: Array<Shared.Tier>;
-
-    /**
-     * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-     * using list prices rather than the standard rates for this product on the
-     * contract.
-     */
-    use_list_prices?: boolean;
   }
 }
 
@@ -343,13 +336,6 @@ export interface RateAddParams {
    * Only set for TIERED rate_type.
    */
   tiers?: Array<Shared.Tier>;
-
-  /**
-   * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-   * using list prices rather than the standard rates for this product on the
-   * contract.
-   */
-  use_list_prices?: boolean;
 }
 
 export interface RateAddManyParams {
@@ -432,13 +418,6 @@ export namespace RateAddManyParams {
      * Only set for TIERED rate_type.
      */
     tiers?: Array<Shared.Tier>;
-
-    /**
-     * Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-     * using list prices rather than the standard rates for this product on the
-     * contract.
-     */
-    use_list_prices?: boolean;
   }
 }
 

package/src/resources/v1/custom-fields.ts

@@ -180,7 +180,11 @@ export interface CustomFieldListKeysResponse {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -206,7 +210,11 @@ export interface CustomFieldAddKeyParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -230,7 +238,11 @@ export interface CustomFieldDeleteValuesParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   entity_id: string;
 
@@ -260,6 +272,10 @@ export interface CustomFieldListKeysParams extends CursorPageWithoutLimitParams
     | 'rate_card'
     | 'scheduled_charge'
     | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge'
   >;
 }
 
@@ -282,7 +298,11 @@ export interface CustomFieldRemoveKeyParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   key: string;
 }
@@ -311,7 +331,11 @@ export interface CustomFieldSetValuesParams {
     | 'product'
     | 'rate_card'
     | 'scheduled_charge'
-    | 'subscription';
+    | 'subscription'
+    | 'package_commit'
+    | 'package_credit'
+    | 'package_subscription'
+    | 'package_scheduled_charge';
 
   entity_id: string;
 }

package/src/resources/v1/customers/billing-config.ts

@@ -161,7 +161,7 @@ export namespace BillingConfigRetrieveResponse {
 
 export interface BillingConfigCreateParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -186,22 +186,22 @@ export interface BillingConfigCreateParams {
   billing_provider_customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   aws_customer_account_id?: string;
 
   /**
-   * Body param:
+   * Body param
    */
   aws_customer_id?: string;
 
   /**
-   * Body param:
+   * Body param
    */
   aws_product_code?: string;
 
   /**
-   * Body param:
+   * Body param
    */
   aws_region?:
     | 'af-south-1'

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

@@ -1003,7 +1003,7 @@ export interface CustomerArchiveParams {
 
 export interface CustomerListBillableMetricsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1021,7 +1021,7 @@ export interface CustomerListBillableMetricsParams extends CursorPageParams {
 
 export interface CustomerListCostsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1038,7 +1038,7 @@ export interface CustomerListCostsParams extends CursorPageParams {
 
 export interface CustomerPreviewEventsParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1146,19 +1146,19 @@ export namespace CustomerSetBillingConfigurationsParams {
 
 export interface CustomerSetIngestAliasesParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   ingest_aliases: Array<string>;
 }
 
 export interface CustomerSetNameParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1171,7 +1171,7 @@ export interface CustomerSetNameParams {
 
 export interface CustomerUpdateConfigParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

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

@@ -367,6 +367,8 @@ export interface Invoice {
    */
   reseller_royalty?: Invoice.ResellerRoyalty;
 
+  revenue_system_invoices?: Array<Invoice.RevenueSystemInvoice> | null;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -943,6 +945,21 @@ export namespace Invoice {
       gcp_offer_id?: string;
     }
   }
+
+  export interface RevenueSystemInvoice {
+    revenue_system_external_entity_type: string;
+
+    revenue_system_provider: string;
+
+    sync_status: string;
+
+    /**
+     * The error message from the revenue system, if available.
+     */
+    error_message?: string;
+
+    revenue_system_external_entity_id?: string;
+  }
 }
 
 export interface InvoiceRetrieveResponse {
@@ -959,12 +976,12 @@ export interface InvoiceListBreakdownsResponse extends Invoice {
 
 export interface InvoiceRetrieveParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Path param:
+   * Path param
    */
   invoice_id: string;
 
@@ -977,7 +994,7 @@ export interface InvoiceRetrieveParams {
 
 export interface InvoiceListParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1018,7 +1035,7 @@ export interface InvoiceListParams extends CursorPageParams {
 
 export interface InvoiceAddChargeParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -1035,7 +1052,7 @@ export interface InvoiceAddChargeParams {
   customer_plan_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   description: string;
 
@@ -1051,14 +1068,14 @@ export interface InvoiceAddChargeParams {
   price: number;
 
   /**
-   * Body param:
+   * Body param
    */
   quantity: number;
 }
 
 export interface InvoiceListBreakdownsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

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

@@ -197,19 +197,19 @@ export namespace PlanListPriceAdjustmentsResponse {
 
 export interface PlanListParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 }
 
 export interface PlanAddParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   plan_id: string;
 
@@ -326,7 +326,7 @@ export namespace PlanAddParams {
 
 export interface PlanEndParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -359,7 +359,7 @@ export interface PlanEndParams {
 
 export interface PlanListPriceAdjustmentsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

package/src/resources/v1/payments.ts

@@ -95,6 +95,8 @@ export interface Payment {
 
   payment_gateway?: Payment.PaymentGateway;
 
+  revenue_system_payments?: Array<Payment.RevenueSystemPayment>;
+
   status?: PaymentStatus;
 
   updated_at?: string;
@@ -126,6 +128,19 @@ export namespace Payment {
       }
     }
   }
+
+  export interface RevenueSystemPayment {
+    revenue_system_provider: string;
+
+    sync_status: string;
+
+    /**
+     * The error message from the revenue system, if available.
+     */
+    error_message?: string;
+
+    revenue_system_external_payment_id?: string;
+  }
 }
 
 export type PaymentStatus = 'pending' | 'requires_intervention' | 'paid' | 'canceled';

package/src/resources/v1/plans.ts

@@ -306,14 +306,14 @@ export interface PlanGetDetailsParams {
 
 export interface PlanListChargesParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   plan_id: string;
 }
 
 export interface PlanListCustomersParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   plan_id: string;
 

package/src/resources/v1/usage.ts

@@ -451,12 +451,12 @@ export namespace UsageSearchResponse {
 
 export interface UsageListParams extends CursorPageWithoutLimitParams {
   /**
-   * Body param:
+   * Body param
    */
   ending_before: string;
 
   /**
-   * Body param:
+   * Body param
    */
   starting_on: string;
 
@@ -527,12 +527,12 @@ export namespace UsageIngestParams {
 
 export interface UsageListWithGroupsParams extends CursorPageParams {
   /**
-   * Body param:
+   * Body param
    */
   billable_metric_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   customer_id: string;
 
@@ -552,17 +552,17 @@ export interface UsageListWithGroupsParams extends CursorPageParams {
   current_period?: boolean;
 
   /**
-   * Body param:
+   * Body param
    */
   ending_before?: string;
 
   /**
-   * Body param:
+   * Body param
    */
   group_by?: UsageListWithGroupsParams.GroupBy;
 
   /**
-   * Body param:
+   * Body param
    */
   starting_on?: string;
 }

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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