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
@@ -0,0 +1,108 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#list
6
+ class LogListParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute error_code
11
+ # Filter by the `error_code` returned in the response.
12
+ #
13
+ # @return [String, nil]
14
+ optional :error_code, String
15
+
16
+ # @!attribute errors_only
17
+ # Only include requests that returned a 4xx or 5xx status.
18
+ #
19
+ # @return [Boolean, nil]
20
+ optional :errors_only, ContextDev::Internal::Type::Boolean
21
+
22
+ # @!attribute from
23
+ # Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
24
+ # before `to`.
25
+ #
26
+ # @return [Time, nil]
27
+ optional :from, Time
28
+
29
+ # @!attribute key_id
30
+ # Filter by the API key that made the request.
31
+ #
32
+ # @return [String, nil]
33
+ optional :key_id, String
34
+
35
+ # @!attribute limit
36
+ # Number of log entries per page.
37
+ #
38
+ # @return [Integer, nil]
39
+ optional :limit, Integer
40
+
41
+ # @!attribute page
42
+ # Page number, starting at 1.
43
+ #
44
+ # @return [Integer, nil]
45
+ optional :page, Integer
46
+
47
+ # @!attribute path
48
+ # Filter by endpoint path, with or without the /v1 prefix.
49
+ #
50
+ # @return [String, nil]
51
+ optional :path, String
52
+
53
+ # @!attribute search
54
+ # Case-insensitive substring match against the request query and body, e.g. a
55
+ # domain.
56
+ #
57
+ # @return [String, nil]
58
+ optional :search, String
59
+
60
+ # @!attribute status_code
61
+ # Filter by exact HTTP status code.
62
+ #
63
+ # @return [Integer, nil]
64
+ optional :status_code, Integer
65
+
66
+ # @!attribute tags
67
+ # Comma-separated request tags. Matches requests carrying any of them. Up to 20
68
+ # tags, each 1-50 characters.
69
+ #
70
+ # @return [String, nil]
71
+ optional :tags, String
72
+
73
+ # @!attribute to
74
+ # Only include requests at or before this ISO 8601 timestamp. Defaults to now.
75
+ #
76
+ # @return [Time, nil]
77
+ optional :to, Time
78
+
79
+ # @!method initialize(error_code: nil, errors_only: nil, from: nil, key_id: nil, limit: nil, page: nil, path: nil, search: nil, status_code: nil, tags: nil, to: nil, request_options: {})
80
+ # Some parameter documentations has been truncated, see
81
+ # {ContextDev::Models::LogListParams} for more details.
82
+ #
83
+ # @param error_code [String] Filter by the `error_code` returned in the response.
84
+ #
85
+ # @param errors_only [Boolean] Only include requests that returned a 4xx or 5xx status.
86
+ #
87
+ # @param from [Time] Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
88
+ #
89
+ # @param key_id [String] Filter by the API key that made the request.
90
+ #
91
+ # @param limit [Integer] Number of log entries per page.
92
+ #
93
+ # @param page [Integer] Page number, starting at 1.
94
+ #
95
+ # @param path [String] Filter by endpoint path, with or without the /v1 prefix.
96
+ #
97
+ # @param search [String] Case-insensitive substring match against the request query and body, e.g. a doma
98
+ #
99
+ # @param status_code [Integer] Filter by exact HTTP status code.
100
+ #
101
+ # @param tags [String] Comma-separated request tags. Matches requests carrying any of them. Up to 20 ta
102
+ #
103
+ # @param to [Time] Only include requests at or before this ISO 8601 timestamp. Defaults to now.
104
+ #
105
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,174 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#list
6
+ class LogListResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ # Log entries, newest first.
9
+ #
10
+ # @return [Array<ContextDev::Models::LogListResponse::Data>]
11
+ required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::LogListResponse::Data] }
12
+
13
+ # @!attribute has_more
14
+ # Whether a next page exists.
15
+ #
16
+ # @return [Boolean]
17
+ required :has_more, ContextDev::Internal::Type::Boolean
18
+
19
+ # @!attribute limit
20
+ # Entries per page.
21
+ #
22
+ # @return [Integer]
23
+ required :limit, Integer
24
+
25
+ # @!attribute page
26
+ # Current page number.
27
+ #
28
+ # @return [Integer]
29
+ required :page, Integer
30
+
31
+ # @!attribute request_id
32
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ # it when contacting support about a failed request.
34
+ #
35
+ # @return [String]
36
+ required :request_id, String
37
+
38
+ # @!attribute key_metadata
39
+ # Credit usage, included whenever a valid API key is provided.
40
+ #
41
+ # @return [ContextDev::Models::LogListResponse::KeyMetadata, nil]
42
+ optional :key_metadata, -> { ContextDev::Models::LogListResponse::KeyMetadata }
43
+
44
+ # @!method initialize(data:, has_more:, limit:, page:, request_id:, key_metadata: nil)
45
+ # Some parameter documentations has been truncated, see
46
+ # {ContextDev::Models::LogListResponse} for more details.
47
+ #
48
+ # @param data [Array<ContextDev::Models::LogListResponse::Data>] Log entries, newest first.
49
+ #
50
+ # @param has_more [Boolean] Whether a next page exists.
51
+ #
52
+ # @param limit [Integer] Entries per page.
53
+ #
54
+ # @param page [Integer] Current page number.
55
+ #
56
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
57
+ #
58
+ # @param key_metadata [ContextDev::Models::LogListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
59
+
60
+ class Data < ContextDev::Internal::Type::BaseModel
61
+ # @!attribute credits_used
62
+ # Credits charged for this request.
63
+ #
64
+ # @return [Integer]
65
+ required :credits_used, Integer
66
+
67
+ # @!attribute error_code
68
+ # The `error_code` from the response, or null on success.
69
+ #
70
+ # @return [String, nil]
71
+ required :error_code, String, nil?: true
72
+
73
+ # @!attribute key_id
74
+ # ID of the API key that made the request.
75
+ #
76
+ # @return [String, nil]
77
+ required :key_id, String, nil?: true
78
+
79
+ # @!attribute latency_ms
80
+ # Server-side processing time in milliseconds.
81
+ #
82
+ # @return [Float]
83
+ required :latency_ms, Float
84
+
85
+ # @!attribute method_
86
+ # HTTP method.
87
+ #
88
+ # @return [String]
89
+ required :method_, String, api_name: :method
90
+
91
+ # @!attribute path
92
+ # Endpoint path as called.
93
+ #
94
+ # @return [String]
95
+ required :path, String
96
+
97
+ # @!attribute request_id
98
+ # Request ID of the logged API call.
99
+ #
100
+ # @return [String]
101
+ required :request_id, String
102
+
103
+ # @!attribute status_code
104
+ # HTTP status code returned.
105
+ #
106
+ # @return [Integer]
107
+ required :status_code, Integer
108
+
109
+ # @!attribute tags
110
+ # Request tags supplied by the caller.
111
+ #
112
+ # @return [Array<String>]
113
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
114
+
115
+ # @!attribute timestamp
116
+ # When the request completed.
117
+ #
118
+ # @return [Time]
119
+ required :timestamp, Time
120
+
121
+ # @!attribute zdr
122
+ # Whether the request was made under zero data retention.
123
+ #
124
+ # @return [Boolean]
125
+ required :zdr, ContextDev::Internal::Type::Boolean
126
+
127
+ # @!method initialize(credits_used:, error_code:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, zdr:)
128
+ # @param credits_used [Integer] Credits charged for this request.
129
+ #
130
+ # @param error_code [String, nil] The `error_code` from the response, or null on success.
131
+ #
132
+ # @param key_id [String, nil] ID of the API key that made the request.
133
+ #
134
+ # @param latency_ms [Float] Server-side processing time in milliseconds.
135
+ #
136
+ # @param method_ [String] HTTP method.
137
+ #
138
+ # @param path [String] Endpoint path as called.
139
+ #
140
+ # @param request_id [String] Request ID of the logged API call.
141
+ #
142
+ # @param status_code [Integer] HTTP status code returned.
143
+ #
144
+ # @param tags [Array<String>] Request tags supplied by the caller.
145
+ #
146
+ # @param timestamp [Time] When the request completed.
147
+ #
148
+ # @param zdr [Boolean] Whether the request was made under zero data retention.
149
+ end
150
+
151
+ # @see ContextDev::Models::LogListResponse#key_metadata
152
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
153
+ # @!attribute credits_consumed
154
+ # Credits used by this request.
155
+ #
156
+ # @return [Integer]
157
+ required :credits_consumed, Integer
158
+
159
+ # @!attribute credits_remaining
160
+ # Credits remaining for your organization.
161
+ #
162
+ # @return [Integer]
163
+ required :credits_remaining, Integer
164
+
165
+ # @!method initialize(credits_consumed:, credits_remaining:)
166
+ # Credit usage, included whenever a valid API key is provided.
167
+ #
168
+ # @param credits_consumed [Integer] Credits used by this request.
169
+ #
170
+ # @param credits_remaining [Integer] Credits remaining for your organization.
171
+ end
172
+ end
173
+ end
174
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#retrieve
6
+ class LogRetrieveParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute request_id
11
+ # The request ID of the logged API call.
12
+ #
13
+ # @return [String]
14
+ required :request_id, String
15
+
16
+ # @!method initialize(request_id:, request_options: {})
17
+ # @param request_id [String] The request ID of the logged API call.
18
+ #
19
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,226 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#retrieve
6
+ class LogRetrieveResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [ContextDev::Models::LogRetrieveResponse::Data]
10
+ required :data, -> { ContextDev::Models::LogRetrieveResponse::Data }
11
+
12
+ # @!attribute request_id
13
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
14
+ # it when contacting support about a failed request.
15
+ #
16
+ # @return [String]
17
+ required :request_id, String
18
+
19
+ # @!attribute key_metadata
20
+ # Credit usage, included whenever a valid API key is provided.
21
+ #
22
+ # @return [ContextDev::Models::LogRetrieveResponse::KeyMetadata, nil]
23
+ optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::KeyMetadata }
24
+
25
+ # @!method initialize(data:, request_id:, key_metadata: nil)
26
+ # Some parameter documentations has been truncated, see
27
+ # {ContextDev::Models::LogRetrieveResponse} for more details.
28
+ #
29
+ # @param data [ContextDev::Models::LogRetrieveResponse::Data]
30
+ #
31
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
32
+ #
33
+ # @param key_metadata [ContextDev::Models::LogRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
34
+
35
+ # @see ContextDev::Models::LogRetrieveResponse#data
36
+ class Data < ContextDev::Internal::Type::BaseModel
37
+ # @!attribute credits_used
38
+ # Credits charged for this request.
39
+ #
40
+ # @return [Integer]
41
+ required :credits_used, Integer
42
+
43
+ # @!attribute error_code
44
+ # The `error_code` from the response, or null on success.
45
+ #
46
+ # @return [String, nil]
47
+ required :error_code, String, nil?: true
48
+
49
+ # @!attribute input
50
+ # What was sent with the request.
51
+ #
52
+ # @return [ContextDev::Models::LogRetrieveResponse::Data::Input]
53
+ required :input, -> { ContextDev::Models::LogRetrieveResponse::Data::Input }
54
+
55
+ # @!attribute key_id
56
+ # ID of the API key that made the request.
57
+ #
58
+ # @return [String, nil]
59
+ required :key_id, String, nil?: true
60
+
61
+ # @!attribute latency_ms
62
+ # Server-side processing time in milliseconds.
63
+ #
64
+ # @return [Float]
65
+ required :latency_ms, Float
66
+
67
+ # @!attribute method_
68
+ # HTTP method.
69
+ #
70
+ # @return [String]
71
+ required :method_, String, api_name: :method
72
+
73
+ # @!attribute path
74
+ # Endpoint path as called.
75
+ #
76
+ # @return [String]
77
+ required :path, String
78
+
79
+ # @!attribute request_id
80
+ # Request ID of the logged API call.
81
+ #
82
+ # @return [String]
83
+ required :request_id, String
84
+
85
+ # @!attribute status_code
86
+ # HTTP status code returned.
87
+ #
88
+ # @return [Integer]
89
+ required :status_code, Integer
90
+
91
+ # @!attribute tags
92
+ # Request tags supplied by the caller.
93
+ #
94
+ # @return [Array<String>]
95
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
96
+
97
+ # @!attribute timestamp
98
+ # When the request completed.
99
+ #
100
+ # @return [Time]
101
+ required :timestamp, Time
102
+
103
+ # @!attribute user_agent
104
+ # User-Agent header of the request.
105
+ #
106
+ # @return [String, nil]
107
+ required :user_agent, String, nil?: true
108
+
109
+ # @!attribute zdr
110
+ # Whether the request was made under zero data retention.
111
+ #
112
+ # @return [Boolean]
113
+ required :zdr, ContextDev::Internal::Type::Boolean
114
+
115
+ # @!attribute key_metadata
116
+ # Credit usage, included whenever a valid API key is provided.
117
+ #
118
+ # @return [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata, nil]
119
+ optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata }
120
+
121
+ # @!attribute response
122
+ # The retained JSON response with credentials redacted, or null when unavailable.
123
+ #
124
+ # @return [Object, nil]
125
+ optional :response, ContextDev::Internal::Type::Unknown
126
+
127
+ # @!method initialize(credits_used:, error_code:, input:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, user_agent:, zdr:, key_metadata: nil, response: nil)
128
+ # @param credits_used [Integer] Credits charged for this request.
129
+ #
130
+ # @param error_code [String, nil] The `error_code` from the response, or null on success.
131
+ #
132
+ # @param input [ContextDev::Models::LogRetrieveResponse::Data::Input] What was sent with the request.
133
+ #
134
+ # @param key_id [String, nil] ID of the API key that made the request.
135
+ #
136
+ # @param latency_ms [Float] Server-side processing time in milliseconds.
137
+ #
138
+ # @param method_ [String] HTTP method.
139
+ #
140
+ # @param path [String] Endpoint path as called.
141
+ #
142
+ # @param request_id [String] Request ID of the logged API call.
143
+ #
144
+ # @param status_code [Integer] HTTP status code returned.
145
+ #
146
+ # @param tags [Array<String>] Request tags supplied by the caller.
147
+ #
148
+ # @param timestamp [Time] When the request completed.
149
+ #
150
+ # @param user_agent [String, nil] User-Agent header of the request.
151
+ #
152
+ # @param zdr [Boolean] Whether the request was made under zero data retention.
153
+ #
154
+ # @param key_metadata [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata] Credit usage, included whenever a valid API key is provided.
155
+ #
156
+ # @param response [Object] The retained JSON response with credentials redacted, or null when unavailable.
157
+
158
+ # @see ContextDev::Models::LogRetrieveResponse::Data#input
159
+ class Input < ContextDev::Internal::Type::BaseModel
160
+ # @!attribute query
161
+ # Query parameters as sent.
162
+ #
163
+ # @return [Hash{Symbol=>Object}]
164
+ required :query, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
165
+
166
+ # @!attribute body
167
+ # Request body with credentials and uploaded content redacted.
168
+ #
169
+ # @return [Object, nil]
170
+ optional :body, ContextDev::Internal::Type::Unknown
171
+
172
+ # @!method initialize(query:, body: nil)
173
+ # What was sent with the request.
174
+ #
175
+ # @param query [Hash{Symbol=>Object}] Query parameters as sent.
176
+ #
177
+ # @param body [Object] Request body with credentials and uploaded content redacted.
178
+ end
179
+
180
+ # @see ContextDev::Models::LogRetrieveResponse::Data#key_metadata
181
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
182
+ # @!attribute credits_consumed
183
+ # Credits used by this request.
184
+ #
185
+ # @return [Integer]
186
+ required :credits_consumed, Integer
187
+
188
+ # @!attribute credits_remaining
189
+ # Credits remaining for your organization.
190
+ #
191
+ # @return [Integer]
192
+ required :credits_remaining, Integer
193
+
194
+ # @!method initialize(credits_consumed:, credits_remaining:)
195
+ # Credit usage, included whenever a valid API key is provided.
196
+ #
197
+ # @param credits_consumed [Integer] Credits used by this request.
198
+ #
199
+ # @param credits_remaining [Integer] Credits remaining for your organization.
200
+ end
201
+ end
202
+
203
+ # @see ContextDev::Models::LogRetrieveResponse#key_metadata
204
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
205
+ # @!attribute credits_consumed
206
+ # Credits used by this request.
207
+ #
208
+ # @return [Integer]
209
+ required :credits_consumed, Integer
210
+
211
+ # @!attribute credits_remaining
212
+ # Credits remaining for your organization.
213
+ #
214
+ # @return [Integer]
215
+ required :credits_remaining, Integer
216
+
217
+ # @!method initialize(credits_consumed:, credits_remaining:)
218
+ # Credit usage, included whenever a valid API key is provided.
219
+ #
220
+ # @param credits_consumed [Integer] Credits used by this request.
221
+ #
222
+ # @param credits_remaining [Integer] Credits remaining for your organization.
223
+ end
224
+ end
225
+ end
226
+ end
@@ -386,13 +386,21 @@ module ContextDev
386
386
  optional :events,
387
387
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorCreateParams::Webhook::Event] }
388
388
 
389
- # @!method initialize(url:, events: nil)
389
+ # @!attribute retry_
390
+ # Webhook retry settings. Use {} for the default schedule.
391
+ #
392
+ # @return [ContextDev::Models::RetryConfig, nil]
393
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
394
+
395
+ # @!method initialize(url:, events: nil, retry_: nil)
390
396
  # Some parameter documentations has been truncated, see
391
397
  # {ContextDev::Models::MonitorCreateParams::Webhook} for more details.
392
398
  #
393
399
  # @param url [String] Webhook URL events are delivered to.
394
400
  #
395
401
  # @param events [Array<Symbol, ContextDev::Models::MonitorCreateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
402
+ #
403
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
396
404
 
397
405
  module Event
398
406
  extend ContextDev::Internal::Type::Enum
@@ -633,6 +633,12 @@ module ContextDev
633
633
  optional :events,
634
634
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorCreateResponse::Webhook::Event] }
635
635
 
636
+ # @!attribute retry_
637
+ # Webhook retry settings. Use {} for the default schedule.
638
+ #
639
+ # @return [ContextDev::Models::RetryConfig, nil]
640
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
641
+
636
642
  response_only do
637
643
  # @!attribute secret
638
644
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -645,7 +651,7 @@ module ContextDev
645
651
  optional :secret, String
646
652
  end
647
653
 
648
- # @!method initialize(url:, events: nil, secret: nil)
654
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
649
655
  # Some parameter documentations has been truncated, see
650
656
  # {ContextDev::Models::MonitorCreateResponse::Webhook} for more details.
651
657
  #
@@ -653,6 +659,8 @@ module ContextDev
653
659
  #
654
660
  # @param events [Array<Symbol, ContextDev::Models::MonitorCreateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
655
661
  #
662
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
663
+ #
656
664
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
657
665
 
658
666
  module Event
@@ -124,7 +124,13 @@ module ContextDev
124
124
  # @return [ContextDev::Models::WebhookDelivery, nil]
125
125
  optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
126
126
 
127
- # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil)
127
+ # @!attribute webhook_delivery_ids
128
+ # Webhook delivery IDs for this run.
129
+ #
130
+ # @return [Array<String>, nil]
131
+ optional :webhook_delivery_ids, ContextDev::Internal::Type::ArrayOf[String]
132
+
133
+ # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil, webhook_delivery_ids: nil)
128
134
  # Some parameter documentations has been truncated, see
129
135
  # {ContextDev::Models::MonitorListAccountRunsResponse::Data} for more details.
130
136
  #
@@ -159,6 +165,8 @@ module ContextDev
159
165
  # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
160
166
  #
161
167
  # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
168
+ #
169
+ # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
162
170
 
163
171
  # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#change_detection_type
164
172
  module ChangeDetectionType
@@ -647,6 +647,12 @@ module ContextDev
647
647
  optional :events,
648
648
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorListResponse::Data::Webhook::Event] }
649
649
 
650
+ # @!attribute retry_
651
+ # Webhook retry settings. Use {} for the default schedule.
652
+ #
653
+ # @return [ContextDev::Models::RetryConfig, nil]
654
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
655
+
650
656
  response_only do
651
657
  # @!attribute secret
652
658
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -659,7 +665,7 @@ module ContextDev
659
665
  optional :secret, String
660
666
  end
661
667
 
662
- # @!method initialize(url:, events: nil, secret: nil)
668
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
663
669
  # Some parameter documentations has been truncated, see
664
670
  # {ContextDev::Models::MonitorListResponse::Data::Webhook} for more details.
665
671
  #
@@ -667,6 +673,8 @@ module ContextDev
667
673
  #
668
674
  # @param events [Array<Symbol, ContextDev::Models::MonitorListResponse::Data::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
669
675
  #
676
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
677
+ #
670
678
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
671
679
 
672
680
  module Event
@@ -124,7 +124,13 @@ module ContextDev
124
124
  # @return [ContextDev::Models::WebhookDelivery, nil]
125
125
  optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
126
126
 
127
- # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil)
127
+ # @!attribute webhook_delivery_ids
128
+ # Webhook delivery IDs for this run.
129
+ #
130
+ # @return [Array<String>, nil]
131
+ optional :webhook_delivery_ids, ContextDev::Internal::Type::ArrayOf[String]
132
+
133
+ # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil, webhook_delivery_ids: nil)
128
134
  # Some parameter documentations has been truncated, see
129
135
  # {ContextDev::Models::MonitorListRunsResponse::Data} for more details.
130
136
  #
@@ -159,6 +165,8 @@ module ContextDev
159
165
  # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
160
166
  #
161
167
  # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
168
+ #
169
+ # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
162
170
 
163
171
  # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type
164
172
  module ChangeDetectionType