context.dev 2.3.0 → 2.5.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 (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +9 -9
  4. data/lib/context_dev/models/ai_extract_product_params.rb +9 -1
  5. data/lib/context_dev/models/ai_extract_products_params.rb +18 -2
  6. data/lib/context_dev/models/brand_retrieve_params.rb +109 -22
  7. data/lib/context_dev/models/brand_retrieve_response.rb +4 -6
  8. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +32 -3
  9. data/lib/context_dev/models/industry_retrieve_naics_params.rb +11 -1
  10. data/lib/context_dev/models/industry_retrieve_sic_params.rb +11 -1
  11. data/lib/context_dev/models/monitor_create_params.rb +6 -5
  12. data/lib/context_dev/models/monitor_create_response.rb +6 -5
  13. data/lib/context_dev/models/monitor_get_credit_usage_params.rb +30 -0
  14. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +59 -0
  15. data/lib/context_dev/models/monitor_get_limits_params.rb +14 -0
  16. data/lib/context_dev/models/monitor_get_limits_response.rb +52 -0
  17. data/lib/context_dev/models/monitor_list_account_changes_params.rb +16 -7
  18. data/lib/context_dev/models/monitor_list_account_changes_response.rb +2 -1
  19. data/lib/context_dev/models/monitor_list_account_runs_params.rb +7 -10
  20. data/lib/context_dev/models/monitor_list_changes_params.rb +8 -4
  21. data/lib/context_dev/models/monitor_list_changes_response.rb +2 -1
  22. data/lib/context_dev/models/monitor_list_params.rb +18 -19
  23. data/lib/context_dev/models/monitor_list_response.rb +6 -5
  24. data/lib/context_dev/models/monitor_list_runs_params.rb +7 -10
  25. data/lib/context_dev/models/monitor_retrieve_change_response.rb +2 -1
  26. data/lib/context_dev/models/monitor_retrieve_response.rb +6 -5
  27. data/lib/context_dev/models/monitor_update_params.rb +6 -5
  28. data/lib/context_dev/models/monitor_update_response.rb +6 -5
  29. data/lib/context_dev/models/parse_handle_params.rb +296 -46
  30. data/lib/context_dev/models/utility_prefetch_params.rb +9 -1
  31. data/lib/context_dev/models/web_extract_competitors_params.rb +11 -1
  32. data/lib/context_dev/models/web_extract_fonts_params.rb +14 -4
  33. data/lib/context_dev/models/web_extract_params.rb +19 -1
  34. data/lib/context_dev/models/web_extract_styleguide_params.rb +14 -4
  35. data/lib/context_dev/models/web_screenshot_params.rb +69 -18
  36. data/lib/context_dev/models/web_screenshot_response.rb +3 -2
  37. data/lib/context_dev/models/web_search_params.rb +9 -1
  38. data/lib/context_dev/models/web_web_crawl_md_params.rb +34 -1
  39. data/lib/context_dev/models/web_web_scrape_html_params.rb +268 -29
  40. data/lib/context_dev/models/web_web_scrape_images_params.rb +208 -19
  41. data/lib/context_dev/models/web_web_scrape_md_params.rb +352 -38
  42. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +45 -1
  43. data/lib/context_dev/models.rb +4 -0
  44. data/lib/context_dev/resources/ai.rb +3 -1
  45. data/lib/context_dev/resources/brand.rb +6 -2
  46. data/lib/context_dev/resources/industry.rb +6 -2
  47. data/lib/context_dev/resources/monitors.rb +70 -32
  48. data/lib/context_dev/resources/parse.rb +11 -11
  49. data/lib/context_dev/resources/utility.rb +3 -1
  50. data/lib/context_dev/resources/web.rb +104 -55
  51. data/lib/context_dev/version.rb +1 -1
  52. data/lib/context_dev.rb +4 -0
  53. data/rbi/context_dev/models/ai_extract_product_params.rbi +11 -0
  54. data/rbi/context_dev/models/ai_extract_products_params.rbi +22 -0
  55. data/rbi/context_dev/models/brand_retrieve_params.rbi +175 -64
  56. data/rbi/context_dev/models/brand_retrieve_response.rbi +8 -11
  57. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +68 -5
  58. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +15 -0
  59. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +15 -0
  60. data/rbi/context_dev/models/monitor_create_params.rbi +6 -4
  61. data/rbi/context_dev/models/monitor_create_response.rbi +6 -4
  62. data/rbi/context_dev/models/monitor_get_credit_usage_params.rbi +60 -0
  63. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +111 -0
  64. data/rbi/context_dev/models/monitor_get_limits_params.rbi +30 -0
  65. data/rbi/context_dev/models/monitor_get_limits_response.rbi +105 -0
  66. data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +16 -0
  67. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +2 -0
  68. data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +7 -6
  69. data/rbi/context_dev/models/monitor_list_changes_params.rbi +8 -0
  70. data/rbi/context_dev/models/monitor_list_changes_response.rbi +2 -0
  71. data/rbi/context_dev/models/monitor_list_params.rbi +23 -31
  72. data/rbi/context_dev/models/monitor_list_response.rbi +6 -4
  73. data/rbi/context_dev/models/monitor_list_runs_params.rbi +7 -6
  74. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +2 -0
  75. data/rbi/context_dev/models/monitor_retrieve_response.rbi +6 -4
  76. data/rbi/context_dev/models/monitor_update_params.rbi +6 -4
  77. data/rbi/context_dev/models/monitor_update_response.rbi +6 -4
  78. data/rbi/context_dev/models/parse_handle_params.rbi +601 -71
  79. data/rbi/context_dev/models/utility_prefetch_params.rbi +11 -0
  80. data/rbi/context_dev/models/web_extract_competitors_params.rbi +15 -0
  81. data/rbi/context_dev/models/web_extract_fonts_params.rbi +19 -7
  82. data/rbi/context_dev/models/web_extract_params.rbi +26 -0
  83. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +19 -7
  84. data/rbi/context_dev/models/web_screenshot_params.rbi +108 -37
  85. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -2
  86. data/rbi/context_dev/models/web_search_params.rbi +11 -0
  87. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +53 -0
  88. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +554 -49
  89. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +426 -30
  90. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +742 -61
  91. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +82 -0
  92. data/rbi/context_dev/models.rbi +4 -0
  93. data/rbi/context_dev/resources/ai.rbi +3 -0
  94. data/rbi/context_dev/resources/brand.rbi +9 -1
  95. data/rbi/context_dev/resources/industry.rbi +10 -0
  96. data/rbi/context_dev/resources/monitors.rbi +55 -11
  97. data/rbi/context_dev/resources/parse.rbi +44 -24
  98. data/rbi/context_dev/resources/utility.rbi +3 -0
  99. data/rbi/context_dev/resources/web.rbi +224 -48
  100. data/sig/context_dev/models/ai_extract_product_params.rbs +12 -1
  101. data/sig/context_dev/models/ai_extract_products_params.rbs +14 -0
  102. data/sig/context_dev/models/brand_retrieve_params.rbs +97 -51
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +2 -2
  104. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +34 -5
  105. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +7 -0
  106. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +7 -0
  107. data/sig/context_dev/models/monitor_get_credit_usage_params.rbs +32 -0
  108. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +52 -0
  109. data/sig/context_dev/models/monitor_get_limits_params.rbs +15 -0
  110. data/sig/context_dev/models/monitor_get_limits_response.rbs +43 -0
  111. data/sig/context_dev/models/monitor_list_params.rbs +8 -14
  112. data/sig/context_dev/models/parse_handle_params.rbs +297 -50
  113. data/sig/context_dev/models/utility_prefetch_params.rbs +7 -0
  114. data/sig/context_dev/models/web_extract_competitors_params.rbs +12 -1
  115. data/sig/context_dev/models/web_extract_fonts_params.rbs +10 -5
  116. data/sig/context_dev/models/web_extract_params.rbs +14 -0
  117. data/sig/context_dev/models/web_extract_styleguide_params.rbs +10 -5
  118. data/sig/context_dev/models/web_screenshot_params.rbs +41 -20
  119. data/sig/context_dev/models/web_search_params.rbs +7 -0
  120. data/sig/context_dev/models/web_web_crawl_md_params.rbs +28 -1
  121. data/sig/context_dev/models/web_web_scrape_html_params.rbs +175 -47
  122. data/sig/context_dev/models/web_web_scrape_images_params.rbs +128 -38
  123. data/sig/context_dev/models/web_web_scrape_md_params.rbs +229 -62
  124. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +35 -1
  125. data/sig/context_dev/models.rbs +4 -0
  126. data/sig/context_dev/resources/ai.rbs +1 -0
  127. data/sig/context_dev/resources/brand.rbs +3 -1
  128. data/sig/context_dev/resources/industry.rbs +2 -0
  129. data/sig/context_dev/resources/monitors.rbs +12 -2
  130. data/sig/context_dev/resources/parse.rbs +10 -10
  131. data/sig/context_dev/resources/utility.rbs +1 -0
  132. data/sig/context_dev/resources/web.rbs +47 -26
  133. metadata +14 -2
@@ -27,6 +27,14 @@ module ContextDev
27
27
  # @return [Integer, nil]
28
28
  optional :min_results, Integer
29
29
 
30
+ # @!attribute tags
31
+ # Optional comma-separated caller-defined tags for tracking this request. Tags are
32
+ # recorded on the request's usage log and can be used to filter usage on the
33
+ # dashboard usage page. Up to 20 tags, each 1-50 characters.
34
+ #
35
+ # @return [Array<String>, nil]
36
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String]
37
+
30
38
  # @!attribute timeout_ms
31
39
  # Optional timeout in milliseconds for the request. If the request takes longer
32
40
  # than this value, it will be aborted with a 408 status code. Maximum allowed
@@ -43,7 +51,7 @@ module ContextDev
43
51
  # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
44
52
  optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
45
53
 
46
- # @!method initialize(input:, max_results: nil, min_results: nil, timeout_ms: nil, type: nil, request_options: {})
54
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, type: nil, request_options: {})
47
55
  # Some parameter documentations has been truncated, see
48
56
  # {ContextDev::Models::IndustryRetrieveSicParams} for more details.
49
57
  #
@@ -53,6 +61,8 @@ module ContextDev
53
61
  #
54
62
  # @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
55
63
  #
64
+ # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
65
+ #
56
66
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
57
67
  #
58
68
  # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
@@ -41,6 +41,7 @@ module ContextDev
41
41
 
42
42
  # @!attribute tags
43
43
  # User-defined tags for grouping and filtering monitors and their changes.
44
+ # Duplicates are removed.
44
45
  #
45
46
  # @return [Array<String>, nil]
46
47
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -64,7 +65,7 @@ module ContextDev
64
65
  #
65
66
  # @param mode [Symbol, ContextDev::Models::MonitorCreateParams::Mode] Top-level monitor category. Always `web` today; the concrete behavior is describ
66
67
  #
67
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
68
+ # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
68
69
  #
69
70
  # @param webhook [ContextDev::Models::MonitorCreateParams::Webhook, nil]
70
71
  #
@@ -230,13 +231,13 @@ module ContextDev
230
231
  required :url, String
231
232
 
232
233
  # @!attribute exclude
233
- # URL path patterns to exclude.
234
+ # URL path patterns to exclude (max 50).
234
235
  #
235
236
  # @return [Array<String>, nil]
236
237
  optional :exclude, ContextDev::Internal::Type::ArrayOf[String]
237
238
 
238
239
  # @!attribute include
239
- # URL path patterns to include.
240
+ # URL path patterns to include (max 50).
240
241
  #
241
242
  # @return [Array<String>, nil]
242
243
  optional :include, ContextDev::Internal::Type::ArrayOf[String]
@@ -256,9 +257,9 @@ module ContextDev
256
257
  #
257
258
  # @param url [String] Sitemap URL to monitor.
258
259
  #
259
- # @param exclude [Array<String>] URL path patterns to exclude.
260
+ # @param exclude [Array<String>] URL path patterns to exclude (max 50).
260
261
  #
261
- # @param include [Array<String>] URL path patterns to include.
262
+ # @param include [Array<String>] URL path patterns to include (max 50).
262
263
  #
263
264
  # @param max_urls [Integer] Maximum number of sitemap URLs to track (capped at 10,000).
264
265
  #
@@ -94,6 +94,7 @@ module ContextDev
94
94
 
95
95
  # @!attribute tags
96
96
  # User-defined tags for grouping and filtering monitors and their changes.
97
+ # Duplicates are removed.
97
98
  #
98
99
  # @return [Array<String>, nil]
99
100
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -146,7 +147,7 @@ module ContextDev
146
147
  #
147
148
  # @param next_run_at [Time, nil] When the next scheduled run is due.
148
149
  #
149
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
150
+ # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
150
151
  #
151
152
  # @param webhook [ContextDev::Models::MonitorCreateResponse::Webhook, nil]
152
153
  #
@@ -348,13 +349,13 @@ module ContextDev
348
349
  required :url, String
349
350
 
350
351
  # @!attribute exclude
351
- # URL path patterns to exclude.
352
+ # URL path patterns to exclude (max 50).
352
353
  #
353
354
  # @return [Array<String>, nil]
354
355
  optional :exclude, ContextDev::Internal::Type::ArrayOf[String]
355
356
 
356
357
  # @!attribute include
357
- # URL path patterns to include.
358
+ # URL path patterns to include (max 50).
358
359
  #
359
360
  # @return [Array<String>, nil]
360
361
  optional :include, ContextDev::Internal::Type::ArrayOf[String]
@@ -374,9 +375,9 @@ module ContextDev
374
375
  #
375
376
  # @param url [String] Sitemap URL to monitor.
376
377
  #
377
- # @param exclude [Array<String>] URL path patterns to exclude.
378
+ # @param exclude [Array<String>] URL path patterns to exclude (max 50).
378
379
  #
379
- # @param include [Array<String>] URL path patterns to include.
380
+ # @param include [Array<String>] URL path patterns to include (max 50).
380
381
  #
381
382
  # @param max_urls [Integer] Maximum number of sitemap URLs to track (capped at 10,000).
382
383
  #
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#get_credit_usage
6
+ class MonitorGetCreditUsageParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute since
11
+ # Only include items at or after this ISO 8601 timestamp.
12
+ #
13
+ # @return [Time, nil]
14
+ optional :since, Time
15
+
16
+ # @!attribute until_
17
+ # Only include items before this ISO 8601 timestamp.
18
+ #
19
+ # @return [Time, nil]
20
+ optional :until_, Time
21
+
22
+ # @!method initialize(since: nil, until_: nil, request_options: {})
23
+ # @param since [Time] Only include items at or after this ISO 8601 timestamp.
24
+ #
25
+ # @param until_ [Time] Only include items before this ISO 8601 timestamp.
26
+ #
27
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#get_credit_usage
6
+ class MonitorGetCreditUsageResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Array<ContextDev::Models::MonitorGetCreditUsageResponse::Data>]
10
+ required :data,
11
+ -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::MonitorGetCreditUsageResponse::Data] }
12
+
13
+ # @!attribute total_credits
14
+ # Sum of credits across all monitors in the window.
15
+ #
16
+ # @return [Integer]
17
+ required :total_credits, Integer
18
+
19
+ # @!method initialize(data:, total_credits:)
20
+ # @param data [Array<ContextDev::Models::MonitorGetCreditUsageResponse::Data>]
21
+ #
22
+ # @param total_credits [Integer] Sum of credits across all monitors in the window.
23
+
24
+ class Data < ContextDev::Internal::Type::BaseModel
25
+ # @!attribute credits
26
+ # Credits charged to this monitor over the window.
27
+ #
28
+ # @return [Integer]
29
+ required :credits, Integer
30
+
31
+ # @!attribute monitor_id
32
+ #
33
+ # @return [String]
34
+ required :monitor_id, String
35
+
36
+ # @!attribute name
37
+ # Monitor name (falls back to the id when the monitor was deleted).
38
+ #
39
+ # @return [String]
40
+ required :name, String
41
+
42
+ # @!attribute runs
43
+ # Number of billed runs over the window.
44
+ #
45
+ # @return [Integer]
46
+ required :runs, Integer
47
+
48
+ # @!method initialize(credits:, monitor_id:, name:, runs:)
49
+ # @param credits [Integer] Credits charged to this monitor over the window.
50
+ #
51
+ # @param monitor_id [String]
52
+ #
53
+ # @param name [String] Monitor name (falls back to the id when the monitor was deleted).
54
+ #
55
+ # @param runs [Integer] Number of billed runs over the window.
56
+ end
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#get_limits
6
+ class MonitorGetLimitsParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#get_limits
6
+ class MonitorGetLimitsResponse < ContextDev::Internal::Type::BaseModel
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.
10
+ #
11
+ # @return [Integer]
12
+ required :monitors_limit, Integer
13
+
14
+ # @!attribute monitors_used
15
+ # Number of monitors the account currently has.
16
+ #
17
+ # @return [Integer]
18
+ required :monitors_used, Integer
19
+
20
+ # @!attribute plan
21
+ # The plan tier the limit was resolved from.
22
+ #
23
+ # @return [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan]
24
+ required :plan, enum: -> { ContextDev::Models::MonitorGetLimitsResponse::Plan }
25
+
26
+ # @!method initialize(monitors_limit:, monitors_used:, plan:)
27
+ # Some parameter documentations has been truncated, see
28
+ # {ContextDev::Models::MonitorGetLimitsResponse} for more details.
29
+ #
30
+ # @param monitors_limit [Integer] Maximum number of monitors allowed for the account. Defaults to the plan allowan
31
+ #
32
+ # @param monitors_used [Integer] Number of monitors the account currently has.
33
+ #
34
+ # @param plan [Symbol, ContextDev::Models::MonitorGetLimitsResponse::Plan] The plan tier the limit was resolved from.
35
+
36
+ # The plan tier the limit was resolved from.
37
+ #
38
+ # @see ContextDev::Models::MonitorGetLimitsResponse#plan
39
+ module Plan
40
+ extend ContextDev::Internal::Type::Enum
41
+
42
+ FREE = :free
43
+ STARTER = :starter
44
+ PRO = :pro
45
+ SCALE = :scale
46
+
47
+ # @!method self.values
48
+ # @return [Array<Symbol>]
49
+ end
50
+ end
51
+ end
52
+ end
@@ -8,27 +8,32 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute change_detection_type
11
+ # Filter by change detection type.
11
12
  #
12
13
  # @return [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType, nil]
13
14
  optional :change_detection_type,
14
15
  enum: -> { ContextDev::MonitorListAccountChangesParams::ChangeDetectionType }
15
16
 
16
17
  # @!attribute cursor
18
+ # Opaque pagination cursor from a previous response.
17
19
  #
18
20
  # @return [String, nil]
19
21
  optional :cursor, String
20
22
 
21
23
  # @!attribute limit
24
+ # Maximum number of items to return per page (1-100). Defaults to 25.
22
25
  #
23
26
  # @return [Integer, nil]
24
27
  optional :limit, Integer
25
28
 
26
29
  # @!attribute monitor_id
30
+ # Filter changes to a single monitor.
27
31
  #
28
32
  # @return [String, nil]
29
33
  optional :monitor_id, String
30
34
 
31
35
  # @!attribute since
36
+ # Only include items at or after this ISO 8601 timestamp.
32
37
  #
33
38
  # @return [Time, nil]
34
39
  optional :since, Time
@@ -40,34 +45,37 @@ module ContextDev
40
45
  optional :tag, String
41
46
 
42
47
  # @!attribute target_type
48
+ # Filter by target type.
43
49
  #
44
50
  # @return [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType, nil]
45
51
  optional :target_type, enum: -> { ContextDev::MonitorListAccountChangesParams::TargetType }
46
52
 
47
53
  # @!attribute until_
54
+ # Only include items before this ISO 8601 timestamp.
48
55
  #
49
56
  # @return [Time, nil]
50
57
  optional :until_, Time
51
58
 
52
59
  # @!method initialize(change_detection_type: nil, cursor: nil, limit: nil, monitor_id: nil, since: nil, tag: nil, target_type: nil, until_: nil, request_options: {})
53
- # @param change_detection_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType]
60
+ # @param change_detection_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::ChangeDetectionType] Filter by change detection type.
54
61
  #
55
- # @param cursor [String]
62
+ # @param cursor [String] Opaque pagination cursor from a previous response.
56
63
  #
57
- # @param limit [Integer]
64
+ # @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
58
65
  #
59
- # @param monitor_id [String]
66
+ # @param monitor_id [String] Filter changes to a single monitor.
60
67
  #
61
- # @param since [Time]
68
+ # @param since [Time] Only include items at or after this ISO 8601 timestamp.
62
69
  #
63
70
  # @param tag [String] Filter to items that have this tag.
64
71
  #
65
- # @param target_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType]
72
+ # @param target_type [Symbol, ContextDev::Models::MonitorListAccountChangesParams::TargetType] Filter by target type.
66
73
  #
67
- # @param until_ [Time]
74
+ # @param until_ [Time] Only include items before this ISO 8601 timestamp.
68
75
  #
69
76
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
70
77
 
78
+ # Filter by change detection type.
71
79
  module ChangeDetectionType
72
80
  extend ContextDev::Internal::Type::Enum
73
81
 
@@ -78,6 +86,7 @@ module ContextDev
78
86
  # @return [Array<Symbol>]
79
87
  end
80
88
 
89
+ # Filter by target type.
81
90
  module TargetType
82
91
  extend ContextDev::Internal::Type::Enum
83
92
 
@@ -102,6 +102,7 @@ module ContextDev
102
102
 
103
103
  # @!attribute tags
104
104
  # User-defined tags for grouping and filtering monitors and their changes.
105
+ # Duplicates are removed.
105
106
  #
106
107
  # @return [Array<String>, nil]
107
108
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -144,7 +145,7 @@ module ContextDev
144
145
  #
145
146
  # @param removed_url_count [Integer]
146
147
  #
147
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
148
+ # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
148
149
 
149
150
  # @see ContextDev::Models::MonitorListAccountChangesResponse::Data#change_detection_type
150
151
  module ChangeDetectionType
@@ -8,36 +8,33 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute cursor
11
+ # Opaque pagination cursor from a previous response.
11
12
  #
12
13
  # @return [String, nil]
13
14
  optional :cursor, String
14
15
 
15
16
  # @!attribute limit
17
+ # Maximum number of items to return per page (1-100). Defaults to 25.
16
18
  #
17
19
  # @return [Integer, nil]
18
20
  optional :limit, Integer
19
21
 
20
22
  # @!attribute status
21
- # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
22
- # (insufficient credits, monitor paused, or superseded by a concurrent run).
23
+ # Filter runs by lifecycle status.
23
24
  #
24
25
  # @return [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status, nil]
25
26
  optional :status, enum: -> { ContextDev::MonitorListAccountRunsParams::Status }
26
27
 
27
28
  # @!method initialize(cursor: nil, limit: nil, status: nil, request_options: {})
28
- # Some parameter documentations has been truncated, see
29
- # {ContextDev::Models::MonitorListAccountRunsParams} for more details.
29
+ # @param cursor [String] Opaque pagination cursor from a previous response.
30
30
  #
31
- # @param cursor [String]
31
+ # @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
32
32
  #
33
- # @param limit [Integer]
34
- #
35
- # @param status [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
33
+ # @param status [Symbol, ContextDev::Models::MonitorListAccountRunsParams::Status] Filter runs by lifecycle status.
36
34
  #
37
35
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
38
36
 
39
- # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
40
- # (insufficient credits, monitor paused, or superseded by a concurrent run).
37
+ # Filter runs by lifecycle status.
41
38
  module Status
42
39
  extend ContextDev::Internal::Type::Enum
43
40
 
@@ -13,16 +13,19 @@ module ContextDev
13
13
  required :monitor_id, String
14
14
 
15
15
  # @!attribute cursor
16
+ # Opaque pagination cursor from a previous response.
16
17
  #
17
18
  # @return [String, nil]
18
19
  optional :cursor, String
19
20
 
20
21
  # @!attribute limit
22
+ # Maximum number of items to return per page (1-100). Defaults to 25.
21
23
  #
22
24
  # @return [Integer, nil]
23
25
  optional :limit, Integer
24
26
 
25
27
  # @!attribute since
28
+ # Only include items at or after this ISO 8601 timestamp.
26
29
  #
27
30
  # @return [Time, nil]
28
31
  optional :since, Time
@@ -34,6 +37,7 @@ module ContextDev
34
37
  optional :tag, String
35
38
 
36
39
  # @!attribute until_
40
+ # Only include items before this ISO 8601 timestamp.
37
41
  #
38
42
  # @return [Time, nil]
39
43
  optional :until_, Time
@@ -41,15 +45,15 @@ module ContextDev
41
45
  # @!method initialize(monitor_id:, cursor: nil, limit: nil, since: nil, tag: nil, until_: nil, request_options: {})
42
46
  # @param monitor_id [String]
43
47
  #
44
- # @param cursor [String]
48
+ # @param cursor [String] Opaque pagination cursor from a previous response.
45
49
  #
46
- # @param limit [Integer]
50
+ # @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
47
51
  #
48
- # @param since [Time]
52
+ # @param since [Time] Only include items at or after this ISO 8601 timestamp.
49
53
  #
50
54
  # @param tag [String] Filter to items that have this tag.
51
55
  #
52
- # @param until_ [Time]
56
+ # @param until_ [Time] Only include items before this ISO 8601 timestamp.
53
57
  #
54
58
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
55
59
  end
@@ -101,6 +101,7 @@ module ContextDev
101
101
 
102
102
  # @!attribute tags
103
103
  # User-defined tags for grouping and filtering monitors and their changes.
104
+ # Duplicates are removed.
104
105
  #
105
106
  # @return [Array<String>, nil]
106
107
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -143,7 +144,7 @@ module ContextDev
143
144
  #
144
145
  # @param removed_url_count [Integer]
145
146
  #
146
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
147
+ # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
147
148
 
148
149
  # @see ContextDev::Models::MonitorListChangesResponse::Data#change_detection_type
149
150
  module ChangeDetectionType
@@ -8,16 +8,19 @@ module ContextDev
8
8
  include ContextDev::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute change_detection_type
11
+ # Filter by change detection type.
11
12
  #
12
13
  # @return [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType, nil]
13
14
  optional :change_detection_type, enum: -> { ContextDev::MonitorListParams::ChangeDetectionType }
14
15
 
15
16
  # @!attribute cursor
17
+ # Opaque pagination cursor from a previous response.
16
18
  #
17
19
  # @return [String, nil]
18
20
  optional :cursor, String
19
21
 
20
22
  # @!attribute limit
23
+ # Maximum number of items to return per page (1-100). Defaults to 25.
21
24
  #
22
25
  # @return [Integer, nil]
23
26
  optional :limit, Integer
@@ -34,7 +37,8 @@ module ContextDev
34
37
  #
35
38
  # @return [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil]
36
39
  optional :search_by,
37
- -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorListParams::SearchBy] }
40
+ -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorListParams::SearchBy] },
41
+ nil?: true
38
42
 
39
43
  # @!attribute search_type
40
44
  # `prefix` for as-you-type prefix matching (default), `exact` for full-token
@@ -44,11 +48,7 @@ module ContextDev
44
48
  optional :search_type, enum: -> { ContextDev::MonitorListParams::SearchType }
45
49
 
46
50
  # @!attribute status
47
- # Monitor lifecycle status. `failed` means the most recent run failed (see the
48
- # monitor's `last_error`); failed monitors keep running on schedule and flip back
49
- # to `active` on the next successful run. Monitors are auto-`paused` after
50
- # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
51
- # status to `active`.
51
+ # Filter monitors by lifecycle status.
52
52
  #
53
53
  # @return [Symbol, ContextDev::Models::MonitorListParams::Status, nil]
54
54
  optional :status, enum: -> { ContextDev::MonitorListParams::Status }
@@ -63,9 +63,10 @@ module ContextDev
63
63
  # Comma-separated list of tags to filter by (matches monitors having any of them).
64
64
  #
65
65
  # @return [Array<String>, nil]
66
- optional :tags, ContextDev::Internal::Type::ArrayOf[String]
66
+ optional :tags, ContextDev::Internal::Type::ArrayOf[String], nil?: true
67
67
 
68
68
  # @!attribute target_type
69
+ # Filter by target type.
69
70
  #
70
71
  # @return [Symbol, ContextDev::Models::MonitorListParams::TargetType, nil]
71
72
  optional :target_type, enum: -> { ContextDev::MonitorListParams::TargetType }
@@ -74,28 +75,29 @@ module ContextDev
74
75
  # Some parameter documentations has been truncated, see
75
76
  # {ContextDev::Models::MonitorListParams} for more details.
76
77
  #
77
- # @param change_detection_type [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType]
78
+ # @param change_detection_type [Symbol, ContextDev::Models::MonitorListParams::ChangeDetectionType] Filter by change detection type.
78
79
  #
79
- # @param cursor [String]
80
+ # @param cursor [String] Opaque pagination cursor from a previous response.
80
81
  #
81
- # @param limit [Integer]
82
+ # @param limit [Integer] Maximum number of items to return per page (1-100). Defaults to 25.
82
83
  #
83
84
  # @param q [String] Free-text search term, matched against the fields named in `search_by`.
84
85
  #
85
- # @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>] Comma-separated fields to search with `q`. Defaults to all of them. Note `instru
86
+ # @param search_by [Array<Symbol, ContextDev::Models::MonitorListParams::SearchBy>, nil] Comma-separated fields to search with `q`. Defaults to all of them. Note `instru
86
87
  #
87
88
  # @param search_type [Symbol, ContextDev::Models::MonitorListParams::SearchType] `prefix` for as-you-type prefix matching (default), `exact` for full-token match
88
89
  #
89
- # @param status [Symbol, ContextDev::Models::MonitorListParams::Status] Monitor lifecycle status. `failed` means the most recent run failed (see the mon
90
+ # @param status [Symbol, ContextDev::Models::MonitorListParams::Status] Filter monitors by lifecycle status.
90
91
  #
91
92
  # @param tag [String] Filter to items that have this tag.
92
93
  #
93
- # @param tags [Array<String>] Comma-separated list of tags to filter by (matches monitors having any of them).
94
+ # @param tags [Array<String>, nil] Comma-separated list of tags to filter by (matches monitors having any of them).
94
95
  #
95
- # @param target_type [Symbol, ContextDev::Models::MonitorListParams::TargetType]
96
+ # @param target_type [Symbol, ContextDev::Models::MonitorListParams::TargetType] Filter by target type.
96
97
  #
97
98
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
98
99
 
100
+ # Filter by change detection type.
99
101
  module ChangeDetectionType
100
102
  extend ContextDev::Internal::Type::Enum
101
103
 
@@ -130,11 +132,7 @@ module ContextDev
130
132
  # @return [Array<Symbol>]
131
133
  end
132
134
 
133
- # Monitor lifecycle status. `failed` means the most recent run failed (see the
134
- # monitor's `last_error`); failed monitors keep running on schedule and flip back
135
- # to `active` on the next successful run. Monitors are auto-`paused` after
136
- # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
137
- # status to `active`.
135
+ # Filter monitors by lifecycle status.
138
136
  module Status
139
137
  extend ContextDev::Internal::Type::Enum
140
138
 
@@ -146,6 +144,7 @@ module ContextDev
146
144
  # @return [Array<Symbol>]
147
145
  end
148
146
 
147
+ # Filter by target type.
149
148
  module TargetType
150
149
  extend ContextDev::Internal::Type::Enum
151
150
 
@@ -115,6 +115,7 @@ module ContextDev
115
115
 
116
116
  # @!attribute tags
117
117
  # User-defined tags for grouping and filtering monitors and their changes.
118
+ # Duplicates are removed.
118
119
  #
119
120
  # @return [Array<String>, nil]
120
121
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -169,7 +170,7 @@ module ContextDev
169
170
  #
170
171
  # @param next_run_at [Time, nil] When the next scheduled run is due.
171
172
  #
172
- # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes.
173
+ # @param tags [Array<String>] User-defined tags for grouping and filtering monitors and their changes. Duplica
173
174
  #
174
175
  # @param webhook [ContextDev::Models::MonitorListResponse::Data::Webhook, nil]
175
176
  #
@@ -371,13 +372,13 @@ module ContextDev
371
372
  required :url, String
372
373
 
373
374
  # @!attribute exclude
374
- # URL path patterns to exclude.
375
+ # URL path patterns to exclude (max 50).
375
376
  #
376
377
  # @return [Array<String>, nil]
377
378
  optional :exclude, ContextDev::Internal::Type::ArrayOf[String]
378
379
 
379
380
  # @!attribute include
380
- # URL path patterns to include.
381
+ # URL path patterns to include (max 50).
381
382
  #
382
383
  # @return [Array<String>, nil]
383
384
  optional :include, ContextDev::Internal::Type::ArrayOf[String]
@@ -397,9 +398,9 @@ module ContextDev
397
398
  #
398
399
  # @param url [String] Sitemap URL to monitor.
399
400
  #
400
- # @param exclude [Array<String>] URL path patterns to exclude.
401
+ # @param exclude [Array<String>] URL path patterns to exclude (max 50).
401
402
  #
402
- # @param include [Array<String>] URL path patterns to include.
403
+ # @param include [Array<String>] URL path patterns to include (max 50).
403
404
  #
404
405
  # @param max_urls [Integer] Maximum number of sitemap URLs to track (capped at 10,000).
405
406
  #