increase 1.356.0 → 1.358.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 (107) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/lib/increase/internal/transport/base_client.rb +1 -2
  4. data/lib/increase/models/account_statement.rb +12 -8
  5. data/lib/increase/models/card.rb +106 -1
  6. data/lib/increase/models/card_create_params.rb +63 -1
  7. data/lib/increase/models/card_payment.rb +37 -1
  8. data/lib/increase/models/card_renew_params.rb +22 -0
  9. data/lib/increase/models/check_deposit.rb +3 -0
  10. data/lib/increase/models/declined_transaction.rb +3 -0
  11. data/lib/increase/models/digital_card_profile.rb +12 -9
  12. data/lib/increase/models/digital_card_profile_clone_params.rb +12 -9
  13. data/lib/increase/models/digital_card_profile_create_params.rb +12 -9
  14. data/lib/increase/models/entity_create_params.rb +8 -4
  15. data/lib/increase/models/entity_update_params.rb +8 -4
  16. data/lib/increase/models/event.rb +3 -0
  17. data/lib/increase/models/event_list_params.rb +7 -4
  18. data/lib/increase/models/event_subscription.rb +3 -0
  19. data/lib/increase/models/event_subscription_create_params.rb +3 -0
  20. data/lib/increase/models/export.rb +12 -12
  21. data/lib/increase/models/export_create_params.rb +19 -18
  22. data/lib/increase/models/file.rb +1 -1
  23. data/lib/increase/models/file_create_params.rb +1 -1
  24. data/lib/increase/models/file_list_params.rb +1 -1
  25. data/lib/increase/models/inbound_check_deposit.rb +9 -7
  26. data/lib/increase/models/inbound_fednow_transfer.rb +12 -3
  27. data/lib/increase/models/pending_transaction.rb +9 -6
  28. data/lib/increase/models/physical_card.rb +32 -2
  29. data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +3 -0
  30. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +3 -0
  31. data/lib/increase/models/transaction.rb +24 -0
  32. data/lib/increase/models/unwrap_webhook_event.rb +3 -0
  33. data/lib/increase/models.rb +2 -0
  34. data/lib/increase/resources/cards.rb +29 -1
  35. data/lib/increase/resources/digital_card_profiles.rb +12 -8
  36. data/lib/increase/resources/events.rb +2 -2
  37. data/lib/increase/resources/files.rb +3 -1
  38. data/lib/increase/resources/intrafi_account_enrollments.rb +2 -2
  39. data/lib/increase/resources/physical_card_profiles.rb +1 -1
  40. data/lib/increase/resources/supplemental_documents.rb +2 -2
  41. data/lib/increase/version.rb +1 -1
  42. data/lib/increase.rb +1 -0
  43. data/rbi/increase/models/account_statement.rbi +12 -8
  44. data/rbi/increase/models/card.rbi +162 -0
  45. data/rbi/increase/models/card_create_params.rbi +120 -0
  46. data/rbi/increase/models/card_payment.rbi +85 -1
  47. data/rbi/increase/models/card_renew_params.rbi +40 -0
  48. data/rbi/increase/models/check_deposit.rbi +7 -0
  49. data/rbi/increase/models/declined_transaction.rbi +7 -0
  50. data/rbi/increase/models/digital_card_profile.rbi +10 -8
  51. data/rbi/increase/models/digital_card_profile_clone_params.rbi +13 -11
  52. data/rbi/increase/models/digital_card_profile_create_params.rbi +13 -8
  53. data/rbi/increase/models/entity_create_params.rbi +8 -4
  54. data/rbi/increase/models/entity_update_params.rbi +8 -4
  55. data/rbi/increase/models/event.rbi +7 -0
  56. data/rbi/increase/models/event_list_params.rbi +11 -4
  57. data/rbi/increase/models/event_subscription.rbi +7 -0
  58. data/rbi/increase/models/event_subscription_create_params.rbi +7 -0
  59. data/rbi/increase/models/export.rbi +12 -12
  60. data/rbi/increase/models/export_create_params.rbi +18 -18
  61. data/rbi/increase/models/file.rbi +1 -1
  62. data/rbi/increase/models/file_create_params.rbi +1 -1
  63. data/rbi/increase/models/file_list_params.rbi +1 -1
  64. data/rbi/increase/models/inbound_check_deposit.rbi +13 -6
  65. data/rbi/increase/models/inbound_fednow_transfer.rbi +10 -2
  66. data/rbi/increase/models/pending_transaction.rbi +13 -6
  67. data/rbi/increase/models/physical_card.rbi +28 -0
  68. data/rbi/increase/models/simulations/check_deposit_adjustment_params.rbi +7 -0
  69. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +7 -0
  70. data/rbi/increase/models/transaction.rbi +56 -0
  71. data/rbi/increase/models/unwrap_webhook_event.rbi +7 -0
  72. data/rbi/increase/models.rbi +2 -0
  73. data/rbi/increase/resources/cards.rbi +22 -0
  74. data/rbi/increase/resources/digital_card_profiles.rbi +10 -8
  75. data/rbi/increase/resources/events.rbi +2 -2
  76. data/rbi/increase/resources/files.rbi +3 -1
  77. data/rbi/increase/resources/intrafi_account_enrollments.rbi +2 -2
  78. data/rbi/increase/resources/physical_card_profiles.rbi +1 -1
  79. data/rbi/increase/resources/supplemental_documents.rbi +2 -2
  80. data/sig/increase/models/card.rbs +79 -0
  81. data/sig/increase/models/card_create_params.rbs +52 -1
  82. data/sig/increase/models/card_payment.rbs +49 -1
  83. data/sig/increase/models/card_renew_params.rbs +23 -0
  84. data/sig/increase/models/check_deposit.rbs +8 -1
  85. data/sig/increase/models/declined_transaction.rbs +4 -0
  86. data/sig/increase/models/digital_card_profile.rbs +5 -5
  87. data/sig/increase/models/digital_card_profile_clone_params.rbs +7 -7
  88. data/sig/increase/models/digital_card_profile_create_params.rbs +7 -5
  89. data/sig/increase/models/event.rbs +4 -0
  90. data/sig/increase/models/event_list_params.rbs +4 -0
  91. data/sig/increase/models/event_subscription.rbs +4 -0
  92. data/sig/increase/models/event_subscription_create_params.rbs +4 -0
  93. data/sig/increase/models/file.rbs +1 -1
  94. data/sig/increase/models/file_create_params.rbs +1 -1
  95. data/sig/increase/models/file_list_params.rbs +1 -1
  96. data/sig/increase/models/inbound_check_deposit.rbs +12 -9
  97. data/sig/increase/models/inbound_fednow_transfer.rbs +5 -0
  98. data/sig/increase/models/pending_transaction.rbs +4 -0
  99. data/sig/increase/models/physical_card.rbs +15 -0
  100. data/sig/increase/models/simulations/check_deposit_adjustment_params.rbs +4 -0
  101. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +4 -1
  102. data/sig/increase/models/transaction.rbs +32 -0
  103. data/sig/increase/models/unwrap_webhook_event.rbs +4 -0
  104. data/sig/increase/models.rbs +2 -0
  105. data/sig/increase/resources/cards.rbs +6 -0
  106. data/sig/increase/resources/digital_card_profiles.rbs +2 -2
  107. metadata +5 -2
@@ -228,7 +228,8 @@ module Increase
228
228
  # @!attribute industry_code
229
229
  # The North American Industry Classification System (NAICS) code for the
230
230
  # corporation's primary line of business. This is a number, like `5132` for
231
- # `Software Publishers`. A full list of classification codes is available
231
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
232
+ # classification codes is available
232
233
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
233
234
  #
234
235
  # @return [String, nil]
@@ -280,7 +281,8 @@ module Increase
280
281
  # @param industry_code [String]
281
282
  # The North American Industry Classification System (NAICS) code for the
282
283
  # corporation's primary line of business. This is a number, like `5132` for
283
- # `Software Publishers`. A full list of classification codes is available
284
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
285
+ # classification codes is available
284
286
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
285
287
  #
286
288
  # @param website [String]
@@ -1749,7 +1751,8 @@ module Increase
1749
1751
  # @!attribute industry_code
1750
1752
  # The North American Industry Classification System (NAICS) code for the sole
1751
1753
  # proprietorship's primary line of business. This is a number, like `5132` for
1752
- # `Software Publishers`. A full list of classification codes is available
1754
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
1755
+ # classification codes is available
1753
1756
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1754
1757
  #
1755
1758
  # @return [String, nil]
@@ -1792,7 +1795,8 @@ module Increase
1792
1795
  # @param industry_code [String]
1793
1796
  # The North American Industry Classification System (NAICS) code for the sole
1794
1797
  # proprietorship's primary line of business. This is a number, like `5132` for
1795
- # `Software Publishers`. A full list of classification codes is available
1798
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
1799
+ # classification codes is available
1796
1800
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
1797
1801
  #
1798
1802
  # @param tax_identifier [String]
@@ -147,7 +147,8 @@ module Increase
147
147
  # @!attribute industry_code
148
148
  # The North American Industry Classification System (NAICS) code for the
149
149
  # corporation's primary line of business. This is a number, like `5132` for
150
- # `Software Publishers`. A full list of classification codes is available
150
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
151
+ # classification codes is available
151
152
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
152
153
  #
153
154
  # @return [String, nil]
@@ -192,7 +193,8 @@ module Increase
192
193
  # @param industry_code [String]
193
194
  # The North American Industry Classification System (NAICS) code for the
194
195
  # corporation's primary line of business. This is a number, like `5132` for
195
- # `Software Publishers`. A full list of classification codes is available
196
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
197
+ # classification codes is available
196
198
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
197
199
  #
198
200
  # @param legal_identifier [Increase::Models::EntityUpdateParams::Corporation::LegalIdentifier]
@@ -791,7 +793,8 @@ module Increase
791
793
  # @!attribute industry_code
792
794
  # The North American Industry Classification System (NAICS) code for the sole
793
795
  # proprietorship's primary line of business. This is a number, like `5132` for
794
- # `Software Publishers`. A full list of classification codes is available
796
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
797
+ # classification codes is available
795
798
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
796
799
  #
797
800
  # @return [String, nil]
@@ -832,7 +835,8 @@ module Increase
832
835
  # @param industry_code [String]
833
836
  # The North American Industry Classification System (NAICS) code for the sole
834
837
  # proprietorship's primary line of business. This is a number, like `5132` for
835
- # `Software Publishers`. A full list of classification codes is available
838
+ # `Software Publishers`. Increase uses the 2022 version of NAICS. A full list of
839
+ # classification codes is available
836
840
  # [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
837
841
  #
838
842
  # @param sole_proprietor [Increase::Models::EntityUpdateParams::SoleProprietorship::SoleProprietor]
@@ -185,6 +185,9 @@ module Increase
185
185
  # Occurs whenever a Digital Wallet Token is updated.
186
186
  DIGITAL_WALLET_TOKEN_UPDATED = :"digital_wallet_token.updated"
187
187
 
188
+ # Occurs whenever a Digital Wallet Token Request is created.
189
+ DIGITAL_WALLET_TOKEN_REQUEST_CREATED = :"digital_wallet_token_request.created"
190
+
188
191
  # Occurs whenever an Entity is created.
189
192
  ENTITY_CREATED = :"entity.created"
190
193
 
@@ -30,8 +30,8 @@ module Increase
30
30
  optional :cursor, String
31
31
 
32
32
  # @!attribute limit
33
- # Limit the size of the list that is returned. The default (and maximum) is 100
34
- # objects.
33
+ # Limit the size of the list that is returned. The default is 100 objects and the
34
+ # maximum is 1,000.
35
35
  #
36
36
  # Defaults to `100`.
37
37
  #
@@ -54,8 +54,8 @@ module Increase
54
54
  # @param cursor [String] Return the page of entries after this one.
55
55
  #
56
56
  # @param limit [Integer]
57
- # Limit the size of the list that is returned. The default (and maximum) is 100
58
- # objects.
57
+ # Limit the size of the list that is returned. The default is 100 objects and the
58
+ # maximum is 1,000.
59
59
  #
60
60
  # Defaults to `100`.
61
61
  #
@@ -197,6 +197,9 @@ module Increase
197
197
  # Occurs whenever a Digital Wallet Token is updated.
198
198
  DIGITAL_WALLET_TOKEN_UPDATED = :"digital_wallet_token.updated"
199
199
 
200
+ # Occurs whenever a Digital Wallet Token Request is created.
201
+ DIGITAL_WALLET_TOKEN_REQUEST_CREATED = :"digital_wallet_token_request.created"
202
+
200
203
  # Occurs whenever an Entity is created.
201
204
  ENTITY_CREATED = :"entity.created"
202
205
 
@@ -226,6 +226,9 @@ module Increase
226
226
  # Occurs whenever a Digital Wallet Token is updated.
227
227
  DIGITAL_WALLET_TOKEN_UPDATED = :"digital_wallet_token.updated"
228
228
 
229
+ # Occurs whenever a Digital Wallet Token Request is created.
230
+ DIGITAL_WALLET_TOKEN_REQUEST_CREATED = :"digital_wallet_token_request.created"
231
+
229
232
  # Occurs whenever an Entity is created.
230
233
  ENTITY_CREATED = :"entity.created"
231
234
 
@@ -195,6 +195,9 @@ module Increase
195
195
  # Occurs whenever a Digital Wallet Token is updated.
196
196
  DIGITAL_WALLET_TOKEN_UPDATED = :"digital_wallet_token.updated"
197
197
 
198
+ # Occurs whenever a Digital Wallet Token Request is created.
199
+ DIGITAL_WALLET_TOKEN_REQUEST_CREATED = :"digital_wallet_token_request.created"
200
+
198
201
  # Occurs whenever an Entity is created.
199
202
  ENTITY_CREATED = :"entity.created"
200
203
 
@@ -257,7 +257,7 @@ module Increase
257
257
  required :account_id, String, nil?: true
258
258
 
259
259
  # @!attribute effective_date
260
- # The date for which to retrieve the balance.
260
+ # The UTC date for which to retrieve the balance.
261
261
  #
262
262
  # @return [Date, nil]
263
263
  required :effective_date, Date, nil?: true
@@ -274,7 +274,7 @@ module Increase
274
274
  #
275
275
  # @param account_id [String, nil] Filter results by Account.
276
276
  #
277
- # @param effective_date [Date, nil] The date for which to retrieve the balance.
277
+ # @param effective_date [Date, nil] The UTC date for which to retrieve the balance.
278
278
  #
279
279
  # @param program_id [String, nil] Filter results by Program.
280
280
  end
@@ -334,7 +334,7 @@ module Increase
334
334
  required :account_number_id, String
335
335
 
336
336
  # @!attribute balance_date
337
- # The date of the balance to include in the letter.
337
+ # The UTC date of the balance to include in the letter.
338
338
  #
339
339
  # @return [Date, nil]
340
340
  required :balance_date, Date, nil?: true
@@ -345,7 +345,7 @@ module Increase
345
345
  #
346
346
  # @param account_number_id [String] The Account Number to create a letter for.
347
347
  #
348
- # @param balance_date [Date, nil] The date of the balance to include in the letter.
348
+ # @param balance_date [Date, nil] The UTC date of the balance to include in the letter.
349
349
  end
350
350
 
351
351
  # @see Increase::Models::Export#balance_csv
@@ -403,13 +403,13 @@ module Increase
403
403
  required :bookkeeping_account_id, String, nil?: true
404
404
 
405
405
  # @!attribute on_or_after_date
406
- # Filter balances to those on or after this date.
406
+ # Filter balances to those on or after this UTC date.
407
407
  #
408
408
  # @return [Date, nil]
409
409
  required :on_or_after_date, Date, nil?: true
410
410
 
411
411
  # @!attribute on_or_before_date
412
- # Filter balances to those on or before this date.
412
+ # Filter balances to those on or before this UTC date.
413
413
  #
414
414
  # @return [Date, nil]
415
415
  required :on_or_before_date, Date, nil?: true
@@ -420,9 +420,9 @@ module Increase
420
420
  #
421
421
  # @param bookkeeping_account_id [String, nil] Filter results by Bookkeeping Account.
422
422
  #
423
- # @param on_or_after_date [Date, nil] Filter balances to those on or after this date.
423
+ # @param on_or_after_date [Date, nil] Filter balances to those on or after this UTC date.
424
424
  #
425
- # @param on_or_before_date [Date, nil] Filter balances to those on or before this date.
425
+ # @param on_or_before_date [Date, nil] Filter balances to those on or before this UTC date.
426
426
  end
427
427
 
428
428
  # The category of the Export. We may add additional possible values for this enum
@@ -490,13 +490,13 @@ module Increase
490
490
  required :account_id, String, nil?: true
491
491
 
492
492
  # @!attribute on_or_after_date
493
- # Filter balances on or after this date.
493
+ # Filter balances on or after this UTC date.
494
494
  #
495
495
  # @return [Date, nil]
496
496
  required :on_or_after_date, Date, nil?: true
497
497
 
498
498
  # @!attribute on_or_before_date
499
- # Filter balances on or before this date.
499
+ # Filter balances on or before this UTC date.
500
500
  #
501
501
  # @return [Date, nil]
502
502
  required :on_or_before_date, Date, nil?: true
@@ -507,9 +507,9 @@ module Increase
507
507
  #
508
508
  # @param account_id [String, nil] Filter results by Account.
509
509
  #
510
- # @param on_or_after_date [Date, nil] Filter balances on or after this date.
510
+ # @param on_or_after_date [Date, nil] Filter balances on or after this UTC date.
511
511
  #
512
- # @param on_or_before_date [Date, nil] Filter balances on or before this date.
512
+ # @param on_or_before_date [Date, nil] Filter balances on or before this UTC date.
513
513
  end
514
514
 
515
515
  # @see Increase::Models::Export#dashboard_table_csv
@@ -187,10 +187,9 @@ module Increase
187
187
  optional :account_id, String
188
188
 
189
189
  # @!attribute effective_date
190
- # The date to create a BAI2 report for. If not provided, the current date will be
191
- # used. The timezone is UTC. If the current date is used, the report will include
192
- # intraday balances, otherwise it will include end-of-day balances for the
193
- # provided date.
190
+ # The UTC date to create a BAI2 report for. If not provided, the current date will
191
+ # be used. If the current date is used, the report will include intraday balances,
192
+ # otherwise it will include end-of-day balances for the provided date.
194
193
  #
195
194
  # @return [Date, nil]
196
195
  optional :effective_date, Date
@@ -211,10 +210,9 @@ module Increase
211
210
  # be included.
212
211
  #
213
212
  # @param effective_date [Date]
214
- # The date to create a BAI2 report for. If not provided, the current date will be
215
- # used. The timezone is UTC. If the current date is used, the report will include
216
- # intraday balances, otherwise it will include end-of-day balances for the
217
- # provided date.
213
+ # The UTC date to create a BAI2 report for. If not provided, the current date will
214
+ # be used. If the current date is used, the report will include intraday balances,
215
+ # otherwise it will include end-of-day balances for the provided date.
218
216
  #
219
217
  # @param program_id [String]
220
218
  # The Program to create a BAI2 report for. If not provided, all open accounts will
@@ -274,7 +272,8 @@ module Increase
274
272
  required :account_number_id, String
275
273
 
276
274
  # @!attribute balance_date
277
- # The date of the balance to include in the letter. Defaults to the current date.
275
+ # The UTC date of the balance to include in the letter. Defaults to the current
276
+ # date.
278
277
  #
279
278
  # @return [Date, nil]
280
279
  optional :balance_date, Date
@@ -285,7 +284,9 @@ module Increase
285
284
  #
286
285
  # @param account_number_id [String] The Account Number to create a letter for.
287
286
  #
288
- # @param balance_date [Date] The date of the balance to include in the letter. Defaults to the current date.
287
+ # @param balance_date [Date]
288
+ # The UTC date of the balance to include in the letter. Defaults to the current
289
+ # date.
289
290
  end
290
291
 
291
292
  class BookkeepingAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -297,13 +298,13 @@ module Increase
297
298
  optional :bookkeeping_account_id, String
298
299
 
299
300
  # @!attribute on_or_after_date
300
- # Filter exported Balances to those on or after this date.
301
+ # Filter exported Balances to those on or after this UTC date.
301
302
  #
302
303
  # @return [Date, nil]
303
304
  optional :on_or_after_date, Date
304
305
 
305
306
  # @!attribute on_or_before_date
306
- # Filter exported Balances to those on or before this date.
307
+ # Filter exported Balances to those on or before this UTC date.
307
308
  #
308
309
  # @return [Date, nil]
309
310
  optional :on_or_before_date, Date
@@ -316,9 +317,9 @@ module Increase
316
317
  # Filter exported Bookkeeping Account Balances to the specified Bookkeeping
317
318
  # Account.
318
319
  #
319
- # @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
320
+ # @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
320
321
  #
321
- # @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
322
+ # @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
322
323
  end
323
324
 
324
325
  class DailyAccountBalanceCsv < Increase::Internal::Type::BaseModel
@@ -329,13 +330,13 @@ module Increase
329
330
  optional :account_id, String
330
331
 
331
332
  # @!attribute on_or_after_date
332
- # Filter exported Balances to those on or after this date.
333
+ # Filter exported Balances to those on or after this UTC date.
333
334
  #
334
335
  # @return [Date, nil]
335
336
  optional :on_or_after_date, Date
336
337
 
337
338
  # @!attribute on_or_before_date
338
- # Filter exported Balances to those on or before this date.
339
+ # Filter exported Balances to those on or before this UTC date.
339
340
  #
340
341
  # @return [Date, nil]
341
342
  optional :on_or_before_date, Date
@@ -346,9 +347,9 @@ module Increase
346
347
  #
347
348
  # @param account_id [String] Filter exported Balances to the specified Account.
348
349
  #
349
- # @param on_or_after_date [Date] Filter exported Balances to those on or after this date.
350
+ # @param on_or_after_date [Date] Filter exported Balances to those on or after this UTC date.
350
351
  #
351
- # @param on_or_before_date [Date] Filter exported Balances to those on or before this date.
352
+ # @param on_or_before_date [Date] Filter exported Balances to those on or before this UTC date.
352
353
  end
353
354
 
354
355
  class EntityCsv < Increase::Internal::Type::BaseModel
@@ -177,7 +177,7 @@ module Increase
177
177
  # A legal document forming a trust.
178
178
  TRUST_FORMATION_DOCUMENT = :trust_formation_document
179
179
 
180
- # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
180
+ # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
181
181
  DIGITAL_WALLET_ARTWORK = :digital_wallet_artwork
182
182
 
183
183
  # An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
@@ -86,7 +86,7 @@ module Increase
86
86
  # A legal document forming a trust.
87
87
  TRUST_FORMATION_DOCUMENT = :trust_formation_document
88
88
 
89
- # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
89
+ # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
90
90
  DIGITAL_WALLET_ARTWORK = :digital_wallet_artwork
91
91
 
92
92
  # An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
@@ -181,7 +181,7 @@ module Increase
181
181
  # A legal document forming a trust.
182
182
  TRUST_FORMATION_DOCUMENT = :trust_formation_document
183
183
 
184
- # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
184
+ # A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG with the Visa Brand Mark sized and placed as in the digital card template.
185
185
  DIGITAL_WALLET_ARTWORK = :digital_wallet_artwork
186
186
 
187
187
  # An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
@@ -54,8 +54,8 @@ module Increase
54
54
  # @!attribute back_image_file_id
55
55
  # The ID for the File containing the image of the back of the check.
56
56
  #
57
- # @return [String, nil]
58
- required :back_image_file_id, String, nil?: true
57
+ # @return [String]
58
+ required :back_image_file_id, String
59
59
 
60
60
  # @!attribute bank_of_first_deposit_routing_number
61
61
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
@@ -116,8 +116,8 @@ module Increase
116
116
  # @!attribute front_image_file_id
117
117
  # The ID for the File containing the image of the front of the check.
118
118
  #
119
- # @return [String, nil]
120
- required :front_image_file_id, String, nil?: true
119
+ # @return [String]
120
+ required :front_image_file_id, String
121
121
 
122
122
  # @!attribute payee_name_analysis
123
123
  # Whether the details on the check match the recipient name of the check transfer.
@@ -172,7 +172,7 @@ module Increase
172
172
  # the Inbound Check Deposit will be automatically resolved if it has not been
173
173
  # actioned by then.
174
174
  #
175
- # @param back_image_file_id [String, nil] The ID for the File containing the image of the back of the check.
175
+ # @param back_image_file_id [String] The ID for the File containing the image of the back of the check.
176
176
  #
177
177
  # @param bank_of_first_deposit_routing_number [String, nil]
178
178
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
@@ -205,8 +205,7 @@ module Increase
205
205
  # If you requested a return of this deposit, this will contain details of the
206
206
  # return.
207
207
  #
208
- # @param front_image_file_id [String, nil]
209
- # The ID for the File containing the image of the front of the check.
208
+ # @param front_image_file_id [String] The ID for the File containing the image of the front of the check.
210
209
  #
211
210
  # @param payee_name_analysis [Symbol, Increase::Models::InboundCheckDeposit::PayeeNameAnalysis]
212
211
  # Whether the details on the check match the recipient name of the check transfer.
@@ -273,6 +272,9 @@ module Increase
273
272
  # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
274
273
  WRONG_PAYEE_CREDIT = :wrong_payee_credit
275
274
 
275
+ # A previous adjustment for the check was applied twice and the duplicate has been reversed.
276
+ DUPLICATE_ENTRY = :duplicate_entry
277
+
276
278
  # @!method self.values
277
279
  # @return [Array<Symbol>]
278
280
  end
@@ -84,6 +84,12 @@ module Increase
84
84
  # @return [String, nil]
85
85
  required :end_to_end_identification, String, nil?: true
86
86
 
87
+ # @!attribute message_identification
88
+ # The FedNow network identification of the transfer.
89
+ #
90
+ # @return [String]
91
+ required :message_identification, String
92
+
87
93
  # @!attribute status
88
94
  # The lifecycle status of the transfer.
89
95
  #
@@ -98,7 +104,7 @@ module Increase
98
104
  required :transaction_id, String, nil?: true
99
105
 
100
106
  # @!attribute transaction_identification
101
- # The FedNow network identification of the transfer.
107
+ # An optional identifier for the transfer set by the sending bank.
102
108
  #
103
109
  # @return [String, nil]
104
110
  required :transaction_identification, String, nil?: true
@@ -124,7 +130,7 @@ module Increase
124
130
  # @return [String, nil]
125
131
  required :unstructured_remittance_information, String, nil?: true
126
132
 
127
- # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
133
+ # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, end_to_end_identification:, message_identification:, status:, transaction_id:, transaction_identification:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
128
134
  # An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
129
135
  # your account.
130
136
  #
@@ -162,6 +168,8 @@ module Increase
162
168
  # @param end_to_end_identification [String, nil]
163
169
  # A free-form reference string set by the sender, to help identify the transfer.
164
170
  #
171
+ # @param message_identification [String] The FedNow network identification of the transfer.
172
+ #
165
173
  # @param status [Symbol, Increase::Models::InboundFednowTransfer::Status]
166
174
  # The lifecycle status of the transfer.
167
175
  #
@@ -169,7 +177,8 @@ module Increase
169
177
  # The identifier of the Transaction object created when the transfer was
170
178
  # confirmed.
171
179
  #
172
- # @param transaction_identification [String, nil] The FedNow network identification of the transfer.
180
+ # @param transaction_identification [String, nil]
181
+ # An optional identifier for the transfer set by the sending bank.
173
182
  #
174
183
  # @param type [Symbol, Increase::Models::InboundFednowTransfer::Type]
175
184
  # A constant representing the object's type. For this resource it will always be
@@ -19,9 +19,9 @@ module Increase
19
19
  # @!attribute amount
20
20
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
21
21
  # for example, this is cents. For a card authorization this is the amount still
22
- # held: it decreases when the merchant reverses part of the authorization. The
23
- # amount that settled is available on the resulting Transaction and on the Card
24
- # Payment's `state.settled_amount`.
22
+ # held: it decreases when the merchant reverses or partially settles the
23
+ # authorization. The amount that settled is available on the resulting Transaction
24
+ # and on the Card Payment's `state.settled_amount`.
25
25
  #
26
26
  # @return [Integer]
27
27
  required :amount, Integer
@@ -112,9 +112,9 @@ module Increase
112
112
  # @param amount [Integer]
113
113
  # The Pending Transaction amount in the minor unit of its currency. For dollars,
114
114
  # for example, this is cents. For a card authorization this is the amount still
115
- # held: it decreases when the merchant reverses part of the authorization. The
116
- # amount that settled is available on the resulting Transaction and on the Card
117
- # Payment's `state.settled_amount`.
115
+ # held: it decreases when the merchant reverses or partially settles the
116
+ # authorization. The amount that settled is available on the resulting Transaction
117
+ # and on the Card Payment's `state.settled_amount`.
118
118
  #
119
119
  # @param completed_at [Time, nil]
120
120
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
@@ -2212,6 +2212,9 @@ module Increase
2212
2212
  # Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
2213
2213
  PULSE_SWITCH_FEE = :pulse_switch_fee
2214
2214
 
2215
+ # Pulse Tokenization Fee is a fee charged by the Pulse network for processing tokenized transactions on its network.
2216
+ PULSE_TOKENIZATION_FEE = :pulse_tokenization_fee
2217
+
2215
2218
  # @!method self.values
2216
2219
  # @return [Array<Symbol>]
2217
2220
  end
@@ -35,6 +35,20 @@ module Increase
35
35
  # @return [Time]
36
36
  required :created_at, Time
37
37
 
38
+ # @!attribute expiration_month
39
+ # The month printed on the Physical Card as its expiration, in M format (e.g.,
40
+ # August is 8). This stays the same when the Card is renewed.
41
+ #
42
+ # @return [Integer]
43
+ required :expiration_month, Integer
44
+
45
+ # @!attribute expiration_year
46
+ # The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
47
+ # 2025). This stays the same when the Card is renewed.
48
+ #
49
+ # @return [Integer]
50
+ required :expiration_year, Integer
51
+
38
52
  # @!attribute idempotency_key
39
53
  # The idempotency key you chose for this object. This value is unique across
40
54
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -68,7 +82,7 @@ module Increase
68
82
  # @return [Symbol, Increase::Models::PhysicalCard::Type]
69
83
  required :type, enum: -> { Increase::PhysicalCard::Type }
70
84
 
71
- # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
85
+ # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, expiration_month:, expiration_year:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
72
86
  # Custom physical Visa cards that are shipped to your customers. The artwork is
73
87
  # configurable by a connected [Card Profile](/documentation/api#card-profiles).
74
88
  # The same Card can be used for multiple Physical Cards. Printing cards incurs a
@@ -88,6 +102,14 @@ module Increase
88
102
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
89
103
  # the Physical Card was created.
90
104
  #
105
+ # @param expiration_month [Integer]
106
+ # The month printed on the Physical Card as its expiration, in M format (e.g.,
107
+ # August is 8). This stays the same when the Card is renewed.
108
+ #
109
+ # @param expiration_year [Integer]
110
+ # The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
111
+ # 2025). This stays the same when the Card is renewed.
112
+ #
91
113
  # @param idempotency_key [String, nil]
92
114
  # The idempotency key you chose for this object. This value is unique across
93
115
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -219,6 +241,12 @@ module Increase
219
241
  # @return [String]
220
242
  required :name, String
221
243
 
244
+ # @!attribute phone_number
245
+ # The phone number of the recipient.
246
+ #
247
+ # @return [String, nil]
248
+ required :phone_number, String, nil?: true
249
+
222
250
  # @!attribute postal_code
223
251
  # The postal code of the shipping address.
224
252
  #
@@ -231,7 +259,7 @@ module Increase
231
259
  # @return [String]
232
260
  required :state, String
233
261
 
234
- # @!method initialize(city:, country:, line1:, line2:, line3:, name:, postal_code:, state:)
262
+ # @!method initialize(city:, country:, line1:, line2:, line3:, name:, phone_number:, postal_code:, state:)
235
263
  # The location to where the card's packing label is addressed.
236
264
  #
237
265
  # @param city [String] The city of the shipping address.
@@ -246,6 +274,8 @@ module Increase
246
274
  #
247
275
  # @param name [String] The name of the recipient.
248
276
  #
277
+ # @param phone_number [String, nil] The phone number of the recipient.
278
+ #
249
279
  # @param postal_code [String] The postal code of the shipping address.
250
280
  #
251
281
  # @param state [String] The state of the shipping address.
@@ -68,6 +68,9 @@ module Increase
68
68
  # The check has already been deposited elsewhere and so this is a duplicate.
69
69
  PAID = :paid
70
70
 
71
+ # A previous adjustment for the check was applied twice and the duplicate has been reversed.
72
+ DUPLICATE_ENTRY = :duplicate_entry
73
+
71
74
  # @!method self.values
72
75
  # @return [Array<Symbol>]
73
76
  end
@@ -55,6 +55,9 @@ module Increase
55
55
  # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
56
56
  WRONG_PAYEE_CREDIT = :wrong_payee_credit
57
57
 
58
+ # A previous adjustment for the check was applied twice and the duplicate has been reversed.
59
+ DUPLICATE_ENTRY = :duplicate_entry
60
+
58
61
  # @!method self.values
59
62
  # @return [Array<Symbol>]
60
63
  end