orb-billing 0.2.0 → 0.3.0

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::Credits#list_by_external_id
       class CreditListByExternalIDParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
@@ -22,37 +21,34 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!attribute [r] include_all_blocks
+        # @!attribute include_all_blocks
         #   If set to True, all expired and depleted blocks, as well as active block will be
         #   returned.
         #
         #   @return [Boolean, nil]
         optional :include_all_blocks, Orb::Internal::Type::Boolean
 
-        # @!parse
-        #   # @return [Boolean]
-        #   attr_writer :include_all_blocks
-
-        # @!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 currency [String, nil]
-        #   # @param cursor [String, nil]
-        #   # @param include_all_blocks [Boolean]
-        #   # @param limit [Integer]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
+        #
+        #   @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   ...
+        #
+        #   @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
+        #   ...
+        #
+        #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

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

@@ -40,18 +40,14 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status }
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param balance [Float]
-        #   # @param effective_date [Time, nil]
-        #   # @param expiry_date [Time, nil]
-        #   # @param maximum_initial_balance [Float, nil]
-        #   # @param per_unit_cost_basis [String, nil]
-        #   # @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
-        #   #
-        #   def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:)
+        #   @param id [String]
+        #   @param balance [Float]
+        #   @param effective_date [Time, nil]
+        #   @param expiry_date [Time, nil]
+        #   @param maximum_initial_balance [Float, nil]
+        #   @param per_unit_cost_basis [String, nil]
+        #   @param status [Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status]
 
         # @see Orb::Models::Customers::CreditListByExternalIDResponse#status
         module Status
@@ -60,11 +56,8 @@ module Orb
           ACTIVE = :active
           PENDING_PAYMENT = :pending_payment
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::Credits#list
       class CreditListParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
@@ -22,37 +21,34 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!attribute [r] include_all_blocks
+        # @!attribute include_all_blocks
         #   If set to True, all expired and depleted blocks, as well as active block will be
         #   returned.
         #
         #   @return [Boolean, nil]
         optional :include_all_blocks, Orb::Internal::Type::Boolean
 
-        # @!parse
-        #   # @return [Boolean]
-        #   attr_writer :include_all_blocks
-
-        # @!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 currency [String, nil]
-        #   # @param cursor [String, nil]
-        #   # @param include_all_blocks [Boolean]
-        #   # @param limit [Integer]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::CreditListParams} for more details.
+        #
+        #   @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   ...
+        #
+        #   @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
+        #   ...
+        #
+        #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

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

@@ -40,18 +40,14 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CreditListResponse::Status]
         required :status, enum: -> { Orb::Models::Customers::CreditListResponse::Status }
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param balance [Float]
-        #   # @param effective_date [Time, nil]
-        #   # @param expiry_date [Time, nil]
-        #   # @param maximum_initial_balance [Float, nil]
-        #   # @param per_unit_cost_basis [String, nil]
-        #   # @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status]
-        #   #
-        #   def initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, balance:, effective_date:, expiry_date:, maximum_initial_balance:, per_unit_cost_basis:, status:)
+        #   @param id [String]
+        #   @param balance [Float]
+        #   @param effective_date [Time, nil]
+        #   @param expiry_date [Time, nil]
+        #   @param maximum_initial_balance [Float, nil]
+        #   @param per_unit_cost_basis [String, nil]
+        #   @param status [Symbol, Orb::Models::Customers::CreditListResponse::Status]
 
         # @see Orb::Models::Customers::CreditListResponse#status
         module Status
@@ -60,11 +56,8 @@ module Orb
           ACTIVE = :active
           PENDING_PAYMENT = :pending_payment
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id
         class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute amount
@@ -99,52 +98,52 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
                    nil?: true
 
-          # @!parse
-          #   # @param amount [Float]
-          #   # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
-          #   # @param expiry_date [Time, nil]
-          #   # @param target_expiry_date [Date]
-          #   # @param block_id [String]
-          #   # @param currency [String, nil]
-          #   # @param description [String, nil]
-          #   # @param effective_date [Time, nil]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
-          #   # @param metadata [Hash{Symbol=>String, nil}, nil]
-          #   # @param per_unit_cost_basis [String, nil]
-          #   # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(
-          #     amount:,
-          #     entry_type:,
-          #     expiry_date:,
-          #     target_expiry_date:,
-          #     block_id:,
-          #     currency: nil,
-          #     description: nil,
-          #     effective_date: nil,
-          #     invoice_settings: nil,
-          #     metadata: nil,
-          #     per_unit_cost_basis: nil,
-          #     void_reason: nil,
-          #     request_options: {},
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams} for more
+          #   details.
+          #
+          #   @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
+          #   ...
+          #
+          #   @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
+          #
+          #   @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
+          #
+          #   @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
+          #   ...
+          #
+          #   @param block_id [String] The ID of the block to reverse a decrement from.
+          #
+          #   @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
+          #   ...
+          #
+          #   @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
+          #   ...
+          #
+          #   @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
+          #   ...
+          #
+          #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+          #   ...
+          #
+          #   @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
+          #   ...
+          #
+          #   @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
+          #
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
           module EntryType
             extend Orb::Internal::Type::Enum
 
             AMENDMENT = :amendment
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
 
           class InvoiceSettings < Orb::Internal::Type::BaseModel
@@ -169,31 +168,33 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   If true, the new credit block will require that the corresponding invoice is
             #   paid before it 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
-            #   # 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.
-            #   #
-            #   # @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::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
+            #   for more details.
+            #
+            #   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.
+            #
+            #   @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, the new credit block will require that the corresponding invoice is pai
+            #   ...
           end
 
           # Can only be specified when `entry_type=void`. The reason for the void.
@@ -202,11 +203,8 @@ module Orb
 
             REFUND = :refund
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end