metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi

@@ -22,10 +22,17 @@ module MetronomeSDK
         end
         attr_accessor :charge_type
 
-        sig { returns(MetronomeSDK::CreditTypeData) }
+        sig do
+          returns(MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType)
+        end
         attr_reader :credit_type
 
-        sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
+        sig do
+          params(
+            credit_type:
+              MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType::OrHash
+          ).void
+        end
         attr_writer :credit_type
 
         sig { returns(T::Hash[Symbol, String]) }
@@ -92,7 +99,8 @@ module MetronomeSDK
             id: String,
             charge_type:
               MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType::OrSymbol,
-            credit_type: MetronomeSDK::CreditTypeData::OrHash,
+            credit_type:
+              MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType::OrHash,
             custom_fields: T::Hash[Symbol, String],
             name: String,
             prices:
@@ -135,7 +143,8 @@ module MetronomeSDK
               id: String,
               charge_type:
                 MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType::TaggedSymbol,
-              credit_type: MetronomeSDK::CreditTypeData,
+              credit_type:
+                MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType,
               custom_fields: T::Hash[Symbol, String],
               name: String,
               prices:
@@ -204,6 +213,30 @@ module MetronomeSDK
           end
         end
 
+        class CreditType < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::PlanListChargesResponse::CreditType,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig { params(id: String, name: String).returns(T.attached_class) }
+          def self.new(id:, name:)
+          end
+
+          sig { override.returns({ id: String, name: String }) }
+          def to_hash
+          end
+        end
+
         class Price < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi

@@ -12,12 +12,17 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::V1::CustomerDetail) }
+        sig do
+          returns(
+            MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails
+          )
+        end
         attr_reader :customer_details
 
         sig do
           params(
-            customer_details: MetronomeSDK::V1::CustomerDetail::OrHash
+            customer_details:
+              MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::OrHash
           ).void
         end
         attr_writer :customer_details
@@ -39,7 +44,8 @@ module MetronomeSDK
 
         sig do
           params(
-            customer_details: MetronomeSDK::V1::CustomerDetail::OrHash,
+            customer_details:
+              MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::OrHash,
             plan_details:
               MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails::OrHash
           ).returns(T.attached_class)
@@ -50,7 +56,8 @@ module MetronomeSDK
         sig do
           override.returns(
             {
-              customer_details: MetronomeSDK::V1::CustomerDetail,
+              customer_details:
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails,
               plan_details:
                 MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails
             }
@@ -59,6 +66,243 @@ module MetronomeSDK
         def to_hash
         end
 
+        class CustomerDetails < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # the Metronome ID of the customer
+          sig { returns(String) }
+          attr_accessor :id
+
+          # RFC 3339 timestamp indicating when the customer was created.
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          sig { returns(T::Hash[Symbol, String]) }
+          attr_accessor :custom_fields
+
+          sig do
+            returns(
+              MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CustomerConfig
+            )
+          end
+          attr_reader :customer_config
+
+          sig do
+            params(
+              customer_config:
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CustomerConfig::OrHash
+            ).void
+          end
+          attr_writer :customer_config
+
+          # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+          # alias) that can be used in usage events
+          sig { returns(String) }
+          attr_accessor :external_id
+
+          # aliases for this customer that can be used instead of the Metronome customer ID
+          # in usage events
+          sig { returns(T::Array[String]) }
+          attr_accessor :ingest_aliases
+
+          sig { returns(String) }
+          attr_accessor :name
+
+          # RFC 3339 timestamp indicating when the customer was archived. Null if the
+          # customer is active.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :archived_at
+
+          # This field's availability is dependent on your client's configuration.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus
+              )
+            )
+          end
+          attr_reader :current_billable_status
+
+          sig do
+            params(
+              current_billable_status:
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::OrHash
+            ).void
+          end
+          attr_writer :current_billable_status
+
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              custom_fields: T::Hash[Symbol, String],
+              customer_config:
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CustomerConfig::OrHash,
+              external_id: String,
+              ingest_aliases: T::Array[String],
+              name: String,
+              archived_at: T.nilable(Time),
+              current_billable_status:
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # the Metronome ID of the customer
+            id:,
+            # RFC 3339 timestamp indicating when the customer was created.
+            created_at:,
+            custom_fields:,
+            customer_config:,
+            # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+            # alias) that can be used in usage events
+            external_id:,
+            # aliases for this customer that can be used instead of the Metronome customer ID
+            # in usage events
+            ingest_aliases:,
+            name:,
+            # RFC 3339 timestamp indicating when the customer was archived. Null if the
+            # customer is active.
+            archived_at: nil,
+            # This field's availability is dependent on your client's configuration.
+            current_billable_status: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                custom_fields: T::Hash[Symbol, String],
+                customer_config:
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CustomerConfig,
+                external_id: String,
+                ingest_aliases: T::Array[String],
+                name: String,
+                archived_at: T.nilable(Time),
+                current_billable_status:
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class CustomerConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CustomerConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The Salesforce account ID for the customer
+            sig { returns(T.nilable(String)) }
+            attr_accessor :salesforce_account_id
+
+            sig do
+              params(salesforce_account_id: T.nilable(String)).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The Salesforce account ID for the customer
+              salesforce_account_id:
+            )
+            end
+
+            sig do
+              override.returns({ salesforce_account_id: T.nilable(String) })
+            end
+            def to_hash
+            end
+          end
+
+          class CurrentBillableStatus < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::TaggedSymbol
+              )
+            end
+            attr_accessor :value
+
+            sig { returns(T.nilable(Time)) }
+            attr_accessor :effective_at
+
+            # This field's availability is dependent on your client's configuration.
+            sig do
+              params(
+                value:
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::OrSymbol,
+                effective_at: T.nilable(Time)
+              ).returns(T.attached_class)
+            end
+            def self.new(value:, effective_at: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  value:
+                    MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::TaggedSymbol,
+                  effective_at: T.nilable(Time)
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Value
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              BILLABLE =
+                T.let(
+                  :billable,
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::TaggedSymbol
+                )
+              UNBILLABLE =
+                T.let(
+                  :unbillable,
+                  MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::PlanListCustomersResponse::CustomerDetails::CurrentBillableStatus::Value::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+
         class PlanDetails < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi

@@ -80,6 +80,29 @@ module MetronomeSDK
         sig { params(product_id: String).void }
         attr_writer :product_id
 
+        # 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`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[MetronomeSDK::V2::ContractEditCommitParams::Specifier]
+            )
+          )
+        end
+        attr_reader :specifiers
+
+        sig do
+          params(
+            specifiers:
+              T::Array[
+                MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
+              ]
+          ).void
+        end
+        attr_writer :specifiers
+
         sig do
           params(
             commit_id: String,
@@ -92,6 +115,10 @@ module MetronomeSDK
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
             product_id: String,
+            specifiers:
+              T::Array[
+                MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
+              ],
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -111,6 +138,11 @@ module MetronomeSDK
           invoice_contract_id: nil,
           invoice_schedule: nil,
           product_id: nil,
+          # 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: nil,
           request_options: {}
         )
         end
@@ -128,6 +160,8 @@ module MetronomeSDK
               invoice_schedule:
                 MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule,
               product_id: String,
+              specifiers:
+                T::Array[MetronomeSDK::V2::ContractEditCommitParams::Specifier],
               request_options: MetronomeSDK::RequestOptions
             }
           )
@@ -631,6 +665,77 @@ module MetronomeSDK
             end
           end
         end
+
+        class Specifier < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V2::ContractEditCommitParams::Specifier,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :presentation_group_values
+
+          sig do
+            params(presentation_group_values: T::Hash[Symbol, String]).void
+          end
+          attr_writer :presentation_group_values
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :pricing_group_values
+
+          sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
+          attr_writer :pricing_group_values
+
+          # If provided, the specifier will only apply to the product with the specified ID.
+          sig { returns(T.nilable(String)) }
+          attr_reader :product_id
+
+          sig { params(product_id: String).void }
+          attr_writer :product_id
+
+          # If provided, the specifier will only apply to products with all the specified
+          # tags.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :product_tags
+
+          sig { params(product_tags: T::Array[String]).void }
+          attr_writer :product_tags
+
+          sig do
+            params(
+              presentation_group_values: T::Hash[Symbol, String],
+              pricing_group_values: T::Hash[Symbol, String],
+              product_id: String,
+              product_tags: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            presentation_group_values: nil,
+            pricing_group_values: nil,
+            # If provided, the specifier will only apply to the product with the specified ID.
+            product_id: nil,
+            # If provided, the specifier will only apply to products with all the specified
+            # tags.
+            product_tags: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                presentation_group_values: T::Hash[Symbol, String],
+                pricing_group_values: T::Hash[Symbol, String],
+                product_id: String,
+                product_tags: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi

@@ -12,19 +12,56 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::ID) }
+        sig do
+          returns(MetronomeSDK::Models::V2::ContractEditCommitResponse::Data)
+        end
         attr_reader :data
 
-        sig { params(data: MetronomeSDK::ID::OrHash).void }
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V2::ContractEditCommitResponse::Data::OrHash
+          ).void
+        end
         attr_writer :data
 
-        sig { params(data: MetronomeSDK::ID::OrHash).returns(T.attached_class) }
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V2::ContractEditCommitResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
         def self.new(data:)
         end
 
-        sig { override.returns({ data: MetronomeSDK::ID }) }
+        sig do
+          override.returns(
+            { data: MetronomeSDK::Models::V2::ContractEditCommitResponse::Data }
+          )
+        end
         def to_hash
         end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V2::ContractEditCommitResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi

@@ -56,6 +56,29 @@ module MetronomeSDK
         sig { params(product_id: String).void }
         attr_writer :product_id
 
+        # 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`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[MetronomeSDK::V2::ContractEditCreditParams::Specifier]
+            )
+          )
+        end
+        attr_reader :specifiers
+
+        sig do
+          params(
+            specifiers:
+              T::Array[
+                MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
+              ]
+          ).void
+        end
+        attr_writer :specifiers
+
         sig do
           params(
             credit_id: String,
@@ -65,6 +88,10 @@ module MetronomeSDK
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
             product_id: String,
+            specifiers:
+              T::Array[
+                MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
+              ],
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -81,6 +108,11 @@ module MetronomeSDK
           # applicable_product_tags are not provided, the credit applies to all products.
           applicable_product_tags: nil,
           product_id: nil,
+          # 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: nil,
           request_options: {}
         )
         end
@@ -95,6 +127,8 @@ module MetronomeSDK
               applicable_product_ids: T.nilable(T::Array[String]),
               applicable_product_tags: T.nilable(T::Array[String]),
               product_id: String,
+              specifiers:
+                T::Array[MetronomeSDK::V2::ContractEditCreditParams::Specifier],
               request_options: MetronomeSDK::RequestOptions
             }
           )
@@ -331,6 +365,77 @@ module MetronomeSDK
             end
           end
         end
+
+        class Specifier < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V2::ContractEditCreditParams::Specifier,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :presentation_group_values
+
+          sig do
+            params(presentation_group_values: T::Hash[Symbol, String]).void
+          end
+          attr_writer :presentation_group_values
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :pricing_group_values
+
+          sig { params(pricing_group_values: T::Hash[Symbol, String]).void }
+          attr_writer :pricing_group_values
+
+          # If provided, the specifier will only apply to the product with the specified ID.
+          sig { returns(T.nilable(String)) }
+          attr_reader :product_id
+
+          sig { params(product_id: String).void }
+          attr_writer :product_id
+
+          # If provided, the specifier will only apply to products with all the specified
+          # tags.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :product_tags
+
+          sig { params(product_tags: T::Array[String]).void }
+          attr_writer :product_tags
+
+          sig do
+            params(
+              presentation_group_values: T::Hash[Symbol, String],
+              pricing_group_values: T::Hash[Symbol, String],
+              product_id: String,
+              product_tags: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            presentation_group_values: nil,
+            pricing_group_values: nil,
+            # If provided, the specifier will only apply to the product with the specified ID.
+            product_id: nil,
+            # If provided, the specifier will only apply to products with all the specified
+            # tags.
+            product_tags: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                presentation_group_values: T::Hash[Symbol, String],
+                pricing_group_values: T::Hash[Symbol, String],
+                product_id: String,
+                product_tags: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end