orb-billing 0.1.0.pre.alpha.33

data/rbi/lib/orb/models/customers/credit_list_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditListParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # The ledger currency or custom pricing unit to use.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   from the initial request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cursor
+
+        # If set to True, all expired and depleted blocks, as well as active block will be
+        #   returned.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_all_blocks
+
+        sig { params(include_all_blocks: T::Boolean).void }
+        attr_writer :include_all_blocks
+
+        # The number of items to fetch. Defaults to 20.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          params(
+            currency: T.nilable(String),
+            cursor: T.nilable(String),
+            include_all_blocks: T::Boolean,
+            limit: Integer,
+            request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                currency: T.nilable(String),
+                cursor: T.nilable(String),
+                include_all_blocks: T::Boolean,
+                limit: Integer,
+                request_options: Orb::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/customers/credit_list_response.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CreditListResponse < Orb::BaseModel
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Float) }
+        attr_accessor :balance
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :effective_date
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expiry_date
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :maximum_initial_balance
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :per_unit_cost_basis
+
+        sig { returns(Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) }
+        attr_accessor :status
+
+        sig do
+          params(
+            id: String,
+            balance: Float,
+            effective_date: T.nilable(Time),
+            expiry_date: T.nilable(Time),
+            maximum_initial_balance: T.nilable(Float),
+            per_unit_cost_basis: T.nilable(String),
+            status: Orb::Models::Customers::CreditListResponse::Status::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          balance:,
+          effective_date:,
+          expiry_date:,
+          maximum_initial_balance:,
+          per_unit_cost_basis:,
+          status:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                balance: Float,
+                effective_date: T.nilable(Time),
+                expiry_date: T.nilable(Time),
+                maximum_initial_balance: T.nilable(Float),
+                per_unit_cost_basis: T.nilable(String),
+                status: Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Orb::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListResponse::Status) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) }
+
+          ACTIVE = T.let(:active, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol)
+          PENDING_PAYMENT =
+            T.let(:pending_payment, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,270 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      module Credits
+        class LedgerCreateEntryByExternalIDParams < Orb::BaseModel
+          extend Orb::Type::RequestParameters::Converter
+          include Orb::RequestParameters
+
+          # The number of credits to effect. Note that this is required for increment,
+          #   decrement or void operations.
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          sig { returns(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol) }
+          attr_accessor :entry_type
+
+          # The currency or custom pricing unit to use for this ledger entry. If this is a
+          #   real-world currency, it must match the customer's invoicing currency.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :currency
+
+          # Optional metadata that can be specified when adding ledger results via the API.
+          #   For example, this can be used to note an increment refers to trial credits, or
+          #   for noting corrections as a result of an incident, etc.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # An ISO 8601 format date that denotes when this credit balance should become
+          #   available for use.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :effective_date
+
+          # An ISO 8601 format date that identifies the origination credit block to expire
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :expiry_date
+
+          # Passing `invoice_settings` automatically generates an invoice for the newly
+          #   added credits. If `invoice_settings` is passed, you must specify
+          #   per_unit_cost_basis, as the calculation of the invoice total is done on that
+          #   basis.
+          sig { returns(T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings)) }
+          attr_reader :invoice_settings
+
+          sig do
+            params(
+              invoice_settings: T.nilable(
+                T.any(
+                  Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings,
+                  Orb::Util::AnyHash
+                )
+              )
+            )
+              .void
+          end
+          attr_writer :invoice_settings
+
+          # 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`.
+          sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+          attr_accessor :metadata
+
+          # Can only be specified when entry_type=increment. How much, in the customer's
+          #   currency, a customer paid for a single credit in this block
+          sig { returns(T.nilable(String)) }
+          attr_accessor :per_unit_cost_basis
+
+          # A future date (specified in YYYY-MM-DD format) used for expiration change,
+          #   denoting when credits transferred (as part of a partial block expiration) should
+          #   expire.
+          sig { returns(Date) }
+          attr_accessor :target_expiry_date
+
+          # The ID of the block to reverse a decrement from.
+          sig { returns(String) }
+          attr_accessor :block_id
+
+          # Can only be specified when `entry_type=void`. The reason for the void.
+          sig do
+            returns(
+              T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol)
+            )
+          end
+          attr_accessor :void_reason
+
+          sig do
+            params(
+              amount: Float,
+              entry_type: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol,
+              expiry_date: T.nilable(Time),
+              target_expiry_date: Date,
+              block_id: String,
+              currency: T.nilable(String),
+              description: T.nilable(String),
+              effective_date: T.nilable(Time),
+              invoice_settings: T.nilable(
+                T.any(
+                  Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings,
+                  Orb::Util::AnyHash
+                )
+              ),
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+              per_unit_cost_basis: T.nilable(String),
+              void_reason: T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol),
+              request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            amount:,
+            entry_type:,
+            expiry_date:,
+            target_expiry_date:,
+            block_id:,
+            currency: nil,
+            description: nil,
+            effective_date: nil,
+            invoice_settings: nil,
+            metadata: nil,
+            per_unit_cost_basis: nil,
+            void_reason: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override
+              .returns(
+                {
+                  amount: Float,
+                  entry_type: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol,
+                  currency: T.nilable(String),
+                  description: T.nilable(String),
+                  effective_date: T.nilable(Time),
+                  expiry_date: T.nilable(Time),
+                  invoice_settings: T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings),
+                  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+                  per_unit_cost_basis: T.nilable(String),
+                  target_expiry_date: Date,
+                  block_id: String,
+                  void_reason: T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol),
+                  request_options: Orb::RequestOptions
+                }
+              )
+          end
+          def to_hash
+          end
+
+          module EntryType
+            extend Orb::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  String,
+                  Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol
+                )
+              end
+
+            AMENDMENT =
+              T.let(
+                :amendment,
+                Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          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, the new credit block will require that the corresponding invoice is
+            #   paid before it 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
+
+            # Passing `invoice_settings` automatically generates an invoice for the newly
+            #   added credits. If `invoice_settings` is passed, you must specify
+            #   per_unit_cost_basis, as the calculation of the invoice total is done on that
+            #   basis.
+            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
+
+          # Can only be specified when `entry_type=void`. The reason for the void.
+          module VoidReason
+            extend Orb::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason) }
+            OrSymbol =
+              T.type_alias do
+                T.any(
+                  Symbol,
+                  String,
+                  Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol
+                )
+              end
+
+            REFUND =
+              T.let(
+                :refund,
+                Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol
+              )
+
+            sig do
+              override
+                .returns(
+                  T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol]
+                )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end