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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8ef98d3030c8e13d2b4d3ec497e6b4603b18108b853b2dfbf72b784fcf2797d5
|
|
4
|
+
data.tar.gz: 05571a05f9ca05ca7b76fef39a942eccc063cd067584537af015c3c75bd8c171
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 535b48a03656e47a7936e4e57b6e93cc479cfadb801a8d0b1d0dd814bfaa5be9612778286f2dde0727b3274e8fd14efa9248e1609a9ef07e22c65a3e64205d0a
|
|
7
|
+
data.tar.gz: 1da1214b1edddf28e4c442870b77fa58e117a0da698fb32a7c9f0562f760d40f784db28751aaf018d51c0e87c0597d5b9160e97aa9e3c4c5965f6c5671642c1b
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.12.0 (2026-08-23)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v2.11.0...v2.12.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.11.0...v2.12.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([f7adbd6](https://github.com/context-dot-dev/context-ruby-sdk/commit/f7adbd63407b697245019ea9483dc090de9ba0ff))
|
|
10
|
+
* **api:** api update ([c26b304](https://github.com/context-dot-dev/context-ruby-sdk/commit/c26b30411607dcc2eaad14962d582f4588f5193f))
|
|
11
|
+
* **api:** api update ([852a96e](https://github.com/context-dot-dev/context-ruby-sdk/commit/852a96e58dab7e6fef53af10093119ffc237f52e))
|
|
12
|
+
* **api:** api update ([c16beb5](https://github.com/context-dot-dev/context-ruby-sdk/commit/c16beb55d66977611c58711b489132f347ab2c96))
|
|
13
|
+
|
|
14
|
+
## 2.11.0 (2026-08-18)
|
|
15
|
+
|
|
16
|
+
Full Changelog: [v2.10.0...v2.11.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.10.0...v2.11.0)
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* **api:** api update ([9bff49f](https://github.com/context-dot-dev/context-ruby-sdk/commit/9bff49f9a966fd40691f2cd7a41ba96ec7679243))
|
|
21
|
+
* **api:** api update ([5b19e0c](https://github.com/context-dot-dev/context-ruby-sdk/commit/5b19e0ce1f7ad615a92e28440bec6ab3703ffe02))
|
|
22
|
+
* **api:** api update ([f4ccf22](https://github.com/context-dot-dev/context-ruby-sdk/commit/f4ccf220f130672950d3231a6b9952c166168ef9))
|
|
23
|
+
|
|
3
24
|
## 2.10.0 (2026-08-17)
|
|
4
25
|
|
|
5
26
|
Full Changelog: [v2.9.0...v2.10.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.9.0...v2.10.0)
|
data/README.md
CHANGED
|
@@ -123,6 +123,14 @@ module ContextDev
|
|
|
123
123
|
# @return [Array<String>]
|
|
124
124
|
required :target_audience, ContextDev::Internal::Type::ArrayOf[String]
|
|
125
125
|
|
|
126
|
+
# @!attribute availability
|
|
127
|
+
# Normalized stock or ordering availability
|
|
128
|
+
#
|
|
129
|
+
# @return [Symbol, ContextDev::Models::AIExtractProductResponse::Product::Availability, nil]
|
|
130
|
+
optional :availability,
|
|
131
|
+
enum: -> { ContextDev::Models::AIExtractProductResponse::Product::Availability },
|
|
132
|
+
nil?: true
|
|
133
|
+
|
|
126
134
|
# @!attribute billing_frequency
|
|
127
135
|
# Billing frequency for the product
|
|
128
136
|
#
|
|
@@ -143,6 +151,12 @@ module ContextDev
|
|
|
143
151
|
# @return [String, nil]
|
|
144
152
|
optional :currency, String, nil?: true
|
|
145
153
|
|
|
154
|
+
# @!attribute dimensions
|
|
155
|
+
# Dimension statements shown for the product, preserving labels, values, and units
|
|
156
|
+
#
|
|
157
|
+
# @return [Array<String>, nil]
|
|
158
|
+
optional :dimensions, ContextDev::Internal::Type::ArrayOf[String]
|
|
159
|
+
|
|
146
160
|
# @!attribute image_url
|
|
147
161
|
# URL to the product image
|
|
148
162
|
#
|
|
@@ -163,13 +177,22 @@ module ContextDev
|
|
|
163
177
|
enum: -> { ContextDev::Models::AIExtractProductResponse::Product::PricingModel },
|
|
164
178
|
nil?: true
|
|
165
179
|
|
|
180
|
+
# @!attribute regular_price
|
|
181
|
+
# Original or regular price before a displayed discount
|
|
182
|
+
#
|
|
183
|
+
# @return [Float, nil]
|
|
184
|
+
optional :regular_price, Float, nil?: true
|
|
185
|
+
|
|
166
186
|
# @!attribute url
|
|
167
187
|
# URL to the product page
|
|
168
188
|
#
|
|
169
189
|
# @return [String, nil]
|
|
170
190
|
optional :url, String, nil?: true
|
|
171
191
|
|
|
172
|
-
# @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil)
|
|
192
|
+
# @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, availability: nil, billing_frequency: nil, category: nil, currency: nil, dimensions: nil, image_url: nil, price: nil, pricing_model: nil, regular_price: nil, url: nil)
|
|
193
|
+
# Some parameter documentations has been truncated, see
|
|
194
|
+
# {ContextDev::Models::AIExtractProductResponse::Product} for more details.
|
|
195
|
+
#
|
|
173
196
|
# The extracted product data, or null if not a product page
|
|
174
197
|
#
|
|
175
198
|
# @param description [String] Description of the product
|
|
@@ -186,20 +209,44 @@ module ContextDev
|
|
|
186
209
|
#
|
|
187
210
|
# @param target_audience [Array<String>] Target audience for the product (array of strings)
|
|
188
211
|
#
|
|
212
|
+
# @param availability [Symbol, ContextDev::Models::AIExtractProductResponse::Product::Availability, nil] Normalized stock or ordering availability
|
|
213
|
+
#
|
|
189
214
|
# @param billing_frequency [Symbol, ContextDev::Models::AIExtractProductResponse::Product::BillingFrequency, nil] Billing frequency for the product
|
|
190
215
|
#
|
|
191
216
|
# @param category [String, nil] Category of the product
|
|
192
217
|
#
|
|
193
218
|
# @param currency [String, nil] Currency code for the price (e.g., USD, EUR)
|
|
194
219
|
#
|
|
220
|
+
# @param dimensions [Array<String>] Dimension statements shown for the product, preserving labels, values, and units
|
|
221
|
+
#
|
|
195
222
|
# @param image_url [String, nil] URL to the product image
|
|
196
223
|
#
|
|
197
224
|
# @param price [Float, nil] Price of the product
|
|
198
225
|
#
|
|
199
226
|
# @param pricing_model [Symbol, ContextDev::Models::AIExtractProductResponse::Product::PricingModel, nil] Pricing model for the product
|
|
200
227
|
#
|
|
228
|
+
# @param regular_price [Float, nil] Original or regular price before a displayed discount
|
|
229
|
+
#
|
|
201
230
|
# @param url [String, nil] URL to the product page
|
|
202
231
|
|
|
232
|
+
# Normalized stock or ordering availability
|
|
233
|
+
#
|
|
234
|
+
# @see ContextDev::Models::AIExtractProductResponse::Product#availability
|
|
235
|
+
module Availability
|
|
236
|
+
extend ContextDev::Internal::Type::Enum
|
|
237
|
+
|
|
238
|
+
IN_STOCK = :in_stock
|
|
239
|
+
OUT_OF_STOCK = :out_of_stock
|
|
240
|
+
LIMITED_AVAILABILITY = :limited_availability
|
|
241
|
+
PREORDER = :preorder
|
|
242
|
+
BACKORDER = :backorder
|
|
243
|
+
MADE_TO_ORDER = :made_to_order
|
|
244
|
+
DISCONTINUED = :discontinued
|
|
245
|
+
|
|
246
|
+
# @!method self.values
|
|
247
|
+
# @return [Array<Symbol>]
|
|
248
|
+
end
|
|
249
|
+
|
|
203
250
|
# Billing frequency for the product
|
|
204
251
|
#
|
|
205
252
|
# @see ContextDev::Models::AIExtractProductResponse::Product#billing_frequency
|
|
@@ -92,6 +92,14 @@ module ContextDev
|
|
|
92
92
|
# @return [Array<String>]
|
|
93
93
|
required :target_audience, ContextDev::Internal::Type::ArrayOf[String]
|
|
94
94
|
|
|
95
|
+
# @!attribute availability
|
|
96
|
+
# Normalized stock or ordering availability
|
|
97
|
+
#
|
|
98
|
+
# @return [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::Availability, nil]
|
|
99
|
+
optional :availability,
|
|
100
|
+
enum: -> { ContextDev::Models::AIExtractProductsResponse::Product::Availability },
|
|
101
|
+
nil?: true
|
|
102
|
+
|
|
95
103
|
# @!attribute billing_frequency
|
|
96
104
|
# Billing frequency for the product
|
|
97
105
|
#
|
|
@@ -112,6 +120,12 @@ module ContextDev
|
|
|
112
120
|
# @return [String, nil]
|
|
113
121
|
optional :currency, String, nil?: true
|
|
114
122
|
|
|
123
|
+
# @!attribute dimensions
|
|
124
|
+
# Dimension statements shown for the product, preserving labels, values, and units
|
|
125
|
+
#
|
|
126
|
+
# @return [Array<String>, nil]
|
|
127
|
+
optional :dimensions, ContextDev::Internal::Type::ArrayOf[String]
|
|
128
|
+
|
|
115
129
|
# @!attribute image_url
|
|
116
130
|
# URL to the product image
|
|
117
131
|
#
|
|
@@ -132,13 +146,22 @@ module ContextDev
|
|
|
132
146
|
enum: -> { ContextDev::Models::AIExtractProductsResponse::Product::PricingModel },
|
|
133
147
|
nil?: true
|
|
134
148
|
|
|
149
|
+
# @!attribute regular_price
|
|
150
|
+
# Original or regular price before a displayed discount
|
|
151
|
+
#
|
|
152
|
+
# @return [Float, nil]
|
|
153
|
+
optional :regular_price, Float, nil?: true
|
|
154
|
+
|
|
135
155
|
# @!attribute url
|
|
136
156
|
# URL to the product page
|
|
137
157
|
#
|
|
138
158
|
# @return [String, nil]
|
|
139
159
|
optional :url, String, nil?: true
|
|
140
160
|
|
|
141
|
-
# @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, billing_frequency: nil, category: nil, currency: nil, image_url: nil, price: nil, pricing_model: nil, url: nil)
|
|
161
|
+
# @!method initialize(description:, features:, images:, name:, sku:, tags:, target_audience:, availability: nil, billing_frequency: nil, category: nil, currency: nil, dimensions: nil, image_url: nil, price: nil, pricing_model: nil, regular_price: nil, url: nil)
|
|
162
|
+
# Some parameter documentations has been truncated, see
|
|
163
|
+
# {ContextDev::Models::AIExtractProductsResponse::Product} for more details.
|
|
164
|
+
#
|
|
142
165
|
# @param description [String] Description of the product
|
|
143
166
|
#
|
|
144
167
|
# @param features [Array<String>] List of product features
|
|
@@ -153,20 +176,44 @@ module ContextDev
|
|
|
153
176
|
#
|
|
154
177
|
# @param target_audience [Array<String>] Target audience for the product (array of strings)
|
|
155
178
|
#
|
|
179
|
+
# @param availability [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::Availability, nil] Normalized stock or ordering availability
|
|
180
|
+
#
|
|
156
181
|
# @param billing_frequency [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::BillingFrequency, nil] Billing frequency for the product
|
|
157
182
|
#
|
|
158
183
|
# @param category [String, nil] Category of the product
|
|
159
184
|
#
|
|
160
185
|
# @param currency [String, nil] Currency code for the price (e.g., USD, EUR)
|
|
161
186
|
#
|
|
187
|
+
# @param dimensions [Array<String>] Dimension statements shown for the product, preserving labels, values, and units
|
|
188
|
+
#
|
|
162
189
|
# @param image_url [String, nil] URL to the product image
|
|
163
190
|
#
|
|
164
191
|
# @param price [Float, nil] Price of the product
|
|
165
192
|
#
|
|
166
193
|
# @param pricing_model [Symbol, ContextDev::Models::AIExtractProductsResponse::Product::PricingModel, nil] Pricing model for the product
|
|
167
194
|
#
|
|
195
|
+
# @param regular_price [Float, nil] Original or regular price before a displayed discount
|
|
196
|
+
#
|
|
168
197
|
# @param url [String, nil] URL to the product page
|
|
169
198
|
|
|
199
|
+
# Normalized stock or ordering availability
|
|
200
|
+
#
|
|
201
|
+
# @see ContextDev::Models::AIExtractProductsResponse::Product#availability
|
|
202
|
+
module Availability
|
|
203
|
+
extend ContextDev::Internal::Type::Enum
|
|
204
|
+
|
|
205
|
+
IN_STOCK = :in_stock
|
|
206
|
+
OUT_OF_STOCK = :out_of_stock
|
|
207
|
+
LIMITED_AVAILABILITY = :limited_availability
|
|
208
|
+
PREORDER = :preorder
|
|
209
|
+
BACKORDER = :backorder
|
|
210
|
+
MADE_TO_ORDER = :made_to_order
|
|
211
|
+
DISCONTINUED = :discontinued
|
|
212
|
+
|
|
213
|
+
# @!method self.values
|
|
214
|
+
# @return [Array<Symbol>]
|
|
215
|
+
end
|
|
216
|
+
|
|
170
217
|
# Billing frequency for the product
|
|
171
218
|
#
|
|
172
219
|
# @see ContextDev::Models::AIExtractProductsResponse::Product#billing_frequency
|
|
@@ -344,10 +344,38 @@ module ContextDev
|
|
|
344
344
|
# @return [String, nil]
|
|
345
345
|
optional :name, String
|
|
346
346
|
|
|
347
|
-
# @!
|
|
347
|
+
# @!attribute source
|
|
348
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
349
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
350
|
+
# logo image pixels.
|
|
351
|
+
#
|
|
352
|
+
# @return [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source, nil]
|
|
353
|
+
optional :source, enum: -> { ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source }
|
|
354
|
+
|
|
355
|
+
# @!method initialize(hex: nil, name: nil, source: nil)
|
|
356
|
+
# Some parameter documentations has been truncated, see
|
|
357
|
+
# {ContextDev::Models::BrandRetrieveResponse::Brand::Color} for more details.
|
|
358
|
+
#
|
|
348
359
|
# @param hex [String] Color in hexadecimal format
|
|
349
360
|
#
|
|
350
361
|
# @param name [String] Name of the color
|
|
362
|
+
#
|
|
363
|
+
# @param source [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::Color::Source] Where the color was observed: 'site' colors come from the website's own theme si
|
|
364
|
+
|
|
365
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
366
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
367
|
+
# logo image pixels.
|
|
368
|
+
#
|
|
369
|
+
# @see ContextDev::Models::BrandRetrieveResponse::Brand::Color#source
|
|
370
|
+
module Source
|
|
371
|
+
extend ContextDev::Internal::Type::Enum
|
|
372
|
+
|
|
373
|
+
SITE = :site
|
|
374
|
+
LOGO = :logo
|
|
375
|
+
|
|
376
|
+
# @!method self.values
|
|
377
|
+
# @return [Array<Symbol>]
|
|
378
|
+
end
|
|
351
379
|
end
|
|
352
380
|
|
|
353
381
|
# @see ContextDev::Models::BrandRetrieveResponse::Brand#employees
|
|
@@ -180,10 +180,39 @@ module ContextDev
|
|
|
180
180
|
# @return [String, nil]
|
|
181
181
|
optional :name, String
|
|
182
182
|
|
|
183
|
-
# @!
|
|
183
|
+
# @!attribute source
|
|
184
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
185
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
186
|
+
# logo image pixels.
|
|
187
|
+
#
|
|
188
|
+
# @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source, nil]
|
|
189
|
+
optional :source, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source }
|
|
190
|
+
|
|
191
|
+
# @!method initialize(hex: nil, name: nil, source: nil)
|
|
192
|
+
# Some parameter documentations has been truncated, see
|
|
193
|
+
# {ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color} for more
|
|
194
|
+
# details.
|
|
195
|
+
#
|
|
184
196
|
# @param hex [String] Color in hexadecimal format
|
|
185
197
|
#
|
|
186
198
|
# @param name [String] Name of the color
|
|
199
|
+
#
|
|
200
|
+
# @param source [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color::Source] Where the color was observed: 'site' colors come from the website's own theme si
|
|
201
|
+
|
|
202
|
+
# Where the color was observed: 'site' colors come from the website's own theme
|
|
203
|
+
# signals (rendered page colors, manifest, theme-color meta), 'logo' colors from
|
|
204
|
+
# logo image pixels.
|
|
205
|
+
#
|
|
206
|
+
# @see ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::Color#source
|
|
207
|
+
module Source
|
|
208
|
+
extend ContextDev::Internal::Type::Enum
|
|
209
|
+
|
|
210
|
+
SITE = :site
|
|
211
|
+
LOGO = :logo
|
|
212
|
+
|
|
213
|
+
# @!method self.values
|
|
214
|
+
# @return [Array<Symbol>]
|
|
215
|
+
end
|
|
187
216
|
end
|
|
188
217
|
|
|
189
218
|
class Logo < ContextDev::Internal::Type::BaseModel
|
|
@@ -5,21 +5,26 @@ module ContextDev
|
|
|
5
5
|
# @see ContextDev::Resources::News#search
|
|
6
6
|
class NewsSearchResponse < ContextDev::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
+
# Articles matching the search, in the requested order.
|
|
8
9
|
#
|
|
9
10
|
# @return [Array<ContextDev::Models::NewsSearchResponse::Data>]
|
|
10
11
|
required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::NewsSearchResponse::Data] }
|
|
11
12
|
|
|
12
13
|
# @!attribute has_more
|
|
14
|
+
# True when more results are available beyond this page.
|
|
13
15
|
#
|
|
14
16
|
# @return [Boolean]
|
|
15
17
|
required :has_more, ContextDev::Internal::Type::Boolean
|
|
16
18
|
|
|
17
19
|
# @!attribute meta
|
|
20
|
+
# Summary information about this response.
|
|
18
21
|
#
|
|
19
22
|
# @return [ContextDev::Models::NewsSearchResponse::Meta]
|
|
20
23
|
required :meta, -> { ContextDev::Models::NewsSearchResponse::Meta }
|
|
21
24
|
|
|
22
25
|
# @!attribute next_cursor
|
|
26
|
+
# Pass as cursor in the next request to fetch the following page. Null when there
|
|
27
|
+
# are no more results.
|
|
23
28
|
#
|
|
24
29
|
# @return [String, nil]
|
|
25
30
|
required :next_cursor, String, nil?: true
|
|
@@ -35,119 +40,150 @@ module ContextDev
|
|
|
35
40
|
# Some parameter documentations has been truncated, see
|
|
36
41
|
# {ContextDev::Models::NewsSearchResponse} for more details.
|
|
37
42
|
#
|
|
38
|
-
# @param data [Array<ContextDev::Models::NewsSearchResponse::Data>]
|
|
43
|
+
# @param data [Array<ContextDev::Models::NewsSearchResponse::Data>] Articles matching the search, in the requested order.
|
|
39
44
|
#
|
|
40
|
-
# @param has_more [Boolean]
|
|
45
|
+
# @param has_more [Boolean] True when more results are available beyond this page.
|
|
41
46
|
#
|
|
42
|
-
# @param meta [ContextDev::Models::NewsSearchResponse::Meta]
|
|
47
|
+
# @param meta [ContextDev::Models::NewsSearchResponse::Meta] Summary information about this response.
|
|
43
48
|
#
|
|
44
|
-
# @param next_cursor [String, nil]
|
|
49
|
+
# @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
|
|
45
50
|
#
|
|
46
51
|
# @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
|
|
47
52
|
|
|
48
53
|
class Data < ContextDev::Internal::Type::BaseModel
|
|
49
54
|
# @!attribute id
|
|
55
|
+
# Stable unique identifier for this article. Use it to deduplicate or reference an
|
|
56
|
+
# article across requests.
|
|
50
57
|
#
|
|
51
58
|
# @return [String]
|
|
52
59
|
required :id, String
|
|
53
60
|
|
|
54
61
|
# @!attribute authors
|
|
62
|
+
# Bylined authors. Empty when no byline is available.
|
|
55
63
|
#
|
|
56
64
|
# @return [Array<String>]
|
|
57
65
|
required :authors, ContextDev::Internal::Type::ArrayOf[String]
|
|
58
66
|
|
|
59
67
|
# @!attribute description
|
|
68
|
+
# Short summary or excerpt of the article, when the publisher provides one.
|
|
60
69
|
#
|
|
61
70
|
# @return [String, nil]
|
|
62
71
|
required :description, String, nil?: true
|
|
63
72
|
|
|
64
73
|
# @!attribute image_url
|
|
74
|
+
# Lead image for the article, when one is available.
|
|
65
75
|
#
|
|
66
76
|
# @return [String, nil]
|
|
67
77
|
required :image_url, String, nil?: true
|
|
68
78
|
|
|
69
79
|
# @!attribute language
|
|
80
|
+
# Language the article is written in, as a lowercase ISO 639-1 code such as en.
|
|
81
|
+
# Null when unknown.
|
|
70
82
|
#
|
|
71
83
|
# @return [String, nil]
|
|
72
84
|
required :language, String, nil?: true
|
|
73
85
|
|
|
74
86
|
# @!attribute match
|
|
87
|
+
# How the article relates to the company you searched for.
|
|
75
88
|
#
|
|
76
89
|
# @return [ContextDev::Models::NewsSearchResponse::Data::Match]
|
|
77
90
|
required :match, -> { ContextDev::Models::NewsSearchResponse::Data::Match }
|
|
78
91
|
|
|
79
92
|
# @!attribute published_at
|
|
93
|
+
# When the article was published, as an ISO 8601 timestamp. Null when the
|
|
94
|
+
# publisher does not state a reliable date.
|
|
80
95
|
#
|
|
81
96
|
# @return [Time, nil]
|
|
82
97
|
required :published_at, Time, nil?: true
|
|
83
98
|
|
|
84
99
|
# @!attribute source
|
|
100
|
+
# The publication that published the article.
|
|
85
101
|
#
|
|
86
102
|
# @return [ContextDev::Models::NewsSearchResponse::Data::Source]
|
|
87
103
|
required :source, -> { ContextDev::Models::NewsSearchResponse::Data::Source }
|
|
88
104
|
|
|
89
105
|
# @!attribute story_id
|
|
90
|
-
#
|
|
106
|
+
# Shared by articles covering the same story on the same day. Use it to group or
|
|
107
|
+
# collapse syndicated copies of one announcement across outlets.
|
|
91
108
|
#
|
|
92
109
|
# @return [String]
|
|
93
110
|
required :story_id, String
|
|
94
111
|
|
|
95
112
|
# @!attribute title
|
|
113
|
+
# Article headline.
|
|
96
114
|
#
|
|
97
115
|
# @return [String]
|
|
98
116
|
required :title, String
|
|
99
117
|
|
|
100
118
|
# @!attribute type
|
|
119
|
+
# Kind of coverage. Use it to separate independent reporting (editorial) from
|
|
120
|
+
# company-issued content (press_release, regulatory_filing, advisory).
|
|
101
121
|
#
|
|
102
122
|
# @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type]
|
|
103
123
|
required :type, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Type }
|
|
104
124
|
|
|
105
125
|
# @!attribute url
|
|
126
|
+
# Link to the article on the publisher site.
|
|
106
127
|
#
|
|
107
128
|
# @return [String]
|
|
108
129
|
required :url, String
|
|
109
130
|
|
|
110
131
|
# @!method initialize(id:, authors:, description:, image_url:, language:, match:, published_at:, source:, story_id:, title:, type:, url:)
|
|
111
|
-
#
|
|
132
|
+
# Some parameter documentations has been truncated, see
|
|
133
|
+
# {ContextDev::Models::NewsSearchResponse::Data} for more details.
|
|
112
134
|
#
|
|
113
|
-
# @param
|
|
135
|
+
# @param id [String] Stable unique identifier for this article. Use it to deduplicate or reference an
|
|
114
136
|
#
|
|
115
|
-
# @param
|
|
137
|
+
# @param authors [Array<String>] Bylined authors. Empty when no byline is available.
|
|
116
138
|
#
|
|
117
|
-
# @param
|
|
139
|
+
# @param description [String, nil] Short summary or excerpt of the article, when the publisher provides one.
|
|
118
140
|
#
|
|
119
|
-
# @param
|
|
141
|
+
# @param image_url [String, nil] Lead image for the article, when one is available.
|
|
120
142
|
#
|
|
121
|
-
# @param
|
|
143
|
+
# @param language [String, nil] Language the article is written in, as a lowercase ISO 639-1 code such as en. Nu
|
|
122
144
|
#
|
|
123
|
-
# @param
|
|
145
|
+
# @param match [ContextDev::Models::NewsSearchResponse::Data::Match] How the article relates to the company you searched for.
|
|
124
146
|
#
|
|
125
|
-
# @param
|
|
147
|
+
# @param published_at [Time, nil] When the article was published, as an ISO 8601 timestamp. Null when the publishe
|
|
126
148
|
#
|
|
127
|
-
# @param
|
|
149
|
+
# @param source [ContextDev::Models::NewsSearchResponse::Data::Source] The publication that published the article.
|
|
128
150
|
#
|
|
129
|
-
# @param
|
|
151
|
+
# @param story_id [String] Shared by articles covering the same story on the same day. Use it to group or c
|
|
130
152
|
#
|
|
131
|
-
# @param
|
|
153
|
+
# @param title [String] Article headline.
|
|
132
154
|
#
|
|
133
|
-
# @param
|
|
155
|
+
# @param type [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type] Kind of coverage. Use it to separate independent reporting (editorial) from comp
|
|
156
|
+
#
|
|
157
|
+
# @param url [String] Link to the article on the publisher site.
|
|
134
158
|
|
|
135
159
|
# @see ContextDev::Models::NewsSearchResponse::Data#match
|
|
136
160
|
class Match < ContextDev::Internal::Type::BaseModel
|
|
137
161
|
# @!attribute confidence
|
|
162
|
+
# How confident the match is, from 0 to 1. Null when a score is unavailable.
|
|
138
163
|
#
|
|
139
164
|
# @return [Float, nil]
|
|
140
165
|
required :confidence, Float, nil?: true
|
|
141
166
|
|
|
142
167
|
# @!attribute level
|
|
168
|
+
# primary when the article is mainly about the company, secondary when the company
|
|
169
|
+
# is mentioned but is not the main subject.
|
|
143
170
|
#
|
|
144
171
|
# @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level]
|
|
145
172
|
required :level, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Match::Level }
|
|
146
173
|
|
|
147
174
|
# @!method initialize(confidence:, level:)
|
|
148
|
-
#
|
|
149
|
-
#
|
|
175
|
+
# Some parameter documentations has been truncated, see
|
|
176
|
+
# {ContextDev::Models::NewsSearchResponse::Data::Match} for more details.
|
|
177
|
+
#
|
|
178
|
+
# How the article relates to the company you searched for.
|
|
179
|
+
#
|
|
180
|
+
# @param confidence [Float, nil] How confident the match is, from 0 to 1. Null when a score is unavailable.
|
|
181
|
+
#
|
|
182
|
+
# @param level [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level] primary when the article is mainly about the company, secondary when the company
|
|
150
183
|
|
|
184
|
+
# primary when the article is mainly about the company, secondary when the company
|
|
185
|
+
# is mentioned but is not the main subject.
|
|
186
|
+
#
|
|
151
187
|
# @see ContextDev::Models::NewsSearchResponse::Data::Match#level
|
|
152
188
|
module Level
|
|
153
189
|
extend ContextDev::Internal::Type::Enum
|
|
@@ -169,23 +205,30 @@ module ContextDev
|
|
|
169
205
|
required :direct, ContextDev::Internal::Type::Boolean
|
|
170
206
|
|
|
171
207
|
# @!attribute domain
|
|
208
|
+
# Website domain of the publication.
|
|
172
209
|
#
|
|
173
210
|
# @return [String]
|
|
174
211
|
required :domain, String
|
|
175
212
|
|
|
176
213
|
# @!attribute name
|
|
214
|
+
# Name of the publication, such as Reuters.
|
|
177
215
|
#
|
|
178
216
|
# @return [String]
|
|
179
217
|
required :name, String
|
|
180
218
|
|
|
181
219
|
# @!method initialize(direct:, domain:, name:)
|
|
220
|
+
# The publication that published the article.
|
|
221
|
+
#
|
|
182
222
|
# @param direct [Boolean] True when Context observed this article in the publisher-owned feed.
|
|
183
223
|
#
|
|
184
|
-
# @param domain [String]
|
|
224
|
+
# @param domain [String] Website domain of the publication.
|
|
185
225
|
#
|
|
186
|
-
# @param name [String]
|
|
226
|
+
# @param name [String] Name of the publication, such as Reuters.
|
|
187
227
|
end
|
|
188
228
|
|
|
229
|
+
# Kind of coverage. Use it to separate independent reporting (editorial) from
|
|
230
|
+
# company-issued content (press_release, regulatory_filing, advisory).
|
|
231
|
+
#
|
|
189
232
|
# @see ContextDev::Models::NewsSearchResponse::Data#type
|
|
190
233
|
module Type
|
|
191
234
|
extend ContextDev::Internal::Type::Enum
|
|
@@ -203,12 +246,15 @@ module ContextDev
|
|
|
203
246
|
# @see ContextDev::Models::NewsSearchResponse#meta
|
|
204
247
|
class Meta < ContextDev::Internal::Type::BaseModel
|
|
205
248
|
# @!attribute count
|
|
249
|
+
# Number of articles in this page.
|
|
206
250
|
#
|
|
207
251
|
# @return [Integer]
|
|
208
252
|
required :count, Integer
|
|
209
253
|
|
|
210
254
|
# @!method initialize(count:)
|
|
211
|
-
#
|
|
255
|
+
# Summary information about this response.
|
|
256
|
+
#
|
|
257
|
+
# @param count [Integer] Number of articles in this page.
|
|
212
258
|
end
|
|
213
259
|
|
|
214
260
|
# @see ContextDev::Models::NewsSearchResponse#key_metadata
|