orb-billing 0.12.0 → 1.0.0

data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi

@@ -0,0 +1,368 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewSubscriptionMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Orb::NewSubscriptionMatrixWithAllocationPrice,
+            Orb::Internal::AnyHash
+          )
+        end
+
+      # The cadence to bill for this price on.
+      sig do
+        returns(
+          Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::OrSymbol
+        )
+      end
+      attr_accessor :cadence
+
+      # The id of the item the price will be associated with.
+      sig { returns(String) }
+      attr_accessor :item_id
+
+      sig { returns(Orb::MatrixWithAllocationConfig) }
+      attr_reader :matrix_with_allocation_config
+
+      sig do
+        params(
+          matrix_with_allocation_config: Orb::MatrixWithAllocationConfig::OrHash
+        ).void
+      end
+      attr_writer :matrix_with_allocation_config
+
+      sig do
+        returns(
+          Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType::OrSymbol
+        )
+      end
+      attr_accessor :model_type
+
+      # The name of the price.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The id of the billable metric for the price. Only needed if the price is
+      # usage-based.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :billable_metric_id
+
+      # If the Price represents a fixed cost, the price will be billed in-advance if
+      # this is true, and in-arrears if this is false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :billed_in_advance
+
+      # For custom cadence: specifies the duration of the billing period in days or
+      # months.
+      sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+      attr_reader :billing_cycle_configuration
+
+      sig do
+        params(
+          billing_cycle_configuration:
+            T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+        ).void
+      end
+      attr_writer :billing_cycle_configuration
+
+      # The per unit conversion rate of the price currency to the invoicing currency.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :conversion_rate
+
+      # The configuration for the rate of the price currency to the invoicing currency.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              Orb::UnitConversionRateConfig,
+              Orb::TieredConversionRateConfig
+            )
+          )
+        )
+      end
+      attr_accessor :conversion_rate_config
+
+      # An ISO 4217 currency string, or custom pricing unit identifier, in which this
+      # price is billed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :currency
+
+      # For dimensional price: specifies a price group and dimension values
+      sig { returns(T.nilable(Orb::NewDimensionalPriceConfiguration)) }
+      attr_reader :dimensional_price_configuration
+
+      sig do
+        params(
+          dimensional_price_configuration:
+            T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash)
+        ).void
+      end
+      attr_writer :dimensional_price_configuration
+
+      # An alias for the price.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_price_id
+
+      # If the Price represents a fixed cost, this represents the quantity of units
+      # applied.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fixed_price_quantity
+
+      # The property used to group this price on an invoice
+      sig { returns(T.nilable(String)) }
+      attr_accessor :invoice_grouping_key
+
+      # Within each billing cycle, specifies the cadence at which invoices are produced.
+      # If unspecified, a single invoice is produced per billing cycle.
+      sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+      attr_reader :invoicing_cycle_configuration
+
+      sig do
+        params(
+          invoicing_cycle_configuration:
+            T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+        ).void
+      end
+      attr_writer :invoicing_cycle_configuration
+
+      # User-specified key/value pairs for the resource. Individual keys can be removed
+      # by setting the value to `null`, and the entire metadata mapping can be cleared
+      # by setting `metadata` to `null`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      # A transient ID that can be used to reference this price when adding adjustments
+      # in the same API call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reference_id
+
+      sig do
+        params(
+          cadence:
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::OrSymbol,
+          item_id: String,
+          matrix_with_allocation_config:
+            Orb::MatrixWithAllocationConfig::OrHash,
+          model_type:
+            Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType::OrSymbol,
+          name: String,
+          billable_metric_id: T.nilable(String),
+          billed_in_advance: T.nilable(T::Boolean),
+          billing_cycle_configuration:
+            T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+          conversion_rate: T.nilable(Float),
+          conversion_rate_config:
+            T.nilable(
+              T.any(
+                Orb::UnitConversionRateConfig::OrHash,
+                Orb::TieredConversionRateConfig::OrHash
+              )
+            ),
+          currency: T.nilable(String),
+          dimensional_price_configuration:
+            T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash),
+          external_price_id: T.nilable(String),
+          fixed_price_quantity: T.nilable(Float),
+          invoice_grouping_key: T.nilable(String),
+          invoicing_cycle_configuration:
+            T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          reference_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The cadence to bill for this price on.
+        cadence:,
+        # The id of the item the price will be associated with.
+        item_id:,
+        matrix_with_allocation_config:,
+        model_type:,
+        # The name of the price.
+        name:,
+        # The id of the billable metric for the price. Only needed if the price is
+        # usage-based.
+        billable_metric_id: nil,
+        # If the Price represents a fixed cost, the price will be billed in-advance if
+        # this is true, and in-arrears if this is false.
+        billed_in_advance: nil,
+        # For custom cadence: specifies the duration of the billing period in days or
+        # months.
+        billing_cycle_configuration: nil,
+        # The per unit conversion rate of the price currency to the invoicing currency.
+        conversion_rate: nil,
+        # The configuration for the rate of the price currency to the invoicing currency.
+        conversion_rate_config: nil,
+        # An ISO 4217 currency string, or custom pricing unit identifier, in which this
+        # price is billed.
+        currency: nil,
+        # For dimensional price: specifies a price group and dimension values
+        dimensional_price_configuration: nil,
+        # An alias for the price.
+        external_price_id: nil,
+        # If the Price represents a fixed cost, this represents the quantity of units
+        # applied.
+        fixed_price_quantity: nil,
+        # The property used to group this price on an invoice
+        invoice_grouping_key: nil,
+        # Within each billing cycle, specifies the cadence at which invoices are produced.
+        # If unspecified, a single invoice is produced per billing cycle.
+        invoicing_cycle_configuration: nil,
+        # User-specified key/value pairs for the resource. Individual keys can be removed
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
+        metadata: nil,
+        # A transient ID that can be used to reference this price when adding adjustments
+        # in the same API call.
+        reference_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cadence:
+              Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::OrSymbol,
+            item_id: String,
+            matrix_with_allocation_config: Orb::MatrixWithAllocationConfig,
+            model_type:
+              Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType::OrSymbol,
+            name: String,
+            billable_metric_id: T.nilable(String),
+            billed_in_advance: T.nilable(T::Boolean),
+            billing_cycle_configuration:
+              T.nilable(Orb::NewBillingCycleConfiguration),
+            conversion_rate: T.nilable(Float),
+            conversion_rate_config:
+              T.nilable(
+                T.any(
+                  Orb::UnitConversionRateConfig,
+                  Orb::TieredConversionRateConfig
+                )
+              ),
+            currency: T.nilable(String),
+            dimensional_price_configuration:
+              T.nilable(Orb::NewDimensionalPriceConfiguration),
+            external_price_id: T.nilable(String),
+            fixed_price_quantity: T.nilable(Float),
+            invoice_grouping_key: T.nilable(String),
+            invoicing_cycle_configuration:
+              T.nilable(Orb::NewBillingCycleConfiguration),
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            reference_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The cadence to bill for this price on.
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ANNUAL =
+          T.let(
+            :annual,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+        SEMI_ANNUAL =
+          T.let(
+            :semi_annual,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+        MONTHLY =
+          T.let(
+            :monthly,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+        QUARTERLY =
+          T.let(
+            :quarterly,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+        ONE_TIME =
+          T.let(
+            :one_time,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+        CUSTOM =
+          T.let(
+            :custom,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::NewSubscriptionMatrixWithAllocationPrice::Cadence::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module ModelType
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MATRIX_WITH_ALLOCATION =
+          T.let(
+            :matrix_with_allocation,
+            Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::NewSubscriptionMatrixWithAllocationPrice::ModelType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The configuration for the rate of the price currency to the invoicing currency.
+      module ConversionRateConfig
+        extend Orb::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Orb::UnitConversionRateConfig,
+              Orb::TieredConversionRateConfig
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::NewSubscriptionMatrixWithAllocationPrice::ConversionRateConfig::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end