increase 1.203.0 → 1.204.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 (47) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/account_transfer.rb +25 -25
  5. data/lib/increase/models/ach_transfer.rb +28 -28
  6. data/lib/increase/models/card_dispute.rb +79 -79
  7. data/lib/increase/models/card_payment.rb +82 -82
  8. data/lib/increase/models/card_push_transfer.rb +25 -25
  9. data/lib/increase/models/card_validation.rb +25 -25
  10. data/lib/increase/models/check_transfer.rb +25 -25
  11. data/lib/increase/models/declined_transaction.rb +53 -53
  12. data/lib/increase/models/fednow_transfer.rb +25 -25
  13. data/lib/increase/models/pending_transaction.rb +85 -85
  14. data/lib/increase/models/real_time_payments_transfer.rb +25 -25
  15. data/lib/increase/models/swift_transfer.rb +25 -25
  16. data/lib/increase/models/transaction.rb +173 -173
  17. data/lib/increase/models/wire_transfer.rb +28 -28
  18. data/lib/increase/version.rb +1 -1
  19. data/rbi/increase/models/account_transfer.rbi +40 -40
  20. data/rbi/increase/models/ach_transfer.rbi +42 -42
  21. data/rbi/increase/models/card_dispute.rbi +141 -141
  22. data/rbi/increase/models/card_payment.rbi +144 -144
  23. data/rbi/increase/models/card_push_transfer.rbi +40 -40
  24. data/rbi/increase/models/card_validation.rbi +40 -40
  25. data/rbi/increase/models/check_transfer.rbi +40 -40
  26. data/rbi/increase/models/declined_transaction.rbi +99 -99
  27. data/rbi/increase/models/fednow_transfer.rbi +40 -40
  28. data/rbi/increase/models/pending_transaction.rbi +163 -163
  29. data/rbi/increase/models/real_time_payments_transfer.rbi +44 -44
  30. data/rbi/increase/models/swift_transfer.rbi +40 -40
  31. data/rbi/increase/models/transaction.rbi +534 -534
  32. data/rbi/increase/models/wire_transfer.rbi +42 -42
  33. data/sig/increase/models/account_transfer.rbs +17 -17
  34. data/sig/increase/models/ach_transfer.rbs +19 -19
  35. data/sig/increase/models/card_dispute.rbs +56 -56
  36. data/sig/increase/models/card_payment.rbs +81 -81
  37. data/sig/increase/models/card_push_transfer.rbs +17 -17
  38. data/sig/increase/models/card_validation.rbs +17 -17
  39. data/sig/increase/models/check_transfer.rbs +17 -17
  40. data/sig/increase/models/declined_transaction.rbs +52 -52
  41. data/sig/increase/models/fednow_transfer.rbs +17 -17
  42. data/sig/increase/models/pending_transaction.rbs +92 -92
  43. data/sig/increase/models/real_time_payments_transfer.rbs +17 -17
  44. data/sig/increase/models/swift_transfer.rbs +17 -17
  45. data/sig/increase/models/transaction.rbs +202 -202
  46. data/sig/increase/models/wire_transfer.rbs +19 -19
  47. metadata +2 -2
@@ -273,55 +273,41 @@ module Increase
273
273
 
274
274
  # @see Increase::Models::WireTransfer#created_by
275
275
  class CreatedBy < Increase::Internal::Type::BaseModel
276
- # @!attribute api_key
277
- # If present, details about the API key that created the transfer.
278
- #
279
- # @return [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
280
- required :api_key, -> { Increase::WireTransfer::CreatedBy::APIKey }, nil?: true
281
-
282
276
  # @!attribute category
283
277
  # The type of object that created this transfer.
284
278
  #
285
279
  # @return [Symbol, Increase::Models::WireTransfer::CreatedBy::Category]
286
280
  required :category, enum: -> { Increase::WireTransfer::CreatedBy::Category }
287
281
 
282
+ # @!attribute api_key
283
+ # If present, details about the API key that created the transfer.
284
+ #
285
+ # @return [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
286
+ optional :api_key, -> { Increase::WireTransfer::CreatedBy::APIKey }, nil?: true
287
+
288
288
  # @!attribute oauth_application
289
289
  # If present, details about the OAuth Application that created the transfer.
290
290
  #
291
291
  # @return [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil]
292
- required :oauth_application, -> { Increase::WireTransfer::CreatedBy::OAuthApplication }, nil?: true
292
+ optional :oauth_application, -> { Increase::WireTransfer::CreatedBy::OAuthApplication }, nil?: true
293
293
 
294
294
  # @!attribute user
295
295
  # If present, details about the User that created the transfer.
296
296
  #
297
297
  # @return [Increase::Models::WireTransfer::CreatedBy::User, nil]
298
- required :user, -> { Increase::WireTransfer::CreatedBy::User }, nil?: true
298
+ optional :user, -> { Increase::WireTransfer::CreatedBy::User }, nil?: true
299
299
 
300
- # @!method initialize(api_key:, category:, oauth_application:, user:)
300
+ # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
301
301
  # What object created the transfer, either via the API or the dashboard.
302
302
  #
303
- # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
304
- #
305
303
  # @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] The type of object that created this transfer.
306
304
  #
305
+ # @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
306
+ #
307
307
  # @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
308
308
  #
309
309
  # @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
310
310
 
311
- # @see Increase::Models::WireTransfer::CreatedBy#api_key
312
- class APIKey < Increase::Internal::Type::BaseModel
313
- # @!attribute description
314
- # The description set for the API key when it was created.
315
- #
316
- # @return [String, nil]
317
- required :description, String, nil?: true
318
-
319
- # @!method initialize(description:)
320
- # If present, details about the API key that created the transfer.
321
- #
322
- # @param description [String, nil] The description set for the API key when it was created.
323
- end
324
-
325
311
  # The type of object that created this transfer.
326
312
  #
327
313
  # @see Increase::Models::WireTransfer::CreatedBy#category
@@ -341,6 +327,20 @@ module Increase
341
327
  # @return [Array<Symbol>]
342
328
  end
343
329
 
330
+ # @see Increase::Models::WireTransfer::CreatedBy#api_key
331
+ class APIKey < Increase::Internal::Type::BaseModel
332
+ # @!attribute description
333
+ # The description set for the API key when it was created.
334
+ #
335
+ # @return [String, nil]
336
+ required :description, String, nil?: true
337
+
338
+ # @!method initialize(description:)
339
+ # If present, details about the API key that created the transfer.
340
+ #
341
+ # @param description [String, nil] The description set for the API key when it was created.
342
+ end
343
+
344
344
  # @see Increase::Models::WireTransfer::CreatedBy#oauth_application
345
345
  class OAuthApplication < Increase::Internal::Type::BaseModel
346
346
  # @!attribute name
@@ -541,16 +541,16 @@ module Increase
541
541
  # is equal to `tax`.
542
542
  #
543
543
  # @return [Increase::Models::WireTransfer::Remittance::Tax, nil]
544
- required :tax, -> { Increase::WireTransfer::Remittance::Tax }, nil?: true
544
+ optional :tax, -> { Increase::WireTransfer::Remittance::Tax }, nil?: true
545
545
 
546
546
  # @!attribute unstructured
547
547
  # Unstructured remittance information. Required if `category` is equal to
548
548
  # `unstructured`.
549
549
  #
550
550
  # @return [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
551
- required :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
551
+ optional :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
552
552
 
553
- # @!method initialize(category:, tax:, unstructured:)
553
+ # @!method initialize(category:, tax: nil, unstructured: nil)
554
554
  # Some parameter documentations has been truncated, see
555
555
  # {Increase::Models::WireTransfer::Remittance} for more details.
556
556
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.203.0"
4
+ VERSION = "1.204.0"
5
5
  end
@@ -309,6 +309,12 @@ module Increase
309
309
  )
310
310
  end
311
311
 
312
+ # The type of object that created this transfer.
313
+ sig do
314
+ returns(Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol)
315
+ end
316
+ attr_accessor :category
317
+
312
318
  # If present, details about the API key that created the transfer.
313
319
  sig { returns(T.nilable(Increase::AccountTransfer::CreatedBy::APIKey)) }
314
320
  attr_reader :api_key
@@ -321,12 +327,6 @@ module Increase
321
327
  end
322
328
  attr_writer :api_key
323
329
 
324
- # The type of object that created this transfer.
325
- sig do
326
- returns(Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol)
327
- end
328
- attr_accessor :category
329
-
330
330
  # If present, details about the OAuth Application that created the transfer.
331
331
  sig do
332
332
  returns(
@@ -359,9 +359,9 @@ module Increase
359
359
  # What object created the transfer, either via the API or the dashboard.
360
360
  sig do
361
361
  params(
362
+ category: Increase::AccountTransfer::CreatedBy::Category::OrSymbol,
362
363
  api_key:
363
364
  T.nilable(Increase::AccountTransfer::CreatedBy::APIKey::OrHash),
364
- category: Increase::AccountTransfer::CreatedBy::Category::OrSymbol,
365
365
  oauth_application:
366
366
  T.nilable(
367
367
  Increase::AccountTransfer::CreatedBy::OAuthApplication::OrHash
@@ -370,23 +370,23 @@ module Increase
370
370
  ).returns(T.attached_class)
371
371
  end
372
372
  def self.new(
373
- # If present, details about the API key that created the transfer.
374
- api_key:,
375
373
  # The type of object that created this transfer.
376
374
  category:,
375
+ # If present, details about the API key that created the transfer.
376
+ api_key: nil,
377
377
  # If present, details about the OAuth Application that created the transfer.
378
- oauth_application:,
378
+ oauth_application: nil,
379
379
  # If present, details about the User that created the transfer.
380
- user:
380
+ user: nil
381
381
  )
382
382
  end
383
383
 
384
384
  sig do
385
385
  override.returns(
386
386
  {
387
- api_key: T.nilable(Increase::AccountTransfer::CreatedBy::APIKey),
388
387
  category:
389
388
  Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol,
389
+ api_key: T.nilable(Increase::AccountTransfer::CreatedBy::APIKey),
390
390
  oauth_application:
391
391
  T.nilable(
392
392
  Increase::AccountTransfer::CreatedBy::OAuthApplication
@@ -398,34 +398,6 @@ module Increase
398
398
  def to_hash
399
399
  end
400
400
 
401
- class APIKey < Increase::Internal::Type::BaseModel
402
- OrHash =
403
- T.type_alias do
404
- T.any(
405
- Increase::AccountTransfer::CreatedBy::APIKey,
406
- Increase::Internal::AnyHash
407
- )
408
- end
409
-
410
- # The description set for the API key when it was created.
411
- sig { returns(T.nilable(String)) }
412
- attr_accessor :description
413
-
414
- # If present, details about the API key that created the transfer.
415
- sig do
416
- params(description: T.nilable(String)).returns(T.attached_class)
417
- end
418
- def self.new(
419
- # The description set for the API key when it was created.
420
- description:
421
- )
422
- end
423
-
424
- sig { override.returns({ description: T.nilable(String) }) }
425
- def to_hash
426
- end
427
- end
428
-
429
401
  # The type of object that created this transfer.
430
402
  module Category
431
403
  extend Increase::Internal::Type::Enum
@@ -468,6 +440,34 @@ module Increase
468
440
  end
469
441
  end
470
442
 
443
+ class APIKey < Increase::Internal::Type::BaseModel
444
+ OrHash =
445
+ T.type_alias do
446
+ T.any(
447
+ Increase::AccountTransfer::CreatedBy::APIKey,
448
+ Increase::Internal::AnyHash
449
+ )
450
+ end
451
+
452
+ # The description set for the API key when it was created.
453
+ sig { returns(T.nilable(String)) }
454
+ attr_accessor :description
455
+
456
+ # If present, details about the API key that created the transfer.
457
+ sig do
458
+ params(description: T.nilable(String)).returns(T.attached_class)
459
+ end
460
+ def self.new(
461
+ # The description set for the API key when it was created.
462
+ description:
463
+ )
464
+ end
465
+
466
+ sig { override.returns({ description: T.nilable(String) }) }
467
+ def to_hash
468
+ end
469
+ end
470
+
471
471
  class OAuthApplication < Increase::Internal::Type::BaseModel
472
472
  OrHash =
473
473
  T.type_alias do
@@ -546,10 +546,10 @@ module Increase
546
546
  # over time; your application should be able to handle such additions gracefully.
547
547
  category:,
548
548
  # Unstructured `payment_related_information` passed through with the transfer.
549
- freeform:,
549
+ freeform: nil,
550
550
  # Structured ASC X12 820 remittance advice records. Please reach out to
551
551
  # [support@increase.com](mailto:support@increase.com) for more information.
552
- payment_order_remittance_advice:
552
+ payment_order_remittance_advice: nil
553
553
  )
554
554
  end
555
555
 
@@ -862,6 +862,12 @@ module Increase
862
862
  T.any(Increase::ACHTransfer::CreatedBy, Increase::Internal::AnyHash)
863
863
  end
864
864
 
865
+ # The type of object that created this transfer.
866
+ sig do
867
+ returns(Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol)
868
+ end
869
+ attr_accessor :category
870
+
865
871
  # If present, details about the API key that created the transfer.
866
872
  sig { returns(T.nilable(Increase::ACHTransfer::CreatedBy::APIKey)) }
867
873
  attr_reader :api_key
@@ -873,12 +879,6 @@ module Increase
873
879
  end
874
880
  attr_writer :api_key
875
881
 
876
- # The type of object that created this transfer.
877
- sig do
878
- returns(Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol)
879
- end
880
- attr_accessor :category
881
-
882
882
  # If present, details about the OAuth Application that created the transfer.
883
883
  sig do
884
884
  returns(T.nilable(Increase::ACHTransfer::CreatedBy::OAuthApplication))
@@ -909,9 +909,9 @@ module Increase
909
909
  # What object created the transfer, either via the API or the dashboard.
910
910
  sig do
911
911
  params(
912
+ category: Increase::ACHTransfer::CreatedBy::Category::OrSymbol,
912
913
  api_key:
913
914
  T.nilable(Increase::ACHTransfer::CreatedBy::APIKey::OrHash),
914
- category: Increase::ACHTransfer::CreatedBy::Category::OrSymbol,
915
915
  oauth_application:
916
916
  T.nilable(
917
917
  Increase::ACHTransfer::CreatedBy::OAuthApplication::OrHash
@@ -920,23 +920,23 @@ module Increase
920
920
  ).returns(T.attached_class)
921
921
  end
922
922
  def self.new(
923
- # If present, details about the API key that created the transfer.
924
- api_key:,
925
923
  # The type of object that created this transfer.
926
924
  category:,
925
+ # If present, details about the API key that created the transfer.
926
+ api_key: nil,
927
927
  # If present, details about the OAuth Application that created the transfer.
928
- oauth_application:,
928
+ oauth_application: nil,
929
929
  # If present, details about the User that created the transfer.
930
- user:
930
+ user: nil
931
931
  )
932
932
  end
933
933
 
934
934
  sig do
935
935
  override.returns(
936
936
  {
937
- api_key: T.nilable(Increase::ACHTransfer::CreatedBy::APIKey),
938
937
  category:
939
938
  Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol,
939
+ api_key: T.nilable(Increase::ACHTransfer::CreatedBy::APIKey),
940
940
  oauth_application:
941
941
  T.nilable(Increase::ACHTransfer::CreatedBy::OAuthApplication),
942
942
  user: T.nilable(Increase::ACHTransfer::CreatedBy::User)
@@ -946,34 +946,6 @@ module Increase
946
946
  def to_hash
947
947
  end
948
948
 
949
- class APIKey < Increase::Internal::Type::BaseModel
950
- OrHash =
951
- T.type_alias do
952
- T.any(
953
- Increase::ACHTransfer::CreatedBy::APIKey,
954
- Increase::Internal::AnyHash
955
- )
956
- end
957
-
958
- # The description set for the API key when it was created.
959
- sig { returns(T.nilable(String)) }
960
- attr_accessor :description
961
-
962
- # If present, details about the API key that created the transfer.
963
- sig do
964
- params(description: T.nilable(String)).returns(T.attached_class)
965
- end
966
- def self.new(
967
- # The description set for the API key when it was created.
968
- description:
969
- )
970
- end
971
-
972
- sig { override.returns({ description: T.nilable(String) }) }
973
- def to_hash
974
- end
975
- end
976
-
977
949
  # The type of object that created this transfer.
978
950
  module Category
979
951
  extend Increase::Internal::Type::Enum
@@ -1014,6 +986,34 @@ module Increase
1014
986
  end
1015
987
  end
1016
988
 
989
+ class APIKey < Increase::Internal::Type::BaseModel
990
+ OrHash =
991
+ T.type_alias do
992
+ T.any(
993
+ Increase::ACHTransfer::CreatedBy::APIKey,
994
+ Increase::Internal::AnyHash
995
+ )
996
+ end
997
+
998
+ # The description set for the API key when it was created.
999
+ sig { returns(T.nilable(String)) }
1000
+ attr_accessor :description
1001
+
1002
+ # If present, details about the API key that created the transfer.
1003
+ sig do
1004
+ params(description: T.nilable(String)).returns(T.attached_class)
1005
+ end
1006
+ def self.new(
1007
+ # The description set for the API key when it was created.
1008
+ description:
1009
+ )
1010
+ end
1011
+
1012
+ sig { override.returns({ description: T.nilable(String) }) }
1013
+ def to_hash
1014
+ end
1015
+ end
1016
+
1017
1017
  class OAuthApplication < Increase::Internal::Type::BaseModel
1018
1018
  OrHash =
1019
1019
  T.type_alias do