increase 1.363.0 → 1.364.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 (100) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -0
  4. data/lib/increase/models/account_number.rb +51 -81
  5. data/lib/increase/models/account_number_create_params.rb +41 -75
  6. data/lib/increase/models/account_number_list_params.rb +39 -39
  7. data/lib/increase/models/account_number_update_params.rb +48 -79
  8. data/lib/increase/models/card_payment.rb +6 -0
  9. data/lib/increase/models/card_update_params.rb +12 -8
  10. data/lib/increase/models/checkbook.rb +352 -0
  11. data/lib/increase/models/checkbook_check.rb +100 -0
  12. data/lib/increase/models/checkbook_check_list_params.rb +61 -0
  13. data/lib/increase/models/checkbook_check_retrieve_params.rb +22 -0
  14. data/lib/increase/models/checkbook_check_stop_params.rb +22 -0
  15. data/lib/increase/models/checkbook_create_params.rb +111 -0
  16. data/lib/increase/models/checkbook_list_params.rb +104 -0
  17. data/lib/increase/models/checkbook_retrieve_params.rb +22 -0
  18. data/lib/increase/models/checkbook_stop_params.rb +22 -0
  19. data/lib/increase/models/declined_transaction.rb +10 -1
  20. data/lib/increase/models/entity.rb +1 -65
  21. data/lib/increase/models/entity_create_params.rb +1 -65
  22. data/lib/increase/models/entity_update_params.rb +1 -57
  23. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  24. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  25. data/lib/increase/models/real_time_decision.rb +65 -1
  26. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  27. data/lib/increase/models/transaction.rb +24 -2
  28. data/lib/increase/models.rb +18 -0
  29. data/lib/increase/resources/account_numbers.rb +19 -16
  30. data/lib/increase/resources/checkbook_checks.rb +90 -0
  31. data/lib/increase/resources/checkbooks.rb +127 -0
  32. data/lib/increase/resources/entities.rb +2 -12
  33. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  34. data/lib/increase/resources/simulations.rb +4 -0
  35. data/lib/increase/version.rb +1 -1
  36. data/lib/increase.rb +13 -0
  37. data/rbi/increase/client.rbi +6 -0
  38. data/rbi/increase/models/account_number.rbi +86 -173
  39. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  40. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  41. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  42. data/rbi/increase/models/card_payment.rbi +14 -0
  43. data/rbi/increase/models/card_update_params.rbi +17 -15
  44. data/rbi/increase/models/checkbook.rbi +507 -0
  45. data/rbi/increase/models/checkbook_check.rbi +142 -0
  46. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  47. data/rbi/increase/models/checkbook_check_retrieve_params.rbi +46 -0
  48. data/rbi/increase/models/checkbook_check_stop_params.rbi +43 -0
  49. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  50. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  51. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  52. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  53. data/rbi/increase/models/declined_transaction.rbi +8 -0
  54. data/rbi/increase/models/entity.rbi +0 -97
  55. data/rbi/increase/models/entity_create_params.rbi +0 -119
  56. data/rbi/increase/models/entity_update_params.rbi +0 -108
  57. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  58. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  59. data/rbi/increase/models/real_time_decision.rbi +134 -3
  60. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  61. data/rbi/increase/models/transaction.rbi +30 -0
  62. data/rbi/increase/models.rbi +18 -0
  63. data/rbi/increase/resources/account_numbers.rbi +24 -19
  64. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  65. data/rbi/increase/resources/checkbooks.rbi +96 -0
  66. data/rbi/increase/resources/entities.rbi +0 -11
  67. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  68. data/rbi/increase/resources/simulations.rbi +3 -0
  69. data/sig/increase/client.rbs +4 -0
  70. data/sig/increase/models/account_number.rbs +34 -66
  71. data/sig/increase/models/account_number_create_params.rbs +30 -64
  72. data/sig/increase/models/account_number_list_params.rbs +44 -44
  73. data/sig/increase/models/account_number_update_params.rbs +39 -77
  74. data/sig/increase/models/card_payment.rbs +8 -0
  75. data/sig/increase/models/card_update_params.rbs +7 -11
  76. data/sig/increase/models/checkbook.rbs +272 -0
  77. data/sig/increase/models/checkbook_check.rbs +76 -0
  78. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  79. data/sig/increase/models/checkbook_check_retrieve_params.rbs +24 -0
  80. data/sig/increase/models/checkbook_check_stop_params.rbs +24 -0
  81. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  82. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  83. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  84. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  85. data/sig/increase/models/declined_transaction.rbs +5 -0
  86. data/sig/increase/models/entity.rbs +0 -46
  87. data/sig/increase/models/entity_create_params.rbs +0 -55
  88. data/sig/increase/models/entity_update_params.rbs +0 -48
  89. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  90. data/sig/increase/models/real_time_decision.rbs +69 -3
  91. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  92. data/sig/increase/models/transaction.rbs +22 -1
  93. data/sig/increase/models.rbs +18 -0
  94. data/sig/increase/resources/account_numbers.rbs +5 -5
  95. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  96. data/sig/increase/resources/checkbooks.rbs +33 -0
  97. data/sig/increase/resources/entities.rbs +0 -3
  98. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  99. data/sig/increase/resources/simulations.rbs +2 -0
  100. metadata +41 -2
@@ -3945,16 +3945,80 @@ module Increase
3945
3945
 
3946
3946
  # @see Increase::Models::RealTimeDecision::DigitalWalletToken#device
3947
3947
  class Device < Increase::Internal::Type::BaseModel
3948
+ # @!attribute device_type
3949
+ # Device type.
3950
+ #
3951
+ # @return [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Device::DeviceType, nil]
3952
+ required :device_type,
3953
+ enum: -> { Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType },
3954
+ nil?: true
3955
+
3948
3956
  # @!attribute identifier
3949
3957
  # ID assigned to the device by the digital wallet provider.
3950
3958
  #
3951
3959
  # @return [String, nil]
3952
3960
  required :identifier, String, nil?: true
3953
3961
 
3954
- # @!method initialize(identifier:)
3962
+ # @!attribute ip_address
3963
+ # IP address of the device.
3964
+ #
3965
+ # @return [String, nil]
3966
+ required :ip_address, String, nil?: true
3967
+
3968
+ # @!attribute name
3969
+ # Name of the device, for example "My Work Phone".
3970
+ #
3971
+ # @return [String, nil]
3972
+ required :name, String, nil?: true
3973
+
3974
+ # @!method initialize(device_type:, identifier:, ip_address:, name:)
3955
3975
  # Device that is being used to provision the digital wallet token.
3956
3976
  #
3977
+ # @param device_type [Symbol, Increase::Models::RealTimeDecision::DigitalWalletToken::Device::DeviceType, nil]
3978
+ # Device type.
3979
+ #
3957
3980
  # @param identifier [String, nil] ID assigned to the device by the digital wallet provider.
3981
+ #
3982
+ # @param ip_address [String, nil] IP address of the device.
3983
+ #
3984
+ # @param name [String, nil] Name of the device, for example "My Work Phone".
3985
+
3986
+ # Device type.
3987
+ #
3988
+ # @see Increase::Models::RealTimeDecision::DigitalWalletToken::Device#device_type
3989
+ module DeviceType
3990
+ extend Increase::Internal::Type::Enum
3991
+
3992
+ # Unknown
3993
+ UNKNOWN = :unknown
3994
+
3995
+ # Mobile Phone
3996
+ MOBILE_PHONE = :mobile_phone
3997
+
3998
+ # Tablet
3999
+ TABLET = :tablet
4000
+
4001
+ # Watch
4002
+ WATCH = :watch
4003
+
4004
+ # Mobile Phone or Tablet
4005
+ MOBILEPHONE_OR_TABLET = :mobilephone_or_tablet
4006
+
4007
+ # PC
4008
+ PC = :pc
4009
+
4010
+ # Household Device
4011
+ HOUSEHOLD_DEVICE = :household_device
4012
+
4013
+ # Wearable Device
4014
+ WEARABLE_DEVICE = :wearable_device
4015
+
4016
+ # Automobile Device
4017
+ AUTOMOBILE_DEVICE = :automobile_device
4018
+
4019
+ # @!method self.values
4020
+ # @return [Array<Symbol>]
4021
+ end
3958
4022
  end
3959
4023
 
3960
4024
  # The digital wallet app being used.
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::Checkbooks#mail
7
+ class CheckbookMailParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute checkbook_id
12
+ # The identifier of the Checkbook you wish to mail.
13
+ #
14
+ # @return [String]
15
+ required :checkbook_id, String
16
+
17
+ # @!method initialize(checkbook_id:, request_options: {})
18
+ # @param checkbook_id [String] The identifier of the Checkbook you wish to mail.
19
+ #
20
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
24
+ end
@@ -4472,6 +4472,9 @@ module Increase
4472
4472
  # Electric vehicle charging level 3 480 volt
4473
4473
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
4474
4474
 
4475
+ # Diesel 1 off-road non-taxable
4476
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
4477
+
4475
4478
  # Renewable diesel R95 or greater off-road non-taxable
4476
4479
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
4477
4480
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -6752,6 +6755,9 @@ module Increase
6752
6755
  # Electric vehicle charging level 3 480 volt
6753
6756
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
6754
6757
 
6758
+ # Diesel 1 off-road non-taxable
6759
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
6760
+
6755
6761
  # Renewable diesel R95 or greater off-road non-taxable
6756
6762
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
6757
6763
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -8144,6 +8150,12 @@ module Increase
8144
8150
  # @return [String, nil]
8145
8151
  required :bank_of_first_deposit_routing_number, String, nil?: true
8146
8152
 
8153
+ # @!attribute checkbook_check_id
8154
+ # The identifier of the Checkbook Check object that was deposited.
8155
+ #
8156
+ # @return [String, nil]
8157
+ required :checkbook_check_id, String, nil?: true
8158
+
8147
8159
  # @!attribute deposited_at
8148
8160
  # When the check was deposited.
8149
8161
  #
@@ -8183,7 +8195,7 @@ module Increase
8183
8195
  # @return [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type]
8184
8196
  required :type, enum: -> { Increase::Transaction::Source::CheckTransferDeposit::Type }
8185
8197
 
8186
- # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
8198
+ # @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, checkbook_check_id:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
8187
8199
  # A Check Transfer Deposit object. This field will be present in the JSON response
8188
8200
  # if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
8189
8201
  # is a check drawn on an Increase account that has been deposited by an external
@@ -8198,6 +8210,8 @@ module Increase
8198
8210
  # bank depositing this check. In some rare cases, this is not transmitted via
8199
8211
  # Check 21 and the value will be null.
8200
8212
  #
8213
+ # @param checkbook_check_id [String, nil] The identifier of the Checkbook Check object that was deposited.
8214
+ #
8201
8215
  # @param deposited_at [Time] When the check was deposited.
8202
8216
  #
8203
8217
  # @param front_image_file_id [String, nil]
@@ -8675,6 +8689,12 @@ module Increase
8675
8689
 
8676
8690
  # @see Increase::Models::Transaction::Source#inbound_check_deposit_return_intention
8677
8691
  class InboundCheckDepositReturnIntention < Increase::Internal::Type::BaseModel
8692
+ # @!attribute checkbook_check_id
8693
+ # The identifier of the Checkbook Check object that was deposited.
8694
+ #
8695
+ # @return [String, nil]
8696
+ required :checkbook_check_id, String, nil?: true
8697
+
8678
8698
  # @!attribute inbound_check_deposit_id
8679
8699
  # The ID of the Inbound Check Deposit that is being returned.
8680
8700
  #
@@ -8687,13 +8707,15 @@ module Increase
8687
8707
  # @return [String, nil]
8688
8708
  required :transfer_id, String, nil?: true
8689
8709
 
8690
- # @!method initialize(inbound_check_deposit_id:, transfer_id:)
8710
+ # @!method initialize(checkbook_check_id:, inbound_check_deposit_id:, transfer_id:)
8691
8711
  # An Inbound Check Deposit Return Intention object. This field will be present in
8692
8712
  # the JSON response if and only if `category` is equal to
8693
8713
  # `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
8694
8714
  # Intention is created when Increase receives an Inbound Check and the User
8695
8715
  # requests that it be returned.
8696
8716
  #
8717
+ # @param checkbook_check_id [String, nil] The identifier of the Checkbook Check object that was deposited.
8718
+ #
8697
8719
  # @param inbound_check_deposit_id [String] The ID of the Inbound Check Deposit that is being returned.
8698
8720
  #
8699
8721
  # @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited.
@@ -193,6 +193,24 @@ module Increase
193
193
 
194
194
  CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
195
195
 
196
+ Checkbook = Increase::Models::Checkbook
197
+
198
+ CheckbookCheck = Increase::Models::CheckbookCheck
199
+
200
+ CheckbookCheckListParams = Increase::Models::CheckbookCheckListParams
201
+
202
+ CheckbookCheckRetrieveParams = Increase::Models::CheckbookCheckRetrieveParams
203
+
204
+ CheckbookCheckStopParams = Increase::Models::CheckbookCheckStopParams
205
+
206
+ CheckbookCreateParams = Increase::Models::CheckbookCreateParams
207
+
208
+ CheckbookListParams = Increase::Models::CheckbookListParams
209
+
210
+ CheckbookRetrieveParams = Increase::Models::CheckbookRetrieveParams
211
+
212
+ CheckbookStopParams = Increase::Models::CheckbookStopParams
213
+
196
214
  CheckDeposit = Increase::Models::CheckDeposit
197
215
 
198
216
  CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams
@@ -5,18 +5,20 @@ module Increase
5
5
  class AccountNumbers
6
6
  # Create an Account Number
7
7
  #
8
- # @overload create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
8
+ # @overload create(account_id:, name:, inbound_ach_debits: nil, unregistered_inbound_checks: nil, request_options: {})
9
9
  #
10
10
  # @param account_id [String] The Account the Account Number should belong to.
11
11
  #
12
12
  # @param name [String] The name you choose for the Account Number.
13
13
  #
14
- # @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
15
- # Options related to how this Account Number should handle inbound ACH transfers.
14
+ # @param inbound_ach_debits [Symbol, Increase::Models::AccountNumberCreateParams::InboundACHDebits]
15
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
16
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
17
+ # active. If you do not specify this field, the default is `allowed`.
16
18
  #
17
- # @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
18
- # Options related to how this Account Number should handle inbound check
19
- # withdrawals.
19
+ # @param unregistered_inbound_checks [Symbol, Increase::Models::AccountNumberCreateParams::UnregisteredInboundChecks]
20
+ # Whether unregistered inbound checks for this Account Number can be deposited. If
21
+ # you do not specify this field, the default is `blocked`.
20
22
  #
21
23
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
22
24
  #
@@ -56,22 +58,23 @@ module Increase
56
58
 
57
59
  # Update an Account Number
58
60
  #
59
- # @overload update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
61
+ # @overload update(account_number_id, inbound_ach_debits: nil, name: nil, status: nil, unregistered_inbound_checks: nil, request_options: {})
60
62
  #
61
63
  # @param account_number_id [String] The identifier of the Account Number.
62
64
  #
63
- # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
64
- # Options related to how this Account Number handles inbound ACH transfers.
65
- #
66
- # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
67
- # Options related to how this Account Number should handle inbound check
68
- # withdrawals.
65
+ # @param inbound_ach_debits [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACHDebits]
66
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
67
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
68
+ # active.
69
69
  #
70
70
  # @param name [String] The name you choose for the Account Number.
71
71
  #
72
72
  # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
73
73
  # This indicates if transfers can be made to the Account Number.
74
74
  #
75
+ # @param unregistered_inbound_checks [Symbol, Increase::Models::AccountNumberUpdateParams::UnregisteredInboundChecks]
76
+ # Whether unregistered inbound checks for this Account Number can be deposited.
77
+ #
75
78
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
76
79
  #
77
80
  # @return [Increase::Models::AccountNumber]
@@ -90,12 +93,10 @@ module Increase
90
93
 
91
94
  # List Account Numbers
92
95
  #
93
- # @overload list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
96
+ # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, inbound_ach_debits: nil, limit: nil, status: nil, request_options: {})
94
97
  #
95
98
  # @param account_id [String] Filter Account Numbers to those belonging to the specified Account.
96
99
  #
97
- # @param ach_debit_status [Increase::Models::AccountNumberListParams::ACHDebitStatus]
98
- #
99
100
  # @param created_at [Increase::Models::AccountNumberListParams::CreatedAt]
100
101
  #
101
102
  # @param cursor [String] Return the page of entries after this one.
@@ -106,6 +107,8 @@ module Increase
106
107
  # request is only processed once. Learn more about
107
108
  # [idempotency](https://increase.com/documentation/idempotency-keys).
108
109
  #
110
+ # @param inbound_ach_debits [Increase::Models::AccountNumberListParams::InboundACHDebits]
111
+ #
109
112
  # @param limit [Integer]
110
113
  # Limit the size of the list that is returned. The default (and maximum) is 100
111
114
  # objects.
@@ -0,0 +1,90 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class CheckbookChecks
6
+ # Retrieve a Checkbook Check
7
+ #
8
+ # @overload retrieve(checkbook_check_id, request_options: {})
9
+ #
10
+ # @param checkbook_check_id [String] The identifier of the Checkbook Check.
11
+ #
12
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
13
+ #
14
+ # @return [Increase::Models::CheckbookCheck]
15
+ #
16
+ # @see Increase::Models::CheckbookCheckRetrieveParams
17
+ def retrieve(checkbook_check_id, params = {})
18
+ @client.request(
19
+ method: :get,
20
+ path: ["checkbook_checks/%1$s", checkbook_check_id],
21
+ model: Increase::CheckbookCheck,
22
+ options: params[:request_options]
23
+ )
24
+ end
25
+
26
+ # List Checkbook Checks
27
+ #
28
+ # @overload list(account_number_id: nil, check_number: nil, checkbook_id: nil, cursor: nil, limit: nil, request_options: {})
29
+ #
30
+ # @param account_number_id [String] Filter Checkbook Checks to those drawn on the specified Account Number.
31
+ #
32
+ # @param check_number [Integer] Filter Checkbook Checks to the one with the specified check number.
33
+ #
34
+ # @param checkbook_id [String] Filter Checkbook Checks to those belonging to the specified Checkbook.
35
+ #
36
+ # @param cursor [String] Return the page of entries after this one.
37
+ #
38
+ # @param limit [Integer]
39
+ # Limit the size of the list that is returned. The default (and maximum) is 100
40
+ # objects.
41
+ #
42
+ # Defaults to `100`.
43
+ #
44
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
45
+ #
46
+ # @return [Increase::Internal::Page<Increase::Models::CheckbookCheck>]
47
+ #
48
+ # @see Increase::Models::CheckbookCheckListParams
49
+ def list(params = {})
50
+ parsed, options = Increase::CheckbookCheckListParams.dump_request(params)
51
+ query = Increase::Internal::Util.encode_query_params(parsed)
52
+ @client.request(
53
+ method: :get,
54
+ path: "checkbook_checks",
55
+ query: query,
56
+ page: Increase::Internal::Page,
57
+ model: Increase::CheckbookCheck,
58
+ options: options
59
+ )
60
+ end
61
+
62
+ # Stop a Checkbook Check. A stopped check cannot be deposited.
63
+ #
64
+ # @overload stop(checkbook_check_id, request_options: {})
65
+ #
66
+ # @param checkbook_check_id [String] The identifier of the Checkbook Check to stop.
67
+ #
68
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
69
+ #
70
+ # @return [Increase::Models::CheckbookCheck]
71
+ #
72
+ # @see Increase::Models::CheckbookCheckStopParams
73
+ def stop(checkbook_check_id, params = {})
74
+ @client.request(
75
+ method: :post,
76
+ path: ["checkbook_checks/%1$s/stop", checkbook_check_id],
77
+ model: Increase::CheckbookCheck,
78
+ options: params[:request_options]
79
+ )
80
+ end
81
+
82
+ # @api private
83
+ #
84
+ # @param client [Increase::Client]
85
+ def initialize(client:)
86
+ @client = client
87
+ end
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,127 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class Checkbooks
6
+ # Create a Checkbook
7
+ #
8
+ # @overload create(account_number_id:, mailing_address:, payer:, request_options: {})
9
+ #
10
+ # @param account_number_id [String]
11
+ # The identifier of the Account Number that the checks will draw from. The Account
12
+ # Number must be active.
13
+ #
14
+ # @param mailing_address [Increase::Models::CheckbookCreateParams::MailingAddress]
15
+ # The destination address that the Checkbook will be mailed to.
16
+ #
17
+ # @param payer [Array<Increase::Models::CheckbookCreateParams::Payer>]
18
+ # The payer of the checks. This will be printed on the top-left corner of each
19
+ # check. This should be an array of up to 4 elements, each of which represents a
20
+ # line of the payer.
21
+ #
22
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
23
+ #
24
+ # @return [Increase::Models::Checkbook]
25
+ #
26
+ # @see Increase::Models::CheckbookCreateParams
27
+ def create(params)
28
+ parsed, options = Increase::CheckbookCreateParams.dump_request(params)
29
+ @client.request(
30
+ method: :post,
31
+ path: "checkbooks",
32
+ body: parsed,
33
+ model: Increase::Checkbook,
34
+ options: options
35
+ )
36
+ end
37
+
38
+ # Retrieve a Checkbook
39
+ #
40
+ # @overload retrieve(checkbook_id, request_options: {})
41
+ #
42
+ # @param checkbook_id [String] The identifier of the Checkbook.
43
+ #
44
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
45
+ #
46
+ # @return [Increase::Models::Checkbook]
47
+ #
48
+ # @see Increase::Models::CheckbookRetrieveParams
49
+ def retrieve(checkbook_id, params = {})
50
+ @client.request(
51
+ method: :get,
52
+ path: ["checkbooks/%1$s", checkbook_id],
53
+ model: Increase::Checkbook,
54
+ options: params[:request_options]
55
+ )
56
+ end
57
+
58
+ # List Checkbooks
59
+ #
60
+ # @overload list(account_number_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
61
+ #
62
+ # @param account_number_id [String] Filter Checkbooks to those attached to the specified Account Number.
63
+ #
64
+ # @param cursor [String] Return the page of entries after this one.
65
+ #
66
+ # @param idempotency_key [String]
67
+ # Filter records to the one with the specified `idempotency_key` you chose for
68
+ # that object. This value is unique across Increase and is used to ensure that a
69
+ # request is only processed once. Learn more about
70
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
71
+ #
72
+ # @param limit [Integer]
73
+ # Limit the size of the list that is returned. The default (and maximum) is 100
74
+ # objects.
75
+ #
76
+ # Defaults to `100`.
77
+ #
78
+ # @param status [Increase::Models::CheckbookListParams::Status]
79
+ #
80
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
81
+ #
82
+ # @return [Increase::Internal::Page<Increase::Models::Checkbook>]
83
+ #
84
+ # @see Increase::Models::CheckbookListParams
85
+ def list(params = {})
86
+ parsed, options = Increase::CheckbookListParams.dump_request(params)
87
+ query = Increase::Internal::Util.encode_query_params(parsed)
88
+ @client.request(
89
+ method: :get,
90
+ path: "checkbooks",
91
+ query: query,
92
+ page: Increase::Internal::Page,
93
+ model: Increase::Checkbook,
94
+ options: options
95
+ )
96
+ end
97
+
98
+ # Stop a Checkbook. Stopping a Checkbook stops all of its checks that have not yet
99
+ # been deposited.
100
+ #
101
+ # @overload stop(checkbook_id, request_options: {})
102
+ #
103
+ # @param checkbook_id [String] The identifier of the Checkbook to stop.
104
+ #
105
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
106
+ #
107
+ # @return [Increase::Models::Checkbook]
108
+ #
109
+ # @see Increase::Models::CheckbookStopParams
110
+ def stop(checkbook_id, params = {})
111
+ @client.request(
112
+ method: :post,
113
+ path: ["checkbooks/%1$s/stop", checkbook_id],
114
+ model: Increase::Checkbook,
115
+ options: params[:request_options]
116
+ )
117
+ end
118
+
119
+ # @api private
120
+ #
121
+ # @param client [Increase::Client]
122
+ def initialize(client:)
123
+ @client = client
124
+ end
125
+ end
126
+ end
127
+ end
@@ -5,7 +5,7 @@ module Increase
5
5
  class Entities
6
6
  # Create an Entity
7
7
  #
8
- # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
8
+ # @overload create(structure:, corporation: nil, government_authority: nil, joint: nil, natural_person: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
9
9
  #
10
10
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
11
11
  #
@@ -13,8 +13,6 @@ module Increase
13
13
  # Details of the corporation entity to create. Required if `structure` is equal to
14
14
  # `corporation`.
15
15
  #
16
- # @param description [String] The description you choose to give the entity.
17
- #
18
16
  # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
19
17
  # Details of the Government Authority entity to create. Required if `structure` is
20
18
  # equal to `government_authority`.
@@ -29,10 +27,6 @@ module Increase
29
27
  # `social_security_number` or `individual_taxpayer_identification_number`
30
28
  # identification methods.
31
29
  #
32
- # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
33
- # An assessment of the entity's potential risk of involvement in financial crimes,
34
- # such as money laundering.
35
- #
36
30
  # @param sole_proprietorship [Increase::Models::EntityCreateParams::SoleProprietorship]
37
31
  # Details of the sole proprietorship entity to create. Required if `structure` is
38
32
  # equal to `sole_proprietorship`.
@@ -91,7 +85,7 @@ module Increase
91
85
 
92
86
  # Update an Entity
93
87
  #
94
- # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
88
+ # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
95
89
  #
96
90
  # @param entity_id [String] The entity identifier.
97
91
  #
@@ -112,10 +106,6 @@ module Increase
112
106
  # Details of the natural person entity to update. If you specify this parameter
113
107
  # and the entity is not a natural person, the request will fail.
114
108
  #
115
- # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
116
- # An assessment of the entity’s potential risk of involvement in financial crimes,
117
- # such as money laundering.
118
- #
119
109
  # @param sole_proprietorship [Increase::Models::EntityUpdateParams::SoleProprietorship]
120
110
  # Details of the sole proprietorship entity to update. If you specify this
121
111
  # parameter and the entity is not a sole proprietorship, the request will fail.
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class Checkbooks
7
+ # Simulates the mailing of a [Checkbook](#checkbooks), which happens periodically
8
+ # throughout the day in production but can be sped up in sandbox. This Checkbook
9
+ # must have a `status` of `pending_submission` or `pending_mailing`.
10
+ #
11
+ # @overload mail(checkbook_id, request_options: {})
12
+ #
13
+ # @param checkbook_id [String] The identifier of the Checkbook you wish to mail.
14
+ #
15
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
16
+ #
17
+ # @return [Increase::Models::Checkbook]
18
+ #
19
+ # @see Increase::Models::Simulations::CheckbookMailParams
20
+ def mail(checkbook_id, params = {})
21
+ @client.request(
22
+ method: :post,
23
+ path: ["simulations/checkbooks/%1$s/mail", checkbook_id],
24
+ model: Increase::Checkbook,
25
+ options: params[:request_options]
26
+ )
27
+ end
28
+
29
+ # @api private
30
+ #
31
+ # @param client [Increase::Client]
32
+ def initialize(client:)
33
+ @client = client
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -72,6 +72,9 @@ module Increase
72
72
  # @return [Increase::Resources::Simulations::CheckTransfers]
73
73
  attr_reader :check_transfers
74
74
 
75
+ # @return [Increase::Resources::Simulations::Checkbooks]
76
+ attr_reader :checkbooks
77
+
75
78
  # @return [Increase::Resources::Simulations::InboundCheckDeposits]
76
79
  attr_reader :inbound_check_deposits
77
80
 
@@ -143,6 +146,7 @@ module Increase
143
146
  @inbound_wire_drawdown_requests =
144
147
  Increase::Resources::Simulations::InboundWireDrawdownRequests.new(client: client)
145
148
  @check_transfers = Increase::Resources::Simulations::CheckTransfers.new(client: client)
149
+ @checkbooks = Increase::Resources::Simulations::Checkbooks.new(client: client)
146
150
  @inbound_check_deposits = Increase::Resources::Simulations::InboundCheckDeposits.new(client: client)
147
151
  @real_time_payments_transfers =
148
152
  Increase::Resources::Simulations::RealTimePaymentsTransfers.new(client: client)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.363.0"
4
+ VERSION = "1.364.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -131,6 +131,15 @@ require_relative "increase/models/card_validation"
131
131
  require_relative "increase/models/card_validation_create_params"
132
132
  require_relative "increase/models/card_validation_list_params"
133
133
  require_relative "increase/models/card_validation_retrieve_params"
134
+ require_relative "increase/models/checkbook"
135
+ require_relative "increase/models/checkbook_check"
136
+ require_relative "increase/models/checkbook_check_list_params"
137
+ require_relative "increase/models/checkbook_check_retrieve_params"
138
+ require_relative "increase/models/checkbook_check_stop_params"
139
+ require_relative "increase/models/checkbook_create_params"
140
+ require_relative "increase/models/checkbook_list_params"
141
+ require_relative "increase/models/checkbook_retrieve_params"
142
+ require_relative "increase/models/checkbook_stop_params"
134
143
  require_relative "increase/models/check_deposit"
135
144
  require_relative "increase/models/check_deposit_create_params"
136
145
  require_relative "increase/models/check_deposit_list_params"
@@ -317,6 +326,7 @@ require_relative "increase/models/simulations/card_refund_create_params"
317
326
  require_relative "increase/models/simulations/card_reversal_create_params"
318
327
  require_relative "increase/models/simulations/card_settlement_create_params"
319
328
  require_relative "increase/models/simulations/card_token_create_params"
329
+ require_relative "increase/models/simulations/checkbook_mail_params"
320
330
  require_relative "increase/models/simulations/check_deposit_adjustment_params"
321
331
  require_relative "increase/models/simulations/check_deposit_reject_params"
322
332
  require_relative "increase/models/simulations/check_deposit_return_params"
@@ -384,6 +394,8 @@ require_relative "increase/resources/card_push_transfers"
384
394
  require_relative "increase/resources/cards"
385
395
  require_relative "increase/resources/card_tokens"
386
396
  require_relative "increase/resources/card_validations"
397
+ require_relative "increase/resources/checkbook_checks"
398
+ require_relative "increase/resources/checkbooks"
387
399
  require_relative "increase/resources/check_deposits"
388
400
  require_relative "increase/resources/check_transfers"
389
401
  require_relative "increase/resources/declined_transactions"
@@ -437,6 +449,7 @@ require_relative "increase/resources/simulations/card_refunds"
437
449
  require_relative "increase/resources/simulations/card_reversals"
438
450
  require_relative "increase/resources/simulations/card_settlements"
439
451
  require_relative "increase/resources/simulations/card_tokens"
452
+ require_relative "increase/resources/simulations/checkbooks"
440
453
  require_relative "increase/resources/simulations/check_deposits"
441
454
  require_relative "increase/resources/simulations/check_transfers"
442
455
  require_relative "increase/resources/simulations/digital_wallet_token_requests"