orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#create
+      class BalanceTransactionCreateParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!attribute amount
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
+        required :type, enum: -> { Orb::Models::Customers::BalanceTransactionCreateParams::Type }
+
+        # @!attribute description
+        #   An optional description that can be specified around this entry.
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!parse
+        #   # @param amount [String]
+        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
+        #   # @param description [String, nil]
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(amount:, type:, description: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        module Type
+          extend Orb::Enum
+
+          INCREMENT = :increment
+          DECREMENT = :decrement
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#create
+      class BalanceTransactionCreateResponse < Orb::BaseModel
+        # @!attribute id
+        #   A unique id for this transaction.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute action
+        #
+        #   @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action]
+        required :action, enum: -> { Orb::Models::Customers::BalanceTransactionCreateResponse::Action }
+
+        # @!attribute amount
+        #   The value of the amount changed in the transaction.
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute created_at
+        #   The creation time of this transaction.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute credit_note
+        #
+        #   @return [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil]
+        required :credit_note,
+                 -> { Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote },
+                 nil?: true
+
+        # @!attribute description
+        #   An optional description provided for manual customer balance adjustments.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute ending_balance
+        #   The new value of the customer's balance prior to the transaction, in the
+        #     customer's currency.
+        #
+        #   @return [String]
+        required :ending_balance, String
+
+        # @!attribute invoice
+        #
+        #   @return [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
+        required :invoice, -> { Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice }, nil?: true
+
+        # @!attribute starting_balance
+        #   The original value of the customer's balance prior to the transaction, in the
+        #     customer's currency.
+        #
+        #   @return [String]
+        required :starting_balance, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
+        required :type, enum: -> { Orb::Models::Customers::BalanceTransactionCreateResponse::Type }
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param action [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action]
+        #   # @param amount [String]
+        #   # @param created_at [Time]
+        #   # @param credit_note [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil]
+        #   # @param description [String, nil]
+        #   # @param ending_balance [String]
+        #   # @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
+        #   # @param starting_balance [String]
+        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     action:,
+        #     amount:,
+        #     created_at:,
+        #     credit_note:,
+        #     description:,
+        #     ending_balance:,
+        #     invoice:,
+        #     starting_balance:,
+        #     type:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::Customers::BalanceTransactionCreateResponse#action
+        module Action
+          extend Orb::Enum
+
+          APPLIED_TO_INVOICE = :applied_to_invoice
+          MANUAL_ADJUSTMENT = :manual_adjustment
+          PRORATED_REFUND = :prorated_refund
+          REVERT_PRORATED_REFUND = :revert_prorated_refund
+          RETURN_FROM_VOIDING = :return_from_voiding
+          CREDIT_NOTE_APPLIED = :credit_note_applied
+          CREDIT_NOTE_VOIDED = :credit_note_voided
+          OVERPAYMENT_REFUND = :overpayment_refund
+          EXTERNAL_PAYMENT = :external_payment
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionCreateResponse#credit_note
+        class CreditNote < Orb::BaseModel
+          # @!attribute id
+          #   The id of the Credit note
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!parse
+          #   # @param id [String]
+          #   #
+          #   def initialize(id:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionCreateResponse#invoice
+        class Invoice < Orb::BaseModel
+          # @!attribute id
+          #   The Invoice id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!parse
+          #   # @param id [String]
+          #   #
+          #   def initialize(id:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionCreateResponse#type
+        module Type
+          extend Orb::Enum
+
+          INCREMENT = :increment
+          DECREMENT = :decrement
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#list
+      class BalanceTransactionListParams < 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
+
+        # @!attribute operation_time_gt
+        #
+        #   @return [Time, nil]
+        optional :operation_time_gt, Time, api_name: :"operation_time[gt]", nil?: true
+
+        # @!attribute operation_time_gte
+        #
+        #   @return [Time, nil]
+        optional :operation_time_gte, Time, api_name: :"operation_time[gte]", nil?: true
+
+        # @!attribute operation_time_lt
+        #
+        #   @return [Time, nil]
+        optional :operation_time_lt, Time, api_name: :"operation_time[lt]", nil?: true
+
+        # @!attribute operation_time_lte
+        #
+        #   @return [Time, nil]
+        optional :operation_time_lte, Time, api_name: :"operation_time[lte]", nil?: true
+
+        # @!parse
+        #   # @param cursor [String, nil]
+        #   # @param limit [Integer]
+        #   # @param operation_time_gt [Time, nil]
+        #   # @param operation_time_gte [Time, nil]
+        #   # @param operation_time_lt [Time, nil]
+        #   # @param operation_time_lte [Time, nil]
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(
+        #     cursor: nil,
+        #     limit: nil,
+        #     operation_time_gt: nil,
+        #     operation_time_gte: nil,
+        #     operation_time_lt: nil,
+        #     operation_time_lte: nil,
+        #     request_options: {},
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#list
+      class BalanceTransactionListResponse < Orb::BaseModel
+        # @!attribute id
+        #   A unique id for this transaction.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute action
+        #
+        #   @return [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action]
+        required :action, enum: -> { Orb::Models::Customers::BalanceTransactionListResponse::Action }
+
+        # @!attribute amount
+        #   The value of the amount changed in the transaction.
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute created_at
+        #   The creation time of this transaction.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute credit_note
+        #
+        #   @return [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil]
+        required :credit_note,
+                 -> { Orb::Models::Customers::BalanceTransactionListResponse::CreditNote },
+                 nil?: true
+
+        # @!attribute description
+        #   An optional description provided for manual customer balance adjustments.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute ending_balance
+        #   The new value of the customer's balance prior to the transaction, in the
+        #     customer's currency.
+        #
+        #   @return [String]
+        required :ending_balance, String
+
+        # @!attribute invoice
+        #
+        #   @return [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
+        required :invoice, -> { Orb::Models::Customers::BalanceTransactionListResponse::Invoice }, nil?: true
+
+        # @!attribute starting_balance
+        #   The original value of the customer's balance prior to the transaction, in the
+        #     customer's currency.
+        #
+        #   @return [String]
+        required :starting_balance, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
+        required :type, enum: -> { Orb::Models::Customers::BalanceTransactionListResponse::Type }
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param action [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action]
+        #   # @param amount [String]
+        #   # @param created_at [Time]
+        #   # @param credit_note [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil]
+        #   # @param description [String, nil]
+        #   # @param ending_balance [String]
+        #   # @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
+        #   # @param starting_balance [String]
+        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     action:,
+        #     amount:,
+        #     created_at:,
+        #     credit_note:,
+        #     description:,
+        #     ending_balance:,
+        #     invoice:,
+        #     starting_balance:,
+        #     type:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::Customers::BalanceTransactionListResponse#action
+        module Action
+          extend Orb::Enum
+
+          APPLIED_TO_INVOICE = :applied_to_invoice
+          MANUAL_ADJUSTMENT = :manual_adjustment
+          PRORATED_REFUND = :prorated_refund
+          REVERT_PRORATED_REFUND = :revert_prorated_refund
+          RETURN_FROM_VOIDING = :return_from_voiding
+          CREDIT_NOTE_APPLIED = :credit_note_applied
+          CREDIT_NOTE_VOIDED = :credit_note_voided
+          OVERPAYMENT_REFUND = :overpayment_refund
+          EXTERNAL_PAYMENT = :external_payment
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionListResponse#credit_note
+        class CreditNote < Orb::BaseModel
+          # @!attribute id
+          #   The id of the Credit note
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!parse
+          #   # @param id [String]
+          #   #
+          #   def initialize(id:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionListResponse#invoice
+        class Invoice < Orb::BaseModel
+          # @!attribute id
+          #   The Invoice id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!parse
+          #   # @param id [String]
+          #   #
+          #   def initialize(id:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+
+        # @see Orb::Models::Customers::BalanceTransactionListResponse#type
+        module Type
+          extend Orb::Enum
+
+          INCREMENT = :increment
+          DECREMENT = :decrement
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::Costs#list_by_external_id
+      class CostListByExternalIDParams < Orb::BaseModel
+        # @!parse
+        #   extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        # @!attribute currency
+        #   The currency or custom pricing unit to use.
+        #
+        #   @return [String, nil]
+        optional :currency, String, nil?: true
+
+        # @!attribute timeframe_end
+        #   Costs returned are exclusive of `timeframe_end`.
+        #
+        #   @return [Time, nil]
+        optional :timeframe_end, Time, nil?: true
+
+        # @!attribute timeframe_start
+        #   Costs returned are inclusive of `timeframe_start`.
+        #
+        #   @return [Time, nil]
+        optional :timeframe_start, Time, nil?: true
+
+        # @!attribute view_mode
+        #   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.
+        #
+        #   @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
+        optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
+
+        # @!parse
+        #   # @param currency [String, nil]
+        #   # @param timeframe_end [Time, nil]
+        #   # @param timeframe_start [Time, nil]
+        #   # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
+        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # 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
+
+          PERIODIC = :periodic
+          CUMULATIVE = :cumulative
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/customers/cost_list_by_external_id_response.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Customers
+      # @see Orb::Resources::Customers::Costs#list_by_external_id
+      class CostListByExternalIDResponse < Orb::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data>]
+        required :data, -> { Orb::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data] }
+
+        # @!parse
+        #   # @param data [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data>]
+        #   #
+        #   def initialize(data:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        class Data < Orb::BaseModel
+          # @!attribute per_price_costs
+          #
+          #   @return [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost>]
+          required :per_price_costs,
+                   -> { Orb::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost] }
+
+          # @!attribute subtotal
+          #   Total costs for the timeframe, excluding any minimums and discounts.
+          #
+          #   @return [String]
+          required :subtotal, String
+
+          # @!attribute timeframe_end
+          #
+          #   @return [Time]
+          required :timeframe_end, Time
+
+          # @!attribute timeframe_start
+          #
+          #   @return [Time]
+          required :timeframe_start, Time
+
+          # @!attribute total
+          #   Total costs for the timeframe, including any minimums and discounts.
+          #
+          #   @return [String]
+          required :total, String
+
+          # @!parse
+          #   # @param per_price_costs [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost>]
+          #   # @param subtotal [String]
+          #   # @param timeframe_end [Time]
+          #   # @param timeframe_start [Time]
+          #   # @param total [String]
+          #   #
+          #   def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+
+          class PerPriceCost < Orb::BaseModel
+            # @!attribute price
+            #   The price object
+            #
+            #   @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
+            required :price, union: -> { Orb::Models::Price }
+
+            # @!attribute price_id
+            #   The price the cost is associated with
+            #
+            #   @return [String]
+            required :price_id, String
+
+            # @!attribute subtotal
+            #   Price's contributions for the timeframe, excluding any minimums and discounts.
+            #
+            #   @return [String]
+            required :subtotal, String
+
+            # @!attribute total
+            #   Price's contributions for the timeframe, including minimums and discounts.
+            #
+            #   @return [String]
+            required :total, String
+
+            # @!attribute quantity
+            #   The price's quantity for the timeframe
+            #
+            #   @return [Float, nil]
+            optional :quantity, Float, nil?: true
+
+            # @!parse
+            #   # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
+            #   # @param price_id [String]
+            #   # @param subtotal [String]
+            #   # @param total [String]
+            #   # @param quantity [Float, nil]
+            #   #
+            #   def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super
+
+            # def initialize: (Hash | Orb::BaseModel) -> void
+          end
+        end
+      end
+    end
+  end
+end