orb-billing 0.2.0 → 0.3.0

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

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id
         class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute amount
@@ -65,33 +64,32 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param active_from [Time, nil]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     active_from: nil,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     request_options: {},
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more
+          #   details.
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
+          #
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
           class InvoiceSettings < Orb::Internal::Type::BaseModel
             # @!attribute auto_collection
@@ -115,28 +113,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   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.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings}
+            #   for more details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -146,11 +146,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

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

@@ -59,31 +59,29 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse} for more
+          #   details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
 
           # @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse#invoice_settings
           class InvoiceSettings < Orb::Internal::Type::BaseModel
@@ -108,28 +106,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   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.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings}
+            #   for more details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -141,11 +141,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

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

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#create
         class TopUpCreateParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute amount
@@ -64,33 +63,31 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param active_from [Time, nil]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     active_from: nil,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     request_options: {},
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
+          #
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
           class InvoiceSettings < Orb::Internal::Type::BaseModel
             # @!attribute auto_collection
@@ -114,28 +111,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   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.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings} for more
+            #   details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -145,11 +144,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

data/lib/orb/models/customers/credits/top_up_create_response.rb

@@ -58,31 +58,28 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpCreateResponse} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil] The unit of expires_after.
 
           # @see Orb::Models::Customers::Credits::TopUpCreateResponse#invoice_settings
           class InvoiceSettings < Orb::Internal::Type::BaseModel
@@ -107,28 +104,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   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.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings} for more
+            #   details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -140,11 +139,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#delete_by_external_id
         class TopUpDeleteByExternalIDParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute external_customer_id
@@ -15,13 +14,9 @@ module Orb
           #   @return [String]
           required :external_customer_id, String
 
-          # @!parse
-          #   # @param external_customer_id [String]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(external_customer_id:, request_options: {}, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(external_customer_id:, request_options: {})
+          #   @param external_customer_id [String]
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end
     end

data/lib/orb/models/customers/credits/top_up_delete_params.rb

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#delete
         class TopUpDeleteParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute customer_id
@@ -15,13 +14,9 @@ module Orb
           #   @return [String]
           required :customer_id, String
 
-          # @!parse
-          #   # @param customer_id [String]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(customer_id:, request_options: {}, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(customer_id:, request_options: {})
+          #   @param customer_id [String]
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end
     end

data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id
         class TopUpListByExternalIDParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute cursor
@@ -17,24 +16,22 @@ module Orb
           #   @return [String, nil]
           optional :cursor, String, nil?: true
 
-          # @!attribute [r] limit
+          # @!attribute limit
           #   The number of items to fetch. Defaults to 20.
           #
           #   @return [Integer, nil]
           optional :limit, Integer
 
-          # @!parse
-          #   # @return [Integer]
-          #   attr_writer :limit
-
-          # @!parse
-          #   # @param cursor [String, nil]
-          #   # @param limit [Integer]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(cursor: nil, limit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
+          #
+          #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          #   ...
+          #
+          #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end
     end