orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id
+        class TopUpListByExternalIDParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!attribute cursor
+          #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+          #     from the initial request.
+          #
+          #   @return [String, nil]
+          optional :cursor, String, nil?: true
+
+          # @!attribute [r] limit
+          #   The number of items to fetch. Defaults to 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!parse
+          #   # @return [Integer]
+          #   attr_writer :limit
+
+          # @!parse
+          #   # @param cursor [String, nil]
+          #   # @param limit [Integer]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id
+        class TopUpListByExternalIDResponse < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute amount
+          #   The amount to increment when the threshold is reached.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute currency
+          #   The currency or custom pricing unit to use for this top-up. If this is a
+          #     real-world currency, it must match the customer's invoicing currency.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute invoice_settings
+          #   Settings for invoices generated by triggered top-ups.
+          #
+          #   @return [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings]
+          required :invoice_settings,
+                   -> { Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings }
+
+          # @!attribute per_unit_cost_basis
+          #   How much, in the customer's currency, to charge for each unit.
+          #
+          #   @return [String]
+          required :per_unit_cost_basis, String
+
+          # @!attribute threshold
+          #   The threshold at which to trigger the top-up. If the balance is at or below this
+          #     threshold, the top-up will be triggered.
+          #
+          #   @return [String]
+          required :threshold, String
+
+          # @!attribute expires_after
+          #   The number of days or months after which the top-up expires. If unspecified, it
+          #     does not expire.
+          #
+          #   @return [Integer, nil]
+          optional :expires_after, Integer, nil?: true
+
+          # @!attribute expires_after_unit
+          #   The unit of expires_after.
+          #
+          #   @return [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil]
+          #   #
+          #   def initialize(
+          #     id:,
+          #     amount:,
+          #     currency:,
+          #     invoice_settings:,
+          #     per_unit_cost_basis:,
+          #     threshold:,
+          #     expires_after: nil,
+          #     expires_after_unit: nil,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+
+          # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#invoice_settings
+          class InvoiceSettings < Orb::BaseModel
+            # @!attribute auto_collection
+            #   Whether the credits purchase invoice should auto collect with the customer's
+            #     saved payment method.
+            #
+            #   @return [Boolean]
+            required :auto_collection, Orb::BooleanModel
+
+            # @!attribute net_terms
+            #   The net terms determines the difference between the invoice date and the issue
+            #     date for the invoice. If you intend the invoice to be due on issue, set this
+            #     to 0.
+            #
+            #   @return [Integer]
+            required :net_terms, Integer
+
+            # @!attribute memo
+            #   An optional memo to display on the invoice.
+            #
+            #   @return [String, nil]
+            optional :memo, String, nil?: true
+
+            # @!attribute [r] require_successful_payment
+            #   If true, new credit blocks created by this top-up will require that the
+            #     corresponding invoice is paid before they can be drawn down from.
+            #
+            #   @return [Boolean, nil]
+            optional :require_successful_payment, Orb::BooleanModel
+
+            # @!parse
+            #   # @return [Boolean]
+            #   attr_writer :require_successful_payment
+
+            # @!parse
+            #   # Settings for invoices generated by triggered top-ups.
+            #   #
+            #   # @param auto_collection [Boolean]
+            #   # @param net_terms [Integer]
+            #   # @param memo [String, nil]
+            #   # @param require_successful_payment [Boolean]
+            #   #
+            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+          end
+
+          # The unit of expires_after.
+          #
+          # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#expires_after_unit
+          module ExpiresAfterUnit
+            extend Orb::Enum
+
+            DAY = :day
+            MONTH = :month
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/customers/credits/top_up_list_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list
+        class TopUpListParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!attribute cursor
+          #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+          #     from the initial request.
+          #
+          #   @return [String, nil]
+          optional :cursor, String, nil?: true
+
+          # @!attribute [r] limit
+          #   The number of items to fetch. Defaults to 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!parse
+          #   # @return [Integer]
+          #   attr_writer :limit
+
+          # @!parse
+          #   # @param cursor [String, nil]
+          #   # @param limit [Integer]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/customers/credits/top_up_list_response.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list
+        class TopUpListResponse < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute amount
+          #   The amount to increment when the threshold is reached.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute currency
+          #   The currency or custom pricing unit to use for this top-up. If this is a
+          #     real-world currency, it must match the customer's invoicing currency.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute invoice_settings
+          #   Settings for invoices generated by triggered top-ups.
+          #
+          #   @return [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings]
+          required :invoice_settings, -> { Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings }
+
+          # @!attribute per_unit_cost_basis
+          #   How much, in the customer's currency, to charge for each unit.
+          #
+          #   @return [String]
+          required :per_unit_cost_basis, String
+
+          # @!attribute threshold
+          #   The threshold at which to trigger the top-up. If the balance is at or below this
+          #     threshold, the top-up will be triggered.
+          #
+          #   @return [String]
+          required :threshold, String
+
+          # @!attribute expires_after
+          #   The number of days or months after which the top-up expires. If unspecified, it
+          #     does not expire.
+          #
+          #   @return [Integer, nil]
+          optional :expires_after, Integer, nil?: true
+
+          # @!attribute expires_after_unit
+          #   The unit of expires_after.
+          #
+          #   @return [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil]
+          #   #
+          #   def initialize(
+          #     id:,
+          #     amount:,
+          #     currency:,
+          #     invoice_settings:,
+          #     per_unit_cost_basis:,
+          #     threshold:,
+          #     expires_after: nil,
+          #     expires_after_unit: nil,
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+
+          # @see Orb::Models::Customers::Credits::TopUpListResponse#invoice_settings
+          class InvoiceSettings < Orb::BaseModel
+            # @!attribute auto_collection
+            #   Whether the credits purchase invoice should auto collect with the customer's
+            #     saved payment method.
+            #
+            #   @return [Boolean]
+            required :auto_collection, Orb::BooleanModel
+
+            # @!attribute net_terms
+            #   The net terms determines the difference between the invoice date and the issue
+            #     date for the invoice. If you intend the invoice to be due on issue, set this
+            #     to 0.
+            #
+            #   @return [Integer]
+            required :net_terms, Integer
+
+            # @!attribute memo
+            #   An optional memo to display on the invoice.
+            #
+            #   @return [String, nil]
+            optional :memo, String, nil?: true
+
+            # @!attribute [r] require_successful_payment
+            #   If true, new credit blocks created by this top-up will require that the
+            #     corresponding invoice is paid before they can be drawn down from.
+            #
+            #   @return [Boolean, nil]
+            optional :require_successful_payment, Orb::BooleanModel
+
+            # @!parse
+            #   # @return [Boolean]
+            #   attr_writer :require_successful_payment
+
+            # @!parse
+            #   # Settings for invoices generated by triggered top-ups.
+            #   #
+            #   # @param auto_collection [Boolean]
+            #   # @param net_terms [Integer]
+            #   # @param memo [String, nil]
+            #   # @param require_successful_payment [Boolean]
+            #   #
+            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+          end
+
+          # The unit of expires_after.
+          #
+          # @see Orb::Models::Customers::Credits::TopUpListResponse#expires_after_unit
+          module ExpiresAfterUnit
+            extend Orb::Enum
+
+            DAY = :day
+            MONTH = :month
+
+            finalize!
+
+            # @!parse
+            #   # @return [Array<Symbol>]
+            #   def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/dimensional_price_group.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::DimensionalPriceGroups#create
+    class DimensionalPriceGroup < Orb::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute billable_metric_id
+      #   The billable metric associated with this dimensional price group. All prices
+      #     associated with this dimensional price group will be computed using this
+      #     billable metric.
+      #
+      #   @return [String]
+      required :billable_metric_id, String
+
+      # @!attribute dimensions
+      #   The dimensions that this dimensional price group is defined over
+      #
+      #   @return [Array<String>]
+      required :dimensions, Orb::ArrayOf[String]
+
+      # @!attribute external_dimensional_price_group_id
+      #   An alias for the dimensional price group
+      #
+      #   @return [String, nil]
+      required :external_dimensional_price_group_id, String, nil?: true
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #     to an empty dictionary. 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}]
+      required :metadata, Orb::HashOf[String]
+
+      # @!attribute name
+      #   The name of the dimensional price group
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!parse
+      #   # A dimensional price group is used to partition the result of a billable metric
+      #   #   by a set of dimensions. Prices in a price group must specify the parition used
+      #   #   to derive their usage.
+      #   #
+      #   # @param id [String]
+      #   # @param billable_metric_id [String]
+      #   # @param dimensions [Array<String>]
+      #   # @param external_dimensional_price_group_id [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   #
+      #   def initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/dimensional_price_group_create_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::DimensionalPriceGroups#create
+    class DimensionalPriceGroupCreateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute billable_metric_id
+      #
+      #   @return [String]
+      required :billable_metric_id, String
+
+      # @!attribute dimensions
+      #   The set of keys (in order) used to disambiguate prices in the group.
+      #
+      #   @return [Array<String>]
+      required :dimensions, Orb::ArrayOf[String]
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute external_dimensional_price_group_id
+      #
+      #   @return [String, nil]
+      optional :external_dimensional_price_group_id, String, 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::HashOf[String, nil?: true], nil?: true
+
+      # @!parse
+      #   # @param billable_metric_id [String]
+      #   # @param dimensions [Array<String>]
+      #   # @param name [String]
+      #   # @param external_dimensional_price_group_id [String, nil]
+      #   # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     billable_metric_id:,
+      #     dimensions:,
+      #     name:,
+      #     external_dimensional_price_group_id: nil,
+      #     metadata: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/dimensional_price_group_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::DimensionalPriceGroups#list
+    class DimensionalPriceGroupListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!parse
+      #   # @param cursor [String, nil]
+      #   # @param limit [Integer]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/dimensional_price_group_retrieve_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::DimensionalPriceGroups#retrieve
+    class DimensionalPriceGroupRetrieveParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      # @see Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID#retrieve
+      class ExternalDimensionalPriceGroupIDRetrieveParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!parse
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(request_options: {}, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/dimensional_price_groups.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class DimensionalPriceGroupsAPI < Orb::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Orb::Models::DimensionalPriceGroup>]
+      required :data, -> { Orb::ArrayOf[Orb::Models::DimensionalPriceGroup] }
+
+      # @!attribute pagination_metadata
+      #
+      #   @return [Orb::Models::PaginationMetadata]
+      required :pagination_metadata, -> { Orb::Models::PaginationMetadata }
+
+      # @!parse
+      #   # @param data [Array<Orb::Models::DimensionalPriceGroup>]
+      #   # @param pagination_metadata [Orb::Models::PaginationMetadata]
+      #   #
+      #   def initialize(data:, pagination_metadata:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/discount.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Discount
+      extend Orb::Union
+
+      discriminator :discount_type
+
+      variant :percentage, -> { Orb::Models::PercentageDiscount }
+
+      variant :trial, -> { Orb::Models::TrialDiscount }
+
+      variant :usage, -> { Orb::Models::UsageDiscount }
+
+      variant :amount, -> { Orb::Models::AmountDiscount }
+
+      # @!parse
+      #   # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
+      #   def self.variants; end
+    end
+  end
+end