brand.dev 1.1.0 → 1.2.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.
@@ -42,42 +42,42 @@ module BrandDev
42
42
  # @!attribute colors
43
43
  # Primary colors used on the website
44
44
  #
45
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, nil]
46
- optional :colors, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors }
45
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors]
46
+ required :colors, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors }
47
47
 
48
48
  # @!attribute components
49
49
  # UI component styles
50
50
  #
51
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, nil]
52
- optional :components, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components }
51
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components]
52
+ required :components, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components }
53
53
 
54
54
  # @!attribute element_spacing
55
55
  # Spacing system used on the website
56
56
  #
57
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, nil]
58
- optional :element_spacing,
57
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing]
58
+ required :element_spacing,
59
59
  -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing },
60
60
  api_name: :elementSpacing
61
61
 
62
62
  # @!attribute mode
63
63
  # The primary color mode of the website design
64
64
  #
65
- # @return [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode, nil]
66
- optional :mode, enum: -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode }
65
+ # @return [Symbol, BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode]
66
+ required :mode, enum: -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Mode }
67
67
 
68
68
  # @!attribute shadows
69
69
  # Shadow styles used on the website
70
70
  #
71
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, nil]
72
- optional :shadows, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows }
71
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows]
72
+ required :shadows, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows }
73
73
 
74
74
  # @!attribute typography
75
75
  # Typography styles used on the website
76
76
  #
77
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography, nil]
78
- optional :typography, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography }
77
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography]
78
+ required :typography, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography }
79
79
 
80
- # @!method initialize(colors: nil, components: nil, element_spacing: nil, mode: nil, shadows: nil, typography: nil)
80
+ # @!method initialize(colors:, components:, element_spacing:, mode:, shadows:, typography:)
81
81
  # Comprehensive styleguide data extracted from the website
82
82
  #
83
83
  # @param colors [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors] Primary colors used on the website
@@ -95,31 +95,31 @@ module BrandDev
95
95
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#colors
96
96
  class Colors < BrandDev::Internal::Type::BaseModel
97
97
  # @!attribute accent
98
- # Accent color of the website (hex format)
98
+ # Accent color (hex format)
99
99
  #
100
- # @return [String, nil]
101
- optional :accent, String
100
+ # @return [String]
101
+ required :accent, String
102
102
 
103
103
  # @!attribute background
104
- # Background color of the website (hex format)
104
+ # Background color (hex format)
105
105
  #
106
- # @return [String, nil]
107
- optional :background, String
106
+ # @return [String]
107
+ required :background, String
108
108
 
109
109
  # @!attribute text
110
- # Text color of the website (hex format)
110
+ # Text color (hex format)
111
111
  #
112
- # @return [String, nil]
113
- optional :text, String
112
+ # @return [String]
113
+ required :text, String
114
114
 
115
- # @!method initialize(accent: nil, background: nil, text: nil)
115
+ # @!method initialize(accent:, background:, text:)
116
116
  # Primary colors used on the website
117
117
  #
118
- # @param accent [String] Accent color of the website (hex format)
118
+ # @param accent [String] Accent color (hex format)
119
119
  #
120
- # @param background [String] Background color of the website (hex format)
120
+ # @param background [String] Background color (hex format)
121
121
  #
122
- # @param text [String] Text color of the website (hex format)
122
+ # @param text [String] Text color (hex format)
123
123
  end
124
124
 
125
125
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#components
@@ -127,8 +127,8 @@ module BrandDev
127
127
  # @!attribute button
128
128
  # Button component styles
129
129
  #
130
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, nil]
131
- optional :button, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button }
130
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button]
131
+ required :button, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button }
132
132
 
133
133
  # @!attribute card
134
134
  # Card component style
@@ -136,7 +136,7 @@ module BrandDev
136
136
  # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, nil]
137
137
  optional :card, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card }
138
138
 
139
- # @!method initialize(button: nil, card: nil)
139
+ # @!method initialize(button:, card: nil)
140
140
  # UI component styles
141
141
  #
142
142
  # @param button [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button] Button component styles
@@ -146,20 +146,17 @@ module BrandDev
146
146
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components#button
147
147
  class Button < BrandDev::Internal::Type::BaseModel
148
148
  # @!attribute link
149
- # Link button style
150
149
  #
151
150
  # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, nil]
152
151
  optional :link, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link }
153
152
 
154
153
  # @!attribute primary
155
- # Primary button style
156
154
  #
157
155
  # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, nil]
158
156
  optional :primary,
159
157
  -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary }
160
158
 
161
159
  # @!attribute secondary
162
- # Secondary button style
163
160
  #
164
161
  # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, nil]
165
162
  optional :secondary,
@@ -168,229 +165,416 @@ module BrandDev
168
165
  # @!method initialize(link: nil, primary: nil, secondary: nil)
169
166
  # Button component styles
170
167
  #
171
- # @param link [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link] Link button style
172
- #
173
- # @param primary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary] Primary button style
174
- #
175
- # @param secondary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary] Secondary button style
168
+ # @param link [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link]
169
+ # @param primary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary]
170
+ # @param secondary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary]
176
171
 
177
172
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#link
178
173
  class Link < BrandDev::Internal::Type::BaseModel
179
174
  # @!attribute background_color
180
175
  #
181
- # @return [String, nil]
182
- optional :background_color, String, api_name: :backgroundColor
176
+ # @return [String]
177
+ required :background_color, String, api_name: :backgroundColor
183
178
 
184
179
  # @!attribute border_color
180
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
181
+ # alpha)
185
182
  #
186
- # @return [String, nil]
187
- optional :border_color, String, api_name: :borderColor
183
+ # @return [String]
184
+ required :border_color, String, api_name: :borderColor
188
185
 
189
186
  # @!attribute border_radius
190
187
  #
191
- # @return [String, nil]
192
- optional :border_radius, String, api_name: :borderRadius
188
+ # @return [String]
189
+ required :border_radius, String, api_name: :borderRadius
193
190
 
194
191
  # @!attribute border_style
195
192
  #
196
- # @return [String, nil]
197
- optional :border_style, String, api_name: :borderStyle
193
+ # @return [String]
194
+ required :border_style, String, api_name: :borderStyle
198
195
 
199
196
  # @!attribute border_width
200
197
  #
201
- # @return [String, nil]
202
- optional :border_width, String, api_name: :borderWidth
198
+ # @return [String]
199
+ required :border_width, String, api_name: :borderWidth
203
200
 
204
201
  # @!attribute box_shadow
202
+ # Computed box-shadow (comma-separated layers when present)
205
203
  #
206
- # @return [String, nil]
207
- optional :box_shadow, String, api_name: :boxShadow
204
+ # @return [String]
205
+ required :box_shadow, String, api_name: :boxShadow
208
206
 
209
207
  # @!attribute color
210
208
  #
211
- # @return [String, nil]
212
- optional :color, String
209
+ # @return [String]
210
+ required :color, String
211
+
212
+ # @!attribute css
213
+ # Ready-to-use CSS declaration block for this component style
214
+ #
215
+ # @return [String]
216
+ required :css, String
213
217
 
214
218
  # @!attribute font_size
215
219
  #
216
- # @return [String, nil]
217
- optional :font_size, String, api_name: :fontSize
220
+ # @return [String]
221
+ required :font_size, String, api_name: :fontSize
218
222
 
219
223
  # @!attribute font_weight
220
224
  #
221
- # @return [Float, nil]
222
- optional :font_weight, Float, api_name: :fontWeight
225
+ # @return [Float]
226
+ required :font_weight, Float, api_name: :fontWeight
227
+
228
+ # @!attribute min_height
229
+ # Sampled minimum height of the button box (typically px)
230
+ #
231
+ # @return [String]
232
+ required :min_height, String, api_name: :minHeight
233
+
234
+ # @!attribute min_width
235
+ # Sampled minimum width of the button box (typically px)
236
+ #
237
+ # @return [String]
238
+ required :min_width, String, api_name: :minWidth
223
239
 
224
240
  # @!attribute padding
225
241
  #
226
- # @return [String, nil]
227
- optional :padding, String
242
+ # @return [String]
243
+ required :padding, String
228
244
 
229
245
  # @!attribute text_decoration
230
246
  #
247
+ # @return [String]
248
+ required :text_decoration, String, api_name: :textDecoration
249
+
250
+ # @!attribute font_fallbacks
251
+ # Full ordered font list from computed font-family
252
+ #
253
+ # @return [Array<String>, nil]
254
+ optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
255
+
256
+ # @!attribute font_family
257
+ # Primary button typeface (first in fontFallbacks)
258
+ #
231
259
  # @return [String, nil]
232
- optional :text_decoration, String, api_name: :textDecoration
260
+ optional :font_family, String, api_name: :fontFamily
233
261
 
234
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
235
- # Link button style
262
+ # @!attribute text_decoration_color
263
+ # Hex color of the underline when it differs from the text color
264
+ #
265
+ # @return [String, nil]
266
+ optional :text_decoration_color, String, api_name: :textDecorationColor
267
+
268
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
269
+ # Some parameter documentations has been truncated, see
270
+ # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link}
271
+ # for more details.
236
272
  #
237
273
  # @param background_color [String]
238
- # @param border_color [String]
274
+ #
275
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
276
+ #
239
277
  # @param border_radius [String]
278
+ #
240
279
  # @param border_style [String]
280
+ #
241
281
  # @param border_width [String]
242
- # @param box_shadow [String]
282
+ #
283
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
284
+ #
243
285
  # @param color [String]
286
+ #
287
+ # @param css [String] Ready-to-use CSS declaration block for this component style
288
+ #
244
289
  # @param font_size [String]
290
+ #
245
291
  # @param font_weight [Float]
292
+ #
293
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
294
+ #
295
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
296
+ #
246
297
  # @param padding [String]
298
+ #
247
299
  # @param text_decoration [String]
300
+ #
301
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
302
+ #
303
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
304
+ #
305
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
248
306
  end
249
307
 
250
308
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#primary
251
309
  class Primary < BrandDev::Internal::Type::BaseModel
252
310
  # @!attribute background_color
253
311
  #
254
- # @return [String, nil]
255
- optional :background_color, String, api_name: :backgroundColor
312
+ # @return [String]
313
+ required :background_color, String, api_name: :backgroundColor
256
314
 
257
315
  # @!attribute border_color
316
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
317
+ # alpha)
258
318
  #
259
- # @return [String, nil]
260
- optional :border_color, String, api_name: :borderColor
319
+ # @return [String]
320
+ required :border_color, String, api_name: :borderColor
261
321
 
262
322
  # @!attribute border_radius
263
323
  #
264
- # @return [String, nil]
265
- optional :border_radius, String, api_name: :borderRadius
324
+ # @return [String]
325
+ required :border_radius, String, api_name: :borderRadius
266
326
 
267
327
  # @!attribute border_style
268
328
  #
269
- # @return [String, nil]
270
- optional :border_style, String, api_name: :borderStyle
329
+ # @return [String]
330
+ required :border_style, String, api_name: :borderStyle
271
331
 
272
332
  # @!attribute border_width
273
333
  #
274
- # @return [String, nil]
275
- optional :border_width, String, api_name: :borderWidth
334
+ # @return [String]
335
+ required :border_width, String, api_name: :borderWidth
276
336
 
277
337
  # @!attribute box_shadow
338
+ # Computed box-shadow (comma-separated layers when present)
278
339
  #
279
- # @return [String, nil]
280
- optional :box_shadow, String, api_name: :boxShadow
340
+ # @return [String]
341
+ required :box_shadow, String, api_name: :boxShadow
281
342
 
282
343
  # @!attribute color
283
344
  #
284
- # @return [String, nil]
285
- optional :color, String
345
+ # @return [String]
346
+ required :color, String
347
+
348
+ # @!attribute css
349
+ # Ready-to-use CSS declaration block for this component style
350
+ #
351
+ # @return [String]
352
+ required :css, String
286
353
 
287
354
  # @!attribute font_size
288
355
  #
289
- # @return [String, nil]
290
- optional :font_size, String, api_name: :fontSize
356
+ # @return [String]
357
+ required :font_size, String, api_name: :fontSize
291
358
 
292
359
  # @!attribute font_weight
293
360
  #
294
- # @return [Float, nil]
295
- optional :font_weight, Float, api_name: :fontWeight
361
+ # @return [Float]
362
+ required :font_weight, Float, api_name: :fontWeight
363
+
364
+ # @!attribute min_height
365
+ # Sampled minimum height of the button box (typically px)
366
+ #
367
+ # @return [String]
368
+ required :min_height, String, api_name: :minHeight
369
+
370
+ # @!attribute min_width
371
+ # Sampled minimum width of the button box (typically px)
372
+ #
373
+ # @return [String]
374
+ required :min_width, String, api_name: :minWidth
296
375
 
297
376
  # @!attribute padding
298
377
  #
299
- # @return [String, nil]
300
- optional :padding, String
378
+ # @return [String]
379
+ required :padding, String
301
380
 
302
381
  # @!attribute text_decoration
303
382
  #
383
+ # @return [String]
384
+ required :text_decoration, String, api_name: :textDecoration
385
+
386
+ # @!attribute font_fallbacks
387
+ # Full ordered font list from computed font-family
388
+ #
389
+ # @return [Array<String>, nil]
390
+ optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
391
+
392
+ # @!attribute font_family
393
+ # Primary button typeface (first in fontFallbacks)
394
+ #
304
395
  # @return [String, nil]
305
- optional :text_decoration, String, api_name: :textDecoration
396
+ optional :font_family, String, api_name: :fontFamily
397
+
398
+ # @!attribute text_decoration_color
399
+ # Hex color of the underline when it differs from the text color
400
+ #
401
+ # @return [String, nil]
402
+ optional :text_decoration_color, String, api_name: :textDecorationColor
306
403
 
307
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
308
- # Primary button style
404
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
405
+ # Some parameter documentations has been truncated, see
406
+ # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary}
407
+ # for more details.
309
408
  #
310
409
  # @param background_color [String]
311
- # @param border_color [String]
410
+ #
411
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
412
+ #
312
413
  # @param border_radius [String]
414
+ #
313
415
  # @param border_style [String]
416
+ #
314
417
  # @param border_width [String]
315
- # @param box_shadow [String]
418
+ #
419
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
420
+ #
316
421
  # @param color [String]
422
+ #
423
+ # @param css [String] Ready-to-use CSS declaration block for this component style
424
+ #
317
425
  # @param font_size [String]
426
+ #
318
427
  # @param font_weight [Float]
428
+ #
429
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
430
+ #
431
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
432
+ #
319
433
  # @param padding [String]
434
+ #
320
435
  # @param text_decoration [String]
436
+ #
437
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
438
+ #
439
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
440
+ #
441
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
321
442
  end
322
443
 
323
444
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#secondary
324
445
  class Secondary < BrandDev::Internal::Type::BaseModel
325
446
  # @!attribute background_color
326
447
  #
327
- # @return [String, nil]
328
- optional :background_color, String, api_name: :backgroundColor
448
+ # @return [String]
449
+ required :background_color, String, api_name: :backgroundColor
329
450
 
330
451
  # @!attribute border_color
452
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
453
+ # alpha)
331
454
  #
332
- # @return [String, nil]
333
- optional :border_color, String, api_name: :borderColor
455
+ # @return [String]
456
+ required :border_color, String, api_name: :borderColor
334
457
 
335
458
  # @!attribute border_radius
336
459
  #
337
- # @return [String, nil]
338
- optional :border_radius, String, api_name: :borderRadius
460
+ # @return [String]
461
+ required :border_radius, String, api_name: :borderRadius
339
462
 
340
463
  # @!attribute border_style
341
464
  #
342
- # @return [String, nil]
343
- optional :border_style, String, api_name: :borderStyle
465
+ # @return [String]
466
+ required :border_style, String, api_name: :borderStyle
344
467
 
345
468
  # @!attribute border_width
346
469
  #
347
- # @return [String, nil]
348
- optional :border_width, String, api_name: :borderWidth
470
+ # @return [String]
471
+ required :border_width, String, api_name: :borderWidth
349
472
 
350
473
  # @!attribute box_shadow
474
+ # Computed box-shadow (comma-separated layers when present)
351
475
  #
352
- # @return [String, nil]
353
- optional :box_shadow, String, api_name: :boxShadow
476
+ # @return [String]
477
+ required :box_shadow, String, api_name: :boxShadow
354
478
 
355
479
  # @!attribute color
356
480
  #
357
- # @return [String, nil]
358
- optional :color, String
481
+ # @return [String]
482
+ required :color, String
483
+
484
+ # @!attribute css
485
+ # Ready-to-use CSS declaration block for this component style
486
+ #
487
+ # @return [String]
488
+ required :css, String
359
489
 
360
490
  # @!attribute font_size
361
491
  #
362
- # @return [String, nil]
363
- optional :font_size, String, api_name: :fontSize
492
+ # @return [String]
493
+ required :font_size, String, api_name: :fontSize
364
494
 
365
495
  # @!attribute font_weight
366
496
  #
367
- # @return [Float, nil]
368
- optional :font_weight, Float, api_name: :fontWeight
497
+ # @return [Float]
498
+ required :font_weight, Float, api_name: :fontWeight
499
+
500
+ # @!attribute min_height
501
+ # Sampled minimum height of the button box (typically px)
502
+ #
503
+ # @return [String]
504
+ required :min_height, String, api_name: :minHeight
505
+
506
+ # @!attribute min_width
507
+ # Sampled minimum width of the button box (typically px)
508
+ #
509
+ # @return [String]
510
+ required :min_width, String, api_name: :minWidth
369
511
 
370
512
  # @!attribute padding
371
513
  #
372
- # @return [String, nil]
373
- optional :padding, String
514
+ # @return [String]
515
+ required :padding, String
374
516
 
375
517
  # @!attribute text_decoration
376
518
  #
519
+ # @return [String]
520
+ required :text_decoration, String, api_name: :textDecoration
521
+
522
+ # @!attribute font_fallbacks
523
+ # Full ordered font list from computed font-family
524
+ #
525
+ # @return [Array<String>, nil]
526
+ optional :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
527
+
528
+ # @!attribute font_family
529
+ # Primary button typeface (first in fontFallbacks)
530
+ #
377
531
  # @return [String, nil]
378
- optional :text_decoration, String, api_name: :textDecoration
532
+ optional :font_family, String, api_name: :fontFamily
379
533
 
380
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, color: nil, font_size: nil, font_weight: nil, padding: nil, text_decoration: nil)
381
- # Secondary button style
534
+ # @!attribute text_decoration_color
535
+ # Hex color of the underline when it differs from the text color
536
+ #
537
+ # @return [String, nil]
538
+ optional :text_decoration_color, String, api_name: :textDecorationColor
539
+
540
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
541
+ # Some parameter documentations has been truncated, see
542
+ # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary}
543
+ # for more details.
382
544
  #
383
545
  # @param background_color [String]
384
- # @param border_color [String]
546
+ #
547
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
548
+ #
385
549
  # @param border_radius [String]
550
+ #
386
551
  # @param border_style [String]
552
+ #
387
553
  # @param border_width [String]
388
- # @param box_shadow [String]
554
+ #
555
+ # @param box_shadow [String] Computed box-shadow (comma-separated layers when present)
556
+ #
389
557
  # @param color [String]
558
+ #
559
+ # @param css [String] Ready-to-use CSS declaration block for this component style
560
+ #
390
561
  # @param font_size [String]
562
+ #
391
563
  # @param font_weight [Float]
564
+ #
565
+ # @param min_height [String] Sampled minimum height of the button box (typically px)
566
+ #
567
+ # @param min_width [String] Sampled minimum width of the button box (typically px)
568
+ #
392
569
  # @param padding [String]
570
+ #
393
571
  # @param text_decoration [String]
572
+ #
573
+ # @param font_fallbacks [Array<String>] Full ordered font list from computed font-family
574
+ #
575
+ # @param font_family [String] Primary button typeface (first in fontFallbacks)
576
+ #
577
+ # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
394
578
  end
395
579
  end
396
580
 
@@ -398,54 +582,75 @@ module BrandDev
398
582
  class Card < BrandDev::Internal::Type::BaseModel
399
583
  # @!attribute background_color
400
584
  #
401
- # @return [String, nil]
402
- optional :background_color, String, api_name: :backgroundColor
585
+ # @return [String]
586
+ required :background_color, String, api_name: :backgroundColor
403
587
 
404
588
  # @!attribute border_color
589
+ # Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has
590
+ # alpha)
405
591
  #
406
- # @return [String, nil]
407
- optional :border_color, String, api_name: :borderColor
592
+ # @return [String]
593
+ required :border_color, String, api_name: :borderColor
408
594
 
409
595
  # @!attribute border_radius
410
596
  #
411
- # @return [String, nil]
412
- optional :border_radius, String, api_name: :borderRadius
597
+ # @return [String]
598
+ required :border_radius, String, api_name: :borderRadius
413
599
 
414
600
  # @!attribute border_style
415
601
  #
416
- # @return [String, nil]
417
- optional :border_style, String, api_name: :borderStyle
602
+ # @return [String]
603
+ required :border_style, String, api_name: :borderStyle
418
604
 
419
605
  # @!attribute border_width
420
606
  #
421
- # @return [String, nil]
422
- optional :border_width, String, api_name: :borderWidth
607
+ # @return [String]
608
+ required :border_width, String, api_name: :borderWidth
423
609
 
424
610
  # @!attribute box_shadow
425
611
  #
426
- # @return [String, nil]
427
- optional :box_shadow, String, api_name: :boxShadow
612
+ # @return [String]
613
+ required :box_shadow, String, api_name: :boxShadow
614
+
615
+ # @!attribute css
616
+ # Ready-to-use CSS declaration block for this component style
617
+ #
618
+ # @return [String]
619
+ required :css, String
428
620
 
429
621
  # @!attribute padding
430
622
  #
431
- # @return [String, nil]
432
- optional :padding, String
623
+ # @return [String]
624
+ required :padding, String
433
625
 
434
626
  # @!attribute text_color
435
627
  #
436
- # @return [String, nil]
437
- optional :text_color, String, api_name: :textColor
628
+ # @return [String]
629
+ required :text_color, String, api_name: :textColor
438
630
 
439
- # @!method initialize(background_color: nil, border_color: nil, border_radius: nil, border_style: nil, border_width: nil, box_shadow: nil, padding: nil, text_color: nil)
631
+ # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, css:, padding:, text_color:)
632
+ # Some parameter documentations has been truncated, see
633
+ # {BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card} for
634
+ # more details.
635
+ #
440
636
  # Card component style
441
637
  #
442
638
  # @param background_color [String]
443
- # @param border_color [String]
639
+ #
640
+ # @param border_color [String] Border color as CSS hex (#RRGGBB or #RRGGBBAA when computed border-color has alp
641
+ #
444
642
  # @param border_radius [String]
643
+ #
445
644
  # @param border_style [String]
645
+ #
446
646
  # @param border_width [String]
647
+ #
447
648
  # @param box_shadow [String]
649
+ #
650
+ # @param css [String] Ready-to-use CSS declaration block for this component style
651
+ #
448
652
  # @param padding [String]
653
+ #
449
654
  # @param text_color [String]
450
655
  end
451
656
  end
@@ -453,47 +658,38 @@ module BrandDev
453
658
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#element_spacing
454
659
  class ElementSpacing < BrandDev::Internal::Type::BaseModel
455
660
  # @!attribute lg
456
- # Large spacing value
457
661
  #
458
- # @return [String, nil]
459
- optional :lg, String
662
+ # @return [String]
663
+ required :lg, String
460
664
 
461
665
  # @!attribute md
462
- # Medium spacing value
463
666
  #
464
- # @return [String, nil]
465
- optional :md, String
667
+ # @return [String]
668
+ required :md, String
466
669
 
467
670
  # @!attribute sm
468
- # Small spacing value
469
671
  #
470
- # @return [String, nil]
471
- optional :sm, String
672
+ # @return [String]
673
+ required :sm, String
472
674
 
473
675
  # @!attribute xl
474
- # Extra large spacing value
475
676
  #
476
- # @return [String, nil]
477
- optional :xl, String
677
+ # @return [String]
678
+ required :xl, String
478
679
 
479
680
  # @!attribute xs
480
- # Extra small spacing value
481
681
  #
482
- # @return [String, nil]
483
- optional :xs, String
682
+ # @return [String]
683
+ required :xs, String
484
684
 
485
- # @!method initialize(lg: nil, md: nil, sm: nil, xl: nil, xs: nil)
685
+ # @!method initialize(lg:, md:, sm:, xl:, xs:)
486
686
  # Spacing system used on the website
487
687
  #
488
- # @param lg [String] Large spacing value
489
- #
490
- # @param md [String] Medium spacing value
491
- #
492
- # @param sm [String] Small spacing value
493
- #
494
- # @param xl [String] Extra large spacing value
495
- #
496
- # @param xs [String] Extra small spacing value
688
+ # @param lg [String]
689
+ # @param md [String]
690
+ # @param sm [String]
691
+ # @param xl [String]
692
+ # @param xs [String]
497
693
  end
498
694
 
499
695
  # The primary color mode of the website design
@@ -512,47 +708,38 @@ module BrandDev
512
708
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#shadows
513
709
  class Shadows < BrandDev::Internal::Type::BaseModel
514
710
  # @!attribute inner
515
- # Inner shadow value
516
711
  #
517
- # @return [String, nil]
518
- optional :inner, String
712
+ # @return [String]
713
+ required :inner, String
519
714
 
520
715
  # @!attribute lg
521
- # Large shadow value
522
716
  #
523
- # @return [String, nil]
524
- optional :lg, String
717
+ # @return [String]
718
+ required :lg, String
525
719
 
526
720
  # @!attribute md
527
- # Medium shadow value
528
721
  #
529
- # @return [String, nil]
530
- optional :md, String
722
+ # @return [String]
723
+ required :md, String
531
724
 
532
725
  # @!attribute sm
533
- # Small shadow value
534
726
  #
535
- # @return [String, nil]
536
- optional :sm, String
727
+ # @return [String]
728
+ required :sm, String
537
729
 
538
730
  # @!attribute xl
539
- # Extra large shadow value
540
731
  #
541
- # @return [String, nil]
542
- optional :xl, String
732
+ # @return [String]
733
+ required :xl, String
543
734
 
544
- # @!method initialize(inner: nil, lg: nil, md: nil, sm: nil, xl: nil)
735
+ # @!method initialize(inner:, lg:, md:, sm:, xl:)
545
736
  # Shadow styles used on the website
546
737
  #
547
- # @param inner [String] Inner shadow value
548
- #
549
- # @param lg [String] Large shadow value
550
- #
551
- # @param md [String] Medium shadow value
552
- #
553
- # @param sm [String] Small shadow value
554
- #
555
- # @param xl [String] Extra large shadow value
738
+ # @param inner [String]
739
+ # @param lg [String]
740
+ # @param md [String]
741
+ # @param sm [String]
742
+ # @param xl [String]
556
743
  end
557
744
 
558
745
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide#typography
@@ -560,21 +747,20 @@ module BrandDev
560
747
  # @!attribute headings
561
748
  # Heading styles
562
749
  #
563
- # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, nil]
564
- optional :headings, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings }
750
+ # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings]
751
+ required :headings, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings }
565
752
 
566
753
  # @!attribute p_
567
- # Paragraph text styles
568
754
  #
569
755
  # @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, nil]
570
756
  optional :p_, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P }, api_name: :p
571
757
 
572
- # @!method initialize(headings: nil, p_: nil)
758
+ # @!method initialize(headings:, p_: nil)
573
759
  # Typography styles used on the website
574
760
  #
575
761
  # @param headings [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings] Heading styles
576
762
  #
577
- # @param p_ [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P] Paragraph text styles
763
+ # @param p_ [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P]
578
764
 
579
765
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#headings
580
766
  class Headings < BrandDev::Internal::Type::BaseModel
@@ -608,179 +794,242 @@ module BrandDev
608
794
 
609
795
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h1
610
796
  class H1 < BrandDev::Internal::Type::BaseModel
797
+ # @!attribute font_fallbacks
798
+ # Full ordered font list from resolved computed font-family
799
+ #
800
+ # @return [Array<String>]
801
+ required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
802
+
611
803
  # @!attribute font_family
804
+ # Primary face (first family in the computed stack)
612
805
  #
613
- # @return [String, nil]
614
- optional :font_family, String, api_name: :fontFamily
806
+ # @return [String]
807
+ required :font_family, String, api_name: :fontFamily
615
808
 
616
809
  # @!attribute font_size
617
810
  #
618
- # @return [String, nil]
619
- optional :font_size, String, api_name: :fontSize
811
+ # @return [String]
812
+ required :font_size, String, api_name: :fontSize
620
813
 
621
814
  # @!attribute font_weight
622
815
  #
623
- # @return [Float, nil]
624
- optional :font_weight, Float, api_name: :fontWeight
816
+ # @return [Float]
817
+ required :font_weight, Float, api_name: :fontWeight
625
818
 
626
819
  # @!attribute letter_spacing
627
820
  #
628
- # @return [String, nil]
629
- optional :letter_spacing, String, api_name: :letterSpacing
821
+ # @return [String]
822
+ required :letter_spacing, String, api_name: :letterSpacing
630
823
 
631
824
  # @!attribute line_height
632
825
  #
633
- # @return [String, nil]
634
- optional :line_height, String, api_name: :lineHeight
826
+ # @return [String]
827
+ required :line_height, String, api_name: :lineHeight
635
828
 
636
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
637
- # @param font_family [String]
829
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
830
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
831
+ #
832
+ # @param font_family [String] Primary face (first family in the computed stack)
833
+ #
638
834
  # @param font_size [String]
835
+ #
639
836
  # @param font_weight [Float]
837
+ #
640
838
  # @param letter_spacing [String]
839
+ #
641
840
  # @param line_height [String]
642
841
  end
643
842
 
644
843
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h2
645
844
  class H2 < BrandDev::Internal::Type::BaseModel
845
+ # @!attribute font_fallbacks
846
+ # Full ordered font list from resolved computed font-family
847
+ #
848
+ # @return [Array<String>]
849
+ required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
850
+
646
851
  # @!attribute font_family
852
+ # Primary face (first family in the computed stack)
647
853
  #
648
- # @return [String, nil]
649
- optional :font_family, String, api_name: :fontFamily
854
+ # @return [String]
855
+ required :font_family, String, api_name: :fontFamily
650
856
 
651
857
  # @!attribute font_size
652
858
  #
653
- # @return [String, nil]
654
- optional :font_size, String, api_name: :fontSize
859
+ # @return [String]
860
+ required :font_size, String, api_name: :fontSize
655
861
 
656
862
  # @!attribute font_weight
657
863
  #
658
- # @return [Float, nil]
659
- optional :font_weight, Float, api_name: :fontWeight
864
+ # @return [Float]
865
+ required :font_weight, Float, api_name: :fontWeight
660
866
 
661
867
  # @!attribute letter_spacing
662
868
  #
663
- # @return [String, nil]
664
- optional :letter_spacing, String, api_name: :letterSpacing
869
+ # @return [String]
870
+ required :letter_spacing, String, api_name: :letterSpacing
665
871
 
666
872
  # @!attribute line_height
667
873
  #
668
- # @return [String, nil]
669
- optional :line_height, String, api_name: :lineHeight
874
+ # @return [String]
875
+ required :line_height, String, api_name: :lineHeight
670
876
 
671
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
672
- # @param font_family [String]
877
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
878
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
879
+ #
880
+ # @param font_family [String] Primary face (first family in the computed stack)
881
+ #
673
882
  # @param font_size [String]
883
+ #
674
884
  # @param font_weight [Float]
885
+ #
675
886
  # @param letter_spacing [String]
887
+ #
676
888
  # @param line_height [String]
677
889
  end
678
890
 
679
891
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h3
680
892
  class H3 < BrandDev::Internal::Type::BaseModel
893
+ # @!attribute font_fallbacks
894
+ # Full ordered font list from resolved computed font-family
895
+ #
896
+ # @return [Array<String>]
897
+ required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
898
+
681
899
  # @!attribute font_family
900
+ # Primary face (first family in the computed stack)
682
901
  #
683
- # @return [String, nil]
684
- optional :font_family, String, api_name: :fontFamily
902
+ # @return [String]
903
+ required :font_family, String, api_name: :fontFamily
685
904
 
686
905
  # @!attribute font_size
687
906
  #
688
- # @return [String, nil]
689
- optional :font_size, String, api_name: :fontSize
907
+ # @return [String]
908
+ required :font_size, String, api_name: :fontSize
690
909
 
691
910
  # @!attribute font_weight
692
911
  #
693
- # @return [Float, nil]
694
- optional :font_weight, Float, api_name: :fontWeight
912
+ # @return [Float]
913
+ required :font_weight, Float, api_name: :fontWeight
695
914
 
696
915
  # @!attribute letter_spacing
697
916
  #
698
- # @return [String, nil]
699
- optional :letter_spacing, String, api_name: :letterSpacing
917
+ # @return [String]
918
+ required :letter_spacing, String, api_name: :letterSpacing
700
919
 
701
920
  # @!attribute line_height
702
921
  #
703
- # @return [String, nil]
704
- optional :line_height, String, api_name: :lineHeight
922
+ # @return [String]
923
+ required :line_height, String, api_name: :lineHeight
705
924
 
706
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
707
- # @param font_family [String]
925
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
926
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
927
+ #
928
+ # @param font_family [String] Primary face (first family in the computed stack)
929
+ #
708
930
  # @param font_size [String]
931
+ #
709
932
  # @param font_weight [Float]
933
+ #
710
934
  # @param letter_spacing [String]
935
+ #
711
936
  # @param line_height [String]
712
937
  end
713
938
 
714
939
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h4
715
940
  class H4 < BrandDev::Internal::Type::BaseModel
941
+ # @!attribute font_fallbacks
942
+ # Full ordered font list from resolved computed font-family
943
+ #
944
+ # @return [Array<String>]
945
+ required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
946
+
716
947
  # @!attribute font_family
948
+ # Primary face (first family in the computed stack)
717
949
  #
718
- # @return [String, nil]
719
- optional :font_family, String, api_name: :fontFamily
950
+ # @return [String]
951
+ required :font_family, String, api_name: :fontFamily
720
952
 
721
953
  # @!attribute font_size
722
954
  #
723
- # @return [String, nil]
724
- optional :font_size, String, api_name: :fontSize
955
+ # @return [String]
956
+ required :font_size, String, api_name: :fontSize
725
957
 
726
958
  # @!attribute font_weight
727
959
  #
728
- # @return [Float, nil]
729
- optional :font_weight, Float, api_name: :fontWeight
960
+ # @return [Float]
961
+ required :font_weight, Float, api_name: :fontWeight
730
962
 
731
963
  # @!attribute letter_spacing
732
964
  #
733
- # @return [String, nil]
734
- optional :letter_spacing, String, api_name: :letterSpacing
965
+ # @return [String]
966
+ required :letter_spacing, String, api_name: :letterSpacing
735
967
 
736
968
  # @!attribute line_height
737
969
  #
738
- # @return [String, nil]
739
- optional :line_height, String, api_name: :lineHeight
970
+ # @return [String]
971
+ required :line_height, String, api_name: :lineHeight
740
972
 
741
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
742
- # @param font_family [String]
973
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
974
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
975
+ #
976
+ # @param font_family [String] Primary face (first family in the computed stack)
977
+ #
743
978
  # @param font_size [String]
979
+ #
744
980
  # @param font_weight [Float]
981
+ #
745
982
  # @param letter_spacing [String]
983
+ #
746
984
  # @param line_height [String]
747
985
  end
748
986
  end
749
987
 
750
988
  # @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#p_
751
989
  class P < BrandDev::Internal::Type::BaseModel
990
+ # @!attribute font_fallbacks
991
+ # Full ordered font list from resolved computed font-family
992
+ #
993
+ # @return [Array<String>]
994
+ required :font_fallbacks, BrandDev::Internal::Type::ArrayOf[String], api_name: :fontFallbacks
995
+
752
996
  # @!attribute font_family
997
+ # Primary face (first family in the computed stack)
753
998
  #
754
- # @return [String, nil]
755
- optional :font_family, String, api_name: :fontFamily
999
+ # @return [String]
1000
+ required :font_family, String, api_name: :fontFamily
756
1001
 
757
1002
  # @!attribute font_size
758
1003
  #
759
- # @return [String, nil]
760
- optional :font_size, String, api_name: :fontSize
1004
+ # @return [String]
1005
+ required :font_size, String, api_name: :fontSize
761
1006
 
762
1007
  # @!attribute font_weight
763
1008
  #
764
- # @return [Float, nil]
765
- optional :font_weight, Float, api_name: :fontWeight
1009
+ # @return [Float]
1010
+ required :font_weight, Float, api_name: :fontWeight
766
1011
 
767
1012
  # @!attribute letter_spacing
768
1013
  #
769
- # @return [String, nil]
770
- optional :letter_spacing, String, api_name: :letterSpacing
1014
+ # @return [String]
1015
+ required :letter_spacing, String, api_name: :letterSpacing
771
1016
 
772
1017
  # @!attribute line_height
773
1018
  #
774
- # @return [String, nil]
775
- optional :line_height, String, api_name: :lineHeight
1019
+ # @return [String]
1020
+ required :line_height, String, api_name: :lineHeight
776
1021
 
777
- # @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
778
- # Paragraph text styles
1022
+ # @!method initialize(font_fallbacks:, font_family:, font_size:, font_weight:, letter_spacing:, line_height:)
1023
+ # @param font_fallbacks [Array<String>] Full ordered font list from resolved computed font-family
1024
+ #
1025
+ # @param font_family [String] Primary face (first family in the computed stack)
779
1026
  #
780
- # @param font_family [String]
781
1027
  # @param font_size [String]
1028
+ #
782
1029
  # @param font_weight [Float]
1030
+ #
783
1031
  # @param letter_spacing [String]
1032
+ #
784
1033
  # @param line_height [String]
785
1034
  end
786
1035
  end