orb-billing 0.11.0 → 1.0.0

data/lib/orb/models/new_avalara_tax_configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewAvalaraTaxConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute tax_exempt
+      #
+      #   @return [Boolean]
+      required :tax_exempt, Orb::Internal::Type::Boolean
+
+      # @!attribute tax_provider
+      #
+      #   @return [Symbol, Orb::Models::NewAvalaraTaxConfiguration::TaxProvider]
+      required :tax_provider, enum: -> { Orb::NewAvalaraTaxConfiguration::TaxProvider }
+
+      # @!attribute tax_exemption_code
+      #
+      #   @return [String, nil]
+      optional :tax_exemption_code, String, nil?: true
+
+      # @!method initialize(tax_exempt:, tax_provider:, tax_exemption_code: nil)
+      #   @param tax_exempt [Boolean]
+      #   @param tax_provider [Symbol, Orb::Models::NewAvalaraTaxConfiguration::TaxProvider]
+      #   @param tax_exemption_code [String, nil]
+
+      # @see Orb::Models::NewAvalaraTaxConfiguration#tax_provider
+      module TaxProvider
+        extend Orb::Internal::Type::Enum
+
+        AVALARA = :avalara
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/new_billing_cycle_configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewBillingCycleConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute duration
+      #   The duration of the billing period.
+      #
+      #   @return [Integer]
+      required :duration, Integer
+
+      # @!attribute duration_unit
+      #   The unit of billing period duration.
+      #
+      #   @return [Symbol, Orb::Models::NewBillingCycleConfiguration::DurationUnit]
+      required :duration_unit, enum: -> { Orb::NewBillingCycleConfiguration::DurationUnit }
+
+      # @!method initialize(duration:, duration_unit:)
+      #   @param duration [Integer] The duration of the billing period.
+      #
+      #   @param duration_unit [Symbol, Orb::Models::NewBillingCycleConfiguration::DurationUnit] The unit of billing period duration.
+
+      # The unit of billing period duration.
+      #
+      # @see Orb::Models::NewBillingCycleConfiguration#duration_unit
+      module DurationUnit
+        extend Orb::Internal::Type::Enum
+
+        DAY = :day
+        MONTH = :month
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/new_dimensional_price_configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewDimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
+      # @!attribute dimension_values
+      #   The list of dimension values matching (in order) the dimensions of the price
+      #   group
+      #
+      #   @return [Array<String>]
+      required :dimension_values, Orb::Internal::Type::ArrayOf[String]
+
+      # @!attribute dimensional_price_group_id
+      #   The id of the dimensional price group to include this price in
+      #
+      #   @return [String, nil]
+      optional :dimensional_price_group_id, String, nil?: true
+
+      # @!attribute external_dimensional_price_group_id
+      #   The external id of the dimensional price group to include this price in
+      #
+      #   @return [String, nil]
+      optional :external_dimensional_price_group_id, String, nil?: true
+
+      # @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewDimensionalPriceConfiguration} for more details.
+      #
+      #   @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
+      #
+      #   @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
+      #
+      #   @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
+    end
+  end
+end

data/lib/orb/models/new_floating_bps_price.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewFloatingBPSPrice < Orb::Internal::Type::BaseModel
+      # @!attribute bps_config
+      #
+      #   @return [Orb::Models::BPSConfig]
+      required :bps_config, -> { Orb::BPSConfig }
+
+      # @!attribute cadence
+      #   The cadence to bill for this price on.
+      #
+      #   @return [Symbol, Orb::Models::NewFloatingBPSPrice::Cadence]
+      required :cadence, enum: -> { Orb::NewFloatingBPSPrice::Cadence }
+
+      # @!attribute currency
+      #   An ISO 4217 currency string for which this price is billed in.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute item_id
+      #   The id of the item the price will be associated with.
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!attribute model_type
+      #
+      #   @return [Symbol, Orb::Models::NewFloatingBPSPrice::ModelType]
+      required :model_type, enum: -> { Orb::NewFloatingBPSPrice::ModelType }
+
+      # @!attribute name
+      #   The name of the price.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute billable_metric_id
+      #   The id of the billable metric for the price. Only needed if the price is
+      #   usage-based.
+      #
+      #   @return [String, nil]
+      optional :billable_metric_id, String, nil?: true
+
+      # @!attribute billed_in_advance
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!attribute billing_cycle_configuration
+      #   For custom cadence: specifies the duration of the billing period in days or
+      #   months.
+      #
+      #   @return [Orb::Models::NewBillingCycleConfiguration, nil]
+      optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
+
+      # @!attribute conversion_rate
+      #   The per unit conversion rate of the price currency to the invoicing currency.
+      #
+      #   @return [Float, nil]
+      optional :conversion_rate, Float, nil?: true
+
+      # @!attribute conversion_rate_config
+      #   The configuration for the rate of the price currency to the invoicing currency.
+      #
+      #   @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
+      optional :conversion_rate_config,
+               union: -> {
+                 Orb::NewFloatingBPSPrice::ConversionRateConfig
+               },
+               nil?: true
+
+      # @!attribute dimensional_price_configuration
+      #   For dimensional price: specifies a price group and dimension values
+      #
+      #   @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
+      optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
+
+      # @!attribute external_price_id
+      #   An alias for the price.
+      #
+      #   @return [String, nil]
+      optional :external_price_id, String, nil?: true
+
+      # @!attribute fixed_price_quantity
+      #   If the Price represents a fixed cost, this represents the quantity of units
+      #   applied.
+      #
+      #   @return [Float, nil]
+      optional :fixed_price_quantity, Float, nil?: true
+
+      # @!attribute invoice_grouping_key
+      #   The property used to group this price on an invoice
+      #
+      #   @return [String, nil]
+      optional :invoice_grouping_key, String, nil?: true
+
+      # @!attribute invoicing_cycle_configuration
+      #   Within each billing cycle, specifies the cadence at which invoices are produced.
+      #   If unspecified, a single invoice is produced per billing cycle.
+      #
+      #   @return [Orb::Models::NewBillingCycleConfiguration, nil]
+      optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
+
+      # @!attribute metadata
+      #   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`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!method initialize(bps_config:, cadence:, currency:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewFloatingBPSPrice} for more details.
+      #
+      #   @param bps_config [Orb::Models::BPSConfig]
+      #
+      #   @param cadence [Symbol, Orb::Models::NewFloatingBPSPrice::Cadence] The cadence to bill for this price on.
+      #
+      #   @param currency [String] An ISO 4217 currency string for which this price is billed in.
+      #
+      #   @param item_id [String] The id of the item the price will be associated with.
+      #
+      #   @param model_type [Symbol, Orb::Models::NewFloatingBPSPrice::ModelType]
+      #
+      #   @param name [String] The name of the price.
+      #
+      #   @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
+      #
+      #   @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
+      #
+      #   @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
+      #
+      #   @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
+      #
+      #   @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
+      #
+      #   @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
+      #
+      #   @param external_price_id [String, nil] An alias for the price.
+      #
+      #   @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
+      #
+      #   @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
+      #
+      #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+
+      # The cadence to bill for this price on.
+      #
+      # @see Orb::Models::NewFloatingBPSPrice#cadence
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        ANNUAL = :annual
+        SEMI_ANNUAL = :semi_annual
+        MONTHLY = :monthly
+        QUARTERLY = :quarterly
+        ONE_TIME = :one_time
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Orb::Models::NewFloatingBPSPrice#model_type
+      module ModelType
+        extend Orb::Internal::Type::Enum
+
+        BPS = :bps
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The configuration for the rate of the price currency to the invoicing currency.
+      #
+      # @see Orb::Models::NewFloatingBPSPrice#conversion_rate_config
+      module ConversionRateConfig
+        extend Orb::Internal::Type::Union
+
+        discriminator :conversion_rate_type
+
+        variant :unit, -> { Orb::UnitConversionRateConfig }
+
+        variant :tiered, -> { Orb::TieredConversionRateConfig }
+
+        # @!method self.variants
+        #   @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
+      end
+    end
+  end
+end

data/lib/orb/models/new_floating_bulk_bps_price.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewFloatingBulkBPSPrice < Orb::Internal::Type::BaseModel
+      # @!attribute bulk_bps_config
+      #
+      #   @return [Orb::Models::BulkBPSConfig]
+      required :bulk_bps_config, -> { Orb::BulkBPSConfig }
+
+      # @!attribute cadence
+      #   The cadence to bill for this price on.
+      #
+      #   @return [Symbol, Orb::Models::NewFloatingBulkBPSPrice::Cadence]
+      required :cadence, enum: -> { Orb::NewFloatingBulkBPSPrice::Cadence }
+
+      # @!attribute currency
+      #   An ISO 4217 currency string for which this price is billed in.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute item_id
+      #   The id of the item the price will be associated with.
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!attribute model_type
+      #
+      #   @return [Symbol, Orb::Models::NewFloatingBulkBPSPrice::ModelType]
+      required :model_type, enum: -> { Orb::NewFloatingBulkBPSPrice::ModelType }
+
+      # @!attribute name
+      #   The name of the price.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute billable_metric_id
+      #   The id of the billable metric for the price. Only needed if the price is
+      #   usage-based.
+      #
+      #   @return [String, nil]
+      optional :billable_metric_id, String, nil?: true
+
+      # @!attribute billed_in_advance
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
+
+      # @!attribute billing_cycle_configuration
+      #   For custom cadence: specifies the duration of the billing period in days or
+      #   months.
+      #
+      #   @return [Orb::Models::NewBillingCycleConfiguration, nil]
+      optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
+
+      # @!attribute conversion_rate
+      #   The per unit conversion rate of the price currency to the invoicing currency.
+      #
+      #   @return [Float, nil]
+      optional :conversion_rate, Float, nil?: true
+
+      # @!attribute conversion_rate_config
+      #   The configuration for the rate of the price currency to the invoicing currency.
+      #
+      #   @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
+      optional :conversion_rate_config,
+               union: -> { Orb::NewFloatingBulkBPSPrice::ConversionRateConfig },
+               nil?: true
+
+      # @!attribute dimensional_price_configuration
+      #   For dimensional price: specifies a price group and dimension values
+      #
+      #   @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
+      optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
+
+      # @!attribute external_price_id
+      #   An alias for the price.
+      #
+      #   @return [String, nil]
+      optional :external_price_id, String, nil?: true
+
+      # @!attribute fixed_price_quantity
+      #   If the Price represents a fixed cost, this represents the quantity of units
+      #   applied.
+      #
+      #   @return [Float, nil]
+      optional :fixed_price_quantity, Float, nil?: true
+
+      # @!attribute invoice_grouping_key
+      #   The property used to group this price on an invoice
+      #
+      #   @return [String, nil]
+      optional :invoice_grouping_key, String, nil?: true
+
+      # @!attribute invoicing_cycle_configuration
+      #   Within each billing cycle, specifies the cadence at which invoices are produced.
+      #   If unspecified, a single invoice is produced per billing cycle.
+      #
+      #   @return [Orb::Models::NewBillingCycleConfiguration, nil]
+      optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
+
+      # @!attribute metadata
+      #   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`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!method initialize(bulk_bps_config:, cadence:, currency:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewFloatingBulkBPSPrice} for more details.
+      #
+      #   @param bulk_bps_config [Orb::Models::BulkBPSConfig]
+      #
+      #   @param cadence [Symbol, Orb::Models::NewFloatingBulkBPSPrice::Cadence] The cadence to bill for this price on.
+      #
+      #   @param currency [String] An ISO 4217 currency string for which this price is billed in.
+      #
+      #   @param item_id [String] The id of the item the price will be associated with.
+      #
+      #   @param model_type [Symbol, Orb::Models::NewFloatingBulkBPSPrice::ModelType]
+      #
+      #   @param name [String] The name of the price.
+      #
+      #   @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
+      #
+      #   @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
+      #
+      #   @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
+      #
+      #   @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
+      #
+      #   @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
+      #
+      #   @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
+      #
+      #   @param external_price_id [String, nil] An alias for the price.
+      #
+      #   @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
+      #
+      #   @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
+      #
+      #   @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
+      #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+
+      # The cadence to bill for this price on.
+      #
+      # @see Orb::Models::NewFloatingBulkBPSPrice#cadence
+      module Cadence
+        extend Orb::Internal::Type::Enum
+
+        ANNUAL = :annual
+        SEMI_ANNUAL = :semi_annual
+        MONTHLY = :monthly
+        QUARTERLY = :quarterly
+        ONE_TIME = :one_time
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Orb::Models::NewFloatingBulkBPSPrice#model_type
+      module ModelType
+        extend Orb::Internal::Type::Enum
+
+        BULK_BPS = :bulk_bps
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The configuration for the rate of the price currency to the invoicing currency.
+      #
+      # @see Orb::Models::NewFloatingBulkBPSPrice#conversion_rate_config
+      module ConversionRateConfig
+        extend Orb::Internal::Type::Union
+
+        discriminator :conversion_rate_type
+
+        variant :unit, -> { Orb::UnitConversionRateConfig }
+
+        variant :tiered, -> { Orb::TieredConversionRateConfig }
+
+        # @!method self.variants
+        #   @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
+      end
+    end
+  end
+end