context.dev 2.13.0 → 2.15.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 +20 -0
- data/README.md +1 -10
- data/lib/context_dev/client.rb +4 -0
- data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
- data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
- data/lib/context_dev/models/batch_cancel_response.rb +4 -4
- data/lib/context_dev/models/batch_delete_response.rb +7 -12
- data/lib/context_dev/models/batch_get_results_response.rb +7 -12
- data/lib/context_dev/models/batch_list_response.rb +7 -12
- data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
- data/lib/context_dev/models/batch_submit_params.rb +34 -3
- data/lib/context_dev/models/batch_submit_response.rb +4 -4
- data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
- data/lib/context_dev/models/brand_search_params.rb +3 -4
- data/lib/context_dev/models/brand_search_response.rb +7 -9
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
- data/lib/context_dev/models/monitor_create_params.rb +9 -1
- data/lib/context_dev/models/monitor_create_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
- data/lib/context_dev/models/monitor_update_params.rb +9 -1
- data/lib/context_dev/models/monitor_update_response.rb +9 -1
- data/lib/context_dev/models/news_search_response.rb +7 -9
- data/lib/context_dev/models/parse_handle_params.rb +3 -4
- data/lib/context_dev/models/parse_handle_response.rb +7 -12
- data/lib/context_dev/models/person_enrich_response.rb +7 -12
- data/lib/context_dev/models/retry_config.rb +22 -0
- data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
- data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
- data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
- data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
- data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
- data/lib/context_dev/models/web_extract_response.rb +7 -9
- data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
- data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
- data/lib/context_dev/models/web_screenshot_params.rb +3 -4
- data/lib/context_dev/models/web_screenshot_response.rb +7 -9
- data/lib/context_dev/models/web_search_response.rb +7 -9
- data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +13 -5
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
- data/lib/context_dev/models/webhook_delivery.rb +9 -1
- data/lib/context_dev/models/webhooks/attempt.rb +102 -0
- data/lib/context_dev/models/webhooks/delivery.rb +253 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
- data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
- data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
- data/lib/context_dev/models.rb +4 -0
- data/lib/context_dev/resources/batch.rb +4 -2
- data/lib/context_dev/resources/brand.rb +2 -2
- data/lib/context_dev/resources/industry.rb +2 -2
- data/lib/context_dev/resources/parse.rb +1 -1
- data/lib/context_dev/resources/web.rb +18 -14
- data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
- data/lib/context_dev/resources/webhooks.rb +19 -0
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +14 -0
- data/rbi/context_dev/client.rbi +3 -0
- data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
- data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
- data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
- data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
- data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
- data/rbi/context_dev/models/batch_list_response.rbi +7 -10
- data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
- data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
- data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
- data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
- data/rbi/context_dev/models/brand_search_params.rbi +4 -6
- data/rbi/context_dev/models/brand_search_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
- data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
- data/rbi/context_dev/models/news_search_response.rbi +7 -10
- data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
- data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
- data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
- data/rbi/context_dev/models/retry_config.rbi +35 -0
- data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
- data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
- data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
- data/rbi/context_dev/models/web_search_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +17 -6
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
- data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
- data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
- data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
- data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
- data/rbi/context_dev/models.rbi +4 -0
- data/rbi/context_dev/resources/batch.rbi +6 -1
- data/rbi/context_dev/resources/brand.rbi +4 -6
- data/rbi/context_dev/resources/industry.rbi +4 -6
- data/rbi/context_dev/resources/parse.rbi +2 -3
- data/rbi/context_dev/resources/web.rbi +26 -29
- data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
- data/rbi/context_dev/resources/webhooks.rbi +16 -0
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
- data/sig/context_dev/models/batch_submit_params.rbs +23 -0
- data/sig/context_dev/models/monitor_create_params.rbs +8 -1
- data/sig/context_dev/models/monitor_create_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_list_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
- data/sig/context_dev/models/monitor_update_params.rbs +8 -1
- data/sig/context_dev/models/monitor_update_response.rbs +7 -0
- data/sig/context_dev/models/retry_config.rbs +15 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
- data/sig/context_dev/models/webhook_delivery.rbs +10 -3
- data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
- data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
- data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
- data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
- data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
- data/sig/context_dev/models.rbs +4 -0
- data/sig/context_dev/resources/batch.rbs +1 -0
- data/sig/context_dev/resources/web.rbs +1 -0
- data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
- data/sig/context_dev/resources/webhooks.rbs +9 -0
- metadata +44 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 515f65691600e29045376881e888810e56f7df8cc0c1a65a9b5077f9c72c1258
|
|
4
|
+
data.tar.gz: 521f7a02b0d575c2bb3f624b73dbdd8ec3fcd892fd5f6115016e2f751e9ff470
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e1a0aad5bc3dc9521467690dc7c1d2cc8500a4fed431fed65c89fe9443807a97b8e9ce4badc89abd5918d9bbfd8f223306d26438cc579142bb2f0fde4d6a4492
|
|
7
|
+
data.tar.gz: b9e69f23af6eebf3b8da837b926b6622fa1977afa07b39dac78485e2cb1c798eb5362dca640f5bf9a7f177631ed739944f3ca2837e7e21eb54b316b78977bdef
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.14.0...v2.15.0) (2026-09-08)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **webhooks:** add configurable retries and manual replay ([00388ec](https://github.com/context-dot-dev/context-ruby-sdk/commit/00388ec76d375d7466c9b0d85dfe983d2a369807))
|
|
9
|
+
* **webhooks:** simplify delivery APIs ([fbd879e](https://github.com/context-dot-dev/context-ruby-sdk/commit/fbd879eaa0c0008cba1c3b19f1fe1accb53d8771))
|
|
10
|
+
|
|
11
|
+
## [2.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.13.0...v2.14.0) (2026-09-03)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* **sitemap:** add subdomain discovery ([5630b67](https://github.com/context-dot-dev/context-ruby-sdk/commit/5630b67ab555ab5dabd06b0ade2c4d2837f13423))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* **openapi:** strip empty-object defaults from the generated spec ([fcbb393](https://github.com/context-dot-dev/context-ruby-sdk/commit/fcbb393067fd9058bb2d443bd2a8f2a9e4b8f17c))
|
|
22
|
+
|
|
3
23
|
## [2.13.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.12.0...v2.13.0) (2026-08-27)
|
|
4
24
|
|
|
5
25
|
|
data/README.md
CHANGED
|
@@ -4,15 +4,6 @@ The Context Dev Ruby library provides convenient access to the Context Dev REST
|
|
|
4
4
|
|
|
5
5
|
It is generated with [Stainless](https://www.stainless.com/).
|
|
6
6
|
|
|
7
|
-
## MCP Server
|
|
8
|
-
|
|
9
|
-
Use the Context Dev MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
|
|
10
|
-
|
|
11
|
-
[](https://cursor.com/en-US/install-mcp?name=context.dev-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNvbnRleHQuZGV2LW1jcCJdLCJlbnYiOnsiQ09OVEVYVF9ERVZfQVBJX0tFWSI6Ik15IEFQSSBLZXkifX0)
|
|
12
|
-
[](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22context.dev-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22context.dev-mcp%22%5D%2C%22env%22%3A%7B%22CONTEXT_DEV_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
|
|
13
|
-
|
|
14
|
-
> Note: You may need to set environment variables in your MCP client.
|
|
15
|
-
|
|
16
7
|
## Documentation
|
|
17
8
|
|
|
18
9
|
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/context.dev).
|
|
@@ -26,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
17
|
<!-- x-release-please-start-version -->
|
|
27
18
|
|
|
28
19
|
```ruby
|
|
29
|
-
gem "context.dev", "~> 2.
|
|
20
|
+
gem "context.dev", "~> 2.15.0"
|
|
30
21
|
```
|
|
31
22
|
|
|
32
23
|
<!-- x-release-please-end -->
|
data/lib/context_dev/client.rb
CHANGED
|
@@ -47,6 +47,9 @@ module ContextDev
|
|
|
47
47
|
# @return [ContextDev::Resources::Batch]
|
|
48
48
|
attr_reader :batch
|
|
49
49
|
|
|
50
|
+
# @return [ContextDev::Resources::Webhooks]
|
|
51
|
+
attr_reader :webhooks
|
|
52
|
+
|
|
50
53
|
# @return [ContextDev::Resources::People]
|
|
51
54
|
attr_reader :people
|
|
52
55
|
|
|
@@ -123,6 +126,7 @@ module ContextDev
|
|
|
123
126
|
@utility = ContextDev::Resources::Utility.new(client: self)
|
|
124
127
|
@monitors = ContextDev::Resources::Monitors.new(client: self)
|
|
125
128
|
@batch = ContextDev::Resources::Batch.new(client: self)
|
|
129
|
+
@webhooks = ContextDev::Resources::Webhooks.new(client: self)
|
|
126
130
|
@people = ContextDev::Resources::People.new(client: self)
|
|
127
131
|
@news = ContextDev::Resources::News.new(client: self)
|
|
128
132
|
end
|
|
@@ -19,8 +19,7 @@ module ContextDev
|
|
|
19
19
|
optional :is_product_page, ContextDev::Internal::Type::Boolean
|
|
20
20
|
|
|
21
21
|
# @!attribute key_metadata
|
|
22
|
-
#
|
|
23
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
22
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
24
23
|
#
|
|
25
24
|
# @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
|
|
26
25
|
optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
|
|
@@ -45,7 +44,7 @@ module ContextDev
|
|
|
45
44
|
#
|
|
46
45
|
# @param is_product_page [Boolean] Whether the given URL is a product detail page
|
|
47
46
|
#
|
|
48
|
-
# @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata]
|
|
47
|
+
# @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
49
48
|
#
|
|
50
49
|
# @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
|
|
51
50
|
#
|
|
@@ -97,24 +96,23 @@ module ContextDev
|
|
|
97
96
|
# @see ContextDev::Models::AIExtractProductResponse#key_metadata
|
|
98
97
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
99
98
|
# @!attribute credits_consumed
|
|
100
|
-
#
|
|
99
|
+
# Credits used by this request.
|
|
101
100
|
#
|
|
102
101
|
# @return [Integer]
|
|
103
102
|
required :credits_consumed, Integer
|
|
104
103
|
|
|
105
104
|
# @!attribute credits_remaining
|
|
106
|
-
#
|
|
105
|
+
# Credits remaining for your organization.
|
|
107
106
|
#
|
|
108
107
|
# @return [Integer]
|
|
109
108
|
required :credits_remaining, Integer
|
|
110
109
|
|
|
111
110
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
112
|
-
#
|
|
113
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
111
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
114
112
|
#
|
|
115
|
-
# @param credits_consumed [Integer]
|
|
113
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
116
114
|
#
|
|
117
|
-
# @param credits_remaining [Integer]
|
|
115
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
118
116
|
end
|
|
119
117
|
|
|
120
118
|
# The detected ecommerce platform, or null if not a product page
|
|
@@ -13,8 +13,7 @@ module ContextDev
|
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata }
|
|
14
14
|
|
|
15
15
|
# @!attribute key_metadata
|
|
16
|
-
#
|
|
17
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
16
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
18
17
|
#
|
|
19
18
|
# @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil]
|
|
20
19
|
optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
|
|
@@ -32,7 +31,7 @@ module ContextDev
|
|
|
32
31
|
#
|
|
33
32
|
# @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
34
33
|
#
|
|
35
|
-
# @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata]
|
|
34
|
+
# @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
36
35
|
#
|
|
37
36
|
# @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
|
|
38
37
|
|
|
@@ -82,24 +81,23 @@ module ContextDev
|
|
|
82
81
|
# @see ContextDev::Models::AIExtractProductsResponse#key_metadata
|
|
83
82
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
84
83
|
# @!attribute credits_consumed
|
|
85
|
-
#
|
|
84
|
+
# Credits used by this request.
|
|
86
85
|
#
|
|
87
86
|
# @return [Integer]
|
|
88
87
|
required :credits_consumed, Integer
|
|
89
88
|
|
|
90
89
|
# @!attribute credits_remaining
|
|
91
|
-
#
|
|
90
|
+
# Credits remaining for your organization.
|
|
92
91
|
#
|
|
93
92
|
# @return [Integer]
|
|
94
93
|
required :credits_remaining, Integer
|
|
95
94
|
|
|
96
95
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
97
|
-
#
|
|
98
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
96
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
99
97
|
#
|
|
100
|
-
# @param credits_consumed [Integer]
|
|
98
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
101
99
|
#
|
|
102
|
-
# @param credits_remaining [Integer]
|
|
100
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
103
101
|
end
|
|
104
102
|
|
|
105
103
|
class Product < ContextDev::Internal::Type::BaseModel
|
|
@@ -218,13 +218,13 @@ module ContextDev
|
|
|
218
218
|
# @see ContextDev::Models::BatchCancelResponse#key_metadata
|
|
219
219
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
220
220
|
# @!attribute credits_consumed
|
|
221
|
-
#
|
|
221
|
+
# Credits used by this request.
|
|
222
222
|
#
|
|
223
223
|
# @return [Integer]
|
|
224
224
|
required :credits_consumed, Integer
|
|
225
225
|
|
|
226
226
|
# @!attribute credits_remaining
|
|
227
|
-
#
|
|
227
|
+
# Credits remaining for your organization.
|
|
228
228
|
#
|
|
229
229
|
# @return [Integer]
|
|
230
230
|
required :credits_remaining, Integer
|
|
@@ -232,9 +232,9 @@ module ContextDev
|
|
|
232
232
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
233
233
|
# API key usage for this request.
|
|
234
234
|
#
|
|
235
|
-
# @param credits_consumed [Integer]
|
|
235
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
236
236
|
#
|
|
237
|
-
# @param credits_remaining [Integer]
|
|
237
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
238
238
|
end
|
|
239
239
|
end
|
|
240
240
|
end
|
|
@@ -17,43 +17,38 @@ module ContextDev
|
|
|
17
17
|
optional :deleted, ContextDev::Internal::Type::Boolean
|
|
18
18
|
|
|
19
19
|
# @!attribute key_metadata
|
|
20
|
-
#
|
|
21
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
20
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
22
21
|
#
|
|
23
22
|
# @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
|
|
24
23
|
optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
|
|
25
24
|
|
|
26
25
|
# @!method initialize(id: nil, deleted: nil, key_metadata: nil)
|
|
27
|
-
# Some parameter documentations has been truncated, see
|
|
28
|
-
# {ContextDev::Models::BatchDeleteResponse} for more details.
|
|
29
|
-
#
|
|
30
26
|
# @param id [String] ID of the deleted batch.
|
|
31
27
|
#
|
|
32
28
|
# @param deleted [Boolean] Always true on success.
|
|
33
29
|
#
|
|
34
|
-
# @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata]
|
|
30
|
+
# @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
35
31
|
|
|
36
32
|
# @see ContextDev::Models::BatchDeleteResponse#key_metadata
|
|
37
33
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
38
34
|
# @!attribute credits_consumed
|
|
39
|
-
#
|
|
35
|
+
# Credits used by this request.
|
|
40
36
|
#
|
|
41
37
|
# @return [Integer]
|
|
42
38
|
required :credits_consumed, Integer
|
|
43
39
|
|
|
44
40
|
# @!attribute credits_remaining
|
|
45
|
-
#
|
|
41
|
+
# Credits remaining for your organization.
|
|
46
42
|
#
|
|
47
43
|
# @return [Integer]
|
|
48
44
|
required :credits_remaining, Integer
|
|
49
45
|
|
|
50
46
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
51
|
-
#
|
|
52
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
47
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
53
48
|
#
|
|
54
|
-
# @param credits_consumed [Integer]
|
|
49
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
55
50
|
#
|
|
56
|
-
# @param credits_remaining [Integer]
|
|
51
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
57
52
|
end
|
|
58
53
|
end
|
|
59
54
|
end
|
|
@@ -18,8 +18,7 @@ module ContextDev
|
|
|
18
18
|
optional :has_more, ContextDev::Internal::Type::Boolean
|
|
19
19
|
|
|
20
20
|
# @!attribute key_metadata
|
|
21
|
-
#
|
|
22
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
21
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
23
22
|
#
|
|
24
23
|
# @return [ContextDev::Models::BatchGetResultsResponse::KeyMetadata, nil]
|
|
25
24
|
optional :key_metadata, -> { ContextDev::Models::BatchGetResultsResponse::KeyMetadata }
|
|
@@ -31,14 +30,11 @@ module ContextDev
|
|
|
31
30
|
optional :next_cursor, String, nil?: true
|
|
32
31
|
|
|
33
32
|
# @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
34
|
-
# Some parameter documentations has been truncated, see
|
|
35
|
-
# {ContextDev::Models::BatchGetResultsResponse} for more details.
|
|
36
|
-
#
|
|
37
33
|
# @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
|
|
38
34
|
#
|
|
39
35
|
# @param has_more [Boolean] Whether another page is available.
|
|
40
36
|
#
|
|
41
|
-
# @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata]
|
|
37
|
+
# @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
42
38
|
#
|
|
43
39
|
# @param next_cursor [String, nil] Cursor for the next page.
|
|
44
40
|
|
|
@@ -536,24 +532,23 @@ module ContextDev
|
|
|
536
532
|
# @see ContextDev::Models::BatchGetResultsResponse#key_metadata
|
|
537
533
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
538
534
|
# @!attribute credits_consumed
|
|
539
|
-
#
|
|
535
|
+
# Credits used by this request.
|
|
540
536
|
#
|
|
541
537
|
# @return [Integer]
|
|
542
538
|
required :credits_consumed, Integer
|
|
543
539
|
|
|
544
540
|
# @!attribute credits_remaining
|
|
545
|
-
#
|
|
541
|
+
# Credits remaining for your organization.
|
|
546
542
|
#
|
|
547
543
|
# @return [Integer]
|
|
548
544
|
required :credits_remaining, Integer
|
|
549
545
|
|
|
550
546
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
551
|
-
#
|
|
552
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
547
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
553
548
|
#
|
|
554
|
-
# @param credits_consumed [Integer]
|
|
549
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
555
550
|
#
|
|
556
|
-
# @param credits_remaining [Integer]
|
|
551
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
557
552
|
end
|
|
558
553
|
end
|
|
559
554
|
end
|
|
@@ -17,8 +17,7 @@ module ContextDev
|
|
|
17
17
|
optional :has_more, ContextDev::Internal::Type::Boolean
|
|
18
18
|
|
|
19
19
|
# @!attribute key_metadata
|
|
20
|
-
#
|
|
21
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
20
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
22
21
|
#
|
|
23
22
|
# @return [ContextDev::Models::BatchListResponse::KeyMetadata, nil]
|
|
24
23
|
optional :key_metadata, -> { ContextDev::Models::BatchListResponse::KeyMetadata }
|
|
@@ -30,14 +29,11 @@ module ContextDev
|
|
|
30
29
|
optional :next_cursor, String, nil?: true
|
|
31
30
|
|
|
32
31
|
# @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
|
|
33
|
-
# Some parameter documentations has been truncated, see
|
|
34
|
-
# {ContextDev::Models::BatchListResponse} for more details.
|
|
35
|
-
#
|
|
36
32
|
# @param data [Array<ContextDev::Models::BatchListResponse::Data>] Batches on this page.
|
|
37
33
|
#
|
|
38
34
|
# @param has_more [Boolean] Whether another page is available.
|
|
39
35
|
#
|
|
40
|
-
# @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata]
|
|
36
|
+
# @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
41
37
|
#
|
|
42
38
|
# @param next_cursor [String, nil] Cursor for the next page.
|
|
43
39
|
|
|
@@ -364,24 +360,23 @@ module ContextDev
|
|
|
364
360
|
# @see ContextDev::Models::BatchListResponse#key_metadata
|
|
365
361
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
366
362
|
# @!attribute credits_consumed
|
|
367
|
-
#
|
|
363
|
+
# Credits used by this request.
|
|
368
364
|
#
|
|
369
365
|
# @return [Integer]
|
|
370
366
|
required :credits_consumed, Integer
|
|
371
367
|
|
|
372
368
|
# @!attribute credits_remaining
|
|
373
|
-
#
|
|
369
|
+
# Credits remaining for your organization.
|
|
374
370
|
#
|
|
375
371
|
# @return [Integer]
|
|
376
372
|
required :credits_remaining, Integer
|
|
377
373
|
|
|
378
374
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
379
|
-
#
|
|
380
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
375
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
381
376
|
#
|
|
382
|
-
# @param credits_consumed [Integer]
|
|
377
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
383
378
|
#
|
|
384
|
-
# @param credits_remaining [Integer]
|
|
379
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
385
380
|
end
|
|
386
381
|
end
|
|
387
382
|
end
|
|
@@ -99,7 +99,13 @@ module ContextDev
|
|
|
99
99
|
# @return [ContextDev::Models::BatchRetrieveResponse::KeyMetadata, nil]
|
|
100
100
|
optional :key_metadata, -> { ContextDev::Models::BatchRetrieveResponse::KeyMetadata }
|
|
101
101
|
|
|
102
|
-
# @!
|
|
102
|
+
# @!attribute webhook_delivery_id
|
|
103
|
+
# Batch completion delivery ID, when available.
|
|
104
|
+
#
|
|
105
|
+
# @return [String, nil]
|
|
106
|
+
optional :webhook_delivery_id, String
|
|
107
|
+
|
|
108
|
+
# @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
|
|
103
109
|
# Some parameter documentations has been truncated, see
|
|
104
110
|
# {ContextDev::Models::BatchRetrieveResponse} for more details.
|
|
105
111
|
#
|
|
@@ -133,6 +139,8 @@ module ContextDev
|
|
|
133
139
|
# @param timing [ContextDev::Models::BatchRetrieveResponse::Timing]
|
|
134
140
|
#
|
|
135
141
|
# @param key_metadata [ContextDev::Models::BatchRetrieveResponse::KeyMetadata] API key usage for this request.
|
|
142
|
+
#
|
|
143
|
+
# @param webhook_delivery_id [String] Batch completion delivery ID, when available.
|
|
136
144
|
|
|
137
145
|
# @see ContextDev::Models::BatchRetrieveResponse#credits
|
|
138
146
|
class Credits < ContextDev::Internal::Type::BaseModel
|
|
@@ -359,13 +367,13 @@ module ContextDev
|
|
|
359
367
|
# @see ContextDev::Models::BatchRetrieveResponse#key_metadata
|
|
360
368
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
361
369
|
# @!attribute credits_consumed
|
|
362
|
-
#
|
|
370
|
+
# Credits used by this request.
|
|
363
371
|
#
|
|
364
372
|
# @return [Integer]
|
|
365
373
|
required :credits_consumed, Integer
|
|
366
374
|
|
|
367
375
|
# @!attribute credits_remaining
|
|
368
|
-
#
|
|
376
|
+
# Credits remaining for your organization.
|
|
369
377
|
#
|
|
370
378
|
# @return [Integer]
|
|
371
379
|
required :credits_remaining, Integer
|
|
@@ -373,9 +381,9 @@ module ContextDev
|
|
|
373
381
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
374
382
|
# API key usage for this request.
|
|
375
383
|
#
|
|
376
|
-
# @param credits_consumed [Integer]
|
|
384
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
377
385
|
#
|
|
378
|
-
# @param credits_remaining [Integer]
|
|
386
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
379
387
|
end
|
|
380
388
|
end
|
|
381
389
|
end
|
|
@@ -19,8 +19,16 @@ module ContextDev
|
|
|
19
19
|
# @return [Array<String>, nil]
|
|
20
20
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
21
21
|
|
|
22
|
+
# @!attribute webhook
|
|
23
|
+
# Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
|
|
24
|
+
# preserves legacy delivery; retry: {} opts into durable retries.
|
|
25
|
+
#
|
|
26
|
+
# @return [ContextDev::Models::BatchSubmitParams::Webhook, nil]
|
|
27
|
+
optional :webhook, -> { ContextDev::BatchSubmitParams::Webhook }
|
|
28
|
+
|
|
22
29
|
# @!attribute webhook_url
|
|
23
|
-
# URL notified when the batch finishes.
|
|
30
|
+
# Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
|
|
31
|
+
# Cannot be combined with webhook.
|
|
24
32
|
#
|
|
25
33
|
# @return [String, nil]
|
|
26
34
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
@@ -32,7 +40,7 @@ module ContextDev
|
|
|
32
40
|
# @return [String, nil]
|
|
33
41
|
optional :idempotency_key, String
|
|
34
42
|
|
|
35
|
-
# @!method initialize(input:, tags: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
|
|
43
|
+
# @!method initialize(input:, tags: nil, webhook: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
|
|
36
44
|
# Some parameter documentations has been truncated, see
|
|
37
45
|
# {ContextDev::Models::BatchSubmitParams} for more details.
|
|
38
46
|
#
|
|
@@ -40,7 +48,9 @@ module ContextDev
|
|
|
40
48
|
#
|
|
41
49
|
# @param tags [Array<String>] Tags stored on the batch. Filter the batch list by them later.
|
|
42
50
|
#
|
|
43
|
-
# @param
|
|
51
|
+
# @param webhook [ContextDev::Models::BatchSubmitParams::Webhook] Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
|
|
52
|
+
#
|
|
53
|
+
# @param webhook_url [String] Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
|
|
44
54
|
#
|
|
45
55
|
# @param idempotency_key [String] Any string unique to this submission. Retries with the same key return the origi
|
|
46
56
|
#
|
|
@@ -2105,6 +2115,27 @@ module ContextDev
|
|
|
2105
2115
|
# @!method self.variants
|
|
2106
2116
|
# @return [Array(ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl)]
|
|
2107
2117
|
end
|
|
2118
|
+
|
|
2119
|
+
class Webhook < ContextDev::Internal::Type::BaseModel
|
|
2120
|
+
# @!attribute url
|
|
2121
|
+
#
|
|
2122
|
+
# @return [String]
|
|
2123
|
+
required :url, String
|
|
2124
|
+
|
|
2125
|
+
# @!attribute retry_
|
|
2126
|
+
# Webhook retry settings. Use {} for the default schedule.
|
|
2127
|
+
#
|
|
2128
|
+
# @return [ContextDev::Models::RetryConfig, nil]
|
|
2129
|
+
optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
|
|
2130
|
+
|
|
2131
|
+
# @!method initialize(url:, retry_: nil)
|
|
2132
|
+
# Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
|
|
2133
|
+
# preserves legacy delivery; retry: {} opts into durable retries.
|
|
2134
|
+
#
|
|
2135
|
+
# @param url [String]
|
|
2136
|
+
#
|
|
2137
|
+
# @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
|
|
2138
|
+
end
|
|
2108
2139
|
end
|
|
2109
2140
|
end
|
|
2110
2141
|
end
|
|
@@ -238,13 +238,13 @@ module ContextDev
|
|
|
238
238
|
# @see ContextDev::Models::BatchSubmitResponse#key_metadata
|
|
239
239
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
240
240
|
# @!attribute credits_consumed
|
|
241
|
-
#
|
|
241
|
+
# Credits used by this request.
|
|
242
242
|
#
|
|
243
243
|
# @return [Integer]
|
|
244
244
|
required :credits_consumed, Integer
|
|
245
245
|
|
|
246
246
|
# @!attribute credits_remaining
|
|
247
|
-
#
|
|
247
|
+
# Credits remaining for your organization.
|
|
248
248
|
#
|
|
249
249
|
# @return [Integer]
|
|
250
250
|
required :credits_remaining, Integer
|
|
@@ -252,9 +252,9 @@ module ContextDev
|
|
|
252
252
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
253
253
|
# API key usage for this request.
|
|
254
254
|
#
|
|
255
|
-
# @param credits_consumed [Integer]
|
|
255
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
256
256
|
#
|
|
257
|
-
# @param credits_remaining [Integer]
|
|
257
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
258
258
|
end
|
|
259
259
|
end
|
|
260
260
|
end
|
|
@@ -25,8 +25,7 @@ module ContextDev
|
|
|
25
25
|
optional :code, Integer
|
|
26
26
|
|
|
27
27
|
# @!attribute key_metadata
|
|
28
|
-
#
|
|
29
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
28
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
30
29
|
#
|
|
31
30
|
# @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil]
|
|
32
31
|
optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata }
|
|
@@ -47,7 +46,7 @@ module ContextDev
|
|
|
47
46
|
#
|
|
48
47
|
# @param code [Integer] HTTP status code
|
|
49
48
|
#
|
|
50
|
-
# @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata]
|
|
49
|
+
# @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
51
50
|
#
|
|
52
51
|
# @param status [String] Status of the response, e.g., 'ok'
|
|
53
52
|
|
|
@@ -1176,24 +1175,23 @@ module ContextDev
|
|
|
1176
1175
|
# @see ContextDev::Models::BrandRetrieveResponse#key_metadata
|
|
1177
1176
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
1178
1177
|
# @!attribute credits_consumed
|
|
1179
|
-
#
|
|
1178
|
+
# Credits used by this request.
|
|
1180
1179
|
#
|
|
1181
1180
|
# @return [Integer]
|
|
1182
1181
|
required :credits_consumed, Integer
|
|
1183
1182
|
|
|
1184
1183
|
# @!attribute credits_remaining
|
|
1185
|
-
#
|
|
1184
|
+
# Credits remaining for your organization.
|
|
1186
1185
|
#
|
|
1187
1186
|
# @return [Integer]
|
|
1188
1187
|
required :credits_remaining, Integer
|
|
1189
1188
|
|
|
1190
1189
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
1191
|
-
#
|
|
1192
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
1190
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
1193
1191
|
#
|
|
1194
|
-
# @param credits_consumed [Integer]
|
|
1192
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
1195
1193
|
#
|
|
1196
|
-
# @param credits_remaining [Integer]
|
|
1194
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
1197
1195
|
end
|
|
1198
1196
|
end
|
|
1199
1197
|
end
|
|
@@ -23,9 +23,8 @@ module ContextDev
|
|
|
23
23
|
optional :max_age_ms, Integer, nil?: true
|
|
24
24
|
|
|
25
25
|
# @!attribute tags
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
26
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
27
|
+
# characters.
|
|
29
28
|
#
|
|
30
29
|
# @return [Array<String>, nil]
|
|
31
30
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -52,7 +51,7 @@ module ContextDev
|
|
|
52
51
|
#
|
|
53
52
|
# @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
|
|
54
53
|
#
|
|
55
|
-
# @param tags [Array<String>]
|
|
54
|
+
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
56
55
|
#
|
|
57
56
|
# @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
|
|
58
57
|
#
|
|
@@ -25,8 +25,7 @@ module ContextDev
|
|
|
25
25
|
optional :code, Integer
|
|
26
26
|
|
|
27
27
|
# @!attribute key_metadata
|
|
28
|
-
#
|
|
29
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
28
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
30
29
|
#
|
|
31
30
|
# @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
|
|
32
31
|
optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
|
|
@@ -47,7 +46,7 @@ module ContextDev
|
|
|
47
46
|
#
|
|
48
47
|
# @param code [Integer] HTTP status code of the response
|
|
49
48
|
#
|
|
50
|
-
# @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata]
|
|
49
|
+
# @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
51
50
|
#
|
|
52
51
|
# @param status [String] Status of the response, e.g., 'ok'
|
|
53
52
|
|
|
@@ -401,24 +400,23 @@ module ContextDev
|
|
|
401
400
|
# @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata
|
|
402
401
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
403
402
|
# @!attribute credits_consumed
|
|
404
|
-
#
|
|
403
|
+
# Credits used by this request.
|
|
405
404
|
#
|
|
406
405
|
# @return [Integer]
|
|
407
406
|
required :credits_consumed, Integer
|
|
408
407
|
|
|
409
408
|
# @!attribute credits_remaining
|
|
410
|
-
#
|
|
409
|
+
# Credits remaining for your organization.
|
|
411
410
|
#
|
|
412
411
|
# @return [Integer]
|
|
413
412
|
required :credits_remaining, Integer
|
|
414
413
|
|
|
415
414
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
416
|
-
#
|
|
417
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
415
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
418
416
|
#
|
|
419
|
-
# @param credits_consumed [Integer]
|
|
417
|
+
# @param credits_consumed [Integer] Credits used by this request.
|
|
420
418
|
#
|
|
421
|
-
# @param credits_remaining [Integer]
|
|
419
|
+
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
422
420
|
end
|
|
423
421
|
end
|
|
424
422
|
end
|