brand.dev 0.1.0 → 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 824d292c41a48213239b6d735b4603e5e00e06e78993cf0ef687aa52222c9755
4
- data.tar.gz: fd40a5b5cab29332c6a1a25654015f31230523e059646ce75be08696c0605fd8
3
+ metadata.gz: df28fd5aa0d8231a27a6b3c155f9000846e642c65fc753f1774bd6c0e58a014b
4
+ data.tar.gz: a55600ebc91b03e85320b577705bbd1e5ad3edd60ed6b7b2dbfb5cb1af9089bd
5
5
  SHA512:
6
- metadata.gz: 134eb59e2cf2b53012812e2d0028e488ecfae96cc0a0bd18e79f0042421fde9d121a0e90d152e6093947a538367e121d97e89b6c5264d5b3ece7b884d99154c6
7
- data.tar.gz: 6dec3e7ad876474973f234021971eb5dd751ac87f638dbee58a95f9915e79c7099c2281b3583e9667c150894409de7edb7cdf72ef5ca9a2b9bdef461de9c3757
6
+ metadata.gz: 5d6cdee2fb3161e12e02d0645fbf71508664827af349b769d2f148db5f53df609b135fc556303160711ca287655fbe646aed2826495663d0df3173cb0baea1f4
7
+ data.tar.gz: 5b6f254d84d2d883ba3c07fe4f86768f10e7fb82651f9f587fe4eb21a81313b98790358ab120275240152c186be0d42568bc106682d0acfab95766b669bdabdb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
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
+
3
11
  ## 0.1.0 (2025-07-29)
4
12
 
5
13
  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
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "brand.dev", "~> 0.1.0"
18
+ gem "brand.dev", "~> 0.2.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -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(code: nil, data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil)
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
- # Mode of the logo, e.g., 'dark', 'light'
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 [String, nil]
303
- optional :mode, String
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
- # URL of the logo image
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, group: nil, mode: nil, resolution: nil, url: nil)
319
- # @param colors [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color>] Array of colors in the logo
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 group [Integer] Group identifier for logos
349
+ # @param colors [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo::Color>] Array of colors in the logo
322
350
  #
323
- # @param mode [String] Mode of the logo, e.g., 'dark', 'light'
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 url [String] URL of the logo image
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
- # Mode of the logo, e.g., 'dark', 'light'
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 [String, nil]
301
- optional :mode, String
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
- # URL of the logo image
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, group: nil, mode: nil, resolution: nil, url: nil)
316
- # @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>] Array of colors in the logo
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 group [Integer] Group identifier for logos
345
+ # @param colors [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo::Color>] Array of colors in the logo
319
346
  #
320
- # @param mode [String] Mode of the logo, e.g., 'dark', 'light'
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 url [String] URL of the logo image
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
- # Mode of the logo, e.g., 'dark', 'light'
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 [String, nil]
301
- optional :mode, String
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
- # URL of the logo image
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, group: nil, mode: nil, resolution: nil, url: nil)
316
- # @param colors [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color>] Array of colors in the logo
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 group [Integer] Group identifier for logos
345
+ # @param colors [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo::Color>] Array of colors in the logo
319
346
  #
320
- # @param mode [String] Mode of the logo, e.g., 'dark', 'light'
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 url [String] URL of the logo image
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