context.dev 1.4.0 → 1.5.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 (51) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +0 -4
  5. data/lib/context_dev/internal/type/base_model.rb +3 -3
  6. data/lib/context_dev/models/brand_identify_from_transaction_params.rb +0 -1
  7. data/lib/context_dev/models/brand_retrieve_by_name_params.rb +5 -5
  8. data/lib/context_dev/models/industry_retrieve_naics_params.rb +4 -4
  9. data/lib/context_dev/models/{style_extract_fonts_params.rb → web_extract_fonts_params.rb} +18 -7
  10. data/lib/context_dev/models/{style_extract_fonts_response.rb → web_extract_fonts_response.rb} +5 -5
  11. data/lib/context_dev/models/{style_extract_styleguide_params.rb → web_extract_styleguide_params.rb} +8 -5
  12. data/lib/context_dev/models/{style_extract_styleguide_response.rb → web_extract_styleguide_response.rb} +147 -80
  13. data/lib/context_dev/models/web_screenshot_params.rb +3 -2
  14. data/lib/context_dev/models/web_web_scrape_html_params.rb +14 -1
  15. data/lib/context_dev/models/web_web_scrape_md_params.rb +13 -3
  16. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +2 -3
  17. data/lib/context_dev/models.rb +4 -4
  18. data/lib/context_dev/resources/brand.rb +8 -12
  19. data/lib/context_dev/resources/industry.rb +3 -3
  20. data/lib/context_dev/resources/web.rb +80 -18
  21. data/lib/context_dev/version.rb +1 -1
  22. data/lib/context_dev.rb +4 -5
  23. data/rbi/context_dev/client.rbi +0 -3
  24. data/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +0 -2
  25. data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +6 -6
  26. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +6 -6
  27. data/rbi/context_dev/models/{style_extract_fonts_params.rbi → web_extract_fonts_params.rbi} +27 -7
  28. data/rbi/context_dev/models/{style_extract_fonts_response.rbi → web_extract_fonts_response.rbi} +6 -9
  29. data/rbi/context_dev/models/{style_extract_styleguide_params.rbi → web_extract_styleguide_params.rbi} +12 -6
  30. data/rbi/context_dev/models/{style_extract_styleguide_response.rbi → web_extract_styleguide_response.rbi} +232 -94
  31. data/rbi/context_dev/models/web_screenshot_params.rbi +6 -4
  32. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +19 -1
  33. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +17 -2
  34. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +2 -4
  35. data/rbi/context_dev/models.rbi +4 -5
  36. data/rbi/context_dev/resources/brand.rbi +9 -14
  37. data/rbi/context_dev/resources/industry.rbi +4 -4
  38. data/rbi/context_dev/resources/web.rbi +74 -17
  39. data/sig/context_dev/client.rbs +0 -2
  40. data/sig/context_dev/models/{style_extract_styleguide_params.rbs → web_extract_fonts_params.rbs} +2 -2
  41. data/sig/context_dev/models/{style_extract_fonts_response.rbs → web_extract_fonts_response.rbs} +6 -6
  42. data/sig/context_dev/models/{style_extract_fonts_params.rbs → web_extract_styleguide_params.rbs} +13 -5
  43. data/sig/context_dev/models/{style_extract_styleguide_response.rbs → web_extract_styleguide_response.rbs} +147 -95
  44. data/sig/context_dev/models/web_web_scrape_html_params.rbs +8 -1
  45. data/sig/context_dev/models/web_web_scrape_md_params.rbs +7 -0
  46. data/sig/context_dev/models.rbs +4 -4
  47. data/sig/context_dev/resources/web.rbs +16 -0
  48. metadata +14 -17
  49. data/lib/context_dev/resources/style.rb +0 -76
  50. data/rbi/context_dev/resources/style.rbi +0 -60
  51. data/sig/context_dev/resources/style.rbs +0 -20
data/lib/context_dev/models/{style_extract_styleguide_response.rb → web_extract_styleguide_response.rb} RENAMED
@@ -2,8 +2,8 @@
2
2
 
3
3
  module ContextDev
4
4
  module Models
5
- # @see ContextDev::Resources::Style#extract_styleguide
6
- class StyleExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel
5
+ # @see ContextDev::Resources::Web#extract_styleguide
6
+ class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel
7
7
  # @!attribute code
8
8
  # HTTP status code
9
9
  #
@@ -25,8 +25,8 @@ module ContextDev
25
25
  # @!attribute styleguide
26
26
  # Comprehensive styleguide data extracted from the website
27
27
  #
28
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide, nil]
29
- optional :styleguide, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide }
28
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil]
29
+ optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }
30
30
 
31
31
  # @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil)
32
32
  # @param code [Integer] HTTP status code
@@ -35,64 +35,79 @@ module ContextDev
35
35
  #
36
36
  # @param status [String] Status of the response, e.g., 'ok'
37
37
  #
38
- # @param styleguide [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
38
+ # @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website
39
39
 
40
- # @see ContextDev::Models::StyleExtractStyleguideResponse#styleguide
40
+ # @see ContextDev::Models::WebExtractStyleguideResponse#styleguide
41
41
  class Styleguide < ContextDev::Internal::Type::BaseModel
42
42
  # @!attribute colors
43
43
  # Primary colors used on the website
44
44
  #
45
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors]
46
- required :colors, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors }
45
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Colors]
46
+ required :colors, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Colors }
47
47
 
48
48
  # @!attribute components
49
49
  # UI component styles
50
50
  #
51
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components]
52
- required :components, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components }
51
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components]
52
+ required :components, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components }
53
53
 
54
54
  # @!attribute element_spacing
55
55
  # Spacing system used on the website
56
56
  #
57
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing]
57
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::ElementSpacing]
58
58
  required :element_spacing,
59
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing },
59
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::ElementSpacing },
60
60
  api_name: :elementSpacing
61
61
 
62
+ # @!attribute font_links
63
+ # Font assets keyed by family name as it appears in fontFamily/fontFallbacks
64
+ # (non-generic names only). Clients match typography.fontFamily / fontWeight or
65
+ # button styles to pick a file URL from files.
66
+ #
67
+ # @return [Hash{Symbol=>ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink}]
68
+ required :font_links,
69
+ -> { ContextDev::Internal::Type::HashOf[ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink] },
70
+ api_name: :fontLinks
71
+
62
72
  # @!attribute mode
63
73
  # The primary color mode of the website design
64
74
  #
65
- # @return [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode]
66
- required :mode, enum: -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode }
75
+ # @return [Symbol, ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Mode]
76
+ required :mode, enum: -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Mode }
67
77
 
68
78
  # @!attribute shadows
69
79
  # Shadow styles used on the website
70
80
  #
71
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows]
72
- required :shadows, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows }
81
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Shadows]
82
+ required :shadows, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Shadows }
73
83
 
74
84
  # @!attribute typography
75
85
  # Typography styles used on the website
76
86
  #
77
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography]
78
- required :typography, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography }
87
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography]
88
+ required :typography, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography }
79
89
 
80
- # @!method initialize(colors:, components:, element_spacing:, mode:, shadows:, typography:)
90
+ # @!method initialize(colors:, components:, element_spacing:, font_links:, mode:, shadows:, typography:)
91
+ # Some parameter documentations has been truncated, see
92
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide} for more details.
93
+ #
81
94
  # Comprehensive styleguide data extracted from the website
82
95
  #
83
- # @param colors [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Colors] Primary colors used on the website
96
+ # @param colors [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Colors] Primary colors used on the website
84
97
  #
85
- # @param components [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components] UI component styles
98
+ # @param components [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components] UI component styles
86
99
  #
87
- # @param element_spacing [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website
100
+ # @param element_spacing [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::ElementSpacing] Spacing system used on the website
88
101
  #
89
- # @param mode [Symbol, ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Mode] The primary color mode of the website design
102
+ # @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink}] Font assets keyed by family name as it appears in fontFamily/fontFallbacks (non-
90
103
  #
91
- # @param shadows [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website
104
+ # @param mode [Symbol, ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Mode] The primary color mode of the website design
92
105
  #
93
- # @param typography [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography] Typography styles used on the website
106
+ # @param shadows [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Shadows] Shadow styles used on the website
107
+ #
108
+ # @param typography [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography] Typography styles used on the website
94
109
 
95
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#colors
110
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#colors
96
111
  class Colors < ContextDev::Internal::Type::BaseModel
97
112
  # @!attribute accent
98
113
  # Accent color (hex format)
@@ -122,56 +137,55 @@ module ContextDev
122
137
  # @param text [String] Text color (hex format)
123
138
  end
124
139
 
125
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#components
140
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#components
126
141
  class Components < ContextDev::Internal::Type::BaseModel
127
142
  # @!attribute button
128
143
  # Button component styles
129
144
  #
130
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button]
131
- required :button,
132
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button }
145
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button]
146
+ required :button, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button }
133
147
 
134
148
  # @!attribute card
135
149
  # Card component style
136
150
  #
137
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card, nil]
138
- optional :card, -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card }
151
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Card, nil]
152
+ optional :card, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Card }
139
153
 
140
154
  # @!method initialize(button:, card: nil)
141
155
  # UI component styles
142
156
  #
143
- # @param button [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button] Button component styles
157
+ # @param button [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button] Button component styles
144
158
  #
145
- # @param card [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card] Card component style
159
+ # @param card [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Card] Card component style
146
160
 
147
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components#button
161
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components#button
148
162
  class Button < ContextDev::Internal::Type::BaseModel
149
163
  # @!attribute link
150
164
  #
151
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link, nil]
165
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Link, nil]
152
166
  optional :link,
153
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link }
167
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Link }
154
168
 
155
169
  # @!attribute primary
156
170
  #
157
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary, nil]
171
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Primary, nil]
158
172
  optional :primary,
159
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary }
173
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Primary }
160
174
 
161
175
  # @!attribute secondary
162
176
  #
163
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary, nil]
177
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Secondary, nil]
164
178
  optional :secondary,
165
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary }
179
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Secondary }
166
180
 
167
181
  # @!method initialize(link: nil, primary: nil, secondary: nil)
168
182
  # Button component styles
169
183
  #
170
- # @param link [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link]
171
- # @param primary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary]
172
- # @param secondary [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary]
184
+ # @param link [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Link]
185
+ # @param primary [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Primary]
186
+ # @param secondary [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Secondary]
173
187
 
174
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#link
188
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button#link
175
189
  class Link < ContextDev::Internal::Type::BaseModel
176
190
  # @!attribute background_color
177
191
  #
@@ -269,7 +283,7 @@ module ContextDev
269
283
 
270
284
  # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
271
285
  # Some parameter documentations has been truncated, see
272
- # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Link}
286
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Link}
273
287
  # for more details.
274
288
  #
275
289
  # @param background_color [String]
@@ -307,7 +321,7 @@ module ContextDev
307
321
  # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
308
322
  end
309
323
 
310
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#primary
324
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button#primary
311
325
  class Primary < ContextDev::Internal::Type::BaseModel
312
326
  # @!attribute background_color
313
327
  #
@@ -405,7 +419,7 @@ module ContextDev
405
419
 
406
420
  # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
407
421
  # Some parameter documentations has been truncated, see
408
- # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Primary}
422
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Primary}
409
423
  # for more details.
410
424
  #
411
425
  # @param background_color [String]
@@ -443,7 +457,7 @@ module ContextDev
443
457
  # @param text_decoration_color [String] Hex color of the underline when it differs from the text color
444
458
  end
445
459
 
446
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button#secondary
460
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button#secondary
447
461
  class Secondary < ContextDev::Internal::Type::BaseModel
448
462
  # @!attribute background_color
449
463
  #
@@ -541,7 +555,7 @@ module ContextDev
541
555
 
542
556
  # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, color:, css:, font_size:, font_weight:, min_height:, min_width:, padding:, text_decoration:, font_fallbacks: nil, font_family: nil, text_decoration_color: nil)
543
557
  # Some parameter documentations has been truncated, see
544
- # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Button::Secondary}
558
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Button::Secondary}
545
559
  # for more details.
546
560
  #
547
561
  # @param background_color [String]
@@ -580,7 +594,7 @@ module ContextDev
580
594
  end
581
595
  end
582
596
 
583
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components#card
597
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components#card
584
598
  class Card < ContextDev::Internal::Type::BaseModel
585
599
  # @!attribute background_color
586
600
  #
@@ -632,7 +646,7 @@ module ContextDev
632
646
 
633
647
  # @!method initialize(background_color:, border_color:, border_radius:, border_style:, border_width:, box_shadow:, css:, padding:, text_color:)
634
648
  # Some parameter documentations has been truncated, see
635
- # {ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Components::Card}
649
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Components::Card}
636
650
  # for more details.
637
651
  #
638
652
  # Card component style
@@ -657,7 +671,7 @@ module ContextDev
657
671
  end
658
672
  end
659
673
 
660
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#element_spacing
674
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#element_spacing
661
675
  class ElementSpacing < ContextDev::Internal::Type::BaseModel
662
676
  # @!attribute lg
663
677
  #
@@ -694,9 +708,62 @@ module ContextDev
694
708
  # @param xs [String]
695
709
  end
696
710
 
711
+ class FontLink < ContextDev::Internal::Type::BaseModel
712
+ # @!attribute files
713
+ # Upright font files keyed by weight string (e.g. "400" for regular, "500",
714
+ # "700"). Values are absolute URLs.
715
+ #
716
+ # @return [Hash{Symbol=>String}]
717
+ required :files, ContextDev::Internal::Type::HashOf[String]
718
+
719
+ # @!attribute type
720
+ #
721
+ # @return [Symbol, ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink::Type]
722
+ required :type, enum: -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink::Type }
723
+
724
+ # @!attribute category
725
+ # Google Fonts category when type is google (e.g. sans-serif, serif, monospace,
726
+ # display, handwriting). Omitted for custom fonts when unknown.
727
+ #
728
+ # @return [String, nil]
729
+ optional :category, String
730
+
731
+ # @!attribute display_name
732
+ # Present when type is custom: human-readable name derived from the fontLinks key
733
+ # (strip build/hash suffixes, split camelCase / PascalCase, normalize separators).
734
+ # Google entries omit this.
735
+ #
736
+ # @return [String, nil]
737
+ optional :display_name, String, api_name: :displayName
738
+
739
+ # @!method initialize(files:, type:, category: nil, display_name: nil)
740
+ # Some parameter documentations has been truncated, see
741
+ # {ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink} for
742
+ # more details.
743
+ #
744
+ # @param files [Hash{Symbol=>String}] Upright font files keyed by weight string (e.g. "400" for regular, "500", "700")
745
+ #
746
+ # @param type [Symbol, ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink::Type]
747
+ #
748
+ # @param category [String] Google Fonts category when type is google (e.g. sans-serif, serif, monospace, di
749
+ #
750
+ # @param display_name [String] Present when type is custom: human-readable name derived from the fontLinks key
751
+
752
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::FontLink#type
753
+ module Type
754
+ extend ContextDev::Internal::Type::Enum
755
+
756
+ GOOGLE = :google
757
+ CUSTOM = :custom
758
+
759
+ # @!method self.values
760
+ # @return [Array<Symbol>]
761
+ end
762
+ end
763
+
697
764
  # The primary color mode of the website design
698
765
  #
699
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#mode
766
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#mode
700
767
  module Mode
701
768
  extend ContextDev::Internal::Type::Enum
702
769
 
@@ -707,7 +774,7 @@ module ContextDev
707
774
  # @return [Array<Symbol>]
708
775
  end
709
776
 
710
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#shadows
777
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#shadows
711
778
  class Shadows < ContextDev::Internal::Type::BaseModel
712
779
  # @!attribute inner
713
780
  #
@@ -744,64 +811,64 @@ module ContextDev
744
811
  # @param xl [String]
745
812
  end
746
813
 
747
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide#typography
814
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide#typography
748
815
  class Typography < ContextDev::Internal::Type::BaseModel
749
816
  # @!attribute headings
750
817
  # Heading styles
751
818
  #
752
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings]
819
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings]
753
820
  required :headings,
754
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings }
821
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings }
755
822
 
756
823
  # @!attribute p_
757
824
  #
758
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P, nil]
825
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::P, nil]
759
826
  optional :p_,
760
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P },
827
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::P },
761
828
  api_name: :p
762
829
 
763
830
  # @!method initialize(headings:, p_: nil)
764
831
  # Typography styles used on the website
765
832
  #
766
- # @param headings [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings] Heading styles
833
+ # @param headings [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings] Heading styles
767
834
  #
768
- # @param p_ [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::P]
835
+ # @param p_ [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::P]
769
836
 
770
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#headings
837
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography#headings
771
838
  class Headings < ContextDev::Internal::Type::BaseModel
772
839
  # @!attribute h1
773
840
  #
774
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1, nil]
841
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H1, nil]
775
842
  optional :h1,
776
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1 }
843
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H1 }
777
844
 
778
845
  # @!attribute h2
779
846
  #
780
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2, nil]
847
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H2, nil]
781
848
  optional :h2,
782
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2 }
849
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H2 }
783
850
 
784
851
  # @!attribute h3
785
852
  #
786
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3, nil]
853
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H3, nil]
787
854
  optional :h3,
788
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3 }
855
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H3 }
789
856
 
790
857
  # @!attribute h4
791
858
  #
792
- # @return [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4, nil]
859
+ # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H4, nil]
793
860
  optional :h4,
794
- -> { ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4 }
861
+ -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H4 }
795
862
 
796
863
  # @!method initialize(h1: nil, h2: nil, h3: nil, h4: nil)
797
864
  # Heading styles
798
865
  #
799
- # @param h1 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H1]
800
- # @param h2 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H2]
801
- # @param h3 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H3]
802
- # @param h4 [ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings::H4]
866
+ # @param h1 [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H1]
867
+ # @param h2 [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H2]
868
+ # @param h3 [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H3]
869
+ # @param h4 [ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings::H4]
803
870
 
804
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h1
871
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings#h1
805
872
  class H1 < ContextDev::Internal::Type::BaseModel
806
873
  # @!attribute font_fallbacks
807
874
  # Full ordered font list from resolved computed font-family
@@ -849,7 +916,7 @@ module ContextDev
849
916
  # @param line_height [String]
850
917
  end
851
918
 
852
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h2
919
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings#h2
853
920
  class H2 < ContextDev::Internal::Type::BaseModel
854
921
  # @!attribute font_fallbacks
855
922
  # Full ordered font list from resolved computed font-family
@@ -897,7 +964,7 @@ module ContextDev
897
964
  # @param line_height [String]
898
965
  end
899
966
 
900
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h3
967
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings#h3
901
968
  class H3 < ContextDev::Internal::Type::BaseModel
902
969
  # @!attribute font_fallbacks
903
970
  # Full ordered font list from resolved computed font-family
@@ -945,7 +1012,7 @@ module ContextDev
945
1012
  # @param line_height [String]
946
1013
  end
947
1014
 
948
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography::Headings#h4
1015
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography::Headings#h4
949
1016
  class H4 < ContextDev::Internal::Type::BaseModel
950
1017
  # @!attribute font_fallbacks
951
1018
  # Full ordered font list from resolved computed font-family
@@ -994,7 +1061,7 @@ module ContextDev
994
1061
  end
995
1062
  end
996
1063
 
997
- # @see ContextDev::Models::StyleExtractStyleguideResponse::Styleguide::Typography#p_
1064
+ # @see ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Typography#p_
998
1065
  class P < ContextDev::Internal::Type::BaseModel
999
1066
  # @!attribute font_fallbacks
1000
1067
  # Full ordered font list from resolved computed font-family
data/lib/context_dev/models/web_screenshot_params.rb CHANGED
@@ -10,14 +10,15 @@ module ContextDev
10
10
  # @!attribute direct_url
11
11
  # A specific URL to screenshot directly, bypassing domain resolution (e.g.,
12
12
  # 'https://example.com/pricing'). When provided, the screenshot is taken of this
13
- # exact URL.
13
+ # exact URL. You must provide either 'domain' or 'directUrl', but not both.
14
14
  #
15
15
  # @return [String, nil]
16
16
  optional :direct_url, String
17
17
 
18
18
  # @!attribute domain
19
19
  # Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The
20
- # domain will be automatically normalized and validated.
20
+ # domain will be automatically normalized and validated. You must provide either
21
+ # 'domain' or 'directUrl', but not both.
21
22
  #
22
23
  # @return [String, nil]
23
24
  optional :domain, String
data/lib/context_dev/models/web_web_scrape_html_params.rb CHANGED
@@ -13,9 +13,22 @@ module ContextDev
13
13
  # @return [String]
14
14
  required :url, String
15
15
 
16
- # @!method initialize(url:, request_options: {})
16
+ # @!attribute max_age_ms
17
+ # Return a cached result if a prior scrape for the same parameters exists and is
18
+ # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
19
+ # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :max_age_ms, Integer
23
+
24
+ # @!method initialize(url:, max_age_ms: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
27
+ #
17
28
  # @param url [String] Full URL to scrape (must include http:// or https:// protocol)
18
29
  #
30
+ # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
31
+ #
19
32
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
20
33
  end
21
34
  end
data/lib/context_dev/models/web_web_scrape_md_params.rb CHANGED
@@ -8,7 +8,7 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute url
11
- # Full URL to scrape and convert to markdown (must include http:// or https://
11
+ # Full URL to scrape into LLM usable Markdown (must include http:// or https://
12
12
  # protocol)
13
13
  #
14
14
  # @return [String]
@@ -26,6 +26,14 @@ module ContextDev
26
26
  # @return [Boolean, nil]
27
27
  optional :include_links, ContextDev::Internal::Type::Boolean
28
28
 
29
+ # @!attribute max_age_ms
30
+ # Return a cached result if a prior scrape for the same parameters exists and is
31
+ # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
32
+ # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
33
+ #
34
+ # @return [Integer, nil]
35
+ optional :max_age_ms, Integer
36
+
29
37
  # @!attribute shorten_base64_images
30
38
  # Shorten base64-encoded image data in the Markdown output
31
39
  #
@@ -39,16 +47,18 @@ module ContextDev
39
47
  # @return [Boolean, nil]
40
48
  optional :use_main_content_only, ContextDev::Internal::Type::Boolean
41
49
 
42
- # @!method initialize(url:, include_images: nil, include_links: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {})
50
+ # @!method initialize(url:, include_images: nil, include_links: nil, max_age_ms: nil, shorten_base64_images: nil, use_main_content_only: nil, request_options: {})
43
51
  # Some parameter documentations has been truncated, see
44
52
  # {ContextDev::Models::WebWebScrapeMdParams} for more details.
45
53
  #
46
- # @param url [String] Full URL to scrape and convert to markdown (must include http:// or https:// pro
54
+ # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr
47
55
  #
48
56
  # @param include_images [Boolean] Include image references in Markdown output
49
57
  #
50
58
  # @param include_links [Boolean] Preserve hyperlinks in Markdown output
51
59
  #
60
+ # @param max_age_ms [Integer] Return a cached result if a prior scrape for the same parameters exists and is y
61
+ #
52
62
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
53
63
  #
54
64
  # @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
data/lib/context_dev/models/web_web_scrape_sitemap_params.rb CHANGED
@@ -8,8 +8,7 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute domain
11
- # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
12
- # automatically normalized and validated.
11
+ # Domain to build a sitemap for
13
12
  #
14
13
  # @return [String]
15
14
  required :domain, String
@@ -25,7 +24,7 @@ module ContextDev
25
24
  # Some parameter documentations has been truncated, see
26
25
  # {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
27
26
  #
28
- # @param domain [String] Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be auto
27
+ # @param domain [String] Domain to build a sitemap for
29
28
  #
30
29
  # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
31
30
  #
data/lib/context_dev/models.rb CHANGED
@@ -61,14 +61,14 @@ module ContextDev
61
61
 
62
62
  IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
63
63
 
64
- StyleExtractFontsParams = ContextDev::Models::StyleExtractFontsParams
65
-
66
- StyleExtractStyleguideParams = ContextDev::Models::StyleExtractStyleguideParams
67
-
68
64
  UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams
69
65
 
70
66
  UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
71
67
 
68
+ WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
69
+
70
+ WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams
71
+
72
72
  WebScreenshotParams = ContextDev::Models::WebScreenshotParams
73
73
 
74
74
  WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams