context.dev 0.0.2

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 (194) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +10 -0
  4. data/README.md +244 -0
  5. data/SECURITY.md +27 -0
  6. data/lib/context_dev/client.rb +74 -0
  7. data/lib/context_dev/errors.rb +228 -0
  8. data/lib/context_dev/file_part.rb +58 -0
  9. data/lib/context_dev/internal/transport/base_client.rb +573 -0
  10. data/lib/context_dev/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/context_dev/internal/type/array_of.rb +168 -0
  12. data/lib/context_dev/internal/type/base_model.rb +531 -0
  13. data/lib/context_dev/internal/type/base_page.rb +55 -0
  14. data/lib/context_dev/internal/type/boolean.rb +77 -0
  15. data/lib/context_dev/internal/type/converter.rb +327 -0
  16. data/lib/context_dev/internal/type/enum.rb +131 -0
  17. data/lib/context_dev/internal/type/file_input.rb +111 -0
  18. data/lib/context_dev/internal/type/hash_of.rb +188 -0
  19. data/lib/context_dev/internal/type/request_parameters.rb +42 -0
  20. data/lib/context_dev/internal/type/union.rb +237 -0
  21. data/lib/context_dev/internal/type/unknown.rb +81 -0
  22. data/lib/context_dev/internal/util.rb +951 -0
  23. data/lib/context_dev/internal.rb +20 -0
  24. data/lib/context_dev/models/brand_ai_product_params.rb +34 -0
  25. data/lib/context_dev/models/brand_ai_product_response.rb +193 -0
  26. data/lib/context_dev/models/brand_ai_products_params.rb +94 -0
  27. data/lib/context_dev/models/brand_ai_products_response.rb +160 -0
  28. data/lib/context_dev/models/brand_ai_query_params.rb +236 -0
  29. data/lib/context_dev/models/brand_ai_query_response.rb +98 -0
  30. data/lib/context_dev/models/brand_fonts_params.rb +36 -0
  31. data/lib/context_dev/models/brand_fonts_response.rb +100 -0
  32. data/lib/context_dev/models/brand_identify_from_transaction_params.rb +407 -0
  33. data/lib/context_dev/models/brand_identify_from_transaction_response.rb +854 -0
  34. data/lib/context_dev/models/brand_prefetch_by_email_params.rb +37 -0
  35. data/lib/context_dev/models/brand_prefetch_by_email_response.rb +33 -0
  36. data/lib/context_dev/models/brand_prefetch_params.rb +35 -0
  37. data/lib/context_dev/models/brand_prefetch_response.rb +33 -0
  38. data/lib/context_dev/models/brand_retrieve_by_email_params.rb +116 -0
  39. data/lib/context_dev/models/brand_retrieve_by_email_response.rb +851 -0
  40. data/lib/context_dev/models/brand_retrieve_by_isin_params.rb +116 -0
  41. data/lib/context_dev/models/brand_retrieve_by_isin_response.rb +850 -0
  42. data/lib/context_dev/models/brand_retrieve_by_name_params.rb +115 -0
  43. data/lib/context_dev/models/brand_retrieve_by_name_response.rb +850 -0
  44. data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb +204 -0
  45. data/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +852 -0
  46. data/lib/context_dev/models/brand_retrieve_naics_params.rb +54 -0
  47. data/lib/context_dev/models/brand_retrieve_naics_response.rb +83 -0
  48. data/lib/context_dev/models/brand_retrieve_params.rb +117 -0
  49. data/lib/context_dev/models/brand_retrieve_response.rb +850 -0
  50. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +35 -0
  51. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +307 -0
  52. data/lib/context_dev/models/brand_screenshot_params.rb +103 -0
  53. data/lib/context_dev/models/brand_screenshot_response.rb +64 -0
  54. data/lib/context_dev/models/brand_styleguide_params.rb +70 -0
  55. data/lib/context_dev/models/brand_styleguide_response.rb +790 -0
  56. data/lib/context_dev/models/brand_web_scrape_html_params.rb +22 -0
  57. data/lib/context_dev/models/brand_web_scrape_html_response.rb +45 -0
  58. data/lib/context_dev/models/brand_web_scrape_images_params.rb +22 -0
  59. data/lib/context_dev/models/brand_web_scrape_images_response.rb +111 -0
  60. data/lib/context_dev/models/brand_web_scrape_md_params.rb +50 -0
  61. data/lib/context_dev/models/brand_web_scrape_md_response.rb +45 -0
  62. data/lib/context_dev/models/brand_web_scrape_sitemap_params.rb +26 -0
  63. data/lib/context_dev/models/brand_web_scrape_sitemap_response.rb +91 -0
  64. data/lib/context_dev/models.rb +81 -0
  65. data/lib/context_dev/request_options.rb +77 -0
  66. data/lib/context_dev/resources/brand.rb +654 -0
  67. data/lib/context_dev/version.rb +5 -0
  68. data/lib/context_dev.rb +96 -0
  69. data/manifest.yaml +17 -0
  70. data/rbi/context_dev/client.rbi +49 -0
  71. data/rbi/context_dev/errors.rbi +205 -0
  72. data/rbi/context_dev/file_part.rbi +37 -0
  73. data/rbi/context_dev/internal/transport/base_client.rbi +300 -0
  74. data/rbi/context_dev/internal/transport/pooled_net_requester.rbi +84 -0
  75. data/rbi/context_dev/internal/type/array_of.rbi +104 -0
  76. data/rbi/context_dev/internal/type/base_model.rbi +308 -0
  77. data/rbi/context_dev/internal/type/base_page.rbi +42 -0
  78. data/rbi/context_dev/internal/type/boolean.rbi +58 -0
  79. data/rbi/context_dev/internal/type/converter.rbi +216 -0
  80. data/rbi/context_dev/internal/type/enum.rbi +82 -0
  81. data/rbi/context_dev/internal/type/file_input.rbi +59 -0
  82. data/rbi/context_dev/internal/type/hash_of.rbi +104 -0
  83. data/rbi/context_dev/internal/type/request_parameters.rbi +29 -0
  84. data/rbi/context_dev/internal/type/union.rbi +128 -0
  85. data/rbi/context_dev/internal/type/unknown.rbi +58 -0
  86. data/rbi/context_dev/internal/util.rbi +507 -0
  87. data/rbi/context_dev/internal.rbi +18 -0
  88. data/rbi/context_dev/models/brand_ai_product_params.rbi +56 -0
  89. data/rbi/context_dev/models/brand_ai_product_response.rbi +380 -0
  90. data/rbi/context_dev/models/brand_ai_products_params.rbi +188 -0
  91. data/rbi/context_dev/models/brand_ai_products_response.rbi +310 -0
  92. data/rbi/context_dev/models/brand_ai_query_params.rbi +504 -0
  93. data/rbi/context_dev/models/brand_ai_query_response.rbi +205 -0
  94. data/rbi/context_dev/models/brand_fonts_params.rbi +60 -0
  95. data/rbi/context_dev/models/brand_fonts_response.rbi +147 -0
  96. data/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +1682 -0
  97. data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +2595 -0
  98. data/rbi/context_dev/models/brand_prefetch_by_email_params.rbi +65 -0
  99. data/rbi/context_dev/models/brand_prefetch_by_email_response.rbi +57 -0
  100. data/rbi/context_dev/models/brand_prefetch_params.rbi +58 -0
  101. data/rbi/context_dev/models/brand_prefetch_response.rbi +57 -0
  102. data/rbi/context_dev/models/brand_retrieve_by_email_params.rbi +386 -0
  103. data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +2591 -0
  104. data/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi +386 -0
  105. data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +2590 -0
  106. data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +384 -0
  107. data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +2590 -0
  108. data/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi +796 -0
  109. data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +2592 -0
  110. data/rbi/context_dev/models/brand_retrieve_naics_params.rbi +89 -0
  111. data/rbi/context_dev/models/brand_retrieve_naics_response.rbi +190 -0
  112. data/rbi/context_dev/models/brand_retrieve_params.rbi +382 -0
  113. data/rbi/context_dev/models/brand_retrieve_response.rbi +2574 -0
  114. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +61 -0
  115. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +763 -0
  116. data/rbi/context_dev/models/brand_screenshot_params.rbi +225 -0
  117. data/rbi/context_dev/models/brand_screenshot_response.rbi +135 -0
  118. data/rbi/context_dev/models/brand_styleguide_params.rbi +139 -0
  119. data/rbi/context_dev/models/brand_styleguide_response.rbi +1707 -0
  120. data/rbi/context_dev/models/brand_web_scrape_html_params.rbi +43 -0
  121. data/rbi/context_dev/models/brand_web_scrape_html_response.rbi +92 -0
  122. data/rbi/context_dev/models/brand_web_scrape_images_params.rbi +43 -0
  123. data/rbi/context_dev/models/brand_web_scrape_images_response.rbi +261 -0
  124. data/rbi/context_dev/models/brand_web_scrape_md_params.rbi +81 -0
  125. data/rbi/context_dev/models/brand_web_scrape_md_response.rbi +92 -0
  126. data/rbi/context_dev/models/brand_web_scrape_sitemap_params.rbi +45 -0
  127. data/rbi/context_dev/models/brand_web_scrape_sitemap_response.rbi +167 -0
  128. data/rbi/context_dev/models.rbi +45 -0
  129. data/rbi/context_dev/request_options.rbi +59 -0
  130. data/rbi/context_dev/resources/brand.rbi +545 -0
  131. data/rbi/context_dev/version.rbi +5 -0
  132. data/sig/context_dev/client.rbs +26 -0
  133. data/sig/context_dev/errors.rbs +117 -0
  134. data/sig/context_dev/file_part.rbs +21 -0
  135. data/sig/context_dev/internal/transport/base_client.rbs +133 -0
  136. data/sig/context_dev/internal/transport/pooled_net_requester.rbs +48 -0
  137. data/sig/context_dev/internal/type/array_of.rbs +48 -0
  138. data/sig/context_dev/internal/type/base_model.rbs +102 -0
  139. data/sig/context_dev/internal/type/base_page.rbs +24 -0
  140. data/sig/context_dev/internal/type/boolean.rbs +26 -0
  141. data/sig/context_dev/internal/type/converter.rbs +79 -0
  142. data/sig/context_dev/internal/type/enum.rbs +32 -0
  143. data/sig/context_dev/internal/type/file_input.rbs +25 -0
  144. data/sig/context_dev/internal/type/hash_of.rbs +48 -0
  145. data/sig/context_dev/internal/type/request_parameters.rbs +19 -0
  146. data/sig/context_dev/internal/type/union.rbs +52 -0
  147. data/sig/context_dev/internal/type/unknown.rbs +26 -0
  148. data/sig/context_dev/internal/util.rbs +195 -0
  149. data/sig/context_dev/internal.rbs +9 -0
  150. data/sig/context_dev/models/brand_ai_product_params.rbs +30 -0
  151. data/sig/context_dev/models/brand_ai_product_response.rbs +149 -0
  152. data/sig/context_dev/models/brand_ai_products_params.rbs +88 -0
  153. data/sig/context_dev/models/brand_ai_products_response.rbs +128 -0
  154. data/sig/context_dev/models/brand_ai_query_params.rbs +218 -0
  155. data/sig/context_dev/models/brand_ai_query_response.rbs +93 -0
  156. data/sig/context_dev/models/brand_fonts_params.rbs +30 -0
  157. data/sig/context_dev/models/brand_fonts_response.rbs +82 -0
  158. data/sig/context_dev/models/brand_identify_from_transaction_params.rbs +686 -0
  159. data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +1076 -0
  160. data/sig/context_dev/models/brand_prefetch_by_email_params.rbs +30 -0
  161. data/sig/context_dev/models/brand_prefetch_by_email_response.rbs +28 -0
  162. data/sig/context_dev/models/brand_prefetch_params.rbs +30 -0
  163. data/sig/context_dev/models/brand_prefetch_response.rbs +28 -0
  164. data/sig/context_dev/models/brand_retrieve_by_email_params.rbs +162 -0
  165. data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +1076 -0
  166. data/sig/context_dev/models/brand_retrieve_by_isin_params.rbs +162 -0
  167. data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +1076 -0
  168. data/sig/context_dev/models/brand_retrieve_by_name_params.rbs +162 -0
  169. data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +1076 -0
  170. data/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs +324 -0
  171. data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +1076 -0
  172. data/sig/context_dev/models/brand_retrieve_naics_params.rbs +47 -0
  173. data/sig/context_dev/models/brand_retrieve_naics_response.rbs +84 -0
  174. data/sig/context_dev/models/brand_retrieve_params.rbs +162 -0
  175. data/sig/context_dev/models/brand_retrieve_response.rbs +1076 -0
  176. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +30 -0
  177. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +312 -0
  178. data/sig/context_dev/models/brand_screenshot_params.rbs +100 -0
  179. data/sig/context_dev/models/brand_screenshot_response.rbs +63 -0
  180. data/sig/context_dev/models/brand_styleguide_params.rbs +62 -0
  181. data/sig/context_dev/models/brand_styleguide_response.rbs +945 -0
  182. data/sig/context_dev/models/brand_web_scrape_html_params.rbs +23 -0
  183. data/sig/context_dev/models/brand_web_scrape_html_response.rbs +40 -0
  184. data/sig/context_dev/models/brand_web_scrape_images_params.rbs +23 -0
  185. data/sig/context_dev/models/brand_web_scrape_images_response.rbs +98 -0
  186. data/sig/context_dev/models/brand_web_scrape_md_params.rbs +47 -0
  187. data/sig/context_dev/models/brand_web_scrape_md_response.rbs +40 -0
  188. data/sig/context_dev/models/brand_web_scrape_sitemap_params.rbs +23 -0
  189. data/sig/context_dev/models/brand_web_scrape_sitemap_response.rbs +77 -0
  190. data/sig/context_dev/models.rbs +41 -0
  191. data/sig/context_dev/request_options.rbs +36 -0
  192. data/sig/context_dev/resources/brand.rbs +151 -0
  193. data/sig/context_dev/version.rbs +3 -0
  194. metadata +265 -0
@@ -0,0 +1,43 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel
6
+ extend ContextDev::Internal::Type::RequestParameters::Converter
7
+ include ContextDev::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ ContextDev::BrandWebScrapeHTMLParams,
13
+ ContextDev::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Full URL to scrape (must include http:// or https:// protocol)
18
+ sig { returns(String) }
19
+ attr_accessor :url
20
+
21
+ sig do
22
+ params(
23
+ url: String,
24
+ request_options: ContextDev::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # Full URL to scrape (must include http:// or https:// protocol)
29
+ url:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ { url: String, request_options: ContextDev::RequestOptions }
37
+ )
38
+ end
39
+ def to_hash
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,92 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ ContextDev::Models::BrandWebScrapeHTMLResponse,
10
+ ContextDev::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # Raw HTML content of the page
15
+ sig { returns(String) }
16
+ attr_accessor :html
17
+
18
+ # Indicates success
19
+ sig do
20
+ returns(
21
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
22
+ )
23
+ end
24
+ attr_accessor :success
25
+
26
+ # The URL that was scraped
27
+ sig { returns(String) }
28
+ attr_accessor :url
29
+
30
+ sig do
31
+ params(
32
+ html: String,
33
+ success:
34
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success::OrBoolean,
35
+ url: String
36
+ ).returns(T.attached_class)
37
+ end
38
+ def self.new(
39
+ # Raw HTML content of the page
40
+ html:,
41
+ # Indicates success
42
+ success:,
43
+ # The URL that was scraped
44
+ url:
45
+ )
46
+ end
47
+
48
+ sig do
49
+ override.returns(
50
+ {
51
+ html: String,
52
+ success:
53
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean,
54
+ url: String
55
+ }
56
+ )
57
+ end
58
+ def to_hash
59
+ end
60
+
61
+ # Indicates success
62
+ module Success
63
+ extend ContextDev::Internal::Type::Enum
64
+
65
+ TaggedBoolean =
66
+ T.type_alias do
67
+ T.all(
68
+ T::Boolean,
69
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success
70
+ )
71
+ end
72
+ OrBoolean = T.type_alias { T::Boolean }
73
+
74
+ TRUE =
75
+ T.let(
76
+ true,
77
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
78
+ )
79
+
80
+ sig do
81
+ override.returns(
82
+ T::Array[
83
+ ContextDev::Models::BrandWebScrapeHTMLResponse::Success::TaggedBoolean
84
+ ]
85
+ )
86
+ end
87
+ def self.values
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,43 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeImagesParams < ContextDev::Internal::Type::BaseModel
6
+ extend ContextDev::Internal::Type::RequestParameters::Converter
7
+ include ContextDev::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ ContextDev::BrandWebScrapeImagesParams,
13
+ ContextDev::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Full URL to scrape images from (must include http:// or https:// protocol)
18
+ sig { returns(String) }
19
+ attr_accessor :url
20
+
21
+ sig do
22
+ params(
23
+ url: String,
24
+ request_options: ContextDev::RequestOptions::OrHash
25
+ ).returns(T.attached_class)
26
+ end
27
+ def self.new(
28
+ # Full URL to scrape images from (must include http:// or https:// protocol)
29
+ url:,
30
+ request_options: {}
31
+ )
32
+ end
33
+
34
+ sig do
35
+ override.returns(
36
+ { url: String, request_options: ContextDev::RequestOptions }
37
+ )
38
+ end
39
+ def to_hash
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,261 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ ContextDev::Models::BrandWebScrapeImagesResponse,
10
+ ContextDev::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # Array of scraped images
15
+ sig do
16
+ returns(
17
+ T::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image]
18
+ )
19
+ end
20
+ attr_accessor :images
21
+
22
+ # Indicates success
23
+ sig do
24
+ returns(
25
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
26
+ )
27
+ end
28
+ attr_accessor :success
29
+
30
+ # The URL that was scraped
31
+ sig { returns(String) }
32
+ attr_accessor :url
33
+
34
+ sig do
35
+ params(
36
+ images:
37
+ T::Array[
38
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::OrHash
39
+ ],
40
+ success:
41
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success::OrBoolean,
42
+ url: String
43
+ ).returns(T.attached_class)
44
+ end
45
+ def self.new(
46
+ # Array of scraped images
47
+ images:,
48
+ # Indicates success
49
+ success:,
50
+ # The URL that was scraped
51
+ url:
52
+ )
53
+ end
54
+
55
+ sig do
56
+ override.returns(
57
+ {
58
+ images:
59
+ T::Array[ContextDev::Models::BrandWebScrapeImagesResponse::Image],
60
+ success:
61
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean,
62
+ url: String
63
+ }
64
+ )
65
+ end
66
+ def to_hash
67
+ end
68
+
69
+ class Image < ContextDev::Internal::Type::BaseModel
70
+ OrHash =
71
+ T.type_alias do
72
+ T.any(
73
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image,
74
+ ContextDev::Internal::AnyHash
75
+ )
76
+ end
77
+
78
+ # Alt text of the image, or null if not present
79
+ sig { returns(T.nilable(String)) }
80
+ attr_accessor :alt
81
+
82
+ # The HTML element the image was found in
83
+ sig do
84
+ returns(
85
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
86
+ )
87
+ end
88
+ attr_accessor :element
89
+
90
+ # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
91
+ sig { returns(String) }
92
+ attr_accessor :src
93
+
94
+ # The type/format of the src value
95
+ sig do
96
+ returns(
97
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
98
+ )
99
+ end
100
+ attr_accessor :type
101
+
102
+ sig do
103
+ params(
104
+ alt: T.nilable(String),
105
+ element:
106
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::OrSymbol,
107
+ src: String,
108
+ type:
109
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::OrSymbol
110
+ ).returns(T.attached_class)
111
+ end
112
+ def self.new(
113
+ # Alt text of the image, or null if not present
114
+ alt:,
115
+ # The HTML element the image was found in
116
+ element:,
117
+ # The image source - can be a URL, inline HTML (for SVGs), or a base64 data URI
118
+ src:,
119
+ # The type/format of the src value
120
+ type:
121
+ )
122
+ end
123
+
124
+ sig do
125
+ override.returns(
126
+ {
127
+ alt: T.nilable(String),
128
+ element:
129
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol,
130
+ src: String,
131
+ type:
132
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
133
+ }
134
+ )
135
+ end
136
+ def to_hash
137
+ end
138
+
139
+ # The HTML element the image was found in
140
+ module Element
141
+ extend ContextDev::Internal::Type::Enum
142
+
143
+ TaggedSymbol =
144
+ T.type_alias do
145
+ T.all(
146
+ Symbol,
147
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element
148
+ )
149
+ end
150
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
151
+
152
+ IMG =
153
+ T.let(
154
+ :img,
155
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
156
+ )
157
+ SVG =
158
+ T.let(
159
+ :svg,
160
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
161
+ )
162
+ LINK =
163
+ T.let(
164
+ :link,
165
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
166
+ )
167
+ SOURCE =
168
+ T.let(
169
+ :source,
170
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
171
+ )
172
+ VIDEO =
173
+ T.let(
174
+ :video,
175
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
176
+ )
177
+
178
+ sig do
179
+ override.returns(
180
+ T::Array[
181
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Element::TaggedSymbol
182
+ ]
183
+ )
184
+ end
185
+ def self.values
186
+ end
187
+ end
188
+
189
+ # The type/format of the src value
190
+ module Type
191
+ extend ContextDev::Internal::Type::Enum
192
+
193
+ TaggedSymbol =
194
+ T.type_alias do
195
+ T.all(
196
+ Symbol,
197
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type
198
+ )
199
+ end
200
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
201
+
202
+ URL =
203
+ T.let(
204
+ :url,
205
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
206
+ )
207
+ HTML =
208
+ T.let(
209
+ :html,
210
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
211
+ )
212
+ BASE64 =
213
+ T.let(
214
+ :base64,
215
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
216
+ )
217
+
218
+ sig do
219
+ override.returns(
220
+ T::Array[
221
+ ContextDev::Models::BrandWebScrapeImagesResponse::Image::Type::TaggedSymbol
222
+ ]
223
+ )
224
+ end
225
+ def self.values
226
+ end
227
+ end
228
+ end
229
+
230
+ # Indicates success
231
+ module Success
232
+ extend ContextDev::Internal::Type::Enum
233
+
234
+ TaggedBoolean =
235
+ T.type_alias do
236
+ T.all(
237
+ T::Boolean,
238
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success
239
+ )
240
+ end
241
+ OrBoolean = T.type_alias { T::Boolean }
242
+
243
+ TRUE =
244
+ T.let(
245
+ true,
246
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
247
+ )
248
+
249
+ sig do
250
+ override.returns(
251
+ T::Array[
252
+ ContextDev::Models::BrandWebScrapeImagesResponse::Success::TaggedBoolean
253
+ ]
254
+ )
255
+ end
256
+ def self.values
257
+ end
258
+ end
259
+ end
260
+ end
261
+ end
@@ -0,0 +1,81 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeMdParams < ContextDev::Internal::Type::BaseModel
6
+ extend ContextDev::Internal::Type::RequestParameters::Converter
7
+ include ContextDev::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ ContextDev::BrandWebScrapeMdParams,
13
+ ContextDev::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Full URL to scrape and convert to markdown (must include http:// or https://
18
+ # protocol)
19
+ sig { returns(String) }
20
+ attr_accessor :url
21
+
22
+ # Include image references in Markdown output
23
+ sig { returns(T.nilable(T::Boolean)) }
24
+ attr_reader :include_images
25
+
26
+ sig { params(include_images: T::Boolean).void }
27
+ attr_writer :include_images
28
+
29
+ # Preserve hyperlinks in Markdown output
30
+ sig { returns(T.nilable(T::Boolean)) }
31
+ attr_reader :include_links
32
+
33
+ sig { params(include_links: T::Boolean).void }
34
+ attr_writer :include_links
35
+
36
+ # Shorten base64-encoded image data in the Markdown output
37
+ sig { returns(T.nilable(T::Boolean)) }
38
+ attr_reader :shorten_base64_images
39
+
40
+ sig { params(shorten_base64_images: T::Boolean).void }
41
+ attr_writer :shorten_base64_images
42
+
43
+ sig do
44
+ params(
45
+ url: String,
46
+ include_images: T::Boolean,
47
+ include_links: T::Boolean,
48
+ shorten_base64_images: T::Boolean,
49
+ request_options: ContextDev::RequestOptions::OrHash
50
+ ).returns(T.attached_class)
51
+ end
52
+ def self.new(
53
+ # Full URL to scrape and convert to markdown (must include http:// or https://
54
+ # protocol)
55
+ url:,
56
+ # Include image references in Markdown output
57
+ include_images: nil,
58
+ # Preserve hyperlinks in Markdown output
59
+ include_links: nil,
60
+ # Shorten base64-encoded image data in the Markdown output
61
+ shorten_base64_images: nil,
62
+ request_options: {}
63
+ )
64
+ end
65
+
66
+ sig do
67
+ override.returns(
68
+ {
69
+ url: String,
70
+ include_images: T::Boolean,
71
+ include_links: T::Boolean,
72
+ shorten_base64_images: T::Boolean,
73
+ request_options: ContextDev::RequestOptions
74
+ }
75
+ )
76
+ end
77
+ def to_hash
78
+ end
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,92 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(
9
+ ContextDev::Models::BrandWebScrapeMdResponse,
10
+ ContextDev::Internal::AnyHash
11
+ )
12
+ end
13
+
14
+ # Page content converted to GitHub Flavored Markdown
15
+ sig { returns(String) }
16
+ attr_accessor :markdown
17
+
18
+ # Indicates success
19
+ sig do
20
+ returns(
21
+ ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
22
+ )
23
+ end
24
+ attr_accessor :success
25
+
26
+ # The URL that was scraped
27
+ sig { returns(String) }
28
+ attr_accessor :url
29
+
30
+ sig do
31
+ params(
32
+ markdown: String,
33
+ success:
34
+ ContextDev::Models::BrandWebScrapeMdResponse::Success::OrBoolean,
35
+ url: String
36
+ ).returns(T.attached_class)
37
+ end
38
+ def self.new(
39
+ # Page content converted to GitHub Flavored Markdown
40
+ markdown:,
41
+ # Indicates success
42
+ success:,
43
+ # The URL that was scraped
44
+ url:
45
+ )
46
+ end
47
+
48
+ sig do
49
+ override.returns(
50
+ {
51
+ markdown: String,
52
+ success:
53
+ ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean,
54
+ url: String
55
+ }
56
+ )
57
+ end
58
+ def to_hash
59
+ end
60
+
61
+ # Indicates success
62
+ module Success
63
+ extend ContextDev::Internal::Type::Enum
64
+
65
+ TaggedBoolean =
66
+ T.type_alias do
67
+ T.all(
68
+ T::Boolean,
69
+ ContextDev::Models::BrandWebScrapeMdResponse::Success
70
+ )
71
+ end
72
+ OrBoolean = T.type_alias { T::Boolean }
73
+
74
+ TRUE =
75
+ T.let(
76
+ true,
77
+ ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
78
+ )
79
+
80
+ sig do
81
+ override.returns(
82
+ T::Array[
83
+ ContextDev::Models::BrandWebScrapeMdResponse::Success::TaggedBoolean
84
+ ]
85
+ )
86
+ end
87
+ def self.values
88
+ end
89
+ end
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,45 @@
1
+ # typed: strong
2
+
3
+ module ContextDev
4
+ module Models
5
+ class BrandWebScrapeSitemapParams < ContextDev::Internal::Type::BaseModel
6
+ extend ContextDev::Internal::Type::RequestParameters::Converter
7
+ include ContextDev::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ ContextDev::BrandWebScrapeSitemapParams,
13
+ ContextDev::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
18
+ # automatically normalized and validated.
19
+ sig { returns(String) }
20
+ attr_accessor :domain
21
+
22
+ sig do
23
+ params(
24
+ domain: String,
25
+ request_options: ContextDev::RequestOptions::OrHash
26
+ ).returns(T.attached_class)
27
+ end
28
+ def self.new(
29
+ # Domain name to crawl sitemaps for (e.g., 'example.com'). The domain will be
30
+ # automatically normalized and validated.
31
+ domain:,
32
+ request_options: {}
33
+ )
34
+ end
35
+
36
+ sig do
37
+ override.returns(
38
+ { domain: String, request_options: ContextDev::RequestOptions }
39
+ )
40
+ end
41
+ def to_hash
42
+ end
43
+ end
44
+ end
45
+ end