context.dev 2.21.0 → 2.22.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 +24 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -9
  5. data/lib/context_dev/models/batch_cancel_params.rb +2 -2
  6. data/lib/context_dev/models/batch_cancel_response.rb +16 -21
  7. data/lib/context_dev/models/batch_delete_params.rb +2 -2
  8. data/lib/context_dev/models/batch_delete_response.rb +8 -8
  9. data/lib/context_dev/models/batch_get_results_params.rb +2 -2
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -22
  11. data/lib/context_dev/models/batch_list_response.rb +38 -47
  12. data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
  13. data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
  14. data/lib/context_dev/models/batch_submit_params.rb +80 -109
  15. data/lib/context_dev/models/batch_submit_response.rb +18 -28
  16. data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
  17. data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
  18. data/lib/context_dev/models/brand_search_params.rb +2 -3
  19. data/lib/context_dev/models/brand_search_response.rb +8 -8
  20. data/lib/context_dev/models/crawl_controls.rb +1 -2
  21. data/lib/context_dev/models/feedback_submit_params.rb +2 -2
  22. data/lib/context_dev/models/feedback_submit_response.rb +8 -8
  23. data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
  24. data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
  25. data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
  26. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
  27. data/lib/context_dev/models/intake.rb +7 -13
  28. data/lib/context_dev/models/log_list_response.rb +14 -10
  29. data/lib/context_dev/models/log_retrieve_response.rb +15 -41
  30. data/lib/context_dev/models/monitor_create_params.rb +238 -72
  31. data/lib/context_dev/models/monitor_create_response.rb +364 -175
  32. data/lib/context_dev/models/monitor_delete_params.rb +3 -1
  33. data/lib/context_dev/models/monitor_delete_response.rb +44 -1
  34. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
  35. data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
  36. data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
  37. data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
  38. data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
  39. data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
  40. data/lib/context_dev/models/monitor_list_params.rb +3 -3
  41. data/lib/context_dev/models/monitor_list_response.rb +304 -106
  42. data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
  43. data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
  44. data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
  45. data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
  46. data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
  47. data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
  48. data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
  49. data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
  50. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
  51. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
  52. data/lib/context_dev/models/monitor_run_params.rb +3 -1
  53. data/lib/context_dev/models/monitor_run_response.rb +42 -4
  54. data/lib/context_dev/models/monitor_update_params.rb +239 -71
  55. data/lib/context_dev/models/monitor_update_response.rb +361 -171
  56. data/lib/context_dev/models/news_search_params.rb +10 -6
  57. data/lib/context_dev/models/news_search_response.rb +8 -8
  58. data/lib/context_dev/models/parse_handle_params.rb +9 -20
  59. data/lib/context_dev/models/parse_handle_response.rb +8 -8
  60. data/lib/context_dev/models/person_enrich_params.rb +76 -50
  61. data/lib/context_dev/models/person_enrich_response.rb +8 -8
  62. data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
  63. data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
  64. data/lib/context_dev/models/web_answers_params.rb +28 -47
  65. data/lib/context_dev/models/web_answers_response.rb +9 -8
  66. data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
  67. data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
  68. data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
  69. data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
  70. data/lib/context_dev/models/web_map_urls_params.rb +30 -51
  71. data/lib/context_dev/models/web_map_urls_response.rb +8 -8
  72. data/lib/context_dev/models/web_scrape_params.rb +193 -191
  73. data/lib/context_dev/models/web_scrape_response.rb +219 -95
  74. data/lib/context_dev/models/web_screenshot_params.rb +20 -39
  75. data/lib/context_dev/models/web_screenshot_response.rb +18 -28
  76. data/lib/context_dev/models/web_search_params.rb +76 -65
  77. data/lib/context_dev/models/web_search_response.rb +68 -27
  78. data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
  79. data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
  80. data/lib/context_dev/models/webhook_delivery.rb +3 -7
  81. data/lib/context_dev/models/webhooks/attempt.rb +3 -3
  82. data/lib/context_dev/models/webhooks/delivery.rb +16 -11
  83. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
  84. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
  85. data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
  86. data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
  87. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
  88. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
  89. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
  90. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
  91. data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
  92. data/lib/context_dev/resources/batch.rb +17 -16
  93. data/lib/context_dev/resources/brand.rb +6 -8
  94. data/lib/context_dev/resources/feedback.rb +4 -5
  95. data/lib/context_dev/resources/industry.rb +9 -11
  96. data/lib/context_dev/resources/logs.rb +4 -5
  97. data/lib/context_dev/resources/monitors.rb +50 -53
  98. data/lib/context_dev/resources/news.rb +4 -8
  99. data/lib/context_dev/resources/parse.rb +4 -5
  100. data/lib/context_dev/resources/people.rb +11 -13
  101. data/lib/context_dev/resources/utility.rb +4 -11
  102. data/lib/context_dev/resources/web.rb +69 -94
  103. data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
  104. data/lib/context_dev/resources/webhooks.rb +1 -1
  105. data/lib/context_dev/version.rb +1 -1
  106. data/rbi/context_dev/client.rbi +4 -9
  107. data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
  108. data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
  109. data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
  110. data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
  111. data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
  112. data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
  113. data/rbi/context_dev/models/batch_list_response.rbi +41 -53
  114. data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
  115. data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
  116. data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
  117. data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
  118. data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
  119. data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
  120. data/rbi/context_dev/models/brand_search_params.rbi +2 -4
  121. data/rbi/context_dev/models/brand_search_response.rbi +9 -9
  122. data/rbi/context_dev/models/crawl_controls.rbi +1 -2
  123. data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
  124. data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
  125. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
  126. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
  127. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
  128. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
  129. data/rbi/context_dev/models/intake.rbi +7 -19
  130. data/rbi/context_dev/models/log_list_response.rbi +13 -11
  131. data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
  132. data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
  133. data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
  134. data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
  135. data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
  136. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
  137. data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
  138. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
  139. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
  140. data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
  141. data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
  142. data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
  143. data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
  144. data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
  145. data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
  146. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
  147. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
  148. data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
  149. data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
  150. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
  151. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
  152. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
  153. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
  154. data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
  155. data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
  156. data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
  157. data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
  158. data/rbi/context_dev/models/news_search_params.rbi +10 -2
  159. data/rbi/context_dev/models/news_search_response.rbi +9 -9
  160. data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
  161. data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
  162. data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
  163. data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
  164. data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
  165. data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
  166. data/rbi/context_dev/models/web_answers_params.rbi +33 -63
  167. data/rbi/context_dev/models/web_answers_response.rbi +11 -9
  168. data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
  169. data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
  170. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
  171. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
  172. data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
  173. data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
  174. data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
  175. data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
  176. data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
  177. data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
  178. data/rbi/context_dev/models/web_search_params.rbi +114 -82
  179. data/rbi/context_dev/models/web_search_response.rbi +145 -33
  180. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
  181. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
  182. data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
  183. data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
  184. data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
  185. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
  186. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
  187. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
  188. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
  189. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
  190. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
  191. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
  192. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
  193. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
  194. data/rbi/context_dev/resources/batch.rbi +19 -18
  195. data/rbi/context_dev/resources/brand.rbi +6 -9
  196. data/rbi/context_dev/resources/feedback.rbi +4 -5
  197. data/rbi/context_dev/resources/industry.rbi +11 -27
  198. data/rbi/context_dev/resources/logs.rbi +4 -5
  199. data/rbi/context_dev/resources/monitors.rbi +71 -49
  200. data/rbi/context_dev/resources/news.rbi +4 -8
  201. data/rbi/context_dev/resources/parse.rbi +7 -14
  202. data/rbi/context_dev/resources/people.rbi +15 -13
  203. data/rbi/context_dev/resources/utility.rbi +4 -11
  204. data/rbi/context_dev/resources/web.rbi +89 -190
  205. data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
  206. data/rbi/context_dev/resources/webhooks.rbi +1 -1
  207. data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
  208. data/sig/context_dev/models/monitor_create_params.rbs +113 -0
  209. data/sig/context_dev/models/monitor_create_response.rbs +203 -53
  210. data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
  211. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
  212. data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
  213. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
  214. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
  215. data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
  216. data/sig/context_dev/models/monitor_list_response.rbs +149 -3
  217. data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
  218. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
  219. data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
  220. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
  221. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
  222. data/sig/context_dev/models/monitor_run_response.rbs +48 -3
  223. data/sig/context_dev/models/monitor_update_params.rbs +113 -0
  224. data/sig/context_dev/models/monitor_update_response.rbs +203 -53
  225. data/sig/context_dev/models/web_scrape_response.rbs +204 -27
  226. data/sig/context_dev/models/web_search_params.rbs +25 -0
  227. data/sig/context_dev/models/web_search_response.rbs +48 -0
  228. data/sig/context_dev/resources/web.rbs +1 -0
  229. metadata +2 -2
@@ -15,12 +15,12 @@ module ContextDev
15
15
  sig { returns(ContextDev::Models::PersonEnrichResponse::Match::Variants) }
16
16
  attr_accessor :match
17
17
 
18
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
19
- # it when contacting support about a failed request.
18
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
19
+ # support.
20
20
  sig { returns(String) }
21
21
  attr_accessor :request_id
22
22
 
23
- # Credit usage, included whenever a valid API key is provided.
23
+ # Credits this request used and your remaining balance.
24
24
  sig do
25
25
  returns(
26
26
  T.nilable(ContextDev::Models::PersonEnrichResponse::KeyMetadata)
@@ -60,10 +60,10 @@ module ContextDev
60
60
  def self.new(
61
61
  # The highest-scoring person candidate.
62
62
  match:,
63
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
64
- # it when contacting support about a failed request.
63
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
64
+ # support.
65
65
  request_id:,
66
- # Credit usage, included whenever a valid API key is provided.
66
+ # Credits this request used and your remaining balance.
67
67
  key_metadata: nil,
68
68
  # True when the timeout ended processing and this response contains the usable
69
69
  # data completed so far. Unfinished fields are omitted.
@@ -1280,7 +1280,7 @@ module ContextDev
1280
1280
  )
1281
1281
  end
1282
1282
 
1283
- # Credits used by this request.
1283
+ # Credits charged for this request.
1284
1284
  sig { returns(Integer) }
1285
1285
  attr_accessor :credits_consumed
1286
1286
 
@@ -1288,14 +1288,14 @@ module ContextDev
1288
1288
  sig { returns(Integer) }
1289
1289
  attr_accessor :credits_remaining
1290
1290
 
1291
- # Credit usage, included whenever a valid API key is provided.
1291
+ # Credits this request used and your remaining balance.
1292
1292
  sig do
1293
1293
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
1294
1294
  T.attached_class
1295
1295
  )
1296
1296
  end
1297
1297
  def self.new(
1298
- # Credits used by this request.
1298
+ # Credits charged for this request.
1299
1299
  credits_consumed:,
1300
1300
  # Credits remaining for your organization.
1301
1301
  credits_remaining:
@@ -25,21 +25,18 @@ module ContextDev
25
25
  end
26
26
  attr_accessor :identifier
27
27
 
28
- # What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the
29
- # styleguide cache.
28
+ # Data to prefetch.
30
29
  sig { returns(ContextDev::UtilityPrefetchParams::Type::OrSymbol) }
31
30
  attr_accessor :type
32
31
 
33
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
32
+ # Labels for filtering usage in the dashboard.
34
33
  sig { returns(T.nilable(T::Array[String])) }
35
34
  attr_reader :tags
36
35
 
37
36
  sig { params(tags: T::Array[String]).void }
38
37
  attr_writer :tags
39
38
 
40
- # Optional request deadline and behavior on timeout. For GET requests, use
41
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
42
- # timeoutOpts object.
39
+ # Request deadline and what to return when it passes.
43
40
  sig { returns(T.nilable(ContextDev::UtilityPrefetchParams::TimeoutOpts)) }
44
41
  attr_reader :timeout_opts
45
42
 
@@ -66,14 +63,11 @@ module ContextDev
66
63
  def self.new(
67
64
  # Identifier of the target to prefetch. Provide exactly one of domain or email.
68
65
  identifier:,
69
- # What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the
70
- # styleguide cache.
66
+ # Data to prefetch.
71
67
  type:,
72
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
68
+ # Labels for filtering usage in the dashboard.
73
69
  tags: nil,
74
- # Optional request deadline and behavior on timeout. For GET requests, use
75
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
76
- # timeoutOpts object.
70
+ # Request deadline and what to return when it passes.
77
71
  timeout_opts: nil,
78
72
  request_options: {}
79
73
  )
@@ -118,14 +112,14 @@ module ContextDev
118
112
  )
119
113
  end
120
114
 
121
- # Domain name to prefetch data for
115
+ # Domain, e.g. `stripe.com`.
122
116
  sig { returns(String) }
123
117
  attr_accessor :domain
124
118
 
125
119
  # Prefetch by domain.
126
120
  sig { params(domain: String).returns(T.attached_class) }
127
121
  def self.new(
128
- # Domain name to prefetch data for
122
+ # Domain, e.g. `stripe.com`.
129
123
  domain:
130
124
  )
131
125
  end
@@ -174,8 +168,7 @@ module ContextDev
174
168
  end
175
169
  end
176
170
 
177
- # What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the
178
- # styleguide cache.
171
+ # Data to prefetch.
179
172
  module Type
180
173
  extend ContextDev::Internal::Type::Enum
181
174
 
@@ -211,12 +204,11 @@ module ContextDev
211
204
  )
212
205
  end
213
206
 
214
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
207
+ # Deadline in milliseconds.
215
208
  sig { returns(Integer) }
216
209
  attr_accessor :milliseconds
217
210
 
218
- # What to do at the deadline. This endpoint supports "fail": return 408
219
- # REQUEST_TIMEOUT without charging credits.
211
+ # Only "fail" is supported: return 408 at the deadline.
220
212
  sig do
221
213
  returns(
222
214
  T.nilable(
@@ -234,9 +226,7 @@ module ContextDev
234
226
  end
235
227
  attr_writer :behavior
236
228
 
237
- # Optional request deadline and behavior on timeout. For GET requests, use
238
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
239
- # timeoutOpts object.
229
+ # Request deadline and what to return when it passes.
240
230
  sig do
241
231
  params(
242
232
  milliseconds: Integer,
@@ -245,10 +235,9 @@ module ContextDev
245
235
  ).returns(T.attached_class)
246
236
  end
247
237
  def self.new(
248
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
238
+ # Deadline in milliseconds.
249
239
  milliseconds:,
250
- # What to do at the deadline. This endpoint supports "fail": return 408
251
- # REQUEST_TIMEOUT without charging credits.
240
+ # Only "fail" is supported: return 408 at the deadline.
252
241
  behavior: nil
253
242
  )
254
243
  end
@@ -265,8 +254,7 @@ module ContextDev
265
254
  def to_hash
266
255
  end
267
256
 
268
- # What to do at the deadline. This endpoint supports "fail": return 408
269
- # REQUEST_TIMEOUT without charging credits.
257
+ # Only "fail" is supported: return 408 at the deadline.
270
258
  module Behavior
271
259
  extend ContextDev::Internal::Type::Enum
272
260
 
@@ -11,8 +11,8 @@ module ContextDev
11
11
  )
12
12
  end
13
13
 
14
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
- # it when contacting support about a failed request.
14
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
15
+ # support.
16
16
  sig { returns(String) }
17
17
  attr_accessor :request_id
18
18
 
@@ -23,7 +23,7 @@ module ContextDev
23
23
  sig { params(domain: String).void }
24
24
  attr_writer :domain
25
25
 
26
- # Credit usage, included whenever a valid API key is provided.
26
+ # Credits this request used and your remaining balance.
27
27
  sig do
28
28
  returns(
29
29
  T.nilable(ContextDev::Models::UtilityPrefetchResponse::KeyMetadata)
@@ -46,7 +46,7 @@ module ContextDev
46
46
  sig { params(message: String).void }
47
47
  attr_writer :message
48
48
 
49
- # Status of the response, e.g., 'ok'
49
+ # Always `ok` on success.
50
50
  sig { returns(T.nilable(String)) }
51
51
  attr_reader :status
52
52
 
@@ -82,16 +82,16 @@ module ContextDev
82
82
  ).returns(T.attached_class)
83
83
  end
84
84
  def self.new(
85
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
86
- # it when contacting support about a failed request.
85
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
86
+ # support.
87
87
  request_id:,
88
88
  # The domain that was queued for prefetching
89
89
  domain: nil,
90
- # Credit usage, included whenever a valid API key is provided.
90
+ # Credits this request used and your remaining balance.
91
91
  key_metadata: nil,
92
92
  # Success message
93
93
  message: nil,
94
- # Status of the response, e.g., 'ok'
94
+ # Always `ok` on success.
95
95
  status: nil,
96
96
  # The type of prefetch that was queued, echoed from the request
97
97
  type: nil
@@ -124,7 +124,7 @@ module ContextDev
124
124
  )
125
125
  end
126
126
 
127
- # Credits used by this request.
127
+ # Credits charged for this request.
128
128
  sig { returns(Integer) }
129
129
  attr_accessor :credits_consumed
130
130
 
@@ -132,14 +132,14 @@ module ContextDev
132
132
  sig { returns(Integer) }
133
133
  attr_accessor :credits_remaining
134
134
 
135
- # Credit usage, included whenever a valid API key is provided.
135
+ # Credits this request used and your remaining balance.
136
136
  sig do
137
137
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
138
138
  T.attached_class
139
139
  )
140
140
  end
141
141
  def self.new(
142
- # Credits used by this request.
142
+ # Credits charged for this request.
143
143
  credits_consumed:,
144
144
  # Credits remaining for your organization.
145
145
  credits_remaining:
@@ -11,41 +11,35 @@ module ContextDev
11
11
  T.any(ContextDev::WebAnswersParams, ContextDev::Internal::AnyHash)
12
12
  end
13
13
 
14
- # What to research and answer, in plain language. Naming a domain in the task (for
15
- # example "pricing on context.dev") makes the agent read that site before it
16
- # searches.
14
+ # Research task. The agent selects company/profile lookups, web searches, or page
15
+ # reads. Include domains or URLs to focus the research.
17
16
  sig { returns(String) }
18
17
  attr_accessor :task
19
18
 
20
- # An example object with placeholder values (for example {"pricing_page_url": "",
21
- # "plans": [{"name": "", "price": 0}]}). Object keys and value types are
22
- # preserved; unknown values may be null. Empty arrays accept any JSON items.
23
- # Defaults to {"result": ""}. Maximum 8 levels, 500 values, and 16000 characters.
19
+ # Example answer object, not JSON Schema. Up to 8 levels, 500 values, and 16000
20
+ # characters; unknowns may be null.
24
21
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
25
22
  attr_reader :json_format
26
23
 
27
24
  sig { params(json_format: T::Hash[Symbol, T.anything]).void }
28
25
  attr_writer :json_format
29
26
 
30
- # Research level: fast uses a smaller model and research budget for 10 credits;
31
- # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
32
- # Only successful requests consume credits.
27
+ # `fast` prioritizes speed, with extra verification for people and companies;
28
+ # `ultra` supports deeper research (default).
33
29
  sig { returns(T.nilable(ContextDev::WebAnswersParams::Mode::OrSymbol)) }
34
30
  attr_reader :mode
35
31
 
36
32
  sig { params(mode: ContextDev::WebAnswersParams::Mode::OrSymbol).void }
37
33
  attr_writer :mode
38
34
 
39
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
35
+ # Labels for filtering usage in the dashboard.
40
36
  sig { returns(T.nilable(T::Array[String])) }
41
37
  attr_reader :tags
42
38
 
43
39
  sig { params(tags: T::Array[String]).void }
44
40
  attr_writer :tags
45
41
 
46
- # Optional request deadline and behavior on timeout. For GET requests, use
47
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
48
- # timeoutOpts object.
42
+ # Request deadline and what to return when it passes.
49
43
  sig { returns(T.nilable(ContextDev::WebAnswersParams::TimeoutOpts)) }
50
44
  attr_reader :timeout_opts
51
45
 
@@ -56,11 +50,8 @@ module ContextDev
56
50
  end
57
51
  attr_writer :timeout_opts
58
52
 
59
- # Set to enabled to bypass shared caches and omit request and response content
60
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
61
- # omitted. Requires zero data retention to be enabled for your organization
62
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
63
- # Successful ZDR responses include X-Context-ZDR: true.
53
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
54
+ # your organization has ZDR.
64
55
  sig { returns(T.nilable(ContextDev::WebAnswersParams::Zdr::OrSymbol)) }
65
56
  attr_reader :zdr
66
57
 
@@ -79,30 +70,21 @@ module ContextDev
79
70
  ).returns(T.attached_class)
80
71
  end
81
72
  def self.new(
82
- # What to research and answer, in plain language. Naming a domain in the task (for
83
- # example "pricing on context.dev") makes the agent read that site before it
84
- # searches.
73
+ # Research task. The agent selects company/profile lookups, web searches, or page
74
+ # reads. Include domains or URLs to focus the research.
85
75
  task:,
86
- # An example object with placeholder values (for example {"pricing_page_url": "",
87
- # "plans": [{"name": "", "price": 0}]}). Object keys and value types are
88
- # preserved; unknown values may be null. Empty arrays accept any JSON items.
89
- # Defaults to {"result": ""}. Maximum 8 levels, 500 values, and 16000 characters.
76
+ # Example answer object, not JSON Schema. Up to 8 levels, 500 values, and 16000
77
+ # characters; unknowns may be null.
90
78
  json_format: nil,
91
- # Research level: fast uses a smaller model and research budget for 10 credits;
92
- # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
93
- # Only successful requests consume credits.
79
+ # `fast` prioritizes speed, with extra verification for people and companies;
80
+ # `ultra` supports deeper research (default).
94
81
  mode: nil,
95
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
82
+ # Labels for filtering usage in the dashboard.
96
83
  tags: nil,
97
- # Optional request deadline and behavior on timeout. For GET requests, use
98
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
99
- # timeoutOpts object.
84
+ # Request deadline and what to return when it passes.
100
85
  timeout_opts: nil,
101
- # Set to enabled to bypass shared caches and omit request and response content
102
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
103
- # omitted. Requires zero data retention to be enabled for your organization
104
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
105
- # Successful ZDR responses include X-Context-ZDR: true.
86
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
87
+ # your organization has ZDR.
106
88
  zdr: nil,
107
89
  request_options: {}
108
90
  )
@@ -124,9 +106,8 @@ module ContextDev
124
106
  def to_hash
125
107
  end
126
108
 
127
- # Research level: fast uses a smaller model and research budget for 10 credits;
128
- # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
129
- # Only successful requests consume credits.
109
+ # `fast` prioritizes speed, with extra verification for people and companies;
110
+ # `ultra` supports deeper research (default).
130
111
  module Mode
131
112
  extend ContextDev::Internal::Type::Enum
132
113
 
@@ -155,14 +136,12 @@ module ContextDev
155
136
  )
156
137
  end
157
138
 
158
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
139
+ # Deadline in milliseconds.
159
140
  sig { returns(Integer) }
160
141
  attr_accessor :milliseconds
161
142
 
162
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
163
- # credits. "return-partial" returns usable results collected so far; if none are
164
- # available, the request still fails without charging credits. Partial results are
165
- # not cached as complete results.
143
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
144
+ # inspect the response’s partial flag.
166
145
  sig do
167
146
  returns(
168
147
  T.nilable(
@@ -180,9 +159,7 @@ module ContextDev
180
159
  end
181
160
  attr_writer :behavior
182
161
 
183
- # Optional request deadline and behavior on timeout. For GET requests, use
184
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
185
- # timeoutOpts object.
162
+ # Request deadline and what to return when it passes.
186
163
  sig do
187
164
  params(
188
165
  milliseconds: Integer,
@@ -191,12 +168,10 @@ module ContextDev
191
168
  ).returns(T.attached_class)
192
169
  end
193
170
  def self.new(
194
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
171
+ # Deadline in milliseconds.
195
172
  milliseconds:,
196
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
197
- # credits. "return-partial" returns usable results collected so far; if none are
198
- # available, the request still fails without charging credits. Partial results are
199
- # not cached as complete results.
173
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
174
+ # inspect the response’s partial flag.
200
175
  behavior: nil
201
176
  )
202
177
  end
@@ -213,10 +188,8 @@ module ContextDev
213
188
  def to_hash
214
189
  end
215
190
 
216
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
217
- # credits. "return-partial" returns usable results collected so far; if none are
218
- # available, the request still fails without charging credits. Partial results are
219
- # not cached as complete results.
191
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
192
+ # inspect the response’s partial flag.
220
193
  module Behavior
221
194
  extend ContextDev::Internal::Type::Enum
222
195
 
@@ -249,11 +222,8 @@ module ContextDev
249
222
  end
250
223
  end
251
224
 
252
- # Set to enabled to bypass shared caches and omit request and response content
253
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
254
- # omitted. Requires zero data retention to be enabled for your organization
255
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
256
- # Successful ZDR responses include X-Context-ZDR: true.
225
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
226
+ # your organization has ZDR.
257
227
  module Zdr
258
228
  extend ContextDev::Internal::Type::Enum
259
229
 
@@ -15,12 +15,13 @@ module ContextDev
15
15
  sig { returns(T::Hash[Symbol, T.anything]) }
16
16
  attr_accessor :json_content
17
17
 
18
- # URLs that supplied search results or readable page content, in first-seen order.
19
- # Unreadable pages are excluded.
18
+ # Public evidence URLs from searches, pages, or company/profile records, in
19
+ # first-seen order. A listed URL may identify a record without its page being
20
+ # read.
20
21
  sig { returns(T::Array[String]) }
21
22
  attr_accessor :sources
22
23
 
23
- # Credit usage, included whenever a valid API key is provided.
24
+ # Credits this request used and your remaining balance.
24
25
  sig do
25
26
  returns(T.nilable(ContextDev::Models::WebAnswersResponse::KeyMetadata))
26
27
  end
@@ -54,10 +55,11 @@ module ContextDev
54
55
  def self.new(
55
56
  # The answer, in the shape requested by json_format.
56
57
  json_content:,
57
- # URLs that supplied search results or readable page content, in first-seen order.
58
- # Unreadable pages are excluded.
58
+ # Public evidence URLs from searches, pages, or company/profile records, in
59
+ # first-seen order. A listed URL may identify a record without its page being
60
+ # read.
59
61
  sources:,
60
- # Credit usage, included whenever a valid API key is provided.
62
+ # Credits this request used and your remaining balance.
61
63
  key_metadata: nil,
62
64
  # True when the request deadline ended research and the answer uses the evidence
63
65
  # collected so far.
@@ -87,7 +89,7 @@ module ContextDev
87
89
  )
88
90
  end
89
91
 
90
- # Credits used by this request.
92
+ # Credits charged for this request.
91
93
  sig { returns(Integer) }
92
94
  attr_accessor :credits_consumed
93
95
 
@@ -95,14 +97,14 @@ module ContextDev
95
97
  sig { returns(Integer) }
96
98
  attr_accessor :credits_remaining
97
99
 
98
- # Credit usage, included whenever a valid API key is provided.
100
+ # Credits this request used and your remaining balance.
99
101
  sig do
100
102
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
101
103
  T.attached_class
102
104
  )
103
105
  end
104
106
  def self.new(
105
- # Credits used by this request.
107
+ # Credits charged for this request.
106
108
  credits_consumed:,
107
109
  # Credits remaining for your organization.
108
110
  credits_remaining:
@@ -26,17 +26,14 @@ module ContextDev
26
26
  sig { params(num_competitors: Integer).void }
27
27
  attr_writer :num_competitors
28
28
 
29
- # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
30
- # characters.
29
+ # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
31
30
  sig { returns(T.nilable(T::Array[String])) }
32
31
  attr_reader :tags
33
32
 
34
33
  sig { params(tags: T::Array[String]).void }
35
34
  attr_writer :tags
36
35
 
37
- # Optional request deadline and behavior on timeout. For GET requests, use
38
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
39
- # timeoutOpts object.
36
+ # Request deadline and what to return when it passes.
40
37
  sig do
41
38
  returns(T.nilable(ContextDev::WebExtractCompetitorsParams::TimeoutOpts))
42
39
  end
@@ -50,11 +47,8 @@ module ContextDev
50
47
  end
51
48
  attr_writer :timeout_opts
52
49
 
53
- # Set to enabled to bypass shared caches and omit request and response content
54
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
55
- # omitted. Requires zero data retention to be enabled for your organization
56
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
57
- # Successful ZDR responses include X-Context-ZDR: true.
50
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
51
+ # your organization has ZDR.
58
52
  sig do
59
53
  returns(
60
54
  T.nilable(ContextDev::WebExtractCompetitorsParams::Zdr::OrSymbol)
@@ -84,18 +78,12 @@ module ContextDev
84
78
  domain:,
85
79
  # Exact number of direct competitors to return. Defaults to 5.
86
80
  num_competitors: nil,
87
- # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
88
- # characters.
81
+ # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
89
82
  tags: nil,
90
- # Optional request deadline and behavior on timeout. For GET requests, use
91
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
92
- # timeoutOpts object.
83
+ # Request deadline and what to return when it passes.
93
84
  timeout_opts: nil,
94
- # Set to enabled to bypass shared caches and omit request and response content
95
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
96
- # omitted. Requires zero data retention to be enabled for your organization
97
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
98
- # Successful ZDR responses include X-Context-ZDR: true.
85
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
86
+ # your organization has ZDR.
99
87
  zdr: nil,
100
88
  request_options: {}
101
89
  )
@@ -125,14 +113,12 @@ module ContextDev
125
113
  )
126
114
  end
127
115
 
128
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
116
+ # Deadline in milliseconds.
129
117
  sig { returns(Integer) }
130
118
  attr_accessor :milliseconds
131
119
 
132
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
133
- # credits. "return-partial" returns usable results collected so far; if none are
134
- # available, the request still fails without charging credits. Partial results are
135
- # not cached as complete results.
120
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
121
+ # inspect the response’s partial flag.
136
122
  sig do
137
123
  returns(
138
124
  T.nilable(
@@ -150,9 +136,7 @@ module ContextDev
150
136
  end
151
137
  attr_writer :behavior
152
138
 
153
- # Optional request deadline and behavior on timeout. For GET requests, use
154
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
155
- # timeoutOpts object.
139
+ # Request deadline and what to return when it passes.
156
140
  sig do
157
141
  params(
158
142
  milliseconds: Integer,
@@ -161,12 +145,10 @@ module ContextDev
161
145
  ).returns(T.attached_class)
162
146
  end
163
147
  def self.new(
164
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
148
+ # Deadline in milliseconds.
165
149
  milliseconds:,
166
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
167
- # credits. "return-partial" returns usable results collected so far; if none are
168
- # available, the request still fails without charging credits. Partial results are
169
- # not cached as complete results.
150
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
151
+ # inspect the response’s partial flag.
170
152
  behavior: nil
171
153
  )
172
154
  end
@@ -183,10 +165,8 @@ module ContextDev
183
165
  def to_hash
184
166
  end
185
167
 
186
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
187
- # credits. "return-partial" returns usable results collected so far; if none are
188
- # available, the request still fails without charging credits. Partial results are
189
- # not cached as complete results.
168
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
169
+ # inspect the response’s partial flag.
190
170
  module Behavior
191
171
  extend ContextDev::Internal::Type::Enum
192
172
 
@@ -222,11 +202,8 @@ module ContextDev
222
202
  end
223
203
  end
224
204
 
225
- # Set to enabled to bypass shared caches and omit request and response content
226
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
227
- # omitted. Requires zero data retention to be enabled for your organization
228
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
229
- # Successful ZDR responses include X-Context-ZDR: true.
205
+ # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
206
+ # your organization has ZDR.
230
207
  module Zdr
231
208
  extend ContextDev::Internal::Type::Enum
232
209