orb-billing 0.2.0 → 0.3.0

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

@@ -46,8 +46,15 @@ module Orb
             )
               .returns(T.attached_class)
           end
-          def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end
-
+          def self.new(
+            per_price_costs:,
+            # Total costs for the timeframe, excluding any minimums and discounts.
+            subtotal:,
+            timeframe_end:,
+            timeframe_start:,
+            # Total costs for the timeframe, including any minimums and discounts.
+            total:
+          ); end
           sig do
             override
               .returns(
@@ -156,8 +163,18 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end
-
+            def self.new(
+              # The price object
+              price:,
+              # The price the cost is associated with
+              price_id:,
+              # Price's contributions for the timeframe, excluding any minimums and discounts.
+              subtotal:,
+              # Price's contributions for the timeframe, including minimums and discounts.
+              total:,
+              # The price's quantity for the timeframe
+              quantity: nil
+            ); end
             sig do
               override
                 .returns(

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

@@ -37,14 +37,19 @@ module Orb
             .returns(T.attached_class)
         end
         def self.new(
+          # The currency or custom pricing unit to use.
           currency: nil,
+          # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,
+          # Costs returned are inclusive of `timeframe_start`.
           timeframe_start: nil,
+          # 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.
           view_mode: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         sig do
           override
             .returns(
@@ -67,8 +72,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListParams::ViewMode) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol)
           CUMULATIVE = T.let(:cumulative, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol)

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

@@ -44,8 +44,15 @@ module Orb
             )
               .returns(T.attached_class)
           end
-          def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end
-
+          def self.new(
+            per_price_costs:,
+            # Total costs for the timeframe, excluding any minimums and discounts.
+            subtotal:,
+            timeframe_end:,
+            timeframe_start:,
+            # Total costs for the timeframe, including any minimums and discounts.
+            total:
+          ); end
           sig do
             override
               .returns(
@@ -154,8 +161,18 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end
-
+            def self.new(
+              # The price object
+              price:,
+              # The price the cost is associated with
+              price_id:,
+              # Price's contributions for the timeframe, excluding any minimums and discounts.
+              subtotal:,
+              # Price's contributions for the timeframe, including minimums and discounts.
+              total:,
+              # The price's quantity for the timeframe
+              quantity: nil
+            ); end
             sig do
               override
                 .returns(

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

@@ -41,9 +41,19 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
-        end
-
+        def self.new(
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # If set to True, all expired and depleted blocks, as well as active block will be
+          # returned.
+          include_all_blocks: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

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

@@ -69,8 +69,7 @@ module Orb
 
           TaggedSymbol =
             T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           ACTIVE = T.let(:active, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol)
           PENDING_PAYMENT =

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

@@ -41,9 +41,19 @@ module Orb
           )
             .returns(T.attached_class)
         end
-        def self.new(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
-        end
-
+        def self.new(
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # If set to True, all expired and depleted blocks, as well as active block will be
+          # returned.
+          include_all_blocks: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(

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

@@ -68,8 +68,7 @@ module Orb
           extend Orb::Internal::Type::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) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           ACTIVE = T.let(:active, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol)
           PENDING_PAYMENT =

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

@@ -109,17 +109,41 @@ module Orb
               .returns(T.attached_class)
           end
           def self.new(
+            # The number of credits to effect. Note that this is required for increment,
+            # decrement or void operations.
             amount:,
             entry_type:,
+            # An ISO 8601 format date that identifies the origination credit block to expire
             expiry_date:,
+            # 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.
             target_expiry_date:,
+            # The ID of the block to reverse a decrement from.
             block_id:,
+            # 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.
             currency: nil,
+            # 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.
             description: nil,
+            # An ISO 8601 format date that denotes when this credit balance should become
+            # available for use.
             effective_date: nil,
+            # 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.
             invoice_settings: nil,
+            # 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`.
             metadata: nil,
+            # 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
             per_unit_cost_basis: nil,
+            # Can only be specified when `entry_type=void`. The reason for the void.
             void_reason: nil,
             request_options: {}
           ); end
@@ -150,14 +174,7 @@ module Orb
 
             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
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             AMENDMENT =
               T.let(
@@ -211,8 +228,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              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.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, the new credit block will require that the corresponding invoice is
+              # paid before it can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -233,14 +262,7 @@ module Orb
 
             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
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             REFUND =
               T.let(

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

@@ -122,6 +122,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               starting_balance:,
               entry_type: :increment
@@ -197,14 +201,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -354,6 +351,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               starting_balance:,
               event_id: nil,
@@ -435,14 +436,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -584,6 +578,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               new_block_expiry_date:,
               starting_balance:,
@@ -661,14 +659,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -806,6 +797,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               starting_balance:,
               entry_type: :credit_block_expiry
@@ -881,14 +876,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -1030,6 +1018,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               starting_balance:,
               void_amount:,
@@ -1109,14 +1101,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -1266,6 +1251,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               new_block_expiry_date:,
               starting_balance:,
@@ -1347,14 +1336,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(
@@ -1492,6 +1474,10 @@ module Orb
               ending_balance:,
               entry_status:,
               ledger_sequence_number:,
+              # User specified key-value pairs for the resource. If not present, this defaults
+              # to an empty dictionary. Individual keys can be removed by setting the value to
+              # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+              # `null`.
               metadata:,
               starting_balance:,
               entry_type: :amendment
@@ -1567,14 +1553,7 @@ module Orb
                 T.type_alias do
                   T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus)
                 end
-              OrSymbol =
-                T.type_alias do
-                  T.any(
-                    Symbol,
-                    String,
-                    Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
-                  )
-                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               COMMITTED =
                 T.let(

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

@@ -99,17 +99,41 @@ module Orb
               .returns(T.attached_class)
           end
           def self.new(
+            # The number of credits to effect. Note that this is required for increment,
+            # decrement or void operations.
             amount:,
             entry_type:,
+            # An ISO 8601 format date that identifies the origination credit block to expire
             expiry_date:,
+            # 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.
             target_expiry_date:,
+            # The ID of the block to reverse a decrement from.
             block_id:,
+            # 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.
             currency: nil,
+            # 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.
             description: nil,
+            # An ISO 8601 format date that denotes when this credit balance should become
+            # available for use.
             effective_date: nil,
+            # 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.
             invoice_settings: nil,
+            # 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`.
             metadata: nil,
+            # 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
             per_unit_cost_basis: nil,
+            # Can only be specified when `entry_type=void`. The reason for the void.
             void_reason: nil,
             request_options: {}
           ); end
@@ -140,8 +164,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             AMENDMENT =
               T.let(:amendment, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol)
@@ -190,8 +213,20 @@ module Orb
               )
                 .returns(T.attached_class)
             end
-            def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
-
+            def self.new(
+              # Whether the credits purchase invoice should auto collect with the customer's
+              # saved payment method.
+              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.
+              net_terms:,
+              # An optional memo to display on the invoice.
+              memo: nil,
+              # If true, the new credit block will require that the corresponding invoice is
+              # paid before it can be drawn down from.
+              require_successful_payment: nil
+            ); end
             sig do
               override
                 .returns(
@@ -212,8 +247,7 @@ module Orb
 
             TaggedSymbol =
               T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             REFUND =
               T.let(:refund, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol)