context.dev 2.15.0 → 2.17.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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +30 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +6 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_params.rb +53 -8
  7. data/lib/context_dev/models/ai_extract_product_response.rb +19 -1
  8. data/lib/context_dev/models/ai_extract_products_params.rb +116 -16
  9. data/lib/context_dev/models/ai_extract_products_response.rb +20 -1
  10. data/lib/context_dev/models/batch_cancel_response.rb +10 -1
  11. data/lib/context_dev/models/batch_delete_response.rb +13 -1
  12. data/lib/context_dev/models/batch_get_results_response.rb +13 -1
  13. data/lib/context_dev/models/batch_list_response.rb +13 -1
  14. data/lib/context_dev/models/batch_retrieve_response.rb +10 -1
  15. data/lib/context_dev/models/batch_submit_response.rb +10 -1
  16. data/lib/context_dev/models/brand_retrieve_params.rb +355 -60
  17. data/lib/context_dev/models/brand_retrieve_response.rb +19 -1
  18. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +57 -11
  19. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +19 -1
  20. data/lib/context_dev/models/brand_search_response.rb +10 -1
  21. data/lib/context_dev/models/industry_retrieve_naics_params.rb +53 -8
  22. data/lib/context_dev/models/industry_retrieve_naics_response.rb +22 -1
  23. data/lib/context_dev/models/industry_retrieve_sic_params.rb +53 -8
  24. data/lib/context_dev/models/industry_retrieve_sic_response.rb +19 -1
  25. data/lib/context_dev/models/log_list_params.rb +108 -0
  26. data/lib/context_dev/models/log_list_response.rb +174 -0
  27. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  28. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  29. data/lib/context_dev/models/monitor_create_params.rb +27 -3
  30. data/lib/context_dev/models/monitor_create_response.rb +30 -5
  31. data/lib/context_dev/models/monitor_list_response.rb +30 -5
  32. data/lib/context_dev/models/monitor_retrieve_response.rb +30 -5
  33. data/lib/context_dev/models/monitor_update_params.rb +27 -3
  34. data/lib/context_dev/models/monitor_update_response.rb +30 -5
  35. data/lib/context_dev/models/news_search_response.rb +10 -1
  36. data/lib/context_dev/models/parse_handle_response.rb +13 -1
  37. data/lib/context_dev/models/person_enrich_params.rb +53 -8
  38. data/lib/context_dev/models/person_enrich_response.rb +22 -1
  39. data/lib/context_dev/models/utility_prefetch_params.rb +48 -8
  40. data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
  41. data/lib/context_dev/models/web_answers_params.rb +124 -0
  42. data/lib/context_dev/models/web_answers_response.rb +68 -0
  43. data/lib/context_dev/models/web_extract_competitors_params.rb +53 -8
  44. data/lib/context_dev/models/web_extract_competitors_response.rb +22 -1
  45. data/lib/context_dev/models/web_extract_fonts_params.rb +58 -11
  46. data/lib/context_dev/models/web_extract_fonts_response.rb +41 -1
  47. data/lib/context_dev/models/web_extract_params.rb +53 -8
  48. data/lib/context_dev/models/web_extract_response.rb +19 -1
  49. data/lib/context_dev/models/web_extract_styleguide_params.rb +58 -11
  50. data/lib/context_dev/models/web_extract_styleguide_response.rb +41 -1
  51. data/lib/context_dev/models/web_screenshot_params.rb +58 -9
  52. data/lib/context_dev/models/web_screenshot_response.rb +41 -1
  53. data/lib/context_dev/models/web_search_params.rb +112 -16
  54. data/lib/context_dev/models/web_search_response.rb +52 -2
  55. data/lib/context_dev/models/web_web_crawl_md_params.rb +53 -8
  56. data/lib/context_dev/models/web_web_crawl_md_response.rb +20 -1
  57. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +344 -0
  58. data/lib/context_dev/models/web_web_scrape_bytes_response.rb +135 -0
  59. data/lib/context_dev/models/web_web_scrape_html_params.rb +58 -9
  60. data/lib/context_dev/models/web_web_scrape_html_response.rb +41 -1
  61. data/lib/context_dev/models/web_web_scrape_images_params.rb +58 -9
  62. data/lib/context_dev/models/web_web_scrape_images_response.rb +51 -1
  63. data/lib/context_dev/models/web_web_scrape_md_params.rb +58 -9
  64. data/lib/context_dev/models/web_web_scrape_md_response.rb +41 -1
  65. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +53 -8
  66. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +20 -1
  67. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +13 -1
  68. data/lib/context_dev/models/webhooks/delivery_list_response.rb +13 -1
  69. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +13 -1
  70. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +13 -1
  71. data/lib/context_dev/models.rb +8 -0
  72. data/lib/context_dev/resources/ai.rb +2 -2
  73. data/lib/context_dev/resources/brand.rb +3 -3
  74. data/lib/context_dev/resources/industry.rb +6 -6
  75. data/lib/context_dev/resources/logs.rb +83 -0
  76. data/lib/context_dev/resources/people.rb +2 -2
  77. data/lib/context_dev/resources/utility.rb +2 -2
  78. data/lib/context_dev/resources/web.rb +119 -33
  79. data/lib/context_dev/version.rb +1 -1
  80. data/lib/context_dev.rb +9 -0
  81. data/rbi/context_dev/client.rbi +5 -0
  82. data/rbi/context_dev/models/ai_extract_product_params.rbi +125 -13
  83. data/rbi/context_dev/models/ai_extract_product_response.rbi +23 -0
  84. data/rbi/context_dev/models/ai_extract_products_params.rbi +264 -26
  85. data/rbi/context_dev/models/ai_extract_products_response.rbi +25 -0
  86. data/rbi/context_dev/models/batch_cancel_response.rbi +10 -0
  87. data/rbi/context_dev/models/batch_delete_response.rbi +10 -0
  88. data/rbi/context_dev/models/batch_get_results_response.rbi +10 -0
  89. data/rbi/context_dev/models/batch_list_response.rbi +10 -0
  90. data/rbi/context_dev/models/batch_retrieve_response.rbi +10 -0
  91. data/rbi/context_dev/models/batch_submit_response.rbi +10 -0
  92. data/rbi/context_dev/models/brand_retrieve_params.rbi +816 -102
  93. data/rbi/context_dev/models/brand_retrieve_response.rbi +23 -0
  94. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +136 -19
  95. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +23 -0
  96. data/rbi/context_dev/models/brand_search_response.rbi +10 -0
  97. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +127 -13
  98. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +23 -0
  99. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +127 -13
  100. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +23 -0
  101. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  102. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  103. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  104. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  105. data/rbi/context_dev/models/monitor_create_params.rbi +40 -2
  106. data/rbi/context_dev/models/monitor_create_response.rbi +44 -4
  107. data/rbi/context_dev/models/monitor_list_response.rbi +44 -4
  108. data/rbi/context_dev/models/monitor_retrieve_response.rbi +44 -4
  109. data/rbi/context_dev/models/monitor_update_params.rbi +40 -2
  110. data/rbi/context_dev/models/monitor_update_response.rbi +44 -4
  111. data/rbi/context_dev/models/news_search_response.rbi +10 -0
  112. data/rbi/context_dev/models/parse_handle_response.rbi +10 -0
  113. data/rbi/context_dev/models/person_enrich_params.rbi +123 -13
  114. data/rbi/context_dev/models/person_enrich_response.rbi +26 -3
  115. data/rbi/context_dev/models/utility_prefetch_params.rbi +112 -13
  116. data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
  117. data/rbi/context_dev/models/web_answers_params.rbi +234 -0
  118. data/rbi/context_dev/models/web_answers_response.rbi +122 -0
  119. data/rbi/context_dev/models/web_extract_competitors_params.rbi +127 -13
  120. data/rbi/context_dev/models/web_extract_competitors_response.rbi +26 -3
  121. data/rbi/context_dev/models/web_extract_fonts_params.rbi +132 -19
  122. data/rbi/context_dev/models/web_extract_fonts_response.rbi +81 -0
  123. data/rbi/context_dev/models/web_extract_params.rbi +120 -13
  124. data/rbi/context_dev/models/web_extract_response.rbi +26 -3
  125. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +136 -19
  126. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +81 -0
  127. data/rbi/context_dev/models/web_screenshot_params.rbi +132 -15
  128. data/rbi/context_dev/models/web_screenshot_response.rbi +81 -0
  129. data/rbi/context_dev/models/web_search_params.rbi +253 -26
  130. data/rbi/context_dev/models/web_search_response.rbi +102 -6
  131. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +123 -13
  132. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +29 -3
  133. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +699 -0
  134. data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +238 -0
  135. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +134 -15
  136. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +71 -0
  137. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +136 -15
  138. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +99 -3
  139. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +132 -15
  140. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +71 -0
  141. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +127 -13
  142. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +28 -3
  143. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +10 -0
  144. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +10 -0
  145. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +10 -0
  146. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +10 -0
  147. data/rbi/context_dev/models.rbi +8 -0
  148. data/rbi/context_dev/resources/ai.rbi +5 -5
  149. data/rbi/context_dev/resources/brand.rbi +9 -8
  150. data/rbi/context_dev/resources/industry.rbi +12 -10
  151. data/rbi/context_dev/resources/logs.rbi +76 -0
  152. data/rbi/context_dev/resources/people.rbi +5 -5
  153. data/rbi/context_dev/resources/utility.rbi +5 -5
  154. data/rbi/context_dev/resources/web.rbi +173 -68
  155. data/sig/context_dev/client.rbs +2 -0
  156. data/sig/context_dev/models/ai_extract_product_params.rbs +44 -5
  157. data/sig/context_dev/models/ai_extract_product_response.rbs +12 -0
  158. data/sig/context_dev/models/ai_extract_products_params.rbs +88 -10
  159. data/sig/context_dev/models/ai_extract_products_response.rbs +12 -0
  160. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  161. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  162. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  163. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  164. data/sig/context_dev/models/batch_retrieve_response.rbs +5 -0
  165. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  166. data/sig/context_dev/models/brand_retrieve_params.rbs +264 -30
  167. data/sig/context_dev/models/brand_retrieve_response.rbs +12 -0
  168. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +44 -5
  169. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +12 -0
  170. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  171. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +44 -5
  172. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +12 -0
  173. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +44 -5
  174. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +12 -0
  175. data/sig/context_dev/models/log_list_params.rbs +98 -0
  176. data/sig/context_dev/models/log_list_response.rbs +135 -0
  177. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  178. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  179. data/sig/context_dev/models/monitor_create_params.rbs +14 -0
  180. data/sig/context_dev/models/monitor_create_response.rbs +14 -0
  181. data/sig/context_dev/models/monitor_list_response.rbs +14 -0
  182. data/sig/context_dev/models/monitor_retrieve_response.rbs +14 -0
  183. data/sig/context_dev/models/monitor_update_params.rbs +14 -0
  184. data/sig/context_dev/models/monitor_update_response.rbs +14 -0
  185. data/sig/context_dev/models/news_search_response.rbs +5 -0
  186. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  187. data/sig/context_dev/models/person_enrich_params.rbs +44 -5
  188. data/sig/context_dev/models/person_enrich_response.rbs +15 -3
  189. data/sig/context_dev/models/utility_prefetch_params.rbs +43 -5
  190. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  191. data/sig/context_dev/models/web_answers_params.rbs +106 -0
  192. data/sig/context_dev/models/web_answers_response.rbs +60 -0
  193. data/sig/context_dev/models/web_extract_competitors_params.rbs +44 -5
  194. data/sig/context_dev/models/web_extract_competitors_response.rbs +15 -3
  195. data/sig/context_dev/models/web_extract_fonts_params.rbs +44 -5
  196. data/sig/context_dev/models/web_extract_fonts_response.rbs +25 -0
  197. data/sig/context_dev/models/web_extract_params.rbs +44 -5
  198. data/sig/context_dev/models/web_extract_response.rbs +15 -3
  199. data/sig/context_dev/models/web_extract_styleguide_params.rbs +44 -5
  200. data/sig/context_dev/models/web_extract_styleguide_response.rbs +25 -0
  201. data/sig/context_dev/models/web_screenshot_params.rbs +44 -5
  202. data/sig/context_dev/models/web_screenshot_response.rbs +25 -0
  203. data/sig/context_dev/models/web_search_params.rbs +88 -10
  204. data/sig/context_dev/models/web_search_response.rbs +38 -6
  205. data/sig/context_dev/models/web_web_crawl_md_params.rbs +44 -5
  206. data/sig/context_dev/models/web_web_crawl_md_response.rbs +15 -3
  207. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +531 -0
  208. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +108 -0
  209. data/sig/context_dev/models/web_web_scrape_html_params.rbs +44 -5
  210. data/sig/context_dev/models/web_web_scrape_html_response.rbs +21 -0
  211. data/sig/context_dev/models/web_web_scrape_images_params.rbs +44 -5
  212. data/sig/context_dev/models/web_web_scrape_images_response.rbs +35 -3
  213. data/sig/context_dev/models/web_web_scrape_md_params.rbs +44 -5
  214. data/sig/context_dev/models/web_web_scrape_md_response.rbs +21 -0
  215. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +44 -5
  216. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +15 -3
  217. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +5 -0
  218. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +5 -0
  219. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +7 -0
  220. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +5 -0
  221. data/sig/context_dev/models.rbs +8 -0
  222. data/sig/context_dev/resources/ai.rbs +1 -1
  223. data/sig/context_dev/resources/brand.rbs +1 -1
  224. data/sig/context_dev/resources/industry.rbs +2 -2
  225. data/sig/context_dev/resources/logs.rbs +27 -0
  226. data/sig/context_dev/resources/people.rbs +1 -1
  227. data/sig/context_dev/resources/utility.rbs +1 -1
  228. data/sig/context_dev/resources/web.rbs +30 -11
  229. metadata +29 -2
@@ -68,14 +68,21 @@ module ContextDev
68
68
  sig { params(tags: T::Array[String]).void }
69
69
  attr_writer :tags
70
70
 
71
- # Optional timeout in milliseconds for the request. If the request takes longer
72
- # than this value, it will be aborted with a 408 status code. Maximum allowed
73
- # value is 300000ms (5 minutes).
74
- sig { returns(T.nilable(Integer)) }
75
- attr_reader :timeout_ms
71
+ # Optional request deadline and behavior on timeout. For GET requests, use
72
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
73
+ # timeoutOpts object.
74
+ sig do
75
+ returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::TimeoutOpts))
76
+ end
77
+ attr_reader :timeout_opts
76
78
 
77
- sig { params(timeout_ms: Integer).void }
78
- attr_writer :timeout_ms
79
+ sig do
80
+ params(
81
+ timeout_opts:
82
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash
83
+ ).void
84
+ end
85
+ attr_writer :timeout_opts
79
86
 
80
87
  # Optional RE2-compatible regex pattern. Only URLs matching this pattern are
81
88
  # returned and counted against maxLinks.
@@ -108,7 +115,8 @@ module ContextDev
108
115
  search: String,
109
116
  sitemap_url: String,
110
117
  tags: T::Array[String],
111
- timeout_ms: Integer,
118
+ timeout_opts:
119
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash,
112
120
  url_regex: String,
113
121
  zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
114
122
  request_options: ContextDev::RequestOptions::OrHash
@@ -137,10 +145,10 @@ module ContextDev
137
145
  # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
138
146
  # characters.
139
147
  tags: nil,
140
- # Optional timeout in milliseconds for the request. If the request takes longer
141
- # than this value, it will be aborted with a 408 status code. Maximum allowed
142
- # value is 300000ms (5 minutes).
143
- timeout_ms: nil,
148
+ # Optional request deadline and behavior on timeout. For GET requests, use
149
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
150
+ # timeoutOpts object.
151
+ timeout_opts: nil,
144
152
  # Optional RE2-compatible regex pattern. Only URLs matching this pattern are
145
153
  # returned and counted against maxLinks.
146
154
  url_regex: nil,
@@ -163,7 +171,7 @@ module ContextDev
163
171
  search: String,
164
172
  sitemap_url: String,
165
173
  tags: T::Array[String],
166
- timeout_ms: Integer,
174
+ timeout_opts: ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
167
175
  url_regex: String,
168
176
  zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
169
177
  request_options: ContextDev::RequestOptions
@@ -173,6 +181,112 @@ module ContextDev
173
181
  def to_hash
174
182
  end
175
183
 
184
+ class TimeoutOpts < ContextDev::Internal::Type::BaseModel
185
+ OrHash =
186
+ T.type_alias do
187
+ T.any(
188
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
189
+ ContextDev::Internal::AnyHash
190
+ )
191
+ end
192
+
193
+ # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
194
+ sig { returns(Integer) }
195
+ attr_accessor :milliseconds
196
+
197
+ # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
198
+ # credits. "return-partial" returns usable results collected so far; if none are
199
+ # available, the request still fails without charging credits. Partial results are
200
+ # not cached as complete results.
201
+ sig do
202
+ returns(
203
+ T.nilable(
204
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
205
+ )
206
+ )
207
+ end
208
+ attr_reader :behavior
209
+
210
+ sig do
211
+ params(
212
+ behavior:
213
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
214
+ ).void
215
+ end
216
+ attr_writer :behavior
217
+
218
+ # Optional request deadline and behavior on timeout. For GET requests, use
219
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
220
+ # timeoutOpts object.
221
+ sig do
222
+ params(
223
+ milliseconds: Integer,
224
+ behavior:
225
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
226
+ ).returns(T.attached_class)
227
+ end
228
+ def self.new(
229
+ # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
230
+ milliseconds:,
231
+ # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
232
+ # credits. "return-partial" returns usable results collected so far; if none are
233
+ # available, the request still fails without charging credits. Partial results are
234
+ # not cached as complete results.
235
+ behavior: nil
236
+ )
237
+ end
238
+
239
+ sig do
240
+ override.returns(
241
+ {
242
+ milliseconds: Integer,
243
+ behavior:
244
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
245
+ }
246
+ )
247
+ end
248
+ def to_hash
249
+ end
250
+
251
+ # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
252
+ # credits. "return-partial" returns usable results collected so far; if none are
253
+ # available, the request still fails without charging credits. Partial results are
254
+ # not cached as complete results.
255
+ module Behavior
256
+ extend ContextDev::Internal::Type::Enum
257
+
258
+ TaggedSymbol =
259
+ T.type_alias do
260
+ T.all(
261
+ Symbol,
262
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior
263
+ )
264
+ end
265
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
266
+
267
+ FAIL =
268
+ T.let(
269
+ :fail,
270
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
271
+ )
272
+ RETURN_PARTIAL =
273
+ T.let(
274
+ :"return-partial",
275
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
276
+ )
277
+
278
+ sig do
279
+ override.returns(
280
+ T::Array[
281
+ ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
282
+ ]
283
+ )
284
+ end
285
+ def self.values
286
+ end
287
+ end
288
+ end
289
+
176
290
  # Set to enabled to bypass shared caches and omit request and response content
177
291
  # from retained usage logs. Requires zero data retention to be enabled for your
178
292
  # organization (contact support@context.dev), otherwise the request fails with
@@ -26,6 +26,11 @@ module ContextDev
26
26
  end
27
27
  attr_writer :meta
28
28
 
29
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
30
+ # it when contacting support about a failed request.
31
+ sig { returns(String) }
32
+ attr_accessor :request_id
33
+
29
34
  # Indicates success
30
35
  sig do
31
36
  returns(
@@ -57,15 +62,26 @@ module ContextDev
57
62
  end
58
63
  attr_writer :key_metadata
59
64
 
65
+ # True when timeoutOpts.behavior=return-partial returned the usable results
66
+ # collected before the deadline. Partial collections are not cached as complete
67
+ # results.
68
+ sig { returns(T.nilable(T::Boolean)) }
69
+ attr_reader :partial
70
+
71
+ sig { params(partial: T::Boolean).void }
72
+ attr_writer :partial
73
+
60
74
  sig do
61
75
  params(
62
76
  domain: String,
63
77
  meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash,
78
+ request_id: String,
64
79
  success:
65
80
  ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean,
66
81
  urls: T::Array[String],
67
82
  key_metadata:
68
- ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash
83
+ ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash,
84
+ partial: T::Boolean
69
85
  ).returns(T.attached_class)
70
86
  end
71
87
  def self.new(
@@ -73,13 +89,20 @@ module ContextDev
73
89
  domain:,
74
90
  # Metadata about the sitemap crawl operation
75
91
  meta:,
92
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
93
+ # it when contacting support about a failed request.
94
+ request_id:,
76
95
  # Indicates success
77
96
  success:,
78
97
  # Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
79
98
  # these are only the matching pages, most relevant first.
80
99
  urls:,
81
100
  # Credit usage, included whenever a valid API key is provided.
82
- key_metadata: nil
101
+ key_metadata: nil,
102
+ # True when timeoutOpts.behavior=return-partial returned the usable results
103
+ # collected before the deadline. Partial collections are not cached as complete
104
+ # results.
105
+ partial: nil
83
106
  )
84
107
  end
85
108
 
@@ -88,11 +111,13 @@ module ContextDev
88
111
  {
89
112
  domain: String,
90
113
  meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
114
+ request_id: String,
91
115
  success:
92
116
  ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean,
93
117
  urls: T::Array[String],
94
118
  key_metadata:
95
- ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata
119
+ ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata,
120
+ partial: T::Boolean
96
121
  }
97
122
  )
98
123
  end
@@ -24,6 +24,11 @@ module ContextDev
24
24
  sig { returns(T.nilable(String)) }
25
25
  attr_accessor :next_cursor
26
26
 
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ sig { returns(String) }
30
+ attr_accessor :request_id
31
+
27
32
  # Credit usage, included whenever a valid API key is provided.
28
33
  sig do
29
34
  returns(
@@ -47,6 +52,7 @@ module ContextDev
47
52
  data: T::Array[ContextDev::Webhooks::Attempt::OrHash],
48
53
  has_more: T::Boolean,
49
54
  next_cursor: T.nilable(String),
55
+ request_id: String,
50
56
  key_metadata:
51
57
  ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata::OrHash
52
58
  ).returns(T.attached_class)
@@ -58,6 +64,9 @@ module ContextDev
58
64
  has_more:,
59
65
  # Next page cursor, or null on the last page.
60
66
  next_cursor:,
67
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
68
+ # it when contacting support about a failed request.
69
+ request_id:,
61
70
  # Credit usage, included whenever a valid API key is provided.
62
71
  key_metadata: nil
63
72
  )
@@ -69,6 +78,7 @@ module ContextDev
69
78
  data: T::Array[ContextDev::Webhooks::Attempt],
70
79
  has_more: T::Boolean,
71
80
  next_cursor: T.nilable(String),
81
+ request_id: String,
72
82
  key_metadata:
73
83
  ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata
74
84
  }
@@ -24,6 +24,11 @@ module ContextDev
24
24
  sig { returns(T.nilable(String)) }
25
25
  attr_accessor :next_cursor
26
26
 
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ sig { returns(String) }
30
+ attr_accessor :request_id
31
+
27
32
  # Credit usage, included whenever a valid API key is provided.
28
33
  sig do
29
34
  returns(
@@ -47,6 +52,7 @@ module ContextDev
47
52
  data: T::Array[ContextDev::Webhooks::DeliverySummary::OrHash],
48
53
  has_more: T::Boolean,
49
54
  next_cursor: T.nilable(String),
55
+ request_id: String,
50
56
  key_metadata:
51
57
  ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata::OrHash
52
58
  ).returns(T.attached_class)
@@ -58,6 +64,9 @@ module ContextDev
58
64
  has_more:,
59
65
  # Next page cursor, or null on the last page.
60
66
  next_cursor:,
67
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
68
+ # it when contacting support about a failed request.
69
+ request_id:,
61
70
  # Credit usage, included whenever a valid API key is provided.
62
71
  key_metadata: nil
63
72
  )
@@ -69,6 +78,7 @@ module ContextDev
69
78
  data: T::Array[ContextDev::Webhooks::DeliverySummary],
70
79
  has_more: T::Boolean,
71
80
  next_cursor: T.nilable(String),
81
+ request_id: String,
72
82
  key_metadata:
73
83
  ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata
74
84
  }
@@ -12,6 +12,11 @@ module ContextDev
12
12
  )
13
13
  end
14
14
 
15
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
16
+ # it when contacting support about a failed request.
17
+ sig { returns(String) }
18
+ attr_accessor :request_id
19
+
15
20
  # Credit usage, included whenever a valid API key is provided.
16
21
  sig do
17
22
  returns(
@@ -32,11 +37,15 @@ module ContextDev
32
37
 
33
38
  sig do
34
39
  params(
40
+ request_id: String,
35
41
  key_metadata:
36
42
  ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata::OrHash
37
43
  ).returns(T.attached_class)
38
44
  end
39
45
  def self.new(
46
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
47
+ # it when contacting support about a failed request.
48
+ request_id:,
40
49
  # Credit usage, included whenever a valid API key is provided.
41
50
  key_metadata: nil
42
51
  )
@@ -45,6 +54,7 @@ module ContextDev
45
54
  sig do
46
55
  override.returns(
47
56
  {
57
+ request_id: String,
48
58
  key_metadata:
49
59
  ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata
50
60
  }
@@ -16,6 +16,11 @@ module ContextDev
16
16
  sig { returns(String) }
17
17
  attr_accessor :id
18
18
 
19
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
20
+ # it when contacting support about a failed request.
21
+ sig { returns(String) }
22
+ attr_accessor :request_id
23
+
19
24
  # Credit usage, included whenever a valid API key is provided.
20
25
  sig do
21
26
  returns(
@@ -37,6 +42,7 @@ module ContextDev
37
42
  sig do
38
43
  params(
39
44
  id: String,
45
+ request_id: String,
40
46
  key_metadata:
41
47
  ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata::OrHash
42
48
  ).returns(T.attached_class)
@@ -44,6 +50,9 @@ module ContextDev
44
50
  def self.new(
45
51
  # Delivery ID.
46
52
  id:,
53
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
54
+ # it when contacting support about a failed request.
55
+ request_id:,
47
56
  # Credit usage, included whenever a valid API key is provided.
48
57
  key_metadata: nil
49
58
  )
@@ -53,6 +62,7 @@ module ContextDev
53
62
  override.returns(
54
63
  {
55
64
  id: String,
65
+ request_id: String,
56
66
  key_metadata:
57
67
  ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata
58
68
  }
@@ -34,6 +34,10 @@ module ContextDev
34
34
 
35
35
  Intake = ContextDev::Models::Intake
36
36
 
37
+ LogListParams = ContextDev::Models::LogListParams
38
+
39
+ LogRetrieveParams = ContextDev::Models::LogRetrieveParams
40
+
37
41
  MonitorCreateParams = ContextDev::Models::MonitorCreateParams
38
42
 
39
43
  MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
@@ -74,6 +78,8 @@ module ContextDev
74
78
 
75
79
  UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
76
80
 
81
+ WebAnswersParams = ContextDev::Models::WebAnswersParams
82
+
77
83
  WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
78
84
 
79
85
  WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
@@ -92,6 +98,8 @@ module ContextDev
92
98
 
93
99
  WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
94
100
 
101
+ WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
102
+
95
103
  WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
96
104
 
97
105
  WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams
@@ -10,7 +10,7 @@ module ContextDev
10
10
  url: String,
11
11
  max_age_ms: Integer,
12
12
  tags: T::Array[String],
13
- timeout_ms: Integer,
13
+ timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash,
14
14
  request_options: ContextDev::RequestOptions::OrHash
15
15
  ).returns(ContextDev::Models::AIExtractProductResponse)
16
16
  end
@@ -23,10 +23,10 @@ module ContextDev
23
23
  max_age_ms: nil,
24
24
  # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
25
25
  tags: 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,
26
+ # Optional request deadline and behavior on timeout. For GET requests, use
27
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
28
+ # timeoutOpts object.
29
+ timeout_opts: nil,
30
30
  request_options: {}
31
31
  )
32
32
  end
@@ -38,7 +38,8 @@ module ContextDev
38
38
  max_age_ms: T.nilable(Integer),
39
39
  tags: T::Array[String],
40
40
  theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
41
- timeout_ms: Integer,
41
+ timeout_opts:
42
+ ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::OrHash,
42
43
  request_options: ContextDev::RequestOptions::OrHash
43
44
  ).returns(ContextDev::Models::BrandRetrieveSimplifiedResponse)
44
45
  end
@@ -46,19 +47,19 @@ module ContextDev
46
47
  # Domain name to retrieve simplified brand data for
47
48
  domain:,
48
49
  # Maximum age in milliseconds for cached brand data before the API performs a hard
49
- # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
50
- # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
51
- # year.
50
+ # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
51
+ # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
52
+ # are clamped to 1 year.
52
53
  max_age_ms: nil,
53
54
  # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
54
55
  # characters.
55
56
  tags: nil,
56
57
  # Optional theme preference used when selecting brand assets.
57
58
  theme: nil,
58
- # Optional timeout in milliseconds for the request. If the request takes longer
59
- # than this value, it will be aborted with a 408 status code. Maximum allowed
60
- # value is 300000ms (5 minutes).
61
- timeout_ms: nil,
59
+ # Optional request deadline and behavior on timeout. For GET requests, use
60
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
61
+ # timeoutOpts object.
62
+ timeout_opts: nil,
62
63
  request_options: {}
63
64
  )
64
65
  end
@@ -10,7 +10,8 @@ module ContextDev
10
10
  max_results: Integer,
11
11
  min_results: Integer,
12
12
  tags: T::Array[String],
13
- timeout_ms: Integer,
13
+ timeout_opts:
14
+ ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::OrHash,
14
15
  request_options: ContextDev::RequestOptions::OrHash
15
16
  ).returns(ContextDev::Models::IndustryRetrieveNaicsResponse)
16
17
  end
@@ -27,10 +28,10 @@ module ContextDev
27
28
  # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
28
29
  # characters.
29
30
  tags: nil,
30
- # Optional timeout in milliseconds for the request. If the request takes longer
31
- # than this value, it will be aborted with a 408 status code. Maximum allowed
32
- # value is 300000ms (5 minutes).
33
- timeout_ms: nil,
31
+ # Optional request deadline and behavior on timeout. For GET requests, use
32
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
33
+ # timeoutOpts object.
34
+ timeout_opts: nil,
34
35
  request_options: {}
35
36
  )
36
37
  end
@@ -44,7 +45,8 @@ module ContextDev
44
45
  max_results: Integer,
45
46
  min_results: Integer,
46
47
  tags: T::Array[String],
47
- timeout_ms: Integer,
48
+ timeout_opts:
49
+ ContextDev::IndustryRetrieveSicParams::TimeoutOpts::OrHash,
48
50
  type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
49
51
  request_options: ContextDev::RequestOptions::OrHash
50
52
  ).returns(ContextDev::Models::IndustryRetrieveSicResponse)
@@ -61,10 +63,10 @@ module ContextDev
61
63
  # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
62
64
  # characters.
63
65
  tags: nil,
64
- # Optional timeout in milliseconds for the request. If the request takes longer
65
- # than this value, it will be aborted with a 408 status code. Maximum allowed
66
- # value is 300000ms (5 minutes).
67
- timeout_ms: nil,
66
+ # Optional request deadline and behavior on timeout. For GET requests, use
67
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
68
+ # timeoutOpts object.
69
+ timeout_opts: nil,
68
70
  # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
69
71
  # Industrial Classification system; `latest_sec` uses the current SIC list as
70
72
  # published by the SEC. Defaults to `original_sic`.
@@ -0,0 +1,76 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Resources
5
+ # Read your organization's API request logs to debug failed calls. These endpoints
6
+ # cost no credits and use a separate rate limit.
7
+ class Logs
8
+ # Get one logged API call, including its request input and response body.
9
+ sig do
10
+ params(
11
+ request_id: String,
12
+ request_options: ContextDev::RequestOptions::OrHash
13
+ ).returns(ContextDev::Models::LogRetrieveResponse)
14
+ end
15
+ def retrieve(
16
+ # The request ID of the logged API call.
17
+ request_id,
18
+ request_options: {}
19
+ )
20
+ end
21
+
22
+ # List your organization's API requests, newest first. Defaults to the last 24
23
+ # hours.
24
+ sig do
25
+ params(
26
+ error_code: String,
27
+ errors_only: T::Boolean,
28
+ from: Time,
29
+ key_id: String,
30
+ limit: Integer,
31
+ page: Integer,
32
+ path: String,
33
+ search: String,
34
+ status_code: Integer,
35
+ tags: String,
36
+ to: Time,
37
+ request_options: ContextDev::RequestOptions::OrHash
38
+ ).returns(ContextDev::Models::LogListResponse)
39
+ end
40
+ def list(
41
+ # Filter by the `error_code` returned in the response.
42
+ error_code: nil,
43
+ # Only include requests that returned a 4xx or 5xx status.
44
+ errors_only: nil,
45
+ # Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
46
+ # before `to`.
47
+ from: nil,
48
+ # Filter by the API key that made the request.
49
+ key_id: nil,
50
+ # Number of log entries per page.
51
+ limit: nil,
52
+ # Page number, starting at 1.
53
+ page: nil,
54
+ # Filter by endpoint path, with or without the /v1 prefix.
55
+ path: nil,
56
+ # Case-insensitive substring match against the request query and body, e.g. a
57
+ # domain.
58
+ search: nil,
59
+ # Filter by exact HTTP status code.
60
+ status_code: nil,
61
+ # Comma-separated request tags. Matches requests carrying any of them. Up to 20
62
+ # tags, each 1-50 characters.
63
+ tags: nil,
64
+ # Only include requests at or before this ISO 8601 timestamp. Defaults to now.
65
+ to: nil,
66
+ request_options: {}
67
+ )
68
+ end
69
+
70
+ # @api private
71
+ sig { params(client: ContextDev::Client).returns(T.attached_class) }
72
+ def self.new(client:)
73
+ end
74
+ end
75
+ end
76
+ end
@@ -17,7 +17,7 @@ module ContextDev
17
17
  name: ContextDev::PersonEnrichParams::Name::OrHash,
18
18
  social_urls: T::Array[String],
19
19
  tags: T::Array[String],
20
- timeout_ms: Integer,
20
+ timeout_opts: ContextDev::PersonEnrichParams::TimeoutOpts::OrHash,
21
21
  request_options: ContextDev::RequestOptions::OrHash
22
22
  ).returns(ContextDev::Models::PersonEnrichResponse)
23
23
  end
@@ -30,10 +30,10 @@ module ContextDev
30
30
  social_urls: nil,
31
31
  # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
32
32
  tags: nil,
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
- timeout_ms: nil,
33
+ # Optional request deadline and behavior on timeout. For GET requests, use
34
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
35
+ # timeoutOpts object.
36
+ timeout_opts: nil,
37
37
  request_options: {}
38
38
  )
39
39
  end
@@ -17,7 +17,7 @@ module ContextDev
17
17
  ),
18
18
  type: ContextDev::UtilityPrefetchParams::Type::OrSymbol,
19
19
  tags: T::Array[String],
20
- timeout_ms: Integer,
20
+ timeout_opts: ContextDev::UtilityPrefetchParams::TimeoutOpts::OrHash,
21
21
  request_options: ContextDev::RequestOptions::OrHash
22
22
  ).returns(ContextDev::Models::UtilityPrefetchResponse)
23
23
  end
@@ -29,10 +29,10 @@ module ContextDev
29
29
  type:,
30
30
  # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
31
31
  tags: nil,
32
- # Optional timeout in milliseconds for the request. If the request takes longer
33
- # than this value, it will be aborted with a 408 status code. Maximum allowed
34
- # value is 300000ms (5 minutes).
35
- timeout_ms: nil,
32
+ # Optional request deadline and behavior on timeout. For GET requests, use
33
+ # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
34
+ # timeoutOpts object.
35
+ timeout_opts: nil,
36
36
  request_options: {}
37
37
  )
38
38
  end