context.dev 2.14.0 → 2.15.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 +8 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -0
- data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
- data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
- data/lib/context_dev/models/batch_cancel_response.rb +4 -4
- data/lib/context_dev/models/batch_delete_response.rb +7 -12
- data/lib/context_dev/models/batch_get_results_response.rb +7 -12
- data/lib/context_dev/models/batch_list_response.rb +7 -12
- data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
- data/lib/context_dev/models/batch_submit_params.rb +34 -3
- data/lib/context_dev/models/batch_submit_response.rb +4 -4
- data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
- data/lib/context_dev/models/brand_search_params.rb +3 -4
- data/lib/context_dev/models/brand_search_response.rb +7 -9
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
- data/lib/context_dev/models/monitor_create_params.rb +9 -1
- data/lib/context_dev/models/monitor_create_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
- data/lib/context_dev/models/monitor_update_params.rb +9 -1
- data/lib/context_dev/models/monitor_update_response.rb +9 -1
- data/lib/context_dev/models/news_search_response.rb +7 -9
- data/lib/context_dev/models/parse_handle_params.rb +3 -4
- data/lib/context_dev/models/parse_handle_response.rb +7 -12
- data/lib/context_dev/models/person_enrich_response.rb +7 -12
- data/lib/context_dev/models/retry_config.rb +22 -0
- data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
- data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
- data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
- data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
- data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
- data/lib/context_dev/models/web_extract_response.rb +7 -9
- data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
- data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
- data/lib/context_dev/models/web_screenshot_params.rb +3 -4
- data/lib/context_dev/models/web_screenshot_response.rb +7 -9
- data/lib/context_dev/models/web_search_response.rb +7 -9
- data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
- data/lib/context_dev/models/webhook_delivery.rb +9 -1
- data/lib/context_dev/models/webhooks/attempt.rb +102 -0
- data/lib/context_dev/models/webhooks/delivery.rb +253 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
- data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
- data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
- data/lib/context_dev/models.rb +4 -0
- data/lib/context_dev/resources/batch.rb +4 -2
- data/lib/context_dev/resources/brand.rb +2 -2
- data/lib/context_dev/resources/industry.rb +2 -2
- data/lib/context_dev/resources/parse.rb +1 -1
- data/lib/context_dev/resources/web.rb +8 -8
- data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
- data/lib/context_dev/resources/webhooks.rb +19 -0
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +14 -0
- data/rbi/context_dev/client.rbi +3 -0
- data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
- data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
- data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
- data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
- data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
- data/rbi/context_dev/models/batch_list_response.rbi +7 -10
- data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
- data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
- data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
- data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
- data/rbi/context_dev/models/brand_search_params.rbi +4 -6
- data/rbi/context_dev/models/brand_search_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
- data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
- data/rbi/context_dev/models/news_search_response.rbi +7 -10
- data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
- data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
- data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
- data/rbi/context_dev/models/retry_config.rbi +35 -0
- data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
- data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
- data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
- data/rbi/context_dev/models/web_search_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
- data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
- data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
- data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
- data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
- data/rbi/context_dev/models.rbi +4 -0
- data/rbi/context_dev/resources/batch.rbi +6 -1
- data/rbi/context_dev/resources/brand.rbi +4 -6
- data/rbi/context_dev/resources/industry.rbi +4 -6
- data/rbi/context_dev/resources/parse.rbi +2 -3
- data/rbi/context_dev/resources/web.rbi +16 -24
- data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
- data/rbi/context_dev/resources/webhooks.rbi +16 -0
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
- data/sig/context_dev/models/batch_submit_params.rbs +23 -0
- data/sig/context_dev/models/monitor_create_params.rbs +8 -1
- data/sig/context_dev/models/monitor_create_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_list_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
- data/sig/context_dev/models/monitor_update_params.rbs +8 -1
- data/sig/context_dev/models/monitor_update_response.rbs +7 -0
- data/sig/context_dev/models/retry_config.rbs +15 -0
- data/sig/context_dev/models/webhook_delivery.rbs +10 -3
- data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
- data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
- data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
- data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
- data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
- data/sig/context_dev/models.rbs +4 -0
- data/sig/context_dev/resources/batch.rbs +1 -0
- data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
- data/sig/context_dev/resources/webhooks.rbs +9 -0
- metadata +44 -2
|
@@ -67,8 +67,7 @@ module ContextDev
|
|
|
67
67
|
end
|
|
68
68
|
attr_writer :actions_applied
|
|
69
69
|
|
|
70
|
-
#
|
|
71
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
70
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
72
71
|
sig do
|
|
73
72
|
returns(
|
|
74
73
|
T.nilable(ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata)
|
|
@@ -116,8 +115,7 @@ module ContextDev
|
|
|
116
115
|
url:,
|
|
117
116
|
# One verified outcome per requested browser action, in request order.
|
|
118
117
|
actions_applied: nil,
|
|
119
|
-
#
|
|
120
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
118
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
121
119
|
key_metadata: nil
|
|
122
120
|
)
|
|
123
121
|
end
|
|
@@ -781,25 +779,24 @@ module ContextDev
|
|
|
781
779
|
)
|
|
782
780
|
end
|
|
783
781
|
|
|
784
|
-
#
|
|
782
|
+
# Credits used by this request.
|
|
785
783
|
sig { returns(Integer) }
|
|
786
784
|
attr_accessor :credits_consumed
|
|
787
785
|
|
|
788
|
-
#
|
|
786
|
+
# Credits remaining for your organization.
|
|
789
787
|
sig { returns(Integer) }
|
|
790
788
|
attr_accessor :credits_remaining
|
|
791
789
|
|
|
792
|
-
#
|
|
793
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
790
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
794
791
|
sig do
|
|
795
792
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
796
793
|
T.attached_class
|
|
797
794
|
)
|
|
798
795
|
end
|
|
799
796
|
def self.new(
|
|
800
|
-
#
|
|
797
|
+
# Credits used by this request.
|
|
801
798
|
credits_consumed:,
|
|
802
|
-
#
|
|
799
|
+
# Credits remaining for your organization.
|
|
803
800
|
credits_remaining:
|
|
804
801
|
)
|
|
805
802
|
end
|
|
@@ -129,9 +129,8 @@ module ContextDev
|
|
|
129
129
|
sig { params(shorten_base64_images: T::Boolean).void }
|
|
130
130
|
attr_writer :shorten_base64_images
|
|
131
131
|
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
132
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
133
|
+
# characters.
|
|
135
134
|
sig { returns(T.nilable(T::Array[String])) }
|
|
136
135
|
attr_reader :tags
|
|
137
136
|
|
|
@@ -251,9 +250,8 @@ module ContextDev
|
|
|
251
250
|
settle_animations: nil,
|
|
252
251
|
# Shorten base64-encoded image data in the Markdown output
|
|
253
252
|
shorten_base64_images: nil,
|
|
254
|
-
#
|
|
255
|
-
#
|
|
256
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
253
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
254
|
+
# characters.
|
|
257
255
|
tags: nil,
|
|
258
256
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
259
257
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -95,8 +95,7 @@ module ContextDev
|
|
|
95
95
|
sig { params(html: String).void }
|
|
96
96
|
attr_writer :html
|
|
97
97
|
|
|
98
|
-
#
|
|
99
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
98
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
100
99
|
sig do
|
|
101
100
|
returns(
|
|
102
101
|
T.nilable(ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata)
|
|
@@ -159,8 +158,7 @@ module ContextDev
|
|
|
159
158
|
# from — the same body the Scrape HTML endpoint returns for the equivalent
|
|
160
159
|
# request.
|
|
161
160
|
html: nil,
|
|
162
|
-
#
|
|
163
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
161
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
164
162
|
key_metadata: nil
|
|
165
163
|
)
|
|
166
164
|
end
|
|
@@ -984,25 +982,24 @@ module ContextDev
|
|
|
984
982
|
)
|
|
985
983
|
end
|
|
986
984
|
|
|
987
|
-
#
|
|
985
|
+
# Credits used by this request.
|
|
988
986
|
sig { returns(Integer) }
|
|
989
987
|
attr_accessor :credits_consumed
|
|
990
988
|
|
|
991
|
-
#
|
|
989
|
+
# Credits remaining for your organization.
|
|
992
990
|
sig { returns(Integer) }
|
|
993
991
|
attr_accessor :credits_remaining
|
|
994
992
|
|
|
995
|
-
#
|
|
996
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
993
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
997
994
|
sig do
|
|
998
995
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
999
996
|
T.attached_class
|
|
1000
997
|
)
|
|
1001
998
|
end
|
|
1002
999
|
def self.new(
|
|
1003
|
-
#
|
|
1000
|
+
# Credits used by this request.
|
|
1004
1001
|
credits_consumed:,
|
|
1005
|
-
#
|
|
1002
|
+
# Credits remaining for your organization.
|
|
1006
1003
|
credits_remaining:
|
|
1007
1004
|
)
|
|
1008
1005
|
end
|
|
@@ -60,9 +60,8 @@ module ContextDev
|
|
|
60
60
|
sig { params(sitemap_url: String).void }
|
|
61
61
|
attr_writer :sitemap_url
|
|
62
62
|
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
63
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
64
|
+
# characters.
|
|
66
65
|
sig { returns(T.nilable(T::Array[String])) }
|
|
67
66
|
attr_reader :tags
|
|
68
67
|
|
|
@@ -135,9 +134,8 @@ module ContextDev
|
|
|
135
134
|
# Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
|
|
136
135
|
# instead of discovering the domain's sitemaps.
|
|
137
136
|
sitemap_url: nil,
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
137
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
138
|
+
# characters.
|
|
141
139
|
tags: nil,
|
|
142
140
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
143
141
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -39,8 +39,7 @@ module ContextDev
|
|
|
39
39
|
sig { returns(T::Array[String]) }
|
|
40
40
|
attr_accessor :urls
|
|
41
41
|
|
|
42
|
-
#
|
|
43
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
42
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
44
43
|
sig do
|
|
45
44
|
returns(
|
|
46
45
|
T.nilable(
|
|
@@ -79,8 +78,7 @@ module ContextDev
|
|
|
79
78
|
# Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
|
|
80
79
|
# these are only the matching pages, most relevant first.
|
|
81
80
|
urls:,
|
|
82
|
-
#
|
|
83
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
81
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
84
82
|
key_metadata: nil
|
|
85
83
|
)
|
|
86
84
|
end
|
|
@@ -200,25 +198,24 @@ module ContextDev
|
|
|
200
198
|
)
|
|
201
199
|
end
|
|
202
200
|
|
|
203
|
-
#
|
|
201
|
+
# Credits used by this request.
|
|
204
202
|
sig { returns(Integer) }
|
|
205
203
|
attr_accessor :credits_consumed
|
|
206
204
|
|
|
207
|
-
#
|
|
205
|
+
# Credits remaining for your organization.
|
|
208
206
|
sig { returns(Integer) }
|
|
209
207
|
attr_accessor :credits_remaining
|
|
210
208
|
|
|
211
|
-
#
|
|
212
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
209
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
213
210
|
sig do
|
|
214
211
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
215
212
|
T.attached_class
|
|
216
213
|
)
|
|
217
214
|
end
|
|
218
215
|
def self.new(
|
|
219
|
-
#
|
|
216
|
+
# Credits used by this request.
|
|
220
217
|
credits_consumed:,
|
|
221
|
-
#
|
|
218
|
+
# Credits remaining for your organization.
|
|
222
219
|
credits_remaining:
|
|
223
220
|
)
|
|
224
221
|
end
|
|
@@ -41,6 +41,13 @@ module ContextDev
|
|
|
41
41
|
sig { returns(ContextDev::WebhookDelivery::Status::TaggedSymbol) }
|
|
42
42
|
attr_accessor :status
|
|
43
43
|
|
|
44
|
+
# Delivery ID for status checks and retries, when available.
|
|
45
|
+
sig { returns(T.nilable(String)) }
|
|
46
|
+
attr_reader :delivery_id
|
|
47
|
+
|
|
48
|
+
sig { params(delivery_id: String).void }
|
|
49
|
+
attr_writer :delivery_id
|
|
50
|
+
|
|
44
51
|
sig do
|
|
45
52
|
params(
|
|
46
53
|
attempted_at: Time,
|
|
@@ -48,7 +55,8 @@ module ContextDev
|
|
|
48
55
|
event: ContextDev::WebhookDelivery::Event::OrSymbol,
|
|
49
56
|
event_id: String,
|
|
50
57
|
http_status: T.nilable(Integer),
|
|
51
|
-
status: ContextDev::WebhookDelivery::Status::OrSymbol
|
|
58
|
+
status: ContextDev::WebhookDelivery::Status::OrSymbol,
|
|
59
|
+
delivery_id: String
|
|
52
60
|
).returns(T.attached_class)
|
|
53
61
|
end
|
|
54
62
|
def self.new(
|
|
@@ -65,7 +73,9 @@ module ContextDev
|
|
|
65
73
|
# Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
|
|
66
74
|
# response; failed means no HTTP response was received; skipped_unsafe_url means
|
|
67
75
|
# the URL failed the public-endpoint safety check.
|
|
68
|
-
status
|
|
76
|
+
status:,
|
|
77
|
+
# Delivery ID for status checks and retries, when available.
|
|
78
|
+
delivery_id: nil
|
|
69
79
|
)
|
|
70
80
|
end
|
|
71
81
|
|
|
@@ -77,7 +87,8 @@ module ContextDev
|
|
|
77
87
|
event: ContextDev::WebhookDelivery::Event::TaggedSymbol,
|
|
78
88
|
event_id: String,
|
|
79
89
|
http_status: T.nilable(Integer),
|
|
80
|
-
status: ContextDev::WebhookDelivery::Status::TaggedSymbol
|
|
90
|
+
status: ContextDev::WebhookDelivery::Status::TaggedSymbol,
|
|
91
|
+
delivery_id: String
|
|
81
92
|
}
|
|
82
93
|
)
|
|
83
94
|
end
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
class Attempt < ContextDev::Internal::Type::BaseModel
|
|
7
|
+
OrHash =
|
|
8
|
+
T.type_alias do
|
|
9
|
+
T.any(ContextDev::Webhooks::Attempt, ContextDev::Internal::AnyHash)
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# Attempt number, starting at 1.
|
|
13
|
+
sig { returns(Integer) }
|
|
14
|
+
attr_accessor :attempt
|
|
15
|
+
|
|
16
|
+
# Completion time, or null while in progress.
|
|
17
|
+
sig { returns(T.nilable(Time)) }
|
|
18
|
+
attr_accessor :completed_at
|
|
19
|
+
|
|
20
|
+
# Attempt error, or null if none.
|
|
21
|
+
sig { returns(T.nilable(ContextDev::Webhooks::Attempt::Error)) }
|
|
22
|
+
attr_reader :error
|
|
23
|
+
|
|
24
|
+
sig do
|
|
25
|
+
params(
|
|
26
|
+
error: T.nilable(ContextDev::Webhooks::Attempt::Error::OrHash)
|
|
27
|
+
).void
|
|
28
|
+
end
|
|
29
|
+
attr_writer :error
|
|
30
|
+
|
|
31
|
+
# HTTP response status, or null if no response was received.
|
|
32
|
+
sig { returns(T.nilable(Integer)) }
|
|
33
|
+
attr_accessor :http_status
|
|
34
|
+
|
|
35
|
+
# Attempt start time.
|
|
36
|
+
sig { returns(Time) }
|
|
37
|
+
attr_accessor :started_at
|
|
38
|
+
|
|
39
|
+
# What started this attempt.
|
|
40
|
+
sig { returns(ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol) }
|
|
41
|
+
attr_accessor :trigger
|
|
42
|
+
|
|
43
|
+
# URL used for this attempt.
|
|
44
|
+
sig { returns(String) }
|
|
45
|
+
attr_accessor :url
|
|
46
|
+
|
|
47
|
+
sig do
|
|
48
|
+
params(
|
|
49
|
+
attempt: Integer,
|
|
50
|
+
completed_at: T.nilable(Time),
|
|
51
|
+
error: T.nilable(ContextDev::Webhooks::Attempt::Error::OrHash),
|
|
52
|
+
http_status: T.nilable(Integer),
|
|
53
|
+
started_at: Time,
|
|
54
|
+
trigger: ContextDev::Webhooks::Attempt::Trigger::OrSymbol,
|
|
55
|
+
url: String
|
|
56
|
+
).returns(T.attached_class)
|
|
57
|
+
end
|
|
58
|
+
def self.new(
|
|
59
|
+
# Attempt number, starting at 1.
|
|
60
|
+
attempt:,
|
|
61
|
+
# Completion time, or null while in progress.
|
|
62
|
+
completed_at:,
|
|
63
|
+
# Attempt error, or null if none.
|
|
64
|
+
error:,
|
|
65
|
+
# HTTP response status, or null if no response was received.
|
|
66
|
+
http_status:,
|
|
67
|
+
# Attempt start time.
|
|
68
|
+
started_at:,
|
|
69
|
+
# What started this attempt.
|
|
70
|
+
trigger:,
|
|
71
|
+
# URL used for this attempt.
|
|
72
|
+
url:
|
|
73
|
+
)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
sig do
|
|
77
|
+
override.returns(
|
|
78
|
+
{
|
|
79
|
+
attempt: Integer,
|
|
80
|
+
completed_at: T.nilable(Time),
|
|
81
|
+
error: T.nilable(ContextDev::Webhooks::Attempt::Error),
|
|
82
|
+
http_status: T.nilable(Integer),
|
|
83
|
+
started_at: Time,
|
|
84
|
+
trigger: ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol,
|
|
85
|
+
url: String
|
|
86
|
+
}
|
|
87
|
+
)
|
|
88
|
+
end
|
|
89
|
+
def to_hash
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
class Error < ContextDev::Internal::Type::BaseModel
|
|
93
|
+
OrHash =
|
|
94
|
+
T.type_alias do
|
|
95
|
+
T.any(
|
|
96
|
+
ContextDev::Webhooks::Attempt::Error,
|
|
97
|
+
ContextDev::Internal::AnyHash
|
|
98
|
+
)
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Error code.
|
|
102
|
+
sig { returns(String) }
|
|
103
|
+
attr_accessor :code
|
|
104
|
+
|
|
105
|
+
# Error details.
|
|
106
|
+
sig { returns(String) }
|
|
107
|
+
attr_accessor :message
|
|
108
|
+
|
|
109
|
+
# Attempt error, or null if none.
|
|
110
|
+
sig do
|
|
111
|
+
params(code: String, message: String).returns(T.attached_class)
|
|
112
|
+
end
|
|
113
|
+
def self.new(
|
|
114
|
+
# Error code.
|
|
115
|
+
code:,
|
|
116
|
+
# Error details.
|
|
117
|
+
message:
|
|
118
|
+
)
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
sig { override.returns({ code: String, message: String }) }
|
|
122
|
+
def to_hash
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# What started this attempt.
|
|
127
|
+
module Trigger
|
|
128
|
+
extend ContextDev::Internal::Type::Enum
|
|
129
|
+
|
|
130
|
+
TaggedSymbol =
|
|
131
|
+
T.type_alias do
|
|
132
|
+
T.all(Symbol, ContextDev::Webhooks::Attempt::Trigger)
|
|
133
|
+
end
|
|
134
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
135
|
+
|
|
136
|
+
INITIAL =
|
|
137
|
+
T.let(
|
|
138
|
+
:initial,
|
|
139
|
+
ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol
|
|
140
|
+
)
|
|
141
|
+
AUTOMATIC =
|
|
142
|
+
T.let(
|
|
143
|
+
:automatic,
|
|
144
|
+
ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol
|
|
145
|
+
)
|
|
146
|
+
MANUAL =
|
|
147
|
+
T.let(:manual, ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol)
|
|
148
|
+
|
|
149
|
+
sig do
|
|
150
|
+
override.returns(
|
|
151
|
+
T::Array[ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol]
|
|
152
|
+
)
|
|
153
|
+
end
|
|
154
|
+
def self.values
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|