context.dev 2.18.0 → 2.20.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 (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +220 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +0 -4
  5. data/lib/context_dev/models/monitor_retrieve_run_params.rb +26 -0
  6. data/lib/context_dev/models/monitor_retrieve_run_response.rb +232 -0
  7. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +20 -0
  8. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +765 -0
  9. data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb} +14 -14
  10. data/lib/context_dev/models/web_map_urls_response.rb +123 -0
  11. data/lib/context_dev/models/web_scrape_params.rb +1035 -0
  12. data/lib/context_dev/models/web_scrape_response.rb +974 -0
  13. data/lib/context_dev/models/web_screenshot_params.rb +15 -1
  14. data/lib/context_dev/models/web_screenshot_response.rb +3 -3
  15. data/lib/context_dev/models.rb +8 -22
  16. data/lib/context_dev/resources/brand.rb +0 -36
  17. data/lib/context_dev/resources/monitors.rb +47 -0
  18. data/lib/context_dev/resources/web.rb +118 -486
  19. data/lib/context_dev/version.rb +1 -1
  20. data/lib/context_dev.rb +8 -23
  21. data/rbi/context_dev/client.rbi +0 -3
  22. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +46 -0
  23. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +452 -0
  24. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +38 -0
  25. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +1367 -0
  26. data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi} +23 -45
  27. data/rbi/context_dev/models/web_map_urls_response.rbi +226 -0
  28. data/rbi/context_dev/models/web_scrape_params.rbi +2221 -0
  29. data/rbi/context_dev/models/web_scrape_response.rbi +1874 -0
  30. data/rbi/context_dev/models/web_screenshot_params.rbi +23 -0
  31. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -4
  32. data/rbi/context_dev/models.rbi +9 -24
  33. data/rbi/context_dev/resources/brand.rbi +0 -35
  34. data/rbi/context_dev/resources/monitors.rbi +24 -0
  35. data/rbi/context_dev/resources/web.rbi +152 -654
  36. data/sig/context_dev/client.rbs +0 -2
  37. data/sig/context_dev/models/monitor_retrieve_run_params.rbs +28 -0
  38. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +182 -0
  39. data/sig/context_dev/models/monitor_rotate_webhook_secret_params.rbs +23 -0
  40. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +545 -0
  41. data/sig/context_dev/models/{web_web_scrape_sitemap_params.rbs → web_map_urls_params.rbs} +22 -22
  42. data/sig/context_dev/models/web_map_urls_response.rbs +125 -0
  43. data/sig/context_dev/models/web_scrape_params.rbs +925 -0
  44. data/sig/context_dev/models/web_scrape_response.rbs +782 -0
  45. data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
  46. data/sig/context_dev/models.rbs +8 -22
  47. data/sig/context_dev/resources/brand.rbs +0 -9
  48. data/sig/context_dev/resources/monitors.rbs +11 -0
  49. data/sig/context_dev/resources/web.rbs +33 -128
  50. metadata +26 -71
  51. data/lib/context_dev/models/ai_extract_product_params.rb +0 -125
  52. data/lib/context_dev/models/ai_extract_product_response.rb +0 -402
  53. data/lib/context_dev/models/ai_extract_products_params.rb +0 -233
  54. data/lib/context_dev/models/ai_extract_products_response.rb +0 -370
  55. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +0 -120
  56. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +0 -441
  57. data/lib/context_dev/models/web_extract_fonts_params.rb +0 -114
  58. data/lib/context_dev/models/web_extract_fonts_response.rb +0 -291
  59. data/lib/context_dev/models/web_extract_params.rb +0 -419
  60. data/lib/context_dev/models/web_extract_response.rb +0 -287
  61. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +0 -346
  62. data/lib/context_dev/models/web_web_scrape_bytes_response.rb +0 -135
  63. data/lib/context_dev/models/web_web_scrape_html_params.rb +0 -812
  64. data/lib/context_dev/models/web_web_scrape_html_response.rb +0 -628
  65. data/lib/context_dev/models/web_web_scrape_images_params.rb +0 -373
  66. data/lib/context_dev/models/web_web_scrape_images_response.rb +0 -409
  67. data/lib/context_dev/models/web_web_scrape_md_params.rb +0 -670
  68. data/lib/context_dev/models/web_web_scrape_md_response.rb +0 -567
  69. data/lib/context_dev/models/web_web_scrape_screenshot_params.rb +0 -471
  70. data/lib/context_dev/models/web_web_scrape_screenshot_response.rb +0 -169
  71. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +0 -144
  72. data/lib/context_dev/resources/ai.rb +0 -71
  73. data/rbi/context_dev/models/ai_extract_product_params.rbi +0 -253
  74. data/rbi/context_dev/models/ai_extract_product_response.rbi +0 -791
  75. data/rbi/context_dev/models/ai_extract_products_params.rbi +0 -490
  76. data/rbi/context_dev/models/ai_extract_products_response.rbi +0 -718
  77. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +0 -256
  78. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +0 -1040
  79. data/rbi/context_dev/models/web_extract_fonts_params.rbi +0 -223
  80. data/rbi/context_dev/models/web_extract_fonts_response.rbi +0 -563
  81. data/rbi/context_dev/models/web_extract_params.rbi +0 -781
  82. data/rbi/context_dev/models/web_extract_response.rbi +0 -512
  83. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +0 -702
  84. data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +0 -238
  85. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +0 -1690
  86. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +0 -1287
  87. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +0 -728
  88. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
  89. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1052
  90. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
  91. data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +0 -1580
  92. data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +0 -332
  93. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
  94. data/rbi/context_dev/resources/ai.rbi +0 -63
  95. data/sig/context_dev/models/ai_extract_product_params.rbs +0 -106
  96. data/sig/context_dev/models/ai_extract_product_response.rbs +0 -314
  97. data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
  98. data/sig/context_dev/models/ai_extract_products_response.rbs +0 -293
  99. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
  100. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
  101. data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
  102. data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
  103. data/sig/context_dev/models/web_extract_params.rbs +0 -324
  104. data/sig/context_dev/models/web_extract_response.rbs +0 -239
  105. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
  106. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
  107. data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -878
  108. data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -525
  109. data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -281
  110. data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
  111. data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
  112. data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
  113. data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +0 -619
  114. data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +0 -127
  115. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
  116. data/sig/context_dev/resources/ai.rbs +0 -21
@@ -1,910 +0,0 @@
1
- # typed: strong
2
-
3
- module ContextDev
4
- module Models
5
- class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- ContextDev::Models::WebWebScrapeImagesResponse,
10
- ContextDev::Internal::AnyHash
11
- )
12
- end
13
-
14
- # Cache outcome for this response. Composite responses are hits only when every
15
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
16
- # oldest contributing hit.
17
- sig do
18
- returns(ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata)
19
- end
20
- attr_reader :cache_metadata
21
-
22
- sig do
23
- params(
24
- cache_metadata:
25
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash
26
- ).void
27
- end
28
- attr_writer :cache_metadata
29
-
30
- # Images found on the page.
31
- sig do
32
- returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image])
33
- end
34
- attr_accessor :images
35
-
36
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
37
- # it when contacting support about a failed request.
38
- sig { returns(String) }
39
- attr_accessor :request_id
40
-
41
- # Always true on success.
42
- sig do
43
- returns(
44
- ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean
45
- )
46
- end
47
- attr_accessor :success
48
-
49
- # Page URL that was scraped.
50
- sig { returns(String) }
51
- attr_accessor :url
52
-
53
- # One verified outcome per requested browser action, in request order.
54
- sig do
55
- returns(
56
- T.nilable(
57
- T::Array[
58
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied
59
- ]
60
- )
61
- )
62
- end
63
- attr_reader :actions_applied
64
-
65
- sig do
66
- params(
67
- actions_applied:
68
- T::Array[
69
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::OrHash
70
- ]
71
- ).void
72
- end
73
- attr_writer :actions_applied
74
-
75
- # How complete the returned content is. `loaded` means the page finished the waits
76
- # the request asked for. `still-loading` only occurs with
77
- # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
78
- # reached first, so the content reflects the DOM at that moment and late-rendering
79
- # parts may be missing. Partial results are billed at the base request cost.
80
- sig do
81
- returns(
82
- T.nilable(
83
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
84
- )
85
- )
86
- end
87
- attr_reader :final_dom_state
88
-
89
- sig do
90
- params(
91
- final_dom_state:
92
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::OrSymbol
93
- ).void
94
- end
95
- attr_writer :final_dom_state
96
-
97
- # Credit usage, included whenever a valid API key is provided.
98
- sig do
99
- returns(
100
- T.nilable(ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata)
101
- )
102
- end
103
- attr_reader :key_metadata
104
-
105
- sig do
106
- params(
107
- key_metadata:
108
- ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
109
- ).void
110
- end
111
- attr_writer :key_metadata
112
-
113
- # True when the deadline interrupted rendering or image enrichment. Partial
114
- # results are billed at the base request cost, without enrichment or actions
115
- # surcharges.
116
- sig { returns(T.nilable(T::Boolean)) }
117
- attr_reader :partial
118
-
119
- sig { params(partial: T::Boolean).void }
120
- attr_writer :partial
121
-
122
- sig do
123
- params(
124
- cache_metadata:
125
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash,
126
- images:
127
- T::Array[
128
- ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash
129
- ],
130
- request_id: String,
131
- success:
132
- ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean,
133
- url: String,
134
- actions_applied:
135
- T::Array[
136
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::OrHash
137
- ],
138
- final_dom_state:
139
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::OrSymbol,
140
- key_metadata:
141
- ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash,
142
- partial: T::Boolean
143
- ).returns(T.attached_class)
144
- end
145
- def self.new(
146
- # Cache outcome for this response. Composite responses are hits only when every
147
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
148
- # oldest contributing hit.
149
- cache_metadata:,
150
- # Images found on the page.
151
- images:,
152
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
153
- # it when contacting support about a failed request.
154
- request_id:,
155
- # Always true on success.
156
- success:,
157
- # Page URL that was scraped.
158
- url:,
159
- # One verified outcome per requested browser action, in request order.
160
- actions_applied: nil,
161
- # How complete the returned content is. `loaded` means the page finished the waits
162
- # the request asked for. `still-loading` only occurs with
163
- # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
164
- # reached first, so the content reflects the DOM at that moment and late-rendering
165
- # parts may be missing. Partial results are billed at the base request cost.
166
- final_dom_state: nil,
167
- # Credit usage, included whenever a valid API key is provided.
168
- key_metadata: nil,
169
- # True when the deadline interrupted rendering or image enrichment. Partial
170
- # results are billed at the base request cost, without enrichment or actions
171
- # surcharges.
172
- partial: nil
173
- )
174
- end
175
-
176
- sig do
177
- override.returns(
178
- {
179
- cache_metadata:
180
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata,
181
- images:
182
- T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
183
- request_id: String,
184
- success:
185
- ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean,
186
- url: String,
187
- actions_applied:
188
- T::Array[
189
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied
190
- ],
191
- final_dom_state:
192
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol,
193
- key_metadata:
194
- ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata,
195
- partial: T::Boolean
196
- }
197
- )
198
- end
199
- def to_hash
200
- end
201
-
202
- class CacheMetadata < ContextDev::Internal::Type::BaseModel
203
- OrHash =
204
- T.type_alias do
205
- T.any(
206
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata,
207
- ContextDev::Internal::AnyHash
208
- )
209
- end
210
-
211
- # Age of the cached data in milliseconds. Zero for miss and zdr responses.
212
- sig { returns(Integer) }
213
- attr_accessor :age_ms
214
-
215
- # Whether the response was served from cache, required fresh work, or honored
216
- # zero-data-retention cache bypass.
217
- sig do
218
- returns(
219
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
220
- )
221
- end
222
- attr_accessor :status
223
-
224
- # Cache outcome for this response. Composite responses are hits only when every
225
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
226
- # oldest contributing hit.
227
- sig do
228
- params(
229
- age_ms: Integer,
230
- status:
231
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::OrSymbol
232
- ).returns(T.attached_class)
233
- end
234
- def self.new(
235
- # Age of the cached data in milliseconds. Zero for miss and zdr responses.
236
- age_ms:,
237
- # Whether the response was served from cache, required fresh work, or honored
238
- # zero-data-retention cache bypass.
239
- status:
240
- )
241
- end
242
-
243
- sig do
244
- override.returns(
245
- {
246
- age_ms: Integer,
247
- status:
248
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
249
- }
250
- )
251
- end
252
- def to_hash
253
- end
254
-
255
- # Whether the response was served from cache, required fresh work, or honored
256
- # zero-data-retention cache bypass.
257
- module Status
258
- extend ContextDev::Internal::Type::Enum
259
-
260
- TaggedSymbol =
261
- T.type_alias do
262
- T.all(
263
- Symbol,
264
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status
265
- )
266
- end
267
- OrSymbol = T.type_alias { T.any(Symbol, String) }
268
-
269
- HIT =
270
- T.let(
271
- :hit,
272
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
273
- )
274
- MISS =
275
- T.let(
276
- :miss,
277
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
278
- )
279
- ZDR =
280
- T.let(
281
- :zdr,
282
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
283
- )
284
-
285
- sig do
286
- override.returns(
287
- T::Array[
288
- ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
289
- ]
290
- )
291
- end
292
- def self.values
293
- end
294
- end
295
- end
296
-
297
- class Image < ContextDev::Internal::Type::BaseModel
298
- OrHash =
299
- T.type_alias do
300
- T.any(
301
- ContextDev::Models::WebWebScrapeImagesResponse::Image,
302
- ContextDev::Internal::AnyHash
303
- )
304
- end
305
-
306
- # Image alt text, or null when unavailable.
307
- sig { returns(T.nilable(String)) }
308
- attr_accessor :alt
309
-
310
- # Where the image was found.
311
- sig do
312
- returns(
313
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
314
- )
315
- end
316
- attr_accessor :element
317
-
318
- # Original image value: URL, inline SVG or HTML, or base64 data URI.
319
- sig { returns(String) }
320
- attr_accessor :src
321
-
322
- # Format of src.
323
- sig do
324
- returns(
325
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
326
- )
327
- end
328
- attr_accessor :type
329
-
330
- # Requested metadata for images that could be processed.
331
- sig do
332
- returns(
333
- T.nilable(
334
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment
335
- )
336
- )
337
- end
338
- attr_reader :enrichment
339
-
340
- sig do
341
- params(
342
- enrichment:
343
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash
344
- ).void
345
- end
346
- attr_writer :enrichment
347
-
348
- sig do
349
- params(
350
- alt: T.nilable(String),
351
- element:
352
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::OrSymbol,
353
- src: String,
354
- type:
355
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::OrSymbol,
356
- enrichment:
357
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::OrHash
358
- ).returns(T.attached_class)
359
- end
360
- def self.new(
361
- # Image alt text, or null when unavailable.
362
- alt:,
363
- # Where the image was found.
364
- element:,
365
- # Original image value: URL, inline SVG or HTML, or base64 data URI.
366
- src:,
367
- # Format of src.
368
- type:,
369
- # Requested metadata for images that could be processed.
370
- enrichment: nil
371
- )
372
- end
373
-
374
- sig do
375
- override.returns(
376
- {
377
- alt: T.nilable(String),
378
- element:
379
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol,
380
- src: String,
381
- type:
382
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol,
383
- enrichment:
384
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment
385
- }
386
- )
387
- end
388
- def to_hash
389
- end
390
-
391
- # Where the image was found.
392
- module Element
393
- extend ContextDev::Internal::Type::Enum
394
-
395
- TaggedSymbol =
396
- T.type_alias do
397
- T.all(
398
- Symbol,
399
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element
400
- )
401
- end
402
- OrSymbol = T.type_alias { T.any(Symbol, String) }
403
-
404
- IMG =
405
- T.let(
406
- :img,
407
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
408
- )
409
- SVG =
410
- T.let(
411
- :svg,
412
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
413
- )
414
- LINK =
415
- T.let(
416
- :link,
417
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
418
- )
419
- SOURCE =
420
- T.let(
421
- :source,
422
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
423
- )
424
- VIDEO =
425
- T.let(
426
- :video,
427
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
428
- )
429
- CSS =
430
- T.let(
431
- :css,
432
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
433
- )
434
- OBJECT =
435
- T.let(
436
- :object,
437
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
438
- )
439
- META =
440
- T.let(
441
- :meta,
442
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
443
- )
444
- BACKGROUND =
445
- T.let(
446
- :background,
447
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
448
- )
449
-
450
- sig do
451
- override.returns(
452
- T::Array[
453
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Element::TaggedSymbol
454
- ]
455
- )
456
- end
457
- def self.values
458
- end
459
- end
460
-
461
- # Format of src.
462
- module Type
463
- extend ContextDev::Internal::Type::Enum
464
-
465
- TaggedSymbol =
466
- T.type_alias do
467
- T.all(
468
- Symbol,
469
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type
470
- )
471
- end
472
- OrSymbol = T.type_alias { T.any(Symbol, String) }
473
-
474
- URL =
475
- T.let(
476
- :url,
477
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
478
- )
479
- HTML =
480
- T.let(
481
- :html,
482
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
483
- )
484
- BASE64 =
485
- T.let(
486
- :base64,
487
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
488
- )
489
-
490
- sig do
491
- override.returns(
492
- T::Array[
493
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Type::TaggedSymbol
494
- ]
495
- )
496
- end
497
- def self.values
498
- end
499
- end
500
-
501
- class Enrichment < ContextDev::Internal::Type::BaseModel
502
- OrHash =
503
- T.type_alias do
504
- T.any(
505
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment,
506
- ContextDev::Internal::AnyHash
507
- )
508
- end
509
-
510
- # Image height in pixels, when measured.
511
- sig { returns(T.nilable(Integer)) }
512
- attr_reader :height
513
-
514
- sig { params(height: Integer).void }
515
- attr_writer :height
516
-
517
- # Detected MIME type, when hosted.
518
- sig { returns(T.nilable(String)) }
519
- attr_reader :mimetype
520
-
521
- sig { params(mimetype: String).void }
522
- attr_writer :mimetype
523
-
524
- # Visual asset category, when classified.
525
- sig do
526
- returns(
527
- T.nilable(
528
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
529
- )
530
- )
531
- end
532
- attr_reader :type
533
-
534
- sig do
535
- params(
536
- type:
537
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol
538
- ).void
539
- end
540
- attr_writer :type
541
-
542
- # Brand.dev CDN URL, when hosted.
543
- sig { returns(T.nilable(String)) }
544
- attr_reader :url
545
-
546
- sig { params(url: String).void }
547
- attr_writer :url
548
-
549
- # Image width in pixels, when measured.
550
- sig { returns(T.nilable(Integer)) }
551
- attr_reader :width
552
-
553
- sig { params(width: Integer).void }
554
- attr_writer :width
555
-
556
- # Requested metadata for images that could be processed.
557
- sig do
558
- params(
559
- height: Integer,
560
- mimetype: String,
561
- type:
562
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::OrSymbol,
563
- url: String,
564
- width: Integer
565
- ).returns(T.attached_class)
566
- end
567
- def self.new(
568
- # Image height in pixels, when measured.
569
- height: nil,
570
- # Detected MIME type, when hosted.
571
- mimetype: nil,
572
- # Visual asset category, when classified.
573
- type: nil,
574
- # Brand.dev CDN URL, when hosted.
575
- url: nil,
576
- # Image width in pixels, when measured.
577
- width: nil
578
- )
579
- end
580
-
581
- sig do
582
- override.returns(
583
- {
584
- height: Integer,
585
- mimetype: String,
586
- type:
587
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol,
588
- url: String,
589
- width: Integer
590
- }
591
- )
592
- end
593
- def to_hash
594
- end
595
-
596
- # Visual asset category, when classified.
597
- module Type
598
- extend ContextDev::Internal::Type::Enum
599
-
600
- TaggedSymbol =
601
- T.type_alias do
602
- T.all(
603
- Symbol,
604
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type
605
- )
606
- end
607
- OrSymbol = T.type_alias { T.any(Symbol, String) }
608
-
609
- PHOTOGRAPHY =
610
- T.let(
611
- :photography,
612
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
613
- )
614
- ILLUSTRATION =
615
- T.let(
616
- :illustration,
617
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
618
- )
619
- LOGO =
620
- T.let(
621
- :logo,
622
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
623
- )
624
- WORDMARK =
625
- T.let(
626
- :wordmark,
627
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
628
- )
629
- ICON =
630
- T.let(
631
- :icon,
632
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
633
- )
634
- PATTERN =
635
- T.let(
636
- :pattern,
637
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
638
- )
639
- GRAPHIC =
640
- T.let(
641
- :graphic,
642
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
643
- )
644
- OTHER =
645
- T.let(
646
- :other,
647
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
648
- )
649
-
650
- sig do
651
- override.returns(
652
- T::Array[
653
- ContextDev::Models::WebWebScrapeImagesResponse::Image::Enrichment::Type::TaggedSymbol
654
- ]
655
- )
656
- end
657
- def self.values
658
- end
659
- end
660
- end
661
- end
662
-
663
- # Always true on success.
664
- module Success
665
- extend ContextDev::Internal::Type::Enum
666
-
667
- TaggedBoolean =
668
- T.type_alias do
669
- T.all(
670
- T::Boolean,
671
- ContextDev::Models::WebWebScrapeImagesResponse::Success
672
- )
673
- end
674
- OrBoolean = T.type_alias { T::Boolean }
675
-
676
- TRUE =
677
- T.let(
678
- true,
679
- ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean
680
- )
681
-
682
- sig do
683
- override.returns(
684
- T::Array[
685
- ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean
686
- ]
687
- )
688
- end
689
- def self.values
690
- end
691
- end
692
-
693
- class ActionsApplied < ContextDev::Internal::Type::BaseModel
694
- OrHash =
695
- T.type_alias do
696
- T.any(
697
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied,
698
- ContextDev::Internal::AnyHash
699
- )
700
- end
701
-
702
- sig { returns(String) }
703
- attr_accessor :instruction
704
-
705
- # Applied means the requested page state was visibly verified. Failed means it was
706
- # not verified. Skipped means it was not attempted.
707
- sig do
708
- returns(
709
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol
710
- )
711
- end
712
- attr_accessor :status
713
-
714
- # Visible page evidence used to verify an applied action.
715
- sig { returns(T.nilable(String)) }
716
- attr_reader :completion_evidence
717
-
718
- sig { params(completion_evidence: String).void }
719
- attr_writer :completion_evidence
720
-
721
- sig { returns(T.nilable(Float)) }
722
- attr_reader :duration_ms
723
-
724
- sig { params(duration_ms: Float).void }
725
- attr_writer :duration_ms
726
-
727
- sig { returns(T.nilable(String)) }
728
- attr_reader :error
729
-
730
- sig { params(error: String).void }
731
- attr_writer :error
732
-
733
- sig { returns(T.nilable(String)) }
734
- attr_reader :method_
735
-
736
- sig { params(method_: String).void }
737
- attr_writer :method_
738
-
739
- sig { returns(T.nilable(String)) }
740
- attr_reader :target_description
741
-
742
- sig { params(target_description: String).void }
743
- attr_writer :target_description
744
-
745
- sig do
746
- params(
747
- instruction: String,
748
- status:
749
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::OrSymbol,
750
- completion_evidence: String,
751
- duration_ms: Float,
752
- error: String,
753
- method_: String,
754
- target_description: String
755
- ).returns(T.attached_class)
756
- end
757
- def self.new(
758
- instruction:,
759
- # Applied means the requested page state was visibly verified. Failed means it was
760
- # not verified. Skipped means it was not attempted.
761
- status:,
762
- # Visible page evidence used to verify an applied action.
763
- completion_evidence: nil,
764
- duration_ms: nil,
765
- error: nil,
766
- method_: nil,
767
- target_description: nil
768
- )
769
- end
770
-
771
- sig do
772
- override.returns(
773
- {
774
- instruction: String,
775
- status:
776
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol,
777
- completion_evidence: String,
778
- duration_ms: Float,
779
- error: String,
780
- method_: String,
781
- target_description: String
782
- }
783
- )
784
- end
785
- def to_hash
786
- end
787
-
788
- # Applied means the requested page state was visibly verified. Failed means it was
789
- # not verified. Skipped means it was not attempted.
790
- module Status
791
- extend ContextDev::Internal::Type::Enum
792
-
793
- TaggedSymbol =
794
- T.type_alias do
795
- T.all(
796
- Symbol,
797
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status
798
- )
799
- end
800
- OrSymbol = T.type_alias { T.any(Symbol, String) }
801
-
802
- APPLIED =
803
- T.let(
804
- :applied,
805
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol
806
- )
807
- FAILED =
808
- T.let(
809
- :failed,
810
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol
811
- )
812
- SKIPPED =
813
- T.let(
814
- :skipped,
815
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol
816
- )
817
-
818
- sig do
819
- override.returns(
820
- T::Array[
821
- ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::Status::TaggedSymbol
822
- ]
823
- )
824
- end
825
- def self.values
826
- end
827
- end
828
- end
829
-
830
- # How complete the returned content is. `loaded` means the page finished the waits
831
- # the request asked for. `still-loading` only occurs with
832
- # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
833
- # reached first, so the content reflects the DOM at that moment and late-rendering
834
- # parts may be missing. Partial results are billed at the base request cost.
835
- module FinalDomState
836
- extend ContextDev::Internal::Type::Enum
837
-
838
- TaggedSymbol =
839
- T.type_alias do
840
- T.all(
841
- Symbol,
842
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState
843
- )
844
- end
845
- OrSymbol = T.type_alias { T.any(Symbol, String) }
846
-
847
- LOADED =
848
- T.let(
849
- :loaded,
850
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
851
- )
852
- STILL_LOADING =
853
- T.let(
854
- :"still-loading",
855
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
856
- )
857
-
858
- sig do
859
- override.returns(
860
- T::Array[
861
- ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
862
- ]
863
- )
864
- end
865
- def self.values
866
- end
867
- end
868
-
869
- class KeyMetadata < ContextDev::Internal::Type::BaseModel
870
- OrHash =
871
- T.type_alias do
872
- T.any(
873
- ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata,
874
- ContextDev::Internal::AnyHash
875
- )
876
- end
877
-
878
- # Credits used by this request.
879
- sig { returns(Integer) }
880
- attr_accessor :credits_consumed
881
-
882
- # Credits remaining for your organization.
883
- sig { returns(Integer) }
884
- attr_accessor :credits_remaining
885
-
886
- # Credit usage, included whenever a valid API key is provided.
887
- sig do
888
- params(credits_consumed: Integer, credits_remaining: Integer).returns(
889
- T.attached_class
890
- )
891
- end
892
- def self.new(
893
- # Credits used by this request.
894
- credits_consumed:,
895
- # Credits remaining for your organization.
896
- credits_remaining:
897
- )
898
- end
899
-
900
- sig do
901
- override.returns(
902
- { credits_consumed: Integer, credits_remaining: Integer }
903
- )
904
- end
905
- def to_hash
906
- end
907
- end
908
- end
909
- end
910
- end