Class: Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/simulations/inbound_ach_transfer_create_params.rb

Defined Under Namespace

Modules: Category Classes: Freeform

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(category: , freeform: nil) ⇒ Object

Additional information to include in the transfer.

Parameters:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 118

class Addenda < Increase::Internal::Type::BaseModel
  # @!attribute category
  #   The type of addenda to simulate being sent with the transfer.
  #
  #   @return [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category]
  required :category, enum: -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Category }

  # @!attribute freeform
  #   Unstructured `payment_related_information` passed through with the transfer.
  #
  #   @return [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform, nil]
  optional :freeform, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform }

  # @!method initialize(category:, freeform: nil)
  #   Additional information to include in the transfer.
  #
  #   @param category [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category] The type of addenda to simulate being sent with the transfer.
  #
  #   @param freeform [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform] Unstructured `payment_related_information` passed through with the transfer.

  # The type of addenda to simulate being sent with the transfer.
  #
  # @see Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda#category
  module Category
    extend Increase::Internal::Type::Enum

    # Unstructured `payment_related_information` passed through with the transfer.
    FREEFORM = :freeform

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda#freeform
  class Freeform < Increase::Internal::Type::BaseModel
    # @!attribute entries
    #   Each entry represents an addendum sent with the transfer.
    #
    #   @return [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>]
    required :entries,
             -> { Increase::Internal::Type::ArrayOf[Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry] }

    # @!method initialize(entries:)
    #   Unstructured `payment_related_information` passed through with the transfer.
    #
    #   @param entries [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>] Each entry represents an addendum sent with the transfer.

    class Entry < Increase::Internal::Type::BaseModel
      # @!attribute payment_related_information
      #   The payment related information passed in the addendum.
      #
      #   @return [String]
      required :payment_related_information, String

      # @!method initialize(payment_related_information:)
      #   @param payment_related_information [String] The payment related information passed in the addendum.
    end
  end
end

Instance Attribute Details

#category ⇒ Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category

The type of addenda to simulate being sent with the transfer.

Returns:



123
 
# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 123

required :category, enum: -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Category }

#freeform ⇒ Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform?

Unstructured ‘payment_related_information` passed through with the transfer.

Returns:



129
 
# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 129

optional :freeform, -> { Increase::Simulations::InboundACHTransferCreateParams::Addenda::Freeform }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/simulations/inbound_ach_transfer_create_params.rb', line 147