brand.dev 0.0.2 → 0.1.0.pre.alpha.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 +0 -173
- data/README.md +1 -1
- data/lib/brand_dev/errors.rb +0 -22
- data/lib/brand_dev/internal/transport/base_client.rb +2 -10
- data/lib/brand_dev/internal/type/array_of.rb +1 -6
- data/lib/brand_dev/internal/type/base_model.rb +25 -77
- data/lib/brand_dev/internal/type/boolean.rb +1 -7
- data/lib/brand_dev/internal/type/converter.rb +34 -42
- data/lib/brand_dev/internal/type/enum.rb +5 -16
- data/lib/brand_dev/internal/type/file_input.rb +1 -6
- data/lib/brand_dev/internal/type/hash_of.rb +1 -6
- data/lib/brand_dev/internal/type/union.rb +9 -17
- data/lib/brand_dev/internal/type/unknown.rb +1 -7
- data/lib/brand_dev/internal/util.rb +9 -8
- data/lib/brand_dev/models/brand_ai_query_params.rb +5 -87
- data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +1 -14
- data/lib/brand_dev/models/brand_identify_from_transaction_response.rb +29 -1
- data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +1 -14
- data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +29 -1
- data/lib/brand_dev/models/brand_retrieve_naics_params.rb +1 -11
- data/lib/brand_dev/models/brand_retrieve_params.rb +1 -24
- data/lib/brand_dev/models/brand_retrieve_response.rb +29 -1
- data/lib/brand_dev/models/brand_search_params.rb +22 -0
- data/lib/brand_dev/models/brand_search_response.rb +35 -0
- data/lib/brand_dev/models.rb +5 -11
- data/lib/brand_dev/resources/brand.rb +20 -139
- data/lib/brand_dev/version.rb +1 -1
- data/lib/brand_dev.rb +2 -8
- data/rbi/brand_dev/errors.rbi +0 -16
- data/rbi/brand_dev/internal/type/boolean.rbi +0 -2
- data/rbi/brand_dev/internal/type/converter.rbi +15 -15
- data/rbi/brand_dev/internal/type/union.rbi +0 -5
- data/rbi/brand_dev/internal/type/unknown.rbi +0 -2
- data/rbi/brand_dev/internal/util.rbi +0 -2
- data/rbi/brand_dev/models/brand_ai_query_params.rbi +6 -141
- data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +0 -15
- data/rbi/brand_dev/models/brand_identify_from_transaction_response.rbi +69 -0
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +1 -19
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +69 -0
- data/rbi/brand_dev/models/brand_retrieve_naics_params.rbi +1 -19
- data/rbi/brand_dev/models/brand_retrieve_params.rbi +0 -30
- data/rbi/brand_dev/models/brand_retrieve_response.rbi +65 -0
- data/rbi/brand_dev/models/brand_search_params.rbi +40 -0
- data/rbi/brand_dev/models/brand_search_response.rbi +63 -0
- data/rbi/brand_dev/models.rbi +1 -8
- data/rbi/brand_dev/resources/brand.rbi +8 -112
- data/sig/brand_dev/errors.rbs +0 -9
- data/sig/brand_dev/internal/type/converter.rbs +1 -7
- data/sig/brand_dev/models/brand_ai_query_params.rbs +5 -82
- data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +1 -7
- data/sig/brand_dev/models/brand_identify_from_transaction_response.rbs +25 -0
- data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +1 -8
- data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +25 -0
- data/sig/brand_dev/models/brand_retrieve_naics_params.rbs +1 -8
- data/sig/brand_dev/models/brand_retrieve_params.rbs +1 -15
- data/sig/brand_dev/models/brand_retrieve_response.rbs +25 -0
- data/sig/brand_dev/models/brand_search_params.rbs +23 -0
- data/sig/brand_dev/models/brand_search_response.rbs +29 -0
- data/sig/brand_dev/models.rbs +1 -7
- data/sig/brand_dev/resources/brand.rbs +4 -29
- metadata +10 -28
- data/lib/brand_dev/models/brand_prefetch_params.rb +0 -35
- data/lib/brand_dev/models/brand_prefetch_response.rb +0 -33
- data/lib/brand_dev/models/brand_retrieve_simplified_params.rb +0 -35
- data/lib/brand_dev/models/brand_retrieve_simplified_response.rb +0 -280
- data/lib/brand_dev/models/brand_screenshot_params.rb +0 -49
- data/lib/brand_dev/models/brand_screenshot_response.rb +0 -64
- data/lib/brand_dev/models/brand_styleguide_params.rb +0 -36
- data/lib/brand_dev/models/brand_styleguide_response.rb +0 -769
- data/rbi/brand_dev/models/brand_prefetch_params.rbi +0 -58
- data/rbi/brand_dev/models/brand_prefetch_response.rbi +0 -57
- data/rbi/brand_dev/models/brand_retrieve_simplified_params.rbi +0 -61
- data/rbi/brand_dev/models/brand_retrieve_simplified_response.rbi +0 -667
- data/rbi/brand_dev/models/brand_screenshot_params.rbi +0 -105
- data/rbi/brand_dev/models/brand_screenshot_response.rbi +0 -135
- data/rbi/brand_dev/models/brand_styleguide_params.rbi +0 -60
- data/rbi/brand_dev/models/brand_styleguide_response.rbi +0 -1648
- data/sig/brand_dev/models/brand_prefetch_params.rbs +0 -30
- data/sig/brand_dev/models/brand_prefetch_response.rbs +0 -28
- data/sig/brand_dev/models/brand_retrieve_simplified_params.rbs +0 -30
- data/sig/brand_dev/models/brand_retrieve_simplified_response.rbs +0 -292
- data/sig/brand_dev/models/brand_screenshot_params.rbs +0 -46
- data/sig/brand_dev/models/brand_screenshot_response.rbs +0 -63
- data/sig/brand_dev/models/brand_styleguide_params.rbs +0 -30
- data/sig/brand_dev/models/brand_styleguide_response.rbs +0 -925
@@ -0,0 +1,29 @@
|
|
1
|
+
module BrandDev
|
2
|
+
module Models
|
3
|
+
type brand_search_response_item =
|
4
|
+
{ domain: String, logo: String, title: String }
|
5
|
+
|
6
|
+
class BrandSearchResponseItem < BrandDev::Internal::Type::BaseModel
|
7
|
+
attr_reader domain: String?
|
8
|
+
|
9
|
+
def domain=: (String) -> String
|
10
|
+
|
11
|
+
attr_reader logo: String?
|
12
|
+
|
13
|
+
def logo=: (String) -> String
|
14
|
+
|
15
|
+
attr_reader title: String?
|
16
|
+
|
17
|
+
def title=: (String) -> String
|
18
|
+
|
19
|
+
def initialize: (?domain: String, ?logo: String, ?title: String) -> void
|
20
|
+
|
21
|
+
def to_hash: -> { domain: String, logo: String, title: String }
|
22
|
+
end
|
23
|
+
|
24
|
+
type brand_search_response =
|
25
|
+
::Array[BrandDev::Models::BrandSearchResponseItem]
|
26
|
+
|
27
|
+
BrandSearchResponse: BrandDev::Internal::Type::Converter
|
28
|
+
end
|
29
|
+
end
|
data/sig/brand_dev/models.rbs
CHANGED
@@ -3,17 +3,11 @@ module BrandDev
|
|
3
3
|
|
4
4
|
class BrandIdentifyFromTransactionParams = BrandDev::Models::BrandIdentifyFromTransactionParams
|
5
5
|
|
6
|
-
class BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
|
7
|
-
|
8
6
|
class BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
|
9
7
|
|
10
8
|
class BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
|
11
9
|
|
12
10
|
class BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
|
13
11
|
|
14
|
-
class
|
15
|
-
|
16
|
-
class BrandScreenshotParams = BrandDev::Models::BrandScreenshotParams
|
17
|
-
|
18
|
-
class BrandStyleguideParams = BrandDev::Models::BrandStyleguideParams
|
12
|
+
class BrandSearchParams = BrandDev::Models::BrandSearchParams
|
19
13
|
end
|
@@ -4,60 +4,35 @@ module BrandDev
|
|
4
4
|
def retrieve: (
|
5
5
|
domain: String,
|
6
6
|
?force_language: BrandDev::Models::BrandRetrieveParams::force_language,
|
7
|
-
?max_speed: bool,
|
8
|
-
?timeout_ms: Integer,
|
9
7
|
?request_options: BrandDev::request_opts
|
10
8
|
) -> BrandDev::Models::BrandRetrieveResponse
|
11
9
|
|
12
10
|
def ai_query: (
|
13
11
|
data_to_extract: ::Array[BrandDev::BrandAIQueryParams::DataToExtract],
|
14
12
|
domain: String,
|
15
|
-
?specific_pages:
|
16
|
-
?timeout_ms: Integer,
|
13
|
+
?specific_pages: ::Array[String],
|
17
14
|
?request_options: BrandDev::request_opts
|
18
15
|
) -> BrandDev::Models::BrandAIQueryResponse
|
19
16
|
|
20
17
|
def identify_from_transaction: (
|
21
18
|
transaction_info: String,
|
22
|
-
?timeout_ms: Integer,
|
23
19
|
?request_options: BrandDev::request_opts
|
24
20
|
) -> BrandDev::Models::BrandIdentifyFromTransactionResponse
|
25
21
|
|
26
|
-
def prefetch: (
|
27
|
-
domain: String,
|
28
|
-
?timeout_ms: Integer,
|
29
|
-
?request_options: BrandDev::request_opts
|
30
|
-
) -> BrandDev::Models::BrandPrefetchResponse
|
31
|
-
|
32
22
|
def retrieve_by_ticker: (
|
33
23
|
ticker: String,
|
34
|
-
?timeout_ms: Integer,
|
35
24
|
?request_options: BrandDev::request_opts
|
36
25
|
) -> BrandDev::Models::BrandRetrieveByTickerResponse
|
37
26
|
|
38
27
|
def retrieve_naics: (
|
39
28
|
input: String,
|
40
|
-
?timeout_ms: Integer,
|
41
29
|
?request_options: BrandDev::request_opts
|
42
30
|
) -> BrandDev::Models::BrandRetrieveNaicsResponse
|
43
31
|
|
44
|
-
def
|
45
|
-
|
46
|
-
?timeout_ms: Integer,
|
47
|
-
?request_options: BrandDev::request_opts
|
48
|
-
) -> BrandDev::Models::BrandRetrieveSimplifiedResponse
|
49
|
-
|
50
|
-
def screenshot: (
|
51
|
-
domain: String,
|
52
|
-
?full_screenshot: BrandDev::Models::BrandScreenshotParams::full_screenshot,
|
53
|
-
?request_options: BrandDev::request_opts
|
54
|
-
) -> BrandDev::Models::BrandScreenshotResponse
|
55
|
-
|
56
|
-
def styleguide: (
|
57
|
-
domain: String,
|
58
|
-
?timeout_ms: Integer,
|
32
|
+
def search: (
|
33
|
+
query: String,
|
59
34
|
?request_options: BrandDev::request_opts
|
60
|
-
) -> BrandDev::Models::
|
35
|
+
) -> BrandDev::Models::brand_search_response
|
61
36
|
|
62
37
|
def initialize: (client: BrandDev::Client) -> void
|
63
38
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: brand.dev
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.1.0.pre.alpha.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brand Dev
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-06-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: connection_pool
|
@@ -58,20 +58,14 @@ files:
|
|
58
58
|
- lib/brand_dev/models/brand_ai_query_response.rb
|
59
59
|
- lib/brand_dev/models/brand_identify_from_transaction_params.rb
|
60
60
|
- lib/brand_dev/models/brand_identify_from_transaction_response.rb
|
61
|
-
- lib/brand_dev/models/brand_prefetch_params.rb
|
62
|
-
- lib/brand_dev/models/brand_prefetch_response.rb
|
63
61
|
- lib/brand_dev/models/brand_retrieve_by_ticker_params.rb
|
64
62
|
- lib/brand_dev/models/brand_retrieve_by_ticker_response.rb
|
65
63
|
- lib/brand_dev/models/brand_retrieve_naics_params.rb
|
66
64
|
- lib/brand_dev/models/brand_retrieve_naics_response.rb
|
67
65
|
- lib/brand_dev/models/brand_retrieve_params.rb
|
68
66
|
- lib/brand_dev/models/brand_retrieve_response.rb
|
69
|
-
- lib/brand_dev/models/
|
70
|
-
- lib/brand_dev/models/
|
71
|
-
- lib/brand_dev/models/brand_screenshot_params.rb
|
72
|
-
- lib/brand_dev/models/brand_screenshot_response.rb
|
73
|
-
- lib/brand_dev/models/brand_styleguide_params.rb
|
74
|
-
- lib/brand_dev/models/brand_styleguide_response.rb
|
67
|
+
- lib/brand_dev/models/brand_search_params.rb
|
68
|
+
- lib/brand_dev/models/brand_search_response.rb
|
75
69
|
- lib/brand_dev/request_options.rb
|
76
70
|
- lib/brand_dev/resources/brand.rb
|
77
71
|
- lib/brand_dev/version.rb
|
@@ -99,20 +93,14 @@ files:
|
|
99
93
|
- rbi/brand_dev/models/brand_ai_query_response.rbi
|
100
94
|
- rbi/brand_dev/models/brand_identify_from_transaction_params.rbi
|
101
95
|
- rbi/brand_dev/models/brand_identify_from_transaction_response.rbi
|
102
|
-
- rbi/brand_dev/models/brand_prefetch_params.rbi
|
103
|
-
- rbi/brand_dev/models/brand_prefetch_response.rbi
|
104
96
|
- rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi
|
105
97
|
- rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi
|
106
98
|
- rbi/brand_dev/models/brand_retrieve_naics_params.rbi
|
107
99
|
- rbi/brand_dev/models/brand_retrieve_naics_response.rbi
|
108
100
|
- rbi/brand_dev/models/brand_retrieve_params.rbi
|
109
101
|
- rbi/brand_dev/models/brand_retrieve_response.rbi
|
110
|
-
- rbi/brand_dev/models/
|
111
|
-
- rbi/brand_dev/models/
|
112
|
-
- rbi/brand_dev/models/brand_screenshot_params.rbi
|
113
|
-
- rbi/brand_dev/models/brand_screenshot_response.rbi
|
114
|
-
- rbi/brand_dev/models/brand_styleguide_params.rbi
|
115
|
-
- rbi/brand_dev/models/brand_styleguide_response.rbi
|
102
|
+
- rbi/brand_dev/models/brand_search_params.rbi
|
103
|
+
- rbi/brand_dev/models/brand_search_response.rbi
|
116
104
|
- rbi/brand_dev/request_options.rbi
|
117
105
|
- rbi/brand_dev/resources/brand.rbi
|
118
106
|
- rbi/brand_dev/version.rbi
|
@@ -139,20 +127,14 @@ files:
|
|
139
127
|
- sig/brand_dev/models/brand_ai_query_response.rbs
|
140
128
|
- sig/brand_dev/models/brand_identify_from_transaction_params.rbs
|
141
129
|
- sig/brand_dev/models/brand_identify_from_transaction_response.rbs
|
142
|
-
- sig/brand_dev/models/brand_prefetch_params.rbs
|
143
|
-
- sig/brand_dev/models/brand_prefetch_response.rbs
|
144
130
|
- sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs
|
145
131
|
- sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs
|
146
132
|
- sig/brand_dev/models/brand_retrieve_naics_params.rbs
|
147
133
|
- sig/brand_dev/models/brand_retrieve_naics_response.rbs
|
148
134
|
- sig/brand_dev/models/brand_retrieve_params.rbs
|
149
135
|
- sig/brand_dev/models/brand_retrieve_response.rbs
|
150
|
-
- sig/brand_dev/models/
|
151
|
-
- sig/brand_dev/models/
|
152
|
-
- sig/brand_dev/models/brand_screenshot_params.rbs
|
153
|
-
- sig/brand_dev/models/brand_screenshot_response.rbs
|
154
|
-
- sig/brand_dev/models/brand_styleguide_params.rbs
|
155
|
-
- sig/brand_dev/models/brand_styleguide_response.rbs
|
136
|
+
- sig/brand_dev/models/brand_search_params.rbs
|
137
|
+
- sig/brand_dev/models/brand_search_response.rbs
|
156
138
|
- sig/brand_dev/request_options.rbs
|
157
139
|
- sig/brand_dev/resources/brand.rbs
|
158
140
|
- sig/brand_dev/version.rbs
|
@@ -173,9 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
173
155
|
version: 3.2.0
|
174
156
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
175
157
|
requirements:
|
176
|
-
- - "
|
158
|
+
- - ">"
|
177
159
|
- !ruby/object:Gem::Version
|
178
|
-
version:
|
160
|
+
version: 1.3.1
|
179
161
|
requirements: []
|
180
162
|
rubygems_version: 3.4.1
|
181
163
|
signing_key:
|
@@ -1,35 +0,0 @@
|
|
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
|
@@ -1,33 +0,0 @@
|
|
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
|
@@ -1,35 +0,0 @@
|
|
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
|
@@ -1,280 +0,0 @@
|
|
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
|
@@ -1,49 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module BrandDev
|
4
|
-
module Models
|
5
|
-
# @see BrandDev::Resources::Brand#screenshot
|
6
|
-
class BrandScreenshotParams < 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 take screenshot of (e.g., 'example.com', 'google.com'). The
|
12
|
-
# domain will be automatically normalized and validated.
|
13
|
-
#
|
14
|
-
# @return [String]
|
15
|
-
required :domain, String
|
16
|
-
|
17
|
-
# @!attribute full_screenshot
|
18
|
-
# Optional parameter to determine screenshot type. If 'true', takes a full page
|
19
|
-
# screenshot capturing all content. If 'false' or not provided, takes a viewport
|
20
|
-
# screenshot (standard browser view).
|
21
|
-
#
|
22
|
-
# @return [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot, nil]
|
23
|
-
optional :full_screenshot, enum: -> { BrandDev::BrandScreenshotParams::FullScreenshot }
|
24
|
-
|
25
|
-
# @!method initialize(domain:, full_screenshot: nil, request_options: {})
|
26
|
-
# Some parameter documentations has been truncated, see
|
27
|
-
# {BrandDev::Models::BrandScreenshotParams} for more details.
|
28
|
-
#
|
29
|
-
# @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai
|
30
|
-
#
|
31
|
-
# @param full_screenshot [Symbol, BrandDev::Models::BrandScreenshotParams::FullScreenshot] Optional parameter to determine screenshot type. If 'true', takes a full page sc
|
32
|
-
#
|
33
|
-
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
|
34
|
-
|
35
|
-
# Optional parameter to determine screenshot type. If 'true', takes a full page
|
36
|
-
# screenshot capturing all content. If 'false' or not provided, takes a viewport
|
37
|
-
# screenshot (standard browser view).
|
38
|
-
module FullScreenshot
|
39
|
-
extend BrandDev::Internal::Type::Enum
|
40
|
-
|
41
|
-
TRUE = :true
|
42
|
-
FALSE = :false
|
43
|
-
|
44
|
-
# @!method self.values
|
45
|
-
# @return [Array<Symbol>]
|
46
|
-
end
|
47
|
-
end
|
48
|
-
end
|
49
|
-
end
|