context.dev 2.3.0 → 2.5.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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +9 -9
  4. data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
  5. data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
  6. data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
  7. data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
  8. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
  9. data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
  10. data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
  11. data/lib/context_dev/models/monitor_create_params.rb +6 -5
  12. data/lib/context_dev/models/monitor_create_response.rb +6 -5
  13. data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
  14. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
  15. data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
  16. data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
  17. data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
  18. data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
  19. data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
  20. data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
  21. data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
  22. data/lib/context_dev/models/monitor_list_params.rb +18 -19
  23. data/lib/context_dev/models/monitor_list_response.rb +6 -5
  24. data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
  25. data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
  26. data/lib/context_dev/models/monitor_retrieve_response.rb +6 -5
  27. data/lib/context_dev/models/monitor_update_params.rb +6 -5
  28. data/lib/context_dev/models/monitor_update_response.rb +6 -5
  29. data/lib/context_dev/models/parse_handle_params.rb +296 -46
  30. data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
  31. data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
  32. data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
  33. data/lib/context_dev/models/web_extract_params.rb +19 -1
  34. data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
  35. data/lib/context_dev/models/web_screenshot_params.rb +69 -18
  36. data/lib/context_dev/models/web_screenshot_response.rb +3 -2
  37. data/lib/context_dev/models/web_search_params.rb +9 -1
  38. data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
  39. data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
  40. data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
  41. data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
  42. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
  43. data/lib/context_dev/models.rb +4 -0
  44. data/lib/context_dev/resources/ai.rb +3 -1
  45. data/lib/context_dev/resources/brand.rb +6 -2
  46. data/lib/context_dev/resources/industry.rb +6 -2
  47. data/lib/context_dev/resources/monitors.rb +70 -32
  48. data/lib/context_dev/resources/parse.rb +11 -11
  49. data/lib/context_dev/resources/utility.rb +3 -1
  50. data/lib/context_dev/resources/web.rb +104 -55
  51. data/lib/context_dev/version.rb +1 -1
  52. data/lib/context_dev.rb +4 -0
  53. data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
  54. data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
  55. data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
  56. data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
  57. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
  58. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
  59. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
  60. data/rbi/context_dev/models/monitor_create_params.rbi +6 -4
  61. data/rbi/context_dev/models/monitor_create_response.rbi +6 -4
  62. data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
  63. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
  64. data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
  65. data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
  66. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
  67. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
  68. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
  69. data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
  70. data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
  71. data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
  72. data/rbi/context_dev/models/monitor_list_response.rbi +6 -4
  73. data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
  74. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
  75. data/rbi/context_dev/models/monitor_retrieve_response.rbi +6 -4
  76. data/rbi/context_dev/models/monitor_update_params.rbi +6 -4
  77. data/rbi/context_dev/models/monitor_update_response.rbi +6 -4
  78. data/rbi/context_dev/models/parse_handle_params.rbi +601 -71
  79. data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
  80. data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
  81. data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
  82. data/rbi/context_dev/models/web_extract_params.rbi +26 -0
  83. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
  84. data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
  85. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
  86. data/rbi/context_dev/models/web_search_params.rbi +11 -0
  87. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
  88. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
  89. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
  90. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
  91. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
  92. data/rbi/context_dev/models.rbi +4 -0
  93. data/rbi/context_dev/resources/ai.rbi +3 -0
  94. data/rbi/context_dev/resources/brand.rbi +9 -1
  95. data/rbi/context_dev/resources/industry.rbi +10 -0
  96. data/rbi/context_dev/resources/monitors.rbi +55 -11
  97. data/rbi/context_dev/resources/parse.rbi +44 -24
  98. data/rbi/context_dev/resources/utility.rbi +3 -0
  99. data/rbi/context_dev/resources/web.rbi +224 -48
  100. data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
  101. data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
  102. data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
  104. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
  105. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
  106. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
  107. data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
  108. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
  109. data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
  110. data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
  111. data/sig/context_dev/models/monitor_list_params.rbs +8 -14
  112. data/sig/context_dev/models/parse_handle_params.rbs +297 -50
  113. data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
  114. data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
  115. data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
  116. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  117. data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
  118. data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
  119. data/sig/context_dev/models/web_search_params.rbs +7 -0
  120. data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
  121. data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
  122. data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
  123. data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
  124. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
  125. data/sig/context_dev/models.rbs +4 -0
  126. data/sig/context_dev/resources/ai.rbs +1 -0
  127. data/sig/context_dev/resources/brand.rbs +3 -1
  128. data/sig/context_dev/resources/industry.rbs +2 -0
  129. data/sig/context_dev/resources/monitors.rbs +12 -2
  130. data/sig/context_dev/resources/parse.rbs +10 -10
  131. data/sig/context_dev/resources/utility.rbs +1 -0
  132. data/sig/context_dev/resources/web.rbs +47 -26
  133. metadata +14 -2
@@ -135,6 +135,13 @@ module ContextDev
135
135
  sig { params(stop_after_ms: Integer).void }
136
136
  attr_writer :stop_after_ms
137
137
 
138
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
139
+ sig { returns(T.nilable(T::Array[String])) }
140
+ attr_reader :tags
141
+
142
+ sig { params(tags: T::Array[String]).void }
143
+ attr_writer :tags
144
+
138
145
  # Optional timeout in milliseconds for the request. If the request takes longer
139
146
  # than this value, it will be aborted with a 408 status code. Maximum allowed
140
147
  # value is 300000ms (5 minutes).
@@ -167,6 +174,16 @@ module ContextDev
167
174
  sig { params(wait_for_ms: Integer).void }
168
175
  attr_writer :wait_for_ms
169
176
 
177
+ # Set to enabled to bypass shared caches and omit request and response content
178
+ # from retained usage logs. Requires zero data retention to be enabled for your
179
+ # organization (contact support@context.dev), otherwise the request fails with
180
+ # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
181
+ sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol)) }
182
+ attr_reader :zdr
183
+
184
+ sig { params(zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol).void }
185
+ attr_writer :zdr
186
+
170
187
  sig do
171
188
  params(
172
189
  url: String,
@@ -184,10 +201,12 @@ module ContextDev
184
201
  settle_animations: T::Boolean,
185
202
  shorten_base64_images: T::Boolean,
186
203
  stop_after_ms: Integer,
204
+ tags: T::Array[String],
187
205
  timeout_ms: Integer,
188
206
  url_regex: String,
189
207
  use_main_content_only: T::Boolean,
190
208
  wait_for_ms: Integer,
209
+ zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol,
191
210
  request_options: ContextDev::RequestOptions::OrHash
192
211
  ).returns(T.attached_class)
193
212
  end
@@ -240,6 +259,8 @@ module ContextDev
240
259
  # instead of continuing. Min: 10000 (10s). Max: 110000 (110s). Default: 80000
241
260
  # (80s).
242
261
  stop_after_ms: nil,
262
+ # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
263
+ tags: nil,
243
264
  # Optional timeout in milliseconds for the request. If the request takes longer
244
265
  # than this value, it will be aborted with a 408 status code. Maximum allowed
245
266
  # value is 300000ms (5 minutes).
@@ -252,6 +273,11 @@ module ContextDev
252
273
  # Optional browser wait time in milliseconds after initial page load for each
253
274
  # crawled page. Min: 0. Max: 30000 (30 seconds).
254
275
  wait_for_ms: nil,
276
+ # Set to enabled to bypass shared caches and omit request and response content
277
+ # from retained usage logs. Requires zero data retention to be enabled for your
278
+ # organization (contact support@context.dev), otherwise the request fails with
279
+ # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
280
+ zdr: nil,
255
281
  request_options: {}
256
282
  )
257
283
  end
@@ -274,10 +300,12 @@ module ContextDev
274
300
  settle_animations: T::Boolean,
275
301
  shorten_base64_images: T::Boolean,
276
302
  stop_after_ms: Integer,
303
+ tags: T::Array[String],
277
304
  timeout_ms: Integer,
278
305
  url_regex: String,
279
306
  use_main_content_only: T::Boolean,
280
307
  wait_for_ms: Integer,
308
+ zdr: ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol,
281
309
  request_options: ContextDev::RequestOptions
282
310
  }
283
311
  )
@@ -591,6 +619,31 @@ module ContextDev
591
619
  def to_hash
592
620
  end
593
621
  end
622
+
623
+ # Set to enabled to bypass shared caches and omit request and response content
624
+ # from retained usage logs. Requires zero data retention to be enabled for your
625
+ # organization (contact support@context.dev), otherwise the request fails with
626
+ # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
627
+ module Zdr
628
+ extend ContextDev::Internal::Type::Enum
629
+
630
+ TaggedSymbol =
631
+ T.type_alias { T.all(Symbol, ContextDev::WebWebCrawlMdParams::Zdr) }
632
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
633
+
634
+ ENABLED =
635
+ T.let(:enabled, ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol)
636
+ DISABLED =
637
+ T.let(:disabled, ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol)
638
+
639
+ sig do
640
+ override.returns(
641
+ T::Array[ContextDev::WebWebCrawlMdParams::Zdr::TaggedSymbol]
642
+ )
643
+ end
644
+ def self.values
645
+ end
646
+ end
594
647
  end
595
648
  end
596
649
  end