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
@@ -1,90 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class BookkeepingEntrySetListParams < Increase::Internal::Type::BaseModel
6
- extend Increase::Internal::Type::RequestParameters::Converter
7
- include Increase::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(
12
- Increase::BookkeepingEntrySetListParams,
13
- Increase::Internal::AnyHash
14
- )
15
- end
16
-
17
- # Return the page of entries after this one.
18
- sig { returns(T.nilable(String)) }
19
- attr_reader :cursor
20
-
21
- sig { params(cursor: String).void }
22
- attr_writer :cursor
23
-
24
- # Filter records to the one with the specified `idempotency_key` you chose for
25
- # that object. This value is unique across Increase and is used to ensure that a
26
- # request is only processed once. Learn more about
27
- # [idempotency](https://increase.com/documentation/idempotency-keys).
28
- sig { returns(T.nilable(String)) }
29
- attr_reader :idempotency_key
30
-
31
- sig { params(idempotency_key: String).void }
32
- attr_writer :idempotency_key
33
-
34
- # Limit the size of the list that is returned. The default (and maximum) is 100
35
- # objects.
36
- sig { returns(T.nilable(Integer)) }
37
- attr_reader :limit
38
-
39
- sig { params(limit: Integer).void }
40
- attr_writer :limit
41
-
42
- # Filter to the Bookkeeping Entry Set that maps to this Transaction.
43
- sig { returns(T.nilable(String)) }
44
- attr_reader :transaction_id
45
-
46
- sig { params(transaction_id: String).void }
47
- attr_writer :transaction_id
48
-
49
- sig do
50
- params(
51
- cursor: String,
52
- idempotency_key: String,
53
- limit: Integer,
54
- transaction_id: String,
55
- request_options: Increase::RequestOptions::OrHash
56
- ).returns(T.attached_class)
57
- end
58
- def self.new(
59
- # Return the page of entries after this one.
60
- cursor: nil,
61
- # Filter records to the one with the specified `idempotency_key` you chose for
62
- # that object. This value is unique across Increase and is used to ensure that a
63
- # request is only processed once. Learn more about
64
- # [idempotency](https://increase.com/documentation/idempotency-keys).
65
- idempotency_key: nil,
66
- # Limit the size of the list that is returned. The default (and maximum) is 100
67
- # objects.
68
- limit: nil,
69
- # Filter to the Bookkeeping Entry Set that maps to this Transaction.
70
- transaction_id: nil,
71
- request_options: {}
72
- )
73
- end
74
-
75
- sig do
76
- override.returns(
77
- {
78
- cursor: String,
79
- idempotency_key: String,
80
- limit: Integer,
81
- transaction_id: String,
82
- request_options: Increase::RequestOptions
83
- }
84
- )
85
- end
86
- def to_hash
87
- end
88
- end
89
- end
90
- end
@@ -1,251 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class Lockbox < Increase::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias { T.any(Increase::Lockbox, Increase::Internal::AnyHash) }
8
-
9
- # The Lockbox identifier.
10
- sig { returns(String) }
11
- attr_accessor :id
12
-
13
- # The identifier for the Account checks sent to this lockbox will be deposited
14
- # into.
15
- sig { returns(String) }
16
- attr_accessor :account_id
17
-
18
- # The mailing address for the Lockbox.
19
- sig { returns(Increase::Lockbox::Address) }
20
- attr_reader :address
21
-
22
- sig { params(address: Increase::Lockbox::Address::OrHash).void }
23
- attr_writer :address
24
-
25
- # Indicates if checks mailed to this lockbox will be deposited.
26
- sig { returns(Increase::Lockbox::CheckDepositBehavior::TaggedSymbol) }
27
- attr_accessor :check_deposit_behavior
28
-
29
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
30
- # was created.
31
- sig { returns(Time) }
32
- attr_accessor :created_at
33
-
34
- # The description you choose for the Lockbox.
35
- sig { returns(T.nilable(String)) }
36
- attr_accessor :description
37
-
38
- # The idempotency key you chose for this object. This value is unique across
39
- # Increase and is used to ensure that a request is only processed once. Learn more
40
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
41
- sig { returns(T.nilable(String)) }
42
- attr_accessor :idempotency_key
43
-
44
- # The recipient name you choose for the Lockbox.
45
- sig { returns(T.nilable(String)) }
46
- attr_accessor :recipient_name
47
-
48
- # A constant representing the object's type. For this resource it will always be
49
- # `lockbox`.
50
- sig { returns(Increase::Lockbox::Type::TaggedSymbol) }
51
- attr_accessor :type
52
-
53
- # Lockboxes are physical locations that can receive mail containing paper checks.
54
- # Increase will automatically create a Check Deposit for checks received this way.
55
- sig do
56
- params(
57
- id: String,
58
- account_id: String,
59
- address: Increase::Lockbox::Address::OrHash,
60
- check_deposit_behavior:
61
- Increase::Lockbox::CheckDepositBehavior::OrSymbol,
62
- created_at: Time,
63
- description: T.nilable(String),
64
- idempotency_key: T.nilable(String),
65
- recipient_name: T.nilable(String),
66
- type: Increase::Lockbox::Type::OrSymbol
67
- ).returns(T.attached_class)
68
- end
69
- def self.new(
70
- # The Lockbox identifier.
71
- id:,
72
- # The identifier for the Account checks sent to this lockbox will be deposited
73
- # into.
74
- account_id:,
75
- # The mailing address for the Lockbox.
76
- address:,
77
- # Indicates if checks mailed to this lockbox will be deposited.
78
- check_deposit_behavior:,
79
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
80
- # was created.
81
- created_at:,
82
- # The description you choose for the Lockbox.
83
- description:,
84
- # The idempotency key you chose for this object. This value is unique across
85
- # Increase and is used to ensure that a request is only processed once. Learn more
86
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
87
- idempotency_key:,
88
- # The recipient name you choose for the Lockbox.
89
- recipient_name:,
90
- # A constant representing the object's type. For this resource it will always be
91
- # `lockbox`.
92
- type:
93
- )
94
- end
95
-
96
- sig do
97
- override.returns(
98
- {
99
- id: String,
100
- account_id: String,
101
- address: Increase::Lockbox::Address,
102
- check_deposit_behavior:
103
- Increase::Lockbox::CheckDepositBehavior::TaggedSymbol,
104
- created_at: Time,
105
- description: T.nilable(String),
106
- idempotency_key: T.nilable(String),
107
- recipient_name: T.nilable(String),
108
- type: Increase::Lockbox::Type::TaggedSymbol
109
- }
110
- )
111
- end
112
- def to_hash
113
- end
114
-
115
- class Address < Increase::Internal::Type::BaseModel
116
- OrHash =
117
- T.type_alias do
118
- T.any(Increase::Lockbox::Address, Increase::Internal::AnyHash)
119
- end
120
-
121
- # The city of the address.
122
- sig { returns(String) }
123
- attr_accessor :city
124
-
125
- # The first line of the address.
126
- sig { returns(String) }
127
- attr_accessor :line1
128
-
129
- # The second line of the address.
130
- sig { returns(String) }
131
- attr_accessor :line2
132
-
133
- # The postal code of the address.
134
- sig { returns(String) }
135
- attr_accessor :postal_code
136
-
137
- # The recipient line of the address. This will include the recipient name you
138
- # provide when creating the address, as well as an ATTN suffix to help route the
139
- # mail to your lockbox. Mail senders must include this ATTN line to receive mail
140
- # at this Lockbox.
141
- sig { returns(T.nilable(String)) }
142
- attr_accessor :recipient
143
-
144
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
145
- # the address.
146
- sig { returns(String) }
147
- attr_accessor :state
148
-
149
- # The mailing address for the Lockbox.
150
- sig do
151
- params(
152
- city: String,
153
- line1: String,
154
- line2: String,
155
- postal_code: String,
156
- recipient: T.nilable(String),
157
- state: String
158
- ).returns(T.attached_class)
159
- end
160
- def self.new(
161
- # The city of the address.
162
- city:,
163
- # The first line of the address.
164
- line1:,
165
- # The second line of the address.
166
- line2:,
167
- # The postal code of the address.
168
- postal_code:,
169
- # The recipient line of the address. This will include the recipient name you
170
- # provide when creating the address, as well as an ATTN suffix to help route the
171
- # mail to your lockbox. Mail senders must include this ATTN line to receive mail
172
- # at this Lockbox.
173
- recipient:,
174
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
175
- # the address.
176
- state:
177
- )
178
- end
179
-
180
- sig do
181
- override.returns(
182
- {
183
- city: String,
184
- line1: String,
185
- line2: String,
186
- postal_code: String,
187
- recipient: T.nilable(String),
188
- state: String
189
- }
190
- )
191
- end
192
- def to_hash
193
- end
194
- end
195
-
196
- # Indicates if checks mailed to this lockbox will be deposited.
197
- module CheckDepositBehavior
198
- extend Increase::Internal::Type::Enum
199
-
200
- TaggedSymbol =
201
- T.type_alias do
202
- T.all(Symbol, Increase::Lockbox::CheckDepositBehavior)
203
- end
204
- OrSymbol = T.type_alias { T.any(Symbol, String) }
205
-
206
- # Checks mailed to this Lockbox will be deposited.
207
- ENABLED =
208
- T.let(:enabled, Increase::Lockbox::CheckDepositBehavior::TaggedSymbol)
209
-
210
- # Checks mailed to this Lockbox will not be deposited.
211
- DISABLED =
212
- T.let(
213
- :disabled,
214
- Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
215
- )
216
-
217
- # Checks mailed to this Lockbox will be pending until actioned.
218
- PEND_FOR_PROCESSING =
219
- T.let(
220
- :pend_for_processing,
221
- Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
222
- )
223
-
224
- sig do
225
- override.returns(
226
- T::Array[Increase::Lockbox::CheckDepositBehavior::TaggedSymbol]
227
- )
228
- end
229
- def self.values
230
- end
231
- end
232
-
233
- # A constant representing the object's type. For this resource it will always be
234
- # `lockbox`.
235
- module Type
236
- extend Increase::Internal::Type::Enum
237
-
238
- TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Lockbox::Type) }
239
- OrSymbol = T.type_alias { T.any(Symbol, String) }
240
-
241
- LOCKBOX = T.let(:lockbox, Increase::Lockbox::Type::TaggedSymbol)
242
-
243
- sig do
244
- override.returns(T::Array[Increase::Lockbox::Type::TaggedSymbol])
245
- end
246
- def self.values
247
- end
248
- end
249
- end
250
- end
251
- end
@@ -1,40 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class LockboxRetrieveParams < Increase::Internal::Type::BaseModel
6
- extend Increase::Internal::Type::RequestParameters::Converter
7
- include Increase::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(Increase::LockboxRetrieveParams, Increase::Internal::AnyHash)
12
- end
13
-
14
- # The identifier of the Lockbox to retrieve.
15
- sig { returns(String) }
16
- attr_accessor :lockbox_id
17
-
18
- sig do
19
- params(
20
- lockbox_id: String,
21
- request_options: Increase::RequestOptions::OrHash
22
- ).returns(T.attached_class)
23
- end
24
- def self.new(
25
- # The identifier of the Lockbox to retrieve.
26
- lockbox_id:,
27
- request_options: {}
28
- )
29
- end
30
-
31
- sig do
32
- override.returns(
33
- { lockbox_id: String, request_options: Increase::RequestOptions }
34
- )
35
- end
36
- def to_hash
37
- end
38
- end
39
- end
40
- end
@@ -1,131 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Models
5
- class LockboxUpdateParams < Increase::Internal::Type::BaseModel
6
- extend Increase::Internal::Type::RequestParameters::Converter
7
- include Increase::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(Increase::LockboxUpdateParams, Increase::Internal::AnyHash)
12
- end
13
-
14
- # The identifier of the Lockbox.
15
- sig { returns(String) }
16
- attr_accessor :lockbox_id
17
-
18
- # This indicates if checks mailed to this lockbox will be deposited.
19
- sig do
20
- returns(
21
- T.nilable(
22
- Increase::LockboxUpdateParams::CheckDepositBehavior::OrSymbol
23
- )
24
- )
25
- end
26
- attr_reader :check_deposit_behavior
27
-
28
- sig do
29
- params(
30
- check_deposit_behavior:
31
- Increase::LockboxUpdateParams::CheckDepositBehavior::OrSymbol
32
- ).void
33
- end
34
- attr_writer :check_deposit_behavior
35
-
36
- # The description you choose for the Lockbox.
37
- sig { returns(T.nilable(String)) }
38
- attr_reader :description
39
-
40
- sig { params(description: String).void }
41
- attr_writer :description
42
-
43
- # The recipient name you choose for the Lockbox.
44
- sig { returns(T.nilable(String)) }
45
- attr_reader :recipient_name
46
-
47
- sig { params(recipient_name: String).void }
48
- attr_writer :recipient_name
49
-
50
- sig do
51
- params(
52
- lockbox_id: String,
53
- check_deposit_behavior:
54
- Increase::LockboxUpdateParams::CheckDepositBehavior::OrSymbol,
55
- description: String,
56
- recipient_name: String,
57
- request_options: Increase::RequestOptions::OrHash
58
- ).returns(T.attached_class)
59
- end
60
- def self.new(
61
- # The identifier of the Lockbox.
62
- lockbox_id:,
63
- # This indicates if checks mailed to this lockbox will be deposited.
64
- check_deposit_behavior: nil,
65
- # The description you choose for the Lockbox.
66
- description: nil,
67
- # The recipient name you choose for the Lockbox.
68
- recipient_name: nil,
69
- request_options: {}
70
- )
71
- end
72
-
73
- sig do
74
- override.returns(
75
- {
76
- lockbox_id: String,
77
- check_deposit_behavior:
78
- Increase::LockboxUpdateParams::CheckDepositBehavior::OrSymbol,
79
- description: String,
80
- recipient_name: String,
81
- request_options: Increase::RequestOptions
82
- }
83
- )
84
- end
85
- def to_hash
86
- end
87
-
88
- # This indicates if checks mailed to this lockbox will be deposited.
89
- module CheckDepositBehavior
90
- extend Increase::Internal::Type::Enum
91
-
92
- TaggedSymbol =
93
- T.type_alias do
94
- T.all(Symbol, Increase::LockboxUpdateParams::CheckDepositBehavior)
95
- end
96
- OrSymbol = T.type_alias { T.any(Symbol, String) }
97
-
98
- # Checks mailed to this Lockbox will be deposited.
99
- ENABLED =
100
- T.let(
101
- :enabled,
102
- Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
103
- )
104
-
105
- # Checks mailed to this Lockbox will not be deposited.
106
- DISABLED =
107
- T.let(
108
- :disabled,
109
- Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
110
- )
111
-
112
- # Checks mailed to this Lockbox will be pending until actioned.
113
- PEND_FOR_PROCESSING =
114
- T.let(
115
- :pend_for_processing,
116
- Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
117
- )
118
-
119
- sig do
120
- override.returns(
121
- T::Array[
122
- Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
123
- ]
124
- )
125
- end
126
- def self.values
127
- end
128
- end
129
- end
130
- end
131
- end
@@ -1,94 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Resources
5
- class BookkeepingAccounts
6
- # Create a Bookkeeping Account
7
- sig do
8
- params(
9
- name: String,
10
- account_id: String,
11
- compliance_category:
12
- Increase::BookkeepingAccountCreateParams::ComplianceCategory::OrSymbol,
13
- entity_id: String,
14
- request_options: Increase::RequestOptions::OrHash
15
- ).returns(Increase::BookkeepingAccount)
16
- end
17
- def create(
18
- # The name you choose for the account.
19
- name:,
20
- # The account, if `compliance_category` is `commingled_cash`.
21
- account_id: nil,
22
- # The account compliance category.
23
- compliance_category: nil,
24
- # The entity, if `compliance_category` is `customer_balance`.
25
- entity_id: nil,
26
- request_options: {}
27
- )
28
- end
29
-
30
- # Update a Bookkeeping Account
31
- sig do
32
- params(
33
- bookkeeping_account_id: String,
34
- name: String,
35
- request_options: Increase::RequestOptions::OrHash
36
- ).returns(Increase::BookkeepingAccount)
37
- end
38
- def update(
39
- # The bookkeeping account you would like to update.
40
- bookkeeping_account_id,
41
- # The name you choose for the account.
42
- name:,
43
- request_options: {}
44
- )
45
- end
46
-
47
- # List Bookkeeping Accounts
48
- sig do
49
- params(
50
- cursor: String,
51
- idempotency_key: String,
52
- limit: Integer,
53
- request_options: Increase::RequestOptions::OrHash
54
- ).returns(Increase::Internal::Page[Increase::BookkeepingAccount])
55
- end
56
- def list(
57
- # Return the page of entries after this one.
58
- cursor: nil,
59
- # Filter records to the one with the specified `idempotency_key` you chose for
60
- # that object. This value is unique across Increase and is used to ensure that a
61
- # request is only processed once. Learn more about
62
- # [idempotency](https://increase.com/documentation/idempotency-keys).
63
- idempotency_key: nil,
64
- # Limit the size of the list that is returned. The default (and maximum) is 100
65
- # objects.
66
- limit: nil,
67
- request_options: {}
68
- )
69
- end
70
-
71
- # Retrieve a Bookkeeping Account Balance
72
- sig do
73
- params(
74
- bookkeeping_account_id: String,
75
- at_time: Time,
76
- request_options: Increase::RequestOptions::OrHash
77
- ).returns(Increase::BookkeepingBalanceLookup)
78
- end
79
- def balance(
80
- # The identifier of the Bookkeeping Account to retrieve.
81
- bookkeeping_account_id,
82
- # The moment to query the balance at. If not set, returns the current balances.
83
- at_time: nil,
84
- request_options: {}
85
- )
86
- end
87
-
88
- # @api private
89
- sig { params(client: Increase::Client).returns(T.attached_class) }
90
- def self.new(client:)
91
- end
92
- end
93
- end
94
- end
@@ -1,47 +0,0 @@
1
- # typed: strong
2
-
3
- module Increase
4
- module Resources
5
- class BookkeepingEntries
6
- # Retrieve a Bookkeeping Entry
7
- sig do
8
- params(
9
- bookkeeping_entry_id: String,
10
- request_options: Increase::RequestOptions::OrHash
11
- ).returns(Increase::BookkeepingEntry)
12
- end
13
- def retrieve(
14
- # The identifier of the Bookkeeping Entry.
15
- bookkeeping_entry_id,
16
- request_options: {}
17
- )
18
- end
19
-
20
- # List Bookkeeping Entries
21
- sig do
22
- params(
23
- account_id: String,
24
- cursor: String,
25
- limit: Integer,
26
- request_options: Increase::RequestOptions::OrHash
27
- ).returns(Increase::Internal::Page[Increase::BookkeepingEntry])
28
- end
29
- def list(
30
- # The identifier for the Bookkeeping Account to filter by.
31
- account_id: nil,
32
- # Return the page of entries after this one.
33
- cursor: nil,
34
- # Limit the size of the list that is returned. The default (and maximum) is 100
35
- # objects.
36
- limit: nil,
37
- request_options: {}
38
- )
39
- end
40
-
41
- # @api private
42
- sig { params(client: Increase::Client).returns(T.attached_class) }
43
- def self.new(client:)
44
- end
45
- end
46
- end
47
- end