increase 1.303.0 → 1.305.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 (131) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/increase/client.rb +7 -15
  5. data/lib/increase/models/card_push_transfer.rb +3 -0
  6. data/lib/increase/models/card_token_capabilities.rb +3 -0
  7. data/lib/increase/models/card_validation.rb +3 -0
  8. data/lib/increase/models/check_deposit.rb +7 -6
  9. data/lib/increase/models/inbound_mail_item.rb +22 -7
  10. data/lib/increase/models/inbound_mail_item_list_params.rb +13 -5
  11. data/lib/increase/models/lockbox_address.rb +162 -0
  12. data/lib/increase/models/lockbox_address_create_params.rb +22 -0
  13. data/lib/increase/models/{lockbox_list_params.rb → lockbox_address_list_params.rb} +8 -16
  14. data/lib/increase/models/lockbox_address_retrieve_params.rb +22 -0
  15. data/lib/increase/models/lockbox_address_update_params.rb +55 -0
  16. data/lib/increase/models/lockbox_recipient.rb +135 -0
  17. data/lib/increase/models/lockbox_recipient_create_params.rb +49 -0
  18. data/lib/increase/models/lockbox_recipient_list_params.rb +110 -0
  19. data/lib/increase/models/lockbox_recipient_retrieve_params.rb +22 -0
  20. data/lib/increase/models/lockbox_recipient_update_params.rb +63 -0
  21. data/lib/increase/models/simulations/card_token_create_params.rb +3 -0
  22. data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +17 -9
  23. data/lib/increase/models.rb +15 -31
  24. data/lib/increase/resources/inbound_mail_items.rb +4 -2
  25. data/lib/increase/resources/lockbox_addresses.rb +115 -0
  26. data/lib/increase/resources/lockbox_recipients.rb +130 -0
  27. data/lib/increase/resources/simulations/inbound_mail_items.rb +5 -3
  28. data/lib/increase/version.rb +1 -1
  29. data/lib/increase.rb +12 -22
  30. data/rbi/increase/client.rbi +5 -11
  31. data/rbi/increase/models/card_push_transfer.rbi +3 -0
  32. data/rbi/increase/models/card_token_capabilities.rbi +7 -0
  33. data/rbi/increase/models/card_validation.rbi +3 -0
  34. data/rbi/increase/models/check_deposit.rbi +10 -8
  35. data/rbi/increase/models/inbound_mail_item.rbi +32 -9
  36. data/rbi/increase/models/inbound_mail_item_list_params.rbi +19 -8
  37. data/rbi/increase/models/lockbox_address.rbi +228 -0
  38. data/rbi/increase/models/lockbox_address_create_params.rbi +46 -0
  39. data/rbi/increase/models/{lockbox_list_params.rbi → lockbox_address_list_params.rbi} +9 -18
  40. data/rbi/increase/models/{bookkeeping_entry_set_retrieve_params.rbi → lockbox_address_retrieve_params.rbi} +8 -8
  41. data/rbi/increase/models/lockbox_address_update_params.rbi +116 -0
  42. data/rbi/increase/models/lockbox_recipient.rbi +182 -0
  43. data/rbi/increase/models/{lockbox_create_params.rbi → lockbox_recipient_create_params.rbi} +19 -8
  44. data/rbi/increase/models/lockbox_recipient_list_params.rbi +190 -0
  45. data/rbi/increase/models/{bookkeeping_entry_retrieve_params.rbi → lockbox_recipient_retrieve_params.rbi} +8 -8
  46. data/rbi/increase/models/lockbox_recipient_update_params.rbi +129 -0
  47. data/rbi/increase/models/simulations/card_token_create_params.rbi +7 -0
  48. data/rbi/increase/models/simulations/inbound_mail_item_create_params.rbi +22 -8
  49. data/rbi/increase/models.rbi +16 -38
  50. data/rbi/increase/resources/inbound_mail_items.rbi +6 -3
  51. data/rbi/increase/resources/{bookkeeping_entry_sets.rbi → lockbox_addresses.rbi} +35 -24
  52. data/rbi/increase/resources/{lockboxes.rbi → lockbox_recipients.rbi} +31 -26
  53. data/rbi/increase/resources/simulations/inbound_mail_items.rbi +6 -3
  54. data/sig/increase/client.rbs +3 -7
  55. data/sig/increase/models/card_push_transfer.rbs +4 -1
  56. data/sig/increase/models/card_token_capabilities.rbs +4 -1
  57. data/sig/increase/models/card_validation.rbs +4 -1
  58. data/sig/increase/models/check_deposit.rbs +4 -4
  59. data/sig/increase/models/inbound_mail_item.rbs +20 -5
  60. data/sig/increase/models/inbound_mail_item_list_params.rbs +12 -5
  61. data/sig/increase/models/lockbox_address.rbs +117 -0
  62. data/sig/increase/models/{lockbox_retrieve_params.rbs → lockbox_address_create_params.rbs} +8 -6
  63. data/sig/increase/models/{lockbox_list_params.rbs → lockbox_address_list_params.rbs} +8 -15
  64. data/sig/increase/models/{bookkeeping_entry_set_retrieve_params.rbs → lockbox_address_retrieve_params.rbs} +6 -6
  65. data/sig/increase/models/lockbox_address_update_params.rbs +59 -0
  66. data/sig/increase/models/lockbox_recipient.rbs +92 -0
  67. data/sig/increase/models/{lockbox_create_params.rbs → lockbox_recipient_create_params.rbs} +12 -3
  68. data/sig/increase/models/lockbox_recipient_list_params.rbs +100 -0
  69. data/sig/increase/models/{bookkeeping_entry_retrieve_params.rbs → lockbox_recipient_retrieve_params.rbs} +6 -6
  70. data/sig/increase/models/lockbox_recipient_update_params.rbs +66 -0
  71. data/sig/increase/models/simulations/card_token_create_params.rbs +4 -1
  72. data/sig/increase/models/simulations/inbound_mail_item_create_params.rbs +18 -5
  73. data/sig/increase/models.rbs +15 -31
  74. data/sig/increase/resources/inbound_mail_items.rbs +2 -1
  75. data/sig/increase/resources/lockbox_addresses.rbs +32 -0
  76. data/sig/increase/resources/{lockboxes.rbs → lockbox_recipients.rbs} +11 -9
  77. data/sig/increase/resources/simulations/inbound_mail_items.rbs +2 -1
  78. metadata +38 -68
  79. data/lib/increase/models/bookkeeping_account.rb +0 -104
  80. data/lib/increase/models/bookkeeping_account_balance_params.rb +0 -30
  81. data/lib/increase/models/bookkeeping_account_create_params.rb +0 -60
  82. data/lib/increase/models/bookkeeping_account_list_params.rb +0 -45
  83. data/lib/increase/models/bookkeeping_account_update_params.rb +0 -30
  84. data/lib/increase/models/bookkeeping_balance_lookup.rb +0 -54
  85. data/lib/increase/models/bookkeeping_entry.rb +0 -79
  86. data/lib/increase/models/bookkeeping_entry_list_params.rb +0 -42
  87. data/lib/increase/models/bookkeeping_entry_retrieve_params.rb +0 -22
  88. data/lib/increase/models/bookkeeping_entry_set.rb +0 -116
  89. data/lib/increase/models/bookkeeping_entry_set_create_params.rb +0 -67
  90. data/lib/increase/models/bookkeeping_entry_set_list_params.rb +0 -53
  91. data/lib/increase/models/bookkeeping_entry_set_retrieve_params.rb +0 -22
  92. data/lib/increase/models/lockbox.rb +0 -185
  93. data/lib/increase/models/lockbox_create_params.rb +0 -38
  94. data/lib/increase/models/lockbox_retrieve_params.rb +0 -22
  95. data/lib/increase/models/lockbox_update_params.rb +0 -63
  96. data/lib/increase/resources/bookkeeping_accounts.rb +0 -122
  97. data/lib/increase/resources/bookkeeping_entries.rb +0 -65
  98. data/lib/increase/resources/bookkeeping_entry_sets.rb +0 -96
  99. data/lib/increase/resources/lockboxes.rb +0 -123
  100. data/rbi/increase/models/bookkeeping_account.rbi +0 -165
  101. data/rbi/increase/models/bookkeeping_account_balance_params.rbi +0 -57
  102. data/rbi/increase/models/bookkeeping_account_create_params.rbi +0 -130
  103. data/rbi/increase/models/bookkeeping_account_list_params.rbi +0 -79
  104. data/rbi/increase/models/bookkeeping_account_update_params.rbi +0 -54
  105. data/rbi/increase/models/bookkeeping_balance_lookup.rbi +0 -85
  106. data/rbi/increase/models/bookkeeping_entry.rbi +0 -108
  107. data/rbi/increase/models/bookkeeping_entry_list_params.rbi +0 -73
  108. data/rbi/increase/models/bookkeeping_entry_set.rbi +0 -162
  109. data/rbi/increase/models/bookkeeping_entry_set_create_params.rbi +0 -110
  110. data/rbi/increase/models/bookkeeping_entry_set_list_params.rbi +0 -90
  111. data/rbi/increase/models/lockbox.rbi +0 -251
  112. data/rbi/increase/models/lockbox_retrieve_params.rbi +0 -40
  113. data/rbi/increase/models/lockbox_update_params.rbi +0 -131
  114. data/rbi/increase/resources/bookkeeping_accounts.rbi +0 -94
  115. data/rbi/increase/resources/bookkeeping_entries.rbi +0 -47
  116. data/sig/increase/models/bookkeeping_account.rbs +0 -74
  117. data/sig/increase/models/bookkeeping_account_balance_params.rbs +0 -30
  118. data/sig/increase/models/bookkeeping_account_create_params.rbs +0 -63
  119. data/sig/increase/models/bookkeeping_account_list_params.rbs +0 -38
  120. data/sig/increase/models/bookkeeping_account_update_params.rbs +0 -28
  121. data/sig/increase/models/bookkeeping_balance_lookup.rbs +0 -40
  122. data/sig/increase/models/bookkeeping_entry.rbs +0 -55
  123. data/sig/increase/models/bookkeeping_entry_list_params.rbs +0 -38
  124. data/sig/increase/models/bookkeeping_entry_set.rbs +0 -78
  125. data/sig/increase/models/bookkeeping_entry_set_create_params.rbs +0 -52
  126. data/sig/increase/models/bookkeeping_entry_set_list_params.rbs +0 -49
  127. data/sig/increase/models/lockbox.rbs +0 -129
  128. data/sig/increase/models/lockbox_update_params.rbs +0 -66
  129. data/sig/increase/resources/bookkeeping_accounts.rbs +0 -34
  130. data/sig/increase/resources/bookkeeping_entries.rbs +0 -19
  131. data/sig/increase/resources/bookkeeping_entry_sets.rbs +0 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2d6f5d3a29c14a9277df04326bd8a9ac8e1d489c0e41e23a602e0e333021d5f9
4
- data.tar.gz: 0210b3572cd3b418a453398f714ed4bfc891dfdddb71873dfacf8f1e3032c935
3
+ metadata.gz: a6f57aed67af5f378f5c990bea51a9c56ddeb650d702ef066b0280c443ca778c
4
+ data.tar.gz: 9103eb9ddd8e786ae13a22bdec499069f93e6f47fa573f60f56e9b4ee7824be5
5
5
  SHA512:
6
- metadata.gz: 9d8684dbf25052b35191954ad8dca34f3608a38495967f5637bc318a95926d4aaf030aa374827b67d69fc6c20ddf78063fe182d7081857d2df64c98d1a8a03ca
7
- data.tar.gz: 00eddb439ee5cbfa4ee278bf821310d6a59afdf8d65589c3e242ec2c5208016d4ce6e1b92dea1c97625ce72df28d68f621e5d3479624719ae8cde54a970a000e
6
+ metadata.gz: 6dbf4e16935e1f20e22e9367b80a7a792508fc6b0ac0786ef58d5dbf4516c518e277a1d2f5d8879928e5eccd469e93c33fcd34d4111bd46fe059c456f2900b05
7
+ data.tar.gz: d1d3ddec77eef80468717553d80d7f3fda2023e4e0faf31c569fd3bb2a4c1b7301f8173276b3d266aed0ecbbbff10ca8785077c1913cfaab149a320a16f1c85e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.305.0 (2026-04-27)
4
+
5
+ Full Changelog: [v1.304.0...v1.305.0](https://github.com/Increase/increase-ruby/compare/v1.304.0...v1.305.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([5e8547a](https://github.com/Increase/increase-ruby/commit/5e8547a8f860d23a7595c630b5f0e076f9fbd87c))
10
+ * **api:** api update ([a1819e1](https://github.com/Increase/increase-ruby/commit/a1819e1664e37290f8beea3a2949ef713e9d73bb))
11
+
12
+ ## 1.304.0 (2026-04-22)
13
+
14
+ Full Changelog: [v1.303.0...v1.304.0](https://github.com/Increase/increase-ruby/compare/v1.303.0...v1.304.0)
15
+
16
+ ### Features
17
+
18
+ * **api:** api update ([ee95745](https://github.com/Increase/increase-ruby/commit/ee95745eb726ad7c3c6d41acaf08e31eef7797cd))
19
+
20
+
21
+ ### Chores
22
+
23
+ * **internal:** more robust bootstrap script ([38fcf79](https://github.com/Increase/increase-ruby/commit/38fcf79f3af96bc20825171972ab1868bbce8948))
24
+
3
25
  ## 1.303.0 (2026-04-20)
4
26
 
5
27
  Full Changelog: [v1.302.0...v1.303.0](https://github.com/Increase/increase-ruby/compare/v1.302.0...v1.303.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.303.0"
18
+ gem "increase", "~> 1.305.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -113,8 +113,11 @@ module Increase
113
113
  # @return [Increase::Resources::CheckDeposits]
114
114
  attr_reader :check_deposits
115
115
 
116
- # @return [Increase::Resources::Lockboxes]
117
- attr_reader :lockboxes
116
+ # @return [Increase::Resources::LockboxAddresses]
117
+ attr_reader :lockbox_addresses
118
+
119
+ # @return [Increase::Resources::LockboxRecipients]
120
+ attr_reader :lockbox_recipients
118
121
 
119
122
  # @return [Increase::Resources::InboundMailItems]
120
123
  attr_reader :inbound_mail_items
@@ -161,15 +164,6 @@ module Increase
161
164
  # @return [Increase::Resources::RealTimeDecisions]
162
165
  attr_reader :real_time_decisions
163
166
 
164
- # @return [Increase::Resources::BookkeepingAccounts]
165
- attr_reader :bookkeeping_accounts
166
-
167
- # @return [Increase::Resources::BookkeepingEntrySets]
168
- attr_reader :bookkeeping_entry_sets
169
-
170
- # @return [Increase::Resources::BookkeepingEntries]
171
- attr_reader :bookkeeping_entries
172
-
173
167
  # @return [Increase::Resources::Groups]
174
168
  attr_reader :groups
175
169
 
@@ -299,7 +293,8 @@ module Increase
299
293
  @inbound_fednow_transfers = Increase::Resources::InboundFednowTransfers.new(client: self)
300
294
  @swift_transfers = Increase::Resources::SwiftTransfers.new(client: self)
301
295
  @check_deposits = Increase::Resources::CheckDeposits.new(client: self)
302
- @lockboxes = Increase::Resources::Lockboxes.new(client: self)
296
+ @lockbox_addresses = Increase::Resources::LockboxAddresses.new(client: self)
297
+ @lockbox_recipients = Increase::Resources::LockboxRecipients.new(client: self)
303
298
  @inbound_mail_items = Increase::Resources::InboundMailItems.new(client: self)
304
299
  @routing_numbers = Increase::Resources::RoutingNumbers.new(client: self)
305
300
  @external_accounts = Increase::Resources::ExternalAccounts.new(client: self)
@@ -315,9 +310,6 @@ module Increase
315
310
  @events = Increase::Resources::Events.new(client: self)
316
311
  @event_subscriptions = Increase::Resources::EventSubscriptions.new(client: self)
317
312
  @real_time_decisions = Increase::Resources::RealTimeDecisions.new(client: self)
318
- @bookkeeping_accounts = Increase::Resources::BookkeepingAccounts.new(client: self)
319
- @bookkeeping_entry_sets = Increase::Resources::BookkeepingEntrySets.new(client: self)
320
- @bookkeeping_entries = Increase::Resources::BookkeepingEntries.new(client: self)
321
313
  @groups = Increase::Resources::Groups.new(client: self)
322
314
  @oauth_applications = Increase::Resources::OAuthApplications.new(client: self)
323
315
  @oauth_connections = Increase::Resources::OAuthConnections.new(client: self)
@@ -1309,6 +1309,9 @@ module Increase
1309
1309
  # Mastercard and Maestro
1310
1310
  MASTERCARD = :mastercard
1311
1311
 
1312
+ # Pulse
1313
+ PULSE = :pulse
1314
+
1312
1315
  # @!method self.values
1313
1316
  # @return [Array<Symbol>]
1314
1317
  end
@@ -109,6 +109,9 @@ module Increase
109
109
  # Mastercard and Maestro
110
110
  MASTERCARD = :mastercard
111
111
 
112
+ # Pulse
113
+ PULSE = :pulse
114
+
112
115
  # @!method self.values
113
116
  # @return [Array<Symbol>]
114
117
  end
@@ -771,6 +771,9 @@ module Increase
771
771
  # Mastercard and Maestro
772
772
  MASTERCARD = :mastercard
773
773
 
774
+ # Pulse
775
+ PULSE = :pulse
776
+
774
777
  # @!method self.values
775
778
  # @return [Array<Symbol>]
776
779
  end
@@ -105,12 +105,13 @@ module Increase
105
105
  # @return [String, nil]
106
106
  required :inbound_mail_item_id, String, nil?: true
107
107
 
108
- # @!attribute lockbox_id
109
- # If the Check Deposit was the result of an Inbound Mail Item, this will contain
110
- # the identifier of the Lockbox that received it.
108
+ # @!attribute lockbox_recipient_id
109
+ # If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
110
+ # Recipient, this will contain the identifier of the Lockbox Recipient that
111
+ # received it.
111
112
  #
112
113
  # @return [String, nil]
113
- required :lockbox_id, String, nil?: true
114
+ required :lockbox_recipient_id, String, nil?: true
114
115
 
115
116
  # @!attribute status
116
117
  # The status of the Check Deposit.
@@ -131,7 +132,7 @@ module Increase
131
132
  # @return [Symbol, Increase::Models::CheckDeposit::Type]
132
133
  required :type, enum: -> { Increase::CheckDeposit::Type }
133
134
 
134
- # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
135
+ # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_recipient_id:, status:, transaction_id:, type:)
135
136
  # Some parameter documentations has been truncated, see
136
137
  # {Increase::Models::CheckDeposit} for more details.
137
138
  #
@@ -167,7 +168,7 @@ module Increase
167
168
  #
168
169
  # @param inbound_mail_item_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t
169
170
  #
170
- # @param lockbox_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t
171
+ # @param lockbox_recipient_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
171
172
  #
172
173
  # @param status [Symbol, Increase::Models::CheckDeposit::Status] The status of the Check Deposit.
173
174
  #
@@ -29,12 +29,18 @@ module Increase
29
29
  # @return [String]
30
30
  required :file_id, String
31
31
 
32
- # @!attribute lockbox_id
33
- # The identifier for the Lockbox that received this mail item. For mail items that
34
- # could not be processed due to an invalid address, this will be null.
32
+ # @!attribute lockbox_address_id
33
+ # The identifier for the Lockbox Address that received this mail item.
35
34
  #
36
35
  # @return [String, nil]
37
- required :lockbox_id, String, nil?: true
36
+ required :lockbox_address_id, String, nil?: true
37
+
38
+ # @!attribute lockbox_recipient_id
39
+ # The identifier for the Lockbox Recipient that received this mail item. For mail
40
+ # items that could not be routed to a Lockbox Recipient, this will be null.
41
+ #
42
+ # @return [String, nil]
43
+ required :lockbox_recipient_id, String, nil?: true
38
44
 
39
45
  # @!attribute recipient_name
40
46
  # The recipient name as written on the mail item.
@@ -61,11 +67,12 @@ module Increase
61
67
  # @return [Symbol, Increase::Models::InboundMailItem::Type]
62
68
  required :type, enum: -> { Increase::InboundMailItem::Type }
63
69
 
64
- # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:)
70
+ # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_address_id:, lockbox_recipient_id:, recipient_name:, rejection_reason:, status:, type:)
65
71
  # Some parameter documentations has been truncated, see
66
72
  # {Increase::Models::InboundMailItem} for more details.
67
73
  #
68
- # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
74
+ # Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
75
+ # Address.
69
76
  #
70
77
  # @param id [String] The Inbound Mail Item identifier.
71
78
  #
@@ -75,7 +82,9 @@ module Increase
75
82
  #
76
83
  # @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
77
84
  #
78
- # @param lockbox_id [String, nil] The identifier for the Lockbox that received this mail item. For mail items that
85
+ # @param lockbox_address_id [String, nil] The identifier for the Lockbox Address that received this mail item.
86
+ #
87
+ # @param lockbox_recipient_id [String, nil] The identifier for the Lockbox Recipient that received this mail item. For mail
79
88
  #
80
89
  # @param recipient_name [String, nil] The recipient name as written on the mail item.
81
90
  #
@@ -164,6 +173,12 @@ module Increase
164
173
  # The Lockbox or its associated Account is not active.
165
174
  LOCKBOX_NOT_ACTIVE = :lockbox_not_active
166
175
 
176
+ # The Lockbox Address is not active.
177
+ LOCKBOX_ADDRESS_NOT_ACTIVE = :lockbox_address_not_active
178
+
179
+ # The Lockbox Recipient or its associated Account is not active.
180
+ LOCKBOX_RECIPIENT_NOT_ACTIVE = :lockbox_recipient_not_active
181
+
167
182
  # @!method self.values
168
183
  # @return [Array<Symbol>]
169
184
  end
@@ -25,13 +25,19 @@ module Increase
25
25
  # @return [Integer, nil]
26
26
  optional :limit, Integer
27
27
 
28
- # @!attribute lockbox_id
29
- # Filter Inbound Mail Items to ones sent to the provided Lockbox.
28
+ # @!attribute lockbox_address_id
29
+ # Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
30
30
  #
31
31
  # @return [String, nil]
32
- optional :lockbox_id, String
32
+ optional :lockbox_address_id, String
33
33
 
34
- # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {})
34
+ # @!attribute lockbox_recipient_id
35
+ # Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
36
+ #
37
+ # @return [String, nil]
38
+ optional :lockbox_recipient_id, String
39
+
40
+ # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
35
41
  # Some parameter documentations has been truncated, see
36
42
  # {Increase::Models::InboundMailItemListParams} for more details.
37
43
  #
@@ -41,7 +47,9 @@ module Increase
41
47
  #
42
48
  # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
43
49
  #
44
- # @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox.
50
+ # @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
51
+ #
52
+ # @param lockbox_recipient_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
45
53
  #
46
54
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
47
55
 
@@ -0,0 +1,162 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::LockboxAddresses#create
6
+ class LockboxAddress < Increase::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The Lockbox Address identifier.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute address
14
+ # The mailing address for the Lockbox Address. It will be present after Increase
15
+ # generates it.
16
+ #
17
+ # @return [Increase::Models::LockboxAddress::Address, nil]
18
+ required :address, -> { Increase::LockboxAddress::Address }, nil?: true
19
+
20
+ # @!attribute created_at
21
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
22
+ # Address was created.
23
+ #
24
+ # @return [Time]
25
+ required :created_at, Time
26
+
27
+ # @!attribute description
28
+ # The description you choose for the Lockbox Address.
29
+ #
30
+ # @return [String, nil]
31
+ required :description, String, nil?: true
32
+
33
+ # @!attribute idempotency_key
34
+ # The idempotency key you chose for this object. This value is unique across
35
+ # Increase and is used to ensure that a request is only processed once. Learn more
36
+ # about [idempotency](https://increase.com/documentation/idempotency-keys).
37
+ #
38
+ # @return [String, nil]
39
+ required :idempotency_key, String, nil?: true
40
+
41
+ # @!attribute status
42
+ # The status of the Lockbox Address.
43
+ #
44
+ # @return [Symbol, Increase::Models::LockboxAddress::Status]
45
+ required :status, enum: -> { Increase::LockboxAddress::Status }
46
+
47
+ # @!attribute type
48
+ # A constant representing the object's type. For this resource it will always be
49
+ # `lockbox_address`.
50
+ #
51
+ # @return [Symbol, Increase::Models::LockboxAddress::Type]
52
+ required :type, enum: -> { Increase::LockboxAddress::Type }
53
+
54
+ # @!method initialize(id:, address:, created_at:, description:, idempotency_key:, status:, type:)
55
+ # Some parameter documentations has been truncated, see
56
+ # {Increase::Models::LockboxAddress} for more details.
57
+ #
58
+ # Lockbox Addresses are physical locations that can receive mail containing paper
59
+ # checks.
60
+ #
61
+ # @param id [String] The Lockbox Address identifier.
62
+ #
63
+ # @param address [Increase::Models::LockboxAddress::Address, nil] The mailing address for the Lockbox Address. It will be present after Increase g
64
+ #
65
+ # @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
66
+ #
67
+ # @param description [String, nil] The description you choose for the Lockbox Address.
68
+ #
69
+ # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
70
+ #
71
+ # @param status [Symbol, Increase::Models::LockboxAddress::Status] The status of the Lockbox Address.
72
+ #
73
+ # @param type [Symbol, Increase::Models::LockboxAddress::Type] A constant representing the object's type. For this resource it will always be `
74
+
75
+ # @see Increase::Models::LockboxAddress#address
76
+ class Address < Increase::Internal::Type::BaseModel
77
+ # @!attribute city
78
+ # The city of the address.
79
+ #
80
+ # @return [String]
81
+ required :city, String
82
+
83
+ # @!attribute line1
84
+ # The first line of the address.
85
+ #
86
+ # @return [String]
87
+ required :line1, String
88
+
89
+ # @!attribute line2
90
+ # The second line of the address.
91
+ #
92
+ # @return [String]
93
+ required :line2, String
94
+
95
+ # @!attribute postal_code
96
+ # The postal code of the address.
97
+ #
98
+ # @return [String]
99
+ required :postal_code, String
100
+
101
+ # @!attribute state
102
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
103
+ # the address.
104
+ #
105
+ # @return [String]
106
+ required :state, String
107
+
108
+ # @!method initialize(city:, line1:, line2:, postal_code:, state:)
109
+ # Some parameter documentations has been truncated, see
110
+ # {Increase::Models::LockboxAddress::Address} for more details.
111
+ #
112
+ # The mailing address for the Lockbox Address. It will be present after Increase
113
+ # generates it.
114
+ #
115
+ # @param city [String] The city of the address.
116
+ #
117
+ # @param line1 [String] The first line of the address.
118
+ #
119
+ # @param line2 [String] The second line of the address.
120
+ #
121
+ # @param postal_code [String] The postal code of the address.
122
+ #
123
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
124
+ end
125
+
126
+ # The status of the Lockbox Address.
127
+ #
128
+ # @see Increase::Models::LockboxAddress#status
129
+ module Status
130
+ extend Increase::Internal::Type::Enum
131
+
132
+ # Increase is generating this Lockbox Address.
133
+ PENDING = :pending
134
+
135
+ # This Lockbox Address is active.
136
+ ACTIVE = :active
137
+
138
+ # This Lockbox Address is disabled.
139
+ DISABLED = :disabled
140
+
141
+ # This Lockbox Address is permanently disabled.
142
+ CANCELED = :canceled
143
+
144
+ # @!method self.values
145
+ # @return [Array<Symbol>]
146
+ end
147
+
148
+ # A constant representing the object's type. For this resource it will always be
149
+ # `lockbox_address`.
150
+ #
151
+ # @see Increase::Models::LockboxAddress#type
152
+ module Type
153
+ extend Increase::Internal::Type::Enum
154
+
155
+ LOCKBOX_ADDRESS = :lockbox_address
156
+
157
+ # @!method self.values
158
+ # @return [Array<Symbol>]
159
+ end
160
+ end
161
+ end
162
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::LockboxAddresses#create
6
+ class LockboxAddressCreateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute description
11
+ # The description you choose for the Lockbox Address.
12
+ #
13
+ # @return [String, nil]
14
+ optional :description, String
15
+
16
+ # @!method initialize(description: nil, request_options: {})
17
+ # @param description [String] The description you choose for the Lockbox Address.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -2,21 +2,15 @@
2
2
 
3
3
  module Increase
4
4
  module Models
5
- # @see Increase::Resources::Lockboxes#list
6
- class LockboxListParams < Increase::Internal::Type::BaseModel
5
+ # @see Increase::Resources::LockboxAddresses#list
6
+ class LockboxAddressListParams < Increase::Internal::Type::BaseModel
7
7
  extend Increase::Internal::Type::RequestParameters::Converter
8
8
  include Increase::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute account_id
11
- # Filter Lockboxes to those associated with the provided Account.
12
- #
13
- # @return [String, nil]
14
- optional :account_id, String
15
-
16
10
  # @!attribute created_at
17
11
  #
18
- # @return [Increase::Models::LockboxListParams::CreatedAt, nil]
19
- optional :created_at, -> { Increase::LockboxListParams::CreatedAt }
12
+ # @return [Increase::Models::LockboxAddressListParams::CreatedAt, nil]
13
+ optional :created_at, -> { Increase::LockboxAddressListParams::CreatedAt }
20
14
 
21
15
  # @!attribute cursor
22
16
  # Return the page of entries after this one.
@@ -40,13 +34,11 @@ module Increase
40
34
  # @return [Integer, nil]
41
35
  optional :limit, Integer
42
36
 
43
- # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
37
+ # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
44
38
  # Some parameter documentations has been truncated, see
45
- # {Increase::Models::LockboxListParams} for more details.
46
- #
47
- # @param account_id [String] Filter Lockboxes to those associated with the provided Account.
39
+ # {Increase::Models::LockboxAddressListParams} for more details.
48
40
  #
49
- # @param created_at [Increase::Models::LockboxListParams::CreatedAt]
41
+ # @param created_at [Increase::Models::LockboxAddressListParams::CreatedAt]
50
42
  #
51
43
  # @param cursor [String] Return the page of entries after this one.
52
44
  #
@@ -87,7 +79,7 @@ module Increase
87
79
 
88
80
  # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
89
81
  # Some parameter documentations has been truncated, see
90
- # {Increase::Models::LockboxListParams::CreatedAt} for more details.
82
+ # {Increase::Models::LockboxAddressListParams::CreatedAt} for more details.
91
83
  #
92
84
  # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
93
85
  #
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::LockboxAddresses#retrieve
6
+ class LockboxAddressRetrieveParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute lockbox_address_id
11
+ # The identifier of the Lockbox Address to retrieve.
12
+ #
13
+ # @return [String]
14
+ required :lockbox_address_id, String
15
+
16
+ # @!method initialize(lockbox_address_id:, request_options: {})
17
+ # @param lockbox_address_id [String] The identifier of the Lockbox Address to retrieve.
18
+ #
19
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::LockboxAddresses#update
6
+ class LockboxAddressUpdateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute lockbox_address_id
11
+ # The identifier of the Lockbox Address.
12
+ #
13
+ # @return [String]
14
+ required :lockbox_address_id, String
15
+
16
+ # @!attribute description
17
+ # The description you choose for the Lockbox Address.
18
+ #
19
+ # @return [String, nil]
20
+ optional :description, String
21
+
22
+ # @!attribute status
23
+ # The status of the Lockbox Address.
24
+ #
25
+ # @return [Symbol, Increase::Models::LockboxAddressUpdateParams::Status, nil]
26
+ optional :status, enum: -> { Increase::LockboxAddressUpdateParams::Status }
27
+
28
+ # @!method initialize(lockbox_address_id:, description: nil, status: nil, request_options: {})
29
+ # @param lockbox_address_id [String] The identifier of the Lockbox Address.
30
+ #
31
+ # @param description [String] The description you choose for the Lockbox Address.
32
+ #
33
+ # @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status] The status of the Lockbox Address.
34
+ #
35
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
36
+
37
+ # The status of the Lockbox Address.
38
+ module Status
39
+ extend Increase::Internal::Type::Enum
40
+
41
+ # This Lockbox Address is active.
42
+ ACTIVE = :active
43
+
44
+ # This Lockbox Address is disabled.
45
+ DISABLED = :disabled
46
+
47
+ # This Lockbox Address is permanently disabled.
48
+ CANCELED = :canceled
49
+
50
+ # @!method self.values
51
+ # @return [Array<Symbol>]
52
+ end
53
+ end
54
+ end
55
+ end