metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi

@@ -0,0 +1,248 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class ProductUpdateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # ID of the product to update
+          sig { returns(String) }
+          attr_accessor :product_id
+
+          # Timestamp representing when the update should go into effect. It must be on an
+          # hour boundary (e.g. 1:00, not 1:30).
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          # Available for USAGE products only. If not provided, defaults to product's
+          # current billable metric.
+          sig { returns(T.nilable(String)) }
+          attr_reader :billable_metric_id
+
+          sig { params(billable_metric_id: String).void }
+          attr_writer :billable_metric_id
+
+          # Available for COMPOSITE products only. If not provided, defaults to product's
+          # current composite_product_ids.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :composite_product_ids
+
+          sig { params(composite_product_ids: T::Array[String]).void }
+          attr_writer :composite_product_ids
+
+          # Available for COMPOSITE products only. If not provided, defaults to product's
+          # current composite_tags.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :composite_tags
+
+          sig { params(composite_tags: T::Array[String]).void }
+          attr_writer :composite_tags
+
+          # Beta feature only available for composite products. If true, products with $0
+          # will not be included when computing composite usage. Defaults to false
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :exclude_free_usage
+
+          sig { params(exclude_free_usage: T::Boolean).void }
+          attr_writer :exclude_free_usage
+
+          # Defaults to product's current refundability status. This field's availability is
+          # dependent on your client's configuration.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_refundable
+
+          sig { params(is_refundable: T::Boolean).void }
+          attr_writer :is_refundable
+
+          # displayed on invoices. If not provided, defaults to product's current name.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # If not provided, defaults to product's current netsuite_internal_item_id. This
+          # field's availability is dependent on your client's configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :netsuite_internal_item_id
+
+          sig { params(netsuite_internal_item_id: String).void }
+          attr_writer :netsuite_internal_item_id
+
+          # Available for USAGE and COMPOSITE products only. If not provided, defaults to
+          # product's current netsuite_overage_item_id. This field's availability is
+          # dependent on your client's configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :netsuite_overage_item_id
+
+          sig { params(netsuite_overage_item_id: String).void }
+          attr_writer :netsuite_overage_item_id
+
+          # For USAGE products only. Groups usage line items on invoices. The superset of
+          # values in the pricing group key and presentation group key must be set as one
+          # compound group key on the billable metric.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :presentation_group_key
+
+          sig { params(presentation_group_key: T::Array[String]).void }
+          attr_writer :presentation_group_key
+
+          # For USAGE products only. If set, pricing for this product will be determined for
+          # each pricing_group_key value, as opposed to the product as a whole. The superset
+          # of values in the pricing group key and presentation group key must be set as one
+          # compound group key on the billable metric.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :pricing_group_key
+
+          sig { params(pricing_group_key: T::Array[String]).void }
+          attr_writer :pricing_group_key
+
+          # Optional. Only valid for USAGE products. If provided, the quantity will be
+          # converted using the provided conversion factor and operation. For example, if
+          # the operation is "multiply" and the conversion factor is 100, then the quantity
+          # will be multiplied by 100. This can be used in cases where data is sent in one
+          # unit and priced in another. For example, data could be sent in MB and priced in
+          # GB. In this case, the conversion factor would be 1024 and the operation would be
+          # "divide".
+          sig { returns(T.nilable(MetronomeSDK::Models::V1::Contracts::QuantityConversion)) }
+          attr_reader :quantity_conversion
+
+          sig do
+            params(
+              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash))
+            )
+              .void
+          end
+          attr_writer :quantity_conversion
+
+          # Optional. Only valid for USAGE products. If provided, the quantity will be
+          # rounded using the provided rounding method and decimal places. For example, if
+          # the method is "round up" and the decimal places is 0, then the quantity will be
+          # rounded up to the nearest integer.
+          sig { returns(T.nilable(MetronomeSDK::Models::V1::Contracts::QuantityRounding)) }
+          attr_reader :quantity_rounding
+
+          sig do
+            params(
+              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash))
+            )
+              .void
+          end
+          attr_writer :quantity_rounding
+
+          # If not provided, defaults to product's current tags
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :tags
+
+          sig { params(tags: T::Array[String]).void }
+          attr_writer :tags
+
+          sig do
+            params(
+              product_id: String,
+              starting_at: Time,
+              billable_metric_id: String,
+              composite_product_ids: T::Array[String],
+              composite_tags: T::Array[String],
+              exclude_free_usage: T::Boolean,
+              is_refundable: T::Boolean,
+              name: String,
+              netsuite_internal_item_id: String,
+              netsuite_overage_item_id: String,
+              presentation_group_key: T::Array[String],
+              pricing_group_key: T::Array[String],
+              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash)),
+              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash)),
+              tags: T::Array[String],
+              request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # ID of the product to update
+            product_id:,
+            # Timestamp representing when the update should go into effect. It must be on an
+            # hour boundary (e.g. 1:00, not 1:30).
+            starting_at:,
+            # Available for USAGE products only. If not provided, defaults to product's
+            # current billable metric.
+            billable_metric_id: nil,
+            # Available for COMPOSITE products only. If not provided, defaults to product's
+            # current composite_product_ids.
+            composite_product_ids: nil,
+            # Available for COMPOSITE products only. If not provided, defaults to product's
+            # current composite_tags.
+            composite_tags: nil,
+            # Beta feature only available for composite products. If true, products with $0
+            # will not be included when computing composite usage. Defaults to false
+            exclude_free_usage: nil,
+            # Defaults to product's current refundability status. This field's availability is
+            # dependent on your client's configuration.
+            is_refundable: nil,
+            # displayed on invoices. If not provided, defaults to product's current name.
+            name: nil,
+            # If not provided, defaults to product's current netsuite_internal_item_id. This
+            # field's availability is dependent on your client's configuration.
+            netsuite_internal_item_id: nil,
+            # Available for USAGE and COMPOSITE products only. If not provided, defaults to
+            # product's current netsuite_overage_item_id. This field's availability is
+            # dependent on your client's configuration.
+            netsuite_overage_item_id: nil,
+            # For USAGE products only. Groups usage line items on invoices. The superset of
+            # values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            presentation_group_key: nil,
+            # For USAGE products only. If set, pricing for this product will be determined for
+            # each pricing_group_key value, as opposed to the product as a whole. The superset
+            # of values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            pricing_group_key: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # converted using the provided conversion factor and operation. For example, if
+            # the operation is "multiply" and the conversion factor is 100, then the quantity
+            # will be multiplied by 100. This can be used in cases where data is sent in one
+            # unit and priced in another. For example, data could be sent in MB and priced in
+            # GB. In this case, the conversion factor would be 1024 and the operation would be
+            # "divide".
+            quantity_conversion: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # rounded using the provided rounding method and decimal places. For example, if
+            # the method is "round up" and the decimal places is 0, then the quantity will be
+            # rounded up to the nearest integer.
+            quantity_rounding: nil,
+            # If not provided, defaults to product's current tags
+            tags: nil,
+            request_options: {}
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  product_id: String,
+                  starting_at: Time,
+                  billable_metric_id: String,
+                  composite_product_ids: T::Array[String],
+                  composite_tags: T::Array[String],
+                  exclude_free_usage: T::Boolean,
+                  is_refundable: T::Boolean,
+                  name: String,
+                  netsuite_internal_item_id: String,
+                  netsuite_overage_item_id: String,
+                  presentation_group_key: T::Array[String],
+                  pricing_group_key: T::Array[String],
+                  quantity_conversion: T.nilable(MetronomeSDK::Models::V1::Contracts::QuantityConversion),
+                  quantity_rounding: T.nilable(MetronomeSDK::Models::V1::Contracts::QuantityRounding),
+                  tags: T::Array[String],
+                  request_options: MetronomeSDK::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class ProductUpdateResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(MetronomeSDK::Models::ID) }
+          attr_reader :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+          def self.new(data:); end
+
+          sig { override.returns({data: MetronomeSDK::Models::ID}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class QuantityConversion < MetronomeSDK::Internal::Type::BaseModel
+          # The factor to multiply or divide the quantity by.
+          sig { returns(Float) }
+          attr_accessor :conversion_factor
+
+          # The operation to perform on the quantity
+          sig { returns(MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::OrSymbol) }
+          attr_accessor :operation
+
+          # Optional name for this conversion.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # Optional. Only valid for USAGE products. If provided, the quantity will be
+          # converted using the provided conversion factor and operation. For example, if
+          # the operation is "multiply" and the conversion factor is 100, then the quantity
+          # will be multiplied by 100. This can be used in cases where data is sent in one
+          # unit and priced in another. For example, data could be sent in MB and priced in
+          # GB. In this case, the conversion factor would be 1024 and the operation would be
+          # "divide".
+          sig do
+            params(
+              conversion_factor: Float,
+              operation: MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::OrSymbol,
+              name: String
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # The factor to multiply or divide the quantity by.
+            conversion_factor:,
+            # The operation to perform on the quantity
+            operation:,
+            # Optional name for this conversion.
+            name: nil
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  conversion_factor: Float,
+                  operation: MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::OrSymbol,
+                  name: String
+                }
+              )
+          end
+          def to_hash; end
+
+          # The operation to perform on the quantity
+          module Operation
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MULTIPLY =
+              T.let(:MULTIPLY, MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::TaggedSymbol)
+            DIVIDE = T.let(:DIVIDE, MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::TaggedSymbol)
+
+            sig do
+              override
+                .returns(T::Array[MetronomeSDK::Models::V1::Contracts::QuantityConversion::Operation::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(Float) }
+          attr_accessor :decimal_places
+
+          sig { returns(MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::OrSymbol) }
+          attr_accessor :rounding_method
+
+          # Optional. Only valid for USAGE products. If provided, the quantity will be
+          # rounded using the provided rounding method and decimal places. For example, if
+          # the method is "round up" and the decimal places is 0, then the quantity will be
+          # rounded up to the nearest integer.
+          sig do
+            params(
+              decimal_places: Float,
+              rounding_method: MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::OrSymbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(decimal_places:, rounding_method:); end
+
+          sig do
+            override
+              .returns(
+                {
+                  decimal_places: Float,
+                  rounding_method: MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::OrSymbol
+                }
+              )
+          end
+          def to_hash; end
+
+          module RoundingMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ROUND_UP =
+              T.let(:ROUND_UP, MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol)
+            ROUND_DOWN =
+              T.let(:ROUND_DOWN, MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol)
+            ROUND_HALF_UP =
+              T.let(:ROUND_HALF_UP, MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol)
+
+            sig do
+              override
+                .returns(T::Array[MetronomeSDK::Models::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class RateCardCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # Used only in UI/API. It is not exposed to end customers.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Reference this alias when creating a contract. If the same alias is assigned to
+          # multiple rate cards, it will reference the rate card to which it was most
+          # recently assigned. It is not exposed to end customers.
+          sig { returns(T.nilable(T::Array[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias])) }
+          attr_reader :aliases
+
+          sig do
+            params(
+              aliases: T::Array[T.any(MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias, MetronomeSDK::Internal::AnyHash)]
+            )
+              .void
+          end
+          attr_writer :aliases
+
+          # Required when using custom pricing units in rates.
+          sig do
+            returns(
+              T.nilable(T::Array[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion])
+            )
+          end
+          attr_reader :credit_type_conversions
+
+          sig do
+            params(
+              credit_type_conversions: T::Array[
+                T.any(
+                  MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              ]
+            )
+              .void
+          end
+          attr_writer :credit_type_conversions
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # The Metronome ID of the credit type to associate with the rate card, defaults to
+          # USD (cents) if not passed.
+          sig { returns(T.nilable(String)) }
+          attr_reader :fiat_credit_type_id
+
+          sig { params(fiat_credit_type_id: String).void }
+          attr_writer :fiat_credit_type_id
+
+          sig do
+            params(
+              name: String,
+              aliases: T::Array[T.any(MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias, MetronomeSDK::Internal::AnyHash)],
+              credit_type_conversions: T::Array[
+                T.any(
+                  MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              ],
+              custom_fields: T::Hash[Symbol, String],
+              description: String,
+              fiat_credit_type_id: String,
+              request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # Used only in UI/API. It is not exposed to end customers.
+            name:,
+            # Reference this alias when creating a contract. If the same alias is assigned to
+            # multiple rate cards, it will reference the rate card to which it was most
+            # recently assigned. It is not exposed to end customers.
+            aliases: nil,
+            # Required when using custom pricing units in rates.
+            credit_type_conversions: nil,
+            custom_fields: nil,
+            description: nil,
+            # The Metronome ID of the credit type to associate with the rate card, defaults to
+            # USD (cents) if not passed.
+            fiat_credit_type_id: nil,
+            request_options: {}
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  name: String,
+                  aliases: T::Array[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias],
+                  credit_type_conversions: T::Array[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion],
+                  custom_fields: T::Hash[Symbol, String],
+                  description: String,
+                  fiat_credit_type_id: String,
+                  request_options: MetronomeSDK::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+
+          class Alias < MetronomeSDK::Internal::Type::BaseModel
+            sig { returns(String) }
+            attr_accessor :name
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :ending_before
+
+            sig { params(ending_before: Time).void }
+            attr_writer :ending_before
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :starting_at
+
+            sig { params(starting_at: Time).void }
+            attr_writer :starting_at
+
+            sig { params(name: String, ending_before: Time, starting_at: Time).returns(T.attached_class) }
+            def self.new(name:, ending_before: nil, starting_at: nil); end
+
+            sig { override.returns({name: String, ending_before: Time, starting_at: Time}) }
+            def to_hash; end
+          end
+
+          class CreditTypeConversion < MetronomeSDK::Internal::Type::BaseModel
+            sig { returns(String) }
+            attr_accessor :custom_credit_type_id
+
+            sig { returns(Float) }
+            attr_accessor :fiat_per_custom_credit
+
+            sig do
+              params(custom_credit_type_id: String, fiat_per_custom_credit: Float).returns(T.attached_class)
+            end
+            def self.new(custom_credit_type_id:, fiat_per_custom_credit:); end
+
+            sig { override.returns({custom_credit_type_id: String, fiat_per_custom_credit: Float}) }
+            def to_hash; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class RateCardCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(MetronomeSDK::Models::ID) }
+          attr_reader :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+          def self.new(data:); end
+
+          sig { override.returns({data: MetronomeSDK::Models::ID}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        class RateCardListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # 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
+
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :body
+
+          sig { params(body: T.anything).void }
+          attr_writer :body
+
+          sig do
+            params(
+              limit: Integer,
+              next_page: String,
+              body: T.anything,
+              request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # Max number of results that should be returned
+            limit: nil,
+            # Cursor that indicates where the next page of results should start.
+            next_page: nil,
+            body: nil,
+            request_options: {}
+          ); end
+          sig do
+            override
+              .returns(
+                {
+                  limit: Integer,
+                  next_page: String,
+                  body: T.anything,
+                  request_options: MetronomeSDK::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end