context.dev 2.10.0 → 2.12.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/README.md +1 -1
- data/lib/context_dev/models/ai_extract_product_response.rb +48 -1
- data/lib/context_dev/models/ai_extract_products_response.rb +48 -1
- data/lib/context_dev/models/brand_retrieve_response.rb +29 -1
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +30 -1
- data/lib/context_dev/models/news_search_params.rb +1 -0
- data/lib/context_dev/models/news_search_response.rb +68 -22
- data/lib/context_dev/models/web_extract_params.rb +169 -6
- data/lib/context_dev/models/web_extract_response.rb +85 -1
- data/lib/context_dev/models/web_screenshot_params.rb +13 -1
- data/lib/context_dev/models/web_web_crawl_md_params.rb +7 -5
- data/lib/context_dev/models/web_web_scrape_html_params.rb +99 -3
- data/lib/context_dev/models/web_web_scrape_images_params.rb +99 -3
- data/lib/context_dev/models/web_web_scrape_images_response.rb +85 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +99 -3
- data/lib/context_dev/resources/web.rb +13 -8
- data/lib/context_dev/version.rb +1 -1
- data/rbi/context_dev/models/ai_extract_product_response.rbi +99 -0
- data/rbi/context_dev/models/ai_extract_products_response.rbi +99 -0
- data/rbi/context_dev/models/brand_retrieve_response.rbi +80 -3
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +80 -3
- data/rbi/context_dev/models/news_search_params.rbi +5 -0
- data/rbi/context_dev/models/news_search_response.rbi +70 -4
- data/rbi/context_dev/models/web_extract_params.rbi +353 -8
- data/rbi/context_dev/models/web_extract_response.rbi +172 -3
- data/rbi/context_dev/models/web_screenshot_params.rbi +19 -0
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +10 -6
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +218 -4
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +218 -4
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +169 -0
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +218 -4
- data/rbi/context_dev/resources/web.rbi +38 -10
- data/sig/context_dev/models/ai_extract_product_response.rbs +40 -0
- data/sig/context_dev/models/ai_extract_products_response.rbs +40 -0
- data/sig/context_dev/models/brand_retrieve_response.rbs +33 -3
- data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +33 -3
- data/sig/context_dev/models/news_search_params.rbs +2 -0
- data/sig/context_dev/models/web_extract_params.rbs +117 -0
- data/sig/context_dev/models/web_extract_response.rbs +81 -3
- data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +74 -0
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +74 -0
- data/sig/context_dev/models/web_web_scrape_images_response.rbs +78 -0
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +74 -0
- data/sig/context_dev/resources/web.rbs +2 -0
- metadata +2 -2
|
@@ -158,6 +158,16 @@ module ContextDev
|
|
|
158
158
|
sig { returns(T::Array[String]) }
|
|
159
159
|
attr_accessor :target_audience
|
|
160
160
|
|
|
161
|
+
# Normalized stock or ordering availability
|
|
162
|
+
sig do
|
|
163
|
+
returns(
|
|
164
|
+
T.nilable(
|
|
165
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
166
|
+
)
|
|
167
|
+
)
|
|
168
|
+
end
|
|
169
|
+
attr_accessor :availability
|
|
170
|
+
|
|
161
171
|
# Billing frequency for the product
|
|
162
172
|
sig do
|
|
163
173
|
returns(
|
|
@@ -176,6 +186,13 @@ module ContextDev
|
|
|
176
186
|
sig { returns(T.nilable(String)) }
|
|
177
187
|
attr_accessor :currency
|
|
178
188
|
|
|
189
|
+
# Dimension statements shown for the product, preserving labels, values, and units
|
|
190
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
191
|
+
attr_reader :dimensions
|
|
192
|
+
|
|
193
|
+
sig { params(dimensions: T::Array[String]).void }
|
|
194
|
+
attr_writer :dimensions
|
|
195
|
+
|
|
179
196
|
# URL to the product image
|
|
180
197
|
sig { returns(T.nilable(String)) }
|
|
181
198
|
attr_accessor :image_url
|
|
@@ -194,6 +211,10 @@ module ContextDev
|
|
|
194
211
|
end
|
|
195
212
|
attr_accessor :pricing_model
|
|
196
213
|
|
|
214
|
+
# Original or regular price before a displayed discount
|
|
215
|
+
sig { returns(T.nilable(Float)) }
|
|
216
|
+
attr_accessor :regular_price
|
|
217
|
+
|
|
197
218
|
# URL to the product page
|
|
198
219
|
sig { returns(T.nilable(String)) }
|
|
199
220
|
attr_accessor :url
|
|
@@ -207,18 +228,24 @@ module ContextDev
|
|
|
207
228
|
sku: T.nilable(String),
|
|
208
229
|
tags: T::Array[String],
|
|
209
230
|
target_audience: T::Array[String],
|
|
231
|
+
availability:
|
|
232
|
+
T.nilable(
|
|
233
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::OrSymbol
|
|
234
|
+
),
|
|
210
235
|
billing_frequency:
|
|
211
236
|
T.nilable(
|
|
212
237
|
ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::OrSymbol
|
|
213
238
|
),
|
|
214
239
|
category: T.nilable(String),
|
|
215
240
|
currency: T.nilable(String),
|
|
241
|
+
dimensions: T::Array[String],
|
|
216
242
|
image_url: T.nilable(String),
|
|
217
243
|
price: T.nilable(Float),
|
|
218
244
|
pricing_model:
|
|
219
245
|
T.nilable(
|
|
220
246
|
ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::OrSymbol
|
|
221
247
|
),
|
|
248
|
+
regular_price: T.nilable(Float),
|
|
222
249
|
url: T.nilable(String)
|
|
223
250
|
).returns(T.attached_class)
|
|
224
251
|
end
|
|
@@ -237,18 +264,24 @@ module ContextDev
|
|
|
237
264
|
tags:,
|
|
238
265
|
# Target audience for the product (array of strings)
|
|
239
266
|
target_audience:,
|
|
267
|
+
# Normalized stock or ordering availability
|
|
268
|
+
availability: nil,
|
|
240
269
|
# Billing frequency for the product
|
|
241
270
|
billing_frequency: nil,
|
|
242
271
|
# Category of the product
|
|
243
272
|
category: nil,
|
|
244
273
|
# Currency code for the price (e.g., USD, EUR)
|
|
245
274
|
currency: nil,
|
|
275
|
+
# Dimension statements shown for the product, preserving labels, values, and units
|
|
276
|
+
dimensions: nil,
|
|
246
277
|
# URL to the product image
|
|
247
278
|
image_url: nil,
|
|
248
279
|
# Price of the product
|
|
249
280
|
price: nil,
|
|
250
281
|
# Pricing model for the product
|
|
251
282
|
pricing_model: nil,
|
|
283
|
+
# Original or regular price before a displayed discount
|
|
284
|
+
regular_price: nil,
|
|
252
285
|
# URL to the product page
|
|
253
286
|
url: nil
|
|
254
287
|
)
|
|
@@ -264,18 +297,24 @@ module ContextDev
|
|
|
264
297
|
sku: T.nilable(String),
|
|
265
298
|
tags: T::Array[String],
|
|
266
299
|
target_audience: T::Array[String],
|
|
300
|
+
availability:
|
|
301
|
+
T.nilable(
|
|
302
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
303
|
+
),
|
|
267
304
|
billing_frequency:
|
|
268
305
|
T.nilable(
|
|
269
306
|
ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency::TaggedSymbol
|
|
270
307
|
),
|
|
271
308
|
category: T.nilable(String),
|
|
272
309
|
currency: T.nilable(String),
|
|
310
|
+
dimensions: T::Array[String],
|
|
273
311
|
image_url: T.nilable(String),
|
|
274
312
|
price: T.nilable(Float),
|
|
275
313
|
pricing_model:
|
|
276
314
|
T.nilable(
|
|
277
315
|
ContextDev::Models::AIExtractProductsResponse::Product::PricingModel::TaggedSymbol
|
|
278
316
|
),
|
|
317
|
+
regular_price: T.nilable(Float),
|
|
279
318
|
url: T.nilable(String)
|
|
280
319
|
}
|
|
281
320
|
)
|
|
@@ -283,6 +322,66 @@ module ContextDev
|
|
|
283
322
|
def to_hash
|
|
284
323
|
end
|
|
285
324
|
|
|
325
|
+
# Normalized stock or ordering availability
|
|
326
|
+
module Availability
|
|
327
|
+
extend ContextDev::Internal::Type::Enum
|
|
328
|
+
|
|
329
|
+
TaggedSymbol =
|
|
330
|
+
T.type_alias do
|
|
331
|
+
T.all(
|
|
332
|
+
Symbol,
|
|
333
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability
|
|
334
|
+
)
|
|
335
|
+
end
|
|
336
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
337
|
+
|
|
338
|
+
IN_STOCK =
|
|
339
|
+
T.let(
|
|
340
|
+
:in_stock,
|
|
341
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
342
|
+
)
|
|
343
|
+
OUT_OF_STOCK =
|
|
344
|
+
T.let(
|
|
345
|
+
:out_of_stock,
|
|
346
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
347
|
+
)
|
|
348
|
+
LIMITED_AVAILABILITY =
|
|
349
|
+
T.let(
|
|
350
|
+
:limited_availability,
|
|
351
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
352
|
+
)
|
|
353
|
+
PREORDER =
|
|
354
|
+
T.let(
|
|
355
|
+
:preorder,
|
|
356
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
357
|
+
)
|
|
358
|
+
BACKORDER =
|
|
359
|
+
T.let(
|
|
360
|
+
:backorder,
|
|
361
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
362
|
+
)
|
|
363
|
+
MADE_TO_ORDER =
|
|
364
|
+
T.let(
|
|
365
|
+
:made_to_order,
|
|
366
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
367
|
+
)
|
|
368
|
+
DISCONTINUED =
|
|
369
|
+
T.let(
|
|
370
|
+
:discontinued,
|
|
371
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
372
|
+
)
|
|
373
|
+
|
|
374
|
+
sig do
|
|
375
|
+
override.returns(
|
|
376
|
+
T::Array[
|
|
377
|
+
ContextDev::Models::AIExtractProductsResponse::Product::Availability::TaggedSymbol
|
|
378
|
+
]
|
|
379
|
+
)
|
|
380
|
+
end
|
|
381
|
+
def self.values
|
|
382
|
+
end
|
|
383
|
+
end
|
|
384
|
+
|
|
286
385
|
# Billing frequency for the product
|
|
287
386
|
module BillingFrequency
|
|
288
387
|
extend ContextDev::Internal::Type::Enum
|
|
@@ -767,18 +767,95 @@ module ContextDev
|
|
|
767
767
|
sig { params(name: String).void }
|
|
768
768
|
attr_writer :name
|
|
769
769
|
|
|
770
|
-
|
|
770
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
771
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
772
|
+
# logo image pixels.
|
|
773
|
+
sig do
|
|
774
|
+
returns(
|
|
775
|
+
T.nilable(
|
|
776
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::TaggedSymbol
|
|
777
|
+
)
|
|
778
|
+
)
|
|
779
|
+
end
|
|
780
|
+
attr_reader :source
|
|
781
|
+
|
|
782
|
+
sig do
|
|
783
|
+
params(
|
|
784
|
+
source:
|
|
785
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::OrSymbol
|
|
786
|
+
).void
|
|
787
|
+
end
|
|
788
|
+
attr_writer :source
|
|
789
|
+
|
|
790
|
+
sig do
|
|
791
|
+
params(
|
|
792
|
+
hex: String,
|
|
793
|
+
name: String,
|
|
794
|
+
source:
|
|
795
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::OrSymbol
|
|
796
|
+
).returns(T.attached_class)
|
|
797
|
+
end
|
|
771
798
|
def self.new(
|
|
772
799
|
# Color in hexadecimal format
|
|
773
800
|
hex: nil,
|
|
774
801
|
# Name of the color
|
|
775
|
-
name: nil
|
|
802
|
+
name: nil,
|
|
803
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
804
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
805
|
+
# logo image pixels.
|
|
806
|
+
source: nil
|
|
776
807
|
)
|
|
777
808
|
end
|
|
778
809
|
|
|
779
|
-
sig
|
|
810
|
+
sig do
|
|
811
|
+
override.returns(
|
|
812
|
+
{
|
|
813
|
+
hex: String,
|
|
814
|
+
name: String,
|
|
815
|
+
source:
|
|
816
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::TaggedSymbol
|
|
817
|
+
}
|
|
818
|
+
)
|
|
819
|
+
end
|
|
780
820
|
def to_hash
|
|
781
821
|
end
|
|
822
|
+
|
|
823
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
824
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
825
|
+
# logo image pixels.
|
|
826
|
+
module Source
|
|
827
|
+
extend ContextDev::Internal::Type::Enum
|
|
828
|
+
|
|
829
|
+
TaggedSymbol =
|
|
830
|
+
T.type_alias do
|
|
831
|
+
T.all(
|
|
832
|
+
Symbol,
|
|
833
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source
|
|
834
|
+
)
|
|
835
|
+
end
|
|
836
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
837
|
+
|
|
838
|
+
SITE =
|
|
839
|
+
T.let(
|
|
840
|
+
:site,
|
|
841
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::TaggedSymbol
|
|
842
|
+
)
|
|
843
|
+
LOGO =
|
|
844
|
+
T.let(
|
|
845
|
+
:logo,
|
|
846
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::TaggedSymbol
|
|
847
|
+
)
|
|
848
|
+
|
|
849
|
+
sig do
|
|
850
|
+
override.returns(
|
|
851
|
+
T::Array[
|
|
852
|
+
ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source::TaggedSymbol
|
|
853
|
+
]
|
|
854
|
+
)
|
|
855
|
+
end
|
|
856
|
+
def self.values
|
|
857
|
+
end
|
|
858
|
+
end
|
|
782
859
|
end
|
|
783
860
|
|
|
784
861
|
class Employees < ContextDev::Internal::Type::BaseModel
|
|
@@ -453,18 +453,95 @@ module ContextDev
|
|
|
453
453
|
sig { params(name: String).void }
|
|
454
454
|
attr_writer :name
|
|
455
455
|
|
|
456
|
-
|
|
456
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
457
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
458
|
+
# logo image pixels.
|
|
459
|
+
sig do
|
|
460
|
+
returns(
|
|
461
|
+
T.nilable(
|
|
462
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
|
|
463
|
+
)
|
|
464
|
+
)
|
|
465
|
+
end
|
|
466
|
+
attr_reader :source
|
|
467
|
+
|
|
468
|
+
sig do
|
|
469
|
+
params(
|
|
470
|
+
source:
|
|
471
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::OrSymbol
|
|
472
|
+
).void
|
|
473
|
+
end
|
|
474
|
+
attr_writer :source
|
|
475
|
+
|
|
476
|
+
sig do
|
|
477
|
+
params(
|
|
478
|
+
hex: String,
|
|
479
|
+
name: String,
|
|
480
|
+
source:
|
|
481
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::OrSymbol
|
|
482
|
+
).returns(T.attached_class)
|
|
483
|
+
end
|
|
457
484
|
def self.new(
|
|
458
485
|
# Color in hexadecimal format
|
|
459
486
|
hex: nil,
|
|
460
487
|
# Name of the color
|
|
461
|
-
name: nil
|
|
488
|
+
name: nil,
|
|
489
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
490
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
491
|
+
# logo image pixels.
|
|
492
|
+
source: nil
|
|
462
493
|
)
|
|
463
494
|
end
|
|
464
495
|
|
|
465
|
-
sig
|
|
496
|
+
sig do
|
|
497
|
+
override.returns(
|
|
498
|
+
{
|
|
499
|
+
hex: String,
|
|
500
|
+
name: String,
|
|
501
|
+
source:
|
|
502
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
|
|
503
|
+
}
|
|
504
|
+
)
|
|
505
|
+
end
|
|
466
506
|
def to_hash
|
|
467
507
|
end
|
|
508
|
+
|
|
509
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
510
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
511
|
+
# logo image pixels.
|
|
512
|
+
module Source
|
|
513
|
+
extend ContextDev::Internal::Type::Enum
|
|
514
|
+
|
|
515
|
+
TaggedSymbol =
|
|
516
|
+
T.type_alias do
|
|
517
|
+
T.all(
|
|
518
|
+
Symbol,
|
|
519
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source
|
|
520
|
+
)
|
|
521
|
+
end
|
|
522
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
523
|
+
|
|
524
|
+
SITE =
|
|
525
|
+
T.let(
|
|
526
|
+
:site,
|
|
527
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
|
|
528
|
+
)
|
|
529
|
+
LOGO =
|
|
530
|
+
T.let(
|
|
531
|
+
:logo,
|
|
532
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
|
|
533
|
+
)
|
|
534
|
+
|
|
535
|
+
sig do
|
|
536
|
+
override.returns(
|
|
537
|
+
T::Array[
|
|
538
|
+
ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source::TaggedSymbol
|
|
539
|
+
]
|
|
540
|
+
)
|
|
541
|
+
end
|
|
542
|
+
def self.values
|
|
543
|
+
end
|
|
544
|
+
end
|
|
468
545
|
end
|
|
469
546
|
|
|
470
547
|
class Logo < ContextDev::Internal::Type::BaseModel
|
|
@@ -1123,6 +1123,11 @@ module ContextDev
|
|
|
1123
1123
|
:cl,
|
|
1124
1124
|
ContextDev::NewsSearchParams::FilterBy::SourceCountry::TaggedSymbol
|
|
1125
1125
|
)
|
|
1126
|
+
CZ =
|
|
1127
|
+
T.let(
|
|
1128
|
+
:cz,
|
|
1129
|
+
ContextDev::NewsSearchParams::FilterBy::SourceCountry::TaggedSymbol
|
|
1130
|
+
)
|
|
1126
1131
|
DE =
|
|
1127
1132
|
T.let(
|
|
1128
1133
|
:de,
|
|
@@ -11,12 +11,15 @@ module ContextDev
|
|
|
11
11
|
)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
+
# Articles matching the search, in the requested order.
|
|
14
15
|
sig { returns(T::Array[ContextDev::Models::NewsSearchResponse::Data]) }
|
|
15
16
|
attr_accessor :data
|
|
16
17
|
|
|
18
|
+
# True when more results are available beyond this page.
|
|
17
19
|
sig { returns(T::Boolean) }
|
|
18
20
|
attr_accessor :has_more
|
|
19
21
|
|
|
22
|
+
# Summary information about this response.
|
|
20
23
|
sig { returns(ContextDev::Models::NewsSearchResponse::Meta) }
|
|
21
24
|
attr_reader :meta
|
|
22
25
|
|
|
@@ -25,6 +28,8 @@ module ContextDev
|
|
|
25
28
|
end
|
|
26
29
|
attr_writer :meta
|
|
27
30
|
|
|
31
|
+
# Pass as cursor in the next request to fetch the following page. Null when there
|
|
32
|
+
# are no more results.
|
|
28
33
|
sig { returns(T.nilable(String)) }
|
|
29
34
|
attr_accessor :next_cursor
|
|
30
35
|
|
|
@@ -54,9 +59,14 @@ module ContextDev
|
|
|
54
59
|
).returns(T.attached_class)
|
|
55
60
|
end
|
|
56
61
|
def self.new(
|
|
62
|
+
# Articles matching the search, in the requested order.
|
|
57
63
|
data:,
|
|
64
|
+
# True when more results are available beyond this page.
|
|
58
65
|
has_more:,
|
|
66
|
+
# Summary information about this response.
|
|
59
67
|
meta:,
|
|
68
|
+
# Pass as cursor in the next request to fetch the following page. Null when there
|
|
69
|
+
# are no more results.
|
|
60
70
|
next_cursor:,
|
|
61
71
|
# Metadata about the API key used for the request. Included in every response
|
|
62
72
|
# whenever a valid API key is provided, even when the response status is not 200.
|
|
@@ -87,21 +97,29 @@ module ContextDev
|
|
|
87
97
|
)
|
|
88
98
|
end
|
|
89
99
|
|
|
100
|
+
# Stable unique identifier for this article. Use it to deduplicate or reference an
|
|
101
|
+
# article across requests.
|
|
90
102
|
sig { returns(String) }
|
|
91
103
|
attr_accessor :id
|
|
92
104
|
|
|
105
|
+
# Bylined authors. Empty when no byline is available.
|
|
93
106
|
sig { returns(T::Array[String]) }
|
|
94
107
|
attr_accessor :authors
|
|
95
108
|
|
|
109
|
+
# Short summary or excerpt of the article, when the publisher provides one.
|
|
96
110
|
sig { returns(T.nilable(String)) }
|
|
97
111
|
attr_accessor :description
|
|
98
112
|
|
|
113
|
+
# Lead image for the article, when one is available.
|
|
99
114
|
sig { returns(T.nilable(String)) }
|
|
100
115
|
attr_accessor :image_url
|
|
101
116
|
|
|
117
|
+
# Language the article is written in, as a lowercase ISO 639-1 code such as en.
|
|
118
|
+
# Null when unknown.
|
|
102
119
|
sig { returns(T.nilable(String)) }
|
|
103
120
|
attr_accessor :language
|
|
104
121
|
|
|
122
|
+
# How the article relates to the company you searched for.
|
|
105
123
|
sig { returns(ContextDev::Models::NewsSearchResponse::Data::Match) }
|
|
106
124
|
attr_reader :match
|
|
107
125
|
|
|
@@ -112,9 +130,12 @@ module ContextDev
|
|
|
112
130
|
end
|
|
113
131
|
attr_writer :match
|
|
114
132
|
|
|
133
|
+
# When the article was published, as an ISO 8601 timestamp. Null when the
|
|
134
|
+
# publisher does not state a reliable date.
|
|
115
135
|
sig { returns(T.nilable(Time)) }
|
|
116
136
|
attr_accessor :published_at
|
|
117
137
|
|
|
138
|
+
# The publication that published the article.
|
|
118
139
|
sig { returns(ContextDev::Models::NewsSearchResponse::Data::Source) }
|
|
119
140
|
attr_reader :source
|
|
120
141
|
|
|
@@ -125,13 +146,17 @@ module ContextDev
|
|
|
125
146
|
end
|
|
126
147
|
attr_writer :source
|
|
127
148
|
|
|
128
|
-
#
|
|
149
|
+
# Shared by articles covering the same story on the same day. Use it to group or
|
|
150
|
+
# collapse syndicated copies of one announcement across outlets.
|
|
129
151
|
sig { returns(String) }
|
|
130
152
|
attr_accessor :story_id
|
|
131
153
|
|
|
154
|
+
# Article headline.
|
|
132
155
|
sig { returns(String) }
|
|
133
156
|
attr_accessor :title
|
|
134
157
|
|
|
158
|
+
# Kind of coverage. Use it to separate independent reporting (editorial) from
|
|
159
|
+
# company-issued content (press_release, regulatory_filing, advisory).
|
|
135
160
|
sig do
|
|
136
161
|
returns(
|
|
137
162
|
ContextDev::Models::NewsSearchResponse::Data::Type::TaggedSymbol
|
|
@@ -139,6 +164,7 @@ module ContextDev
|
|
|
139
164
|
end
|
|
140
165
|
attr_accessor :type
|
|
141
166
|
|
|
167
|
+
# Link to the article on the publisher site.
|
|
142
168
|
sig { returns(String) }
|
|
143
169
|
attr_accessor :url
|
|
144
170
|
|
|
@@ -160,18 +186,34 @@ module ContextDev
|
|
|
160
186
|
).returns(T.attached_class)
|
|
161
187
|
end
|
|
162
188
|
def self.new(
|
|
189
|
+
# Stable unique identifier for this article. Use it to deduplicate or reference an
|
|
190
|
+
# article across requests.
|
|
163
191
|
id:,
|
|
192
|
+
# Bylined authors. Empty when no byline is available.
|
|
164
193
|
authors:,
|
|
194
|
+
# Short summary or excerpt of the article, when the publisher provides one.
|
|
165
195
|
description:,
|
|
196
|
+
# Lead image for the article, when one is available.
|
|
166
197
|
image_url:,
|
|
198
|
+
# Language the article is written in, as a lowercase ISO 639-1 code such as en.
|
|
199
|
+
# Null when unknown.
|
|
167
200
|
language:,
|
|
201
|
+
# How the article relates to the company you searched for.
|
|
168
202
|
match:,
|
|
203
|
+
# When the article was published, as an ISO 8601 timestamp. Null when the
|
|
204
|
+
# publisher does not state a reliable date.
|
|
169
205
|
published_at:,
|
|
206
|
+
# The publication that published the article.
|
|
170
207
|
source:,
|
|
171
|
-
#
|
|
208
|
+
# Shared by articles covering the same story on the same day. Use it to group or
|
|
209
|
+
# collapse syndicated copies of one announcement across outlets.
|
|
172
210
|
story_id:,
|
|
211
|
+
# Article headline.
|
|
173
212
|
title:,
|
|
213
|
+
# Kind of coverage. Use it to separate independent reporting (editorial) from
|
|
214
|
+
# company-issued content (press_release, regulatory_filing, advisory).
|
|
174
215
|
type:,
|
|
216
|
+
# Link to the article on the publisher site.
|
|
175
217
|
url:
|
|
176
218
|
)
|
|
177
219
|
end
|
|
@@ -207,9 +249,12 @@ module ContextDev
|
|
|
207
249
|
)
|
|
208
250
|
end
|
|
209
251
|
|
|
252
|
+
# How confident the match is, from 0 to 1. Null when a score is unavailable.
|
|
210
253
|
sig { returns(T.nilable(Float)) }
|
|
211
254
|
attr_accessor :confidence
|
|
212
255
|
|
|
256
|
+
# primary when the article is mainly about the company, secondary when the company
|
|
257
|
+
# is mentioned but is not the main subject.
|
|
213
258
|
sig do
|
|
214
259
|
returns(
|
|
215
260
|
ContextDev::Models::NewsSearchResponse::Data::Match::Level::TaggedSymbol
|
|
@@ -217,6 +262,7 @@ module ContextDev
|
|
|
217
262
|
end
|
|
218
263
|
attr_accessor :level
|
|
219
264
|
|
|
265
|
+
# How the article relates to the company you searched for.
|
|
220
266
|
sig do
|
|
221
267
|
params(
|
|
222
268
|
confidence: T.nilable(Float),
|
|
@@ -224,7 +270,13 @@ module ContextDev
|
|
|
224
270
|
ContextDev::Models::NewsSearchResponse::Data::Match::Level::OrSymbol
|
|
225
271
|
).returns(T.attached_class)
|
|
226
272
|
end
|
|
227
|
-
def self.new(
|
|
273
|
+
def self.new(
|
|
274
|
+
# How confident the match is, from 0 to 1. Null when a score is unavailable.
|
|
275
|
+
confidence:,
|
|
276
|
+
# primary when the article is mainly about the company, secondary when the company
|
|
277
|
+
# is mentioned but is not the main subject.
|
|
278
|
+
level:
|
|
279
|
+
)
|
|
228
280
|
end
|
|
229
281
|
|
|
230
282
|
sig do
|
|
@@ -239,6 +291,8 @@ module ContextDev
|
|
|
239
291
|
def to_hash
|
|
240
292
|
end
|
|
241
293
|
|
|
294
|
+
# primary when the article is mainly about the company, secondary when the company
|
|
295
|
+
# is mentioned but is not the main subject.
|
|
242
296
|
module Level
|
|
243
297
|
extend ContextDev::Internal::Type::Enum
|
|
244
298
|
|
|
@@ -287,12 +341,15 @@ module ContextDev
|
|
|
287
341
|
sig { returns(T::Boolean) }
|
|
288
342
|
attr_accessor :direct
|
|
289
343
|
|
|
344
|
+
# Website domain of the publication.
|
|
290
345
|
sig { returns(String) }
|
|
291
346
|
attr_accessor :domain
|
|
292
347
|
|
|
348
|
+
# Name of the publication, such as Reuters.
|
|
293
349
|
sig { returns(String) }
|
|
294
350
|
attr_accessor :name
|
|
295
351
|
|
|
352
|
+
# The publication that published the article.
|
|
296
353
|
sig do
|
|
297
354
|
params(direct: T::Boolean, domain: String, name: String).returns(
|
|
298
355
|
T.attached_class
|
|
@@ -301,7 +358,9 @@ module ContextDev
|
|
|
301
358
|
def self.new(
|
|
302
359
|
# True when Context observed this article in the publisher-owned feed.
|
|
303
360
|
direct:,
|
|
361
|
+
# Website domain of the publication.
|
|
304
362
|
domain:,
|
|
363
|
+
# Name of the publication, such as Reuters.
|
|
305
364
|
name:
|
|
306
365
|
)
|
|
307
366
|
end
|
|
@@ -315,6 +374,8 @@ module ContextDev
|
|
|
315
374
|
end
|
|
316
375
|
end
|
|
317
376
|
|
|
377
|
+
# Kind of coverage. Use it to separate independent reporting (editorial) from
|
|
378
|
+
# company-issued content (press_release, regulatory_filing, advisory).
|
|
318
379
|
module Type
|
|
319
380
|
extend ContextDev::Internal::Type::Enum
|
|
320
381
|
|
|
@@ -366,11 +427,16 @@ module ContextDev
|
|
|
366
427
|
)
|
|
367
428
|
end
|
|
368
429
|
|
|
430
|
+
# Number of articles in this page.
|
|
369
431
|
sig { returns(Integer) }
|
|
370
432
|
attr_accessor :count
|
|
371
433
|
|
|
434
|
+
# Summary information about this response.
|
|
372
435
|
sig { params(count: Integer).returns(T.attached_class) }
|
|
373
|
-
def self.new(
|
|
436
|
+
def self.new(
|
|
437
|
+
# Number of articles in this page.
|
|
438
|
+
count:
|
|
439
|
+
)
|
|
374
440
|
end
|
|
375
441
|
|
|
376
442
|
sig { override.returns({ count: Integer }) }
|