orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class BalanceTransactionCreateParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        sig { returns(String) }
+        attr_accessor :amount
+
+        sig { returns(Orb::Models::Customers::BalanceTransactionCreateParams::Type::OrSymbol) }
+        attr_accessor :type
+
+        # An optional description that can be specified around this entry.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig do
+          params(
+            amount: String,
+            type: Orb::Models::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
+            description: T.nilable(String),
+            request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(amount:, type:, description: nil, request_options: {})
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                amount: String,
+                type: Orb::Models::Customers::BalanceTransactionCreateParams::Type::OrSymbol,
+                description: T.nilable(String),
+                request_options: Orb::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) }
+
+          INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
+          DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class BalanceTransactionCreateResponse < Orb::BaseModel
+        # A unique id for this transaction.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) }
+        attr_accessor :action
+
+        # The value of the amount changed in the transaction.
+        sig { returns(String) }
+        attr_accessor :amount
+
+        # The creation time of this transaction.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(T.nilable(Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote)) }
+        attr_reader :credit_note
+
+        sig do
+          params(
+            credit_note: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, Orb::Util::AnyHash))
+          )
+            .void
+        end
+        attr_writer :credit_note
+
+        # An optional description provided for manual customer balance adjustments.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The new value of the customer's balance prior to the transaction, in the
+        #   customer's currency.
+        sig { returns(String) }
+        attr_accessor :ending_balance
+
+        sig { returns(T.nilable(Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice)) }
+        attr_reader :invoice
+
+        sig do
+          params(
+            invoice: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, Orb::Util::AnyHash))
+          )
+            .void
+        end
+        attr_writer :invoice
+
+        # The original value of the customer's balance prior to the transaction, in the
+        #   customer's currency.
+        sig { returns(String) }
+        attr_accessor :starting_balance
+
+        sig { returns(Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            id: String,
+            action: Orb::Models::Customers::BalanceTransactionCreateResponse::Action::OrSymbol,
+            amount: String,
+            created_at: Time,
+            credit_note: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, Orb::Util::AnyHash)),
+            description: T.nilable(String),
+            ending_balance: String,
+            invoice: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, Orb::Util::AnyHash)),
+            starting_balance: String,
+            type: Orb::Models::Customers::BalanceTransactionCreateResponse::Type::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          action:,
+          amount:,
+          created_at:,
+          credit_note:,
+          description:,
+          ending_balance:,
+          invoice:,
+          starting_balance:,
+          type:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                action: Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol,
+                amount: String,
+                created_at: Time,
+                credit_note: T.nilable(Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote),
+                description: T.nilable(String),
+                ending_balance: String,
+                invoice: T.nilable(Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice),
+                starting_balance: String,
+                type: Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module Action
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) }
+
+          APPLIED_TO_INVOICE =
+            T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+          MANUAL_ADJUSTMENT =
+            T.let(:manual_adjustment, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+          PRORATED_REFUND =
+            T.let(:prorated_refund, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+          REVERT_PRORATED_REFUND =
+            T.let(
+              :revert_prorated_refund,
+              Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol
+            )
+          RETURN_FROM_VOIDING =
+            T.let(
+              :return_from_voiding,
+              Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol
+            )
+          CREDIT_NOTE_APPLIED =
+            T.let(
+              :credit_note_applied,
+              Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol
+            )
+          CREDIT_NOTE_VOIDED =
+            T.let(:credit_note_voided, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+          OVERPAYMENT_REFUND =
+            T.let(:overpayment_refund, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+          EXTERNAL_PAYMENT =
+            T.let(:external_payment, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+        class CreditNote < Orb::BaseModel
+          # The id of the Credit note
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({id: String}) }
+          def to_hash
+          end
+        end
+
+        class Invoice < Orb::BaseModel
+          # The Invoice id
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({id: String}) }
+          def to_hash
+          end
+        end
+
+        module Type
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) }
+
+          INCREMENT =
+            T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)
+          DECREMENT =
+            T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class BalanceTransactionListParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # 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
+
+        # 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 { returns(T.nilable(Time)) }
+        attr_accessor :operation_time_gt
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :operation_time_gte
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :operation_time_lt
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :operation_time_lte
+
+        sig do
+          params(
+            cursor: T.nilable(String),
+            limit: Integer,
+            operation_time_gt: T.nilable(Time),
+            operation_time_gte: T.nilable(Time),
+            operation_time_lt: T.nilable(Time),
+            operation_time_lte: T.nilable(Time),
+            request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          cursor: nil,
+          limit: nil,
+          operation_time_gt: nil,
+          operation_time_gte: nil,
+          operation_time_lt: nil,
+          operation_time_lte: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                cursor: T.nilable(String),
+                limit: Integer,
+                operation_time_gt: T.nilable(Time),
+                operation_time_gte: T.nilable(Time),
+                operation_time_lt: T.nilable(Time),
+                operation_time_lte: T.nilable(Time),
+                request_options: Orb::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class BalanceTransactionListResponse < Orb::BaseModel
+        # A unique id for this transaction.
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) }
+        attr_accessor :action
+
+        # The value of the amount changed in the transaction.
+        sig { returns(String) }
+        attr_accessor :amount
+
+        # The creation time of this transaction.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(T.nilable(Orb::Models::Customers::BalanceTransactionListResponse::CreditNote)) }
+        attr_reader :credit_note
+
+        sig do
+          params(
+            credit_note: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, Orb::Util::AnyHash))
+          )
+            .void
+        end
+        attr_writer :credit_note
+
+        # An optional description provided for manual customer balance adjustments.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The new value of the customer's balance prior to the transaction, in the
+        #   customer's currency.
+        sig { returns(String) }
+        attr_accessor :ending_balance
+
+        sig { returns(T.nilable(Orb::Models::Customers::BalanceTransactionListResponse::Invoice)) }
+        attr_reader :invoice
+
+        sig do
+          params(
+            invoice: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionListResponse::Invoice, Orb::Util::AnyHash))
+          )
+            .void
+        end
+        attr_writer :invoice
+
+        # The original value of the customer's balance prior to the transaction, in the
+        #   customer's currency.
+        sig { returns(String) }
+        attr_accessor :starting_balance
+
+        sig { returns(Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            id: String,
+            action: Orb::Models::Customers::BalanceTransactionListResponse::Action::OrSymbol,
+            amount: String,
+            created_at: Time,
+            credit_note: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, Orb::Util::AnyHash)),
+            description: T.nilable(String),
+            ending_balance: String,
+            invoice: T.nilable(T.any(Orb::Models::Customers::BalanceTransactionListResponse::Invoice, Orb::Util::AnyHash)),
+            starting_balance: String,
+            type: Orb::Models::Customers::BalanceTransactionListResponse::Type::OrSymbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          action:,
+          amount:,
+          created_at:,
+          credit_note:,
+          description:,
+          ending_balance:,
+          invoice:,
+          starting_balance:,
+          type:
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                id: String,
+                action: Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol,
+                amount: String,
+                created_at: Time,
+                credit_note: T.nilable(Orb::Models::Customers::BalanceTransactionListResponse::CreditNote),
+                description: T.nilable(String),
+                ending_balance: String,
+                invoice: T.nilable(Orb::Models::Customers::BalanceTransactionListResponse::Invoice),
+                starting_balance: String,
+                type: Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module Action
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) }
+
+          APPLIED_TO_INVOICE =
+            T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          MANUAL_ADJUSTMENT =
+            T.let(:manual_adjustment, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          PRORATED_REFUND =
+            T.let(:prorated_refund, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          REVERT_PRORATED_REFUND =
+            T.let(
+              :revert_prorated_refund,
+              Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol
+            )
+          RETURN_FROM_VOIDING =
+            T.let(:return_from_voiding, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          CREDIT_NOTE_APPLIED =
+            T.let(:credit_note_applied, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          CREDIT_NOTE_VOIDED =
+            T.let(:credit_note_voided, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          OVERPAYMENT_REFUND =
+            T.let(:overpayment_refund, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+          EXTERNAL_PAYMENT =
+            T.let(:external_payment, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+        class CreditNote < Orb::BaseModel
+          # The id of the Credit note
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({id: String}) }
+          def to_hash
+          end
+        end
+
+        class Invoice < Orb::BaseModel
+          # The Invoice id
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({id: String}) }
+          def to_hash
+          end
+        end
+
+        module Type
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) }
+
+          INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
+          DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Orb
+  module Models
+    module Customers
+      class CostListByExternalIDParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # The currency or custom pricing unit to use.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :currency
+
+        # Costs returned are exclusive of `timeframe_end`.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :timeframe_end
+
+        # Costs returned are inclusive of `timeframe_start`.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :timeframe_start
+
+        # Controls whether Orb returns cumulative costs since the start of the billing
+        #   period, or incremental day-by-day costs. If your customer has minimums or
+        #   discounts, it's strongly recommended that you use the default cumulative
+        #   behavior.
+        sig { returns(T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol)) }
+        attr_accessor :view_mode
+
+        sig do
+          params(
+            currency: T.nilable(String),
+            timeframe_end: T.nilable(Time),
+            timeframe_start: T.nilable(Time),
+            view_mode: T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol),
+            request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          currency: nil,
+          timeframe_end: nil,
+          timeframe_start: nil,
+          view_mode: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                currency: T.nilable(String),
+                timeframe_end: T.nilable(Time),
+                timeframe_start: T.nilable(Time),
+                view_mode: T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol),
+                request_options: Orb::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        # Controls whether Orb returns cumulative costs since the start of the billing
+        #   period, or incremental day-by-day costs. If your customer has minimums or
+        #   discounts, it's strongly recommended that you use the default cumulative
+        #   behavior.
+        module ViewMode
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) }
+
+          PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
+          CUMULATIVE =
+            T.let(:cumulative, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end