brand.dev 0.1.0 → 0.2.1
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 +16 -0
- data/README.md +1 -1
- data/lib/brand_dev/internal/transport/base_client.rb +1 -1
- data/lib/brand_dev/models/brand_ai_query_response.rb +1 -9
- data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +85 -18
- data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +84 -18
- data/lib/brand_dev/models/brand_retrieve_response.rb +84 -18
- data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +46 -19
- data/lib/brand_dev/version.rb +1 -1
- data/rbi/brand_dev/internal/transport/base_client.rbi +1 -1
- data/rbi/brand_dev/models/brand_ai_query_response.rbi +0 -11
- data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +186 -23
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +186 -23
- data/rbi/brand_dev/models/brand_retrieve_response.rbi +186 -23
- data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +121 -25
- data/sig/brand_dev/internal/transport/base_client.rbs +1 -1
- data/sig/brand_dev/models/brand_ai_query_response.rbs +0 -7
- data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +86 -19
- data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +86 -19
- data/sig/brand_dev/models/brand_retrieve_response.rbs +86 -19
- data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +37 -17
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c1733af9001125a6d8043d5b1cc26bd9daebe84de1815720f1b27d91600d69bb
|
4
|
+
data.tar.gz: 12ca79b8f074d7adbdcc99f5b2caa74dce3af2bd1aa38c7a6693a2467e6e4e17
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e07bc91cf68b05b3382dc7194c8b152e5fec14499d6f10c335b810bdf1366421c746eb11437ef255406736d9bd9390b9c790cb49b10d850ee416a85d8ecad3c2
|
7
|
+
data.tar.gz: c8b69abe8f13128a313e83033ab45058aa62db44d7b84a53120f75c18b70917988f2cb6d30afe9dc9414b2a49bd925637fc2efdbd5bf4ed03b85ce76ea5a4695
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 0.2.1 (2025-08-01)
|
4
|
+
|
5
|
+
Full Changelog: [v0.2.0...v0.2.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.2.0...v0.2.1)
|
6
|
+
|
7
|
+
### Chores
|
8
|
+
|
9
|
+
* **internal:** increase visibility of internal helper method ([cfabb97](https://github.com/brand-dot-dev/ruby-sdk/commit/cfabb971de6365cbc73952eb438d4d9ecfb5407c))
|
10
|
+
|
11
|
+
## 0.2.0 (2025-07-31)
|
12
|
+
|
13
|
+
Full Changelog: [v0.1.0...v0.2.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.1.0...v0.2.0)
|
14
|
+
|
15
|
+
### Features
|
16
|
+
|
17
|
+
* **api:** manual updates ([9e2f31d](https://github.com/brand-dot-dev/ruby-sdk/commit/9e2f31dc4082586468781ae4d25c58155eb2d119))
|
18
|
+
|
3
19
|
## 0.1.0 (2025-07-29)
|
4
20
|
|
5
21
|
Full Changelog: [v0.0.2...v0.1.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.0.2...v0.1.0)
|
data/README.md
CHANGED
@@ -365,7 +365,7 @@ module BrandDev
|
|
365
365
|
#
|
366
366
|
# @raise [BrandDev::Errors::APIError]
|
367
367
|
# @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
|
368
|
-
|
368
|
+
def send_request(request, redirect_count:, retry_count:, send_retry_header:)
|
369
369
|
url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
|
370
370
|
input = {**request.except(:timeout), deadline: BrandDev::Internal::Util.monotonic_secs + timeout}
|
371
371
|
|
@@ -4,12 +4,6 @@ module BrandDev
|
|
4
4
|
module Models
|
5
5
|
# @see BrandDev::Resources::Brand#ai_query
|
6
6
|
class BrandAIQueryResponse < BrandDev::Internal::Type::BaseModel
|
7
|
-
# @!attribute code
|
8
|
-
# HTTP status code
|
9
|
-
#
|
10
|
-
# @return [Integer, nil]
|
11
|
-
optional :code, Integer
|
12
|
-
|
13
7
|
# @!attribute data_extracted
|
14
8
|
# Array of extracted data points
|
15
9
|
#
|
@@ -35,9 +29,7 @@ module BrandDev
|
|
35
29
|
# @return [Array<String>, nil]
|
36
30
|
optional :urls_analyzed, BrandDev::Internal::Type::ArrayOf[String]
|
37
31
|
|
38
|
-
# @!method initialize(
|
39
|
-
# @param code [Integer] HTTP status code
|
40
|
-
#
|
32
|
+
# @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil)
|
41
33
|
# @param data_extracted [Array<BrandDev::Models::BrandAIQueryResponse::DataExtracted>] Array of extracted data points
|
42
34
|
#
|
43
35
|
# @param domain [String] The domain that was analyzed
|
@@ -63,6 +63,12 @@ module BrandDev
|
|
63
63
|
# @return [String, nil]
|
64
64
|
optional :domain, String
|
65
65
|
|
66
|
+
# @!attribute email
|
67
|
+
# Company email address
|
68
|
+
#
|
69
|
+
# @return [String, nil]
|
70
|
+
optional :email, String
|
71
|
+
|
66
72
|
# @!attribute is_nsfw
|
67
73
|
# Indicates whether the brand content is not safe for work (NSFW)
|
68
74
|
#
|
@@ -76,6 +82,12 @@ module BrandDev
|
|
76
82
|
optional :logos,
|
77
83
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo] }
|
78
84
|
|
85
|
+
# @!attribute phone
|
86
|
+
# Company phone number
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
optional :phone, String
|
90
|
+
|
79
91
|
# @!attribute slogan
|
80
92
|
# The brand's slogan
|
81
93
|
#
|
@@ -102,7 +114,7 @@ module BrandDev
|
|
102
114
|
# @return [String, nil]
|
103
115
|
optional :title, String
|
104
116
|
|
105
|
-
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: 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)
|
106
118
|
# Some parameter documentations has been truncated, see
|
107
119
|
# {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more
|
108
120
|
# details.
|
@@ -119,10 +131,14 @@ module BrandDev
|
|
119
131
|
#
|
120
132
|
# @param domain [String] The domain name of the brand
|
121
133
|
#
|
134
|
+
# @param email [String] Company email address
|
135
|
+
#
|
122
136
|
# @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
|
123
137
|
#
|
124
138
|
# @param logos [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo>] An array of logos associated with the brand
|
125
139
|
#
|
140
|
+
# @param phone [String] Company phone number
|
141
|
+
#
|
126
142
|
# @param slogan [String] The brand's slogan
|
127
143
|
#
|
128
144
|
# @param socials [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Social>] An array of social media links for the brand
|
@@ -242,6 +258,12 @@ module BrandDev
|
|
242
258
|
|
243
259
|
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Backdrop#resolution
|
244
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
|
+
|
245
267
|
# @!attribute height
|
246
268
|
# Height of the image in pixels
|
247
269
|
#
|
@@ -254,9 +276,11 @@ module BrandDev
|
|
254
276
|
# @return [Integer, nil]
|
255
277
|
optional :width, Integer
|
256
278
|
|
257
|
-
# @!method initialize(height: nil, width: nil)
|
279
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
258
280
|
# Resolution of the backdrop image
|
259
281
|
#
|
282
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
283
|
+
#
|
260
284
|
# @param height [Integer] Height of the image in pixels
|
261
285
|
#
|
262
286
|
# @param width [Integer] Width of the image in pixels
|
@@ -290,17 +314,13 @@ module BrandDev
|
|
290
314
|
optional :colors,
|
291
315
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color] }
|
292
316
|
|
293
|
-
# @!attribute group
|
294
|
-
# Group identifier for logos
|
295
|
-
#
|
296
|
-
# @return [Integer, nil]
|
297
|
-
optional :group, Integer
|
298
|
-
|
299
317
|
# @!attribute mode
|
300
|
-
#
|
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
|
301
321
|
#
|
302
|
-
# @return [
|
303
|
-
optional :mode,
|
322
|
+
# @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode, nil]
|
323
|
+
optional :mode, enum: -> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Mode }
|
304
324
|
|
305
325
|
# @!attribute resolution
|
306
326
|
# Resolution of the logo image
|
@@ -309,22 +329,32 @@ module BrandDev
|
|
309
329
|
optional :resolution,
|
310
330
|
-> { BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution }
|
311
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
|
+
|
312
338
|
# @!attribute url
|
313
|
-
#
|
339
|
+
# CDN hosted url of the logo (ready for display)
|
314
340
|
#
|
315
341
|
# @return [String, nil]
|
316
342
|
optional :url, String
|
317
343
|
|
318
|
-
# @!method initialize(colors: nil,
|
319
|
-
#
|
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.
|
320
348
|
#
|
321
|
-
# @param
|
349
|
+
# @param colors [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color>] Array of colors in the logo
|
322
350
|
#
|
323
|
-
# @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
|
324
352
|
#
|
325
353
|
# @param resolution [BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Resolution] Resolution of the logo image
|
326
354
|
#
|
327
|
-
# @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)
|
328
358
|
|
329
359
|
class Color < BrandDev::Internal::Type::BaseModel
|
330
360
|
# @!attribute hex
|
@@ -345,8 +375,30 @@ module BrandDev
|
|
345
375
|
# @param name [String] Name of the color
|
346
376
|
end
|
347
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
|
+
|
348
394
|
# @see BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo#resolution
|
349
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
|
+
|
350
402
|
# @!attribute height
|
351
403
|
# Height of the image in pixels
|
352
404
|
#
|
@@ -359,13 +411,28 @@ module BrandDev
|
|
359
411
|
# @return [Integer, nil]
|
360
412
|
optional :width, Integer
|
361
413
|
|
362
|
-
# @!method initialize(height: nil, width: nil)
|
414
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
363
415
|
# Resolution of the logo image
|
364
416
|
#
|
417
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
418
|
+
#
|
365
419
|
# @param height [Integer] Height of the image in pixels
|
366
420
|
#
|
367
421
|
# @param width [Integer] Width of the image in pixels
|
368
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
|
369
436
|
end
|
370
437
|
|
371
438
|
class Social < BrandDev::Internal::Type::BaseModel
|
@@ -63,6 +63,12 @@ module BrandDev
|
|
63
63
|
# @return [String, nil]
|
64
64
|
optional :domain, String
|
65
65
|
|
66
|
+
# @!attribute email
|
67
|
+
# Company email address
|
68
|
+
#
|
69
|
+
# @return [String, nil]
|
70
|
+
optional :email, String
|
71
|
+
|
66
72
|
# @!attribute is_nsfw
|
67
73
|
# Indicates whether the brand content is not safe for work (NSFW)
|
68
74
|
#
|
@@ -76,6 +82,12 @@ module BrandDev
|
|
76
82
|
optional :logos,
|
77
83
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo] }
|
78
84
|
|
85
|
+
# @!attribute phone
|
86
|
+
# Company phone number
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
optional :phone, String
|
90
|
+
|
79
91
|
# @!attribute slogan
|
80
92
|
# The brand's slogan
|
81
93
|
#
|
@@ -102,7 +114,7 @@ module BrandDev
|
|
102
114
|
# @return [String, nil]
|
103
115
|
optional :title, String
|
104
116
|
|
105
|
-
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: 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)
|
106
118
|
# Some parameter documentations has been truncated, see
|
107
119
|
# {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details.
|
108
120
|
#
|
@@ -118,10 +130,14 @@ module BrandDev
|
|
118
130
|
#
|
119
131
|
# @param domain [String] The domain name of the brand
|
120
132
|
#
|
133
|
+
# @param email [String] Company email address
|
134
|
+
#
|
121
135
|
# @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
|
122
136
|
#
|
123
137
|
# @param logos [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>] An array of logos associated with the brand
|
124
138
|
#
|
139
|
+
# @param phone [String] Company phone number
|
140
|
+
#
|
125
141
|
# @param slogan [String] The brand's slogan
|
126
142
|
#
|
127
143
|
# @param socials [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Social>] An array of social media links for the brand
|
@@ -240,6 +256,12 @@ module BrandDev
|
|
240
256
|
|
241
257
|
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Backdrop#resolution
|
242
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
|
+
|
243
265
|
# @!attribute height
|
244
266
|
# Height of the image in pixels
|
245
267
|
#
|
@@ -252,9 +274,11 @@ module BrandDev
|
|
252
274
|
# @return [Integer, nil]
|
253
275
|
optional :width, Integer
|
254
276
|
|
255
|
-
# @!method initialize(height: nil, width: nil)
|
277
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
256
278
|
# Resolution of the backdrop image
|
257
279
|
#
|
280
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
281
|
+
#
|
258
282
|
# @param height [Integer] Height of the image in pixels
|
259
283
|
#
|
260
284
|
# @param width [Integer] Width of the image in pixels
|
@@ -288,17 +312,13 @@ module BrandDev
|
|
288
312
|
optional :colors,
|
289
313
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color] }
|
290
314
|
|
291
|
-
# @!attribute group
|
292
|
-
# Group identifier for logos
|
293
|
-
#
|
294
|
-
# @return [Integer, nil]
|
295
|
-
optional :group, Integer
|
296
|
-
|
297
315
|
# @!attribute mode
|
298
|
-
#
|
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
|
299
319
|
#
|
300
|
-
# @return [
|
301
|
-
optional :mode,
|
320
|
+
# @return [Symbol, BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode, nil]
|
321
|
+
optional :mode, enum: -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Mode }
|
302
322
|
|
303
323
|
# @!attribute resolution
|
304
324
|
# Resolution of the logo image
|
@@ -306,22 +326,31 @@ module BrandDev
|
|
306
326
|
# @return [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution, nil]
|
307
327
|
optional :resolution, -> { BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution }
|
308
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
|
+
|
309
335
|
# @!attribute url
|
310
|
-
#
|
336
|
+
# CDN hosted url of the logo (ready for display)
|
311
337
|
#
|
312
338
|
# @return [String, nil]
|
313
339
|
optional :url, String
|
314
340
|
|
315
|
-
# @!method initialize(colors: nil,
|
316
|
-
#
|
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.
|
317
344
|
#
|
318
|
-
# @param
|
345
|
+
# @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>] Array of colors in the logo
|
319
346
|
#
|
320
|
-
# @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
|
321
348
|
#
|
322
349
|
# @param resolution [BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Resolution] Resolution of the logo image
|
323
350
|
#
|
324
|
-
# @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)
|
325
354
|
|
326
355
|
class Color < BrandDev::Internal::Type::BaseModel
|
327
356
|
# @!attribute hex
|
@@ -342,8 +371,30 @@ module BrandDev
|
|
342
371
|
# @param name [String] Name of the color
|
343
372
|
end
|
344
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
|
+
|
345
390
|
# @see BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo#resolution
|
346
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
|
+
|
347
398
|
# @!attribute height
|
348
399
|
# Height of the image in pixels
|
349
400
|
#
|
@@ -356,13 +407,28 @@ module BrandDev
|
|
356
407
|
# @return [Integer, nil]
|
357
408
|
optional :width, Integer
|
358
409
|
|
359
|
-
# @!method initialize(height: nil, width: nil)
|
410
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
360
411
|
# Resolution of the logo image
|
361
412
|
#
|
413
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
414
|
+
#
|
362
415
|
# @param height [Integer] Height of the image in pixels
|
363
416
|
#
|
364
417
|
# @param width [Integer] Width of the image in pixels
|
365
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
|
366
432
|
end
|
367
433
|
|
368
434
|
class Social < BrandDev::Internal::Type::BaseModel
|
@@ -63,6 +63,12 @@ module BrandDev
|
|
63
63
|
# @return [String, nil]
|
64
64
|
optional :domain, String
|
65
65
|
|
66
|
+
# @!attribute email
|
67
|
+
# Company email address
|
68
|
+
#
|
69
|
+
# @return [String, nil]
|
70
|
+
optional :email, String
|
71
|
+
|
66
72
|
# @!attribute is_nsfw
|
67
73
|
# Indicates whether the brand content is not safe for work (NSFW)
|
68
74
|
#
|
@@ -76,6 +82,12 @@ module BrandDev
|
|
76
82
|
optional :logos,
|
77
83
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Logo] }
|
78
84
|
|
85
|
+
# @!attribute phone
|
86
|
+
# Company phone number
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
optional :phone, String
|
90
|
+
|
79
91
|
# @!attribute slogan
|
80
92
|
# The brand's slogan
|
81
93
|
#
|
@@ -102,7 +114,7 @@ module BrandDev
|
|
102
114
|
# @return [String, nil]
|
103
115
|
optional :title, String
|
104
116
|
|
105
|
-
# @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, is_nsfw: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: 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)
|
106
118
|
# Some parameter documentations has been truncated, see
|
107
119
|
# {BrandDev::Models::BrandRetrieveResponse::Brand} for more details.
|
108
120
|
#
|
@@ -118,10 +130,14 @@ module BrandDev
|
|
118
130
|
#
|
119
131
|
# @param domain [String] The domain name of the brand
|
120
132
|
#
|
133
|
+
# @param email [String] Company email address
|
134
|
+
#
|
121
135
|
# @param is_nsfw [Boolean] Indicates whether the brand content is not safe for work (NSFW)
|
122
136
|
#
|
123
137
|
# @param logos [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
|
124
138
|
#
|
139
|
+
# @param phone [String] Company phone number
|
140
|
+
#
|
125
141
|
# @param slogan [String] The brand's slogan
|
126
142
|
#
|
127
143
|
# @param socials [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Social>] An array of social media links for the brand
|
@@ -240,6 +256,12 @@ module BrandDev
|
|
240
256
|
|
241
257
|
# @see BrandDev::Models::BrandRetrieveResponse::Brand::Backdrop#resolution
|
242
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
|
+
|
243
265
|
# @!attribute height
|
244
266
|
# Height of the image in pixels
|
245
267
|
#
|
@@ -252,9 +274,11 @@ module BrandDev
|
|
252
274
|
# @return [Integer, nil]
|
253
275
|
optional :width, Integer
|
254
276
|
|
255
|
-
# @!method initialize(height: nil, width: nil)
|
277
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
256
278
|
# Resolution of the backdrop image
|
257
279
|
#
|
280
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
281
|
+
#
|
258
282
|
# @param height [Integer] Height of the image in pixels
|
259
283
|
#
|
260
284
|
# @param width [Integer] Width of the image in pixels
|
@@ -288,17 +312,13 @@ module BrandDev
|
|
288
312
|
optional :colors,
|
289
313
|
-> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color] }
|
290
314
|
|
291
|
-
# @!attribute group
|
292
|
-
# Group identifier for logos
|
293
|
-
#
|
294
|
-
# @return [Integer, nil]
|
295
|
-
optional :group, Integer
|
296
|
-
|
297
315
|
# @!attribute mode
|
298
|
-
#
|
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
|
299
319
|
#
|
300
|
-
# @return [
|
301
|
-
optional :mode,
|
320
|
+
# @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode, nil]
|
321
|
+
optional :mode, enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode }
|
302
322
|
|
303
323
|
# @!attribute resolution
|
304
324
|
# Resolution of the logo image
|
@@ -306,22 +326,31 @@ module BrandDev
|
|
306
326
|
# @return [BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution, nil]
|
307
327
|
optional :resolution, -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution }
|
308
328
|
|
329
|
+
# @!attribute type
|
330
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
331
|
+
#
|
332
|
+
# @return [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Type, nil]
|
333
|
+
optional :type, enum: -> { BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Type }
|
334
|
+
|
309
335
|
# @!attribute url
|
310
|
-
#
|
336
|
+
# CDN hosted url of the logo (ready for display)
|
311
337
|
#
|
312
338
|
# @return [String, nil]
|
313
339
|
optional :url, String
|
314
340
|
|
315
|
-
# @!method initialize(colors: nil,
|
316
|
-
#
|
341
|
+
# @!method initialize(colors: nil, mode: nil, resolution: nil, type: nil, url: nil)
|
342
|
+
# Some parameter documentations has been truncated, see
|
343
|
+
# {BrandDev::Models::BrandRetrieveResponse::Brand::Logo} for more details.
|
317
344
|
#
|
318
|
-
# @param
|
345
|
+
# @param colors [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color>] Array of colors in the logo
|
319
346
|
#
|
320
|
-
# @param mode [
|
347
|
+
# @param mode [Symbol, BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Mode] Indicates when this logo is best used: 'light' = best for light mode, 'dark' = b
|
321
348
|
#
|
322
349
|
# @param resolution [BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Resolution] Resolution of the logo image
|
323
350
|
#
|
324
|
-
# @param
|
351
|
+
# @param type [Symbol, BrandDev::Models::BrandRetrieveResponse::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)
|
325
354
|
|
326
355
|
class Color < BrandDev::Internal::Type::BaseModel
|
327
356
|
# @!attribute hex
|
@@ -342,8 +371,30 @@ module BrandDev
|
|
342
371
|
# @param name [String] Name of the color
|
343
372
|
end
|
344
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::BrandRetrieveResponse::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
|
+
|
345
390
|
# @see BrandDev::Models::BrandRetrieveResponse::Brand::Logo#resolution
|
346
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
|
+
|
347
398
|
# @!attribute height
|
348
399
|
# Height of the image in pixels
|
349
400
|
#
|
@@ -356,13 +407,28 @@ module BrandDev
|
|
356
407
|
# @return [Integer, nil]
|
357
408
|
optional :width, Integer
|
358
409
|
|
359
|
-
# @!method initialize(height: nil, width: nil)
|
410
|
+
# @!method initialize(aspect_ratio: nil, height: nil, width: nil)
|
360
411
|
# Resolution of the logo image
|
361
412
|
#
|
413
|
+
# @param aspect_ratio [Float] Aspect ratio of the image (width/height)
|
414
|
+
#
|
362
415
|
# @param height [Integer] Height of the image in pixels
|
363
416
|
#
|
364
417
|
# @param width [Integer] Width of the image in pixels
|
365
418
|
end
|
419
|
+
|
420
|
+
# Type of the logo based on resolution (e.g., 'icon', 'logo')
|
421
|
+
#
|
422
|
+
# @see BrandDev::Models::BrandRetrieveResponse::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
|
366
432
|
end
|
367
433
|
|
368
434
|
class Social < BrandDev::Internal::Type::BaseModel
|