increase 1.361.0 → 1.363.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.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/increase/client.rb +0 -16
- data/lib/increase/internal/transport/pooled_net_requester.rb +3 -0
- data/lib/increase/internal/util.rb +22 -17
- data/lib/increase/models/ach_transfer.rb +38 -23
- data/lib/increase/models/ach_transfer_create_params.rb +73 -42
- data/lib/increase/models/check_transfer.rb +58 -44
- data/lib/increase/models/check_transfer_create_params.rb +35 -21
- data/lib/increase/models/export.rb +12 -1
- data/lib/increase/models/export_create_params.rb +26 -4
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
- data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
- data/lib/increase/models/real_time_payments_transfer.rb +21 -1
- data/lib/increase/models/simulations/card_dispute_action_params.rb +26 -4
- data/lib/increase/models/simulations/wire_drawdown_request_refuse_params.rb +52 -1
- data/lib/increase/models/transaction.rb +3 -3
- data/lib/increase/models/wire_drawdown_request.rb +78 -1
- data/lib/increase/models.rb +3 -20
- data/lib/increase/resources/ach_transfers.rb +43 -22
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
- data/lib/increase/resources/simulations/wire_drawdown_requests.rb +12 -2
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +1 -14
- data/rbi/increase/client.rbi +0 -12
- data/rbi/increase/internal/util.rbi +3 -1
- data/rbi/increase/models/ach_transfer.rbi +35 -23
- data/rbi/increase/models/ach_transfer_create_params.rbi +72 -42
- data/rbi/increase/models/check_transfer.rbi +72 -54
- data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
- data/rbi/increase/models/export.rbi +15 -3
- data/rbi/increase/models/export_create_params.rbi +27 -3
- data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
- data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
- data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
- data/rbi/increase/models/simulations/card_dispute_action_params.rbi +56 -3
- data/rbi/increase/models/simulations/wire_drawdown_request_refuse_params.rbi +107 -0
- data/rbi/increase/models/transaction.rbi +3 -3
- data/rbi/increase/models/wire_drawdown_request.rbi +146 -0
- data/rbi/increase/models.rbi +3 -22
- data/rbi/increase/resources/ach_transfers.rbi +42 -22
- data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
- data/rbi/increase/resources/simulations/wire_drawdown_requests.rbi +9 -0
- data/sig/increase/client.rbs +0 -8
- data/sig/increase/internal/util.rbs +1 -1
- data/sig/increase/models/ach_transfer.rbs +4 -4
- data/sig/increase/models/check_transfer.rbs +59 -49
- data/sig/increase/models/check_transfer_create_params.rbs +20 -12
- data/sig/increase/models/export.rbs +13 -3
- data/sig/increase/models/export_create_params.rbs +7 -0
- data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
- data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
- data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
- data/sig/increase/models/simulations/card_dispute_action_params.rbs +24 -3
- data/sig/increase/models/simulations/wire_drawdown_request_refuse_params.rbs +51 -1
- data/sig/increase/models/transaction.rbs +4 -4
- data/sig/increase/models/wire_drawdown_request.rbs +64 -0
- data/sig/increase/models.rbs +2 -20
- data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
- data/sig/increase/resources/simulations/wire_drawdown_requests.rbs +2 -0
- metadata +20 -45
- data/lib/increase/models/group.rb +0 -57
- data/lib/increase/models/group_retrieve_params.rb +0 -14
- data/lib/increase/models/oauth_application.rb +0 -111
- data/lib/increase/models/oauth_application_list_params.rb +0 -129
- data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
- data/lib/increase/models/oauth_connection.rb +0 -107
- data/lib/increase/models/oauth_connection_list_params.rb +0 -88
- data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
- data/lib/increase/models/oauth_token.rb +0 -76
- data/lib/increase/models/oauth_token_create_params.rb +0 -85
- data/lib/increase/resources/groups.rb +0 -32
- data/lib/increase/resources/oauth_applications.rb +0 -68
- data/lib/increase/resources/oauth_connections.rb +0 -70
- data/lib/increase/resources/oauth_tokens.rb +0 -54
- data/rbi/increase/models/group.rbi +0 -74
- data/rbi/increase/models/group_retrieve_params.rbi +0 -27
- data/rbi/increase/models/oauth_application.rbi +0 -146
- data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
- data/rbi/increase/models/oauth_application_retrieve_params.rbi +0 -46
- data/rbi/increase/models/oauth_connection.rbi +0 -142
- data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
- data/rbi/increase/models/oauth_connection_retrieve_params.rbi +0 -46
- data/rbi/increase/models/oauth_token.rbi +0 -106
- data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
- data/rbi/increase/resources/groups.rbi +0 -21
- data/rbi/increase/resources/oauth_applications.rbi +0 -50
- data/rbi/increase/resources/oauth_connections.rbi +0 -52
- data/rbi/increase/resources/oauth_tokens.rbi +0 -44
- data/sig/increase/models/group.rbs +0 -36
- data/sig/increase/models/group_retrieve_params.rbs +0 -15
- data/sig/increase/models/oauth_application.rbs +0 -74
- data/sig/increase/models/oauth_application_list_params.rbs +0 -123
- data/sig/increase/models/oauth_application_retrieve_params.rbs +0 -24
- data/sig/increase/models/oauth_connection.rbs +0 -74
- data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
- data/sig/increase/models/oauth_connection_retrieve_params.rbs +0 -24
- data/sig/increase/models/oauth_token.rbs +0 -55
- data/sig/increase/models/oauth_token_create_params.rbs +0 -68
- data/sig/increase/resources/groups.rbs +0 -11
- data/sig/increase/resources/oauth_applications.rbs +0 -20
- data/sig/increase/resources/oauth_connections.rbs +0 -20
- data/sig/increase/resources/oauth_tokens.rbs +0 -16
|
@@ -529,9 +529,16 @@ module Increase
|
|
|
529
529
|
# @return [String, nil]
|
|
530
530
|
required :note, String, nil?: true
|
|
531
531
|
|
|
532
|
+
# @!attribute payee
|
|
533
|
+
# The payee of the check. This will be printed in the Pay to the Order Of portion
|
|
534
|
+
# of the check.
|
|
535
|
+
#
|
|
536
|
+
# @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payee>]
|
|
537
|
+
required :payee, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payee] }
|
|
538
|
+
|
|
532
539
|
# @!attribute payer
|
|
533
540
|
# The payer of the check. This will be printed on the top-left portion of the
|
|
534
|
-
# check
|
|
541
|
+
# check.
|
|
535
542
|
#
|
|
536
543
|
# @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
|
|
537
544
|
required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer] }
|
|
@@ -542,17 +549,11 @@ module Increase
|
|
|
542
549
|
# @return [String, nil]
|
|
543
550
|
required :physical_check_batch_id, String, nil?: true
|
|
544
551
|
|
|
545
|
-
# @!attribute recipient_name
|
|
546
|
-
# The name that will be printed on the check.
|
|
547
|
-
#
|
|
548
|
-
# @return [String]
|
|
549
|
-
required :recipient_name, String
|
|
550
|
-
|
|
551
552
|
# @!attribute return_address
|
|
552
553
|
# The return address to be printed on the check.
|
|
553
554
|
#
|
|
554
|
-
# @return [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress
|
|
555
|
-
required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }
|
|
555
|
+
# @return [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress]
|
|
556
|
+
required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }
|
|
556
557
|
|
|
557
558
|
# @!attribute return_address_name
|
|
558
559
|
# A custom name printed above the Increase-managed return address.
|
|
@@ -580,7 +581,7 @@ module Increase
|
|
|
580
581
|
required :tracking_updates,
|
|
581
582
|
-> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
|
|
582
583
|
|
|
583
|
-
# @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, physical_check_batch_id:,
|
|
584
|
+
# @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payee:, payer:, physical_check_batch_id:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
|
|
584
585
|
# Details relating to the physical check that Increase will print and mail. Will
|
|
585
586
|
# be present if and only if `fulfillment_method` is equal to `physical_check`.
|
|
586
587
|
#
|
|
@@ -595,16 +596,18 @@ module Increase
|
|
|
595
596
|
#
|
|
596
597
|
# @param note [String, nil] The descriptor that will be printed on the letter included with the check.
|
|
597
598
|
#
|
|
599
|
+
# @param payee [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payee>]
|
|
600
|
+
# The payee of the check. This will be printed in the Pay to the Order Of portion
|
|
601
|
+
# of the check.
|
|
602
|
+
#
|
|
598
603
|
# @param payer [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
|
|
599
604
|
# The payer of the check. This will be printed on the top-left portion of the
|
|
600
|
-
# check
|
|
605
|
+
# check.
|
|
601
606
|
#
|
|
602
607
|
# @param physical_check_batch_id [String, nil]
|
|
603
608
|
# The identifier of the Physical Check Batch that this check is a part of.
|
|
604
609
|
#
|
|
605
|
-
# @param
|
|
606
|
-
#
|
|
607
|
-
# @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
|
|
610
|
+
# @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress]
|
|
608
611
|
# The return address to be printed on the check.
|
|
609
612
|
#
|
|
610
613
|
# @param return_address_name [String, nil] A custom name printed above the Increase-managed return address.
|
|
@@ -624,14 +627,14 @@ module Increase
|
|
|
624
627
|
# @!attribute city
|
|
625
628
|
# The city of the check's destination.
|
|
626
629
|
#
|
|
627
|
-
# @return [String
|
|
628
|
-
required :city, String
|
|
630
|
+
# @return [String]
|
|
631
|
+
required :city, String
|
|
629
632
|
|
|
630
633
|
# @!attribute line1
|
|
631
634
|
# The street address of the check's destination.
|
|
632
635
|
#
|
|
633
|
-
# @return [String
|
|
634
|
-
required :line1, String
|
|
636
|
+
# @return [String]
|
|
637
|
+
required :line1, String
|
|
635
638
|
|
|
636
639
|
# @!attribute line2
|
|
637
640
|
# The second line of the address of the check's destination.
|
|
@@ -642,8 +645,8 @@ module Increase
|
|
|
642
645
|
# @!attribute name
|
|
643
646
|
# The name component of the check's mailing address.
|
|
644
647
|
#
|
|
645
|
-
# @return [String
|
|
646
|
-
required :name, String
|
|
648
|
+
# @return [String]
|
|
649
|
+
required :name, String
|
|
647
650
|
|
|
648
651
|
# @!attribute phone
|
|
649
652
|
# The phone number to be used in case of delivery issues at the check's mailing
|
|
@@ -655,33 +658,44 @@ module Increase
|
|
|
655
658
|
# @!attribute postal_code
|
|
656
659
|
# The postal code of the check's destination.
|
|
657
660
|
#
|
|
658
|
-
# @return [String
|
|
659
|
-
required :postal_code, String
|
|
661
|
+
# @return [String]
|
|
662
|
+
required :postal_code, String
|
|
660
663
|
|
|
661
664
|
# @!attribute state
|
|
662
665
|
# The state of the check's destination.
|
|
663
666
|
#
|
|
664
|
-
# @return [String
|
|
665
|
-
required :state, String
|
|
667
|
+
# @return [String]
|
|
668
|
+
required :state, String
|
|
666
669
|
|
|
667
670
|
# @!method initialize(city:, line1:, line2:, name:, phone:, postal_code:, state:)
|
|
668
671
|
# Details for where Increase will mail the check.
|
|
669
672
|
#
|
|
670
|
-
# @param city [String
|
|
673
|
+
# @param city [String] The city of the check's destination.
|
|
671
674
|
#
|
|
672
|
-
# @param line1 [String
|
|
675
|
+
# @param line1 [String] The street address of the check's destination.
|
|
673
676
|
#
|
|
674
677
|
# @param line2 [String, nil] The second line of the address of the check's destination.
|
|
675
678
|
#
|
|
676
|
-
# @param name [String
|
|
679
|
+
# @param name [String] The name component of the check's mailing address.
|
|
677
680
|
#
|
|
678
681
|
# @param phone [String, nil]
|
|
679
682
|
# The phone number to be used in case of delivery issues at the check's mailing
|
|
680
683
|
# address. Only used for FedEx overnight shipping.
|
|
681
684
|
#
|
|
682
|
-
# @param postal_code [String
|
|
685
|
+
# @param postal_code [String] The postal code of the check's destination.
|
|
686
|
+
#
|
|
687
|
+
# @param state [String] The state of the check's destination.
|
|
688
|
+
end
|
|
689
|
+
|
|
690
|
+
class Payee < Increase::Internal::Type::BaseModel
|
|
691
|
+
# @!attribute contents
|
|
692
|
+
# The contents of the line.
|
|
683
693
|
#
|
|
684
|
-
# @
|
|
694
|
+
# @return [String]
|
|
695
|
+
required :contents, String
|
|
696
|
+
|
|
697
|
+
# @!method initialize(contents:)
|
|
698
|
+
# @param contents [String] The contents of the line.
|
|
685
699
|
end
|
|
686
700
|
|
|
687
701
|
class Payer < Increase::Internal::Type::BaseModel
|
|
@@ -700,14 +714,14 @@ module Increase
|
|
|
700
714
|
# @!attribute city
|
|
701
715
|
# The city of the check's destination.
|
|
702
716
|
#
|
|
703
|
-
# @return [String
|
|
704
|
-
required :city, String
|
|
717
|
+
# @return [String]
|
|
718
|
+
required :city, String
|
|
705
719
|
|
|
706
720
|
# @!attribute line1
|
|
707
721
|
# The street address of the check's destination.
|
|
708
722
|
#
|
|
709
|
-
# @return [String
|
|
710
|
-
required :line1, String
|
|
723
|
+
# @return [String]
|
|
724
|
+
required :line1, String
|
|
711
725
|
|
|
712
726
|
# @!attribute line2
|
|
713
727
|
# The second line of the address of the check's destination.
|
|
@@ -718,8 +732,8 @@ module Increase
|
|
|
718
732
|
# @!attribute name
|
|
719
733
|
# The name component of the check's return address.
|
|
720
734
|
#
|
|
721
|
-
# @return [String
|
|
722
|
-
required :name, String
|
|
735
|
+
# @return [String]
|
|
736
|
+
required :name, String
|
|
723
737
|
|
|
724
738
|
# @!attribute phone
|
|
725
739
|
# The shipper's phone number to be used in case of delivery issues. Only used for
|
|
@@ -731,33 +745,33 @@ module Increase
|
|
|
731
745
|
# @!attribute postal_code
|
|
732
746
|
# The postal code of the check's destination.
|
|
733
747
|
#
|
|
734
|
-
# @return [String
|
|
735
|
-
required :postal_code, String
|
|
748
|
+
# @return [String]
|
|
749
|
+
required :postal_code, String
|
|
736
750
|
|
|
737
751
|
# @!attribute state
|
|
738
752
|
# The state of the check's destination.
|
|
739
753
|
#
|
|
740
|
-
# @return [String
|
|
741
|
-
required :state, String
|
|
754
|
+
# @return [String]
|
|
755
|
+
required :state, String
|
|
742
756
|
|
|
743
757
|
# @!method initialize(city:, line1:, line2:, name:, phone:, postal_code:, state:)
|
|
744
758
|
# The return address to be printed on the check.
|
|
745
759
|
#
|
|
746
|
-
# @param city [String
|
|
760
|
+
# @param city [String] The city of the check's destination.
|
|
747
761
|
#
|
|
748
|
-
# @param line1 [String
|
|
762
|
+
# @param line1 [String] The street address of the check's destination.
|
|
749
763
|
#
|
|
750
764
|
# @param line2 [String, nil] The second line of the address of the check's destination.
|
|
751
765
|
#
|
|
752
|
-
# @param name [String
|
|
766
|
+
# @param name [String] The name component of the check's return address.
|
|
753
767
|
#
|
|
754
768
|
# @param phone [String, nil]
|
|
755
769
|
# The shipper's phone number to be used in case of delivery issues. Only used for
|
|
756
770
|
# FedEx overnight shipping.
|
|
757
771
|
#
|
|
758
|
-
# @param postal_code [String
|
|
772
|
+
# @param postal_code [String] The postal code of the check's destination.
|
|
759
773
|
#
|
|
760
|
-
# @param state [String
|
|
774
|
+
# @param state [String] The state of the check's destination.
|
|
761
775
|
end
|
|
762
776
|
|
|
763
777
|
# The shipping method for the check.
|
|
@@ -163,6 +163,15 @@ module Increase
|
|
|
163
163
|
# @return [String]
|
|
164
164
|
required :memo, String
|
|
165
165
|
|
|
166
|
+
# @!attribute payee
|
|
167
|
+
# The payee of the check. This will be printed in the Pay to the Order Of portion
|
|
168
|
+
# of the check. This should be an array of up to 4 elements, each of which
|
|
169
|
+
# represents a line of the payee.
|
|
170
|
+
#
|
|
171
|
+
# @return [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payee>]
|
|
172
|
+
required :payee,
|
|
173
|
+
-> { Increase::Internal::Type::ArrayOf[Increase::CheckTransferCreateParams::PhysicalCheck::Payee] }
|
|
174
|
+
|
|
166
175
|
# @!attribute payer
|
|
167
176
|
# The payer of the check. This will be printed on the top-left portion of the
|
|
168
177
|
# check. This should be an array of up to 4 elements, each of which represents a
|
|
@@ -172,12 +181,6 @@ module Increase
|
|
|
172
181
|
required :payer,
|
|
173
182
|
-> { Increase::Internal::Type::ArrayOf[Increase::CheckTransferCreateParams::PhysicalCheck::Payer] }
|
|
174
183
|
|
|
175
|
-
# @!attribute recipient_name
|
|
176
|
-
# The name that will be printed on the check in the 'To:' field.
|
|
177
|
-
#
|
|
178
|
-
# @return [String]
|
|
179
|
-
required :recipient_name, String
|
|
180
|
-
|
|
181
184
|
# @!attribute attachment_file_id
|
|
182
185
|
# The ID of a File to be attached to the check. This must have
|
|
183
186
|
# `purpose: check_attachment`. For details on pricing and restrictions, see
|
|
@@ -238,7 +241,7 @@ module Increase
|
|
|
238
241
|
# @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature, nil]
|
|
239
242
|
optional :signature, -> { Increase::CheckTransferCreateParams::PhysicalCheck::Signature }
|
|
240
243
|
|
|
241
|
-
# @!method initialize(mailing_address:, memo:,
|
|
244
|
+
# @!method initialize(mailing_address:, memo:, payee:, payer:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, physical_check_batch_id: nil, return_address: nil, return_address_name: nil, shipping_method: nil, signature: nil)
|
|
242
245
|
# Details relating to the physical check that Increase will print and mail. This
|
|
243
246
|
# is required if `fulfillment_method` is equal to `physical_check`. It must not be
|
|
244
247
|
# included if any other `fulfillment_method` is provided.
|
|
@@ -249,13 +252,16 @@ module Increase
|
|
|
249
252
|
#
|
|
250
253
|
# @param memo [String] The descriptor that will be printed on the memo field on the check.
|
|
251
254
|
#
|
|
255
|
+
# @param payee [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payee>]
|
|
256
|
+
# The payee of the check. This will be printed in the Pay to the Order Of portion
|
|
257
|
+
# of the check. This should be an array of up to 4 elements, each of which
|
|
258
|
+
# represents a line of the payee.
|
|
259
|
+
#
|
|
252
260
|
# @param payer [Array<Increase::Models::CheckTransferCreateParams::PhysicalCheck::Payer>]
|
|
253
261
|
# The payer of the check. This will be printed on the top-left portion of the
|
|
254
262
|
# check. This should be an array of up to 4 elements, each of which represents a
|
|
255
263
|
# line of the payer.
|
|
256
264
|
#
|
|
257
|
-
# @param recipient_name [String] The name that will be printed on the check in the 'To:' field.
|
|
258
|
-
#
|
|
259
265
|
# @param attachment_file_id [String]
|
|
260
266
|
# The ID of a File to be attached to the check. This must have
|
|
261
267
|
# `purpose: check_attachment`. For details on pricing and restrictions, see
|
|
@@ -306,6 +312,12 @@ module Increase
|
|
|
306
312
|
# @return [String]
|
|
307
313
|
required :line1, String
|
|
308
314
|
|
|
315
|
+
# @!attribute name
|
|
316
|
+
# The name component of the check's destination address.
|
|
317
|
+
#
|
|
318
|
+
# @return [String]
|
|
319
|
+
required :name, String
|
|
320
|
+
|
|
309
321
|
# @!attribute postal_code
|
|
310
322
|
# The postal code component of the check's destination address.
|
|
311
323
|
#
|
|
@@ -324,13 +336,6 @@ module Increase
|
|
|
324
336
|
# @return [String, nil]
|
|
325
337
|
optional :line2, String
|
|
326
338
|
|
|
327
|
-
# @!attribute name
|
|
328
|
-
# The name component of the check's destination address. Defaults to the provided
|
|
329
|
-
# `recipient_name` parameter if `name` is not provided.
|
|
330
|
-
#
|
|
331
|
-
# @return [String, nil]
|
|
332
|
-
optional :name, String
|
|
333
|
-
|
|
334
339
|
# @!attribute phone
|
|
335
340
|
# The phone number to associate with the check's destination address. The phone
|
|
336
341
|
# number is only used when `shipping_method` is `fedex_overnight` and will be
|
|
@@ -339,7 +344,7 @@ module Increase
|
|
|
339
344
|
# @return [String, nil]
|
|
340
345
|
optional :phone, String
|
|
341
346
|
|
|
342
|
-
# @!method initialize(city:, line1:, postal_code:, state:, line2: nil,
|
|
347
|
+
# @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil, phone: nil)
|
|
343
348
|
# Details for where Increase will mail the check. When `physical_check_batch_id`
|
|
344
349
|
# is set, the address must match the Physical Check Batch.
|
|
345
350
|
#
|
|
@@ -347,22 +352,31 @@ module Increase
|
|
|
347
352
|
#
|
|
348
353
|
# @param line1 [String] The first line of the address component of the check's destination address.
|
|
349
354
|
#
|
|
355
|
+
# @param name [String] The name component of the check's destination address.
|
|
356
|
+
#
|
|
350
357
|
# @param postal_code [String] The postal code component of the check's destination address.
|
|
351
358
|
#
|
|
352
359
|
# @param state [String] The US state component of the check's destination address.
|
|
353
360
|
#
|
|
354
361
|
# @param line2 [String] The second line of the address component of the check's destination address.
|
|
355
362
|
#
|
|
356
|
-
# @param name [String]
|
|
357
|
-
# The name component of the check's destination address. Defaults to the provided
|
|
358
|
-
# `recipient_name` parameter if `name` is not provided.
|
|
359
|
-
#
|
|
360
363
|
# @param phone [String]
|
|
361
364
|
# The phone number to associate with the check's destination address. The phone
|
|
362
365
|
# number is only used when `shipping_method` is `fedex_overnight` and will be
|
|
363
366
|
# supplied to FedEx to be used in case of delivery issues.
|
|
364
367
|
end
|
|
365
368
|
|
|
369
|
+
class Payee < Increase::Internal::Type::BaseModel
|
|
370
|
+
# @!attribute contents
|
|
371
|
+
# The contents of the line.
|
|
372
|
+
#
|
|
373
|
+
# @return [String]
|
|
374
|
+
required :contents, String
|
|
375
|
+
|
|
376
|
+
# @!method initialize(contents:)
|
|
377
|
+
# @param contents [String] The contents of the line.
|
|
378
|
+
end
|
|
379
|
+
|
|
366
380
|
class Payer < Increase::Internal::Type::BaseModel
|
|
367
381
|
# @!attribute contents
|
|
368
382
|
# The contents of the line.
|
|
@@ -535,13 +535,24 @@ module Increase
|
|
|
535
535
|
# @return [Increase::Models::Export::FeeCsv::CreatedAt, nil]
|
|
536
536
|
required :created_at, -> { Increase::Export::FeeCsv::CreatedAt }, nil?: true
|
|
537
537
|
|
|
538
|
-
# @!
|
|
538
|
+
# @!attribute fee_statement_period_start
|
|
539
|
+
# Filter fees by the UTC start date of their fee statement's period, such as
|
|
540
|
+
# `2026-08-01`.
|
|
541
|
+
#
|
|
542
|
+
# @return [Date, nil]
|
|
543
|
+
required :fee_statement_period_start, Date, nil?: true
|
|
544
|
+
|
|
545
|
+
# @!method initialize(created_at:, fee_statement_period_start:)
|
|
539
546
|
# Details of the fee CSV export. This field will be present when the `category` is
|
|
540
547
|
# equal to `fee_csv`.
|
|
541
548
|
#
|
|
542
549
|
# @param created_at [Increase::Models::Export::FeeCsv::CreatedAt, nil]
|
|
543
550
|
# Filter fees by their created date. The time range must not include any fees on
|
|
544
551
|
# an open fee statement.
|
|
552
|
+
#
|
|
553
|
+
# @param fee_statement_period_start [Date, nil]
|
|
554
|
+
# Filter fees by the UTC start date of their fee statement's period, such as
|
|
555
|
+
# `2026-08-01`.
|
|
545
556
|
|
|
546
557
|
# @see Increase::Models::Export::FeeCsv#created_at
|
|
547
558
|
class CreatedAt < Increase::Internal::Type::BaseModel
|
|
@@ -359,22 +359,41 @@ module Increase
|
|
|
359
359
|
|
|
360
360
|
class FeeCsv < Increase::Internal::Type::BaseModel
|
|
361
361
|
# @!attribute created_at
|
|
362
|
-
# Filter
|
|
362
|
+
# Filter exported Fees by the time they were created. This suits historical
|
|
363
|
+
# exports across many fee statements. To get all of the Fees for a given fee
|
|
364
|
+
# statement period, we recommend using `fee_statement_period_start` instead. The
|
|
365
|
+
# time range must not include any Fees on an open fee statement.
|
|
363
366
|
#
|
|
364
367
|
# @return [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt, nil]
|
|
365
368
|
optional :created_at, -> { Increase::ExportCreateParams::FeeCsv::CreatedAt }
|
|
366
369
|
|
|
370
|
+
# @!attribute fee_statement_period_start
|
|
371
|
+
# Filter exported Fees to the fee statements whose period starts on this UTC date,
|
|
372
|
+
# such as `2026-08-01`. Use this filter to export all of the Fees on a fee
|
|
373
|
+
# statement. The matching fee statements must be closed.
|
|
374
|
+
#
|
|
375
|
+
# @return [Date, nil]
|
|
376
|
+
optional :fee_statement_period_start, Date
|
|
377
|
+
|
|
367
378
|
# @!attribute program_id
|
|
368
379
|
# Filter exported Fees to the specified Program.
|
|
369
380
|
#
|
|
370
381
|
# @return [String, nil]
|
|
371
382
|
optional :program_id, String
|
|
372
383
|
|
|
373
|
-
# @!method initialize(created_at: nil, program_id: nil)
|
|
384
|
+
# @!method initialize(created_at: nil, fee_statement_period_start: nil, program_id: nil)
|
|
374
385
|
# Options for the created export. Required if `category` is equal to `fee_csv`.
|
|
375
386
|
#
|
|
376
387
|
# @param created_at [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt]
|
|
377
|
-
# Filter
|
|
388
|
+
# Filter exported Fees by the time they were created. This suits historical
|
|
389
|
+
# exports across many fee statements. To get all of the Fees for a given fee
|
|
390
|
+
# statement period, we recommend using `fee_statement_period_start` instead. The
|
|
391
|
+
# time range must not include any Fees on an open fee statement.
|
|
392
|
+
#
|
|
393
|
+
# @param fee_statement_period_start [Date]
|
|
394
|
+
# Filter exported Fees to the fee statements whose period starts on this UTC date,
|
|
395
|
+
# such as `2026-08-01`. Use this filter to export all of the Fees on a fee
|
|
396
|
+
# statement. The matching fee statements must be closed.
|
|
378
397
|
#
|
|
379
398
|
# @param program_id [String] Filter exported Fees to the specified Program.
|
|
380
399
|
|
|
@@ -409,7 +428,10 @@ module Increase
|
|
|
409
428
|
optional :on_or_before, Time
|
|
410
429
|
|
|
411
430
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
412
|
-
# Filter
|
|
431
|
+
# Filter exported Fees by the time they were created. This suits historical
|
|
432
|
+
# exports across many fee statements. To get all of the Fees for a given fee
|
|
433
|
+
# statement period, we recommend using `fee_statement_period_start` instead. The
|
|
434
|
+
# time range must not include any Fees on an open fee statement.
|
|
413
435
|
#
|
|
414
436
|
# @param after [Time]
|
|
415
437
|
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
@@ -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 return_of_real_time_payments_transfer_id
|
|
88
|
+
# The identifier of the Real-Time Payments Transfer this transfer returns, if any.
|
|
89
|
+
#
|
|
90
|
+
# @return [String, nil]
|
|
91
|
+
required :return_of_real_time_payments_transfer_id, String, nil?: true
|
|
92
|
+
|
|
87
93
|
# @!attribute status
|
|
88
94
|
# The lifecycle status of the transfer.
|
|
89
95
|
#
|
|
@@ -109,7 +115,7 @@ module Increase
|
|
|
109
115
|
# @return [String, nil]
|
|
110
116
|
required :unstructured_remittance_information, String, nil?: true
|
|
111
117
|
|
|
112
|
-
# @!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_identification:, type:, unstructured_remittance_information:)
|
|
118
|
+
# @!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:, return_of_real_time_payments_transfer_id:, status:, transaction_identification:, type:, unstructured_remittance_information:)
|
|
113
119
|
# An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer
|
|
114
120
|
# initiated outside of Increase to your account.
|
|
115
121
|
#
|
|
@@ -147,6 +153,9 @@ module Increase
|
|
|
147
153
|
# @param end_to_end_identification [String, nil]
|
|
148
154
|
# A free-form reference string set by the sender, to help identify the transfer.
|
|
149
155
|
#
|
|
156
|
+
# @param return_of_real_time_payments_transfer_id [String, nil]
|
|
157
|
+
# The identifier of the Real-Time Payments Transfer this transfer returns, if any.
|
|
158
|
+
#
|
|
150
159
|
# @param status [Symbol, Increase::Models::InboundRealTimePaymentsTransfer::Status]
|
|
151
160
|
# The lifecycle status of the transfer.
|
|
152
161
|
#
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Increase
|
|
4
|
+
module Models
|
|
5
|
+
# @see Increase::Resources::InboundRealTimePaymentsTransfers#return_
|
|
6
|
+
class InboundRealTimePaymentsTransferReturnParams < Increase::Internal::Type::BaseModel
|
|
7
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Increase::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute inbound_real_time_payments_transfer_id
|
|
11
|
+
# The identifier of the Inbound Real-Time Payments Transfer to return to its
|
|
12
|
+
# sender.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :inbound_real_time_payments_transfer_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute amount
|
|
18
|
+
# The amount to return, in USD cents. Defaults to the full amount of the Inbound
|
|
19
|
+
# Real-Time Payments Transfer, and can't be higher than it.
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer, nil]
|
|
22
|
+
optional :amount, Integer
|
|
23
|
+
|
|
24
|
+
# @!method initialize(inbound_real_time_payments_transfer_id:, amount: nil, request_options: {})
|
|
25
|
+
# @param inbound_real_time_payments_transfer_id [String]
|
|
26
|
+
# The identifier of the Inbound Real-Time Payments Transfer to return to its
|
|
27
|
+
# sender.
|
|
28
|
+
#
|
|
29
|
+
# @param amount [Integer]
|
|
30
|
+
# The amount to return, in USD cents. Defaults to the full amount of the Inbound
|
|
31
|
+
# Real-Time Payments Transfer, and can't be higher than it.
|
|
32
|
+
#
|
|
33
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -83,6 +83,12 @@ module Increase
|
|
|
83
83
|
# @return [String, nil]
|
|
84
84
|
required :debtor_name, String, nil?: true
|
|
85
85
|
|
|
86
|
+
# @!attribute end_to_end_identification
|
|
87
|
+
# A free-form reference string set by the sender, to help identify the transfer.
|
|
88
|
+
#
|
|
89
|
+
# @return [String, nil]
|
|
90
|
+
required :end_to_end_identification, String, nil?: true
|
|
91
|
+
|
|
86
92
|
# @!attribute external_account_id
|
|
87
93
|
# The identifier of the External Account the transfer was made to, if any.
|
|
88
94
|
#
|
|
@@ -120,6 +126,13 @@ module Increase
|
|
|
120
126
|
# @return [Increase::Models::RealTimePaymentsTransfer::Rejection, nil]
|
|
121
127
|
required :rejection, -> { Increase::RealTimePaymentsTransfer::Rejection }, nil?: true
|
|
122
128
|
|
|
129
|
+
# @!attribute return_of_inbound_real_time_payments_transfer_id
|
|
130
|
+
# The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
|
|
131
|
+
# if any.
|
|
132
|
+
#
|
|
133
|
+
# @return [String, nil]
|
|
134
|
+
required :return_of_inbound_real_time_payments_transfer_id, String, nil?: true
|
|
135
|
+
|
|
123
136
|
# @!attribute routing_number
|
|
124
137
|
# The destination American Bankers' Association (ABA) Routing Transit Number
|
|
125
138
|
# (RTN).
|
|
@@ -179,7 +192,7 @@ module Increase
|
|
|
179
192
|
# @return [String]
|
|
180
193
|
required :unstructured_remittance_information, String
|
|
181
194
|
|
|
182
|
-
# @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
|
|
195
|
+
# @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, end_to_end_identification:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, return_of_inbound_real_time_payments_transfer_id:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
|
|
183
196
|
# Real-Time Payments transfers move funds, within seconds, between your Increase
|
|
184
197
|
# account and any other account on the Real-Time Payments network.
|
|
185
198
|
#
|
|
@@ -222,6 +235,9 @@ module Increase
|
|
|
222
235
|
# The name of the transfer's sender. If not provided, defaults to the name of the
|
|
223
236
|
# account's entity.
|
|
224
237
|
#
|
|
238
|
+
# @param end_to_end_identification [String, nil]
|
|
239
|
+
# A free-form reference string set by the sender, to help identify the transfer.
|
|
240
|
+
#
|
|
225
241
|
# @param external_account_id [String, nil]
|
|
226
242
|
# The identifier of the External Account the transfer was made to, if any.
|
|
227
243
|
#
|
|
@@ -244,6 +260,10 @@ module Increase
|
|
|
244
260
|
# If the transfer is rejected by Real-Time Payments or the destination financial
|
|
245
261
|
# institution, this will contain supplemental details.
|
|
246
262
|
#
|
|
263
|
+
# @param return_of_inbound_real_time_payments_transfer_id [String, nil]
|
|
264
|
+
# The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
|
|
265
|
+
# if any.
|
|
266
|
+
#
|
|
247
267
|
# @param routing_number [String]
|
|
248
268
|
# The destination American Bankers' Association (ABA) Routing Transit Number
|
|
249
269
|
# (RTN).
|
|
@@ -68,6 +68,14 @@ module Increase
|
|
|
68
68
|
# @return [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptChargeback, nil]
|
|
69
69
|
optional :accept_chargeback, -> { Increase::Simulations::CardDisputeActionParams::Visa::AcceptChargeback }
|
|
70
70
|
|
|
71
|
+
# @!attribute accept_user_prearbitration
|
|
72
|
+
# The parameters for accepting the user prearbitration. Required if and only if
|
|
73
|
+
# `action` is `accept_user_prearbitration`.
|
|
74
|
+
#
|
|
75
|
+
# @return [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptUserPrearbitration, nil]
|
|
76
|
+
optional :accept_user_prearbitration,
|
|
77
|
+
-> { Increase::Simulations::CardDisputeActionParams::Visa::AcceptUserPrearbitration }
|
|
78
|
+
|
|
71
79
|
# @!attribute accept_user_submission
|
|
72
80
|
# The parameters for accepting the user submission. Required if and only if
|
|
73
81
|
# `action` is `accept_user_submission`.
|
|
@@ -146,7 +154,7 @@ module Increase
|
|
|
146
154
|
optional :time_out_user_prearbitration,
|
|
147
155
|
-> { Increase::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration }
|
|
148
156
|
|
|
149
|
-
# @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, reject: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
|
|
157
|
+
# @!method initialize(action:, accept_chargeback: nil, accept_user_prearbitration: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, reject: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
|
|
150
158
|
# The Visa-specific parameters for taking action on the dispute. Required if and
|
|
151
159
|
# only if `network` is `visa`.
|
|
152
160
|
#
|
|
@@ -158,6 +166,10 @@ module Increase
|
|
|
158
166
|
# The parameters for accepting the chargeback. Required if and only if `action` is
|
|
159
167
|
# `accept_chargeback`.
|
|
160
168
|
#
|
|
169
|
+
# @param accept_user_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptUserPrearbitration]
|
|
170
|
+
# The parameters for accepting the user prearbitration. Required if and only if
|
|
171
|
+
# `action` is `accept_user_prearbitration`.
|
|
172
|
+
#
|
|
161
173
|
# @param accept_user_submission [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptUserSubmission]
|
|
162
174
|
# The parameters for accepting the user submission. Required if and only if
|
|
163
175
|
# `action` is `accept_user_submission`.
|
|
@@ -208,19 +220,22 @@ module Increase
|
|
|
208
220
|
# Simulate the merchant accepting the chargeback. This will move the dispute to a `won` state.
|
|
209
221
|
ACCEPT_CHARGEBACK = :accept_chargeback
|
|
210
222
|
|
|
223
|
+
# Simulate the merchant accepting the user's pre-arbitration. This will move the dispute to a `won` state.
|
|
224
|
+
ACCEPT_USER_PREARBITRATION = :accept_user_prearbitration
|
|
225
|
+
|
|
211
226
|
# Accept the user's submission and transmit it to the network. This will move the dispute to a `pending_response` state.
|
|
212
227
|
ACCEPT_USER_SUBMISSION = :accept_user_submission
|
|
213
228
|
|
|
214
229
|
# Simulate the merchant declining the user's pre-arbitration. This will move the dispute to a `lost` state.
|
|
215
230
|
DECLINE_USER_PREARBITRATION = :decline_user_prearbitration
|
|
216
231
|
|
|
217
|
-
# Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.
|
|
232
|
+
# Simulate the merchant issuing pre-arbitration. Only available for disputes in the fraud or authorization category. This will move the dispute to a `user_submission_required` state.
|
|
218
233
|
RECEIVE_MERCHANT_PREARBITRATION = :receive_merchant_prearbitration
|
|
219
234
|
|
|
220
235
|
# Simulate the dispute being rejected before it is submitted to the network. This will move the dispute to a `rejected` state.
|
|
221
236
|
REJECT = :reject
|
|
222
237
|
|
|
223
|
-
# Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
|
|
238
|
+
# Simulate the merchant re-presenting the dispute. Only available for disputes in a consumer or processing error category. This will move the dispute to a `user_submission_required` state.
|
|
224
239
|
REPRESENT = :represent
|
|
225
240
|
|
|
226
241
|
# Simulate further information being requested from the user. This will move the dispute to a `user_submission_required` state.
|
|
@@ -235,7 +250,7 @@ module Increase
|
|
|
235
250
|
# Simulate the user timing out responding to a merchant re-presentment. This will move the dispute to a `lost` state.
|
|
236
251
|
TIME_OUT_REPRESENTMENT = :time_out_representment
|
|
237
252
|
|
|
238
|
-
# Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `
|
|
253
|
+
# Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `won` state.
|
|
239
254
|
TIME_OUT_USER_PREARBITRATION = :time_out_user_prearbitration
|
|
240
255
|
|
|
241
256
|
# @!method self.values
|
|
@@ -249,6 +264,13 @@ module Increase
|
|
|
249
264
|
# `accept_chargeback`.
|
|
250
265
|
end
|
|
251
266
|
|
|
267
|
+
# @see Increase::Models::Simulations::CardDisputeActionParams::Visa#accept_user_prearbitration
|
|
268
|
+
class AcceptUserPrearbitration < Increase::Internal::Type::BaseModel
|
|
269
|
+
# @!method initialize
|
|
270
|
+
# The parameters for accepting the user prearbitration. Required if and only if
|
|
271
|
+
# `action` is `accept_user_prearbitration`.
|
|
272
|
+
end
|
|
273
|
+
|
|
252
274
|
# @see Increase::Models::Simulations::CardDisputeActionParams::Visa#accept_user_submission
|
|
253
275
|
class AcceptUserSubmission < Increase::Internal::Type::BaseModel
|
|
254
276
|
# @!method initialize
|