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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +2 -2
- data/lib/context_dev/client.rb +6 -0
- data/lib/context_dev/internal/type/base_model.rb +2 -2
- data/lib/context_dev/models/ai_extract_product_response.rb +10 -1
- data/lib/context_dev/models/ai_extract_products_response.rb +10 -1
- data/lib/context_dev/models/batch_cancel_response.rb +10 -1
- data/lib/context_dev/models/batch_delete_response.rb +13 -1
- data/lib/context_dev/models/batch_get_results_response.rb +13 -1
- data/lib/context_dev/models/batch_list_response.rb +13 -1
- data/lib/context_dev/models/batch_retrieve_response.rb +10 -1
- data/lib/context_dev/models/batch_submit_response.rb +10 -1
- data/lib/context_dev/models/brand_retrieve_response.rb +10 -1
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +10 -1
- data/lib/context_dev/models/brand_search_response.rb +10 -1
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +13 -1
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -1
- data/lib/context_dev/models/log_list_params.rb +108 -0
- data/lib/context_dev/models/log_list_response.rb +174 -0
- data/lib/context_dev/models/log_retrieve_params.rb +22 -0
- data/lib/context_dev/models/log_retrieve_response.rb +226 -0
- data/lib/context_dev/models/news_search_response.rb +10 -1
- data/lib/context_dev/models/parse_handle_response.rb +13 -1
- data/lib/context_dev/models/person_enrich_response.rb +13 -1
- data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
- data/lib/context_dev/models/web_extract_competitors_response.rb +13 -1
- data/lib/context_dev/models/web_extract_fonts_response.rb +10 -1
- data/lib/context_dev/models/web_extract_response.rb +10 -1
- data/lib/context_dev/models/web_extract_styleguide_response.rb +10 -1
- data/lib/context_dev/models/web_screenshot_params.rb +2 -1
- data/lib/context_dev/models/web_screenshot_response.rb +10 -1
- data/lib/context_dev/models/web_search_response.rb +10 -1
- data/lib/context_dev/models/web_web_crawl_md_response.rb +10 -1
- data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -1
- data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -1
- data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -1
- data/lib/context_dev/models/web_web_scrape_images_response.rb +10 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -1
- data/lib/context_dev/models/web_web_scrape_md_response.rb +10 -1
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +10 -1
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +13 -1
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +13 -1
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +13 -1
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +13 -1
- data/lib/context_dev/models.rb +4 -0
- data/lib/context_dev/resources/logs.rb +83 -0
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +5 -0
- data/rbi/context_dev/client.rbi +5 -0
- data/rbi/context_dev/models/ai_extract_product_response.rbi +10 -0
- data/rbi/context_dev/models/ai_extract_products_response.rbi +10 -0
- data/rbi/context_dev/models/batch_cancel_response.rbi +10 -0
- data/rbi/context_dev/models/batch_delete_response.rbi +10 -0
- data/rbi/context_dev/models/batch_get_results_response.rbi +10 -0
- data/rbi/context_dev/models/batch_list_response.rbi +10 -0
- data/rbi/context_dev/models/batch_retrieve_response.rbi +10 -0
- data/rbi/context_dev/models/batch_submit_response.rbi +10 -0
- data/rbi/context_dev/models/brand_retrieve_response.rbi +10 -0
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +10 -0
- data/rbi/context_dev/models/brand_search_response.rbi +10 -0
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +10 -0
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +10 -0
- data/rbi/context_dev/models/log_list_params.rbi +162 -0
- data/rbi/context_dev/models/log_list_response.rbi +246 -0
- data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
- data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
- data/rbi/context_dev/models/news_search_response.rbi +10 -0
- data/rbi/context_dev/models/parse_handle_response.rbi +10 -0
- data/rbi/context_dev/models/person_enrich_response.rbi +10 -0
- data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +10 -0
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +10 -0
- data/rbi/context_dev/models/web_extract_response.rbi +10 -0
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +10 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +4 -2
- data/rbi/context_dev/models/web_screenshot_response.rbi +10 -0
- data/rbi/context_dev/models/web_search_response.rbi +10 -0
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +10 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +6 -2
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +10 -0
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +6 -2
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +10 -0
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +6 -2
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +10 -0
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +10 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +10 -0
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +10 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +10 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +10 -0
- data/rbi/context_dev/models.rbi +4 -0
- data/rbi/context_dev/resources/logs.rbi +76 -0
- data/rbi/context_dev/resources/web.rbi +11 -4
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
- data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
- data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
- data/sig/context_dev/models/batch_delete_response.rbs +5 -0
- data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
- data/sig/context_dev/models/batch_list_response.rbs +5 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +5 -0
- data/sig/context_dev/models/batch_submit_response.rbs +5 -0
- data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
- data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
- data/sig/context_dev/models/brand_search_response.rbs +5 -0
- data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
- data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
- data/sig/context_dev/models/log_list_params.rbs +98 -0
- data/sig/context_dev/models/log_list_response.rbs +135 -0
- data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
- data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
- data/sig/context_dev/models/news_search_response.rbs +5 -0
- data/sig/context_dev/models/parse_handle_response.rbs +5 -0
- data/sig/context_dev/models/person_enrich_response.rbs +5 -0
- data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
- data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
- data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
- data/sig/context_dev/models/web_extract_response.rbs +5 -0
- data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
- data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
- data/sig/context_dev/models/web_search_response.rbs +5 -0
- data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
- data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +5 -0
- data/sig/context_dev/models/webhooks/delivery_list_response.rbs +5 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +7 -0
- data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +5 -0
- data/sig/context_dev/models.rbs +4 -0
- data/sig/context_dev/resources/logs.rbs +27 -0
- metadata +17 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f386d4f27c72c64c88946d5e8dbc98bb1cd4f5de22f6400219eb7996954c68df
|
|
4
|
+
data.tar.gz: 062cb685ad8d8469e9e4f81e42d809533d98b0b68c009c57b285a77578023fdb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ec3879167f8c90f9c79ea728be1f927ff23c089ca6103255c7ea64294adfa117a616e9a83f72439a72ee710ca2fa0b66a8fa44e5eac649ceda206f04bb324cd4
|
|
7
|
+
data.tar.gz: 2a2945c6da42e4ec238ecbb23dec1803bf65b2c857c864152e6919c66d35b981aa5b6696848d29b0d541e1810bec79ab19a7462a4ef6c58e70df5c4f9d355f42
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.16.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.15.0...v2.16.0) (2026-09-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** return request_id on every response ([012ba65](https://github.com/context-dot-dev/context-ruby-sdk/commit/012ba65ea7648ebd7b18fa7ad00955a13b8394b9))
|
|
9
|
+
* **logs:** expose request log endpoints in SDKs ([#1025](https://github.com/context-dot-dev/context-ruby-sdk/issues/1025)) ([5b22be7](https://github.com/context-dot-dev/context-ruby-sdk/commit/5b22be7bd1cb6401b8260b5a756b6ec040cbc6a8))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* **api:** reject timeoutMS too short for waitForMs ([e8a6725](https://github.com/context-dot-dev/context-ruby-sdk/commit/e8a67255c9354f69d632697179a4d6270a4677ee))
|
|
15
|
+
|
|
3
16
|
## [2.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.14.0...v2.15.0) (2026-09-08)
|
|
4
17
|
|
|
5
18
|
|
data/README.md
CHANGED
|
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
17
17
|
<!-- x-release-please-start-version -->
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
|
-
gem "context.dev", "~> 2.
|
|
20
|
+
gem "context.dev", "~> 2.16.0"
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
<!-- x-release-please-end -->
|
|
@@ -34,7 +34,7 @@ context_dev = ContextDev::Client.new(
|
|
|
34
34
|
|
|
35
35
|
brand = context_dev.brand.retrieve(body: {domain: "stripe.com", type: "by_domain"})
|
|
36
36
|
|
|
37
|
-
puts(brand.
|
|
37
|
+
puts(brand.request_id)
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
### Handling errors
|
data/lib/context_dev/client.rb
CHANGED
|
@@ -57,6 +57,11 @@ module ContextDev
|
|
|
57
57
|
# @return [ContextDev::Resources::News]
|
|
58
58
|
attr_reader :news
|
|
59
59
|
|
|
60
|
+
# Read your organization's API request logs to debug failed calls. These endpoints
|
|
61
|
+
# cost no credits and use a separate rate limit.
|
|
62
|
+
# @return [ContextDev::Resources::Logs]
|
|
63
|
+
attr_reader :logs
|
|
64
|
+
|
|
60
65
|
# @api private
|
|
61
66
|
#
|
|
62
67
|
# @return [Hash{String=>String}]
|
|
@@ -129,6 +134,7 @@ module ContextDev
|
|
|
129
134
|
@webhooks = ContextDev::Resources::Webhooks.new(client: self)
|
|
130
135
|
@people = ContextDev::Resources::People.new(client: self)
|
|
131
136
|
@news = ContextDev::Resources::News.new(client: self)
|
|
137
|
+
@logs = ContextDev::Resources::Logs.new(client: self)
|
|
132
138
|
end
|
|
133
139
|
end
|
|
134
140
|
end
|
|
@@ -441,8 +441,8 @@ module ContextDev
|
|
|
441
441
|
# # `parse_handle_response` is a `ContextDev::Models::ParseHandleResponse`
|
|
442
442
|
# parse_handle_response => {
|
|
443
443
|
# markdown: markdown,
|
|
444
|
-
#
|
|
445
|
-
#
|
|
444
|
+
# request_id: request_id,
|
|
445
|
+
# success: success
|
|
446
446
|
# }
|
|
447
447
|
def deconstruct_keys(keys)
|
|
448
448
|
(keys || self.class.known_fields.keys)
|
|
@@ -12,6 +12,13 @@ module ContextDev
|
|
|
12
12
|
# @return [ContextDev::Models::AIExtractProductResponse::CacheMetadata]
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::AIExtractProductResponse::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 is_product_page
|
|
16
23
|
# Whether the given URL is a product detail page
|
|
17
24
|
#
|
|
@@ -36,12 +43,14 @@ module ContextDev
|
|
|
36
43
|
# @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
|
|
37
44
|
optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
|
|
38
45
|
|
|
39
|
-
# @!method initialize(cache_metadata:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
|
|
46
|
+
# @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
|
|
40
47
|
# Some parameter documentations has been truncated, see
|
|
41
48
|
# {ContextDev::Models::AIExtractProductResponse} for more details.
|
|
42
49
|
#
|
|
43
50
|
# @param cache_metadata [ContextDev::Models::AIExtractProductResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
44
51
|
#
|
|
52
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
53
|
+
#
|
|
45
54
|
# @param is_product_page [Boolean] Whether the given URL is a product detail page
|
|
46
55
|
#
|
|
47
56
|
# @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
@@ -12,6 +12,13 @@ module ContextDev
|
|
|
12
12
|
# @return [ContextDev::Models::AIExtractProductsResponse::CacheMetadata]
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::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 key_metadata
|
|
16
23
|
# Credit usage, included whenever a valid API key is provided.
|
|
17
24
|
#
|
|
@@ -25,12 +32,14 @@ module ContextDev
|
|
|
25
32
|
optional :products,
|
|
26
33
|
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
|
|
27
34
|
|
|
28
|
-
# @!method initialize(cache_metadata:, key_metadata: nil, products: nil)
|
|
35
|
+
# @!method initialize(cache_metadata:, request_id:, key_metadata: nil, products: nil)
|
|
29
36
|
# Some parameter documentations has been truncated, see
|
|
30
37
|
# {ContextDev::Models::AIExtractProductsResponse} for more details.
|
|
31
38
|
#
|
|
32
39
|
# @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
33
40
|
#
|
|
41
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
42
|
+
#
|
|
34
43
|
# @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
35
44
|
#
|
|
36
45
|
# @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
|
|
@@ -53,6 +53,13 @@ module ContextDev
|
|
|
53
53
|
# @return [ContextDev::Models::BatchCancelResponse::Progress]
|
|
54
54
|
required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
|
|
55
55
|
|
|
56
|
+
# @!attribute request_id
|
|
57
|
+
# Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
58
|
+
# it when contacting support about a failed request.
|
|
59
|
+
#
|
|
60
|
+
# @return [String]
|
|
61
|
+
required :request_id, String
|
|
62
|
+
|
|
56
63
|
# @!attribute status
|
|
57
64
|
# Always `cancelling`. Work already in flight finishes; the batch reaches
|
|
58
65
|
# `cancelled` shortly after.
|
|
@@ -78,7 +85,7 @@ module ContextDev
|
|
|
78
85
|
# @return [ContextDev::Models::BatchCancelResponse::KeyMetadata, nil]
|
|
79
86
|
optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }
|
|
80
87
|
|
|
81
|
-
# @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, status:, tags:, timing:, key_metadata: nil)
|
|
88
|
+
# @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, request_id:, status:, tags:, timing:, key_metadata: nil)
|
|
82
89
|
# Some parameter documentations has been truncated, see
|
|
83
90
|
# {ContextDev::Models::BatchCancelResponse} for more details.
|
|
84
91
|
#
|
|
@@ -98,6 +105,8 @@ module ContextDev
|
|
|
98
105
|
#
|
|
99
106
|
# @param progress [ContextDev::Models::BatchCancelResponse::Progress] How far the batch got before cancellation.
|
|
100
107
|
#
|
|
108
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
109
|
+
#
|
|
101
110
|
# @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Always `cancelling`. Work already in flight finishes; the batch reaches `cancell
|
|
102
111
|
#
|
|
103
112
|
# @param tags [Array<String>] Tags stored on the batch at submission.
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Batch#delete
|
|
6
6
|
class BatchDeleteResponse < 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 id
|
|
8
15
|
# ID of the deleted batch.
|
|
9
16
|
#
|
|
@@ -22,7 +29,12 @@ module ContextDev
|
|
|
22
29
|
# @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
|
|
23
30
|
optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
|
|
24
31
|
|
|
25
|
-
# @!method initialize(id: nil, deleted: nil, key_metadata: nil)
|
|
32
|
+
# @!method initialize(request_id:, id: nil, deleted: nil, key_metadata: nil)
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {ContextDev::Models::BatchDeleteResponse} for more details.
|
|
35
|
+
#
|
|
36
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
37
|
+
#
|
|
26
38
|
# @param id [String] ID of the deleted batch.
|
|
27
39
|
#
|
|
28
40
|
# @param deleted [Boolean] Always true on success.
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Batch#get_results
|
|
6
6
|
class BatchGetResultsResponse < 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 data
|
|
8
15
|
# Result records on this page.
|
|
9
16
|
#
|
|
@@ -29,7 +36,12 @@ module ContextDev
|
|
|
29
36
|
# @return [String, nil]
|
|
30
37
|
optional :next_cursor, String, nil?: true
|
|
31
38
|
|
|
32
|
-
# @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
39
|
+
# @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {ContextDev::Models::BatchGetResultsResponse} for more details.
|
|
42
|
+
#
|
|
43
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
44
|
+
#
|
|
33
45
|
# @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
|
|
34
46
|
#
|
|
35
47
|
# @param has_more [Boolean] Whether another page is available.
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Batch#list
|
|
6
6
|
class BatchListResponse < 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 data
|
|
8
15
|
# Batches on this page.
|
|
9
16
|
#
|
|
@@ -28,7 +35,12 @@ module ContextDev
|
|
|
28
35
|
# @return [String, nil]
|
|
29
36
|
optional :next_cursor, String, nil?: true
|
|
30
37
|
|
|
31
|
-
# @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
38
|
+
# @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
39
|
+
# Some parameter documentations has been truncated, see
|
|
40
|
+
# {ContextDev::Models::BatchListResponse} for more details.
|
|
41
|
+
#
|
|
42
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
43
|
+
#
|
|
32
44
|
# @param data [Array<ContextDev::Models::BatchListResponse::Data>] Batches on this page.
|
|
33
45
|
#
|
|
34
46
|
# @param has_more [Boolean] Whether another page is available.
|
|
@@ -69,6 +69,13 @@ module ContextDev
|
|
|
69
69
|
# @return [ContextDev::Models::BatchRetrieveResponse::Progress]
|
|
70
70
|
required :progress, -> { ContextDev::Models::BatchRetrieveResponse::Progress }
|
|
71
71
|
|
|
72
|
+
# @!attribute request_id
|
|
73
|
+
# Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
74
|
+
# it when contacting support about a failed request.
|
|
75
|
+
#
|
|
76
|
+
# @return [String]
|
|
77
|
+
required :request_id, String
|
|
78
|
+
|
|
72
79
|
# @!attribute results
|
|
73
80
|
# Download links, available once the batch reaches a final status and null before
|
|
74
81
|
# then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
|
|
@@ -105,7 +112,7 @@ module ContextDev
|
|
|
105
112
|
# @return [String, nil]
|
|
106
113
|
optional :webhook_delivery_id, String
|
|
107
114
|
|
|
108
|
-
# @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
|
|
115
|
+
# @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, request_id:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
|
|
109
116
|
# Some parameter documentations has been truncated, see
|
|
110
117
|
# {ContextDev::Models::BatchRetrieveResponse} for more details.
|
|
111
118
|
#
|
|
@@ -130,6 +137,8 @@ module ContextDev
|
|
|
130
137
|
#
|
|
131
138
|
# @param progress [ContextDev::Models::BatchRetrieveResponse::Progress] Pages attempted so far. Use `status` to check completion.
|
|
132
139
|
#
|
|
140
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
141
|
+
#
|
|
133
142
|
# @param results [ContextDev::Models::BatchRetrieveResponse::Results, nil] Download links, available once the batch reaches a final status and null before
|
|
134
143
|
#
|
|
135
144
|
# @param status [Symbol, ContextDev::Models::BatchRetrieveResponse::Status] Current state. `completed`, `cancelled`, and `failed` are final.
|
|
@@ -62,6 +62,13 @@ module ContextDev
|
|
|
62
62
|
# @return [Symbol, ContextDev::Models::BatchSubmitResponse::Mode]
|
|
63
63
|
required :mode, enum: -> { ContextDev::Models::BatchSubmitResponse::Mode }
|
|
64
64
|
|
|
65
|
+
# @!attribute request_id
|
|
66
|
+
# Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
67
|
+
# it when contacting support about a failed request.
|
|
68
|
+
#
|
|
69
|
+
# @return [String]
|
|
70
|
+
required :request_id, String
|
|
71
|
+
|
|
65
72
|
# @!attribute status
|
|
66
73
|
# Always `queued`. An accepted batch has not started yet.
|
|
67
74
|
#
|
|
@@ -87,7 +94,7 @@ module ContextDev
|
|
|
87
94
|
# @return [String, nil]
|
|
88
95
|
optional :webhook_secret, String
|
|
89
96
|
|
|
90
|
-
# @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
|
|
97
|
+
# @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, request_id:, status:, tags:, key_metadata: nil, webhook_secret: nil)
|
|
91
98
|
# Some parameter documentations has been truncated, see
|
|
92
99
|
# {ContextDev::Models::BatchSubmitResponse} for more details.
|
|
93
100
|
#
|
|
@@ -109,6 +116,8 @@ module ContextDev
|
|
|
109
116
|
#
|
|
110
117
|
# @param mode [Symbol, ContextDev::Models::BatchSubmitResponse::Mode] How pages will be selected.
|
|
111
118
|
#
|
|
119
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
120
|
+
#
|
|
112
121
|
# @param status [Symbol, ContextDev::Models::BatchSubmitResponse::Status] Always `queued`. An accepted batch has not started yet.
|
|
113
122
|
#
|
|
114
123
|
# @param tags [Array<String>] Tags stored on the batch.
|
|
@@ -12,6 +12,13 @@ module ContextDev
|
|
|
12
12
|
# @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::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 brand
|
|
16
23
|
# Detailed brand information
|
|
17
24
|
#
|
|
@@ -36,12 +43,14 @@ module ContextDev
|
|
|
36
43
|
# @return [String, nil]
|
|
37
44
|
optional :status, String
|
|
38
45
|
|
|
39
|
-
# @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
|
|
46
|
+
# @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
|
|
40
47
|
# Some parameter documentations has been truncated, see
|
|
41
48
|
# {ContextDev::Models::BrandRetrieveResponse} for more details.
|
|
42
49
|
#
|
|
43
50
|
# @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
44
51
|
#
|
|
52
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
53
|
+
#
|
|
45
54
|
# @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
|
|
46
55
|
#
|
|
47
56
|
# @param code [Integer] HTTP status code
|
|
@@ -12,6 +12,13 @@ module ContextDev
|
|
|
12
12
|
# @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::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 brand
|
|
16
23
|
# Simplified brand information
|
|
17
24
|
#
|
|
@@ -36,12 +43,14 @@ module ContextDev
|
|
|
36
43
|
# @return [String, nil]
|
|
37
44
|
optional :status, String
|
|
38
45
|
|
|
39
|
-
# @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
|
|
46
|
+
# @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
|
|
40
47
|
# Some parameter documentations has been truncated, see
|
|
41
48
|
# {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
|
|
42
49
|
#
|
|
43
50
|
# @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
44
51
|
#
|
|
52
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
53
|
+
#
|
|
45
54
|
# @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
|
|
46
55
|
#
|
|
47
56
|
# @param code [Integer] HTTP status code of the response
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Brand#search
|
|
6
6
|
class BrandSearchResponse < 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 results
|
|
8
15
|
# Up to 10 matching brands, name matches first, then domain matches, most popular
|
|
9
16
|
# first within each group. Empty when nothing matches.
|
|
@@ -18,10 +25,12 @@ module ContextDev
|
|
|
18
25
|
# @return [ContextDev::Models::BrandSearchResponse::KeyMetadata, nil]
|
|
19
26
|
optional :key_metadata, -> { ContextDev::Models::BrandSearchResponse::KeyMetadata }
|
|
20
27
|
|
|
21
|
-
# @!method initialize(results:, key_metadata: nil)
|
|
28
|
+
# @!method initialize(request_id:, results:, key_metadata: nil)
|
|
22
29
|
# Some parameter documentations has been truncated, see
|
|
23
30
|
# {ContextDev::Models::BrandSearchResponse} for more details.
|
|
24
31
|
#
|
|
32
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
33
|
+
#
|
|
25
34
|
# @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, name matches first, then domain matches, most popular
|
|
26
35
|
#
|
|
27
36
|
# @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Industry#retrieve_naics
|
|
6
6
|
class IndustryRetrieveNaicsResponse < 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 codes
|
|
8
15
|
# Array of NAICS codes and titles.
|
|
9
16
|
#
|
|
@@ -35,7 +42,12 @@ module ContextDev
|
|
|
35
42
|
# @return [String, nil]
|
|
36
43
|
optional :type, String
|
|
37
44
|
|
|
38
|
-
# @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
45
|
+
# @!method initialize(request_id:, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
46
|
+
# Some parameter documentations has been truncated, see
|
|
47
|
+
# {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
|
|
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 codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
|
|
40
52
|
#
|
|
41
53
|
# @param domain [String] Domain found for the brand
|
|
@@ -4,6 +4,13 @@ module ContextDev
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see ContextDev::Resources::Industry#retrieve_sic
|
|
6
6
|
class IndustryRetrieveSicResponse < 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 classification
|
|
8
15
|
# Echoes back which SIC dataset was used to classify the brand.
|
|
9
16
|
#
|
|
@@ -43,10 +50,12 @@ module ContextDev
|
|
|
43
50
|
# @return [String, nil]
|
|
44
51
|
optional :type, String
|
|
45
52
|
|
|
46
|
-
# @!method initialize(classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
53
|
+
# @!method initialize(request_id:, classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
47
54
|
# Some parameter documentations has been truncated, see
|
|
48
55
|
# {ContextDev::Models::IndustryRetrieveSicResponse} for more details.
|
|
49
56
|
#
|
|
57
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
58
|
+
#
|
|
50
59
|
# @param classification [Symbol, ContextDev::Models::IndustryRetrieveSicResponse::Classification] Echoes back which SIC dataset was used to classify the brand.
|
|
51
60
|
#
|
|
52
61
|
# @param codes [Array<ContextDev::Models::IndustryRetrieveSicResponse::Code>] Array of SIC codes with confidence scores. Extra fields depend on the requested
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Logs#list
|
|
6
|
+
class LogListParams < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
extend ContextDev::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include ContextDev::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute error_code
|
|
11
|
+
# Filter by the `error_code` returned in the response.
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :error_code, String
|
|
15
|
+
|
|
16
|
+
# @!attribute errors_only
|
|
17
|
+
# Only include requests that returned a 4xx or 5xx status.
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :errors_only, ContextDev::Internal::Type::Boolean
|
|
21
|
+
|
|
22
|
+
# @!attribute from
|
|
23
|
+
# Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
|
|
24
|
+
# before `to`.
|
|
25
|
+
#
|
|
26
|
+
# @return [Time, nil]
|
|
27
|
+
optional :from, Time
|
|
28
|
+
|
|
29
|
+
# @!attribute key_id
|
|
30
|
+
# Filter by the API key that made the request.
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :key_id, String
|
|
34
|
+
|
|
35
|
+
# @!attribute limit
|
|
36
|
+
# Number of log entries per page.
|
|
37
|
+
#
|
|
38
|
+
# @return [Integer, nil]
|
|
39
|
+
optional :limit, Integer
|
|
40
|
+
|
|
41
|
+
# @!attribute page
|
|
42
|
+
# Page number, starting at 1.
|
|
43
|
+
#
|
|
44
|
+
# @return [Integer, nil]
|
|
45
|
+
optional :page, Integer
|
|
46
|
+
|
|
47
|
+
# @!attribute path
|
|
48
|
+
# Filter by endpoint path, with or without the /v1 prefix.
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :path, String
|
|
52
|
+
|
|
53
|
+
# @!attribute search
|
|
54
|
+
# Case-insensitive substring match against the request query and body, e.g. a
|
|
55
|
+
# domain.
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :search, String
|
|
59
|
+
|
|
60
|
+
# @!attribute status_code
|
|
61
|
+
# Filter by exact HTTP status code.
|
|
62
|
+
#
|
|
63
|
+
# @return [Integer, nil]
|
|
64
|
+
optional :status_code, Integer
|
|
65
|
+
|
|
66
|
+
# @!attribute tags
|
|
67
|
+
# Comma-separated request tags. Matches requests carrying any of them. Up to 20
|
|
68
|
+
# tags, each 1-50 characters.
|
|
69
|
+
#
|
|
70
|
+
# @return [String, nil]
|
|
71
|
+
optional :tags, String
|
|
72
|
+
|
|
73
|
+
# @!attribute to
|
|
74
|
+
# Only include requests at or before this ISO 8601 timestamp. Defaults to now.
|
|
75
|
+
#
|
|
76
|
+
# @return [Time, nil]
|
|
77
|
+
optional :to, Time
|
|
78
|
+
|
|
79
|
+
# @!method initialize(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: {})
|
|
80
|
+
# Some parameter documentations has been truncated, see
|
|
81
|
+
# {ContextDev::Models::LogListParams} for more details.
|
|
82
|
+
#
|
|
83
|
+
# @param error_code [String] Filter by the `error_code` returned in the response.
|
|
84
|
+
#
|
|
85
|
+
# @param errors_only [Boolean] Only include requests that returned a 4xx or 5xx status.
|
|
86
|
+
#
|
|
87
|
+
# @param from [Time] Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
|
|
88
|
+
#
|
|
89
|
+
# @param key_id [String] Filter by the API key that made the request.
|
|
90
|
+
#
|
|
91
|
+
# @param limit [Integer] Number of log entries per page.
|
|
92
|
+
#
|
|
93
|
+
# @param page [Integer] Page number, starting at 1.
|
|
94
|
+
#
|
|
95
|
+
# @param path [String] Filter by endpoint path, with or without the /v1 prefix.
|
|
96
|
+
#
|
|
97
|
+
# @param search [String] Case-insensitive substring match against the request query and body, e.g. a doma
|
|
98
|
+
#
|
|
99
|
+
# @param status_code [Integer] Filter by exact HTTP status code.
|
|
100
|
+
#
|
|
101
|
+
# @param tags [String] Comma-separated request tags. Matches requests carrying any of them. Up to 20 ta
|
|
102
|
+
#
|
|
103
|
+
# @param to [Time] Only include requests at or before this ISO 8601 timestamp. Defaults to now.
|
|
104
|
+
#
|
|
105
|
+
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|