orb-billing 0.12.0 → 1.0.1

data/rbi/orb/models/new_amount_discount.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewAmountDiscount < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Orb::NewAmountDiscount, Orb::Internal::AnyHash) }
+
+      sig { returns(Orb::NewAmountDiscount::AdjustmentType::OrSymbol) }
+      attr_accessor :adjustment_type
+
+      sig { returns(String) }
+      attr_accessor :amount_discount
+
+      # If set, the adjustment will apply to every price on the subscription.
+      sig do
+        returns(T.nilable(Orb::NewAmountDiscount::AppliesToAll::OrBoolean))
+      end
+      attr_accessor :applies_to_all
+
+      # The set of item IDs to which this adjustment applies.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :applies_to_item_ids
+
+      # The set of price IDs to which this adjustment applies.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :applies_to_price_ids
+
+      # If set, only prices in the specified currency will have the adjustment applied.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :currency
+
+      # A list of filters that determine which prices this adjustment will apply to.
+      sig { returns(T.nilable(T::Array[Orb::TransformPriceFilter])) }
+      attr_accessor :filters
+
+      # When false, this adjustment will be applied to a single price. Otherwise, it
+      # will be applied at the invoice level, possibly to multiple prices.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_invoice_level
+
+      sig { params(is_invoice_level: T::Boolean).void }
+      attr_writer :is_invoice_level
+
+      # If set, only prices of the specified type will have the adjustment applied.
+      sig { returns(T.nilable(Orb::NewAmountDiscount::PriceType::OrSymbol)) }
+      attr_accessor :price_type
+
+      sig do
+        params(
+          adjustment_type: Orb::NewAmountDiscount::AdjustmentType::OrSymbol,
+          amount_discount: String,
+          applies_to_all:
+            T.nilable(Orb::NewAmountDiscount::AppliesToAll::OrBoolean),
+          applies_to_item_ids: T.nilable(T::Array[String]),
+          applies_to_price_ids: T.nilable(T::Array[String]),
+          currency: T.nilable(String),
+          filters: T.nilable(T::Array[Orb::TransformPriceFilter::OrHash]),
+          is_invoice_level: T::Boolean,
+          price_type: T.nilable(Orb::NewAmountDiscount::PriceType::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        adjustment_type:,
+        amount_discount:,
+        # If set, the adjustment will apply to every price on the subscription.
+        applies_to_all: nil,
+        # The set of item IDs to which this adjustment applies.
+        applies_to_item_ids: nil,
+        # The set of price IDs to which this adjustment applies.
+        applies_to_price_ids: nil,
+        # If set, only prices in the specified currency will have the adjustment applied.
+        currency: nil,
+        # A list of filters that determine which prices this adjustment will apply to.
+        filters: nil,
+        # When false, this adjustment will be applied to a single price. Otherwise, it
+        # will be applied at the invoice level, possibly to multiple prices.
+        is_invoice_level: nil,
+        # If set, only prices of the specified type will have the adjustment applied.
+        price_type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            adjustment_type: Orb::NewAmountDiscount::AdjustmentType::OrSymbol,
+            amount_discount: String,
+            applies_to_all:
+              T.nilable(Orb::NewAmountDiscount::AppliesToAll::OrBoolean),
+            applies_to_item_ids: T.nilable(T::Array[String]),
+            applies_to_price_ids: T.nilable(T::Array[String]),
+            currency: T.nilable(String),
+            filters: T.nilable(T::Array[Orb::TransformPriceFilter]),
+            is_invoice_level: T::Boolean,
+            price_type: T.nilable(Orb::NewAmountDiscount::PriceType::OrSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::NewAmountDiscount::AdjustmentType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AMOUNT_DISCOUNT =
+          T.let(
+            :amount_discount,
+            Orb::NewAmountDiscount::AdjustmentType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewAmountDiscount::AdjustmentType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # If set, the adjustment will apply to every price on the subscription.
+      module AppliesToAll
+        extend Orb::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, Orb::NewAmountDiscount::AppliesToAll)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE = T.let(true, Orb::NewAmountDiscount::AppliesToAll::TaggedBoolean)
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewAmountDiscount::AppliesToAll::TaggedBoolean]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # If set, only prices of the specified type will have the adjustment applied.
+      module PriceType
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::NewAmountDiscount::PriceType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        USAGE = T.let(:usage, Orb::NewAmountDiscount::PriceType::TaggedSymbol)
+        FIXED_IN_ADVANCE =
+          T.let(
+            :fixed_in_advance,
+            Orb::NewAmountDiscount::PriceType::TaggedSymbol
+          )
+        FIXED_IN_ARREARS =
+          T.let(
+            :fixed_in_arrears,
+            Orb::NewAmountDiscount::PriceType::TaggedSymbol
+          )
+        FIXED = T.let(:fixed, Orb::NewAmountDiscount::PriceType::TaggedSymbol)
+        IN_ARREARS =
+          T.let(:in_arrears, Orb::NewAmountDiscount::PriceType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewAmountDiscount::PriceType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/new_avalara_tax_configuration.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::NewAvalaraTaxConfiguration, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :tax_exempt
+
+      sig { returns(Orb::NewAvalaraTaxConfiguration::TaxProvider::OrSymbol) }
+      attr_accessor :tax_provider
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_exemption_code
+
+      sig do
+        params(
+          tax_exempt: T::Boolean,
+          tax_provider: Orb::NewAvalaraTaxConfiguration::TaxProvider::OrSymbol,
+          tax_exemption_code: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(tax_exempt:, tax_provider:, tax_exemption_code: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            tax_exempt: T::Boolean,
+            tax_provider:
+              Orb::NewAvalaraTaxConfiguration::TaxProvider::OrSymbol,
+            tax_exemption_code: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module TaxProvider
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::NewAvalaraTaxConfiguration::TaxProvider)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AVALARA =
+          T.let(
+            :avalara,
+            Orb::NewAvalaraTaxConfiguration::TaxProvider::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewAvalaraTaxConfiguration::TaxProvider::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/new_billing_cycle_configuration.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewBillingCycleConfiguration < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::NewBillingCycleConfiguration, Orb::Internal::AnyHash)
+        end
+
+      # The duration of the billing period.
+      sig { returns(Integer) }
+      attr_accessor :duration
+
+      # The unit of billing period duration.
+      sig { returns(Orb::NewBillingCycleConfiguration::DurationUnit::OrSymbol) }
+      attr_accessor :duration_unit
+
+      sig do
+        params(
+          duration: Integer,
+          duration_unit:
+            Orb::NewBillingCycleConfiguration::DurationUnit::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The duration of the billing period.
+        duration:,
+        # The unit of billing period duration.
+        duration_unit:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            duration: Integer,
+            duration_unit:
+              Orb::NewBillingCycleConfiguration::DurationUnit::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The unit of billing period duration.
+      module DurationUnit
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::NewBillingCycleConfiguration::DurationUnit)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAY =
+          T.let(
+            :day,
+            Orb::NewBillingCycleConfiguration::DurationUnit::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :month,
+            Orb::NewBillingCycleConfiguration::DurationUnit::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::NewBillingCycleConfiguration::DurationUnit::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/new_dimensional_price_configuration.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewDimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::NewDimensionalPriceConfiguration, Orb::Internal::AnyHash)
+        end
+
+      # The list of dimension values matching (in order) the dimensions of the price
+      # group
+      sig { returns(T::Array[String]) }
+      attr_accessor :dimension_values
+
+      # The id of the dimensional price group to include this price in
+      sig { returns(T.nilable(String)) }
+      attr_accessor :dimensional_price_group_id
+
+      # The external id of the dimensional price group to include this price in
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_dimensional_price_group_id
+
+      sig do
+        params(
+          dimension_values: T::Array[String],
+          dimensional_price_group_id: T.nilable(String),
+          external_dimensional_price_group_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The list of dimension values matching (in order) the dimensions of the price
+        # group
+        dimension_values:,
+        # The id of the dimensional price group to include this price in
+        dimensional_price_group_id: nil,
+        # The external id of the dimensional price group to include this price in
+        external_dimensional_price_group_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            dimension_values: T::Array[String],
+            dimensional_price_group_id: T.nilable(String),
+            external_dimensional_price_group_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/new_floating_bps_price.rbi

@@ -0,0 +1,294 @@
+# typed: strong
+
+module Orb
+  module Models
+    class NewFloatingBPSPrice < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Orb::NewFloatingBPSPrice, Orb::Internal::AnyHash) }
+
+      sig { returns(Orb::BPSConfig) }
+      attr_reader :bps_config
+
+      sig { params(bps_config: Orb::BPSConfig::OrHash).void }
+      attr_writer :bps_config
+
+      # The cadence to bill for this price on.
+      sig { returns(Orb::NewFloatingBPSPrice::Cadence::OrSymbol) }
+      attr_accessor :cadence
+
+      # An ISO 4217 currency string for which this price is billed in.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # The id of the item the price will be associated with.
+      sig { returns(String) }
+      attr_accessor :item_id
+
+      sig { returns(Orb::NewFloatingBPSPrice::ModelType::OrSymbol) }
+      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
+
+      # 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
+
+      sig do
+        params(
+          bps_config: Orb::BPSConfig::OrHash,
+          cadence: Orb::NewFloatingBPSPrice::Cadence::OrSymbol,
+          currency: String,
+          item_id: String,
+          model_type: Orb::NewFloatingBPSPrice::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
+              )
+            ),
+          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)])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        bps_config:,
+        # The cadence to bill for this price on.
+        cadence:,
+        # An ISO 4217 currency string for which this price is billed in.
+        currency:,
+        # The id of the item the price will be associated with.
+        item_id:,
+        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,
+        # 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            bps_config: Orb::BPSConfig,
+            cadence: Orb::NewFloatingBPSPrice::Cadence::OrSymbol,
+            currency: String,
+            item_id: String,
+            model_type: Orb::NewFloatingBPSPrice::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
+                )
+              ),
+            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)])
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The cadence to bill for this price on.
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::NewFloatingBPSPrice::Cadence) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ANNUAL = T.let(:annual, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+        SEMI_ANNUAL =
+          T.let(:semi_annual, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+        MONTHLY =
+          T.let(:monthly, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+        QUARTERLY =
+          T.let(:quarterly, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+        ONE_TIME =
+          T.let(:one_time, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+        CUSTOM = T.let(:custom, Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewFloatingBPSPrice::Cadence::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module ModelType
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::NewFloatingBPSPrice::ModelType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BPS = T.let(:bps, Orb::NewFloatingBPSPrice::ModelType::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::NewFloatingBPSPrice::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::NewFloatingBPSPrice::ConversionRateConfig::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end