context.dev 2.15.0 → 2.17.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 +30 -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_params.rb +53 -8
- data/lib/context_dev/models/ai_extract_product_response.rb +19 -1
- data/lib/context_dev/models/ai_extract_products_params.rb +116 -16
- data/lib/context_dev/models/ai_extract_products_response.rb +20 -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_params.rb +355 -60
- data/lib/context_dev/models/brand_retrieve_response.rb +19 -1
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +57 -11
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +19 -1
- data/lib/context_dev/models/brand_search_response.rb +10 -1
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +53 -8
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +22 -1
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +53 -8
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +19 -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/monitor_create_params.rb +27 -3
- data/lib/context_dev/models/monitor_create_response.rb +30 -5
- data/lib/context_dev/models/monitor_list_response.rb +30 -5
- data/lib/context_dev/models/monitor_retrieve_response.rb +30 -5
- data/lib/context_dev/models/monitor_update_params.rb +27 -3
- data/lib/context_dev/models/monitor_update_response.rb +30 -5
- 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_params.rb +53 -8
- data/lib/context_dev/models/person_enrich_response.rb +22 -1
- data/lib/context_dev/models/utility_prefetch_params.rb +48 -8
- data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
- data/lib/context_dev/models/web_answers_params.rb +124 -0
- data/lib/context_dev/models/web_answers_response.rb +68 -0
- data/lib/context_dev/models/web_extract_competitors_params.rb +53 -8
- data/lib/context_dev/models/web_extract_competitors_response.rb +22 -1
- data/lib/context_dev/models/web_extract_fonts_params.rb +58 -11
- data/lib/context_dev/models/web_extract_fonts_response.rb +41 -1
- data/lib/context_dev/models/web_extract_params.rb +53 -8
- data/lib/context_dev/models/web_extract_response.rb +19 -1
- data/lib/context_dev/models/web_extract_styleguide_params.rb +58 -11
- data/lib/context_dev/models/web_extract_styleguide_response.rb +41 -1
- data/lib/context_dev/models/web_screenshot_params.rb +58 -9
- data/lib/context_dev/models/web_screenshot_response.rb +41 -1
- data/lib/context_dev/models/web_search_params.rb +112 -16
- data/lib/context_dev/models/web_search_response.rb +52 -2
- data/lib/context_dev/models/web_web_crawl_md_params.rb +53 -8
- data/lib/context_dev/models/web_web_crawl_md_response.rb +20 -1
- data/lib/context_dev/models/web_web_scrape_bytes_params.rb +344 -0
- data/lib/context_dev/models/web_web_scrape_bytes_response.rb +135 -0
- data/lib/context_dev/models/web_web_scrape_html_params.rb +58 -9
- data/lib/context_dev/models/web_web_scrape_html_response.rb +41 -1
- data/lib/context_dev/models/web_web_scrape_images_params.rb +58 -9
- data/lib/context_dev/models/web_web_scrape_images_response.rb +51 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +58 -9
- data/lib/context_dev/models/web_web_scrape_md_response.rb +41 -1
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +53 -8
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +20 -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 +8 -0
- data/lib/context_dev/resources/ai.rb +2 -2
- data/lib/context_dev/resources/brand.rb +3 -3
- data/lib/context_dev/resources/industry.rb +6 -6
- data/lib/context_dev/resources/logs.rb +83 -0
- data/lib/context_dev/resources/people.rb +2 -2
- data/lib/context_dev/resources/utility.rb +2 -2
- data/lib/context_dev/resources/web.rb +119 -33
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +9 -0
- data/rbi/context_dev/client.rbi +5 -0
- data/rbi/context_dev/models/ai_extract_product_params.rbi +125 -13
- data/rbi/context_dev/models/ai_extract_product_response.rbi +23 -0
- data/rbi/context_dev/models/ai_extract_products_params.rbi +264 -26
- data/rbi/context_dev/models/ai_extract_products_response.rbi +25 -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_params.rbi +816 -102
- data/rbi/context_dev/models/brand_retrieve_response.rbi +23 -0
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +136 -19
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +23 -0
- data/rbi/context_dev/models/brand_search_response.rbi +10 -0
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +127 -13
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +23 -0
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +127 -13
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +23 -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/monitor_create_params.rbi +40 -2
- data/rbi/context_dev/models/monitor_create_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_list_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_update_params.rbi +40 -2
- data/rbi/context_dev/models/monitor_update_response.rbi +44 -4
- 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_params.rbi +123 -13
- data/rbi/context_dev/models/person_enrich_response.rbi +26 -3
- data/rbi/context_dev/models/utility_prefetch_params.rbi +112 -13
- data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
- data/rbi/context_dev/models/web_answers_params.rbi +234 -0
- data/rbi/context_dev/models/web_answers_response.rbi +122 -0
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +127 -13
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +26 -3
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +132 -19
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +81 -0
- data/rbi/context_dev/models/web_extract_params.rbi +120 -13
- data/rbi/context_dev/models/web_extract_response.rbi +26 -3
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +136 -19
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +81 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +132 -15
- data/rbi/context_dev/models/web_screenshot_response.rbi +81 -0
- data/rbi/context_dev/models/web_search_params.rbi +253 -26
- data/rbi/context_dev/models/web_search_response.rbi +102 -6
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +123 -13
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +29 -3
- data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +699 -0
- data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +238 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +134 -15
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +71 -0
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +136 -15
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +99 -3
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +132 -15
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +71 -0
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +127 -13
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +28 -3
- 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 +8 -0
- data/rbi/context_dev/resources/ai.rbi +5 -5
- data/rbi/context_dev/resources/brand.rbi +9 -8
- data/rbi/context_dev/resources/industry.rbi +12 -10
- data/rbi/context_dev/resources/logs.rbi +76 -0
- data/rbi/context_dev/resources/people.rbi +5 -5
- data/rbi/context_dev/resources/utility.rbi +5 -5
- data/rbi/context_dev/resources/web.rbi +173 -68
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/ai_extract_product_params.rbs +44 -5
- data/sig/context_dev/models/ai_extract_product_response.rbs +12 -0
- data/sig/context_dev/models/ai_extract_products_params.rbs +88 -10
- data/sig/context_dev/models/ai_extract_products_response.rbs +12 -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_params.rbs +264 -30
- data/sig/context_dev/models/brand_retrieve_response.rbs +12 -0
- data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +44 -5
- data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +12 -0
- data/sig/context_dev/models/brand_search_response.rbs +5 -0
- data/sig/context_dev/models/industry_retrieve_naics_params.rbs +44 -5
- data/sig/context_dev/models/industry_retrieve_naics_response.rbs +12 -0
- data/sig/context_dev/models/industry_retrieve_sic_params.rbs +44 -5
- data/sig/context_dev/models/industry_retrieve_sic_response.rbs +12 -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/monitor_create_params.rbs +14 -0
- data/sig/context_dev/models/monitor_create_response.rbs +14 -0
- data/sig/context_dev/models/monitor_list_response.rbs +14 -0
- data/sig/context_dev/models/monitor_retrieve_response.rbs +14 -0
- data/sig/context_dev/models/monitor_update_params.rbs +14 -0
- data/sig/context_dev/models/monitor_update_response.rbs +14 -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_params.rbs +44 -5
- data/sig/context_dev/models/person_enrich_response.rbs +15 -3
- data/sig/context_dev/models/utility_prefetch_params.rbs +43 -5
- data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
- data/sig/context_dev/models/web_answers_params.rbs +106 -0
- data/sig/context_dev/models/web_answers_response.rbs +60 -0
- data/sig/context_dev/models/web_extract_competitors_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_competitors_response.rbs +15 -3
- data/sig/context_dev/models/web_extract_fonts_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_fonts_response.rbs +25 -0
- data/sig/context_dev/models/web_extract_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_response.rbs +15 -3
- data/sig/context_dev/models/web_extract_styleguide_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_styleguide_response.rbs +25 -0
- data/sig/context_dev/models/web_screenshot_params.rbs +44 -5
- data/sig/context_dev/models/web_screenshot_response.rbs +25 -0
- data/sig/context_dev/models/web_search_params.rbs +88 -10
- data/sig/context_dev/models/web_search_response.rbs +38 -6
- data/sig/context_dev/models/web_web_crawl_md_params.rbs +44 -5
- data/sig/context_dev/models/web_web_crawl_md_response.rbs +15 -3
- data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +531 -0
- data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +108 -0
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +21 -0
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_images_response.rbs +35 -3
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +21 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +15 -3
- 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 +8 -0
- data/sig/context_dev/resources/ai.rbs +1 -1
- data/sig/context_dev/resources/brand.rbs +1 -1
- data/sig/context_dev/resources/industry.rbs +2 -2
- data/sig/context_dev/resources/logs.rbs +27 -0
- data/sig/context_dev/resources/people.rbs +1 -1
- data/sig/context_dev/resources/utility.rbs +1 -1
- data/sig/context_dev/resources/web.rbs +30 -11
- metadata +29 -2
|
@@ -15,9 +15,9 @@ module ContextDev
|
|
|
15
15
|
|
|
16
16
|
# @!attribute max_age_ms
|
|
17
17
|
# Maximum age in milliseconds for cached brand data before the API performs a hard
|
|
18
|
-
# refresh. Defaults to 3 months (7776000000 ms).
|
|
19
|
-
# are clamped to
|
|
20
|
-
# year.
|
|
18
|
+
# refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
|
|
19
|
+
# refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
|
|
20
|
+
# are clamped to 1 year.
|
|
21
21
|
#
|
|
22
22
|
# @return [Integer, nil]
|
|
23
23
|
optional :max_age_ms, Integer, nil?: true
|
|
@@ -35,15 +35,15 @@ module ContextDev
|
|
|
35
35
|
# @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme, nil]
|
|
36
36
|
optional :theme, enum: -> { ContextDev::BrandRetrieveSimplifiedParams::Theme }
|
|
37
37
|
|
|
38
|
-
# @!attribute
|
|
39
|
-
# Optional
|
|
40
|
-
#
|
|
41
|
-
#
|
|
38
|
+
# @!attribute timeout_opts
|
|
39
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
40
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
41
|
+
# timeoutOpts object.
|
|
42
42
|
#
|
|
43
|
-
# @return [
|
|
44
|
-
optional :
|
|
43
|
+
# @return [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts, nil]
|
|
44
|
+
optional :timeout_opts, -> { ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts }
|
|
45
45
|
|
|
46
|
-
# @!method initialize(domain:, max_age_ms: nil, tags: nil, theme: nil,
|
|
46
|
+
# @!method initialize(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
|
|
47
47
|
# Some parameter documentations has been truncated, see
|
|
48
48
|
# {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
|
|
49
49
|
#
|
|
@@ -55,7 +55,7 @@ module ContextDev
|
|
|
55
55
|
#
|
|
56
56
|
# @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
|
|
57
57
|
#
|
|
58
|
-
# @param
|
|
58
|
+
# @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
59
59
|
#
|
|
60
60
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
61
61
|
|
|
@@ -69,6 +69,52 @@ module ContextDev
|
|
|
69
69
|
# @!method self.values
|
|
70
70
|
# @return [Array<Symbol>]
|
|
71
71
|
end
|
|
72
|
+
|
|
73
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
74
|
+
# @!attribute milliseconds
|
|
75
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
76
|
+
#
|
|
77
|
+
# @return [Integer]
|
|
78
|
+
required :milliseconds, Integer
|
|
79
|
+
|
|
80
|
+
# @!attribute behavior
|
|
81
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
82
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
83
|
+
# available, the request still fails without charging credits. Partial results are
|
|
84
|
+
# not cached as complete results.
|
|
85
|
+
#
|
|
86
|
+
# @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior, nil]
|
|
87
|
+
optional :behavior, enum: -> { ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior }
|
|
88
|
+
|
|
89
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts} for more
|
|
92
|
+
# details.
|
|
93
|
+
#
|
|
94
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
95
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
96
|
+
# timeoutOpts object.
|
|
97
|
+
#
|
|
98
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
99
|
+
#
|
|
100
|
+
# @param behavior [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
101
|
+
|
|
102
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
103
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
104
|
+
# available, the request still fails without charging credits. Partial results are
|
|
105
|
+
# not cached as complete results.
|
|
106
|
+
#
|
|
107
|
+
# @see ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts#behavior
|
|
108
|
+
module Behavior
|
|
109
|
+
extend ContextDev::Internal::Type::Enum
|
|
110
|
+
|
|
111
|
+
FAIL = :fail
|
|
112
|
+
RETURN_PARTIAL = :"return-partial"
|
|
113
|
+
|
|
114
|
+
# @!method self.values
|
|
115
|
+
# @return [Array<Symbol>]
|
|
116
|
+
end
|
|
117
|
+
end
|
|
72
118
|
end
|
|
73
119
|
end
|
|
74
120
|
end
|
|
@@ -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
|
#
|
|
@@ -30,24 +37,35 @@ module ContextDev
|
|
|
30
37
|
# @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
|
|
31
38
|
optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
|
|
32
39
|
|
|
40
|
+
# @!attribute partial
|
|
41
|
+
# True when the timeout ended processing and only completed brand data is
|
|
42
|
+
# returned.
|
|
43
|
+
#
|
|
44
|
+
# @return [Boolean, nil]
|
|
45
|
+
optional :partial, ContextDev::Internal::Type::Boolean
|
|
46
|
+
|
|
33
47
|
# @!attribute status
|
|
34
48
|
# Status of the response, e.g., 'ok'
|
|
35
49
|
#
|
|
36
50
|
# @return [String, nil]
|
|
37
51
|
optional :status, String
|
|
38
52
|
|
|
39
|
-
# @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
|
|
53
|
+
# @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, partial: nil, status: nil)
|
|
40
54
|
# Some parameter documentations has been truncated, see
|
|
41
55
|
# {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
|
|
42
56
|
#
|
|
43
57
|
# @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
44
58
|
#
|
|
59
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
60
|
+
#
|
|
45
61
|
# @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
|
|
46
62
|
#
|
|
47
63
|
# @param code [Integer] HTTP status code of the response
|
|
48
64
|
#
|
|
49
65
|
# @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
50
66
|
#
|
|
67
|
+
# @param partial [Boolean] True when the timeout ended processing and only completed brand data is returned
|
|
68
|
+
#
|
|
51
69
|
# @param status [String] Status of the response, e.g., 'ok'
|
|
52
70
|
|
|
53
71
|
# @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
|
|
@@ -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.
|
|
@@ -35,15 +35,15 @@ module ContextDev
|
|
|
35
35
|
# @return [Array<String>, nil]
|
|
36
36
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
37
37
|
|
|
38
|
-
# @!attribute
|
|
39
|
-
# Optional
|
|
40
|
-
#
|
|
41
|
-
#
|
|
38
|
+
# @!attribute timeout_opts
|
|
39
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
40
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
41
|
+
# timeoutOpts object.
|
|
42
42
|
#
|
|
43
|
-
# @return [
|
|
44
|
-
optional :
|
|
43
|
+
# @return [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts, nil]
|
|
44
|
+
optional :timeout_opts, -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts }
|
|
45
45
|
|
|
46
|
-
# @!method initialize(input:, max_results: nil, min_results: nil, tags: nil,
|
|
46
|
+
# @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
|
|
47
47
|
# Some parameter documentations has been truncated, see
|
|
48
48
|
# {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
|
|
49
49
|
#
|
|
@@ -55,9 +55,54 @@ module ContextDev
|
|
|
55
55
|
#
|
|
56
56
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
57
57
|
#
|
|
58
|
-
# @param
|
|
58
|
+
# @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
59
59
|
#
|
|
60
60
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
61
|
+
|
|
62
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
63
|
+
# @!attribute milliseconds
|
|
64
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
65
|
+
#
|
|
66
|
+
# @return [Integer]
|
|
67
|
+
required :milliseconds, Integer
|
|
68
|
+
|
|
69
|
+
# @!attribute behavior
|
|
70
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
71
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
72
|
+
# available, the request still fails without charging credits. Partial results are
|
|
73
|
+
# not cached as complete results.
|
|
74
|
+
#
|
|
75
|
+
# @return [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior, nil]
|
|
76
|
+
optional :behavior, enum: -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior }
|
|
77
|
+
|
|
78
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
79
|
+
# Some parameter documentations has been truncated, see
|
|
80
|
+
# {ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts} for more details.
|
|
81
|
+
#
|
|
82
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
83
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
84
|
+
# timeoutOpts object.
|
|
85
|
+
#
|
|
86
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
87
|
+
#
|
|
88
|
+
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
89
|
+
|
|
90
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
91
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
92
|
+
# available, the request still fails without charging credits. Partial results are
|
|
93
|
+
# not cached as complete results.
|
|
94
|
+
#
|
|
95
|
+
# @see ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts#behavior
|
|
96
|
+
module Behavior
|
|
97
|
+
extend ContextDev::Internal::Type::Enum
|
|
98
|
+
|
|
99
|
+
FAIL = :fail
|
|
100
|
+
RETURN_PARTIAL = :"return-partial"
|
|
101
|
+
|
|
102
|
+
# @!method self.values
|
|
103
|
+
# @return [Array<Symbol>]
|
|
104
|
+
end
|
|
105
|
+
end
|
|
61
106
|
end
|
|
62
107
|
end
|
|
63
108
|
end
|
|
@@ -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
|
#
|
|
@@ -23,6 +30,13 @@ module ContextDev
|
|
|
23
30
|
# @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
|
|
24
31
|
optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata }
|
|
25
32
|
|
|
33
|
+
# @!attribute partial
|
|
34
|
+
# True when the timeout ended processing and this response contains only usable
|
|
35
|
+
# results completed so far. Unfinished results are omitted.
|
|
36
|
+
#
|
|
37
|
+
# @return [Boolean, nil]
|
|
38
|
+
optional :partial, ContextDev::Internal::Type::Boolean
|
|
39
|
+
|
|
26
40
|
# @!attribute status
|
|
27
41
|
# Status of the response, e.g., 'ok'
|
|
28
42
|
#
|
|
@@ -35,13 +49,20 @@ module ContextDev
|
|
|
35
49
|
# @return [String, nil]
|
|
36
50
|
optional :type, String
|
|
37
51
|
|
|
38
|
-
# @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
52
|
+
# @!method initialize(request_id:, codes: nil, domain: nil, key_metadata: nil, partial: nil, status: nil, type: nil)
|
|
53
|
+
# Some parameter documentations has been truncated, see
|
|
54
|
+
# {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
|
|
55
|
+
#
|
|
56
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
57
|
+
#
|
|
39
58
|
# @param codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
|
|
40
59
|
#
|
|
41
60
|
# @param domain [String] Domain found for the brand
|
|
42
61
|
#
|
|
43
62
|
# @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
44
63
|
#
|
|
64
|
+
# @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
|
|
65
|
+
#
|
|
45
66
|
# @param status [String] Status of the response, e.g., 'ok'
|
|
46
67
|
#
|
|
47
68
|
# @param type [String] Industry classification type, for naics api it will be `naics`
|
|
@@ -34,13 +34,13 @@ module ContextDev
|
|
|
34
34
|
# @return [Array<String>, nil]
|
|
35
35
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
36
36
|
|
|
37
|
-
# @!attribute
|
|
38
|
-
# Optional
|
|
39
|
-
#
|
|
40
|
-
#
|
|
37
|
+
# @!attribute timeout_opts
|
|
38
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
39
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
40
|
+
# timeoutOpts object.
|
|
41
41
|
#
|
|
42
|
-
# @return [
|
|
43
|
-
optional :
|
|
42
|
+
# @return [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts, nil]
|
|
43
|
+
optional :timeout_opts, -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts }
|
|
44
44
|
|
|
45
45
|
# @!attribute type
|
|
46
46
|
# Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
|
|
@@ -50,7 +50,7 @@ module ContextDev
|
|
|
50
50
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
|
|
51
51
|
optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
|
|
52
52
|
|
|
53
|
-
# @!method initialize(input:, max_results: nil, min_results: nil, tags: nil,
|
|
53
|
+
# @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
|
|
54
54
|
# Some parameter documentations has been truncated, see
|
|
55
55
|
# {ContextDev::Models::IndustryRetrieveSicParams} for more details.
|
|
56
56
|
#
|
|
@@ -62,12 +62,57 @@ module ContextDev
|
|
|
62
62
|
#
|
|
63
63
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
64
64
|
#
|
|
65
|
-
# @param
|
|
65
|
+
# @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
66
66
|
#
|
|
67
67
|
# @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
|
|
68
68
|
#
|
|
69
69
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
70
70
|
|
|
71
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
72
|
+
# @!attribute milliseconds
|
|
73
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
74
|
+
#
|
|
75
|
+
# @return [Integer]
|
|
76
|
+
required :milliseconds, Integer
|
|
77
|
+
|
|
78
|
+
# @!attribute behavior
|
|
79
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
80
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
81
|
+
# available, the request still fails without charging credits. Partial results are
|
|
82
|
+
# not cached as complete results.
|
|
83
|
+
#
|
|
84
|
+
# @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts::Behavior, nil]
|
|
85
|
+
optional :behavior, enum: -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior }
|
|
86
|
+
|
|
87
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
88
|
+
# Some parameter documentations has been truncated, see
|
|
89
|
+
# {ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts} for more details.
|
|
90
|
+
#
|
|
91
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
92
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
93
|
+
# timeoutOpts object.
|
|
94
|
+
#
|
|
95
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
96
|
+
#
|
|
97
|
+
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
98
|
+
|
|
99
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
100
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
101
|
+
# available, the request still fails without charging credits. Partial results are
|
|
102
|
+
# not cached as complete results.
|
|
103
|
+
#
|
|
104
|
+
# @see ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts#behavior
|
|
105
|
+
module Behavior
|
|
106
|
+
extend ContextDev::Internal::Type::Enum
|
|
107
|
+
|
|
108
|
+
FAIL = :fail
|
|
109
|
+
RETURN_PARTIAL = :"return-partial"
|
|
110
|
+
|
|
111
|
+
# @!method self.values
|
|
112
|
+
# @return [Array<Symbol>]
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
|
|
71
116
|
# Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
|
|
72
117
|
# Industrial Classification system; `latest_sec` uses the current SIC list as
|
|
73
118
|
# published by the SEC. Defaults to `original_sic`.
|
|
@@ -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
|
#
|
|
@@ -31,6 +38,13 @@ module ContextDev
|
|
|
31
38
|
# @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil]
|
|
32
39
|
optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
|
|
33
40
|
|
|
41
|
+
# @!attribute partial
|
|
42
|
+
# True when the timeout ended processing and this response contains only usable
|
|
43
|
+
# results completed so far. Unfinished results are omitted.
|
|
44
|
+
#
|
|
45
|
+
# @return [Boolean, nil]
|
|
46
|
+
optional :partial, ContextDev::Internal::Type::Boolean
|
|
47
|
+
|
|
34
48
|
# @!attribute status
|
|
35
49
|
# Status of the response, e.g., 'ok'
|
|
36
50
|
#
|
|
@@ -43,10 +57,12 @@ module ContextDev
|
|
|
43
57
|
# @return [String, nil]
|
|
44
58
|
optional :type, String
|
|
45
59
|
|
|
46
|
-
# @!method initialize(classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
|
|
60
|
+
# @!method initialize(request_id:, classification: nil, codes: nil, domain: nil, key_metadata: nil, partial: nil, status: nil, type: nil)
|
|
47
61
|
# Some parameter documentations has been truncated, see
|
|
48
62
|
# {ContextDev::Models::IndustryRetrieveSicResponse} for more details.
|
|
49
63
|
#
|
|
64
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
65
|
+
#
|
|
50
66
|
# @param classification [Symbol, ContextDev::Models::IndustryRetrieveSicResponse::Classification] Echoes back which SIC dataset was used to classify the brand.
|
|
51
67
|
#
|
|
52
68
|
# @param codes [Array<ContextDev::Models::IndustryRetrieveSicResponse::Code>] Array of SIC codes with confidence scores. Extra fields depend on the requested
|
|
@@ -55,6 +71,8 @@ module ContextDev
|
|
|
55
71
|
#
|
|
56
72
|
# @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
57
73
|
#
|
|
74
|
+
# @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
|
|
75
|
+
#
|
|
58
76
|
# @param status [String] Status of the response, e.g., 'ok'
|
|
59
77
|
#
|
|
60
78
|
# @param type [String] Industry classification type, for sic api it will be `sic`
|
|
@@ -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
|