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
@@ -623,6 +623,12 @@ module ContextDev
623
623
  optional :events,
624
624
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorRetrieveResponse::Webhook::Event] }
625
625
 
626
+ # @!attribute retry_
627
+ # Webhook retry settings. Use {} for the default schedule.
628
+ #
629
+ # @return [ContextDev::Models::RetryConfig, nil]
630
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
631
+
626
632
  response_only do
627
633
  # @!attribute secret
628
634
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -635,7 +641,7 @@ module ContextDev
635
641
  optional :secret, String
636
642
  end
637
643
 
638
- # @!method initialize(url:, events: nil, secret: nil)
644
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
639
645
  # Some parameter documentations has been truncated, see
640
646
  # {ContextDev::Models::MonitorRetrieveResponse::Webhook} for more details.
641
647
  #
@@ -643,6 +649,8 @@ module ContextDev
643
649
  #
644
650
  # @param events [Array<Symbol, ContextDev::Models::MonitorRetrieveResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
645
651
  #
652
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
653
+ #
646
654
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
647
655
 
648
656
  module Event
@@ -391,7 +391,13 @@ module ContextDev
391
391
  optional :events,
392
392
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorUpdateParams::Webhook::Event] }
393
393
 
394
- # @!method initialize(url:, events: nil)
394
+ # @!attribute retry_
395
+ # Webhook retry settings. Use {} for the default schedule.
396
+ #
397
+ # @return [ContextDev::Models::RetryConfig, nil]
398
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
399
+
400
+ # @!method initialize(url:, events: nil, retry_: nil)
395
401
  # Some parameter documentations has been truncated, see
396
402
  # {ContextDev::Models::MonitorUpdateParams::Webhook} for more details.
397
403
  #
@@ -400,6 +406,8 @@ module ContextDev
400
406
  # @param url [String] Webhook URL events are delivered to.
401
407
  #
402
408
  # @param events [Array<Symbol, ContextDev::Models::MonitorUpdateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
409
+ #
410
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
403
411
 
404
412
  module Event
405
413
  extend ContextDev::Internal::Type::Enum
@@ -623,6 +623,12 @@ module ContextDev
623
623
  optional :events,
624
624
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorUpdateResponse::Webhook::Event] }
625
625
 
626
+ # @!attribute retry_
627
+ # Webhook retry settings. Use {} for the default schedule.
628
+ #
629
+ # @return [ContextDev::Models::RetryConfig, nil]
630
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
631
+
626
632
  response_only do
627
633
  # @!attribute secret
628
634
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -635,7 +641,7 @@ module ContextDev
635
641
  optional :secret, String
636
642
  end
637
643
 
638
- # @!method initialize(url:, events: nil, secret: nil)
644
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
639
645
  # Some parameter documentations has been truncated, see
640
646
  # {ContextDev::Models::MonitorUpdateResponse::Webhook} for more details.
641
647
  #
@@ -643,6 +649,8 @@ module ContextDev
643
649
  #
644
650
  # @param events [Array<Symbol, ContextDev::Models::MonitorUpdateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
645
651
  #
652
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
653
+ #
646
654
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
647
655
 
648
656
  module Event
@@ -29,14 +29,20 @@ module ContextDev
29
29
  # @return [String, nil]
30
30
  required :next_cursor, String, nil?: true
31
31
 
32
+ # @!attribute request_id
33
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
34
+ # it when contacting support about a failed request.
35
+ #
36
+ # @return [String]
37
+ required :request_id, String
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::NewsSearchResponse::KeyMetadata, nil]
37
43
  optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
38
44
 
39
- # @!method initialize(data:, has_more:, meta:, next_cursor:, key_metadata: nil)
45
+ # @!method initialize(data:, has_more:, meta:, next_cursor:, request_id:, key_metadata: nil)
40
46
  # Some parameter documentations has been truncated, see
41
47
  # {ContextDev::Models::NewsSearchResponse} for more details.
42
48
  #
@@ -48,7 +54,9 @@ module ContextDev
48
54
  #
49
55
  # @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
50
56
  #
51
- # @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
57
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
58
+ #
59
+ # @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
52
60
 
53
61
  class Data < ContextDev::Internal::Type::BaseModel
54
62
  # @!attribute id
@@ -260,24 +268,23 @@ module ContextDev
260
268
  # @see ContextDev::Models::NewsSearchResponse#key_metadata
261
269
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
262
270
  # @!attribute credits_consumed
263
- # The number of credits consumed by this request.
271
+ # Credits used by this request.
264
272
  #
265
273
  # @return [Integer]
266
274
  required :credits_consumed, Integer
267
275
 
268
276
  # @!attribute credits_remaining
269
- # The number of credits remaining for your organization after this request.
277
+ # Credits remaining for your organization.
270
278
  #
271
279
  # @return [Integer]
272
280
  required :credits_remaining, Integer
273
281
 
274
282
  # @!method initialize(credits_consumed:, credits_remaining:)
275
- # Metadata about the API key used for the request. Included in every response
276
- # whenever a valid API key is provided, even when the response status is not 200.
283
+ # Credit usage, included whenever a valid API key is provided.
277
284
  #
278
- # @param credits_consumed [Integer] The number of credits consumed by this request.
285
+ # @param credits_consumed [Integer] Credits used by this request.
279
286
  #
280
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
287
+ # @param credits_remaining [Integer] Credits remaining for your organization.
281
288
  end
282
289
  end
283
290
  end
@@ -60,9 +60,8 @@ module ContextDev
60
60
  optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
61
61
 
62
62
  # @!attribute tags
63
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
64
- # recorded on the request's usage log and can be used to filter usage on the
65
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
63
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
64
+ # characters.
66
65
  #
67
66
  # @return [Array<String>, nil]
68
67
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -102,7 +101,7 @@ module ContextDev
102
101
  #
103
102
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
104
103
  #
105
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
104
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
106
105
  #
107
106
  # @param use_main_content_only [Boolean] Extract only the main content from HTML-like inputs
108
107
  #
@@ -10,6 +10,13 @@ module ContextDev
10
10
  # @return [String]
11
11
  required :markdown, String
12
12
 
13
+ # @!attribute request_id
14
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
+ # it when contacting support about a failed request.
16
+ #
17
+ # @return [String]
18
+ required :request_id, String
19
+
13
20
  # @!attribute success
14
21
  # Indicates success
15
22
  #
@@ -23,23 +30,24 @@ module ContextDev
23
30
  required :type, enum: -> { ContextDev::Models::ParseHandleResponse::Type }
24
31
 
25
32
  # @!attribute key_metadata
26
- # Metadata about the API key used for the request. Included in every response
27
- # whenever a valid API key is provided, even when the response status is not 200.
33
+ # Credit usage, included whenever a valid API key is provided.
28
34
  #
29
35
  # @return [ContextDev::Models::ParseHandleResponse::KeyMetadata, nil]
30
36
  optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata }
31
37
 
32
- # @!method initialize(markdown:, success:, type:, key_metadata: nil)
38
+ # @!method initialize(markdown:, request_id:, success:, type:, key_metadata: nil)
33
39
  # Some parameter documentations has been truncated, see
34
40
  # {ContextDev::Models::ParseHandleResponse} for more details.
35
41
  #
36
42
  # @param markdown [String] Input bytes converted to GitHub Flavored Markdown
37
43
  #
44
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
45
+ #
38
46
  # @param success [Boolean, ContextDev::Models::ParseHandleResponse::Success] Indicates success
39
47
  #
40
48
  # @param type [Symbol, ContextDev::Models::ParseHandleResponse::Type] Detected content type used for parsing
41
49
  #
42
- # @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
50
+ # @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
43
51
 
44
52
  # Indicates success
45
53
  #
@@ -108,24 +116,23 @@ module ContextDev
108
116
  # @see ContextDev::Models::ParseHandleResponse#key_metadata
109
117
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
110
118
  # @!attribute credits_consumed
111
- # The number of credits consumed by this request.
119
+ # Credits used by this request.
112
120
  #
113
121
  # @return [Integer]
114
122
  required :credits_consumed, Integer
115
123
 
116
124
  # @!attribute credits_remaining
117
- # The number of credits remaining for your organization after this request.
125
+ # Credits remaining for your organization.
118
126
  #
119
127
  # @return [Integer]
120
128
  required :credits_remaining, Integer
121
129
 
122
130
  # @!method initialize(credits_consumed:, credits_remaining:)
123
- # Metadata about the API key used for the request. Included in every response
124
- # whenever a valid API key is provided, even when the response status is not 200.
131
+ # Credit usage, included whenever a valid API key is provided.
125
132
  #
126
- # @param credits_consumed [Integer] The number of credits consumed by this request.
133
+ # @param credits_consumed [Integer] Credits used by this request.
127
134
  #
128
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
135
+ # @param credits_remaining [Integer] Credits remaining for your organization.
129
136
  end
130
137
  end
131
138
  end
@@ -10,20 +10,28 @@ module ContextDev
10
10
  # @return [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound]
11
11
  required :match, union: -> { ContextDev::Models::PersonEnrichResponse::Match }
12
12
 
13
+ # @!attribute request_id
14
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
+ # it when contacting support about a failed request.
16
+ #
17
+ # @return [String]
18
+ required :request_id, String
19
+
13
20
  # @!attribute key_metadata
14
- # Metadata about the API key used for the request. Included in every response
15
- # whenever a valid API key is provided, even when the response status is not 200.
21
+ # Credit usage, included whenever a valid API key is provided.
16
22
  #
17
23
  # @return [ContextDev::Models::PersonEnrichResponse::KeyMetadata, nil]
18
24
  optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }
19
25
 
20
- # @!method initialize(match:, key_metadata: nil)
26
+ # @!method initialize(match:, request_id:, key_metadata: nil)
21
27
  # Some parameter documentations has been truncated, see
22
28
  # {ContextDev::Models::PersonEnrichResponse} for more details.
23
29
  #
24
30
  # @param match [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound] The highest-scoring person candidate.
25
31
  #
26
- # @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
32
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ #
34
+ # @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
27
35
 
28
36
  # The highest-scoring person candidate.
29
37
  #
@@ -617,24 +625,23 @@ module ContextDev
617
625
  # @see ContextDev::Models::PersonEnrichResponse#key_metadata
618
626
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
619
627
  # @!attribute credits_consumed
620
- # The number of credits consumed by this request.
628
+ # Credits used by this request.
621
629
  #
622
630
  # @return [Integer]
623
631
  required :credits_consumed, Integer
624
632
 
625
633
  # @!attribute credits_remaining
626
- # The number of credits remaining for your organization after this request.
634
+ # Credits remaining for your organization.
627
635
  #
628
636
  # @return [Integer]
629
637
  required :credits_remaining, Integer
630
638
 
631
639
  # @!method initialize(credits_consumed:, credits_remaining:)
632
- # Metadata about the API key used for the request. Included in every response
633
- # whenever a valid API key is provided, even when the response status is not 200.
640
+ # Credit usage, included whenever a valid API key is provided.
634
641
  #
635
- # @param credits_consumed [Integer] The number of credits consumed by this request.
642
+ # @param credits_consumed [Integer] Credits used by this request.
636
643
  #
637
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
644
+ # @param credits_remaining [Integer] Credits remaining for your organization.
638
645
  end
639
646
  end
640
647
  end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ class RetryConfig < ContextDev::Internal::Type::BaseModel
6
+ # @!attribute delays_seconds
7
+ # Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
8
+ # retries.
9
+ #
10
+ # @return [Array<Integer>, nil]
11
+ optional :delays_seconds, ContextDev::Internal::Type::ArrayOf[Integer]
12
+
13
+ # @!method initialize(delays_seconds: nil)
14
+ # Some parameter documentations has been truncated, see
15
+ # {ContextDev::Models::RetryConfig} for more details.
16
+ #
17
+ # Webhook retry settings. Use {} for the default schedule.
18
+ #
19
+ # @param delays_seconds [Array<Integer>] Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
20
+ end
21
+ end
22
+ end
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Utility#prefetch
6
6
  class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute request_id
8
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
9
+ # it when contacting support about a failed request.
10
+ #
11
+ # @return [String]
12
+ required :request_id, String
13
+
7
14
  # @!attribute domain
8
15
  # The domain that was queued for prefetching
9
16
  #
@@ -11,8 +18,7 @@ module ContextDev
11
18
  optional :domain, String
12
19
 
13
20
  # @!attribute key_metadata
14
- # Metadata about the API key used for the request. Included in every response
15
- # whenever a valid API key is provided, even when the response status is not 200.
21
+ # Credit usage, included whenever a valid API key is provided.
16
22
  #
17
23
  # @return [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, nil]
18
24
  optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchResponse::KeyMetadata }
@@ -35,13 +41,15 @@ module ContextDev
35
41
  # @return [Symbol, ContextDev::Models::UtilityPrefetchResponse::Type, nil]
36
42
  optional :type, enum: -> { ContextDev::Models::UtilityPrefetchResponse::Type }
37
43
 
38
- # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
44
+ # @!method initialize(request_id:, domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
39
45
  # Some parameter documentations has been truncated, see
40
46
  # {ContextDev::Models::UtilityPrefetchResponse} for more details.
41
47
  #
48
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
49
+ #
42
50
  # @param domain [String] The domain that was queued for prefetching
43
51
  #
44
- # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
52
+ # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
45
53
  #
46
54
  # @param message [String] Success message
47
55
  #
@@ -52,24 +60,23 @@ module ContextDev
52
60
  # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata
53
61
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
54
62
  # @!attribute credits_consumed
55
- # The number of credits consumed by this request.
63
+ # Credits used by this request.
56
64
  #
57
65
  # @return [Integer]
58
66
  required :credits_consumed, Integer
59
67
 
60
68
  # @!attribute credits_remaining
61
- # The number of credits remaining for your organization after this request.
69
+ # Credits remaining for your organization.
62
70
  #
63
71
  # @return [Integer]
64
72
  required :credits_remaining, Integer
65
73
 
66
74
  # @!method initialize(credits_consumed:, credits_remaining:)
67
- # Metadata about the API key used for the request. Included in every response
68
- # whenever a valid API key is provided, even when the response status is not 200.
75
+ # Credit usage, included whenever a valid API key is provided.
69
76
  #
70
- # @param credits_consumed [Integer] The number of credits consumed by this request.
77
+ # @param credits_consumed [Integer] Credits used by this request.
71
78
  #
72
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
79
+ # @param credits_remaining [Integer] Credits remaining for your organization.
73
80
  end
74
81
 
75
82
  # The type of prefetch that was queued, echoed from the request
@@ -21,9 +21,8 @@ module ContextDev
21
21
  optional :num_competitors, Integer
22
22
 
23
23
  # @!attribute tags
24
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
25
- # recorded on the request's usage log and can be used to filter usage on the
26
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
24
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
25
+ # characters.
27
26
  #
28
27
  # @return [Array<String>, nil]
29
28
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -44,7 +43,7 @@ module ContextDev
44
43
  #
45
44
  # @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5.
46
45
  #
47
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
46
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
48
47
  #
49
48
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
50
49
  #
@@ -17,6 +17,13 @@ module ContextDev
17
17
  # @return [String]
18
18
  required :domain, String
19
19
 
20
+ # @!attribute request_id
21
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
22
+ # it when contacting support about a failed request.
23
+ #
24
+ # @return [String]
25
+ required :request_id, String
26
+
20
27
  # @!attribute status
21
28
  # Status of the response.
22
29
  #
@@ -30,13 +37,12 @@ module ContextDev
30
37
  required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target }
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::WebExtractCompetitorsResponse::KeyMetadata, nil]
37
43
  optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
38
44
 
39
- # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil)
45
+ # @!method initialize(competitors:, domain:, request_id:, status:, target:, key_metadata: nil)
40
46
  # Some parameter documentations has been truncated, see
41
47
  # {ContextDev::Models::WebExtractCompetitorsResponse} for more details.
42
48
  #
@@ -44,11 +50,13 @@ module ContextDev
44
50
  #
45
51
  # @param domain [String] Normalized input domain.
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 status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response.
48
56
  #
49
57
  # @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
50
58
  #
51
- # @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
59
+ # @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
52
60
 
53
61
  class Competitor < ContextDev::Internal::Type::BaseModel
54
62
  # @!attribute confidence
@@ -168,24 +176,23 @@ module ContextDev
168
176
  # @see ContextDev::Models::WebExtractCompetitorsResponse#key_metadata
169
177
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
170
178
  # @!attribute credits_consumed
171
- # The number of credits consumed by this request.
179
+ # Credits used by this request.
172
180
  #
173
181
  # @return [Integer]
174
182
  required :credits_consumed, Integer
175
183
 
176
184
  # @!attribute credits_remaining
177
- # The number of credits remaining for your organization after this request.
185
+ # Credits remaining for your organization.
178
186
  #
179
187
  # @return [Integer]
180
188
  required :credits_remaining, Integer
181
189
 
182
190
  # @!method initialize(credits_consumed:, credits_remaining:)
183
- # Metadata about the API key used for the request. Included in every response
184
- # whenever a valid API key is provided, even when the response status is not 200.
191
+ # Credit usage, included whenever a valid API key is provided.
185
192
  #
186
- # @param credits_consumed [Integer] The number of credits consumed by this request.
193
+ # @param credits_consumed [Integer] Credits used by this request.
187
194
  #
188
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
195
+ # @param credits_remaining [Integer] Credits remaining for your organization.
189
196
  end
190
197
  end
191
198
  end
@@ -33,9 +33,8 @@ module ContextDev
33
33
  optional :max_age_ms, Integer, nil?: true
34
34
 
35
35
  # @!attribute tags
36
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
37
- # recorded on the request's usage log and can be used to filter usage on the
38
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
36
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
37
+ # characters.
39
38
  #
40
39
  # @return [Array<String>, nil]
41
40
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -58,7 +57,7 @@ module ContextDev
58
57
  #
59
58
  # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
60
59
  #
61
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
60
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
62
61
  #
63
62
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
64
63
  #
@@ -31,6 +31,13 @@ module ContextDev
31
31
  required :fonts,
32
32
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractFontsResponse::Font] }
33
33
 
34
+ # @!attribute request_id
35
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
36
+ # it when contacting support about a failed request.
37
+ #
38
+ # @return [String]
39
+ required :request_id, String
40
+
34
41
  # @!attribute status
35
42
  # Status of the response, e.g., 'ok'
36
43
  #
@@ -48,13 +55,12 @@ module ContextDev
48
55
  api_name: :fontLinks
49
56
 
50
57
  # @!attribute key_metadata
51
- # Metadata about the API key used for the request. Included in every response
52
- # whenever a valid API key is provided, even when the response status is not 200.
58
+ # Credit usage, included whenever a valid API key is provided.
53
59
  #
54
60
  # @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil]
55
61
  optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata }
56
62
 
57
- # @!method initialize(cache_metadata:, code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil)
63
+ # @!method initialize(cache_metadata:, code:, domain:, fonts:, request_id:, status:, font_links: nil, key_metadata: nil)
58
64
  # Some parameter documentations has been truncated, see
59
65
  # {ContextDev::Models::WebExtractFontsResponse} for more details.
60
66
  #
@@ -66,11 +72,13 @@ module ContextDev
66
72
  #
67
73
  # @param fonts [Array<ContextDev::Models::WebExtractFontsResponse::Font>] Array of font usage information
68
74
  #
75
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
76
+ #
69
77
  # @param status [String] Status of the response, e.g., 'ok'
70
78
  #
71
79
  # @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n
72
80
  #
73
- # @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
81
+ # @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
74
82
 
75
83
  # @see ContextDev::Models::WebExtractFontsResponse#cache_metadata
76
84
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -229,24 +237,23 @@ module ContextDev
229
237
  # @see ContextDev::Models::WebExtractFontsResponse#key_metadata
230
238
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
231
239
  # @!attribute credits_consumed
232
- # The number of credits consumed by this request.
240
+ # Credits used by this request.
233
241
  #
234
242
  # @return [Integer]
235
243
  required :credits_consumed, Integer
236
244
 
237
245
  # @!attribute credits_remaining
238
- # The number of credits remaining for your organization after this request.
246
+ # Credits remaining for your organization.
239
247
  #
240
248
  # @return [Integer]
241
249
  required :credits_remaining, Integer
242
250
 
243
251
  # @!method initialize(credits_consumed:, credits_remaining:)
244
- # Metadata about the API key used for the request. Included in every response
245
- # whenever a valid API key is provided, even when the response status is not 200.
252
+ # Credit usage, included whenever a valid API key is provided.
246
253
  #
247
- # @param credits_consumed [Integer] The number of credits consumed by this request.
254
+ # @param credits_consumed [Integer] Credits used by this request.
248
255
  #
249
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
256
+ # @param credits_remaining [Integer] Credits remaining for your organization.
250
257
  end
251
258
  end
252
259
  end