increase 1.342.0 → 1.344.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 (46) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/internal/transport/base_client.rb +5 -36
  4. data/lib/increase/models/beneficial_owner_create_params.rb +9 -12
  5. data/lib/increase/models/beneficial_owner_update_params.rb +9 -12
  6. data/lib/increase/models/entity_create_params.rb +54 -72
  7. data/lib/increase/models/entity_update_params.rb +18 -24
  8. data/lib/increase/models/event.rb +6 -0
  9. data/lib/increase/models/event_list_params.rb +6 -0
  10. data/lib/increase/models/event_subscription.rb +6 -0
  11. data/lib/increase/models/event_subscription_create_params.rb +6 -0
  12. data/lib/increase/models/file.rb +3 -1
  13. data/lib/increase/models/file_contents_params.rb +22 -0
  14. data/lib/increase/models/unwrap_webhook_event.rb +6 -0
  15. data/lib/increase/models.rb +2 -0
  16. data/lib/increase/resources/files.rb +28 -0
  17. data/lib/increase/version.rb +1 -1
  18. data/lib/increase.rb +1 -0
  19. data/rbi/increase/internal/transport/base_client.rbi +2 -10
  20. data/rbi/increase/models/beneficial_owner_create_params.rbi +8 -13
  21. data/rbi/increase/models/beneficial_owner_update_params.rbi +8 -13
  22. data/rbi/increase/models/entity_create_params.rbi +48 -78
  23. data/rbi/increase/models/entity_update_params.rbi +16 -26
  24. data/rbi/increase/models/event.rbi +14 -0
  25. data/rbi/increase/models/event_list_params.rbi +14 -0
  26. data/rbi/increase/models/event_subscription.rbi +14 -0
  27. data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
  28. data/rbi/increase/models/file.rbi +3 -1
  29. data/rbi/increase/models/file_contents_params.rbi +40 -0
  30. data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
  31. data/rbi/increase/models.rbi +2 -0
  32. data/rbi/increase/resources/files.rbi +21 -0
  33. data/sig/increase/internal/transport/base_client.rbs +1 -4
  34. data/sig/increase/models/beneficial_owner_create_params.rbs +5 -7
  35. data/sig/increase/models/beneficial_owner_update_params.rbs +5 -7
  36. data/sig/increase/models/entity_create_params.rbs +30 -42
  37. data/sig/increase/models/entity_update_params.rbs +10 -14
  38. data/sig/increase/models/event.rbs +8 -0
  39. data/sig/increase/models/event_list_params.rbs +8 -0
  40. data/sig/increase/models/event_subscription.rbs +8 -0
  41. data/sig/increase/models/event_subscription_create_params.rbs +8 -0
  42. data/sig/increase/models/file_contents_params.rbs +23 -0
  43. data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
  44. data/sig/increase/models.rbs +2 -0
  45. data/sig/increase/resources/files.rbs +5 -0
  46. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 44b0c99f9f94e376bbbde161d7b141bfe9a27643400b13c0c0e134a564d2d698
4
- data.tar.gz: ca46f0f817f585ef9d37022233dfae92be8fa56e5efc60053aeb9db60b4ddcad
3
+ metadata.gz: 20afab8858e9ec6236c7f8339614d1275aeaacf2a32b442cf881574b380cde2c
4
+ data.tar.gz: 7f9a3de472920bf70178dd94f5c598d5492f115d4959453c2c1011f692725ed2
5
5
  SHA512:
6
- metadata.gz: 9a16128eea85df7d332895cb12ea94f275053d15b6908a6484a189ce26cdeee98b6998d98e3a64002c82dd84702fc3f9db20dad1481977e70f7ce2c82111a1dd
7
- data.tar.gz: 9dba6715858bb4263772de1062463d767e54a10c9a39530aec9c1f04bbc816dc708f1aa567a0b1b13a42f9a4305984b671dafdfa9b86833ea004c62146b539cf
6
+ metadata.gz: 6f6bfaddbe85bec4d9a75716cb7c258e546114abd6984a67ea77ec386febe9fa67ff9620fbb98ffd79776d984fdaaff11af86079316072db26ff30ff38ef381f
7
+ data.tar.gz: a30a20214302342fd852a2d5f4c04970097b09105395c9f7d83872c85c650efd293bee0ec285d35b4c71bd30dace8d0232971d5162da137719c410491af04f5c
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.342.0"
18
+ gem "increase", "~> 1.344.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -12,18 +12,6 @@ module Increase
12
12
  # from whatwg fetch spec
13
13
  MAX_REDIRECTS = 20
14
14
 
15
- # rubocop:disable Style/MutableConstant
16
- PLATFORM_HEADERS =
17
- {
18
- "x-stainless-arch" => Increase::Internal::Util.arch,
19
- "x-stainless-lang" => "ruby",
20
- "x-stainless-os" => Increase::Internal::Util.os,
21
- "x-stainless-package-version" => Increase::VERSION,
22
- "x-stainless-runtime" => ::RUBY_ENGINE,
23
- "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
24
- }
25
- # rubocop:enable Style/MutableConstant
26
-
27
15
  class << self
28
16
  # @api private
29
17
  #
@@ -198,7 +186,6 @@ module Increase
198
186
  )
199
187
  @requester = Increase::Internal::Transport::PooledNetRequester.new
200
188
  @headers = Increase::Internal::Util.normalized_headers(
201
- self.class::PLATFORM_HEADERS,
202
189
  {
203
190
  "accept" => "application/json",
204
191
  "content-type" => "application/json",
@@ -287,14 +274,7 @@ module Increase
287
274
  headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key }
288
275
  end
289
276
 
290
- unless headers.key?("x-stainless-retry-count")
291
- headers["x-stainless-retry-count"] = "0"
292
- end
293
-
294
277
  timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
295
- unless headers.key?("x-stainless-timeout") || timeout.zero?
296
- headers["x-stainless-timeout"] = timeout.to_s
297
- end
298
278
 
299
279
  headers.reject! { |_, v| v.to_s.empty? }
300
280
 
@@ -369,18 +349,12 @@ module Increase
369
349
  #
370
350
  # @param retry_count [Integer]
371
351
  #
372
- # @param send_retry_header [Boolean]
373
- #
374
352
  # @raise [Increase::Errors::APIError]
375
353
  # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
376
- def send_request(request, redirect_count:, retry_count:, send_retry_header:)
377
- url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
354
+ def send_request(request, redirect_count:, retry_count:)
355
+ url, max_retries, timeout = request.fetch_values(:url, :max_retries, :timeout)
378
356
  input = {**request.except(:timeout), deadline: Increase::Internal::Util.monotonic_secs + timeout}
379
357
 
380
- if send_retry_header
381
- headers["x-stainless-retry-count"] = retry_count.to_s
382
- end
383
-
384
358
  begin
385
359
  status, response, stream = @requester.execute(input)
386
360
  rescue Increase::Errors::APIConnectionError => e
@@ -403,8 +377,7 @@ module Increase
403
377
  send_request(
404
378
  request,
405
379
  redirect_count: redirect_count + 1,
406
- retry_count: retry_count,
407
- send_retry_header: send_retry_header
380
+ retry_count: retry_count
408
381
  )
409
382
  in Increase::Errors::APIConnectionError if retry_count >= max_retries
410
383
  raise status
@@ -432,8 +405,7 @@ module Increase
432
405
  send_request(
433
406
  request,
434
407
  redirect_count: redirect_count,
435
- retry_count: retry_count + 1,
436
- send_retry_header: send_retry_header
408
+ retry_count: retry_count + 1
437
409
  )
438
410
  end
439
411
  end
@@ -486,13 +458,10 @@ module Increase
486
458
  request = build_request(req.except(:options), opts)
487
459
  url = request.fetch(:url)
488
460
 
489
- # Don't send the current retry count in the headers if the caller modified the header defaults.
490
- send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
491
461
  status, response, stream = send_request(
492
462
  request,
493
463
  redirect_count: 0,
494
- retry_count: 0,
495
- send_retry_header: send_retry_header
464
+ retry_count: 0
496
465
  )
497
466
 
498
467
  headers = Increase::Internal::Util.normalized_headers(response.each_header.to_h)
@@ -115,19 +115,18 @@ module Increase
115
115
  # @return [String]
116
116
  required :city, String
117
117
 
118
+ # @!attribute country
119
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
120
+ #
121
+ # @return [String]
122
+ required :country, String
123
+
118
124
  # @!attribute line1
119
125
  # The first line of the address. This is usually the street number and street.
120
126
  #
121
127
  # @return [String]
122
128
  required :line1, String
123
129
 
124
- # @!attribute country
125
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
126
- # to `US`.
127
- #
128
- # @return [String, nil]
129
- optional :country, String
130
-
131
130
  # @!attribute line2
132
131
  # The second line of the address. This might be the floor or room number.
133
132
  #
@@ -147,17 +146,15 @@ module Increase
147
146
  # @return [String, nil]
148
147
  optional :zip, String
149
148
 
150
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
149
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
151
150
  # The individual's physical address. Mail receiving locations like PO Boxes and
152
151
  # PMB's are disallowed.
153
152
  #
154
153
  # @param city [String] The city, district, town, or village of the address.
155
154
  #
156
- # @param line1 [String] The first line of the address. This is usually the street number and street.
155
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
157
156
  #
158
- # @param country [String]
159
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
160
- # to `US`.
157
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
161
158
  #
162
159
  # @param line2 [String] The second line of the address. This might be the floor or room number.
163
160
  #
@@ -84,19 +84,18 @@ module Increase
84
84
  # @return [String]
85
85
  required :city, String
86
86
 
87
+ # @!attribute country
88
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
89
+ #
90
+ # @return [String]
91
+ required :country, String
92
+
87
93
  # @!attribute line1
88
94
  # The first line of the address. This is usually the street number and street.
89
95
  #
90
96
  # @return [String]
91
97
  required :line1, String
92
98
 
93
- # @!attribute country
94
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
95
- # to `US`.
96
- #
97
- # @return [String, nil]
98
- optional :country, String
99
-
100
99
  # @!attribute line2
101
100
  # The second line of the address. This might be the floor or room number.
102
101
  #
@@ -116,17 +115,15 @@ module Increase
116
115
  # @return [String, nil]
117
116
  optional :zip, String
118
117
 
119
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
118
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
120
119
  # The individual's physical address. Mail receiving locations like PO Boxes and
121
120
  # PMB's are disallowed.
122
121
  #
123
122
  # @param city [String] The city, district, town, or village of the address.
124
123
  #
125
- # @param line1 [String] The first line of the address. This is usually the street number and street.
124
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
126
125
  #
127
- # @param country [String]
128
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
129
- # to `US`.
126
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
130
127
  #
131
128
  # @param line2 [String] The second line of the address. This might be the floor or room number.
132
129
  #
@@ -281,19 +281,18 @@ module Increase
281
281
  # @return [String]
282
282
  required :city, String
283
283
 
284
+ # @!attribute country
285
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
286
+ #
287
+ # @return [String]
288
+ required :country, String
289
+
284
290
  # @!attribute line1
285
291
  # The first line of the address. This is usually the street number and street.
286
292
  #
287
293
  # @return [String]
288
294
  required :line1, String
289
295
 
290
- # @!attribute country
291
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
292
- # to `US`.
293
- #
294
- # @return [String, nil]
295
- optional :country, String
296
-
297
296
  # @!attribute line2
298
297
  # The second line of the address. This might be the floor or room number.
299
298
  #
@@ -313,17 +312,15 @@ module Increase
313
312
  # @return [String, nil]
314
313
  optional :zip, String
315
314
 
316
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
315
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
317
316
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
318
317
  # are disallowed.
319
318
  #
320
319
  # @param city [String] The city, district, town, or village of the address.
321
320
  #
322
- # @param line1 [String] The first line of the address. This is usually the street number and street.
321
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
323
322
  #
324
- # @param country [String]
325
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
326
- # to `US`.
323
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
327
324
  #
328
325
  # @param line2 [String] The second line of the address. This might be the floor or room number.
329
326
  #
@@ -432,19 +429,18 @@ module Increase
432
429
  # @return [String]
433
430
  required :city, String
434
431
 
432
+ # @!attribute country
433
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
434
+ #
435
+ # @return [String]
436
+ required :country, String
437
+
435
438
  # @!attribute line1
436
439
  # The first line of the address. This is usually the street number and street.
437
440
  #
438
441
  # @return [String]
439
442
  required :line1, String
440
443
 
441
- # @!attribute country
442
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
443
- # to `US`.
444
- #
445
- # @return [String, nil]
446
- optional :country, String
447
-
448
444
  # @!attribute line2
449
445
  # The second line of the address. This might be the floor or room number.
450
446
  #
@@ -464,17 +460,15 @@ module Increase
464
460
  # @return [String, nil]
465
461
  optional :zip, String
466
462
 
467
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
463
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
468
464
  # The individual's physical address. Mail receiving locations like PO Boxes and
469
465
  # PMB's are disallowed.
470
466
  #
471
467
  # @param city [String] The city, district, town, or village of the address.
472
468
  #
473
- # @param line1 [String] The first line of the address. This is usually the street number and street.
469
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
474
470
  #
475
- # @param country [String]
476
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
477
- # to `US`.
471
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
478
472
  #
479
473
  # @param line2 [String] The second line of the address. This might be the floor or room number.
480
474
  #
@@ -1024,19 +1018,18 @@ module Increase
1024
1018
  # @return [String]
1025
1019
  required :city, String
1026
1020
 
1021
+ # @!attribute country
1022
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1023
+ #
1024
+ # @return [String]
1025
+ required :country, String
1026
+
1027
1027
  # @!attribute line1
1028
1028
  # The first line of the address. This is usually the street number and street.
1029
1029
  #
1030
1030
  # @return [String]
1031
1031
  required :line1, String
1032
1032
 
1033
- # @!attribute country
1034
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
1035
- # to `US`.
1036
- #
1037
- # @return [String, nil]
1038
- optional :country, String
1039
-
1040
1033
  # @!attribute line2
1041
1034
  # The second line of the address. This might be the floor or room number.
1042
1035
  #
@@ -1056,17 +1049,15 @@ module Increase
1056
1049
  # @return [String, nil]
1057
1050
  optional :zip, String
1058
1051
 
1059
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
1052
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1060
1053
  # The individual's physical address. Mail receiving locations like PO Boxes and
1061
1054
  # PMB's are disallowed.
1062
1055
  #
1063
1056
  # @param city [String] The city, district, town, or village of the address.
1064
1057
  #
1065
- # @param line1 [String] The first line of the address. This is usually the street number and street.
1058
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1066
1059
  #
1067
- # @param country [String]
1068
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
1069
- # to `US`.
1060
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1070
1061
  #
1071
1062
  # @param line2 [String] The second line of the address. This might be the floor or room number.
1072
1063
  #
@@ -1364,19 +1355,18 @@ module Increase
1364
1355
  # @return [String]
1365
1356
  required :city, String
1366
1357
 
1358
+ # @!attribute country
1359
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1360
+ #
1361
+ # @return [String]
1362
+ required :country, String
1363
+
1367
1364
  # @!attribute line1
1368
1365
  # The first line of the address. This is usually the street number and street.
1369
1366
  #
1370
1367
  # @return [String]
1371
1368
  required :line1, String
1372
1369
 
1373
- # @!attribute country
1374
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
1375
- # to `US`.
1376
- #
1377
- # @return [String, nil]
1378
- optional :country, String
1379
-
1380
1370
  # @!attribute line2
1381
1371
  # The second line of the address. This might be the floor or room number.
1382
1372
  #
@@ -1396,17 +1386,15 @@ module Increase
1396
1386
  # @return [String, nil]
1397
1387
  optional :zip, String
1398
1388
 
1399
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
1389
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
1400
1390
  # The individual's physical address. Mail receiving locations like PO Boxes and
1401
1391
  # PMB's are disallowed.
1402
1392
  #
1403
1393
  # @param city [String] The city, district, town, or village of the address.
1404
1394
  #
1405
- # @param line1 [String] The first line of the address. This is usually the street number and street.
1395
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
1406
1396
  #
1407
- # @param country [String]
1408
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
1409
- # to `US`.
1397
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
1410
1398
  #
1411
1399
  # @param line2 [String] The second line of the address. This might be the floor or room number.
1412
1400
  #
@@ -2022,19 +2010,18 @@ module Increase
2022
2010
  # @return [String]
2023
2011
  required :city, String
2024
2012
 
2013
+ # @!attribute country
2014
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2015
+ #
2016
+ # @return [String]
2017
+ required :country, String
2018
+
2025
2019
  # @!attribute line1
2026
2020
  # The first line of the address. This is usually the street number and street.
2027
2021
  #
2028
2022
  # @return [String]
2029
2023
  required :line1, String
2030
2024
 
2031
- # @!attribute country
2032
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
2033
- # to `US`.
2034
- #
2035
- # @return [String, nil]
2036
- optional :country, String
2037
-
2038
2025
  # @!attribute line2
2039
2026
  # The second line of the address. This might be the floor or room number.
2040
2027
  #
@@ -2054,17 +2041,15 @@ module Increase
2054
2041
  # @return [String, nil]
2055
2042
  optional :zip, String
2056
2043
 
2057
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
2044
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
2058
2045
  # The individual's physical address. Mail receiving locations like PO Boxes and
2059
2046
  # PMB's are disallowed.
2060
2047
  #
2061
2048
  # @param city [String] The city, district, town, or village of the address.
2062
2049
  #
2063
- # @param line1 [String] The first line of the address. This is usually the street number and street.
2050
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2064
2051
  #
2065
- # @param country [String]
2066
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
2067
- # to `US`.
2052
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
2068
2053
  #
2069
2054
  # @param line2 [String] The second line of the address. This might be the floor or room number.
2070
2055
  #
@@ -2363,19 +2348,18 @@ module Increase
2363
2348
  # @return [String]
2364
2349
  required :city, String
2365
2350
 
2351
+ # @!attribute country
2352
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2353
+ #
2354
+ # @return [String]
2355
+ required :country, String
2356
+
2366
2357
  # @!attribute line1
2367
2358
  # The first line of the address. This is usually the street number and street.
2368
2359
  #
2369
2360
  # @return [String]
2370
2361
  required :line1, String
2371
2362
 
2372
- # @!attribute country
2373
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
2374
- # to `US`.
2375
- #
2376
- # @return [String, nil]
2377
- optional :country, String
2378
-
2379
2363
  # @!attribute line2
2380
2364
  # The second line of the address. This might be the floor or room number.
2381
2365
  #
@@ -2395,17 +2379,15 @@ module Increase
2395
2379
  # @return [String, nil]
2396
2380
  optional :zip, String
2397
2381
 
2398
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
2382
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
2399
2383
  # The individual's physical address. Mail receiving locations like PO Boxes and
2400
2384
  # PMB's are disallowed.
2401
2385
  #
2402
2386
  # @param city [String] The city, district, town, or village of the address.
2403
2387
  #
2404
- # @param line1 [String] The first line of the address. This is usually the street number and street.
2388
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
2405
2389
  #
2406
- # @param country [String]
2407
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
2408
- # to `US`.
2390
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
2409
2391
  #
2410
2392
  # @param line2 [String] The second line of the address. This might be the floor or room number.
2411
2393
  #
@@ -202,19 +202,18 @@ module Increase
202
202
  # @return [String]
203
203
  required :city, String
204
204
 
205
+ # @!attribute country
206
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
207
+ #
208
+ # @return [String]
209
+ required :country, String
210
+
205
211
  # @!attribute line1
206
212
  # The first line of the address. This is usually the street number and street.
207
213
  #
208
214
  # @return [String]
209
215
  required :line1, String
210
216
 
211
- # @!attribute country
212
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
213
- # to `US`.
214
- #
215
- # @return [String, nil]
216
- optional :country, String
217
-
218
217
  # @!attribute line2
219
218
  # The second line of the address. This might be the floor or room number.
220
219
  #
@@ -234,17 +233,15 @@ module Increase
234
233
  # @return [String, nil]
235
234
  optional :zip, String
236
235
 
237
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
236
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
238
237
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
239
238
  # are disallowed.
240
239
  #
241
240
  # @param city [String] The city, district, town, or village of the address.
242
241
  #
243
- # @param line1 [String] The first line of the address. This is usually the street number and street.
242
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
244
243
  #
245
- # @param country [String]
246
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
247
- # to `US`.
244
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
248
245
  #
249
246
  # @param line2 [String] The second line of the address. This might be the floor or room number.
250
247
  #
@@ -430,19 +427,18 @@ module Increase
430
427
  # @return [String]
431
428
  required :city, String
432
429
 
430
+ # @!attribute country
431
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
432
+ #
433
+ # @return [String]
434
+ required :country, String
435
+
433
436
  # @!attribute line1
434
437
  # The first line of the address. This is usually the street number and street.
435
438
  #
436
439
  # @return [String]
437
440
  required :line1, String
438
441
 
439
- # @!attribute country
440
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
441
- # to `US`.
442
- #
443
- # @return [String, nil]
444
- optional :country, String
445
-
446
442
  # @!attribute line2
447
443
  # The second line of the address. This might be the floor or room number.
448
444
  #
@@ -462,17 +458,15 @@ module Increase
462
458
  # @return [String, nil]
463
459
  optional :zip, String
464
460
 
465
- # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
461
+ # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
466
462
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
467
463
  # are disallowed.
468
464
  #
469
465
  # @param city [String] The city, district, town, or village of the address.
470
466
  #
471
- # @param line1 [String] The first line of the address. This is usually the street number and street.
467
+ # @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
472
468
  #
473
- # @param country [String]
474
- # The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
475
- # to `US`.
469
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
476
470
  #
477
471
  # @param line2 [String] The second line of the address. This might be the floor or room number.
478
472
  #
@@ -355,6 +355,12 @@ module Increase
355
355
  # Occurs whenever a Physical Check is updated.
356
356
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
357
357
 
358
+ # Occurs whenever a Physical Check Book is created.
359
+ PHYSICAL_CHECK_BOOK_CREATED = :"physical_check_book.created"
360
+
361
+ # Occurs whenever a Physical Check Book is updated.
362
+ PHYSICAL_CHECK_BOOK_UPDATED = :"physical_check_book.updated"
363
+
358
364
  # Occurs whenever a Program is created.
359
365
  PROGRAM_CREATED = :"program.created"
360
366
 
@@ -363,6 +363,12 @@ module Increase
363
363
  # Occurs whenever a Physical Check is updated.
364
364
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
365
365
 
366
+ # Occurs whenever a Physical Check Book is created.
367
+ PHYSICAL_CHECK_BOOK_CREATED = :"physical_check_book.created"
368
+
369
+ # Occurs whenever a Physical Check Book is updated.
370
+ PHYSICAL_CHECK_BOOK_UPDATED = :"physical_check_book.updated"
371
+
366
372
  # Occurs whenever a Program is created.
367
373
  PROGRAM_CREATED = :"program.created"
368
374
 
@@ -396,6 +396,12 @@ module Increase
396
396
  # Occurs whenever a Physical Check is updated.
397
397
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
398
398
 
399
+ # Occurs whenever a Physical Check Book is created.
400
+ PHYSICAL_CHECK_BOOK_CREATED = :"physical_check_book.created"
401
+
402
+ # Occurs whenever a Physical Check Book is updated.
403
+ PHYSICAL_CHECK_BOOK_UPDATED = :"physical_check_book.updated"
404
+
399
405
  # Occurs whenever a Program is created.
400
406
  PROGRAM_CREATED = :"program.created"
401
407
 
@@ -365,6 +365,12 @@ module Increase
365
365
  # Occurs whenever a Physical Check is updated.
366
366
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
367
367
 
368
+ # Occurs whenever a Physical Check Book is created.
369
+ PHYSICAL_CHECK_BOOK_CREATED = :"physical_check_book.created"
370
+
371
+ # Occurs whenever a Physical Check Book is updated.
372
+ PHYSICAL_CHECK_BOOK_UPDATED = :"physical_check_book.updated"
373
+
368
374
  # Occurs whenever a Program is created.
369
375
  PROGRAM_CREATED = :"program.created"
370
376
 
@@ -67,7 +67,9 @@ module Increase
67
67
  # Files are objects that represent a file hosted on Increase's servers. The file
68
68
  # may have been uploaded by you (for example, when uploading a check image) or it
69
69
  # may have been created by Increase (for example, an autogenerated statement PDF).
70
- # If you need to download a File, create a File Link.
70
+ # If you need to download a File, use the `/files/{file_id}/contents` endpoint. If
71
+ # you need to share a File with someone who doesn't have access to your API key,
72
+ # create a File Link.
71
73
  #
72
74
  # @param id [String] The File's identifier.
73
75
  #