context.dev 2.9.0 → 2.11.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 (80) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +5 -0
  5. data/lib/context_dev/models/batch_get_results_response.rb +33 -3
  6. data/lib/context_dev/models/batch_submit_params.rb +44 -316
  7. data/lib/context_dev/models/brand_retrieve_response.rb +29 -1
  8. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +30 -1
  9. data/lib/context_dev/models/brand_search_params.rb +41 -3
  10. data/lib/context_dev/models/news_search_params.rb +467 -0
  11. data/lib/context_dev/models/news_search_response.rb +284 -0
  12. data/lib/context_dev/models/parse_handle_params.rb +15 -144
  13. data/lib/context_dev/models/person_enrich_response.rb +61 -1
  14. data/lib/context_dev/models/utility_prefetch_params.rb +19 -16
  15. data/lib/context_dev/models/utility_prefetch_response.rb +4 -5
  16. data/lib/context_dev/models/web_screenshot_params.rb +16 -31
  17. data/lib/context_dev/models/web_web_crawl_md_response.rb +30 -1
  18. data/lib/context_dev/models/web_web_scrape_html_params.rb +15 -153
  19. data/lib/context_dev/models/web_web_scrape_html_response.rb +30 -1
  20. data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -124
  21. data/lib/context_dev/models/web_web_scrape_md_params.rb +35 -238
  22. data/lib/context_dev/models/web_web_scrape_md_response.rb +41 -2
  23. data/lib/context_dev/models.rb +2 -0
  24. data/lib/context_dev/resources/brand.rb +10 -11
  25. data/lib/context_dev/resources/news.rb +51 -0
  26. data/lib/context_dev/resources/parse.rb +5 -5
  27. data/lib/context_dev/resources/utility.rb +7 -6
  28. data/lib/context_dev/resources/web.rb +30 -24
  29. data/lib/context_dev/version.rb +1 -1
  30. data/lib/context_dev.rb +3 -0
  31. data/rbi/context_dev/client.rbi +4 -0
  32. data/rbi/context_dev/models/batch_get_results_response.rbi +71 -2
  33. data/rbi/context_dev/models/batch_submit_params.rbi +58 -592
  34. data/rbi/context_dev/models/brand_retrieve_response.rbi +80 -3
  35. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +80 -3
  36. data/rbi/context_dev/models/brand_search_params.rbi +71 -2
  37. data/rbi/context_dev/models/news_search_params.rbi +1294 -0
  38. data/rbi/context_dev/models/news_search_response.rbi +489 -0
  39. data/rbi/context_dev/models/parse_handle_params.rbi +20 -316
  40. data/rbi/context_dev/models/person_enrich_response.rbi +87 -0
  41. data/rbi/context_dev/models/utility_prefetch_params.rbi +24 -16
  42. data/rbi/context_dev/models/utility_prefetch_response.rbi +8 -6
  43. data/rbi/context_dev/models/web_screenshot_params.rbi +23 -71
  44. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +67 -0
  45. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +20 -356
  46. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +65 -0
  47. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +16 -287
  48. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +47 -551
  49. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +80 -0
  50. data/rbi/context_dev/models.rbi +2 -0
  51. data/rbi/context_dev/resources/brand.rbi +14 -9
  52. data/rbi/context_dev/resources/news.rbi +46 -0
  53. data/rbi/context_dev/resources/parse.rbi +5 -21
  54. data/rbi/context_dev/resources/utility.rbi +8 -6
  55. data/rbi/context_dev/resources/web.rbi +34 -66
  56. data/sig/context_dev/client.rbs +2 -0
  57. data/sig/context_dev/models/batch_get_results_response.rbs +21 -0
  58. data/sig/context_dev/models/batch_submit_params.rbs +54 -144
  59. data/sig/context_dev/models/brand_retrieve_response.rbs +33 -3
  60. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +33 -3
  61. data/sig/context_dev/models/brand_search_params.rbs +38 -1
  62. data/sig/context_dev/models/news_search_params.rbs +532 -0
  63. data/sig/context_dev/models/news_search_response.rbs +206 -0
  64. data/sig/context_dev/models/parse_handle_params.rbs +25 -90
  65. data/sig/context_dev/models/person_enrich_response.rbs +31 -0
  66. data/sig/context_dev/models/utility_prefetch_params.rbs +2 -1
  67. data/sig/context_dev/models/utility_prefetch_response.rbs +2 -1
  68. data/sig/context_dev/models/web_screenshot_params.rbs +12 -18
  69. data/sig/context_dev/models/web_web_crawl_md_response.rbs +21 -0
  70. data/sig/context_dev/models/web_web_scrape_html_params.rbs +24 -94
  71. data/sig/context_dev/models/web_web_scrape_html_response.rbs +21 -0
  72. data/sig/context_dev/models/web_web_scrape_images_params.rbs +20 -72
  73. data/sig/context_dev/models/web_web_scrape_md_params.rbs +46 -148
  74. data/sig/context_dev/models/web_web_scrape_md_response.rbs +28 -0
  75. data/sig/context_dev/models.rbs +2 -0
  76. data/sig/context_dev/resources/brand.rbs +3 -0
  77. data/sig/context_dev/resources/news.rbs +17 -0
  78. data/sig/context_dev/resources/parse.rbs +5 -5
  79. data/sig/context_dev/resources/web.rbs +13 -11
  80. metadata +11 -2
@@ -767,18 +767,95 @@ module ContextDev
767
767
  sig { params(name: String).void }
768
768
  attr_writer :name
769
769
 
770
- sig { params(hex: String, name: String).returns(T.attached_class) }
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 { override.returns({ hex: String, name: String }) }
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
- sig { params(hex: String, name: String).returns(T.attached_class) }
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 { override.returns({ hex: String, name: String }) }
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
@@ -11,11 +11,35 @@ module ContextDev
11
11
  T.any(ContextDev::BrandSearchParams, ContextDev::Internal::AnyHash)
12
12
  end
13
13
 
14
- # Search term, matched against brand names and domains by prefix (e.g. 'nike',
14
+ # Search term, matched against the fields selected by queryBy (e.g. 'nike',
15
15
  # 'nike.com', 'nik').
16
16
  sig { returns(String) }
17
17
  attr_accessor :query
18
18
 
19
+ # Whether the search term matches by prefix, so partial words match as they are
20
+ # typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
21
+ sig { returns(T.nilable(T::Boolean)) }
22
+ attr_reader :autocomplete
23
+
24
+ sig { params(autocomplete: T::Boolean).void }
25
+ attr_writer :autocomplete
26
+
27
+ # Fields to match the search term against, as a comma-separated list or repeated
28
+ # parameter: 'name', 'domain', or both. Defaults to both.
29
+ sig do
30
+ returns(
31
+ T.nilable(T::Array[ContextDev::BrandSearchParams::QueryBy::OrSymbol])
32
+ )
33
+ end
34
+ attr_reader :query_by
35
+
36
+ sig do
37
+ params(
38
+ query_by: T::Array[ContextDev::BrandSearchParams::QueryBy::OrSymbol]
39
+ ).void
40
+ end
41
+ attr_writer :query_by
42
+
19
43
  # Optional comma-separated caller-defined tags for tracking this request. Tags are
20
44
  # recorded on the request's usage log and can be used to filter usage on the
21
45
  # dashboard usage page. Up to 20 tags, each 1-50 characters.
@@ -25,21 +49,41 @@ module ContextDev
25
49
  sig { params(tags: T::Array[String]).void }
26
50
  attr_writer :tags
27
51
 
52
+ # Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
53
+ # typo tolerance).
54
+ sig { returns(T.nilable(Integer)) }
55
+ attr_reader :typo_tolerance
56
+
57
+ sig { params(typo_tolerance: Integer).void }
58
+ attr_writer :typo_tolerance
59
+
28
60
  sig do
29
61
  params(
30
62
  query: String,
63
+ autocomplete: T::Boolean,
64
+ query_by: T::Array[ContextDev::BrandSearchParams::QueryBy::OrSymbol],
31
65
  tags: T::Array[String],
66
+ typo_tolerance: Integer,
32
67
  request_options: ContextDev::RequestOptions::OrHash
33
68
  ).returns(T.attached_class)
34
69
  end
35
70
  def self.new(
36
- # Search term, matched against brand names and domains by prefix (e.g. 'nike',
71
+ # Search term, matched against the fields selected by queryBy (e.g. 'nike',
37
72
  # 'nike.com', 'nik').
38
73
  query:,
74
+ # Whether the search term matches by prefix, so partial words match as they are
75
+ # typed (e.g. 'nik' matches Nike). Set to false to match whole words only.
76
+ autocomplete: nil,
77
+ # Fields to match the search term against, as a comma-separated list or repeated
78
+ # parameter: 'name', 'domain', or both. Defaults to both.
79
+ query_by: nil,
39
80
  # Optional comma-separated caller-defined tags for tracking this request. Tags are
40
81
  # recorded on the request's usage log and can be used to filter usage on the
41
82
  # dashboard usage page. Up to 20 tags, each 1-50 characters.
42
83
  tags: nil,
84
+ # Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
85
+ # typo tolerance).
86
+ typo_tolerance: nil,
43
87
  request_options: {}
44
88
  )
45
89
  end
@@ -48,13 +92,38 @@ module ContextDev
48
92
  override.returns(
49
93
  {
50
94
  query: String,
95
+ autocomplete: T::Boolean,
96
+ query_by:
97
+ T::Array[ContextDev::BrandSearchParams::QueryBy::OrSymbol],
51
98
  tags: T::Array[String],
99
+ typo_tolerance: Integer,
52
100
  request_options: ContextDev::RequestOptions
53
101
  }
54
102
  )
55
103
  end
56
104
  def to_hash
57
105
  end
106
+
107
+ module QueryBy
108
+ extend ContextDev::Internal::Type::Enum
109
+
110
+ TaggedSymbol =
111
+ T.type_alias { T.all(Symbol, ContextDev::BrandSearchParams::QueryBy) }
112
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
113
+
114
+ NAME =
115
+ T.let(:name, ContextDev::BrandSearchParams::QueryBy::TaggedSymbol)
116
+ DOMAIN =
117
+ T.let(:domain, ContextDev::BrandSearchParams::QueryBy::TaggedSymbol)
118
+
119
+ sig do
120
+ override.returns(
121
+ T::Array[ContextDev::BrandSearchParams::QueryBy::TaggedSymbol]
122
+ )
123
+ end
124
+ def self.values
125
+ end
126
+ end
58
127
  end
59
128
  end
60
129
  end