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
@@ -16,6 +16,20 @@ module ContextDev
16
16
  sig { returns(String) }
17
17
  attr_accessor :url
18
18
 
19
+ # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
20
+ # When provided, Context.dev fetches the target page from that country.
21
+ sig do
22
+ returns(T.nilable(ContextDev::WebWebScrapeMdParams::Country::OrSymbol))
23
+ end
24
+ attr_reader :country
25
+
26
+ sig do
27
+ params(
28
+ country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol
29
+ ).void
30
+ end
31
+ attr_writer :country
32
+
19
33
  # CSS selectors to remove before conversion to Markdown. Applied after
20
34
  # includeSelectors. Exclusion takes precedence: an element matching both is
21
35
  # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
@@ -81,6 +95,15 @@ module ContextDev
81
95
  sig { params(pdf: ContextDev::WebWebScrapeMdParams::Pdf::OrHash).void }
82
96
  attr_writer :pdf
83
97
 
98
+ # When true, waits briefly for CSS and transition animations to settle before
99
+ # converting to Markdown. Defaults to false. This adds a bit of latency in
100
+ # exchange for more stable output on animated pages.
101
+ sig { returns(T.nilable(T::Boolean)) }
102
+ attr_reader :settle_animations
103
+
104
+ sig { params(settle_animations: T::Boolean).void }
105
+ attr_writer :settle_animations
106
+
84
107
  # Shorten base64-encoded image data in the Markdown output
85
108
  sig { returns(T.nilable(T::Boolean)) }
86
109
  attr_reader :shorten_base64_images
@@ -116,6 +139,7 @@ module ContextDev
116
139
  sig do
117
140
  params(
118
141
  url: String,
142
+ country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol,
119
143
  exclude_selectors: T::Array[String],
120
144
  headers: T::Hash[Symbol, String],
121
145
  include_frames: T::Boolean,
@@ -124,6 +148,7 @@ module ContextDev
124
148
  include_selectors: T::Array[String],
125
149
  max_age_ms: Integer,
126
150
  pdf: ContextDev::WebWebScrapeMdParams::Pdf::OrHash,
151
+ settle_animations: T::Boolean,
127
152
  shorten_base64_images: T::Boolean,
128
153
  timeout_ms: Integer,
129
154
  use_main_content_only: T::Boolean,
@@ -135,6 +160,9 @@ module ContextDev
135
160
  # Full URL to scrape into LLM usable Markdown (must include http:// or https://
136
161
  # protocol)
137
162
  url:,
163
+ # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
164
+ # When provided, Context.dev fetches the target page from that country.
165
+ country: nil,
138
166
  # CSS selectors to remove before conversion to Markdown. Applied after
139
167
  # includeSelectors. Exclusion takes precedence: an element matching both is
140
168
  # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
@@ -160,6 +188,10 @@ module ContextDev
160
188
  # PDF parsing controls. Use start/end to limit text extraction and OCR to an
161
189
  # inclusive 1-based page range.
162
190
  pdf: nil,
191
+ # When true, waits briefly for CSS and transition animations to settle before
192
+ # converting to Markdown. Defaults to false. This adds a bit of latency in
193
+ # exchange for more stable output on animated pages.
194
+ settle_animations: nil,
163
195
  # Shorten base64-encoded image data in the Markdown output
164
196
  shorten_base64_images: nil,
165
197
  # Optional timeout in milliseconds for the request. If the request takes longer
@@ -180,6 +212,7 @@ module ContextDev
180
212
  override.returns(
181
213
  {
182
214
  url: String,
215
+ country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol,
183
216
  exclude_selectors: T::Array[String],
184
217
  headers: T::Hash[Symbol, String],
185
218
  include_frames: T::Boolean,
@@ -188,6 +221,7 @@ module ContextDev
188
221
  include_selectors: T::Array[String],
189
222
  max_age_ms: Integer,
190
223
  pdf: ContextDev::WebWebScrapeMdParams::Pdf,
224
+ settle_animations: T::Boolean,
191
225
  shorten_base64_images: T::Boolean,
192
226
  timeout_ms: Integer,
193
227
  use_main_content_only: T::Boolean,
@@ -199,6 +233,231 @@ module ContextDev
199
233
  def to_hash
200
234
  end
201
235
 
236
+ # Two-letter ISO 3166-1 alpha-2 country code for the website request location.
237
+ # When provided, Context.dev fetches the target page from that country.
238
+ module Country
239
+ extend ContextDev::Internal::Type::Enum
240
+
241
+ TaggedSymbol =
242
+ T.type_alias do
243
+ T.all(Symbol, ContextDev::WebWebScrapeMdParams::Country)
244
+ end
245
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
246
+
247
+ AD = T.let(:ad, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
248
+ AE = T.let(:ae, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
249
+ AF = T.let(:af, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
250
+ AG = T.let(:ag, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
251
+ AI = T.let(:ai, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
252
+ AL = T.let(:al, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
253
+ AM = T.let(:am, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
254
+ AO = T.let(:ao, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
255
+ AR = T.let(:ar, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
256
+ AT = T.let(:at, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
257
+ AU = T.let(:au, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
258
+ AW = T.let(:aw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
259
+ AZ = T.let(:az, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
260
+ BA = T.let(:ba, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
261
+ BB = T.let(:bb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
262
+ BD = T.let(:bd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
263
+ BE = T.let(:be, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
264
+ BF = T.let(:bf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
265
+ BG = T.let(:bg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
266
+ BH = T.let(:bh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
267
+ BI = T.let(:bi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
268
+ BJ = T.let(:bj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
269
+ BM = T.let(:bm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
270
+ BN = T.let(:bn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
271
+ BO = T.let(:bo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
272
+ BQ = T.let(:bq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
273
+ BR = T.let(:br, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
274
+ BS = T.let(:bs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
275
+ BW = T.let(:bw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
276
+ BY = T.let(:by, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
277
+ BZ = T.let(:bz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
278
+ CA = T.let(:ca, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
279
+ CD = T.let(:cd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
280
+ CF = T.let(:cf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
281
+ CG = T.let(:cg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
282
+ CH = T.let(:ch, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
283
+ CI = T.let(:ci, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
284
+ CL = T.let(:cl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
285
+ CM = T.let(:cm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
286
+ CN = T.let(:cn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
287
+ CO = T.let(:co, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
288
+ CR = T.let(:cr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
289
+ CV = T.let(:cv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
290
+ CW = T.let(:cw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
291
+ CY = T.let(:cy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
292
+ CZ = T.let(:cz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
293
+ DE = T.let(:de, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
294
+ DJ = T.let(:dj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
295
+ DK = T.let(:dk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
296
+ DM = T.let(:dm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
297
+ DO = T.let(:do, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
298
+ DZ = T.let(:dz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
299
+ EC = T.let(:ec, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
300
+ EE = T.let(:ee, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
301
+ EG = T.let(:eg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
302
+ ES = T.let(:es, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
303
+ ET = T.let(:et, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
304
+ FI = T.let(:fi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
305
+ FJ = T.let(:fj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
306
+ FR = T.let(:fr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
307
+ GA = T.let(:ga, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
308
+ GB = T.let(:gb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
309
+ GD = T.let(:gd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
310
+ GE = T.let(:ge, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
311
+ GF = T.let(:gf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
312
+ GG = T.let(:gg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
313
+ GH = T.let(:gh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
314
+ GM = T.let(:gm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
315
+ GN = T.let(:gn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
316
+ GP = T.let(:gp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
317
+ GQ = T.let(:gq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
318
+ GR = T.let(:gr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
319
+ GT = T.let(:gt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
320
+ GU = T.let(:gu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
321
+ GW = T.let(:gw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
322
+ GY = T.let(:gy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
323
+ HK = T.let(:hk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
324
+ HN = T.let(:hn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
325
+ HR = T.let(:hr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
326
+ HT = T.let(:ht, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
327
+ HU = T.let(:hu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
328
+ ID = T.let(:id, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
329
+ IE = T.let(:ie, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
330
+ IL = T.let(:il, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
331
+ IM = T.let(:im, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
332
+ IN = T.let(:in, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
333
+ IQ = T.let(:iq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
334
+ IR = T.let(:ir, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
335
+ IS = T.let(:is, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
336
+ IT = T.let(:it, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
337
+ JE = T.let(:je, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
338
+ JM = T.let(:jm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
339
+ JO = T.let(:jo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
340
+ JP = T.let(:jp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
341
+ KE = T.let(:ke, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
342
+ KG = T.let(:kg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
343
+ KH = T.let(:kh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
344
+ KN = T.let(:kn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
345
+ KR = T.let(:kr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
346
+ KW = T.let(:kw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
347
+ KY = T.let(:ky, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
348
+ KZ = T.let(:kz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
349
+ LA = T.let(:la, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
350
+ LB = T.let(:lb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
351
+ LC = T.let(:lc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
352
+ LK = T.let(:lk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
353
+ LR = T.let(:lr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
354
+ LS = T.let(:ls, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
355
+ LT = T.let(:lt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
356
+ LU = T.let(:lu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
357
+ LV = T.let(:lv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
358
+ LY = T.let(:ly, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
359
+ MA = T.let(:ma, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
360
+ MC = T.let(:mc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
361
+ MD = T.let(:md, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
362
+ ME = T.let(:me, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
363
+ MF = T.let(:mf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
364
+ MG = T.let(:mg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
365
+ MK = T.let(:mk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
366
+ ML = T.let(:ml, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
367
+ MM = T.let(:mm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
368
+ MN = T.let(:mn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
369
+ MO = T.let(:mo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
370
+ MQ = T.let(:mq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
371
+ MR = T.let(:mr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
372
+ MT = T.let(:mt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
373
+ MU = T.let(:mu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
374
+ MV = T.let(:mv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
375
+ MW = T.let(:mw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
376
+ MX = T.let(:mx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
377
+ MY = T.let(:my, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
378
+ MZ = T.let(:mz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
379
+ NA = T.let(:na, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
380
+ NC = T.let(:nc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
381
+ NE = T.let(:ne, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
382
+ NG = T.let(:ng, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
383
+ NI = T.let(:ni, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
384
+ NL = T.let(:nl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
385
+ NO = T.let(:no, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
386
+ NP = T.let(:np, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
387
+ NZ = T.let(:nz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
388
+ OM = T.let(:om, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
389
+ PA = T.let(:pa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
390
+ PE = T.let(:pe, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
391
+ PF = T.let(:pf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
392
+ PG = T.let(:pg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
393
+ PH = T.let(:ph, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
394
+ PK = T.let(:pk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
395
+ PL = T.let(:pl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
396
+ PR = T.let(:pr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
397
+ PS = T.let(:ps, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
398
+ PT = T.let(:pt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
399
+ PY = T.let(:py, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
400
+ QA = T.let(:qa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
401
+ RE = T.let(:re, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
402
+ RO = T.let(:ro, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
403
+ RS = T.let(:rs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
404
+ RU = T.let(:ru, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
405
+ RW = T.let(:rw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
406
+ SA = T.let(:sa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
407
+ SC = T.let(:sc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
408
+ SD = T.let(:sd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
409
+ SE = T.let(:se, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
410
+ SG = T.let(:sg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
411
+ SI = T.let(:si, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
412
+ SK = T.let(:sk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
413
+ SL = T.let(:sl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
414
+ SM = T.let(:sm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
415
+ SN = T.let(:sn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
416
+ SO = T.let(:so, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
417
+ SR = T.let(:sr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
418
+ SS = T.let(:ss, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
419
+ ST = T.let(:st, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
420
+ SV = T.let(:sv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
421
+ SX = T.let(:sx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
422
+ SY = T.let(:sy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
423
+ SZ = T.let(:sz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
424
+ TC = T.let(:tc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
425
+ TD = T.let(:td, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
426
+ TG = T.let(:tg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
427
+ TH = T.let(:th, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
428
+ TJ = T.let(:tj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
429
+ TL = T.let(:tl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
430
+ TM = T.let(:tm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
431
+ TN = T.let(:tn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
432
+ TR = T.let(:tr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
433
+ TT = T.let(:tt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
434
+ TW = T.let(:tw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
435
+ TZ = T.let(:tz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
436
+ UA = T.let(:ua, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
437
+ UG = T.let(:ug, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
438
+ US = T.let(:us, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
439
+ UY = T.let(:uy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
440
+ UZ = T.let(:uz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
441
+ VC = T.let(:vc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
442
+ VE = T.let(:ve, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
443
+ VG = T.let(:vg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
444
+ VI = T.let(:vi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
445
+ VN = T.let(:vn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
446
+ YE = T.let(:ye, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
447
+ YT = T.let(:yt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
448
+ ZA = T.let(:za, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
449
+ ZM = T.let(:zm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
450
+ ZW = T.let(:zw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
451
+
452
+ sig do
453
+ override.returns(
454
+ T::Array[ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol]
455
+ )
456
+ end
457
+ def self.values
458
+ end
459
+ end
460
+
202
461
  class Pdf < ContextDev::Internal::Type::BaseModel
203
462
  OrHash =
204
463
  T.type_alias do
@@ -1,23 +1,10 @@
1
1
  # typed: strong
2
2
 
3
3
  module ContextDev
4
- AIAIQueryParams = ContextDev::Models::AIAIQueryParams
5
-
6
4
  AIExtractProductParams = ContextDev::Models::AIExtractProductParams
7
5
 
8
6
  AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
9
7
 
10
- BrandIdentifyFromTransactionParams =
11
- ContextDev::Models::BrandIdentifyFromTransactionParams
12
-
13
- BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams
14
-
15
- BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams
16
-
17
- BrandRetrieveByNameParams = ContextDev::Models::BrandRetrieveByNameParams
18
-
19
- BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams
20
-
21
8
  BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
22
9
 
23
10
  BrandRetrieveSimplifiedParams =
@@ -27,8 +14,29 @@ module ContextDev
27
14
 
28
15
  IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
29
16
 
30
- UtilityPrefetchByEmailParams =
31
- ContextDev::Models::UtilityPrefetchByEmailParams
17
+ MonitorCreateParams = ContextDev::Models::MonitorCreateParams
18
+
19
+ MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
20
+
21
+ MonitorListAccountChangesParams =
22
+ ContextDev::Models::MonitorListAccountChangesParams
23
+
24
+ MonitorListAccountRunsParams =
25
+ ContextDev::Models::MonitorListAccountRunsParams
26
+
27
+ MonitorListChangesParams = ContextDev::Models::MonitorListChangesParams
28
+
29
+ MonitorListParams = ContextDev::Models::MonitorListParams
30
+
31
+ MonitorListRunsParams = ContextDev::Models::MonitorListRunsParams
32
+
33
+ MonitorRetrieveChangeParams = ContextDev::Models::MonitorRetrieveChangeParams
34
+
35
+ MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
36
+
37
+ MonitorRunParams = ContextDev::Models::MonitorRunParams
38
+
39
+ MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
32
40
 
33
41
  UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
34
42
 
@@ -3,34 +3,6 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class AI
6
- # Use AI to extract specific data points from a brand's website. The AI will crawl
7
- # the website and extract the requested information based on the provided data
8
- # points.
9
- sig do
10
- params(
11
- data_to_extract:
12
- T::Array[ContextDev::AIAIQueryParams::DataToExtract::OrHash],
13
- domain: String,
14
- specific_pages: ContextDev::AIAIQueryParams::SpecificPages::OrHash,
15
- timeout_ms: Integer,
16
- request_options: ContextDev::RequestOptions::OrHash
17
- ).returns(ContextDev::Models::AIAIQueryResponse)
18
- end
19
- def ai_query(
20
- # Array of data points to extract from the website
21
- data_to_extract:,
22
- # The domain name to analyze
23
- domain:,
24
- # Optional object specifying which pages to analyze
25
- specific_pages: nil,
26
- # Optional timeout in milliseconds for the request. If the request takes longer
27
- # than this value, it will be aborted with a 408 status code. Maximum allowed
28
- # value is 300000ms (5 minutes).
29
- timeout_ms: nil,
30
- request_options: {}
31
- )
32
- end
33
-
34
6
  # Given a single URL, determines if it is a product page and extracts the product
35
7
  # information.
36
8
  sig do
@@ -3,240 +3,25 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class Brand
6
- # Retrieve logos, backdrops, colors, industry, description, and more from any
7
- # domain
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.
8
9
  sig do
9
10
  params(
10
- domain: String,
11
- force_language:
12
- ContextDev::BrandRetrieveParams::ForceLanguage::OrSymbol,
13
- max_age_ms: Integer,
14
- max_speed: T::Boolean,
15
- timeout_ms: Integer,
11
+ body:
12
+ T.any(
13
+ ContextDev::BrandRetrieveParams::Body::ByDomain::OrHash,
14
+ ContextDev::BrandRetrieveParams::Body::ByName::OrHash,
15
+ ContextDev::BrandRetrieveParams::Body::ByEmail::OrHash,
16
+ ContextDev::BrandRetrieveParams::Body::ByTicker::OrHash,
17
+ ContextDev::BrandRetrieveParams::Body::ByTransaction::OrHash
18
+ ),
16
19
  request_options: ContextDev::RequestOptions::OrHash
17
20
  ).returns(ContextDev::Models::BrandRetrieveResponse)
18
21
  end
19
22
  def retrieve(
20
- # Domain name to retrieve brand data for (e.g., 'example.com', 'google.com').
21
- # Cannot be used with name or ticker parameters.
22
- domain:,
23
- # Optional parameter to force the language of the retrieved brand data.
24
- force_language: nil,
25
- # Maximum age in milliseconds for cached brand data before the API performs a hard
26
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
27
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
28
- # year.
29
- max_age_ms: nil,
30
- # Optional parameter to optimize the API call for maximum speed. When set to true,
31
- # the API will skip time-consuming operations for faster response at the cost of
32
- # less comprehensive data. Works with all three lookup methods.
33
- max_speed: nil,
34
- # Optional timeout in milliseconds for the request. If the request takes longer
35
- # than this value, it will be aborted with a 408 status code. Maximum allowed
36
- # value is 300000ms (5 minutes).
37
- timeout_ms: nil,
38
- request_options: {}
39
- )
40
- end
41
-
42
- # Endpoint specially designed for platforms that want to identify transaction data
43
- # by the transaction title.
44
- sig do
45
- params(
46
- transaction_info: String,
47
- city: String,
48
- country_gl:
49
- ContextDev::BrandIdentifyFromTransactionParams::CountryGl::OrSymbol,
50
- force_language:
51
- ContextDev::BrandIdentifyFromTransactionParams::ForceLanguage::OrSymbol,
52
- high_confidence_only: T::Boolean,
53
- max_speed: T::Boolean,
54
- mcc: String,
55
- phone: Float,
56
- timeout_ms: Integer,
57
- request_options: ContextDev::RequestOptions::OrHash
58
- ).returns(ContextDev::Models::BrandIdentifyFromTransactionResponse)
59
- end
60
- def identify_from_transaction(
61
- # Transaction information to identify the brand
62
- transaction_info:,
63
- # Optional city name to prioritize when searching for the brand.
64
- city: nil,
65
- # Optional country code (GL parameter) to specify the country. This affects the
66
- # geographic location used for search queries.
67
- country_gl: nil,
68
- # Optional parameter to force the language of the retrieved brand data.
69
- force_language: nil,
70
- # When set to true, the API will perform an additional verification steps to
71
- # ensure the identified brand matches the transaction with high confidence.
72
- high_confidence_only: nil,
73
- # Optional parameter to optimize the API call for maximum speed. When set to true,
74
- # the API will skip time-consuming operations for faster response at the cost of
75
- # less comprehensive data.
76
- max_speed: nil,
77
- # Optional Merchant Category Code (MCC) to help identify the business
78
- # category/industry.
79
- mcc: nil,
80
- # Optional phone number from the transaction to help verify brand match.
81
- phone: nil,
82
- # Optional timeout in milliseconds for the request. If the request takes longer
83
- # than this value, it will be aborted with a 408 status code. Maximum allowed
84
- # value is 300000ms (5 minutes).
85
- timeout_ms: nil,
86
- request_options: {}
87
- )
88
- end
89
-
90
- # Retrieve brand information using an email address while detecting disposable and
91
- # free email addresses. Disposable and free email addresses (like gmail.com,
92
- # yahoo.com) will throw a 422 error.
93
- sig do
94
- params(
95
- email: String,
96
- force_language:
97
- ContextDev::BrandRetrieveByEmailParams::ForceLanguage::OrSymbol,
98
- max_age_ms: Integer,
99
- max_speed: T::Boolean,
100
- timeout_ms: Integer,
101
- request_options: ContextDev::RequestOptions::OrHash
102
- ).returns(ContextDev::Models::BrandRetrieveByEmailResponse)
103
- end
104
- def retrieve_by_email(
105
- # Email address to retrieve brand data for (e.g., 'contact@example.com'). The
106
- # domain will be extracted from the email. Free email providers (gmail.com,
107
- # yahoo.com, etc.) and disposable email addresses are not allowed.
108
- email:,
109
- # Optional parameter to force the language of the retrieved brand data.
110
- force_language: nil,
111
- # Maximum age in milliseconds for cached brand data before the API performs a hard
112
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
113
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
114
- # year.
115
- max_age_ms: nil,
116
- # Optional parameter to optimize the API call for maximum speed. When set to true,
117
- # the API will skip time-consuming operations for faster response at the cost of
118
- # less comprehensive data.
119
- max_speed: nil,
120
- # Optional timeout in milliseconds for the request. If the request takes longer
121
- # than this value, it will be aborted with a 408 status code. Maximum allowed
122
- # value is 300000ms (5 minutes).
123
- timeout_ms: nil,
124
- request_options: {}
125
- )
126
- end
127
-
128
- # Retrieve brand information using an ISIN (International Securities
129
- # Identification Number).
130
- sig do
131
- params(
132
- isin: String,
133
- force_language:
134
- ContextDev::BrandRetrieveByIsinParams::ForceLanguage::OrSymbol,
135
- max_age_ms: Integer,
136
- max_speed: T::Boolean,
137
- timeout_ms: Integer,
138
- request_options: ContextDev::RequestOptions::OrHash
139
- ).returns(ContextDev::Models::BrandRetrieveByIsinResponse)
140
- end
141
- def retrieve_by_isin(
142
- # ISIN (International Securities Identification Number) to retrieve brand data for
143
- # (e.g., 'AU000000IMD5', 'US0378331005'). Must be exactly 12 characters: 2 letters
144
- # followed by 9 alphanumeric characters and ending with a digit.
145
- isin:,
146
- # Optional parameter to force the language of the retrieved brand data.
147
- force_language: nil,
148
- # Maximum age in milliseconds for cached brand data before the API performs a hard
149
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
150
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
151
- # year.
152
- max_age_ms: nil,
153
- # Optional parameter to optimize the API call for maximum speed. When set to true,
154
- # the API will skip time-consuming operations for faster response at the cost of
155
- # less comprehensive data.
156
- max_speed: nil,
157
- # Optional timeout in milliseconds for the request. If the request takes longer
158
- # than this value, it will be aborted with a 408 status code. Maximum allowed
159
- # value is 300000ms (5 minutes).
160
- timeout_ms: nil,
161
- request_options: {}
162
- )
163
- end
164
-
165
- # Retrieve brand information using a company name.
166
- sig do
167
- params(
168
- name: String,
169
- country_gl:
170
- ContextDev::BrandRetrieveByNameParams::CountryGl::OrSymbol,
171
- force_language:
172
- ContextDev::BrandRetrieveByNameParams::ForceLanguage::OrSymbol,
173
- max_age_ms: Integer,
174
- max_speed: T::Boolean,
175
- timeout_ms: Integer,
176
- request_options: ContextDev::RequestOptions::OrHash
177
- ).returns(ContextDev::Models::BrandRetrieveByNameResponse)
178
- end
179
- def retrieve_by_name(
180
- # Company name to retrieve brand data for (e.g., 'Apple Inc', 'Microsoft
181
- # Corporation'). Must be 3-30 characters.
182
- name:,
183
- # Optional country code hint (GL parameter) to specify the country for the company
184
- # name.
185
- country_gl: nil,
186
- # Optional parameter to force the language of the retrieved brand data.
187
- force_language: nil,
188
- # Maximum age in milliseconds for cached brand data before the API performs a hard
189
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
190
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
191
- # year.
192
- max_age_ms: nil,
193
- # Optional parameter to optimize the API call for maximum speed. When set to true,
194
- # the API will skip time-consuming operations for faster response at the cost of
195
- # less comprehensive data.
196
- max_speed: nil,
197
- # Optional timeout in milliseconds for the request. If the request takes longer
198
- # than this value, it will be aborted with a 408 status code. Maximum allowed
199
- # value is 300000ms (5 minutes).
200
- timeout_ms: nil,
201
- request_options: {}
202
- )
203
- end
204
-
205
- # Retrieve brand information using a stock ticker symbol.
206
- sig do
207
- params(
208
- ticker: String,
209
- force_language:
210
- ContextDev::BrandRetrieveByTickerParams::ForceLanguage::OrSymbol,
211
- max_age_ms: Integer,
212
- max_speed: T::Boolean,
213
- ticker_exchange:
214
- ContextDev::BrandRetrieveByTickerParams::TickerExchange::OrSymbol,
215
- timeout_ms: Integer,
216
- request_options: ContextDev::RequestOptions::OrHash
217
- ).returns(ContextDev::Models::BrandRetrieveByTickerResponse)
218
- end
219
- def retrieve_by_ticker(
220
- # Stock ticker symbol to retrieve brand data for (e.g., 'AAPL', 'GOOGL', 'BRK.A').
221
- # Must be 1-15 characters, letters/numbers/dots only.
222
- ticker:,
223
- # Optional parameter to force the language of the retrieved brand data.
224
- force_language: nil,
225
- # Maximum age in milliseconds for cached brand data before the API performs a hard
226
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
227
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
228
- # year.
229
- max_age_ms: nil,
230
- # Optional parameter to optimize the API call for maximum speed. When set to true,
231
- # the API will skip time-consuming operations for faster response at the cost of
232
- # less comprehensive data.
233
- max_speed: nil,
234
- # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
235
- ticker_exchange: nil,
236
- # Optional timeout in milliseconds for the request. If the request takes longer
237
- # than this value, it will be aborted with a 408 status code. Maximum allowed
238
- # value is 300000ms (5 minutes).
239
- timeout_ms: nil,
23
+ # Exactly one lookup type must be provided.
24
+ body:,
240
25
  request_options: {}
241
26
  )
242
27
  end