brand.dev 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -0
- data/README.md +1 -1
- data/lib/brand_dev/models/brand_identify_from_transaction_params.rb +80 -1
- data/lib/brand_dev/models/brand_retrieve_by_email_params.rb +116 -0
- data/lib/brand_dev/models/brand_retrieve_by_email_response.rb +850 -0
- data/lib/brand_dev/models/brand_retrieve_by_name_params.rb +115 -0
- data/lib/brand_dev/models/brand_retrieve_by_name_response.rb +850 -0
- data/lib/brand_dev/models/brand_retrieve_by_ticker_params.rb +204 -0
- data/lib/brand_dev/models/brand_retrieve_by_ticker_response.rb +850 -0
- data/lib/brand_dev/models/brand_retrieve_params.rb +1 -112
- data/lib/brand_dev/models.rb +6 -0
- data/lib/brand_dev/resources/brand.rb +109 -11
- data/lib/brand_dev/version.rb +1 -1
- data/lib/brand_dev.rb +6 -0
- data/rbi/brand_dev/models/brand_identify_from_transaction_params.rbi +324 -0
- data/rbi/brand_dev/models/brand_retrieve_by_email_params.rbi +386 -0
- data/rbi/brand_dev/models/brand_retrieve_by_email_response.rbi +2590 -0
- data/rbi/brand_dev/models/brand_retrieve_by_name_params.rbi +384 -0
- data/rbi/brand_dev/models/brand_retrieve_by_name_response.rbi +2588 -0
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_params.rbi +790 -0
- data/rbi/brand_dev/models/brand_retrieve_by_ticker_response.rbi +2590 -0
- data/rbi/brand_dev/models/brand_retrieve_params.rbi +0 -437
- data/rbi/brand_dev/models.rbi +6 -0
- data/rbi/brand_dev/resources/brand.rbi +108 -17
- data/sig/brand_dev/models/brand_identify_from_transaction_params.rbs +133 -1
- data/sig/brand_dev/models/brand_retrieve_by_email_params.rbs +162 -0
- data/sig/brand_dev/models/brand_retrieve_by_email_response.rbs +1076 -0
- data/sig/brand_dev/models/brand_retrieve_by_name_params.rbs +162 -0
- data/sig/brand_dev/models/brand_retrieve_by_name_response.rbs +1076 -0
- data/sig/brand_dev/models/brand_retrieve_by_ticker_params.rbs +324 -0
- data/sig/brand_dev/models/brand_retrieve_by_ticker_response.rbs +1076 -0
- data/sig/brand_dev/models/brand_retrieve_params.rbs +0 -176
- data/sig/brand_dev/models.rbs +6 -0
- data/sig/brand_dev/resources/brand.rbs +27 -3
- metadata +20 -2
|
@@ -29,29 +29,6 @@ module BrandDev
|
|
|
29
29
|
# @return [Boolean, nil]
|
|
30
30
|
optional :max_speed, BrandDev::Internal::Type::Boolean
|
|
31
31
|
|
|
32
|
-
# @!attribute name
|
|
33
|
-
# Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
|
|
34
|
-
# Corporation'). Must be 3-30 characters. Cannot be used with domain or ticker
|
|
35
|
-
# parameters.
|
|
36
|
-
#
|
|
37
|
-
# @return [String, nil]
|
|
38
|
-
optional :name, String
|
|
39
|
-
|
|
40
|
-
# @!attribute ticker
|
|
41
|
-
# Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
42
|
-
# Must be 1-15 characters, letters/numbers/dots only. Cannot be used with domain
|
|
43
|
-
# or name parameters.
|
|
44
|
-
#
|
|
45
|
-
# @return [String, nil]
|
|
46
|
-
optional :ticker, String
|
|
47
|
-
|
|
48
|
-
# @!attribute ticker_exchange
|
|
49
|
-
# Optional stock exchange for the ticker. Only used when ticker parameter is
|
|
50
|
-
# provided. Defaults to assume ticker is American if not specified.
|
|
51
|
-
#
|
|
52
|
-
# @return [Symbol, BrandDev::Models::BrandRetrieveParams::TickerExchange, nil]
|
|
53
|
-
optional :ticker_exchange, enum: -> { BrandDev::BrandRetrieveParams::TickerExchange }
|
|
54
|
-
|
|
55
32
|
# @!attribute timeout_ms
|
|
56
33
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
57
34
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -60,7 +37,7 @@ module BrandDev
|
|
|
60
37
|
# @return [Integer, nil]
|
|
61
38
|
optional :timeout_ms, Integer
|
|
62
39
|
|
|
63
|
-
# @!method initialize(domain: nil, force_language: nil, max_speed: nil,
|
|
40
|
+
# @!method initialize(domain: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
|
|
64
41
|
# Some parameter documentations has been truncated, see
|
|
65
42
|
# {BrandDev::Models::BrandRetrieveParams} for more details.
|
|
66
43
|
#
|
|
@@ -70,12 +47,6 @@ module BrandDev
|
|
|
70
47
|
#
|
|
71
48
|
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
72
49
|
#
|
|
73
|
-
# @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
|
|
74
|
-
#
|
|
75
|
-
# @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
76
|
-
#
|
|
77
|
-
# @param ticker_exchange [Symbol, BrandDev::Models::BrandRetrieveParams::TickerExchange] Optional stock exchange for the ticker. Only used when ticker parameter is provi
|
|
78
|
-
#
|
|
79
50
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
80
51
|
#
|
|
81
52
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -141,88 +112,6 @@ module BrandDev
|
|
|
141
112
|
# @!method self.values
|
|
142
113
|
# @return [Array<Symbol>]
|
|
143
114
|
end
|
|
144
|
-
|
|
145
|
-
# Optional stock exchange for the ticker. Only used when ticker parameter is
|
|
146
|
-
# provided. Defaults to assume ticker is American if not specified.
|
|
147
|
-
module TickerExchange
|
|
148
|
-
extend BrandDev::Internal::Type::Enum
|
|
149
|
-
|
|
150
|
-
AMEX = :AMEX
|
|
151
|
-
AMS = :AMS
|
|
152
|
-
AQS = :AQS
|
|
153
|
-
ASX = :ASX
|
|
154
|
-
ATH = :ATH
|
|
155
|
-
BER = :BER
|
|
156
|
-
BME = :BME
|
|
157
|
-
BRU = :BRU
|
|
158
|
-
BSE = :BSE
|
|
159
|
-
BUD = :BUD
|
|
160
|
-
BUE = :BUE
|
|
161
|
-
BVC = :BVC
|
|
162
|
-
CBOE = :CBOE
|
|
163
|
-
CNQ = :CNQ
|
|
164
|
-
CPH = :CPH
|
|
165
|
-
DFM = :DFM
|
|
166
|
-
DOH = :DOH
|
|
167
|
-
DUB = :DUB
|
|
168
|
-
DUS = :DUS
|
|
169
|
-
DXE = :DXE
|
|
170
|
-
EGX = :EGX
|
|
171
|
-
FSX = :FSX
|
|
172
|
-
HAM = :HAM
|
|
173
|
-
HEL = :HEL
|
|
174
|
-
HKSE = :HKSE
|
|
175
|
-
HOSE = :HOSE
|
|
176
|
-
ICE = :ICE
|
|
177
|
-
IOB = :IOB
|
|
178
|
-
IST = :IST
|
|
179
|
-
JKT = :JKT
|
|
180
|
-
JNB = :JNB
|
|
181
|
-
JPX = :JPX
|
|
182
|
-
KLS = :KLS
|
|
183
|
-
KOE = :KOE
|
|
184
|
-
KSC = :KSC
|
|
185
|
-
KUW = :KUW
|
|
186
|
-
LIS = :LIS
|
|
187
|
-
LSE = :LSE
|
|
188
|
-
MCX = :MCX
|
|
189
|
-
MEX = :MEX
|
|
190
|
-
MIL = :MIL
|
|
191
|
-
MUN = :MUN
|
|
192
|
-
NASDAQ = :NASDAQ
|
|
193
|
-
NEO = :NEO
|
|
194
|
-
NSE = :NSE
|
|
195
|
-
NYSE = :NYSE
|
|
196
|
-
NZE = :NZE
|
|
197
|
-
OSL = :OSL
|
|
198
|
-
OTC = :OTC
|
|
199
|
-
PAR = :PAR
|
|
200
|
-
PNK = :PNK
|
|
201
|
-
PRA = :PRA
|
|
202
|
-
RIS = :RIS
|
|
203
|
-
SAO = :SAO
|
|
204
|
-
SAU = :SAU
|
|
205
|
-
SES = :SES
|
|
206
|
-
SET = :SET
|
|
207
|
-
SGO = :SGO
|
|
208
|
-
SHH = :SHH
|
|
209
|
-
SHZ = :SHZ
|
|
210
|
-
SIX = :SIX
|
|
211
|
-
STO = :STO
|
|
212
|
-
STU = :STU
|
|
213
|
-
TAI = :TAI
|
|
214
|
-
TAL = :TAL
|
|
215
|
-
TLV = :TLV
|
|
216
|
-
TSX = :TSX
|
|
217
|
-
TSXV = :TSXV
|
|
218
|
-
TWO = :TWO
|
|
219
|
-
VIE = :VIE
|
|
220
|
-
WSE = :WSE
|
|
221
|
-
XETRA = :XETRA
|
|
222
|
-
|
|
223
|
-
# @!method self.values
|
|
224
|
-
# @return [Array<Symbol>]
|
|
225
|
-
end
|
|
226
115
|
end
|
|
227
116
|
end
|
|
228
117
|
end
|
data/lib/brand_dev/models.rb
CHANGED
|
@@ -45,6 +45,12 @@ module BrandDev
|
|
|
45
45
|
|
|
46
46
|
BrandPrefetchParams = BrandDev::Models::BrandPrefetchParams
|
|
47
47
|
|
|
48
|
+
BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams
|
|
49
|
+
|
|
50
|
+
BrandRetrieveByNameParams = BrandDev::Models::BrandRetrieveByNameParams
|
|
51
|
+
|
|
52
|
+
BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
|
|
53
|
+
|
|
48
54
|
BrandRetrieveNaicsParams = BrandDev::Models::BrandRetrieveNaicsParams
|
|
49
55
|
|
|
50
56
|
BrandRetrieveParams = BrandDev::Models::BrandRetrieveParams
|
|
@@ -6,10 +6,10 @@ module BrandDev
|
|
|
6
6
|
# Some parameter documentations has been truncated, see
|
|
7
7
|
# {BrandDev::Models::BrandRetrieveParams} for more details.
|
|
8
8
|
#
|
|
9
|
-
# Retrieve
|
|
10
|
-
#
|
|
9
|
+
# Retrieve logos, backdrops, colors, industry, description, and more from any
|
|
10
|
+
# domain
|
|
11
11
|
#
|
|
12
|
-
# @overload retrieve(domain: nil, force_language: nil, max_speed: nil,
|
|
12
|
+
# @overload retrieve(domain: nil, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
|
|
13
13
|
#
|
|
14
14
|
# @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
|
|
15
15
|
#
|
|
@@ -17,12 +17,6 @@ module BrandDev
|
|
|
17
17
|
#
|
|
18
18
|
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
19
19
|
#
|
|
20
|
-
# @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
|
|
21
|
-
#
|
|
22
|
-
# @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
23
|
-
#
|
|
24
|
-
# @param ticker_exchange [Symbol, BrandDev::Models::BrandRetrieveParams::TickerExchange] Optional stock exchange for the ticker. Only used when ticker parameter is provi
|
|
25
|
-
#
|
|
26
20
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
27
21
|
#
|
|
28
22
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -80,10 +74,14 @@ module BrandDev
|
|
|
80
74
|
# Endpoint specially designed for platforms that want to identify transaction data
|
|
81
75
|
# by the transaction title.
|
|
82
76
|
#
|
|
83
|
-
# @overload identify_from_transaction(transaction_info:, timeout_ms: nil, request_options: {})
|
|
77
|
+
# @overload identify_from_transaction(transaction_info:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
|
|
84
78
|
#
|
|
85
79
|
# @param transaction_info [String] Transaction information to identify the brand
|
|
86
80
|
#
|
|
81
|
+
# @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
82
|
+
#
|
|
83
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
84
|
+
#
|
|
87
85
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
88
86
|
#
|
|
89
87
|
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -96,7 +94,7 @@ module BrandDev
|
|
|
96
94
|
@client.request(
|
|
97
95
|
method: :get,
|
|
98
96
|
path: "brand/transaction_identifier",
|
|
99
|
-
query: parsed.transform_keys(timeout_ms: "timeoutMS"),
|
|
97
|
+
query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
|
|
100
98
|
model: BrandDev::Models::BrandIdentifyFromTransactionResponse,
|
|
101
99
|
options: options
|
|
102
100
|
)
|
|
@@ -132,6 +130,106 @@ module BrandDev
|
|
|
132
130
|
)
|
|
133
131
|
end
|
|
134
132
|
|
|
133
|
+
# Some parameter documentations has been truncated, see
|
|
134
|
+
# {BrandDev::Models::BrandRetrieveByEmailParams} for more details.
|
|
135
|
+
#
|
|
136
|
+
# Retrieve brand information using an email address while detecting disposable and
|
|
137
|
+
# free email addresses. This endpoint extracts the domain from the email address
|
|
138
|
+
# and returns brand data for that domain. Disposable and free email addresses
|
|
139
|
+
# (like gmail.com, yahoo.com) will throw a 422 error.
|
|
140
|
+
#
|
|
141
|
+
# @overload retrieve_by_email(email:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
|
|
142
|
+
#
|
|
143
|
+
# @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
|
|
144
|
+
#
|
|
145
|
+
# @param force_language [Symbol, BrandDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
146
|
+
#
|
|
147
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
148
|
+
#
|
|
149
|
+
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
150
|
+
#
|
|
151
|
+
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
152
|
+
#
|
|
153
|
+
# @return [BrandDev::Models::BrandRetrieveByEmailResponse]
|
|
154
|
+
#
|
|
155
|
+
# @see BrandDev::Models::BrandRetrieveByEmailParams
|
|
156
|
+
def retrieve_by_email(params)
|
|
157
|
+
parsed, options = BrandDev::BrandRetrieveByEmailParams.dump_request(params)
|
|
158
|
+
@client.request(
|
|
159
|
+
method: :get,
|
|
160
|
+
path: "brand/retrieve-by-email",
|
|
161
|
+
query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
|
|
162
|
+
model: BrandDev::Models::BrandRetrieveByEmailResponse,
|
|
163
|
+
options: options
|
|
164
|
+
)
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
# Some parameter documentations has been truncated, see
|
|
168
|
+
# {BrandDev::Models::BrandRetrieveByNameParams} for more details.
|
|
169
|
+
#
|
|
170
|
+
# Retrieve brand information using a company name. This endpoint searches for the
|
|
171
|
+
# company by name and returns its brand data.
|
|
172
|
+
#
|
|
173
|
+
# @overload retrieve_by_name(name:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
|
|
174
|
+
#
|
|
175
|
+
# @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
|
|
176
|
+
#
|
|
177
|
+
# @param force_language [Symbol, BrandDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
178
|
+
#
|
|
179
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
180
|
+
#
|
|
181
|
+
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
182
|
+
#
|
|
183
|
+
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
184
|
+
#
|
|
185
|
+
# @return [BrandDev::Models::BrandRetrieveByNameResponse]
|
|
186
|
+
#
|
|
187
|
+
# @see BrandDev::Models::BrandRetrieveByNameParams
|
|
188
|
+
def retrieve_by_name(params)
|
|
189
|
+
parsed, options = BrandDev::BrandRetrieveByNameParams.dump_request(params)
|
|
190
|
+
@client.request(
|
|
191
|
+
method: :get,
|
|
192
|
+
path: "brand/retrieve-by-name",
|
|
193
|
+
query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
|
|
194
|
+
model: BrandDev::Models::BrandRetrieveByNameResponse,
|
|
195
|
+
options: options
|
|
196
|
+
)
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
# Some parameter documentations has been truncated, see
|
|
200
|
+
# {BrandDev::Models::BrandRetrieveByTickerParams} for more details.
|
|
201
|
+
#
|
|
202
|
+
# Retrieve brand information using a stock ticker symbol. This endpoint looks up
|
|
203
|
+
# the company associated with the ticker and returns its brand data.
|
|
204
|
+
#
|
|
205
|
+
# @overload retrieve_by_ticker(ticker:, force_language: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
|
|
206
|
+
#
|
|
207
|
+
# @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
|
|
208
|
+
#
|
|
209
|
+
# @param force_language [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
|
|
210
|
+
#
|
|
211
|
+
# @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
212
|
+
#
|
|
213
|
+
# @param ticker_exchange [Symbol, BrandDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
|
|
214
|
+
#
|
|
215
|
+
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
216
|
+
#
|
|
217
|
+
# @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
218
|
+
#
|
|
219
|
+
# @return [BrandDev::Models::BrandRetrieveByTickerResponse]
|
|
220
|
+
#
|
|
221
|
+
# @see BrandDev::Models::BrandRetrieveByTickerParams
|
|
222
|
+
def retrieve_by_ticker(params)
|
|
223
|
+
parsed, options = BrandDev::BrandRetrieveByTickerParams.dump_request(params)
|
|
224
|
+
@client.request(
|
|
225
|
+
method: :get,
|
|
226
|
+
path: "brand/retrieve-by-ticker",
|
|
227
|
+
query: parsed.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
|
|
228
|
+
model: BrandDev::Models::BrandRetrieveByTickerResponse,
|
|
229
|
+
options: options
|
|
230
|
+
)
|
|
231
|
+
end
|
|
232
|
+
|
|
135
233
|
# Some parameter documentations has been truncated, see
|
|
136
234
|
# {BrandDev::Models::BrandRetrieveNaicsParams} for more details.
|
|
137
235
|
#
|
data/lib/brand_dev/version.rb
CHANGED
data/lib/brand_dev.rb
CHANGED
|
@@ -56,6 +56,12 @@ require_relative "brand_dev/models/brand_identify_from_transaction_params"
|
|
|
56
56
|
require_relative "brand_dev/models/brand_identify_from_transaction_response"
|
|
57
57
|
require_relative "brand_dev/models/brand_prefetch_params"
|
|
58
58
|
require_relative "brand_dev/models/brand_prefetch_response"
|
|
59
|
+
require_relative "brand_dev/models/brand_retrieve_by_email_params"
|
|
60
|
+
require_relative "brand_dev/models/brand_retrieve_by_email_response"
|
|
61
|
+
require_relative "brand_dev/models/brand_retrieve_by_name_params"
|
|
62
|
+
require_relative "brand_dev/models/brand_retrieve_by_name_response"
|
|
63
|
+
require_relative "brand_dev/models/brand_retrieve_by_ticker_params"
|
|
64
|
+
require_relative "brand_dev/models/brand_retrieve_by_ticker_response"
|
|
59
65
|
require_relative "brand_dev/models/brand_retrieve_naics_params"
|
|
60
66
|
require_relative "brand_dev/models/brand_retrieve_naics_response"
|
|
61
67
|
require_relative "brand_dev/models/brand_retrieve_params"
|
|
@@ -18,6 +18,33 @@ module BrandDev
|
|
|
18
18
|
sig { returns(String) }
|
|
19
19
|
attr_accessor :transaction_info
|
|
20
20
|
|
|
21
|
+
# Optional parameter to force the language of the retrieved brand data.
|
|
22
|
+
sig do
|
|
23
|
+
returns(
|
|
24
|
+
T.nilable(
|
|
25
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol
|
|
26
|
+
)
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
attr_reader :force_language
|
|
30
|
+
|
|
31
|
+
sig do
|
|
32
|
+
params(
|
|
33
|
+
force_language:
|
|
34
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol
|
|
35
|
+
).void
|
|
36
|
+
end
|
|
37
|
+
attr_writer :force_language
|
|
38
|
+
|
|
39
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
40
|
+
# the API will skip time-consuming operations for faster response at the cost of
|
|
41
|
+
# less comprehensive data.
|
|
42
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
43
|
+
attr_reader :max_speed
|
|
44
|
+
|
|
45
|
+
sig { params(max_speed: T::Boolean).void }
|
|
46
|
+
attr_writer :max_speed
|
|
47
|
+
|
|
21
48
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
22
49
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
23
50
|
# value is 300000ms (5 minutes).
|
|
@@ -30,6 +57,9 @@ module BrandDev
|
|
|
30
57
|
sig do
|
|
31
58
|
params(
|
|
32
59
|
transaction_info: String,
|
|
60
|
+
force_language:
|
|
61
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
|
|
62
|
+
max_speed: T::Boolean,
|
|
33
63
|
timeout_ms: Integer,
|
|
34
64
|
request_options: BrandDev::RequestOptions::OrHash
|
|
35
65
|
).returns(T.attached_class)
|
|
@@ -37,6 +67,12 @@ module BrandDev
|
|
|
37
67
|
def self.new(
|
|
38
68
|
# Transaction information to identify the brand
|
|
39
69
|
transaction_info:,
|
|
70
|
+
# Optional parameter to force the language of the retrieved brand data.
|
|
71
|
+
force_language: nil,
|
|
72
|
+
# Optional parameter to optimize the API call for maximum speed. When set to true,
|
|
73
|
+
# the API will skip time-consuming operations for faster response at the cost of
|
|
74
|
+
# less comprehensive data.
|
|
75
|
+
max_speed: nil,
|
|
40
76
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
41
77
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
42
78
|
# value is 300000ms (5 minutes).
|
|
@@ -49,6 +85,9 @@ module BrandDev
|
|
|
49
85
|
override.returns(
|
|
50
86
|
{
|
|
51
87
|
transaction_info: String,
|
|
88
|
+
force_language:
|
|
89
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
|
|
90
|
+
max_speed: T::Boolean,
|
|
52
91
|
timeout_ms: Integer,
|
|
53
92
|
request_options: BrandDev::RequestOptions
|
|
54
93
|
}
|
|
@@ -56,6 +95,291 @@ module BrandDev
|
|
|
56
95
|
end
|
|
57
96
|
def to_hash
|
|
58
97
|
end
|
|
98
|
+
|
|
99
|
+
# Optional parameter to force the language of the retrieved brand data.
|
|
100
|
+
module ForceLanguage
|
|
101
|
+
extend BrandDev::Internal::Type::Enum
|
|
102
|
+
|
|
103
|
+
TaggedSymbol =
|
|
104
|
+
T.type_alias do
|
|
105
|
+
T.all(
|
|
106
|
+
Symbol,
|
|
107
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
111
|
+
|
|
112
|
+
ALBANIAN =
|
|
113
|
+
T.let(
|
|
114
|
+
:albanian,
|
|
115
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
116
|
+
)
|
|
117
|
+
ARABIC =
|
|
118
|
+
T.let(
|
|
119
|
+
:arabic,
|
|
120
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
121
|
+
)
|
|
122
|
+
AZERI =
|
|
123
|
+
T.let(
|
|
124
|
+
:azeri,
|
|
125
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
126
|
+
)
|
|
127
|
+
BENGALI =
|
|
128
|
+
T.let(
|
|
129
|
+
:bengali,
|
|
130
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
131
|
+
)
|
|
132
|
+
BULGARIAN =
|
|
133
|
+
T.let(
|
|
134
|
+
:bulgarian,
|
|
135
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
136
|
+
)
|
|
137
|
+
CEBUANO =
|
|
138
|
+
T.let(
|
|
139
|
+
:cebuano,
|
|
140
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
141
|
+
)
|
|
142
|
+
CROATIAN =
|
|
143
|
+
T.let(
|
|
144
|
+
:croatian,
|
|
145
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
146
|
+
)
|
|
147
|
+
CZECH =
|
|
148
|
+
T.let(
|
|
149
|
+
:czech,
|
|
150
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
151
|
+
)
|
|
152
|
+
DANISH =
|
|
153
|
+
T.let(
|
|
154
|
+
:danish,
|
|
155
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
156
|
+
)
|
|
157
|
+
DUTCH =
|
|
158
|
+
T.let(
|
|
159
|
+
:dutch,
|
|
160
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
161
|
+
)
|
|
162
|
+
ENGLISH =
|
|
163
|
+
T.let(
|
|
164
|
+
:english,
|
|
165
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
166
|
+
)
|
|
167
|
+
ESTONIAN =
|
|
168
|
+
T.let(
|
|
169
|
+
:estonian,
|
|
170
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
171
|
+
)
|
|
172
|
+
FARSI =
|
|
173
|
+
T.let(
|
|
174
|
+
:farsi,
|
|
175
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
176
|
+
)
|
|
177
|
+
FINNISH =
|
|
178
|
+
T.let(
|
|
179
|
+
:finnish,
|
|
180
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
181
|
+
)
|
|
182
|
+
FRENCH =
|
|
183
|
+
T.let(
|
|
184
|
+
:french,
|
|
185
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
186
|
+
)
|
|
187
|
+
GERMAN =
|
|
188
|
+
T.let(
|
|
189
|
+
:german,
|
|
190
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
191
|
+
)
|
|
192
|
+
HAUSA =
|
|
193
|
+
T.let(
|
|
194
|
+
:hausa,
|
|
195
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
196
|
+
)
|
|
197
|
+
HAWAIIAN =
|
|
198
|
+
T.let(
|
|
199
|
+
:hawaiian,
|
|
200
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
201
|
+
)
|
|
202
|
+
HINDI =
|
|
203
|
+
T.let(
|
|
204
|
+
:hindi,
|
|
205
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
206
|
+
)
|
|
207
|
+
HUNGARIAN =
|
|
208
|
+
T.let(
|
|
209
|
+
:hungarian,
|
|
210
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
211
|
+
)
|
|
212
|
+
ICELANDIC =
|
|
213
|
+
T.let(
|
|
214
|
+
:icelandic,
|
|
215
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
216
|
+
)
|
|
217
|
+
INDONESIAN =
|
|
218
|
+
T.let(
|
|
219
|
+
:indonesian,
|
|
220
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
221
|
+
)
|
|
222
|
+
ITALIAN =
|
|
223
|
+
T.let(
|
|
224
|
+
:italian,
|
|
225
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
226
|
+
)
|
|
227
|
+
KAZAKH =
|
|
228
|
+
T.let(
|
|
229
|
+
:kazakh,
|
|
230
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
231
|
+
)
|
|
232
|
+
KYRGYZ =
|
|
233
|
+
T.let(
|
|
234
|
+
:kyrgyz,
|
|
235
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
236
|
+
)
|
|
237
|
+
LATIN =
|
|
238
|
+
T.let(
|
|
239
|
+
:latin,
|
|
240
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
241
|
+
)
|
|
242
|
+
LATVIAN =
|
|
243
|
+
T.let(
|
|
244
|
+
:latvian,
|
|
245
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
246
|
+
)
|
|
247
|
+
LITHUANIAN =
|
|
248
|
+
T.let(
|
|
249
|
+
:lithuanian,
|
|
250
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
251
|
+
)
|
|
252
|
+
MACEDONIAN =
|
|
253
|
+
T.let(
|
|
254
|
+
:macedonian,
|
|
255
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
256
|
+
)
|
|
257
|
+
MONGOLIAN =
|
|
258
|
+
T.let(
|
|
259
|
+
:mongolian,
|
|
260
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
261
|
+
)
|
|
262
|
+
NEPALI =
|
|
263
|
+
T.let(
|
|
264
|
+
:nepali,
|
|
265
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
266
|
+
)
|
|
267
|
+
NORWEGIAN =
|
|
268
|
+
T.let(
|
|
269
|
+
:norwegian,
|
|
270
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
271
|
+
)
|
|
272
|
+
PASHTO =
|
|
273
|
+
T.let(
|
|
274
|
+
:pashto,
|
|
275
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
276
|
+
)
|
|
277
|
+
PIDGIN =
|
|
278
|
+
T.let(
|
|
279
|
+
:pidgin,
|
|
280
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
281
|
+
)
|
|
282
|
+
POLISH =
|
|
283
|
+
T.let(
|
|
284
|
+
:polish,
|
|
285
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
286
|
+
)
|
|
287
|
+
PORTUGUESE =
|
|
288
|
+
T.let(
|
|
289
|
+
:portuguese,
|
|
290
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
291
|
+
)
|
|
292
|
+
ROMANIAN =
|
|
293
|
+
T.let(
|
|
294
|
+
:romanian,
|
|
295
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
296
|
+
)
|
|
297
|
+
RUSSIAN =
|
|
298
|
+
T.let(
|
|
299
|
+
:russian,
|
|
300
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
301
|
+
)
|
|
302
|
+
SERBIAN =
|
|
303
|
+
T.let(
|
|
304
|
+
:serbian,
|
|
305
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
306
|
+
)
|
|
307
|
+
SLOVAK =
|
|
308
|
+
T.let(
|
|
309
|
+
:slovak,
|
|
310
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
311
|
+
)
|
|
312
|
+
SLOVENE =
|
|
313
|
+
T.let(
|
|
314
|
+
:slovene,
|
|
315
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
316
|
+
)
|
|
317
|
+
SOMALI =
|
|
318
|
+
T.let(
|
|
319
|
+
:somali,
|
|
320
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
321
|
+
)
|
|
322
|
+
SPANISH =
|
|
323
|
+
T.let(
|
|
324
|
+
:spanish,
|
|
325
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
326
|
+
)
|
|
327
|
+
SWAHILI =
|
|
328
|
+
T.let(
|
|
329
|
+
:swahili,
|
|
330
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
331
|
+
)
|
|
332
|
+
SWEDISH =
|
|
333
|
+
T.let(
|
|
334
|
+
:swedish,
|
|
335
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
336
|
+
)
|
|
337
|
+
TAGALOG =
|
|
338
|
+
T.let(
|
|
339
|
+
:tagalog,
|
|
340
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
341
|
+
)
|
|
342
|
+
TURKISH =
|
|
343
|
+
T.let(
|
|
344
|
+
:turkish,
|
|
345
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
346
|
+
)
|
|
347
|
+
UKRAINIAN =
|
|
348
|
+
T.let(
|
|
349
|
+
:ukrainian,
|
|
350
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
351
|
+
)
|
|
352
|
+
URDU =
|
|
353
|
+
T.let(
|
|
354
|
+
:urdu,
|
|
355
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
356
|
+
)
|
|
357
|
+
UZBEK =
|
|
358
|
+
T.let(
|
|
359
|
+
:uzbek,
|
|
360
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
361
|
+
)
|
|
362
|
+
VIETNAMESE =
|
|
363
|
+
T.let(
|
|
364
|
+
:vietnamese,
|
|
365
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
366
|
+
)
|
|
367
|
+
WELSH =
|
|
368
|
+
T.let(
|
|
369
|
+
:welsh,
|
|
370
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
371
|
+
)
|
|
372
|
+
|
|
373
|
+
sig do
|
|
374
|
+
override.returns(
|
|
375
|
+
T::Array[
|
|
376
|
+
BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::TaggedSymbol
|
|
377
|
+
]
|
|
378
|
+
)
|
|
379
|
+
end
|
|
380
|
+
def self.values
|
|
381
|
+
end
|
|
382
|
+
end
|
|
59
383
|
end
|
|
60
384
|
end
|
|
61
385
|
end
|