context.dev 2.13.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.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -10
  4. data/lib/context_dev/client.rb +4 -0
  5. data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
  6. data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
  7. data/lib/context_dev/models/batch_cancel_response.rb +4 -4
  8. data/lib/context_dev/models/batch_delete_response.rb +7 -12
  9. data/lib/context_dev/models/batch_get_results_response.rb +7 -12
  10. data/lib/context_dev/models/batch_list_response.rb +7 -12
  11. data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
  12. data/lib/context_dev/models/batch_submit_params.rb +34 -3
  13. data/lib/context_dev/models/batch_submit_response.rb +4 -4
  14. data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
  15. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
  16. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
  17. data/lib/context_dev/models/brand_search_params.rb +3 -4
  18. data/lib/context_dev/models/brand_search_response.rb +7 -9
  19. data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
  20. data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
  21. data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
  22. data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
  23. data/lib/context_dev/models/monitor_create_params.rb +9 -1
  24. data/lib/context_dev/models/monitor_create_response.rb +9 -1
  25. data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
  26. data/lib/context_dev/models/monitor_list_response.rb +9 -1
  27. data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
  28. data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
  29. data/lib/context_dev/models/monitor_update_params.rb +9 -1
  30. data/lib/context_dev/models/monitor_update_response.rb +9 -1
  31. data/lib/context_dev/models/news_search_response.rb +7 -9
  32. data/lib/context_dev/models/parse_handle_params.rb +3 -4
  33. data/lib/context_dev/models/parse_handle_response.rb +7 -12
  34. data/lib/context_dev/models/person_enrich_response.rb +7 -12
  35. data/lib/context_dev/models/retry_config.rb +22 -0
  36. data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
  37. data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
  38. data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
  39. data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
  40. data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
  41. data/lib/context_dev/models/web_extract_response.rb +7 -9
  42. data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
  43. data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
  44. data/lib/context_dev/models/web_screenshot_params.rb +3 -4
  45. data/lib/context_dev/models/web_screenshot_response.rb +7 -9
  46. data/lib/context_dev/models/web_search_response.rb +7 -9
  47. data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
  48. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
  49. data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
  50. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
  51. data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
  52. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
  53. data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
  54. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +13 -5
  55. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
  56. data/lib/context_dev/models/webhook_delivery.rb +9 -1
  57. data/lib/context_dev/models/webhooks/attempt.rb +102 -0
  58. data/lib/context_dev/models/webhooks/delivery.rb +253 -0
  59. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
  60. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
  61. data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
  62. data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
  63. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
  64. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
  65. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
  66. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
  67. data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
  68. data/lib/context_dev/models.rb +4 -0
  69. data/lib/context_dev/resources/batch.rb +4 -2
  70. data/lib/context_dev/resources/brand.rb +2 -2
  71. data/lib/context_dev/resources/industry.rb +2 -2
  72. data/lib/context_dev/resources/parse.rb +1 -1
  73. data/lib/context_dev/resources/web.rb +18 -14
  74. data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
  75. data/lib/context_dev/resources/webhooks.rb +19 -0
  76. data/lib/context_dev/version.rb +1 -1
  77. data/lib/context_dev.rb +14 -0
  78. data/rbi/context_dev/client.rbi +3 -0
  79. data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
  80. data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
  81. data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
  82. data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
  83. data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
  84. data/rbi/context_dev/models/batch_list_response.rbi +7 -10
  85. data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
  86. data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
  87. data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
  88. data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
  89. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
  90. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
  91. data/rbi/context_dev/models/brand_search_params.rbi +4 -6
  92. data/rbi/context_dev/models/brand_search_response.rbi +7 -10
  93. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
  94. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
  95. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
  96. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
  97. data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
  98. data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
  99. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
  100. data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
  101. data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
  102. data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
  103. data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
  104. data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
  105. data/rbi/context_dev/models/news_search_response.rbi +7 -10
  106. data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
  107. data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
  108. data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
  109. data/rbi/context_dev/models/retry_config.rbi +35 -0
  110. data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
  111. data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
  112. data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
  113. data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
  114. data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
  115. data/rbi/context_dev/models/web_extract_response.rbi +7 -10
  116. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
  117. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
  118. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
  119. data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
  120. data/rbi/context_dev/models/web_search_response.rbi +7 -10
  121. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
  122. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
  123. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
  124. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
  125. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
  126. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
  127. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
  128. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +17 -6
  129. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
  130. data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
  131. data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
  132. data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
  133. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
  134. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
  135. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
  136. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
  137. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
  138. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
  139. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
  140. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
  141. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
  142. data/rbi/context_dev/models.rbi +4 -0
  143. data/rbi/context_dev/resources/batch.rbi +6 -1
  144. data/rbi/context_dev/resources/brand.rbi +4 -6
  145. data/rbi/context_dev/resources/industry.rbi +4 -6
  146. data/rbi/context_dev/resources/parse.rbi +2 -3
  147. data/rbi/context_dev/resources/web.rbi +26 -29
  148. data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
  149. data/rbi/context_dev/resources/webhooks.rbi +16 -0
  150. data/sig/context_dev/client.rbs +2 -0
  151. data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
  152. data/sig/context_dev/models/batch_submit_params.rbs +23 -0
  153. data/sig/context_dev/models/monitor_create_params.rbs +8 -1
  154. data/sig/context_dev/models/monitor_create_response.rbs +7 -0
  155. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
  156. data/sig/context_dev/models/monitor_list_response.rbs +7 -0
  157. data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
  158. data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
  159. data/sig/context_dev/models/monitor_update_params.rbs +8 -1
  160. data/sig/context_dev/models/monitor_update_response.rbs +7 -0
  161. data/sig/context_dev/models/retry_config.rbs +15 -0
  162. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
  163. data/sig/context_dev/models/webhook_delivery.rbs +10 -3
  164. data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
  165. data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
  166. data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
  167. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
  168. data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
  169. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
  170. data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
  171. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
  172. data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
  173. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
  174. data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
  175. data/sig/context_dev/models.rbs +4 -0
  176. data/sig/context_dev/resources/batch.rbs +1 -0
  177. data/sig/context_dev/resources/web.rbs +1 -0
  178. data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
  179. data/sig/context_dev/resources/webhooks.rbs +9 -0
  180. metadata +44 -2
@@ -16,8 +16,7 @@ module ContextDev
16
16
  sig { returns(T::Array[ContextDev::Models::BrandSearchResponse::Result]) }
17
17
  attr_accessor :results
18
18
 
19
- # Metadata about the API key used for the request. Included in every response
20
- # whenever a valid API key is provided, even when the response status is not 200.
19
+ # Credit usage, included whenever a valid API key is provided.
21
20
  sig do
22
21
  returns(T.nilable(ContextDev::Models::BrandSearchResponse::KeyMetadata))
23
22
  end
@@ -43,8 +42,7 @@ module ContextDev
43
42
  # Up to 10 matching brands, name matches first, then domain matches, most popular
44
43
  # first within each group. Empty when nothing matches.
45
44
  results:,
46
- # Metadata about the API key used for the request. Included in every response
47
- # whenever a valid API key is provided, even when the response status is not 200.
45
+ # Credit usage, included whenever a valid API key is provided.
48
46
  key_metadata: nil
49
47
  )
50
48
  end
@@ -112,25 +110,24 @@ module ContextDev
112
110
  )
113
111
  end
114
112
 
115
- # The number of credits consumed by this request.
113
+ # Credits used by this request.
116
114
  sig { returns(Integer) }
117
115
  attr_accessor :credits_consumed
118
116
 
119
- # The number of credits remaining for your organization after this request.
117
+ # Credits remaining for your organization.
120
118
  sig { returns(Integer) }
121
119
  attr_accessor :credits_remaining
122
120
 
123
- # Metadata about the API key used for the request. Included in every response
124
- # whenever a valid API key is provided, even when the response status is not 200.
121
+ # Credit usage, included whenever a valid API key is provided.
125
122
  sig do
126
123
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
127
124
  T.attached_class
128
125
  )
129
126
  end
130
127
  def self.new(
131
- # The number of credits consumed by this request.
128
+ # Credits used by this request.
132
129
  credits_consumed:,
133
- # The number of credits remaining for your organization after this request.
130
+ # Credits remaining for your organization.
134
131
  credits_remaining:
135
132
  )
136
133
  end
@@ -35,9 +35,8 @@ module ContextDev
35
35
  sig { params(min_results: Integer).void }
36
36
  attr_writer :min_results
37
37
 
38
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
39
- # recorded on the request's usage log and can be used to filter usage on the
40
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
38
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
39
+ # characters.
41
40
  sig { returns(T.nilable(T::Array[String])) }
42
41
  attr_reader :tags
43
42
 
@@ -73,9 +72,8 @@ module ContextDev
73
72
  max_results: nil,
74
73
  # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
75
74
  min_results: nil,
76
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
77
- # recorded on the request's usage log and can be used to filter usage on the
78
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
75
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
76
+ # characters.
79
77
  tags: nil,
80
78
  # Optional timeout in milliseconds for the request. If the request takes longer
81
79
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -38,8 +38,7 @@ module ContextDev
38
38
  sig { params(domain: String).void }
39
39
  attr_writer :domain
40
40
 
41
- # Metadata about the API key used for the request. Included in every response
42
- # whenever a valid API key is provided, even when the response status is not 200.
41
+ # Credit usage, included whenever a valid API key is provided.
43
42
  sig do
44
43
  returns(
45
44
  T.nilable(
@@ -89,8 +88,7 @@ module ContextDev
89
88
  codes: nil,
90
89
  # Domain found for the brand
91
90
  domain: nil,
92
- # Metadata about the API key used for the request. Included in every response
93
- # whenever a valid API key is provided, even when the response status is not 200.
91
+ # Credit usage, included whenever a valid API key is provided.
94
92
  key_metadata: nil,
95
93
  # Status of the response, e.g., 'ok'
96
94
  status: nil,
@@ -221,25 +219,24 @@ module ContextDev
221
219
  )
222
220
  end
223
221
 
224
- # The number of credits consumed by this request.
222
+ # Credits used by this request.
225
223
  sig { returns(Integer) }
226
224
  attr_accessor :credits_consumed
227
225
 
228
- # The number of credits remaining for your organization after this request.
226
+ # Credits remaining for your organization.
229
227
  sig { returns(Integer) }
230
228
  attr_accessor :credits_remaining
231
229
 
232
- # Metadata about the API key used for the request. Included in every response
233
- # whenever a valid API key is provided, even when the response status is not 200.
230
+ # Credit usage, included whenever a valid API key is provided.
234
231
  sig do
235
232
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
236
233
  T.attached_class
237
234
  )
238
235
  end
239
236
  def self.new(
240
- # The number of credits consumed by this request.
237
+ # Credits used by this request.
241
238
  credits_consumed:,
242
- # The number of credits remaining for your organization after this request.
239
+ # Credits remaining for your organization.
243
240
  credits_remaining:
244
241
  )
245
242
  end
@@ -34,9 +34,8 @@ module ContextDev
34
34
  sig { params(min_results: Integer).void }
35
35
  attr_writer :min_results
36
36
 
37
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
38
- # recorded on the request's usage log and can be used to filter usage on the
39
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
37
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
38
+ # characters.
40
39
  sig { returns(T.nilable(T::Array[String])) }
41
40
  attr_reader :tags
42
41
 
@@ -87,9 +86,8 @@ module ContextDev
87
86
  max_results: nil,
88
87
  # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
89
88
  min_results: nil,
90
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
91
- # recorded on the request's usage log and can be used to filter usage on the
92
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
89
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
90
+ # characters.
93
91
  tags: nil,
94
92
  # Optional timeout in milliseconds for the request. If the request takes longer
95
93
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -58,8 +58,7 @@ module ContextDev
58
58
  sig { params(domain: String).void }
59
59
  attr_writer :domain
60
60
 
61
- # Metadata about the API key used for the request. Included in every response
62
- # whenever a valid API key is provided, even when the response status is not 200.
61
+ # Credit usage, included whenever a valid API key is provided.
63
62
  sig do
64
63
  returns(
65
64
  T.nilable(
@@ -115,8 +114,7 @@ module ContextDev
115
114
  codes: nil,
116
115
  # Domain found for the brand
117
116
  domain: nil,
118
- # Metadata about the API key used for the request. Included in every response
119
- # whenever a valid API key is provided, even when the response status is not 200.
117
+ # Credit usage, included whenever a valid API key is provided.
120
118
  key_metadata: nil,
121
119
  # Status of the response, e.g., 'ok'
122
120
  status: nil,
@@ -323,25 +321,24 @@ module ContextDev
323
321
  )
324
322
  end
325
323
 
326
- # The number of credits consumed by this request.
324
+ # Credits used by this request.
327
325
  sig { returns(Integer) }
328
326
  attr_accessor :credits_consumed
329
327
 
330
- # The number of credits remaining for your organization after this request.
328
+ # Credits remaining for your organization.
331
329
  sig { returns(Integer) }
332
330
  attr_accessor :credits_remaining
333
331
 
334
- # Metadata about the API key used for the request. Included in every response
335
- # whenever a valid API key is provided, even when the response status is not 200.
332
+ # Credit usage, included whenever a valid API key is provided.
336
333
  sig do
337
334
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
338
335
  T.attached_class
339
336
  )
340
337
  end
341
338
  def self.new(
342
- # The number of credits consumed by this request.
339
+ # Credits used by this request.
343
340
  credits_consumed:,
344
- # The number of credits remaining for your organization after this request.
341
+ # Credits remaining for your organization.
345
342
  credits_remaining:
346
343
  )
347
344
  end
@@ -694,13 +694,21 @@ module ContextDev
694
694
  end
695
695
  attr_writer :events
696
696
 
697
+ # Webhook retry settings. Use {} for the default schedule.
698
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
699
+ attr_reader :retry_
700
+
701
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
702
+ attr_writer :retry_
703
+
697
704
  sig do
698
705
  params(
699
706
  url: String,
700
707
  events:
701
708
  T::Array[
702
709
  ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol
703
- ]
710
+ ],
711
+ retry_: ContextDev::RetryConfig::OrHash
704
712
  ).returns(T.attached_class)
705
713
  end
706
714
  def self.new(
@@ -710,7 +718,9 @@ module ContextDev
710
718
  # detects a change; `run.completed` fires on every completed run — including runs
711
719
  # that detected no change — and embeds the change when one was detected. Defaults
712
720
  # to `["change.detected"]` when omitted.
713
- events: nil
721
+ events: nil,
722
+ # Webhook retry settings. Use {} for the default schedule.
723
+ retry_: nil
714
724
  )
715
725
  end
716
726
 
@@ -722,6 +732,7 @@ module ContextDev
722
732
  T::Array[
723
733
  ContextDev::MonitorCreateParams::Webhook::Event::OrSymbol
724
734
  ],
735
+ retry_: ContextDev::RetryConfig,
725
736
  secret: String
726
737
  }
727
738
  )
@@ -1087,6 +1087,13 @@ module ContextDev
1087
1087
  end
1088
1088
  attr_writer :events
1089
1089
 
1090
+ # Webhook retry settings. Use {} for the default schedule.
1091
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
1092
+ attr_reader :retry_
1093
+
1094
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
1095
+ attr_writer :retry_
1096
+
1090
1097
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1091
1098
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1092
1099
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1105,6 +1112,7 @@ module ContextDev
1105
1112
  T::Array[
1106
1113
  ContextDev::Models::MonitorCreateResponse::Webhook::Event::OrSymbol
1107
1114
  ],
1115
+ retry_: ContextDev::RetryConfig::OrHash,
1108
1116
  secret: String
1109
1117
  ).returns(T.attached_class)
1110
1118
  end
@@ -1116,6 +1124,8 @@ module ContextDev
1116
1124
  # that detected no change — and embeds the change when one was detected. Defaults
1117
1125
  # to `["change.detected"]` when omitted.
1118
1126
  events: nil,
1127
+ # Webhook retry settings. Use {} for the default schedule.
1128
+ retry_: nil,
1119
1129
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1120
1130
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1121
1131
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1133,6 +1143,7 @@ module ContextDev
1133
1143
  T::Array[
1134
1144
  ContextDev::Models::MonitorCreateResponse::Webhook::Event::TaggedSymbol
1135
1145
  ],
1146
+ retry_: ContextDev::RetryConfig,
1136
1147
  secret: String
1137
1148
  }
1138
1149
  )
@@ -172,6 +172,13 @@ module ContextDev
172
172
  end
173
173
  attr_writer :webhook_delivery
174
174
 
175
+ # Webhook delivery IDs for this run.
176
+ sig { returns(T.nilable(T::Array[String])) }
177
+ attr_reader :webhook_delivery_ids
178
+
179
+ sig { params(webhook_delivery_ids: T::Array[String]).void }
180
+ attr_writer :webhook_delivery_ids
181
+
175
182
  sig do
176
183
  params(
177
184
  id: String,
@@ -199,7 +206,8 @@ module ContextDev
199
206
  ),
200
207
  started_at: T.nilable(Time),
201
208
  webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash],
202
- webhook_delivery: ContextDev::WebhookDelivery::OrHash
209
+ webhook_delivery: ContextDev::WebhookDelivery::OrHash,
210
+ webhook_delivery_ids: T::Array[String]
203
211
  ).returns(T.attached_class)
204
212
  end
205
213
  def self.new(
@@ -231,7 +239,9 @@ module ContextDev
231
239
  # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
232
240
  # can deliver multiple events. Omitted when no webhook was attempted, including
233
241
  # historical runs created before delivery tracking was added.
234
- webhook_delivery: nil
242
+ webhook_delivery: nil,
243
+ # Webhook delivery IDs for this run.
244
+ webhook_delivery_ids: nil
235
245
  )
236
246
  end
237
247
 
@@ -263,7 +273,8 @@ module ContextDev
263
273
  ),
264
274
  started_at: T.nilable(Time),
265
275
  webhook_deliveries: T::Array[ContextDev::WebhookDelivery],
266
- webhook_delivery: ContextDev::WebhookDelivery
276
+ webhook_delivery: ContextDev::WebhookDelivery,
277
+ webhook_delivery_ids: T::Array[String]
267
278
  }
268
279
  )
269
280
  end
@@ -1145,6 +1145,13 @@ module ContextDev
1145
1145
  end
1146
1146
  attr_writer :events
1147
1147
 
1148
+ # Webhook retry settings. Use {} for the default schedule.
1149
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
1150
+ attr_reader :retry_
1151
+
1152
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
1153
+ attr_writer :retry_
1154
+
1148
1155
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1149
1156
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1150
1157
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1163,6 +1170,7 @@ module ContextDev
1163
1170
  T::Array[
1164
1171
  ContextDev::Models::MonitorListResponse::Data::Webhook::Event::OrSymbol
1165
1172
  ],
1173
+ retry_: ContextDev::RetryConfig::OrHash,
1166
1174
  secret: String
1167
1175
  ).returns(T.attached_class)
1168
1176
  end
@@ -1174,6 +1182,8 @@ module ContextDev
1174
1182
  # that detected no change — and embeds the change when one was detected. Defaults
1175
1183
  # to `["change.detected"]` when omitted.
1176
1184
  events: nil,
1185
+ # Webhook retry settings. Use {} for the default schedule.
1186
+ retry_: nil,
1177
1187
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1178
1188
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1179
1189
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1191,6 +1201,7 @@ module ContextDev
1191
1201
  T::Array[
1192
1202
  ContextDev::Models::MonitorListResponse::Data::Webhook::Event::TaggedSymbol
1193
1203
  ],
1204
+ retry_: ContextDev::RetryConfig,
1194
1205
  secret: String
1195
1206
  }
1196
1207
  )
@@ -163,6 +163,13 @@ module ContextDev
163
163
  end
164
164
  attr_writer :webhook_delivery
165
165
 
166
+ # Webhook delivery IDs for this run.
167
+ sig { returns(T.nilable(T::Array[String])) }
168
+ attr_reader :webhook_delivery_ids
169
+
170
+ sig { params(webhook_delivery_ids: T::Array[String]).void }
171
+ attr_writer :webhook_delivery_ids
172
+
166
173
  sig do
167
174
  params(
168
175
  id: String,
@@ -190,7 +197,8 @@ module ContextDev
190
197
  ),
191
198
  started_at: T.nilable(Time),
192
199
  webhook_deliveries: T::Array[ContextDev::WebhookDelivery::OrHash],
193
- webhook_delivery: ContextDev::WebhookDelivery::OrHash
200
+ webhook_delivery: ContextDev::WebhookDelivery::OrHash,
201
+ webhook_delivery_ids: T::Array[String]
194
202
  ).returns(T.attached_class)
195
203
  end
196
204
  def self.new(
@@ -222,7 +230,9 @@ module ContextDev
222
230
  # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
223
231
  # can deliver multiple events. Omitted when no webhook was attempted, including
224
232
  # historical runs created before delivery tracking was added.
225
- webhook_delivery: nil
233
+ webhook_delivery: nil,
234
+ # Webhook delivery IDs for this run.
235
+ webhook_delivery_ids: nil
226
236
  )
227
237
  end
228
238
 
@@ -254,7 +264,8 @@ module ContextDev
254
264
  ),
255
265
  started_at: T.nilable(Time),
256
266
  webhook_deliveries: T::Array[ContextDev::WebhookDelivery],
257
- webhook_delivery: ContextDev::WebhookDelivery
267
+ webhook_delivery: ContextDev::WebhookDelivery,
268
+ webhook_delivery_ids: T::Array[String]
258
269
  }
259
270
  )
260
271
  end
@@ -1083,6 +1083,13 @@ module ContextDev
1083
1083
  end
1084
1084
  attr_writer :events
1085
1085
 
1086
+ # Webhook retry settings. Use {} for the default schedule.
1087
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
1088
+ attr_reader :retry_
1089
+
1090
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
1091
+ attr_writer :retry_
1092
+
1086
1093
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1087
1094
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1088
1095
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1101,6 +1108,7 @@ module ContextDev
1101
1108
  T::Array[
1102
1109
  ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::OrSymbol
1103
1110
  ],
1111
+ retry_: ContextDev::RetryConfig::OrHash,
1104
1112
  secret: String
1105
1113
  ).returns(T.attached_class)
1106
1114
  end
@@ -1112,6 +1120,8 @@ module ContextDev
1112
1120
  # that detected no change — and embeds the change when one was detected. Defaults
1113
1121
  # to `["change.detected"]` when omitted.
1114
1122
  events: nil,
1123
+ # Webhook retry settings. Use {} for the default schedule.
1124
+ retry_: nil,
1115
1125
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1116
1126
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1117
1127
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1129,6 +1139,7 @@ module ContextDev
1129
1139
  T::Array[
1130
1140
  ContextDev::Models::MonitorRetrieveResponse::Webhook::Event::TaggedSymbol
1131
1141
  ],
1142
+ retry_: ContextDev::RetryConfig,
1132
1143
  secret: String
1133
1144
  }
1134
1145
  )
@@ -720,6 +720,13 @@ module ContextDev
720
720
  end
721
721
  attr_writer :events
722
722
 
723
+ # Webhook retry settings. Use {} for the default schedule.
724
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
725
+ attr_reader :retry_
726
+
727
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
728
+ attr_writer :retry_
729
+
723
730
  # Set to null to remove the webhook.
724
731
  sig do
725
732
  params(
@@ -727,7 +734,8 @@ module ContextDev
727
734
  events:
728
735
  T::Array[
729
736
  ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol
730
- ]
737
+ ],
738
+ retry_: ContextDev::RetryConfig::OrHash
731
739
  ).returns(T.attached_class)
732
740
  end
733
741
  def self.new(
@@ -737,7 +745,9 @@ module ContextDev
737
745
  # detects a change; `run.completed` fires on every completed run — including runs
738
746
  # that detected no change — and embeds the change when one was detected. Defaults
739
747
  # to `["change.detected"]` when omitted.
740
- events: nil
748
+ events: nil,
749
+ # Webhook retry settings. Use {} for the default schedule.
750
+ retry_: nil
741
751
  )
742
752
  end
743
753
 
@@ -749,6 +759,7 @@ module ContextDev
749
759
  T::Array[
750
760
  ContextDev::MonitorUpdateParams::Webhook::Event::OrSymbol
751
761
  ],
762
+ retry_: ContextDev::RetryConfig,
752
763
  secret: String
753
764
  }
754
765
  )
@@ -1075,6 +1075,13 @@ module ContextDev
1075
1075
  end
1076
1076
  attr_writer :events
1077
1077
 
1078
+ # Webhook retry settings. Use {} for the default schedule.
1079
+ sig { returns(T.nilable(ContextDev::RetryConfig)) }
1080
+ attr_reader :retry_
1081
+
1082
+ sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
1083
+ attr_writer :retry_
1084
+
1078
1085
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1079
1086
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1080
1087
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1093,6 +1100,7 @@ module ContextDev
1093
1100
  T::Array[
1094
1101
  ContextDev::Models::MonitorUpdateResponse::Webhook::Event::OrSymbol
1095
1102
  ],
1103
+ retry_: ContextDev::RetryConfig::OrHash,
1096
1104
  secret: String
1097
1105
  ).returns(T.attached_class)
1098
1106
  end
@@ -1104,6 +1112,8 @@ module ContextDev
1104
1112
  # that detected no change — and embeds the change when one was detected. Defaults
1105
1113
  # to `["change.detected"]` when omitted.
1106
1114
  events: nil,
1115
+ # Webhook retry settings. Use {} for the default schedule.
1116
+ retry_: nil,
1107
1117
  # Signing secret used to verify webhook authenticity. Each delivery includes an
1108
1118
  # `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
1109
1119
  # `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
@@ -1121,6 +1131,7 @@ module ContextDev
1121
1131
  T::Array[
1122
1132
  ContextDev::Models::MonitorUpdateResponse::Webhook::Event::TaggedSymbol
1123
1133
  ],
1134
+ retry_: ContextDev::RetryConfig,
1124
1135
  secret: String
1125
1136
  }
1126
1137
  )
@@ -33,8 +33,7 @@ module ContextDev
33
33
  sig { returns(T.nilable(String)) }
34
34
  attr_accessor :next_cursor
35
35
 
36
- # Metadata about the API key used for the request. Included in every response
37
- # whenever a valid API key is provided, even when the response status is not 200.
36
+ # Credit usage, included whenever a valid API key is provided.
38
37
  sig do
39
38
  returns(T.nilable(ContextDev::Models::NewsSearchResponse::KeyMetadata))
40
39
  end
@@ -68,8 +67,7 @@ module ContextDev
68
67
  # Pass as cursor in the next request to fetch the following page. Null when there
69
68
  # are no more results.
70
69
  next_cursor:,
71
- # Metadata about the API key used for the request. Included in every response
72
- # 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.
73
71
  key_metadata: nil
74
72
  )
75
73
  end
@@ -453,25 +451,24 @@ module ContextDev
453
451
  )
454
452
  end
455
453
 
456
- # The number of credits consumed by this request.
454
+ # Credits used by this request.
457
455
  sig { returns(Integer) }
458
456
  attr_accessor :credits_consumed
459
457
 
460
- # The number of credits remaining for your organization after this request.
458
+ # Credits remaining for your organization.
461
459
  sig { returns(Integer) }
462
460
  attr_accessor :credits_remaining
463
461
 
464
- # Metadata about the API key used for the request. Included in every response
465
- # whenever a valid API key is provided, even when the response status is not 200.
462
+ # Credit usage, included whenever a valid API key is provided.
466
463
  sig do
467
464
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
468
465
  T.attached_class
469
466
  )
470
467
  end
471
468
  def self.new(
472
- # The number of credits consumed by this request.
469
+ # Credits used by this request.
473
470
  credits_consumed:,
474
- # The number of credits remaining for your organization after this request.
471
+ # Credits remaining for your organization.
475
472
  credits_remaining:
476
473
  )
477
474
  end
@@ -74,9 +74,8 @@ module ContextDev
74
74
  sig { params(shorten_base64_images: T::Boolean).void }
75
75
  attr_writer :shorten_base64_images
76
76
 
77
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
78
- # recorded on the request's usage log and can be used to filter usage on the
79
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
77
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
78
+ # characters.
80
79
  sig { returns(T.nilable(T::Array[String])) }
81
80
  attr_reader :tags
82
81
 
@@ -137,9 +136,8 @@ module ContextDev
137
136
  pdf: nil,
138
137
  # Shorten base64-encoded image data in the Markdown output
139
138
  shorten_base64_images: nil,
140
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
141
- # recorded on the request's usage log and can be used to filter usage on the
142
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
139
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
140
+ # characters.
143
141
  tags: nil,
144
142
  # Extract only the main content from HTML-like inputs
145
143
  use_main_content_only: nil,
@@ -27,8 +27,7 @@ module ContextDev
27
27
  end
28
28
  attr_accessor :type
29
29
 
30
- # Metadata about the API key used for the request. Included in every response
31
- # whenever a valid API key is provided, even when the response status is not 200.
30
+ # Credit usage, included whenever a valid API key is provided.
32
31
  sig do
33
32
  returns(T.nilable(ContextDev::Models::ParseHandleResponse::KeyMetadata))
34
33
  end
@@ -58,8 +57,7 @@ module ContextDev
58
57
  success:,
59
58
  # Detected content type used for parsing
60
59
  type:,
61
- # Metadata about the API key used for the request. Included in every response
62
- # whenever a valid API key is provided, even when the response status is not 200.
60
+ # Credit usage, included whenever a valid API key is provided.
63
61
  key_metadata: nil
64
62
  )
65
63
  end
@@ -341,25 +339,24 @@ module ContextDev
341
339
  )
342
340
  end
343
341
 
344
- # The number of credits consumed by this request.
342
+ # Credits used by this request.
345
343
  sig { returns(Integer) }
346
344
  attr_accessor :credits_consumed
347
345
 
348
- # The number of credits remaining for your organization after this request.
346
+ # Credits remaining for your organization.
349
347
  sig { returns(Integer) }
350
348
  attr_accessor :credits_remaining
351
349
 
352
- # Metadata about the API key used for the request. Included in every response
353
- # whenever a valid API key is provided, even when the response status is not 200.
350
+ # Credit usage, included whenever a valid API key is provided.
354
351
  sig do
355
352
  params(credits_consumed: Integer, credits_remaining: Integer).returns(
356
353
  T.attached_class
357
354
  )
358
355
  end
359
356
  def self.new(
360
- # The number of credits consumed by this request.
357
+ # Credits used by this request.
361
358
  credits_consumed:,
362
- # The number of credits remaining for your organization after this request.
359
+ # Credits remaining for your organization.
363
360
  credits_remaining:
364
361
  )
365
362
  end