metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi

@@ -12,202 +12,154 @@ module MetronomeSDK
             )
           end
 
+        sig { returns(T::Boolean) }
+        attr_accessor :enforce_uniqueness
+
         sig do
           returns(
-            T::Array[
-              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data
-            ]
+            MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
           )
         end
-        attr_accessor :data
+        attr_accessor :entity
 
-        sig { returns(T.nilable(String)) }
-        attr_accessor :next_page
+        sig { returns(String) }
+        attr_accessor :key
 
         sig do
           params(
-            data:
-              T::Array[
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::OrHash
-              ],
-            next_page: T.nilable(String)
+            enforce_uniqueness: T::Boolean,
+            entity:
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::OrSymbol,
+            key: String
           ).returns(T.attached_class)
         end
-        def self.new(data:, next_page:)
+        def self.new(enforce_uniqueness:, entity:, key:)
         end
 
         sig do
           override.returns(
             {
-              data:
-                T::Array[
-                  MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data
-                ],
-              next_page: T.nilable(String)
+              enforce_uniqueness: T::Boolean,
+              entity:
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol,
+              key: String
             }
           )
         end
         def to_hash
         end
 
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
             T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data,
-                MetronomeSDK::Internal::AnyHash
+              T.all(
+                Symbol,
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity
               )
             end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          sig { returns(T::Boolean) }
-          attr_accessor :enforce_uniqueness
-
-          sig do
-            returns(
-              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
+          ALERT =
+            T.let(
+              :alert,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          BILLABLE_METRIC =
+            T.let(
+              :billable_metric,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CHARGE =
+            T.let(
+              :charge,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          COMMIT =
+            T.let(
+              :commit,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CONTRACT_CREDIT =
+            T.let(
+              :contract_credit,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CONTRACT_PRODUCT =
+            T.let(
+              :contract_product,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CONTRACT =
+            T.let(
+              :contract,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CREDIT_GRANT =
+            T.let(
+              :credit_grant,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CUSTOMER_PLAN =
+            T.let(
+              :customer_plan,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          CUSTOMER =
+            T.let(
+              :customer,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          DISCOUNT =
+            T.let(
+              :discount,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PLAN =
+            T.let(
+              :plan,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PROFESSIONAL_SERVICE =
+            T.let(
+              :professional_service,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          PRODUCT =
+            T.let(
+              :product,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          RATE_CARD =
+            T.let(
+              :rate_card,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          SCHEDULED_CHARGE =
+            T.let(
+              :scheduled_charge,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+            )
+          SUBSCRIPTION =
+            T.let(
+              :subscription,
+              MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
             )
-          end
-          attr_accessor :entity
-
-          sig { returns(String) }
-          attr_accessor :key
-
-          sig do
-            params(
-              enforce_uniqueness: T::Boolean,
-              entity:
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::OrSymbol,
-              key: String
-            ).returns(T.attached_class)
-          end
-          def self.new(enforce_uniqueness:, entity:, key:)
-          end
 
           sig do
             override.returns(
-              {
-                enforce_uniqueness: T::Boolean,
-                entity:
-                  MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol,
-                key: String
-              }
+              T::Array[
+                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Entity::TaggedSymbol
+              ]
             )
           end
-          def to_hash
-          end
-
-          module Entity
-            extend MetronomeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            ALERT =
-              T.let(
-                :alert,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            BILLABLE_METRIC =
-              T.let(
-                :billable_metric,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CHARGE =
-              T.let(
-                :charge,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            COMMIT =
-              T.let(
-                :commit,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CONTRACT_CREDIT =
-              T.let(
-                :contract_credit,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CONTRACT_PRODUCT =
-              T.let(
-                :contract_product,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CONTRACT =
-              T.let(
-                :contract,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CREDIT_GRANT =
-              T.let(
-                :credit_grant,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CUSTOMER_PLAN =
-              T.let(
-                :customer_plan,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            CUSTOMER =
-              T.let(
-                :customer,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            DISCOUNT =
-              T.let(
-                :discount,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            INVOICE =
-              T.let(
-                :invoice,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            PLAN =
-              T.let(
-                :plan,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            PROFESSIONAL_SERVICE =
-              T.let(
-                :professional_service,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            PRODUCT =
-              T.let(
-                :product,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            RATE_CARD =
-              T.let(
-                :rate_card,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            SCHEDULED_CHARGE =
-              T.let(
-                :scheduled_charge,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-            SUBSCRIPTION =
-              T.let(
-                :subscription,
-                MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::Entity::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
+          def self.values
           end
         end
       end

data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi

@@ -15,6 +15,7 @@ module MetronomeSDK
             )
           end
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -37,7 +38,13 @@ module MetronomeSDK
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(custom_fields:, entity:, entity_id:, request_options: {})
+        def self.new(
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+          custom_fields:,
+          entity:,
+          entity_id:,
+          request_options: {}
+        )
         end
 
         sig do

data/rbi/metronome_sdk/models/v1/customer.rbi

@@ -26,6 +26,7 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :name
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_reader :custom_fields
 
@@ -51,6 +52,7 @@ module MetronomeSDK
           # in usage events
           ingest_aliases:,
           name:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields: nil
         )
         end

data/rbi/metronome_sdk/models/v1/customer_create_params.rbi

@@ -34,6 +34,7 @@ module MetronomeSDK
         end
         attr_writer :billing_config
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_reader :custom_fields
 
@@ -95,6 +96,7 @@ module MetronomeSDK
           # This will be truncated to 160 characters if the provided name is longer.
           name:,
           billing_config: nil,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields: nil,
           customer_billing_provider_configurations: nil,
           # (deprecated, use ingest_aliases instead) an alias that can be used to refer to
@@ -469,6 +471,16 @@ module MetronomeSDK
                 :send_invoice,
                 MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
               )
+            AUTO_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :auto_charge_payment_intent,
+                MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
+              )
+            MANUALLY_CHARGE_PAYMENT_INTENT =
+              T.let(
+                :manually_charge_payment_intent,
+                MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -536,6 +548,27 @@ module MetronomeSDK
           sig { params(delivery_method_id: String).void }
           attr_writer :delivery_method_id
 
+          # Specifies which tax provider Metronome should use for tax calculation when
+          # billing through Stripe. This is only supported for Stripe billing provider
+          # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+          # collection methods.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::OrSymbol
+              )
+            )
+          end
+          attr_reader :tax_provider
+
+          sig do
+            params(
+              tax_provider:
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::OrSymbol
+            ).void
+          end
+          attr_writer :tax_provider
+
           sig do
             params(
               billing_provider:
@@ -543,7 +576,9 @@ module MetronomeSDK
               configuration: T::Hash[Symbol, T.anything],
               delivery_method:
                 MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod::OrSymbol,
-              delivery_method_id: String
+              delivery_method_id: String,
+              tax_provider:
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -559,7 +594,12 @@ module MetronomeSDK
             delivery_method: nil,
             # ID of the delivery method to use for this customer. If not provided, the
             # `delivery_method` must be provided.
-            delivery_method_id: nil
+            delivery_method_id: nil,
+            # Specifies which tax provider Metronome should use for tax calculation when
+            # billing through Stripe. This is only supported for Stripe billing provider
+            # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+            # collection methods.
+            tax_provider: nil
           )
           end
 
@@ -571,7 +611,9 @@ module MetronomeSDK
                 configuration: T::Hash[Symbol, T.anything],
                 delivery_method:
                   MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::DeliveryMethod::OrSymbol,
-                delivery_method_id: String
+                delivery_method_id: String,
+                tax_provider:
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::OrSymbol
               }
             )
           end
@@ -673,6 +715,49 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          # Specifies which tax provider Metronome should use for tax calculation when
+          # billing through Stripe. This is only supported for Stripe billing provider
+          # configurations with auto_charge_payment_intent or manual_charge_payment_intent
+          # collection methods.
+          module TaxProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANROK =
+              T.let(
+                :anrok,
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::TaggedSymbol
+              )
+            AVALARA =
+              T.let(
+                :avalara,
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::TaggedSymbol
+              )
+            STRIPE =
+              T.let(
+                :stripe,
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::TaxProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/customer_detail.rbi

@@ -20,6 +20,7 @@ module MetronomeSDK
         sig { returns(Time) }
         attr_accessor :created_at
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -47,6 +48,10 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :name
 
+        # RFC 3339 timestamp indicating when the customer was last updated.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
         # RFC 3339 timestamp indicating when the customer was archived. Null if the
         # customer is active.
         sig { returns(T.nilable(Time)) }
@@ -78,6 +83,7 @@ module MetronomeSDK
             external_id: String,
             ingest_aliases: T::Array[String],
             name: String,
+            updated_at: Time,
             archived_at: T.nilable(Time),
             current_billable_status:
               MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus::OrHash
@@ -88,6 +94,7 @@ module MetronomeSDK
           id:,
           # RFC 3339 timestamp indicating when the customer was created.
           created_at:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           customer_config:,
           # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
@@ -97,6 +104,8 @@ module MetronomeSDK
           # in usage events
           ingest_aliases:,
           name:,
+          # RFC 3339 timestamp indicating when the customer was last updated.
+          updated_at:,
           # RFC 3339 timestamp indicating when the customer was archived. Null if the
           # customer is active.
           archived_at: nil,
@@ -115,6 +124,7 @@ module MetronomeSDK
               external_id: String,
               ingest_aliases: T::Array[String],
               name: String,
+              updated_at: Time,
               archived_at: T.nilable(Time),
               current_billable_status:
                 MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus

data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi

@@ -67,6 +67,7 @@ module MetronomeSDK
         sig { params(archived_at: Time).void }
         attr_writer :archived_at
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_reader :custom_fields
 
@@ -159,6 +160,7 @@ module MetronomeSDK
           # RFC 3339 timestamp indicating when the billable metric was archived. If not
           # provided, the billable metric is not archived.
           archived_at: nil,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields: nil,
           # An optional filtering rule to match the 'event_type' property of an event.
           event_type_filter: nil,

data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi

@@ -104,15 +104,6 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :event_type
 
-          # 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.
-          sig { returns(T.nilable(String)) }
-          attr_reader :customer_id
-
-          sig { params(customer_id: String).void }
-          attr_writer :customer_id
-
           sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
           attr_reader :properties
 
@@ -126,9 +117,9 @@ module MetronomeSDK
           sig { params(timestamp: String).void }
           attr_writer :timestamp
 
-          # 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.
+          # Optional unique identifier for event deduplication. When provided, preview
+          # events are automatically deduplicated against historical events from the past 34
+          # days. Duplicate transaction IDs within the same request will return an error.
           sig { returns(T.nilable(String)) }
           attr_reader :transaction_id
 
@@ -138,7 +129,6 @@ module MetronomeSDK
           sig do
             params(
               event_type: String,
-              customer_id: String,
               properties: T::Hash[Symbol, T.anything],
               timestamp: String,
               transaction_id: String
@@ -146,16 +136,12 @@ module MetronomeSDK
           end
           def self.new(
             event_type:,
-            # 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: nil,
             properties: nil,
             # RFC 3339 formatted. If not provided, the current time will be used.
             timestamp: nil,
-            # 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.
+            # Optional unique identifier for event deduplication. When provided, preview
+            # events are automatically deduplicated against historical events from the past 34
+            # days. Duplicate transaction IDs within the same request will return an error.
             transaction_id: nil
           )
           end
@@ -164,7 +150,6 @@ module MetronomeSDK
             override.returns(
               {
                 event_type: String,
-                customer_id: String,
                 properties: T::Hash[Symbol, T.anything],
                 timestamp: String,
                 transaction_id: String

data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi

@@ -12,21 +12,22 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::V1::Customers::Invoice) }
-        attr_reader :data
-
-        sig { params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).void }
-        attr_writer :data
+        sig { returns(T::Array[MetronomeSDK::V1::Customers::Invoice]) }
+        attr_accessor :data
 
         sig do
-          params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            data: T::Array[MetronomeSDK::V1::Customers::Invoice::OrHash]
+          ).returns(T.attached_class)
         end
         def self.new(data:)
         end
 
-        sig { override.returns({ data: MetronomeSDK::V1::Customers::Invoice }) }
+        sig do
+          override.returns(
+            { data: T::Array[MetronomeSDK::V1::Customers::Invoice] }
+          )
+        end
         def to_hash
         end
       end