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
@@ -7302,23 +7302,154 @@ module Increase
7302
7302
  )
7303
7303
  end
7304
7304
 
7305
+ # Device type.
7306
+ sig do
7307
+ returns(
7308
+ T.nilable(
7309
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7310
+ )
7311
+ )
7312
+ end
7313
+ attr_accessor :device_type
7314
+
7305
7315
  # ID assigned to the device by the digital wallet provider.
7306
7316
  sig { returns(T.nilable(String)) }
7307
7317
  attr_accessor :identifier
7308
7318
 
7319
+ # IP address of the device.
7320
+ sig { returns(T.nilable(String)) }
7321
+ attr_accessor :ip_address
7322
+
7323
+ # Name of the device, for example "My Work Phone".
7324
+ sig { returns(T.nilable(String)) }
7325
+ attr_accessor :name
7326
+
7309
7327
  # Device that is being used to provision the digital wallet token.
7310
7328
  sig do
7311
- params(identifier: T.nilable(String)).returns(T.attached_class)
7329
+ params(
7330
+ device_type:
7331
+ T.nilable(
7332
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::OrSymbol
7333
+ ),
7334
+ identifier: T.nilable(String),
7335
+ ip_address: T.nilable(String),
7336
+ name: T.nilable(String)
7337
+ ).returns(T.attached_class)
7312
7338
  end
7313
7339
  def self.new(
7340
+ # Device type.
7341
+ device_type:,
7314
7342
  # ID assigned to the device by the digital wallet provider.
7315
- identifier:
7343
+ identifier:,
7344
+ # IP address of the device.
7345
+ ip_address:,
7346
+ # Name of the device, for example "My Work Phone".
7347
+ name:
7316
7348
  )
7317
7349
  end
7318
7350
 
7319
- sig { override.returns({ identifier: T.nilable(String) }) }
7351
+ sig do
7352
+ override.returns(
7353
+ {
7354
+ device_type:
7355
+ T.nilable(
7356
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7357
+ ),
7358
+ identifier: T.nilable(String),
7359
+ ip_address: T.nilable(String),
7360
+ name: T.nilable(String)
7361
+ }
7362
+ )
7363
+ end
7320
7364
  def to_hash
7321
7365
  end
7366
+
7367
+ # Device type.
7368
+ module DeviceType
7369
+ extend Increase::Internal::Type::Enum
7370
+
7371
+ TaggedSymbol =
7372
+ T.type_alias do
7373
+ T.all(
7374
+ Symbol,
7375
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType
7376
+ )
7377
+ end
7378
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7379
+
7380
+ # Unknown
7381
+ UNKNOWN =
7382
+ T.let(
7383
+ :unknown,
7384
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7385
+ )
7386
+
7387
+ # Mobile Phone
7388
+ MOBILE_PHONE =
7389
+ T.let(
7390
+ :mobile_phone,
7391
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7392
+ )
7393
+
7394
+ # Tablet
7395
+ TABLET =
7396
+ T.let(
7397
+ :tablet,
7398
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7399
+ )
7400
+
7401
+ # Watch
7402
+ WATCH =
7403
+ T.let(
7404
+ :watch,
7405
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7406
+ )
7407
+
7408
+ # Mobile Phone or Tablet
7409
+ MOBILEPHONE_OR_TABLET =
7410
+ T.let(
7411
+ :mobilephone_or_tablet,
7412
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7413
+ )
7414
+
7415
+ # PC
7416
+ PC =
7417
+ T.let(
7418
+ :pc,
7419
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7420
+ )
7421
+
7422
+ # Household Device
7423
+ HOUSEHOLD_DEVICE =
7424
+ T.let(
7425
+ :household_device,
7426
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7427
+ )
7428
+
7429
+ # Wearable Device
7430
+ WEARABLE_DEVICE =
7431
+ T.let(
7432
+ :wearable_device,
7433
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7434
+ )
7435
+
7436
+ # Automobile Device
7437
+ AUTOMOBILE_DEVICE =
7438
+ T.let(
7439
+ :automobile_device,
7440
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7441
+ )
7442
+
7443
+ sig do
7444
+ override.returns(
7445
+ T::Array[
7446
+ Increase::RealTimeDecision::DigitalWalletToken::Device::DeviceType::TaggedSymbol
7447
+ ]
7448
+ )
7449
+ end
7450
+ def self.values
7451
+ end
7452
+ end
7322
7453
  end
7323
7454
 
7324
7455
  # The digital wallet app being used.
@@ -0,0 +1,45 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CheckbookMailParams < 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::CheckbookMailParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Checkbook you wish to mail.
19
+ sig { returns(String) }
20
+ attr_accessor :checkbook_id
21
+
22
+ sig do
23
+ params(
24
+ checkbook_id: String,
25
+ request_options: Increase::RequestOptions::OrHash
26
+ ).returns(T.attached_class)
27
+ end
28
+ def self.new(
29
+ # The identifier of the Checkbook you wish to mail.
30
+ checkbook_id:,
31
+ request_options: {}
32
+ )
33
+ end
34
+
35
+ sig do
36
+ override.returns(
37
+ { checkbook_id: String, request_options: Increase::RequestOptions }
38
+ )
39
+ end
40
+ def to_hash
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -8070,6 +8070,13 @@ module Increase
8070
8070
  Increase::Transaction::Source::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
8071
8071
  )
8072
8072
 
8073
+ # Diesel 1 off-road non-taxable
8074
+ DIESEL_1_OFF_ROAD_NON_TAXABLE =
8075
+ T.let(
8076
+ :diesel_1_off_road_non_taxable,
8077
+ Increase::Transaction::Source::CardRefund::PurchaseDetails::Fleet::FuelType::TaggedSymbol
8078
+ )
8079
+
8073
8080
  # Renewable diesel R95 or greater off-road non-taxable
8074
8081
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
8075
8082
  T.let(
@@ -12159,6 +12166,13 @@ module Increase
12159
12166
  Increase::Transaction::Source::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
12160
12167
  )
12161
12168
 
12169
+ # Diesel 1 off-road non-taxable
12170
+ DIESEL_1_OFF_ROAD_NON_TAXABLE =
12171
+ T.let(
12172
+ :diesel_1_off_road_non_taxable,
12173
+ Increase::Transaction::Source::CardSettlement::PurchaseDetails::Fleet::FuelType::TaggedSymbol
12174
+ )
12175
+
12162
12176
  # Renewable diesel R95 or greater off-road non-taxable
12163
12177
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
12164
12178
  T.let(
@@ -14713,6 +14727,10 @@ module Increase
14713
14727
  sig { returns(T.nilable(String)) }
14714
14728
  attr_accessor :bank_of_first_deposit_routing_number
14715
14729
 
14730
+ # The identifier of the Checkbook Check object that was deposited.
14731
+ sig { returns(T.nilable(String)) }
14732
+ attr_accessor :checkbook_check_id
14733
+
14716
14734
  # When the check was deposited.
14717
14735
  sig { returns(Time) }
14718
14736
  attr_accessor :deposited_at
@@ -14752,6 +14770,7 @@ module Increase
14752
14770
  params(
14753
14771
  back_image_file_id: T.nilable(String),
14754
14772
  bank_of_first_deposit_routing_number: T.nilable(String),
14773
+ checkbook_check_id: T.nilable(String),
14755
14774
  deposited_at: Time,
14756
14775
  front_image_file_id: T.nilable(String),
14757
14776
  inbound_check_deposit_id: T.nilable(String),
@@ -14769,6 +14788,8 @@ module Increase
14769
14788
  # bank depositing this check. In some rare cases, this is not transmitted via
14770
14789
  # Check 21 and the value will be null.
14771
14790
  bank_of_first_deposit_routing_number:,
14791
+ # The identifier of the Checkbook Check object that was deposited.
14792
+ checkbook_check_id:,
14772
14793
  # When the check was deposited.
14773
14794
  deposited_at:,
14774
14795
  # The identifier of the API File object containing an image of the front of the
@@ -14792,6 +14813,7 @@ module Increase
14792
14813
  {
14793
14814
  back_image_file_id: T.nilable(String),
14794
14815
  bank_of_first_deposit_routing_number: T.nilable(String),
14816
+ checkbook_check_id: T.nilable(String),
14795
14817
  deposited_at: Time,
14796
14818
  front_image_file_id: T.nilable(String),
14797
14819
  inbound_check_deposit_id: T.nilable(String),
@@ -15680,6 +15702,10 @@ module Increase
15680
15702
  )
15681
15703
  end
15682
15704
 
15705
+ # The identifier of the Checkbook Check object that was deposited.
15706
+ sig { returns(T.nilable(String)) }
15707
+ attr_accessor :checkbook_check_id
15708
+
15683
15709
  # The ID of the Inbound Check Deposit that is being returned.
15684
15710
  sig { returns(String) }
15685
15711
  attr_accessor :inbound_check_deposit_id
@@ -15695,11 +15721,14 @@ module Increase
15695
15721
  # requests that it be returned.
15696
15722
  sig do
15697
15723
  params(
15724
+ checkbook_check_id: T.nilable(String),
15698
15725
  inbound_check_deposit_id: String,
15699
15726
  transfer_id: T.nilable(String)
15700
15727
  ).returns(T.attached_class)
15701
15728
  end
15702
15729
  def self.new(
15730
+ # The identifier of the Checkbook Check object that was deposited.
15731
+ checkbook_check_id:,
15703
15732
  # The ID of the Inbound Check Deposit that is being returned.
15704
15733
  inbound_check_deposit_id:,
15705
15734
  # The identifier of the Check Transfer object that was deposited.
@@ -15710,6 +15739,7 @@ module Increase
15710
15739
  sig do
15711
15740
  override.returns(
15712
15741
  {
15742
+ checkbook_check_id: T.nilable(String),
15713
15743
  inbound_check_deposit_id: String,
15714
15744
  transfer_id: T.nilable(String)
15715
15745
  }
@@ -166,6 +166,24 @@ module Increase
166
166
 
167
167
  CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
168
168
 
169
+ Checkbook = Increase::Models::Checkbook
170
+
171
+ CheckbookCheck = Increase::Models::CheckbookCheck
172
+
173
+ CheckbookCheckListParams = Increase::Models::CheckbookCheckListParams
174
+
175
+ CheckbookCheckRetrieveParams = Increase::Models::CheckbookCheckRetrieveParams
176
+
177
+ CheckbookCheckStopParams = Increase::Models::CheckbookCheckStopParams
178
+
179
+ CheckbookCreateParams = Increase::Models::CheckbookCreateParams
180
+
181
+ CheckbookListParams = Increase::Models::CheckbookListParams
182
+
183
+ CheckbookRetrieveParams = Increase::Models::CheckbookRetrieveParams
184
+
185
+ CheckbookStopParams = Increase::Models::CheckbookStopParams
186
+
169
187
  CheckDeposit = Increase::Models::CheckDeposit
170
188
 
171
189
  CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams
@@ -8,9 +8,10 @@ module Increase
8
8
  params(
9
9
  account_id: String,
10
10
  name: String,
11
- inbound_ach: Increase::AccountNumberCreateParams::InboundACH::OrHash,
12
- inbound_checks:
13
- Increase::AccountNumberCreateParams::InboundChecks::OrHash,
11
+ inbound_ach_debits:
12
+ Increase::AccountNumberCreateParams::InboundACHDebits::OrSymbol,
13
+ unregistered_inbound_checks:
14
+ Increase::AccountNumberCreateParams::UnregisteredInboundChecks::OrSymbol,
14
15
  request_options: Increase::RequestOptions::OrHash
15
16
  ).returns(Increase::AccountNumber)
16
17
  end
@@ -19,11 +20,13 @@ module Increase
19
20
  account_id:,
20
21
  # The name you choose for the Account Number.
21
22
  name:,
22
- # Options related to how this Account Number should handle inbound ACH transfers.
23
- inbound_ach: nil,
24
- # Options related to how this Account Number should handle inbound check
25
- # withdrawals.
26
- inbound_checks: nil,
23
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
24
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
25
+ # active. If you do not specify this field, the default is `allowed`.
26
+ inbound_ach_debits: nil,
27
+ # Whether unregistered inbound checks for this Account Number can be deposited. If
28
+ # you do not specify this field, the default is `blocked`.
29
+ unregistered_inbound_checks: nil,
27
30
  request_options: {}
28
31
  )
29
32
  end
@@ -46,26 +49,28 @@ module Increase
46
49
  sig do
47
50
  params(
48
51
  account_number_id: String,
49
- inbound_ach: Increase::AccountNumberUpdateParams::InboundACH::OrHash,
50
- inbound_checks:
51
- Increase::AccountNumberUpdateParams::InboundChecks::OrHash,
52
+ inbound_ach_debits:
53
+ Increase::AccountNumberUpdateParams::InboundACHDebits::OrSymbol,
52
54
  name: String,
53
55
  status: Increase::AccountNumberUpdateParams::Status::OrSymbol,
56
+ unregistered_inbound_checks:
57
+ Increase::AccountNumberUpdateParams::UnregisteredInboundChecks::OrSymbol,
54
58
  request_options: Increase::RequestOptions::OrHash
55
59
  ).returns(Increase::AccountNumber)
56
60
  end
57
61
  def update(
58
62
  # The identifier of the Account Number.
59
63
  account_number_id,
60
- # Options related to how this Account Number handles inbound ACH transfers.
61
- inbound_ach: nil,
62
- # Options related to how this Account Number should handle inbound check
63
- # withdrawals.
64
- inbound_checks: nil,
64
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
65
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
66
+ # active.
67
+ inbound_ach_debits: nil,
65
68
  # The name you choose for the Account Number.
66
69
  name: nil,
67
70
  # This indicates if transfers can be made to the Account Number.
68
71
  status: nil,
72
+ # Whether unregistered inbound checks for this Account Number can be deposited.
73
+ unregistered_inbound_checks: nil,
69
74
  request_options: {}
70
75
  )
71
76
  end
@@ -74,11 +79,11 @@ module Increase
74
79
  sig do
75
80
  params(
76
81
  account_id: String,
77
- ach_debit_status:
78
- Increase::AccountNumberListParams::ACHDebitStatus::OrHash,
79
82
  created_at: Increase::AccountNumberListParams::CreatedAt::OrHash,
80
83
  cursor: String,
81
84
  idempotency_key: String,
85
+ inbound_ach_debits:
86
+ Increase::AccountNumberListParams::InboundACHDebits::OrHash,
82
87
  limit: Integer,
83
88
  status: Increase::AccountNumberListParams::Status::OrHash,
84
89
  request_options: Increase::RequestOptions::OrHash
@@ -87,7 +92,6 @@ module Increase
87
92
  def list(
88
93
  # Filter Account Numbers to those belonging to the specified Account.
89
94
  account_id: nil,
90
- ach_debit_status: nil,
91
95
  created_at: nil,
92
96
  # Return the page of entries after this one.
93
97
  cursor: nil,
@@ -96,6 +100,7 @@ module Increase
96
100
  # request is only processed once. Learn more about
97
101
  # [idempotency](https://increase.com/documentation/idempotency-keys).
98
102
  idempotency_key: nil,
103
+ inbound_ach_debits: nil,
99
104
  # Limit the size of the list that is returned. The default (and maximum) is 100
100
105
  # objects.
101
106
  #
@@ -0,0 +1,69 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Resources
5
+ class CheckbookChecks
6
+ # Retrieve a Checkbook Check
7
+ sig do
8
+ params(
9
+ checkbook_check_id: String,
10
+ request_options: Increase::RequestOptions::OrHash
11
+ ).returns(Increase::CheckbookCheck)
12
+ end
13
+ def retrieve(
14
+ # The identifier of the Checkbook Check.
15
+ checkbook_check_id,
16
+ request_options: {}
17
+ )
18
+ end
19
+
20
+ # List Checkbook Checks
21
+ sig do
22
+ params(
23
+ account_number_id: String,
24
+ check_number: Integer,
25
+ checkbook_id: String,
26
+ cursor: String,
27
+ limit: Integer,
28
+ request_options: Increase::RequestOptions::OrHash
29
+ ).returns(Increase::Internal::Page[Increase::CheckbookCheck])
30
+ end
31
+ def list(
32
+ # Filter Checkbook Checks to those drawn on the specified Account Number.
33
+ account_number_id: nil,
34
+ # Filter Checkbook Checks to the one with the specified check number.
35
+ check_number: nil,
36
+ # Filter Checkbook Checks to those belonging to the specified Checkbook.
37
+ checkbook_id: nil,
38
+ # Return the page of entries after this one.
39
+ cursor: nil,
40
+ # Limit the size of the list that is returned. The default (and maximum) is 100
41
+ # objects.
42
+ #
43
+ # Defaults to `100`.
44
+ limit: nil,
45
+ request_options: {}
46
+ )
47
+ end
48
+
49
+ # Stop a Checkbook Check. A stopped check cannot be deposited.
50
+ sig do
51
+ params(
52
+ checkbook_check_id: String,
53
+ request_options: Increase::RequestOptions::OrHash
54
+ ).returns(Increase::CheckbookCheck)
55
+ end
56
+ def stop(
57
+ # The identifier of the Checkbook Check to stop.
58
+ checkbook_check_id,
59
+ request_options: {}
60
+ )
61
+ end
62
+
63
+ # @api private
64
+ sig { params(client: Increase::Client).returns(T.attached_class) }
65
+ def self.new(client:)
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,96 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Resources
5
+ class Checkbooks
6
+ # Create a Checkbook
7
+ sig do
8
+ params(
9
+ account_number_id: String,
10
+ mailing_address:
11
+ Increase::CheckbookCreateParams::MailingAddress::OrHash,
12
+ payer: T::Array[Increase::CheckbookCreateParams::Payer::OrHash],
13
+ request_options: Increase::RequestOptions::OrHash
14
+ ).returns(Increase::Checkbook)
15
+ end
16
+ def create(
17
+ # The identifier of the Account Number that the checks will draw from. The Account
18
+ # Number must be active.
19
+ account_number_id:,
20
+ # The destination address that the Checkbook will be mailed to.
21
+ mailing_address:,
22
+ # The payer of the checks. This will be printed on the top-left corner of each
23
+ # check. This should be an array of up to 4 elements, each of which represents a
24
+ # line of the payer.
25
+ payer:,
26
+ request_options: {}
27
+ )
28
+ end
29
+
30
+ # Retrieve a Checkbook
31
+ sig do
32
+ params(
33
+ checkbook_id: String,
34
+ request_options: Increase::RequestOptions::OrHash
35
+ ).returns(Increase::Checkbook)
36
+ end
37
+ def retrieve(
38
+ # The identifier of the Checkbook.
39
+ checkbook_id,
40
+ request_options: {}
41
+ )
42
+ end
43
+
44
+ # List Checkbooks
45
+ sig do
46
+ params(
47
+ account_number_id: String,
48
+ cursor: String,
49
+ idempotency_key: String,
50
+ limit: Integer,
51
+ status: Increase::CheckbookListParams::Status::OrHash,
52
+ request_options: Increase::RequestOptions::OrHash
53
+ ).returns(Increase::Internal::Page[Increase::Checkbook])
54
+ end
55
+ def list(
56
+ # Filter Checkbooks to those attached to the specified Account Number.
57
+ account_number_id: nil,
58
+ # Return the page of entries after this one.
59
+ cursor: nil,
60
+ # Filter records to the one with the specified `idempotency_key` you chose for
61
+ # that object. This value is unique across Increase and is used to ensure that a
62
+ # request is only processed once. Learn more about
63
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
64
+ idempotency_key: nil,
65
+ # Limit the size of the list that is returned. The default (and maximum) is 100
66
+ # objects.
67
+ #
68
+ # Defaults to `100`.
69
+ limit: nil,
70
+ status: nil,
71
+ request_options: {}
72
+ )
73
+ end
74
+
75
+ # Stop a Checkbook. Stopping a Checkbook stops all of its checks that have not yet
76
+ # been deposited.
77
+ sig do
78
+ params(
79
+ checkbook_id: String,
80
+ request_options: Increase::RequestOptions::OrHash
81
+ ).returns(Increase::Checkbook)
82
+ end
83
+ def stop(
84
+ # The identifier of the Checkbook to stop.
85
+ checkbook_id,
86
+ request_options: {}
87
+ )
88
+ end
89
+
90
+ # @api private
91
+ sig { params(client: Increase::Client).returns(T.attached_class) }
92
+ def self.new(client:)
93
+ end
94
+ end
95
+ end
96
+ end
@@ -8,12 +8,10 @@ module Increase
8
8
  params(
9
9
  structure: Increase::EntityCreateParams::Structure::OrSymbol,
10
10
  corporation: Increase::EntityCreateParams::Corporation::OrHash,
11
- description: String,
12
11
  government_authority:
13
12
  Increase::EntityCreateParams::GovernmentAuthority::OrHash,
14
13
  joint: Increase::EntityCreateParams::Joint::OrHash,
15
14
  natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
16
- risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
17
15
  sole_proprietorship:
18
16
  Increase::EntityCreateParams::SoleProprietorship::OrHash,
19
17
  supplemental_documents:
@@ -34,8 +32,6 @@ module Increase
34
32
  # Details of the corporation entity to create. Required if `structure` is equal to
35
33
  # `corporation`.
36
34
  corporation: nil,
37
- # The description you choose to give the entity.
38
- description: nil,
39
35
  # Details of the Government Authority entity to create. Required if `structure` is
40
36
  # equal to `government_authority`.
41
37
  government_authority: nil,
@@ -47,9 +43,6 @@ module Increase
47
43
  # `social_security_number` or `individual_taxpayer_identification_number`
48
44
  # identification methods.
49
45
  natural_person: nil,
50
- # An assessment of the entity's potential risk of involvement in financial crimes,
51
- # such as money laundering.
52
- risk_rating: nil,
53
46
  # Details of the sole proprietorship entity to create. Required if `structure` is
54
47
  # equal to `sole_proprietorship`.
55
48
  sole_proprietorship: nil,
@@ -92,7 +85,6 @@ module Increase
92
85
  government_authority:
93
86
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
94
87
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
95
- risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
96
88
  sole_proprietorship:
97
89
  Increase::EntityUpdateParams::SoleProprietorship::OrHash,
98
90
  terms_agreements:
@@ -119,9 +111,6 @@ module Increase
119
111
  # Details of the natural person entity to update. If you specify this parameter
120
112
  # and the entity is not a natural person, the request will fail.
121
113
  natural_person: nil,
122
- # An assessment of the entity’s potential risk of involvement in financial crimes,
123
- # such as money laundering.
124
- risk_rating: nil,
125
114
  # Details of the sole proprietorship entity to update. If you specify this
126
115
  # parameter and the entity is not a sole proprietorship, the request will fail.
127
116
  sole_proprietorship: nil,
@@ -0,0 +1,30 @@
1
+ # typed: strong
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
+ sig do
11
+ params(
12
+ checkbook_id: String,
13
+ request_options: Increase::RequestOptions::OrHash
14
+ ).returns(Increase::Checkbook)
15
+ end
16
+ def mail(
17
+ # The identifier of the Checkbook you wish to mail.
18
+ checkbook_id,
19
+ request_options: {}
20
+ )
21
+ end
22
+
23
+ # @api private
24
+ sig { params(client: Increase::Client).returns(T.attached_class) }
25
+ def self.new(client:)
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
@@ -78,6 +78,9 @@ module Increase
78
78
  sig { returns(Increase::Resources::Simulations::CheckTransfers) }
79
79
  attr_reader :check_transfers
80
80
 
81
+ sig { returns(Increase::Resources::Simulations::Checkbooks) }
82
+ attr_reader :checkbooks
83
+
81
84
  sig { returns(Increase::Resources::Simulations::InboundCheckDeposits) }
82
85
  attr_reader :inbound_check_deposits
83
86
 
@@ -63,6 +63,10 @@ module Increase
63
63
 
64
64
  attr_reader check_transfers: Increase::Resources::CheckTransfers
65
65
 
66
+ attr_reader checkbooks: Increase::Resources::Checkbooks
67
+
68
+ attr_reader checkbook_checks: Increase::Resources::CheckbookChecks
69
+
66
70
  attr_reader inbound_check_deposits: Increase::Resources::InboundCheckDeposits
67
71
 
68
72
  attr_reader real_time_payments_transfers: Increase::Resources::RealTimePaymentsTransfers