metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/models/v1/contract_retrieve_params.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class ContractRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        sig { returns(String) }
+        attr_accessor :contract_id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # Include the balance of credits and commits in the response. Setting this flag
+        # may cause the query to be slower.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_balance
+
+        sig { params(include_balance: T::Boolean).void }
+        attr_writer :include_balance
+
+        # Include commit ledgers in the response. Setting this flag may cause the query to
+        # be slower.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_ledgers
+
+        sig { params(include_ledgers: T::Boolean).void }
+        attr_writer :include_ledgers
+
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            include_balance: T::Boolean,
+            include_ledgers: T::Boolean,
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          contract_id:,
+          customer_id:,
+          # Include the balance of credits and commits in the response. Setting this flag
+          # may cause the query to be slower.
+          include_balance: nil,
+          # Include commit ledgers in the response. Setting this flag may cause the query to
+          # be slower.
+          include_ledgers: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                contract_id: String,
+                customer_id: String,
+                include_balance: T::Boolean,
+                include_ledgers: T::Boolean,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class ContractRetrieveRateScheduleParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # ID of the contract to get the rate schedule for.
+        sig { returns(String) }
+        attr_accessor :contract_id
+
+        # ID of the customer for whose contract to get the rate schedule for.
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # Max number of results that should be returned
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # optional timestamp which overlaps with the returned rate schedule segments. When
+        # not specified, the current timestamp will be used.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :at
+
+        sig { params(at: Time).void }
+        attr_writer :at
+
+        # List of rate selectors, rates matching ANY of the selectors will be included in
+        # the response. Passing no selectors will result in all rates being returned.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector])) }
+        attr_reader :selectors
+
+        sig do
+          params(
+            selectors: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ]
+          )
+            .void
+        end
+        attr_writer :selectors
+
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            limit: Integer,
+            next_page: String,
+            at: Time,
+            selectors: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          # ID of the contract to get the rate schedule for.
+          contract_id:,
+          # ID of the customer for whose contract to get the rate schedule for.
+          customer_id:,
+          # Max number of results that should be returned
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # optional timestamp which overlaps with the returned rate schedule segments. When
+          # not specified, the current timestamp will be used.
+          at: nil,
+          # List of rate selectors, rates matching ANY of the selectors will be included in
+          # the response. Passing no selectors will result in all rates being returned.
+          selectors: nil,
+          request_options: {}
+        ); end
+        sig do
+          override
+            .returns(
+              {
+                contract_id: String,
+                customer_id: String,
+                limit: Integer,
+                next_page: String,
+                at: Time,
+                selectors: T::Array[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector],
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+        end
+        def to_hash; end
+
+        class Selector < MetronomeSDK::Internal::Type::BaseModel
+          # List of pricing group key value pairs, rates containing the matching key / value
+          # pairs will be included in the response.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :partial_pricing_group_values
+
+          sig { params(partial_pricing_group_values: T::Hash[Symbol, String]).void }
+          attr_writer :partial_pricing_group_values
+
+          # List of pricing group key value pairs, rates matching all of the key / value
+          # pairs will be included in the response.
+          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
+
+          # Rates matching the product id will be included in the response.
+          sig { returns(T.nilable(String)) }
+          attr_reader :product_id
+
+          sig { params(product_id: String).void }
+          attr_writer :product_id
+
+          # List of product tags, rates matching any of the tags will be included in the
+          # response.
+          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(
+              partial_pricing_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(
+            # List of pricing group key value pairs, rates containing the matching key / value
+            # pairs will be included in the response.
+            partial_pricing_group_values: nil,
+            # List of pricing group key value pairs, rates matching all of the key / value
+            # pairs will be included in the response.
+            pricing_group_values: nil,
+            # Rates matching the product id will be included in the response.
+            product_id: nil,
+            # List of product tags, rates matching any of the tags will be included in the
+            # response.
+            product_tags: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  partial_pricing_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
+end

data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi

@@ -0,0 +1,254 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class ContractRetrieveRateScheduleResponse < MetronomeSDK::Internal::Type::BaseModel
+        sig { returns(T::Array[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data]) }
+        attr_accessor :data
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_page
+
+        sig do
+          params(
+            data: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            next_page: T.nilable(String)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(data:, next_page: nil); end
+
+        sig do
+          override
+            .returns(
+              {
+                data: T::Array[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data],
+                next_page: T.nilable(String)
+              }
+            )
+        end
+        def to_hash; end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(T::Boolean) }
+          attr_accessor :entitled
+
+          sig { returns(MetronomeSDK::Models::Rate) }
+          attr_reader :list_rate
+
+          sig { params(list_rate: T.any(MetronomeSDK::Models::Rate, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :list_rate
+
+          sig { returns(T::Hash[Symbol, String]) }
+          attr_accessor :product_custom_fields
+
+          sig { returns(String) }
+          attr_accessor :product_id
+
+          sig { returns(String) }
+          attr_accessor :product_name
+
+          sig { returns(T::Array[String]) }
+          attr_accessor :product_tags
+
+          sig { returns(String) }
+          attr_accessor :rate_card_id
+
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          # A distinct rate on the rate card. You can choose to use this rate rather than
+          # list rate when consuming a credit or commit.
+          sig { returns(T.nilable(MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate)) }
+          attr_reader :commit_rate
+
+          sig do
+            params(
+              commit_rate: T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate,
+                MetronomeSDK::Internal::AnyHash
+              )
+            )
+              .void
+          end
+          attr_writer :commit_rate
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :ending_before
+
+          sig { params(ending_before: Time).void }
+          attr_writer :ending_before
+
+          sig { returns(T.nilable(MetronomeSDK::Models::Rate)) }
+          attr_reader :override_rate
+
+          sig { params(override_rate: T.any(MetronomeSDK::Models::Rate, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :override_rate
+
+          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
+
+          sig do
+            params(
+              entitled: T::Boolean,
+              list_rate: T.any(MetronomeSDK::Models::Rate, MetronomeSDK::Internal::AnyHash),
+              product_custom_fields: T::Hash[Symbol, String],
+              product_id: String,
+              product_name: String,
+              product_tags: T::Array[String],
+              rate_card_id: String,
+              starting_at: Time,
+              commit_rate: T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate,
+                MetronomeSDK::Internal::AnyHash
+              ),
+              ending_before: Time,
+              override_rate: T.any(MetronomeSDK::Models::Rate, MetronomeSDK::Internal::AnyHash),
+              pricing_group_values: T::Hash[Symbol, String]
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            entitled:,
+            list_rate:,
+            product_custom_fields:,
+            product_id:,
+            product_name:,
+            product_tags:,
+            rate_card_id:,
+            starting_at:,
+            # A distinct rate on the rate card. You can choose to use this rate rather than
+            # list rate when consuming a credit or commit.
+            commit_rate: nil,
+            ending_before: nil,
+            override_rate: nil,
+            pricing_group_values: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  entitled: T::Boolean,
+                  list_rate: MetronomeSDK::Models::Rate,
+                  product_custom_fields: T::Hash[Symbol, String],
+                  product_id: String,
+                  product_name: String,
+                  product_tags: T::Array[String],
+                  rate_card_id: String,
+                  starting_at: Time,
+                  commit_rate: MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate,
+                  ending_before: Time,
+                  override_rate: MetronomeSDK::Models::Rate,
+                  pricing_group_values: T::Hash[Symbol, String]
+                }
+              )
+          end
+          def to_hash; end
+
+          class CommitRate < MetronomeSDK::Internal::Type::BaseModel
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+              )
+            end
+            attr_accessor :rate_type
+
+            # Commit rate price. For FLAT rate_type, this must be >=0.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :price
+
+            sig { params(price: Float).void }
+            attr_writer :price
+
+            # Only set for TIERED rate_type.
+            sig { returns(T.nilable(T::Array[MetronomeSDK::Models::Tier])) }
+            attr_reader :tiers
+
+            sig { params(tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)]).void }
+            attr_writer :tiers
+
+            # A distinct rate on the rate card. You can choose to use this rate rather than
+            # list rate when consuming a credit or commit.
+            sig do
+              params(
+                rate_type: MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::OrSymbol,
+                price: Float,
+                tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)]
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              rate_type:,
+              # Commit rate price. For FLAT rate_type, this must be >=0.
+              price: nil,
+              # Only set for TIERED rate_type.
+              tiers: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    rate_type: MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol,
+                    price: Float,
+                    tiers: T::Array[MetronomeSDK::Models::Tier]
+                  }
+                )
+            end
+            def to_hash; end
+
+            module RateType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType) }
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              FLAT =
+                T.let(
+                  :FLAT,
+                  MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+                )
+              PERCENTAGE =
+                T.let(
+                  :PERCENTAGE,
+                  MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+                )
+              SUBSCRIPTION =
+                T.let(
+                  :SUBSCRIPTION,
+                  MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+                )
+              TIERED =
+                T.let(
+                  :TIERED,
+                  MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+                )
+              CUSTOM =
+                T.let(
+                  :CUSTOM,
+                  MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
+                )
+
+              sig do
+                override
+                  .returns(
+                    T::Array[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol]
+                  )
+              end
+              def self.values; end
+            end
+          end
+        end
+      end
+    end
+  end
+end