Class: Increase::Models::WireTransferCreateParams::Remittance

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

Defined Under Namespace

Modules: Category Classes: Tax, Unstructured

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(date: , identification_number: , type_code: ) ⇒ Object

Some parameter documentations has been truncated, see Tax for more details.

Internal Revenue Service (IRS) tax repayment information. Required if ‘category` is equal to `tax`.

Parameters:

  • date (Date) (defaults to: ) —

    The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno

  • identification_number (String) (defaults to: ) —

    The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E

  • type_code (String) (defaults to: ) —

    The 5-character tax type code.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/increase/models/wire_transfer_create_params.rb', line 159

class Remittance < Increase::Internal::Type::BaseModel
  # @!attribute category
  #   The type of remittance information being passed.
  #
  #   @return [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category]
  required :category, enum: -> { Increase::WireTransferCreateParams::Remittance::Category }

  # @!attribute tax
  #   Internal Revenue Service (IRS) tax repayment information. Required if `category`
  #   is equal to `tax`.
  #
  #   @return [Increase::Models::WireTransferCreateParams::Remittance::Tax, nil]
  optional :tax, -> { Increase::WireTransferCreateParams::Remittance::Tax }

  # @!attribute unstructured
  #   Unstructured remittance information. Required if `category` is equal to
  #   `unstructured`.
  #
  #   @return [Increase::Models::WireTransferCreateParams::Remittance::Unstructured, nil]
  optional :unstructured, -> { Increase::WireTransferCreateParams::Remittance::Unstructured }

  # @!method initialize(category:, tax: nil, unstructured: nil)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::WireTransferCreateParams::Remittance} for more details.
  #
  #   Additional remittance information related to the wire transfer.
  #
  #   @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category] The type of remittance information being passed.
  #
  #   @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax] Internal Revenue Service (IRS) tax repayment information. Required if `category`
  #
  #   @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured] Unstructured remittance information. Required if `category` is equal to `unstruc

  # The type of remittance information being passed.
  #
  # @see Increase::Models::WireTransferCreateParams::Remittance#category
  module Category
    extend Increase::Internal::Type::Enum

    # The wire transfer contains unstructured remittance information.
    UNSTRUCTURED = :unstructured

    # The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS).
    TAX = :tax

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

  # @see Increase::Models::WireTransferCreateParams::Remittance#tax
  class Tax < Increase::Internal::Type::BaseModel
    # @!attribute date
    #   The month and year the tax payment is for, in YYYY-MM-DD format. The day is
    #   ignored.
    #
    #   @return [Date]
    required :date, Date

    # @!attribute identification_number
    #   The 9-digit Tax Identification Number (TIN) or Employer Identification Number
    #   (EIN).
    #
    #   @return [String]
    required :identification_number, String

    # @!attribute type_code
    #   The 5-character tax type code.
    #
    #   @return [String]
    required :type_code, String

    # @!method initialize(date:, identification_number:, type_code:)
    #   Some parameter documentations has been truncated, see
    #   {Increase::Models::WireTransferCreateParams::Remittance::Tax} for more details.
    #
    #   Internal Revenue Service (IRS) tax repayment information. Required if `category`
    #   is equal to `tax`.
    #
    #   @param date [Date] The month and year the tax payment is for, in YYYY-MM-DD format. The day is igno
    #
    #   @param identification_number [String] The 9-digit Tax Identification Number (TIN) or Employer Identification Number (E
    #
    #   @param type_code [String] The 5-character tax type code.
  end

  # @see Increase::Models::WireTransferCreateParams::Remittance#unstructured
  class Unstructured < Increase::Internal::Type::BaseModel
    # @!attribute message
    #   The message to the beneficiary.
    #
    #   @return [String]
    required :message, String

    # @!method initialize(message:)
    #   Unstructured remittance information. Required if `category` is equal to
    #   `unstructured`.
    #
    #   @param message [String] The message to the beneficiary.
  end
end

Instance Attribute Details

#category ⇒ Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category

The type of remittance information being passed.

Returns:



164
 
# File 'lib/increase/models/wire_transfer_create_params.rb', line 164

required :category, enum: -> { Increase::WireTransferCreateParams::Remittance::Category }

#tax ⇒ Increase::Models::WireTransferCreateParams::Remittance::Tax?

Internal Revenue Service (IRS) tax repayment information. Required if ‘category` is equal to `tax`.

Returns:



171
 
# File 'lib/increase/models/wire_transfer_create_params.rb', line 171

optional :tax, -> { Increase::WireTransferCreateParams::Remittance::Tax }

#unstructured ⇒ Increase::Models::WireTransferCreateParams::Remittance::Unstructured?

Unstructured remittance information. Required if ‘category` is equal to `unstructured`.

Returns:



178
 
# File 'lib/increase/models/wire_transfer_create_params.rb', line 178

optional :unstructured, -> { Increase::WireTransferCreateParams::Remittance::Unstructured }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/wire_transfer_create_params.rb', line 204