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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 80f2543fcc4bea83a179705a9859488ab375dda0c090f19bb2f60a1977c8c623
4
- data.tar.gz: 305854a6e398aea7dca9727c02936ac99a6cc87b65ecad87d5f4856eed950903
3
+ metadata.gz: 7345fd0c4a995324b2445ec0b5dda19ac6d7a92b486b2ea6474b60f7e297f3e0
4
+ data.tar.gz: d948fd3f7cfb083757d0982cb4ed96151f625fe9c5bf0dedb015c18403a7a8bd
5
5
  SHA512:
6
- metadata.gz: b20da8940735c566bd19934c3a4abb9b9c52fe977eaf6c91c2b76888ee0b75a5d00e329d4258e8fa327995b13a7ffd2d0083d746f2576411dc3415c15271457d
7
- data.tar.gz: 998d1d4008117fe497e8a7c18606c9ff1a490cc6b5ee4ea2cfe98384475c9c9d4b8ae0da49a2cc2a0d54298e294221f2ba76c320b31161882607b749801d6493
6
+ metadata.gz: ff2c874347bef037df231844dccefa881c8abb269ce96e25e96040ad2fe6bac39ca1d5347345a6da13db61ea6482a967f33d1a0588f5a38c432594977f4d5783
7
+ data.tar.gz: 686086c0e2b25367c362a039450f998818d2d29d3f795e788845540b1cd79b6ace46318adfde01baa3d196b226931d38ba99773c6c1059dd679cb11ebf10b89a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.13.0 (2025-11-24)
4
+
5
+ Full Changelog: [v0.12.0...v0.13.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.12.0...v0.13.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([4480dc7](https://github.com/brand-dot-dev/ruby-sdk/commit/4480dc7ecf1583cf54713fb7bec96455d17ff80d))
10
+
11
+
12
+ ### Chores
13
+
14
+ * explicitly require "base64" gem ([90da5d4](https://github.com/brand-dot-dev/ruby-sdk/commit/90da5d4c95586955a55b3295778830b51f81f937))
15
+
16
+ ## 0.12.0 (2025-11-19)
17
+
18
+ Full Changelog: [v0.11.1...v0.12.0](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.11.1...v0.12.0)
19
+
20
+ ### Features
21
+
22
+ * **api:** manual updates ([f0def2c](https://github.com/brand-dot-dev/ruby-sdk/commit/f0def2c0d881ac259944db23321d5a7944483559))
23
+
3
24
  ## 0.11.1 (2025-11-05)
4
25
 
5
26
  Full Changelog: [v0.11.0...v0.11.1](https://github.com/brand-dot-dev/ruby-sdk/compare/v0.11.0...v0.11.1)
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "brand.dev", "~> 0.11.1"
20
+ gem "brand.dev", "~> 0.13.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -13,6 +13,19 @@ module BrandDev
13
13
  # @return [String]
14
14
  required :transaction_info, String
15
15
 
16
+ # @!attribute city
17
+ # Optional city name to prioritize when searching for the brand.
18
+ #
19
+ # @return [String, nil]
20
+ optional :city, String
21
+
22
+ # @!attribute country_gl
23
+ # Optional country code (GL parameter) to specify the country for Google search
24
+ # results. This affects the geographic location used for search queries.
25
+ #
26
+ # @return [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::CountryGl, nil]
27
+ optional :country_gl, enum: -> { BrandDev::BrandIdentifyFromTransactionParams::CountryGl }
28
+
16
29
  # @!attribute force_language
17
30
  # Optional parameter to force the language of the retrieved brand data.
18
31
  #
@@ -27,6 +40,13 @@ module BrandDev
27
40
  # @return [Boolean, nil]
28
41
  optional :max_speed, BrandDev::Internal::Type::Boolean
29
42
 
43
+ # @!attribute mcc
44
+ # Optional Merchant Category Code (MCC) to help identify the business
45
+ # category/industry.
46
+ #
47
+ # @return [String, nil]
48
+ optional :mcc, String
49
+
30
50
  # @!attribute timeout_ms
31
51
  # Optional timeout in milliseconds for the request. If the request takes longer
32
52
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -35,20 +55,275 @@ module BrandDev
35
55
  # @return [Integer, nil]
36
56
  optional :timeout_ms, Integer
37
57
 
38
- # @!method initialize(transaction_info:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
58
+ # @!method initialize(transaction_info:, city: nil, country_gl: nil, force_language: nil, max_speed: nil, mcc: nil, timeout_ms: nil, request_options: {})
39
59
  # Some parameter documentations has been truncated, see
40
60
  # {BrandDev::Models::BrandIdentifyFromTransactionParams} for more details.
41
61
  #
42
62
  # @param transaction_info [String] Transaction information to identify the brand
43
63
  #
64
+ # @param city [String] Optional city name to prioritize when searching for the brand.
65
+ #
66
+ # @param country_gl [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::CountryGl] Optional country code (GL parameter) to specify the country for Google search re
67
+ #
44
68
  # @param force_language [Symbol, BrandDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
45
69
  #
46
70
  # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
47
71
  #
72
+ # @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
73
+ #
48
74
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
49
75
  #
50
76
  # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
51
77
 
78
+ # Optional country code (GL parameter) to specify the country for Google search
79
+ # results. This affects the geographic location used for search queries.
80
+ module CountryGl
81
+ extend BrandDev::Internal::Type::Enum
82
+
83
+ AD = :ad
84
+ AE = :ae
85
+ AF = :af
86
+ AG = :ag
87
+ AI = :ai
88
+ AL = :al
89
+ AM = :am
90
+ AN = :an
91
+ AO = :ao
92
+ AQ = :aq
93
+ AR = :ar
94
+ AS = :as
95
+ AT = :at
96
+ AU = :au
97
+ AW = :aw
98
+ AZ = :az
99
+ BA = :ba
100
+ BB = :bb
101
+ BD = :bd
102
+ BE = :be
103
+ BF = :bf
104
+ BG = :bg
105
+ BH = :bh
106
+ BI = :bi
107
+ BJ = :bj
108
+ BM = :bm
109
+ BN = :bn
110
+ BO = :bo
111
+ BR = :br
112
+ BS = :bs
113
+ BT = :bt
114
+ BV = :bv
115
+ BW = :bw
116
+ BY = :by
117
+ BZ = :bz
118
+ CA = :ca
119
+ CC = :cc
120
+ CD = :cd
121
+ CF = :cf
122
+ CG = :cg
123
+ CH = :ch
124
+ CI = :ci
125
+ CK = :ck
126
+ CL = :cl
127
+ CM = :cm
128
+ CN = :cn
129
+ CO = :co
130
+ CR = :cr
131
+ CU = :cu
132
+ CV = :cv
133
+ CX = :cx
134
+ CY = :cy
135
+ CZ = :cz
136
+ DE = :de
137
+ DJ = :dj
138
+ DK = :dk
139
+ DM = :dm
140
+ DO = :do
141
+ DZ = :dz
142
+ EC = :ec
143
+ EE = :ee
144
+ EG = :eg
145
+ EH = :eh
146
+ ER = :er
147
+ ES = :es
148
+ ET = :et
149
+ FI = :fi
150
+ FJ = :fj
151
+ FK = :fk
152
+ FM = :fm
153
+ FO = :fo
154
+ FR = :fr
155
+ GA = :ga
156
+ GB = :gb
157
+ GD = :gd
158
+ GE = :ge
159
+ GF = :gf
160
+ GH = :gh
161
+ GI = :gi
162
+ GL = :gl
163
+ GM = :gm
164
+ GN = :gn
165
+ GP = :gp
166
+ GQ = :gq
167
+ GR = :gr
168
+ GS = :gs
169
+ GT = :gt
170
+ GU = :gu
171
+ GW = :gw
172
+ GY = :gy
173
+ HK = :hk
174
+ HM = :hm
175
+ HN = :hn
176
+ HR = :hr
177
+ HT = :ht
178
+ HU = :hu
179
+ ID = :id
180
+ IE = :ie
181
+ IL = :il
182
+ IN = :in
183
+ IO = :io
184
+ IQ = :iq
185
+ IR = :ir
186
+ IS = :is
187
+ IT = :it
188
+ JM = :jm
189
+ JO = :jo
190
+ JP = :jp
191
+ KE = :ke
192
+ KG = :kg
193
+ KH = :kh
194
+ KI = :ki
195
+ KM = :km
196
+ KN = :kn
197
+ KP = :kp
198
+ KR = :kr
199
+ KW = :kw
200
+ KY = :ky
201
+ KZ = :kz
202
+ LA = :la
203
+ LB = :lb
204
+ LC = :lc
205
+ LI = :li
206
+ LK = :lk
207
+ LR = :lr
208
+ LS = :ls
209
+ LT = :lt
210
+ LU = :lu
211
+ LV = :lv
212
+ LY = :ly
213
+ MA = :ma
214
+ MC = :mc
215
+ MD = :md
216
+ MG = :mg
217
+ MH = :mh
218
+ MK = :mk
219
+ ML = :ml
220
+ MM = :mm
221
+ MN = :mn
222
+ MO = :mo
223
+ MP = :mp
224
+ MQ = :mq
225
+ MR = :mr
226
+ MS = :ms
227
+ MT = :mt
228
+ MU = :mu
229
+ MV = :mv
230
+ MW = :mw
231
+ MX = :mx
232
+ MY = :my
233
+ MZ = :mz
234
+ NA = :na
235
+ NC = :nc
236
+ NE = :ne
237
+ NF = :nf
238
+ NG = :ng
239
+ NI = :ni
240
+ NL = :nl
241
+ NO = :no
242
+ NP = :np
243
+ NR = :nr
244
+ NU = :nu
245
+ NZ = :nz
246
+ OM = :om
247
+ PA = :pa
248
+ PE = :pe
249
+ PF = :pf
250
+ PG = :pg
251
+ PH = :ph
252
+ PK = :pk
253
+ PL = :pl
254
+ PM = :pm
255
+ PN = :pn
256
+ PR = :pr
257
+ PS = :ps
258
+ PT = :pt
259
+ PW = :pw
260
+ PY = :py
261
+ QA = :qa
262
+ RE = :re
263
+ RO = :ro
264
+ RS = :rs
265
+ RU = :ru
266
+ RW = :rw
267
+ SA = :sa
268
+ SB = :sb
269
+ SC = :sc
270
+ SD = :sd
271
+ SE = :se
272
+ SG = :sg
273
+ SH = :sh
274
+ SI = :si
275
+ SJ = :sj
276
+ SK = :sk
277
+ SL = :sl
278
+ SM = :sm
279
+ SN = :sn
280
+ SO = :so
281
+ SR = :sr
282
+ ST = :st
283
+ SV = :sv
284
+ SY = :sy
285
+ SZ = :sz
286
+ TC = :tc
287
+ TD = :td
288
+ TF = :tf
289
+ TG = :tg
290
+ TH = :th
291
+ TJ = :tj
292
+ TK = :tk
293
+ TL = :tl
294
+ TM = :tm
295
+ TN = :tn
296
+ TO = :to
297
+ TR = :tr
298
+ TT = :tt
299
+ TV = :tv
300
+ TW = :tw
301
+ TZ = :tz
302
+ UA = :ua
303
+ UG = :ug
304
+ UM = :um
305
+ US = :us
306
+ UY = :uy
307
+ UZ = :uz
308
+ VA = :va
309
+ VC = :vc
310
+ VE = :ve
311
+ VG = :vg
312
+ VI = :vi
313
+ VN = :vn
314
+ VU = :vu
315
+ WF = :wf
316
+ WS = :ws
317
+ YE = :ye
318
+ YT = :yt
319
+ ZA = :za
320
+ ZM = :zm
321
+ ZW = :zw
322
+
323
+ # @!method self.values
324
+ # @return [Array<Symbol>]
325
+ end
326
+
52
327
  # Optional parameter to force the language of the retrieved brand data.
53
328
  module ForceLanguage
54
329
  extend BrandDev::Internal::Type::Enum
@@ -0,0 +1,116 @@
1
+ # frozen_string_literal: true
2
+
3
+ module BrandDev
4
+ module Models
5
+ # @see BrandDev::Resources::Brand#retrieve_by_isin
6
+ class BrandRetrieveByIsinParams < BrandDev::Internal::Type::BaseModel
7
+ extend BrandDev::Internal::Type::RequestParameters::Converter
8
+ include BrandDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute isin
11
+ # ISIN (International Securities Identification Number) to retrieve brand data for
12
+ # (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
13
+ # followed by 9 alphanumeric characters and ending with a digit.
14
+ #
15
+ # @return [String]
16
+ required :isin, String
17
+
18
+ # @!attribute force_language
19
+ # Optional parameter to force the language of the retrieved brand data.
20
+ #
21
+ # @return [Symbol, BrandDev::Models::BrandRetrieveByIsinParams::ForceLanguage, nil]
22
+ optional :force_language, enum: -> { BrandDev::BrandRetrieveByIsinParams::ForceLanguage }
23
+
24
+ # @!attribute max_speed
25
+ # Optional parameter to optimize the API call for maximum speed. When set to true,
26
+ # the API will skip time-consuming operations for faster response at the cost of
27
+ # less comprehensive data.
28
+ #
29
+ # @return [Boolean, nil]
30
+ optional :max_speed, BrandDev::Internal::Type::Boolean
31
+
32
+ # @!attribute timeout_ms
33
+ # Optional timeout in milliseconds for the request. If the request takes longer
34
+ # than this value, it will be aborted with a 408 status code. Maximum allowed
35
+ # value is 300000ms (5 minutes).
36
+ #
37
+ # @return [Integer, nil]
38
+ optional :timeout_ms, Integer
39
+
40
+ # @!method initialize(isin:, force_language: nil, max_speed: nil, timeout_ms: nil, request_options: {})
41
+ # Some parameter documentations has been truncated, see
42
+ # {BrandDev::Models::BrandRetrieveByIsinParams} for more details.
43
+ #
44
+ # @param isin [String] ISIN (International Securities Identification Number) to retrieve brand data for
45
+ #
46
+ # @param force_language [Symbol, BrandDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
47
+ #
48
+ # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
49
+ #
50
+ # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
51
+ #
52
+ # @param request_options [BrandDev::RequestOptions, Hash{Symbol=>Object}]
53
+
54
+ # Optional parameter to force the language of the retrieved brand data.
55
+ module ForceLanguage
56
+ extend BrandDev::Internal::Type::Enum
57
+
58
+ ALBANIAN = :albanian
59
+ ARABIC = :arabic
60
+ AZERI = :azeri
61
+ BENGALI = :bengali
62
+ BULGARIAN = :bulgarian
63
+ CEBUANO = :cebuano
64
+ CROATIAN = :croatian
65
+ CZECH = :czech
66
+ DANISH = :danish
67
+ DUTCH = :dutch
68
+ ENGLISH = :english
69
+ ESTONIAN = :estonian
70
+ FARSI = :farsi
71
+ FINNISH = :finnish
72
+ FRENCH = :french
73
+ GERMAN = :german
74
+ HAUSA = :hausa
75
+ HAWAIIAN = :hawaiian
76
+ HINDI = :hindi
77
+ HUNGARIAN = :hungarian
78
+ ICELANDIC = :icelandic
79
+ INDONESIAN = :indonesian
80
+ ITALIAN = :italian
81
+ KAZAKH = :kazakh
82
+ KYRGYZ = :kyrgyz
83
+ LATIN = :latin
84
+ LATVIAN = :latvian
85
+ LITHUANIAN = :lithuanian
86
+ MACEDONIAN = :macedonian
87
+ MONGOLIAN = :mongolian
88
+ NEPALI = :nepali
89
+ NORWEGIAN = :norwegian
90
+ PASHTO = :pashto
91
+ PIDGIN = :pidgin
92
+ POLISH = :polish
93
+ PORTUGUESE = :portuguese
94
+ ROMANIAN = :romanian
95
+ RUSSIAN = :russian
96
+ SERBIAN = :serbian
97
+ SLOVAK = :slovak
98
+ SLOVENE = :slovene
99
+ SOMALI = :somali
100
+ SPANISH = :spanish
101
+ SWAHILI = :swahili
102
+ SWEDISH = :swedish
103
+ TAGALOG = :tagalog
104
+ TURKISH = :turkish
105
+ UKRAINIAN = :ukrainian
106
+ URDU = :urdu
107
+ UZBEK = :uzbek
108
+ VIETNAMESE = :vietnamese
109
+ WELSH = :welsh
110
+
111
+ # @!method self.values
112
+ # @return [Array<Symbol>]
113
+ end
114
+ end
115
+ end
116
+ end