orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id
+        class TopUpCreateByExternalIDParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!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::TopUpCreateByExternalIDParams::InvoiceSettings]
+          required :invoice_settings,
+                   -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::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 active_from
+          #   The date from which the top-up is active. If unspecified, the top-up is active
+          #     immediately.
+          #
+          #   @return [Time, nil]
+          optional :active_from, Time, nil?: true
+
+          # @!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::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param active_from [Time, nil]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(
+          #     amount:,
+          #     currency:,
+          #     invoice_settings:,
+          #     per_unit_cost_basis:,
+          #     threshold:,
+          #     active_from: nil,
+          #     expires_after: nil,
+          #     expires_after_unit: nil,
+          #     request_options: {},
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+
+          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.
+          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_create_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#create_by_external_id
+        class TopUpCreateByExternalIDResponse < 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::TopUpCreateByExternalIDResponse::InvoiceSettings]
+          required :invoice_settings,
+                   -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::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::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::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::TopUpCreateByExternalIDResponse#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::TopUpCreateByExternalIDResponse#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_create_params.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#create
+        class TopUpCreateParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!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::TopUpCreateParams::InvoiceSettings]
+          required :invoice_settings, -> { Orb::Models::Customers::Credits::TopUpCreateParams::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 active_from
+          #   The date from which the top-up is active. If unspecified, the top-up is active
+          #     immediately.
+          #
+          #   @return [Time, nil]
+          optional :active_from, Time, nil?: true
+
+          # @!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::TopUpCreateParams::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param active_from [Time, nil]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(
+          #     amount:,
+          #     currency:,
+          #     invoice_settings:,
+          #     per_unit_cost_basis:,
+          #     threshold:,
+          #     active_from: nil,
+          #     expires_after: nil,
+          #     expires_after_unit: nil,
+          #     request_options: {},
+          #     **
+          #   )
+          #     super
+          #   end
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+
+          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.
+          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_create_response.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#create
+        class TopUpCreateResponse < 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::TopUpCreateResponse::InvoiceSettings]
+          required :invoice_settings, -> { Orb::Models::Customers::Credits::TopUpCreateResponse::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::TopUpCreateResponse::ExpiresAfterUnit, nil]
+          optional :expires_after_unit,
+                   enum: -> { Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit },
+                   nil?: true
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param amount [String]
+          #   # @param currency [String]
+          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings]
+          #   # @param per_unit_cost_basis [String]
+          #   # @param threshold [String]
+          #   # @param expires_after [Integer, nil]
+          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::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::TopUpCreateResponse#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::TopUpCreateResponse#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_delete_by_external_id_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#delete_by_external_id
+        class TopUpDeleteByExternalIDParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!attribute external_customer_id
+          #
+          #   @return [String]
+          required :external_customer_id, String
+
+          # @!parse
+          #   # @param external_customer_id [String]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(external_customer_id:, request_options: {}, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#delete
+        class TopUpDeleteParams < Orb::BaseModel
+          # @!parse
+          #   extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!parse
+          #   # @param customer_id [String]
+          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+          #   #
+          #   def initialize(customer_id:, request_options: {}, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+    end
+  end
+end