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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9466fcaa09f9ec61d32190bb375d3ab087ed0b65fee544da877b25658b7a5ec6
4
- data.tar.gz: 144ee545505230e27fe0b71489c8b0ea78decc5b2d4973809e44543ac9b9f2d2
3
+ metadata.gz: f9f95f2e0df86506965d6b864cb017e5bb21b21a5090193d20299fa5fbb1398f
4
+ data.tar.gz: 1156d84ed5ed98615c210cc8c75856468dd46ccac281bab298fc28b64d346bd2
5
5
  SHA512:
6
- metadata.gz: f8c2585ab6bb76b8b24496228b16d933f2cb332d25385bfeb6b09576fa3589be92c522e74f3aebe9949fdc13514a395a458e4d61c3cad48fa55d78f7ac9481db
7
- data.tar.gz: e275e7a3f906bb92ccf256065d87f3c570e987a75bc8c5a2a3fa30f53f89f26a1ca70296d9d4eca9af8cb6d77aba94713282ce0e6291c01eab20afedb28b1e83
6
+ metadata.gz: 933efa417990cbdbeea6963256403823d35e5af9ca22fe7d847cf727813a05d045e685e23d4ba29ed67719a3a21e9505acab131b1e5ec88ec969a29ff27a65c4
7
+ data.tar.gz: ba95682b31e3dcbbccba0fee60e65221181b61a45898aa431c1ba5445b7f1665959e71a9abe757e504c3884a50cc875c694c879b3061ad914c34235914b8e7cb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.69.0 (2025-09-08)
4
+
5
+ Full Changelog: [v1.68.0...v1.69.0](https://github.com/Increase/increase-ruby/compare/v1.68.0...v1.69.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([02897b2](https://github.com/Increase/increase-ruby/commit/02897b2a6ead3059648d4be9cde81454c9a35eee))
10
+
11
+ ## 1.68.0 (2025-09-07)
12
+
13
+ Full Changelog: [v1.67.0...v1.68.0](https://github.com/Increase/increase-ruby/compare/v1.67.0...v1.68.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([89e4d03](https://github.com/Increase/increase-ruby/commit/89e4d038f966f4d797cd83249df91a6fb6ee992c))
18
+
3
19
  ## 1.67.0 (2025-09-05)
4
20
 
5
21
  Full Changelog: [v1.66.0...v1.67.0](https://github.com/Increase/increase-ruby/compare/v1.66.0...v1.67.0)
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.67.0"
18
+ gem "increase", "~> 1.69.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -68,45 +68,235 @@ module Increase
68
68
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
69
69
 
70
70
  class Corporation < Increase::Internal::Type::BaseModel
71
+ # @!attribute address
72
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
73
+ # are disallowed.
74
+ #
75
+ # @return [Increase::Models::EntityUpdateParams::Corporation::Address, nil]
76
+ optional :address, -> { Increase::EntityUpdateParams::Corporation::Address }
77
+
71
78
  # @!attribute name
72
79
  # The legal name of the corporation.
73
80
  #
74
81
  # @return [String, nil]
75
82
  optional :name, String
76
83
 
77
- # @!method initialize(name: nil)
84
+ # @!method initialize(address: nil, name: nil)
85
+ # Some parameter documentations has been truncated, see
86
+ # {Increase::Models::EntityUpdateParams::Corporation} for more details.
87
+ #
78
88
  # Details of the corporation entity to update. If you specify this parameter and
79
89
  # the entity is not a corporation, the request will fail.
80
90
  #
91
+ # @param address [Increase::Models::EntityUpdateParams::Corporation::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
92
+ #
81
93
  # @param name [String] The legal name of the corporation.
94
+
95
+ # @see Increase::Models::EntityUpdateParams::Corporation#address
96
+ class Address < Increase::Internal::Type::BaseModel
97
+ # @!attribute city
98
+ # The city of the address.
99
+ #
100
+ # @return [String]
101
+ required :city, String
102
+
103
+ # @!attribute line1
104
+ # The first line of the address. This is usually the street number and street.
105
+ #
106
+ # @return [String]
107
+ required :line1, String
108
+
109
+ # @!attribute state
110
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
111
+ # the address.
112
+ #
113
+ # @return [String]
114
+ required :state, String
115
+
116
+ # @!attribute zip
117
+ # The ZIP code of the address.
118
+ #
119
+ # @return [String]
120
+ required :zip, String
121
+
122
+ # @!attribute line2
123
+ # The second line of the address. This might be the floor or room number.
124
+ #
125
+ # @return [String, nil]
126
+ optional :line2, String
127
+
128
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
129
+ # Some parameter documentations has been truncated, see
130
+ # {Increase::Models::EntityUpdateParams::Corporation::Address} for more details.
131
+ #
132
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
133
+ # are disallowed.
134
+ #
135
+ # @param city [String] The city of the address.
136
+ #
137
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
138
+ #
139
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
140
+ #
141
+ # @param zip [String] The ZIP code of the address.
142
+ #
143
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
144
+ end
82
145
  end
83
146
 
84
147
  class GovernmentAuthority < Increase::Internal::Type::BaseModel
148
+ # @!attribute address
149
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
150
+ # are disallowed.
151
+ #
152
+ # @return [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address, nil]
153
+ optional :address, -> { Increase::EntityUpdateParams::GovernmentAuthority::Address }
154
+
85
155
  # @!attribute name
86
156
  # The legal name of the government authority.
87
157
  #
88
158
  # @return [String, nil]
89
159
  optional :name, String
90
160
 
91
- # @!method initialize(name: nil)
161
+ # @!method initialize(address: nil, name: nil)
162
+ # Some parameter documentations has been truncated, see
163
+ # {Increase::Models::EntityUpdateParams::GovernmentAuthority} for more details.
164
+ #
92
165
  # Details of the government authority entity to update. If you specify this
93
166
  # parameter and the entity is not a government authority, the request will fail.
94
167
  #
168
+ # @param address [Increase::Models::EntityUpdateParams::GovernmentAuthority::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
169
+ #
95
170
  # @param name [String] The legal name of the government authority.
171
+
172
+ # @see Increase::Models::EntityUpdateParams::GovernmentAuthority#address
173
+ class Address < Increase::Internal::Type::BaseModel
174
+ # @!attribute city
175
+ # The city of the address.
176
+ #
177
+ # @return [String]
178
+ required :city, String
179
+
180
+ # @!attribute line1
181
+ # The first line of the address. This is usually the street number and street.
182
+ #
183
+ # @return [String]
184
+ required :line1, String
185
+
186
+ # @!attribute state
187
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
188
+ # the address.
189
+ #
190
+ # @return [String]
191
+ required :state, String
192
+
193
+ # @!attribute zip
194
+ # The ZIP code of the address.
195
+ #
196
+ # @return [String]
197
+ required :zip, String
198
+
199
+ # @!attribute line2
200
+ # The second line of the address. This might be the floor or room number.
201
+ #
202
+ # @return [String, nil]
203
+ optional :line2, String
204
+
205
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
206
+ # Some parameter documentations has been truncated, see
207
+ # {Increase::Models::EntityUpdateParams::GovernmentAuthority::Address} for more
208
+ # details.
209
+ #
210
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
211
+ # are disallowed.
212
+ #
213
+ # @param city [String] The city of the address.
214
+ #
215
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
216
+ #
217
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
218
+ #
219
+ # @param zip [String] The ZIP code of the address.
220
+ #
221
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
222
+ end
96
223
  end
97
224
 
98
225
  class NaturalPerson < Increase::Internal::Type::BaseModel
226
+ # @!attribute address
227
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
228
+ # are disallowed.
229
+ #
230
+ # @return [Increase::Models::EntityUpdateParams::NaturalPerson::Address, nil]
231
+ optional :address, -> { Increase::EntityUpdateParams::NaturalPerson::Address }
232
+
99
233
  # @!attribute name
100
234
  # The legal name of the natural person.
101
235
  #
102
236
  # @return [String, nil]
103
237
  optional :name, String
104
238
 
105
- # @!method initialize(name: nil)
239
+ # @!method initialize(address: nil, name: nil)
240
+ # Some parameter documentations has been truncated, see
241
+ # {Increase::Models::EntityUpdateParams::NaturalPerson} for more details.
242
+ #
106
243
  # Details of the natural person entity to update. If you specify this parameter
107
244
  # and the entity is not a natural person, the request will fail.
108
245
  #
246
+ # @param address [Increase::Models::EntityUpdateParams::NaturalPerson::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
247
+ #
109
248
  # @param name [String] The legal name of the natural person.
249
+
250
+ # @see Increase::Models::EntityUpdateParams::NaturalPerson#address
251
+ class Address < Increase::Internal::Type::BaseModel
252
+ # @!attribute city
253
+ # The city of the address.
254
+ #
255
+ # @return [String]
256
+ required :city, String
257
+
258
+ # @!attribute line1
259
+ # The first line of the address. This is usually the street number and street.
260
+ #
261
+ # @return [String]
262
+ required :line1, String
263
+
264
+ # @!attribute state
265
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
266
+ # the address.
267
+ #
268
+ # @return [String]
269
+ required :state, String
270
+
271
+ # @!attribute zip
272
+ # The ZIP code of the address.
273
+ #
274
+ # @return [String]
275
+ required :zip, String
276
+
277
+ # @!attribute line2
278
+ # The second line of the address. This might be the floor or room number.
279
+ #
280
+ # @return [String, nil]
281
+ optional :line2, String
282
+
283
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
284
+ # Some parameter documentations has been truncated, see
285
+ # {Increase::Models::EntityUpdateParams::NaturalPerson::Address} for more details.
286
+ #
287
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
288
+ # are disallowed.
289
+ #
290
+ # @param city [String] The city of the address.
291
+ #
292
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
293
+ #
294
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
295
+ #
296
+ # @param zip [String] The ZIP code of the address.
297
+ #
298
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
299
+ end
110
300
  end
111
301
 
112
302
  class RiskRating < Increase::Internal::Type::BaseModel
@@ -196,17 +386,80 @@ module Increase
196
386
  end
197
387
 
198
388
  class Trust < Increase::Internal::Type::BaseModel
389
+ # @!attribute address
390
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
391
+ # are disallowed.
392
+ #
393
+ # @return [Increase::Models::EntityUpdateParams::Trust::Address, nil]
394
+ optional :address, -> { Increase::EntityUpdateParams::Trust::Address }
395
+
199
396
  # @!attribute name
200
397
  # The legal name of the trust.
201
398
  #
202
399
  # @return [String, nil]
203
400
  optional :name, String
204
401
 
205
- # @!method initialize(name: nil)
402
+ # @!method initialize(address: nil, name: nil)
403
+ # Some parameter documentations has been truncated, see
404
+ # {Increase::Models::EntityUpdateParams::Trust} for more details.
405
+ #
206
406
  # Details of the trust entity to update. If you specify this parameter and the
207
407
  # entity is not a trust, the request will fail.
208
408
  #
409
+ # @param address [Increase::Models::EntityUpdateParams::Trust::Address] The entity's physical address. Mail receiving locations like PO Boxes and PMB's
410
+ #
209
411
  # @param name [String] The legal name of the trust.
412
+
413
+ # @see Increase::Models::EntityUpdateParams::Trust#address
414
+ class Address < Increase::Internal::Type::BaseModel
415
+ # @!attribute city
416
+ # The city of the address.
417
+ #
418
+ # @return [String]
419
+ required :city, String
420
+
421
+ # @!attribute line1
422
+ # The first line of the address. This is usually the street number and street.
423
+ #
424
+ # @return [String]
425
+ required :line1, String
426
+
427
+ # @!attribute state
428
+ # The two-letter United States Postal Service (USPS) abbreviation for the state of
429
+ # the address.
430
+ #
431
+ # @return [String]
432
+ required :state, String
433
+
434
+ # @!attribute zip
435
+ # The ZIP code of the address.
436
+ #
437
+ # @return [String]
438
+ required :zip, String
439
+
440
+ # @!attribute line2
441
+ # The second line of the address. This might be the floor or room number.
442
+ #
443
+ # @return [String, nil]
444
+ optional :line2, String
445
+
446
+ # @!method initialize(city:, line1:, state:, zip:, line2: nil)
447
+ # Some parameter documentations has been truncated, see
448
+ # {Increase::Models::EntityUpdateParams::Trust::Address} for more details.
449
+ #
450
+ # The entity's physical address. Mail receiving locations like PO Boxes and PMB's
451
+ # are disallowed.
452
+ #
453
+ # @param city [String] The city of the address.
454
+ #
455
+ # @param line1 [String] The first line of the address. This is usually the street number and street.
456
+ #
457
+ # @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
458
+ #
459
+ # @param zip [String] The ZIP code of the address.
460
+ #
461
+ # @param line2 [String] The second line of the address. This might be the floor or room number.
462
+ end
210
463
  end
211
464
  end
212
465
  end
@@ -37,6 +37,12 @@ module Increase
37
37
  # @return [String]
38
38
  required :program_id, String
39
39
 
40
+ # @!attribute back_color
41
+ # The color of the text on the back of the card. Defaults to "black".
42
+ #
43
+ # @return [Symbol, Increase::Models::PhysicalCardProfileCreateParams::BackColor, nil]
44
+ optional :back_color, enum: -> { Increase::PhysicalCardProfileCreateParams::BackColor }
45
+
40
46
  # @!attribute card_stock_reference
41
47
  # A reference ID provided by the fulfillment provider for the card stock used.
42
48
  # Only used if you've ordered card stock separately.
@@ -51,6 +57,12 @@ module Increase
51
57
  # @return [String, nil]
52
58
  optional :carrier_stock_reference, String
53
59
 
60
+ # @!attribute front_color
61
+ # The color of the design on the front of the card. Defaults to "black".
62
+ #
63
+ # @return [Symbol, Increase::Models::PhysicalCardProfileCreateParams::FrontColor, nil]
64
+ optional :front_color, enum: -> { Increase::PhysicalCardProfileCreateParams::FrontColor }
65
+
54
66
  # @!attribute front_text
55
67
  # Text printed on the front of the card. Reach out to
56
68
  # [support@increase.com](mailto:support@increase.com) for more information.
@@ -58,7 +70,7 @@ module Increase
58
70
  # @return [Increase::Models::PhysicalCardProfileCreateParams::FrontText, nil]
59
71
  optional :front_text, -> { Increase::PhysicalCardProfileCreateParams::FrontText }
60
72
 
61
- # @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, card_stock_reference: nil, carrier_stock_reference: nil, front_text: nil, request_options: {})
73
+ # @!method initialize(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, back_color: nil, card_stock_reference: nil, carrier_stock_reference: nil, front_color: nil, front_text: nil, request_options: {})
62
74
  # Some parameter documentations has been truncated, see
63
75
  # {Increase::Models::PhysicalCardProfileCreateParams} for more details.
64
76
  #
@@ -72,14 +84,46 @@ module Increase
72
84
  #
73
85
  # @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
74
86
  #
87
+ # @param back_color [Symbol, Increase::Models::PhysicalCardProfileCreateParams::BackColor] The color of the text on the back of the card. Defaults to "black".
88
+ #
75
89
  # @param card_stock_reference [String] A reference ID provided by the fulfillment provider for the card stock used. Onl
76
90
  #
77
91
  # @param carrier_stock_reference [String] A reference ID provided by the fulfillment provider for the carrier stock used.
78
92
  #
93
+ # @param front_color [Symbol, Increase::Models::PhysicalCardProfileCreateParams::FrontColor] The color of the design on the front of the card. Defaults to "black".
94
+ #
79
95
  # @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt
80
96
  #
81
97
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
82
98
 
99
+ # The color of the text on the back of the card. Defaults to "black".
100
+ module BackColor
101
+ extend Increase::Internal::Type::Enum
102
+
103
+ # Black personalization color.
104
+ BLACK = :black
105
+
106
+ # White personalization color.
107
+ WHITE = :white
108
+
109
+ # @!method self.values
110
+ # @return [Array<Symbol>]
111
+ end
112
+
113
+ # The color of the design on the front of the card. Defaults to "black".
114
+ module FrontColor
115
+ extend Increase::Internal::Type::Enum
116
+
117
+ # Black personalization color.
118
+ BLACK = :black
119
+
120
+ # White personalization color.
121
+ WHITE = :white
122
+
123
+ # @!method self.values
124
+ # @return [Array<Symbol>]
125
+ end
126
+
83
127
  class FrontText < Increase::Internal::Type::BaseModel
84
128
  # @!attribute line1
85
129
  # The first line of text on the front of the card.
@@ -8,7 +8,7 @@ module Increase
8
8
  #
9
9
  # Create a Physical Card Profile
10
10
  #
11
- # @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, card_stock_reference: nil, carrier_stock_reference: nil, front_text: nil, request_options: {})
11
+ # @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, back_color: nil, card_stock_reference: nil, carrier_stock_reference: nil, front_color: nil, front_text: nil, request_options: {})
12
12
  #
13
13
  # @param carrier_image_file_id [String] The identifier of the File containing the physical card's carrier image.
14
14
  #
@@ -20,10 +20,14 @@ module Increase
20
20
  #
21
21
  # @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
22
22
  #
23
+ # @param back_color [Symbol, Increase::Models::PhysicalCardProfileCreateParams::BackColor] The color of the text on the back of the card. Defaults to "black".
24
+ #
23
25
  # @param card_stock_reference [String] A reference ID provided by the fulfillment provider for the card stock used. Onl
24
26
  #
25
27
  # @param carrier_stock_reference [String] A reference ID provided by the fulfillment provider for the carrier stock used.
26
28
  #
29
+ # @param front_color [Symbol, Increase::Models::PhysicalCardProfileCreateParams::FrontColor] The color of the design on the front of the card. Defaults to "black".
30
+ #
27
31
  # @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText] Text printed on the front of the card. Reach out to [support@increase.com](mailt
28
32
  #
29
33
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.67.0"
4
+ VERSION = "1.69.0"
5
5
  end