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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.303.0
4
+ version: 1.305.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-04-20 00:00:00.000000000 Z
11
+ date: 2026-04-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -121,19 +121,6 @@ files:
121
121
  - lib/increase/models/beneficial_owner_list_params.rb
122
122
  - lib/increase/models/beneficial_owner_retrieve_params.rb
123
123
  - lib/increase/models/beneficial_owner_update_params.rb
124
- - lib/increase/models/bookkeeping_account.rb
125
- - lib/increase/models/bookkeeping_account_balance_params.rb
126
- - lib/increase/models/bookkeeping_account_create_params.rb
127
- - lib/increase/models/bookkeeping_account_list_params.rb
128
- - lib/increase/models/bookkeeping_account_update_params.rb
129
- - lib/increase/models/bookkeeping_balance_lookup.rb
130
- - lib/increase/models/bookkeeping_entry.rb
131
- - lib/increase/models/bookkeeping_entry_list_params.rb
132
- - lib/increase/models/bookkeeping_entry_retrieve_params.rb
133
- - lib/increase/models/bookkeeping_entry_set.rb
134
- - lib/increase/models/bookkeeping_entry_set_create_params.rb
135
- - lib/increase/models/bookkeeping_entry_set_list_params.rb
136
- - lib/increase/models/bookkeeping_entry_set_retrieve_params.rb
137
124
  - lib/increase/models/card.rb
138
125
  - lib/increase/models/card_create_details_iframe_params.rb
139
126
  - lib/increase/models/card_create_params.rb
@@ -279,11 +266,16 @@ files:
279
266
  - lib/increase/models/intrafi_exclusion_create_params.rb
280
267
  - lib/increase/models/intrafi_exclusion_list_params.rb
281
268
  - lib/increase/models/intrafi_exclusion_retrieve_params.rb
282
- - lib/increase/models/lockbox.rb
283
- - lib/increase/models/lockbox_create_params.rb
284
- - lib/increase/models/lockbox_list_params.rb
285
- - lib/increase/models/lockbox_retrieve_params.rb
286
- - lib/increase/models/lockbox_update_params.rb
269
+ - lib/increase/models/lockbox_address.rb
270
+ - lib/increase/models/lockbox_address_create_params.rb
271
+ - lib/increase/models/lockbox_address_list_params.rb
272
+ - lib/increase/models/lockbox_address_retrieve_params.rb
273
+ - lib/increase/models/lockbox_address_update_params.rb
274
+ - lib/increase/models/lockbox_recipient.rb
275
+ - lib/increase/models/lockbox_recipient_create_params.rb
276
+ - lib/increase/models/lockbox_recipient_list_params.rb
277
+ - lib/increase/models/lockbox_recipient_retrieve_params.rb
278
+ - lib/increase/models/lockbox_recipient_update_params.rb
287
279
  - lib/increase/models/oauth_application.rb
288
280
  - lib/increase/models/oauth_application_list_params.rb
289
281
  - lib/increase/models/oauth_application_retrieve_params.rb
@@ -400,9 +392,6 @@ files:
400
392
  - lib/increase/resources/ach_prenotifications.rb
401
393
  - lib/increase/resources/ach_transfers.rb
402
394
  - lib/increase/resources/beneficial_owners.rb
403
- - lib/increase/resources/bookkeeping_accounts.rb
404
- - lib/increase/resources/bookkeeping_entries.rb
405
- - lib/increase/resources/bookkeeping_entry_sets.rb
406
395
  - lib/increase/resources/card_disputes.rb
407
396
  - lib/increase/resources/card_payments.rb
408
397
  - lib/increase/resources/card_purchase_supplements.rb
@@ -435,7 +424,8 @@ files:
435
424
  - lib/increase/resources/intrafi_account_enrollments.rb
436
425
  - lib/increase/resources/intrafi_balances.rb
437
426
  - lib/increase/resources/intrafi_exclusions.rb
438
- - lib/increase/resources/lockboxes.rb
427
+ - lib/increase/resources/lockbox_addresses.rb
428
+ - lib/increase/resources/lockbox_recipients.rb
439
429
  - lib/increase/resources/oauth_applications.rb
440
430
  - lib/increase/resources/oauth_connections.rb
441
431
  - lib/increase/resources/oauth_tokens.rb
@@ -544,19 +534,6 @@ files:
544
534
  - rbi/increase/models/beneficial_owner_list_params.rbi
545
535
  - rbi/increase/models/beneficial_owner_retrieve_params.rbi
546
536
  - rbi/increase/models/beneficial_owner_update_params.rbi
547
- - rbi/increase/models/bookkeeping_account.rbi
548
- - rbi/increase/models/bookkeeping_account_balance_params.rbi
549
- - rbi/increase/models/bookkeeping_account_create_params.rbi
550
- - rbi/increase/models/bookkeeping_account_list_params.rbi
551
- - rbi/increase/models/bookkeeping_account_update_params.rbi
552
- - rbi/increase/models/bookkeeping_balance_lookup.rbi
553
- - rbi/increase/models/bookkeeping_entry.rbi
554
- - rbi/increase/models/bookkeeping_entry_list_params.rbi
555
- - rbi/increase/models/bookkeeping_entry_retrieve_params.rbi
556
- - rbi/increase/models/bookkeeping_entry_set.rbi
557
- - rbi/increase/models/bookkeeping_entry_set_create_params.rbi
558
- - rbi/increase/models/bookkeeping_entry_set_list_params.rbi
559
- - rbi/increase/models/bookkeeping_entry_set_retrieve_params.rbi
560
537
  - rbi/increase/models/card.rbi
561
538
  - rbi/increase/models/card_create_details_iframe_params.rbi
562
539
  - rbi/increase/models/card_create_params.rbi
@@ -702,11 +679,16 @@ files:
702
679
  - rbi/increase/models/intrafi_exclusion_create_params.rbi
703
680
  - rbi/increase/models/intrafi_exclusion_list_params.rbi
704
681
  - rbi/increase/models/intrafi_exclusion_retrieve_params.rbi
705
- - rbi/increase/models/lockbox.rbi
706
- - rbi/increase/models/lockbox_create_params.rbi
707
- - rbi/increase/models/lockbox_list_params.rbi
708
- - rbi/increase/models/lockbox_retrieve_params.rbi
709
- - rbi/increase/models/lockbox_update_params.rbi
682
+ - rbi/increase/models/lockbox_address.rbi
683
+ - rbi/increase/models/lockbox_address_create_params.rbi
684
+ - rbi/increase/models/lockbox_address_list_params.rbi
685
+ - rbi/increase/models/lockbox_address_retrieve_params.rbi
686
+ - rbi/increase/models/lockbox_address_update_params.rbi
687
+ - rbi/increase/models/lockbox_recipient.rbi
688
+ - rbi/increase/models/lockbox_recipient_create_params.rbi
689
+ - rbi/increase/models/lockbox_recipient_list_params.rbi
690
+ - rbi/increase/models/lockbox_recipient_retrieve_params.rbi
691
+ - rbi/increase/models/lockbox_recipient_update_params.rbi
710
692
  - rbi/increase/models/oauth_application.rbi
711
693
  - rbi/increase/models/oauth_application_list_params.rbi
712
694
  - rbi/increase/models/oauth_application_retrieve_params.rbi
@@ -823,9 +805,6 @@ files:
823
805
  - rbi/increase/resources/ach_prenotifications.rbi
824
806
  - rbi/increase/resources/ach_transfers.rbi
825
807
  - rbi/increase/resources/beneficial_owners.rbi
826
- - rbi/increase/resources/bookkeeping_accounts.rbi
827
- - rbi/increase/resources/bookkeeping_entries.rbi
828
- - rbi/increase/resources/bookkeeping_entry_sets.rbi
829
808
  - rbi/increase/resources/card_disputes.rbi
830
809
  - rbi/increase/resources/card_payments.rbi
831
810
  - rbi/increase/resources/card_purchase_supplements.rbi
@@ -858,7 +837,8 @@ files:
858
837
  - rbi/increase/resources/intrafi_account_enrollments.rbi
859
838
  - rbi/increase/resources/intrafi_balances.rbi
860
839
  - rbi/increase/resources/intrafi_exclusions.rbi
861
- - rbi/increase/resources/lockboxes.rbi
840
+ - rbi/increase/resources/lockbox_addresses.rbi
841
+ - rbi/increase/resources/lockbox_recipients.rbi
862
842
  - rbi/increase/resources/oauth_applications.rbi
863
843
  - rbi/increase/resources/oauth_connections.rbi
864
844
  - rbi/increase/resources/oauth_tokens.rbi
@@ -966,19 +946,6 @@ files:
966
946
  - sig/increase/models/beneficial_owner_list_params.rbs
967
947
  - sig/increase/models/beneficial_owner_retrieve_params.rbs
968
948
  - sig/increase/models/beneficial_owner_update_params.rbs
969
- - sig/increase/models/bookkeeping_account.rbs
970
- - sig/increase/models/bookkeeping_account_balance_params.rbs
971
- - sig/increase/models/bookkeeping_account_create_params.rbs
972
- - sig/increase/models/bookkeeping_account_list_params.rbs
973
- - sig/increase/models/bookkeeping_account_update_params.rbs
974
- - sig/increase/models/bookkeeping_balance_lookup.rbs
975
- - sig/increase/models/bookkeeping_entry.rbs
976
- - sig/increase/models/bookkeeping_entry_list_params.rbs
977
- - sig/increase/models/bookkeeping_entry_retrieve_params.rbs
978
- - sig/increase/models/bookkeeping_entry_set.rbs
979
- - sig/increase/models/bookkeeping_entry_set_create_params.rbs
980
- - sig/increase/models/bookkeeping_entry_set_list_params.rbs
981
- - sig/increase/models/bookkeeping_entry_set_retrieve_params.rbs
982
949
  - sig/increase/models/card.rbs
983
950
  - sig/increase/models/card_create_details_iframe_params.rbs
984
951
  - sig/increase/models/card_create_params.rbs
@@ -1124,11 +1091,16 @@ files:
1124
1091
  - sig/increase/models/intrafi_exclusion_create_params.rbs
1125
1092
  - sig/increase/models/intrafi_exclusion_list_params.rbs
1126
1093
  - sig/increase/models/intrafi_exclusion_retrieve_params.rbs
1127
- - sig/increase/models/lockbox.rbs
1128
- - sig/increase/models/lockbox_create_params.rbs
1129
- - sig/increase/models/lockbox_list_params.rbs
1130
- - sig/increase/models/lockbox_retrieve_params.rbs
1131
- - sig/increase/models/lockbox_update_params.rbs
1094
+ - sig/increase/models/lockbox_address.rbs
1095
+ - sig/increase/models/lockbox_address_create_params.rbs
1096
+ - sig/increase/models/lockbox_address_list_params.rbs
1097
+ - sig/increase/models/lockbox_address_retrieve_params.rbs
1098
+ - sig/increase/models/lockbox_address_update_params.rbs
1099
+ - sig/increase/models/lockbox_recipient.rbs
1100
+ - sig/increase/models/lockbox_recipient_create_params.rbs
1101
+ - sig/increase/models/lockbox_recipient_list_params.rbs
1102
+ - sig/increase/models/lockbox_recipient_retrieve_params.rbs
1103
+ - sig/increase/models/lockbox_recipient_update_params.rbs
1132
1104
  - sig/increase/models/oauth_application.rbs
1133
1105
  - sig/increase/models/oauth_application_list_params.rbs
1134
1106
  - sig/increase/models/oauth_application_retrieve_params.rbs
@@ -1245,9 +1217,6 @@ files:
1245
1217
  - sig/increase/resources/ach_prenotifications.rbs
1246
1218
  - sig/increase/resources/ach_transfers.rbs
1247
1219
  - sig/increase/resources/beneficial_owners.rbs
1248
- - sig/increase/resources/bookkeeping_accounts.rbs
1249
- - sig/increase/resources/bookkeeping_entries.rbs
1250
- - sig/increase/resources/bookkeeping_entry_sets.rbs
1251
1220
  - sig/increase/resources/card_disputes.rbs
1252
1221
  - sig/increase/resources/card_payments.rbs
1253
1222
  - sig/increase/resources/card_purchase_supplements.rbs
@@ -1280,7 +1249,8 @@ files:
1280
1249
  - sig/increase/resources/intrafi_account_enrollments.rbs
1281
1250
  - sig/increase/resources/intrafi_balances.rbs
1282
1251
  - sig/increase/resources/intrafi_exclusions.rbs
1283
- - sig/increase/resources/lockboxes.rbs
1252
+ - sig/increase/resources/lockbox_addresses.rbs
1253
+ - sig/increase/resources/lockbox_recipients.rbs
1284
1254
  - sig/increase/resources/oauth_applications.rbs
1285
1255
  - sig/increase/resources/oauth_connections.rbs
1286
1256
  - sig/increase/resources/oauth_tokens.rbs
@@ -1,104 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#create
6
- class BookkeepingAccount < Increase::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The account identifier.
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute account_id
14
- # The API Account associated with this bookkeeping account.
15
- #
16
- # @return [String, nil]
17
- required :account_id, String, nil?: true
18
-
19
- # @!attribute compliance_category
20
- # The compliance category of the account.
21
- #
22
- # @return [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil]
23
- required :compliance_category, enum: -> { Increase::BookkeepingAccount::ComplianceCategory }, nil?: true
24
-
25
- # @!attribute entity_id
26
- # The Entity associated with this bookkeeping account.
27
- #
28
- # @return [String, nil]
29
- required :entity_id, String, nil?: true
30
-
31
- # @!attribute idempotency_key
32
- # The idempotency key you chose for this object. This value is unique across
33
- # Increase and is used to ensure that a request is only processed once. Learn more
34
- # about [idempotency](https://increase.com/documentation/idempotency-keys).
35
- #
36
- # @return [String, nil]
37
- required :idempotency_key, String, nil?: true
38
-
39
- # @!attribute name
40
- # The name you choose for the account.
41
- #
42
- # @return [String]
43
- required :name, String
44
-
45
- # @!attribute type
46
- # A constant representing the object's type. For this resource it will always be
47
- # `bookkeeping_account`.
48
- #
49
- # @return [Symbol, Increase::Models::BookkeepingAccount::Type]
50
- required :type, enum: -> { Increase::BookkeepingAccount::Type }
51
-
52
- # @!method initialize(id:, account_id:, compliance_category:, entity_id:, idempotency_key:, name:, type:)
53
- # Some parameter documentations has been truncated, see
54
- # {Increase::Models::BookkeepingAccount} for more details.
55
- #
56
- # Accounts are T-accounts. They can store accounting entries. Your compliance
57
- # setup might require annotating money movements using this API. Learn more in our
58
- # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
59
- #
60
- # @param id [String] The account identifier.
61
- #
62
- # @param account_id [String, nil] The API Account associated with this bookkeeping account.
63
- #
64
- # @param compliance_category [Symbol, Increase::Models::BookkeepingAccount::ComplianceCategory, nil] The compliance category of the account.
65
- #
66
- # @param entity_id [String, nil] The Entity associated with this bookkeeping account.
67
- #
68
- # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
69
- #
70
- # @param name [String] The name you choose for the account.
71
- #
72
- # @param type [Symbol, Increase::Models::BookkeepingAccount::Type] A constant representing the object's type. For this resource it will always be `
73
-
74
- # The compliance category of the account.
75
- #
76
- # @see Increase::Models::BookkeepingAccount#compliance_category
77
- module ComplianceCategory
78
- extend Increase::Internal::Type::Enum
79
-
80
- # A cash in an commingled Increase Account.
81
- COMMINGLED_CASH = :commingled_cash
82
-
83
- # A customer balance.
84
- CUSTOMER_BALANCE = :customer_balance
85
-
86
- # @!method self.values
87
- # @return [Array<Symbol>]
88
- end
89
-
90
- # A constant representing the object's type. For this resource it will always be
91
- # `bookkeeping_account`.
92
- #
93
- # @see Increase::Models::BookkeepingAccount#type
94
- module Type
95
- extend Increase::Internal::Type::Enum
96
-
97
- BOOKKEEPING_ACCOUNT = :bookkeeping_account
98
-
99
- # @!method self.values
100
- # @return [Array<Symbol>]
101
- end
102
- end
103
- end
104
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#balance
6
- class BookkeepingAccountBalanceParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute bookkeeping_account_id
11
- # The identifier of the Bookkeeping Account to retrieve.
12
- #
13
- # @return [String]
14
- required :bookkeeping_account_id, String
15
-
16
- # @!attribute at_time
17
- # The moment to query the balance at. If not set, returns the current balances.
18
- #
19
- # @return [Time, nil]
20
- optional :at_time, Time
21
-
22
- # @!method initialize(bookkeeping_account_id:, at_time: nil, request_options: {})
23
- # @param bookkeeping_account_id [String] The identifier of the Bookkeeping Account to retrieve.
24
- #
25
- # @param at_time [Time] The moment to query the balance at. If not set, returns the current balances.
26
- #
27
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
28
- end
29
- end
30
- end
@@ -1,60 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#create
6
- class BookkeepingAccountCreateParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute name
11
- # The name you choose for the account.
12
- #
13
- # @return [String]
14
- required :name, String
15
-
16
- # @!attribute account_id
17
- # The account, if `compliance_category` is `commingled_cash`.
18
- #
19
- # @return [String, nil]
20
- optional :account_id, String
21
-
22
- # @!attribute compliance_category
23
- # The account compliance category.
24
- #
25
- # @return [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory, nil]
26
- optional :compliance_category, enum: -> { Increase::BookkeepingAccountCreateParams::ComplianceCategory }
27
-
28
- # @!attribute entity_id
29
- # The entity, if `compliance_category` is `customer_balance`.
30
- #
31
- # @return [String, nil]
32
- optional :entity_id, String
33
-
34
- # @!method initialize(name:, account_id: nil, compliance_category: nil, entity_id: nil, request_options: {})
35
- # @param name [String] The name you choose for the account.
36
- #
37
- # @param account_id [String] The account, if `compliance_category` is `commingled_cash`.
38
- #
39
- # @param compliance_category [Symbol, Increase::Models::BookkeepingAccountCreateParams::ComplianceCategory] The account compliance category.
40
- #
41
- # @param entity_id [String] The entity, if `compliance_category` is `customer_balance`.
42
- #
43
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
44
-
45
- # The account compliance category.
46
- module ComplianceCategory
47
- extend Increase::Internal::Type::Enum
48
-
49
- # A cash in an commingled Increase Account.
50
- COMMINGLED_CASH = :commingled_cash
51
-
52
- # A customer balance.
53
- CUSTOMER_BALANCE = :customer_balance
54
-
55
- # @!method self.values
56
- # @return [Array<Symbol>]
57
- end
58
- end
59
- end
60
- end
@@ -1,45 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#list
6
- class BookkeepingAccountListParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute cursor
11
- # Return the page of entries after this one.
12
- #
13
- # @return [String, nil]
14
- optional :cursor, String
15
-
16
- # @!attribute idempotency_key
17
- # Filter records to the one with the specified `idempotency_key` you chose for
18
- # that object. This value is unique across Increase and is used to ensure that a
19
- # request is only processed once. Learn more about
20
- # [idempotency](https://increase.com/documentation/idempotency-keys).
21
- #
22
- # @return [String, nil]
23
- optional :idempotency_key, String
24
-
25
- # @!attribute limit
26
- # Limit the size of the list that is returned. The default (and maximum) is 100
27
- # objects.
28
- #
29
- # @return [Integer, nil]
30
- optional :limit, Integer
31
-
32
- # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
33
- # Some parameter documentations has been truncated, see
34
- # {Increase::Models::BookkeepingAccountListParams} for more details.
35
- #
36
- # @param cursor [String] Return the page of entries after this one.
37
- #
38
- # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
39
- #
40
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
41
- #
42
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
43
- end
44
- end
45
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#update
6
- class BookkeepingAccountUpdateParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute bookkeeping_account_id
11
- # The bookkeeping account you would like to update.
12
- #
13
- # @return [String]
14
- required :bookkeeping_account_id, String
15
-
16
- # @!attribute name
17
- # The name you choose for the account.
18
- #
19
- # @return [String]
20
- required :name, String
21
-
22
- # @!method initialize(bookkeeping_account_id:, name:, request_options: {})
23
- # @param bookkeeping_account_id [String] The bookkeeping account you would like to update.
24
- #
25
- # @param name [String] The name you choose for the account.
26
- #
27
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
28
- end
29
- end
30
- end
@@ -1,54 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingAccounts#balance
6
- class BookkeepingBalanceLookup < Increase::Internal::Type::BaseModel
7
- # @!attribute balance
8
- # The Bookkeeping Account's current balance, representing the sum of all
9
- # Bookkeeping Entries on the Bookkeeping Account.
10
- #
11
- # @return [Integer]
12
- required :balance, Integer
13
-
14
- # @!attribute bookkeeping_account_id
15
- # The identifier for the account for which the balance was queried.
16
- #
17
- # @return [String]
18
- required :bookkeeping_account_id, String
19
-
20
- # @!attribute type
21
- # A constant representing the object's type. For this resource it will always be
22
- # `bookkeeping_balance_lookup`.
23
- #
24
- # @return [Symbol, Increase::Models::BookkeepingBalanceLookup::Type]
25
- required :type, enum: -> { Increase::BookkeepingBalanceLookup::Type }
26
-
27
- # @!method initialize(balance:, bookkeeping_account_id:, type:)
28
- # Some parameter documentations has been truncated, see
29
- # {Increase::Models::BookkeepingBalanceLookup} for more details.
30
- #
31
- # Represents a request to lookup the balance of a Bookkeeping Account at a given
32
- # point in time.
33
- #
34
- # @param balance [Integer] The Bookkeeping Account's current balance, representing the sum of all Bookkeepi
35
- #
36
- # @param bookkeeping_account_id [String] The identifier for the account for which the balance was queried.
37
- #
38
- # @param type [Symbol, Increase::Models::BookkeepingBalanceLookup::Type] A constant representing the object's type. For this resource it will always be `
39
-
40
- # A constant representing the object's type. For this resource it will always be
41
- # `bookkeeping_balance_lookup`.
42
- #
43
- # @see Increase::Models::BookkeepingBalanceLookup#type
44
- module Type
45
- extend Increase::Internal::Type::Enum
46
-
47
- BOOKKEEPING_BALANCE_LOOKUP = :bookkeeping_balance_lookup
48
-
49
- # @!method self.values
50
- # @return [Array<Symbol>]
51
- end
52
- end
53
- end
54
- end
@@ -1,79 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingEntries#retrieve
6
- class BookkeepingEntry < Increase::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The entry identifier.
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute account_id
14
- # The identifier for the Account the Entry belongs to.
15
- #
16
- # @return [String]
17
- required :account_id, String
18
-
19
- # @!attribute amount
20
- # The Entry amount in the minor unit of its currency. For dollars, for example,
21
- # this is cents.
22
- #
23
- # @return [Integer]
24
- required :amount, Integer
25
-
26
- # @!attribute created_at
27
- # When the entry set was created.
28
- #
29
- # @return [Time]
30
- required :created_at, Time
31
-
32
- # @!attribute entry_set_id
33
- # The identifier for the Entry Set the Entry belongs to.
34
- #
35
- # @return [String]
36
- required :entry_set_id, String
37
-
38
- # @!attribute type
39
- # A constant representing the object's type. For this resource it will always be
40
- # `bookkeeping_entry`.
41
- #
42
- # @return [Symbol, Increase::Models::BookkeepingEntry::Type]
43
- required :type, enum: -> { Increase::BookkeepingEntry::Type }
44
-
45
- # @!method initialize(id:, account_id:, amount:, created_at:, entry_set_id:, type:)
46
- # Some parameter documentations has been truncated, see
47
- # {Increase::Models::BookkeepingEntry} for more details.
48
- #
49
- # Entries are T-account entries recording debits and credits. Your compliance
50
- # setup might require annotating money movements using this API. Learn more in our
51
- # [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
52
- #
53
- # @param id [String] The entry identifier.
54
- #
55
- # @param account_id [String] The identifier for the Account the Entry belongs to.
56
- #
57
- # @param amount [Integer] The Entry amount in the minor unit of its currency. For dollars, for example, th
58
- #
59
- # @param created_at [Time] When the entry set was created.
60
- #
61
- # @param entry_set_id [String] The identifier for the Entry Set the Entry belongs to.
62
- #
63
- # @param type [Symbol, Increase::Models::BookkeepingEntry::Type] A constant representing the object's type. For this resource it will always be `
64
-
65
- # A constant representing the object's type. For this resource it will always be
66
- # `bookkeeping_entry`.
67
- #
68
- # @see Increase::Models::BookkeepingEntry#type
69
- module Type
70
- extend Increase::Internal::Type::Enum
71
-
72
- BOOKKEEPING_ENTRY = :bookkeeping_entry
73
-
74
- # @!method self.values
75
- # @return [Array<Symbol>]
76
- end
77
- end
78
- end
79
- end
@@ -1,42 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingEntries#list
6
- class BookkeepingEntryListParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute account_id
11
- # The identifier for the Bookkeeping Account to filter by.
12
- #
13
- # @return [String, nil]
14
- optional :account_id, String
15
-
16
- # @!attribute cursor
17
- # Return the page of entries after this one.
18
- #
19
- # @return [String, nil]
20
- optional :cursor, String
21
-
22
- # @!attribute limit
23
- # Limit the size of the list that is returned. The default (and maximum) is 100
24
- # objects.
25
- #
26
- # @return [Integer, nil]
27
- optional :limit, Integer
28
-
29
- # @!method initialize(account_id: nil, cursor: nil, limit: nil, request_options: {})
30
- # Some parameter documentations has been truncated, see
31
- # {Increase::Models::BookkeepingEntryListParams} for more details.
32
- #
33
- # @param account_id [String] The identifier for the Bookkeeping Account to filter by.
34
- #
35
- # @param cursor [String] Return the page of entries after this one.
36
- #
37
- # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
38
- #
39
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
40
- end
41
- end
42
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Increase
4
- module Models
5
- # @see Increase::Resources::BookkeepingEntries#retrieve
6
- class BookkeepingEntryRetrieveParams < Increase::Internal::Type::BaseModel
7
- extend Increase::Internal::Type::RequestParameters::Converter
8
- include Increase::Internal::Type::RequestParameters
9
-
10
- # @!attribute bookkeeping_entry_id
11
- # The identifier of the Bookkeeping Entry.
12
- #
13
- # @return [String]
14
- required :bookkeeping_entry_id, String
15
-
16
- # @!method initialize(bookkeeping_entry_id:, request_options: {})
17
- # @param bookkeeping_entry_id [String] The identifier of the Bookkeeping Entry.
18
- #
19
- # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
20
- end
21
- end
22
- end