orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,196 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        class TopUpCreateByExternalIDParams < Orb::BaseModel
+          extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # The amount to increment when the threshold is reached.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :currency
+
+          # Settings for invoices generated by triggered top-ups.
+          sig { returns(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings) }
+          attr_reader :invoice_settings
+
+          sig do
+            params(
+              invoice_settings: T.any(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings, Orb::Util::AnyHash)
+            )
+              .void
+          end
+          attr_writer :invoice_settings
+
+          # How much, in the customer's currency, to charge for each unit.
+          sig { returns(String) }
+          attr_accessor :per_unit_cost_basis
+
+          # The threshold at which to trigger the top-up. If the balance is at or below this
+          #   threshold, the top-up will be triggered.
+          sig { returns(String) }
+          attr_accessor :threshold
+
+          # The date from which the top-up is active. If unspecified, the top-up is active
+          #   immediately.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :active_from
+
+          # The number of days or months after which the top-up expires. If unspecified, it
+          #   does not expire.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :expires_after
+
+          # The unit of expires_after.
+          sig do
+            returns(
+              T.nilable(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol)
+            )
+          end
+          attr_accessor :expires_after_unit
+
+          sig do
+            params(
+              amount: String,
+              currency: String,
+              invoice_settings: T.any(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings, Orb::Util::AnyHash),
+              per_unit_cost_basis: String,
+              threshold: String,
+              active_from: T.nilable(Time),
+              expires_after: T.nilable(Integer),
+              expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol),
+              request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            currency:,
+            invoice_settings:,
+            per_unit_cost_basis:,
+            threshold:,
+            active_from: nil,
+            expires_after: nil,
+            expires_after_unit: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  amount: String,
+                  currency: String,
+                  invoice_settings: Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings,
+                  per_unit_cost_basis: String,
+                  threshold: String,
+                  active_from: T.nilable(Time),
+                  expires_after: T.nilable(Integer),
+                  expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::OrSymbol),
+                  request_options: Orb::RequestOptions
+                }
+              )
+          end
+          def to_hash
+          end
+
+          class InvoiceSettings < Orb::BaseModel
+            # Whether the credits purchase invoice should auto collect with the customer's
+            #   saved payment method.
+            sig { returns(T::Boolean) }
+            attr_accessor :auto_collection
+
+            # 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.
+            sig { returns(Integer) }
+            attr_accessor :net_terms
+
+            # An optional memo to display on the invoice.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :memo
+
+            # 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.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :require_successful_payment
+
+            sig { params(require_successful_payment: T::Boolean).void }
+            attr_writer :require_successful_payment
+
+            # Settings for invoices generated by triggered top-ups.
+            sig do
+              params(
+                auto_collection: T::Boolean,
+                net_terms: Integer,
+                memo: T.nilable(String),
+                require_successful_payment: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            end
+
+            sig do
+              override
+                .returns(
+                  {
+                    auto_collection: T::Boolean,
+                    net_terms: Integer,
+                    memo: T.nilable(String),
+                    require_successful_payment: T::Boolean
+                  }
+                )
+            end
+            def to_hash
+            end
+          end
+
+          # The unit of expires_after.
+          module ExpiresAfterUnit
+            extend Orb::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  String,
+                  Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
+                )
+              end
+
+            DAY =
+              T.let(
+                :day,
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
+              )
+            MONTH =
+              T.let(
+                :month,
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi

@@ -0,0 +1,198 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        class TopUpCreateByExternalIDResponse < Orb::BaseModel
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The amount to increment when the threshold is reached.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :currency
+
+          # Settings for invoices generated by triggered top-ups.
+          sig { returns(Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings) }
+          attr_reader :invoice_settings
+
+          sig do
+            params(
+              invoice_settings: T.any(
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings,
+                Orb::Util::AnyHash
+              )
+            )
+              .void
+          end
+          attr_writer :invoice_settings
+
+          # How much, in the customer's currency, to charge for each unit.
+          sig { returns(String) }
+          attr_accessor :per_unit_cost_basis
+
+          # The threshold at which to trigger the top-up. If the balance is at or below this
+          #   threshold, the top-up will be triggered.
+          sig { returns(String) }
+          attr_accessor :threshold
+
+          # The number of days or months after which the top-up expires. If unspecified, it
+          #   does not expire.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :expires_after
+
+          # The unit of expires_after.
+          sig do
+            returns(
+              T.nilable(
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :expires_after_unit
+
+          sig do
+            params(
+              id: String,
+              amount: String,
+              currency: String,
+              invoice_settings: T.any(
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings,
+                Orb::Util::AnyHash
+              ),
+              per_unit_cost_basis: String,
+              threshold: String,
+              expires_after: T.nilable(Integer),
+              expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::OrSymbol)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            amount:,
+            currency:,
+            invoice_settings:,
+            per_unit_cost_basis:,
+            threshold:,
+            expires_after: nil,
+            expires_after_unit: nil
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  id: String,
+                  amount: String,
+                  currency: String,
+                  invoice_settings: Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings,
+                  per_unit_cost_basis: String,
+                  threshold: String,
+                  expires_after: T.nilable(Integer),
+                  expires_after_unit: T.nilable(
+                    Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
+                  )
+                }
+              )
+          end
+          def to_hash
+          end
+
+          class InvoiceSettings < Orb::BaseModel
+            # Whether the credits purchase invoice should auto collect with the customer's
+            #   saved payment method.
+            sig { returns(T::Boolean) }
+            attr_accessor :auto_collection
+
+            # 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.
+            sig { returns(Integer) }
+            attr_accessor :net_terms
+
+            # An optional memo to display on the invoice.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :memo
+
+            # 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.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :require_successful_payment
+
+            sig { params(require_successful_payment: T::Boolean).void }
+            attr_writer :require_successful_payment
+
+            # Settings for invoices generated by triggered top-ups.
+            sig do
+              params(
+                auto_collection: T::Boolean,
+                net_terms: Integer,
+                memo: T.nilable(String),
+                require_successful_payment: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            end
+
+            sig do
+              override
+                .returns(
+                  {
+                    auto_collection: T::Boolean,
+                    net_terms: Integer,
+                    memo: T.nilable(String),
+                    require_successful_payment: T::Boolean
+                  }
+                )
+            end
+            def to_hash
+            end
+          end
+
+          # The unit of expires_after.
+          module ExpiresAfterUnit
+            extend Orb::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  String,
+                  Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
+                )
+              end
+
+            DAY =
+              T.let(
+                :day,
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
+              )
+            MONTH =
+              T.let(
+                :month,
+                Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi

@@ -0,0 +1,176 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        class TopUpCreateParams < Orb::BaseModel
+          extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # The amount to increment when the threshold is reached.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :currency
+
+          # Settings for invoices generated by triggered top-ups.
+          sig { returns(Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings) }
+          attr_reader :invoice_settings
+
+          sig do
+            params(
+              invoice_settings: T.any(Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings, Orb::Util::AnyHash)
+            )
+              .void
+          end
+          attr_writer :invoice_settings
+
+          # How much, in the customer's currency, to charge for each unit.
+          sig { returns(String) }
+          attr_accessor :per_unit_cost_basis
+
+          # The threshold at which to trigger the top-up. If the balance is at or below this
+          #   threshold, the top-up will be triggered.
+          sig { returns(String) }
+          attr_accessor :threshold
+
+          # The date from which the top-up is active. If unspecified, the top-up is active
+          #   immediately.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :active_from
+
+          # The number of days or months after which the top-up expires. If unspecified, it
+          #   does not expire.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :expires_after
+
+          # The unit of expires_after.
+          sig { returns(T.nilable(Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol)) }
+          attr_accessor :expires_after_unit
+
+          sig do
+            params(
+              amount: String,
+              currency: String,
+              invoice_settings: T.any(Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings, Orb::Util::AnyHash),
+              per_unit_cost_basis: String,
+              threshold: String,
+              active_from: T.nilable(Time),
+              expires_after: T.nilable(Integer),
+              expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol),
+              request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            currency:,
+            invoice_settings:,
+            per_unit_cost_basis:,
+            threshold:,
+            active_from: nil,
+            expires_after: nil,
+            expires_after_unit: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  amount: String,
+                  currency: String,
+                  invoice_settings: Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings,
+                  per_unit_cost_basis: String,
+                  threshold: String,
+                  active_from: T.nilable(Time),
+                  expires_after: T.nilable(Integer),
+                  expires_after_unit: T.nilable(Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::OrSymbol),
+                  request_options: Orb::RequestOptions
+                }
+              )
+          end
+          def to_hash
+          end
+
+          class InvoiceSettings < Orb::BaseModel
+            # Whether the credits purchase invoice should auto collect with the customer's
+            #   saved payment method.
+            sig { returns(T::Boolean) }
+            attr_accessor :auto_collection
+
+            # 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.
+            sig { returns(Integer) }
+            attr_accessor :net_terms
+
+            # An optional memo to display on the invoice.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :memo
+
+            # 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.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :require_successful_payment
+
+            sig { params(require_successful_payment: T::Boolean).void }
+            attr_writer :require_successful_payment
+
+            # Settings for invoices generated by triggered top-ups.
+            sig do
+              params(
+                auto_collection: T::Boolean,
+                net_terms: Integer,
+                memo: T.nilable(String),
+                require_successful_payment: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            end
+
+            sig do
+              override
+                .returns(
+                  {
+                    auto_collection: T::Boolean,
+                    net_terms: Integer,
+                    memo: T.nilable(String),
+                    require_successful_payment: T::Boolean
+                  }
+                )
+            end
+            def to_hash
+            end
+          end
+
+          # The unit of expires_after.
+          module ExpiresAfterUnit
+            extend Orb::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit) }
+            OrSymbol =
+              T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) }
+
+            DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol)
+            MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol)
+
+            sig do
+              override
+                .returns(T::Array[Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol])
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end