orb-billing 0.1.3 → 0.3.0

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

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::Ledger#create_entry
         class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute amount
@@ -98,52 +97,51 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason },
                    nil?: true
 
-          # @!parse
-          #   # @param amount [Float]
-          #   # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::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::LedgerCreateEntryParams::InvoiceSettings, nil]
-          #   # @param metadata [Hash{Symbol=>String, nil}, nil]
-          #   # @param per_unit_cost_basis [String, nil]
-          #   # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::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::LedgerCreateEntryParams} 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::LedgerCreateEntryParams::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::LedgerCreateEntryParams::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::LedgerCreateEntryParams::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
@@ -168,31 +166,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::LedgerCreateEntryParams::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.
@@ -201,11 +201,8 @@ module Orb
 
             REFUND = :refund
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end