context.dev 2.21.0 → 2.22.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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -9
  5. data/lib/context_dev/models/batch_cancel_params.rb +2 -2
  6. data/lib/context_dev/models/batch_cancel_response.rb +16 -21
  7. data/lib/context_dev/models/batch_delete_params.rb +2 -2
  8. data/lib/context_dev/models/batch_delete_response.rb +8 -8
  9. data/lib/context_dev/models/batch_get_results_params.rb +2 -2
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -22
  11. data/lib/context_dev/models/batch_list_response.rb +38 -47
  12. data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
  13. data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
  14. data/lib/context_dev/models/batch_submit_params.rb +80 -109
  15. data/lib/context_dev/models/batch_submit_response.rb +18 -28
  16. data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
  17. data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
  18. data/lib/context_dev/models/brand_search_params.rb +2 -3
  19. data/lib/context_dev/models/brand_search_response.rb +8 -8
  20. data/lib/context_dev/models/crawl_controls.rb +1 -2
  21. data/lib/context_dev/models/feedback_submit_params.rb +2 -2
  22. data/lib/context_dev/models/feedback_submit_response.rb +8 -8
  23. data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
  24. data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
  25. data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
  26. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
  27. data/lib/context_dev/models/intake.rb +7 -13
  28. data/lib/context_dev/models/log_list_response.rb +14 -10
  29. data/lib/context_dev/models/log_retrieve_response.rb +15 -41
  30. data/lib/context_dev/models/monitor_create_params.rb +238 -72
  31. data/lib/context_dev/models/monitor_create_response.rb +364 -175
  32. data/lib/context_dev/models/monitor_delete_params.rb +3 -1
  33. data/lib/context_dev/models/monitor_delete_response.rb +44 -1
  34. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
  35. data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
  36. data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
  37. data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
  38. data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
  39. data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
  40. data/lib/context_dev/models/monitor_list_params.rb +3 -3
  41. data/lib/context_dev/models/monitor_list_response.rb +304 -106
  42. data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
  43. data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
  44. data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
  45. data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
  46. data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
  47. data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
  48. data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
  49. data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
  50. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
  51. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
  52. data/lib/context_dev/models/monitor_run_params.rb +3 -1
  53. data/lib/context_dev/models/monitor_run_response.rb +42 -4
  54. data/lib/context_dev/models/monitor_update_params.rb +239 -71
  55. data/lib/context_dev/models/monitor_update_response.rb +361 -171
  56. data/lib/context_dev/models/news_search_params.rb +10 -6
  57. data/lib/context_dev/models/news_search_response.rb +8 -8
  58. data/lib/context_dev/models/parse_handle_params.rb +9 -20
  59. data/lib/context_dev/models/parse_handle_response.rb +8 -8
  60. data/lib/context_dev/models/person_enrich_params.rb +76 -50
  61. data/lib/context_dev/models/person_enrich_response.rb +8 -8
  62. data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
  63. data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
  64. data/lib/context_dev/models/web_answers_params.rb +28 -47
  65. data/lib/context_dev/models/web_answers_response.rb +9 -8
  66. data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
  67. data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
  68. data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
  69. data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
  70. data/lib/context_dev/models/web_map_urls_params.rb +30 -51
  71. data/lib/context_dev/models/web_map_urls_response.rb +8 -8
  72. data/lib/context_dev/models/web_scrape_params.rb +193 -191
  73. data/lib/context_dev/models/web_scrape_response.rb +219 -95
  74. data/lib/context_dev/models/web_screenshot_params.rb +20 -39
  75. data/lib/context_dev/models/web_screenshot_response.rb +18 -28
  76. data/lib/context_dev/models/web_search_params.rb +76 -65
  77. data/lib/context_dev/models/web_search_response.rb +68 -27
  78. data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
  79. data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
  80. data/lib/context_dev/models/webhook_delivery.rb +3 -7
  81. data/lib/context_dev/models/webhooks/attempt.rb +3 -3
  82. data/lib/context_dev/models/webhooks/delivery.rb +16 -11
  83. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
  84. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
  85. data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
  86. data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
  87. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
  88. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
  89. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
  90. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
  91. data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
  92. data/lib/context_dev/resources/batch.rb +17 -16
  93. data/lib/context_dev/resources/brand.rb +6 -8
  94. data/lib/context_dev/resources/feedback.rb +4 -5
  95. data/lib/context_dev/resources/industry.rb +9 -11
  96. data/lib/context_dev/resources/logs.rb +4 -5
  97. data/lib/context_dev/resources/monitors.rb +50 -53
  98. data/lib/context_dev/resources/news.rb +4 -8
  99. data/lib/context_dev/resources/parse.rb +4 -5
  100. data/lib/context_dev/resources/people.rb +11 -13
  101. data/lib/context_dev/resources/utility.rb +4 -11
  102. data/lib/context_dev/resources/web.rb +69 -94
  103. data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
  104. data/lib/context_dev/resources/webhooks.rb +1 -1
  105. data/lib/context_dev/version.rb +1 -1
  106. data/rbi/context_dev/client.rbi +4 -9
  107. data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
  108. data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
  109. data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
  110. data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
  111. data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
  112. data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
  113. data/rbi/context_dev/models/batch_list_response.rbi +41 -53
  114. data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
  115. data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
  116. data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
  117. data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
  118. data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
  119. data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
  120. data/rbi/context_dev/models/brand_search_params.rbi +2 -4
  121. data/rbi/context_dev/models/brand_search_response.rbi +9 -9
  122. data/rbi/context_dev/models/crawl_controls.rbi +1 -2
  123. data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
  124. data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
  125. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
  126. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
  127. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
  128. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
  129. data/rbi/context_dev/models/intake.rbi +7 -19
  130. data/rbi/context_dev/models/log_list_response.rbi +13 -11
  131. data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
  132. data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
  133. data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
  134. data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
  135. data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
  136. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
  137. data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
  138. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
  139. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
  140. data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
  141. data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
  142. data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
  143. data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
  144. data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
  145. data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
  146. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
  147. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
  148. data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
  149. data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
  150. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
  151. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
  152. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
  153. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
  154. data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
  155. data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
  156. data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
  157. data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
  158. data/rbi/context_dev/models/news_search_params.rbi +10 -2
  159. data/rbi/context_dev/models/news_search_response.rbi +9 -9
  160. data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
  161. data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
  162. data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
  163. data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
  164. data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
  165. data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
  166. data/rbi/context_dev/models/web_answers_params.rbi +33 -63
  167. data/rbi/context_dev/models/web_answers_response.rbi +11 -9
  168. data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
  169. data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
  170. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
  171. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
  172. data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
  173. data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
  174. data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
  175. data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
  176. data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
  177. data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
  178. data/rbi/context_dev/models/web_search_params.rbi +114 -82
  179. data/rbi/context_dev/models/web_search_response.rbi +145 -33
  180. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
  181. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
  182. data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
  183. data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
  184. data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
  185. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
  186. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
  187. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
  188. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
  189. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
  190. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
  191. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
  192. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
  193. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
  194. data/rbi/context_dev/resources/batch.rbi +19 -18
  195. data/rbi/context_dev/resources/brand.rbi +6 -9
  196. data/rbi/context_dev/resources/feedback.rbi +4 -5
  197. data/rbi/context_dev/resources/industry.rbi +11 -27
  198. data/rbi/context_dev/resources/logs.rbi +4 -5
  199. data/rbi/context_dev/resources/monitors.rbi +71 -49
  200. data/rbi/context_dev/resources/news.rbi +4 -8
  201. data/rbi/context_dev/resources/parse.rbi +7 -14
  202. data/rbi/context_dev/resources/people.rbi +15 -13
  203. data/rbi/context_dev/resources/utility.rbi +4 -11
  204. data/rbi/context_dev/resources/web.rbi +89 -190
  205. data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
  206. data/rbi/context_dev/resources/webhooks.rbi +1 -1
  207. data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
  208. data/sig/context_dev/models/monitor_create_params.rbs +113 -0
  209. data/sig/context_dev/models/monitor_create_response.rbs +203 -53
  210. data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
  211. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
  212. data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
  213. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
  214. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
  215. data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
  216. data/sig/context_dev/models/monitor_list_response.rbs +149 -3
  217. data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
  218. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
  219. data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
  220. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
  221. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
  222. data/sig/context_dev/models/monitor_run_response.rbs +48 -3
  223. data/sig/context_dev/models/monitor_update_params.rbs +113 -0
  224. data/sig/context_dev/models/monitor_update_response.rbs +203 -53
  225. data/sig/context_dev/models/web_scrape_response.rbs +204 -27
  226. data/sig/context_dev/models/web_search_params.rbs +25 -0
  227. data/sig/context_dev/models/web_search_response.rbs +48 -0
  228. data/sig/context_dev/resources/web.rbs +1 -0
  229. metadata +2 -2
@@ -8,12 +8,14 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute monitor_id
11
+ # ID of the monitor.
11
12
  #
12
13
  # @return [String]
13
14
  required :monitor_id, String
14
15
 
15
16
  # @!method initialize(monitor_id:, request_options: {})
16
- # @param monitor_id [String]
17
+ # @param monitor_id [String] ID of the monitor.
18
+ #
17
19
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
18
20
  end
19
21
  end
@@ -14,9 +14,52 @@ module ContextDev
14
14
  # @return [Boolean]
15
15
  required :deleted, ContextDev::Internal::Type::Boolean
16
16
 
17
- # @!method initialize(id:, deleted:)
17
+ # @!attribute request_id
18
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
19
+ # support.
20
+ #
21
+ # @return [String]
22
+ required :request_id, String
23
+
24
+ # @!attribute key_metadata
25
+ # Credits this request used and your remaining balance.
26
+ #
27
+ # @return [ContextDev::Models::MonitorDeleteResponse::KeyMetadata, nil]
28
+ optional :key_metadata, -> { ContextDev::Models::MonitorDeleteResponse::KeyMetadata }
29
+
30
+ # @!method initialize(id:, deleted:, request_id:, key_metadata: nil)
31
+ # Some parameter documentations has been truncated, see
32
+ # {ContextDev::Models::MonitorDeleteResponse} for more details.
33
+ #
18
34
  # @param id [String]
35
+ #
19
36
  # @param deleted [Boolean]
37
+ #
38
+ # @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
39
+ #
40
+ # @param key_metadata [ContextDev::Models::MonitorDeleteResponse::KeyMetadata] Credits this request used and your remaining balance.
41
+
42
+ # @see ContextDev::Models::MonitorDeleteResponse#key_metadata
43
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
44
+ # @!attribute credits_consumed
45
+ # Credits charged for this request.
46
+ #
47
+ # @return [Integer]
48
+ required :credits_consumed, Integer
49
+
50
+ # @!attribute credits_remaining
51
+ # Credits remaining for your organization.
52
+ #
53
+ # @return [Integer]
54
+ required :credits_remaining, Integer
55
+
56
+ # @!method initialize(credits_consumed:, credits_remaining:)
57
+ # Credits this request used and your remaining balance.
58
+ #
59
+ # @param credits_consumed [Integer] Credits charged for this request.
60
+ #
61
+ # @param credits_remaining [Integer] Credits remaining for your organization.
62
+ end
20
63
  end
21
64
  end
22
65
  end
@@ -10,16 +10,36 @@ module ContextDev
10
10
  required :data,
11
11
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorGetCreditUsageResponse::Data] }
12
12
 
13
+ # @!attribute request_id
14
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
15
+ # support.
16
+ #
17
+ # @return [String]
18
+ required :request_id, String
19
+
13
20
  # @!attribute total_credits
14
21
  # Sum of credits across all monitors in the window.
15
22
  #
16
23
  # @return [Integer]
17
24
  required :total_credits, Integer
18
25
 
19
- # @!method initialize(data:, total_credits:)
26
+ # @!attribute key_metadata
27
+ # Credits this request used and your remaining balance.
28
+ #
29
+ # @return [ContextDev::Models::MonitorGetCreditUsageResponse::KeyMetadata, nil]
30
+ optional :key_metadata, -> { ContextDev::Models::MonitorGetCreditUsageResponse::KeyMetadata }
31
+
32
+ # @!method initialize(data:, request_id:, total_credits:, key_metadata: nil)
33
+ # Some parameter documentations has been truncated, see
34
+ # {ContextDev::Models::MonitorGetCreditUsageResponse} for more details.
35
+ #
20
36
  # @param data [Array<ContextDev::Models::MonitorGetCreditUsageResponse::Data>]
21
37
  #
38
+ # @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
39
+ #
22
40
  # @param total_credits [Integer] Sum of credits across all monitors in the window.
41
+ #
42
+ # @param key_metadata [ContextDev::Models::MonitorGetCreditUsageResponse::KeyMetadata] Credits this request used and your remaining balance.
23
43
 
24
44
  class Data < ContextDev::Internal::Type::BaseModel
25
45
  # @!attribute credits
@@ -54,6 +74,28 @@ module ContextDev
54
74
  #
55
75
  # @param runs [Integer] Number of billed runs over the window.
56
76
  end
77
+
78
+ # @see ContextDev::Models::MonitorGetCreditUsageResponse#key_metadata
79
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
80
+ # @!attribute credits_consumed
81
+ # Credits charged for this request.
82
+ #
83
+ # @return [Integer]
84
+ required :credits_consumed, Integer
85
+
86
+ # @!attribute credits_remaining
87
+ # Credits remaining for your organization.
88
+ #
89
+ # @return [Integer]
90
+ required :credits_remaining, Integer
91
+
92
+ # @!method initialize(credits_consumed:, credits_remaining:)
93
+ # Credits this request used and your remaining balance.
94
+ #
95
+ # @param credits_consumed [Integer] Credits charged for this request.
96
+ #
97
+ # @param credits_remaining [Integer] Credits remaining for your organization.
98
+ end
57
99
  end
58
100
  end
59
101
  end
@@ -5,8 +5,7 @@ module ContextDev
5
5
  # @see ContextDev::Resources::Monitors#get_limits
6
6
  class MonitorGetLimitsResponse < ContextDev::Internal::Type::BaseModel
7
7
  # @!attribute monitors_limit
8
- # Maximum number of monitors allowed for the account. Defaults to the plan
9
- # allowance unless a custom limit is set for the organization.
8
+ # Most monitors you can have: your plan's allowance or a custom limit.
10
9
  #
11
10
  # @return [Integer]
12
11
  required :monitors_limit, Integer
@@ -18,22 +17,41 @@ module ContextDev
18
17
  required :monitors_used, Integer
19
18
 
20
19
  # @!attribute plan
21
- # The plan tier the limit was resolved from.
20
+ # `starter` means Developer; `pro` means Pro or Growth; `scale` means Scale or
21
+ # Enterprise.
22
22
  #
23
23
  # @return [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan]
24
24
  required :plan, enum: -> { ContextDev::Models::MonitorGetLimitsResponse::Plan }
25
25
 
26
- # @!method initialize(monitors_limit:, monitors_used:, plan:)
26
+ # @!attribute request_id
27
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
28
+ # support.
29
+ #
30
+ # @return [String]
31
+ required :request_id, String
32
+
33
+ # @!attribute key_metadata
34
+ # Credits this request used and your remaining balance.
35
+ #
36
+ # @return [ContextDev::Models::MonitorGetLimitsResponse::KeyMetadata, nil]
37
+ optional :key_metadata, -> { ContextDev::Models::MonitorGetLimitsResponse::KeyMetadata }
38
+
39
+ # @!method initialize(monitors_limit:, monitors_used:, plan:, request_id:, key_metadata: nil)
27
40
  # Some parameter documentations has been truncated, see
28
41
  # {ContextDev::Models::MonitorGetLimitsResponse} for more details.
29
42
  #
30
- # @param monitors_limit [Integer] Maximum number of monitors allowed for the account. Defaults to the plan allowan
43
+ # @param monitors_limit [Integer] Most monitors you can have: your plan's allowance or a custom limit.
31
44
  #
32
45
  # @param monitors_used [Integer] Number of monitors the account currently has.
33
46
  #
34
- # @param plan [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan] The plan tier the limit was resolved from.
47
+ # @param plan [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan] `starter` means Developer; `pro` means Pro or Growth; `scale` means Scale or Ent
48
+ #
49
+ # @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
50
+ #
51
+ # @param key_metadata [ContextDev::Models::MonitorGetLimitsResponse::KeyMetadata] Credits this request used and your remaining balance.
35
52
 
36
- # The plan tier the limit was resolved from.
53
+ # `starter` means Developer; `pro` means Pro or Growth; `scale` means Scale or
54
+ # Enterprise.
37
55
  #
38
56
  # @see ContextDev::Models::MonitorGetLimitsResponse#plan
39
57
  module Plan
@@ -47,6 +65,28 @@ module ContextDev
47
65
  # @!method self.values
48
66
  # @return [Array<Symbol>]
49
67
  end
68
+
69
+ # @see ContextDev::Models::MonitorGetLimitsResponse#key_metadata
70
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
71
+ # @!attribute credits_consumed
72
+ # Credits charged for this request.
73
+ #
74
+ # @return [Integer]
75
+ required :credits_consumed, Integer
76
+
77
+ # @!attribute credits_remaining
78
+ # Credits remaining for your organization.
79
+ #
80
+ # @return [Integer]
81
+ required :credits_remaining, Integer
82
+
83
+ # @!method initialize(credits_consumed:, credits_remaining:)
84
+ # Credits this request used and your remaining balance.
85
+ #
86
+ # @param credits_consumed [Integer] Credits charged for this request.
87
+ #
88
+ # @param credits_remaining [Integer] Credits remaining for your organization.
89
+ end
50
90
  end
51
91
  end
52
92
  end
@@ -20,10 +20,32 @@ module ContextDev
20
20
  # @return [String, nil]
21
21
  required :next_cursor, String, nil?: true
22
22
 
23
- # @!method initialize(data:, has_more:, next_cursor:)
23
+ # @!attribute request_id
24
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
25
+ # support.
26
+ #
27
+ # @return [String]
28
+ required :request_id, String
29
+
30
+ # @!attribute key_metadata
31
+ # Credits this request used and your remaining balance.
32
+ #
33
+ # @return [ContextDev::Models::MonitorListAccountChangesResponse::KeyMetadata, nil]
34
+ optional :key_metadata, -> { ContextDev::Models::MonitorListAccountChangesResponse::KeyMetadata }
35
+
36
+ # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
37
+ # Some parameter documentations has been truncated, see
38
+ # {ContextDev::Models::MonitorListAccountChangesResponse} for more details.
39
+ #
24
40
  # @param data [Array<ContextDev::Models::MonitorListAccountChangesResponse::Data>]
41
+ #
25
42
  # @param has_more [Boolean]
43
+ #
26
44
  # @param next_cursor [String, nil]
45
+ #
46
+ # @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
47
+ #
48
+ # @param key_metadata [ContextDev::Models::MonitorListAccountChangesResponse::KeyMetadata] Credits this request used and your remaining balance.
27
49
 
28
50
  class Data < ContextDev::Internal::Type::BaseModel
29
51
  # @!attribute id
@@ -43,8 +65,7 @@ module ContextDev
43
65
  required :detected_at, Time
44
66
 
45
67
  # @!attribute mode
46
- # Top-level monitor category. Always `web` today; the concrete behavior is
47
- # described by `target` and `change_detection`.
68
+ # Always `web`. Optional.
48
69
  #
49
70
  # @return [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::Mode]
50
71
  required :mode, enum: -> { ContextDev::Models::MonitorListAccountChangesResponse::Data::Mode }
@@ -54,11 +75,23 @@ module ContextDev
54
75
  # @return [String]
55
76
  required :monitor_id, String
56
77
 
78
+ # @!attribute run_id
79
+ # The run that detected this change.
80
+ #
81
+ # @return [String]
82
+ required :run_id, String
83
+
57
84
  # @!attribute summary
58
85
  #
59
86
  # @return [String]
60
87
  required :summary, String
61
88
 
89
+ # @!attribute tags
90
+ # Labels for filtering monitors, their changes, and their usage.
91
+ #
92
+ # @return [Array<String>]
93
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
94
+
62
95
  # @!attribute target_type
63
96
  #
64
97
  # @return [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::TargetType]
@@ -80,11 +113,39 @@ module ContextDev
80
113
  # @return [Integer, nil]
81
114
  optional :added_url_count, Integer
82
115
 
116
+ # @!attribute added_urls
117
+ # At most 500 URLs are included; the corresponding count field is always exact.
118
+ #
119
+ # @return [Array<String>, nil]
120
+ optional :added_urls, ContextDev::Internal::Type::ArrayOf[String]
121
+
122
+ # @!attribute after_text_excerpt
123
+ #
124
+ # @return [String, nil]
125
+ optional :after_text_excerpt, String
126
+
127
+ # @!attribute before_text_excerpt
128
+ #
129
+ # @return [String, nil]
130
+ optional :before_text_excerpt, String
131
+
83
132
  # @!attribute confidence
84
133
  #
85
134
  # @return [Float, nil]
86
135
  optional :confidence, Float
87
136
 
137
+ # @!attribute diff
138
+ # Text diff between the previous and current page baseline (page targets).
139
+ #
140
+ # @return [String, nil]
141
+ optional :diff, String
142
+
143
+ # @!attribute evidence
144
+ #
145
+ # @return [Array<ContextDev::Models::MonitorListAccountChangesResponse::Data::Evidence>, nil]
146
+ optional :evidence,
147
+ -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorListAccountChangesResponse::Data::Evidence] }
148
+
88
149
  # @!attribute importance
89
150
  #
90
151
  # @return [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::Importance, nil]
@@ -95,27 +156,25 @@ module ContextDev
95
156
  # @return [Integer, nil]
96
157
  optional :matched_url_count, Integer
97
158
 
159
+ # @!attribute matched_urls
160
+ # At most 500 URLs are included; the corresponding count field is always exact.
161
+ #
162
+ # @return [Array<String>, nil]
163
+ optional :matched_urls, ContextDev::Internal::Type::ArrayOf[String]
164
+
98
165
  # @!attribute removed_url_count
99
166
  #
100
167
  # @return [Integer, nil]
101
168
  optional :removed_url_count, Integer
102
169
 
103
- # @!attribute tags
104
- # User-defined tags for grouping and filtering monitors and their changes.
105
- # Duplicates are removed.
170
+ # @!attribute removed_urls
171
+ # At most 500 URLs are included; the corresponding count field is always exact.
106
172
  #
107
173
  # @return [Array<String>, nil]
108
- optional :tags, ContextDev::Internal::Type::ArrayOf[String]
174
+ optional :removed_urls, ContextDev::Internal::Type::ArrayOf[String]
109
175
 
110
- # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, summary:, target_type:, title:, url:, added_url_count: nil, confidence: nil, importance: nil, matched_url_count: nil, removed_url_count: nil, tags: nil)
111
- # Some parameter documentations has been truncated, see
112
- # {ContextDev::Models::MonitorListAccountChangesResponse::Data} for more details.
113
- #
114
- # A lightweight change summary. `mode` is the constant `web`; `target_type` and
115
- # `change_detection_type` describe the change, and which optional fields are
116
- # present depends on them (e.g. sitemap changes include
117
- # `added_url_count`/`removed_url_count`; semantic changes include
118
- # `confidence`/`importance`).
176
+ # @!method initialize(id:, change_detection_type:, detected_at:, mode:, monitor_id:, run_id:, summary:, tags:, target_type:, title:, url:, added_url_count: nil, added_urls: nil, after_text_excerpt: nil, before_text_excerpt: nil, confidence: nil, diff: nil, evidence: nil, importance: nil, matched_url_count: nil, matched_urls: nil, removed_url_count: nil, removed_urls: nil)
177
+ # Detected change, including applicable diffs, URLs, and supporting evidence.
119
178
  #
120
179
  # @param id [String]
121
180
  #
@@ -123,12 +182,16 @@ module ContextDev
123
182
  #
124
183
  # @param detected_at [Time]
125
184
  #
126
- # @param mode [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
185
+ # @param mode [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::Mode] Always `web`. Optional.
127
186
  #
128
187
  # @param monitor_id [String]
129
188
  #
189
+ # @param run_id [String] The run that detected this change.
190
+ #
130
191
  # @param summary [String]
131
192
  #
193
+ # @param tags [Array<String>] Labels for filtering monitors, their changes, and their usage.
194
+ #
132
195
  # @param target_type [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::TargetType]
133
196
  #
134
197
  # @param title [String]
@@ -137,15 +200,27 @@ module ContextDev
137
200
  #
138
201
  # @param added_url_count [Integer]
139
202
  #
203
+ # @param added_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
204
+ #
205
+ # @param after_text_excerpt [String]
206
+ #
207
+ # @param before_text_excerpt [String]
208
+ #
140
209
  # @param confidence [Float]
141
210
  #
211
+ # @param diff [String] Text diff between the previous and current page baseline (page targets).
212
+ #
213
+ # @param evidence [Array<ContextDev::Models::MonitorListAccountChangesResponse::Data::Evidence>]
214
+ #
142
215
  # @param importance [Symbol, ContextDev::Models::MonitorListAccountChangesResponse::Data::Importance]
143
216
  #
144
217
  # @param matched_url_count [Integer]
145
218
  #
219
+ # @param matched_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
220
+ #
146
221
  # @param removed_url_count [Integer]
147
222
  #
148
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
223
+ # @param removed_urls [Array<String>] At most 500 URLs are included; the corresponding count field is always exact.
149
224
 
150
225
  # @see ContextDev::Models::MonitorListAccountChangesResponse::Data#change_detection_type
151
226
  module ChangeDetectionType
@@ -158,8 +233,7 @@ module ContextDev
158
233
  # @return [Array<Symbol>]
159
234
  end
160
235
 
161
- # Top-level monitor category. Always `web` today; the concrete behavior is
162
- # described by `target` and `change_detection`.
236
+ # Always `web`. Optional.
163
237
  #
164
238
  # @see ContextDev::Models::MonitorListAccountChangesResponse::Data#mode
165
239
  module Mode
@@ -183,6 +257,33 @@ module ContextDev
183
257
  # @return [Array<Symbol>]
184
258
  end
185
259
 
260
+ class Evidence < ContextDev::Internal::Type::BaseModel
261
+ # @!attribute after
262
+ # Snapshot of the content after the change.
263
+ #
264
+ # @return [String]
265
+ required :after, String
266
+
267
+ # @!attribute before
268
+ # Snapshot of the content before the change.
269
+ #
270
+ # @return [String]
271
+ required :before, String
272
+
273
+ # @!attribute url
274
+ # Optional URL the evidence relates to. Absent for whole-target diffs.
275
+ #
276
+ # @return [String, nil]
277
+ optional :url, String
278
+
279
+ # @!method initialize(after:, before:, url: nil)
280
+ # @param after [String] Snapshot of the content after the change.
281
+ #
282
+ # @param before [String] Snapshot of the content before the change.
283
+ #
284
+ # @param url [String] Optional URL the evidence relates to. Absent for whole-target diffs.
285
+ end
286
+
186
287
  # @see ContextDev::Models::MonitorListAccountChangesResponse::Data#importance
187
288
  module Importance
188
289
  extend ContextDev::Internal::Type::Enum
@@ -195,6 +296,28 @@ module ContextDev
195
296
  # @return [Array<Symbol>]
196
297
  end
197
298
  end
299
+
300
+ # @see ContextDev::Models::MonitorListAccountChangesResponse#key_metadata
301
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
302
+ # @!attribute credits_consumed
303
+ # Credits charged for this request.
304
+ #
305
+ # @return [Integer]
306
+ required :credits_consumed, Integer
307
+
308
+ # @!attribute credits_remaining
309
+ # Credits remaining for your organization.
310
+ #
311
+ # @return [Integer]
312
+ required :credits_remaining, Integer
313
+
314
+ # @!method initialize(credits_consumed:, credits_remaining:)
315
+ # Credits this request used and your remaining balance.
316
+ #
317
+ # @param credits_consumed [Integer] Credits charged for this request.
318
+ #
319
+ # @param credits_remaining [Integer] Credits remaining for your organization.
320
+ end
198
321
  end
199
322
  end
200
323
  end
@@ -20,10 +20,32 @@ module ContextDev
20
20
  # @return [String, nil]
21
21
  required :next_cursor, String, nil?: true
22
22
 
23
- # @!method initialize(data:, has_more:, next_cursor:)
23
+ # @!attribute request_id
24
+ # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
25
+ # support.
26
+ #
27
+ # @return [String]
28
+ required :request_id, String
29
+
30
+ # @!attribute key_metadata
31
+ # Credits this request used and your remaining balance.
32
+ #
33
+ # @return [ContextDev::Models::MonitorListAccountRunsResponse::KeyMetadata, nil]
34
+ optional :key_metadata, -> { ContextDev::Models::MonitorListAccountRunsResponse::KeyMetadata }
35
+
36
+ # @!method initialize(data:, has_more:, next_cursor:, request_id:, key_metadata: nil)
37
+ # Some parameter documentations has been truncated, see
38
+ # {ContextDev::Models::MonitorListAccountRunsResponse} for more details.
39
+ #
24
40
  # @param data [Array<ContextDev::Models::MonitorListAccountRunsResponse::Data>]
41
+ #
25
42
  # @param has_more [Boolean]
43
+ #
26
44
  # @param next_cursor [String, nil]
45
+ #
46
+ # @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
47
+ #
48
+ # @param key_metadata [ContextDev::Models::MonitorListAccountRunsResponse::KeyMetadata] Credits this request used and your remaining balance.
27
49
 
28
50
  class Data < ContextDev::Internal::Type::BaseModel
29
51
  # @!attribute id
@@ -61,7 +83,7 @@ module ContextDev
61
83
  required :monitor_id, String
62
84
 
63
85
  # @!attribute run_type
64
- # The first run after monitor creation is a baseline run.
86
+ # A baseline run follows creation or a target or detection change.
65
87
  #
66
88
  # @return [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::RunType]
67
89
  required :run_type, enum: -> { ContextDev::Models::MonitorListAccountRunsResponse::Data::RunType }
@@ -117,9 +139,7 @@ module ContextDev
117
139
  # @!attribute webhook_delivery
118
140
  # @deprecated
119
141
  #
120
- # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
121
- # can deliver multiple events. Omitted when no webhook was attempted, including
122
- # historical runs created before delivery tracking was added.
142
+ # Deprecated. Use `webhook_deliveries` for all attempts.
123
143
  #
124
144
  # @return [ContextDev::Models::WebhookDelivery, nil]
125
145
  optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
@@ -146,7 +166,7 @@ module ContextDev
146
166
  #
147
167
  # @param monitor_id [String]
148
168
  #
149
- # @param run_type [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::RunType] The first run after monitor creation is a baseline run.
169
+ # @param run_type [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::RunType] A baseline run follows creation or a target or detection change.
150
170
  #
151
171
  # @param status [Symbol, ContextDev::Models::MonitorListAccountRunsResponse::Data::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
152
172
  #
@@ -164,7 +184,7 @@ module ContextDev
164
184
  #
165
185
  # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
166
186
  #
167
- # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
187
+ # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated. Use `webhook_deliveries` for all attempts.
168
188
  #
169
189
  # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
170
190
 
@@ -179,7 +199,7 @@ module ContextDev
179
199
  # @return [Array<Symbol>]
180
200
  end
181
201
 
182
- # The first run after monitor creation is a baseline run.
202
+ # A baseline run follows creation or a target or detection change.
183
203
  #
184
204
  # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#run_type
185
205
  module RunType
@@ -252,6 +272,28 @@ module ContextDev
252
272
  # @return [Array<Symbol>]
253
273
  end
254
274
  end
275
+
276
+ # @see ContextDev::Models::MonitorListAccountRunsResponse#key_metadata
277
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
278
+ # @!attribute credits_consumed
279
+ # Credits charged for this request.
280
+ #
281
+ # @return [Integer]
282
+ required :credits_consumed, Integer
283
+
284
+ # @!attribute credits_remaining
285
+ # Credits remaining for your organization.
286
+ #
287
+ # @return [Integer]
288
+ required :credits_remaining, Integer
289
+
290
+ # @!method initialize(credits_consumed:, credits_remaining:)
291
+ # Credits this request used and your remaining balance.
292
+ #
293
+ # @param credits_consumed [Integer] Credits charged for this request.
294
+ #
295
+ # @param credits_remaining [Integer] Credits remaining for your organization.
296
+ end
255
297
  end
256
298
  end
257
299
  end
@@ -8,6 +8,7 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute monitor_id
11
+ # ID of the monitor.
11
12
  #
12
13
  # @return [String]
13
14
  required :monitor_id, String
@@ -43,7 +44,7 @@ module ContextDev
43
44
  optional :until_, Time
44
45
 
45
46
  # @!method initialize(monitor_id:, cursor: nil, limit: nil, since: nil, tag: nil, until_: nil, request_options: {})
46
- # @param monitor_id [String]
47
+ # @param monitor_id [String] ID of the monitor.
47
48
  #
48
49
  # @param cursor [String] Opaque pagination cursor from a previous response.
49
50
  #