brand.dev 0.11.1 → 0.13.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.
@@ -10,6 +10,8 @@ module BrandDev
10
10
 
11
11
  BrandRetrieveByEmailParams = BrandDev::Models::BrandRetrieveByEmailParams
12
12
 
13
+ BrandRetrieveByIsinParams = BrandDev::Models::BrandRetrieveByIsinParams
14
+
13
15
  BrandRetrieveByNameParams = BrandDev::Models::BrandRetrieveByNameParams
14
16
 
15
17
  BrandRetrieveByTickerParams = BrandDev::Models::BrandRetrieveByTickerParams
@@ -67,9 +67,13 @@ module BrandDev
67
67
  sig do
68
68
  params(
69
69
  transaction_info: String,
70
+ city: String,
71
+ country_gl:
72
+ BrandDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
70
73
  force_language:
71
74
  BrandDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
72
75
  max_speed: T::Boolean,
76
+ mcc: String,
73
77
  timeout_ms: Integer,
74
78
  request_options: BrandDev::RequestOptions::OrHash
75
79
  ).returns(BrandDev::Models::BrandIdentifyFromTransactionResponse)
@@ -77,12 +81,20 @@ module BrandDev
77
81
  def identify_from_transaction(
78
82
  # Transaction information to identify the brand
79
83
  transaction_info:,
84
+ # Optional city name to prioritize when searching for the brand.
85
+ city: nil,
86
+ # Optional country code (GL parameter) to specify the country for Google search
87
+ # results. This affects the geographic location used for search queries.
88
+ country_gl: nil,
80
89
  # Optional parameter to force the language of the retrieved brand data.
81
90
  force_language: nil,
82
91
  # Optional parameter to optimize the API call for maximum speed. When set to true,
83
92
  # the API will skip time-consuming operations for faster response at the cost of
84
93
  # less comprehensive data.
85
94
  max_speed: nil,
95
+ # Optional Merchant Category Code (MCC) to help identify the business
96
+ # category/industry.
97
+ mcc: nil,
86
98
  # Optional timeout in milliseconds for the request. If the request takes longer
87
99
  # than this value, it will be aborted with a 408 status code. Maximum allowed
88
100
  # value is 300000ms (5 minutes).
@@ -146,6 +158,38 @@ module BrandDev
146
158
  )
147
159
  end
148
160
 
161
+ # Retrieve brand information using an ISIN (International Securities
162
+ # Identification Number). This endpoint looks up the company associated with the
163
+ # ISIN and returns its brand data.
164
+ sig do
165
+ params(
166
+ isin: String,
167
+ force_language:
168
+ BrandDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol,
169
+ max_speed: T::Boolean,
170
+ timeout_ms: Integer,
171
+ request_options: BrandDev::RequestOptions::OrHash
172
+ ).returns(BrandDev::Models::BrandRetrieveByIsinResponse)
173
+ end
174
+ def retrieve_by_isin(
175
+ # ISIN (International Securities Identification Number) to retrieve brand data for
176
+ # (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
177
+ # followed by 9 alphanumeric characters and ending with a digit.
178
+ isin:,
179
+ # Optional parameter to force the language of the retrieved brand data.
180
+ force_language: nil,
181
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
182
+ # the API will skip time-consuming operations for faster response at the cost of
183
+ # less comprehensive data.
184
+ max_speed: nil,
185
+ # Optional timeout in milliseconds for the request. If the request takes longer
186
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
187
+ # value is 300000ms (5 minutes).
188
+ timeout_ms: nil,
189
+ request_options: {}
190
+ )
191
+ end
192
+
149
193
  # Retrieve brand information using a company name. This endpoint searches for the
150
194
  # company by name and returns its brand data.
151
195
  sig do
@@ -3,8 +3,11 @@ module BrandDev
3
3
  type brand_identify_from_transaction_params =
4
4
  {
5
5
  transaction_info: String,
6
+ city: String,
7
+ country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
6
8
  force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
7
9
  max_speed: bool,
10
+ mcc: String,
8
11
  timeout_ms: Integer
9
12
  }
10
13
  & BrandDev::Internal::Type::request_parameters
@@ -15,6 +18,16 @@ module BrandDev
15
18
 
16
19
  attr_accessor transaction_info: String
17
20
 
21
+ attr_reader city: String?
22
+
23
+ def city=: (String) -> String
24
+
25
+ attr_reader country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl?
26
+
27
+ def country_gl=: (
28
+ BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl
29
+ ) -> BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl
30
+
18
31
  attr_reader force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language?
19
32
 
20
33
  def force_language=: (
@@ -25,26 +38,523 @@ module BrandDev
25
38
 
26
39
  def max_speed=: (bool) -> bool
27
40
 
41
+ attr_reader mcc: String?
42
+
43
+ def mcc=: (String) -> String
44
+
28
45
  attr_reader timeout_ms: Integer?
29
46
 
30
47
  def timeout_ms=: (Integer) -> Integer
31
48
 
32
49
  def initialize: (
33
50
  transaction_info: String,
51
+ ?city: String,
52
+ ?country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
34
53
  ?force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
35
54
  ?max_speed: bool,
55
+ ?mcc: String,
36
56
  ?timeout_ms: Integer,
37
57
  ?request_options: BrandDev::request_opts
38
58
  ) -> void
39
59
 
40
60
  def to_hash: -> {
41
61
  transaction_info: String,
62
+ city: String,
63
+ country_gl: BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl,
42
64
  force_language: BrandDev::Models::BrandIdentifyFromTransactionParams::force_language,
43
65
  max_speed: bool,
66
+ mcc: String,
44
67
  timeout_ms: Integer,
45
68
  request_options: BrandDev::RequestOptions
46
69
  }
47
70
 
71
+ type country_gl =
72
+ :ad
73
+ | :ae
74
+ | :af
75
+ | :ag
76
+ | :ai
77
+ | :al
78
+ | :am
79
+ | :an
80
+ | :ao
81
+ | :aq
82
+ | :ar
83
+ | :as
84
+ | :at
85
+ | :au
86
+ | :aw
87
+ | :az
88
+ | :ba
89
+ | :bb
90
+ | :bd
91
+ | :be
92
+ | :bf
93
+ | :bg
94
+ | :bh
95
+ | :bi
96
+ | :bj
97
+ | :bm
98
+ | :bn
99
+ | :bo
100
+ | :br
101
+ | :bs
102
+ | :bt
103
+ | :bv
104
+ | :bw
105
+ | :by
106
+ | :bz
107
+ | :ca
108
+ | :cc
109
+ | :cd
110
+ | :cf
111
+ | :cg
112
+ | :ch
113
+ | :ci
114
+ | :ck
115
+ | :cl
116
+ | :cm
117
+ | :cn
118
+ | :co
119
+ | :cr
120
+ | :cu
121
+ | :cv
122
+ | :cx
123
+ | :cy
124
+ | :cz
125
+ | :de
126
+ | :dj
127
+ | :dk
128
+ | :dm
129
+ | :do
130
+ | :dz
131
+ | :ec
132
+ | :ee
133
+ | :eg
134
+ | :eh
135
+ | :er
136
+ | :es
137
+ | :et
138
+ | :fi
139
+ | :fj
140
+ | :fk
141
+ | :fm
142
+ | :fo
143
+ | :fr
144
+ | :ga
145
+ | :gb
146
+ | :gd
147
+ | :ge
148
+ | :gf
149
+ | :gh
150
+ | :gi
151
+ | :gl
152
+ | :gm
153
+ | :gn
154
+ | :gp
155
+ | :gq
156
+ | :gr
157
+ | :gs
158
+ | :gt
159
+ | :gu
160
+ | :gw
161
+ | :gy
162
+ | :hk
163
+ | :hm
164
+ | :hn
165
+ | :hr
166
+ | :ht
167
+ | :hu
168
+ | :id
169
+ | :ie
170
+ | :il
171
+ | :in
172
+ | :io
173
+ | :iq
174
+ | :ir
175
+ | :is
176
+ | :it
177
+ | :jm
178
+ | :jo
179
+ | :jp
180
+ | :ke
181
+ | :kg
182
+ | :kh
183
+ | :ki
184
+ | :km
185
+ | :kn
186
+ | :kp
187
+ | :kr
188
+ | :kw
189
+ | :ky
190
+ | :kz
191
+ | :la
192
+ | :lb
193
+ | :lc
194
+ | :li
195
+ | :lk
196
+ | :lr
197
+ | :ls
198
+ | :lt
199
+ | :lu
200
+ | :lv
201
+ | :ly
202
+ | :ma
203
+ | :mc
204
+ | :md
205
+ | :mg
206
+ | :mh
207
+ | :mk
208
+ | :ml
209
+ | :mm
210
+ | :mn
211
+ | :mo
212
+ | :mp
213
+ | :mq
214
+ | :mr
215
+ | :ms
216
+ | :mt
217
+ | :mu
218
+ | :mv
219
+ | :mw
220
+ | :mx
221
+ | :my
222
+ | :mz
223
+ | :na
224
+ | :nc
225
+ | :ne
226
+ | :nf
227
+ | :ng
228
+ | :ni
229
+ | :nl
230
+ | :no
231
+ | :np
232
+ | :nr
233
+ | :nu
234
+ | :nz
235
+ | :om
236
+ | :pa
237
+ | :pe
238
+ | :pf
239
+ | :pg
240
+ | :ph
241
+ | :pk
242
+ | :pl
243
+ | :pm
244
+ | :pn
245
+ | :pr
246
+ | :ps
247
+ | :pt
248
+ | :pw
249
+ | :py
250
+ | :qa
251
+ | :re
252
+ | :ro
253
+ | :rs
254
+ | :ru
255
+ | :rw
256
+ | :sa
257
+ | :sb
258
+ | :sc
259
+ | :sd
260
+ | :se
261
+ | :sg
262
+ | :sh
263
+ | :si
264
+ | :sj
265
+ | :sk
266
+ | :sl
267
+ | :sm
268
+ | :sn
269
+ | :so
270
+ | :sr
271
+ | :st
272
+ | :sv
273
+ | :sy
274
+ | :sz
275
+ | :tc
276
+ | :td
277
+ | :tf
278
+ | :tg
279
+ | :th
280
+ | :tj
281
+ | :tk
282
+ | :tl
283
+ | :tm
284
+ | :tn
285
+ | :to
286
+ | :tr
287
+ | :tt
288
+ | :tv
289
+ | :tw
290
+ | :tz
291
+ | :ua
292
+ | :ug
293
+ | :um
294
+ | :us
295
+ | :uy
296
+ | :uz
297
+ | :va
298
+ | :vc
299
+ | :ve
300
+ | :vg
301
+ | :vi
302
+ | :vn
303
+ | :vu
304
+ | :wf
305
+ | :ws
306
+ | :ye
307
+ | :yt
308
+ | :za
309
+ | :zm
310
+ | :zw
311
+
312
+ module CountryGl
313
+ extend BrandDev::Internal::Type::Enum
314
+
315
+ AD: :ad
316
+ AE: :ae
317
+ AF: :af
318
+ AG: :ag
319
+ AI: :ai
320
+ AL: :al
321
+ AM: :am
322
+ AN: :an
323
+ AO: :ao
324
+ AQ: :aq
325
+ AR: :ar
326
+ AS: :as
327
+ AT: :at
328
+ AU: :au
329
+ AW: :aw
330
+ AZ: :az
331
+ BA: :ba
332
+ BB: :bb
333
+ BD: :bd
334
+ BE: :be
335
+ BF: :bf
336
+ BG: :bg
337
+ BH: :bh
338
+ BI: :bi
339
+ BJ: :bj
340
+ BM: :bm
341
+ BN: :bn
342
+ BO: :bo
343
+ BR: :br
344
+ BS: :bs
345
+ BT: :bt
346
+ BV: :bv
347
+ BW: :bw
348
+ BY: :by
349
+ BZ: :bz
350
+ CA: :ca
351
+ CC: :cc
352
+ CD: :cd
353
+ CF: :cf
354
+ CG: :cg
355
+ CH: :ch
356
+ CI: :ci
357
+ CK: :ck
358
+ CL: :cl
359
+ CM: :cm
360
+ CN: :cn
361
+ CO: :co
362
+ CR: :cr
363
+ CU: :cu
364
+ CV: :cv
365
+ CX: :cx
366
+ CY: :cy
367
+ CZ: :cz
368
+ DE: :de
369
+ DJ: :dj
370
+ DK: :dk
371
+ DM: :dm
372
+ DO: :do
373
+ DZ: :dz
374
+ EC: :ec
375
+ EE: :ee
376
+ EG: :eg
377
+ EH: :eh
378
+ ER: :er
379
+ ES: :es
380
+ ET: :et
381
+ FI: :fi
382
+ FJ: :fj
383
+ FK: :fk
384
+ FM: :fm
385
+ FO: :fo
386
+ FR: :fr
387
+ GA: :ga
388
+ GB: :gb
389
+ GD: :gd
390
+ GE: :ge
391
+ GF: :gf
392
+ GH: :gh
393
+ GI: :gi
394
+ GL: :gl
395
+ GM: :gm
396
+ GN: :gn
397
+ GP: :gp
398
+ GQ: :gq
399
+ GR: :gr
400
+ GS: :gs
401
+ GT: :gt
402
+ GU: :gu
403
+ GW: :gw
404
+ GY: :gy
405
+ HK: :hk
406
+ HM: :hm
407
+ HN: :hn
408
+ HR: :hr
409
+ HT: :ht
410
+ HU: :hu
411
+ ID: :id
412
+ IE: :ie
413
+ IL: :il
414
+ IN: :in
415
+ IO: :io
416
+ IQ: :iq
417
+ IR: :ir
418
+ IS: :is
419
+ IT: :it
420
+ JM: :jm
421
+ JO: :jo
422
+ JP: :jp
423
+ KE: :ke
424
+ KG: :kg
425
+ KH: :kh
426
+ KI: :ki
427
+ KM: :km
428
+ KN: :kn
429
+ KP: :kp
430
+ KR: :kr
431
+ KW: :kw
432
+ KY: :ky
433
+ KZ: :kz
434
+ LA: :la
435
+ LB: :lb
436
+ LC: :lc
437
+ LI: :li
438
+ LK: :lk
439
+ LR: :lr
440
+ LS: :ls
441
+ LT: :lt
442
+ LU: :lu
443
+ LV: :lv
444
+ LY: :ly
445
+ MA: :ma
446
+ MC: :mc
447
+ MD: :md
448
+ MG: :mg
449
+ MH: :mh
450
+ MK: :mk
451
+ ML: :ml
452
+ MM: :mm
453
+ MN: :mn
454
+ MO: :mo
455
+ MP: :mp
456
+ MQ: :mq
457
+ MR: :mr
458
+ MS: :ms
459
+ MT: :mt
460
+ MU: :mu
461
+ MV: :mv
462
+ MW: :mw
463
+ MX: :mx
464
+ MY: :my
465
+ MZ: :mz
466
+ NA: :na
467
+ NC: :nc
468
+ NE: :ne
469
+ NF: :nf
470
+ NG: :ng
471
+ NI: :ni
472
+ NL: :nl
473
+ NO: :no
474
+ NP: :np
475
+ NR: :nr
476
+ NU: :nu
477
+ NZ: :nz
478
+ OM: :om
479
+ PA: :pa
480
+ PE: :pe
481
+ PF: :pf
482
+ PG: :pg
483
+ PH: :ph
484
+ PK: :pk
485
+ PL: :pl
486
+ PM: :pm
487
+ PN: :pn
488
+ PR: :pr
489
+ PS: :ps
490
+ PT: :pt
491
+ PW: :pw
492
+ PY: :py
493
+ QA: :qa
494
+ RE: :re
495
+ RO: :ro
496
+ RS: :rs
497
+ RU: :ru
498
+ RW: :rw
499
+ SA: :sa
500
+ SB: :sb
501
+ SC: :sc
502
+ SD: :sd
503
+ SE: :se
504
+ SG: :sg
505
+ SH: :sh
506
+ SI: :si
507
+ SJ: :sj
508
+ SK: :sk
509
+ SL: :sl
510
+ SM: :sm
511
+ SN: :sn
512
+ SO: :so
513
+ SR: :sr
514
+ ST: :st
515
+ SV: :sv
516
+ SY: :sy
517
+ SZ: :sz
518
+ TC: :tc
519
+ TD: :td
520
+ TF: :tf
521
+ TG: :tg
522
+ TH: :th
523
+ TJ: :tj
524
+ TK: :tk
525
+ TL: :tl
526
+ TM: :tm
527
+ TN: :tn
528
+ TO: :to
529
+ TR: :tr
530
+ TT: :tt
531
+ TV: :tv
532
+ TW: :tw
533
+ TZ: :tz
534
+ UA: :ua
535
+ UG: :ug
536
+ UM: :um
537
+ US: :us
538
+ UY: :uy
539
+ UZ: :uz
540
+ VA: :va
541
+ VC: :vc
542
+ VE: :ve
543
+ VG: :vg
544
+ VI: :vi
545
+ VN: :vn
546
+ VU: :vu
547
+ WF: :wf
548
+ WS: :ws
549
+ YE: :ye
550
+ YT: :yt
551
+ ZA: :za
552
+ ZM: :zm
553
+ ZW: :zw
554
+
555
+ def self?.values: -> ::Array[BrandDev::Models::BrandIdentifyFromTransactionParams::country_gl]
556
+ end
557
+
48
558
  type force_language =
49
559
  :albanian
50
560
  | :arabic