orb-billing 0.12.0 → 1.0.0

data/lib/orb/models/new_percentage_discount.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewPercentageDiscount < Orb::Internal::Type::BaseModel
+      # @!attribute adjustment_type
+      #
+      #   @return [Symbol, Orb::Models::NewPercentageDiscount::AdjustmentType]
+      required :adjustment_type, enum: -> { Orb::NewPercentageDiscount::AdjustmentType }
+
+      # @!attribute percentage_discount
+      #
+      #   @return [Float]
+      required :percentage_discount, Float
+
+      # @!attribute applies_to_all
+      #   If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @return [Boolean, Orb::Models::NewPercentageDiscount::AppliesToAll, nil]
+      optional :applies_to_all, enum: -> { Orb::NewPercentageDiscount::AppliesToAll }, nil?: true
+
+      # @!attribute applies_to_item_ids
+      #   The set of item IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_item_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute applies_to_price_ids
+      #   The set of price IDs to which this adjustment applies.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute currency
+      #   If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute filters
+      #   A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @return [Array<Orb::Models::TransformPriceFilter>, nil]
+      optional :filters, -> { Orb::Internal::Type::ArrayOf[Orb::TransformPriceFilter] }, nil?: true
+
+      # @!attribute is_invoice_level
+      #   When false, this adjustment will be applied to a single price. Otherwise, it
+      #   will be applied at the invoice level, possibly to multiple prices.
+      #
+      #   @return [Boolean, nil]
+      optional :is_invoice_level, Orb::Internal::Type::Boolean
+
+      # @!attribute price_type
+      #   If set, only prices of the specified type will have the adjustment applied.
+      #
+      #   @return [Symbol, Orb::Models::NewPercentageDiscount::PriceType, nil]
+      optional :price_type, enum: -> { Orb::NewPercentageDiscount::PriceType }, nil?: true
+
+      # @!method initialize(adjustment_type:, percentage_discount:, applies_to_all: nil, applies_to_item_ids: nil, applies_to_price_ids: nil, currency: nil, filters: nil, is_invoice_level: nil, price_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::NewPercentageDiscount} for more details.
+      #
+      #   @param adjustment_type [Symbol, Orb::Models::NewPercentageDiscount::AdjustmentType]
+      #
+      #   @param percentage_discount [Float]
+      #
+      #   @param applies_to_all [Boolean, Orb::Models::NewPercentageDiscount::AppliesToAll, nil] If set, the adjustment will apply to every price on the subscription.
+      #
+      #   @param applies_to_item_ids [Array<String>, nil] The set of item IDs to which this adjustment applies.
+      #
+      #   @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
+      #
+      #   @param currency [String, nil] If set, only prices in the specified currency will have the adjustment applied.
+      #
+      #   @param filters [Array<Orb::Models::TransformPriceFilter>, nil] A list of filters that determine which prices this adjustment will apply to.
+      #
+      #   @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
+      #
+      #   @param price_type [Symbol, Orb::Models::NewPercentageDiscount::PriceType, nil] If set, only prices of the specified type will have the adjustment applied.
+
+      # @see Orb::Models::NewPercentageDiscount#adjustment_type
+      module AdjustmentType
+        extend Orb::Internal::Type::Enum
+
+        PERCENTAGE_DISCOUNT = :percentage_discount
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # If set, the adjustment will apply to every price on the subscription.
+      #
+      # @see Orb::Models::NewPercentageDiscount#applies_to_all
+      module AppliesToAll
+        extend Orb::Internal::Type::Enum
+
+        TRUE = true
+
+        # @!method self.values
+        #   @return [Array<Boolean>]
+      end
+
+      # If set, only prices of the specified type will have the adjustment applied.
+      #
+      # @see Orb::Models::NewPercentageDiscount#price_type
+      module PriceType
+        extend Orb::Internal::Type::Enum
+
+        USAGE = :usage
+        FIXED_IN_ADVANCE = :fixed_in_advance
+        FIXED_IN_ARREARS = :fixed_in_arrears
+        FIXED = :fixed
+        IN_ARREARS = :in_arrears
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/new_plan_bps_price.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewPlanBPSPrice < 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::NewPlanBPSPrice::Cadence]
+      required :cadence, enum: -> { Orb::NewPlanBPSPrice::Cadence }
+
+      # @!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::NewPlanBPSPrice::ModelType]
+      required :model_type, enum: -> { Orb::NewPlanBPSPrice::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::NewPlanBPSPrice::ConversionRateConfig }, nil?: true
+
+      # @!attribute currency
+      #   An ISO 4217 currency string, or custom pricing unit identifier, in which this
+      #   price is billed.
+      #
+      #   @return [String, nil]
+      optional :currency, String, 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:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: 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::NewPlanBPSPrice} for more details.
+      #
+      #   @param bps_config [Orb::Models::BPSConfig]
+      #
+      #   @param cadence [Symbol, Orb::Models::NewPlanBPSPrice::Cadence] The cadence to bill for this price on.
+      #
+      #   @param item_id [String] The id of the item the price will be associated with.
+      #
+      #   @param model_type [Symbol, Orb::Models::NewPlanBPSPrice::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 currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
+      #
+      #   @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::NewPlanBPSPrice#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::NewPlanBPSPrice#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::NewPlanBPSPrice#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_plan_bulk_bps_price.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class NewPlanBulkBPSPrice < 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::NewPlanBulkBPSPrice::Cadence]
+      required :cadence, enum: -> { Orb::NewPlanBulkBPSPrice::Cadence }
+
+      # @!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::NewPlanBulkBPSPrice::ModelType]
+      required :model_type, enum: -> { Orb::NewPlanBulkBPSPrice::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::NewPlanBulkBPSPrice::ConversionRateConfig
+               },
+               nil?: true
+
+      # @!attribute currency
+      #   An ISO 4217 currency string, or custom pricing unit identifier, in which this
+      #   price is billed.
+      #
+      #   @return [String, nil]
+      optional :currency, String, 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:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: 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::NewPlanBulkBPSPrice} for more details.
+      #
+      #   @param bulk_bps_config [Orb::Models::BulkBPSConfig]
+      #
+      #   @param cadence [Symbol, Orb::Models::NewPlanBulkBPSPrice::Cadence] The cadence to bill for this price on.
+      #
+      #   @param item_id [String] The id of the item the price will be associated with.
+      #
+      #   @param model_type [Symbol, Orb::Models::NewPlanBulkBPSPrice::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 currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
+      #
+      #   @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::NewPlanBulkBPSPrice#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::NewPlanBulkBPSPrice#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::NewPlanBulkBPSPrice#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