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
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Logs#list
|
|
6
|
+
class LogListResponse < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# Log entries, newest first.
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<ContextDev::Models::LogListResponse::Data>]
|
|
11
|
+
required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::LogListResponse::Data] }
|
|
12
|
+
|
|
13
|
+
# @!attribute has_more
|
|
14
|
+
# Whether a next page exists.
|
|
15
|
+
#
|
|
16
|
+
# @return [Boolean]
|
|
17
|
+
required :has_more, ContextDev::Internal::Type::Boolean
|
|
18
|
+
|
|
19
|
+
# @!attribute limit
|
|
20
|
+
# Entries per page.
|
|
21
|
+
#
|
|
22
|
+
# @return [Integer]
|
|
23
|
+
required :limit, Integer
|
|
24
|
+
|
|
25
|
+
# @!attribute page
|
|
26
|
+
# Current page number.
|
|
27
|
+
#
|
|
28
|
+
# @return [Integer]
|
|
29
|
+
required :page, Integer
|
|
30
|
+
|
|
31
|
+
# @!attribute request_id
|
|
32
|
+
# Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
33
|
+
# it when contacting support about a failed request.
|
|
34
|
+
#
|
|
35
|
+
# @return [String]
|
|
36
|
+
required :request_id, String
|
|
37
|
+
|
|
38
|
+
# @!attribute key_metadata
|
|
39
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
40
|
+
#
|
|
41
|
+
# @return [ContextDev::Models::LogListResponse::KeyMetadata, nil]
|
|
42
|
+
optional :key_metadata, -> { ContextDev::Models::LogListResponse::KeyMetadata }
|
|
43
|
+
|
|
44
|
+
# @!method initialize(data:, has_more:, limit:, page:, request_id:, key_metadata: nil)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {ContextDev::Models::LogListResponse} for more details.
|
|
47
|
+
#
|
|
48
|
+
# @param data [Array<ContextDev::Models::LogListResponse::Data>] Log entries, newest first.
|
|
49
|
+
#
|
|
50
|
+
# @param has_more [Boolean] Whether a next page exists.
|
|
51
|
+
#
|
|
52
|
+
# @param limit [Integer] Entries per page.
|
|
53
|
+
#
|
|
54
|
+
# @param page [Integer] Current page number.
|
|
55
|
+
#
|
|
56
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
57
|
+
#
|
|
58
|
+
# @param key_metadata [ContextDev::Models::LogListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
59
|
+
|
|
60
|
+
class Data < ContextDev::Internal::Type::BaseModel
|
|
61
|
+
# @!attribute credits_used
|
|
62
|
+
# Credits charged for this request.
|
|
63
|
+
#
|
|
64
|
+
# @return [Integer]
|
|
65
|
+
required :credits_used, Integer
|
|
66
|
+
|
|
67
|
+
# @!attribute error_code
|
|
68
|
+
# The `error_code` from the response, or null on success.
|
|
69
|
+
#
|
|
70
|
+
# @return [String, nil]
|
|
71
|
+
required :error_code, String, nil?: true
|
|
72
|
+
|
|
73
|
+
# @!attribute key_id
|
|
74
|
+
# ID of the API key that made the request.
|
|
75
|
+
#
|
|
76
|
+
# @return [String, nil]
|
|
77
|
+
required :key_id, String, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!attribute latency_ms
|
|
80
|
+
# Server-side processing time in milliseconds.
|
|
81
|
+
#
|
|
82
|
+
# @return [Float]
|
|
83
|
+
required :latency_ms, Float
|
|
84
|
+
|
|
85
|
+
# @!attribute method_
|
|
86
|
+
# HTTP method.
|
|
87
|
+
#
|
|
88
|
+
# @return [String]
|
|
89
|
+
required :method_, String, api_name: :method
|
|
90
|
+
|
|
91
|
+
# @!attribute path
|
|
92
|
+
# Endpoint path as called.
|
|
93
|
+
#
|
|
94
|
+
# @return [String]
|
|
95
|
+
required :path, String
|
|
96
|
+
|
|
97
|
+
# @!attribute request_id
|
|
98
|
+
# Request ID of the logged API call.
|
|
99
|
+
#
|
|
100
|
+
# @return [String]
|
|
101
|
+
required :request_id, String
|
|
102
|
+
|
|
103
|
+
# @!attribute status_code
|
|
104
|
+
# HTTP status code returned.
|
|
105
|
+
#
|
|
106
|
+
# @return [Integer]
|
|
107
|
+
required :status_code, Integer
|
|
108
|
+
|
|
109
|
+
# @!attribute tags
|
|
110
|
+
# Request tags supplied by the caller.
|
|
111
|
+
#
|
|
112
|
+
# @return [Array<String>]
|
|
113
|
+
required :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
114
|
+
|
|
115
|
+
# @!attribute timestamp
|
|
116
|
+
# When the request completed.
|
|
117
|
+
#
|
|
118
|
+
# @return [Time]
|
|
119
|
+
required :timestamp, Time
|
|
120
|
+
|
|
121
|
+
# @!attribute zdr
|
|
122
|
+
# Whether the request was made under zero data retention.
|
|
123
|
+
#
|
|
124
|
+
# @return [Boolean]
|
|
125
|
+
required :zdr, ContextDev::Internal::Type::Boolean
|
|
126
|
+
|
|
127
|
+
# @!method initialize(credits_used:, error_code:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, zdr:)
|
|
128
|
+
# @param credits_used [Integer] Credits charged for this request.
|
|
129
|
+
#
|
|
130
|
+
# @param error_code [String, nil] The `error_code` from the response, or null on success.
|
|
131
|
+
#
|
|
132
|
+
# @param key_id [String, nil] ID of the API key that made the request.
|
|
133
|
+
#
|
|
134
|
+
# @param latency_ms [Float] Server-side processing time in milliseconds.
|
|
135
|
+
#
|
|
136
|
+
# @param method_ [String] HTTP method.
|
|
137
|
+
#
|
|
138
|
+
# @param path [String] Endpoint path as called.
|
|
139
|
+
#
|
|
140
|
+
# @param request_id [String] Request ID of the logged API call.
|
|
141
|
+
#
|
|
142
|
+
# @param status_code [Integer] HTTP status code returned.
|
|
143
|
+
#
|
|
144
|
+
# @param tags [Array<String>] Request tags supplied by the caller.
|
|
145
|
+
#
|
|
146
|
+
# @param timestamp [Time] When the request completed.
|
|
147
|
+
#
|
|
148
|
+
# @param zdr [Boolean] Whether the request was made under zero data retention.
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# @see ContextDev::Models::LogListResponse#key_metadata
|
|
152
|
+
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
153
|
+
# @!attribute credits_consumed
|
|
154
|
+
# Credits used by this request.
|
|
155
|
+
#
|
|
156
|
+
# @return [Integer]
|
|
157
|
+
required :credits_consumed, Integer
|
|
158
|
+
|
|
159
|
+
# @!attribute credits_remaining
|
|
160
|
+
# Credits remaining for your organization.
|
|
161
|
+
#
|
|
162
|
+
# @return [Integer]
|
|
163
|
+
required :credits_remaining, Integer
|
|
164
|
+
|
|
165
|
+
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
166
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
167
|
+
#
|
|
168
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
169
|
+
#
|
|
170
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Logs#retrieve
|
|
6
|
+
class LogRetrieveParams < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
extend ContextDev::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include ContextDev::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute request_id
|
|
11
|
+
# The request ID of the logged API call.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :request_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(request_id:, request_options: {})
|
|
17
|
+
# @param request_id [String] The request ID of the logged API call.
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
# @see ContextDev::Resources::Logs#retrieve
|
|
6
|
+
class LogRetrieveResponse < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [ContextDev::Models::LogRetrieveResponse::Data]
|
|
10
|
+
required :data, -> { ContextDev::Models::LogRetrieveResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!attribute request_id
|
|
13
|
+
# Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
14
|
+
# it when contacting support about a failed request.
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :request_id, String
|
|
18
|
+
|
|
19
|
+
# @!attribute key_metadata
|
|
20
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
21
|
+
#
|
|
22
|
+
# @return [ContextDev::Models::LogRetrieveResponse::KeyMetadata, nil]
|
|
23
|
+
optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::KeyMetadata }
|
|
24
|
+
|
|
25
|
+
# @!method initialize(data:, request_id:, key_metadata: nil)
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {ContextDev::Models::LogRetrieveResponse} for more details.
|
|
28
|
+
#
|
|
29
|
+
# @param data [ContextDev::Models::LogRetrieveResponse::Data]
|
|
30
|
+
#
|
|
31
|
+
# @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
|
|
32
|
+
#
|
|
33
|
+
# @param key_metadata [ContextDev::Models::LogRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
34
|
+
|
|
35
|
+
# @see ContextDev::Models::LogRetrieveResponse#data
|
|
36
|
+
class Data < ContextDev::Internal::Type::BaseModel
|
|
37
|
+
# @!attribute credits_used
|
|
38
|
+
# Credits charged for this request.
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer]
|
|
41
|
+
required :credits_used, Integer
|
|
42
|
+
|
|
43
|
+
# @!attribute error_code
|
|
44
|
+
# The `error_code` from the response, or null on success.
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
required :error_code, String, nil?: true
|
|
48
|
+
|
|
49
|
+
# @!attribute input
|
|
50
|
+
# What was sent with the request.
|
|
51
|
+
#
|
|
52
|
+
# @return [ContextDev::Models::LogRetrieveResponse::Data::Input]
|
|
53
|
+
required :input, -> { ContextDev::Models::LogRetrieveResponse::Data::Input }
|
|
54
|
+
|
|
55
|
+
# @!attribute key_id
|
|
56
|
+
# ID of the API key that made the request.
|
|
57
|
+
#
|
|
58
|
+
# @return [String, nil]
|
|
59
|
+
required :key_id, String, nil?: true
|
|
60
|
+
|
|
61
|
+
# @!attribute latency_ms
|
|
62
|
+
# Server-side processing time in milliseconds.
|
|
63
|
+
#
|
|
64
|
+
# @return [Float]
|
|
65
|
+
required :latency_ms, Float
|
|
66
|
+
|
|
67
|
+
# @!attribute method_
|
|
68
|
+
# HTTP method.
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :method_, String, api_name: :method
|
|
72
|
+
|
|
73
|
+
# @!attribute path
|
|
74
|
+
# Endpoint path as called.
|
|
75
|
+
#
|
|
76
|
+
# @return [String]
|
|
77
|
+
required :path, String
|
|
78
|
+
|
|
79
|
+
# @!attribute request_id
|
|
80
|
+
# Request ID of the logged API call.
|
|
81
|
+
#
|
|
82
|
+
# @return [String]
|
|
83
|
+
required :request_id, String
|
|
84
|
+
|
|
85
|
+
# @!attribute status_code
|
|
86
|
+
# HTTP status code returned.
|
|
87
|
+
#
|
|
88
|
+
# @return [Integer]
|
|
89
|
+
required :status_code, Integer
|
|
90
|
+
|
|
91
|
+
# @!attribute tags
|
|
92
|
+
# Request tags supplied by the caller.
|
|
93
|
+
#
|
|
94
|
+
# @return [Array<String>]
|
|
95
|
+
required :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
96
|
+
|
|
97
|
+
# @!attribute timestamp
|
|
98
|
+
# When the request completed.
|
|
99
|
+
#
|
|
100
|
+
# @return [Time]
|
|
101
|
+
required :timestamp, Time
|
|
102
|
+
|
|
103
|
+
# @!attribute user_agent
|
|
104
|
+
# User-Agent header of the request.
|
|
105
|
+
#
|
|
106
|
+
# @return [String, nil]
|
|
107
|
+
required :user_agent, String, nil?: true
|
|
108
|
+
|
|
109
|
+
# @!attribute zdr
|
|
110
|
+
# Whether the request was made under zero data retention.
|
|
111
|
+
#
|
|
112
|
+
# @return [Boolean]
|
|
113
|
+
required :zdr, ContextDev::Internal::Type::Boolean
|
|
114
|
+
|
|
115
|
+
# @!attribute key_metadata
|
|
116
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
117
|
+
#
|
|
118
|
+
# @return [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata, nil]
|
|
119
|
+
optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata }
|
|
120
|
+
|
|
121
|
+
# @!attribute response
|
|
122
|
+
# The retained JSON response with credentials redacted, or null when unavailable.
|
|
123
|
+
#
|
|
124
|
+
# @return [Object, nil]
|
|
125
|
+
optional :response, ContextDev::Internal::Type::Unknown
|
|
126
|
+
|
|
127
|
+
# @!method initialize(credits_used:, error_code:, input:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, user_agent:, zdr:, key_metadata: nil, response: nil)
|
|
128
|
+
# @param credits_used [Integer] Credits charged for this request.
|
|
129
|
+
#
|
|
130
|
+
# @param error_code [String, nil] The `error_code` from the response, or null on success.
|
|
131
|
+
#
|
|
132
|
+
# @param input [ContextDev::Models::LogRetrieveResponse::Data::Input] What was sent with the request.
|
|
133
|
+
#
|
|
134
|
+
# @param key_id [String, nil] ID of the API key that made the request.
|
|
135
|
+
#
|
|
136
|
+
# @param latency_ms [Float] Server-side processing time in milliseconds.
|
|
137
|
+
#
|
|
138
|
+
# @param method_ [String] HTTP method.
|
|
139
|
+
#
|
|
140
|
+
# @param path [String] Endpoint path as called.
|
|
141
|
+
#
|
|
142
|
+
# @param request_id [String] Request ID of the logged API call.
|
|
143
|
+
#
|
|
144
|
+
# @param status_code [Integer] HTTP status code returned.
|
|
145
|
+
#
|
|
146
|
+
# @param tags [Array<String>] Request tags supplied by the caller.
|
|
147
|
+
#
|
|
148
|
+
# @param timestamp [Time] When the request completed.
|
|
149
|
+
#
|
|
150
|
+
# @param user_agent [String, nil] User-Agent header of the request.
|
|
151
|
+
#
|
|
152
|
+
# @param zdr [Boolean] Whether the request was made under zero data retention.
|
|
153
|
+
#
|
|
154
|
+
# @param key_metadata [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
155
|
+
#
|
|
156
|
+
# @param response [Object] The retained JSON response with credentials redacted, or null when unavailable.
|
|
157
|
+
|
|
158
|
+
# @see ContextDev::Models::LogRetrieveResponse::Data#input
|
|
159
|
+
class Input < ContextDev::Internal::Type::BaseModel
|
|
160
|
+
# @!attribute query
|
|
161
|
+
# Query parameters as sent.
|
|
162
|
+
#
|
|
163
|
+
# @return [Hash{Symbol=>Object}]
|
|
164
|
+
required :query, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
|
|
165
|
+
|
|
166
|
+
# @!attribute body
|
|
167
|
+
# Request body with credentials and uploaded content redacted.
|
|
168
|
+
#
|
|
169
|
+
# @return [Object, nil]
|
|
170
|
+
optional :body, ContextDev::Internal::Type::Unknown
|
|
171
|
+
|
|
172
|
+
# @!method initialize(query:, body: nil)
|
|
173
|
+
# What was sent with the request.
|
|
174
|
+
#
|
|
175
|
+
# @param query [Hash{Symbol=>Object}] Query parameters as sent.
|
|
176
|
+
#
|
|
177
|
+
# @param body [Object] Request body with credentials and uploaded content redacted.
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
# @see ContextDev::Models::LogRetrieveResponse::Data#key_metadata
|
|
181
|
+
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
182
|
+
# @!attribute credits_consumed
|
|
183
|
+
# Credits used by this request.
|
|
184
|
+
#
|
|
185
|
+
# @return [Integer]
|
|
186
|
+
required :credits_consumed, Integer
|
|
187
|
+
|
|
188
|
+
# @!attribute credits_remaining
|
|
189
|
+
# Credits remaining for your organization.
|
|
190
|
+
#
|
|
191
|
+
# @return [Integer]
|
|
192
|
+
required :credits_remaining, Integer
|
|
193
|
+
|
|
194
|
+
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
195
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
196
|
+
#
|
|
197
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
198
|
+
#
|
|
199
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# @see ContextDev::Models::LogRetrieveResponse#key_metadata
|
|
204
|
+
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
205
|
+
# @!attribute credits_consumed
|
|
206
|
+
# Credits used by this request.
|
|
207
|
+
#
|
|
208
|
+
# @return [Integer]
|
|
209
|
+
required :credits_consumed, Integer
|
|
210
|
+
|
|
211
|
+
# @!attribute credits_remaining
|
|
212
|
+
# Credits remaining for your organization.
|
|
213
|
+
#
|
|
214
|
+
# @return [Integer]
|
|
215
|
+
required :credits_remaining, Integer
|
|
216
|
+
|
|
217
|
+
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
218
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
219
|
+
#
|
|
220
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
221
|
+
#
|
|
222
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
223
|
+
end
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
end
|
|
@@ -97,6 +97,25 @@ module ContextDev
|
|
|
97
97
|
# @return [String]
|
|
98
98
|
required :url, String
|
|
99
99
|
|
|
100
|
+
# @!attribute exclude_selectors
|
|
101
|
+
# CSS selectors for HTML regions to remove before text extraction. Applied after
|
|
102
|
+
# include_selectors; exclusion takes precedence when an element matches both. Omit
|
|
103
|
+
# or pass an empty array to apply no explicit exclusions. Changing these selectors
|
|
104
|
+
# creates a new baseline.
|
|
105
|
+
#
|
|
106
|
+
# @return [Array<String>, nil]
|
|
107
|
+
optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
108
|
+
|
|
109
|
+
# @!attribute include_selectors
|
|
110
|
+
# CSS selectors defining the HTML regions to monitor. Matching subtrees are
|
|
111
|
+
# combined in document order before text extraction, instead of automatic
|
|
112
|
+
# main-content selection. Omit or pass an empty array to use automatic
|
|
113
|
+
# main-content extraction. If the filtered page has no usable text, the run fails
|
|
114
|
+
# without replacing the baseline. Changing these selectors creates a new baseline.
|
|
115
|
+
#
|
|
116
|
+
# @return [Array<String>, nil]
|
|
117
|
+
optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
118
|
+
|
|
100
119
|
# @!attribute instructions
|
|
101
120
|
# Plain-language goal describing which page changes matter. When provided without
|
|
102
121
|
# change_detection, semantic detection is inferred.
|
|
@@ -110,7 +129,7 @@ module ContextDev
|
|
|
110
129
|
# @return [Boolean, nil]
|
|
111
130
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
112
131
|
|
|
113
|
-
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
132
|
+
# @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
114
133
|
# Some parameter documentations has been truncated, see
|
|
115
134
|
# {ContextDev::Models::MonitorCreateParams::Target::Page} for more details.
|
|
116
135
|
#
|
|
@@ -119,6 +138,10 @@ module ContextDev
|
|
|
119
138
|
#
|
|
120
139
|
# @param url [String]
|
|
121
140
|
#
|
|
141
|
+
# @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
|
|
142
|
+
#
|
|
143
|
+
# @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
|
|
144
|
+
#
|
|
122
145
|
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
123
146
|
#
|
|
124
147
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
@@ -371,7 +394,8 @@ module ContextDev
|
|
|
371
394
|
|
|
372
395
|
class Webhook < ContextDev::Internal::Type::BaseModel
|
|
373
396
|
# @!attribute url
|
|
374
|
-
# Webhook URL events are delivered to.
|
|
397
|
+
# Webhook URL events are delivered to. Slack incoming webhook URLs are
|
|
398
|
+
# automatically formatted as Slack messages.
|
|
375
399
|
#
|
|
376
400
|
# @return [String]
|
|
377
401
|
required :url, String
|
|
@@ -396,7 +420,7 @@ module ContextDev
|
|
|
396
420
|
# Some parameter documentations has been truncated, see
|
|
397
421
|
# {ContextDev::Models::MonitorCreateParams::Webhook} for more details.
|
|
398
422
|
#
|
|
399
|
-
# @param url [String] Webhook URL events are delivered to.
|
|
423
|
+
# @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
|
|
400
424
|
#
|
|
401
425
|
# @param events [Array<Symbol, ContextDev::Models::MonitorCreateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
|
|
402
426
|
#
|
|
@@ -331,6 +331,25 @@ module ContextDev
|
|
|
331
331
|
# @return [String]
|
|
332
332
|
required :url, String
|
|
333
333
|
|
|
334
|
+
# @!attribute exclude_selectors
|
|
335
|
+
# CSS selectors for HTML regions to remove before text extraction. Applied after
|
|
336
|
+
# include_selectors; exclusion takes precedence when an element matches both. Omit
|
|
337
|
+
# or pass an empty array to apply no explicit exclusions. Changing these selectors
|
|
338
|
+
# creates a new baseline.
|
|
339
|
+
#
|
|
340
|
+
# @return [Array<String>, nil]
|
|
341
|
+
optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
342
|
+
|
|
343
|
+
# @!attribute include_selectors
|
|
344
|
+
# CSS selectors defining the HTML regions to monitor. Matching subtrees are
|
|
345
|
+
# combined in document order before text extraction, instead of automatic
|
|
346
|
+
# main-content selection. Omit or pass an empty array to use automatic
|
|
347
|
+
# main-content extraction. If the filtered page has no usable text, the run fails
|
|
348
|
+
# without replacing the baseline. Changing these selectors creates a new baseline.
|
|
349
|
+
#
|
|
350
|
+
# @return [Array<String>, nil]
|
|
351
|
+
optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
352
|
+
|
|
334
353
|
# @!attribute instructions
|
|
335
354
|
# Plain-language goal describing which page changes matter. When provided without
|
|
336
355
|
# change_detection, semantic detection is inferred.
|
|
@@ -344,7 +363,7 @@ module ContextDev
|
|
|
344
363
|
# @return [Boolean, nil]
|
|
345
364
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
346
365
|
|
|
347
|
-
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
366
|
+
# @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
348
367
|
# Some parameter documentations has been truncated, see
|
|
349
368
|
# {ContextDev::Models::MonitorCreateResponse::Target::Page} for more details.
|
|
350
369
|
#
|
|
@@ -353,6 +372,10 @@ module ContextDev
|
|
|
353
372
|
#
|
|
354
373
|
# @param url [String]
|
|
355
374
|
#
|
|
375
|
+
# @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
|
|
376
|
+
#
|
|
377
|
+
# @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
|
|
378
|
+
#
|
|
356
379
|
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
357
380
|
#
|
|
358
381
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
@@ -618,7 +641,8 @@ module ContextDev
|
|
|
618
641
|
# @see ContextDev::Models::MonitorCreateResponse#webhook
|
|
619
642
|
class Webhook < ContextDev::Internal::Type::BaseModel
|
|
620
643
|
# @!attribute url
|
|
621
|
-
# Webhook URL events are delivered to.
|
|
644
|
+
# Webhook URL events are delivered to. Slack incoming webhook URLs are
|
|
645
|
+
# automatically formatted as Slack messages.
|
|
622
646
|
#
|
|
623
647
|
# @return [String]
|
|
624
648
|
required :url, String
|
|
@@ -641,7 +665,8 @@ module ContextDev
|
|
|
641
665
|
|
|
642
666
|
response_only do
|
|
643
667
|
# @!attribute secret
|
|
644
|
-
# Signing secret used to verify webhook authenticity.
|
|
668
|
+
# Signing secret used to verify webhook authenticity. Omitted unless the API key
|
|
669
|
+
# has monitors:write permission or full access. Each delivery includes an
|
|
645
670
|
# `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
|
|
646
671
|
# `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
|
|
647
672
|
# compare and reject stale timestamps to prevent replay. Generated by the API;
|
|
@@ -655,13 +680,13 @@ module ContextDev
|
|
|
655
680
|
# Some parameter documentations has been truncated, see
|
|
656
681
|
# {ContextDev::Models::MonitorCreateResponse::Webhook} for more details.
|
|
657
682
|
#
|
|
658
|
-
# @param url [String] Webhook URL events are delivered to.
|
|
683
|
+
# @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
|
|
659
684
|
#
|
|
660
685
|
# @param events [Array<Symbol, ContextDev::Models::MonitorCreateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
|
|
661
686
|
#
|
|
662
687
|
# @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
|
|
663
688
|
#
|
|
664
|
-
# @param secret [String] Signing secret used to verify webhook authenticity.
|
|
689
|
+
# @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
|
|
665
690
|
|
|
666
691
|
module Event
|
|
667
692
|
extend ContextDev::Internal::Type::Enum
|
|
@@ -344,6 +344,25 @@ module ContextDev
|
|
|
344
344
|
# @return [String]
|
|
345
345
|
required :url, String
|
|
346
346
|
|
|
347
|
+
# @!attribute exclude_selectors
|
|
348
|
+
# CSS selectors for HTML regions to remove before text extraction. Applied after
|
|
349
|
+
# include_selectors; exclusion takes precedence when an element matches both. Omit
|
|
350
|
+
# or pass an empty array to apply no explicit exclusions. Changing these selectors
|
|
351
|
+
# creates a new baseline.
|
|
352
|
+
#
|
|
353
|
+
# @return [Array<String>, nil]
|
|
354
|
+
optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
355
|
+
|
|
356
|
+
# @!attribute include_selectors
|
|
357
|
+
# CSS selectors defining the HTML regions to monitor. Matching subtrees are
|
|
358
|
+
# combined in document order before text extraction, instead of automatic
|
|
359
|
+
# main-content selection. Omit or pass an empty array to use automatic
|
|
360
|
+
# main-content extraction. If the filtered page has no usable text, the run fails
|
|
361
|
+
# without replacing the baseline. Changing these selectors creates a new baseline.
|
|
362
|
+
#
|
|
363
|
+
# @return [Array<String>, nil]
|
|
364
|
+
optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
|
|
365
|
+
|
|
347
366
|
# @!attribute instructions
|
|
348
367
|
# Plain-language goal describing which page changes matter. When provided without
|
|
349
368
|
# change_detection, semantic detection is inferred.
|
|
@@ -357,7 +376,7 @@ module ContextDev
|
|
|
357
376
|
# @return [Boolean, nil]
|
|
358
377
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
359
378
|
|
|
360
|
-
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
379
|
+
# @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
361
380
|
# Some parameter documentations has been truncated, see
|
|
362
381
|
# {ContextDev::Models::MonitorListResponse::Data::Target::Page} for more details.
|
|
363
382
|
#
|
|
@@ -366,6 +385,10 @@ module ContextDev
|
|
|
366
385
|
#
|
|
367
386
|
# @param url [String]
|
|
368
387
|
#
|
|
388
|
+
# @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
|
|
389
|
+
#
|
|
390
|
+
# @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
|
|
391
|
+
#
|
|
369
392
|
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
370
393
|
#
|
|
371
394
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
@@ -632,7 +655,8 @@ module ContextDev
|
|
|
632
655
|
# @see ContextDev::Models::MonitorListResponse::Data#webhook
|
|
633
656
|
class Webhook < ContextDev::Internal::Type::BaseModel
|
|
634
657
|
# @!attribute url
|
|
635
|
-
# Webhook URL events are delivered to.
|
|
658
|
+
# Webhook URL events are delivered to. Slack incoming webhook URLs are
|
|
659
|
+
# automatically formatted as Slack messages.
|
|
636
660
|
#
|
|
637
661
|
# @return [String]
|
|
638
662
|
required :url, String
|
|
@@ -655,7 +679,8 @@ module ContextDev
|
|
|
655
679
|
|
|
656
680
|
response_only do
|
|
657
681
|
# @!attribute secret
|
|
658
|
-
# Signing secret used to verify webhook authenticity.
|
|
682
|
+
# Signing secret used to verify webhook authenticity. Omitted unless the API key
|
|
683
|
+
# has monitors:write permission or full access. Each delivery includes an
|
|
659
684
|
# `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
|
|
660
685
|
# `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
|
|
661
686
|
# compare and reject stale timestamps to prevent replay. Generated by the API;
|
|
@@ -669,13 +694,13 @@ module ContextDev
|
|
|
669
694
|
# Some parameter documentations has been truncated, see
|
|
670
695
|
# {ContextDev::Models::MonitorListResponse::Data::Webhook} for more details.
|
|
671
696
|
#
|
|
672
|
-
# @param url [String] Webhook URL events are delivered to.
|
|
697
|
+
# @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
|
|
673
698
|
#
|
|
674
699
|
# @param events [Array<Symbol, ContextDev::Models::MonitorListResponse::Data::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
|
|
675
700
|
#
|
|
676
701
|
# @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
|
|
677
702
|
#
|
|
678
|
-
# @param secret [String] Signing secret used to verify webhook authenticity.
|
|
703
|
+
# @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
|
|
679
704
|
|
|
680
705
|
module Event
|
|
681
706
|
extend ContextDev::Internal::Type::Enum
|