context.dev 2.17.1 → 2.19.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 (139) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +0 -4
  5. data/lib/context_dev/models/industry_retrieve_naics_params.rb +28 -1
  6. data/lib/context_dev/models/industry_retrieve_sic_params.rb +28 -1
  7. data/lib/context_dev/models/monitor_retrieve_run_params.rb +26 -0
  8. data/lib/context_dev/models/monitor_retrieve_run_response.rb +232 -0
  9. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +20 -0
  10. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +765 -0
  11. data/lib/context_dev/models/parse_handle_params.rb +8 -6
  12. data/lib/context_dev/models/person_enrich_params.rb +28 -1
  13. data/lib/context_dev/models/web_answers_params.rb +28 -1
  14. data/lib/context_dev/models/web_extract_competitors_params.rb +28 -1
  15. data/lib/context_dev/models/web_extract_styleguide_params.rb +30 -3
  16. data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb} +22 -20
  17. data/lib/context_dev/models/web_map_urls_response.rb +123 -0
  18. data/lib/context_dev/models/web_scrape_params.rb +906 -0
  19. data/lib/context_dev/models/web_scrape_response.rb +659 -0
  20. data/lib/context_dev/models/web_screenshot_params.rb +25 -9
  21. data/lib/context_dev/models/web_screenshot_response.rb +3 -3
  22. data/lib/context_dev/models/web_search_params.rb +30 -3
  23. data/lib/context_dev/models.rb +8 -20
  24. data/lib/context_dev/resources/brand.rb +0 -36
  25. data/lib/context_dev/resources/industry.rb +6 -2
  26. data/lib/context_dev/resources/monitors.rb +47 -0
  27. data/lib/context_dev/resources/people.rb +3 -1
  28. data/lib/context_dev/resources/web.rb +116 -413
  29. data/lib/context_dev/version.rb +1 -1
  30. data/lib/context_dev.rb +8 -21
  31. data/rbi/context_dev/client.rbi +0 -3
  32. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +59 -0
  33. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +57 -0
  34. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +46 -0
  35. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +452 -0
  36. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +38 -0
  37. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +1367 -0
  38. data/rbi/context_dev/models/parse_handle_params.rbi +12 -9
  39. data/rbi/context_dev/models/person_enrich_params.rbi +45 -0
  40. data/rbi/context_dev/models/web_answers_params.rbi +45 -0
  41. data/rbi/context_dev/models/web_extract_competitors_params.rbi +59 -0
  42. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +62 -3
  43. data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi} +35 -54
  44. data/rbi/context_dev/models/web_map_urls_response.rbi +226 -0
  45. data/rbi/context_dev/models/web_scrape_params.rbi +2000 -0
  46. data/rbi/context_dev/models/{web_web_scrape_html_response.rbi → web_scrape_response.rbi} +550 -418
  47. data/rbi/context_dev/models/web_screenshot_params.rbi +38 -12
  48. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -4
  49. data/rbi/context_dev/models/web_search_params.rbi +48 -3
  50. data/rbi/context_dev/models.rbi +9 -21
  51. data/rbi/context_dev/resources/brand.rbi +0 -35
  52. data/rbi/context_dev/resources/industry.rbi +14 -0
  53. data/rbi/context_dev/resources/monitors.rbi +24 -0
  54. data/rbi/context_dev/resources/parse.rbi +4 -4
  55. data/rbi/context_dev/resources/people.rbi +7 -0
  56. data/rbi/context_dev/resources/web.rbi +166 -533
  57. data/sig/context_dev/client.rbs +0 -2
  58. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +21 -1
  59. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +21 -1
  60. data/sig/context_dev/models/monitor_retrieve_run_params.rbs +28 -0
  61. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +182 -0
  62. data/sig/context_dev/models/monitor_rotate_webhook_secret_params.rbs +23 -0
  63. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +545 -0
  64. data/sig/context_dev/models/person_enrich_params.rbs +21 -1
  65. data/sig/context_dev/models/web_answers_params.rbs +21 -1
  66. data/sig/context_dev/models/web_extract_competitors_params.rbs +21 -1
  67. data/sig/context_dev/models/web_extract_styleguide_params.rbs +21 -1
  68. data/sig/context_dev/models/{web_web_scrape_sitemap_params.rbs → web_map_urls_params.rbs} +22 -22
  69. data/sig/context_dev/models/web_map_urls_response.rbs +125 -0
  70. data/sig/context_dev/models/web_scrape_params.rbs +834 -0
  71. data/sig/context_dev/models/web_scrape_response.rbs +552 -0
  72. data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
  73. data/sig/context_dev/models/web_search_params.rbs +21 -1
  74. data/sig/context_dev/models.rbs +8 -20
  75. data/sig/context_dev/resources/brand.rbs +0 -9
  76. data/sig/context_dev/resources/industry.rbs +2 -0
  77. data/sig/context_dev/resources/monitors.rbs +11 -0
  78. data/sig/context_dev/resources/people.rbs +1 -0
  79. data/sig/context_dev/resources/web.rbs +34 -108
  80. metadata +26 -65
  81. data/lib/context_dev/models/ai_extract_product_params.rb +0 -98
  82. data/lib/context_dev/models/ai_extract_product_response.rb +0 -352
  83. data/lib/context_dev/models/ai_extract_products_params.rb +0 -233
  84. data/lib/context_dev/models/ai_extract_products_response.rb +0 -320
  85. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +0 -120
  86. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +0 -441
  87. data/lib/context_dev/models/web_extract_fonts_params.rb +0 -114
  88. data/lib/context_dev/models/web_extract_fonts_response.rb +0 -291
  89. data/lib/context_dev/models/web_extract_params.rb +0 -392
  90. data/lib/context_dev/models/web_extract_response.rb +0 -287
  91. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +0 -344
  92. data/lib/context_dev/models/web_web_scrape_bytes_response.rb +0 -135
  93. data/lib/context_dev/models/web_web_scrape_html_params.rb +0 -633
  94. data/lib/context_dev/models/web_web_scrape_html_response.rb +0 -588
  95. data/lib/context_dev/models/web_web_scrape_images_params.rb +0 -346
  96. data/lib/context_dev/models/web_web_scrape_images_response.rb +0 -409
  97. data/lib/context_dev/models/web_web_scrape_md_params.rb +0 -668
  98. data/lib/context_dev/models/web_web_scrape_md_response.rb +0 -567
  99. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +0 -144
  100. data/lib/context_dev/resources/ai.rb +0 -69
  101. data/rbi/context_dev/models/ai_extract_product_params.rbi +0 -199
  102. data/rbi/context_dev/models/ai_extract_product_response.rbi +0 -696
  103. data/rbi/context_dev/models/ai_extract_products_params.rbi +0 -490
  104. data/rbi/context_dev/models/ai_extract_products_response.rbi +0 -623
  105. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +0 -256
  106. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +0 -1040
  107. data/rbi/context_dev/models/web_extract_fonts_params.rbi +0 -223
  108. data/rbi/context_dev/models/web_extract_fonts_response.rbi +0 -563
  109. data/rbi/context_dev/models/web_extract_params.rbi +0 -736
  110. data/rbi/context_dev/models/web_extract_response.rbi +0 -512
  111. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +0 -699
  112. data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +0 -238
  113. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +0 -1217
  114. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +0 -671
  115. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
  116. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1049
  117. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
  118. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
  119. data/rbi/context_dev/resources/ai.rbi +0 -56
  120. data/sig/context_dev/models/ai_extract_product_params.rbs +0 -86
  121. data/sig/context_dev/models/ai_extract_product_response.rbs +0 -273
  122. data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
  123. data/sig/context_dev/models/ai_extract_products_response.rbs +0 -252
  124. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
  125. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
  126. data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
  127. data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
  128. data/sig/context_dev/models/web_extract_params.rbs +0 -304
  129. data/sig/context_dev/models/web_extract_response.rbs +0 -239
  130. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
  131. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
  132. data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -730
  133. data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -495
  134. data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -261
  135. data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
  136. data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
  137. data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
  138. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
  139. data/sig/context_dev/resources/ai.rbs +0 -20
@@ -90,9 +90,10 @@ module ContextDev
90
90
  attr_writer :use_main_content_only
91
91
 
92
92
  # Set to enabled to bypass shared caches and omit request and response content
93
- # from retained usage logs. Requires zero data retention to be enabled for your
94
- # organization (contact support@context.dev), otherwise the request fails with
95
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
93
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
94
+ # omitted. Requires zero data retention to be enabled for your organization
95
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
96
+ # Successful ZDR responses include X-Context-ZDR: true.
96
97
  sig { returns(T.nilable(ContextDev::ParseHandleParams::Zdr::OrSymbol)) }
97
98
  attr_reader :zdr
98
99
 
@@ -142,9 +143,10 @@ module ContextDev
142
143
  # Extract only the main content from HTML-like inputs
143
144
  use_main_content_only: nil,
144
145
  # Set to enabled to bypass shared caches and omit request and response content
145
- # from retained usage logs. Requires zero data retention to be enabled for your
146
- # organization (contact support@context.dev), otherwise the request fails with
147
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
146
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
147
+ # omitted. Requires zero data retention to be enabled for your organization
148
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
149
+ # Successful ZDR responses include X-Context-ZDR: true.
148
150
  zdr: nil,
149
151
  request_options: {}
150
152
  )
@@ -370,9 +372,10 @@ module ContextDev
370
372
  end
371
373
 
372
374
  # Set to enabled to bypass shared caches and omit request and response content
373
- # from retained usage logs. Requires zero data retention to be enabled for your
374
- # organization (contact support@context.dev), otherwise the request fails with
375
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
375
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
376
+ # omitted. Requires zero data retention to be enabled for your organization
377
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
378
+ # Successful ZDR responses include X-Context-ZDR: true.
376
379
  module Zdr
377
380
  extend ContextDev::Internal::Type::Enum
378
381
 
@@ -77,6 +77,17 @@ module ContextDev
77
77
  end
78
78
  attr_writer :timeout_opts
79
79
 
80
+ # Set to enabled to bypass shared caches and omit request and response content
81
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
82
+ # omitted. Requires zero data retention to be enabled for your organization
83
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
84
+ # Successful ZDR responses include X-Context-ZDR: true.
85
+ sig { returns(T.nilable(ContextDev::PersonEnrichParams::Zdr::OrSymbol)) }
86
+ attr_reader :zdr
87
+
88
+ sig { params(zdr: ContextDev::PersonEnrichParams::Zdr::OrSymbol).void }
89
+ attr_writer :zdr
90
+
80
91
  sig do
81
92
  params(
82
93
  company: ContextDev::PersonEnrichParams::Company::OrHash,
@@ -88,6 +99,7 @@ module ContextDev
88
99
  social_urls: T::Array[String],
89
100
  tags: T::Array[String],
90
101
  timeout_opts: ContextDev::PersonEnrichParams::TimeoutOpts::OrHash,
102
+ zdr: ContextDev::PersonEnrichParams::Zdr::OrSymbol,
91
103
  request_options: ContextDev::RequestOptions::OrHash
92
104
  ).returns(T.attached_class)
93
105
  end
@@ -104,6 +116,12 @@ module ContextDev
104
116
  # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
105
117
  # timeoutOpts object.
106
118
  timeout_opts: nil,
119
+ # Set to enabled to bypass shared caches and omit request and response content
120
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
121
+ # omitted. Requires zero data retention to be enabled for your organization
122
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
123
+ # Successful ZDR responses include X-Context-ZDR: true.
124
+ zdr: nil,
107
125
  request_options: {}
108
126
  )
109
127
  end
@@ -119,6 +137,7 @@ module ContextDev
119
137
  social_urls: T::Array[String],
120
138
  tags: T::Array[String],
121
139
  timeout_opts: ContextDev::PersonEnrichParams::TimeoutOpts,
140
+ zdr: ContextDev::PersonEnrichParams::Zdr::OrSymbol,
122
141
  request_options: ContextDev::RequestOptions
123
142
  }
124
143
  )
@@ -437,6 +456,32 @@ module ContextDev
437
456
  end
438
457
  end
439
458
  end
459
+
460
+ # Set to enabled to bypass shared caches and omit request and response content
461
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
462
+ # omitted. Requires zero data retention to be enabled for your organization
463
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
464
+ # Successful ZDR responses include X-Context-ZDR: true.
465
+ module Zdr
466
+ extend ContextDev::Internal::Type::Enum
467
+
468
+ TaggedSymbol =
469
+ T.type_alias { T.all(Symbol, ContextDev::PersonEnrichParams::Zdr) }
470
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
471
+
472
+ ENABLED =
473
+ T.let(:enabled, ContextDev::PersonEnrichParams::Zdr::TaggedSymbol)
474
+ DISABLED =
475
+ T.let(:disabled, ContextDev::PersonEnrichParams::Zdr::TaggedSymbol)
476
+
477
+ sig do
478
+ override.returns(
479
+ T::Array[ContextDev::PersonEnrichParams::Zdr::TaggedSymbol]
480
+ )
481
+ end
482
+ def self.values
483
+ end
484
+ end
440
485
  end
441
486
  end
442
487
  end
@@ -56,6 +56,17 @@ module ContextDev
56
56
  end
57
57
  attr_writer :timeout_opts
58
58
 
59
+ # Set to enabled to bypass shared caches and omit request and response content
60
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
61
+ # omitted. Requires zero data retention to be enabled for your organization
62
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
63
+ # Successful ZDR responses include X-Context-ZDR: true.
64
+ sig { returns(T.nilable(ContextDev::WebAnswersParams::Zdr::OrSymbol)) }
65
+ attr_reader :zdr
66
+
67
+ sig { params(zdr: ContextDev::WebAnswersParams::Zdr::OrSymbol).void }
68
+ attr_writer :zdr
69
+
59
70
  sig do
60
71
  params(
61
72
  task: String,
@@ -63,6 +74,7 @@ module ContextDev
63
74
  mode: ContextDev::WebAnswersParams::Mode::OrSymbol,
64
75
  tags: T::Array[String],
65
76
  timeout_opts: ContextDev::WebAnswersParams::TimeoutOpts::OrHash,
77
+ zdr: ContextDev::WebAnswersParams::Zdr::OrSymbol,
66
78
  request_options: ContextDev::RequestOptions::OrHash
67
79
  ).returns(T.attached_class)
68
80
  end
@@ -86,6 +98,12 @@ module ContextDev
86
98
  # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
87
99
  # timeoutOpts object.
88
100
  timeout_opts: nil,
101
+ # Set to enabled to bypass shared caches and omit request and response content
102
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
103
+ # omitted. Requires zero data retention to be enabled for your organization
104
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
105
+ # Successful ZDR responses include X-Context-ZDR: true.
106
+ zdr: nil,
89
107
  request_options: {}
90
108
  )
91
109
  end
@@ -98,6 +116,7 @@ module ContextDev
98
116
  mode: ContextDev::WebAnswersParams::Mode::OrSymbol,
99
117
  tags: T::Array[String],
100
118
  timeout_opts: ContextDev::WebAnswersParams::TimeoutOpts,
119
+ zdr: ContextDev::WebAnswersParams::Zdr::OrSymbol,
101
120
  request_options: ContextDev::RequestOptions
102
121
  }
103
122
  )
@@ -229,6 +248,32 @@ module ContextDev
229
248
  end
230
249
  end
231
250
  end
251
+
252
+ # Set to enabled to bypass shared caches and omit request and response content
253
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
254
+ # omitted. Requires zero data retention to be enabled for your organization
255
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
256
+ # Successful ZDR responses include X-Context-ZDR: true.
257
+ module Zdr
258
+ extend ContextDev::Internal::Type::Enum
259
+
260
+ TaggedSymbol =
261
+ T.type_alias { T.all(Symbol, ContextDev::WebAnswersParams::Zdr) }
262
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
263
+
264
+ ENABLED =
265
+ T.let(:enabled, ContextDev::WebAnswersParams::Zdr::TaggedSymbol)
266
+ DISABLED =
267
+ T.let(:disabled, ContextDev::WebAnswersParams::Zdr::TaggedSymbol)
268
+
269
+ sig do
270
+ override.returns(
271
+ T::Array[ContextDev::WebAnswersParams::Zdr::TaggedSymbol]
272
+ )
273
+ end
274
+ def self.values
275
+ end
276
+ end
232
277
  end
233
278
  end
234
279
  end
@@ -50,6 +50,23 @@ module ContextDev
50
50
  end
51
51
  attr_writer :timeout_opts
52
52
 
53
+ # Set to enabled to bypass shared caches and omit request and response content
54
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
55
+ # omitted. Requires zero data retention to be enabled for your organization
56
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
57
+ # Successful ZDR responses include X-Context-ZDR: true.
58
+ sig do
59
+ returns(
60
+ T.nilable(ContextDev::WebExtractCompetitorsParams::Zdr::OrSymbol)
61
+ )
62
+ end
63
+ attr_reader :zdr
64
+
65
+ sig do
66
+ params(zdr: ContextDev::WebExtractCompetitorsParams::Zdr::OrSymbol).void
67
+ end
68
+ attr_writer :zdr
69
+
53
70
  sig do
54
71
  params(
55
72
  domain: String,
@@ -57,6 +74,7 @@ module ContextDev
57
74
  tags: T::Array[String],
58
75
  timeout_opts:
59
76
  ContextDev::WebExtractCompetitorsParams::TimeoutOpts::OrHash,
77
+ zdr: ContextDev::WebExtractCompetitorsParams::Zdr::OrSymbol,
60
78
  request_options: ContextDev::RequestOptions::OrHash
61
79
  ).returns(T.attached_class)
62
80
  end
@@ -73,6 +91,12 @@ module ContextDev
73
91
  # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
74
92
  # timeoutOpts object.
75
93
  timeout_opts: nil,
94
+ # Set to enabled to bypass shared caches and omit request and response content
95
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
96
+ # omitted. Requires zero data retention to be enabled for your organization
97
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
98
+ # Successful ZDR responses include X-Context-ZDR: true.
99
+ zdr: nil,
76
100
  request_options: {}
77
101
  )
78
102
  end
@@ -84,6 +108,7 @@ module ContextDev
84
108
  num_competitors: Integer,
85
109
  tags: T::Array[String],
86
110
  timeout_opts: ContextDev::WebExtractCompetitorsParams::TimeoutOpts,
111
+ zdr: ContextDev::WebExtractCompetitorsParams::Zdr::OrSymbol,
87
112
  request_options: ContextDev::RequestOptions
88
113
  }
89
114
  )
@@ -196,6 +221,40 @@ module ContextDev
196
221
  end
197
222
  end
198
223
  end
224
+
225
+ # Set to enabled to bypass shared caches and omit request and response content
226
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
227
+ # omitted. Requires zero data retention to be enabled for your organization
228
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
229
+ # Successful ZDR responses include X-Context-ZDR: true.
230
+ module Zdr
231
+ extend ContextDev::Internal::Type::Enum
232
+
233
+ TaggedSymbol =
234
+ T.type_alias do
235
+ T.all(Symbol, ContextDev::WebExtractCompetitorsParams::Zdr)
236
+ end
237
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
238
+
239
+ ENABLED =
240
+ T.let(
241
+ :enabled,
242
+ ContextDev::WebExtractCompetitorsParams::Zdr::TaggedSymbol
243
+ )
244
+ DISABLED =
245
+ T.let(
246
+ :disabled,
247
+ ContextDev::WebExtractCompetitorsParams::Zdr::TaggedSymbol
248
+ )
249
+
250
+ sig do
251
+ override.returns(
252
+ T::Array[ContextDev::WebExtractCompetitorsParams::Zdr::TaggedSymbol]
253
+ )
254
+ end
255
+ def self.values
256
+ end
257
+ end
199
258
  end
200
259
  end
201
260
  end
@@ -83,6 +83,23 @@ module ContextDev
83
83
  end
84
84
  attr_writer :timeout_opts
85
85
 
86
+ # Set to enabled to bypass shared caches and omit request and response content
87
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
88
+ # omitted. Requires zero data retention to be enabled for your organization
89
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
90
+ # Successful ZDR responses include X-Context-ZDR: true.
91
+ sig do
92
+ returns(
93
+ T.nilable(ContextDev::WebExtractStyleguideParams::Zdr::OrSymbol)
94
+ )
95
+ end
96
+ attr_reader :zdr
97
+
98
+ sig do
99
+ params(zdr: ContextDev::WebExtractStyleguideParams::Zdr::OrSymbol).void
100
+ end
101
+ attr_writer :zdr
102
+
86
103
  sig do
87
104
  params(
88
105
  color_scheme:
@@ -93,6 +110,7 @@ module ContextDev
93
110
  tags: T::Array[String],
94
111
  timeout_opts:
95
112
  ContextDev::WebExtractStyleguideParams::TimeoutOpts::OrHash,
113
+ zdr: ContextDev::WebExtractStyleguideParams::Zdr::OrSymbol,
96
114
  request_options: ContextDev::RequestOptions::OrHash
97
115
  ).returns(T.attached_class)
98
116
  end
@@ -121,6 +139,12 @@ module ContextDev
121
139
  # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
122
140
  # timeoutOpts object.
123
141
  timeout_opts: nil,
142
+ # Set to enabled to bypass shared caches and omit request and response content
143
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
144
+ # omitted. Requires zero data retention to be enabled for your organization
145
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
146
+ # Successful ZDR responses include X-Context-ZDR: true.
147
+ zdr: nil,
124
148
  request_options: {}
125
149
  )
126
150
  end
@@ -135,6 +159,7 @@ module ContextDev
135
159
  max_age_ms: T.nilable(Integer),
136
160
  tags: T::Array[String],
137
161
  timeout_opts: ContextDev::WebExtractStyleguideParams::TimeoutOpts,
162
+ zdr: ContextDev::WebExtractStyleguideParams::Zdr::OrSymbol,
138
163
  request_options: ContextDev::RequestOptions
139
164
  }
140
165
  )
@@ -192,7 +217,7 @@ module ContextDev
192
217
  # credits. "return-partial" returns usable results collected so far; if none are
193
218
  # available, the request still fails without charging credits. Partial results are
194
219
  # not cached as complete results. "return-partial" requires milliseconds of at
195
- # least 15000.
220
+ # least 5000.
196
221
  sig do
197
222
  returns(
198
223
  T.nilable(
@@ -227,7 +252,7 @@ module ContextDev
227
252
  # credits. "return-partial" returns usable results collected so far; if none are
228
253
  # available, the request still fails without charging credits. Partial results are
229
254
  # not cached as complete results. "return-partial" requires milliseconds of at
230
- # least 15000.
255
+ # least 5000.
231
256
  behavior: nil
232
257
  )
233
258
  end
@@ -248,7 +273,7 @@ module ContextDev
248
273
  # credits. "return-partial" returns usable results collected so far; if none are
249
274
  # available, the request still fails without charging credits. Partial results are
250
275
  # not cached as complete results. "return-partial" requires milliseconds of at
251
- # least 15000.
276
+ # least 5000.
252
277
  module Behavior
253
278
  extend ContextDev::Internal::Type::Enum
254
279
 
@@ -283,6 +308,40 @@ module ContextDev
283
308
  end
284
309
  end
285
310
  end
311
+
312
+ # Set to enabled to bypass shared caches and omit request and response content
313
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
314
+ # omitted. Requires zero data retention to be enabled for your organization
315
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
316
+ # Successful ZDR responses include X-Context-ZDR: true.
317
+ module Zdr
318
+ extend ContextDev::Internal::Type::Enum
319
+
320
+ TaggedSymbol =
321
+ T.type_alias do
322
+ T.all(Symbol, ContextDev::WebExtractStyleguideParams::Zdr)
323
+ end
324
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
325
+
326
+ ENABLED =
327
+ T.let(
328
+ :enabled,
329
+ ContextDev::WebExtractStyleguideParams::Zdr::TaggedSymbol
330
+ )
331
+ DISABLED =
332
+ T.let(
333
+ :disabled,
334
+ ContextDev::WebExtractStyleguideParams::Zdr::TaggedSymbol
335
+ )
336
+
337
+ sig do
338
+ override.returns(
339
+ T::Array[ContextDev::WebExtractStyleguideParams::Zdr::TaggedSymbol]
340
+ )
341
+ end
342
+ def self.values
343
+ end
344
+ end
286
345
  end
287
346
  end
288
347
  end
@@ -2,16 +2,13 @@
2
2
 
3
3
  module ContextDev
4
4
  module Models
5
- class WebWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel
5
+ class WebMapURLsParams < ContextDev::Internal::Type::BaseModel
6
6
  extend ContextDev::Internal::Type::RequestParameters::Converter
7
7
  include ContextDev::Internal::Type::RequestParameters
8
8
 
9
9
  OrHash =
10
10
  T.type_alias do
11
- T.any(
12
- ContextDev::WebWebScrapeSitemapParams,
13
- ContextDev::Internal::AnyHash
14
- )
11
+ T.any(ContextDev::WebMapURLsParams, ContextDev::Internal::AnyHash)
15
12
  end
16
13
 
17
14
  # Domain to build a sitemap for
@@ -71,15 +68,12 @@ module ContextDev
71
68
  # Optional request deadline and behavior on timeout. For GET requests, use
72
69
  # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
73
70
  # timeoutOpts object.
74
- sig do
75
- returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::TimeoutOpts))
76
- end
71
+ sig { returns(T.nilable(ContextDev::WebMapURLsParams::TimeoutOpts)) }
77
72
  attr_reader :timeout_opts
78
73
 
79
74
  sig do
80
75
  params(
81
- timeout_opts:
82
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash
76
+ timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts::OrHash
83
77
  ).void
84
78
  end
85
79
  attr_writer :timeout_opts
@@ -93,17 +87,14 @@ module ContextDev
93
87
  attr_writer :url_regex
94
88
 
95
89
  # Set to enabled to bypass shared caches and omit request and response content
96
- # from retained usage logs. Requires zero data retention to be enabled for your
97
- # organization (contact support@context.dev), otherwise the request fails with
98
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
99
- sig do
100
- returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol))
101
- end
90
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
91
+ # omitted. Requires zero data retention to be enabled for your organization
92
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
93
+ # Successful ZDR responses include X-Context-ZDR: true.
94
+ sig { returns(T.nilable(ContextDev::WebMapURLsParams::Zdr::OrSymbol)) }
102
95
  attr_reader :zdr
103
96
 
104
- sig do
105
- params(zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol).void
106
- end
97
+ sig { params(zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol).void }
107
98
  attr_writer :zdr
108
99
 
109
100
  sig do
@@ -115,10 +106,9 @@ module ContextDev
115
106
  search: String,
116
107
  sitemap_url: String,
117
108
  tags: T::Array[String],
118
- timeout_opts:
119
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::OrHash,
109
+ timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts::OrHash,
120
110
  url_regex: String,
121
- zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
111
+ zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol,
122
112
  request_options: ContextDev::RequestOptions::OrHash
123
113
  ).returns(T.attached_class)
124
114
  end
@@ -153,9 +143,10 @@ module ContextDev
153
143
  # returned and counted against maxLinks.
154
144
  url_regex: nil,
155
145
  # Set to enabled to bypass shared caches and omit request and response content
156
- # from retained usage logs. Requires zero data retention to be enabled for your
157
- # organization (contact support@context.dev), otherwise the request fails with
158
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
146
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
147
+ # omitted. Requires zero data retention to be enabled for your organization
148
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
149
+ # Successful ZDR responses include X-Context-ZDR: true.
159
150
  zdr: nil,
160
151
  request_options: {}
161
152
  )
@@ -171,9 +162,9 @@ module ContextDev
171
162
  search: String,
172
163
  sitemap_url: String,
173
164
  tags: T::Array[String],
174
- timeout_opts: ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
165
+ timeout_opts: ContextDev::WebMapURLsParams::TimeoutOpts,
175
166
  url_regex: String,
176
- zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
167
+ zdr: ContextDev::WebMapURLsParams::Zdr::OrSymbol,
177
168
  request_options: ContextDev::RequestOptions
178
169
  }
179
170
  )
@@ -185,7 +176,7 @@ module ContextDev
185
176
  OrHash =
186
177
  T.type_alias do
187
178
  T.any(
188
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts,
179
+ ContextDev::WebMapURLsParams::TimeoutOpts,
189
180
  ContextDev::Internal::AnyHash
190
181
  )
191
182
  end
@@ -201,7 +192,7 @@ module ContextDev
201
192
  sig do
202
193
  returns(
203
194
  T.nilable(
204
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
195
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
205
196
  )
206
197
  )
207
198
  end
@@ -210,7 +201,7 @@ module ContextDev
210
201
  sig do
211
202
  params(
212
203
  behavior:
213
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
204
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
214
205
  ).void
215
206
  end
216
207
  attr_writer :behavior
@@ -222,7 +213,7 @@ module ContextDev
222
213
  params(
223
214
  milliseconds: Integer,
224
215
  behavior:
225
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
216
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
226
217
  ).returns(T.attached_class)
227
218
  end
228
219
  def self.new(
@@ -241,7 +232,7 @@ module ContextDev
241
232
  {
242
233
  milliseconds: Integer,
243
234
  behavior:
244
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::OrSymbol
235
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::OrSymbol
245
236
  }
246
237
  )
247
238
  end
@@ -257,28 +248,25 @@ module ContextDev
257
248
 
258
249
  TaggedSymbol =
259
250
  T.type_alias do
260
- T.all(
261
- Symbol,
262
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior
263
- )
251
+ T.all(Symbol, ContextDev::WebMapURLsParams::TimeoutOpts::Behavior)
264
252
  end
265
253
  OrSymbol = T.type_alias { T.any(Symbol, String) }
266
254
 
267
255
  FAIL =
268
256
  T.let(
269
257
  :fail,
270
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
258
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
271
259
  )
272
260
  RETURN_PARTIAL =
273
261
  T.let(
274
262
  :"return-partial",
275
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
263
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
276
264
  )
277
265
 
278
266
  sig do
279
267
  override.returns(
280
268
  T::Array[
281
- ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior::TaggedSymbol
269
+ ContextDev::WebMapURLsParams::TimeoutOpts::Behavior::TaggedSymbol
282
270
  ]
283
271
  )
284
272
  end
@@ -288,32 +276,25 @@ module ContextDev
288
276
  end
289
277
 
290
278
  # Set to enabled to bypass shared caches and omit request and response content
291
- # from retained usage logs. Requires zero data retention to be enabled for your
292
- # organization (contact support@context.dev), otherwise the request fails with
293
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
279
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
280
+ # omitted. Requires zero data retention to be enabled for your organization
281
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
282
+ # Successful ZDR responses include X-Context-ZDR: true.
294
283
  module Zdr
295
284
  extend ContextDev::Internal::Type::Enum
296
285
 
297
286
  TaggedSymbol =
298
- T.type_alias do
299
- T.all(Symbol, ContextDev::WebWebScrapeSitemapParams::Zdr)
300
- end
287
+ T.type_alias { T.all(Symbol, ContextDev::WebMapURLsParams::Zdr) }
301
288
  OrSymbol = T.type_alias { T.any(Symbol, String) }
302
289
 
303
290
  ENABLED =
304
- T.let(
305
- :enabled,
306
- ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
307
- )
291
+ T.let(:enabled, ContextDev::WebMapURLsParams::Zdr::TaggedSymbol)
308
292
  DISABLED =
309
- T.let(
310
- :disabled,
311
- ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
312
- )
293
+ T.let(:disabled, ContextDev::WebMapURLsParams::Zdr::TaggedSymbol)
313
294
 
314
295
  sig do
315
296
  override.returns(
316
- T::Array[ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol]
297
+ T::Array[ContextDev::WebMapURLsParams::Zdr::TaggedSymbol]
317
298
  )
318
299
  end
319
300
  def self.values