context.dev 2.15.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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +6 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_response.rb +10 -1
  7. data/lib/context_dev/models/ai_extract_products_response.rb +10 -1
  8. data/lib/context_dev/models/batch_cancel_response.rb +10 -1
  9. data/lib/context_dev/models/batch_delete_response.rb +13 -1
  10. data/lib/context_dev/models/batch_get_results_response.rb +13 -1
  11. data/lib/context_dev/models/batch_list_response.rb +13 -1
  12. data/lib/context_dev/models/batch_retrieve_response.rb +10 -1
  13. data/lib/context_dev/models/batch_submit_response.rb +10 -1
  14. data/lib/context_dev/models/brand_retrieve_response.rb +10 -1
  15. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +10 -1
  16. data/lib/context_dev/models/brand_search_response.rb +10 -1
  17. data/lib/context_dev/models/industry_retrieve_naics_response.rb +13 -1
  18. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -1
  19. data/lib/context_dev/models/log_list_params.rb +108 -0
  20. data/lib/context_dev/models/log_list_response.rb +174 -0
  21. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  22. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  23. data/lib/context_dev/models/news_search_response.rb +10 -1
  24. data/lib/context_dev/models/parse_handle_response.rb +13 -1
  25. data/lib/context_dev/models/person_enrich_response.rb +13 -1
  26. data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
  27. data/lib/context_dev/models/web_extract_competitors_response.rb +13 -1
  28. data/lib/context_dev/models/web_extract_fonts_response.rb +10 -1
  29. data/lib/context_dev/models/web_extract_response.rb +10 -1
  30. data/lib/context_dev/models/web_extract_styleguide_response.rb +10 -1
  31. data/lib/context_dev/models/web_screenshot_params.rb +2 -1
  32. data/lib/context_dev/models/web_screenshot_response.rb +10 -1
  33. data/lib/context_dev/models/web_search_response.rb +10 -1
  34. data/lib/context_dev/models/web_web_crawl_md_response.rb +10 -1
  35. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -1
  36. data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -1
  37. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -1
  38. data/lib/context_dev/models/web_web_scrape_images_response.rb +10 -1
  39. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -1
  40. data/lib/context_dev/models/web_web_scrape_md_response.rb +10 -1
  41. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +10 -1
  42. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +13 -1
  43. data/lib/context_dev/models/webhooks/delivery_list_response.rb +13 -1
  44. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +13 -1
  45. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +13 -1
  46. data/lib/context_dev/models.rb +4 -0
  47. data/lib/context_dev/resources/logs.rb +83 -0
  48. data/lib/context_dev/version.rb +1 -1
  49. data/lib/context_dev.rb +5 -0
  50. data/rbi/context_dev/client.rbi +5 -0
  51. data/rbi/context_dev/models/ai_extract_product_response.rbi +10 -0
  52. data/rbi/context_dev/models/ai_extract_products_response.rbi +10 -0
  53. data/rbi/context_dev/models/batch_cancel_response.rbi +10 -0
  54. data/rbi/context_dev/models/batch_delete_response.rbi +10 -0
  55. data/rbi/context_dev/models/batch_get_results_response.rbi +10 -0
  56. data/rbi/context_dev/models/batch_list_response.rbi +10 -0
  57. data/rbi/context_dev/models/batch_retrieve_response.rbi +10 -0
  58. data/rbi/context_dev/models/batch_submit_response.rbi +10 -0
  59. data/rbi/context_dev/models/brand_retrieve_response.rbi +10 -0
  60. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +10 -0
  61. data/rbi/context_dev/models/brand_search_response.rbi +10 -0
  62. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +10 -0
  63. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +10 -0
  64. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  65. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  66. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  67. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  68. data/rbi/context_dev/models/news_search_response.rbi +10 -0
  69. data/rbi/context_dev/models/parse_handle_response.rbi +10 -0
  70. data/rbi/context_dev/models/person_enrich_response.rbi +10 -0
  71. data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
  72. data/rbi/context_dev/models/web_extract_competitors_response.rbi +10 -0
  73. data/rbi/context_dev/models/web_extract_fonts_response.rbi +10 -0
  74. data/rbi/context_dev/models/web_extract_response.rbi +10 -0
  75. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +10 -0
  76. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -2
  77. data/rbi/context_dev/models/web_screenshot_response.rbi +10 -0
  78. data/rbi/context_dev/models/web_search_response.rbi +10 -0
  79. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +10 -0
  80. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +6 -2
  81. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +10 -0
  82. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +6 -2
  83. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +10 -0
  84. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +6 -2
  85. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +10 -0
  86. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +10 -0
  87. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +10 -0
  88. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +10 -0
  89. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +10 -0
  90. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +10 -0
  91. data/rbi/context_dev/models.rbi +4 -0
  92. data/rbi/context_dev/resources/logs.rbi +76 -0
  93. data/rbi/context_dev/resources/web.rbi +11 -4
  94. data/sig/context_dev/client.rbs +2 -0
  95. data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
  96. data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
  97. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  98. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  99. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  100. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  101. data/sig/context_dev/models/batch_retrieve_response.rbs +5 -0
  102. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
  104. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
  105. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  106. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
  107. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
  108. data/sig/context_dev/models/log_list_params.rbs +98 -0
  109. data/sig/context_dev/models/log_list_response.rbs +135 -0
  110. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  111. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  112. data/sig/context_dev/models/news_search_response.rbs +5 -0
  113. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  114. data/sig/context_dev/models/person_enrich_response.rbs +5 -0
  115. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  116. data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
  117. data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
  118. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  119. data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
  120. data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
  121. data/sig/context_dev/models/web_search_response.rbs +5 -0
  122. data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
  123. data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
  124. data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
  125. data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
  126. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
  127. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +5 -0
  128. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +5 -0
  129. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +7 -0
  130. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +5 -0
  131. data/sig/context_dev/models.rbs +4 -0
  132. data/sig/context_dev/resources/logs.rbs +27 -0
  133. metadata +17 -2
@@ -12,6 +12,13 @@ module ContextDev
12
12
  # @return [ContextDev::Models::WebScreenshotResponse::CacheMetadata]
13
13
  required :cache_metadata, -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata }
14
14
 
15
+ # @!attribute request_id
16
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
17
+ # it when contacting support about a failed request.
18
+ #
19
+ # @return [String]
20
+ required :request_id, String
21
+
15
22
  # @!attribute code
16
23
  # HTTP status code
17
24
  #
@@ -63,12 +70,14 @@ module ContextDev
63
70
  # @return [Integer, nil]
64
71
  optional :width, Integer
65
72
 
66
- # @!method initialize(cache_metadata:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
73
+ # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
67
74
  # Some parameter documentations has been truncated, see
68
75
  # {ContextDev::Models::WebScreenshotResponse} for more details.
69
76
  #
70
77
  # @param cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
71
78
  #
79
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
80
+ #
72
81
  # @param code [Integer] HTTP status code
73
82
  #
74
83
  # @param domain [String] The normalized domain that was processed
@@ -18,6 +18,13 @@ module ContextDev
18
18
  # @return [String]
19
19
  required :query, String
20
20
 
21
+ # @!attribute request_id
22
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
23
+ # it when contacting support about a failed request.
24
+ #
25
+ # @return [String]
26
+ required :request_id, String
27
+
21
28
  # @!attribute results
22
29
  #
23
30
  # @return [Array<ContextDev::Models::WebSearchResponse::Result>]
@@ -30,7 +37,7 @@ module ContextDev
30
37
  # @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil]
31
38
  optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
32
39
 
33
- # @!method initialize(cache_metadata:, query:, results:, key_metadata: nil)
40
+ # @!method initialize(cache_metadata:, query:, request_id:, results:, key_metadata: nil)
34
41
  # Some parameter documentations has been truncated, see
35
42
  # {ContextDev::Models::WebSearchResponse} for more details.
36
43
  #
@@ -38,6 +45,8 @@ module ContextDev
38
45
  #
39
46
  # @param query [String] Echo of the original query (useful when fanout was enabled).
40
47
  #
48
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
49
+ #
41
50
  # @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
42
51
  #
43
52
  # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
@@ -17,6 +17,13 @@ module ContextDev
17
17
  # @return [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
18
18
  required :metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::Metadata }
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 results
21
28
  #
22
29
  # @return [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
@@ -29,7 +36,7 @@ module ContextDev
29
36
  # @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
30
37
  optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
31
38
 
32
- # @!method initialize(cache_metadata:, metadata:, results:, key_metadata: nil)
39
+ # @!method initialize(cache_metadata:, metadata:, request_id:, results:, key_metadata: nil)
33
40
  # Some parameter documentations has been truncated, see
34
41
  # {ContextDev::Models::WebWebCrawlMdResponse} for more details.
35
42
  #
@@ -37,6 +44,8 @@ module ContextDev
37
44
  #
38
45
  # @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
39
46
  #
47
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
48
+ #
40
49
  # @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
41
50
  #
42
51
  # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
@@ -107,7 +107,9 @@ module ContextDev
107
107
 
108
108
  # @!attribute wait_for_ms
109
109
  # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
110
- # 30000 (30 seconds).
110
+ # 30000 (30 seconds). When combined with timeoutMS, timeoutMS must be at least
111
+ # waitForMs + 10000 ms; a shorter deadline is rejected with 400
112
+ # TIMEOUT_TOO_SHORT_FOR_WAIT.
111
113
  #
112
114
  # @return [Integer, nil]
113
115
  optional :wait_for_ms, Integer, nil?: true
@@ -26,6 +26,13 @@ module ContextDev
26
26
  # @return [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata]
27
27
  required :metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::Metadata }
28
28
 
29
+ # @!attribute request_id
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
+ #
33
+ # @return [String]
34
+ required :request_id, String
35
+
29
36
  # @!attribute success
30
37
  # Indicates success
31
38
  #
@@ -68,7 +75,7 @@ module ContextDev
68
75
  # @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
69
76
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
70
77
 
71
- # @!method initialize(cache_metadata:, html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
78
+ # @!method initialize(cache_metadata:, html:, metadata:, request_id:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
72
79
  # Some parameter documentations has been truncated, see
73
80
  # {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
74
81
  #
@@ -78,6 +85,8 @@ module ContextDev
78
85
  #
79
86
  # @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML.
80
87
  #
88
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
89
+ #
81
90
  # @param success [Boolean, ContextDev::Models::WebWebScrapeHTMLResponse::Success] Indicates success
82
91
  #
83
92
  # @param type [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa
@@ -73,7 +73,9 @@ module ContextDev
73
73
 
74
74
  # @!attribute wait_for_ms
75
75
  # Optional browser wait time in milliseconds after initial page load before
76
- # collecting images. Min: 0. Max: 30000 (30 seconds).
76
+ # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
77
+ # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
78
+ # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
77
79
  #
78
80
  # @return [Integer, nil]
79
81
  optional :wait_for_ms, Integer, nil?: true
@@ -19,6 +19,13 @@ module ContextDev
19
19
  required :images,
20
20
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image] }
21
21
 
22
+ # @!attribute request_id
23
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
24
+ # it when contacting support about a failed request.
25
+ #
26
+ # @return [String]
27
+ required :request_id, String
28
+
22
29
  # @!attribute success
23
30
  # Always true on success.
24
31
  #
@@ -45,7 +52,7 @@ module ContextDev
45
52
  # @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
46
53
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
47
54
 
48
- # @!method initialize(cache_metadata:, images:, success:, url:, actions_applied: nil, key_metadata: nil)
55
+ # @!method initialize(cache_metadata:, images:, request_id:, success:, url:, actions_applied: nil, key_metadata: nil)
49
56
  # Some parameter documentations has been truncated, see
50
57
  # {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
51
58
  #
@@ -53,6 +60,8 @@ module ContextDev
53
60
  #
54
61
  # @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images found on the page.
55
62
  #
63
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
64
+ #
56
65
  # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
57
66
  #
58
67
  # @param url [String] Page URL that was scraped.
@@ -134,7 +134,9 @@ module ContextDev
134
134
 
135
135
  # @!attribute wait_for_ms
136
136
  # Optional browser wait time in milliseconds after initial page load before
137
- # 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.
138
140
  #
139
141
  # @return [Integer, nil]
140
142
  optional :wait_for_ms, Integer, nil?: true
@@ -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
  #
@@ -73,7 +80,7 @@ module ContextDev
73
80
  # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
74
81
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
75
82
 
76
- # @!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)
77
84
  # Some parameter documentations has been truncated, see
78
85
  # {ContextDev::Models::WebWebScrapeMdResponse} for more details.
79
86
  #
@@ -85,6 +92,8 @@ module ContextDev
85
92
  #
86
93
  # @param metadata [ContextDev::Models::WebWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML.
87
94
  #
95
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
96
+ #
88
97
  # @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success
89
98
  #
90
99
  # @param url [String] The URL that was scraped
@@ -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
  #
@@ -35,7 +42,7 @@ module ContextDev
35
42
  # @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
36
43
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
37
44
 
38
- # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil)
45
+ # @!method initialize(domain:, meta:, request_id:, success:, urls:, key_metadata: nil)
39
46
  # Some parameter documentations has been truncated, see
40
47
  # {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
41
48
  #
@@ -43,6 +50,8 @@ module ContextDev
43
50
  #
44
51
  # @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
45
52
  #
53
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
54
+ #
46
55
  # @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success
47
56
  #
48
57
  # @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
@@ -23,19 +23,31 @@ module ContextDev
23
23
  # @return [String, nil]
24
24
  required :next_cursor, String, nil?: true
25
25
 
26
+ # @!attribute request_id
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ #
30
+ # @return [String]
31
+ required :request_id, String
32
+
26
33
  # @!attribute key_metadata
27
34
  # Credit usage, included whenever a valid API key is provided.
28
35
  #
29
36
  # @return [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata, nil]
30
37
  optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata }
31
38
 
32
- # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
39
+ # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
40
+ # Some parameter documentations has been truncated, see
41
+ # {ContextDev::Models::Webhooks::DeliveryListAttemptsResponse} for more details.
42
+ #
33
43
  # @param data [Array<ContextDev::Models::Webhooks::Attempt>] Delivery attempts.
34
44
  #
35
45
  # @param has_more [Boolean] Whether more attempts are available.
36
46
  #
37
47
  # @param next_cursor [String, nil] Next page cursor, or null on the last page.
38
48
  #
49
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
50
+ #
39
51
  # @param key_metadata [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
40
52
 
41
53
  # @see ContextDev::Models::Webhooks::DeliveryListAttemptsResponse#key_metadata
@@ -23,19 +23,31 @@ module ContextDev
23
23
  # @return [String, nil]
24
24
  required :next_cursor, String, nil?: true
25
25
 
26
+ # @!attribute request_id
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ #
30
+ # @return [String]
31
+ required :request_id, String
32
+
26
33
  # @!attribute key_metadata
27
34
  # Credit usage, included whenever a valid API key is provided.
28
35
  #
29
36
  # @return [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata, nil]
30
37
  optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata }
31
38
 
32
- # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
39
+ # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
40
+ # Some parameter documentations has been truncated, see
41
+ # {ContextDev::Models::Webhooks::DeliveryListResponse} for more details.
42
+ #
33
43
  # @param data [Array<ContextDev::Models::Webhooks::DeliverySummary>] Webhook deliveries.
34
44
  #
35
45
  # @param has_more [Boolean] Whether more deliveries are available.
36
46
  #
37
47
  # @param next_cursor [String, nil] Next page cursor, or null on the last page.
38
48
  #
49
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
50
+ #
39
51
  # @param key_metadata [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
40
52
 
41
53
  # @see ContextDev::Models::Webhooks::DeliveryListResponse#key_metadata
@@ -5,13 +5,25 @@ module ContextDev
5
5
  module Webhooks
6
6
  # @see ContextDev::Resources::Webhooks::Deliveries#retrieve
7
7
  class DeliveryRetrieveResponse < ContextDev::Models::Webhooks::Delivery
8
+ # @!attribute request_id
9
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
10
+ # it when contacting support about a failed request.
11
+ #
12
+ # @return [String]
13
+ required :request_id, String
14
+
8
15
  # @!attribute key_metadata
9
16
  # Credit usage, included whenever a valid API key is provided.
10
17
  #
11
18
  # @return [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata, nil]
12
19
  optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata }
13
20
 
14
- # @!method initialize(key_metadata: nil)
21
+ # @!method initialize(request_id:, key_metadata: nil)
22
+ # Some parameter documentations has been truncated, see
23
+ # {ContextDev::Models::Webhooks::DeliveryRetrieveResponse} for more details.
24
+ #
25
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
26
+ #
15
27
  # @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
16
28
 
17
29
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
@@ -11,15 +11,27 @@ module ContextDev
11
11
  # @return [String]
12
12
  required :id, String
13
13
 
14
+ # @!attribute request_id
15
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
16
+ # it when contacting support about a failed request.
17
+ #
18
+ # @return [String]
19
+ required :request_id, String
20
+
14
21
  # @!attribute key_metadata
15
22
  # Credit usage, included whenever a valid API key is provided.
16
23
  #
17
24
  # @return [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata, nil]
18
25
  optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata }
19
26
 
20
- # @!method initialize(id:, key_metadata: nil)
27
+ # @!method initialize(id:, request_id:, key_metadata: nil)
28
+ # Some parameter documentations has been truncated, see
29
+ # {ContextDev::Models::Webhooks::DeliveryRetryResponse} for more details.
30
+ #
21
31
  # @param id [String] Delivery ID.
22
32
  #
33
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
34
+ #
23
35
  # @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
24
36
 
25
37
  # @see ContextDev::Models::Webhooks::DeliveryRetryResponse#key_metadata
@@ -71,6 +71,10 @@ module ContextDev
71
71
 
72
72
  Intake = ContextDev::Models::Intake
73
73
 
74
+ LogListParams = ContextDev::Models::LogListParams
75
+
76
+ LogRetrieveParams = ContextDev::Models::LogRetrieveParams
77
+
74
78
  MonitorCreateParams = ContextDev::Models::MonitorCreateParams
75
79
 
76
80
  MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Resources
5
+ # Read your organization's API request logs to debug failed calls. These endpoints
6
+ # cost no credits and use a separate rate limit.
7
+ class Logs
8
+ # Get one logged API call, including its request input and response body.
9
+ #
10
+ # @overload retrieve(request_id, request_options: {})
11
+ #
12
+ # @param request_id [String] The request ID of the logged API call.
13
+ #
14
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
15
+ #
16
+ # @return [ContextDev::Models::LogRetrieveResponse]
17
+ #
18
+ # @see ContextDev::Models::LogRetrieveParams
19
+ def retrieve(request_id, params = {})
20
+ @client.request(
21
+ method: :get,
22
+ path: ["logs/%1$s", request_id],
23
+ model: ContextDev::Models::LogRetrieveResponse,
24
+ options: params[:request_options]
25
+ )
26
+ end
27
+
28
+ # Some parameter documentations has been truncated, see
29
+ # {ContextDev::Models::LogListParams} for more details.
30
+ #
31
+ # List your organization's API requests, newest first. Defaults to the last 24
32
+ # hours.
33
+ #
34
+ # @overload list(error_code: nil, errors_only: nil, from: nil, key_id: nil, limit: nil, page: nil, path: nil, search: nil, status_code: nil, tags: nil, to: nil, request_options: {})
35
+ #
36
+ # @param error_code [String] Filter by the `error_code` returned in the response.
37
+ #
38
+ # @param errors_only [Boolean] Only include requests that returned a 4xx or 5xx status.
39
+ #
40
+ # @param from [Time] Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
41
+ #
42
+ # @param key_id [String] Filter by the API key that made the request.
43
+ #
44
+ # @param limit [Integer] Number of log entries per page.
45
+ #
46
+ # @param page [Integer] Page number, starting at 1.
47
+ #
48
+ # @param path [String] Filter by endpoint path, with or without the /v1 prefix.
49
+ #
50
+ # @param search [String] Case-insensitive substring match against the request query and body, e.g. a doma
51
+ #
52
+ # @param status_code [Integer] Filter by exact HTTP status code.
53
+ #
54
+ # @param tags [String] Comma-separated request tags. Matches requests carrying any of them. Up to 20 ta
55
+ #
56
+ # @param to [Time] Only include requests at or before this ISO 8601 timestamp. Defaults to now.
57
+ #
58
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
59
+ #
60
+ # @return [ContextDev::Models::LogListResponse]
61
+ #
62
+ # @see ContextDev::Models::LogListParams
63
+ def list(params = {})
64
+ parsed, options = ContextDev::LogListParams.dump_request(params)
65
+ query = ContextDev::Internal::Util.encode_query_params(parsed)
66
+ @client.request(
67
+ method: :get,
68
+ path: "logs",
69
+ query: query,
70
+ model: ContextDev::Models::LogListResponse,
71
+ options: options
72
+ )
73
+ end
74
+
75
+ # @api private
76
+ #
77
+ # @param client [ContextDev::Client]
78
+ def initialize(client:)
79
+ @client = client
80
+ end
81
+ end
82
+ end
83
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ContextDev
4
- VERSION = "2.15.0"
4
+ VERSION = "2.16.0"
5
5
  end
data/lib/context_dev.rb CHANGED
@@ -82,6 +82,10 @@ require_relative "context_dev/models/industry_retrieve_naics_response"
82
82
  require_relative "context_dev/models/industry_retrieve_sic_params"
83
83
  require_relative "context_dev/models/industry_retrieve_sic_response"
84
84
  require_relative "context_dev/models/intake"
85
+ require_relative "context_dev/models/log_list_params"
86
+ require_relative "context_dev/models/log_list_response"
87
+ require_relative "context_dev/models/log_retrieve_params"
88
+ require_relative "context_dev/models/log_retrieve_response"
85
89
  require_relative "context_dev/models/monitor_create_params"
86
90
  require_relative "context_dev/models/monitor_create_response"
87
91
  require_relative "context_dev/models/monitor_delete_params"
@@ -156,6 +160,7 @@ require_relative "context_dev/resources/ai"
156
160
  require_relative "context_dev/resources/batch"
157
161
  require_relative "context_dev/resources/brand"
158
162
  require_relative "context_dev/resources/industry"
163
+ require_relative "context_dev/resources/logs"
159
164
  require_relative "context_dev/resources/monitors"
160
165
  require_relative "context_dev/resources/news"
161
166
  require_relative "context_dev/resources/parse"
@@ -52,6 +52,11 @@ module ContextDev
52
52
  sig { returns(ContextDev::Resources::News) }
53
53
  attr_reader :news
54
54
 
55
+ # Read your organization's API request logs to debug failed calls. These endpoints
56
+ # cost no credits and use a separate rate limit.
57
+ sig { returns(ContextDev::Resources::Logs) }
58
+ attr_reader :logs
59
+
55
60
  # @api private
56
61
  sig { override.returns(T::Hash[String, String]) }
57
62
  private def auth_headers
@@ -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
  # Whether the given URL is a product detail page
31
36
  sig { returns(T.nilable(T::Boolean)) }
32
37
  attr_reader :is_product_page
@@ -82,6 +87,7 @@ module ContextDev
82
87
  params(
83
88
  cache_metadata:
84
89
  ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash,
90
+ request_id: String,
85
91
  is_product_page: T::Boolean,
86
92
  key_metadata:
87
93
  ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
@@ -100,6 +106,9 @@ module ContextDev
100
106
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
101
107
  # oldest contributing hit.
102
108
  cache_metadata:,
109
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
110
+ # it when contacting support about a failed request.
111
+ request_id:,
103
112
  # Whether the given URL is a product detail page
104
113
  is_product_page: nil,
105
114
  # Credit usage, included whenever a valid API key is provided.
@@ -116,6 +125,7 @@ module ContextDev
116
125
  {
117
126
  cache_metadata:
118
127
  ContextDev::Models::AIExtractProductResponse::CacheMetadata,
128
+ request_id: String,
119
129
  is_product_page: T::Boolean,
120
130
  key_metadata:
121
131
  ContextDev::Models::AIExtractProductResponse::KeyMetadata,
@@ -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
  # Credit usage, included whenever a valid API key is provided.
31
36
  sig do
32
37
  returns(
@@ -67,6 +72,7 @@ module ContextDev
67
72
  params(
68
73
  cache_metadata:
69
74
  ContextDev::Models::AIExtractProductsResponse::CacheMetadata::OrHash,
75
+ request_id: String,
70
76
  key_metadata:
71
77
  ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash,
72
78
  products:
@@ -80,6 +86,9 @@ module ContextDev
80
86
  # cache-controlled fetch contributing to the output was a hit; age_ms is the
81
87
  # oldest contributing hit.
82
88
  cache_metadata:,
89
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
90
+ # it when contacting support about a failed request.
91
+ request_id:,
83
92
  # Credit usage, included whenever a valid API key is provided.
84
93
  key_metadata: nil,
85
94
  # Array of products extracted from the website
@@ -92,6 +101,7 @@ module ContextDev
92
101
  {
93
102
  cache_metadata:
94
103
  ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
104
+ request_id: String,
95
105
  key_metadata:
96
106
  ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
97
107
  products:
@@ -68,6 +68,11 @@ module ContextDev
68
68
  end
69
69
  attr_writer :progress
70
70
 
71
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
72
+ # it when contacting support about a failed request.
73
+ sig { returns(String) }
74
+ attr_accessor :request_id
75
+
71
76
  # Always `cancelling`. Work already in flight finishes; the batch reaches
72
77
  # `cancelled` shortly after.
73
78
  sig do
@@ -114,6 +119,7 @@ module ContextDev
114
119
  mode: ContextDev::Models::BatchCancelResponse::Mode::OrSymbol,
115
120
  page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
116
121
  progress: ContextDev::Models::BatchCancelResponse::Progress::OrHash,
122
+ request_id: String,
117
123
  status: ContextDev::Models::BatchCancelResponse::Status::OrSymbol,
118
124
  tags: T::Array[String],
119
125
  timing: ContextDev::Models::BatchCancelResponse::Timing::OrHash,
@@ -139,6 +145,9 @@ module ContextDev
139
145
  page_errors:,
140
146
  # How far the batch got before cancellation.
141
147
  progress:,
148
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
149
+ # it when contacting support about a failed request.
150
+ request_id:,
142
151
  # Always `cancelling`. Work already in flight finishes; the batch reaches
143
152
  # `cancelled` shortly after.
144
153
  status:,
@@ -163,6 +172,7 @@ module ContextDev
163
172
  mode: ContextDev::Models::BatchCancelResponse::Mode::TaggedSymbol,
164
173
  page_errors: T::Array[ContextDev::PageErrorCount],
165
174
  progress: ContextDev::Models::BatchCancelResponse::Progress,
175
+ request_id: String,
166
176
  status:
167
177
  ContextDev::Models::BatchCancelResponse::Status::TaggedSymbol,
168
178
  tags: T::Array[String],