brand.dev 0.1.0.pre.alpha.13 → 0.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +49 -0
- data/README.md +1 -1
- data/lib/brand_dev/internal/transport/base_client.rb +10 -2
- data/lib/brand_dev/models/brand_ai_query_response.rb +9 -1
- data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +90 -43
- data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +89 -43
- data/lib/brand_dev/models/brand_retrieve_response.rb +89 -44
- data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +46 -19
- data/lib/brand_dev/models.rb +0 -2
- data/lib/brand_dev/resources/brand.rb +0 -27
- data/lib/brand_dev/version.rb +1 -1
- data/lib/brand_dev.rb +0 -2
- data/rbi/brand_dev/models/brand_ai_query_response.rbi +11 -0
- data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +195 -90
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +195 -90
- data/rbi/brand_dev/models/brand_retrieve_response.rbi +195 -88
- data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +121 -25
- data/rbi/brand_dev/models.rbi +0 -2
- data/rbi/brand_dev/resources/brand.rbi +0 -19
- data/sig/brand_dev/models/brand_ai_query_response.rbs +7 -0
- data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +91 -42
- data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +91 -42
- data/sig/brand_dev/models/brand_retrieve_response.rbs +91 -42
- data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +37 -17
- data/sig/brand_dev/models.rbs +0 -2
- data/sig/brand_dev/resources/brand.rbs +0 -6
- metadata +4 -10
- data/lib/brand_dev/models/brand_search_params.rb +0 -35
- data/lib/brand_dev/models/brand_search_response.rb +0 -35
- data/rbi/brand_dev/models/brand_search_params.rbi +0 -58
- data/rbi/brand_dev/models/brand_search_response.rbi +0 -63
- data/sig/brand_dev/models/brand_search_params.rbs +0 -30
- data/sig/brand_dev/models/brand_search_response.rbs +0 -29
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: df28fd5aa0d8231a27a6b3c155f9000846e642c65fc753f1774bd6c0e58a014b
|
4
|
+
data.tar.gz: a55600ebc91b03e85320b577705bbd1e5ad3edd60ed6b7b2dbfb5cb1af9089bd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5d6cdee2fb3161e12e02d0645fbf71508664827af349b769d2f148db5f53df609b135fc556303160711ca287655fbe646aed2826495663d0df3173cb0baea1f4
|
7
|
+
data.tar.gz: 5b6f254d84d2d883ba3c07fe4f86768f10e7fb82651f9f587fe4eb21a81313b98790358ab120275240152c186be0d42568bc106682d0acfab95766b669bdabdb
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,54 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.2.0 (2025-07-31)
|
4
|
+
|
5
|
+
Full Changelog: [v0.1.0...v0.2.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0...v0.2.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** manual updates ([9e2f31d](https://github.com/brand-dot-dev/ruby-sdk/commit/9e2f31dc4082586468781ae4d25c58155eb2d119))
|
10
|
+
|
11
|
+
## 0.1.0 (2025-07-29)
|
12
|
+
|
13
|
+
Full Changelog: [v0.0.2...v0.1.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.2...v0.1.0)
|
14
|
+
|
15
|
+
### Features
|
16
|
+
|
17
|
+
* **api:** manual updates ([16b9bdc](https://github.com/brand-dot-dev/ruby-sdk/commit/16b9bdcdbcbac819a1120c93399195b102db34ed))
|
18
|
+
|
19
|
+
|
20
|
+
### Bug Fixes
|
21
|
+
|
22
|
+
* **internal:** ensure sorbet test always runs serially ([b780fe6](https://github.com/brand-dot-dev/ruby-sdk/commit/b780fe622148d3af2db69a59c16470ebf82b3702))
|
23
|
+
|
24
|
+
|
25
|
+
### Chores
|
26
|
+
|
27
|
+
* **internal:** version bump ([d7516ea](https://github.com/brand-dot-dev/ruby-sdk/commit/d7516ea2cf7f6c5b21236d90fca254a91476d5ad))
|
28
|
+
* update contribute.md ([05a6bc4](https://github.com/brand-dot-dev/ruby-sdk/commit/05a6bc4264abb72f63d72ee43a0ba2fac7fd0511))
|
29
|
+
|
30
|
+
## 0.0.2 (2025-07-21)
|
31
|
+
|
32
|
+
Full Changelog: [v0.0.1...v0.0.2](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.1...v0.0.2)
|
33
|
+
|
34
|
+
### Chores
|
35
|
+
|
36
|
+
* **internal:** version bump ([c8553b7](https://github.com/brand-dot-dev/ruby-sdk/commit/c8553b728303284cda46b2a980743c5533932fdd))
|
37
|
+
|
38
|
+
## 0.0.1 (2025-07-21)
|
39
|
+
|
40
|
+
Full Changelog: [v0.1.0-alpha.13...v0.0.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.13...v0.0.1)
|
41
|
+
|
42
|
+
### Features
|
43
|
+
|
44
|
+
* **api:** manual updates ([cfaabba](https://github.com/brand-dot-dev/ruby-sdk/commit/cfaabbab93b68ba4926f78560d759d788e4b4b98))
|
45
|
+
|
46
|
+
|
47
|
+
### Chores
|
48
|
+
|
49
|
+
* **internal:** allow streams to also be unwrapped on a per-row basis ([99d7893](https://github.com/brand-dot-dev/ruby-sdk/commit/99d7893d01a3e111d49fb7c39e53bc9dd524f6b6))
|
50
|
+
* **internal:** version bump ([d51ca58](https://github.com/brand-dot-dev/ruby-sdk/commit/d51ca5841eb432576fb2e251d4ebdab02cfb1ad7))
|
51
|
+
|
3
52
|
## 0.1.0-alpha.13 (2025-06-29)
|
4
53
|
|
5
54
|
Full Changelog: [v0.1.0-alpha.12...v0.1.0-alpha.13](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0-alpha.12...v0.1.0-alpha.13)
|
data/README.md
CHANGED
@@ -471,6 +471,7 @@ module BrandDev
|
|
471
471
|
self.class.validate!(req)
|
472
472
|
model = req.fetch(:model) { BrandDev::Internal::Type::Unknown }
|
473
473
|
opts = req[:options].to_h
|
474
|
+
unwrap = req[:unwrap]
|
474
475
|
BrandDev::RequestOptions.validate!(opts)
|
475
476
|
request = build_request(req.except(:options), opts)
|
476
477
|
url = request.fetch(:url)
|
@@ -487,11 +488,18 @@ module BrandDev
|
|
487
488
|
decoded = BrandDev::Internal::Util.decode_content(response, stream: stream)
|
488
489
|
case req
|
489
490
|
in {stream: Class => st}
|
490
|
-
st.new(
|
491
|
+
st.new(
|
492
|
+
model: model,
|
493
|
+
url: url,
|
494
|
+
status: status,
|
495
|
+
response: response,
|
496
|
+
unwrap: unwrap,
|
497
|
+
stream: decoded
|
498
|
+
)
|
491
499
|
in {page: Class => page}
|
492
500
|
page.new(client: self, req: req, headers: response, page_data: decoded)
|
493
501
|
else
|
494
|
-
unwrapped = BrandDev::Internal::Util.dig(decoded,
|
502
|
+
unwrapped = BrandDev::Internal::Util.dig(decoded, unwrap)
|
495
503
|
BrandDev::Internal::Type::Converter.coerce(model, unwrapped)
|
496
504
|
end
|
497
505
|
end
|
@@ -17,17 +17,25 @@ module BrandDev
|
|
17
17
|
# @return [String, nil]
|
18
18
|
optional :domain, String
|
19
19
|
|
20
|
+
# @!attribute status
|
21
|
+
# Status of the response, e.g., 'ok'
|
22
|
+
#
|
23
|
+
# @return [String, nil]
|
24
|
+
optional :status, String
|
25
|
+
|
20
26
|
# @!attribute urls_analyzed
|
21
27
|
# List of URLs that were analyzed
|
22
28
|
#
|
23
29
|
# @return [Array<String>, nil]
|
24
30
|
optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String]
|
25
31
|
|
26
|
-
# @!method initialize(data_extracted: nil, domain: nil, urls_analyzed: nil)
|
32
|
+
# @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil)
|
27
33
|
# @param data_extracted [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>] Array of extracted data points
|
28
34
|
#
|
29
35
|
# @param domain [String] The domain that was analyzed
|
30
36
|
#
|
37
|
+
# @param status [String] Status of the response, e.g., 'ok'
|
38
|
+
#
|
31
39
|
# @param urls_analyzed [Array<String>] List of URLs that were analyzed
|
32
40
|
|
33
41
|
class DataExtracted < BrandDev::Internal::Type::BaseModel
|
@@ -63,12 +63,17 @@ module BrandDev
|
|
63
63
|
# @return [String, nil]
|
64
64
|
optional :domain, String
|
65
65
|
|
66
|
-
# @!attribute
|
67
|
-
#
|
66
|
+
# @!attribute email
|
67
|
+
# Company email address
|
68
68
|
#
|
69
|
-
# @return [
|
70
|
-
optional :
|
71
|
-
|
69
|
+
# @return [String, nil]
|
70
|
+
optional :email, String
|
71
|
+
|
72
|
+
# @!attribute is_nsfw
|
73
|
+
# Indicates whether the brand content is not safe for work (NSFW)
|
74
|
+
#
|
75
|
+
# @return [Boolean, nil]
|
76
|
+
optional :is_nsfw, BrandDev::Internal::Type::Boolean
|
72
77
|
|
73
78
|
# @!attribute logos
|
74
79
|
# An array of logos associated with the brand
|
@@ -77,6 +82,12 @@ module BrandDev
|
|
77
82
|
optional :logos,
|
78
83
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo] }
|
79
84
|
|
85
|
+
# @!attribute phone
|
86
|
+
# Company phone number
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
optional :phone, String
|
90
|
+
|
80
91
|
# @!attribute slogan
|
81
92
|
# The brand's slogan
|
82
93
|
#
|
@@ -103,7 +114,7 @@ module BrandDev
|
|
103
114
|
# @return [String, nil]
|
104
115
|
optional :title, String
|
105
116
|
|
106
|
-
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil,
|
117
|
+
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, is_nsfw: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil)
|
107
118
|
# Some parameter documentations has been truncated, see
|
108
119
|
# {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more
|
109
120
|
# details.
|
@@ -120,10 +131,14 @@ module BrandDev
|
|
120
131
|
#
|
121
132
|
# @param domain [String] The domain name of the brand
|
122
133
|
#
|
123
|
-
# @param
|
134
|
+
# @param email [String] Company email address
|
135
|
+
#
|
136
|
+
# @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
|
124
137
|
#
|
125
138
|
# @param logos [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo>] An array of logos associated with the brand
|
126
139
|
#
|
140
|
+
# @param phone [String] Company phone number
|
141
|
+
#
|
127
142
|
# @param slogan [String] The brand's slogan
|
128
143
|
#
|
129
144
|
# @param socials [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social>] An array of social media links for the brand
|
@@ -243,6 +258,12 @@ module BrandDev
|
|
243
258
|
|
244
259
|
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Backdrop#resolution
|
245
260
|
class Resolution < BrandDev::Internal::Type::BaseModel
|
261
|
+
# @!attribute aspect_ratio
|
262
|
+
# Aspect ratio of the image (width/height)
|
263
|
+
#
|
264
|
+
# @return [Float, nil]
|
265
|
+
optional :aspect_ratio, Float
|
266
|
+
|
246
267
|
# @!attribute height
|
247
268
|
# Height of the image in pixels
|
248
269
|
#
|
@@ -255,9 +276,11 @@ module BrandDev
|
|
255
276
|
# @return [Integer, nil]
|
256
277
|
optional :width, Integer
|
257
278
|
|
258
|
-
# @!method initialize(height: nil, width: nil)
|
279
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
259
280
|
# Resolution of the backdrop image
|
260
281
|
#
|
282
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
283
|
+
#
|
261
284
|
# @param height [Integer] Height of the image in pixels
|
262
285
|
#
|
263
286
|
# @param width [Integer] Width of the image in pixels
|
@@ -283,25 +306,6 @@ module BrandDev
|
|
283
306
|
# @param name [String] Name of the color
|
284
307
|
end
|
285
308
|
|
286
|
-
class Font < BrandDev::Internal::Type::BaseModel
|
287
|
-
# @!attribute name
|
288
|
-
# Name of the font
|
289
|
-
#
|
290
|
-
# @return [String, nil]
|
291
|
-
optional :name, String
|
292
|
-
|
293
|
-
# @!attribute usage
|
294
|
-
# Usage of the font, e.g., 'title', 'body', 'button'
|
295
|
-
#
|
296
|
-
# @return [String, nil]
|
297
|
-
optional :usage, String
|
298
|
-
|
299
|
-
# @!method initialize(name: nil, usage: nil)
|
300
|
-
# @param name [String] Name of the font
|
301
|
-
#
|
302
|
-
# @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
|
303
|
-
end
|
304
|
-
|
305
309
|
class Logo < BrandDev::Internal::Type::BaseModel
|
306
310
|
# @!attribute colors
|
307
311
|
# Array of colors in the logo
|
@@ -310,17 +314,13 @@ module BrandDev
|
|
310
314
|
optional :colors,
|
311
315
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color] }
|
312
316
|
|
313
|
-
# @!attribute group
|
314
|
-
# Group identifier for logos
|
315
|
-
#
|
316
|
-
# @return [Integer, nil]
|
317
|
-
optional :group, Integer
|
318
|
-
|
319
317
|
# @!attribute mode
|
320
|
-
#
|
318
|
+
# Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
319
|
+
# best for dark mode, 'has_opaque_background' = can be used for either as image
|
320
|
+
# has its own background
|
321
321
|
#
|
322
|
-
# @return [
|
323
|
-
optional :mode,
|
322
|
+
# @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode, nil]
|
323
|
+
optional :mode, enum: -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode }
|
324
324
|
|
325
325
|
# @!attribute resolution
|
326
326
|
# Resolution of the logo image
|
@@ -329,22 +329,32 @@ module BrandDev
|
|
329
329
|
optional :resolution,
|
330
330
|
-> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution }
|
331
331
|
|
332
|
+
# @!attribute type
|
333
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
334
|
+
#
|
335
|
+
# @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type, nil]
|
336
|
+
optional :type, enum: -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type }
|
337
|
+
|
332
338
|
# @!attribute url
|
333
|
-
#
|
339
|
+
# CDN hosted url of the logo (ready for display)
|
334
340
|
#
|
335
341
|
# @return [String, nil]
|
336
342
|
optional :url, String
|
337
343
|
|
338
|
-
# @!method initialize(colors: nil,
|
339
|
-
#
|
344
|
+
# @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
|
345
|
+
# Some parameter documentations has been truncated, see
|
346
|
+
# {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo} for more
|
347
|
+
# details.
|
340
348
|
#
|
341
|
-
# @param
|
349
|
+
# @param colors [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color>] Array of colors in the logo
|
342
350
|
#
|
343
|
-
# @param mode [
|
351
|
+
# @param mode [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
|
344
352
|
#
|
345
353
|
# @param resolution [BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution] Resolution of the logo image
|
346
354
|
#
|
347
|
-
# @param
|
355
|
+
# @param type [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
|
356
|
+
#
|
357
|
+
# @param url [String] CDN hosted url of the logo (ready for display)
|
348
358
|
|
349
359
|
class Color < BrandDev::Internal::Type::BaseModel
|
350
360
|
# @!attribute hex
|
@@ -365,8 +375,30 @@ module BrandDev
|
|
365
375
|
# @param name [String] Name of the color
|
366
376
|
end
|
367
377
|
|
378
|
+
# Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
379
|
+
# best for dark mode, 'has_opaque_background' = can be used for either as image
|
380
|
+
# has its own background
|
381
|
+
#
|
382
|
+
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo#mode
|
383
|
+
module Mode
|
384
|
+
extend BrandDev::Internal::Type::Enum
|
385
|
+
|
386
|
+
LIGHT = :light
|
387
|
+
DARK = :dark
|
388
|
+
HAS_OPAQUE_BACKGROUND = :has_opaque_background
|
389
|
+
|
390
|
+
# @!method self.values
|
391
|
+
# @return [Array<Symbol>]
|
392
|
+
end
|
393
|
+
|
368
394
|
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo#resolution
|
369
395
|
class Resolution < BrandDev::Internal::Type::BaseModel
|
396
|
+
# @!attribute aspect_ratio
|
397
|
+
# Aspect ratio of the image (width/height)
|
398
|
+
#
|
399
|
+
# @return [Float, nil]
|
400
|
+
optional :aspect_ratio, Float
|
401
|
+
|
370
402
|
# @!attribute height
|
371
403
|
# Height of the image in pixels
|
372
404
|
#
|
@@ -379,13 +411,28 @@ module BrandDev
|
|
379
411
|
# @return [Integer, nil]
|
380
412
|
optional :width, Integer
|
381
413
|
|
382
|
-
# @!method initialize(height: nil, width: nil)
|
414
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
383
415
|
# Resolution of the logo image
|
384
416
|
#
|
417
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
418
|
+
#
|
385
419
|
# @param height [Integer] Height of the image in pixels
|
386
420
|
#
|
387
421
|
# @param width [Integer] Width of the image in pixels
|
388
422
|
end
|
423
|
+
|
424
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
425
|
+
#
|
426
|
+
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo#type
|
427
|
+
module Type
|
428
|
+
extend BrandDev::Internal::Type::Enum
|
429
|
+
|
430
|
+
ICON = :icon
|
431
|
+
LOGO = :logo
|
432
|
+
|
433
|
+
# @!method self.values
|
434
|
+
# @return [Array<Symbol>]
|
435
|
+
end
|
389
436
|
end
|
390
437
|
|
391
438
|
class Social < BrandDev::Internal::Type::BaseModel
|
@@ -63,12 +63,17 @@ module BrandDev
|
|
63
63
|
# @return [String, nil]
|
64
64
|
optional :domain, String
|
65
65
|
|
66
|
-
# @!attribute
|
67
|
-
#
|
66
|
+
# @!attribute email
|
67
|
+
# Company email address
|
68
68
|
#
|
69
|
-
# @return [
|
70
|
-
optional :
|
71
|
-
|
69
|
+
# @return [String, nil]
|
70
|
+
optional :email, String
|
71
|
+
|
72
|
+
# @!attribute is_nsfw
|
73
|
+
# Indicates whether the brand content is not safe for work (NSFW)
|
74
|
+
#
|
75
|
+
# @return [Boolean, nil]
|
76
|
+
optional :is_nsfw, BrandDev::Internal::Type::Boolean
|
72
77
|
|
73
78
|
# @!attribute logos
|
74
79
|
# An array of logos associated with the brand
|
@@ -77,6 +82,12 @@ module BrandDev
|
|
77
82
|
optional :logos,
|
78
83
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo] }
|
79
84
|
|
85
|
+
# @!attribute phone
|
86
|
+
# Company phone number
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
optional :phone, String
|
90
|
+
|
80
91
|
# @!attribute slogan
|
81
92
|
# The brand's slogan
|
82
93
|
#
|
@@ -103,7 +114,7 @@ module BrandDev
|
|
103
114
|
# @return [String, nil]
|
104
115
|
optional :title, String
|
105
116
|
|
106
|
-
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil,
|
117
|
+
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, email: nil, is_nsfw: nil, logos: nil, phone: nil, slogan: nil, socials: nil, stock: nil, title: nil)
|
107
118
|
# Some parameter documentations has been truncated, see
|
108
119
|
# {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details.
|
109
120
|
#
|
@@ -119,10 +130,14 @@ module BrandDev
|
|
119
130
|
#
|
120
131
|
# @param domain [String] The domain name of the brand
|
121
132
|
#
|
122
|
-
# @param
|
133
|
+
# @param email [String] Company email address
|
134
|
+
#
|
135
|
+
# @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
|
123
136
|
#
|
124
137
|
# @param logos [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>] An array of logos associated with the brand
|
125
138
|
#
|
139
|
+
# @param phone [String] Company phone number
|
140
|
+
#
|
126
141
|
# @param slogan [String] The brand's slogan
|
127
142
|
#
|
128
143
|
# @param socials [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social>] An array of social media links for the brand
|
@@ -241,6 +256,12 @@ module BrandDev
|
|
241
256
|
|
242
257
|
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop#resolution
|
243
258
|
class Resolution < BrandDev::Internal::Type::BaseModel
|
259
|
+
# @!attribute aspect_ratio
|
260
|
+
# Aspect ratio of the image (width/height)
|
261
|
+
#
|
262
|
+
# @return [Float, nil]
|
263
|
+
optional :aspect_ratio, Float
|
264
|
+
|
244
265
|
# @!attribute height
|
245
266
|
# Height of the image in pixels
|
246
267
|
#
|
@@ -253,9 +274,11 @@ module BrandDev
|
|
253
274
|
# @return [Integer, nil]
|
254
275
|
optional :width, Integer
|
255
276
|
|
256
|
-
# @!method initialize(height: nil, width: nil)
|
277
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
257
278
|
# Resolution of the backdrop image
|
258
279
|
#
|
280
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
281
|
+
#
|
259
282
|
# @param height [Integer] Height of the image in pixels
|
260
283
|
#
|
261
284
|
# @param width [Integer] Width of the image in pixels
|
@@ -281,25 +304,6 @@ module BrandDev
|
|
281
304
|
# @param name [String] Name of the color
|
282
305
|
end
|
283
306
|
|
284
|
-
class Font < BrandDev::Internal::Type::BaseModel
|
285
|
-
# @!attribute name
|
286
|
-
# Name of the font
|
287
|
-
#
|
288
|
-
# @return [String, nil]
|
289
|
-
optional :name, String
|
290
|
-
|
291
|
-
# @!attribute usage
|
292
|
-
# Usage of the font, e.g., 'title', 'body', 'button'
|
293
|
-
#
|
294
|
-
# @return [String, nil]
|
295
|
-
optional :usage, String
|
296
|
-
|
297
|
-
# @!method initialize(name: nil, usage: nil)
|
298
|
-
# @param name [String] Name of the font
|
299
|
-
#
|
300
|
-
# @param usage [String] Usage of the font, e.g., 'title', 'body', 'button'
|
301
|
-
end
|
302
|
-
|
303
307
|
class Logo < BrandDev::Internal::Type::BaseModel
|
304
308
|
# @!attribute colors
|
305
309
|
# Array of colors in the logo
|
@@ -308,17 +312,13 @@ module BrandDev
|
|
308
312
|
optional :colors,
|
309
313
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color] }
|
310
314
|
|
311
|
-
# @!attribute group
|
312
|
-
# Group identifier for logos
|
313
|
-
#
|
314
|
-
# @return [Integer, nil]
|
315
|
-
optional :group, Integer
|
316
|
-
|
317
315
|
# @!attribute mode
|
318
|
-
#
|
316
|
+
# Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
317
|
+
# best for dark mode, 'has_opaque_background' = can be used for either as image
|
318
|
+
# has its own background
|
319
319
|
#
|
320
|
-
# @return [
|
321
|
-
optional :mode,
|
320
|
+
# @return [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode, nil]
|
321
|
+
optional :mode, enum: -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode }
|
322
322
|
|
323
323
|
# @!attribute resolution
|
324
324
|
# Resolution of the logo image
|
@@ -326,22 +326,31 @@ module BrandDev
|
|
326
326
|
# @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution, nil]
|
327
327
|
optional :resolution, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution }
|
328
328
|
|
329
|
+
# @!attribute type
|
330
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
331
|
+
#
|
332
|
+
# @return [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type, nil]
|
333
|
+
optional :type, enum: -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type }
|
334
|
+
|
329
335
|
# @!attribute url
|
330
|
-
#
|
336
|
+
# CDN hosted url of the logo (ready for display)
|
331
337
|
#
|
332
338
|
# @return [String, nil]
|
333
339
|
optional :url, String
|
334
340
|
|
335
|
-
# @!method initialize(colors: nil,
|
336
|
-
#
|
341
|
+
# @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
|
342
|
+
# Some parameter documentations has been truncated, see
|
343
|
+
# {BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo} for more details.
|
337
344
|
#
|
338
|
-
# @param
|
345
|
+
# @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>] Array of colors in the logo
|
339
346
|
#
|
340
|
-
# @param mode [
|
347
|
+
# @param mode [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
|
341
348
|
#
|
342
349
|
# @param resolution [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution] Resolution of the logo image
|
343
350
|
#
|
344
|
-
# @param
|
351
|
+
# @param type [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
|
352
|
+
#
|
353
|
+
# @param url [String] CDN hosted url of the logo (ready for display)
|
345
354
|
|
346
355
|
class Color < BrandDev::Internal::Type::BaseModel
|
347
356
|
# @!attribute hex
|
@@ -362,8 +371,30 @@ module BrandDev
|
|
362
371
|
# @param name [String] Name of the color
|
363
372
|
end
|
364
373
|
|
374
|
+
# Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
|
375
|
+
# best for dark mode, 'has_opaque_background' = can be used for either as image
|
376
|
+
# has its own background
|
377
|
+
#
|
378
|
+
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo#mode
|
379
|
+
module Mode
|
380
|
+
extend BrandDev::Internal::Type::Enum
|
381
|
+
|
382
|
+
LIGHT = :light
|
383
|
+
DARK = :dark
|
384
|
+
HAS_OPAQUE_BACKGROUND = :has_opaque_background
|
385
|
+
|
386
|
+
# @!method self.values
|
387
|
+
# @return [Array<Symbol>]
|
388
|
+
end
|
389
|
+
|
365
390
|
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo#resolution
|
366
391
|
class Resolution < BrandDev::Internal::Type::BaseModel
|
392
|
+
# @!attribute aspect_ratio
|
393
|
+
# Aspect ratio of the image (width/height)
|
394
|
+
#
|
395
|
+
# @return [Float, nil]
|
396
|
+
optional :aspect_ratio, Float
|
397
|
+
|
367
398
|
# @!attribute height
|
368
399
|
# Height of the image in pixels
|
369
400
|
#
|
@@ -376,13 +407,28 @@ module BrandDev
|
|
376
407
|
# @return [Integer, nil]
|
377
408
|
optional :width, Integer
|
378
409
|
|
379
|
-
# @!method initialize(height: nil, width: nil)
|
410
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
380
411
|
# Resolution of the logo image
|
381
412
|
#
|
413
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
414
|
+
#
|
382
415
|
# @param height [Integer] Height of the image in pixels
|
383
416
|
#
|
384
417
|
# @param width [Integer] Width of the image in pixels
|
385
418
|
end
|
419
|
+
|
420
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
421
|
+
#
|
422
|
+
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo#type
|
423
|
+
module Type
|
424
|
+
extend BrandDev::Internal::Type::Enum
|
425
|
+
|
426
|
+
ICON = :icon
|
427
|
+
LOGO = :logo
|
428
|
+
|
429
|
+
# @!method self.values
|
430
|
+
# @return [Array<Symbol>]
|
431
|
+
end
|
386
432
|
end
|
387
433
|
|
388
434
|
class Social < BrandDev::Internal::Type::BaseModel
|