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

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

@@ -1,237 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class ProductListItemState < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::V1::Contracts::ProductListItemState,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig { returns(String) }
-          attr_accessor :created_by
-
-          sig { returns(String) }
-          attr_accessor :name
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :billable_metric_id
-
-          sig { params(billable_metric_id: String).void }
-          attr_writer :billable_metric_id
-
-          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
-
-          sig { returns(T.nilable(T::Array[String])) }
-          attr_reader :composite_tags
-
-          sig { params(composite_tags: T::Array[String]).void }
-          attr_writer :composite_tags
-
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_reader :exclude_free_usage
-
-          sig { params(exclude_free_usage: T::Boolean).void }
-          attr_writer :exclude_free_usage
-
-          # 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
-
-          # 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
-
-          # 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 do
-            returns(T.nilable(MetronomeSDK::V1::Contracts::QuantityConversion))
-          end
-          attr_reader :quantity_conversion
-
-          sig do
-            params(
-              quantity_conversion:
-                T.nilable(
-                  MetronomeSDK::V1::Contracts::QuantityConversion::OrHash
-                )
-            ).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 do
-            returns(T.nilable(MetronomeSDK::V1::Contracts::QuantityRounding))
-          end
-          attr_reader :quantity_rounding
-
-          sig do
-            params(
-              quantity_rounding:
-                T.nilable(MetronomeSDK::V1::Contracts::QuantityRounding::OrHash)
-            ).void
-          end
-          attr_writer :quantity_rounding
-
-          sig { returns(T.nilable(Time)) }
-          attr_reader :starting_at
-
-          sig { params(starting_at: Time).void }
-          attr_writer :starting_at
-
-          sig { returns(T.nilable(T::Array[String])) }
-          attr_reader :tags
-
-          sig { params(tags: T::Array[String]).void }
-          attr_writer :tags
-
-          sig do
-            params(
-              created_at: Time,
-              created_by: String,
-              name: String,
-              billable_metric_id: String,
-              composite_product_ids: T::Array[String],
-              composite_tags: T::Array[String],
-              exclude_free_usage: T::Boolean,
-              is_refundable: T::Boolean,
-              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::V1::Contracts::QuantityConversion::OrHash
-                ),
-              quantity_rounding:
-                T.nilable(
-                  MetronomeSDK::V1::Contracts::QuantityRounding::OrHash
-                ),
-              starting_at: Time,
-              tags: T::Array[String]
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            created_at:,
-            created_by:,
-            name:,
-            billable_metric_id: nil,
-            composite_product_ids: nil,
-            composite_tags: nil,
-            exclude_free_usage: nil,
-            # This field's availability is dependent on your client's configuration.
-            is_refundable: nil,
-            # This field's availability is dependent on your client's configuration.
-            netsuite_internal_item_id: nil,
-            # 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,
-            starting_at: nil,
-            tags: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                created_at: Time,
-                created_by: String,
-                name: String,
-                billable_metric_id: String,
-                composite_product_ids: T::Array[String],
-                composite_tags: T::Array[String],
-                exclude_free_usage: T::Boolean,
-                is_refundable: T::Boolean,
-                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::V1::Contracts::QuantityConversion),
-                quantity_rounding:
-                  T.nilable(MetronomeSDK::V1::Contracts::QuantityRounding),
-                starting_at: Time,
-                tags: T::Array[String]
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,111 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class QuantityConversion < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::V1::Contracts::QuantityConversion,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          # The factor to multiply or divide the quantity by.
-          sig { returns(Float) }
-          attr_accessor :conversion_factor
-
-          # The operation to perform on the quantity
-          sig do
-            returns(
-              MetronomeSDK::V1::Contracts::QuantityConversion::Operation::OrSymbol
-            )
-          end
-          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::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::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 do
-                T.all(
-                  Symbol,
-                  MetronomeSDK::V1::Contracts::QuantityConversion::Operation
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            MULTIPLY =
-              T.let(
-                :MULTIPLY,
-                MetronomeSDK::V1::Contracts::QuantityConversion::Operation::TaggedSymbol
-              )
-            DIVIDE =
-              T.let(
-                :DIVIDE,
-                MetronomeSDK::V1::Contracts::QuantityConversion::Operation::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  MetronomeSDK::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

@@ -1,94 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::V1::Contracts::QuantityRounding,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Float) }
-          attr_accessor :decimal_places
-
-          sig do
-            returns(
-              MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod::OrSymbol
-            )
-          end
-          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::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::V1::Contracts::QuantityRounding::RoundingMethod::OrSymbol
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module RoundingMethod
-            extend MetronomeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            ROUND_UP =
-              T.let(
-                :ROUND_UP,
-                MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol
-              )
-            ROUND_DOWN =
-              T.let(
-                :ROUND_DOWN,
-                MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol
-              )
-            ROUND_HALF_UP =
-              T.let(
-                :ROUND_HALF_UP,
-                MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi

@@ -1,90 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class CreditLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::V1::CreditLedgerEntry,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        # an amount representing the change to the customer's credit balance
-        sig { returns(Float) }
-        attr_accessor :amount
-
-        sig { returns(String) }
-        attr_accessor :created_by
-
-        # the credit grant this entry is related to
-        sig { returns(String) }
-        attr_accessor :credit_grant_id
-
-        sig { returns(Time) }
-        attr_accessor :effective_at
-
-        sig { returns(String) }
-        attr_accessor :reason
-
-        # the running balance for this credit type at the time of the ledger entry,
-        # including all preceding charges
-        sig { returns(Float) }
-        attr_accessor :running_balance
-
-        # if this entry is a deduction, the Metronome ID of the invoice where the credit
-        # deduction was consumed; if this entry is a grant, the Metronome ID of the
-        # invoice where the grant's paid_amount was charged
-        sig { returns(T.nilable(String)) }
-        attr_accessor :invoice_id
-
-        sig do
-          params(
-            amount: Float,
-            created_by: String,
-            credit_grant_id: String,
-            effective_at: Time,
-            reason: String,
-            running_balance: Float,
-            invoice_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # an amount representing the change to the customer's credit balance
-          amount:,
-          created_by:,
-          # the credit grant this entry is related to
-          credit_grant_id:,
-          effective_at:,
-          reason:,
-          # the running balance for this credit type at the time of the ledger entry,
-          # including all preceding charges
-          running_balance:,
-          # if this entry is a deduction, the Metronome ID of the invoice where the credit
-          # deduction was consumed; if this entry is a grant, the Metronome ID of the
-          # invoice where the grant's paid_amount was charged
-          invoice_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              amount: Float,
-              created_by: String,
-              credit_grant_id: String,
-              effective_at: Time,
-              reason: String,
-              running_balance: Float,
-              invoice_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

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

@@ -1,74 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class Customer < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(MetronomeSDK::V1::Customer, MetronomeSDK::Internal::AnyHash)
-          end
-
-        # the Metronome ID of the customer
-        sig { returns(String) }
-        attr_accessor :id
-
-        # (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
-
-        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 do
-          params(
-            id: String,
-            external_id: String,
-            ingest_aliases: T::Array[String],
-            name: String,
-            custom_fields: T::Hash[Symbol, String]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # the Metronome ID of the customer
-          id:,
-          # (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:,
-          custom_fields: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              external_id: String,
-              ingest_aliases: T::Array[String],
-              name: String,
-              custom_fields: T::Hash[Symbol, String]
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end