context.dev 2.14.0 → 2.16.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 (221) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +10 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_response.rb +17 -10
  7. data/lib/context_dev/models/ai_extract_products_response.rb +17 -10
  8. data/lib/context_dev/models/batch_cancel_response.rb +14 -5
  9. data/lib/context_dev/models/batch_delete_response.rb +17 -10
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -10
  11. data/lib/context_dev/models/batch_list_response.rb +17 -10
  12. data/lib/context_dev/models/batch_retrieve_response.rb +22 -5
  13. data/lib/context_dev/models/batch_submit_params.rb +34 -3
  14. data/lib/context_dev/models/batch_submit_response.rb +14 -5
  15. data/lib/context_dev/models/brand_retrieve_response.rb +17 -10
  16. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
  17. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +17 -10
  18. data/lib/context_dev/models/brand_search_params.rb +3 -4
  19. data/lib/context_dev/models/brand_search_response.rb +17 -10
  20. data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
  21. data/lib/context_dev/models/industry_retrieve_naics_response.rb +17 -10
  22. data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
  23. data/lib/context_dev/models/industry_retrieve_sic_response.rb +17 -10
  24. data/lib/context_dev/models/log_list_params.rb +108 -0
  25. data/lib/context_dev/models/log_list_response.rb +174 -0
  26. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  27. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  28. data/lib/context_dev/models/monitor_create_params.rb +9 -1
  29. data/lib/context_dev/models/monitor_create_response.rb +9 -1
  30. data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
  31. data/lib/context_dev/models/monitor_list_response.rb +9 -1
  32. data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
  33. data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
  34. data/lib/context_dev/models/monitor_update_params.rb +9 -1
  35. data/lib/context_dev/models/monitor_update_response.rb +9 -1
  36. data/lib/context_dev/models/news_search_response.rb +17 -10
  37. data/lib/context_dev/models/parse_handle_params.rb +3 -4
  38. data/lib/context_dev/models/parse_handle_response.rb +17 -10
  39. data/lib/context_dev/models/person_enrich_response.rb +17 -10
  40. data/lib/context_dev/models/retry_config.rb +22 -0
  41. data/lib/context_dev/models/utility_prefetch_response.rb +17 -10
  42. data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
  43. data/lib/context_dev/models/web_extract_competitors_response.rb +17 -10
  44. data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
  45. data/lib/context_dev/models/web_extract_fonts_response.rb +17 -10
  46. data/lib/context_dev/models/web_extract_response.rb +17 -10
  47. data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
  48. data/lib/context_dev/models/web_extract_styleguide_response.rb +17 -10
  49. data/lib/context_dev/models/web_screenshot_params.rb +5 -5
  50. data/lib/context_dev/models/web_screenshot_response.rb +17 -10
  51. data/lib/context_dev/models/web_search_response.rb +17 -10
  52. data/lib/context_dev/models/web_web_crawl_md_response.rb +17 -10
  53. data/lib/context_dev/models/web_web_scrape_html_params.rb +6 -5
  54. data/lib/context_dev/models/web_web_scrape_html_response.rb +17 -10
  55. data/lib/context_dev/models/web_web_scrape_images_params.rb +6 -5
  56. data/lib/context_dev/models/web_web_scrape_images_response.rb +17 -10
  57. data/lib/context_dev/models/web_web_scrape_md_params.rb +6 -5
  58. data/lib/context_dev/models/web_web_scrape_md_response.rb +17 -10
  59. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +3 -4
  60. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +17 -10
  61. data/lib/context_dev/models/webhook_delivery.rb +9 -1
  62. data/lib/context_dev/models/webhooks/attempt.rb +102 -0
  63. data/lib/context_dev/models/webhooks/delivery.rb +253 -0
  64. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
  65. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +77 -0
  66. data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
  67. data/lib/context_dev/models/webhooks/delivery_list_response.rb +77 -0
  68. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
  69. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +52 -0
  70. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
  71. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +61 -0
  72. data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
  73. data/lib/context_dev/models.rb +8 -0
  74. data/lib/context_dev/resources/batch.rb +4 -2
  75. data/lib/context_dev/resources/brand.rb +2 -2
  76. data/lib/context_dev/resources/industry.rb +2 -2
  77. data/lib/context_dev/resources/logs.rb +83 -0
  78. data/lib/context_dev/resources/parse.rb +1 -1
  79. data/lib/context_dev/resources/web.rb +8 -8
  80. data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
  81. data/lib/context_dev/resources/webhooks.rb +19 -0
  82. data/lib/context_dev/version.rb +1 -1
  83. data/lib/context_dev.rb +19 -0
  84. data/rbi/context_dev/client.rbi +8 -0
  85. data/rbi/context_dev/models/ai_extract_product_response.rbi +17 -10
  86. data/rbi/context_dev/models/ai_extract_products_response.rbi +17 -10
  87. data/rbi/context_dev/models/batch_cancel_response.rbi +14 -4
  88. data/rbi/context_dev/models/batch_delete_response.rbi +17 -10
  89. data/rbi/context_dev/models/batch_get_results_response.rbi +17 -10
  90. data/rbi/context_dev/models/batch_list_response.rbi +17 -10
  91. data/rbi/context_dev/models/batch_retrieve_response.rbi +29 -7
  92. data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
  93. data/rbi/context_dev/models/batch_submit_response.rbi +14 -4
  94. data/rbi/context_dev/models/brand_retrieve_response.rbi +17 -10
  95. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
  96. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +17 -10
  97. data/rbi/context_dev/models/brand_search_params.rbi +4 -6
  98. data/rbi/context_dev/models/brand_search_response.rbi +17 -10
  99. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
  100. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +17 -10
  101. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
  102. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +17 -10
  103. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  104. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  105. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  106. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  107. data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
  108. data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
  109. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
  110. data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
  111. data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
  112. data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
  113. data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
  114. data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
  115. data/rbi/context_dev/models/news_search_response.rbi +17 -10
  116. data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
  117. data/rbi/context_dev/models/parse_handle_response.rbi +17 -10
  118. data/rbi/context_dev/models/person_enrich_response.rbi +17 -10
  119. data/rbi/context_dev/models/retry_config.rbi +35 -0
  120. data/rbi/context_dev/models/utility_prefetch_response.rbi +17 -10
  121. data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
  122. data/rbi/context_dev/models/web_extract_competitors_response.rbi +17 -10
  123. data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
  124. data/rbi/context_dev/models/web_extract_fonts_response.rbi +17 -10
  125. data/rbi/context_dev/models/web_extract_response.rbi +17 -10
  126. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
  127. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +17 -10
  128. data/rbi/context_dev/models/web_screenshot_params.rbi +8 -8
  129. data/rbi/context_dev/models/web_screenshot_response.rbi +17 -10
  130. data/rbi/context_dev/models/web_search_response.rbi +17 -10
  131. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +17 -10
  132. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +10 -8
  133. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +17 -10
  134. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +10 -8
  135. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +17 -10
  136. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +10 -8
  137. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +17 -10
  138. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +4 -6
  139. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +17 -10
  140. data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
  141. data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
  142. data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
  143. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
  144. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +133 -0
  145. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
  146. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +133 -0
  147. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
  148. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +109 -0
  149. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
  150. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +117 -0
  151. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
  152. data/rbi/context_dev/models.rbi +8 -0
  153. data/rbi/context_dev/resources/batch.rbi +6 -1
  154. data/rbi/context_dev/resources/brand.rbi +4 -6
  155. data/rbi/context_dev/resources/industry.rbi +4 -6
  156. data/rbi/context_dev/resources/logs.rbi +76 -0
  157. data/rbi/context_dev/resources/parse.rbi +2 -3
  158. data/rbi/context_dev/resources/web.rbi +27 -28
  159. data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
  160. data/rbi/context_dev/resources/webhooks.rbi +16 -0
  161. data/sig/context_dev/client.rbs +4 -0
  162. data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
  163. data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
  164. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  165. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  166. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  167. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  168. data/sig/context_dev/models/batch_retrieve_response.rbs +15 -3
  169. data/sig/context_dev/models/batch_submit_params.rbs +23 -0
  170. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  171. data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
  172. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
  173. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  174. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
  175. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
  176. data/sig/context_dev/models/log_list_params.rbs +98 -0
  177. data/sig/context_dev/models/log_list_response.rbs +135 -0
  178. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  179. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  180. data/sig/context_dev/models/monitor_create_params.rbs +8 -1
  181. data/sig/context_dev/models/monitor_create_response.rbs +7 -0
  182. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
  183. data/sig/context_dev/models/monitor_list_response.rbs +7 -0
  184. data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
  185. data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
  186. data/sig/context_dev/models/monitor_update_params.rbs +8 -1
  187. data/sig/context_dev/models/monitor_update_response.rbs +7 -0
  188. data/sig/context_dev/models/news_search_response.rbs +5 -0
  189. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  190. data/sig/context_dev/models/person_enrich_response.rbs +5 -0
  191. data/sig/context_dev/models/retry_config.rbs +15 -0
  192. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  193. data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
  194. data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
  195. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  196. data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
  197. data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
  198. data/sig/context_dev/models/web_search_response.rbs +5 -0
  199. data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
  200. data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
  201. data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
  202. data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
  203. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
  204. data/sig/context_dev/models/webhook_delivery.rbs +10 -3
  205. data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
  206. data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
  207. data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
  208. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +65 -0
  209. data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
  210. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +65 -0
  211. data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
  212. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +52 -0
  213. data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
  214. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +55 -0
  215. data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
  216. data/sig/context_dev/models.rbs +8 -0
  217. data/sig/context_dev/resources/batch.rbs +1 -0
  218. data/sig/context_dev/resources/logs.rbs +27 -0
  219. data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
  220. data/sig/context_dev/resources/webhooks.rbs +9 -0
  221. metadata +59 -2
@@ -39,6 +39,11 @@ module ContextDev
39
39
  end
40
40
  attr_writer :metadata
41
41
 
42
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
43
+ # it when contacting support about a failed request.
44
+ sig { returns(String) }
45
+ attr_accessor :request_id
46
+
42
47
  # Status of the response, e.g., 'ok'
43
48
  sig { returns(String) }
44
49
  attr_accessor :status
@@ -51,8 +56,7 @@ module ContextDev
51
56
  sig { returns(T::Array[String]) }
52
57
  attr_accessor :urls_analyzed
53
58
 
54
- # Metadata about the API key used for the request. Included in every response
55
- # whenever a valid API key is provided, even when the response status is not 200.
59
+ # Credit usage, included whenever a valid API key is provided.
56
60
  sig do
57
61
  returns(T.nilable(ContextDev::Models::WebExtractResponse::KeyMetadata))
58
62
  end
@@ -72,6 +76,7 @@ module ContextDev
72
76
  ContextDev::Models::WebExtractResponse::CacheMetadata::OrHash,
73
77
  data: T::Hash[Symbol, T.anything],
74
78
  metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash,
79
+ request_id: String,
75
80
  status: String,
76
81
  url: String,
77
82
  urls_analyzed: T::Array[String],
@@ -87,14 +92,16 @@ module ContextDev
87
92
  # Extracted data matching the request schema
88
93
  data:,
89
94
  metadata:,
95
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
96
+ # it when contacting support about a failed request.
97
+ request_id:,
90
98
  # Status of the response, e.g., 'ok'
91
99
  status:,
92
100
  # The starting URL that was analyzed
93
101
  url:,
94
102
  # List of URLs whose Markdown was used for extraction
95
103
  urls_analyzed:,
96
- # Metadata about the API key used for the request. Included in every response
97
- # whenever a valid API key is provided, even when the response status is not 200.
104
+ # Credit usage, included whenever a valid API key is provided.
98
105
  key_metadata: nil
99
106
  )
100
107
  end
@@ -106,6 +113,7 @@ module ContextDev
106
113
  ContextDev::Models::WebExtractResponse::CacheMetadata,
107
114
  data: T::Hash[Symbol, T.anything],
108
115
  metadata: ContextDev::Models::WebExtractResponse::Metadata,
116
+ request_id: String,
109
117
  status: String,
110
118
  url: String,
111
119
  urls_analyzed: T::Array[String],
@@ -456,25 +464,24 @@ module ContextDev
456
464
  )
457
465
  end
458
466
 
459
- # The number of credits consumed by this request.
467
+ # Credits used by this request.
460
468
  sig { returns(Integer) }
461
469
  attr_accessor :credits_consumed
462
470
 
463
- # The number of credits remaining for your organization after this request.
471
+ # Credits remaining for your organization.
464
472
  sig { returns(Integer) }
465
473
  attr_accessor :credits_remaining
466
474
 
467
- # Metadata about the API key used for the request. Included in every response
468
- # whenever a valid API key is provided, even when the response status is not 200.
475
+ # Credit usage, included whenever a valid API key is provided.
469
476
  sig do
470
477
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
471
478
  T.attached_class
472
479
  )
473
480
  end
474
481
  def self.new(
475
- # The number of credits consumed by this request.
482
+ # Credits used by this request.
476
483
  credits_consumed:,
477
- # The number of credits remaining for your organization after this request.
484
+ # Credits remaining for your organization.
478
485
  credits_remaining:
479
486
  )
480
487
  end
@@ -59,9 +59,8 @@ module ContextDev
59
59
  sig { returns(T.nilable(Integer)) }
60
60
  attr_accessor :max_age_ms
61
61
 
62
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
63
- # recorded on the request's usage log and can be used to filter usage on the
64
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
62
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
63
+ # characters.
65
64
  sig { returns(T.nilable(T::Array[String])) }
66
65
  attr_reader :tags
67
66
 
@@ -107,9 +106,8 @@ module ContextDev
107
106
  # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
108
107
  # year.
109
108
  max_age_ms: nil,
110
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
111
- # recorded on the request's usage log and can be used to filter usage on the
112
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
109
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
110
+ # characters.
113
111
  tags: nil,
114
112
  # Optional timeout in milliseconds for the request. If the request takes longer
115
113
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -27,6 +27,11 @@ module ContextDev
27
27
  end
28
28
  attr_writer :cache_metadata
29
29
 
30
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
31
+ # it when contacting support about a failed request.
32
+ sig { returns(String) }
33
+ attr_accessor :request_id
34
+
30
35
  # HTTP status code
31
36
  sig { returns(T.nilable(Integer)) }
32
37
  attr_reader :code
@@ -41,8 +46,7 @@ module ContextDev
41
46
  sig { params(domain: String).void }
42
47
  attr_writer :domain
43
48
 
44
- # Metadata about the API key used for the request. Included in every response
45
- # whenever a valid API key is provided, even when the response status is not 200.
49
+ # Credit usage, included whenever a valid API key is provided.
46
50
  sig do
47
51
  returns(
48
52
  T.nilable(
@@ -89,6 +93,7 @@ module ContextDev
89
93
  params(
90
94
  cache_metadata:
91
95
  ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::OrHash,
96
+ request_id: String,
92
97
  code: Integer,
93
98
  domain: String,
94
99
  key_metadata:
@@ -103,12 +108,14 @@ module ContextDev
103
108
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
104
109
  # oldest contributing hit.
105
110
  cache_metadata:,
111
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
112
+ # it when contacting support about a failed request.
113
+ request_id:,
106
114
  # HTTP status code
107
115
  code: nil,
108
116
  # The normalized domain that was processed
109
117
  domain: nil,
110
- # Metadata about the API key used for the request. Included in every response
111
- # whenever a valid API key is provided, even when the response status is not 200.
118
+ # Credit usage, included whenever a valid API key is provided.
112
119
  key_metadata: nil,
113
120
  # Status of the response, e.g., 'ok'
114
121
  status: nil,
@@ -122,6 +129,7 @@ module ContextDev
122
129
  {
123
130
  cache_metadata:
124
131
  ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata,
132
+ request_id: String,
125
133
  code: Integer,
126
134
  domain: String,
127
135
  key_metadata:
@@ -239,25 +247,24 @@ module ContextDev
239
247
  )
240
248
  end
241
249
 
242
- # The number of credits consumed by this request.
250
+ # Credits used by this request.
243
251
  sig { returns(Integer) }
244
252
  attr_accessor :credits_consumed
245
253
 
246
- # The number of credits remaining for your organization after this request.
254
+ # Credits remaining for your organization.
247
255
  sig { returns(Integer) }
248
256
  attr_accessor :credits_remaining
249
257
 
250
- # Metadata about the API key used for the request. Included in every response
251
- # whenever a valid API key is provided, even when the response status is not 200.
258
+ # Credit usage, included whenever a valid API key is provided.
252
259
  sig do
253
260
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
254
261
  T.attached_class
255
262
  )
256
263
  end
257
264
  def self.new(
258
- # The number of credits consumed by this request.
265
+ # Credits used by this request.
259
266
  credits_consumed:,
260
- # The number of credits remaining for your organization after this request.
267
+ # Credits remaining for your organization.
261
268
  credits_remaining:
262
269
  )
263
270
  end
@@ -123,9 +123,8 @@ module ContextDev
123
123
  sig { returns(T.nilable(Integer)) }
124
124
  attr_accessor :scroll_offset
125
125
 
126
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
127
- # recorded on the request's usage log and can be used to filter usage on the
128
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
126
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
127
+ # characters.
129
128
  sig { returns(T.nilable(T::Array[String])) }
130
129
  attr_reader :tags
131
130
 
@@ -152,7 +151,8 @@ module ContextDev
152
151
 
153
152
  # Optional browser wait time in milliseconds after initial page load before taking
154
153
  # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
155
- # omitted.
154
+ # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
155
+ # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
156
156
  sig { returns(T.nilable(Integer)) }
157
157
  attr_accessor :wait_for_ms
158
158
 
@@ -233,9 +233,8 @@ module ContextDev
233
233
  # top to bottom). The final slice may be shorter than the viewport height. Takes
234
234
  # precedence over fullScreenshot. Max: 100000.
235
235
  scroll_offset: nil,
236
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
237
- # recorded on the request's usage log and can be used to filter usage on the
238
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
236
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
237
+ # characters.
239
238
  tags: nil,
240
239
  # Optional timeout in milliseconds for the request. If the request takes longer
241
240
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -245,7 +244,8 @@ module ContextDev
245
244
  viewport: nil,
246
245
  # Optional browser wait time in milliseconds after initial page load before taking
247
246
  # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
248
- # omitted.
247
+ # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
248
+ # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
249
249
  wait_for_ms: nil,
250
250
  # Set to enabled to bypass shared caches and omit request and response content
251
251
  # from retained usage logs. Requires zero data retention to be enabled for your
@@ -25,6 +25,11 @@ module ContextDev
25
25
  end
26
26
  attr_writer :cache_metadata
27
27
 
28
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
29
+ # it when contacting support about a failed request.
30
+ sig { returns(String) }
31
+ attr_accessor :request_id
32
+
28
33
  # HTTP status code
29
34
  sig { returns(T.nilable(Integer)) }
30
35
  attr_reader :code
@@ -46,8 +51,7 @@ module ContextDev
46
51
  sig { params(height: Integer).void }
47
52
  attr_writer :height
48
53
 
49
- # Metadata about the API key used for the request. Included in every response
50
- # whenever a valid API key is provided, even when the response status is not 200.
54
+ # Credit usage, included whenever a valid API key is provided.
51
55
  sig do
52
56
  returns(
53
57
  T.nilable(ContextDev::Models::WebScreenshotResponse::KeyMetadata)
@@ -107,6 +111,7 @@ module ContextDev
107
111
  params(
108
112
  cache_metadata:
109
113
  ContextDev::Models::WebScreenshotResponse::CacheMetadata::OrHash,
114
+ request_id: String,
110
115
  code: Integer,
111
116
  domain: String,
112
117
  height: Integer,
@@ -124,14 +129,16 @@ module ContextDev
124
129
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
125
130
  # oldest contributing hit.
126
131
  cache_metadata:,
132
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
133
+ # it when contacting support about a failed request.
134
+ request_id:,
127
135
  # HTTP status code
128
136
  code: nil,
129
137
  # The normalized domain that was processed
130
138
  domain: nil,
131
139
  # Height in pixels of the returned screenshot image
132
140
  height: nil,
133
- # Metadata about the API key used for the request. Included in every response
134
- # whenever a valid API key is provided, even when the response status is not 200.
141
+ # Credit usage, included whenever a valid API key is provided.
135
142
  key_metadata: nil,
136
143
  # Public image URL for standard requests, or an in-memory data URL when ZDR is
137
144
  # enabled.
@@ -150,6 +157,7 @@ module ContextDev
150
157
  {
151
158
  cache_metadata:
152
159
  ContextDev::Models::WebScreenshotResponse::CacheMetadata,
160
+ request_id: String,
153
161
  code: Integer,
154
162
  domain: String,
155
163
  height: Integer,
@@ -270,25 +278,24 @@ module ContextDev
270
278
  )
271
279
  end
272
280
 
273
- # The number of credits consumed by this request.
281
+ # Credits used by this request.
274
282
  sig { returns(Integer) }
275
283
  attr_accessor :credits_consumed
276
284
 
277
- # The number of credits remaining for your organization after this request.
285
+ # Credits remaining for your organization.
278
286
  sig { returns(Integer) }
279
287
  attr_accessor :credits_remaining
280
288
 
281
- # Metadata about the API key used for the request. Included in every response
282
- # whenever a valid API key is provided, even when the response status is not 200.
289
+ # Credit usage, included whenever a valid API key is provided.
283
290
  sig do
284
291
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
285
292
  T.attached_class
286
293
  )
287
294
  end
288
295
  def self.new(
289
- # The number of credits consumed by this request.
296
+ # Credits used by this request.
290
297
  credits_consumed:,
291
- # The number of credits remaining for your organization after this request.
298
+ # Credits remaining for your organization.
292
299
  credits_remaining:
293
300
  )
294
301
  end
@@ -29,11 +29,15 @@ module ContextDev
29
29
  sig { returns(String) }
30
30
  attr_accessor :query
31
31
 
32
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ # it when contacting support about a failed request.
34
+ sig { returns(String) }
35
+ attr_accessor :request_id
36
+
32
37
  sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
33
38
  attr_accessor :results
34
39
 
35
- # Metadata about the API key used for the request. Included in every response
36
- # whenever a valid API key is provided, even when the response status is not 200.
40
+ # Credit usage, included whenever a valid API key is provided.
37
41
  sig do
38
42
  returns(T.nilable(ContextDev::Models::WebSearchResponse::KeyMetadata))
39
43
  end
@@ -52,6 +56,7 @@ module ContextDev
52
56
  cache_metadata:
53
57
  ContextDev::Models::WebSearchResponse::CacheMetadata::OrHash,
54
58
  query: String,
59
+ request_id: String,
55
60
  results:
56
61
  T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash],
57
62
  key_metadata:
@@ -65,9 +70,11 @@ module ContextDev
65
70
  cache_metadata:,
66
71
  # Echo of the original query (useful when fanout was enabled).
67
72
  query:,
73
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
74
+ # it when contacting support about a failed request.
75
+ request_id:,
68
76
  results:,
69
- # Metadata about the API key used for the request. Included in every response
70
- # whenever a valid API key is provided, even when the response status is not 200.
77
+ # Credit usage, included whenever a valid API key is provided.
71
78
  key_metadata: nil
72
79
  )
73
80
  end
@@ -78,6 +85,7 @@ module ContextDev
78
85
  cache_metadata:
79
86
  ContextDev::Models::WebSearchResponse::CacheMetadata,
80
87
  query: String,
88
+ request_id: String,
81
89
  results: T::Array[ContextDev::Models::WebSearchResponse::Result],
82
90
  key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata
83
91
  }
@@ -419,25 +427,24 @@ module ContextDev
419
427
  )
420
428
  end
421
429
 
422
- # The number of credits consumed by this request.
430
+ # Credits used by this request.
423
431
  sig { returns(Integer) }
424
432
  attr_accessor :credits_consumed
425
433
 
426
- # The number of credits remaining for your organization after this request.
434
+ # Credits remaining for your organization.
427
435
  sig { returns(Integer) }
428
436
  attr_accessor :credits_remaining
429
437
 
430
- # Metadata about the API key used for the request. Included in every response
431
- # whenever a valid API key is provided, even when the response status is not 200.
438
+ # Credit usage, included whenever a valid API key is provided.
432
439
  sig do
433
440
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
434
441
  T.attached_class
435
442
  )
436
443
  end
437
444
  def self.new(
438
- # The number of credits consumed by this request.
445
+ # Credits used by this request.
439
446
  credits_consumed:,
440
- # The number of credits remaining for your organization after this request.
447
+ # Credits remaining for your organization.
441
448
  credits_remaining:
442
449
  )
443
450
  end
@@ -35,13 +35,17 @@ module ContextDev
35
35
  end
36
36
  attr_writer :metadata
37
37
 
38
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
39
+ # it when contacting support about a failed request.
40
+ sig { returns(String) }
41
+ attr_accessor :request_id
42
+
38
43
  sig do
39
44
  returns(T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result])
40
45
  end
41
46
  attr_accessor :results
42
47
 
43
- # Metadata about the API key used for the request. Included in every response
44
- # whenever a valid API key is provided, even when the response status is not 200.
48
+ # Credit usage, included whenever a valid API key is provided.
45
49
  sig do
46
50
  returns(
47
51
  T.nilable(ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata)
@@ -62,6 +66,7 @@ module ContextDev
62
66
  cache_metadata:
63
67
  ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata::OrHash,
64
68
  metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash,
69
+ request_id: String,
65
70
  results:
66
71
  T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash],
67
72
  key_metadata:
@@ -74,9 +79,11 @@ module ContextDev
74
79
  # oldest contributing hit.
75
80
  cache_metadata:,
76
81
  metadata:,
82
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
83
+ # it when contacting support about a failed request.
84
+ request_id:,
77
85
  results:,
78
- # Metadata about the API key used for the request. Included in every response
79
- # whenever a valid API key is provided, even when the response status is not 200.
86
+ # Credit usage, included whenever a valid API key is provided.
80
87
  key_metadata: nil
81
88
  )
82
89
  end
@@ -87,6 +94,7 @@ module ContextDev
87
94
  cache_metadata:
88
95
  ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata,
89
96
  metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata,
97
+ request_id: String,
90
98
  results:
91
99
  T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result],
92
100
  key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata
@@ -875,25 +883,24 @@ module ContextDev
875
883
  )
876
884
  end
877
885
 
878
- # The number of credits consumed by this request.
886
+ # Credits used by this request.
879
887
  sig { returns(Integer) }
880
888
  attr_accessor :credits_consumed
881
889
 
882
- # The number of credits remaining for your organization after this request.
890
+ # Credits remaining for your organization.
883
891
  sig { returns(Integer) }
884
892
  attr_accessor :credits_remaining
885
893
 
886
- # Metadata about the API key used for the request. Included in every response
887
- # whenever a valid API key is provided, even when the response status is not 200.
894
+ # Credit usage, included whenever a valid API key is provided.
888
895
  sig do
889
896
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
890
897
  T.attached_class
891
898
  )
892
899
  end
893
900
  def self.new(
894
- # The number of credits consumed by this request.
901
+ # Credits used by this request.
895
902
  credits_consumed:,
896
- # The number of credits remaining for your organization after this request.
903
+ # Credits remaining for your organization.
897
904
  credits_remaining:
898
905
  )
899
906
  end
@@ -103,9 +103,8 @@ module ContextDev
103
103
  sig { params(settle_animations: T::Boolean).void }
104
104
  attr_writer :settle_animations
105
105
 
106
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
107
- # recorded on the request's usage log and can be used to filter usage on the
108
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
106
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
107
+ # characters.
109
108
  sig { returns(T.nilable(T::Array[String])) }
110
109
  attr_reader :tags
111
110
 
@@ -130,7 +129,9 @@ module ContextDev
130
129
  attr_writer :use_main_content_only
131
130
 
132
131
  # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
133
- # 30000 (30 seconds).
132
+ # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
133
+ # waitForMs + 10000 ms; a shorter deadline is rejected with 400
134
+ # TIMEOUT_TOO_SHORT_FOR_WAIT.
134
135
  sig { returns(T.nilable(Integer)) }
135
136
  attr_accessor :wait_for_ms
136
137
 
@@ -212,9 +213,8 @@ module ContextDev
212
213
  # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
213
214
  # more stable output on animated pages.
214
215
  settle_animations: nil,
215
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
216
- # recorded on the request's usage log and can be used to filter usage on the
217
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
216
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
217
+ # characters.
218
218
  tags: nil,
219
219
  # Optional timeout in milliseconds for the request. If the request takes longer
220
220
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -224,7 +224,9 @@ module ContextDev
224
224
  # headers, footers, sidebars, and navigation when detectable.
225
225
  use_main_content_only: nil,
226
226
  # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
227
- # 30000 (30 seconds).
227
+ # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
228
+ # waitForMs + 10000 ms; a shorter deadline is rejected with 400
229
+ # TIMEOUT_TOO_SHORT_FOR_WAIT.
228
230
  wait_for_ms: nil,
229
231
  # Set to enabled to bypass shared caches and omit request and response content
230
232
  # from retained usage logs. Requires zero data retention to be enabled for your
@@ -45,6 +45,11 @@ module ContextDev
45
45
  end
46
46
  attr_writer :metadata
47
47
 
48
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
49
+ # it when contacting support about a failed request.
50
+ sig { returns(String) }
51
+ attr_accessor :request_id
52
+
48
53
  # Indicates success
49
54
  sig do
50
55
  returns(
@@ -98,8 +103,7 @@ module ContextDev
98
103
  sig { params(actions_html_stale: T::Boolean).void }
99
104
  attr_writer :actions_html_stale
100
105
 
101
- # Metadata about the API key used for the request. Included in every response
102
- # whenever a valid API key is provided, even when the response status is not 200.
106
+ # Credit usage, included whenever a valid API key is provided.
103
107
  sig do
104
108
  returns(
105
109
  T.nilable(ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata)
@@ -122,6 +126,7 @@ module ContextDev
122
126
  html: String,
123
127
  metadata:
124
128
  ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::OrHash,
129
+ request_id: String,
125
130
  success:
126
131
  ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean,
127
132
  type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::OrSymbol,
@@ -146,6 +151,9 @@ module ContextDev
146
151
  html:,
147
152
  # Metadata extracted from the scraped page HTML.
148
153
  metadata:,
154
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
155
+ # it when contacting support about a failed request.
156
+ request_id:,
149
157
  # Indicates success
150
158
  success:,
151
159
  # Detected content type of the returned `html` field. Sitemaps and feeds are
@@ -160,8 +168,7 @@ module ContextDev
160
168
  # True when an action was applied but the returned content could not be refreshed
161
169
  # afterward.
162
170
  actions_html_stale: nil,
163
- # Metadata about the API key used for the request. Included in every response
164
- # whenever a valid API key is provided, even when the response status is not 200.
171
+ # Credit usage, included whenever a valid API key is provided.
165
172
  key_metadata: nil
166
173
  )
167
174
  end
@@ -173,6 +180,7 @@ module ContextDev
173
180
  ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata,
174
181
  html: String,
175
182
  metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata,
183
+ request_id: String,
176
184
  success:
177
185
  ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean,
178
186
  type:
@@ -1080,25 +1088,24 @@ module ContextDev
1080
1088
  )
1081
1089
  end
1082
1090
 
1083
- # The number of credits consumed by this request.
1091
+ # Credits used by this request.
1084
1092
  sig { returns(Integer) }
1085
1093
  attr_accessor :credits_consumed
1086
1094
 
1087
- # The number of credits remaining for your organization after this request.
1095
+ # Credits remaining for your organization.
1088
1096
  sig { returns(Integer) }
1089
1097
  attr_accessor :credits_remaining
1090
1098
 
1091
- # Metadata about the API key used for the request. Included in every response
1092
- # whenever a valid API key is provided, even when the response status is not 200.
1099
+ # Credit usage, included whenever a valid API key is provided.
1093
1100
  sig do
1094
1101
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
1095
1102
  T.attached_class
1096
1103
  )
1097
1104
  end
1098
1105
  def self.new(
1099
- # The number of credits consumed by this request.
1106
+ # Credits used by this request.
1100
1107
  credits_consumed:,
1101
- # The number of credits remaining for your organization after this request.
1108
+ # Credits remaining for your organization.
1102
1109
  credits_remaining:
1103
1110
  )
1104
1111
  end
@@ -75,9 +75,8 @@ module ContextDev
75
75
  sig { returns(T.nilable(Integer)) }
76
76
  attr_accessor :max_age_ms
77
77
 
78
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
79
- # recorded on the request's usage log and can be used to filter usage on the
80
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
78
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
79
+ # characters.
81
80
  sig { returns(T.nilable(T::Array[String])) }
82
81
  attr_reader :tags
83
82
 
@@ -94,7 +93,9 @@ module ContextDev
94
93
  attr_writer :timeout_ms
95
94
 
96
95
  # Optional browser wait time in milliseconds after initial page load before
97
- # collecting images. Min: 0. Max: 30000 (30 seconds).
96
+ # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
97
+ # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
98
+ # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
98
99
  sig { returns(T.nilable(Integer)) }
99
100
  attr_accessor :wait_for_ms
100
101
 
@@ -144,16 +145,17 @@ module ContextDev
144
145
  # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
145
146
  # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
146
147
  max_age_ms: nil,
147
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
148
- # recorded on the request's usage log and can be used to filter usage on the
149
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
148
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
149
+ # characters.
150
150
  tags: nil,
151
151
  # Optional timeout in milliseconds for the request. If the request takes longer
152
152
  # than this value, it will be aborted with a 408 status code. Maximum allowed
153
153
  # value is 300000ms (5 minutes).
154
154
  timeout_ms: nil,
155
155
  # Optional browser wait time in milliseconds after initial page load before
156
- # collecting images. Min: 0. Max: 30000 (30 seconds).
156
+ # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
157
+ # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
158
+ # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
157
159
  wait_for_ms: nil,
158
160
  request_options: {}
159
161
  )