context.dev 2.14.0 → 2.16.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 (221) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +10 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_response.rb +17 -10
  7. data/lib/context_dev/models/ai_extract_products_response.rb +17 -10
  8. data/lib/context_dev/models/batch_cancel_response.rb +14 -5
  9. data/lib/context_dev/models/batch_delete_response.rb +17 -10
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -10
  11. data/lib/context_dev/models/batch_list_response.rb +17 -10
  12. data/lib/context_dev/models/batch_retrieve_response.rb +22 -5
  13. data/lib/context_dev/models/batch_submit_params.rb +34 -3
  14. data/lib/context_dev/models/batch_submit_response.rb +14 -5
  15. data/lib/context_dev/models/brand_retrieve_response.rb +17 -10
  16. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
  17. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +17 -10
  18. data/lib/context_dev/models/brand_search_params.rb +3 -4
  19. data/lib/context_dev/models/brand_search_response.rb +17 -10
  20. data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
  21. data/lib/context_dev/models/industry_retrieve_naics_response.rb +17 -10
  22. data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
  23. data/lib/context_dev/models/industry_retrieve_sic_response.rb +17 -10
  24. data/lib/context_dev/models/log_list_params.rb +108 -0
  25. data/lib/context_dev/models/log_list_response.rb +174 -0
  26. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  27. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  28. data/lib/context_dev/models/monitor_create_params.rb +9 -1
  29. data/lib/context_dev/models/monitor_create_response.rb +9 -1
  30. data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
  31. data/lib/context_dev/models/monitor_list_response.rb +9 -1
  32. data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
  33. data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
  34. data/lib/context_dev/models/monitor_update_params.rb +9 -1
  35. data/lib/context_dev/models/monitor_update_response.rb +9 -1
  36. data/lib/context_dev/models/news_search_response.rb +17 -10
  37. data/lib/context_dev/models/parse_handle_params.rb +3 -4
  38. data/lib/context_dev/models/parse_handle_response.rb +17 -10
  39. data/lib/context_dev/models/person_enrich_response.rb +17 -10
  40. data/lib/context_dev/models/retry_config.rb +22 -0
  41. data/lib/context_dev/models/utility_prefetch_response.rb +17 -10
  42. data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
  43. data/lib/context_dev/models/web_extract_competitors_response.rb +17 -10
  44. data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
  45. data/lib/context_dev/models/web_extract_fonts_response.rb +17 -10
  46. data/lib/context_dev/models/web_extract_response.rb +17 -10
  47. data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
  48. data/lib/context_dev/models/web_extract_styleguide_response.rb +17 -10
  49. data/lib/context_dev/models/web_screenshot_params.rb +5 -5
  50. data/lib/context_dev/models/web_screenshot_response.rb +17 -10
  51. data/lib/context_dev/models/web_search_response.rb +17 -10
  52. data/lib/context_dev/models/web_web_crawl_md_response.rb +17 -10
  53. data/lib/context_dev/models/web_web_scrape_html_params.rb +6 -5
  54. data/lib/context_dev/models/web_web_scrape_html_response.rb +17 -10
  55. data/lib/context_dev/models/web_web_scrape_images_params.rb +6 -5
  56. data/lib/context_dev/models/web_web_scrape_images_response.rb +17 -10
  57. data/lib/context_dev/models/web_web_scrape_md_params.rb +6 -5
  58. data/lib/context_dev/models/web_web_scrape_md_response.rb +17 -10
  59. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +3 -4
  60. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +17 -10
  61. data/lib/context_dev/models/webhook_delivery.rb +9 -1
  62. data/lib/context_dev/models/webhooks/attempt.rb +102 -0
  63. data/lib/context_dev/models/webhooks/delivery.rb +253 -0
  64. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
  65. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +77 -0
  66. data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
  67. data/lib/context_dev/models/webhooks/delivery_list_response.rb +77 -0
  68. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
  69. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +52 -0
  70. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
  71. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +61 -0
  72. data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
  73. data/lib/context_dev/models.rb +8 -0
  74. data/lib/context_dev/resources/batch.rb +4 -2
  75. data/lib/context_dev/resources/brand.rb +2 -2
  76. data/lib/context_dev/resources/industry.rb +2 -2
  77. data/lib/context_dev/resources/logs.rb +83 -0
  78. data/lib/context_dev/resources/parse.rb +1 -1
  79. data/lib/context_dev/resources/web.rb +8 -8
  80. data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
  81. data/lib/context_dev/resources/webhooks.rb +19 -0
  82. data/lib/context_dev/version.rb +1 -1
  83. data/lib/context_dev.rb +19 -0
  84. data/rbi/context_dev/client.rbi +8 -0
  85. data/rbi/context_dev/models/ai_extract_product_response.rbi +17 -10
  86. data/rbi/context_dev/models/ai_extract_products_response.rbi +17 -10
  87. data/rbi/context_dev/models/batch_cancel_response.rbi +14 -4
  88. data/rbi/context_dev/models/batch_delete_response.rbi +17 -10
  89. data/rbi/context_dev/models/batch_get_results_response.rbi +17 -10
  90. data/rbi/context_dev/models/batch_list_response.rbi +17 -10
  91. data/rbi/context_dev/models/batch_retrieve_response.rbi +29 -7
  92. data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
  93. data/rbi/context_dev/models/batch_submit_response.rbi +14 -4
  94. data/rbi/context_dev/models/brand_retrieve_response.rbi +17 -10
  95. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
  96. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +17 -10
  97. data/rbi/context_dev/models/brand_search_params.rbi +4 -6
  98. data/rbi/context_dev/models/brand_search_response.rbi +17 -10
  99. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
  100. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +17 -10
  101. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
  102. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +17 -10
  103. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  104. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  105. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  106. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  107. data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
  108. data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
  109. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
  110. data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
  111. data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
  112. data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
  113. data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
  114. data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
  115. data/rbi/context_dev/models/news_search_response.rbi +17 -10
  116. data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
  117. data/rbi/context_dev/models/parse_handle_response.rbi +17 -10
  118. data/rbi/context_dev/models/person_enrich_response.rbi +17 -10
  119. data/rbi/context_dev/models/retry_config.rbi +35 -0
  120. data/rbi/context_dev/models/utility_prefetch_response.rbi +17 -10
  121. data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
  122. data/rbi/context_dev/models/web_extract_competitors_response.rbi +17 -10
  123. data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
  124. data/rbi/context_dev/models/web_extract_fonts_response.rbi +17 -10
  125. data/rbi/context_dev/models/web_extract_response.rbi +17 -10
  126. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
  127. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +17 -10
  128. data/rbi/context_dev/models/web_screenshot_params.rbi +8 -8
  129. data/rbi/context_dev/models/web_screenshot_response.rbi +17 -10
  130. data/rbi/context_dev/models/web_search_response.rbi +17 -10
  131. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +17 -10
  132. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +10 -8
  133. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +17 -10
  134. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +10 -8
  135. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +17 -10
  136. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +10 -8
  137. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +17 -10
  138. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +4 -6
  139. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +17 -10
  140. data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
  141. data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
  142. data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
  143. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
  144. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +133 -0
  145. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
  146. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +133 -0
  147. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
  148. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +109 -0
  149. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
  150. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +117 -0
  151. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
  152. data/rbi/context_dev/models.rbi +8 -0
  153. data/rbi/context_dev/resources/batch.rbi +6 -1
  154. data/rbi/context_dev/resources/brand.rbi +4 -6
  155. data/rbi/context_dev/resources/industry.rbi +4 -6
  156. data/rbi/context_dev/resources/logs.rbi +76 -0
  157. data/rbi/context_dev/resources/parse.rbi +2 -3
  158. data/rbi/context_dev/resources/web.rbi +27 -28
  159. data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
  160. data/rbi/context_dev/resources/webhooks.rbi +16 -0
  161. data/sig/context_dev/client.rbs +4 -0
  162. data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
  163. data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
  164. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  165. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  166. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  167. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  168. data/sig/context_dev/models/batch_retrieve_response.rbs +15 -3
  169. data/sig/context_dev/models/batch_submit_params.rbs +23 -0
  170. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  171. data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
  172. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
  173. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  174. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
  175. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
  176. data/sig/context_dev/models/log_list_params.rbs +98 -0
  177. data/sig/context_dev/models/log_list_response.rbs +135 -0
  178. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  179. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  180. data/sig/context_dev/models/monitor_create_params.rbs +8 -1
  181. data/sig/context_dev/models/monitor_create_response.rbs +7 -0
  182. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
  183. data/sig/context_dev/models/monitor_list_response.rbs +7 -0
  184. data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
  185. data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
  186. data/sig/context_dev/models/monitor_update_params.rbs +8 -1
  187. data/sig/context_dev/models/monitor_update_response.rbs +7 -0
  188. data/sig/context_dev/models/news_search_response.rbs +5 -0
  189. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  190. data/sig/context_dev/models/person_enrich_response.rbs +5 -0
  191. data/sig/context_dev/models/retry_config.rbs +15 -0
  192. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  193. data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
  194. data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
  195. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  196. data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
  197. data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
  198. data/sig/context_dev/models/web_search_response.rbs +5 -0
  199. data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
  200. data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
  201. data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
  202. data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
  203. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
  204. data/sig/context_dev/models/webhook_delivery.rbs +10 -3
  205. data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
  206. data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
  207. data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
  208. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +65 -0
  209. data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
  210. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +65 -0
  211. data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
  212. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +52 -0
  213. data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
  214. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +55 -0
  215. data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
  216. data/sig/context_dev/models.rbs +8 -0
  217. data/sig/context_dev/resources/batch.rbs +1 -0
  218. data/sig/context_dev/resources/logs.rbs +27 -0
  219. data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
  220. data/sig/context_dev/resources/webhooks.rbs +9 -0
  221. metadata +59 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ad23a0354a5f9cc6d6ad23a499a78ebe67f48f5e8d45c2660c70f9f6582acf39
4
- data.tar.gz: 5b20bcd0881f27b3d5033c7664233cc5638d78358979bbe5b2fd25ae1f7538fd
3
+ metadata.gz: f386d4f27c72c64c88946d5e8dbc98bb1cd4f5de22f6400219eb7996954c68df
4
+ data.tar.gz: 062cb685ad8d8469e9e4f81e42d809533d98b0b68c009c57b285a77578023fdb
5
5
  SHA512:
6
- metadata.gz: 7ebed39d39da3add4c5177e25f778c2f1483799859ab776b9db4bb8f3f452059a5b109cee3a4df284d5c1a09abe9c5b777323673c481d9af5e2aebeebbf3b90e
7
- data.tar.gz: 4e8e97e0881e10ea884b242681ac561cbf737dfca8b85340e3fda3718ae836b926d9ec4d7eb6d4ed5defa288b83ab432472b7af6dec8f33d59501345c9982179
6
+ metadata.gz: ec3879167f8c90f9c79ea728be1f927ff23c089ca6103255c7ea64294adfa117a616e9a83f72439a72ee710ca2fa0b66a8fa44e5eac649ceda206f04bb324cd4
7
+ data.tar.gz: 2a2945c6da42e4ec238ecbb23dec1803bf65b2c857c864152e6919c66d35b981aa5b6696848d29b0d541e1810bec79ab19a7462a4ef6c58e70df5c4f9d355f42
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.16.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.15.0...v2.16.0) (2026-09-11)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** return request_id on every response ([012ba65](https://github.com/context-dot-dev/context-ruby-sdk/commit/012ba65ea7648ebd7b18fa7ad00955a13b8394b9))
9
+ * **logs:** expose request log endpoints in SDKs ([#1025](https://github.com/context-dot-dev/context-ruby-sdk/issues/1025)) ([5b22be7](https://github.com/context-dot-dev/context-ruby-sdk/commit/5b22be7bd1cb6401b8260b5a756b6ec040cbc6a8))
10
+
11
+
12
+ ### Bug Fixes
13
+
14
+ * **api:** reject timeoutMS too short for waitForMs ([e8a6725](https://github.com/context-dot-dev/context-ruby-sdk/commit/e8a67255c9354f69d632697179a4d6270a4677ee))
15
+
16
+ ## [2.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.14.0...v2.15.0) (2026-09-08)
17
+
18
+
19
+ ### Features
20
+
21
+ * **webhooks:** add configurable retries and manual replay ([00388ec](https://github.com/context-dot-dev/context-ruby-sdk/commit/00388ec76d375d7466c9b0d85dfe983d2a369807))
22
+ * **webhooks:** simplify delivery APIs ([fbd879e](https://github.com/context-dot-dev/context-ruby-sdk/commit/fbd879eaa0c0008cba1c3b19f1fe1accb53d8771))
23
+
3
24
  ## [2.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.13.0...v2.14.0) (2026-09-03)
4
25
 
5
26
 
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "context.dev", "~> 2.14.0"
20
+ gem "context.dev", "~> 2.16.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -34,7 +34,7 @@ context_dev = ContextDev::Client.new(
34
34
 
35
35
  brand = context_dev.brand.retrieve(body: {domain: "stripe.com", type: "by_domain"})
36
36
 
37
- puts(brand.cache_metadata)
37
+ puts(brand.request_id)
38
38
  ```
39
39
 
40
40
  ### Handling errors
@@ -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
 
@@ -54,6 +57,11 @@ module ContextDev
54
57
  # @return [ContextDev::Resources::News]
55
58
  attr_reader :news
56
59
 
60
+ # Read your organization's API request logs to debug failed calls. These endpoints
61
+ # cost no credits and use a separate rate limit.
62
+ # @return [ContextDev::Resources::Logs]
63
+ attr_reader :logs
64
+
57
65
  # @api private
58
66
  #
59
67
  # @return [Hash{String=>String}]
@@ -123,8 +131,10 @@ module ContextDev
123
131
  @utility = ContextDev::Resources::Utility.new(client: self)
124
132
  @monitors = ContextDev::Resources::Monitors.new(client: self)
125
133
  @batch = ContextDev::Resources::Batch.new(client: self)
134
+ @webhooks = ContextDev::Resources::Webhooks.new(client: self)
126
135
  @people = ContextDev::Resources::People.new(client: self)
127
136
  @news = ContextDev::Resources::News.new(client: self)
137
+ @logs = ContextDev::Resources::Logs.new(client: self)
128
138
  end
129
139
  end
130
140
  end
@@ -441,8 +441,8 @@ module ContextDev
441
441
  # # `parse_handle_response` is a `ContextDev::Models::ParseHandleResponse`
442
442
  # parse_handle_response => {
443
443
  # markdown: markdown,
444
- # success: success,
445
- # type: type
444
+ # request_id: request_id,
445
+ # success: success
446
446
  # }
447
447
  def deconstruct_keys(keys)
448
448
  (keys || self.class.known_fields.keys)
@@ -12,6 +12,13 @@ module ContextDev
12
12
  # @return [ContextDev::Models::AIExtractProductResponse::CacheMetadata]
13
13
  required :cache_metadata, -> { ContextDev::Models::AIExtractProductResponse::CacheMetadata }
14
14
 
15
+ # @!attribute request_id
16
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
17
+ # it when contacting support about a failed request.
18
+ #
19
+ # @return [String]
20
+ required :request_id, String
21
+
15
22
  # @!attribute is_product_page
16
23
  # Whether the given URL is a product detail page
17
24
  #
@@ -19,8 +26,7 @@ module ContextDev
19
26
  optional :is_product_page, ContextDev::Internal::Type::Boolean
20
27
 
21
28
  # @!attribute key_metadata
22
- # Metadata about the API key used for the request. Included in every response
23
- # whenever a valid API key is provided, even when the response status is not 200.
29
+ # Credit usage, included whenever a valid API key is provided.
24
30
  #
25
31
  # @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
26
32
  optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
@@ -37,15 +43,17 @@ module ContextDev
37
43
  # @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
38
44
  optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
39
45
 
40
- # @!method initialize(cache_metadata:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
46
+ # @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
41
47
  # Some parameter documentations has been truncated, see
42
48
  # {ContextDev::Models::AIExtractProductResponse} for more details.
43
49
  #
44
50
  # @param cache_metadata [ContextDev::Models::AIExtractProductResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
45
51
  #
52
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
53
+ #
46
54
  # @param is_product_page [Boolean] Whether the given URL is a product detail page
47
55
  #
48
- # @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
56
+ # @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
49
57
  #
50
58
  # @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
51
59
  #
@@ -97,24 +105,23 @@ module ContextDev
97
105
  # @see ContextDev::Models::AIExtractProductResponse#key_metadata
98
106
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
99
107
  # @!attribute credits_consumed
100
- # The number of credits consumed by this request.
108
+ # Credits used by this request.
101
109
  #
102
110
  # @return [Integer]
103
111
  required :credits_consumed, Integer
104
112
 
105
113
  # @!attribute credits_remaining
106
- # The number of credits remaining for your organization after this request.
114
+ # Credits remaining for your organization.
107
115
  #
108
116
  # @return [Integer]
109
117
  required :credits_remaining, Integer
110
118
 
111
119
  # @!method initialize(credits_consumed:, credits_remaining:)
112
- # Metadata about the API key used for the request. Included in every response
113
- # 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.
114
121
  #
115
- # @param credits_consumed [Integer] The number of credits consumed by this request.
122
+ # @param credits_consumed [Integer] Credits used by this request.
116
123
  #
117
- # @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.
118
125
  end
119
126
 
120
127
  # The detected ecommerce platform, or null if not a product page
@@ -12,9 +12,15 @@ module ContextDev
12
12
  # @return [ContextDev::Models::AIExtractProductsResponse::CacheMetadata]
13
13
  required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata }
14
14
 
15
+ # @!attribute request_id
16
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
17
+ # it when contacting support about a failed request.
18
+ #
19
+ # @return [String]
20
+ required :request_id, String
21
+
15
22
  # @!attribute key_metadata
16
- # Metadata about the API key used for the request. Included in every response
17
- # whenever a valid API key is provided, even when the response status is not 200.
23
+ # Credit usage, included whenever a valid API key is provided.
18
24
  #
19
25
  # @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil]
20
26
  optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
@@ -26,13 +32,15 @@ module ContextDev
26
32
  optional :products,
27
33
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
28
34
 
29
- # @!method initialize(cache_metadata:, key_metadata: nil, products: nil)
35
+ # @!method initialize(cache_metadata:, request_id:, key_metadata: nil, products: nil)
30
36
  # Some parameter documentations has been truncated, see
31
37
  # {ContextDev::Models::AIExtractProductsResponse} for more details.
32
38
  #
33
39
  # @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
34
40
  #
35
- # @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
41
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
42
+ #
43
+ # @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
36
44
  #
37
45
  # @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
38
46
 
@@ -82,24 +90,23 @@ module ContextDev
82
90
  # @see ContextDev::Models::AIExtractProductsResponse#key_metadata
83
91
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
84
92
  # @!attribute credits_consumed
85
- # The number of credits consumed by this request.
93
+ # Credits used by this request.
86
94
  #
87
95
  # @return [Integer]
88
96
  required :credits_consumed, Integer
89
97
 
90
98
  # @!attribute credits_remaining
91
- # The number of credits remaining for your organization after this request.
99
+ # Credits remaining for your organization.
92
100
  #
93
101
  # @return [Integer]
94
102
  required :credits_remaining, Integer
95
103
 
96
104
  # @!method initialize(credits_consumed:, credits_remaining:)
97
- # Metadata about the API key used for the request. Included in every response
98
- # whenever a valid API key is provided, even when the response status is not 200.
105
+ # Credit usage, included whenever a valid API key is provided.
99
106
  #
100
- # @param credits_consumed [Integer] The number of credits consumed by this request.
107
+ # @param credits_consumed [Integer] Credits used by this request.
101
108
  #
102
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
109
+ # @param credits_remaining [Integer] Credits remaining for your organization.
103
110
  end
104
111
 
105
112
  class Product < ContextDev::Internal::Type::BaseModel
@@ -53,6 +53,13 @@ module ContextDev
53
53
  # @return [ContextDev::Models::BatchCancelResponse::Progress]
54
54
  required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
55
55
 
56
+ # @!attribute request_id
57
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
58
+ # it when contacting support about a failed request.
59
+ #
60
+ # @return [String]
61
+ required :request_id, String
62
+
56
63
  # @!attribute status
57
64
  # Always `cancelling`. Work already in flight finishes; the batch reaches
58
65
  # `cancelled` shortly after.
@@ -78,7 +85,7 @@ module ContextDev
78
85
  # @return [ContextDev::Models::BatchCancelResponse::KeyMetadata, nil]
79
86
  optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }
80
87
 
81
- # @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, status:, tags:, timing:, key_metadata: nil)
88
+ # @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, request_id:, status:, tags:, timing:, key_metadata: nil)
82
89
  # Some parameter documentations has been truncated, see
83
90
  # {ContextDev::Models::BatchCancelResponse} for more details.
84
91
  #
@@ -98,6 +105,8 @@ module ContextDev
98
105
  #
99
106
  # @param progress [ContextDev::Models::BatchCancelResponse::Progress] How far the batch got before cancellation.
100
107
  #
108
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
109
+ #
101
110
  # @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Always `cancelling`. Work already in flight finishes; the batch reaches `cancell
102
111
  #
103
112
  # @param tags [Array<String>] Tags stored on the batch at submission.
@@ -218,13 +227,13 @@ module ContextDev
218
227
  # @see ContextDev::Models::BatchCancelResponse#key_metadata
219
228
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
220
229
  # @!attribute credits_consumed
221
- # The number of credits consumed by this request.
230
+ # Credits used by this request.
222
231
  #
223
232
  # @return [Integer]
224
233
  required :credits_consumed, Integer
225
234
 
226
235
  # @!attribute credits_remaining
227
- # The number of credits remaining for your organization after this request.
236
+ # Credits remaining for your organization.
228
237
  #
229
238
  # @return [Integer]
230
239
  required :credits_remaining, Integer
@@ -232,9 +241,9 @@ module ContextDev
232
241
  # @!method initialize(credits_consumed:, credits_remaining:)
233
242
  # API key usage for this request.
234
243
  #
235
- # @param credits_consumed [Integer] The number of credits consumed by this request.
244
+ # @param credits_consumed [Integer] Credits used by this request.
236
245
  #
237
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
246
+ # @param credits_remaining [Integer] Credits remaining for your organization.
238
247
  end
239
248
  end
240
249
  end
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Batch#delete
6
6
  class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute request_id
8
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
9
+ # it when contacting support about a failed request.
10
+ #
11
+ # @return [String]
12
+ required :request_id, String
13
+
7
14
  # @!attribute id
8
15
  # ID of the deleted batch.
9
16
  #
@@ -17,43 +24,43 @@ module ContextDev
17
24
  optional :deleted, ContextDev::Internal::Type::Boolean
18
25
 
19
26
  # @!attribute key_metadata
20
- # Metadata about the API key used for the request. Included in every response
21
- # 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.
22
28
  #
23
29
  # @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
24
30
  optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
25
31
 
26
- # @!method initialize(id: nil, deleted: nil, key_metadata: nil)
32
+ # @!method initialize(request_id:, id: nil, deleted: nil, key_metadata: nil)
27
33
  # Some parameter documentations has been truncated, see
28
34
  # {ContextDev::Models::BatchDeleteResponse} for more details.
29
35
  #
36
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
37
+ #
30
38
  # @param id [String] ID of the deleted batch.
31
39
  #
32
40
  # @param deleted [Boolean] Always true on success.
33
41
  #
34
- # @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
42
+ # @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
35
43
 
36
44
  # @see ContextDev::Models::BatchDeleteResponse#key_metadata
37
45
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
38
46
  # @!attribute credits_consumed
39
- # The number of credits consumed by this request.
47
+ # Credits used by this request.
40
48
  #
41
49
  # @return [Integer]
42
50
  required :credits_consumed, Integer
43
51
 
44
52
  # @!attribute credits_remaining
45
- # The number of credits remaining for your organization after this request.
53
+ # Credits remaining for your organization.
46
54
  #
47
55
  # @return [Integer]
48
56
  required :credits_remaining, Integer
49
57
 
50
58
  # @!method initialize(credits_consumed:, credits_remaining:)
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.
59
+ # Credit usage, included whenever a valid API key is provided.
53
60
  #
54
- # @param credits_consumed [Integer] The number of credits consumed by this request.
61
+ # @param credits_consumed [Integer] Credits used by this request.
55
62
  #
56
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
63
+ # @param credits_remaining [Integer] Credits remaining for your organization.
57
64
  end
58
65
  end
59
66
  end
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Batch#get_results
6
6
  class BatchGetResultsResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute request_id
8
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
9
+ # it when contacting support about a failed request.
10
+ #
11
+ # @return [String]
12
+ required :request_id, String
13
+
7
14
  # @!attribute data
8
15
  # Result records on this page.
9
16
  #
@@ -18,8 +25,7 @@ module ContextDev
18
25
  optional :has_more, ContextDev::Internal::Type::Boolean
19
26
 
20
27
  # @!attribute key_metadata
21
- # Metadata about the API key used for the request. Included in every response
22
- # 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.
23
29
  #
24
30
  # @return [ContextDev::Models::BatchGetResultsResponse::KeyMetadata, nil]
25
31
  optional :key_metadata, -> { ContextDev::Models::BatchGetResultsResponse::KeyMetadata }
@@ -30,15 +36,17 @@ module ContextDev
30
36
  # @return [String, nil]
31
37
  optional :next_cursor, String, nil?: true
32
38
 
33
- # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
39
+ # @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
34
40
  # Some parameter documentations has been truncated, see
35
41
  # {ContextDev::Models::BatchGetResultsResponse} for more details.
36
42
  #
43
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
44
+ #
37
45
  # @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
38
46
  #
39
47
  # @param has_more [Boolean] Whether another page is available.
40
48
  #
41
- # @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
49
+ # @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
42
50
  #
43
51
  # @param next_cursor [String, nil] Cursor for the next page.
44
52
 
@@ -536,24 +544,23 @@ module ContextDev
536
544
  # @see ContextDev::Models::BatchGetResultsResponse#key_metadata
537
545
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
538
546
  # @!attribute credits_consumed
539
- # The number of credits consumed by this request.
547
+ # Credits used by this request.
540
548
  #
541
549
  # @return [Integer]
542
550
  required :credits_consumed, Integer
543
551
 
544
552
  # @!attribute credits_remaining
545
- # The number of credits remaining for your organization after this request.
553
+ # Credits remaining for your organization.
546
554
  #
547
555
  # @return [Integer]
548
556
  required :credits_remaining, Integer
549
557
 
550
558
  # @!method initialize(credits_consumed:, credits_remaining:)
551
- # Metadata about the API key used for the request. Included in every response
552
- # whenever a valid API key is provided, even when the response status is not 200.
559
+ # Credit usage, included whenever a valid API key is provided.
553
560
  #
554
- # @param credits_consumed [Integer] The number of credits consumed by this request.
561
+ # @param credits_consumed [Integer] Credits used by this request.
555
562
  #
556
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
563
+ # @param credits_remaining [Integer] Credits remaining for your organization.
557
564
  end
558
565
  end
559
566
  end
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Batch#list
6
6
  class BatchListResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute request_id
8
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
9
+ # it when contacting support about a failed request.
10
+ #
11
+ # @return [String]
12
+ required :request_id, String
13
+
7
14
  # @!attribute data
8
15
  # Batches on this page.
9
16
  #
@@ -17,8 +24,7 @@ module ContextDev
17
24
  optional :has_more, ContextDev::Internal::Type::Boolean
18
25
 
19
26
  # @!attribute key_metadata
20
- # Metadata about the API key used for the request. Included in every response
21
- # 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.
22
28
  #
23
29
  # @return [ContextDev::Models::BatchListResponse::KeyMetadata, nil]
24
30
  optional :key_metadata, -> { ContextDev::Models::BatchListResponse::KeyMetadata }
@@ -29,15 +35,17 @@ module ContextDev
29
35
  # @return [String, nil]
30
36
  optional :next_cursor, String, nil?: true
31
37
 
32
- # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
38
+ # @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
33
39
  # Some parameter documentations has been truncated, see
34
40
  # {ContextDev::Models::BatchListResponse} for more details.
35
41
  #
42
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
43
+ #
36
44
  # @param data [Array<ContextDev::Models::BatchListResponse::Data>] Batches on this page.
37
45
  #
38
46
  # @param has_more [Boolean] Whether another page is available.
39
47
  #
40
- # @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
48
+ # @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
41
49
  #
42
50
  # @param next_cursor [String, nil] Cursor for the next page.
43
51
 
@@ -364,24 +372,23 @@ module ContextDev
364
372
  # @see ContextDev::Models::BatchListResponse#key_metadata
365
373
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
366
374
  # @!attribute credits_consumed
367
- # The number of credits consumed by this request.
375
+ # Credits used by this request.
368
376
  #
369
377
  # @return [Integer]
370
378
  required :credits_consumed, Integer
371
379
 
372
380
  # @!attribute credits_remaining
373
- # The number of credits remaining for your organization after this request.
381
+ # Credits remaining for your organization.
374
382
  #
375
383
  # @return [Integer]
376
384
  required :credits_remaining, Integer
377
385
 
378
386
  # @!method initialize(credits_consumed:, credits_remaining:)
379
- # Metadata about the API key used for the request. Included in every response
380
- # whenever a valid API key is provided, even when the response status is not 200.
387
+ # Credit usage, included whenever a valid API key is provided.
381
388
  #
382
- # @param credits_consumed [Integer] The number of credits consumed by this request.
389
+ # @param credits_consumed [Integer] Credits used by this request.
383
390
  #
384
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
391
+ # @param credits_remaining [Integer] Credits remaining for your organization.
385
392
  end
386
393
  end
387
394
  end
@@ -69,6 +69,13 @@ module ContextDev
69
69
  # @return [ContextDev::Models::BatchRetrieveResponse::Progress]
70
70
  required :progress, -> { ContextDev::Models::BatchRetrieveResponse::Progress }
71
71
 
72
+ # @!attribute request_id
73
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
74
+ # it when contacting support about a failed request.
75
+ #
76
+ # @return [String]
77
+ required :request_id, String
78
+
72
79
  # @!attribute results
73
80
  # Download links, available once the batch reaches a final status and null before
74
81
  # then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
@@ -99,7 +106,13 @@ module ContextDev
99
106
  # @return [ContextDev::Models::BatchRetrieveResponse::KeyMetadata, nil]
100
107
  optional :key_metadata, -> { ContextDev::Models::BatchRetrieveResponse::KeyMetadata }
101
108
 
102
- # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil)
109
+ # @!attribute webhook_delivery_id
110
+ # Batch completion delivery ID, when available.
111
+ #
112
+ # @return [String, nil]
113
+ optional :webhook_delivery_id, String
114
+
115
+ # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, request_id:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
103
116
  # Some parameter documentations has been truncated, see
104
117
  # {ContextDev::Models::BatchRetrieveResponse} for more details.
105
118
  #
@@ -124,6 +137,8 @@ module ContextDev
124
137
  #
125
138
  # @param progress [ContextDev::Models::BatchRetrieveResponse::Progress] Pages attempted so far. Use `status` to check completion.
126
139
  #
140
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
141
+ #
127
142
  # @param results [ContextDev::Models::BatchRetrieveResponse::Results, nil] Download links, available once the batch reaches a final status and null before
128
143
  #
129
144
  # @param status [Symbol, ContextDev::Models::BatchRetrieveResponse::Status] Current state. `completed`, `cancelled`, and `failed` are final.
@@ -133,6 +148,8 @@ module ContextDev
133
148
  # @param timing [ContextDev::Models::BatchRetrieveResponse::Timing]
134
149
  #
135
150
  # @param key_metadata [ContextDev::Models::BatchRetrieveResponse::KeyMetadata] API key usage for this request.
151
+ #
152
+ # @param webhook_delivery_id [String] Batch completion delivery ID, when available.
136
153
 
137
154
  # @see ContextDev::Models::BatchRetrieveResponse#credits
138
155
  class Credits < ContextDev::Internal::Type::BaseModel
@@ -359,13 +376,13 @@ module ContextDev
359
376
  # @see ContextDev::Models::BatchRetrieveResponse#key_metadata
360
377
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
361
378
  # @!attribute credits_consumed
362
- # The number of credits consumed by this request.
379
+ # Credits used by this request.
363
380
  #
364
381
  # @return [Integer]
365
382
  required :credits_consumed, Integer
366
383
 
367
384
  # @!attribute credits_remaining
368
- # The number of credits remaining for your organization after this request.
385
+ # Credits remaining for your organization.
369
386
  #
370
387
  # @return [Integer]
371
388
  required :credits_remaining, Integer
@@ -373,9 +390,9 @@ module ContextDev
373
390
  # @!method initialize(credits_consumed:, credits_remaining:)
374
391
  # API key usage for this request.
375
392
  #
376
- # @param credits_consumed [Integer] The number of credits consumed by this request.
393
+ # @param credits_consumed [Integer] Credits used by this request.
377
394
  #
378
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
395
+ # @param credits_remaining [Integer] Credits remaining for your organization.
379
396
  end
380
397
  end
381
398
  end