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.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +188 -0
  3. data/README.md +7 -3
  4. data/lib/brand_dev/errors.rb +22 -0
  5. data/lib/brand_dev/internal/transport/base_client.rb +10 -2
  6. data/lib/brand_dev/internal/type/array_of.rb +6 -1
  7. data/lib/brand_dev/internal/type/base_model.rb +77 -25
  8. data/lib/brand_dev/internal/type/boolean.rb +7 -1
  9. data/lib/brand_dev/internal/type/converter.rb +42 -34
  10. data/lib/brand_dev/internal/type/enum.rb +16 -5
  11. data/lib/brand_dev/internal/type/file_input.rb +6 -1
  12. data/lib/brand_dev/internal/type/hash_of.rb +6 -1
  13. data/lib/brand_dev/internal/type/union.rb +17 -9
  14. data/lib/brand_dev/internal/type/unknown.rb +7 -1
  15. data/lib/brand_dev/internal/util.rb +8 -9
  16. data/lib/brand_dev/models/brand_ai_query_params.rb +173 -0
  17. data/lib/brand_dev/models/brand_ai_query_response.rb +80 -0
  18. data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +14 -1
  19. data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +1 -29
  20. data/lib/brand_dev/models/brand_prefetch_params.rb +35 -0
  21. data/lib/brand_dev/models/brand_prefetch_response.rb +33 -0
  22. data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +14 -1
  23. data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +1 -29
  24. data/lib/brand_dev/models/brand_retrieve_naics_params.rb +11 -1
  25. data/lib/brand_dev/models/brand_retrieve_params.rb +24 -1
  26. data/lib/brand_dev/models/brand_retrieve_response.rb +1 -29
  27. data/lib/brand_dev/models/brand_retrieve_simplified_params.rb +35 -0
  28. data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +280 -0
  29. data/lib/brand_dev/models/brand_screenshot_params.rb +49 -0
  30. data/lib/brand_dev/models/brand_screenshot_response.rb +64 -0
  31. data/lib/brand_dev/models/brand_styleguide_params.rb +36 -0
  32. data/lib/brand_dev/models/brand_styleguide_response.rb +769 -0
  33. data/lib/brand_dev/models.rb +13 -5
  34. data/lib/brand_dev/resources/brand.rb +165 -18
  35. data/lib/brand_dev/version.rb +1 -1
  36. data/lib/brand_dev.rb +10 -2
  37. data/rbi/brand_dev/errors.rbi +16 -0
  38. data/rbi/brand_dev/internal/type/boolean.rbi +2 -0
  39. data/rbi/brand_dev/internal/type/converter.rbi +15 -15
  40. data/rbi/brand_dev/internal/type/union.rbi +5 -0
  41. data/rbi/brand_dev/internal/type/unknown.rbi +2 -0
  42. data/rbi/brand_dev/internal/util.rbi +2 -0
  43. data/rbi/brand_dev/models/brand_ai_query_params.rbi +319 -0
  44. data/rbi/brand_dev/models/brand_ai_query_response.rbi +182 -0
  45. data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +15 -0
  46. data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +0 -69
  47. data/rbi/brand_dev/models/brand_prefetch_params.rbi +58 -0
  48. data/rbi/brand_dev/models/brand_prefetch_response.rbi +57 -0
  49. data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +19 -1
  50. data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +0 -69
  51. data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi +19 -1
  52. data/rbi/brand_dev/models/brand_retrieve_params.rbi +30 -0
  53. data/rbi/brand_dev/models/brand_retrieve_response.rbi +0 -65
  54. data/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi +61 -0
  55. data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +667 -0
  56. data/rbi/brand_dev/models/brand_screenshot_params.rbi +105 -0
  57. data/rbi/brand_dev/models/brand_screenshot_response.rbi +135 -0
  58. data/rbi/brand_dev/models/brand_styleguide_params.rbi +60 -0
  59. data/rbi/brand_dev/models/brand_styleguide_response.rbi +1648 -0
  60. data/rbi/brand_dev/models.rbi +10 -1
  61. data/rbi/brand_dev/resources/brand.rbi +133 -6
  62. data/sig/brand_dev/errors.rbs +9 -0
  63. data/sig/brand_dev/internal/type/converter.rbs +7 -1
  64. data/sig/brand_dev/models/brand_ai_query_params.rbs +162 -0
  65. data/sig/brand_dev/models/brand_ai_query_response.rbs +79 -0
  66. data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +7 -1
  67. data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +0 -25
  68. data/sig/brand_dev/models/brand_prefetch_params.rbs +30 -0
  69. data/sig/brand_dev/models/brand_prefetch_response.rbs +28 -0
  70. data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +8 -1
  71. data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +0 -25
  72. data/sig/brand_dev/models/brand_retrieve_naics_params.rbs +8 -1
  73. data/sig/brand_dev/models/brand_retrieve_params.rbs +15 -1
  74. data/sig/brand_dev/models/brand_retrieve_response.rbs +0 -25
  75. data/sig/brand_dev/models/brand_retrieve_simplified_params.rbs +30 -0
  76. data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +292 -0
  77. data/sig/brand_dev/models/brand_screenshot_params.rbs +46 -0
  78. data/sig/brand_dev/models/brand_screenshot_response.rbs +63 -0
  79. data/sig/brand_dev/models/brand_styleguide_params.rbs +30 -0
  80. data/sig/brand_dev/models/brand_styleguide_response.rbs +925 -0
  81. data/sig/brand_dev/models.rbs +9 -1
  82. data/sig/brand_dev/resources/brand.rbs +35 -3
  83. metadata +46 -22
  84. data/lib/brand_dev/models/brand_search_params.rb +0 -22
  85. data/lib/brand_dev/models/brand_search_response.rb +0 -35
  86. data/rbi/brand_dev/models/brand_search_params.rbi +0 -40
  87. data/rbi/brand_dev/models/brand_search_response.rbi +0 -63
  88. data/sig/brand_dev/models/brand_search_params.rbs +0 -23
  89. data/sig/brand_dev/models/brand_search_response.rbs +0 -29
@@ -63,13 +63,6 @@ module BrandDev
63
63
  # @return [String, nil]
64
64
  optional :domain, String
65
65
 
66
- # @!attribute fonts
67
- # An array of fonts used by the brand's website
68
- #
69
- # @return [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>, nil]
70
- optional :fonts,
71
- -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font] }
72
-
73
66
  # @!attribute logos
74
67
  # An array of logos associated with the brand
75
68
  #
@@ -103,7 +96,7 @@ module BrandDev
103
96
  # @return [String, nil]
104
97
  optional :title, String
105
98
 
106
- # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
99
+ # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
107
100
  # Some parameter documentations has been truncated, see
108
101
  # {BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand} for more
109
102
  # details.
@@ -120,8 +113,6 @@ module BrandDev
120
113
  #
121
114
  # @param domain [String] The domain name of the brand
122
115
  #
123
- # @param fonts [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Font>] An array of fonts used by the brand's website
124
- #
125
116
  # @param logos [Array<BrandDev::Models::BrandIdentifyFromTransactionResponse::Brand::Logo>] An array of logos associated with the brand
126
117
  #
127
118
  # @param slogan [String] The brand's slogan
@@ -283,25 +274,6 @@ module BrandDev
283
274
  # @param name [String] Name of the color
284
275
  end
285
276
 
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
277
  class Logo < BrandDev::Internal::Type::BaseModel
306
278
  # @!attribute colors
307
279
  # Array of colors in the logo
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module BrandDev
4
+ module Models
5
+ # @see BrandDev::Resources::Brand#prefetch
6
+ class BrandPrefetchParams < BrandDev::Internal::Type::BaseModel
7
+ extend BrandDev::Internal::Type::RequestParameters::Converter
8
+ include BrandDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute domain
11
+ # Domain name to prefetch brand data for
12
+ #
13
+ # @return [String]
14
+ required :domain, String
15
+
16
+ # @!attribute timeout_ms
17
+ # Optional timeout in milliseconds for the request. If the request takes longer
18
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
19
+ # value is 300000ms (5 minutes).
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :timeout_ms, Integer, api_name: :timeoutMS
23
+
24
+ # @!method initialize(domain:, timeout_ms: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {BrandDev::Models::BrandPrefetchParams} for more details.
27
+ #
28
+ # @param domain [String] Domain name to prefetch brand data for
29
+ #
30
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
31
+ #
32
+ # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ module BrandDev
4
+ module Models
5
+ # @see BrandDev::Resources::Brand#prefetch
6
+ class BrandPrefetchResponse < BrandDev::Internal::Type::BaseModel
7
+ # @!attribute domain
8
+ # The domain that was queued for prefetching
9
+ #
10
+ # @return [String, nil]
11
+ optional :domain, String
12
+
13
+ # @!attribute message
14
+ # Success message
15
+ #
16
+ # @return [String, nil]
17
+ optional :message, String
18
+
19
+ # @!attribute status
20
+ # Status of the response, e.g., 'ok'
21
+ #
22
+ # @return [String, nil]
23
+ optional :status, String
24
+
25
+ # @!method initialize(domain: nil, message: nil, status: nil)
26
+ # @param domain [String] The domain that was queued for prefetching
27
+ #
28
+ # @param message [String] Success message
29
+ #
30
+ # @param status [String] Status of the response, e.g., 'ok'
31
+ end
32
+ end
33
+ end
@@ -13,9 +13,22 @@ module BrandDev
13
13
  # @return [String]
14
14
  required :ticker, String
15
15
 
16
- # @!method initialize(ticker:, request_options: {})
16
+ # @!attribute timeout_ms
17
+ # Optional timeout in milliseconds for the request. If the request takes longer
18
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
19
+ # value is 300000ms (5 minutes).
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :timeout_ms, Integer
23
+
24
+ # @!method initialize(ticker:, timeout_ms: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {BrandDev::Models::BrandRetrieveByTickerParams} for more details.
27
+ #
17
28
  # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g. AAPL, TSLA, etc.)
18
29
  #
30
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
31
+ #
19
32
  # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
20
33
  end
21
34
  end
@@ -63,13 +63,6 @@ module BrandDev
63
63
  # @return [String, nil]
64
64
  optional :domain, String
65
65
 
66
- # @!attribute fonts
67
- # An array of fonts used by the brand's website
68
- #
69
- # @return [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>, nil]
70
- optional :fonts,
71
- -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font] }
72
-
73
66
  # @!attribute logos
74
67
  # An array of logos associated with the brand
75
68
  #
@@ -103,7 +96,7 @@ module BrandDev
103
96
  # @return [String, nil]
104
97
  optional :title, String
105
98
 
106
- # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
99
+ # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
107
100
  # Some parameter documentations has been truncated, see
108
101
  # {BrandDev::Models::BrandRetrieveByTickerResponse::Brand} for more details.
109
102
  #
@@ -119,8 +112,6 @@ module BrandDev
119
112
  #
120
113
  # @param domain [String] The domain name of the brand
121
114
  #
122
- # @param fonts [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Font>] An array of fonts used by the brand's website
123
- #
124
115
  # @param logos [Array<BrandDev::Models::BrandRetrieveByTickerResponse::Brand::Logo>] An array of logos associated with the brand
125
116
  #
126
117
  # @param slogan [String] The brand's slogan
@@ -281,25 +272,6 @@ module BrandDev
281
272
  # @param name [String] Name of the color
282
273
  end
283
274
 
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
275
  class Logo < BrandDev::Internal::Type::BaseModel
304
276
  # @!attribute colors
305
277
  # Array of colors in the logo
@@ -15,12 +15,22 @@ module BrandDev
15
15
  # @return [String]
16
16
  required :input, String
17
17
 
18
- # @!method initialize(input:, request_options: {})
18
+ # @!attribute timeout_ms
19
+ # Optional timeout in milliseconds for the request. If the request takes longer
20
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
21
+ # value is 300000ms (5 minutes).
22
+ #
23
+ # @return [Integer, nil]
24
+ optional :timeout_ms, Integer
25
+
26
+ # @!method initialize(input:, timeout_ms: nil, request_options: {})
19
27
  # Some parameter documentations has been truncated, see
20
28
  # {BrandDev::Models::BrandRetrieveNaicsParams} for more details.
21
29
  #
22
30
  # @param input [String] Brand domain or title to retrieve NAICS code for. If a valid domain is provided
23
31
  #
32
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
33
+ #
24
34
  # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
25
35
  end
26
36
  end
@@ -19,11 +19,34 @@ module BrandDev
19
19
  # @return [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage, nil]
20
20
  optional :force_language, enum: -> { BrandDev::BrandRetrieveParams::ForceLanguage }
21
21
 
22
- # @!method initialize(domain:, force_language: nil, request_options: {})
22
+ # @!attribute max_speed
23
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
24
+ # the API will skip time-consuming operations for faster response at the cost of
25
+ # less comprehensive data.
26
+ #
27
+ # @return [Boolean, nil]
28
+ optional :max_speed, BrandDev::Internal::Type::Boolean
29
+
30
+ # @!attribute timeout_ms
31
+ # Optional timeout in milliseconds for the request. If the request takes longer
32
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
33
+ # value is 300000ms (5 minutes).
34
+ #
35
+ # @return [Integer, nil]
36
+ optional :timeout_ms, Integer
37
+
38
+ # @!method initialize(domain:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
39
+ # Some parameter documentations has been truncated, see
40
+ # {BrandDev::Models::BrandRetrieveParams} for more details.
41
+ #
23
42
  # @param domain [String] Domain name to retrieve brand data for
24
43
  #
25
44
  # @param force_language [Symbol, BrandDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data
26
45
  #
46
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
47
+ #
48
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
49
+ #
27
50
  # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
28
51
 
29
52
  # Optional parameter to force the language of the retrieved brand data
@@ -63,13 +63,6 @@ module BrandDev
63
63
  # @return [String, nil]
64
64
  optional :domain, String
65
65
 
66
- # @!attribute fonts
67
- # An array of fonts used by the brand's website
68
- #
69
- # @return [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>, nil]
70
- optional :fonts,
71
- -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveResponse::Brand::Font] }
72
-
73
66
  # @!attribute logos
74
67
  # An array of logos associated with the brand
75
68
  #
@@ -103,7 +96,7 @@ module BrandDev
103
96
  # @return [String, nil]
104
97
  optional :title, String
105
98
 
106
- # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, fonts: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
99
+ # @!method initialize(address: nil, backdrops: nil, colors: nil, description: nil, domain: nil, logos: nil, slogan: nil, socials: nil, stock: nil, title: nil)
107
100
  # Some parameter documentations has been truncated, see
108
101
  # {BrandDev::Models::BrandRetrieveResponse::Brand} for more details.
109
102
  #
@@ -119,8 +112,6 @@ module BrandDev
119
112
  #
120
113
  # @param domain [String] The domain name of the brand
121
114
  #
122
- # @param fonts [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Font>] An array of fonts used by the brand's website
123
- #
124
115
  # @param logos [Array<BrandDev::Models::BrandRetrieveResponse::Brand::Logo>] An array of logos associated with the brand
125
116
  #
126
117
  # @param slogan [String] The brand's slogan
@@ -281,25 +272,6 @@ module BrandDev
281
272
  # @param name [String] Name of the color
282
273
  end
283
274
 
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
275
  class Logo < BrandDev::Internal::Type::BaseModel
304
276
  # @!attribute colors
305
277
  # Array of colors in the logo
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module BrandDev
4
+ module Models
5
+ # @see BrandDev::Resources::Brand#retrieve_simplified
6
+ class BrandRetrieveSimplifiedParams < BrandDev::Internal::Type::BaseModel
7
+ extend BrandDev::Internal::Type::RequestParameters::Converter
8
+ include BrandDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute domain
11
+ # Domain name to retrieve simplified brand data for
12
+ #
13
+ # @return [String]
14
+ required :domain, String
15
+
16
+ # @!attribute timeout_ms
17
+ # Optional timeout in milliseconds for the request. If the request takes longer
18
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
19
+ # value is 300000ms (5 minutes).
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :timeout_ms, Integer
23
+
24
+ # @!method initialize(domain:, timeout_ms: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {BrandDev::Models::BrandRetrieveSimplifiedParams} for more details.
27
+ #
28
+ # @param domain [String] Domain name to retrieve simplified brand data for
29
+ #
30
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
31
+ #
32
+ # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,280 @@
1
+ # frozen_string_literal: true
2
+
3
+ module BrandDev
4
+ module Models
5
+ # @see BrandDev::Resources::Brand#retrieve_simplified
6
+ class BrandRetrieveSimplifiedResponse < BrandDev::Internal::Type::BaseModel
7
+ # @!attribute brand
8
+ # Simplified brand information
9
+ #
10
+ # @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand, nil]
11
+ optional :brand, -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand }
12
+
13
+ # @!attribute code
14
+ # HTTP status code of the response
15
+ #
16
+ # @return [Integer, nil]
17
+ optional :code, Integer
18
+
19
+ # @!attribute status
20
+ # Status of the response, e.g., 'ok'
21
+ #
22
+ # @return [String, nil]
23
+ optional :status, String
24
+
25
+ # @!method initialize(brand: nil, code: nil, status: nil)
26
+ # @param brand [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
27
+ #
28
+ # @param code [Integer] HTTP status code of the response
29
+ #
30
+ # @param status [String] Status of the response, e.g., 'ok'
31
+
32
+ # @see BrandDev::Models::BrandRetrieveSimplifiedResponse#brand
33
+ class Brand < BrandDev::Internal::Type::BaseModel
34
+ # @!attribute backdrops
35
+ # An array of backdrop images for the brand
36
+ #
37
+ # @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>, nil]
38
+ optional :backdrops,
39
+ -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop] }
40
+
41
+ # @!attribute colors
42
+ # An array of brand colors
43
+ #
44
+ # @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>, nil]
45
+ optional :colors,
46
+ -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color] }
47
+
48
+ # @!attribute domain
49
+ # The domain name of the brand
50
+ #
51
+ # @return [String, nil]
52
+ optional :domain, String
53
+
54
+ # @!attribute logos
55
+ # An array of logos associated with the brand
56
+ #
57
+ # @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>, nil]
58
+ optional :logos,
59
+ -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo] }
60
+
61
+ # @!attribute title
62
+ # The title or name of the brand
63
+ #
64
+ # @return [String, nil]
65
+ optional :title, String
66
+
67
+ # @!method initialize(backdrops: nil, colors: nil, domain: nil, logos: nil, title: nil)
68
+ # Simplified brand information
69
+ #
70
+ # @param backdrops [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop>] An array of backdrop images for the brand
71
+ #
72
+ # @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color>] An array of brand colors
73
+ #
74
+ # @param domain [String] The domain name of the brand
75
+ #
76
+ # @param logos [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo>] An array of logos associated with the brand
77
+ #
78
+ # @param title [String] The title or name of the brand
79
+
80
+ class Backdrop < BrandDev::Internal::Type::BaseModel
81
+ # @!attribute colors
82
+ # Array of colors in the backdrop image
83
+ #
84
+ # @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>, nil]
85
+ optional :colors,
86
+ -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color] }
87
+
88
+ # @!attribute resolution
89
+ # Resolution of the backdrop image
90
+ #
91
+ # @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution, nil]
92
+ optional :resolution,
93
+ -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution }
94
+
95
+ # @!attribute url
96
+ # URL of the backdrop image
97
+ #
98
+ # @return [String, nil]
99
+ optional :url, String
100
+
101
+ # @!method initialize(colors: nil, resolution: nil, url: nil)
102
+ # @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color>] Array of colors in the backdrop image
103
+ #
104
+ # @param resolution [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution] Resolution of the backdrop image
105
+ #
106
+ # @param url [String] URL of the backdrop image
107
+
108
+ class Color < BrandDev::Internal::Type::BaseModel
109
+ # @!attribute hex
110
+ # Color in hexadecimal format
111
+ #
112
+ # @return [String, nil]
113
+ optional :hex, String
114
+
115
+ # @!attribute name
116
+ # Name of the color
117
+ #
118
+ # @return [String, nil]
119
+ optional :name, String
120
+
121
+ # @!method initialize(hex: nil, name: nil)
122
+ # @param hex [String] Color in hexadecimal format
123
+ #
124
+ # @param name [String] Name of the color
125
+ end
126
+
127
+ # @see BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop#resolution
128
+ class Resolution < BrandDev::Internal::Type::BaseModel
129
+ # @!attribute aspect_ratio
130
+ # Aspect ratio of the image (width/height)
131
+ #
132
+ # @return [Float, nil]
133
+ optional :aspect_ratio, Float
134
+
135
+ # @!attribute height
136
+ # Height of the image in pixels
137
+ #
138
+ # @return [Integer, nil]
139
+ optional :height, Integer
140
+
141
+ # @!attribute width
142
+ # Width of the image in pixels
143
+ #
144
+ # @return [Integer, nil]
145
+ optional :width, Integer
146
+
147
+ # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
148
+ # Resolution of the backdrop image
149
+ #
150
+ # @param aspect_ratio [Float] Aspect ratio of the image (width/height)
151
+ #
152
+ # @param height [Integer] Height of the image in pixels
153
+ #
154
+ # @param width [Integer] Width of the image in pixels
155
+ end
156
+ end
157
+
158
+ class Color < BrandDev::Internal::Type::BaseModel
159
+ # @!attribute hex
160
+ # Color in hexadecimal format
161
+ #
162
+ # @return [String, nil]
163
+ optional :hex, String
164
+
165
+ # @!attribute name
166
+ # Name of the color
167
+ #
168
+ # @return [String, nil]
169
+ optional :name, String
170
+
171
+ # @!method initialize(hex: nil, name: nil)
172
+ # @param hex [String] Color in hexadecimal format
173
+ #
174
+ # @param name [String] Name of the color
175
+ end
176
+
177
+ class Logo < BrandDev::Internal::Type::BaseModel
178
+ # @!attribute colors
179
+ # Array of colors in the logo
180
+ #
181
+ # @return [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>, nil]
182
+ optional :colors,
183
+ -> { BrandDev::Internal::Type::ArrayOf[BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color] }
184
+
185
+ # @!attribute group
186
+ # Group identifier for logos
187
+ #
188
+ # @return [Integer, nil]
189
+ optional :group, Integer
190
+
191
+ # @!attribute mode
192
+ # Mode of the logo, e.g., 'dark', 'light'
193
+ #
194
+ # @return [String, nil]
195
+ optional :mode, String
196
+
197
+ # @!attribute resolution
198
+ # Resolution of the logo image
199
+ #
200
+ # @return [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution, nil]
201
+ optional :resolution, -> { BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution }
202
+
203
+ # @!attribute type
204
+ # Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
205
+ #
206
+ # @return [String, nil]
207
+ optional :type, String
208
+
209
+ # @!attribute url
210
+ # URL of the logo image
211
+ #
212
+ # @return [String, nil]
213
+ optional :url, String
214
+
215
+ # @!method initialize(colors: nil, group: nil, mode: nil, resolution: nil, type: nil, url: nil)
216
+ # @param colors [Array<BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color>] Array of colors in the logo
217
+ #
218
+ # @param group [Integer] Group identifier for logos
219
+ #
220
+ # @param mode [String] Mode of the logo, e.g., 'dark', 'light'
221
+ #
222
+ # @param resolution [BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution] Resolution of the logo image
223
+ #
224
+ # @param type [String] Type of the logo based on resolution (e.g., 'icon', 'logo', 'banner')
225
+ #
226
+ # @param url [String] URL of the logo image
227
+
228
+ class Color < BrandDev::Internal::Type::BaseModel
229
+ # @!attribute hex
230
+ # Color in hexadecimal format
231
+ #
232
+ # @return [String, nil]
233
+ optional :hex, String
234
+
235
+ # @!attribute name
236
+ # Name of the color
237
+ #
238
+ # @return [String, nil]
239
+ optional :name, String
240
+
241
+ # @!method initialize(hex: nil, name: nil)
242
+ # @param hex [String] Color in hexadecimal format
243
+ #
244
+ # @param name [String] Name of the color
245
+ end
246
+
247
+ # @see BrandDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo#resolution
248
+ class Resolution < BrandDev::Internal::Type::BaseModel
249
+ # @!attribute aspect_ratio
250
+ # Aspect ratio of the image (width/height)
251
+ #
252
+ # @return [Float, nil]
253
+ optional :aspect_ratio, Float
254
+
255
+ # @!attribute height
256
+ # Height of the image in pixels
257
+ #
258
+ # @return [Integer, nil]
259
+ optional :height, Integer
260
+
261
+ # @!attribute width
262
+ # Width of the image in pixels
263
+ #
264
+ # @return [Integer, nil]
265
+ optional :width, Integer
266
+
267
+ # @!method initialize(aspect_ratio: nil, height: nil, width: nil)
268
+ # Resolution of the logo image
269
+ #
270
+ # @param aspect_ratio [Float] Aspect ratio of the image (width/height)
271
+ #
272
+ # @param height [Integer] Height of the image in pixels
273
+ #
274
+ # @param width [Integer] Width of the image in pixels
275
+ end
276
+ end
277
+ end
278
+ end
279
+ end
280
+ end