increase 1.203.0 → 1.205.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 (53) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/account_transfer.rb +25 -25
  5. data/lib/increase/models/ach_prenotification.rb +8 -8
  6. data/lib/increase/models/ach_transfer.rb +36 -36
  7. data/lib/increase/models/card_dispute.rb +79 -79
  8. data/lib/increase/models/card_payment.rb +82 -82
  9. data/lib/increase/models/card_push_transfer.rb +25 -25
  10. data/lib/increase/models/card_validation.rb +25 -25
  11. data/lib/increase/models/check_transfer.rb +25 -25
  12. data/lib/increase/models/declined_transaction.rb +53 -53
  13. data/lib/increase/models/fednow_transfer.rb +25 -25
  14. data/lib/increase/models/pending_transaction.rb +85 -85
  15. data/lib/increase/models/real_time_payments_transfer.rb +25 -25
  16. data/lib/increase/models/simulations/ach_transfer_return_params.rb +8 -8
  17. data/lib/increase/models/swift_transfer.rb +25 -25
  18. data/lib/increase/models/transaction.rb +181 -181
  19. data/lib/increase/models/wire_transfer.rb +28 -28
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/account_transfer.rbi +40 -40
  22. data/rbi/increase/models/ach_prenotification.rbi +8 -8
  23. data/rbi/increase/models/ach_transfer.rbi +50 -50
  24. data/rbi/increase/models/card_dispute.rbi +141 -141
  25. data/rbi/increase/models/card_payment.rbi +144 -144
  26. data/rbi/increase/models/card_push_transfer.rbi +40 -40
  27. data/rbi/increase/models/card_validation.rbi +40 -40
  28. data/rbi/increase/models/check_transfer.rbi +40 -40
  29. data/rbi/increase/models/declined_transaction.rbi +99 -99
  30. data/rbi/increase/models/fednow_transfer.rbi +40 -40
  31. data/rbi/increase/models/pending_transaction.rbi +163 -163
  32. data/rbi/increase/models/real_time_payments_transfer.rbi +44 -44
  33. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +8 -8
  34. data/rbi/increase/models/swift_transfer.rbi +40 -40
  35. data/rbi/increase/models/transaction.rbi +542 -542
  36. data/rbi/increase/models/wire_transfer.rbi +42 -42
  37. data/sig/increase/models/account_transfer.rbs +17 -17
  38. data/sig/increase/models/ach_prenotification.rbs +8 -8
  39. data/sig/increase/models/ach_transfer.rbs +27 -27
  40. data/sig/increase/models/card_dispute.rbs +56 -56
  41. data/sig/increase/models/card_payment.rbs +81 -81
  42. data/sig/increase/models/card_push_transfer.rbs +17 -17
  43. data/sig/increase/models/card_validation.rbs +17 -17
  44. data/sig/increase/models/check_transfer.rbs +17 -17
  45. data/sig/increase/models/declined_transaction.rbs +52 -52
  46. data/sig/increase/models/fednow_transfer.rbs +17 -17
  47. data/sig/increase/models/pending_transaction.rbs +92 -92
  48. data/sig/increase/models/real_time_payments_transfer.rbs +17 -17
  49. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -8
  50. data/sig/increase/models/swift_transfer.rbs +17 -17
  51. data/sig/increase/models/transaction.rbs +210 -210
  52. data/sig/increase/models/wire_transfer.rbs +19 -19
  53. metadata +2 -2
@@ -294,6 +294,19 @@ module Increase
294
294
  # @return [Symbol, Increase::Models::CardDispute::Visa::NetworkEvent::Category]
295
295
  required :category, enum: -> { Increase::CardDispute::Visa::NetworkEvent::Category }
296
296
 
297
+ # @!attribute created_at
298
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
299
+ # the Visa Card Dispute Network Event was created.
300
+ #
301
+ # @return [Time]
302
+ required :created_at, Time
303
+
304
+ # @!attribute dispute_financial_transaction_id
305
+ # The dispute financial transaction that resulted from the network event, if any.
306
+ #
307
+ # @return [String, nil]
308
+ required :dispute_financial_transaction_id, String, nil?: true
309
+
297
310
  # @!attribute chargeback_accepted
298
311
  # A Card Dispute Chargeback Accepted Visa Network Event object. This field will be
299
312
  # present in the JSON response if and only if `category` is equal to
@@ -302,7 +315,7 @@ module Increase
302
315
  # accepted by the merchant.
303
316
  #
304
317
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackAccepted, nil]
305
- required :chargeback_accepted,
318
+ optional :chargeback_accepted,
306
319
  -> { Increase::CardDispute::Visa::NetworkEvent::ChargebackAccepted },
307
320
  nil?: true
308
321
 
@@ -314,7 +327,7 @@ module Increase
314
327
  # submitted to the network.
315
328
  #
316
329
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackSubmitted, nil]
317
- required :chargeback_submitted,
330
+ optional :chargeback_submitted,
318
331
  -> { Increase::CardDispute::Visa::NetworkEvent::ChargebackSubmitted },
319
332
  nil?: true
320
333
 
@@ -326,23 +339,10 @@ module Increase
326
339
  # out in the user's favor.
327
340
  #
328
341
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackTimedOut, nil]
329
- required :chargeback_timed_out,
342
+ optional :chargeback_timed_out,
330
343
  -> { Increase::CardDispute::Visa::NetworkEvent::ChargebackTimedOut },
331
344
  nil?: true
332
345
 
333
- # @!attribute created_at
334
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
335
- # the Visa Card Dispute Network Event was created.
336
- #
337
- # @return [Time]
338
- required :created_at, Time
339
-
340
- # @!attribute dispute_financial_transaction_id
341
- # The dispute financial transaction that resulted from the network event, if any.
342
- #
343
- # @return [String, nil]
344
- required :dispute_financial_transaction_id, String, nil?: true
345
-
346
346
  # @!attribute merchant_prearbitration_decline_submitted
347
347
  # A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event
348
348
  # object. This field will be present in the JSON response if and only if
@@ -352,7 +352,7 @@ module Increase
352
352
  # merchant's request for a prearbitration request decision in their favor.
353
353
  #
354
354
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationDeclineSubmitted, nil]
355
- required :merchant_prearbitration_decline_submitted,
355
+ optional :merchant_prearbitration_decline_submitted,
356
356
  -> { Increase::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationDeclineSubmitted },
357
357
  nil?: true
358
358
 
@@ -364,7 +364,7 @@ module Increase
364
364
  # the merchant has issued a prearbitration request in the user's favor.
365
365
  #
366
366
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationReceived, nil]
367
- required :merchant_prearbitration_received,
367
+ optional :merchant_prearbitration_received,
368
368
  -> { Increase::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationReceived },
369
369
  nil?: true
370
370
 
@@ -377,7 +377,7 @@ module Increase
377
377
  # prearbitration request.
378
378
  #
379
379
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationTimedOut, nil]
380
- required :merchant_prearbitration_timed_out,
380
+ optional :merchant_prearbitration_timed_out,
381
381
  -> { Increase::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationTimedOut },
382
382
  nil?: true
383
383
 
@@ -389,7 +389,7 @@ module Increase
389
389
  # chargeback and has re-presented the payment.
390
390
  #
391
391
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::Represented, nil]
392
- required :represented, -> { Increase::CardDispute::Visa::NetworkEvent::Represented }, nil?: true
392
+ optional :represented, -> { Increase::CardDispute::Visa::NetworkEvent::Represented }, nil?: true
393
393
 
394
394
  # @!attribute representment_timed_out
395
395
  # A Card Dispute Re-presentment Timed Out Visa Network Event object. This field
@@ -399,7 +399,7 @@ module Increase
399
399
  # respond to the re-presentment by the merchant within the time limit.
400
400
  #
401
401
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::RepresentmentTimedOut, nil]
402
- required :representment_timed_out,
402
+ optional :representment_timed_out,
403
403
  -> { Increase::CardDispute::Visa::NetworkEvent::RepresentmentTimedOut },
404
404
  nil?: true
405
405
 
@@ -411,7 +411,7 @@ module Increase
411
411
  # the merchant has accepted the user's prearbitration request in the user's favor.
412
412
  #
413
413
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::UserPrearbitrationAccepted, nil]
414
- required :user_prearbitration_accepted,
414
+ optional :user_prearbitration_accepted,
415
415
  -> { Increase::CardDispute::Visa::NetworkEvent::UserPrearbitrationAccepted },
416
416
  nil?: true
417
417
 
@@ -423,7 +423,7 @@ module Increase
423
423
  # the merchant has declined the user's prearbitration request.
424
424
  #
425
425
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::UserPrearbitrationDeclined, nil]
426
- required :user_prearbitration_declined,
426
+ optional :user_prearbitration_declined,
427
427
  -> { Increase::CardDispute::Visa::NetworkEvent::UserPrearbitrationDeclined },
428
428
  nil?: true
429
429
 
@@ -435,7 +435,7 @@ module Increase
435
435
  # the user's request for prearbitration has been submitted to the network.
436
436
  #
437
437
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::UserPrearbitrationSubmitted, nil]
438
- required :user_prearbitration_submitted,
438
+ optional :user_prearbitration_submitted,
439
439
  -> { Increase::CardDispute::Visa::NetworkEvent::UserPrearbitrationSubmitted },
440
440
  nil?: true
441
441
 
@@ -447,7 +447,7 @@ module Increase
447
447
  # the merchant has timed out responding to the user's prearbitration request.
448
448
  #
449
449
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::UserPrearbitrationTimedOut, nil]
450
- required :user_prearbitration_timed_out,
450
+ optional :user_prearbitration_timed_out,
451
451
  -> { Increase::CardDispute::Visa::NetworkEvent::UserPrearbitrationTimedOut },
452
452
  nil?: true
453
453
 
@@ -459,11 +459,11 @@ module Increase
459
459
  # request to withdraw the dispute has been submitted to the network.
460
460
  #
461
461
  # @return [Increase::Models::CardDispute::Visa::NetworkEvent::UserWithdrawalSubmitted, nil]
462
- required :user_withdrawal_submitted,
462
+ optional :user_withdrawal_submitted,
463
463
  -> { Increase::CardDispute::Visa::NetworkEvent::UserWithdrawalSubmitted },
464
464
  nil?: true
465
465
 
466
- # @!method initialize(attachment_files:, category:, chargeback_accepted:, chargeback_submitted:, chargeback_timed_out:, created_at:, dispute_financial_transaction_id:, merchant_prearbitration_decline_submitted:, merchant_prearbitration_received:, merchant_prearbitration_timed_out:, represented:, representment_timed_out:, user_prearbitration_accepted:, user_prearbitration_declined:, user_prearbitration_submitted:, user_prearbitration_timed_out:, user_withdrawal_submitted:)
466
+ # @!method initialize(attachment_files:, category:, created_at:, dispute_financial_transaction_id:, chargeback_accepted: nil, chargeback_submitted: nil, chargeback_timed_out: nil, merchant_prearbitration_decline_submitted: nil, merchant_prearbitration_received: nil, merchant_prearbitration_timed_out: nil, represented: nil, representment_timed_out: nil, user_prearbitration_accepted: nil, user_prearbitration_declined: nil, user_prearbitration_submitted: nil, user_prearbitration_timed_out: nil, user_withdrawal_submitted: nil)
467
467
  # Some parameter documentations has been truncated, see
468
468
  # {Increase::Models::CardDispute::Visa::NetworkEvent} for more details.
469
469
  #
@@ -471,16 +471,16 @@ module Increase
471
471
  #
472
472
  # @param category [Symbol, Increase::Models::CardDispute::Visa::NetworkEvent::Category] The category of the user submission. We may add additional possible values for t
473
473
  #
474
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
475
+ #
476
+ # @param dispute_financial_transaction_id [String, nil] The dispute financial transaction that resulted from the network event, if any.
477
+ #
474
478
  # @param chargeback_accepted [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackAccepted, nil] A Card Dispute Chargeback Accepted Visa Network Event object. This field will be
475
479
  #
476
480
  # @param chargeback_submitted [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackSubmitted, nil] A Card Dispute Chargeback Submitted Visa Network Event object. This field will b
477
481
  #
478
482
  # @param chargeback_timed_out [Increase::Models::CardDispute::Visa::NetworkEvent::ChargebackTimedOut, nil] A Card Dispute Chargeback Timed Out Visa Network Event object. This field will b
479
483
  #
480
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
481
- #
482
- # @param dispute_financial_transaction_id [String, nil] The dispute financial transaction that resulted from the network event, if any.
483
- #
484
484
  # @param merchant_prearbitration_decline_submitted [Increase::Models::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationDeclineSubmitted, nil] A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event obj
485
485
  #
486
486
  # @param merchant_prearbitration_received [Increase::Models::CardDispute::Visa::NetworkEvent::MerchantPrearbitrationReceived, nil] A Card Dispute Merchant Pre-Arbitration Received Visa Network Event object. This
@@ -1569,15 +1569,6 @@ module Increase
1569
1569
  # @return [Symbol, Increase::Models::CardDispute::Visa::UserSubmission::Category]
1570
1570
  required :category, enum: -> { Increase::CardDispute::Visa::UserSubmission::Category }
1571
1571
 
1572
- # @!attribute chargeback
1573
- # A Visa Card Dispute Chargeback User Submission Chargeback Details object. This
1574
- # field will be present in the JSON response if and only if `category` is equal to
1575
- # `chargeback`. Contains the details specific to a Visa chargeback User Submission
1576
- # for a Card Dispute.
1577
- #
1578
- # @return [Increase::Models::CardDispute::Visa::UserSubmission::Chargeback, nil]
1579
- required :chargeback, -> { Increase::CardDispute::Visa::UserSubmission::Chargeback }, nil?: true
1580
-
1581
1572
  # @!attribute created_at
1582
1573
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
1583
1574
  # the Visa Card Dispute User Submission was created.
@@ -1606,17 +1597,6 @@ module Increase
1606
1597
  # @return [String, nil]
1607
1598
  required :further_information_requested_reason, String, nil?: true
1608
1599
 
1609
- # @!attribute merchant_prearbitration_decline
1610
- # A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object.
1611
- # This field will be present in the JSON response if and only if `category` is
1612
- # equal to `merchant_prearbitration_decline`. Contains the details specific to a
1613
- # merchant prearbitration decline Visa Card Dispute User Submission.
1614
- #
1615
- # @return [Increase::Models::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline, nil]
1616
- required :merchant_prearbitration_decline,
1617
- -> { Increase::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline },
1618
- nil?: true
1619
-
1620
1600
  # @!attribute status
1621
1601
  # The status of the Visa Card Dispute User Submission.
1622
1602
  #
@@ -1630,6 +1610,26 @@ module Increase
1630
1610
  # @return [Time]
1631
1611
  required :updated_at, Time
1632
1612
 
1613
+ # @!attribute chargeback
1614
+ # A Visa Card Dispute Chargeback User Submission Chargeback Details object. This
1615
+ # field will be present in the JSON response if and only if `category` is equal to
1616
+ # `chargeback`. Contains the details specific to a Visa chargeback User Submission
1617
+ # for a Card Dispute.
1618
+ #
1619
+ # @return [Increase::Models::CardDispute::Visa::UserSubmission::Chargeback, nil]
1620
+ optional :chargeback, -> { Increase::CardDispute::Visa::UserSubmission::Chargeback }, nil?: true
1621
+
1622
+ # @!attribute merchant_prearbitration_decline
1623
+ # A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object.
1624
+ # This field will be present in the JSON response if and only if `category` is
1625
+ # equal to `merchant_prearbitration_decline`. Contains the details specific to a
1626
+ # merchant prearbitration decline Visa Card Dispute User Submission.
1627
+ #
1628
+ # @return [Increase::Models::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline, nil]
1629
+ optional :merchant_prearbitration_decline,
1630
+ -> { Increase::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline },
1631
+ nil?: true
1632
+
1633
1633
  # @!attribute user_prearbitration
1634
1634
  # A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This
1635
1635
  # field will be present in the JSON response if and only if `category` is equal to
@@ -1637,11 +1637,11 @@ module Increase
1637
1637
  # pre-arbitration Visa Card Dispute User Submission.
1638
1638
  #
1639
1639
  # @return [Increase::Models::CardDispute::Visa::UserSubmission::UserPrearbitration, nil]
1640
- required :user_prearbitration,
1640
+ optional :user_prearbitration,
1641
1641
  -> { Increase::CardDispute::Visa::UserSubmission::UserPrearbitration },
1642
1642
  nil?: true
1643
1643
 
1644
- # @!method initialize(accepted_at:, amount:, attachment_files:, category:, chargeback:, created_at:, explanation:, further_information_requested_at:, further_information_requested_reason:, merchant_prearbitration_decline:, status:, updated_at:, user_prearbitration:)
1644
+ # @!method initialize(accepted_at:, amount:, attachment_files:, category:, created_at:, explanation:, further_information_requested_at:, further_information_requested_reason:, status:, updated_at:, chargeback: nil, merchant_prearbitration_decline: nil, user_prearbitration: nil)
1645
1645
  # Some parameter documentations has been truncated, see
1646
1646
  # {Increase::Models::CardDispute::Visa::UserSubmission} for more details.
1647
1647
  #
@@ -1653,8 +1653,6 @@ module Increase
1653
1653
  #
1654
1654
  # @param category [Symbol, Increase::Models::CardDispute::Visa::UserSubmission::Category] The category of the user submission. We may add additional possible values for t
1655
1655
  #
1656
- # @param chargeback [Increase::Models::CardDispute::Visa::UserSubmission::Chargeback, nil] A Visa Card Dispute Chargeback User Submission Chargeback Details object. This f
1657
- #
1658
1656
  # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1659
1657
  #
1660
1658
  # @param explanation [String, nil] The free-form explanation provided to Increase to provide more context for the u
@@ -1663,12 +1661,14 @@ module Increase
1663
1661
  #
1664
1662
  # @param further_information_requested_reason [String, nil] The reason for Increase requesting further information from the user for the Vis
1665
1663
  #
1666
- # @param merchant_prearbitration_decline [Increase::Models::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline, nil] A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object. Thi
1667
- #
1668
1664
  # @param status [Symbol, Increase::Models::CardDispute::Visa::UserSubmission::Status] The status of the Visa Card Dispute User Submission.
1669
1665
  #
1670
1666
  # @param updated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
1671
1667
  #
1668
+ # @param chargeback [Increase::Models::CardDispute::Visa::UserSubmission::Chargeback, nil] A Visa Card Dispute Chargeback User Submission Chargeback Details object. This f
1669
+ #
1670
+ # @param merchant_prearbitration_decline [Increase::Models::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline, nil] A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object. Thi
1671
+ #
1672
1672
  # @param user_prearbitration [Increase::Models::CardDispute::Visa::UserSubmission::UserPrearbitration, nil] A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This
1673
1673
 
1674
1674
  class AttachmentFile < Increase::Internal::Type::BaseModel
@@ -1703,6 +1703,28 @@ module Increase
1703
1703
  # @return [Array<Symbol>]
1704
1704
  end
1705
1705
 
1706
+ # The status of the Visa Card Dispute User Submission.
1707
+ #
1708
+ # @see Increase::Models::CardDispute::Visa::UserSubmission#status
1709
+ module Status
1710
+ extend Increase::Internal::Type::Enum
1711
+
1712
+ # The User Submission was abandoned.
1713
+ ABANDONED = :abandoned
1714
+
1715
+ # The User Submission was accepted.
1716
+ ACCEPTED = :accepted
1717
+
1718
+ # Further information is requested, please resubmit with the requested information.
1719
+ FURTHER_INFORMATION_REQUESTED = :further_information_requested
1720
+
1721
+ # The User Submission is pending review.
1722
+ PENDING_REVIEWING = :pending_reviewing
1723
+
1724
+ # @!method self.values
1725
+ # @return [Array<Symbol>]
1726
+ end
1727
+
1706
1728
  # @see Increase::Models::CardDispute::Visa::UserSubmission#chargeback
1707
1729
  class Chargeback < Increase::Internal::Type::BaseModel
1708
1730
  # @!attribute authorization
@@ -5131,28 +5153,6 @@ module Increase
5131
5153
  # @param reason [String] The reason the user declined the merchant's request for pre-arbitration in their
5132
5154
  end
5133
5155
 
5134
- # The status of the Visa Card Dispute User Submission.
5135
- #
5136
- # @see Increase::Models::CardDispute::Visa::UserSubmission#status
5137
- module Status
5138
- extend Increase::Internal::Type::Enum
5139
-
5140
- # The User Submission was abandoned.
5141
- ABANDONED = :abandoned
5142
-
5143
- # The User Submission was accepted.
5144
- ACCEPTED = :accepted
5145
-
5146
- # Further information is requested, please resubmit with the requested information.
5147
- FURTHER_INFORMATION_REQUESTED = :further_information_requested
5148
-
5149
- # The User Submission is pending review.
5150
- PENDING_REVIEWING = :pending_reviewing
5151
-
5152
- # @!method self.values
5153
- # @return [Array<Symbol>]
5154
- end
5155
-
5156
5156
  # @see Increase::Models::CardDispute::Visa::UserSubmission#user_prearbitration
5157
5157
  class UserPrearbitration < Increase::Internal::Type::BaseModel
5158
5158
  # @!attribute category_change
@@ -86,13 +86,27 @@ module Increase
86
86
  # @param type [Symbol, Increase::Models::CardPayment::Type] A constant representing the object's type. For this resource it will always be `
87
87
 
88
88
  class Element < Increase::Internal::Type::BaseModel
89
+ # @!attribute category
90
+ # The type of the resource. We may add additional possible values for this enum
91
+ # over time; your application should be able to handle such additions gracefully.
92
+ #
93
+ # @return [Symbol, Increase::Models::CardPayment::Element::Category]
94
+ required :category, enum: -> { Increase::CardPayment::Element::Category }
95
+
96
+ # @!attribute created_at
97
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
98
+ # the card payment element was created.
99
+ #
100
+ # @return [Time]
101
+ required :created_at, Time
102
+
89
103
  # @!attribute card_authentication
90
104
  # A Card Authentication object. This field will be present in the JSON response if
91
105
  # and only if `category` is equal to `card_authentication`. Card Authentications
92
106
  # are attempts to authenticate a transaction or a card with 3DS.
93
107
  #
94
108
  # @return [Increase::Models::CardPayment::Element::CardAuthentication, nil]
95
- required :card_authentication, -> { Increase::CardPayment::Element::CardAuthentication }, nil?: true
109
+ optional :card_authentication, -> { Increase::CardPayment::Element::CardAuthentication }, nil?: true
96
110
 
97
111
  # @!attribute card_authorization
98
112
  # A Card Authorization object. This field will be present in the JSON response if
@@ -101,7 +115,7 @@ module Increase
101
115
  # transaction.
102
116
  #
103
117
  # @return [Increase::Models::CardPayment::Element::CardAuthorization, nil]
104
- required :card_authorization, -> { Increase::CardPayment::Element::CardAuthorization }, nil?: true
118
+ optional :card_authorization, -> { Increase::CardPayment::Element::CardAuthorization }, nil?: true
105
119
 
106
120
  # @!attribute card_authorization_expiration
107
121
  # A Card Authorization Expiration object. This field will be present in the JSON
@@ -110,7 +124,7 @@ module Increase
110
124
  # never settled by the acquirer.
111
125
  #
112
126
  # @return [Increase::Models::CardPayment::Element::CardAuthorizationExpiration, nil]
113
- required :card_authorization_expiration,
127
+ optional :card_authorization_expiration,
114
128
  -> { Increase::CardPayment::Element::CardAuthorizationExpiration },
115
129
  nil?: true
116
130
 
@@ -122,14 +136,14 @@ module Increase
122
136
  # requests their balance at an ATM.
123
137
  #
124
138
  # @return [Increase::Models::CardPayment::Element::CardBalanceInquiry, nil]
125
- required :card_balance_inquiry, -> { Increase::CardPayment::Element::CardBalanceInquiry }, nil?: true
139
+ optional :card_balance_inquiry, -> { Increase::CardPayment::Element::CardBalanceInquiry }, nil?: true
126
140
 
127
141
  # @!attribute card_decline
128
142
  # A Card Decline object. This field will be present in the JSON response if and
129
143
  # only if `category` is equal to `card_decline`.
130
144
  #
131
145
  # @return [Increase::Models::CardPayment::Element::CardDecline, nil]
132
- required :card_decline, -> { Increase::CardPayment::Element::CardDecline }, nil?: true
146
+ optional :card_decline, -> { Increase::CardPayment::Element::CardDecline }, nil?: true
133
147
 
134
148
  # @!attribute card_financial
135
149
  # A Card Financial object. This field will be present in the JSON response if and
@@ -137,7 +151,7 @@ module Increase
137
151
  # holds placed on a customers funds with the intent to later clear a transaction.
138
152
  #
139
153
  # @return [Increase::Models::CardPayment::Element::CardFinancial, nil]
140
- required :card_financial, -> { Increase::CardPayment::Element::CardFinancial }, nil?: true
154
+ optional :card_financial, -> { Increase::CardPayment::Element::CardFinancial }, nil?: true
141
155
 
142
156
  # @!attribute card_fuel_confirmation
143
157
  # A Card Fuel Confirmation object. This field will be present in the JSON response
@@ -146,7 +160,7 @@ module Increase
146
160
  # transaction is completed.
147
161
  #
148
162
  # @return [Increase::Models::CardPayment::Element::CardFuelConfirmation, nil]
149
- required :card_fuel_confirmation,
163
+ optional :card_fuel_confirmation,
150
164
  -> {
151
165
  Increase::CardPayment::Element::CardFuelConfirmation
152
166
  },
@@ -158,7 +172,7 @@ module Increase
158
172
  # pending amount of an authorized transaction.
159
173
  #
160
174
  # @return [Increase::Models::CardPayment::Element::CardIncrement, nil]
161
- required :card_increment, -> { Increase::CardPayment::Element::CardIncrement }, nil?: true
175
+ optional :card_increment, -> { Increase::CardPayment::Element::CardIncrement }, nil?: true
162
176
 
163
177
  # @!attribute card_refund
164
178
  # A Card Refund object. This field will be present in the JSON response if and
@@ -168,7 +182,7 @@ module Increase
168
182
  # transaction.
169
183
  #
170
184
  # @return [Increase::Models::CardPayment::Element::CardRefund, nil]
171
- required :card_refund, -> { Increase::CardPayment::Element::CardRefund }, nil?: true
185
+ optional :card_refund, -> { Increase::CardPayment::Element::CardRefund }, nil?: true
172
186
 
173
187
  # @!attribute card_reversal
174
188
  # A Card Reversal object. This field will be present in the JSON response if and
@@ -176,7 +190,7 @@ module Increase
176
190
  # or the entirety of an existing Card Authorization.
177
191
  #
178
192
  # @return [Increase::Models::CardPayment::Element::CardReversal, nil]
179
- required :card_reversal, -> { Increase::CardPayment::Element::CardReversal }, nil?: true
193
+ optional :card_reversal, -> { Increase::CardPayment::Element::CardReversal }, nil?: true
180
194
 
181
195
  # @!attribute card_settlement
182
196
  # A Card Settlement object. This field will be present in the JSON response if and
@@ -186,7 +200,7 @@ module Increase
186
200
  # without first authorizing it.
187
201
  #
188
202
  # @return [Increase::Models::CardPayment::Element::CardSettlement, nil]
189
- required :card_settlement, -> { Increase::CardPayment::Element::CardSettlement }, nil?: true
203
+ optional :card_settlement, -> { Increase::CardPayment::Element::CardSettlement }, nil?: true
190
204
 
191
205
  # @!attribute card_validation
192
206
  # An Inbound Card Validation object. This field will be present in the JSON
@@ -195,33 +209,23 @@ module Increase
195
209
  # optionally its address and/or Card Verification Value are valid.
196
210
  #
197
211
  # @return [Increase::Models::CardPayment::Element::CardValidation, nil]
198
- required :card_validation, -> { Increase::CardPayment::Element::CardValidation }, nil?: true
199
-
200
- # @!attribute category
201
- # The type of the resource. We may add additional possible values for this enum
202
- # over time; your application should be able to handle such additions gracefully.
203
- #
204
- # @return [Symbol, Increase::Models::CardPayment::Element::Category]
205
- required :category, enum: -> { Increase::CardPayment::Element::Category }
206
-
207
- # @!attribute created_at
208
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
209
- # the card payment element was created.
210
- #
211
- # @return [Time]
212
- required :created_at, Time
212
+ optional :card_validation, -> { Increase::CardPayment::Element::CardValidation }, nil?: true
213
213
 
214
214
  # @!attribute other
215
215
  # If the category of this Transaction source is equal to `other`, this field will
216
216
  # contain an empty object, otherwise it will contain null.
217
217
  #
218
218
  # @return [Increase::Models::CardPayment::Element::Other, nil]
219
- required :other, -> { Increase::CardPayment::Element::Other }, nil?: true
219
+ optional :other, -> { Increase::CardPayment::Element::Other }, nil?: true
220
220
 
221
- # @!method initialize(card_authentication:, card_authorization:, card_authorization_expiration:, card_balance_inquiry:, card_decline:, card_financial:, card_fuel_confirmation:, card_increment:, card_refund:, card_reversal:, card_settlement:, card_validation:, category:, created_at:, other:)
221
+ # @!method initialize(category:, created_at:, card_authentication: nil, card_authorization: nil, card_authorization_expiration: nil, card_balance_inquiry: nil, card_decline: nil, card_financial: nil, card_fuel_confirmation: nil, card_increment: nil, card_refund: nil, card_reversal: nil, card_settlement: nil, card_validation: nil, other: nil)
222
222
  # Some parameter documentations has been truncated, see
223
223
  # {Increase::Models::CardPayment::Element} for more details.
224
224
  #
225
+ # @param category [Symbol, Increase::Models::CardPayment::Element::Category] The type of the resource. We may add additional possible values for this enum ov
226
+ #
227
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
228
+ #
225
229
  # @param card_authentication [Increase::Models::CardPayment::Element::CardAuthentication, nil] A Card Authentication object. This field will be present in the JSON response if
226
230
  #
227
231
  # @param card_authorization [Increase::Models::CardPayment::Element::CardAuthorization, nil] A Card Authorization object. This field will be present in the JSON response if
@@ -246,12 +250,58 @@ module Increase
246
250
  #
247
251
  # @param card_validation [Increase::Models::CardPayment::Element::CardValidation, nil] An Inbound Card Validation object. This field will be present in the JSON respon
248
252
  #
249
- # @param category [Symbol, Increase::Models::CardPayment::Element::Category] The type of the resource. We may add additional possible values for this enum ov
250
- #
251
- # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
252
- #
253
253
  # @param other [Increase::Models::CardPayment::Element::Other, nil] If the category of this Transaction source is equal to `other`, this field will
254
254
 
255
+ # The type of the resource. We may add additional possible values for this enum
256
+ # over time; your application should be able to handle such additions gracefully.
257
+ #
258
+ # @see Increase::Models::CardPayment::Element#category
259
+ module Category
260
+ extend Increase::Internal::Type::Enum
261
+
262
+ # Card Authorization: details will be under the `card_authorization` object.
263
+ CARD_AUTHORIZATION = :card_authorization
264
+
265
+ # Card Authentication: details will be under the `card_authentication` object.
266
+ CARD_AUTHENTICATION = :card_authentication
267
+
268
+ # Card Balance Inquiry: details will be under the `card_balance_inquiry` object.
269
+ CARD_BALANCE_INQUIRY = :card_balance_inquiry
270
+
271
+ # Inbound Card Validation: details will be under the `card_validation` object.
272
+ CARD_VALIDATION = :card_validation
273
+
274
+ # Card Decline: details will be under the `card_decline` object.
275
+ CARD_DECLINE = :card_decline
276
+
277
+ # Card Reversal: details will be under the `card_reversal` object.
278
+ CARD_REVERSAL = :card_reversal
279
+
280
+ # Card Authorization Expiration: details will be under the `card_authorization_expiration` object.
281
+ CARD_AUTHORIZATION_EXPIRATION = :card_authorization_expiration
282
+
283
+ # Card Increment: details will be under the `card_increment` object.
284
+ CARD_INCREMENT = :card_increment
285
+
286
+ # Card Settlement: details will be under the `card_settlement` object.
287
+ CARD_SETTLEMENT = :card_settlement
288
+
289
+ # Card Refund: details will be under the `card_refund` object.
290
+ CARD_REFUND = :card_refund
291
+
292
+ # Card Fuel Confirmation: details will be under the `card_fuel_confirmation` object.
293
+ CARD_FUEL_CONFIRMATION = :card_fuel_confirmation
294
+
295
+ # Card Financial: details will be under the `card_financial` object.
296
+ CARD_FINANCIAL = :card_financial
297
+
298
+ # Unknown card payment element.
299
+ OTHER = :other
300
+
301
+ # @!method self.values
302
+ # @return [Array<Symbol>]
303
+ end
304
+
255
305
  # @see Increase::Models::CardPayment::Element#card_authentication
256
306
  class CardAuthentication < Increase::Internal::Type::BaseModel
257
307
  # @!attribute id
@@ -10526,56 +10576,6 @@ module Increase
10526
10576
  end
10527
10577
  end
10528
10578
 
10529
- # The type of the resource. We may add additional possible values for this enum
10530
- # over time; your application should be able to handle such additions gracefully.
10531
- #
10532
- # @see Increase::Models::CardPayment::Element#category
10533
- module Category
10534
- extend Increase::Internal::Type::Enum
10535
-
10536
- # Card Authorization: details will be under the `card_authorization` object.
10537
- CARD_AUTHORIZATION = :card_authorization
10538
-
10539
- # Card Authentication: details will be under the `card_authentication` object.
10540
- CARD_AUTHENTICATION = :card_authentication
10541
-
10542
- # Card Balance Inquiry: details will be under the `card_balance_inquiry` object.
10543
- CARD_BALANCE_INQUIRY = :card_balance_inquiry
10544
-
10545
- # Inbound Card Validation: details will be under the `card_validation` object.
10546
- CARD_VALIDATION = :card_validation
10547
-
10548
- # Card Decline: details will be under the `card_decline` object.
10549
- CARD_DECLINE = :card_decline
10550
-
10551
- # Card Reversal: details will be under the `card_reversal` object.
10552
- CARD_REVERSAL = :card_reversal
10553
-
10554
- # Card Authorization Expiration: details will be under the `card_authorization_expiration` object.
10555
- CARD_AUTHORIZATION_EXPIRATION = :card_authorization_expiration
10556
-
10557
- # Card Increment: details will be under the `card_increment` object.
10558
- CARD_INCREMENT = :card_increment
10559
-
10560
- # Card Settlement: details will be under the `card_settlement` object.
10561
- CARD_SETTLEMENT = :card_settlement
10562
-
10563
- # Card Refund: details will be under the `card_refund` object.
10564
- CARD_REFUND = :card_refund
10565
-
10566
- # Card Fuel Confirmation: details will be under the `card_fuel_confirmation` object.
10567
- CARD_FUEL_CONFIRMATION = :card_fuel_confirmation
10568
-
10569
- # Card Financial: details will be under the `card_financial` object.
10570
- CARD_FINANCIAL = :card_financial
10571
-
10572
- # Unknown card payment element.
10573
- OTHER = :other
10574
-
10575
- # @!method self.values
10576
- # @return [Array<Symbol>]
10577
- end
10578
-
10579
10579
  # @see Increase::Models::CardPayment::Element#other
10580
10580
  class Other < Increase::Internal::Type::BaseModel
10581
10581
  # @!method initialize