brand.dev 0.0.1.pre.alpha.0 → 0.0.2
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 +4 -4
- data/CHANGELOG.md +188 -0
- data/README.md +7 -3
- data/lib/brand_dev/errors.rb +22 -0
- data/lib/brand_dev/internal/transport/base_client.rb +10 -2
- data/lib/brand_dev/internal/type/array_of.rb +6 -1
- data/lib/brand_dev/internal/type/base_model.rb +77 -25
- data/lib/brand_dev/internal/type/boolean.rb +7 -1
- data/lib/brand_dev/internal/type/converter.rb +42 -34
- data/lib/brand_dev/internal/type/enum.rb +16 -5
- data/lib/brand_dev/internal/type/file_input.rb +6 -1
- data/lib/brand_dev/internal/type/hash_of.rb +6 -1
- data/lib/brand_dev/internal/type/union.rb +17 -9
- data/lib/brand_dev/internal/type/unknown.rb +7 -1
- data/lib/brand_dev/internal/util.rb +8 -9
- data/lib/brand_dev/models/brand_ai_query_params.rb +173 -0
- data/lib/brand_dev/models/brand_ai_query_response.rb +80 -0
- data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +14 -1
- data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +1 -29
- data/lib/brand_dev/models/brand_prefetch_params.rb +35 -0
- data/lib/brand_dev/models/brand_prefetch_response.rb +33 -0
- data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +14 -1
- data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +1 -29
- data/lib/brand_dev/models/brand_retrieve_naics_params.rb +11 -1
- data/lib/brand_dev/models/brand_retrieve_params.rb +24 -1
- data/lib/brand_dev/models/brand_retrieve_response.rb +1 -29
- data/lib/brand_dev/models/brand_retrieve_simplified_params.rb +35 -0
- data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +280 -0
- data/lib/brand_dev/models/brand_screenshot_params.rb +49 -0
- data/lib/brand_dev/models/brand_screenshot_response.rb +64 -0
- data/lib/brand_dev/models/brand_styleguide_params.rb +36 -0
- data/lib/brand_dev/models/brand_styleguide_response.rb +769 -0
- data/lib/brand_dev/models.rb +13 -5
- data/lib/brand_dev/resources/brand.rb +165 -18
- data/lib/brand_dev/version.rb +1 -1
- data/lib/brand_dev.rb +10 -2
- data/rbi/brand_dev/errors.rbi +16 -0
- data/rbi/brand_dev/internal/type/boolean.rbi +2 -0
- data/rbi/brand_dev/internal/type/converter.rbi +15 -15
- data/rbi/brand_dev/internal/type/union.rbi +5 -0
- data/rbi/brand_dev/internal/type/unknown.rbi +2 -0
- data/rbi/brand_dev/internal/util.rbi +2 -0
- data/rbi/brand_dev/models/brand_ai_query_params.rbi +319 -0
- data/rbi/brand_dev/models/brand_ai_query_response.rbi +182 -0
- data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +15 -0
- data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +0 -69
- data/rbi/brand_dev/models/brand_prefetch_params.rbi +58 -0
- data/rbi/brand_dev/models/brand_prefetch_response.rbi +57 -0
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +19 -1
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +0 -69
- data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi +19 -1
- data/rbi/brand_dev/models/brand_retrieve_params.rbi +30 -0
- data/rbi/brand_dev/models/brand_retrieve_response.rbi +0 -65
- data/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi +61 -0
- data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +667 -0
- data/rbi/brand_dev/models/brand_screenshot_params.rbi +105 -0
- data/rbi/brand_dev/models/brand_screenshot_response.rbi +135 -0
- data/rbi/brand_dev/models/brand_styleguide_params.rbi +60 -0
- data/rbi/brand_dev/models/brand_styleguide_response.rbi +1648 -0
- data/rbi/brand_dev/models.rbi +10 -1
- data/rbi/brand_dev/resources/brand.rbi +133 -6
- data/sig/brand_dev/errors.rbs +9 -0
- data/sig/brand_dev/internal/type/converter.rbs +7 -1
- data/sig/brand_dev/models/brand_ai_query_params.rbs +162 -0
- data/sig/brand_dev/models/brand_ai_query_response.rbs +79 -0
- data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +7 -1
- data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +0 -25
- data/sig/brand_dev/models/brand_prefetch_params.rbs +30 -0
- data/sig/brand_dev/models/brand_prefetch_response.rbs +28 -0
- data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +8 -1
- data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +0 -25
- data/sig/brand_dev/models/brand_retrieve_naics_params.rbs +8 -1
- data/sig/brand_dev/models/brand_retrieve_params.rbs +15 -1
- data/sig/brand_dev/models/brand_retrieve_response.rbs +0 -25
- data/sig/brand_dev/models/brand_retrieve_simplified_params.rbs +30 -0
- data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +292 -0
- data/sig/brand_dev/models/brand_screenshot_params.rbs +46 -0
- data/sig/brand_dev/models/brand_screenshot_response.rbs +63 -0
- data/sig/brand_dev/models/brand_styleguide_params.rbs +30 -0
- data/sig/brand_dev/models/brand_styleguide_response.rbs +925 -0
- data/sig/brand_dev/models.rbs +9 -1
- data/sig/brand_dev/resources/brand.rbs +35 -3
- metadata +46 -22
- data/lib/brand_dev/models/brand_search_params.rb +0 -22
- data/lib/brand_dev/models/brand_search_response.rb +0 -35
- data/rbi/brand_dev/models/brand_search_params.rbi +0 -40
- data/rbi/brand_dev/models/brand_search_response.rbi +0 -63
- data/sig/brand_dev/models/brand_search_params.rbs +0 -23
- data/sig/brand_dev/models/brand_search_response.rbs +0 -29
@@ -0,0 +1,769 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module BrandDev
|
4
|
+
module Models
|
5
|
+
# @see BrandDev::Resources::Brand#styleguide
|
6
|
+
class BrandStyleguideResponse < BrandDev::Internal::Type::BaseModel
|
7
|
+
# @!attribute code
|
8
|
+
# HTTP status code
|
9
|
+
#
|
10
|
+
# @return [Integer, nil]
|
11
|
+
optional :code, Integer
|
12
|
+
|
13
|
+
# @!attribute domain
|
14
|
+
# The normalized domain that was processed
|
15
|
+
#
|
16
|
+
# @return [String, nil]
|
17
|
+
optional :domain, String
|
18
|
+
|
19
|
+
# @!attribute status
|
20
|
+
# Status of the response, e.g., 'ok'
|
21
|
+
#
|
22
|
+
# @return [String, nil]
|
23
|
+
optional :status, String
|
24
|
+
|
25
|
+
# @!attribute styleguide
|
26
|
+
# Comprehensive styleguide data extracted from the website
|
27
|
+
#
|
28
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide, nil]
|
29
|
+
optional :styleguide, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide }
|
30
|
+
|
31
|
+
# @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil)
|
32
|
+
# @param code [Integer] HTTP status code
|
33
|
+
#
|
34
|
+
# @param domain [String] The normalized domain that was processed
|
35
|
+
#
|
36
|
+
# @param status [String] Status of the response, e.g., 'ok'
|
37
|
+
#
|
38
|
+
# @param styleguide [BrandDev::Models::BrandStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
|
39
|
+
|
40
|
+
# @see BrandDev::Models::BrandStyleguideResponse#styleguide
|
41
|
+
class Styleguide < BrandDev::Internal::Type::BaseModel
|
42
|
+
# @!attribute colors
|
43
|
+
# Primary colors used on the website
|
44
|
+
#
|
45
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors, nil]
|
46
|
+
optional :colors, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors }
|
47
|
+
|
48
|
+
# @!attribute components
|
49
|
+
# UI component styles
|
50
|
+
#
|
51
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components, nil]
|
52
|
+
optional :components, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components }
|
53
|
+
|
54
|
+
# @!attribute element_spacing
|
55
|
+
# Spacing system used on the website
|
56
|
+
#
|
57
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing, nil]
|
58
|
+
optional :element_spacing,
|
59
|
+
-> { BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing },
|
60
|
+
api_name: :elementSpacing
|
61
|
+
|
62
|
+
# @!attribute shadows
|
63
|
+
# Shadow styles used on the website
|
64
|
+
#
|
65
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows, nil]
|
66
|
+
optional :shadows, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows }
|
67
|
+
|
68
|
+
# @!attribute typography
|
69
|
+
# Typography styles used on the website
|
70
|
+
#
|
71
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography, nil]
|
72
|
+
optional :typography, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography }
|
73
|
+
|
74
|
+
# @!method initialize(colors: nil, components: nil, element_spacing: nil, shadows: nil, typography: nil)
|
75
|
+
# Comprehensive styleguide data extracted from the website
|
76
|
+
#
|
77
|
+
# @param colors [BrandDev::Models::BrandStyleguideResponse::Styleguide::Colors] Primary colors used on the website
|
78
|
+
#
|
79
|
+
# @param components [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components] UI component styles
|
80
|
+
#
|
81
|
+
# @param element_spacing [BrandDev::Models::BrandStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website
|
82
|
+
#
|
83
|
+
# @param shadows [BrandDev::Models::BrandStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website
|
84
|
+
#
|
85
|
+
# @param typography [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography] Typography styles used on the website
|
86
|
+
|
87
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide#colors
|
88
|
+
class Colors < BrandDev::Internal::Type::BaseModel
|
89
|
+
# @!attribute accent
|
90
|
+
# Accent color of the website (hex format)
|
91
|
+
#
|
92
|
+
# @return [String, nil]
|
93
|
+
optional :accent, String
|
94
|
+
|
95
|
+
# @!attribute background
|
96
|
+
# Background color of the website (hex format)
|
97
|
+
#
|
98
|
+
# @return [String, nil]
|
99
|
+
optional :background, String
|
100
|
+
|
101
|
+
# @!attribute text
|
102
|
+
# Text color of the website (hex format)
|
103
|
+
#
|
104
|
+
# @return [String, nil]
|
105
|
+
optional :text, String
|
106
|
+
|
107
|
+
# @!method initialize(accent: nil, background: nil, text: nil)
|
108
|
+
# Primary colors used on the website
|
109
|
+
#
|
110
|
+
# @param accent [String] Accent color of the website (hex format)
|
111
|
+
#
|
112
|
+
# @param background [String] Background color of the website (hex format)
|
113
|
+
#
|
114
|
+
# @param text [String] Text color of the website (hex format)
|
115
|
+
end
|
116
|
+
|
117
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide#components
|
118
|
+
class Components < BrandDev::Internal::Type::BaseModel
|
119
|
+
# @!attribute button
|
120
|
+
# Button component styles
|
121
|
+
#
|
122
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button, nil]
|
123
|
+
optional :button, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button }
|
124
|
+
|
125
|
+
# @!attribute card
|
126
|
+
# Card component style
|
127
|
+
#
|
128
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card, nil]
|
129
|
+
optional :card, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card }
|
130
|
+
|
131
|
+
# @!method initialize(button: nil, card: nil)
|
132
|
+
# UI component styles
|
133
|
+
#
|
134
|
+
# @param button [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button] Button component styles
|
135
|
+
#
|
136
|
+
# @param card [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Card] Card component style
|
137
|
+
|
138
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components#button
|
139
|
+
class Button < BrandDev::Internal::Type::BaseModel
|
140
|
+
# @!attribute link
|
141
|
+
# Link button style
|
142
|
+
#
|
143
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link, nil]
|
144
|
+
optional :link, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link }
|
145
|
+
|
146
|
+
# @!attribute primary
|
147
|
+
# Primary button style
|
148
|
+
#
|
149
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary, nil]
|
150
|
+
optional :primary,
|
151
|
+
-> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary }
|
152
|
+
|
153
|
+
# @!attribute secondary
|
154
|
+
# Secondary button style
|
155
|
+
#
|
156
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary, nil]
|
157
|
+
optional :secondary,
|
158
|
+
-> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary }
|
159
|
+
|
160
|
+
# @!method initialize(link: nil, primary: nil, secondary: nil)
|
161
|
+
# Button component styles
|
162
|
+
#
|
163
|
+
# @param link [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Link] Link button style
|
164
|
+
#
|
165
|
+
# @param primary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Primary] Primary button style
|
166
|
+
#
|
167
|
+
# @param secondary [BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button::Secondary] Secondary button style
|
168
|
+
|
169
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#link
|
170
|
+
class Link < BrandDev::Internal::Type::BaseModel
|
171
|
+
# @!attribute background_color
|
172
|
+
#
|
173
|
+
# @return [String, nil]
|
174
|
+
optional :background_color, String, api_name: :backgroundColor
|
175
|
+
|
176
|
+
# @!attribute border_color
|
177
|
+
#
|
178
|
+
# @return [String, nil]
|
179
|
+
optional :border_color, String, api_name: :borderColor
|
180
|
+
|
181
|
+
# @!attribute border_radius
|
182
|
+
#
|
183
|
+
# @return [String, nil]
|
184
|
+
optional :border_radius, String, api_name: :borderRadius
|
185
|
+
|
186
|
+
# @!attribute border_style
|
187
|
+
#
|
188
|
+
# @return [String, nil]
|
189
|
+
optional :border_style, String, api_name: :borderStyle
|
190
|
+
|
191
|
+
# @!attribute border_width
|
192
|
+
#
|
193
|
+
# @return [String, nil]
|
194
|
+
optional :border_width, String, api_name: :borderWidth
|
195
|
+
|
196
|
+
# @!attribute box_shadow
|
197
|
+
#
|
198
|
+
# @return [String, nil]
|
199
|
+
optional :box_shadow, String, api_name: :boxShadow
|
200
|
+
|
201
|
+
# @!attribute color
|
202
|
+
#
|
203
|
+
# @return [String, nil]
|
204
|
+
optional :color, String
|
205
|
+
|
206
|
+
# @!attribute font_size
|
207
|
+
#
|
208
|
+
# @return [String, nil]
|
209
|
+
optional :font_size, String, api_name: :fontSize
|
210
|
+
|
211
|
+
# @!attribute font_weight
|
212
|
+
#
|
213
|
+
# @return [Float, nil]
|
214
|
+
optional :font_weight, Float, api_name: :fontWeight
|
215
|
+
|
216
|
+
# @!attribute padding
|
217
|
+
#
|
218
|
+
# @return [String, nil]
|
219
|
+
optional :padding, String
|
220
|
+
|
221
|
+
# @!attribute text_decoration
|
222
|
+
#
|
223
|
+
# @return [String, nil]
|
224
|
+
optional :text_decoration, String, api_name: :textDecoration
|
225
|
+
|
226
|
+
# @!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)
|
227
|
+
# Link button style
|
228
|
+
#
|
229
|
+
# @param background_color [String]
|
230
|
+
# @param border_color [String]
|
231
|
+
# @param border_radius [String]
|
232
|
+
# @param border_style [String]
|
233
|
+
# @param border_width [String]
|
234
|
+
# @param box_shadow [String]
|
235
|
+
# @param color [String]
|
236
|
+
# @param font_size [String]
|
237
|
+
# @param font_weight [Float]
|
238
|
+
# @param padding [String]
|
239
|
+
# @param text_decoration [String]
|
240
|
+
end
|
241
|
+
|
242
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#primary
|
243
|
+
class Primary < BrandDev::Internal::Type::BaseModel
|
244
|
+
# @!attribute background_color
|
245
|
+
#
|
246
|
+
# @return [String, nil]
|
247
|
+
optional :background_color, String, api_name: :backgroundColor
|
248
|
+
|
249
|
+
# @!attribute border_color
|
250
|
+
#
|
251
|
+
# @return [String, nil]
|
252
|
+
optional :border_color, String, api_name: :borderColor
|
253
|
+
|
254
|
+
# @!attribute border_radius
|
255
|
+
#
|
256
|
+
# @return [String, nil]
|
257
|
+
optional :border_radius, String, api_name: :borderRadius
|
258
|
+
|
259
|
+
# @!attribute border_style
|
260
|
+
#
|
261
|
+
# @return [String, nil]
|
262
|
+
optional :border_style, String, api_name: :borderStyle
|
263
|
+
|
264
|
+
# @!attribute border_width
|
265
|
+
#
|
266
|
+
# @return [String, nil]
|
267
|
+
optional :border_width, String, api_name: :borderWidth
|
268
|
+
|
269
|
+
# @!attribute box_shadow
|
270
|
+
#
|
271
|
+
# @return [String, nil]
|
272
|
+
optional :box_shadow, String, api_name: :boxShadow
|
273
|
+
|
274
|
+
# @!attribute color
|
275
|
+
#
|
276
|
+
# @return [String, nil]
|
277
|
+
optional :color, String
|
278
|
+
|
279
|
+
# @!attribute font_size
|
280
|
+
#
|
281
|
+
# @return [String, nil]
|
282
|
+
optional :font_size, String, api_name: :fontSize
|
283
|
+
|
284
|
+
# @!attribute font_weight
|
285
|
+
#
|
286
|
+
# @return [Float, nil]
|
287
|
+
optional :font_weight, Float, api_name: :fontWeight
|
288
|
+
|
289
|
+
# @!attribute padding
|
290
|
+
#
|
291
|
+
# @return [String, nil]
|
292
|
+
optional :padding, String
|
293
|
+
|
294
|
+
# @!attribute text_decoration
|
295
|
+
#
|
296
|
+
# @return [String, nil]
|
297
|
+
optional :text_decoration, String, api_name: :textDecoration
|
298
|
+
|
299
|
+
# @!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)
|
300
|
+
# Primary button style
|
301
|
+
#
|
302
|
+
# @param background_color [String]
|
303
|
+
# @param border_color [String]
|
304
|
+
# @param border_radius [String]
|
305
|
+
# @param border_style [String]
|
306
|
+
# @param border_width [String]
|
307
|
+
# @param box_shadow [String]
|
308
|
+
# @param color [String]
|
309
|
+
# @param font_size [String]
|
310
|
+
# @param font_weight [Float]
|
311
|
+
# @param padding [String]
|
312
|
+
# @param text_decoration [String]
|
313
|
+
end
|
314
|
+
|
315
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components::Button#secondary
|
316
|
+
class Secondary < BrandDev::Internal::Type::BaseModel
|
317
|
+
# @!attribute background_color
|
318
|
+
#
|
319
|
+
# @return [String, nil]
|
320
|
+
optional :background_color, String, api_name: :backgroundColor
|
321
|
+
|
322
|
+
# @!attribute border_color
|
323
|
+
#
|
324
|
+
# @return [String, nil]
|
325
|
+
optional :border_color, String, api_name: :borderColor
|
326
|
+
|
327
|
+
# @!attribute border_radius
|
328
|
+
#
|
329
|
+
# @return [String, nil]
|
330
|
+
optional :border_radius, String, api_name: :borderRadius
|
331
|
+
|
332
|
+
# @!attribute border_style
|
333
|
+
#
|
334
|
+
# @return [String, nil]
|
335
|
+
optional :border_style, String, api_name: :borderStyle
|
336
|
+
|
337
|
+
# @!attribute border_width
|
338
|
+
#
|
339
|
+
# @return [String, nil]
|
340
|
+
optional :border_width, String, api_name: :borderWidth
|
341
|
+
|
342
|
+
# @!attribute box_shadow
|
343
|
+
#
|
344
|
+
# @return [String, nil]
|
345
|
+
optional :box_shadow, String, api_name: :boxShadow
|
346
|
+
|
347
|
+
# @!attribute color
|
348
|
+
#
|
349
|
+
# @return [String, nil]
|
350
|
+
optional :color, String
|
351
|
+
|
352
|
+
# @!attribute font_size
|
353
|
+
#
|
354
|
+
# @return [String, nil]
|
355
|
+
optional :font_size, String, api_name: :fontSize
|
356
|
+
|
357
|
+
# @!attribute font_weight
|
358
|
+
#
|
359
|
+
# @return [Float, nil]
|
360
|
+
optional :font_weight, Float, api_name: :fontWeight
|
361
|
+
|
362
|
+
# @!attribute padding
|
363
|
+
#
|
364
|
+
# @return [String, nil]
|
365
|
+
optional :padding, String
|
366
|
+
|
367
|
+
# @!attribute text_decoration
|
368
|
+
#
|
369
|
+
# @return [String, nil]
|
370
|
+
optional :text_decoration, String, api_name: :textDecoration
|
371
|
+
|
372
|
+
# @!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)
|
373
|
+
# Secondary button style
|
374
|
+
#
|
375
|
+
# @param background_color [String]
|
376
|
+
# @param border_color [String]
|
377
|
+
# @param border_radius [String]
|
378
|
+
# @param border_style [String]
|
379
|
+
# @param border_width [String]
|
380
|
+
# @param box_shadow [String]
|
381
|
+
# @param color [String]
|
382
|
+
# @param font_size [String]
|
383
|
+
# @param font_weight [Float]
|
384
|
+
# @param padding [String]
|
385
|
+
# @param text_decoration [String]
|
386
|
+
end
|
387
|
+
end
|
388
|
+
|
389
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Components#card
|
390
|
+
class Card < BrandDev::Internal::Type::BaseModel
|
391
|
+
# @!attribute background_color
|
392
|
+
#
|
393
|
+
# @return [String, nil]
|
394
|
+
optional :background_color, String, api_name: :backgroundColor
|
395
|
+
|
396
|
+
# @!attribute border_color
|
397
|
+
#
|
398
|
+
# @return [String, nil]
|
399
|
+
optional :border_color, String, api_name: :borderColor
|
400
|
+
|
401
|
+
# @!attribute border_radius
|
402
|
+
#
|
403
|
+
# @return [String, nil]
|
404
|
+
optional :border_radius, String, api_name: :borderRadius
|
405
|
+
|
406
|
+
# @!attribute border_style
|
407
|
+
#
|
408
|
+
# @return [String, nil]
|
409
|
+
optional :border_style, String, api_name: :borderStyle
|
410
|
+
|
411
|
+
# @!attribute border_width
|
412
|
+
#
|
413
|
+
# @return [String, nil]
|
414
|
+
optional :border_width, String, api_name: :borderWidth
|
415
|
+
|
416
|
+
# @!attribute box_shadow
|
417
|
+
#
|
418
|
+
# @return [String, nil]
|
419
|
+
optional :box_shadow, String, api_name: :boxShadow
|
420
|
+
|
421
|
+
# @!attribute padding
|
422
|
+
#
|
423
|
+
# @return [String, nil]
|
424
|
+
optional :padding, String
|
425
|
+
|
426
|
+
# @!attribute text_color
|
427
|
+
#
|
428
|
+
# @return [String, nil]
|
429
|
+
optional :text_color, String, api_name: :textColor
|
430
|
+
|
431
|
+
# @!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)
|
432
|
+
# Card component style
|
433
|
+
#
|
434
|
+
# @param background_color [String]
|
435
|
+
# @param border_color [String]
|
436
|
+
# @param border_radius [String]
|
437
|
+
# @param border_style [String]
|
438
|
+
# @param border_width [String]
|
439
|
+
# @param box_shadow [String]
|
440
|
+
# @param padding [String]
|
441
|
+
# @param text_color [String]
|
442
|
+
end
|
443
|
+
end
|
444
|
+
|
445
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide#element_spacing
|
446
|
+
class ElementSpacing < BrandDev::Internal::Type::BaseModel
|
447
|
+
# @!attribute lg
|
448
|
+
# Large spacing value
|
449
|
+
#
|
450
|
+
# @return [String, nil]
|
451
|
+
optional :lg, String
|
452
|
+
|
453
|
+
# @!attribute md
|
454
|
+
# Medium spacing value
|
455
|
+
#
|
456
|
+
# @return [String, nil]
|
457
|
+
optional :md, String
|
458
|
+
|
459
|
+
# @!attribute sm
|
460
|
+
# Small spacing value
|
461
|
+
#
|
462
|
+
# @return [String, nil]
|
463
|
+
optional :sm, String
|
464
|
+
|
465
|
+
# @!attribute xl
|
466
|
+
# Extra large spacing value
|
467
|
+
#
|
468
|
+
# @return [String, nil]
|
469
|
+
optional :xl, String
|
470
|
+
|
471
|
+
# @!attribute xs
|
472
|
+
# Extra small spacing value
|
473
|
+
#
|
474
|
+
# @return [String, nil]
|
475
|
+
optional :xs, String
|
476
|
+
|
477
|
+
# @!method initialize(lg: nil, md: nil, sm: nil, xl: nil, xs: nil)
|
478
|
+
# Spacing system used on the website
|
479
|
+
#
|
480
|
+
# @param lg [String] Large spacing value
|
481
|
+
#
|
482
|
+
# @param md [String] Medium spacing value
|
483
|
+
#
|
484
|
+
# @param sm [String] Small spacing value
|
485
|
+
#
|
486
|
+
# @param xl [String] Extra large spacing value
|
487
|
+
#
|
488
|
+
# @param xs [String] Extra small spacing value
|
489
|
+
end
|
490
|
+
|
491
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide#shadows
|
492
|
+
class Shadows < BrandDev::Internal::Type::BaseModel
|
493
|
+
# @!attribute inner
|
494
|
+
# Inner shadow value
|
495
|
+
#
|
496
|
+
# @return [String, nil]
|
497
|
+
optional :inner, String
|
498
|
+
|
499
|
+
# @!attribute lg
|
500
|
+
# Large shadow value
|
501
|
+
#
|
502
|
+
# @return [String, nil]
|
503
|
+
optional :lg, String
|
504
|
+
|
505
|
+
# @!attribute md
|
506
|
+
# Medium shadow value
|
507
|
+
#
|
508
|
+
# @return [String, nil]
|
509
|
+
optional :md, String
|
510
|
+
|
511
|
+
# @!attribute sm
|
512
|
+
# Small shadow value
|
513
|
+
#
|
514
|
+
# @return [String, nil]
|
515
|
+
optional :sm, String
|
516
|
+
|
517
|
+
# @!attribute xl
|
518
|
+
# Extra large shadow value
|
519
|
+
#
|
520
|
+
# @return [String, nil]
|
521
|
+
optional :xl, String
|
522
|
+
|
523
|
+
# @!method initialize(inner: nil, lg: nil, md: nil, sm: nil, xl: nil)
|
524
|
+
# Shadow styles used on the website
|
525
|
+
#
|
526
|
+
# @param inner [String] Inner shadow value
|
527
|
+
#
|
528
|
+
# @param lg [String] Large shadow value
|
529
|
+
#
|
530
|
+
# @param md [String] Medium shadow value
|
531
|
+
#
|
532
|
+
# @param sm [String] Small shadow value
|
533
|
+
#
|
534
|
+
# @param xl [String] Extra large shadow value
|
535
|
+
end
|
536
|
+
|
537
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide#typography
|
538
|
+
class Typography < BrandDev::Internal::Type::BaseModel
|
539
|
+
# @!attribute headings
|
540
|
+
# Heading styles
|
541
|
+
#
|
542
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings, nil]
|
543
|
+
optional :headings, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings }
|
544
|
+
|
545
|
+
# @!attribute p_
|
546
|
+
# Paragraph text styles
|
547
|
+
#
|
548
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P, nil]
|
549
|
+
optional :p_, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P }, api_name: :p
|
550
|
+
|
551
|
+
# @!method initialize(headings: nil, p_: nil)
|
552
|
+
# Typography styles used on the website
|
553
|
+
#
|
554
|
+
# @param headings [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings] Heading styles
|
555
|
+
#
|
556
|
+
# @param p_ [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::P] Paragraph text styles
|
557
|
+
|
558
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#headings
|
559
|
+
class Headings < BrandDev::Internal::Type::BaseModel
|
560
|
+
# @!attribute h1
|
561
|
+
#
|
562
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1, nil]
|
563
|
+
optional :h1, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1 }
|
564
|
+
|
565
|
+
# @!attribute h2
|
566
|
+
#
|
567
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2, nil]
|
568
|
+
optional :h2, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2 }
|
569
|
+
|
570
|
+
# @!attribute h3
|
571
|
+
#
|
572
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3, nil]
|
573
|
+
optional :h3, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3 }
|
574
|
+
|
575
|
+
# @!attribute h4
|
576
|
+
#
|
577
|
+
# @return [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4, nil]
|
578
|
+
optional :h4, -> { BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4 }
|
579
|
+
|
580
|
+
# @!method initialize(h1: nil, h2: nil, h3: nil, h4: nil)
|
581
|
+
# Heading styles
|
582
|
+
#
|
583
|
+
# @param h1 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H1]
|
584
|
+
# @param h2 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H2]
|
585
|
+
# @param h3 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H3]
|
586
|
+
# @param h4 [BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings::H4]
|
587
|
+
|
588
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h1
|
589
|
+
class H1 < BrandDev::Internal::Type::BaseModel
|
590
|
+
# @!attribute font_family
|
591
|
+
#
|
592
|
+
# @return [String, nil]
|
593
|
+
optional :font_family, String, api_name: :fontFamily
|
594
|
+
|
595
|
+
# @!attribute font_size
|
596
|
+
#
|
597
|
+
# @return [String, nil]
|
598
|
+
optional :font_size, String, api_name: :fontSize
|
599
|
+
|
600
|
+
# @!attribute font_weight
|
601
|
+
#
|
602
|
+
# @return [Float, nil]
|
603
|
+
optional :font_weight, Float, api_name: :fontWeight
|
604
|
+
|
605
|
+
# @!attribute letter_spacing
|
606
|
+
#
|
607
|
+
# @return [String, nil]
|
608
|
+
optional :letter_spacing, String, api_name: :letterSpacing
|
609
|
+
|
610
|
+
# @!attribute line_height
|
611
|
+
#
|
612
|
+
# @return [String, nil]
|
613
|
+
optional :line_height, String, api_name: :lineHeight
|
614
|
+
|
615
|
+
# @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
|
616
|
+
# @param font_family [String]
|
617
|
+
# @param font_size [String]
|
618
|
+
# @param font_weight [Float]
|
619
|
+
# @param letter_spacing [String]
|
620
|
+
# @param line_height [String]
|
621
|
+
end
|
622
|
+
|
623
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h2
|
624
|
+
class H2 < BrandDev::Internal::Type::BaseModel
|
625
|
+
# @!attribute font_family
|
626
|
+
#
|
627
|
+
# @return [String, nil]
|
628
|
+
optional :font_family, String, api_name: :fontFamily
|
629
|
+
|
630
|
+
# @!attribute font_size
|
631
|
+
#
|
632
|
+
# @return [String, nil]
|
633
|
+
optional :font_size, String, api_name: :fontSize
|
634
|
+
|
635
|
+
# @!attribute font_weight
|
636
|
+
#
|
637
|
+
# @return [Float, nil]
|
638
|
+
optional :font_weight, Float, api_name: :fontWeight
|
639
|
+
|
640
|
+
# @!attribute letter_spacing
|
641
|
+
#
|
642
|
+
# @return [String, nil]
|
643
|
+
optional :letter_spacing, String, api_name: :letterSpacing
|
644
|
+
|
645
|
+
# @!attribute line_height
|
646
|
+
#
|
647
|
+
# @return [String, nil]
|
648
|
+
optional :line_height, String, api_name: :lineHeight
|
649
|
+
|
650
|
+
# @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
|
651
|
+
# @param font_family [String]
|
652
|
+
# @param font_size [String]
|
653
|
+
# @param font_weight [Float]
|
654
|
+
# @param letter_spacing [String]
|
655
|
+
# @param line_height [String]
|
656
|
+
end
|
657
|
+
|
658
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h3
|
659
|
+
class H3 < BrandDev::Internal::Type::BaseModel
|
660
|
+
# @!attribute font_family
|
661
|
+
#
|
662
|
+
# @return [String, nil]
|
663
|
+
optional :font_family, String, api_name: :fontFamily
|
664
|
+
|
665
|
+
# @!attribute font_size
|
666
|
+
#
|
667
|
+
# @return [String, nil]
|
668
|
+
optional :font_size, String, api_name: :fontSize
|
669
|
+
|
670
|
+
# @!attribute font_weight
|
671
|
+
#
|
672
|
+
# @return [Float, nil]
|
673
|
+
optional :font_weight, Float, api_name: :fontWeight
|
674
|
+
|
675
|
+
# @!attribute letter_spacing
|
676
|
+
#
|
677
|
+
# @return [String, nil]
|
678
|
+
optional :letter_spacing, String, api_name: :letterSpacing
|
679
|
+
|
680
|
+
# @!attribute line_height
|
681
|
+
#
|
682
|
+
# @return [String, nil]
|
683
|
+
optional :line_height, String, api_name: :lineHeight
|
684
|
+
|
685
|
+
# @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
|
686
|
+
# @param font_family [String]
|
687
|
+
# @param font_size [String]
|
688
|
+
# @param font_weight [Float]
|
689
|
+
# @param letter_spacing [String]
|
690
|
+
# @param line_height [String]
|
691
|
+
end
|
692
|
+
|
693
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography::Headings#h4
|
694
|
+
class H4 < BrandDev::Internal::Type::BaseModel
|
695
|
+
# @!attribute font_family
|
696
|
+
#
|
697
|
+
# @return [String, nil]
|
698
|
+
optional :font_family, String, api_name: :fontFamily
|
699
|
+
|
700
|
+
# @!attribute font_size
|
701
|
+
#
|
702
|
+
# @return [String, nil]
|
703
|
+
optional :font_size, String, api_name: :fontSize
|
704
|
+
|
705
|
+
# @!attribute font_weight
|
706
|
+
#
|
707
|
+
# @return [Float, nil]
|
708
|
+
optional :font_weight, Float, api_name: :fontWeight
|
709
|
+
|
710
|
+
# @!attribute letter_spacing
|
711
|
+
#
|
712
|
+
# @return [String, nil]
|
713
|
+
optional :letter_spacing, String, api_name: :letterSpacing
|
714
|
+
|
715
|
+
# @!attribute line_height
|
716
|
+
#
|
717
|
+
# @return [String, nil]
|
718
|
+
optional :line_height, String, api_name: :lineHeight
|
719
|
+
|
720
|
+
# @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
|
721
|
+
# @param font_family [String]
|
722
|
+
# @param font_size [String]
|
723
|
+
# @param font_weight [Float]
|
724
|
+
# @param letter_spacing [String]
|
725
|
+
# @param line_height [String]
|
726
|
+
end
|
727
|
+
end
|
728
|
+
|
729
|
+
# @see BrandDev::Models::BrandStyleguideResponse::Styleguide::Typography#p_
|
730
|
+
class P < BrandDev::Internal::Type::BaseModel
|
731
|
+
# @!attribute font_family
|
732
|
+
#
|
733
|
+
# @return [String, nil]
|
734
|
+
optional :font_family, String, api_name: :fontFamily
|
735
|
+
|
736
|
+
# @!attribute font_size
|
737
|
+
#
|
738
|
+
# @return [String, nil]
|
739
|
+
optional :font_size, String, api_name: :fontSize
|
740
|
+
|
741
|
+
# @!attribute font_weight
|
742
|
+
#
|
743
|
+
# @return [Float, nil]
|
744
|
+
optional :font_weight, Float, api_name: :fontWeight
|
745
|
+
|
746
|
+
# @!attribute letter_spacing
|
747
|
+
#
|
748
|
+
# @return [String, nil]
|
749
|
+
optional :letter_spacing, String, api_name: :letterSpacing
|
750
|
+
|
751
|
+
# @!attribute line_height
|
752
|
+
#
|
753
|
+
# @return [String, nil]
|
754
|
+
optional :line_height, String, api_name: :lineHeight
|
755
|
+
|
756
|
+
# @!method initialize(font_family: nil, font_size: nil, font_weight: nil, letter_spacing: nil, line_height: nil)
|
757
|
+
# Paragraph text styles
|
758
|
+
#
|
759
|
+
# @param font_family [String]
|
760
|
+
# @param font_size [String]
|
761
|
+
# @param font_weight [Float]
|
762
|
+
# @param letter_spacing [String]
|
763
|
+
# @param line_height [String]
|
764
|
+
end
|
765
|
+
end
|
766
|
+
end
|
767
|
+
end
|
768
|
+
end
|
769
|
+
end
|