increase 1.353.0 → 1.355.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 (152) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +18 -0
  4. data/lib/increase/models/ach_transfer.rb +3 -3
  5. data/lib/increase/models/beneficial_owner_create_params.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_update_params.rb +1 -1
  7. data/lib/increase/models/card_create_details_token_params.rb +22 -0
  8. data/lib/increase/models/card_details_token.rb +57 -0
  9. data/lib/increase/models/card_payment.rb +29 -1
  10. data/lib/increase/models/declined_transaction.rb +3 -0
  11. data/lib/increase/models/digital_wallet_token.rb +18 -0
  12. data/lib/increase/models/digital_wallet_token_request.rb +307 -0
  13. data/lib/increase/models/digital_wallet_token_request_list_params.rb +99 -0
  14. data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb +22 -0
  15. data/lib/increase/models/digital_wallet_token_transition_params.rb +48 -0
  16. data/lib/increase/models/entity.rb +35 -7
  17. data/lib/increase/models/entity_beneficial_owner.rb +1 -1
  18. data/lib/increase/models/entity_create_params.rb +1 -1
  19. data/lib/increase/models/export.rb +19 -19
  20. data/lib/increase/models/export_create_params.rb +15 -15
  21. data/lib/increase/models/export_list_params.rb +19 -19
  22. data/lib/increase/models/inbound_real_time_payments_request_for_payment.rb +318 -0
  23. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rb +113 -0
  24. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rb +25 -0
  25. data/lib/increase/models/inbound_wire_transfer.rb +10 -1
  26. data/lib/increase/models/physical_check_batch.rb +266 -0
  27. data/lib/increase/models/physical_check_batch_cancel_params.rb +22 -0
  28. data/lib/increase/models/physical_check_batch_complete_params.rb +22 -0
  29. data/lib/increase/models/physical_check_batch_create_params.rb +189 -0
  30. data/lib/increase/models/real_time_decision.rb +9 -0
  31. data/lib/increase/models/real_time_decision_action_params.rb +3 -0
  32. data/lib/increase/models/real_time_payments_request_for_payment.rb +658 -0
  33. data/lib/increase/models/real_time_payments_requests_for_payment_cancel_params.rb +64 -0
  34. data/lib/increase/models/real_time_payments_requests_for_payment_create_params.rb +194 -0
  35. data/lib/increase/models/real_time_payments_requests_for_payment_list_params.rb +117 -0
  36. data/lib/increase/models/real_time_payments_requests_for_payment_retrieve_params.rb +23 -0
  37. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -0
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  39. data/lib/increase/models/simulations/fednow_transfer_complete_params.rb +103 -0
  40. data/lib/increase/models/simulations/inbound_check_deposit_accept_params.rb +24 -0
  41. data/lib/increase/models/transaction.rb +36 -2
  42. data/lib/increase/models.rb +42 -0
  43. data/lib/increase/resources/cards.rb +23 -0
  44. data/lib/increase/resources/digital_wallet_token_requests.rb +68 -0
  45. data/lib/increase/resources/digital_wallet_tokens.rb +28 -0
  46. data/lib/increase/resources/inbound_real_time_payments_requests_for_payment.rb +79 -0
  47. data/lib/increase/resources/physical_check_batches.rb +86 -0
  48. data/lib/increase/resources/real_time_payments_requests_for_payment.rb +159 -0
  49. data/lib/increase/resources/simulations/fednow_transfers.rb +43 -0
  50. data/lib/increase/resources/simulations/inbound_check_deposits.rb +22 -0
  51. data/lib/increase/resources/simulations.rb +4 -0
  52. data/lib/increase/version.rb +1 -1
  53. data/lib/increase.rb +25 -0
  54. data/rbi/increase/client.rbi +14 -0
  55. data/rbi/increase/models/ach_transfer.rbi +3 -3
  56. data/rbi/increase/models/beneficial_owner_create_params.rbi +1 -1
  57. data/rbi/increase/models/beneficial_owner_update_params.rbi +1 -1
  58. data/rbi/increase/models/card_create_details_token_params.rbi +43 -0
  59. data/rbi/increase/models/card_details_token.rbi +85 -0
  60. data/rbi/increase/models/card_payment.rbi +59 -0
  61. data/rbi/increase/models/declined_transaction.rbi +7 -0
  62. data/rbi/increase/models/digital_wallet_token.rbi +42 -0
  63. data/rbi/increase/models/digital_wallet_token_request.rbi +586 -0
  64. data/rbi/increase/models/digital_wallet_token_request_list_params.rbi +171 -0
  65. data/rbi/increase/models/digital_wallet_token_request_retrieve_params.rbi +46 -0
  66. data/rbi/increase/models/digital_wallet_token_transition_params.rbi +100 -0
  67. data/rbi/increase/models/entity.rbi +71 -6
  68. data/rbi/increase/models/entity_beneficial_owner.rbi +1 -1
  69. data/rbi/increase/models/entity_create_params.rbi +1 -1
  70. data/rbi/increase/models/export.rbi +32 -32
  71. data/rbi/increase/models/export_create_params.rbi +29 -29
  72. data/rbi/increase/models/export_list_params.rbi +37 -37
  73. data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi +442 -0
  74. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi +188 -0
  75. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi +48 -0
  76. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  77. data/rbi/increase/models/physical_check_batch.rbi +382 -0
  78. data/rbi/increase/models/physical_check_batch_cancel_params.rbi +46 -0
  79. data/rbi/increase/models/physical_check_batch_complete_params.rbi +46 -0
  80. data/rbi/increase/models/physical_check_batch_create_params.rbi +326 -0
  81. data/rbi/increase/models/real_time_decision.rbi +21 -0
  82. data/rbi/increase/models/real_time_decision_action_params.rbi +7 -0
  83. data/rbi/increase/models/real_time_payments_request_for_payment.rbi +1166 -0
  84. data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi +136 -0
  85. data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi +303 -0
  86. data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi +192 -0
  87. data/rbi/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbi +46 -0
  88. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +21 -0
  89. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  90. data/rbi/increase/models/simulations/fednow_transfer_complete_params.rbi +243 -0
  91. data/rbi/increase/models/simulations/inbound_check_deposit_accept_params.rbi +48 -0
  92. data/rbi/increase/models/transaction.rbi +60 -0
  93. data/rbi/increase/models.rbi +50 -0
  94. data/rbi/increase/resources/cards.rbi +17 -0
  95. data/rbi/increase/resources/digital_wallet_token_requests.rbi +52 -0
  96. data/rbi/increase/resources/digital_wallet_tokens.rbi +21 -0
  97. data/rbi/increase/resources/inbound_real_time_payments_requests_for_payment.rbi +62 -0
  98. data/rbi/increase/resources/physical_check_batches.rbi +66 -0
  99. data/rbi/increase/resources/real_time_payments_requests_for_payment.rbi +127 -0
  100. data/rbi/increase/resources/simulations/fednow_transfers.rbi +34 -0
  101. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +16 -0
  102. data/rbi/increase/resources/simulations.rbi +3 -0
  103. data/sig/increase/client.rbs +8 -0
  104. data/sig/increase/models/ach_transfer.rbs +4 -4
  105. data/sig/increase/models/beneficial_owner_create_params.rbs +1 -1
  106. data/sig/increase/models/beneficial_owner_update_params.rbs +1 -1
  107. data/sig/increase/models/card_create_details_token_params.rbs +23 -0
  108. data/sig/increase/models/card_details_token.rbs +40 -0
  109. data/sig/increase/models/card_payment.rbs +23 -0
  110. data/sig/increase/models/declined_transaction.rbs +4 -0
  111. data/sig/increase/models/digital_wallet_token.rbs +36 -3
  112. data/sig/increase/models/digital_wallet_token_request.rbs +260 -0
  113. data/sig/increase/models/digital_wallet_token_request_list_params.rbs +86 -0
  114. data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs +24 -0
  115. data/sig/increase/models/digital_wallet_token_transition_params.rbs +48 -0
  116. data/sig/increase/models/entity.rbs +25 -6
  117. data/sig/increase/models/entity_beneficial_owner.rbs +1 -1
  118. data/sig/increase/models/entity_create_params.rbs +1 -1
  119. data/sig/increase/models/export.rbs +28 -28
  120. data/sig/increase/models/export_create_params.rbs +22 -22
  121. data/sig/increase/models/export_list_params.rbs +28 -28
  122. data/sig/increase/models/inbound_real_time_payments_request_for_payment.rbs +200 -0
  123. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbs +93 -0
  124. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  125. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  126. data/sig/increase/models/physical_check_batch.rbs +193 -0
  127. data/sig/increase/models/physical_check_batch_cancel_params.rbs +24 -0
  128. data/sig/increase/models/physical_check_batch_complete_params.rbs +24 -0
  129. data/sig/increase/models/physical_check_batch_create_params.rbs +156 -0
  130. data/sig/increase/models/real_time_decision.rbs +14 -2
  131. data/sig/increase/models/real_time_decision_action_params.rbs +4 -0
  132. data/sig/increase/models/real_time_payments_request_for_payment.rbs +513 -0
  133. data/sig/increase/models/real_time_payments_requests_for_payment_cancel_params.rbs +66 -0
  134. data/sig/increase/models/real_time_payments_requests_for_payment_create_params.rbs +149 -0
  135. data/sig/increase/models/real_time_payments_requests_for_payment_list_params.rbs +93 -0
  136. data/sig/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  137. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +12 -0
  138. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  139. data/sig/increase/models/simulations/fednow_transfer_complete_params.rbs +122 -0
  140. data/sig/increase/models/simulations/inbound_check_deposit_accept_params.rbs +26 -0
  141. data/sig/increase/models/transaction.rbs +24 -0
  142. data/sig/increase/models.rbs +36 -0
  143. data/sig/increase/resources/cards.rbs +5 -0
  144. data/sig/increase/resources/digital_wallet_token_requests.rbs +20 -0
  145. data/sig/increase/resources/digital_wallet_tokens.rbs +6 -0
  146. data/sig/increase/resources/inbound_real_time_payments_requests_for_payment.rbs +21 -0
  147. data/sig/increase/resources/physical_check_batches.rbs +24 -0
  148. data/sig/increase/resources/real_time_payments_requests_for_payment.rbs +41 -0
  149. data/sig/increase/resources/simulations/fednow_transfers.rbs +15 -0
  150. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +5 -0
  151. data/sig/increase/resources/simulations.rbs +2 -0
  152. metadata +77 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fff32c0810855540ecec2bbf731aa17c10dbfba28e99d55a532ee7d918536dc6
4
- data.tar.gz: 96a88553b9dfb0bb7df9a6e6f66a4322320384b26ff3e9a723d1ed7e8a8cb081
3
+ metadata.gz: 4e287890bb13668b2bb2adb2f9e68bfd837576e9bb33efd6d0b86614940cb072
4
+ data.tar.gz: 620e23fadc6f8680b151b45b1de3f0eb7cb8893409f284c3deeffd9c2eb4556d
5
5
  SHA512:
6
- metadata.gz: fc58d7606a136ebf727659ff13b63cc7f679158cb0e9a37f83047f7834db6c60485d29977f49dad1235b2747a0ad39a7a76de4db8e336e19019808e65e367174
7
- data.tar.gz: 2ae3049931377b31e164a8355fc0913f0c3f9ae2824e11f94418f77ff8c18d499a31de0babe2f9245637b269c7688d07b81f17ffdc05464868d30191afad56e7
6
+ metadata.gz: de7bbed3ce04e4fb2cebfd5e23fa4e99a33c6a6ef02718d7ca936580348ceb931b1235d2da7b478e73b473d197b910106000fde7effb12d88c6e2dfd60d816d2
7
+ data.tar.gz: 1ae7ced3bec1ad76179ac9886825b689387ab2d334585714532d4d7a45978171aefccbafa55e6f6e0bd8254819246e0079a816095ab031b3ad129f4336045283
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.353.0"
18
+ gem "increase", "~> 1.355.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -59,6 +59,9 @@ module Increase
59
59
  # @return [Increase::Resources::DigitalWalletTokens]
60
60
  attr_reader :digital_wallet_tokens
61
61
 
62
+ # @return [Increase::Resources::DigitalWalletTokenRequests]
63
+ attr_reader :digital_wallet_token_requests
64
+
62
65
  # @return [Increase::Resources::Transactions]
63
66
  attr_reader :transactions
64
67
 
@@ -101,6 +104,12 @@ module Increase
101
104
  # @return [Increase::Resources::InboundRealTimePaymentsTransfers]
102
105
  attr_reader :inbound_real_time_payments_transfers
103
106
 
107
+ # @return [Increase::Resources::RealTimePaymentsRequestsForPayment]
108
+ attr_reader :real_time_payments_requests_for_payment
109
+
110
+ # @return [Increase::Resources::InboundRealTimePaymentsRequestsForPayment]
111
+ attr_reader :inbound_real_time_payments_requests_for_payment
112
+
104
113
  # @return [Increase::Resources::FednowTransfers]
105
114
  attr_reader :fednow_transfers
106
115
 
@@ -194,6 +203,9 @@ module Increase
194
203
  # @return [Increase::Resources::CardValidations]
195
204
  attr_reader :card_validations
196
205
 
206
+ # @return [Increase::Resources::PhysicalCheckBatches]
207
+ attr_reader :physical_check_batches
208
+
197
209
  # @return [Increase::Resources::Simulations]
198
210
  attr_reader :simulations
199
211
 
@@ -290,6 +302,7 @@ module Increase
290
302
  @digital_card_profiles = Increase::Resources::DigitalCardProfiles.new(client: self)
291
303
  @physical_card_profiles = Increase::Resources::PhysicalCardProfiles.new(client: self)
292
304
  @digital_wallet_tokens = Increase::Resources::DigitalWalletTokens.new(client: self)
305
+ @digital_wallet_token_requests = Increase::Resources::DigitalWalletTokenRequests.new(client: self)
293
306
  @transactions = Increase::Resources::Transactions.new(client: self)
294
307
  @pending_transactions = Increase::Resources::PendingTransactions.new(client: self)
295
308
  @declined_transactions = Increase::Resources::DeclinedTransactions.new(client: self)
@@ -305,6 +318,10 @@ module Increase
305
318
  @real_time_payments_transfers = Increase::Resources::RealTimePaymentsTransfers.new(client: self)
306
319
  @inbound_real_time_payments_transfers =
307
320
  Increase::Resources::InboundRealTimePaymentsTransfers.new(client: self)
321
+ @real_time_payments_requests_for_payment =
322
+ Increase::Resources::RealTimePaymentsRequestsForPayment.new(client: self)
323
+ @inbound_real_time_payments_requests_for_payment =
324
+ Increase::Resources::InboundRealTimePaymentsRequestsForPayment.new(client: self)
308
325
  @fednow_transfers = Increase::Resources::FednowTransfers.new(client: self)
309
326
  @inbound_fednow_transfers = Increase::Resources::InboundFednowTransfers.new(client: self)
310
327
  @swift_transfers = Increase::Resources::SwiftTransfers.new(client: self)
@@ -336,6 +353,7 @@ module Increase
336
353
  @card_tokens = Increase::Resources::CardTokens.new(client: self)
337
354
  @card_push_transfers = Increase::Resources::CardPushTransfers.new(client: self)
338
355
  @card_validations = Increase::Resources::CardValidations.new(client: self)
356
+ @physical_check_batches = Increase::Resources::PhysicalCheckBatches.new(client: self)
339
357
  @simulations = Increase::Resources::Simulations.new(client: self)
340
358
  end
341
359
  end
@@ -385,15 +385,15 @@ module Increase
385
385
  # When the Federal Reserve acknowledged the submitted file containing this
386
386
  # transfer.
387
387
  #
388
- # @return [String]
389
- required :acknowledged_at, String
388
+ # @return [Time]
389
+ required :acknowledged_at, Time
390
390
 
391
391
  # @!method initialize(acknowledged_at:)
392
392
  # After the transfer is acknowledged by FedACH, this will contain supplemental
393
393
  # details. The Federal Reserve sends an acknowledgement message for each file that
394
394
  # Increase submits.
395
395
  #
396
- # @param acknowledged_at [String]
396
+ # @param acknowledged_at [Time]
397
397
  # When the Federal Reserve acknowledged the submitted file containing this
398
398
  # transfer.
399
399
  end
@@ -250,7 +250,7 @@ module Increase
250
250
  # A social security number.
251
251
  SOCIAL_SECURITY_NUMBER = :social_security_number
252
252
 
253
- # The last four digits of a social security number.
253
+ # The last four digits of a social security number. Not all programs can use this method.
254
254
  SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
255
255
 
256
256
  # An individual taxpayer identification number (ITIN).
@@ -225,7 +225,7 @@ module Increase
225
225
  # A social security number.
226
226
  SOCIAL_SECURITY_NUMBER = :social_security_number
227
227
 
228
- # The last four digits of a social security number.
228
+ # The last four digits of a social security number. Not all programs can use this method.
229
229
  SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
230
230
 
231
231
  # An individual taxpayer identification number (ITIN).
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::Cards#create_details_token
6
+ class CardCreateDetailsTokenParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute card_id
11
+ # The identifier of the Card to mint a details token for.
12
+ #
13
+ # @return [String]
14
+ required :card_id, String
15
+
16
+ # @!method initialize(card_id:, request_options: {})
17
+ # @param card_id [String] The identifier of the Card to mint a details token for.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::Cards#create_details_token
6
+ class CardDetailsToken < Increase::Internal::Type::BaseModel
7
+ # @!attribute token
8
+ # The token. Pass this to the `@increasebank/card-elements` library in your
9
+ # frontend. Treat it as a credential: it authorizes anyone holding it to read the
10
+ # Card's details until it expires.
11
+ #
12
+ # @return [String]
13
+ required :token, String
14
+
15
+ # @!attribute expires_at
16
+ # The time the token will expire. Tokens are valid for one hour.
17
+ #
18
+ # @return [Time]
19
+ required :expires_at, Time
20
+
21
+ # @!attribute type
22
+ # A constant representing the object's type. For this resource it will always be
23
+ # `card_details_token`.
24
+ #
25
+ # @return [Symbol, Increase::Models::CardDetailsToken::Type]
26
+ required :type, enum: -> { Increase::CardDetailsToken::Type }
27
+
28
+ # @!method initialize(token:, expires_at:, type:)
29
+ # A short-lived token that authorizes Increase Card Elements to render the details
30
+ # of a single Card.
31
+ #
32
+ # @param token [String]
33
+ # The token. Pass this to the `@increasebank/card-elements` library in your
34
+ # frontend. Treat it as a credential: it authorizes anyone holding it to read the
35
+ # Card's details until it expires.
36
+ #
37
+ # @param expires_at [Time] The time the token will expire. Tokens are valid for one hour.
38
+ #
39
+ # @param type [Symbol, Increase::Models::CardDetailsToken::Type]
40
+ # A constant representing the object's type. For this resource it will always be
41
+ # `card_details_token`.
42
+
43
+ # A constant representing the object's type. For this resource it will always be
44
+ # `card_details_token`.
45
+ #
46
+ # @see Increase::Models::CardDetailsToken#type
47
+ module Type
48
+ extend Increase::Internal::Type::Enum
49
+
50
+ CARD_DETAILS_TOKEN = :card_details_token
51
+
52
+ # @!method self.values
53
+ # @return [Array<Symbol>]
54
+ end
55
+ end
56
+ end
57
+ end
@@ -5682,6 +5682,9 @@ module Increase
5682
5682
  # The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.
5683
5683
  SUSPECTED_FRAUD = :suspected_fraud
5684
5684
 
5685
+ # Additional customer authentication is required to complete the transaction, such as 3DS.
5686
+ ADDITIONAL_CUSTOMER_AUTHENTICATION_REQUIRED = :additional_customer_authentication_required
5687
+
5685
5688
  # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly.
5686
5689
  OTHER = :other
5687
5690
 
@@ -9001,6 +9004,12 @@ module Increase
9001
9004
  # @return [String, nil]
9002
9005
  required :merchant_state, String, nil?: true
9003
9006
 
9007
+ # @!attribute network
9008
+ # The card network on which this transaction was processed.
9009
+ #
9010
+ # @return [Symbol, Increase::Models::CardPayment::Element::CardRefund::Network]
9011
+ required :network, enum: -> { Increase::CardPayment::Element::CardRefund::Network }
9012
+
9004
9013
  # @!attribute network_identifiers
9005
9014
  # Network-specific identifiers for this refund.
9006
9015
  #
@@ -9051,7 +9060,7 @@ module Increase
9051
9060
  # @return [Symbol, Increase::Models::CardPayment::Element::CardRefund::Type]
9052
9061
  required :type, enum: -> { Increase::CardPayment::Element::CardRefund::Type }
9053
9062
 
9054
- # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
9063
+ # @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
9055
9064
  # A Card Refund object. This field will be present in the JSON response if and
9056
9065
  # only if `category` is equal to `card_refund`. Card Refunds move money back to
9057
9066
  # the cardholder. While they are usually connected to a Card Settlement, an
@@ -9094,6 +9103,9 @@ module Increase
9094
9103
  #
9095
9104
  # @param merchant_state [String, nil] The state the merchant resides in.
9096
9105
  #
9106
+ # @param network [Symbol, Increase::Models::CardPayment::Element::CardRefund::Network]
9107
+ # The card network on which this transaction was processed.
9108
+ #
9097
9109
  # @param network_identifiers [Increase::Models::CardPayment::Element::CardRefund::NetworkIdentifiers]
9098
9110
  # Network-specific identifiers for this refund.
9099
9111
  #
@@ -9227,6 +9239,22 @@ module Increase
9227
9239
  end
9228
9240
  end
9229
9241
 
9242
+ # The card network on which this transaction was processed.
9243
+ #
9244
+ # @see Increase::Models::CardPayment::Element::CardRefund#network
9245
+ module Network
9246
+ extend Increase::Internal::Type::Enum
9247
+
9248
+ # Visa
9249
+ VISA = :visa
9250
+
9251
+ # Pulse
9252
+ PULSE = :pulse
9253
+
9254
+ # @!method self.values
9255
+ # @return [Array<Symbol>]
9256
+ end
9257
+
9230
9258
  # @see Increase::Models::CardPayment::Element::CardRefund#network_identifiers
9231
9259
  class NetworkIdentifiers < Increase::Internal::Type::BaseModel
9232
9260
  # @!attribute acquirer_business_id
@@ -1681,6 +1681,9 @@ module Increase
1681
1681
  # The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again.
1682
1682
  SUSPECTED_FRAUD = :suspected_fraud
1683
1683
 
1684
+ # Additional customer authentication is required to complete the transaction, such as 3DS.
1685
+ ADDITIONAL_CUSTOMER_AUTHENTICATION_REQUIRED = :additional_customer_authentication_required
1686
+
1684
1687
  # The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly.
1685
1688
  OTHER = :other
1686
1689
 
@@ -192,6 +192,15 @@ module Increase
192
192
  # The tokenization attempt was declined by the token requestor.
193
193
  DECLINED_BY_TOKEN_REQUESTOR = :declined_by_token_requestor
194
194
 
195
+ # The group was locked.
196
+ GROUP_LOCKED = :group_locked
197
+
198
+ # The account has been closed.
199
+ ACCOUNT_CLOSED = :account_closed
200
+
201
+ # The account's entity was not active.
202
+ ENTITY_NOT_ACTIVE = :entity_not_active
203
+
195
204
  # @!method self.values
196
205
  # @return [Array<Symbol>]
197
206
  end
@@ -315,6 +324,9 @@ module Increase
315
324
  # The digital wallet token was declined during provisioning.
316
325
  DECLINED = :declined
317
326
 
327
+ # The digital wallet token is transitioning to a new status and is awaiting confirmation from the card network.
328
+ PENDING_TRANSITIONING = :pending_transitioning
329
+
318
330
  # @!method self.values
319
331
  # @return [Array<Symbol>]
320
332
  end
@@ -334,6 +346,9 @@ module Increase
334
346
  # Samsung Pay
335
347
  SAMSUNG_PAY = :samsung_pay
336
348
 
349
+ # Garmin Pay
350
+ GARMIN_PAY = :garmin_pay
351
+
337
352
  # Unknown
338
353
  UNKNOWN = :unknown
339
354
 
@@ -397,6 +412,9 @@ module Increase
397
412
  # The digital wallet token was declined during provisioning.
398
413
  DECLINED = :declined
399
414
 
415
+ # The digital wallet token is transitioning to a new status and is awaiting confirmation from the card network.
416
+ PENDING_TRANSITIONING = :pending_transitioning
417
+
400
418
  # @!method self.values
401
419
  # @return [Array<Symbol>]
402
420
  end
@@ -0,0 +1,307 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::DigitalWalletTokenRequests#retrieve
6
+ class DigitalWalletTokenRequest < Increase::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The Digital Wallet Token Request identifier.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute card_id
14
+ # The identifier of the Card the tokenization was requested for.
15
+ #
16
+ # @return [String]
17
+ required :card_id, String
18
+
19
+ # @!attribute created_at
20
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
21
+ # the Digital Wallet Token Request was created.
22
+ #
23
+ # @return [Time]
24
+ required :created_at, Time
25
+
26
+ # @!attribute declined
27
+ # Details of the decline. Present if and only if `outcome` is `declined`.
28
+ #
29
+ # @return [Increase::Models::DigitalWalletTokenRequest::Declined, nil]
30
+ required :declined, -> { Increase::DigitalWalletTokenRequest::Declined }, nil?: true
31
+
32
+ # @!attribute device
33
+ # The device that requested the tokenization.
34
+ #
35
+ # @return [Increase::Models::DigitalWalletTokenRequest::Device]
36
+ required :device, -> { Increase::DigitalWalletTokenRequest::Device }
37
+
38
+ # @!attribute outcome
39
+ # The outcome of the tokenization request.
40
+ #
41
+ # @return [Symbol, Increase::Models::DigitalWalletTokenRequest::Outcome]
42
+ required :outcome, enum: -> { Increase::DigitalWalletTokenRequest::Outcome }
43
+
44
+ # @!attribute provisioned
45
+ # Details of the provisioned Digital Wallet Token. Present if and only if
46
+ # `outcome` is `provisioned`.
47
+ #
48
+ # @return [Increase::Models::DigitalWalletTokenRequest::Provisioned, nil]
49
+ required :provisioned, -> { Increase::DigitalWalletTokenRequest::Provisioned }, nil?: true
50
+
51
+ # @!attribute token_reference_identifier
52
+ # The reference identifier assigned by the card network to the token.
53
+ #
54
+ # @return [String]
55
+ required :token_reference_identifier, String
56
+
57
+ # @!attribute token_requestor
58
+ # The digital wallet app being used.
59
+ #
60
+ # @return [Symbol, Increase::Models::DigitalWalletTokenRequest::TokenRequestor]
61
+ required :token_requestor, enum: -> { Increase::DigitalWalletTokenRequest::TokenRequestor }
62
+
63
+ # @!attribute type
64
+ # A constant representing the object's type. For this resource it will always be
65
+ # `digital_wallet_token_request`.
66
+ #
67
+ # @return [Symbol, Increase::Models::DigitalWalletTokenRequest::Type]
68
+ required :type, enum: -> { Increase::DigitalWalletTokenRequest::Type }
69
+
70
+ # @!method initialize(id:, card_id:, created_at:, declined:, device:, outcome:, provisioned:, token_reference_identifier:, token_requestor:, type:)
71
+ # A Digital Wallet Token Request is created each time a digital wallet app, such
72
+ # as Apple Pay or Google Pay, requests to tokenize a Card.
73
+ #
74
+ # @param id [String] The Digital Wallet Token Request identifier.
75
+ #
76
+ # @param card_id [String] The identifier of the Card the tokenization was requested for.
77
+ #
78
+ # @param created_at [Time]
79
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
80
+ # the Digital Wallet Token Request was created.
81
+ #
82
+ # @param declined [Increase::Models::DigitalWalletTokenRequest::Declined, nil]
83
+ # Details of the decline. Present if and only if `outcome` is `declined`.
84
+ #
85
+ # @param device [Increase::Models::DigitalWalletTokenRequest::Device]
86
+ # The device that requested the tokenization.
87
+ #
88
+ # @param outcome [Symbol, Increase::Models::DigitalWalletTokenRequest::Outcome]
89
+ # The outcome of the tokenization request.
90
+ #
91
+ # @param provisioned [Increase::Models::DigitalWalletTokenRequest::Provisioned, nil]
92
+ # Details of the provisioned Digital Wallet Token. Present if and only if
93
+ # `outcome` is `provisioned`.
94
+ #
95
+ # @param token_reference_identifier [String]
96
+ # The reference identifier assigned by the card network to the token.
97
+ #
98
+ # @param token_requestor [Symbol, Increase::Models::DigitalWalletTokenRequest::TokenRequestor]
99
+ # The digital wallet app being used.
100
+ #
101
+ # @param type [Symbol, Increase::Models::DigitalWalletTokenRequest::Type]
102
+ # A constant representing the object's type. For this resource it will always be
103
+ # `digital_wallet_token_request`.
104
+
105
+ # @see Increase::Models::DigitalWalletTokenRequest#declined
106
+ class Declined < Increase::Internal::Type::BaseModel
107
+ # @!attribute reason
108
+ # The reason the tokenization was declined.
109
+ #
110
+ # @return [Symbol, Increase::Models::DigitalWalletTokenRequest::Declined::Reason]
111
+ required :reason, enum: -> { Increase::DigitalWalletTokenRequest::Declined::Reason }
112
+
113
+ # @!method initialize(reason:)
114
+ # Details of the decline. Present if and only if `outcome` is `declined`.
115
+ #
116
+ # @param reason [Symbol, Increase::Models::DigitalWalletTokenRequest::Declined::Reason]
117
+ # The reason the tokenization was declined.
118
+
119
+ # The reason the tokenization was declined.
120
+ #
121
+ # @see Increase::Models::DigitalWalletTokenRequest::Declined#reason
122
+ module Reason
123
+ extend Increase::Internal::Type::Enum
124
+
125
+ # The card is not active.
126
+ CARD_NOT_ACTIVE = :card_not_active
127
+
128
+ # The card does not have a two-factor authentication method.
129
+ NO_VERIFICATION_METHOD = :no_verification_method
130
+
131
+ # Your webhook timed out when evaluating the token provisioning attempt.
132
+ WEBHOOK_TIMED_OUT = :webhook_timed_out
133
+
134
+ # Your webhook declined the token provisioning attempt.
135
+ WEBHOOK_DECLINED = :webhook_declined
136
+
137
+ # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
138
+ INCORRECT_CARD_VERIFICATION_CODE = :incorrect_card_verification_code
139
+
140
+ # The tokenization attempt was declined by the token requestor.
141
+ DECLINED_BY_TOKEN_REQUESTOR = :declined_by_token_requestor
142
+
143
+ # The group was locked.
144
+ GROUP_LOCKED = :group_locked
145
+
146
+ # The account has been closed.
147
+ ACCOUNT_CLOSED = :account_closed
148
+
149
+ # The account's entity was not active.
150
+ ENTITY_NOT_ACTIVE = :entity_not_active
151
+
152
+ # @!method self.values
153
+ # @return [Array<Symbol>]
154
+ end
155
+ end
156
+
157
+ # @see Increase::Models::DigitalWalletTokenRequest#device
158
+ class Device < Increase::Internal::Type::BaseModel
159
+ # @!attribute device_type
160
+ # Device type.
161
+ #
162
+ # @return [Symbol, Increase::Models::DigitalWalletTokenRequest::Device::DeviceType, nil]
163
+ required :device_type,
164
+ enum: -> {
165
+ Increase::DigitalWalletTokenRequest::Device::DeviceType
166
+ },
167
+ nil?: true
168
+
169
+ # @!attribute identifier
170
+ # ID assigned to the device by the digital wallet provider.
171
+ #
172
+ # @return [String, nil]
173
+ required :identifier, String, nil?: true
174
+
175
+ # @!attribute ip_address
176
+ # IP address of the device.
177
+ #
178
+ # @return [String, nil]
179
+ required :ip_address, String, nil?: true
180
+
181
+ # @!attribute name
182
+ # Name of the device, for example "My Work Phone".
183
+ #
184
+ # @return [String, nil]
185
+ required :name, String, nil?: true
186
+
187
+ # @!method initialize(device_type:, identifier:, ip_address:, name:)
188
+ # The device that requested the tokenization.
189
+ #
190
+ # @param device_type [Symbol, Increase::Models::DigitalWalletTokenRequest::Device::DeviceType, nil]
191
+ # Device type.
192
+ #
193
+ # @param identifier [String, nil] ID assigned to the device by the digital wallet provider.
194
+ #
195
+ # @param ip_address [String, nil] IP address of the device.
196
+ #
197
+ # @param name [String, nil] Name of the device, for example "My Work Phone".
198
+
199
+ # Device type.
200
+ #
201
+ # @see Increase::Models::DigitalWalletTokenRequest::Device#device_type
202
+ module DeviceType
203
+ extend Increase::Internal::Type::Enum
204
+
205
+ # Unknown
206
+ UNKNOWN = :unknown
207
+
208
+ # Mobile Phone
209
+ MOBILE_PHONE = :mobile_phone
210
+
211
+ # Tablet
212
+ TABLET = :tablet
213
+
214
+ # Watch
215
+ WATCH = :watch
216
+
217
+ # Mobile Phone or Tablet
218
+ MOBILEPHONE_OR_TABLET = :mobilephone_or_tablet
219
+
220
+ # PC
221
+ PC = :pc
222
+
223
+ # Household Device
224
+ HOUSEHOLD_DEVICE = :household_device
225
+
226
+ # Wearable Device
227
+ WEARABLE_DEVICE = :wearable_device
228
+
229
+ # Automobile Device
230
+ AUTOMOBILE_DEVICE = :automobile_device
231
+
232
+ # @!method self.values
233
+ # @return [Array<Symbol>]
234
+ end
235
+ end
236
+
237
+ # The outcome of the tokenization request.
238
+ #
239
+ # @see Increase::Models::DigitalWalletTokenRequest#outcome
240
+ module Outcome
241
+ extend Increase::Internal::Type::Enum
242
+
243
+ # The tokenization request was approved and a Digital Wallet Token was provisioned.
244
+ PROVISIONED = :provisioned
245
+
246
+ # The tokenization request was declined.
247
+ DECLINED = :declined
248
+
249
+ # @!method self.values
250
+ # @return [Array<Symbol>]
251
+ end
252
+
253
+ # @see Increase::Models::DigitalWalletTokenRequest#provisioned
254
+ class Provisioned < Increase::Internal::Type::BaseModel
255
+ # @!attribute digital_wallet_token_id
256
+ # The identifier of the Digital Wallet Token that was provisioned.
257
+ #
258
+ # @return [String]
259
+ required :digital_wallet_token_id, String
260
+
261
+ # @!method initialize(digital_wallet_token_id:)
262
+ # Details of the provisioned Digital Wallet Token. Present if and only if
263
+ # `outcome` is `provisioned`.
264
+ #
265
+ # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token that was provisioned.
266
+ end
267
+
268
+ # The digital wallet app being used.
269
+ #
270
+ # @see Increase::Models::DigitalWalletTokenRequest#token_requestor
271
+ module TokenRequestor
272
+ extend Increase::Internal::Type::Enum
273
+
274
+ # Apple Pay
275
+ APPLE_PAY = :apple_pay
276
+
277
+ # Google Pay
278
+ GOOGLE_PAY = :google_pay
279
+
280
+ # Samsung Pay
281
+ SAMSUNG_PAY = :samsung_pay
282
+
283
+ # Garmin Pay
284
+ GARMIN_PAY = :garmin_pay
285
+
286
+ # Unknown
287
+ UNKNOWN = :unknown
288
+
289
+ # @!method self.values
290
+ # @return [Array<Symbol>]
291
+ end
292
+
293
+ # A constant representing the object's type. For this resource it will always be
294
+ # `digital_wallet_token_request`.
295
+ #
296
+ # @see Increase::Models::DigitalWalletTokenRequest#type
297
+ module Type
298
+ extend Increase::Internal::Type::Enum
299
+
300
+ DIGITAL_WALLET_TOKEN_REQUEST = :digital_wallet_token_request
301
+
302
+ # @!method self.values
303
+ # @return [Array<Symbol>]
304
+ end
305
+ end
306
+ end
307
+ end