increase 1.67.0 → 1.69.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.
@@ -148,6 +148,20 @@ module Increase
148
148
  )
149
149
  end
150
150
 
151
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
152
+ # are disallowed.
153
+ sig do
154
+ returns(T.nilable(Increase::EntityUpdateParams::Corporation::Address))
155
+ end
156
+ attr_reader :address
157
+
158
+ sig do
159
+ params(
160
+ address: Increase::EntityUpdateParams::Corporation::Address::OrHash
161
+ ).void
162
+ end
163
+ attr_writer :address
164
+
151
165
  # The legal name of the corporation.
152
166
  sig { returns(T.nilable(String)) }
153
167
  attr_reader :name
@@ -157,16 +171,105 @@ module Increase
157
171
 
158
172
  # Details of the corporation entity to update. If you specify this parameter and
159
173
  # the entity is not a corporation, the request will fail.
160
- sig { params(name: String).returns(T.attached_class) }
174
+ sig do
175
+ params(
176
+ address: Increase::EntityUpdateParams::Corporation::Address::OrHash,
177
+ name: String
178
+ ).returns(T.attached_class)
179
+ end
161
180
  def self.new(
181
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
182
+ # are disallowed.
183
+ address: nil,
162
184
  # The legal name of the corporation.
163
185
  name: nil
164
186
  )
165
187
  end
166
188
 
167
- sig { override.returns({ name: String }) }
189
+ sig do
190
+ override.returns(
191
+ {
192
+ address: Increase::EntityUpdateParams::Corporation::Address,
193
+ name: String
194
+ }
195
+ )
196
+ end
168
197
  def to_hash
169
198
  end
199
+
200
+ class Address < Increase::Internal::Type::BaseModel
201
+ OrHash =
202
+ T.type_alias do
203
+ T.any(
204
+ Increase::EntityUpdateParams::Corporation::Address,
205
+ Increase::Internal::AnyHash
206
+ )
207
+ end
208
+
209
+ # The city of the address.
210
+ sig { returns(String) }
211
+ attr_accessor :city
212
+
213
+ # The first line of the address. This is usually the street number and street.
214
+ sig { returns(String) }
215
+ attr_accessor :line1
216
+
217
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
218
+ # the address.
219
+ sig { returns(String) }
220
+ attr_accessor :state
221
+
222
+ # The ZIP code of the address.
223
+ sig { returns(String) }
224
+ attr_accessor :zip
225
+
226
+ # The second line of the address. This might be the floor or room number.
227
+ sig { returns(T.nilable(String)) }
228
+ attr_reader :line2
229
+
230
+ sig { params(line2: String).void }
231
+ attr_writer :line2
232
+
233
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
234
+ # are disallowed.
235
+ sig do
236
+ params(
237
+ city: String,
238
+ line1: String,
239
+ state: String,
240
+ zip: String,
241
+ line2: String
242
+ ).returns(T.attached_class)
243
+ end
244
+ def self.new(
245
+ # The city of the address.
246
+ city:,
247
+ # The first line of the address. This is usually the street number and street.
248
+ line1:,
249
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
250
+ # the address.
251
+ state:,
252
+ # The ZIP code of the address.
253
+ zip:,
254
+ # The second line of the address. This might be the floor or room number.
255
+ line2: nil
256
+ )
257
+ end
258
+
259
+ sig do
260
+ override.returns(
261
+ {
262
+ city: String,
263
+ line1: String,
264
+ state: String,
265
+ zip: String,
266
+ line2: String
267
+ }
268
+ )
269
+ end
270
+ def to_hash
271
+ end
272
+ end
170
273
  end
171
274
 
172
275
  class GovernmentAuthority < Increase::Internal::Type::BaseModel
@@ -178,6 +281,25 @@ module Increase
178
281
  )
179
282
  end
180
283
 
284
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
285
+ # are disallowed.
286
+ sig do
287
+ returns(
288
+ T.nilable(
289
+ Increase::EntityUpdateParams::GovernmentAuthority::Address
290
+ )
291
+ )
292
+ end
293
+ attr_reader :address
294
+
295
+ sig do
296
+ params(
297
+ address:
298
+ Increase::EntityUpdateParams::GovernmentAuthority::Address::OrHash
299
+ ).void
300
+ end
301
+ attr_writer :address
302
+
181
303
  # The legal name of the government authority.
182
304
  sig { returns(T.nilable(String)) }
183
305
  attr_reader :name
@@ -187,16 +309,107 @@ module Increase
187
309
 
188
310
  # Details of the government authority entity to update. If you specify this
189
311
  # parameter and the entity is not a government authority, the request will fail.
190
- sig { params(name: String).returns(T.attached_class) }
312
+ sig do
313
+ params(
314
+ address:
315
+ Increase::EntityUpdateParams::GovernmentAuthority::Address::OrHash,
316
+ name: String
317
+ ).returns(T.attached_class)
318
+ end
191
319
  def self.new(
320
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
321
+ # are disallowed.
322
+ address: nil,
192
323
  # The legal name of the government authority.
193
324
  name: nil
194
325
  )
195
326
  end
196
327
 
197
- sig { override.returns({ name: String }) }
328
+ sig do
329
+ override.returns(
330
+ {
331
+ address:
332
+ Increase::EntityUpdateParams::GovernmentAuthority::Address,
333
+ name: String
334
+ }
335
+ )
336
+ end
198
337
  def to_hash
199
338
  end
339
+
340
+ class Address < Increase::Internal::Type::BaseModel
341
+ OrHash =
342
+ T.type_alias do
343
+ T.any(
344
+ Increase::EntityUpdateParams::GovernmentAuthority::Address,
345
+ Increase::Internal::AnyHash
346
+ )
347
+ end
348
+
349
+ # The city of the address.
350
+ sig { returns(String) }
351
+ attr_accessor :city
352
+
353
+ # The first line of the address. This is usually the street number and street.
354
+ sig { returns(String) }
355
+ attr_accessor :line1
356
+
357
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
358
+ # the address.
359
+ sig { returns(String) }
360
+ attr_accessor :state
361
+
362
+ # The ZIP code of the address.
363
+ sig { returns(String) }
364
+ attr_accessor :zip
365
+
366
+ # The second line of the address. This might be the floor or room number.
367
+ sig { returns(T.nilable(String)) }
368
+ attr_reader :line2
369
+
370
+ sig { params(line2: String).void }
371
+ attr_writer :line2
372
+
373
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
374
+ # are disallowed.
375
+ sig do
376
+ params(
377
+ city: String,
378
+ line1: String,
379
+ state: String,
380
+ zip: String,
381
+ line2: String
382
+ ).returns(T.attached_class)
383
+ end
384
+ def self.new(
385
+ # The city of the address.
386
+ city:,
387
+ # The first line of the address. This is usually the street number and street.
388
+ line1:,
389
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
390
+ # the address.
391
+ state:,
392
+ # The ZIP code of the address.
393
+ zip:,
394
+ # The second line of the address. This might be the floor or room number.
395
+ line2: nil
396
+ )
397
+ end
398
+
399
+ sig do
400
+ override.returns(
401
+ {
402
+ city: String,
403
+ line1: String,
404
+ state: String,
405
+ zip: String,
406
+ line2: String
407
+ }
408
+ )
409
+ end
410
+ def to_hash
411
+ end
412
+ end
200
413
  end
201
414
 
202
415
  class NaturalPerson < Increase::Internal::Type::BaseModel
@@ -208,6 +421,23 @@ module Increase
208
421
  )
209
422
  end
210
423
 
424
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
425
+ # are disallowed.
426
+ sig do
427
+ returns(
428
+ T.nilable(Increase::EntityUpdateParams::NaturalPerson::Address)
429
+ )
430
+ end
431
+ attr_reader :address
432
+
433
+ sig do
434
+ params(
435
+ address:
436
+ Increase::EntityUpdateParams::NaturalPerson::Address::OrHash
437
+ ).void
438
+ end
439
+ attr_writer :address
440
+
211
441
  # The legal name of the natural person.
212
442
  sig { returns(T.nilable(String)) }
213
443
  attr_reader :name
@@ -217,16 +447,106 @@ module Increase
217
447
 
218
448
  # Details of the natural person entity to update. If you specify this parameter
219
449
  # and the entity is not a natural person, the request will fail.
220
- sig { params(name: String).returns(T.attached_class) }
450
+ sig do
451
+ params(
452
+ address:
453
+ Increase::EntityUpdateParams::NaturalPerson::Address::OrHash,
454
+ name: String
455
+ ).returns(T.attached_class)
456
+ end
221
457
  def self.new(
458
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
459
+ # are disallowed.
460
+ address: nil,
222
461
  # The legal name of the natural person.
223
462
  name: nil
224
463
  )
225
464
  end
226
465
 
227
- sig { override.returns({ name: String }) }
466
+ sig do
467
+ override.returns(
468
+ {
469
+ address: Increase::EntityUpdateParams::NaturalPerson::Address,
470
+ name: String
471
+ }
472
+ )
473
+ end
228
474
  def to_hash
229
475
  end
476
+
477
+ class Address < Increase::Internal::Type::BaseModel
478
+ OrHash =
479
+ T.type_alias do
480
+ T.any(
481
+ Increase::EntityUpdateParams::NaturalPerson::Address,
482
+ Increase::Internal::AnyHash
483
+ )
484
+ end
485
+
486
+ # The city of the address.
487
+ sig { returns(String) }
488
+ attr_accessor :city
489
+
490
+ # The first line of the address. This is usually the street number and street.
491
+ sig { returns(String) }
492
+ attr_accessor :line1
493
+
494
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
495
+ # the address.
496
+ sig { returns(String) }
497
+ attr_accessor :state
498
+
499
+ # The ZIP code of the address.
500
+ sig { returns(String) }
501
+ attr_accessor :zip
502
+
503
+ # The second line of the address. This might be the floor or room number.
504
+ sig { returns(T.nilable(String)) }
505
+ attr_reader :line2
506
+
507
+ sig { params(line2: String).void }
508
+ attr_writer :line2
509
+
510
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
511
+ # are disallowed.
512
+ sig do
513
+ params(
514
+ city: String,
515
+ line1: String,
516
+ state: String,
517
+ zip: String,
518
+ line2: String
519
+ ).returns(T.attached_class)
520
+ end
521
+ def self.new(
522
+ # The city of the address.
523
+ city:,
524
+ # The first line of the address. This is usually the street number and street.
525
+ line1:,
526
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
527
+ # the address.
528
+ state:,
529
+ # The ZIP code of the address.
530
+ zip:,
531
+ # The second line of the address. This might be the floor or room number.
532
+ line2: nil
533
+ )
534
+ end
535
+
536
+ sig do
537
+ override.returns(
538
+ {
539
+ city: String,
540
+ line1: String,
541
+ state: String,
542
+ zip: String,
543
+ line2: String
544
+ }
545
+ )
546
+ end
547
+ def to_hash
548
+ end
549
+ end
230
550
  end
231
551
 
232
552
  class RiskRating < Increase::Internal::Type::BaseModel
@@ -425,6 +745,18 @@ module Increase
425
745
  )
426
746
  end
427
747
 
748
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
749
+ # are disallowed.
750
+ sig { returns(T.nilable(Increase::EntityUpdateParams::Trust::Address)) }
751
+ attr_reader :address
752
+
753
+ sig do
754
+ params(
755
+ address: Increase::EntityUpdateParams::Trust::Address::OrHash
756
+ ).void
757
+ end
758
+ attr_writer :address
759
+
428
760
  # The legal name of the trust.
429
761
  sig { returns(T.nilable(String)) }
430
762
  attr_reader :name
@@ -434,16 +766,105 @@ module Increase
434
766
 
435
767
  # Details of the trust entity to update. If you specify this parameter and the
436
768
  # entity is not a trust, the request will fail.
437
- sig { params(name: String).returns(T.attached_class) }
769
+ sig do
770
+ params(
771
+ address: Increase::EntityUpdateParams::Trust::Address::OrHash,
772
+ name: String
773
+ ).returns(T.attached_class)
774
+ end
438
775
  def self.new(
776
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
777
+ # are disallowed.
778
+ address: nil,
439
779
  # The legal name of the trust.
440
780
  name: nil
441
781
  )
442
782
  end
443
783
 
444
- sig { override.returns({ name: String }) }
784
+ sig do
785
+ override.returns(
786
+ {
787
+ address: Increase::EntityUpdateParams::Trust::Address,
788
+ name: String
789
+ }
790
+ )
791
+ end
445
792
  def to_hash
446
793
  end
794
+
795
+ class Address < Increase::Internal::Type::BaseModel
796
+ OrHash =
797
+ T.type_alias do
798
+ T.any(
799
+ Increase::EntityUpdateParams::Trust::Address,
800
+ Increase::Internal::AnyHash
801
+ )
802
+ end
803
+
804
+ # The city of the address.
805
+ sig { returns(String) }
806
+ attr_accessor :city
807
+
808
+ # The first line of the address. This is usually the street number and street.
809
+ sig { returns(String) }
810
+ attr_accessor :line1
811
+
812
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
813
+ # the address.
814
+ sig { returns(String) }
815
+ attr_accessor :state
816
+
817
+ # The ZIP code of the address.
818
+ sig { returns(String) }
819
+ attr_accessor :zip
820
+
821
+ # The second line of the address. This might be the floor or room number.
822
+ sig { returns(T.nilable(String)) }
823
+ attr_reader :line2
824
+
825
+ sig { params(line2: String).void }
826
+ attr_writer :line2
827
+
828
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
829
+ # are disallowed.
830
+ sig do
831
+ params(
832
+ city: String,
833
+ line1: String,
834
+ state: String,
835
+ zip: String,
836
+ line2: String
837
+ ).returns(T.attached_class)
838
+ end
839
+ def self.new(
840
+ # The city of the address.
841
+ city:,
842
+ # The first line of the address. This is usually the street number and street.
843
+ line1:,
844
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
845
+ # the address.
846
+ state:,
847
+ # The ZIP code of the address.
848
+ zip:,
849
+ # The second line of the address. This might be the floor or room number.
850
+ line2: nil
851
+ )
852
+ end
853
+
854
+ sig do
855
+ override.returns(
856
+ {
857
+ city: String,
858
+ line1: String,
859
+ state: String,
860
+ zip: String,
861
+ line2: String
862
+ }
863
+ )
864
+ end
865
+ def to_hash
866
+ end
867
+ end
447
868
  end
448
869
  end
449
870
  end
@@ -34,6 +34,24 @@ module Increase
34
34
  sig { returns(String) }
35
35
  attr_accessor :program_id
36
36
 
37
+ # The color of the text on the back of the card. Defaults to "black".
38
+ sig do
39
+ returns(
40
+ T.nilable(
41
+ Increase::PhysicalCardProfileCreateParams::BackColor::OrSymbol
42
+ )
43
+ )
44
+ end
45
+ attr_reader :back_color
46
+
47
+ sig do
48
+ params(
49
+ back_color:
50
+ Increase::PhysicalCardProfileCreateParams::BackColor::OrSymbol
51
+ ).void
52
+ end
53
+ attr_writer :back_color
54
+
37
55
  # A reference ID provided by the fulfillment provider for the card stock used.
38
56
  # Only used if you've ordered card stock separately.
39
57
  sig { returns(T.nilable(String)) }
@@ -50,6 +68,24 @@ module Increase
50
68
  sig { params(carrier_stock_reference: String).void }
51
69
  attr_writer :carrier_stock_reference
52
70
 
71
+ # The color of the design on the front of the card. Defaults to "black".
72
+ sig do
73
+ returns(
74
+ T.nilable(
75
+ Increase::PhysicalCardProfileCreateParams::FrontColor::OrSymbol
76
+ )
77
+ )
78
+ end
79
+ attr_reader :front_color
80
+
81
+ sig do
82
+ params(
83
+ front_color:
84
+ Increase::PhysicalCardProfileCreateParams::FrontColor::OrSymbol
85
+ ).void
86
+ end
87
+ attr_writer :front_color
88
+
53
89
  # Text printed on the front of the card. Reach out to
54
90
  # [support@increase.com](mailto:support@increase.com) for more information.
55
91
  sig do
@@ -72,8 +108,12 @@ module Increase
72
108
  description: String,
73
109
  front_image_file_id: String,
74
110
  program_id: String,
111
+ back_color:
112
+ Increase::PhysicalCardProfileCreateParams::BackColor::OrSymbol,
75
113
  card_stock_reference: String,
76
114
  carrier_stock_reference: String,
115
+ front_color:
116
+ Increase::PhysicalCardProfileCreateParams::FrontColor::OrSymbol,
77
117
  front_text:
78
118
  Increase::PhysicalCardProfileCreateParams::FrontText::OrHash,
79
119
  request_options: Increase::RequestOptions::OrHash
@@ -90,12 +130,16 @@ module Increase
90
130
  front_image_file_id:,
91
131
  # The identifier for the Program that this Physical Card Profile falls under.
92
132
  program_id:,
133
+ # The color of the text on the back of the card. Defaults to "black".
134
+ back_color: nil,
93
135
  # A reference ID provided by the fulfillment provider for the card stock used.
94
136
  # Only used if you've ordered card stock separately.
95
137
  card_stock_reference: nil,
96
138
  # A reference ID provided by the fulfillment provider for the carrier stock used.
97
139
  # Only used if you've ordered carrier stock separately.
98
140
  carrier_stock_reference: nil,
141
+ # The color of the design on the front of the card. Defaults to "black".
142
+ front_color: nil,
99
143
  # Text printed on the front of the card. Reach out to
100
144
  # [support@increase.com](mailto:support@increase.com) for more information.
101
145
  front_text: nil,
@@ -111,8 +155,12 @@ module Increase
111
155
  description: String,
112
156
  front_image_file_id: String,
113
157
  program_id: String,
158
+ back_color:
159
+ Increase::PhysicalCardProfileCreateParams::BackColor::OrSymbol,
114
160
  card_stock_reference: String,
115
161
  carrier_stock_reference: String,
162
+ front_color:
163
+ Increase::PhysicalCardProfileCreateParams::FrontColor::OrSymbol,
116
164
  front_text: Increase::PhysicalCardProfileCreateParams::FrontText,
117
165
  request_options: Increase::RequestOptions
118
166
  }
@@ -121,6 +169,76 @@ module Increase
121
169
  def to_hash
122
170
  end
123
171
 
172
+ # The color of the text on the back of the card. Defaults to "black".
173
+ module BackColor
174
+ extend Increase::Internal::Type::Enum
175
+
176
+ TaggedSymbol =
177
+ T.type_alias do
178
+ T.all(Symbol, Increase::PhysicalCardProfileCreateParams::BackColor)
179
+ end
180
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
181
+
182
+ # Black personalization color.
183
+ BLACK =
184
+ T.let(
185
+ :black,
186
+ Increase::PhysicalCardProfileCreateParams::BackColor::TaggedSymbol
187
+ )
188
+
189
+ # White personalization color.
190
+ WHITE =
191
+ T.let(
192
+ :white,
193
+ Increase::PhysicalCardProfileCreateParams::BackColor::TaggedSymbol
194
+ )
195
+
196
+ sig do
197
+ override.returns(
198
+ T::Array[
199
+ Increase::PhysicalCardProfileCreateParams::BackColor::TaggedSymbol
200
+ ]
201
+ )
202
+ end
203
+ def self.values
204
+ end
205
+ end
206
+
207
+ # The color of the design on the front of the card. Defaults to "black".
208
+ module FrontColor
209
+ extend Increase::Internal::Type::Enum
210
+
211
+ TaggedSymbol =
212
+ T.type_alias do
213
+ T.all(Symbol, Increase::PhysicalCardProfileCreateParams::FrontColor)
214
+ end
215
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
216
+
217
+ # Black personalization color.
218
+ BLACK =
219
+ T.let(
220
+ :black,
221
+ Increase::PhysicalCardProfileCreateParams::FrontColor::TaggedSymbol
222
+ )
223
+
224
+ # White personalization color.
225
+ WHITE =
226
+ T.let(
227
+ :white,
228
+ Increase::PhysicalCardProfileCreateParams::FrontColor::TaggedSymbol
229
+ )
230
+
231
+ sig do
232
+ override.returns(
233
+ T::Array[
234
+ Increase::PhysicalCardProfileCreateParams::FrontColor::TaggedSymbol
235
+ ]
236
+ )
237
+ end
238
+ def self.values
239
+ end
240
+ end
241
+
124
242
  class FrontText < Increase::Internal::Type::BaseModel
125
243
  OrHash =
126
244
  T.type_alias do