context.dev 1.35.0 → 2.0.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.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +24 -17
  4. data/lib/context_dev/client.rb +7 -0
  5. data/lib/context_dev/models/brand_retrieve_params.rb +1036 -174
  6. data/lib/context_dev/models/monitor_create_params.rb +361 -0
  7. data/lib/context_dev/models/monitor_create_response.rb +484 -0
  8. data/lib/context_dev/models/monitor_delete_params.rb +20 -0
  9. data/lib/context_dev/models/monitor_delete_response.rb +22 -0
  10. data/lib/context_dev/models/monitor_list_account_changes_params.rb +93 -0
  11. data/lib/context_dev/models/monitor_list_account_changes_response.rb +199 -0
  12. data/lib/context_dev/models/monitor_list_account_runs_params.rb +55 -0
  13. data/lib/context_dev/models/monitor_list_account_runs_response.rb +227 -0
  14. data/lib/context_dev/models/monitor_list_changes_params.rb +57 -0
  15. data/lib/context_dev/models/monitor_list_changes_response.rb +198 -0
  16. data/lib/context_dev/models/monitor_list_params.rb +161 -0
  17. data/lib/context_dev/models/monitor_list_response.rb +507 -0
  18. data/lib/context_dev/models/monitor_list_runs_params.rb +62 -0
  19. data/lib/context_dev/models/monitor_list_runs_response.rb +227 -0
  20. data/lib/context_dev/models/monitor_retrieve_change_params.rb +20 -0
  21. data/lib/context_dev/models/monitor_retrieve_change_response.rb +271 -0
  22. data/lib/context_dev/models/monitor_retrieve_params.rb +20 -0
  23. data/lib/context_dev/models/monitor_retrieve_response.rb +484 -0
  24. data/lib/context_dev/models/monitor_run_params.rb +20 -0
  25. data/lib/context_dev/models/monitor_run_response.rb +35 -0
  26. data/lib/context_dev/models/monitor_update_params.rb +368 -0
  27. data/lib/context_dev/models/monitor_update_response.rb +484 -0
  28. data/lib/context_dev/models/utility_prefetch_params.rb +70 -6
  29. data/lib/context_dev/models/utility_prefetch_response.rb +23 -1
  30. data/lib/context_dev/models/web_extract_response.rb +17 -1
  31. data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -1
  32. data/lib/context_dev/models/web_screenshot_params.rb +245 -1
  33. data/lib/context_dev/models/web_search_params.rb +270 -3
  34. data/lib/context_dev/models/web_web_crawl_md_params.rb +236 -1
  35. data/lib/context_dev/models/web_web_scrape_html_params.rb +234 -1
  36. data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -2
  37. data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -1
  38. data/lib/context_dev/models/web_web_scrape_md_params.rb +234 -1
  39. data/lib/context_dev/models.rb +20 -12
  40. data/lib/context_dev/resources/ai.rb +0 -33
  41. data/lib/context_dev/resources/brand.rb +7 -204
  42. data/lib/context_dev/resources/monitors.rb +352 -0
  43. data/lib/context_dev/resources/utility.rb +9 -35
  44. data/lib/context_dev/resources/web.rb +36 -8
  45. data/lib/context_dev/version.rb +1 -1
  46. data/lib/context_dev.rb +23 -14
  47. data/rbi/context_dev/client.rbi +6 -0
  48. data/rbi/context_dev/models/brand_retrieve_params.rbi +3792 -679
  49. data/rbi/context_dev/models/monitor_create_params.rbi +640 -0
  50. data/rbi/context_dev/models/monitor_create_response.rbi +820 -0
  51. data/rbi/context_dev/models/monitor_delete_params.rbi +35 -0
  52. data/rbi/context_dev/models/monitor_delete_response.rbi +29 -0
  53. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +211 -0
  54. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +376 -0
  55. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +125 -0
  56. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +464 -0
  57. data/rbi/context_dev/models/monitor_list_changes_params.rbi +91 -0
  58. data/rbi/context_dev/models/monitor_list_changes_response.rbi +372 -0
  59. data/rbi/context_dev/models/monitor_list_params.rbi +332 -0
  60. data/rbi/context_dev/models/monitor_list_response.rbi +885 -0
  61. data/rbi/context_dev/models/monitor_list_runs_params.rbi +125 -0
  62. data/rbi/context_dev/models/monitor_list_runs_response.rbi +455 -0
  63. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +38 -0
  64. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +478 -0
  65. data/rbi/context_dev/models/monitor_retrieve_params.rbi +38 -0
  66. data/rbi/context_dev/models/monitor_retrieve_response.rbi +828 -0
  67. data/rbi/context_dev/models/monitor_run_params.rbi +35 -0
  68. data/rbi/context_dev/models/monitor_run_response.rbi +48 -0
  69. data/rbi/context_dev/models/monitor_update_params.rbi +680 -0
  70. data/rbi/context_dev/models/monitor_update_response.rbi +820 -0
  71. data/rbi/context_dev/models/utility_prefetch_params.rbi +129 -7
  72. data/rbi/context_dev/models/utility_prefetch_response.rbi +55 -3
  73. data/rbi/context_dev/models/web_extract_response.rbi +10 -0
  74. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +59 -0
  75. data/rbi/context_dev/models/web_screenshot_params.rbi +295 -0
  76. data/rbi/context_dev/models/web_search_params.rbi +288 -2
  77. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +260 -0
  78. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +465 -0
  79. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +29 -3
  80. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +17 -0
  81. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +259 -0
  82. data/rbi/context_dev/models.rbi +23 -15
  83. data/rbi/context_dev/resources/ai.rbi +0 -28
  84. data/rbi/context_dev/resources/brand.rbi +13 -228
  85. data/rbi/context_dev/resources/monitors.rbi +286 -0
  86. data/rbi/context_dev/resources/utility.rbi +14 -29
  87. data/rbi/context_dev/resources/web.rbi +56 -1
  88. data/sig/context_dev/client.rbs +2 -0
  89. data/sig/context_dev/models/brand_retrieve_params.rbs +1560 -281
  90. data/sig/context_dev/models/monitor_create_params.rbs +311 -0
  91. data/sig/context_dev/models/monitor_create_response.rbs +369 -0
  92. data/sig/context_dev/models/monitor_delete_params.rbs +23 -0
  93. data/sig/context_dev/models/monitor_delete_response.rbs +15 -0
  94. data/sig/context_dev/models/monitor_list_account_changes_params.rbs +104 -0
  95. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +176 -0
  96. data/sig/context_dev/models/monitor_list_account_runs_params.rbs +58 -0
  97. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +184 -0
  98. data/sig/context_dev/models/monitor_list_changes_params.rbs +61 -0
  99. data/sig/context_dev/models/monitor_list_changes_response.rbs +176 -0
  100. data/sig/context_dev/models/monitor_list_params.rbs +160 -0
  101. data/sig/context_dev/models/monitor_list_response.rbs +396 -0
  102. data/sig/context_dev/models/monitor_list_runs_params.rbs +63 -0
  103. data/sig/context_dev/models/monitor_list_runs_response.rbs +184 -0
  104. data/sig/context_dev/models/monitor_retrieve_change_params.rbs +23 -0
  105. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +228 -0
  106. data/sig/context_dev/models/monitor_retrieve_params.rbs +23 -0
  107. data/sig/context_dev/models/monitor_retrieve_response.rbs +369 -0
  108. data/sig/context_dev/models/monitor_run_params.rbs +23 -0
  109. data/sig/context_dev/models/monitor_run_response.rbs +18 -0
  110. data/sig/context_dev/models/monitor_update_params.rbs +331 -0
  111. data/sig/context_dev/models/monitor_update_response.rbs +369 -0
  112. data/sig/context_dev/models/utility_prefetch_params.rbs +52 -4
  113. data/sig/context_dev/models/utility_prefetch_response.rbs +22 -3
  114. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  115. data/sig/context_dev/models/web_extract_styleguide_params.rbs +20 -0
  116. data/sig/context_dev/models/web_screenshot_params.rbs +446 -0
  117. data/sig/context_dev/models/web_search_params.rbs +503 -0
  118. data/sig/context_dev/models/web_web_crawl_md_params.rbs +433 -0
  119. data/sig/context_dev/models/web_web_scrape_html_params.rbs +433 -0
  120. data/sig/context_dev/models/web_web_scrape_html_response.rbs +8 -0
  121. data/sig/context_dev/models/web_web_scrape_images_params.rbs +7 -0
  122. data/sig/context_dev/models/web_web_scrape_md_params.rbs +433 -0
  123. data/sig/context_dev/models.rbs +20 -12
  124. data/sig/context_dev/resources/ai.rbs +0 -8
  125. data/sig/context_dev/resources/brand.rbs +1 -56
  126. data/sig/context_dev/resources/monitors.rbs +101 -0
  127. data/sig/context_dev/resources/utility.rbs +2 -7
  128. data/sig/context_dev/resources/web.rbs +12 -0
  129. metadata +71 -44
  130. data/lib/context_dev/models/ai_ai_query_params.rb +0 -235
  131. data/lib/context_dev/models/ai_ai_query_response.rb +0 -133
  132. data/lib/context_dev/models/brand_identify_from_transaction_params.rb +0 -474
  133. data/lib/context_dev/models/brand_identify_from_transaction_response.rb +0 -1074
  134. data/lib/context_dev/models/brand_retrieve_by_email_params.rb +0 -195
  135. data/lib/context_dev/models/brand_retrieve_by_email_response.rb +0 -1071
  136. data/lib/context_dev/models/brand_retrieve_by_isin_params.rb +0 -195
  137. data/lib/context_dev/models/brand_retrieve_by_isin_response.rb +0 -1070
  138. data/lib/context_dev/models/brand_retrieve_by_name_params.rb +0 -452
  139. data/lib/context_dev/models/brand_retrieve_by_name_response.rb +0 -1070
  140. data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb +0 -283
  141. data/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +0 -1072
  142. data/lib/context_dev/models/utility_prefetch_by_email_params.rb +0 -37
  143. data/lib/context_dev/models/utility_prefetch_by_email_response.rb +0 -68
  144. data/rbi/context_dev/models/ai_ai_query_params.rbi +0 -504
  145. data/rbi/context_dev/models/ai_ai_query_response.rbi +0 -267
  146. data/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +0 -2020
  147. data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +0 -3515
  148. data/rbi/context_dev/models/brand_retrieve_by_email_params.rbi +0 -743
  149. data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +0 -3511
  150. data/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi +0 -743
  151. data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +0 -3510
  152. data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +0 -1982
  153. data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +0 -3510
  154. data/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi +0 -1153
  155. data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +0 -3512
  156. data/rbi/context_dev/models/utility_prefetch_by_email_params.rbi +0 -65
  157. data/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +0 -132
  158. data/sig/context_dev/models/ai_ai_query_params.rbs +0 -218
  159. data/sig/context_dev/models/ai_ai_query_response.rbs +0 -121
  160. data/sig/context_dev/models/brand_identify_from_transaction_params.rbs +0 -822
  161. data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +0 -1441
  162. data/sig/context_dev/models/brand_retrieve_by_email_params.rbs +0 -305
  163. data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +0 -1441
  164. data/sig/context_dev/models/brand_retrieve_by_isin_params.rbs +0 -305
  165. data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +0 -1441
  166. data/sig/context_dev/models/brand_retrieve_by_name_params.rbs +0 -801
  167. data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +0 -1441
  168. data/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs +0 -467
  169. data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +0 -1441
  170. data/sig/context_dev/models/utility_prefetch_by_email_params.rbs +0 -30
  171. data/sig/context_dev/models/utility_prefetch_by_email_response.rbs +0 -64
@@ -14,6 +14,13 @@ module ContextDev
14
14
  # @return [String]
15
15
  required :url, String
16
16
 
17
+ # @!attribute country
18
+ # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
19
+ # When provided, Context.dev fetches the target page from that country.
20
+ #
21
+ # @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country, nil]
22
+ optional :country, enum: -> { ContextDev::WebWebScrapeMdParams::Country }
23
+
17
24
  # @!attribute exclude_selectors
18
25
  # CSS selectors to remove before conversion to Markdown. Applied after
19
26
  # includeSelectors. Exclusion takes precedence: an element matching both is
@@ -71,6 +78,14 @@ module ContextDev
71
78
  # @return [ContextDev::Models::WebWebScrapeMdParams::Pdf, nil]
72
79
  optional :pdf, -> { ContextDev::WebWebScrapeMdParams::Pdf }
73
80
 
81
+ # @!attribute settle_animations
82
+ # When true, waits briefly for CSS and transition animations to settle before
83
+ # converting to Markdown. Defaults to false. This adds a bit of latency in
84
+ # exchange for more stable output on animated pages.
85
+ #
86
+ # @return [Boolean, nil]
87
+ optional :settle_animations, ContextDev::Internal::Type::Boolean
88
+
74
89
  # @!attribute shorten_base64_images
75
90
  # Shorten base64-encoded image data in the Markdown output
76
91
  #
@@ -99,12 +114,14 @@ module ContextDev
99
114
  # @return [Integer, nil]
100
115
  optional :wait_for_ms, Integer
101
116
 
102
- # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
117
+ # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
103
118
  # Some parameter documentations has been truncated, see
104
119
  # {ContextDev::Models::WebWebScrapeMdParams} for more details.
105
120
  #
106
121
  # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr
107
122
  #
123
+ # @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe
124
+ #
108
125
  # @param exclude_selectors [Array<String>] CSS selectors to remove before conversion to Markdown. Applied after includeSele
109
126
  #
110
127
  # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
@@ -121,6 +138,8 @@ module ContextDev
121
138
  #
122
139
  # @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
123
140
  #
141
+ # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before conv
142
+ #
124
143
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
125
144
  #
126
145
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
@@ -131,6 +150,220 @@ module ContextDev
131
150
  #
132
151
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
133
152
 
153
+ # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
154
+ # When provided, Context.dev fetches the target page from that country.
155
+ module Country
156
+ extend ContextDev::Internal::Type::Enum
157
+
158
+ AD = :ad
159
+ AE = :ae
160
+ AF = :af
161
+ AG = :ag
162
+ AI = :ai
163
+ AL = :al
164
+ AM = :am
165
+ AO = :ao
166
+ AR = :ar
167
+ AT = :at
168
+ AU = :au
169
+ AW = :aw
170
+ AZ = :az
171
+ BA = :ba
172
+ BB = :bb
173
+ BD = :bd
174
+ BE = :be
175
+ BF = :bf
176
+ BG = :bg
177
+ BH = :bh
178
+ BI = :bi
179
+ BJ = :bj
180
+ BM = :bm
181
+ BN = :bn
182
+ BO = :bo
183
+ BQ = :bq
184
+ BR = :br
185
+ BS = :bs
186
+ BW = :bw
187
+ BY = :by
188
+ BZ = :bz
189
+ CA = :ca
190
+ CD = :cd
191
+ CF = :cf
192
+ CG = :cg
193
+ CH = :ch
194
+ CI = :ci
195
+ CL = :cl
196
+ CM = :cm
197
+ CN = :cn
198
+ CO = :co
199
+ CR = :cr
200
+ CV = :cv
201
+ CW = :cw
202
+ CY = :cy
203
+ CZ = :cz
204
+ DE = :de
205
+ DJ = :dj
206
+ DK = :dk
207
+ DM = :dm
208
+ DO = :do
209
+ DZ = :dz
210
+ EC = :ec
211
+ EE = :ee
212
+ EG = :eg
213
+ ES = :es
214
+ ET = :et
215
+ FI = :fi
216
+ FJ = :fj
217
+ FR = :fr
218
+ GA = :ga
219
+ GB = :gb
220
+ GD = :gd
221
+ GE = :ge
222
+ GF = :gf
223
+ GG = :gg
224
+ GH = :gh
225
+ GM = :gm
226
+ GN = :gn
227
+ GP = :gp
228
+ GQ = :gq
229
+ GR = :gr
230
+ GT = :gt
231
+ GU = :gu
232
+ GW = :gw
233
+ GY = :gy
234
+ HK = :hk
235
+ HN = :hn
236
+ HR = :hr
237
+ HT = :ht
238
+ HU = :hu
239
+ ID = :id
240
+ IE = :ie
241
+ IL = :il
242
+ IM = :im
243
+ IN = :in
244
+ IQ = :iq
245
+ IR = :ir
246
+ IS = :is
247
+ IT = :it
248
+ JE = :je
249
+ JM = :jm
250
+ JO = :jo
251
+ JP = :jp
252
+ KE = :ke
253
+ KG = :kg
254
+ KH = :kh
255
+ KN = :kn
256
+ KR = :kr
257
+ KW = :kw
258
+ KY = :ky
259
+ KZ = :kz
260
+ LA = :la
261
+ LB = :lb
262
+ LC = :lc
263
+ LK = :lk
264
+ LR = :lr
265
+ LS = :ls
266
+ LT = :lt
267
+ LU = :lu
268
+ LV = :lv
269
+ LY = :ly
270
+ MA = :ma
271
+ MC = :mc
272
+ MD = :md
273
+ ME = :me
274
+ MF = :mf
275
+ MG = :mg
276
+ MK = :mk
277
+ ML = :ml
278
+ MM = :mm
279
+ MN = :mn
280
+ MO = :mo
281
+ MQ = :mq
282
+ MR = :mr
283
+ MT = :mt
284
+ MU = :mu
285
+ MV = :mv
286
+ MW = :mw
287
+ MX = :mx
288
+ MY = :my
289
+ MZ = :mz
290
+ NA = :na
291
+ NC = :nc
292
+ NE = :ne
293
+ NG = :ng
294
+ NI = :ni
295
+ NL = :nl
296
+ NO = :no
297
+ NP = :np
298
+ NZ = :nz
299
+ OM = :om
300
+ PA = :pa
301
+ PE = :pe
302
+ PF = :pf
303
+ PG = :pg
304
+ PH = :ph
305
+ PK = :pk
306
+ PL = :pl
307
+ PR = :pr
308
+ PS = :ps
309
+ PT = :pt
310
+ PY = :py
311
+ QA = :qa
312
+ RE = :re
313
+ RO = :ro
314
+ RS = :rs
315
+ RU = :ru
316
+ RW = :rw
317
+ SA = :sa
318
+ SC = :sc
319
+ SD = :sd
320
+ SE = :se
321
+ SG = :sg
322
+ SI = :si
323
+ SK = :sk
324
+ SL = :sl
325
+ SM = :sm
326
+ SN = :sn
327
+ SO = :so
328
+ SR = :sr
329
+ SS = :ss
330
+ ST = :st
331
+ SV = :sv
332
+ SX = :sx
333
+ SY = :sy
334
+ SZ = :sz
335
+ TC = :tc
336
+ TD = :td
337
+ TG = :tg
338
+ TH = :th
339
+ TJ = :tj
340
+ TL = :tl
341
+ TM = :tm
342
+ TN = :tn
343
+ TR = :tr
344
+ TT = :tt
345
+ TW = :tw
346
+ TZ = :tz
347
+ UA = :ua
348
+ UG = :ug
349
+ US = :us
350
+ UY = :uy
351
+ UZ = :uz
352
+ VC = :vc
353
+ VE = :ve
354
+ VG = :vg
355
+ VI = :vi
356
+ VN = :vn
357
+ YE = :ye
358
+ YT = :yt
359
+ ZA = :za
360
+ ZM = :zm
361
+ ZW = :zw
362
+
363
+ # @!method self.values
364
+ # @return [Array<Symbol>]
365
+ end
366
+
134
367
  class Pdf < ContextDev::Internal::Type::BaseModel
135
368
  # @!attribute end_
136
369
  # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
@@ -39,31 +39,39 @@ module ContextDev
39
39
  mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
40
40
  end
41
41
 
42
- AIAIQueryParams = ContextDev::Models::AIAIQueryParams
43
-
44
42
  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
45
43
 
46
44
  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
47
45
 
48
- BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams
46
+ BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
49
47
 
50
- BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams
48
+ BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
51
49
 
52
- BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams
50
+ IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
53
51
 
54
- BrandRetrieveByNameParams = ContextDev::Models::BrandRetrieveByNameParams
52
+ IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
55
53
 
56
- BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams
54
+ MonitorCreateParams = ContextDev::Models::MonitorCreateParams
57
55
 
58
- BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
56
+ MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
59
57
 
60
- BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
58
+ MonitorListAccountChangesParams = ContextDev::Models::MonitorListAccountChangesParams
61
59
 
62
- IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
60
+ MonitorListAccountRunsParams = ContextDev::Models::MonitorListAccountRunsParams
63
61
 
64
- IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
62
+ MonitorListChangesParams = ContextDev::Models::MonitorListChangesParams
63
+
64
+ MonitorListParams = ContextDev::Models::MonitorListParams
65
+
66
+ MonitorListRunsParams = ContextDev::Models::MonitorListRunsParams
67
+
68
+ MonitorRetrieveChangeParams = ContextDev::Models::MonitorRetrieveChangeParams
69
+
70
+ MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
71
+
72
+ MonitorRunParams = ContextDev::Models::MonitorRunParams
65
73
 
66
- UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams
74
+ MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
67
75
 
68
76
  UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
69
77
 
@@ -3,39 +3,6 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class AI
6
- # Some parameter documentations has been truncated, see
7
- # {ContextDev::Models::AIAIQueryParams} for more details.
8
- #
9
- # Use AI to extract specific data points from a brand's website. The AI will crawl
10
- # the website and extract the requested information based on the provided data
11
- # points.
12
- #
13
- # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
14
- #
15
- # @param data_to_extract [Array<ContextDev::Models::AIAIQueryParams::DataToExtract>] Array of data points to extract from the website
16
- #
17
- # @param domain [String] The domain name to analyze
18
- #
19
- # @param specific_pages [ContextDev::Models::AIAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
20
- #
21
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
22
- #
23
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
24
- #
25
- # @return [ContextDev::Models::AIAIQueryResponse]
26
- #
27
- # @see ContextDev::Models::AIAIQueryParams
28
- def ai_query(params)
29
- parsed, options = ContextDev::AIAIQueryParams.dump_request(params)
30
- @client.request(
31
- method: :post,
32
- path: "brand/ai/query",
33
- body: parsed,
34
- model: ContextDev::Models::AIAIQueryResponse,
35
- options: options
36
- )
37
- end
38
-
39
6
  # Some parameter documentations has been truncated, see
40
7
  # {ContextDev::Models::AIExtractProductParams} for more details.
41
8
  #
@@ -3,23 +3,13 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class Brand
6
- # Some parameter documentations has been truncated, see
7
- # {ContextDev::Models::BrandRetrieveParams} for more details.
8
- #
9
- # Retrieve logos, backdrops, colors, industry, description, and more from any
10
- # domain
11
- #
12
- # @overload retrieve(domain:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
13
- #
14
- # @param domain [String] Domain name to retrieve brand data for (e.g., 'example.com', 'google.com'). Cann
6
+ # Retrieve logos, backdrops, colors, industry, description, and more. Provide
7
+ # exactly one lookup identifier in the request body: a domain, company name, email
8
+ # address, stock ticker, or transaction descriptor.
15
9
  #
16
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
10
+ # @overload retrieve(body:, request_options: {})
17
11
  #
18
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
19
- #
20
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
21
- #
22
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
12
+ # @param body [ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction] Exactly one lookup type must be provided.
23
13
  #
24
14
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
25
15
  #
@@ -28,202 +18,15 @@ module ContextDev
28
18
  # @see ContextDev::Models::BrandRetrieveParams
29
19
  def retrieve(params)
30
20
  parsed, options = ContextDev::BrandRetrieveParams.dump_request(params)
31
- query = ContextDev::Internal::Util.encode_query_params(parsed)
32
21
  @client.request(
33
- method: :get,
22
+ method: :post,
34
23
  path: "brand/retrieve",
35
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
24
+ body: parsed[:body],
36
25
  model: ContextDev::Models::BrandRetrieveResponse,
37
26
  options: options
38
27
  )
39
28
  end
40
29
 
41
- # Some parameter documentations has been truncated, see
42
- # {ContextDev::Models::BrandIdentifyFromTransactionParams} for more details.
43
- #
44
- # Endpoint specially designed for platforms that want to identify transaction data
45
- # by the transaction title.
46
- #
47
- # @overload identify_from_transaction(transaction_info:, city: nil, country_gl: nil, force_language: nil, high_confidence_only: nil, max_speed: nil, mcc: nil, phone: nil, timeout_ms: nil, request_options: {})
48
- #
49
- # @param transaction_info [String] Transaction information to identify the brand
50
- #
51
- # @param city [String] Optional city name to prioritize when searching for the brand.
52
- #
53
- # @param country_gl [Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::CountryGl] Optional country code (GL parameter) to specify the country. This affects the ge
54
- #
55
- # @param force_language [Symbol, ContextDev::Models::BrandIdentifyFromTransactionParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
56
- #
57
- # @param high_confidence_only [Boolean] When set to true, the API will perform an additional verification steps to ensur
58
- #
59
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
60
- #
61
- # @param mcc [String] Optional Merchant Category Code (MCC) to help identify the business category/ind
62
- #
63
- # @param phone [Float] Optional phone number from the transaction to help verify brand match.
64
- #
65
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
66
- #
67
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
68
- #
69
- # @return [ContextDev::Models::BrandIdentifyFromTransactionResponse]
70
- #
71
- # @see ContextDev::Models::BrandIdentifyFromTransactionParams
72
- def identify_from_transaction(params)
73
- parsed, options = ContextDev::BrandIdentifyFromTransactionParams.dump_request(params)
74
- query = ContextDev::Internal::Util.encode_query_params(parsed)
75
- @client.request(
76
- method: :get,
77
- path: "brand/transaction_identifier",
78
- query: query.transform_keys(max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
79
- model: ContextDev::Models::BrandIdentifyFromTransactionResponse,
80
- options: options
81
- )
82
- end
83
-
84
- # Some parameter documentations has been truncated, see
85
- # {ContextDev::Models::BrandRetrieveByEmailParams} for more details.
86
- #
87
- # Retrieve brand information using an email address while detecting disposable and
88
- # free email addresses. Disposable and free email addresses (like gmail.com,
89
- # yahoo.com) will throw a 422 error.
90
- #
91
- # @overload retrieve_by_email(email:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
92
- #
93
- # @param email [String] Email address to retrieve brand data for (e.g., 'contact@example.com'). The doma
94
- #
95
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByEmailParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
96
- #
97
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
98
- #
99
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
100
- #
101
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
102
- #
103
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
104
- #
105
- # @return [ContextDev::Models::BrandRetrieveByEmailResponse]
106
- #
107
- # @see ContextDev::Models::BrandRetrieveByEmailParams
108
- def retrieve_by_email(params)
109
- parsed, options = ContextDev::BrandRetrieveByEmailParams.dump_request(params)
110
- query = ContextDev::Internal::Util.encode_query_params(parsed)
111
- @client.request(
112
- method: :get,
113
- path: "brand/retrieve-by-email",
114
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
115
- model: ContextDev::Models::BrandRetrieveByEmailResponse,
116
- options: options
117
- )
118
- end
119
-
120
- # Some parameter documentations has been truncated, see
121
- # {ContextDev::Models::BrandRetrieveByIsinParams} for more details.
122
- #
123
- # Retrieve brand information using an ISIN (International Securities
124
- # Identification Number).
125
- #
126
- # @overload retrieve_by_isin(isin:, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
127
- #
128
- # @param isin [String] ISIN (International Securities Identification Number) to retrieve brand data for
129
- #
130
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByIsinParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
131
- #
132
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
133
- #
134
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
135
- #
136
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
137
- #
138
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
139
- #
140
- # @return [ContextDev::Models::BrandRetrieveByIsinResponse]
141
- #
142
- # @see ContextDev::Models::BrandRetrieveByIsinParams
143
- def retrieve_by_isin(params)
144
- parsed, options = ContextDev::BrandRetrieveByIsinParams.dump_request(params)
145
- query = ContextDev::Internal::Util.encode_query_params(parsed)
146
- @client.request(
147
- method: :get,
148
- path: "brand/retrieve-by-isin",
149
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
150
- model: ContextDev::Models::BrandRetrieveByIsinResponse,
151
- options: options
152
- )
153
- end
154
-
155
- # Some parameter documentations has been truncated, see
156
- # {ContextDev::Models::BrandRetrieveByNameParams} for more details.
157
- #
158
- # Retrieve brand information using a company name.
159
- #
160
- # @overload retrieve_by_name(name:, country_gl: nil, force_language: nil, max_age_ms: nil, max_speed: nil, timeout_ms: nil, request_options: {})
161
- #
162
- # @param name [String] Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft Corporati
163
- #
164
- # @param country_gl [Symbol, ContextDev::Models::BrandRetrieveByNameParams::CountryGl] Optional country code hint (GL parameter) to specify the country for the company
165
- #
166
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByNameParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
167
- #
168
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
169
- #
170
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
171
- #
172
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
173
- #
174
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
175
- #
176
- # @return [ContextDev::Models::BrandRetrieveByNameResponse]
177
- #
178
- # @see ContextDev::Models::BrandRetrieveByNameParams
179
- def retrieve_by_name(params)
180
- parsed, options = ContextDev::BrandRetrieveByNameParams.dump_request(params)
181
- query = ContextDev::Internal::Util.encode_query_params(parsed)
182
- @client.request(
183
- method: :get,
184
- path: "brand/retrieve-by-name",
185
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
186
- model: ContextDev::Models::BrandRetrieveByNameResponse,
187
- options: options
188
- )
189
- end
190
-
191
- # Some parameter documentations has been truncated, see
192
- # {ContextDev::Models::BrandRetrieveByTickerParams} for more details.
193
- #
194
- # Retrieve brand information using a stock ticker symbol.
195
- #
196
- # @overload retrieve_by_ticker(ticker:, force_language: nil, max_age_ms: nil, max_speed: nil, ticker_exchange: nil, timeout_ms: nil, request_options: {})
197
- #
198
- # @param ticker [String] Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
199
- #
200
- # @param force_language [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::ForceLanguage] Optional parameter to force the language of the retrieved brand data.
201
- #
202
- # @param max_age_ms [Integer] Maximum age in milliseconds for cached brand data before the API performs a hard
203
- #
204
- # @param max_speed [Boolean] Optional parameter to optimize the API call for maximum speed. When set to true,
205
- #
206
- # @param ticker_exchange [Symbol, ContextDev::Models::BrandRetrieveByTickerParams::TickerExchange] Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
207
- #
208
- # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
209
- #
210
- # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
211
- #
212
- # @return [ContextDev::Models::BrandRetrieveByTickerResponse]
213
- #
214
- # @see ContextDev::Models::BrandRetrieveByTickerParams
215
- def retrieve_by_ticker(params)
216
- parsed, options = ContextDev::BrandRetrieveByTickerParams.dump_request(params)
217
- query = ContextDev::Internal::Util.encode_query_params(parsed)
218
- @client.request(
219
- method: :get,
220
- path: "brand/retrieve-by-ticker",
221
- query: query.transform_keys(max_age_ms: "maxAgeMs", max_speed: "maxSpeed", timeout_ms: "timeoutMS"),
222
- model: ContextDev::Models::BrandRetrieveByTickerResponse,
223
- options: options
224
- )
225
- end
226
-
227
30
  # Some parameter documentations has been truncated, see
228
31
  # {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
229
32
  #