context.dev 2.21.0 → 2.22.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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -9
  5. data/lib/context_dev/models/batch_cancel_params.rb +2 -2
  6. data/lib/context_dev/models/batch_cancel_response.rb +16 -21
  7. data/lib/context_dev/models/batch_delete_params.rb +2 -2
  8. data/lib/context_dev/models/batch_delete_response.rb +8 -8
  9. data/lib/context_dev/models/batch_get_results_params.rb +2 -2
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -22
  11. data/lib/context_dev/models/batch_list_response.rb +38 -47
  12. data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
  13. data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
  14. data/lib/context_dev/models/batch_submit_params.rb +80 -109
  15. data/lib/context_dev/models/batch_submit_response.rb +18 -28
  16. data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
  17. data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
  18. data/lib/context_dev/models/brand_search_params.rb +2 -3
  19. data/lib/context_dev/models/brand_search_response.rb +8 -8
  20. data/lib/context_dev/models/crawl_controls.rb +1 -2
  21. data/lib/context_dev/models/feedback_submit_params.rb +2 -2
  22. data/lib/context_dev/models/feedback_submit_response.rb +8 -8
  23. data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
  24. data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
  25. data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
  26. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
  27. data/lib/context_dev/models/intake.rb +7 -13
  28. data/lib/context_dev/models/log_list_response.rb +14 -10
  29. data/lib/context_dev/models/log_retrieve_response.rb +15 -41
  30. data/lib/context_dev/models/monitor_create_params.rb +238 -72
  31. data/lib/context_dev/models/monitor_create_response.rb +364 -175
  32. data/lib/context_dev/models/monitor_delete_params.rb +3 -1
  33. data/lib/context_dev/models/monitor_delete_response.rb +44 -1
  34. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
  35. data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
  36. data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
  37. data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
  38. data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
  39. data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
  40. data/lib/context_dev/models/monitor_list_params.rb +3 -3
  41. data/lib/context_dev/models/monitor_list_response.rb +304 -106
  42. data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
  43. data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
  44. data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
  45. data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
  46. data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
  47. data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
  48. data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
  49. data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
  50. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
  51. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
  52. data/lib/context_dev/models/monitor_run_params.rb +3 -1
  53. data/lib/context_dev/models/monitor_run_response.rb +42 -4
  54. data/lib/context_dev/models/monitor_update_params.rb +239 -71
  55. data/lib/context_dev/models/monitor_update_response.rb +361 -171
  56. data/lib/context_dev/models/news_search_params.rb +10 -6
  57. data/lib/context_dev/models/news_search_response.rb +8 -8
  58. data/lib/context_dev/models/parse_handle_params.rb +9 -20
  59. data/lib/context_dev/models/parse_handle_response.rb +8 -8
  60. data/lib/context_dev/models/person_enrich_params.rb +76 -50
  61. data/lib/context_dev/models/person_enrich_response.rb +8 -8
  62. data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
  63. data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
  64. data/lib/context_dev/models/web_answers_params.rb +28 -47
  65. data/lib/context_dev/models/web_answers_response.rb +9 -8
  66. data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
  67. data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
  68. data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
  69. data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
  70. data/lib/context_dev/models/web_map_urls_params.rb +30 -51
  71. data/lib/context_dev/models/web_map_urls_response.rb +8 -8
  72. data/lib/context_dev/models/web_scrape_params.rb +193 -191
  73. data/lib/context_dev/models/web_scrape_response.rb +219 -95
  74. data/lib/context_dev/models/web_screenshot_params.rb +20 -39
  75. data/lib/context_dev/models/web_screenshot_response.rb +18 -28
  76. data/lib/context_dev/models/web_search_params.rb +76 -65
  77. data/lib/context_dev/models/web_search_response.rb +68 -27
  78. data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
  79. data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
  80. data/lib/context_dev/models/webhook_delivery.rb +3 -7
  81. data/lib/context_dev/models/webhooks/attempt.rb +3 -3
  82. data/lib/context_dev/models/webhooks/delivery.rb +16 -11
  83. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
  84. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
  85. data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
  86. data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
  87. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
  88. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
  89. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
  90. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
  91. data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
  92. data/lib/context_dev/resources/batch.rb +17 -16
  93. data/lib/context_dev/resources/brand.rb +6 -8
  94. data/lib/context_dev/resources/feedback.rb +4 -5
  95. data/lib/context_dev/resources/industry.rb +9 -11
  96. data/lib/context_dev/resources/logs.rb +4 -5
  97. data/lib/context_dev/resources/monitors.rb +50 -53
  98. data/lib/context_dev/resources/news.rb +4 -8
  99. data/lib/context_dev/resources/parse.rb +4 -5
  100. data/lib/context_dev/resources/people.rb +11 -13
  101. data/lib/context_dev/resources/utility.rb +4 -11
  102. data/lib/context_dev/resources/web.rb +69 -94
  103. data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
  104. data/lib/context_dev/resources/webhooks.rb +1 -1
  105. data/lib/context_dev/version.rb +1 -1
  106. data/rbi/context_dev/client.rbi +4 -9
  107. data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
  108. data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
  109. data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
  110. data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
  111. data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
  112. data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
  113. data/rbi/context_dev/models/batch_list_response.rbi +41 -53
  114. data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
  115. data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
  116. data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
  117. data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
  118. data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
  119. data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
  120. data/rbi/context_dev/models/brand_search_params.rbi +2 -4
  121. data/rbi/context_dev/models/brand_search_response.rbi +9 -9
  122. data/rbi/context_dev/models/crawl_controls.rbi +1 -2
  123. data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
  124. data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
  125. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
  126. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
  127. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
  128. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
  129. data/rbi/context_dev/models/intake.rbi +7 -19
  130. data/rbi/context_dev/models/log_list_response.rbi +13 -11
  131. data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
  132. data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
  133. data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
  134. data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
  135. data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
  136. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
  137. data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
  138. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
  139. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
  140. data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
  141. data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
  142. data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
  143. data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
  144. data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
  145. data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
  146. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
  147. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
  148. data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
  149. data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
  150. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
  151. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
  152. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
  153. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
  154. data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
  155. data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
  156. data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
  157. data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
  158. data/rbi/context_dev/models/news_search_params.rbi +10 -2
  159. data/rbi/context_dev/models/news_search_response.rbi +9 -9
  160. data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
  161. data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
  162. data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
  163. data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
  164. data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
  165. data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
  166. data/rbi/context_dev/models/web_answers_params.rbi +33 -63
  167. data/rbi/context_dev/models/web_answers_response.rbi +11 -9
  168. data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
  169. data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
  170. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
  171. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
  172. data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
  173. data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
  174. data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
  175. data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
  176. data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
  177. data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
  178. data/rbi/context_dev/models/web_search_params.rbi +114 -82
  179. data/rbi/context_dev/models/web_search_response.rbi +145 -33
  180. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
  181. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
  182. data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
  183. data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
  184. data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
  185. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
  186. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
  187. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
  188. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
  189. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
  190. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
  191. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
  192. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
  193. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
  194. data/rbi/context_dev/resources/batch.rbi +19 -18
  195. data/rbi/context_dev/resources/brand.rbi +6 -9
  196. data/rbi/context_dev/resources/feedback.rbi +4 -5
  197. data/rbi/context_dev/resources/industry.rbi +11 -27
  198. data/rbi/context_dev/resources/logs.rbi +4 -5
  199. data/rbi/context_dev/resources/monitors.rbi +71 -49
  200. data/rbi/context_dev/resources/news.rbi +4 -8
  201. data/rbi/context_dev/resources/parse.rbi +7 -14
  202. data/rbi/context_dev/resources/people.rbi +15 -13
  203. data/rbi/context_dev/resources/utility.rbi +4 -11
  204. data/rbi/context_dev/resources/web.rbi +89 -190
  205. data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
  206. data/rbi/context_dev/resources/webhooks.rbi +1 -1
  207. data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
  208. data/sig/context_dev/models/monitor_create_params.rbs +113 -0
  209. data/sig/context_dev/models/monitor_create_response.rbs +203 -53
  210. data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
  211. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
  212. data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
  213. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
  214. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
  215. data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
  216. data/sig/context_dev/models/monitor_list_response.rbs +149 -3
  217. data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
  218. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
  219. data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
  220. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
  221. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
  222. data/sig/context_dev/models/monitor_run_response.rbs +48 -3
  223. data/sig/context_dev/models/monitor_update_params.rbs +113 -0
  224. data/sig/context_dev/models/monitor_update_response.rbs +203 -53
  225. data/sig/context_dev/models/web_scrape_response.rbs +204 -27
  226. data/sig/context_dev/models/web_search_params.rbs +25 -0
  227. data/sig/context_dev/models/web_search_response.rbs +48 -0
  228. data/sig/context_dev/resources/web.rbs +1 -0
  229. metadata +2 -2
@@ -11,7 +11,7 @@ module ContextDev
11
11
  T.any(ContextDev::BrandRetrieveParams, ContextDev::Internal::AnyHash)
12
12
  end
13
13
 
14
- # Exactly one lookup type must be provided.
14
+ # One lookup, chosen by `type`.
15
15
  sig do
16
16
  returns(
17
17
  T.any(
@@ -41,7 +41,7 @@ module ContextDev
41
41
  ).returns(T.attached_class)
42
42
  end
43
43
  def self.new(
44
- # Exactly one lookup type must be provided.
44
+ # One lookup, chosen by `type`.
45
45
  body:,
46
46
  request_options: {}
47
47
  )
@@ -66,7 +66,7 @@ module ContextDev
66
66
  def to_hash
67
67
  end
68
68
 
69
- # Exactly one lookup type must be provided.
69
+ # One lookup, chosen by `type`.
70
70
  module Body
71
71
  extend ContextDev::Internal::Type::Union
72
72
 
@@ -108,10 +108,8 @@ module ContextDev
108
108
  end
109
109
  attr_accessor :force_language
110
110
 
111
- # Maximum age in milliseconds for cached brand data before the API performs a hard
112
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
113
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
114
- # are clamped to 1 year.
111
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
112
+ # year. `0` refreshes.
115
113
  sig { returns(T.nilable(Integer)) }
116
114
  attr_reader :max_age_ms
117
115
 
@@ -127,16 +125,14 @@ module ContextDev
127
125
  sig { params(max_speed: T::Boolean).void }
128
126
  attr_writer :max_speed
129
127
 
130
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
128
+ # Labels for filtering usage in the dashboard.
131
129
  sig { returns(T.nilable(T::Array[String])) }
132
130
  attr_reader :tags
133
131
 
134
132
  sig { params(tags: T::Array[String]).void }
135
133
  attr_writer :tags
136
134
 
137
- # Optional request deadline and behavior on timeout. For GET requests, use
138
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
139
- # timeoutOpts object.
135
+ # Request deadline and what to return when it passes.
140
136
  sig do
141
137
  returns(
142
138
  T.nilable(
@@ -174,20 +170,16 @@ module ContextDev
174
170
  # Domain name to retrieve brand data for (e.g., 'stripe.com').
175
171
  domain:,
176
172
  force_language: nil,
177
- # Maximum age in milliseconds for cached brand data before the API performs a hard
178
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
179
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
180
- # are clamped to 1 year.
173
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
174
+ # year. `0` refreshes.
181
175
  max_age_ms: nil,
182
176
  # Optional parameter to optimize the API call for maximum speed. When set to true,
183
177
  # the API will skip time-consuming operations for faster response at the cost of
184
178
  # less comprehensive data.
185
179
  max_speed: nil,
186
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
180
+ # Labels for filtering usage in the dashboard.
187
181
  tags: nil,
188
- # Optional request deadline and behavior on timeout. For GET requests, use
189
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
190
- # timeoutOpts object.
182
+ # Request deadline and what to return when it passes.
191
183
  timeout_opts: nil,
192
184
  # Discriminator for domain-based brand retrieval.
193
185
  type: :by_domain
@@ -847,14 +839,12 @@ module ContextDev
847
839
  )
848
840
  end
849
841
 
850
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
842
+ # Deadline in milliseconds.
851
843
  sig { returns(Integer) }
852
844
  attr_accessor :milliseconds
853
845
 
854
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
855
- # credits. "return-partial" returns usable results collected so far; if none are
856
- # available, the request still fails without charging credits. Partial results are
857
- # not cached as complete results.
846
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
847
+ # inspect the response’s partial flag.
858
848
  sig do
859
849
  returns(
860
850
  T.nilable(
@@ -872,9 +862,7 @@ module ContextDev
872
862
  end
873
863
  attr_writer :behavior
874
864
 
875
- # Optional request deadline and behavior on timeout. For GET requests, use
876
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
877
- # timeoutOpts object.
865
+ # Request deadline and what to return when it passes.
878
866
  sig do
879
867
  params(
880
868
  milliseconds: Integer,
@@ -883,12 +871,10 @@ module ContextDev
883
871
  ).returns(T.attached_class)
884
872
  end
885
873
  def self.new(
886
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
874
+ # Deadline in milliseconds.
887
875
  milliseconds:,
888
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
889
- # credits. "return-partial" returns usable results collected so far; if none are
890
- # available, the request still fails without charging credits. Partial results are
891
- # not cached as complete results.
876
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
877
+ # inspect the response’s partial flag.
892
878
  behavior: nil
893
879
  )
894
880
  end
@@ -905,10 +891,8 @@ module ContextDev
905
891
  def to_hash
906
892
  end
907
893
 
908
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
909
- # credits. "return-partial" returns usable results collected so far; if none are
910
- # available, the request still fails without charging credits. Partial results are
911
- # not cached as complete results.
894
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
895
+ # inspect the response’s partial flag.
912
896
  module Behavior
913
897
  extend ContextDev::Internal::Type::Enum
914
898
 
@@ -979,10 +963,8 @@ module ContextDev
979
963
  end
980
964
  attr_accessor :force_language
981
965
 
982
- # Maximum age in milliseconds for cached brand data before the API performs a hard
983
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
984
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
985
- # are clamped to 1 year.
966
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
967
+ # year. `0` refreshes.
986
968
  sig { returns(T.nilable(Integer)) }
987
969
  attr_reader :max_age_ms
988
970
 
@@ -998,16 +980,14 @@ module ContextDev
998
980
  sig { params(max_speed: T::Boolean).void }
999
981
  attr_writer :max_speed
1000
982
 
1001
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
983
+ # Labels for filtering usage in the dashboard.
1002
984
  sig { returns(T.nilable(T::Array[String])) }
1003
985
  attr_reader :tags
1004
986
 
1005
987
  sig { params(tags: T::Array[String]).void }
1006
988
  attr_writer :tags
1007
989
 
1008
- # Optional request deadline and behavior on timeout. For GET requests, use
1009
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
1010
- # timeoutOpts object.
990
+ # Request deadline and what to return when it passes.
1011
991
  sig do
1012
992
  returns(
1013
993
  T.nilable(
@@ -1050,20 +1030,16 @@ module ContextDev
1050
1030
  # by company name.
1051
1031
  country_gl: nil,
1052
1032
  force_language: nil,
1053
- # Maximum age in milliseconds for cached brand data before the API performs a hard
1054
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
1055
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
1056
- # are clamped to 1 year.
1033
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
1034
+ # year. `0` refreshes.
1057
1035
  max_age_ms: nil,
1058
1036
  # Optional parameter to optimize the API call for maximum speed. When set to true,
1059
1037
  # the API will skip time-consuming operations for faster response at the cost of
1060
1038
  # less comprehensive data.
1061
1039
  max_speed: nil,
1062
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
1040
+ # Labels for filtering usage in the dashboard.
1063
1041
  tags: nil,
1064
- # Optional request deadline and behavior on timeout. For GET requests, use
1065
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
1066
- # timeoutOpts object.
1042
+ # Request deadline and what to return when it passes.
1067
1043
  timeout_opts: nil,
1068
1044
  # Discriminator for name-based brand retrieval.
1069
1045
  type: :by_name
@@ -1724,14 +1700,12 @@ module ContextDev
1724
1700
  )
1725
1701
  end
1726
1702
 
1727
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
1703
+ # Deadline in milliseconds.
1728
1704
  sig { returns(Integer) }
1729
1705
  attr_accessor :milliseconds
1730
1706
 
1731
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
1732
- # credits. "return-partial" returns usable results collected so far; if none are
1733
- # available, the request still fails without charging credits. Partial results are
1734
- # not cached as complete results.
1707
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
1708
+ # inspect the response’s partial flag.
1735
1709
  sig do
1736
1710
  returns(
1737
1711
  T.nilable(
@@ -1749,9 +1723,7 @@ module ContextDev
1749
1723
  end
1750
1724
  attr_writer :behavior
1751
1725
 
1752
- # Optional request deadline and behavior on timeout. For GET requests, use
1753
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
1754
- # timeoutOpts object.
1726
+ # Request deadline and what to return when it passes.
1755
1727
  sig do
1756
1728
  params(
1757
1729
  milliseconds: Integer,
@@ -1760,12 +1732,10 @@ module ContextDev
1760
1732
  ).returns(T.attached_class)
1761
1733
  end
1762
1734
  def self.new(
1763
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
1735
+ # Deadline in milliseconds.
1764
1736
  milliseconds:,
1765
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
1766
- # credits. "return-partial" returns usable results collected so far; if none are
1767
- # available, the request still fails without charging credits. Partial results are
1768
- # not cached as complete results.
1737
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
1738
+ # inspect the response’s partial flag.
1769
1739
  behavior: nil
1770
1740
  )
1771
1741
  end
@@ -1782,10 +1752,8 @@ module ContextDev
1782
1752
  def to_hash
1783
1753
  end
1784
1754
 
1785
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
1786
- # credits. "return-partial" returns usable results collected so far; if none are
1787
- # available, the request still fails without charging credits. Partial results are
1788
- # not cached as complete results.
1755
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
1756
+ # inspect the response’s partial flag.
1789
1757
  module Behavior
1790
1758
  extend ContextDev::Internal::Type::Enum
1791
1759
 
@@ -1848,10 +1816,8 @@ module ContextDev
1848
1816
  end
1849
1817
  attr_accessor :force_language
1850
1818
 
1851
- # Maximum age in milliseconds for cached brand data before the API performs a hard
1852
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
1853
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
1854
- # are clamped to 1 year.
1819
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
1820
+ # year. `0` refreshes.
1855
1821
  sig { returns(T.nilable(Integer)) }
1856
1822
  attr_reader :max_age_ms
1857
1823
 
@@ -1867,16 +1833,14 @@ module ContextDev
1867
1833
  sig { params(max_speed: T::Boolean).void }
1868
1834
  attr_writer :max_speed
1869
1835
 
1870
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
1836
+ # Labels for filtering usage in the dashboard.
1871
1837
  sig { returns(T.nilable(T::Array[String])) }
1872
1838
  attr_reader :tags
1873
1839
 
1874
1840
  sig { params(tags: T::Array[String]).void }
1875
1841
  attr_writer :tags
1876
1842
 
1877
- # Optional request deadline and behavior on timeout. For GET requests, use
1878
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
1879
- # timeoutOpts object.
1843
+ # Request deadline and what to return when it passes.
1880
1844
  sig do
1881
1845
  returns(
1882
1846
  T.nilable(
@@ -1916,20 +1880,16 @@ module ContextDev
1916
1880
  # Email address to retrieve brand data for (e.g., 'jane@stripe.com').
1917
1881
  email:,
1918
1882
  force_language: nil,
1919
- # Maximum age in milliseconds for cached brand data before the API performs a hard
1920
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
1921
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
1922
- # are clamped to 1 year.
1883
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
1884
+ # year. `0` refreshes.
1923
1885
  max_age_ms: nil,
1924
1886
  # Optional parameter to optimize the API call for maximum speed. When set to true,
1925
1887
  # the API will skip time-consuming operations for faster response at the cost of
1926
1888
  # less comprehensive data.
1927
1889
  max_speed: nil,
1928
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
1890
+ # Labels for filtering usage in the dashboard.
1929
1891
  tags: nil,
1930
- # Optional request deadline and behavior on timeout. For GET requests, use
1931
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
1932
- # timeoutOpts object.
1892
+ # Request deadline and what to return when it passes.
1933
1893
  timeout_opts: nil,
1934
1894
  # Discriminator for email-based brand retrieval.
1935
1895
  type: :by_email
@@ -2589,14 +2549,12 @@ module ContextDev
2589
2549
  )
2590
2550
  end
2591
2551
 
2592
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
2552
+ # Deadline in milliseconds.
2593
2553
  sig { returns(Integer) }
2594
2554
  attr_accessor :milliseconds
2595
2555
 
2596
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
2597
- # credits. "return-partial" returns usable results collected so far; if none are
2598
- # available, the request still fails without charging credits. Partial results are
2599
- # not cached as complete results.
2556
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
2557
+ # inspect the response’s partial flag.
2600
2558
  sig do
2601
2559
  returns(
2602
2560
  T.nilable(
@@ -2614,9 +2572,7 @@ module ContextDev
2614
2572
  end
2615
2573
  attr_writer :behavior
2616
2574
 
2617
- # Optional request deadline and behavior on timeout. For GET requests, use
2618
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
2619
- # timeoutOpts object.
2575
+ # Request deadline and what to return when it passes.
2620
2576
  sig do
2621
2577
  params(
2622
2578
  milliseconds: Integer,
@@ -2625,12 +2581,10 @@ module ContextDev
2625
2581
  ).returns(T.attached_class)
2626
2582
  end
2627
2583
  def self.new(
2628
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
2584
+ # Deadline in milliseconds.
2629
2585
  milliseconds:,
2630
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
2631
- # credits. "return-partial" returns usable results collected so far; if none are
2632
- # available, the request still fails without charging credits. Partial results are
2633
- # not cached as complete results.
2586
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
2587
+ # inspect the response’s partial flag.
2634
2588
  behavior: nil
2635
2589
  )
2636
2590
  end
@@ -2647,10 +2601,8 @@ module ContextDev
2647
2601
  def to_hash
2648
2602
  end
2649
2603
 
2650
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
2651
- # credits. "return-partial" returns usable results collected so far; if none are
2652
- # available, the request still fails without charging credits. Partial results are
2653
- # not cached as complete results.
2604
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
2605
+ # inspect the response’s partial flag.
2654
2606
  module Behavior
2655
2607
  extend ContextDev::Internal::Type::Enum
2656
2608
 
@@ -2713,10 +2665,8 @@ module ContextDev
2713
2665
  end
2714
2666
  attr_accessor :force_language
2715
2667
 
2716
- # Maximum age in milliseconds for cached brand data before the API performs a hard
2717
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
2718
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
2719
- # are clamped to 1 year.
2668
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
2669
+ # year. `0` refreshes.
2720
2670
  sig { returns(T.nilable(Integer)) }
2721
2671
  attr_reader :max_age_ms
2722
2672
 
@@ -2732,7 +2682,7 @@ module ContextDev
2732
2682
  sig { params(max_speed: T::Boolean).void }
2733
2683
  attr_writer :max_speed
2734
2684
 
2735
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
2685
+ # Labels for filtering usage in the dashboard.
2736
2686
  sig { returns(T.nilable(T::Array[String])) }
2737
2687
  attr_reader :tags
2738
2688
 
@@ -2746,9 +2696,7 @@ module ContextDev
2746
2696
  sig { params(ticker_exchange: String).void }
2747
2697
  attr_writer :ticker_exchange
2748
2698
 
2749
- # Optional request deadline and behavior on timeout. For GET requests, use
2750
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
2751
- # timeoutOpts object.
2699
+ # Request deadline and what to return when it passes.
2752
2700
  sig do
2753
2701
  returns(
2754
2702
  T.nilable(
@@ -2788,22 +2736,18 @@ module ContextDev
2788
2736
  # Stock ticker symbol to retrieve brand data for (e.g., 'AAPL').
2789
2737
  ticker:,
2790
2738
  force_language: nil,
2791
- # Maximum age in milliseconds for cached brand data before the API performs a hard
2792
- # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
2793
- # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
2794
- # are clamped to 1 year.
2739
+ # Maximum age of cached brand data in ms. Defaults to 3 months; clamped to 0–1
2740
+ # year. `0` refreshes.
2795
2741
  max_age_ms: nil,
2796
2742
  # Optional parameter to optimize the API call for maximum speed. When set to true,
2797
2743
  # the API will skip time-consuming operations for faster response at the cost of
2798
2744
  # less comprehensive data.
2799
2745
  max_speed: nil,
2800
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
2746
+ # Labels for filtering usage in the dashboard.
2801
2747
  tags: nil,
2802
2748
  # Optional stock exchange for the ticker. Defaults to NASDAQ if not specified.
2803
2749
  ticker_exchange: nil,
2804
- # Optional request deadline and behavior on timeout. For GET requests, use
2805
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
2806
- # timeoutOpts object.
2750
+ # Request deadline and what to return when it passes.
2807
2751
  timeout_opts: nil,
2808
2752
  # Discriminator for ticker-based brand retrieval.
2809
2753
  type: :by_ticker
@@ -3464,14 +3408,12 @@ module ContextDev
3464
3408
  )
3465
3409
  end
3466
3410
 
3467
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
3411
+ # Deadline in milliseconds.
3468
3412
  sig { returns(Integer) }
3469
3413
  attr_accessor :milliseconds
3470
3414
 
3471
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3472
- # credits. "return-partial" returns usable results collected so far; if none are
3473
- # available, the request still fails without charging credits. Partial results are
3474
- # not cached as complete results.
3415
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3416
+ # inspect the response’s partial flag.
3475
3417
  sig do
3476
3418
  returns(
3477
3419
  T.nilable(
@@ -3489,9 +3431,7 @@ module ContextDev
3489
3431
  end
3490
3432
  attr_writer :behavior
3491
3433
 
3492
- # Optional request deadline and behavior on timeout. For GET requests, use
3493
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3494
- # timeoutOpts object.
3434
+ # Request deadline and what to return when it passes.
3495
3435
  sig do
3496
3436
  params(
3497
3437
  milliseconds: Integer,
@@ -3500,12 +3440,10 @@ module ContextDev
3500
3440
  ).returns(T.attached_class)
3501
3441
  end
3502
3442
  def self.new(
3503
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
3443
+ # Deadline in milliseconds.
3504
3444
  milliseconds:,
3505
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3506
- # credits. "return-partial" returns usable results collected so far; if none are
3507
- # available, the request still fails without charging credits. Partial results are
3508
- # not cached as complete results.
3445
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3446
+ # inspect the response’s partial flag.
3509
3447
  behavior: nil
3510
3448
  )
3511
3449
  end
@@ -3522,10 +3460,8 @@ module ContextDev
3522
3460
  def to_hash
3523
3461
  end
3524
3462
 
3525
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3526
- # credits. "return-partial" returns usable results collected so far; if none are
3527
- # available, the request still fails without charging credits. Partial results are
3528
- # not cached as complete results.
3463
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3464
+ # inspect the response’s partial flag.
3529
3465
  module Behavior
3530
3466
  extend ContextDev::Internal::Type::Enum
3531
3467
 
@@ -3581,16 +3517,14 @@ module ContextDev
3581
3517
  sig { returns(Symbol) }
3582
3518
  attr_accessor :type
3583
3519
 
3584
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3520
+ # Labels for filtering usage in the dashboard.
3585
3521
  sig { returns(T.nilable(T::Array[String])) }
3586
3522
  attr_reader :tags
3587
3523
 
3588
3524
  sig { params(tags: T::Array[String]).void }
3589
3525
  attr_writer :tags
3590
3526
 
3591
- # Optional request deadline and behavior on timeout. For GET requests, use
3592
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3593
- # timeoutOpts object.
3527
+ # Request deadline and what to return when it passes.
3594
3528
  sig do
3595
3529
  returns(
3596
3530
  T.nilable(
@@ -3608,11 +3542,8 @@ module ContextDev
3608
3542
  end
3609
3543
  attr_writer :timeout_opts
3610
3544
 
3611
- # Retrieve brand data by fetching the provided URL directly. Note: if you use
3612
- # this, brand data is fetched only from the provided URL — not from the entire
3613
- # internet — so results are limited to what that single page contains. No domain
3614
- # resolution, database lookup, or cross-source enrichment is performed. Cannot be
3615
- # combined with domain, name, email, or ticker.
3545
+ # Retrieve brand data from this exact URL. Cross-site enrichment and other lookup
3546
+ # identifiers are excluded.
3616
3547
  sig do
3617
3548
  params(
3618
3549
  direct_url: String,
@@ -3627,11 +3558,9 @@ module ContextDev
3627
3558
  # 'https://stripe.com/enterprise'). Only this URL is fetched — not the entire
3628
3559
  # internet.
3629
3560
  direct_url:,
3630
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3561
+ # Labels for filtering usage in the dashboard.
3631
3562
  tags: nil,
3632
- # Optional request deadline and behavior on timeout. For GET requests, use
3633
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3634
- # timeoutOpts object.
3563
+ # Request deadline and what to return when it passes.
3635
3564
  timeout_opts: nil,
3636
3565
  # Discriminator for direct-URL-based brand retrieval.
3637
3566
  type: :by_direct_url
@@ -3661,14 +3590,12 @@ module ContextDev
3661
3590
  )
3662
3591
  end
3663
3592
 
3664
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
3593
+ # Deadline in milliseconds.
3665
3594
  sig { returns(Integer) }
3666
3595
  attr_accessor :milliseconds
3667
3596
 
3668
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3669
- # credits. "return-partial" returns usable results collected so far; if none are
3670
- # available, the request still fails without charging credits. Partial results are
3671
- # not cached as complete results.
3597
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3598
+ # inspect the response’s partial flag.
3672
3599
  sig do
3673
3600
  returns(
3674
3601
  T.nilable(
@@ -3686,9 +3613,7 @@ module ContextDev
3686
3613
  end
3687
3614
  attr_writer :behavior
3688
3615
 
3689
- # Optional request deadline and behavior on timeout. For GET requests, use
3690
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3691
- # timeoutOpts object.
3616
+ # Request deadline and what to return when it passes.
3692
3617
  sig do
3693
3618
  params(
3694
3619
  milliseconds: Integer,
@@ -3697,12 +3622,10 @@ module ContextDev
3697
3622
  ).returns(T.attached_class)
3698
3623
  end
3699
3624
  def self.new(
3700
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
3625
+ # Deadline in milliseconds.
3701
3626
  milliseconds:,
3702
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3703
- # credits. "return-partial" returns usable results collected so far; if none are
3704
- # available, the request still fails without charging credits. Partial results are
3705
- # not cached as complete results.
3627
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3628
+ # inspect the response’s partial flag.
3706
3629
  behavior: nil
3707
3630
  )
3708
3631
  end
@@ -3719,10 +3642,8 @@ module ContextDev
3719
3642
  def to_hash
3720
3643
  end
3721
3644
 
3722
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
3723
- # credits. "return-partial" returns usable results collected so far; if none are
3724
- # available, the request still fails without charging credits. Partial results are
3725
- # not cached as complete results.
3645
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
3646
+ # inspect the response’s partial flag.
3726
3647
  module Behavior
3727
3648
  extend ContextDev::Internal::Type::Enum
3728
3649
 
@@ -3854,16 +3775,14 @@ module ContextDev
3854
3775
  end
3855
3776
  attr_writer :phone
3856
3777
 
3857
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3778
+ # Labels for filtering usage in the dashboard.
3858
3779
  sig { returns(T.nilable(T::Array[String])) }
3859
3780
  attr_reader :tags
3860
3781
 
3861
3782
  sig { params(tags: T::Array[String]).void }
3862
3783
  attr_writer :tags
3863
3784
 
3864
- # Optional request deadline and behavior on timeout. For GET requests, use
3865
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3866
- # timeoutOpts object.
3785
+ # Request deadline and what to return when it passes.
3867
3786
  sig do
3868
3787
  returns(
3869
3788
  T.nilable(
@@ -3925,11 +3844,9 @@ module ContextDev
3925
3844
  mcc: nil,
3926
3845
  # Optional phone number from the transaction to help verify brand match.
3927
3846
  phone: nil,
3928
- # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
3847
+ # Labels for filtering usage in the dashboard.
3929
3848
  tags: nil,
3930
- # Optional request deadline and behavior on timeout. For GET requests, use
3931
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
3932
- # timeoutOpts object.
3849
+ # Request deadline and what to return when it passes.
3933
3850
  timeout_opts: nil,
3934
3851
  # Discriminator for transaction-based brand retrieval.
3935
3852
  type: :by_transaction
@@ -4630,14 +4547,12 @@ module ContextDev
4630
4547
  )
4631
4548
  end
4632
4549
 
4633
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
4550
+ # Deadline in milliseconds.
4634
4551
  sig { returns(Integer) }
4635
4552
  attr_accessor :milliseconds
4636
4553
 
4637
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
4638
- # credits. "return-partial" returns usable results collected so far; if none are
4639
- # available, the request still fails without charging credits. Partial results are
4640
- # not cached as complete results.
4554
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
4555
+ # inspect the response’s partial flag.
4641
4556
  sig do
4642
4557
  returns(
4643
4558
  T.nilable(
@@ -4655,9 +4570,7 @@ module ContextDev
4655
4570
  end
4656
4571
  attr_writer :behavior
4657
4572
 
4658
- # Optional request deadline and behavior on timeout. For GET requests, use
4659
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
4660
- # timeoutOpts object.
4573
+ # Request deadline and what to return when it passes.
4661
4574
  sig do
4662
4575
  params(
4663
4576
  milliseconds: Integer,
@@ -4666,12 +4579,10 @@ module ContextDev
4666
4579
  ).returns(T.attached_class)
4667
4580
  end
4668
4581
  def self.new(
4669
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
4582
+ # Deadline in milliseconds.
4670
4583
  milliseconds:,
4671
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
4672
- # credits. "return-partial" returns usable results collected so far; if none are
4673
- # available, the request still fails without charging credits. Partial results are
4674
- # not cached as complete results.
4584
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
4585
+ # inspect the response’s partial flag.
4675
4586
  behavior: nil
4676
4587
  )
4677
4588
  end
@@ -4688,10 +4599,8 @@ module ContextDev
4688
4599
  def to_hash
4689
4600
  end
4690
4601
 
4691
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
4692
- # credits. "return-partial" returns usable results collected so far; if none are
4693
- # available, the request still fails without charging credits. Partial results are
4694
- # not cached as complete results.
4602
+ # "fail" returns 408 at the deadline. "return-partial" returns available results;
4603
+ # inspect the response’s partial flag.
4695
4604
  module Behavior
4696
4605
  extend ContextDev::Internal::Type::Enum
4697
4606