increase 1.228.0 → 1.230.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5a0de1f149d3a02844c233f4383d8e9e26bb5f7fcdc03db331671c46ed6e1d36
4
- data.tar.gz: 2654a00ae91103172d805cf30a5f4ea8d3a530c2dc94b71451fd89129027c3fe
3
+ metadata.gz: 3c069c49ffaad5a87f57090b0daea50e24512280378abb5d295cbc5158fb23b2
4
+ data.tar.gz: 5fe14f953df93c9e39821b77478614c2b0c1a244022de5420f7ec2ed3dc8cb02
5
5
  SHA512:
6
- metadata.gz: 169c245ba8c81938fdb010744afb95daece299475e7fd8e6ca28a9ab8991edf48a106751255014454bb72cab4931c9ed3a74400535cf5c3f6ee46330547a63f7
7
- data.tar.gz: 6a71623b36803afcdfb1a9534c2f6a1d9061672dbaa9d3d5060c5cc45912606aefd8b4b6edcd797cce89477b75377ccbc5d0be206464c181c406376bc5f3fcf6
6
+ metadata.gz: '03206181a8662cd554c3fe8792e1797055d3b40506bba0d11c32cf313fe48afd2ea92a30ea178ef86e00d5b7de0bed9624030ba722536f1a922f3eebff2ab188'
7
+ data.tar.gz: 5f99e831d718444af4441e23505ddf64bd7f1626947c70d66170a8089a70f457eaef68790b072c0647843e2ee68062e678671d2eb88ca1261e1d46bfcf97d4d9
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.230.0 (2026-03-05)
4
+
5
+ Full Changelog: [v1.229.0...v1.230.0](https://github.com/Increase/increase-ruby/compare/v1.229.0...v1.230.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([a02c155](https://github.com/Increase/increase-ruby/commit/a02c155f39f7f44a541ad2151e1dfa14cc21c287))
10
+
11
+ ## 1.229.0 (2026-03-05)
12
+
13
+ Full Changelog: [v1.228.0...v1.229.0](https://github.com/Increase/increase-ruby/compare/v1.228.0...v1.229.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([ece1a38](https://github.com/Increase/increase-ruby/commit/ece1a380172005d1ad991faf6dd7b65b0b12bcc7))
18
+
3
19
  ## 1.228.0 (2026-03-05)
4
20
 
5
21
  Full Changelog: [v1.227.0...v1.228.0](https://github.com/Increase/increase-ruby/compare/v1.227.0...v1.228.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.228.0"
18
+ gem "increase", "~> 1.230.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -485,6 +485,39 @@ module Increase
485
485
  # @return [String, nil]
486
486
  required :real_time_decision_id, String, nil?: true
487
487
 
488
+ # @!attribute requestor_authentication_indicator
489
+ # The 3DS requestor authentication indicator describes why the authentication
490
+ # attempt is performed, such as for a recurring transaction.
491
+ #
492
+ # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator, nil]
493
+ required :requestor_authentication_indicator,
494
+ enum: -> {
495
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator
496
+ },
497
+ nil?: true
498
+
499
+ # @!attribute requestor_challenge_indicator
500
+ # Indicates whether a challenge is requested for this transaction.
501
+ #
502
+ # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator, nil]
503
+ required :requestor_challenge_indicator,
504
+ enum: -> {
505
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator
506
+ },
507
+ nil?: true
508
+
509
+ # @!attribute requestor_name
510
+ # The name of the 3DS requestor.
511
+ #
512
+ # @return [String]
513
+ required :requestor_name, String
514
+
515
+ # @!attribute requestor_url
516
+ # The URL of the 3DS requestor.
517
+ #
518
+ # @return [String]
519
+ required :requestor_url, String
520
+
488
521
  # @!attribute status
489
522
  # The status of the card authentication.
490
523
  #
@@ -498,7 +531,7 @@ module Increase
498
531
  # @return [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type]
499
532
  required :type, enum: -> { Increase::CardPayment::Element::CardAuthentication::Type }
500
533
 
501
- # @!method initialize(id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:, category:, challenge:, created_at:, deny_reason:, device_channel:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, prior_card_authentication_id:, purchase_amount:, purchase_currency:, real_time_decision_id:, status:, type:)
534
+ # @!method initialize(id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:, category:, challenge:, created_at:, deny_reason:, device_channel:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, prior_card_authentication_id:, purchase_amount:, purchase_currency:, real_time_decision_id:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, status:, type:)
502
535
  # Some parameter documentations has been truncated, see
503
536
  # {Increase::Models::CardPayment::Element::CardAuthentication} for more details.
504
537
  #
@@ -556,6 +589,14 @@ module Increase
556
589
  #
557
590
  # @param real_time_decision_id [String, nil] The identifier of the Real-Time Decision sent to approve or decline this authent
558
591
  #
592
+ # @param requestor_authentication_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator, nil] The 3DS requestor authentication indicator describes why the authentication atte
593
+ #
594
+ # @param requestor_challenge_indicator [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator, nil] Indicates whether a challenge is requested for this transaction.
595
+ #
596
+ # @param requestor_name [String] The name of the 3DS requestor.
597
+ #
598
+ # @param requestor_url [String] The URL of the 3DS requestor.
599
+ #
559
600
  # @param status [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status] The status of the card authentication.
560
601
  #
561
602
  # @param type [Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type] A constant representing the object's type. For this resource it will always be `
@@ -828,6 +869,79 @@ module Increase
828
869
  end
829
870
  end
830
871
 
872
+ # The 3DS requestor authentication indicator describes why the authentication
873
+ # attempt is performed, such as for a recurring transaction.
874
+ #
875
+ # @see Increase::Models::CardPayment::Element::CardAuthentication#requestor_authentication_indicator
876
+ module RequestorAuthenticationIndicator
877
+ extend Increase::Internal::Type::Enum
878
+
879
+ # The authentication is for a payment transaction.
880
+ PAYMENT_TRANSACTION = :payment_transaction
881
+
882
+ # The authentication is for a recurring transaction.
883
+ RECURRING_TRANSACTION = :recurring_transaction
884
+
885
+ # The authentication is for an installment transaction.
886
+ INSTALLMENT_TRANSACTION = :installment_transaction
887
+
888
+ # The authentication is for adding a card.
889
+ ADD_CARD = :add_card
890
+
891
+ # The authentication is for maintaining a card.
892
+ MAINTAIN_CARD = :maintain_card
893
+
894
+ # The authentication is for EMV token cardholder verification.
895
+ EMV_TOKEN_CARDHOLDER_VERIFICATION = :emv_token_cardholder_verification
896
+
897
+ # The authentication is for a billing agreement.
898
+ BILLING_AGREEMENT = :billing_agreement
899
+
900
+ # @!method self.values
901
+ # @return [Array<Symbol>]
902
+ end
903
+
904
+ # Indicates whether a challenge is requested for this transaction.
905
+ #
906
+ # @see Increase::Models::CardPayment::Element::CardAuthentication#requestor_challenge_indicator
907
+ module RequestorChallengeIndicator
908
+ extend Increase::Internal::Type::Enum
909
+
910
+ # No preference.
911
+ NO_PREFERENCE = :no_preference
912
+
913
+ # No challenge requested.
914
+ NO_CHALLENGE_REQUESTED = :no_challenge_requested
915
+
916
+ # Challenge requested, 3DS Requestor preference.
917
+ CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE = :challenge_requested_3ds_requestor_preference
918
+
919
+ # Challenge requested, mandate.
920
+ CHALLENGE_REQUESTED_MANDATE = :challenge_requested_mandate
921
+
922
+ # No challenge requested, transactional risk analysis already performed.
923
+ NO_CHALLENGE_REQUESTED_TRANSACTIONAL_RISK_ANALYSIS_ALREADY_PERFORMED =
924
+ :no_challenge_requested_transactional_risk_analysis_already_performed
925
+
926
+ # No challenge requested, data share only.
927
+ NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY = :no_challenge_requested_data_share_only
928
+
929
+ # No challenge requested, strong consumer authentication already performed.
930
+ NO_CHALLENGE_REQUESTED_STRONG_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED =
931
+ :no_challenge_requested_strong_consumer_authentication_already_performed
932
+
933
+ # No challenge requested, utilize whitelist exemption if no challenge required.
934
+ NO_CHALLENGE_REQUESTED_UTILIZE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED =
935
+ :no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required
936
+
937
+ # Challenge requested, whitelist prompt requested if challenge required.
938
+ CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED =
939
+ :challenge_requested_whitelist_prompt_requested_if_challenge_required
940
+
941
+ # @!method self.values
942
+ # @return [Array<Symbol>]
943
+ end
944
+
831
945
  # The status of the card authentication.
832
946
  #
833
947
  # @see Increase::Models::CardPayment::Element::CardAuthentication#status
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::CheckDeposits#adjustment
7
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute check_deposit_id
12
+ # The identifier of the Check Deposit you wish to adjust.
13
+ #
14
+ # @return [String]
15
+ required :check_deposit_id, String
16
+
17
+ # @!attribute amount
18
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
19
+ # cents). A negative amount means that the funds are being clawed back by the
20
+ # other bank and is a debit to your account. Defaults to the negative of the Check
21
+ # Deposit amount.
22
+ #
23
+ # @return [Integer, nil]
24
+ optional :amount, Integer
25
+
26
+ # @!attribute reason
27
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
28
+ # used for a low quality image that the recipient wasn't able to handle.
29
+ #
30
+ # @return [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason, nil]
31
+ optional :reason, enum: -> { Increase::Simulations::CheckDepositAdjustmentParams::Reason }
32
+
33
+ # @!method initialize(check_deposit_id:, amount: nil, reason: nil, request_options: {})
34
+ # Some parameter documentations has been truncated, see
35
+ # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
36
+ #
37
+ # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
38
+ #
39
+ # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
40
+ #
41
+ # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
42
+ #
43
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
44
+
45
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
46
+ # used for a low quality image that the recipient wasn't able to handle.
47
+ module Reason
48
+ extend Increase::Internal::Type::Enum
49
+
50
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
51
+ LATE_RETURN = :late_return
52
+
53
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
54
+ WRONG_PAYEE_CREDIT = :wrong_payee_credit
55
+
56
+ # The check was deposited with a different amount than what was written on the check.
57
+ ADJUSTED_AMOUNT = :adjusted_amount
58
+
59
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
60
+ NON_CONFORMING_ITEM = :non_conforming_item
61
+
62
+ # The check has already been deposited elsewhere and so this is a duplicate.
63
+ PAID = :paid
64
+
65
+ # @!method self.values
66
+ # @return [Array<Symbol>]
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -4,6 +4,38 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class CheckDeposits
7
+ # Some parameter documentations has been truncated, see
8
+ # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
9
+ #
10
+ # Simulates the creation of a
11
+ # [Check Deposit Adjustment](#check-deposit-adjustments) on a
12
+ # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
13
+ # of `submitted`.
14
+ #
15
+ # @overload adjustment(check_deposit_id, amount: nil, reason: nil, request_options: {})
16
+ #
17
+ # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
18
+ #
19
+ # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
20
+ #
21
+ # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
22
+ #
23
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
+ #
25
+ # @return [Increase::Models::CheckDeposit]
26
+ #
27
+ # @see Increase::Models::Simulations::CheckDepositAdjustmentParams
28
+ def adjustment(check_deposit_id, params = {})
29
+ parsed, options = Increase::Simulations::CheckDepositAdjustmentParams.dump_request(params)
30
+ @client.request(
31
+ method: :post,
32
+ path: ["simulations/check_deposits/%1$s/adjustment", check_deposit_id],
33
+ body: parsed,
34
+ model: Increase::CheckDeposit,
35
+ options: options
36
+ )
37
+ end
38
+
7
39
  # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
8
40
  # factors like poor image quality. This Check Deposit must first have a `status`
9
41
  # of `pending`.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.228.0"
4
+ VERSION = "1.230.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -304,6 +304,7 @@ require_relative "increase/models/simulations/card_refund_create_params"
304
304
  require_relative "increase/models/simulations/card_reversal_create_params"
305
305
  require_relative "increase/models/simulations/card_settlement_create_params"
306
306
  require_relative "increase/models/simulations/card_token_create_params"
307
+ require_relative "increase/models/simulations/check_deposit_adjustment_params"
307
308
  require_relative "increase/models/simulations/check_deposit_reject_params"
308
309
  require_relative "increase/models/simulations/check_deposit_return_params"
309
310
  require_relative "increase/models/simulations/check_deposit_submit_params"
@@ -775,6 +775,35 @@ module Increase
775
775
  sig { returns(T.nilable(String)) }
776
776
  attr_accessor :real_time_decision_id
777
777
 
778
+ # The 3DS requestor authentication indicator describes why the authentication
779
+ # attempt is performed, such as for a recurring transaction.
780
+ sig do
781
+ returns(
782
+ T.nilable(
783
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
784
+ )
785
+ )
786
+ end
787
+ attr_accessor :requestor_authentication_indicator
788
+
789
+ # Indicates whether a challenge is requested for this transaction.
790
+ sig do
791
+ returns(
792
+ T.nilable(
793
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
794
+ )
795
+ )
796
+ end
797
+ attr_accessor :requestor_challenge_indicator
798
+
799
+ # The name of the 3DS requestor.
800
+ sig { returns(String) }
801
+ attr_accessor :requestor_name
802
+
803
+ # The URL of the 3DS requestor.
804
+ sig { returns(String) }
805
+ attr_accessor :requestor_url
806
+
778
807
  # The status of the card authentication.
779
808
  sig do
780
809
  returns(
@@ -832,6 +861,16 @@ module Increase
832
861
  purchase_amount: T.nilable(Integer),
833
862
  purchase_currency: T.nilable(String),
834
863
  real_time_decision_id: T.nilable(String),
864
+ requestor_authentication_indicator:
865
+ T.nilable(
866
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::OrSymbol
867
+ ),
868
+ requestor_challenge_indicator:
869
+ T.nilable(
870
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::OrSymbol
871
+ ),
872
+ requestor_name: String,
873
+ requestor_url: String,
835
874
  status:
836
875
  Increase::CardPayment::Element::CardAuthentication::Status::OrSymbol,
837
876
  type:
@@ -902,6 +941,15 @@ module Increase
902
941
  # The identifier of the Real-Time Decision sent to approve or decline this
903
942
  # authentication attempt.
904
943
  real_time_decision_id:,
944
+ # The 3DS requestor authentication indicator describes why the authentication
945
+ # attempt is performed, such as for a recurring transaction.
946
+ requestor_authentication_indicator:,
947
+ # Indicates whether a challenge is requested for this transaction.
948
+ requestor_challenge_indicator:,
949
+ # The name of the 3DS requestor.
950
+ requestor_name:,
951
+ # The URL of the 3DS requestor.
952
+ requestor_url:,
905
953
  # The status of the card authentication.
906
954
  status:,
907
955
  # A constant representing the object's type. For this resource it will always be
@@ -948,6 +996,16 @@ module Increase
948
996
  purchase_amount: T.nilable(Integer),
949
997
  purchase_currency: T.nilable(String),
950
998
  real_time_decision_id: T.nilable(String),
999
+ requestor_authentication_indicator:
1000
+ T.nilable(
1001
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1002
+ ),
1003
+ requestor_challenge_indicator:
1004
+ T.nilable(
1005
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1006
+ ),
1007
+ requestor_name: String,
1008
+ requestor_url: String,
951
1009
  status:
952
1010
  Increase::CardPayment::Element::CardAuthentication::Status::TaggedSymbol,
953
1011
  type:
@@ -1521,6 +1579,167 @@ module Increase
1521
1579
  end
1522
1580
  end
1523
1581
 
1582
+ # The 3DS requestor authentication indicator describes why the authentication
1583
+ # attempt is performed, such as for a recurring transaction.
1584
+ module RequestorAuthenticationIndicator
1585
+ extend Increase::Internal::Type::Enum
1586
+
1587
+ TaggedSymbol =
1588
+ T.type_alias do
1589
+ T.all(
1590
+ Symbol,
1591
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator
1592
+ )
1593
+ end
1594
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1595
+
1596
+ # The authentication is for a payment transaction.
1597
+ PAYMENT_TRANSACTION =
1598
+ T.let(
1599
+ :payment_transaction,
1600
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1601
+ )
1602
+
1603
+ # The authentication is for a recurring transaction.
1604
+ RECURRING_TRANSACTION =
1605
+ T.let(
1606
+ :recurring_transaction,
1607
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1608
+ )
1609
+
1610
+ # The authentication is for an installment transaction.
1611
+ INSTALLMENT_TRANSACTION =
1612
+ T.let(
1613
+ :installment_transaction,
1614
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1615
+ )
1616
+
1617
+ # The authentication is for adding a card.
1618
+ ADD_CARD =
1619
+ T.let(
1620
+ :add_card,
1621
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1622
+ )
1623
+
1624
+ # The authentication is for maintaining a card.
1625
+ MAINTAIN_CARD =
1626
+ T.let(
1627
+ :maintain_card,
1628
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1629
+ )
1630
+
1631
+ # The authentication is for EMV token cardholder verification.
1632
+ EMV_TOKEN_CARDHOLDER_VERIFICATION =
1633
+ T.let(
1634
+ :emv_token_cardholder_verification,
1635
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1636
+ )
1637
+
1638
+ # The authentication is for a billing agreement.
1639
+ BILLING_AGREEMENT =
1640
+ T.let(
1641
+ :billing_agreement,
1642
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1643
+ )
1644
+
1645
+ sig do
1646
+ override.returns(
1647
+ T::Array[
1648
+ Increase::CardPayment::Element::CardAuthentication::RequestorAuthenticationIndicator::TaggedSymbol
1649
+ ]
1650
+ )
1651
+ end
1652
+ def self.values
1653
+ end
1654
+ end
1655
+
1656
+ # Indicates whether a challenge is requested for this transaction.
1657
+ module RequestorChallengeIndicator
1658
+ extend Increase::Internal::Type::Enum
1659
+
1660
+ TaggedSymbol =
1661
+ T.type_alias do
1662
+ T.all(
1663
+ Symbol,
1664
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator
1665
+ )
1666
+ end
1667
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1668
+
1669
+ # No preference.
1670
+ NO_PREFERENCE =
1671
+ T.let(
1672
+ :no_preference,
1673
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1674
+ )
1675
+
1676
+ # No challenge requested.
1677
+ NO_CHALLENGE_REQUESTED =
1678
+ T.let(
1679
+ :no_challenge_requested,
1680
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1681
+ )
1682
+
1683
+ # Challenge requested, 3DS Requestor preference.
1684
+ CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE =
1685
+ T.let(
1686
+ :challenge_requested_3ds_requestor_preference,
1687
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1688
+ )
1689
+
1690
+ # Challenge requested, mandate.
1691
+ CHALLENGE_REQUESTED_MANDATE =
1692
+ T.let(
1693
+ :challenge_requested_mandate,
1694
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1695
+ )
1696
+
1697
+ # No challenge requested, transactional risk analysis already performed.
1698
+ NO_CHALLENGE_REQUESTED_TRANSACTIONAL_RISK_ANALYSIS_ALREADY_PERFORMED =
1699
+ T.let(
1700
+ :no_challenge_requested_transactional_risk_analysis_already_performed,
1701
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1702
+ )
1703
+
1704
+ # No challenge requested, data share only.
1705
+ NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY =
1706
+ T.let(
1707
+ :no_challenge_requested_data_share_only,
1708
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1709
+ )
1710
+
1711
+ # No challenge requested, strong consumer authentication already performed.
1712
+ NO_CHALLENGE_REQUESTED_STRONG_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED =
1713
+ T.let(
1714
+ :no_challenge_requested_strong_consumer_authentication_already_performed,
1715
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1716
+ )
1717
+
1718
+ # No challenge requested, utilize whitelist exemption if no challenge required.
1719
+ NO_CHALLENGE_REQUESTED_UTILIZE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED =
1720
+ T.let(
1721
+ :no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required,
1722
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1723
+ )
1724
+
1725
+ # Challenge requested, whitelist prompt requested if challenge required.
1726
+ CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED =
1727
+ T.let(
1728
+ :challenge_requested_whitelist_prompt_requested_if_challenge_required,
1729
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1730
+ )
1731
+
1732
+ sig do
1733
+ override.returns(
1734
+ T::Array[
1735
+ Increase::CardPayment::Element::CardAuthentication::RequestorChallengeIndicator::TaggedSymbol
1736
+ ]
1737
+ )
1738
+ end
1739
+ def self.values
1740
+ end
1741
+ end
1742
+
1524
1743
  # The status of the card authentication.
1525
1744
  module Status
1526
1745
  extend Increase::Internal::Type::Enum
@@ -0,0 +1,151 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ Increase::Simulations::CheckDepositAdjustmentParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Check Deposit you wish to adjust.
19
+ sig { returns(String) }
20
+ attr_accessor :check_deposit_id
21
+
22
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
23
+ # cents). A negative amount means that the funds are being clawed back by the
24
+ # other bank and is a debit to your account. Defaults to the negative of the Check
25
+ # Deposit amount.
26
+ sig { returns(T.nilable(Integer)) }
27
+ attr_reader :amount
28
+
29
+ sig { params(amount: Integer).void }
30
+ attr_writer :amount
31
+
32
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
33
+ # used for a low quality image that the recipient wasn't able to handle.
34
+ sig do
35
+ returns(
36
+ T.nilable(
37
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
38
+ )
39
+ )
40
+ end
41
+ attr_reader :reason
42
+
43
+ sig do
44
+ params(
45
+ reason:
46
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
47
+ ).void
48
+ end
49
+ attr_writer :reason
50
+
51
+ sig do
52
+ params(
53
+ check_deposit_id: String,
54
+ amount: Integer,
55
+ reason:
56
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
57
+ request_options: Increase::RequestOptions::OrHash
58
+ ).returns(T.attached_class)
59
+ end
60
+ def self.new(
61
+ # The identifier of the Check Deposit you wish to adjust.
62
+ check_deposit_id:,
63
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
64
+ # cents). A negative amount means that the funds are being clawed back by the
65
+ # other bank and is a debit to your account. Defaults to the negative of the Check
66
+ # Deposit amount.
67
+ amount: nil,
68
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
69
+ # used for a low quality image that the recipient wasn't able to handle.
70
+ reason: nil,
71
+ request_options: {}
72
+ )
73
+ end
74
+
75
+ sig do
76
+ override.returns(
77
+ {
78
+ check_deposit_id: String,
79
+ amount: Integer,
80
+ reason:
81
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
82
+ request_options: Increase::RequestOptions
83
+ }
84
+ )
85
+ end
86
+ def to_hash
87
+ end
88
+
89
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
90
+ # used for a low quality image that the recipient wasn't able to handle.
91
+ module Reason
92
+ extend Increase::Internal::Type::Enum
93
+
94
+ TaggedSymbol =
95
+ T.type_alias do
96
+ T.all(
97
+ Symbol,
98
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason
99
+ )
100
+ end
101
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
102
+
103
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
104
+ LATE_RETURN =
105
+ T.let(
106
+ :late_return,
107
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
108
+ )
109
+
110
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
111
+ WRONG_PAYEE_CREDIT =
112
+ T.let(
113
+ :wrong_payee_credit,
114
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
115
+ )
116
+
117
+ # The check was deposited with a different amount than what was written on the check.
118
+ ADJUSTED_AMOUNT =
119
+ T.let(
120
+ :adjusted_amount,
121
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
122
+ )
123
+
124
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
125
+ NON_CONFORMING_ITEM =
126
+ T.let(
127
+ :non_conforming_item,
128
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
129
+ )
130
+
131
+ # The check has already been deposited elsewhere and so this is a duplicate.
132
+ PAID =
133
+ T.let(
134
+ :paid,
135
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
136
+ )
137
+
138
+ sig do
139
+ override.returns(
140
+ T::Array[
141
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
142
+ ]
143
+ )
144
+ end
145
+ def self.values
146
+ end
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -4,6 +4,34 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class CheckDeposits
7
+ # Simulates the creation of a
8
+ # [Check Deposit Adjustment](#check-deposit-adjustments) on a
9
+ # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
10
+ # of `submitted`.
11
+ sig do
12
+ params(
13
+ check_deposit_id: String,
14
+ amount: Integer,
15
+ reason:
16
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
17
+ request_options: Increase::RequestOptions::OrHash
18
+ ).returns(Increase::CheckDeposit)
19
+ end
20
+ def adjustment(
21
+ # The identifier of the Check Deposit you wish to adjust.
22
+ check_deposit_id,
23
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
24
+ # cents). A negative amount means that the funds are being clawed back by the
25
+ # other bank and is a debit to your account. Defaults to the negative of the Check
26
+ # Deposit amount.
27
+ amount: nil,
28
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
29
+ # used for a low quality image that the recipient wasn't able to handle.
30
+ reason: nil,
31
+ request_options: {}
32
+ )
33
+ end
34
+
7
35
  # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
8
36
  # factors like poor image quality. This Check Deposit must first have a `status`
9
37
  # of `pending`.
@@ -234,6 +234,10 @@ module Increase
234
234
  purchase_amount: Integer?,
235
235
  purchase_currency: String?,
236
236
  real_time_decision_id: String?,
237
+ requestor_authentication_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_authentication_indicator?,
238
+ requestor_challenge_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_challenge_indicator?,
239
+ requestor_name: String,
240
+ requestor_url: String,
237
241
  status: Increase::Models::CardPayment::Element::CardAuthentication::status,
238
242
  type: Increase::Models::CardPayment::Element::CardAuthentication::type_
239
243
  }
@@ -289,6 +293,14 @@ module Increase
289
293
 
290
294
  attr_accessor real_time_decision_id: String?
291
295
 
296
+ attr_accessor requestor_authentication_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_authentication_indicator?
297
+
298
+ attr_accessor requestor_challenge_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_challenge_indicator?
299
+
300
+ attr_accessor requestor_name: String
301
+
302
+ attr_accessor requestor_url: String
303
+
292
304
  attr_accessor status: Increase::Models::CardPayment::Element::CardAuthentication::status
293
305
 
294
306
  attr_accessor type: Increase::Models::CardPayment::Element::CardAuthentication::type_
@@ -319,6 +331,10 @@ module Increase
319
331
  purchase_amount: Integer?,
320
332
  purchase_currency: String?,
321
333
  real_time_decision_id: String?,
334
+ requestor_authentication_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_authentication_indicator?,
335
+ requestor_challenge_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_challenge_indicator?,
336
+ requestor_name: String,
337
+ requestor_url: String,
322
338
  status: Increase::Models::CardPayment::Element::CardAuthentication::status,
323
339
  type: Increase::Models::CardPayment::Element::CardAuthentication::type_
324
340
  ) -> void
@@ -349,6 +365,10 @@ module Increase
349
365
  purchase_amount: Integer?,
350
366
  purchase_currency: String?,
351
367
  real_time_decision_id: String?,
368
+ requestor_authentication_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_authentication_indicator?,
369
+ requestor_challenge_indicator: Increase::Models::CardPayment::Element::CardAuthentication::requestor_challenge_indicator?,
370
+ requestor_name: String,
371
+ requestor_url: String,
352
372
  status: Increase::Models::CardPayment::Element::CardAuthentication::status,
353
373
  type: Increase::Models::CardPayment::Element::CardAuthentication::type_
354
374
  }
@@ -579,6 +599,86 @@ module Increase
579
599
  end
580
600
  end
581
601
 
602
+ type requestor_authentication_indicator =
603
+ :payment_transaction
604
+ | :recurring_transaction
605
+ | :installment_transaction
606
+ | :add_card
607
+ | :maintain_card
608
+ | :emv_token_cardholder_verification
609
+ | :billing_agreement
610
+
611
+ module RequestorAuthenticationIndicator
612
+ extend Increase::Internal::Type::Enum
613
+
614
+ # The authentication is for a payment transaction.
615
+ PAYMENT_TRANSACTION: :payment_transaction
616
+
617
+ # The authentication is for a recurring transaction.
618
+ RECURRING_TRANSACTION: :recurring_transaction
619
+
620
+ # The authentication is for an installment transaction.
621
+ INSTALLMENT_TRANSACTION: :installment_transaction
622
+
623
+ # The authentication is for adding a card.
624
+ ADD_CARD: :add_card
625
+
626
+ # The authentication is for maintaining a card.
627
+ MAINTAIN_CARD: :maintain_card
628
+
629
+ # The authentication is for EMV token cardholder verification.
630
+ EMV_TOKEN_CARDHOLDER_VERIFICATION: :emv_token_cardholder_verification
631
+
632
+ # The authentication is for a billing agreement.
633
+ BILLING_AGREEMENT: :billing_agreement
634
+
635
+ def self?.values: -> ::Array[Increase::Models::CardPayment::Element::CardAuthentication::requestor_authentication_indicator]
636
+ end
637
+
638
+ type requestor_challenge_indicator =
639
+ :no_preference
640
+ | :no_challenge_requested
641
+ | :challenge_requested_3ds_requestor_preference
642
+ | :challenge_requested_mandate
643
+ | :no_challenge_requested_transactional_risk_analysis_already_performed
644
+ | :no_challenge_requested_data_share_only
645
+ | :no_challenge_requested_strong_consumer_authentication_already_performed
646
+ | :no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required
647
+ | :challenge_requested_whitelist_prompt_requested_if_challenge_required
648
+
649
+ module RequestorChallengeIndicator
650
+ extend Increase::Internal::Type::Enum
651
+
652
+ # No preference.
653
+ NO_PREFERENCE: :no_preference
654
+
655
+ # No challenge requested.
656
+ NO_CHALLENGE_REQUESTED: :no_challenge_requested
657
+
658
+ # Challenge requested, 3DS Requestor preference.
659
+ CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE: :challenge_requested_3ds_requestor_preference
660
+
661
+ # Challenge requested, mandate.
662
+ CHALLENGE_REQUESTED_MANDATE: :challenge_requested_mandate
663
+
664
+ # No challenge requested, transactional risk analysis already performed.
665
+ NO_CHALLENGE_REQUESTED_TRANSACTIONAL_RISK_ANALYSIS_ALREADY_PERFORMED: :no_challenge_requested_transactional_risk_analysis_already_performed
666
+
667
+ # No challenge requested, data share only.
668
+ NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY: :no_challenge_requested_data_share_only
669
+
670
+ # No challenge requested, strong consumer authentication already performed.
671
+ NO_CHALLENGE_REQUESTED_STRONG_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED: :no_challenge_requested_strong_consumer_authentication_already_performed
672
+
673
+ # No challenge requested, utilize whitelist exemption if no challenge required.
674
+ NO_CHALLENGE_REQUESTED_UTILIZE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED: :no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required
675
+
676
+ # Challenge requested, whitelist prompt requested if challenge required.
677
+ CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED: :challenge_requested_whitelist_prompt_requested_if_challenge_required
678
+
679
+ def self?.values: -> ::Array[Increase::Models::CardPayment::Element::CardAuthentication::requestor_challenge_indicator]
680
+ end
681
+
582
682
  type status =
583
683
  :denied
584
684
  | :authenticated_with_challenge
@@ -0,0 +1,72 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type check_deposit_adjustment_params =
5
+ {
6
+ check_deposit_id: String,
7
+ amount: Integer,
8
+ reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
9
+ }
10
+ & Increase::Internal::Type::request_parameters
11
+
12
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
13
+ extend Increase::Internal::Type::RequestParameters::Converter
14
+ include Increase::Internal::Type::RequestParameters
15
+
16
+ attr_accessor check_deposit_id: String
17
+
18
+ attr_reader amount: Integer?
19
+
20
+ def amount=: (Integer) -> Integer
21
+
22
+ attr_reader reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason?
23
+
24
+ def reason=: (
25
+ Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
26
+ ) -> Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
27
+
28
+ def initialize: (
29
+ check_deposit_id: String,
30
+ ?amount: Integer,
31
+ ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
32
+ ?request_options: Increase::request_opts
33
+ ) -> void
34
+
35
+ def to_hash: -> {
36
+ check_deposit_id: String,
37
+ amount: Integer,
38
+ reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
39
+ request_options: Increase::RequestOptions
40
+ }
41
+
42
+ type reason =
43
+ :late_return
44
+ | :wrong_payee_credit
45
+ | :adjusted_amount
46
+ | :non_conforming_item
47
+ | :paid
48
+
49
+ module Reason
50
+ extend Increase::Internal::Type::Enum
51
+
52
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
53
+ LATE_RETURN: :late_return
54
+
55
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
56
+ WRONG_PAYEE_CREDIT: :wrong_payee_credit
57
+
58
+ # The check was deposited with a different amount than what was written on the check.
59
+ ADJUSTED_AMOUNT: :adjusted_amount
60
+
61
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
62
+ NON_CONFORMING_ITEM: :non_conforming_item
63
+
64
+ # The check has already been deposited elsewhere and so this is a duplicate.
65
+ PAID: :paid
66
+
67
+ def self?.values: -> ::Array[Increase::Models::Simulations::CheckDepositAdjustmentParams::reason]
68
+ end
69
+ end
70
+ end
71
+ end
72
+ end
@@ -2,6 +2,13 @@ module Increase
2
2
  module Resources
3
3
  class Simulations
4
4
  class CheckDeposits
5
+ def adjustment: (
6
+ String check_deposit_id,
7
+ ?amount: Integer,
8
+ ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
9
+ ?request_options: Increase::request_opts
10
+ ) -> Increase::CheckDeposit
11
+
5
12
  def reject: (
6
13
  String check_deposit_id,
7
14
  ?request_options: Increase::request_opts
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.228.0
4
+ version: 1.230.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -321,6 +321,7 @@ files:
321
321
  - lib/increase/models/simulations/card_reversal_create_params.rb
322
322
  - lib/increase/models/simulations/card_settlement_create_params.rb
323
323
  - lib/increase/models/simulations/card_token_create_params.rb
324
+ - lib/increase/models/simulations/check_deposit_adjustment_params.rb
324
325
  - lib/increase/models/simulations/check_deposit_reject_params.rb
325
326
  - lib/increase/models/simulations/check_deposit_return_params.rb
326
327
  - lib/increase/models/simulations/check_deposit_submit_params.rb
@@ -730,6 +731,7 @@ files:
730
731
  - rbi/increase/models/simulations/card_reversal_create_params.rbi
731
732
  - rbi/increase/models/simulations/card_settlement_create_params.rbi
732
733
  - rbi/increase/models/simulations/card_token_create_params.rbi
734
+ - rbi/increase/models/simulations/check_deposit_adjustment_params.rbi
733
735
  - rbi/increase/models/simulations/check_deposit_reject_params.rbi
734
736
  - rbi/increase/models/simulations/check_deposit_return_params.rbi
735
737
  - rbi/increase/models/simulations/check_deposit_submit_params.rbi
@@ -1138,6 +1140,7 @@ files:
1138
1140
  - sig/increase/models/simulations/card_reversal_create_params.rbs
1139
1141
  - sig/increase/models/simulations/card_settlement_create_params.rbs
1140
1142
  - sig/increase/models/simulations/card_token_create_params.rbs
1143
+ - sig/increase/models/simulations/check_deposit_adjustment_params.rbs
1141
1144
  - sig/increase/models/simulations/check_deposit_reject_params.rbs
1142
1145
  - sig/increase/models/simulations/check_deposit_return_params.rbs
1143
1146
  - sig/increase/models/simulations/check_deposit_submit_params.rbs