increase 1.273.0 → 1.275.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1055,6 +1055,16 @@ module Increase
1055
1055
  end
1056
1056
  attr_accessor :reason
1057
1057
 
1058
+ # The scheme fees associated with this card decline.
1059
+ sig do
1060
+ returns(
1061
+ T::Array[
1062
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee
1063
+ ]
1064
+ )
1065
+ end
1066
+ attr_accessor :scheme_fees
1067
+
1058
1068
  # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1059
1069
  # is transacting with.
1060
1070
  sig { returns(T.nilable(String)) }
@@ -1118,6 +1128,10 @@ module Increase
1118
1128
  ),
1119
1129
  reason:
1120
1130
  Increase::DeclinedTransaction::Source::CardDecline::Reason::OrSymbol,
1131
+ scheme_fees:
1132
+ T::Array[
1133
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::OrHash
1134
+ ],
1121
1135
  terminal_id: T.nilable(String),
1122
1136
  verification:
1123
1137
  Increase::DeclinedTransaction::Source::CardDecline::Verification::OrHash
@@ -1196,6 +1210,8 @@ module Increase
1196
1210
  real_time_decision_reason:,
1197
1211
  # Why the transaction was declined.
1198
1212
  reason:,
1213
+ # The scheme fees associated with this card decline.
1214
+ scheme_fees:,
1199
1215
  # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1200
1216
  # is transacting with.
1201
1217
  terminal_id:,
@@ -1245,6 +1261,10 @@ module Increase
1245
1261
  ),
1246
1262
  reason:
1247
1263
  Increase::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol,
1264
+ scheme_fees:
1265
+ T::Array[
1266
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee
1267
+ ],
1248
1268
  terminal_id: T.nilable(String),
1249
1269
  verification:
1250
1270
  Increase::DeclinedTransaction::Source::CardDecline::Verification
@@ -3149,6 +3169,360 @@ module Increase
3149
3169
  end
3150
3170
  end
3151
3171
 
3172
+ class SchemeFee < Increase::Internal::Type::BaseModel
3173
+ OrHash =
3174
+ T.type_alias do
3175
+ T.any(
3176
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee,
3177
+ Increase::Internal::AnyHash
3178
+ )
3179
+ end
3180
+
3181
+ # The fee amount given as a string containing a decimal number.
3182
+ sig { returns(String) }
3183
+ attr_accessor :amount
3184
+
3185
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
3186
+ # created.
3187
+ sig { returns(Time) }
3188
+ attr_accessor :created_at
3189
+
3190
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3191
+ # reimbursement.
3192
+ sig do
3193
+ returns(
3194
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency::TaggedSymbol
3195
+ )
3196
+ end
3197
+ attr_accessor :currency
3198
+
3199
+ # The type of fee being assessed.
3200
+ sig do
3201
+ returns(
3202
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3203
+ )
3204
+ end
3205
+ attr_accessor :fee_type
3206
+
3207
+ # The fixed component of the fee, if applicable, given in major units of the fee
3208
+ # amount.
3209
+ sig { returns(T.nilable(String)) }
3210
+ attr_accessor :fixed_component
3211
+
3212
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
3213
+ # 0.015 for 1.5%).
3214
+ sig { returns(T.nilable(String)) }
3215
+ attr_accessor :variable_rate
3216
+
3217
+ sig do
3218
+ params(
3219
+ amount: String,
3220
+ created_at: Time,
3221
+ currency:
3222
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency::OrSymbol,
3223
+ fee_type:
3224
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::OrSymbol,
3225
+ fixed_component: T.nilable(String),
3226
+ variable_rate: T.nilable(String)
3227
+ ).returns(T.attached_class)
3228
+ end
3229
+ def self.new(
3230
+ # The fee amount given as a string containing a decimal number.
3231
+ amount:,
3232
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
3233
+ # created.
3234
+ created_at:,
3235
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3236
+ # reimbursement.
3237
+ currency:,
3238
+ # The type of fee being assessed.
3239
+ fee_type:,
3240
+ # The fixed component of the fee, if applicable, given in major units of the fee
3241
+ # amount.
3242
+ fixed_component:,
3243
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
3244
+ # 0.015 for 1.5%).
3245
+ variable_rate:
3246
+ )
3247
+ end
3248
+
3249
+ sig do
3250
+ override.returns(
3251
+ {
3252
+ amount: String,
3253
+ created_at: Time,
3254
+ currency:
3255
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency::TaggedSymbol,
3256
+ fee_type:
3257
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol,
3258
+ fixed_component: T.nilable(String),
3259
+ variable_rate: T.nilable(String)
3260
+ }
3261
+ )
3262
+ end
3263
+ def to_hash
3264
+ end
3265
+
3266
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3267
+ # reimbursement.
3268
+ module Currency
3269
+ extend Increase::Internal::Type::Enum
3270
+
3271
+ TaggedSymbol =
3272
+ T.type_alias do
3273
+ T.all(
3274
+ Symbol,
3275
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency
3276
+ )
3277
+ end
3278
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3279
+
3280
+ # US Dollar (USD)
3281
+ USD =
3282
+ T.let(
3283
+ :USD,
3284
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency::TaggedSymbol
3285
+ )
3286
+
3287
+ sig do
3288
+ override.returns(
3289
+ T::Array[
3290
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::Currency::TaggedSymbol
3291
+ ]
3292
+ )
3293
+ end
3294
+ def self.values
3295
+ end
3296
+ end
3297
+
3298
+ # The type of fee being assessed.
3299
+ module FeeType
3300
+ extend Increase::Internal::Type::Enum
3301
+
3302
+ TaggedSymbol =
3303
+ T.type_alias do
3304
+ T.all(
3305
+ Symbol,
3306
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType
3307
+ )
3308
+ end
3309
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3310
+
3311
+ # International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.
3312
+ VISA_INTERNATIONAL_SERVICE_ASSESSMENT_SINGLE_CURRENCY =
3313
+ T.let(
3314
+ :visa_international_service_assessment_single_currency,
3315
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3316
+ )
3317
+
3318
+ # International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.
3319
+ VISA_INTERNATIONAL_SERVICE_ASSESSMENT_CROSS_CURRENCY =
3320
+ T.let(
3321
+ :visa_international_service_assessment_cross_currency,
3322
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3323
+ )
3324
+
3325
+ # Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
3326
+ VISA_AUTHORIZATION_DOMESTIC_POINT_OF_SALE =
3327
+ T.let(
3328
+ :visa_authorization_domestic_point_of_sale,
3329
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3330
+ )
3331
+
3332
+ # Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
3333
+ VISA_AUTHORIZATION_INTERNATIONAL_POINT_OF_SALE =
3334
+ T.let(
3335
+ :visa_authorization_international_point_of_sale,
3336
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3337
+ )
3338
+
3339
+ # Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.
3340
+ VISA_AUTHORIZATION_CANADA_POINT_OF_SALE =
3341
+ T.let(
3342
+ :visa_authorization_canada_point_of_sale,
3343
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3344
+ )
3345
+
3346
+ # Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
3347
+ VISA_AUTHORIZATION_REVERSAL_POINT_OF_SALE =
3348
+ T.let(
3349
+ :visa_authorization_reversal_point_of_sale,
3350
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3351
+ )
3352
+
3353
+ # Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
3354
+ VISA_AUTHORIZATION_REVERSAL_INTERNATIONAL_POINT_OF_SALE =
3355
+ T.let(
3356
+ :visa_authorization_reversal_international_point_of_sale,
3357
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3358
+ )
3359
+
3360
+ # A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.
3361
+ VISA_AUTHORIZATION_ADDRESS_VERIFICATION_SERVICE =
3362
+ T.let(
3363
+ :visa_authorization_address_verification_service,
3364
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3365
+ )
3366
+
3367
+ # Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).
3368
+ VISA_ADVANCED_AUTHORIZATION =
3369
+ T.let(
3370
+ :visa_advanced_authorization,
3371
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3372
+ )
3373
+
3374
+ # Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.
3375
+ VISA_MESSAGE_TRANSMISSION =
3376
+ T.let(
3377
+ :visa_message_transmission,
3378
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3379
+ )
3380
+
3381
+ # Activity, per inquiry, related to the domestic Issuer for Account Number Verification.
3382
+ VISA_ACCOUNT_VERIFICATION_DOMESTIC =
3383
+ T.let(
3384
+ :visa_account_verification_domestic,
3385
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3386
+ )
3387
+
3388
+ # Activity, per inquiry, related to the international Issuer for Account Number Verification.
3389
+ VISA_ACCOUNT_VERIFICATION_INTERNATIONAL =
3390
+ T.let(
3391
+ :visa_account_verification_international,
3392
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3393
+ )
3394
+
3395
+ # Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.
3396
+ VISA_ACCOUNT_VERIFICATION_CANADA =
3397
+ T.let(
3398
+ :visa_account_verification_canada,
3399
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3400
+ )
3401
+
3402
+ # The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
3403
+ VISA_CORPORATE_ACCEPTANCE_FEE =
3404
+ T.let(
3405
+ :visa_corporate_acceptance_fee,
3406
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3407
+ )
3408
+
3409
+ # The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.
3410
+ VISA_CONSUMER_DEBIT_ACCEPTANCE_FEE =
3411
+ T.let(
3412
+ :visa_consumer_debit_acceptance_fee,
3413
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3414
+ )
3415
+
3416
+ # The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.
3417
+ VISA_BUSINESS_DEBIT_ACCEPTANCE_FEE =
3418
+ T.let(
3419
+ :visa_business_debit_acceptance_fee,
3420
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3421
+ )
3422
+
3423
+ # The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
3424
+ VISA_PURCHASING_ACCEPTANCE_FEE =
3425
+ T.let(
3426
+ :visa_purchasing_acceptance_fee,
3427
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3428
+ )
3429
+
3430
+ # Activity and fees for the processing of a sales draft original for a purchase transaction.
3431
+ VISA_PURCHASE_DOMESTIC =
3432
+ T.let(
3433
+ :visa_purchase_domestic,
3434
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3435
+ )
3436
+
3437
+ # Activity and fees for the processing of an international sales draft original for a purchase transaction.
3438
+ VISA_PURCHASE_INTERNATIONAL =
3439
+ T.let(
3440
+ :visa_purchase_international,
3441
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3442
+ )
3443
+
3444
+ # Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
3445
+ VISA_CREDIT_PURCHASE_TOKEN =
3446
+ T.let(
3447
+ :visa_credit_purchase_token,
3448
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3449
+ )
3450
+
3451
+ # Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
3452
+ VISA_DEBIT_PURCHASE_TOKEN =
3453
+ T.let(
3454
+ :visa_debit_purchase_token,
3455
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3456
+ )
3457
+
3458
+ # A per transaction fee assessed for Base II financial draft - Issuer.
3459
+ VISA_CLEARING_TRANSMISSION =
3460
+ T.let(
3461
+ :visa_clearing_transmission,
3462
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3463
+ )
3464
+
3465
+ # Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.
3466
+ VISA_DIRECT_AUTHORIZATION =
3467
+ T.let(
3468
+ :visa_direct_authorization,
3469
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3470
+ )
3471
+
3472
+ # Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.
3473
+ VISA_DIRECT_TRANSACTION_DOMESTIC =
3474
+ T.let(
3475
+ :visa_direct_transaction_domestic,
3476
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3477
+ )
3478
+
3479
+ # Issuer card service fee for Commercial Credit cards.
3480
+ VISA_SERVICE_COMMERCIAL_CREDIT =
3481
+ T.let(
3482
+ :visa_service_commercial_credit,
3483
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3484
+ )
3485
+
3486
+ # Issuer Advertising Service Fee for Commercial Credit cards.
3487
+ VISA_ADVERTISING_SERVICE_COMMERCIAL_CREDIT =
3488
+ T.let(
3489
+ :visa_advertising_service_commercial_credit,
3490
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3491
+ )
3492
+
3493
+ # Issuer Community Growth Acceleration Program Fee.
3494
+ VISA_COMMUNITY_GROWTH_ACCELERATION_PROGRAM =
3495
+ T.let(
3496
+ :visa_community_growth_acceleration_program,
3497
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3498
+ )
3499
+
3500
+ # Issuer Processing Guarantee for Commercial Credit cards.
3501
+ VISA_PROCESSING_GUARANTEE_COMMERCIAL_CREDIT =
3502
+ T.let(
3503
+ :visa_processing_guarantee_commercial_credit,
3504
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3505
+ )
3506
+
3507
+ # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
3508
+ PULSE_SWITCH_FEE =
3509
+ T.let(
3510
+ :pulse_switch_fee,
3511
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3512
+ )
3513
+
3514
+ sig do
3515
+ override.returns(
3516
+ T::Array[
3517
+ Increase::DeclinedTransaction::Source::CardDecline::SchemeFee::FeeType::TaggedSymbol
3518
+ ]
3519
+ )
3520
+ end
3521
+ def self.values
3522
+ end
3523
+ end
3524
+ end
3525
+
3152
3526
  class Verification < Increase::Internal::Type::BaseModel
3153
3527
  OrHash =
3154
3528
  T.type_alias do
@@ -3211,7 +3211,7 @@ module Increase
3211
3211
  end
3212
3212
  OrSymbol = T.type_alias { T.any(Symbol, String) }
3213
3213
 
3214
- # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.tax_identifier).
3214
+ # The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier).
3215
3215
  ENTITY_TAX_IDENTIFIER =
3216
3216
  T.let(
3217
3217
  :entity_tax_identifier,
@@ -213,6 +213,25 @@ module Increase
213
213
  sig { params(industry_code: String).void }
214
214
  attr_writer :industry_code
215
215
 
216
+ # The legal identifier of the corporation. This is usually the Employer
217
+ # Identification Number (EIN).
218
+ sig do
219
+ returns(
220
+ T.nilable(
221
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier
222
+ )
223
+ )
224
+ end
225
+ attr_reader :legal_identifier
226
+
227
+ sig do
228
+ params(
229
+ legal_identifier:
230
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::OrHash
231
+ ).void
232
+ end
233
+ attr_writer :legal_identifier
234
+
216
235
  # The legal name of the corporation.
217
236
  sig { returns(T.nilable(String)) }
218
237
  attr_reader :name
@@ -220,13 +239,6 @@ module Increase
220
239
  sig { params(name: String).void }
221
240
  attr_writer :name
222
241
 
223
- # The Employer Identification Number (EIN) for the corporation.
224
- sig { returns(T.nilable(String)) }
225
- attr_reader :tax_identifier
226
-
227
- sig { params(tax_identifier: String).void }
228
- attr_writer :tax_identifier
229
-
230
242
  # Details of the corporation entity to update. If you specify this parameter and
231
243
  # the entity is not a corporation, the request will fail.
232
244
  sig do
@@ -235,8 +247,9 @@ module Increase
235
247
  email: String,
236
248
  incorporation_state: String,
237
249
  industry_code: String,
238
- name: String,
239
- tax_identifier: String
250
+ legal_identifier:
251
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::OrHash,
252
+ name: String
240
253
  ).returns(T.attached_class)
241
254
  end
242
255
  def self.new(
@@ -254,10 +267,11 @@ module Increase
254
267
  # `Software Publishers`. A full list of classification codes is available
255
268
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
256
269
  industry_code: nil,
270
+ # The legal identifier of the corporation. This is usually the Employer
271
+ # Identification Number (EIN).
272
+ legal_identifier: nil,
257
273
  # The legal name of the corporation.
258
- name: nil,
259
- # The Employer Identification Number (EIN) for the corporation.
260
- tax_identifier: nil
274
+ name: nil
261
275
  )
262
276
  end
263
277
 
@@ -268,8 +282,9 @@ module Increase
268
282
  email: String,
269
283
  incorporation_state: String,
270
284
  industry_code: String,
271
- name: String,
272
- tax_identifier: String
285
+ legal_identifier:
286
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier,
287
+ name: String
273
288
  }
274
289
  )
275
290
  end
@@ -363,6 +378,105 @@ module Increase
363
378
  def to_hash
364
379
  end
365
380
  end
381
+
382
+ class LegalIdentifier < Increase::Internal::Type::BaseModel
383
+ OrHash =
384
+ T.type_alias do
385
+ T.any(
386
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier,
387
+ Increase::Internal::AnyHash
388
+ )
389
+ end
390
+
391
+ # The identifier of the legal identifier.
392
+ sig { returns(String) }
393
+ attr_accessor :value
394
+
395
+ # The category of the legal identifier.
396
+ sig do
397
+ returns(
398
+ T.nilable(
399
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
400
+ )
401
+ )
402
+ end
403
+ attr_reader :category
404
+
405
+ sig do
406
+ params(
407
+ category:
408
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
409
+ ).void
410
+ end
411
+ attr_writer :category
412
+
413
+ # The legal identifier of the corporation. This is usually the Employer
414
+ # Identification Number (EIN).
415
+ sig do
416
+ params(
417
+ value: String,
418
+ category:
419
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
420
+ ).returns(T.attached_class)
421
+ end
422
+ def self.new(
423
+ # The identifier of the legal identifier.
424
+ value:,
425
+ # The category of the legal identifier.
426
+ category: nil
427
+ )
428
+ end
429
+
430
+ sig do
431
+ override.returns(
432
+ {
433
+ value: String,
434
+ category:
435
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::OrSymbol
436
+ }
437
+ )
438
+ end
439
+ def to_hash
440
+ end
441
+
442
+ # The category of the legal identifier.
443
+ module Category
444
+ extend Increase::Internal::Type::Enum
445
+
446
+ TaggedSymbol =
447
+ T.type_alias do
448
+ T.all(
449
+ Symbol,
450
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category
451
+ )
452
+ end
453
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
454
+
455
+ # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
456
+ US_EMPLOYER_IDENTIFICATION_NUMBER =
457
+ T.let(
458
+ :us_employer_identification_number,
459
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
460
+ )
461
+
462
+ # A legal identifier issued by a foreign government, like a tax identification number or registration number.
463
+ OTHER =
464
+ T.let(
465
+ :other,
466
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
467
+ )
468
+
469
+ sig do
470
+ override.returns(
471
+ T::Array[
472
+ Increase::EntityUpdateParams::Corporation::LegalIdentifier::Category::TaggedSymbol
473
+ ]
474
+ )
475
+ end
476
+ def self.values
477
+ end
478
+ end
479
+ end
366
480
  end
367
481
 
368
482
  class GovernmentAuthority < Increase::Internal::Type::BaseModel