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
@@ -2,14 +2,13 @@
2
2
 
3
3
  module ContextDev
4
4
  module Resources
5
- # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
6
- # cost no credits and use a separate rate limit.
5
+ # Report API issues and documentation mismatches.
7
6
  class Feedback
8
7
  # Some parameter documentations has been truncated, see
9
8
  # {ContextDev::Models::FeedbackSubmitParams} for more details.
10
9
  #
11
- # Report a problem with a Context.dev API call, docs page, SDK, or CLI. Include
12
- # request_id, url, or both.
10
+ # Report an API issue or documentation mismatch, including request IDs when
11
+ # available.
13
12
  #
14
13
  # @overload submit(category:, note:, request_id: nil, tags: nil, url: nil, request_options: {})
15
14
  #
@@ -19,7 +18,7 @@ module ContextDev
19
18
  #
20
19
  # @param request_id [String] The request_id of the API call the feedback is about, from its response body or
21
20
  #
22
- # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
21
+ # @param tags [Array<String>] Labels for filtering usage in the dashboard.
23
22
  #
24
23
  # @param url [String] The page the feedback is about, such as one page of a crawl or a docs page.
25
24
  #
@@ -6,7 +6,7 @@ module ContextDev
6
6
  # Some parameter documentations has been truncated, see
7
7
  # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
8
8
  #
9
- # Classify any brand into 2022 NAICS industry codes from its domain or name.
9
+ # Classify a company into NAICS industry codes.
10
10
  #
11
11
  # @overload retrieve_naics(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
12
12
  #
@@ -16,11 +16,11 @@ module ContextDev
16
16
  #
17
17
  # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
18
18
  #
19
- # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
19
+ # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
20
20
  #
21
- # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
21
+ # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Request deadline and what to return when it passes.
22
22
  #
23
- # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
23
+ # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
24
24
  #
25
25
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
26
26
  #
@@ -46,9 +46,7 @@ module ContextDev
46
46
  # Some parameter documentations has been truncated, see
47
47
  # {ContextDev::Models::IndustryRetrieveSicParams} for more details.
48
48
  #
49
- # Classify any brand into Standard Industrial Classification (SIC) codes from its
50
- # domain or name. Choose between the original SIC system (`original_sic`) or the
51
- # latest SIC list maintained by the SEC (`latest_sec`).
49
+ # Classify a company into SIC industry codes.
52
50
  #
53
51
  # @overload retrieve_sic(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, zdr: nil, request_options: {})
54
52
  #
@@ -58,13 +56,13 @@ module ContextDev
58
56
  #
59
57
  # @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
60
58
  #
61
- # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
59
+ # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
62
60
  #
63
- # @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
61
+ # @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Request deadline and what to return when it passes.
64
62
  #
65
- # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
63
+ # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).
66
64
  #
67
- # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
65
+ # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
68
66
  #
69
67
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
70
68
  #
@@ -2,10 +2,9 @@
2
2
 
3
3
  module ContextDev
4
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.
5
+ # Read your organization's API request logs.
7
6
  class Logs
8
- # Get one logged API call, including its request input and response body.
7
+ # Retrieve a request’s metadata, retained input, and response.
9
8
  #
10
9
  # @overload retrieve(request_id, request_options: {})
11
10
  #
@@ -28,8 +27,8 @@ module ContextDev
28
27
  # Some parameter documentations has been truncated, see
29
28
  # {ContextDev::Models::LogListParams} for more details.
30
29
  #
31
- # List your organization's API requests, newest first. Defaults to the last 24
32
- # hours.
30
+ # List your organization’s request logs with filters and pagination. Logs also
31
+ # include batch settlements and monitor runs.
33
32
  #
34
33
  # @overload list(error_code: nil, errors_only: nil, from: nil, key_id: nil, limit: nil, page: nil, path: nil, search: nil, status_code: nil, tags: nil, to: nil, request_options: {})
35
34
  #
@@ -2,33 +2,29 @@
2
2
 
3
3
  module ContextDev
4
4
  module Resources
5
- # Monitor pages, sitemaps, and extracted website data for exact or semantic
6
- # changes. Webhook payloads are documented by the
7
- # MonitorsChangeDetectedWebhookPayload and MonitorsRunCompletedWebhookPayload
8
- # schemas.
5
+ # Watch websites for exact or meaningful changes.
9
6
  class Monitors
10
7
  # Some parameter documentations has been truncated, see
11
8
  # {ContextDev::Models::MonitorCreateParams} for more details.
12
9
  #
13
- # Creates a monitor. The request body is a union of the supported target/change
14
- # detection combinations. The monitor runs immediately after creation to create
15
- # its initial baseline.
10
+ # Watch a page, URL inventory, or extracted website data on a schedule. A run
11
+ # starts immediately to capture the baseline.
16
12
  #
17
13
  # @overload create(name:, target:, change_detection: nil, mode: nil, schedule: nil, tags: nil, webhook: nil, request_options: {})
18
14
  #
19
- # @param name [String]
15
+ # @param name [String] Display name for the monitor.
20
16
  #
21
- # @param target [ContextDev::Models::MonitorCreateParams::Target::Page, ContextDev::Models::MonitorCreateParams::Target::Sitemap, ContextDev::Models::MonitorCreateParams::Target::Extract] Discriminated union describing what the monitor watches.
17
+ # @param target [ContextDev::Models::MonitorCreateParams::Target::Page, ContextDev::Models::MonitorCreateParams::Target::Sitemap, ContextDev::Models::MonitorCreateParams::Target::Extract] What to watch: a page, a sitemap, or data extracted from a site.
22
18
  #
23
- # @param change_detection [ContextDev::Models::MonitorCreateParams::ChangeDetection::Exact, ContextDev::Models::MonitorCreateParams::ChangeDetection::Semantic] Discriminated union describing how changes are detected.
19
+ # @param change_detection [ContextDev::Models::MonitorCreateParams::ChangeDetection::Exact, ContextDev::Models::MonitorCreateParams::ChangeDetection::Semantic] How changes are judged. Defaults to `semantic` for extract targets and page targ
24
20
  #
25
- # @param mode [Symbol, ContextDev::Models::MonitorCreateParams::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
21
+ # @param mode [Symbol, ContextDev::Models::MonitorCreateParams::Mode] Always `web`. Optional.
26
22
  #
27
23
  # @param schedule [ContextDev::Models::MonitorCreateParams::Schedule] Run the monitor on a fixed interval defined by a frequency and a unit, e.g. ever
28
24
  #
29
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
25
+ # @param tags [Array<String>] Labels for filtering monitors, their changes, and their usage.
30
26
  #
31
- # @param webhook [ContextDev::Models::MonitorCreateParams::Webhook, nil]
27
+ # @param webhook [ContextDev::Models::MonitorCreateParams::Webhook, nil] Webhook destination and delivery settings. Null means no webhook is configured.
32
28
  #
33
29
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
34
30
  #
@@ -46,11 +42,12 @@ module ContextDev
46
42
  )
47
43
  end
48
44
 
49
- # Get a monitor
45
+ # Retrieve a monitor’s configuration and current state.
50
46
  #
51
47
  # @overload retrieve(monitor_id, request_options: {})
52
48
  #
53
- # @param monitor_id [String]
49
+ # @param monitor_id [String] ID of the monitor.
50
+ #
54
51
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
55
52
  #
56
53
  # @return [ContextDev::Models::MonitorRetrieveResponse]
@@ -68,27 +65,26 @@ module ContextDev
68
65
  # Some parameter documentations has been truncated, see
69
66
  # {ContextDev::Models::MonitorUpdateParams} for more details.
70
67
  #
71
- # Updates a monitor. If `target` or `change_detection` changes, the monitor
72
- # creates a new baseline. Unsupported target/change detection combinations are
73
- # rejected.
68
+ # Update a monitor. Changing its target or change detection replaces the baseline
69
+ # and queues a new baseline run.
74
70
  #
75
71
  # @overload update(monitor_id, change_detection: nil, name: nil, schedule: nil, status: nil, tags: nil, target: nil, webhook: nil, request_options: {})
76
72
  #
77
- # @param monitor_id [String]
73
+ # @param monitor_id [String] ID of the monitor.
78
74
  #
79
- # @param change_detection [ContextDev::Models::MonitorUpdateParams::ChangeDetection::Exact, ContextDev::Models::MonitorUpdateParams::ChangeDetection::Semantic] Discriminated union describing how changes are detected.
75
+ # @param change_detection [ContextDev::Models::MonitorUpdateParams::ChangeDetection::Exact, ContextDev::Models::MonitorUpdateParams::ChangeDetection::Semantic] How changes are judged. Defaults to `semantic` for extract targets and page targ
80
76
  #
81
- # @param name [String]
77
+ # @param name [String] Display name for the monitor.
82
78
  #
83
79
  # @param schedule [ContextDev::Models::MonitorUpdateParams::Schedule] Run the monitor on a fixed interval defined by a frequency and a unit, e.g. ever
84
80
  #
85
- # @param status [Symbol, ContextDev::Models::MonitorUpdateParams::Status]
81
+ # @param status [Symbol, ContextDev::Models::MonitorUpdateParams::Status] Set `paused` to stop scheduled runs or `active` to resume them.
86
82
  #
87
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
83
+ # @param tags [Array<String>] Labels for filtering monitors, their changes, and their usage.
88
84
  #
89
- # @param target [ContextDev::Models::MonitorUpdateParams::Target::Page, ContextDev::Models::MonitorUpdateParams::Target::Sitemap, ContextDev::Models::MonitorUpdateParams::Target::Extract] Discriminated union describing what the monitor watches.
85
+ # @param target [ContextDev::Models::MonitorUpdateParams::Target::Page, ContextDev::Models::MonitorUpdateParams::Target::Sitemap, ContextDev::Models::MonitorUpdateParams::Target::Extract] What to watch: a page, a sitemap, or data extracted from a site.
90
86
  #
91
- # @param webhook [ContextDev::Models::MonitorUpdateParams::Webhook, nil] Set to null to remove the webhook.
87
+ # @param webhook [ContextDev::Models::MonitorUpdateParams::Webhook, nil] Set to null to remove the webhook. Changing `url` issues a new secret.
92
88
  #
93
89
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
94
90
  #
@@ -109,9 +105,7 @@ module ContextDev
109
105
  # Some parameter documentations has been truncated, see
110
106
  # {ContextDev::Models::MonitorListParams} for more details.
111
107
  #
112
- # Lists monitors for the authenticated organization. Supports free-text search
113
- # (`q` over `search_by` fields, `prefix` or `exact` via `search_type`) plus
114
- # status/type/tag filters. Results are paginated via the opaque `cursor`.
108
+ # List your monitors with optional search and filters.
115
109
  #
116
110
  # @overload list(change_detection_type: nil, cursor: nil, limit: nil, q: nil, search_by: nil, search_type: nil, status: nil, tag: nil, tags: nil, target_type: nil, request_options: {})
117
111
  #
@@ -123,7 +117,7 @@ module ContextDev
123
117
  #
124
118
  # @param q [String] Free-text search term, matched against the fields named in `search_by`.
125
119
  #
126
- # @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Comma-separated fields to search with `q`. Defaults to all of them. Note `instru
120
+ # @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Fields to search with `q`. Defaults to all fields; page and extract targets can
127
121
  #
128
122
  # @param search_type [Symbol, ContextDev::Models::MonitorListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
129
123
  #
@@ -152,11 +146,12 @@ module ContextDev
152
146
  )
153
147
  end
154
148
 
155
- # Delete a monitor
149
+ # Delete a monitor and stop future runs and webhook retries.
156
150
  #
157
151
  # @overload delete(monitor_id, request_options: {})
158
152
  #
159
- # @param monitor_id [String]
153
+ # @param monitor_id [String] ID of the monitor.
154
+ #
160
155
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
161
156
  #
162
157
  # @return [ContextDev::Models::MonitorDeleteResponse]
@@ -171,8 +166,8 @@ module ContextDev
171
166
  )
172
167
  end
173
168
 
174
- # Returns credits charged per monitor over an optional [since, until] window,
175
- # newest spenders first.
169
+ # Return usage per monitor, highest first, for up to the 10,000 most recent runs
170
+ # in the requested window.
176
171
  #
177
172
  # @overload get_credit_usage(since: nil, until_: nil, request_options: {})
178
173
  #
@@ -197,7 +192,7 @@ module ContextDev
197
192
  )
198
193
  end
199
194
 
200
- # Returns how many monitors the account has and the maximum it allows.
195
+ # Retrieve your organization’s monitor allowance and usage.
201
196
  #
202
197
  # @overload get_limits(request_options: {})
203
198
  #
@@ -215,7 +210,7 @@ module ContextDev
215
210
  )
216
211
  end
217
212
 
218
- # Returns an account-wide feed of detected changes across monitors.
213
+ # List full change records across your monitors, newest first.
219
214
  #
220
215
  # @overload list_account_changes(change_detection_type: nil, cursor: nil, limit: nil, monitor_id: nil, since: nil, tag: nil, target_type: nil, until_: nil, request_options: {})
221
216
  #
@@ -252,7 +247,7 @@ module ContextDev
252
247
  )
253
248
  end
254
249
 
255
- # Returns an account-wide feed of monitor runs across all monitors.
250
+ # List runs across your monitors, newest first.
256
251
  #
257
252
  # @overload list_account_runs(cursor: nil, limit: nil, status: nil, request_options: {})
258
253
  #
@@ -279,11 +274,11 @@ module ContextDev
279
274
  )
280
275
  end
281
276
 
282
- # List changes for a monitor
277
+ # List full change records for a monitor, newest first.
283
278
  #
284
279
  # @overload list_changes(monitor_id, cursor: nil, limit: nil, since: nil, tag: nil, until_: nil, request_options: {})
285
280
  #
286
- # @param monitor_id [String]
281
+ # @param monitor_id [String] ID of the monitor.
287
282
  #
288
283
  # @param cursor [String] Opaque pagination cursor from a previous response.
289
284
  #
@@ -312,11 +307,11 @@ module ContextDev
312
307
  )
313
308
  end
314
309
 
315
- # List monitor runs
310
+ # List a monitor’s runs, newest first.
316
311
  #
317
312
  # @overload list_runs(monitor_id, cursor: nil, limit: nil, status: nil, request_options: {})
318
313
  #
319
- # @param monitor_id [String]
314
+ # @param monitor_id [String] ID of the monitor.
320
315
  #
321
316
  # @param cursor [String] Opaque pagination cursor from a previous response.
322
317
  #
@@ -341,11 +336,12 @@ module ContextDev
341
336
  )
342
337
  end
343
338
 
344
- # Get a change
339
+ # Retrieve a detected change, including its diff and available evidence.
345
340
  #
346
341
  # @overload retrieve_change(change_id, request_options: {})
347
342
  #
348
- # @param change_id [String]
343
+ # @param change_id [String] ID of the detected change.
344
+ #
349
345
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
350
346
  #
351
347
  # @return [ContextDev::Models::MonitorRetrieveChangeResponse]
@@ -360,13 +356,14 @@ module ContextDev
360
356
  )
361
357
  end
362
358
 
363
- # Fetches one run for a monitor, including lifecycle status, timing, credits
364
- # charged, and any detected change.
359
+ # Retrieve the status, timing, and results of one monitor run.
365
360
  #
366
361
  # @overload retrieve_run(run_id, monitor_id:, request_options: {})
367
362
  #
368
- # @param run_id [String]
369
- # @param monitor_id [String]
363
+ # @param run_id [String] ID of the monitor run.
364
+ #
365
+ # @param monitor_id [String] ID of the monitor.
366
+ #
370
367
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
371
368
  #
372
369
  # @return [ContextDev::Models::MonitorRetrieveRunResponse]
@@ -386,13 +383,13 @@ module ContextDev
386
383
  )
387
384
  end
388
385
 
389
- # Generates a new signing secret for the monitor's webhook and returns the updated
390
- # monitor (including the new `webhook.secret`). The previous secret stops signing
391
- # deliveries immediately, so update your endpoint before rotating.
386
+ # Generate and return a new signing secret. It takes effect immediately for all
387
+ # subsequent delivery attempts.
392
388
  #
393
389
  # @overload rotate_webhook_secret(monitor_id, request_options: {})
394
390
  #
395
- # @param monitor_id [String]
391
+ # @param monitor_id [String] ID of the monitor.
392
+ #
396
393
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
397
394
  #
398
395
  # @return [ContextDev::Models::MonitorRotateWebhookSecretResponse]
@@ -407,12 +404,12 @@ module ContextDev
407
404
  )
408
405
  end
409
406
 
410
- # Triggers an immediate run of the monitor outside its normal schedule. The run is
411
- # queued and processed asynchronously.
407
+ # Queue a run without changing the regular schedule. Paused monitors return 409.
412
408
  #
413
409
  # @overload run(monitor_id, request_options: {})
414
410
  #
415
- # @param monitor_id [String]
411
+ # @param monitor_id [String] ID of the monitor.
412
+ #
416
413
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
417
414
  #
418
415
  # @return [ContextDev::Models::MonitorRunResponse]
@@ -2,17 +2,13 @@
2
2
 
3
3
  module ContextDev
4
4
  module Resources
5
- # Search live first-party RSS and free historical news data by company identity.
5
+ # Search live and historical news about a company.
6
6
  class News
7
7
  # Some parameter documentations has been truncated, see
8
8
  # {ContextDev::Models::NewsSearchParams} for more details.
9
9
  #
10
- # Searches live and historical company news for one company, identified in
11
- # searchBy by name, domain, ticker (optionally disambiguated by exchange), or
12
- # ISIN. Results can be filtered by one of publisher domain, publisher country,
13
- # article language, or article type, optionally combined with a published-at date
14
- # range, and include stable story IDs, source metadata, verified entity relevance,
15
- # and cursor pagination.
10
+ # Find company news by name, domain, ticker, or ISIN. Filter articles and continue
11
+ # through results with a cursor.
16
12
  #
17
13
  # @overload search(search_by:, cursor: nil, filter_by: nil, limit: nil, sort_by: nil, tags: nil, request_options: {})
18
14
  #
@@ -26,7 +22,7 @@ module ContextDev
26
22
  #
27
23
  # @param sort_by [ContextDev::Models::NewsSearchParams::SortBy] Result ordering. Defaults to newest.
28
24
  #
29
- # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
25
+ # @param tags [Array<String>] Labels for filtering usage in the dashboard.
30
26
  #
31
27
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
32
28
  #
@@ -6,8 +6,7 @@ module ContextDev
6
6
  # Some parameter documentations has been truncated, see
7
7
  # {ContextDev::Models::ParseHandleParams} for more details.
8
8
  #
9
- # Converts raw text, source code, web/data, PDF, Microsoft Office, and image bytes
10
- # into LLM-usable Markdown.
9
+ # Convert uploaded file bytes into Markdown and optional HTML.
11
10
  #
12
11
  # @overload handle(body:, client: nil, extension: nil, include_images: nil, include_links: nil, ocr: nil, pdf: nil, shorten_base64_images: nil, tags: nil, use_main_content_only: nil, zdr: nil, request_options: {})
13
12
  #
@@ -21,17 +20,17 @@ module ContextDev
21
20
  #
22
21
  # @param include_links [Boolean] Query param: Preserve hyperlinks in Markdown output
23
22
  #
24
- # @param ocr [Boolean] Query param: When true for PDF inputs, OCR the selected pages that have no usabl
23
+ # @param ocr [Boolean] Query param: Read text from images and scanned PDF pages. PDF page ranges still
25
24
  #
26
25
  # @param pdf [ContextDev::Models::ParseHandleParams::Pdf] Query param: PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5
27
26
  #
28
27
  # @param shorten_base64_images [Boolean] Query param: Shorten base64-encoded image data in the Markdown output
29
28
  #
30
- # @param tags [Array<String>] Query param: Comma-separated tags for tracking request usage. Up to 20 tags, eac
29
+ # @param tags [Array<String>] Query param: Comma-separated labels for filtering usage, e.g. `production,team-a
31
30
  #
32
31
  # @param use_main_content_only [Boolean] Query param: Extract only the main content from HTML-like inputs
33
32
  #
34
- # @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] Query param: Set to enabled to bypass shared caches and omit request and respons
33
+ # @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] Query param: `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLE
35
34
  #
36
35
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
37
36
  #
@@ -6,30 +6,28 @@ module ContextDev
6
6
  # Some parameter documentations has been truncated, see
7
7
  # {ContextDev::Models::PersonEnrichParams} for more details.
8
8
  #
9
- # Finds and normalizes the best available person candidate from additive identity
10
- # clues, then assigns an identity match score from 0 to 100. Available on all paid
11
- # plans. Successful requests cost 20 credits. Disposable and free email addresses
12
- # (like gmail.com, yahoo.com) will throw a 422 error.
9
+ # Find a person from identity clues and return their profile with a match score.
10
+ # Requires a paid plan; free or disposable email addresses return 422.
13
11
  #
14
12
  # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
15
13
  #
16
- # @param company [ContextDev::Models::PersonEnrichParams::Company]
14
+ # @param company [ContextDev::Models::PersonEnrichParams::Company] Company context to help identify the person. Provide a name or domain.
17
15
  #
18
- # @param education [Array<ContextDev::Models::PersonEnrichParams::Education>]
16
+ # @param education [Array<ContextDev::Models::PersonEnrichParams::Education>] Education history to help distinguish people with similar names.
19
17
  #
20
- # @param email [String]
18
+ # @param email [String] Email address of the person to find.
21
19
  #
22
- # @param location [ContextDev::Models::PersonEnrichParams::Location]
20
+ # @param location [ContextDev::Models::PersonEnrichParams::Location] Location context to help identify the person. Provide a city, region, or country
23
21
  #
24
- # @param name [ContextDev::Models::PersonEnrichParams::Name]
22
+ # @param name [ContextDev::Models::PersonEnrichParams::Name] Person name. Without an email or person-profile URL, provide both first and last
25
23
  #
26
- # @param social_urls [Array<String>]
24
+ # @param social_urls [Array<String>] Public profile URLs for the person. A person-profile URL can identify the person
27
25
  #
28
- # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
26
+ # @param tags [Array<String>] Labels for filtering usage in the dashboard.
29
27
  #
30
- # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
28
+ # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Request deadline and what to return when it passes.
31
29
  #
32
- # @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
30
+ # @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
33
31
  #
34
32
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
35
33
  #
@@ -3,24 +3,17 @@
3
3
  module ContextDev
4
4
  module Resources
5
5
  class Utility
6
- # Some parameter documentations has been truncated, see
7
- # {ContextDev::Models::UtilityPrefetchParams} for more details.
8
- #
9
- # Signal that you may fetch data soon to improve latency. The type field selects
10
- # what to prefetch ('brand' queues a brand data fetch, 'styleguide' queues a
11
- # styleguide extraction) and identifier carries exactly one lookup key: a domain,
12
- # or an email whose domain is extracted and validated (free email providers and
13
- # disposable email addresses are not allowed).
6
+ # Queue brand or styleguide data so a later lookup can return sooner.
14
7
  #
15
8
  # @overload prefetch(identifier:, type:, tags: nil, timeout_opts: nil, request_options: {})
16
9
  #
17
10
  # @param identifier [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier] Identifier of the target to prefetch. Provide exactly one of domain or email.
18
11
  #
19
- # @param type [Symbol, ContextDev::Models::UtilityPrefetchParams::Type] What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the sty
12
+ # @param type [Symbol, ContextDev::Models::UtilityPrefetchParams::Type] Data to prefetch.
20
13
  #
21
- # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
14
+ # @param tags [Array<String>] Labels for filtering usage in the dashboard.
22
15
  #
23
- # @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
16
+ # @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Request deadline and what to return when it passes.
24
17
  #
25
18
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
26
19
  #