increase 1.274.0 → 1.276.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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/card_payment.rb +1847 -207
  5. data/lib/increase/models/declined_transaction.rb +183 -1
  6. data/lib/increase/models/event.rb +6 -0
  7. data/lib/increase/models/event_list_params.rb +6 -0
  8. data/lib/increase/models/event_subscription.rb +6 -0
  9. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  10. data/lib/increase/models/pending_transaction.rb +185 -1
  11. data/lib/increase/models/transaction.rb +548 -3
  12. data/lib/increase/models/unwrap_webhook_event.rb +6 -0
  13. data/lib/increase/version.rb +1 -1
  14. data/rbi/increase/models/card_payment.rbi +3985 -595
  15. data/rbi/increase/models/declined_transaction.rbi +374 -0
  16. data/rbi/increase/models/event.rbi +14 -0
  17. data/rbi/increase/models/event_list_params.rbi +14 -0
  18. data/rbi/increase/models/event_subscription.rbi +14 -0
  19. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  20. data/rbi/increase/models/pending_transaction.rbi +374 -0
  21. data/rbi/increase/models/transaction.rbi +1157 -41
  22. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  23. data/sig/increase/models/card_payment.rbs +1912 -274
  24. data/sig/increase/models/declined_transaction.rbs +182 -0
  25. data/sig/increase/models/event.rbs +8 -0
  26. data/sig/increase/models/event_list_params.rbs +8 -0
  27. data/sig/increase/models/event_subscription.rbs +8 -0
  28. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  29. data/sig/increase/models/pending_transaction.rbs +182 -0
  30. data/sig/increase/models/transaction.rbs +546 -0
  31. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  32. metadata +2 -2
@@ -1304,6 +1304,16 @@ module Increase
1304
1304
  sig { returns(T.nilable(String)) }
1305
1305
  attr_accessor :real_time_decision_id
1306
1306
 
1307
+ # The scheme fees associated with this card authorization.
1308
+ sig do
1309
+ returns(
1310
+ T::Array[
1311
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee
1312
+ ]
1313
+ )
1314
+ end
1315
+ attr_accessor :scheme_fees
1316
+
1307
1317
  # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1308
1318
  # is transacting with.
1309
1319
  sig { returns(T.nilable(String)) }
@@ -1372,6 +1382,10 @@ module Increase
1372
1382
  processing_category:
1373
1383
  Increase::PendingTransaction::Source::CardAuthorization::ProcessingCategory::OrSymbol,
1374
1384
  real_time_decision_id: T.nilable(String),
1385
+ scheme_fees:
1386
+ T::Array[
1387
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::OrHash
1388
+ ],
1375
1389
  terminal_id: T.nilable(String),
1376
1390
  type:
1377
1391
  Increase::PendingTransaction::Source::CardAuthorization::Type::OrSymbol,
@@ -1447,6 +1461,8 @@ module Increase
1447
1461
  # The identifier of the Real-Time Decision sent to approve or decline this
1448
1462
  # transaction.
1449
1463
  real_time_decision_id:,
1464
+ # The scheme fees associated with this card authorization.
1465
+ scheme_fees:,
1450
1466
  # The terminal identifier (commonly abbreviated as TID) of the terminal the card
1451
1467
  # is transacting with.
1452
1468
  terminal_id:,
@@ -1493,6 +1509,10 @@ module Increase
1493
1509
  processing_category:
1494
1510
  Increase::PendingTransaction::Source::CardAuthorization::ProcessingCategory::TaggedSymbol,
1495
1511
  real_time_decision_id: T.nilable(String),
1512
+ scheme_fees:
1513
+ T::Array[
1514
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee
1515
+ ],
1496
1516
  terminal_id: T.nilable(String),
1497
1517
  type:
1498
1518
  Increase::PendingTransaction::Source::CardAuthorization::Type::TaggedSymbol,
@@ -3161,6 +3181,360 @@ module Increase
3161
3181
  end
3162
3182
  end
3163
3183
 
3184
+ class SchemeFee < Increase::Internal::Type::BaseModel
3185
+ OrHash =
3186
+ T.type_alias do
3187
+ T.any(
3188
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee,
3189
+ Increase::Internal::AnyHash
3190
+ )
3191
+ end
3192
+
3193
+ # The fee amount given as a string containing a decimal number.
3194
+ sig { returns(String) }
3195
+ attr_accessor :amount
3196
+
3197
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
3198
+ # created.
3199
+ sig { returns(Time) }
3200
+ attr_accessor :created_at
3201
+
3202
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3203
+ # reimbursement.
3204
+ sig do
3205
+ returns(
3206
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency::TaggedSymbol
3207
+ )
3208
+ end
3209
+ attr_accessor :currency
3210
+
3211
+ # The type of fee being assessed.
3212
+ sig do
3213
+ returns(
3214
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3215
+ )
3216
+ end
3217
+ attr_accessor :fee_type
3218
+
3219
+ # The fixed component of the fee, if applicable, given in major units of the fee
3220
+ # amount.
3221
+ sig { returns(T.nilable(String)) }
3222
+ attr_accessor :fixed_component
3223
+
3224
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
3225
+ # 0.015 for 1.5%).
3226
+ sig { returns(T.nilable(String)) }
3227
+ attr_accessor :variable_rate
3228
+
3229
+ sig do
3230
+ params(
3231
+ amount: String,
3232
+ created_at: Time,
3233
+ currency:
3234
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency::OrSymbol,
3235
+ fee_type:
3236
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::OrSymbol,
3237
+ fixed_component: T.nilable(String),
3238
+ variable_rate: T.nilable(String)
3239
+ ).returns(T.attached_class)
3240
+ end
3241
+ def self.new(
3242
+ # The fee amount given as a string containing a decimal number.
3243
+ amount:,
3244
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
3245
+ # created.
3246
+ created_at:,
3247
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3248
+ # reimbursement.
3249
+ currency:,
3250
+ # The type of fee being assessed.
3251
+ fee_type:,
3252
+ # The fixed component of the fee, if applicable, given in major units of the fee
3253
+ # amount.
3254
+ fixed_component:,
3255
+ # The variable rate component of the fee, if applicable, given as a decimal (e.g.,
3256
+ # 0.015 for 1.5%).
3257
+ variable_rate:
3258
+ )
3259
+ end
3260
+
3261
+ sig do
3262
+ override.returns(
3263
+ {
3264
+ amount: String,
3265
+ created_at: Time,
3266
+ currency:
3267
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency::TaggedSymbol,
3268
+ fee_type:
3269
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol,
3270
+ fixed_component: T.nilable(String),
3271
+ variable_rate: T.nilable(String)
3272
+ }
3273
+ )
3274
+ end
3275
+ def to_hash
3276
+ end
3277
+
3278
+ # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
3279
+ # reimbursement.
3280
+ module Currency
3281
+ extend Increase::Internal::Type::Enum
3282
+
3283
+ TaggedSymbol =
3284
+ T.type_alias do
3285
+ T.all(
3286
+ Symbol,
3287
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency
3288
+ )
3289
+ end
3290
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3291
+
3292
+ # US Dollar (USD)
3293
+ USD =
3294
+ T.let(
3295
+ :USD,
3296
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency::TaggedSymbol
3297
+ )
3298
+
3299
+ sig do
3300
+ override.returns(
3301
+ T::Array[
3302
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::Currency::TaggedSymbol
3303
+ ]
3304
+ )
3305
+ end
3306
+ def self.values
3307
+ end
3308
+ end
3309
+
3310
+ # The type of fee being assessed.
3311
+ module FeeType
3312
+ extend Increase::Internal::Type::Enum
3313
+
3314
+ TaggedSymbol =
3315
+ T.type_alias do
3316
+ T.all(
3317
+ Symbol,
3318
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType
3319
+ )
3320
+ end
3321
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3322
+
3323
+ # 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.
3324
+ VISA_INTERNATIONAL_SERVICE_ASSESSMENT_SINGLE_CURRENCY =
3325
+ T.let(
3326
+ :visa_international_service_assessment_single_currency,
3327
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3328
+ )
3329
+
3330
+ # International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.
3331
+ VISA_INTERNATIONAL_SERVICE_ASSESSMENT_CROSS_CURRENCY =
3332
+ T.let(
3333
+ :visa_international_service_assessment_cross_currency,
3334
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3335
+ )
3336
+
3337
+ # 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.
3338
+ VISA_AUTHORIZATION_DOMESTIC_POINT_OF_SALE =
3339
+ T.let(
3340
+ :visa_authorization_domestic_point_of_sale,
3341
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3342
+ )
3343
+
3344
+ # 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.
3345
+ VISA_AUTHORIZATION_INTERNATIONAL_POINT_OF_SALE =
3346
+ T.let(
3347
+ :visa_authorization_international_point_of_sale,
3348
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3349
+ )
3350
+
3351
+ # 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.
3352
+ VISA_AUTHORIZATION_CANADA_POINT_OF_SALE =
3353
+ T.let(
3354
+ :visa_authorization_canada_point_of_sale,
3355
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3356
+ )
3357
+
3358
+ # 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.
3359
+ VISA_AUTHORIZATION_REVERSAL_POINT_OF_SALE =
3360
+ T.let(
3361
+ :visa_authorization_reversal_point_of_sale,
3362
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3363
+ )
3364
+
3365
+ # 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.
3366
+ VISA_AUTHORIZATION_REVERSAL_INTERNATIONAL_POINT_OF_SALE =
3367
+ T.let(
3368
+ :visa_authorization_reversal_international_point_of_sale,
3369
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3370
+ )
3371
+
3372
+ # A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.
3373
+ VISA_AUTHORIZATION_ADDRESS_VERIFICATION_SERVICE =
3374
+ T.let(
3375
+ :visa_authorization_address_verification_service,
3376
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3377
+ )
3378
+
3379
+ # 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).
3380
+ VISA_ADVANCED_AUTHORIZATION =
3381
+ T.let(
3382
+ :visa_advanced_authorization,
3383
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3384
+ )
3385
+
3386
+ # 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.
3387
+ VISA_MESSAGE_TRANSMISSION =
3388
+ T.let(
3389
+ :visa_message_transmission,
3390
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3391
+ )
3392
+
3393
+ # Activity, per inquiry, related to the domestic Issuer for Account Number Verification.
3394
+ VISA_ACCOUNT_VERIFICATION_DOMESTIC =
3395
+ T.let(
3396
+ :visa_account_verification_domestic,
3397
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3398
+ )
3399
+
3400
+ # Activity, per inquiry, related to the international Issuer for Account Number Verification.
3401
+ VISA_ACCOUNT_VERIFICATION_INTERNATIONAL =
3402
+ T.let(
3403
+ :visa_account_verification_international,
3404
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3405
+ )
3406
+
3407
+ # Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.
3408
+ VISA_ACCOUNT_VERIFICATION_CANADA =
3409
+ T.let(
3410
+ :visa_account_verification_canada,
3411
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3412
+ )
3413
+
3414
+ # 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.
3415
+ VISA_CORPORATE_ACCEPTANCE_FEE =
3416
+ T.let(
3417
+ :visa_corporate_acceptance_fee,
3418
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3419
+ )
3420
+
3421
+ # 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.
3422
+ VISA_CONSUMER_DEBIT_ACCEPTANCE_FEE =
3423
+ T.let(
3424
+ :visa_consumer_debit_acceptance_fee,
3425
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3426
+ )
3427
+
3428
+ # 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.
3429
+ VISA_BUSINESS_DEBIT_ACCEPTANCE_FEE =
3430
+ T.let(
3431
+ :visa_business_debit_acceptance_fee,
3432
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3433
+ )
3434
+
3435
+ # 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.
3436
+ VISA_PURCHASING_ACCEPTANCE_FEE =
3437
+ T.let(
3438
+ :visa_purchasing_acceptance_fee,
3439
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3440
+ )
3441
+
3442
+ # Activity and fees for the processing of a sales draft original for a purchase transaction.
3443
+ VISA_PURCHASE_DOMESTIC =
3444
+ T.let(
3445
+ :visa_purchase_domestic,
3446
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3447
+ )
3448
+
3449
+ # Activity and fees for the processing of an international sales draft original for a purchase transaction.
3450
+ VISA_PURCHASE_INTERNATIONAL =
3451
+ T.let(
3452
+ :visa_purchase_international,
3453
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3454
+ )
3455
+
3456
+ # Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
3457
+ VISA_CREDIT_PURCHASE_TOKEN =
3458
+ T.let(
3459
+ :visa_credit_purchase_token,
3460
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3461
+ )
3462
+
3463
+ # Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
3464
+ VISA_DEBIT_PURCHASE_TOKEN =
3465
+ T.let(
3466
+ :visa_debit_purchase_token,
3467
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3468
+ )
3469
+
3470
+ # A per transaction fee assessed for Base II financial draft - Issuer.
3471
+ VISA_CLEARING_TRANSMISSION =
3472
+ T.let(
3473
+ :visa_clearing_transmission,
3474
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3475
+ )
3476
+
3477
+ # Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.
3478
+ VISA_DIRECT_AUTHORIZATION =
3479
+ T.let(
3480
+ :visa_direct_authorization,
3481
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3482
+ )
3483
+
3484
+ # Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.
3485
+ VISA_DIRECT_TRANSACTION_DOMESTIC =
3486
+ T.let(
3487
+ :visa_direct_transaction_domestic,
3488
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3489
+ )
3490
+
3491
+ # Issuer card service fee for Commercial Credit cards.
3492
+ VISA_SERVICE_COMMERCIAL_CREDIT =
3493
+ T.let(
3494
+ :visa_service_commercial_credit,
3495
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3496
+ )
3497
+
3498
+ # Issuer Advertising Service Fee for Commercial Credit cards.
3499
+ VISA_ADVERTISING_SERVICE_COMMERCIAL_CREDIT =
3500
+ T.let(
3501
+ :visa_advertising_service_commercial_credit,
3502
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3503
+ )
3504
+
3505
+ # Issuer Community Growth Acceleration Program Fee.
3506
+ VISA_COMMUNITY_GROWTH_ACCELERATION_PROGRAM =
3507
+ T.let(
3508
+ :visa_community_growth_acceleration_program,
3509
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3510
+ )
3511
+
3512
+ # Issuer Processing Guarantee for Commercial Credit cards.
3513
+ VISA_PROCESSING_GUARANTEE_COMMERCIAL_CREDIT =
3514
+ T.let(
3515
+ :visa_processing_guarantee_commercial_credit,
3516
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3517
+ )
3518
+
3519
+ # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
3520
+ PULSE_SWITCH_FEE =
3521
+ T.let(
3522
+ :pulse_switch_fee,
3523
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3524
+ )
3525
+
3526
+ sig do
3527
+ override.returns(
3528
+ T::Array[
3529
+ Increase::PendingTransaction::Source::CardAuthorization::SchemeFee::FeeType::TaggedSymbol
3530
+ ]
3531
+ )
3532
+ end
3533
+ def self.values
3534
+ end
3535
+ end
3536
+ end
3537
+
3164
3538
  # A constant representing the object's type. For this resource it will always be
3165
3539
  # `card_authorization`.
3166
3540
  module Type