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
@@ -111,9 +111,8 @@ module ContextDev
111
111
  optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
112
112
 
113
113
  # @!attribute tags
114
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
115
- # recorded on the request's usage log and can be used to filter usage on the
116
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
114
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
115
+ # characters.
117
116
  #
118
117
  # @return [Array<String>, nil]
119
118
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -135,7 +134,9 @@ module ContextDev
135
134
 
136
135
  # @!attribute wait_for_ms
137
136
  # Optional browser wait time in milliseconds after initial page load before
138
- # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds).
137
+ # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
138
+ # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
139
+ # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
139
140
  #
140
141
  # @return [Integer, nil]
141
142
  optional :wait_for_ms, Integer, nil?: true
@@ -181,7 +182,7 @@ module ContextDev
181
182
  #
182
183
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
183
184
  #
184
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
185
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
185
186
  #
186
187
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
187
188
  #
@@ -32,6 +32,13 @@ module ContextDev
32
32
  # @return [ContextDev::Models::WebWebScrapeMdResponse::Metadata]
33
33
  required :metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::Metadata }
34
34
 
35
+ # @!attribute request_id
36
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
37
+ # it when contacting support about a failed request.
38
+ #
39
+ # @return [String]
40
+ required :request_id, String
41
+
35
42
  # @!attribute success
36
43
  # Indicates success
37
44
  #
@@ -68,13 +75,12 @@ module ContextDev
68
75
  optional :html, String
69
76
 
70
77
  # @!attribute key_metadata
71
- # Metadata about the API key used for the request. Included in every response
72
- # whenever a valid API key is provided, even when the response status is not 200.
78
+ # Credit usage, included whenever a valid API key is provided.
73
79
  #
74
80
  # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
75
81
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
76
82
 
77
- # @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
83
+ # @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, request_id:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
78
84
  # Some parameter documentations has been truncated, see
79
85
  # {ContextDev::Models::WebWebScrapeMdResponse} for more details.
80
86
  #
@@ -86,6 +92,8 @@ module ContextDev
86
92
  #
87
93
  # @param metadata [ContextDev::Models::WebWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML.
88
94
  #
95
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
96
+ #
89
97
  # @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success
90
98
  #
91
99
  # @param url [String] The URL that was scraped
@@ -96,7 +104,7 @@ module ContextDev
96
104
  #
97
105
  # @param html [String] Only present when includeHTML=true: the page HTML the Markdown was converted fro
98
106
  #
99
- # @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
107
+ # @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
100
108
 
101
109
  # @see ContextDev::Models::WebWebScrapeMdResponse#cache_metadata
102
110
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -505,24 +513,23 @@ module ContextDev
505
513
  # @see ContextDev::Models::WebWebScrapeMdResponse#key_metadata
506
514
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
507
515
  # @!attribute credits_consumed
508
- # The number of credits consumed by this request.
516
+ # Credits used by this request.
509
517
  #
510
518
  # @return [Integer]
511
519
  required :credits_consumed, Integer
512
520
 
513
521
  # @!attribute credits_remaining
514
- # The number of credits remaining for your organization after this request.
522
+ # Credits remaining for your organization.
515
523
  #
516
524
  # @return [Integer]
517
525
  required :credits_remaining, Integer
518
526
 
519
527
  # @!method initialize(credits_consumed:, credits_remaining:)
520
- # Metadata about the API key used for the request. Included in every response
521
- # whenever a valid API key is provided, even when the response status is not 200.
528
+ # Credit usage, included whenever a valid API key is provided.
522
529
  #
523
- # @param credits_consumed [Integer] The number of credits consumed by this request.
530
+ # @param credits_consumed [Integer] Credits used by this request.
524
531
  #
525
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
532
+ # @param credits_remaining [Integer] Credits remaining for your organization.
526
533
  end
527
534
  end
528
535
  end
@@ -51,9 +51,8 @@ module ContextDev
51
51
  optional :sitemap_url, String
52
52
 
53
53
  # @!attribute tags
54
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
55
- # recorded on the request's usage log and can be used to filter usage on the
56
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
54
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
55
+ # characters.
57
56
  #
58
57
  # @return [Array<String>, nil]
59
58
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -98,7 +97,7 @@ module ContextDev
98
97
  #
99
98
  # @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
100
99
  #
101
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
100
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
102
101
  #
103
102
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
104
103
  #
@@ -16,6 +16,13 @@ module ContextDev
16
16
  # @return [ContextDev::Models::WebWebScrapeSitemapResponse::Meta]
17
17
  required :meta, -> { ContextDev::Models::WebWebScrapeSitemapResponse::Meta }
18
18
 
19
+ # @!attribute request_id
20
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
21
+ # it when contacting support about a failed request.
22
+ #
23
+ # @return [String]
24
+ required :request_id, String
25
+
19
26
  # @!attribute success
20
27
  # Indicates success
21
28
  #
@@ -30,13 +37,12 @@ module ContextDev
30
37
  required :urls, ContextDev::Internal::Type::ArrayOf[String]
31
38
 
32
39
  # @!attribute key_metadata
33
- # Metadata about the API key used for the request. Included in every response
34
- # 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.
35
41
  #
36
42
  # @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
37
43
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
38
44
 
39
- # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil)
45
+ # @!method initialize(domain:, meta:, request_id:, success:, urls:, key_metadata: nil)
40
46
  # Some parameter documentations has been truncated, see
41
47
  # {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
42
48
  #
@@ -44,11 +50,13 @@ module ContextDev
44
50
  #
45
51
  # @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
46
52
  #
53
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
54
+ #
47
55
  # @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success
48
56
  #
49
57
  # @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
50
58
  #
51
- # @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
59
+ # @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
52
60
 
53
61
  # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
54
62
  class Meta < ContextDev::Internal::Type::BaseModel
@@ -103,24 +111,23 @@ module ContextDev
103
111
  # @see ContextDev::Models::WebWebScrapeSitemapResponse#key_metadata
104
112
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
105
113
  # @!attribute credits_consumed
106
- # The number of credits consumed by this request.
114
+ # Credits used by this request.
107
115
  #
108
116
  # @return [Integer]
109
117
  required :credits_consumed, Integer
110
118
 
111
119
  # @!attribute credits_remaining
112
- # The number of credits remaining for your organization after this request.
120
+ # Credits remaining for your organization.
113
121
  #
114
122
  # @return [Integer]
115
123
  required :credits_remaining, Integer
116
124
 
117
125
  # @!method initialize(credits_consumed:, credits_remaining:)
118
- # Metadata about the API key used for the request. Included in every response
119
- # whenever a valid API key is provided, even when the response status is not 200.
126
+ # Credit usage, included whenever a valid API key is provided.
120
127
  #
121
- # @param credits_consumed [Integer] The number of credits consumed by this request.
128
+ # @param credits_consumed [Integer] Credits used by this request.
122
129
  #
123
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
130
+ # @param credits_remaining [Integer] Credits remaining for your organization.
124
131
  end
125
132
  end
126
133
  end
@@ -41,7 +41,13 @@ module ContextDev
41
41
  # @return [Symbol, ContextDev::Models::WebhookDelivery::Status]
42
42
  required :status, enum: -> { ContextDev::WebhookDelivery::Status }
43
43
 
44
- # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:)
44
+ # @!attribute delivery_id
45
+ # Delivery ID for status checks and retries, when available.
46
+ #
47
+ # @return [String, nil]
48
+ optional :delivery_id, String
49
+
50
+ # @!method initialize(attempted_at:, error:, event:, event_id:, http_status:, status:, delivery_id: nil)
45
51
  # Some parameter documentations has been truncated, see
46
52
  # {ContextDev::Models::WebhookDelivery} for more details.
47
53
  #
@@ -56,6 +62,8 @@ module ContextDev
56
62
  # @param http_status [Integer, nil] The endpoint's final HTTP response status, or null when no response was received
57
63
  #
58
64
  # @param status [Symbol, ContextDev::Models::WebhookDelivery::Status] Delivery outcome. delivered means any 2xx response; rejected means a non-2xx res
65
+ #
66
+ # @param delivery_id [String] Delivery ID for status checks and retries, when available.
59
67
 
60
68
  # @see ContextDev::Models::WebhookDelivery#error
61
69
  class Error < ContextDev::Internal::Type::BaseModel
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ module Webhooks
6
+ class Attempt < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute attempt
8
+ # Attempt number, starting at 1.
9
+ #
10
+ # @return [Integer]
11
+ required :attempt, Integer
12
+
13
+ # @!attribute completed_at
14
+ # Completion time, or null while in progress.
15
+ #
16
+ # @return [Time, nil]
17
+ required :completed_at, Time, nil?: true
18
+
19
+ # @!attribute error
20
+ # Attempt error, or null if none.
21
+ #
22
+ # @return [ContextDev::Models::Webhooks::Attempt::Error, nil]
23
+ required :error, -> { ContextDev::Webhooks::Attempt::Error }, nil?: true
24
+
25
+ # @!attribute http_status
26
+ # HTTP response status, or null if no response was received.
27
+ #
28
+ # @return [Integer, nil]
29
+ required :http_status, Integer, nil?: true
30
+
31
+ # @!attribute started_at
32
+ # Attempt start time.
33
+ #
34
+ # @return [Time]
35
+ required :started_at, Time
36
+
37
+ # @!attribute trigger
38
+ # What started this attempt.
39
+ #
40
+ # @return [Symbol, ContextDev::Models::Webhooks::Attempt::Trigger]
41
+ required :trigger, enum: -> { ContextDev::Webhooks::Attempt::Trigger }
42
+
43
+ # @!attribute url
44
+ # URL used for this attempt.
45
+ #
46
+ # @return [String]
47
+ required :url, String
48
+
49
+ # @!method initialize(attempt:, completed_at:, error:, http_status:, started_at:, trigger:, url:)
50
+ # @param attempt [Integer] Attempt number, starting at 1.
51
+ #
52
+ # @param completed_at [Time, nil] Completion time, or null while in progress.
53
+ #
54
+ # @param error [ContextDev::Models::Webhooks::Attempt::Error, nil] Attempt error, or null if none.
55
+ #
56
+ # @param http_status [Integer, nil] HTTP response status, or null if no response was received.
57
+ #
58
+ # @param started_at [Time] Attempt start time.
59
+ #
60
+ # @param trigger [Symbol, ContextDev::Models::Webhooks::Attempt::Trigger] What started this attempt.
61
+ #
62
+ # @param url [String] URL used for this attempt.
63
+
64
+ # @see ContextDev::Models::Webhooks::Attempt#error
65
+ class Error < ContextDev::Internal::Type::BaseModel
66
+ # @!attribute code
67
+ # Error code.
68
+ #
69
+ # @return [String]
70
+ required :code, String
71
+
72
+ # @!attribute message
73
+ # Error details.
74
+ #
75
+ # @return [String]
76
+ required :message, String
77
+
78
+ # @!method initialize(code:, message:)
79
+ # Attempt error, or null if none.
80
+ #
81
+ # @param code [String] Error code.
82
+ #
83
+ # @param message [String] Error details.
84
+ end
85
+
86
+ # What started this attempt.
87
+ #
88
+ # @see ContextDev::Models::Webhooks::Attempt#trigger
89
+ module Trigger
90
+ extend ContextDev::Internal::Type::Enum
91
+
92
+ INITIAL = :initial
93
+ AUTOMATIC = :automatic
94
+ MANUAL = :manual
95
+
96
+ # @!method self.values
97
+ # @return [Array<Symbol>]
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,253 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ module Webhooks
6
+ class Delivery < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # Delivery ID.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # Event creation time.
15
+ #
16
+ # @return [Time]
17
+ required :created_at, Time
18
+
19
+ # @!attribute delivered_at
20
+ # Last successful delivery time, or null if never delivered.
21
+ #
22
+ # @return [Time, nil]
23
+ required :delivered_at, Time, nil?: true
24
+
25
+ # @!attribute event
26
+ # Webhook event type.
27
+ #
28
+ # @return [Symbol, ContextDev::Models::Webhooks::Delivery::Event]
29
+ required :event, enum: -> { ContextDev::Webhooks::Delivery::Event }
30
+
31
+ # @!attribute event_id
32
+ # Stable event ID for deduplicating received webhooks.
33
+ #
34
+ # @return [String]
35
+ required :event_id, String
36
+
37
+ # @!attribute last_attempt
38
+ # Latest attempt, or null if none.
39
+ #
40
+ # @return [ContextDev::Models::Webhooks::Attempt, nil]
41
+ required :last_attempt, -> { ContextDev::Webhooks::Attempt }, nil?: true
42
+
43
+ # @!attribute last_error
44
+ # Latest delivery error, or null if none.
45
+ #
46
+ # @return [ContextDev::Models::Webhooks::Delivery::LastError, nil]
47
+ required :last_error, -> { ContextDev::Webhooks::Delivery::LastError }, nil?: true
48
+
49
+ # @!attribute next_attempt_at
50
+ # Next scheduled attempt, or null if none.
51
+ #
52
+ # @return [Time, nil]
53
+ required :next_attempt_at, Time, nil?: true
54
+
55
+ # @!attribute retry_
56
+ # Webhook retry settings. Use {} for the default schedule.
57
+ #
58
+ # @return [ContextDev::Models::RetryConfig]
59
+ required :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
60
+
61
+ # @!attribute retry_expires_at
62
+ # Manual retry deadline, seven days after event creation.
63
+ #
64
+ # @return [Time]
65
+ required :retry_expires_at, Time
66
+
67
+ # @!attribute source
68
+ # Batch or monitor run that produced the event.
69
+ #
70
+ # @return [ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor]
71
+ required :source, union: -> { ContextDev::Webhooks::Delivery::Source }
72
+
73
+ # @!attribute status
74
+ # Current delivery status.
75
+ #
76
+ # @return [Symbol, ContextDev::Models::Webhooks::Delivery::Status]
77
+ required :status, enum: -> { ContextDev::Webhooks::Delivery::Status }
78
+
79
+ # @!attribute url
80
+ # Webhook destination URL.
81
+ #
82
+ # @return [String]
83
+ required :url, String
84
+
85
+ # @!method initialize(id:, created_at:, delivered_at:, event:, event_id:, last_attempt:, last_error:, next_attempt_at:, retry_:, retry_expires_at:, source:, status:, url:)
86
+ # @param id [String] Delivery ID.
87
+ #
88
+ # @param created_at [Time] Event creation time.
89
+ #
90
+ # @param delivered_at [Time, nil] Last successful delivery time, or null if never delivered.
91
+ #
92
+ # @param event [Symbol, ContextDev::Models::Webhooks::Delivery::Event] Webhook event type.
93
+ #
94
+ # @param event_id [String] Stable event ID for deduplicating received webhooks.
95
+ #
96
+ # @param last_attempt [ContextDev::Models::Webhooks::Attempt, nil] Latest attempt, or null if none.
97
+ #
98
+ # @param last_error [ContextDev::Models::Webhooks::Delivery::LastError, nil] Latest delivery error, or null if none.
99
+ #
100
+ # @param next_attempt_at [Time, nil] Next scheduled attempt, or null if none.
101
+ #
102
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
103
+ #
104
+ # @param retry_expires_at [Time] Manual retry deadline, seven days after event creation.
105
+ #
106
+ # @param source [ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor] Batch or monitor run that produced the event.
107
+ #
108
+ # @param status [Symbol, ContextDev::Models::Webhooks::Delivery::Status] Current delivery status.
109
+ #
110
+ # @param url [String] Webhook destination URL.
111
+
112
+ # Webhook event type.
113
+ #
114
+ # @see ContextDev::Models::Webhooks::Delivery#event
115
+ module Event
116
+ extend ContextDev::Internal::Type::Enum
117
+
118
+ BATCH_COMPLETED = :"batch.completed"
119
+ BATCH_FAILED = :"batch.failed"
120
+ BATCH_CANCELLED = :"batch.cancelled"
121
+ CHANGE_DETECTED = :"change.detected"
122
+ RUN_COMPLETED = :"run.completed"
123
+
124
+ # @!method self.values
125
+ # @return [Array<Symbol>]
126
+ end
127
+
128
+ # @see ContextDev::Models::Webhooks::Delivery#last_error
129
+ class LastError < ContextDev::Internal::Type::BaseModel
130
+ # @!attribute code
131
+ # Error code.
132
+ #
133
+ # @return [String]
134
+ required :code, String
135
+
136
+ # @!attribute message
137
+ # Error details.
138
+ #
139
+ # @return [String]
140
+ required :message, String
141
+
142
+ # @!method initialize(code:, message:)
143
+ # Latest delivery error, or null if none.
144
+ #
145
+ # @param code [String] Error code.
146
+ #
147
+ # @param message [String] Error details.
148
+ end
149
+
150
+ # Batch or monitor run that produced the event.
151
+ #
152
+ # @see ContextDev::Models::Webhooks::Delivery#source
153
+ module Source
154
+ extend ContextDev::Internal::Type::Union
155
+
156
+ variant -> { ContextDev::Webhooks::Delivery::Source::Batch }
157
+
158
+ variant -> { ContextDev::Webhooks::Delivery::Source::Monitor }
159
+
160
+ class Batch < ContextDev::Internal::Type::BaseModel
161
+ # @!attribute batch_id
162
+ # Batch ID.
163
+ #
164
+ # @return [String]
165
+ required :batch_id, String
166
+
167
+ # @!attribute type
168
+ # Delivery source.
169
+ #
170
+ # @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type]
171
+ required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Batch::Type }
172
+
173
+ # @!method initialize(batch_id:, type:)
174
+ # @param batch_id [String] Batch ID.
175
+ #
176
+ # @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type] Delivery source.
177
+
178
+ # Delivery source.
179
+ #
180
+ # @see ContextDev::Models::Webhooks::Delivery::Source::Batch#type
181
+ module Type
182
+ extend ContextDev::Internal::Type::Enum
183
+
184
+ BATCH = :batch
185
+
186
+ # @!method self.values
187
+ # @return [Array<Symbol>]
188
+ end
189
+ end
190
+
191
+ class Monitor < ContextDev::Internal::Type::BaseModel
192
+ # @!attribute monitor_id
193
+ # Monitor ID.
194
+ #
195
+ # @return [String]
196
+ required :monitor_id, String
197
+
198
+ # @!attribute run_id
199
+ # Monitor run ID.
200
+ #
201
+ # @return [String]
202
+ required :run_id, String
203
+
204
+ # @!attribute type
205
+ # Delivery source.
206
+ #
207
+ # @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type]
208
+ required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Monitor::Type }
209
+
210
+ # @!method initialize(monitor_id:, run_id:, type:)
211
+ # @param monitor_id [String] Monitor ID.
212
+ #
213
+ # @param run_id [String] Monitor run ID.
214
+ #
215
+ # @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type] Delivery source.
216
+
217
+ # Delivery source.
218
+ #
219
+ # @see ContextDev::Models::Webhooks::Delivery::Source::Monitor#type
220
+ module Type
221
+ extend ContextDev::Internal::Type::Enum
222
+
223
+ MONITOR = :monitor
224
+
225
+ # @!method self.values
226
+ # @return [Array<Symbol>]
227
+ end
228
+ end
229
+
230
+ # @!method self.variants
231
+ # @return [Array(ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor)]
232
+ end
233
+
234
+ # Current delivery status.
235
+ #
236
+ # @see ContextDev::Models::Webhooks::Delivery#status
237
+ module Status
238
+ extend ContextDev::Internal::Type::Enum
239
+
240
+ PENDING = :pending
241
+ DELIVERING = :delivering
242
+ RETRYING = :retrying
243
+ DELIVERED = :delivered
244
+ FAILED = :failed
245
+ CANCELLED = :cancelled
246
+
247
+ # @!method self.values
248
+ # @return [Array<Symbol>]
249
+ end
250
+ end
251
+ end
252
+ end
253
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ module Webhooks
6
+ # @see ContextDev::Resources::Webhooks::Deliveries#list_attempts
7
+ class DeliveryListAttemptsParams < ContextDev::Internal::Type::BaseModel
8
+ extend ContextDev::Internal::Type::RequestParameters::Converter
9
+ include ContextDev::Internal::Type::RequestParameters
10
+
11
+ # @!attribute delivery_id
12
+ # Delivery ID.
13
+ #
14
+ # @return [String]
15
+ required :delivery_id, String
16
+
17
+ # @!attribute cursor
18
+ # The next_cursor from the previous response.
19
+ #
20
+ # @return [String, nil]
21
+ optional :cursor, String
22
+
23
+ # @!attribute limit
24
+ # Number of attempts to return.
25
+ #
26
+ # @return [Integer, nil]
27
+ optional :limit, Integer
28
+
29
+ # @!attribute tags
30
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
31
+ # characters.
32
+ #
33
+ # @return [Array<String>, nil]
34
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
35
+
36
+ # @!method initialize(delivery_id:, cursor: nil, limit: nil, tags: nil, request_options: {})
37
+ # Some parameter documentations has been truncated, see
38
+ # {ContextDev::Models::Webhooks::DeliveryListAttemptsParams} for more details.
39
+ #
40
+ # @param delivery_id [String] Delivery ID.
41
+ #
42
+ # @param cursor [String] The next_cursor from the previous response.
43
+ #
44
+ # @param limit [Integer] Number of attempts to return.
45
+ #
46
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
47
+ #
48
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
49
+ end
50
+ end
51
+ end
52
+ end