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.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -10
  4. data/lib/context_dev/client.rb +4 -0
  5. data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
  6. data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
  7. data/lib/context_dev/models/batch_cancel_response.rb +4 -4
  8. data/lib/context_dev/models/batch_delete_response.rb +7 -12
  9. data/lib/context_dev/models/batch_get_results_response.rb +7 -12
  10. data/lib/context_dev/models/batch_list_response.rb +7 -12
  11. data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
  12. data/lib/context_dev/models/batch_submit_params.rb +34 -3
  13. data/lib/context_dev/models/batch_submit_response.rb +4 -4
  14. data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
  15. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
  16. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
  17. data/lib/context_dev/models/brand_search_params.rb +3 -4
  18. data/lib/context_dev/models/brand_search_response.rb +7 -9
  19. data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
  20. data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
  21. data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
  22. data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
  23. data/lib/context_dev/models/monitor_create_params.rb +9 -1
  24. data/lib/context_dev/models/monitor_create_response.rb +9 -1
  25. data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
  26. data/lib/context_dev/models/monitor_list_response.rb +9 -1
  27. data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
  28. data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
  29. data/lib/context_dev/models/monitor_update_params.rb +9 -1
  30. data/lib/context_dev/models/monitor_update_response.rb +9 -1
  31. data/lib/context_dev/models/news_search_response.rb +7 -9
  32. data/lib/context_dev/models/parse_handle_params.rb +3 -4
  33. data/lib/context_dev/models/parse_handle_response.rb +7 -12
  34. data/lib/context_dev/models/person_enrich_response.rb +7 -12
  35. data/lib/context_dev/models/retry_config.rb +22 -0
  36. data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
  37. data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
  38. data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
  39. data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
  40. data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
  41. data/lib/context_dev/models/web_extract_response.rb +7 -9
  42. data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
  43. data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
  44. data/lib/context_dev/models/web_screenshot_params.rb +3 -4
  45. data/lib/context_dev/models/web_screenshot_response.rb +7 -9
  46. data/lib/context_dev/models/web_search_response.rb +7 -9
  47. data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
  48. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
  49. data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
  50. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
  51. data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
  52. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
  53. data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
  54. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +13 -5
  55. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
  56. data/lib/context_dev/models/webhook_delivery.rb +9 -1
  57. data/lib/context_dev/models/webhooks/attempt.rb +102 -0
  58. data/lib/context_dev/models/webhooks/delivery.rb +253 -0
  59. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
  60. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
  61. data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
  62. data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
  63. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
  64. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
  65. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
  66. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
  67. data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
  68. data/lib/context_dev/models.rb +4 -0
  69. data/lib/context_dev/resources/batch.rb +4 -2
  70. data/lib/context_dev/resources/brand.rb +2 -2
  71. data/lib/context_dev/resources/industry.rb +2 -2
  72. data/lib/context_dev/resources/parse.rb +1 -1
  73. data/lib/context_dev/resources/web.rb +18 -14
  74. data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
  75. data/lib/context_dev/resources/webhooks.rb +19 -0
  76. data/lib/context_dev/version.rb +1 -1
  77. data/lib/context_dev.rb +14 -0
  78. data/rbi/context_dev/client.rbi +3 -0
  79. data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
  80. data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
  81. data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
  82. data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
  83. data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
  84. data/rbi/context_dev/models/batch_list_response.rbi +7 -10
  85. data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
  86. data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
  87. data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
  88. data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
  89. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
  90. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
  91. data/rbi/context_dev/models/brand_search_params.rbi +4 -6
  92. data/rbi/context_dev/models/brand_search_response.rbi +7 -10
  93. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
  94. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
  95. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
  96. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
  97. data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
  98. data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
  99. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
  100. data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
  101. data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
  102. data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
  103. data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
  104. data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
  105. data/rbi/context_dev/models/news_search_response.rbi +7 -10
  106. data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
  107. data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
  108. data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
  109. data/rbi/context_dev/models/retry_config.rbi +35 -0
  110. data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
  111. data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
  112. data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
  113. data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
  114. data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
  115. data/rbi/context_dev/models/web_extract_response.rbi +7 -10
  116. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
  117. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
  118. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
  119. data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
  120. data/rbi/context_dev/models/web_search_response.rbi +7 -10
  121. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
  122. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
  123. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
  124. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
  125. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
  126. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
  127. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
  128. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +17 -6
  129. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
  130. data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
  131. data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
  132. data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
  133. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
  134. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
  135. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
  136. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
  137. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
  138. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
  139. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
  140. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
  141. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
  142. data/rbi/context_dev/models.rbi +4 -0
  143. data/rbi/context_dev/resources/batch.rbi +6 -1
  144. data/rbi/context_dev/resources/brand.rbi +4 -6
  145. data/rbi/context_dev/resources/industry.rbi +4 -6
  146. data/rbi/context_dev/resources/parse.rbi +2 -3
  147. data/rbi/context_dev/resources/web.rbi +26 -29
  148. data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
  149. data/rbi/context_dev/resources/webhooks.rbi +16 -0
  150. data/sig/context_dev/client.rbs +2 -0
  151. data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
  152. data/sig/context_dev/models/batch_submit_params.rbs +23 -0
  153. data/sig/context_dev/models/monitor_create_params.rbs +8 -1
  154. data/sig/context_dev/models/monitor_create_response.rbs +7 -0
  155. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
  156. data/sig/context_dev/models/monitor_list_response.rbs +7 -0
  157. data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
  158. data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
  159. data/sig/context_dev/models/monitor_update_params.rbs +8 -1
  160. data/sig/context_dev/models/monitor_update_response.rbs +7 -0
  161. data/sig/context_dev/models/retry_config.rbs +15 -0
  162. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
  163. data/sig/context_dev/models/webhook_delivery.rbs +10 -3
  164. data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
  165. data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
  166. data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
  167. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
  168. data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
  169. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
  170. data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
  171. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
  172. data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
  173. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
  174. data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
  175. data/sig/context_dev/models.rbs +4 -0
  176. data/sig/context_dev/resources/batch.rbs +1 -0
  177. data/sig/context_dev/resources/web.rbs +1 -0
  178. data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
  179. data/sig/context_dev/resources/webhooks.rbs +9 -0
  180. metadata +44 -2
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ class RetryConfig < ContextDev::Internal::Type::BaseModel
6
+ # @!attribute delays_seconds
7
+ # Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
8
+ # retries.
9
+ #
10
+ # @return [Array<Integer>, nil]
11
+ optional :delays_seconds, ContextDev::Internal::Type::ArrayOf[Integer]
12
+
13
+ # @!method initialize(delays_seconds: nil)
14
+ # Some parameter documentations has been truncated, see
15
+ # {ContextDev::Models::RetryConfig} for more details.
16
+ #
17
+ # Webhook retry settings. Use {} for the default schedule.
18
+ #
19
+ # @param delays_seconds [Array<Integer>] Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
20
+ end
21
+ end
22
+ end
@@ -11,8 +11,7 @@ module ContextDev
11
11
  optional :domain, String
12
12
 
13
13
  # @!attribute key_metadata
14
- # Metadata about the API key used for the request. Included in every response
15
- # whenever a valid API key is provided, even when the response status is not 200.
14
+ # Credit usage, included whenever a valid API key is provided.
16
15
  #
17
16
  # @return [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, nil]
18
17
  optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchResponse::KeyMetadata }
@@ -36,12 +35,9 @@ module ContextDev
36
35
  optional :type, enum: -> { ContextDev::Models::UtilityPrefetchResponse::Type }
37
36
 
38
37
  # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
39
- # Some parameter documentations has been truncated, see
40
- # {ContextDev::Models::UtilityPrefetchResponse} for more details.
41
- #
42
38
  # @param domain [String] The domain that was queued for prefetching
43
39
  #
44
- # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
40
+ # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
45
41
  #
46
42
  # @param message [String] Success message
47
43
  #
@@ -52,24 +48,23 @@ module ContextDev
52
48
  # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata
53
49
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
54
50
  # @!attribute credits_consumed
55
- # The number of credits consumed by this request.
51
+ # Credits used by this request.
56
52
  #
57
53
  # @return [Integer]
58
54
  required :credits_consumed, Integer
59
55
 
60
56
  # @!attribute credits_remaining
61
- # The number of credits remaining for your organization after this request.
57
+ # Credits remaining for your organization.
62
58
  #
63
59
  # @return [Integer]
64
60
  required :credits_remaining, Integer
65
61
 
66
62
  # @!method initialize(credits_consumed:, credits_remaining:)
67
- # Metadata about the API key used for the request. Included in every response
68
- # whenever a valid API key is provided, even when the response status is not 200.
63
+ # Credit usage, included whenever a valid API key is provided.
69
64
  #
70
- # @param credits_consumed [Integer] The number of credits consumed by this request.
65
+ # @param credits_consumed [Integer] Credits used by this request.
71
66
  #
72
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
67
+ # @param credits_remaining [Integer] Credits remaining for your organization.
73
68
  end
74
69
 
75
70
  # The type of prefetch that was queued, echoed from the request
@@ -21,9 +21,8 @@ module ContextDev
21
21
  optional :num_competitors, Integer
22
22
 
23
23
  # @!attribute tags
24
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
25
- # recorded on the request's usage log and can be used to filter usage on the
26
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
24
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
25
+ # characters.
27
26
  #
28
27
  # @return [Array<String>, nil]
29
28
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -44,7 +43,7 @@ module ContextDev
44
43
  #
45
44
  # @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5.
46
45
  #
47
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
46
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
48
47
  #
49
48
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
50
49
  #
@@ -30,16 +30,12 @@ module ContextDev
30
30
  required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target }
31
31
 
32
32
  # @!attribute key_metadata
33
- # Metadata about the API key used for the request. Included in every response
34
- # whenever a valid API key is provided, even when the response status is not 200.
33
+ # Credit usage, included whenever a valid API key is provided.
35
34
  #
36
35
  # @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil]
37
36
  optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
38
37
 
39
38
  # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil)
40
- # Some parameter documentations has been truncated, see
41
- # {ContextDev::Models::WebExtractCompetitorsResponse} for more details.
42
- #
43
39
  # @param competitors [Array<ContextDev::Models::WebExtractCompetitorsResponse::Competitor>] Direct competitors ordered by relevance and confidence.
44
40
  #
45
41
  # @param domain [String] Normalized input domain.
@@ -48,7 +44,7 @@ module ContextDev
48
44
  #
49
45
  # @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
50
46
  #
51
- # @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
47
+ # @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
52
48
 
53
49
  class Competitor < ContextDev::Internal::Type::BaseModel
54
50
  # @!attribute confidence
@@ -168,24 +164,23 @@ module ContextDev
168
164
  # @see ContextDev::Models::WebExtractCompetitorsResponse#key_metadata
169
165
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
170
166
  # @!attribute credits_consumed
171
- # The number of credits consumed by this request.
167
+ # Credits used by this request.
172
168
  #
173
169
  # @return [Integer]
174
170
  required :credits_consumed, Integer
175
171
 
176
172
  # @!attribute credits_remaining
177
- # The number of credits remaining for your organization after this request.
173
+ # Credits remaining for your organization.
178
174
  #
179
175
  # @return [Integer]
180
176
  required :credits_remaining, Integer
181
177
 
182
178
  # @!method initialize(credits_consumed:, credits_remaining:)
183
- # Metadata about the API key used for the request. Included in every response
184
- # whenever a valid API key is provided, even when the response status is not 200.
179
+ # Credit usage, included whenever a valid API key is provided.
185
180
  #
186
- # @param credits_consumed [Integer] The number of credits consumed by this request.
181
+ # @param credits_consumed [Integer] Credits used by this request.
187
182
  #
188
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
183
+ # @param credits_remaining [Integer] Credits remaining for your organization.
189
184
  end
190
185
  end
191
186
  end
@@ -33,9 +33,8 @@ module ContextDev
33
33
  optional :max_age_ms, Integer, nil?: true
34
34
 
35
35
  # @!attribute tags
36
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
37
- # recorded on the request's usage log and can be used to filter usage on the
38
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
36
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
37
+ # characters.
39
38
  #
40
39
  # @return [Array<String>, nil]
41
40
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -58,7 +57,7 @@ module ContextDev
58
57
  #
59
58
  # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
60
59
  #
61
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
60
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
62
61
  #
63
62
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
64
63
  #
@@ -48,8 +48,7 @@ module ContextDev
48
48
  api_name: :fontLinks
49
49
 
50
50
  # @!attribute key_metadata
51
- # Metadata about the API key used for the request. Included in every response
52
- # whenever a valid API key is provided, even when the response status is not 200.
51
+ # Credit usage, included whenever a valid API key is provided.
53
52
  #
54
53
  # @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil]
55
54
  optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata }
@@ -70,7 +69,7 @@ module ContextDev
70
69
  #
71
70
  # @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n
72
71
  #
73
- # @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
72
+ # @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
74
73
 
75
74
  # @see ContextDev::Models::WebExtractFontsResponse#cache_metadata
76
75
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -229,24 +228,23 @@ module ContextDev
229
228
  # @see ContextDev::Models::WebExtractFontsResponse#key_metadata
230
229
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
231
230
  # @!attribute credits_consumed
232
- # The number of credits consumed by this request.
231
+ # Credits used by this request.
233
232
  #
234
233
  # @return [Integer]
235
234
  required :credits_consumed, Integer
236
235
 
237
236
  # @!attribute credits_remaining
238
- # The number of credits remaining for your organization after this request.
237
+ # Credits remaining for your organization.
239
238
  #
240
239
  # @return [Integer]
241
240
  required :credits_remaining, Integer
242
241
 
243
242
  # @!method initialize(credits_consumed:, credits_remaining:)
244
- # Metadata about the API key used for the request. Included in every response
245
- # whenever a valid API key is provided, even when the response status is not 200.
243
+ # Credit usage, included whenever a valid API key is provided.
246
244
  #
247
- # @param credits_consumed [Integer] The number of credits consumed by this request.
245
+ # @param credits_consumed [Integer] Credits used by this request.
248
246
  #
249
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
247
+ # @param credits_remaining [Integer] Credits remaining for your organization.
250
248
  end
251
249
  end
252
250
  end
@@ -42,8 +42,7 @@ module ContextDev
42
42
  required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
43
43
 
44
44
  # @!attribute key_metadata
45
- # Metadata about the API key used for the request. Included in every response
46
- # whenever a valid API key is provided, even when the response status is not 200.
45
+ # Credit usage, included whenever a valid API key is provided.
47
46
  #
48
47
  # @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
49
48
  optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
@@ -64,7 +63,7 @@ module ContextDev
64
63
  #
65
64
  # @param urls_analyzed [Array<String>] List of URLs whose Markdown was used for extraction
66
65
  #
67
- # @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
66
+ # @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
68
67
 
69
68
  # @see ContextDev::Models::WebExtractResponse#cache_metadata
70
69
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -247,24 +246,23 @@ module ContextDev
247
246
  # @see ContextDev::Models::WebExtractResponse#key_metadata
248
247
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
249
248
  # @!attribute credits_consumed
250
- # The number of credits consumed by this request.
249
+ # Credits used by this request.
251
250
  #
252
251
  # @return [Integer]
253
252
  required :credits_consumed, Integer
254
253
 
255
254
  # @!attribute credits_remaining
256
- # The number of credits remaining for your organization after this request.
255
+ # Credits remaining for your organization.
257
256
  #
258
257
  # @return [Integer]
259
258
  required :credits_remaining, Integer
260
259
 
261
260
  # @!method initialize(credits_consumed:, credits_remaining:)
262
- # Metadata about the API key used for the request. Included in every response
263
- # whenever a valid API key is provided, even when the response status is not 200.
261
+ # Credit usage, included whenever a valid API key is provided.
264
262
  #
265
- # @param credits_consumed [Integer] The number of credits consumed by this request.
263
+ # @param credits_consumed [Integer] Credits used by this request.
266
264
  #
267
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
265
+ # @param credits_remaining [Integer] Credits remaining for your organization.
268
266
  end
269
267
  end
270
268
  end
@@ -41,9 +41,8 @@ module ContextDev
41
41
  optional :max_age_ms, Integer, nil?: true
42
42
 
43
43
  # @!attribute tags
44
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
45
- # recorded on the request's usage log and can be used to filter usage on the
46
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
44
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
45
+ # characters.
47
46
  #
48
47
  # @return [Array<String>, nil]
49
48
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -68,7 +67,7 @@ module ContextDev
68
67
  #
69
68
  # @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
70
69
  #
71
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
70
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
72
71
  #
73
72
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
74
73
  #
@@ -25,8 +25,7 @@ module ContextDev
25
25
  optional :domain, String
26
26
 
27
27
  # @!attribute key_metadata
28
- # Metadata about the API key used for the request. Included in every response
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::WebExtractStyleguideResponse::KeyMetadata, nil]
32
31
  optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata }
@@ -53,7 +52,7 @@ module ContextDev
53
52
  #
54
53
  # @param domain [String] The normalized domain that was processed
55
54
  #
56
- # @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
55
+ # @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
57
56
  #
58
57
  # @param status [String] Status of the response, e.g., 'ok'
59
58
  #
@@ -106,24 +105,23 @@ module ContextDev
106
105
  # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata
107
106
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
108
107
  # @!attribute credits_consumed
109
- # The number of credits consumed by this request.
108
+ # Credits used by this request.
110
109
  #
111
110
  # @return [Integer]
112
111
  required :credits_consumed, Integer
113
112
 
114
113
  # @!attribute credits_remaining
115
- # The number of credits remaining for your organization after this request.
114
+ # Credits remaining for your organization.
116
115
  #
117
116
  # @return [Integer]
118
117
  required :credits_remaining, Integer
119
118
 
120
119
  # @!method initialize(credits_consumed:, credits_remaining:)
121
- # Metadata about the API key used for the request. Included in every response
122
- # whenever a valid API key is provided, even when the response status is not 200.
120
+ # Credit usage, included whenever a valid API key is provided.
123
121
  #
124
- # @param credits_consumed [Integer] The number of credits consumed by this request.
122
+ # @param credits_consumed [Integer] Credits used by this request.
125
123
  #
126
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
124
+ # @param credits_remaining [Integer] Credits remaining for your organization.
127
125
  end
128
126
 
129
127
  # @see ContextDev::Models::WebExtractStyleguideResponse#styleguide
@@ -93,9 +93,8 @@ module ContextDev
93
93
  optional :scroll_offset, Integer, nil?: true
94
94
 
95
95
  # @!attribute tags
96
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
97
- # recorded on the request's usage log and can be used to filter usage on the
98
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
96
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
97
+ # characters.
99
98
  #
100
99
  # @return [Array<String>, nil]
101
100
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -155,7 +154,7 @@ module ContextDev
155
154
  #
156
155
  # @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
157
156
  #
158
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
157
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
159
158
  #
160
159
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
161
160
  #
@@ -31,8 +31,7 @@ module ContextDev
31
31
  optional :height, Integer
32
32
 
33
33
  # @!attribute key_metadata
34
- # Metadata about the API key used for the request. Included in every response
35
- # whenever a valid API key is provided, even when the response status is not 200.
34
+ # Credit usage, included whenever a valid API key is provided.
36
35
  #
37
36
  # @return [ContextDev::Models::WebScreenshotResponse::KeyMetadata, nil]
38
37
  optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
@@ -76,7 +75,7 @@ module ContextDev
76
75
  #
77
76
  # @param height [Integer] Height in pixels of the returned screenshot image
78
77
  #
79
- # @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
78
+ # @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
80
79
  #
81
80
  # @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR is ena
82
81
  #
@@ -132,24 +131,23 @@ module ContextDev
132
131
  # @see ContextDev::Models::WebScreenshotResponse#key_metadata
133
132
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
134
133
  # @!attribute credits_consumed
135
- # The number of credits consumed by this request.
134
+ # Credits used by this request.
136
135
  #
137
136
  # @return [Integer]
138
137
  required :credits_consumed, Integer
139
138
 
140
139
  # @!attribute credits_remaining
141
- # The number of credits remaining for your organization after this request.
140
+ # Credits remaining for your organization.
142
141
  #
143
142
  # @return [Integer]
144
143
  required :credits_remaining, Integer
145
144
 
146
145
  # @!method initialize(credits_consumed:, credits_remaining:)
147
- # Metadata about the API key used for the request. Included in every response
148
- # whenever a valid API key is provided, even when the response status is not 200.
146
+ # Credit usage, included whenever a valid API key is provided.
149
147
  #
150
- # @param credits_consumed [Integer] The number of credits consumed by this request.
148
+ # @param credits_consumed [Integer] Credits used by this request.
151
149
  #
152
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
150
+ # @param credits_remaining [Integer] Credits remaining for your organization.
153
151
  end
154
152
 
155
153
  # Type of screenshot that was captured
@@ -25,8 +25,7 @@ module ContextDev
25
25
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result] }
26
26
 
27
27
  # @!attribute key_metadata
28
- # Metadata about the API key used for the request. Included in every response
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::WebSearchResponse::KeyMetadata, nil]
32
31
  optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
@@ -41,7 +40,7 @@ module ContextDev
41
40
  #
42
41
  # @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
43
42
  #
44
- # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
43
+ # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
45
44
 
46
45
  # @see ContextDev::Models::WebSearchResponse#cache_metadata
47
46
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -189,24 +188,23 @@ module ContextDev
189
188
  # @see ContextDev::Models::WebSearchResponse#key_metadata
190
189
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
191
190
  # @!attribute credits_consumed
192
- # The number of credits consumed by this request.
191
+ # Credits used by this request.
193
192
  #
194
193
  # @return [Integer]
195
194
  required :credits_consumed, Integer
196
195
 
197
196
  # @!attribute credits_remaining
198
- # The number of credits remaining for your organization after this request.
197
+ # Credits remaining for your organization.
199
198
  #
200
199
  # @return [Integer]
201
200
  required :credits_remaining, Integer
202
201
 
203
202
  # @!method initialize(credits_consumed:, credits_remaining:)
204
- # Metadata about the API key used for the request. Included in every response
205
- # whenever a valid API key is provided, even when the response status is not 200.
203
+ # Credit usage, included whenever a valid API key is provided.
206
204
  #
207
- # @param credits_consumed [Integer] The number of credits consumed by this request.
205
+ # @param credits_consumed [Integer] Credits used by this request.
208
206
  #
209
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
207
+ # @param credits_remaining [Integer] Credits remaining for your organization.
210
208
  end
211
209
  end
212
210
  end
@@ -24,8 +24,7 @@ module ContextDev
24
24
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result] }
25
25
 
26
26
  # @!attribute key_metadata
27
- # Metadata about the API key used for the request. Included in every response
28
- # whenever a valid API key is provided, even when the response status is not 200.
27
+ # Credit usage, included whenever a valid API key is provided.
29
28
  #
30
29
  # @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
31
30
  optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
@@ -40,7 +39,7 @@ module ContextDev
40
39
  #
41
40
  # @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
42
41
  #
43
- # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
42
+ # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
44
43
 
45
44
  # @see ContextDev::Models::WebWebCrawlMdResponse#cache_metadata
46
45
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -460,24 +459,23 @@ module ContextDev
460
459
  # @see ContextDev::Models::WebWebCrawlMdResponse#key_metadata
461
460
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
462
461
  # @!attribute credits_consumed
463
- # The number of credits consumed by this request.
462
+ # Credits used by this request.
464
463
  #
465
464
  # @return [Integer]
466
465
  required :credits_consumed, Integer
467
466
 
468
467
  # @!attribute credits_remaining
469
- # The number of credits remaining for your organization after this request.
468
+ # Credits remaining for your organization.
470
469
  #
471
470
  # @return [Integer]
472
471
  required :credits_remaining, Integer
473
472
 
474
473
  # @!method initialize(credits_consumed:, credits_remaining:)
475
- # Metadata about the API key used for the request. Included in every response
476
- # whenever a valid API key is provided, even when the response status is not 200.
474
+ # Credit usage, included whenever a valid API key is provided.
477
475
  #
478
- # @param credits_consumed [Integer] The number of credits consumed by this request.
476
+ # @param credits_consumed [Integer] Credits used by this request.
479
477
  #
480
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
478
+ # @param credits_remaining [Integer] Credits remaining for your organization.
481
479
  end
482
480
  end
483
481
  end
@@ -84,9 +84,8 @@ module ContextDev
84
84
  optional :settle_animations, ContextDev::Internal::Type::Boolean
85
85
 
86
86
  # @!attribute tags
87
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
88
- # recorded on the request's usage log and can be used to filter usage on the
89
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
87
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
88
+ # characters.
90
89
  #
91
90
  # @return [Array<String>, nil]
92
91
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -146,7 +145,7 @@ module ContextDev
146
145
  #
147
146
  # @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
148
147
  #
149
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
148
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
150
149
  #
151
150
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
152
151
  #
@@ -63,8 +63,7 @@ module ContextDev
63
63
  optional :actions_html_stale, ContextDev::Internal::Type::Boolean, api_name: :actionsHtmlStale
64
64
 
65
65
  # @!attribute key_metadata
66
- # Metadata about the API key used for the request. Included in every response
67
- # whenever a valid API key is provided, even when the response status is not 200.
66
+ # Credit usage, included whenever a valid API key is provided.
68
67
  #
69
68
  # @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
70
69
  optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
@@ -89,7 +88,7 @@ module ContextDev
89
88
  #
90
89
  # @param actions_html_stale [Boolean] True when an action was applied but the returned content could not be refreshed
91
90
  #
92
- # @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
91
+ # @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
93
92
 
94
93
  # @see ContextDev::Models::WebWebScrapeHTMLResponse#cache_metadata
95
94
  class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -526,24 +525,23 @@ module ContextDev
526
525
  # @see ContextDev::Models::WebWebScrapeHTMLResponse#key_metadata
527
526
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
528
527
  # @!attribute credits_consumed
529
- # The number of credits consumed by this request.
528
+ # Credits used by this request.
530
529
  #
531
530
  # @return [Integer]
532
531
  required :credits_consumed, Integer
533
532
 
534
533
  # @!attribute credits_remaining
535
- # The number of credits remaining for your organization after this request.
534
+ # Credits remaining for your organization.
536
535
  #
537
536
  # @return [Integer]
538
537
  required :credits_remaining, Integer
539
538
 
540
539
  # @!method initialize(credits_consumed:, credits_remaining:)
541
- # Metadata about the API key used for the request. Included in every response
542
- # whenever a valid API key is provided, even when the response status is not 200.
540
+ # Credit usage, included whenever a valid API key is provided.
543
541
  #
544
- # @param credits_consumed [Integer] The number of credits consumed by this request.
542
+ # @param credits_consumed [Integer] Credits used by this request.
545
543
  #
546
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
544
+ # @param credits_remaining [Integer] Credits remaining for your organization.
547
545
  end
548
546
  end
549
547
  end
@@ -57,9 +57,8 @@ module ContextDev
57
57
  optional :max_age_ms, Integer, nil?: true
58
58
 
59
59
  # @!attribute tags
60
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
61
- # recorded on the request's usage log and can be used to filter usage on the
62
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
60
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
61
+ # characters.
63
62
  #
64
63
  # @return [Array<String>, nil]
65
64
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -95,7 +94,7 @@ module ContextDev
95
94
  #
96
95
  # @param max_age_ms [Integer, nil] Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
97
96
  #
98
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
97
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
99
98
  #
100
99
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
101
100
  #