increase 1.270.0 → 1.273.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.
@@ -285,22 +285,17 @@ module Increase
285
285
  )
286
286
  end
287
287
 
288
- # The city of the address.
288
+ # The city, district, town, or village of the address.
289
289
  sig { returns(String) }
290
290
  attr_accessor :city
291
291
 
292
- # The first line of the address. This is usually the street number and street.
293
- sig { returns(String) }
294
- attr_accessor :line1
295
-
296
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
297
- # the address.
292
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
298
293
  sig { returns(String) }
299
- attr_accessor :state
294
+ attr_accessor :country
300
295
 
301
- # The ZIP code of the address.
296
+ # The first line of the address. This is usually the street number and street.
302
297
  sig { returns(String) }
303
- attr_accessor :zip
298
+ attr_accessor :line1
304
299
 
305
300
  # The second line of the address. This might be the floor or room number.
306
301
  sig { returns(T.nilable(String)) }
@@ -309,29 +304,47 @@ module Increase
309
304
  sig { params(line2: String).void }
310
305
  attr_writer :line2
311
306
 
307
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
308
+ # state, province, or region of the address. Required in certain countries.
309
+ sig { returns(T.nilable(String)) }
310
+ attr_reader :state
311
+
312
+ sig { params(state: String).void }
313
+ attr_writer :state
314
+
315
+ # The ZIP or postal code of the address. Required in certain countries.
316
+ sig { returns(T.nilable(String)) }
317
+ attr_reader :zip
318
+
319
+ sig { params(zip: String).void }
320
+ attr_writer :zip
321
+
312
322
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
313
323
  # are disallowed.
314
324
  sig do
315
325
  params(
316
326
  city: String,
327
+ country: String,
317
328
  line1: String,
329
+ line2: String,
318
330
  state: String,
319
- zip: String,
320
- line2: String
331
+ zip: String
321
332
  ).returns(T.attached_class)
322
333
  end
323
334
  def self.new(
324
- # The city of the address.
335
+ # The city, district, town, or village of the address.
325
336
  city:,
337
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
338
+ country:,
326
339
  # The first line of the address. This is usually the street number and street.
327
340
  line1:,
328
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
329
- # the address.
330
- state:,
331
- # The ZIP code of the address.
332
- zip:,
333
341
  # The second line of the address. This might be the floor or room number.
334
- line2: nil
342
+ line2: nil,
343
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
344
+ # state, province, or region of the address. Required in certain countries.
345
+ state: nil,
346
+ # The ZIP or postal code of the address. Required in certain countries.
347
+ zip: nil
335
348
  )
336
349
  end
337
350
 
@@ -339,10 +352,11 @@ module Increase
339
352
  override.returns(
340
353
  {
341
354
  city: String,
355
+ country: String,
342
356
  line1: String,
357
+ line2: String,
343
358
  state: String,
344
- zip: String,
345
- line2: String
359
+ zip: String
346
360
  }
347
361
  )
348
362
  end
@@ -562,22 +576,17 @@ module Increase
562
576
  )
563
577
  end
564
578
 
565
- # The city of the address.
579
+ # The city, district, town, or village of the address.
566
580
  sig { returns(String) }
567
581
  attr_accessor :city
568
582
 
569
- # The first line of the address. This is usually the street number and street.
570
- sig { returns(String) }
571
- attr_accessor :line1
572
-
573
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
574
- # the address.
583
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
575
584
  sig { returns(String) }
576
- attr_accessor :state
585
+ attr_accessor :country
577
586
 
578
- # The ZIP code of the address.
587
+ # The first line of the address. This is usually the street number and street.
579
588
  sig { returns(String) }
580
- attr_accessor :zip
589
+ attr_accessor :line1
581
590
 
582
591
  # The second line of the address. This might be the floor or room number.
583
592
  sig { returns(T.nilable(String)) }
@@ -586,29 +595,47 @@ module Increase
586
595
  sig { params(line2: String).void }
587
596
  attr_writer :line2
588
597
 
598
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
599
+ # state, province, or region of the address. Required in certain countries.
600
+ sig { returns(T.nilable(String)) }
601
+ attr_reader :state
602
+
603
+ sig { params(state: String).void }
604
+ attr_writer :state
605
+
606
+ # The ZIP or postal code of the address. Required in certain countries.
607
+ sig { returns(T.nilable(String)) }
608
+ attr_reader :zip
609
+
610
+ sig { params(zip: String).void }
611
+ attr_writer :zip
612
+
589
613
  # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
590
614
  # are disallowed.
591
615
  sig do
592
616
  params(
593
617
  city: String,
618
+ country: String,
594
619
  line1: String,
620
+ line2: String,
595
621
  state: String,
596
- zip: String,
597
- line2: String
622
+ zip: String
598
623
  ).returns(T.attached_class)
599
624
  end
600
625
  def self.new(
601
- # The city of the address.
626
+ # The city, district, town, or village of the address.
602
627
  city:,
628
+ # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
629
+ country:,
603
630
  # The first line of the address. This is usually the street number and street.
604
631
  line1:,
605
- # The two-letter United States Postal Service (USPS) abbreviation for the state of
606
- # the address.
607
- state:,
608
- # The ZIP code of the address.
609
- zip:,
610
632
  # The second line of the address. This might be the floor or room number.
611
- line2: nil
633
+ line2: nil,
634
+ # The two-letter United States Postal Service (USPS) abbreviation for the US
635
+ # state, province, or region of the address. Required in certain countries.
636
+ state: nil,
637
+ # The ZIP or postal code of the address. Required in certain countries.
638
+ zip: nil
612
639
  )
613
640
  end
614
641
 
@@ -616,10 +643,11 @@ module Increase
616
643
  override.returns(
617
644
  {
618
645
  city: String,
646
+ country: String,
619
647
  line1: String,
648
+ line2: String,
620
649
  state: String,
621
- zip: String,
622
- line2: String
650
+ zip: String
623
651
  }
624
652
  )
625
653
  end
@@ -108,8 +108,8 @@ module Increase
108
108
  email: String?,
109
109
  incorporation_state: String?,
110
110
  industry_code: String?,
111
+ legal_identifier: Increase::Entity::Corporation::LegalIdentifier?,
111
112
  name: String,
112
- tax_identifier: String?,
113
113
  website: String?
114
114
  }
115
115
 
@@ -124,9 +124,9 @@ module Increase
124
124
 
125
125
  attr_accessor industry_code: String?
126
126
 
127
- attr_accessor name: String
127
+ attr_accessor legal_identifier: Increase::Entity::Corporation::LegalIdentifier?
128
128
 
129
- attr_accessor tax_identifier: String?
129
+ attr_accessor name: String
130
130
 
131
131
  attr_accessor website: String?
132
132
 
@@ -136,8 +136,8 @@ module Increase
136
136
  email: String?,
137
137
  incorporation_state: String?,
138
138
  industry_code: String?,
139
+ legal_identifier: Increase::Entity::Corporation::LegalIdentifier?,
139
140
  name: String,
140
- tax_identifier: String?,
141
141
  website: String?
142
142
  ) -> void
143
143
 
@@ -147,45 +147,50 @@ module Increase
147
147
  email: String?,
148
148
  incorporation_state: String?,
149
149
  industry_code: String?,
150
+ legal_identifier: Increase::Entity::Corporation::LegalIdentifier?,
150
151
  name: String,
151
- tax_identifier: String?,
152
152
  website: String?
153
153
  }
154
154
 
155
155
  type address =
156
156
  {
157
- city: String,
157
+ city: String?,
158
+ country: String,
158
159
  :line1 => String,
159
160
  :line2 => String?,
160
- state: String,
161
- zip: String
161
+ state: String?,
162
+ zip: String?
162
163
  }
163
164
 
164
165
  class Address < Increase::Internal::Type::BaseModel
165
- attr_accessor city: String
166
+ attr_accessor city: String?
167
+
168
+ attr_accessor country: String
166
169
 
167
170
  attr_accessor line1: String
168
171
 
169
172
  attr_accessor line2: String?
170
173
 
171
- attr_accessor state: String
174
+ attr_accessor state: String?
172
175
 
173
- attr_accessor zip: String
176
+ attr_accessor zip: String?
174
177
 
175
178
  def initialize: (
176
- city: String,
179
+ city: String?,
180
+ country: String,
177
181
  line1: String,
178
182
  line2: String?,
179
- state: String,
180
- zip: String
183
+ state: String?,
184
+ zip: String?
181
185
  ) -> void
182
186
 
183
187
  def to_hash: -> {
184
- city: String,
188
+ city: String?,
189
+ country: String,
185
190
  :line1 => String,
186
191
  :line2 => String?,
187
- state: String,
188
- zip: String
192
+ state: String?,
193
+ zip: String?
189
194
  }
190
195
  end
191
196
 
@@ -358,6 +363,42 @@ module Increase
358
363
  def self?.values: -> ::Array[Increase::Models::Entity::Corporation::BeneficialOwner::prong]
359
364
  end
360
365
  end
366
+
367
+ type legal_identifier =
368
+ {
369
+ category: Increase::Models::Entity::Corporation::LegalIdentifier::category,
370
+ value: String
371
+ }
372
+
373
+ class LegalIdentifier < Increase::Internal::Type::BaseModel
374
+ attr_accessor category: Increase::Models::Entity::Corporation::LegalIdentifier::category
375
+
376
+ attr_accessor value: String
377
+
378
+ def initialize: (
379
+ category: Increase::Models::Entity::Corporation::LegalIdentifier::category,
380
+ value: String
381
+ ) -> void
382
+
383
+ def to_hash: -> {
384
+ category: Increase::Models::Entity::Corporation::LegalIdentifier::category,
385
+ value: String
386
+ }
387
+
388
+ type category = :us_employer_identification_number | :other
389
+
390
+ module Category
391
+ extend Increase::Internal::Type::Enum
392
+
393
+ # The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS.
394
+ US_EMPLOYER_IDENTIFICATION_NUMBER: :us_employer_identification_number
395
+
396
+ # A legal identifier issued by a foreign government, like a tax identification number or registration number.
397
+ OTHER: :other
398
+
399
+ def self?.values: -> ::Array[Increase::Models::Entity::Corporation::LegalIdentifier::category]
400
+ end
401
+ end
361
402
  end
362
403
 
363
404
  type government_authority =
@@ -403,38 +444,43 @@ module Increase
403
444
 
404
445
  type address =
405
446
  {
406
- city: String,
447
+ city: String?,
448
+ country: String,
407
449
  :line1 => String,
408
450
  :line2 => String?,
409
- state: String,
410
- zip: String
451
+ state: String?,
452
+ zip: String?
411
453
  }
412
454
 
413
455
  class Address < Increase::Internal::Type::BaseModel
414
- attr_accessor city: String
456
+ attr_accessor city: String?
457
+
458
+ attr_accessor country: String
415
459
 
416
460
  attr_accessor line1: String
417
461
 
418
462
  attr_accessor line2: String?
419
463
 
420
- attr_accessor state: String
464
+ attr_accessor state: String?
421
465
 
422
- attr_accessor zip: String
466
+ attr_accessor zip: String?
423
467
 
424
468
  def initialize: (
425
- city: String,
469
+ city: String?,
470
+ country: String,
426
471
  line1: String,
427
472
  line2: String?,
428
- state: String,
429
- zip: String
473
+ state: String?,
474
+ zip: String?
430
475
  ) -> void
431
476
 
432
477
  def to_hash: -> {
433
- city: String,
478
+ city: String?,
479
+ country: String,
434
480
  :line1 => String,
435
481
  :line2 => String?,
436
- state: String,
437
- zip: String
482
+ state: String?,
483
+ zip: String?
438
484
  }
439
485
  end
440
486
 
@@ -526,38 +572,43 @@ module Increase
526
572
 
527
573
  type address =
528
574
  {
529
- city: String,
575
+ city: String?,
576
+ country: String,
530
577
  :line1 => String,
531
578
  :line2 => String?,
532
- state: String,
533
- zip: String
579
+ state: String?,
580
+ zip: String?
534
581
  }
535
582
 
536
583
  class Address < Increase::Internal::Type::BaseModel
537
- attr_accessor city: String
584
+ attr_accessor city: String?
585
+
586
+ attr_accessor country: String
538
587
 
539
588
  attr_accessor line1: String
540
589
 
541
590
  attr_accessor line2: String?
542
591
 
543
- attr_accessor state: String
592
+ attr_accessor state: String?
544
593
 
545
- attr_accessor zip: String
594
+ attr_accessor zip: String?
546
595
 
547
596
  def initialize: (
548
- city: String,
597
+ city: String?,
598
+ country: String,
549
599
  line1: String,
550
600
  line2: String?,
551
- state: String,
552
- zip: String
601
+ state: String?,
602
+ zip: String?
553
603
  ) -> void
554
604
 
555
605
  def to_hash: -> {
556
- city: String,
606
+ city: String?,
607
+ country: String,
557
608
  :line1 => String,
558
609
  :line2 => String?,
559
- state: String,
560
- zip: String
610
+ state: String?,
611
+ zip: String?
561
612
  }
562
613
  end
563
614
 
@@ -646,38 +697,43 @@ module Increase
646
697
 
647
698
  type address =
648
699
  {
649
- city: String,
700
+ city: String?,
701
+ country: String,
650
702
  :line1 => String,
651
703
  :line2 => String?,
652
- state: String,
653
- zip: String
704
+ state: String?,
705
+ zip: String?
654
706
  }
655
707
 
656
708
  class Address < Increase::Internal::Type::BaseModel
657
- attr_accessor city: String
709
+ attr_accessor city: String?
710
+
711
+ attr_accessor country: String
658
712
 
659
713
  attr_accessor line1: String
660
714
 
661
715
  attr_accessor line2: String?
662
716
 
663
- attr_accessor state: String
717
+ attr_accessor state: String?
664
718
 
665
- attr_accessor zip: String
719
+ attr_accessor zip: String?
666
720
 
667
721
  def initialize: (
668
- city: String,
722
+ city: String?,
723
+ country: String,
669
724
  line1: String,
670
725
  line2: String?,
671
- state: String,
672
- zip: String
726
+ state: String?,
727
+ zip: String?
673
728
  ) -> void
674
729
 
675
730
  def to_hash: -> {
676
- city: String,
731
+ city: String?,
732
+ country: String,
677
733
  :line1 => String,
678
734
  :line2 => String?,
679
- state: String,
680
- zip: String
735
+ state: String?,
736
+ zip: String?
681
737
  }
682
738
  end
683
739
 
@@ -930,38 +986,43 @@ module Increase
930
986
 
931
987
  type address =
932
988
  {
933
- city: String,
989
+ city: String?,
990
+ country: String,
934
991
  :line1 => String,
935
992
  :line2 => String?,
936
- state: String,
937
- zip: String
993
+ state: String?,
994
+ zip: String?
938
995
  }
939
996
 
940
997
  class Address < Increase::Internal::Type::BaseModel
941
- attr_accessor city: String
998
+ attr_accessor city: String?
999
+
1000
+ attr_accessor country: String
942
1001
 
943
1002
  attr_accessor line1: String
944
1003
 
945
1004
  attr_accessor line2: String?
946
1005
 
947
- attr_accessor state: String
1006
+ attr_accessor state: String?
948
1007
 
949
- attr_accessor zip: String
1008
+ attr_accessor zip: String?
950
1009
 
951
1010
  def initialize: (
952
- city: String,
1011
+ city: String?,
1012
+ country: String,
953
1013
  line1: String,
954
1014
  line2: String?,
955
- state: String,
956
- zip: String
1015
+ state: String?,
1016
+ zip: String?
957
1017
  ) -> void
958
1018
 
959
1019
  def to_hash: -> {
960
- city: String,
1020
+ city: String?,
1021
+ country: String,
961
1022
  :line1 => String,
962
1023
  :line2 => String?,
963
- state: String,
964
- zip: String
1024
+ state: String?,
1025
+ zip: String?
965
1026
  }
966
1027
  end
967
1028
 
@@ -1012,38 +1073,43 @@ module Increase
1012
1073
 
1013
1074
  type address =
1014
1075
  {
1015
- city: String,
1076
+ city: String?,
1077
+ country: String,
1016
1078
  :line1 => String,
1017
1079
  :line2 => String?,
1018
- state: String,
1019
- zip: String
1080
+ state: String?,
1081
+ zip: String?
1020
1082
  }
1021
1083
 
1022
1084
  class Address < Increase::Internal::Type::BaseModel
1023
- attr_accessor city: String
1085
+ attr_accessor city: String?
1086
+
1087
+ attr_accessor country: String
1024
1088
 
1025
1089
  attr_accessor line1: String
1026
1090
 
1027
1091
  attr_accessor line2: String?
1028
1092
 
1029
- attr_accessor state: String
1093
+ attr_accessor state: String?
1030
1094
 
1031
- attr_accessor zip: String
1095
+ attr_accessor zip: String?
1032
1096
 
1033
1097
  def initialize: (
1034
- city: String,
1098
+ city: String?,
1099
+ country: String,
1035
1100
  line1: String,
1036
1101
  line2: String?,
1037
- state: String,
1038
- zip: String
1102
+ state: String?,
1103
+ zip: String?
1039
1104
  ) -> void
1040
1105
 
1041
1106
  def to_hash: -> {
1042
- city: String,
1107
+ city: String?,
1108
+ country: String,
1043
1109
  :line1 => String,
1044
1110
  :line2 => String?,
1045
- state: String,
1046
- zip: String
1111
+ state: String?,
1112
+ zip: String?
1047
1113
  }
1048
1114
  end
1049
1115
 
@@ -1152,38 +1218,43 @@ module Increase
1152
1218
 
1153
1219
  type address =
1154
1220
  {
1155
- city: String,
1221
+ city: String?,
1222
+ country: String,
1156
1223
  :line1 => String,
1157
1224
  :line2 => String?,
1158
- state: String,
1159
- zip: String
1225
+ state: String?,
1226
+ zip: String?
1160
1227
  }
1161
1228
 
1162
1229
  class Address < Increase::Internal::Type::BaseModel
1163
- attr_accessor city: String
1230
+ attr_accessor city: String?
1231
+
1232
+ attr_accessor country: String
1164
1233
 
1165
1234
  attr_accessor line1: String
1166
1235
 
1167
1236
  attr_accessor line2: String?
1168
1237
 
1169
- attr_accessor state: String
1238
+ attr_accessor state: String?
1170
1239
 
1171
- attr_accessor zip: String
1240
+ attr_accessor zip: String?
1172
1241
 
1173
1242
  def initialize: (
1174
- city: String,
1243
+ city: String?,
1244
+ country: String,
1175
1245
  line1: String,
1176
1246
  line2: String?,
1177
- state: String,
1178
- zip: String
1247
+ state: String?,
1248
+ zip: String?
1179
1249
  ) -> void
1180
1250
 
1181
1251
  def to_hash: -> {
1182
- city: String,
1252
+ city: String?,
1253
+ country: String,
1183
1254
  :line1 => String,
1184
1255
  :line2 => String?,
1185
- state: String,
1186
- zip: String
1256
+ state: String?,
1257
+ zip: String?
1187
1258
  }
1188
1259
  end
1189
1260