context.dev 2.18.0 → 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 (115) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +18 -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 +906 -0
  12. data/lib/context_dev/models/web_scrape_response.rb +659 -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 +106 -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 +2000 -0
  29. data/rbi/context_dev/models/{web_web_scrape_html_response.rbi → web_scrape_response.rbi} +539 -510
  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 +135 -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 +834 -0
  44. data/sig/context_dev/models/web_scrape_response.rbs +552 -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 +30 -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_images_params.rbi +0 -728
  87. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
  88. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1052
  89. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
  90. data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +0 -1580
  91. data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +0 -332
  92. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
  93. data/rbi/context_dev/resources/ai.rbi +0 -63
  94. data/sig/context_dev/models/ai_extract_product_params.rbs +0 -106
  95. data/sig/context_dev/models/ai_extract_product_response.rbs +0 -314
  96. data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
  97. data/sig/context_dev/models/ai_extract_products_response.rbs +0 -293
  98. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
  99. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
  100. data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
  101. data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
  102. data/sig/context_dev/models/web_extract_params.rbs +0 -324
  103. data/sig/context_dev/models/web_extract_response.rbs +0 -239
  104. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
  105. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
  106. data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -878
  107. data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -525
  108. data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -281
  109. data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
  110. data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
  111. data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
  112. data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +0 -619
  113. data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +0 -127
  114. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
  115. data/sig/context_dev/resources/ai.rbs +0 -21
@@ -1,1040 +0,0 @@
1
- # typed: strong
2
-
3
- module ContextDev
4
- module Models
5
- class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- ContextDev::Models::BrandRetrieveSimplifiedResponse,
10
- ContextDev::Internal::AnyHash
11
- )
12
- end
13
-
14
- # Simplified brand information
15
- sig do
16
- returns(ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand)
17
- end
18
- attr_reader :brand
19
-
20
- sig do
21
- params(
22
- brand:
23
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash
24
- ).void
25
- end
26
- attr_writer :brand
27
-
28
- # Cache outcome for this response. Composite responses are hits only when every
29
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
30
- # oldest contributing hit.
31
- sig do
32
- returns(
33
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata
34
- )
35
- end
36
- attr_reader :cache_metadata
37
-
38
- sig do
39
- params(
40
- cache_metadata:
41
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash
42
- ).void
43
- end
44
- attr_writer :cache_metadata
45
-
46
- # HTTP status code of the response
47
- sig { returns(Integer) }
48
- attr_accessor :code
49
-
50
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
51
- # it when contacting support about a failed request.
52
- sig { returns(String) }
53
- attr_accessor :request_id
54
-
55
- # Status of the response, e.g., 'ok'
56
- sig { returns(String) }
57
- attr_accessor :status
58
-
59
- # Credit usage, included whenever a valid API key is provided.
60
- sig do
61
- returns(
62
- T.nilable(
63
- ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata
64
- )
65
- )
66
- end
67
- attr_reader :key_metadata
68
-
69
- sig do
70
- params(
71
- key_metadata:
72
- ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash
73
- ).void
74
- end
75
- attr_writer :key_metadata
76
-
77
- # True when the timeout ended processing and only completed brand data is
78
- # returned.
79
- sig { returns(T.nilable(T::Boolean)) }
80
- attr_reader :partial
81
-
82
- sig { params(partial: T::Boolean).void }
83
- attr_writer :partial
84
-
85
- sig do
86
- params(
87
- brand:
88
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
89
- cache_metadata:
90
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash,
91
- code: Integer,
92
- request_id: String,
93
- status: String,
94
- key_metadata:
95
- ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash,
96
- partial: T::Boolean
97
- ).returns(T.attached_class)
98
- end
99
- def self.new(
100
- # Simplified brand information
101
- brand:,
102
- # Cache outcome for this response. Composite responses are hits only when every
103
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
104
- # oldest contributing hit.
105
- cache_metadata:,
106
- # HTTP status code of the response
107
- code:,
108
- # Unique id of this API call, also sent in the X-Request-Id response header. Quote
109
- # it when contacting support about a failed request.
110
- request_id:,
111
- # Status of the response, e.g., 'ok'
112
- status:,
113
- # Credit usage, included whenever a valid API key is provided.
114
- key_metadata: nil,
115
- # True when the timeout ended processing and only completed brand data is
116
- # returned.
117
- partial: nil
118
- )
119
- end
120
-
121
- sig do
122
- override.returns(
123
- {
124
- brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
125
- cache_metadata:
126
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata,
127
- code: Integer,
128
- request_id: String,
129
- status: String,
130
- key_metadata:
131
- ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata,
132
- partial: T::Boolean
133
- }
134
- )
135
- end
136
- def to_hash
137
- end
138
-
139
- class Brand < ContextDev::Internal::Type::BaseModel
140
- OrHash =
141
- T.type_alias do
142
- T.any(
143
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
144
- ContextDev::Internal::AnyHash
145
- )
146
- end
147
-
148
- # An array of backdrop images for the brand
149
- sig do
150
- returns(
151
- T.nilable(
152
- T::Array[
153
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop
154
- ]
155
- )
156
- )
157
- end
158
- attr_reader :backdrops
159
-
160
- sig do
161
- params(
162
- backdrops:
163
- T::Array[
164
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::OrHash
165
- ]
166
- ).void
167
- end
168
- attr_writer :backdrops
169
-
170
- # An array of brand colors
171
- sig do
172
- returns(
173
- T.nilable(
174
- T::Array[
175
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color
176
- ]
177
- )
178
- )
179
- end
180
- attr_reader :colors
181
-
182
- sig do
183
- params(
184
- colors:
185
- T::Array[
186
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::OrHash
187
- ]
188
- ).void
189
- end
190
- attr_writer :colors
191
-
192
- # The domain name of the brand
193
- sig { returns(T.nilable(String)) }
194
- attr_reader :domain
195
-
196
- sig { params(domain: String).void }
197
- attr_writer :domain
198
-
199
- # An array of logos associated with the brand
200
- sig do
201
- returns(
202
- T.nilable(
203
- T::Array[
204
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo
205
- ]
206
- )
207
- )
208
- end
209
- attr_reader :logos
210
-
211
- sig do
212
- params(
213
- logos:
214
- T::Array[
215
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::OrHash
216
- ]
217
- ).void
218
- end
219
- attr_writer :logos
220
-
221
- # The title or name of the brand
222
- sig { returns(T.nilable(String)) }
223
- attr_reader :title
224
-
225
- sig { params(title: String).void }
226
- attr_writer :title
227
-
228
- # Simplified brand information
229
- sig do
230
- params(
231
- backdrops:
232
- T::Array[
233
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::OrHash
234
- ],
235
- colors:
236
- T::Array[
237
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::OrHash
238
- ],
239
- domain: String,
240
- logos:
241
- T::Array[
242
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::OrHash
243
- ],
244
- title: String
245
- ).returns(T.attached_class)
246
- end
247
- def self.new(
248
- # An array of backdrop images for the brand
249
- backdrops: nil,
250
- # An array of brand colors
251
- colors: nil,
252
- # The domain name of the brand
253
- domain: nil,
254
- # An array of logos associated with the brand
255
- logos: nil,
256
- # The title or name of the brand
257
- title: nil
258
- )
259
- end
260
-
261
- sig do
262
- override.returns(
263
- {
264
- backdrops:
265
- T::Array[
266
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop
267
- ],
268
- colors:
269
- T::Array[
270
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color
271
- ],
272
- domain: String,
273
- logos:
274
- T::Array[
275
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo
276
- ],
277
- title: String
278
- }
279
- )
280
- end
281
- def to_hash
282
- end
283
-
284
- class Backdrop < ContextDev::Internal::Type::BaseModel
285
- OrHash =
286
- T.type_alias do
287
- T.any(
288
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop,
289
- ContextDev::Internal::AnyHash
290
- )
291
- end
292
-
293
- # Array of colors in the backdrop image
294
- sig do
295
- returns(
296
- T.nilable(
297
- T::Array[
298
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color
299
- ]
300
- )
301
- )
302
- end
303
- attr_reader :colors
304
-
305
- sig do
306
- params(
307
- colors:
308
- T::Array[
309
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color::OrHash
310
- ]
311
- ).void
312
- end
313
- attr_writer :colors
314
-
315
- # Resolution of the backdrop image
316
- sig do
317
- returns(
318
- T.nilable(
319
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution
320
- )
321
- )
322
- end
323
- attr_reader :resolution
324
-
325
- sig do
326
- params(
327
- resolution:
328
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution::OrHash
329
- ).void
330
- end
331
- attr_writer :resolution
332
-
333
- # URL of the backdrop image
334
- sig { returns(T.nilable(String)) }
335
- attr_reader :url
336
-
337
- sig { params(url: String).void }
338
- attr_writer :url
339
-
340
- sig do
341
- params(
342
- colors:
343
- T::Array[
344
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color::OrHash
345
- ],
346
- resolution:
347
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution::OrHash,
348
- url: String
349
- ).returns(T.attached_class)
350
- end
351
- def self.new(
352
- # Array of colors in the backdrop image
353
- colors: nil,
354
- # Resolution of the backdrop image
355
- resolution: nil,
356
- # URL of the backdrop image
357
- url: nil
358
- )
359
- end
360
-
361
- sig do
362
- override.returns(
363
- {
364
- colors:
365
- T::Array[
366
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color
367
- ],
368
- resolution:
369
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
370
- url: String
371
- }
372
- )
373
- end
374
- def to_hash
375
- end
376
-
377
- class Color < ContextDev::Internal::Type::BaseModel
378
- OrHash =
379
- T.type_alias do
380
- T.any(
381
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Color,
382
- ContextDev::Internal::AnyHash
383
- )
384
- end
385
-
386
- # Color in hexadecimal format
387
- sig { returns(T.nilable(String)) }
388
- attr_reader :hex
389
-
390
- sig { params(hex: String).void }
391
- attr_writer :hex
392
-
393
- # Name of the color
394
- sig { returns(T.nilable(String)) }
395
- attr_reader :name
396
-
397
- sig { params(name: String).void }
398
- attr_writer :name
399
-
400
- sig { params(hex: String, name: String).returns(T.attached_class) }
401
- def self.new(
402
- # Color in hexadecimal format
403
- hex: nil,
404
- # Name of the color
405
- name: nil
406
- )
407
- end
408
-
409
- sig { override.returns({ hex: String, name: String }) }
410
- def to_hash
411
- end
412
- end
413
-
414
- class Resolution < ContextDev::Internal::Type::BaseModel
415
- OrHash =
416
- T.type_alias do
417
- T.any(
418
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Backdrop::Resolution,
419
- ContextDev::Internal::AnyHash
420
- )
421
- end
422
-
423
- # Aspect ratio of the image (width/height)
424
- sig { returns(T.nilable(Float)) }
425
- attr_reader :aspect_ratio
426
-
427
- sig { params(aspect_ratio: Float).void }
428
- attr_writer :aspect_ratio
429
-
430
- # Height of the image in pixels
431
- sig { returns(T.nilable(Integer)) }
432
- attr_reader :height
433
-
434
- sig { params(height: Integer).void }
435
- attr_writer :height
436
-
437
- # Width of the image in pixels
438
- sig { returns(T.nilable(Integer)) }
439
- attr_reader :width
440
-
441
- sig { params(width: Integer).void }
442
- attr_writer :width
443
-
444
- # Resolution of the backdrop image
445
- sig do
446
- params(
447
- aspect_ratio: Float,
448
- height: Integer,
449
- width: Integer
450
- ).returns(T.attached_class)
451
- end
452
- def self.new(
453
- # Aspect ratio of the image (width/height)
454
- aspect_ratio: nil,
455
- # Height of the image in pixels
456
- height: nil,
457
- # Width of the image in pixels
458
- width: nil
459
- )
460
- end
461
-
462
- sig do
463
- override.returns(
464
- { aspect_ratio: Float, height: Integer, width: Integer }
465
- )
466
- end
467
- def to_hash
468
- end
469
- end
470
- end
471
-
472
- class Color < ContextDev::Internal::Type::BaseModel
473
- OrHash =
474
- T.type_alias do
475
- T.any(
476
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color,
477
- ContextDev::Internal::AnyHash
478
- )
479
- end
480
-
481
- # Color in hexadecimal format
482
- sig { returns(T.nilable(String)) }
483
- attr_reader :hex
484
-
485
- sig { params(hex: String).void }
486
- attr_writer :hex
487
-
488
- # Name of the color
489
- sig { returns(T.nilable(String)) }
490
- attr_reader :name
491
-
492
- sig { params(name: String).void }
493
- attr_writer :name
494
-
495
- # Where the color was observed: 'site' colors come from the website's own theme
496
- # signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
497
- # logo image pixels.
498
- sig do
499
- returns(
500
- T.nilable(
501
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
502
- )
503
- )
504
- end
505
- attr_reader :source
506
-
507
- sig do
508
- params(
509
- source:
510
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::OrSymbol
511
- ).void
512
- end
513
- attr_writer :source
514
-
515
- sig do
516
- params(
517
- hex: String,
518
- name: String,
519
- source:
520
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::OrSymbol
521
- ).returns(T.attached_class)
522
- end
523
- def self.new(
524
- # Color in hexadecimal format
525
- hex: nil,
526
- # Name of the color
527
- name: nil,
528
- # Where the color was observed: 'site' colors come from the website's own theme
529
- # signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
530
- # logo image pixels.
531
- source: nil
532
- )
533
- end
534
-
535
- sig do
536
- override.returns(
537
- {
538
- hex: String,
539
- name: String,
540
- source:
541
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
542
- }
543
- )
544
- end
545
- def to_hash
546
- end
547
-
548
- # Where the color was observed: 'site' colors come from the website's own theme
549
- # signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
550
- # logo image pixels.
551
- module Source
552
- extend ContextDev::Internal::Type::Enum
553
-
554
- TaggedSymbol =
555
- T.type_alias do
556
- T.all(
557
- Symbol,
558
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source
559
- )
560
- end
561
- OrSymbol = T.type_alias { T.any(Symbol, String) }
562
-
563
- SITE =
564
- T.let(
565
- :site,
566
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
567
- )
568
- LOGO =
569
- T.let(
570
- :logo,
571
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
572
- )
573
-
574
- sig do
575
- override.returns(
576
- T::Array[
577
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
578
- ]
579
- )
580
- end
581
- def self.values
582
- end
583
- end
584
- end
585
-
586
- class Logo < ContextDev::Internal::Type::BaseModel
587
- OrHash =
588
- T.type_alias do
589
- T.any(
590
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo,
591
- ContextDev::Internal::AnyHash
592
- )
593
- end
594
-
595
- # Array of colors in the logo
596
- sig do
597
- returns(
598
- T.nilable(
599
- T::Array[
600
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color
601
- ]
602
- )
603
- )
604
- end
605
- attr_reader :colors
606
-
607
- sig do
608
- params(
609
- colors:
610
- T::Array[
611
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color::OrHash
612
- ]
613
- ).void
614
- end
615
- attr_writer :colors
616
-
617
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
618
- # best for dark mode, 'has_opaque_background' = can be used for either as image
619
- # has its own background
620
- sig do
621
- returns(
622
- T.nilable(
623
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
624
- )
625
- )
626
- end
627
- attr_reader :mode
628
-
629
- sig do
630
- params(
631
- mode:
632
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::OrSymbol
633
- ).void
634
- end
635
- attr_writer :mode
636
-
637
- # Resolution of the logo image
638
- sig do
639
- returns(
640
- T.nilable(
641
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution
642
- )
643
- )
644
- end
645
- attr_reader :resolution
646
-
647
- sig do
648
- params(
649
- resolution:
650
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution::OrHash
651
- ).void
652
- end
653
- attr_writer :resolution
654
-
655
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
656
- sig do
657
- returns(
658
- T.nilable(
659
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
660
- )
661
- )
662
- end
663
- attr_reader :type
664
-
665
- sig do
666
- params(
667
- type:
668
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::OrSymbol
669
- ).void
670
- end
671
- attr_writer :type
672
-
673
- # CDN hosted url of the logo (ready for display)
674
- sig { returns(T.nilable(String)) }
675
- attr_reader :url
676
-
677
- sig { params(url: String).void }
678
- attr_writer :url
679
-
680
- sig do
681
- params(
682
- colors:
683
- T::Array[
684
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color::OrHash
685
- ],
686
- mode:
687
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::OrSymbol,
688
- resolution:
689
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution::OrHash,
690
- type:
691
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::OrSymbol,
692
- url: String
693
- ).returns(T.attached_class)
694
- end
695
- def self.new(
696
- # Array of colors in the logo
697
- colors: nil,
698
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
699
- # best for dark mode, 'has_opaque_background' = can be used for either as image
700
- # has its own background
701
- mode: nil,
702
- # Resolution of the logo image
703
- resolution: nil,
704
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
705
- type: nil,
706
- # CDN hosted url of the logo (ready for display)
707
- url: nil
708
- )
709
- end
710
-
711
- sig do
712
- override.returns(
713
- {
714
- colors:
715
- T::Array[
716
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color
717
- ],
718
- mode:
719
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol,
720
- resolution:
721
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
722
- type:
723
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol,
724
- url: String
725
- }
726
- )
727
- end
728
- def to_hash
729
- end
730
-
731
- class Color < ContextDev::Internal::Type::BaseModel
732
- OrHash =
733
- T.type_alias do
734
- T.any(
735
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Color,
736
- ContextDev::Internal::AnyHash
737
- )
738
- end
739
-
740
- # Color in hexadecimal format
741
- sig { returns(T.nilable(String)) }
742
- attr_reader :hex
743
-
744
- sig { params(hex: String).void }
745
- attr_writer :hex
746
-
747
- # Name of the color
748
- sig { returns(T.nilable(String)) }
749
- attr_reader :name
750
-
751
- sig { params(name: String).void }
752
- attr_writer :name
753
-
754
- sig { params(hex: String, name: String).returns(T.attached_class) }
755
- def self.new(
756
- # Color in hexadecimal format
757
- hex: nil,
758
- # Name of the color
759
- name: nil
760
- )
761
- end
762
-
763
- sig { override.returns({ hex: String, name: String }) }
764
- def to_hash
765
- end
766
- end
767
-
768
- # Indicates when this logo is best used: 'light' = best for light mode, 'dark' =
769
- # best for dark mode, 'has_opaque_background' = can be used for either as image
770
- # has its own background
771
- module Mode
772
- extend ContextDev::Internal::Type::Enum
773
-
774
- TaggedSymbol =
775
- T.type_alias do
776
- T.all(
777
- Symbol,
778
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode
779
- )
780
- end
781
- OrSymbol = T.type_alias { T.any(Symbol, String) }
782
-
783
- LIGHT =
784
- T.let(
785
- :light,
786
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
787
- )
788
- DARK =
789
- T.let(
790
- :dark,
791
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
792
- )
793
- HAS_OPAQUE_BACKGROUND =
794
- T.let(
795
- :has_opaque_background,
796
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
797
- )
798
-
799
- sig do
800
- override.returns(
801
- T::Array[
802
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Mode::TaggedSymbol
803
- ]
804
- )
805
- end
806
- def self.values
807
- end
808
- end
809
-
810
- class Resolution < ContextDev::Internal::Type::BaseModel
811
- OrHash =
812
- T.type_alias do
813
- T.any(
814
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Resolution,
815
- ContextDev::Internal::AnyHash
816
- )
817
- end
818
-
819
- # Aspect ratio of the image (width/height)
820
- sig { returns(T.nilable(Float)) }
821
- attr_reader :aspect_ratio
822
-
823
- sig { params(aspect_ratio: Float).void }
824
- attr_writer :aspect_ratio
825
-
826
- # Height of the image in pixels
827
- sig { returns(T.nilable(Integer)) }
828
- attr_reader :height
829
-
830
- sig { params(height: Integer).void }
831
- attr_writer :height
832
-
833
- # Width of the image in pixels
834
- sig { returns(T.nilable(Integer)) }
835
- attr_reader :width
836
-
837
- sig { params(width: Integer).void }
838
- attr_writer :width
839
-
840
- # Resolution of the logo image
841
- sig do
842
- params(
843
- aspect_ratio: Float,
844
- height: Integer,
845
- width: Integer
846
- ).returns(T.attached_class)
847
- end
848
- def self.new(
849
- # Aspect ratio of the image (width/height)
850
- aspect_ratio: nil,
851
- # Height of the image in pixels
852
- height: nil,
853
- # Width of the image in pixels
854
- width: nil
855
- )
856
- end
857
-
858
- sig do
859
- override.returns(
860
- { aspect_ratio: Float, height: Integer, width: Integer }
861
- )
862
- end
863
- def to_hash
864
- end
865
- end
866
-
867
- # Type of the logo based on resolution (e.g., 'icon', 'logo')
868
- module Type
869
- extend ContextDev::Internal::Type::Enum
870
-
871
- TaggedSymbol =
872
- T.type_alias do
873
- T.all(
874
- Symbol,
875
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type
876
- )
877
- end
878
- OrSymbol = T.type_alias { T.any(Symbol, String) }
879
-
880
- ICON =
881
- T.let(
882
- :icon,
883
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
884
- )
885
- LOGO =
886
- T.let(
887
- :logo,
888
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
889
- )
890
-
891
- sig do
892
- override.returns(
893
- T::Array[
894
- ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Logo::Type::TaggedSymbol
895
- ]
896
- )
897
- end
898
- def self.values
899
- end
900
- end
901
- end
902
- end
903
-
904
- class CacheMetadata < ContextDev::Internal::Type::BaseModel
905
- OrHash =
906
- T.type_alias do
907
- T.any(
908
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata,
909
- ContextDev::Internal::AnyHash
910
- )
911
- end
912
-
913
- # Age of the cached data in milliseconds. Zero for miss and zdr responses.
914
- sig { returns(Integer) }
915
- attr_accessor :age_ms
916
-
917
- # Whether the response was served from cache, required fresh work, or honored
918
- # zero-data-retention cache bypass.
919
- sig do
920
- returns(
921
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
922
- )
923
- end
924
- attr_accessor :status
925
-
926
- # Cache outcome for this response. Composite responses are hits only when every
927
- # cache-controlled fetch contributing to the output was a hit; age_ms is the
928
- # oldest contributing hit.
929
- sig do
930
- params(
931
- age_ms: Integer,
932
- status:
933
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::OrSymbol
934
- ).returns(T.attached_class)
935
- end
936
- def self.new(
937
- # Age of the cached data in milliseconds. Zero for miss and zdr responses.
938
- age_ms:,
939
- # Whether the response was served from cache, required fresh work, or honored
940
- # zero-data-retention cache bypass.
941
- status:
942
- )
943
- end
944
-
945
- sig do
946
- override.returns(
947
- {
948
- age_ms: Integer,
949
- status:
950
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
951
- }
952
- )
953
- end
954
- def to_hash
955
- end
956
-
957
- # Whether the response was served from cache, required fresh work, or honored
958
- # zero-data-retention cache bypass.
959
- module Status
960
- extend ContextDev::Internal::Type::Enum
961
-
962
- TaggedSymbol =
963
- T.type_alias do
964
- T.all(
965
- Symbol,
966
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status
967
- )
968
- end
969
- OrSymbol = T.type_alias { T.any(Symbol, String) }
970
-
971
- HIT =
972
- T.let(
973
- :hit,
974
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
975
- )
976
- MISS =
977
- T.let(
978
- :miss,
979
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
980
- )
981
- ZDR =
982
- T.let(
983
- :zdr,
984
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
985
- )
986
-
987
- sig do
988
- override.returns(
989
- T::Array[
990
- ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status::TaggedSymbol
991
- ]
992
- )
993
- end
994
- def self.values
995
- end
996
- end
997
- end
998
-
999
- class KeyMetadata < ContextDev::Internal::Type::BaseModel
1000
- OrHash =
1001
- T.type_alias do
1002
- T.any(
1003
- ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata,
1004
- ContextDev::Internal::AnyHash
1005
- )
1006
- end
1007
-
1008
- # Credits used by this request.
1009
- sig { returns(Integer) }
1010
- attr_accessor :credits_consumed
1011
-
1012
- # Credits remaining for your organization.
1013
- sig { returns(Integer) }
1014
- attr_accessor :credits_remaining
1015
-
1016
- # Credit usage, included whenever a valid API key is provided.
1017
- sig do
1018
- params(credits_consumed: Integer, credits_remaining: Integer).returns(
1019
- T.attached_class
1020
- )
1021
- end
1022
- def self.new(
1023
- # Credits used by this request.
1024
- credits_consumed:,
1025
- # Credits remaining for your organization.
1026
- credits_remaining:
1027
- )
1028
- end
1029
-
1030
- sig do
1031
- override.returns(
1032
- { credits_consumed: Integer, credits_remaining: Integer }
1033
- )
1034
- end
1035
- def to_hash
1036
- end
1037
- end
1038
- end
1039
- end
1040
- end