context.dev 2.17.1 → 2.19.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 (139) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +33 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +0 -4
  5. data/lib/context_dev/models/industry_retrieve_naics_params.rb +28 -1
  6. data/lib/context_dev/models/industry_retrieve_sic_params.rb +28 -1
  7. data/lib/context_dev/models/monitor_retrieve_run_params.rb +26 -0
  8. data/lib/context_dev/models/monitor_retrieve_run_response.rb +232 -0
  9. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +20 -0
  10. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +765 -0
  11. data/lib/context_dev/models/parse_handle_params.rb +8 -6
  12. data/lib/context_dev/models/person_enrich_params.rb +28 -1
  13. data/lib/context_dev/models/web_answers_params.rb +28 -1
  14. data/lib/context_dev/models/web_extract_competitors_params.rb +28 -1
  15. data/lib/context_dev/models/web_extract_styleguide_params.rb +30 -3
  16. data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb} +22 -20
  17. data/lib/context_dev/models/web_map_urls_response.rb +123 -0
  18. data/lib/context_dev/models/web_scrape_params.rb +906 -0
  19. data/lib/context_dev/models/web_scrape_response.rb +659 -0
  20. data/lib/context_dev/models/web_screenshot_params.rb +25 -9
  21. data/lib/context_dev/models/web_screenshot_response.rb +3 -3
  22. data/lib/context_dev/models/web_search_params.rb +30 -3
  23. data/lib/context_dev/models.rb +8 -20
  24. data/lib/context_dev/resources/brand.rb +0 -36
  25. data/lib/context_dev/resources/industry.rb +6 -2
  26. data/lib/context_dev/resources/monitors.rb +47 -0
  27. data/lib/context_dev/resources/people.rb +3 -1
  28. data/lib/context_dev/resources/web.rb +116 -413
  29. data/lib/context_dev/version.rb +1 -1
  30. data/lib/context_dev.rb +8 -21
  31. data/rbi/context_dev/client.rbi +0 -3
  32. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +59 -0
  33. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +57 -0
  34. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +46 -0
  35. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +452 -0
  36. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +38 -0
  37. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +1367 -0
  38. data/rbi/context_dev/models/parse_handle_params.rbi +12 -9
  39. data/rbi/context_dev/models/person_enrich_params.rbi +45 -0
  40. data/rbi/context_dev/models/web_answers_params.rbi +45 -0
  41. data/rbi/context_dev/models/web_extract_competitors_params.rbi +59 -0
  42. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +62 -3
  43. data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi} +35 -54
  44. data/rbi/context_dev/models/web_map_urls_response.rbi +226 -0
  45. data/rbi/context_dev/models/web_scrape_params.rbi +2000 -0
  46. data/rbi/context_dev/models/{web_web_scrape_html_response.rbi → web_scrape_response.rbi} +550 -418
  47. data/rbi/context_dev/models/web_screenshot_params.rbi +38 -12
  48. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -4
  49. data/rbi/context_dev/models/web_search_params.rbi +48 -3
  50. data/rbi/context_dev/models.rbi +9 -21
  51. data/rbi/context_dev/resources/brand.rbi +0 -35
  52. data/rbi/context_dev/resources/industry.rbi +14 -0
  53. data/rbi/context_dev/resources/monitors.rbi +24 -0
  54. data/rbi/context_dev/resources/parse.rbi +4 -4
  55. data/rbi/context_dev/resources/people.rbi +7 -0
  56. data/rbi/context_dev/resources/web.rbi +166 -533
  57. data/sig/context_dev/client.rbs +0 -2
  58. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +21 -1
  59. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +21 -1
  60. data/sig/context_dev/models/monitor_retrieve_run_params.rbs +28 -0
  61. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +182 -0
  62. data/sig/context_dev/models/monitor_rotate_webhook_secret_params.rbs +23 -0
  63. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +545 -0
  64. data/sig/context_dev/models/person_enrich_params.rbs +21 -1
  65. data/sig/context_dev/models/web_answers_params.rbs +21 -1
  66. data/sig/context_dev/models/web_extract_competitors_params.rbs +21 -1
  67. data/sig/context_dev/models/web_extract_styleguide_params.rbs +21 -1
  68. data/sig/context_dev/models/{web_web_scrape_sitemap_params.rbs → web_map_urls_params.rbs} +22 -22
  69. data/sig/context_dev/models/web_map_urls_response.rbs +125 -0
  70. data/sig/context_dev/models/web_scrape_params.rbs +834 -0
  71. data/sig/context_dev/models/web_scrape_response.rbs +552 -0
  72. data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
  73. data/sig/context_dev/models/web_search_params.rbs +21 -1
  74. data/sig/context_dev/models.rbs +8 -20
  75. data/sig/context_dev/resources/brand.rbs +0 -9
  76. data/sig/context_dev/resources/industry.rbs +2 -0
  77. data/sig/context_dev/resources/monitors.rbs +11 -0
  78. data/sig/context_dev/resources/people.rbs +1 -0
  79. data/sig/context_dev/resources/web.rbs +34 -108
  80. metadata +26 -65
  81. data/lib/context_dev/models/ai_extract_product_params.rb +0 -98
  82. data/lib/context_dev/models/ai_extract_product_response.rb +0 -352
  83. data/lib/context_dev/models/ai_extract_products_params.rb +0 -233
  84. data/lib/context_dev/models/ai_extract_products_response.rb +0 -320
  85. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +0 -120
  86. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +0 -441
  87. data/lib/context_dev/models/web_extract_fonts_params.rb +0 -114
  88. data/lib/context_dev/models/web_extract_fonts_response.rb +0 -291
  89. data/lib/context_dev/models/web_extract_params.rb +0 -392
  90. data/lib/context_dev/models/web_extract_response.rb +0 -287
  91. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +0 -344
  92. data/lib/context_dev/models/web_web_scrape_bytes_response.rb +0 -135
  93. data/lib/context_dev/models/web_web_scrape_html_params.rb +0 -633
  94. data/lib/context_dev/models/web_web_scrape_html_response.rb +0 -588
  95. data/lib/context_dev/models/web_web_scrape_images_params.rb +0 -346
  96. data/lib/context_dev/models/web_web_scrape_images_response.rb +0 -409
  97. data/lib/context_dev/models/web_web_scrape_md_params.rb +0 -668
  98. data/lib/context_dev/models/web_web_scrape_md_response.rb +0 -567
  99. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +0 -144
  100. data/lib/context_dev/resources/ai.rb +0 -69
  101. data/rbi/context_dev/models/ai_extract_product_params.rbi +0 -199
  102. data/rbi/context_dev/models/ai_extract_product_response.rbi +0 -696
  103. data/rbi/context_dev/models/ai_extract_products_params.rbi +0 -490
  104. data/rbi/context_dev/models/ai_extract_products_response.rbi +0 -623
  105. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +0 -256
  106. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +0 -1040
  107. data/rbi/context_dev/models/web_extract_fonts_params.rbi +0 -223
  108. data/rbi/context_dev/models/web_extract_fonts_response.rbi +0 -563
  109. data/rbi/context_dev/models/web_extract_params.rbi +0 -736
  110. data/rbi/context_dev/models/web_extract_response.rbi +0 -512
  111. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +0 -699
  112. data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +0 -238
  113. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +0 -1217
  114. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +0 -671
  115. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
  116. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1049
  117. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
  118. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
  119. data/rbi/context_dev/resources/ai.rbi +0 -56
  120. data/sig/context_dev/models/ai_extract_product_params.rbs +0 -86
  121. data/sig/context_dev/models/ai_extract_product_response.rbs +0 -273
  122. data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
  123. data/sig/context_dev/models/ai_extract_products_response.rbs +0 -252
  124. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
  125. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
  126. data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
  127. data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
  128. data/sig/context_dev/models/web_extract_params.rbs +0 -304
  129. data/sig/context_dev/models/web_extract_response.rbs +0 -239
  130. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
  131. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
  132. data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -730
  133. data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -495
  134. data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -261
  135. data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
  136. data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
  137. data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
  138. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
  139. data/sig/context_dev/resources/ai.rbs +0 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 18b47383d0fc922af7bc818a48819c4d702950b89c51f28b6e373b3b6468108b
4
- data.tar.gz: e0f57cfa02d05a6b3d6b24956798e52fe21841280ac164b7c53d8980b246ec37
3
+ metadata.gz: 19bc4f2a046f36541d3290c8269b746a16049faa40b7b4d6927b7174abf7e9de
4
+ data.tar.gz: a7c8c5666908f100105f0327009e1e818e8c8dc2df8bc6456d6b68e2ac30316c
5
5
  SHA512:
6
- metadata.gz: 50a79881ad62bece93534a540bd06b18e3618687b81c8f817d95929339769766d7260da3bdb7409be4d42957c5d57818dceafc07fa3495b510d8dfde70af014a
7
- data.tar.gz: 6a22ac07b5bebf800443f990c556f1864a41872f5ca08381716702b1cd61a470d22da90a4350dc745e357a1c21959f13bc156d585984ae0b4d7d98124d34cc06
6
+ metadata.gz: b4276f10c86abd47c7c633387aec7307b5db99f8e4f3a48fea4212aad7065d3e842fd8371bf3915ad899f906348d0959d16de12e092c12763c8fe9d4c6031338
7
+ data.tar.gz: f9223e8de4932b02187fc5df5d2ade222843928c784ac4e7839ed693f0ed8cd7d50f1862f48ae83bc72d8b5486dc126e6e7a03d884f9fb6fe6ef8afbfaf6667b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,38 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.19.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.18.0...v2.19.0) (2026-09-22)
4
+
5
+
6
+ ### Features
7
+
8
+ * **billing:** charge for 404s and skip fraud accounting ([#1152](https://github.com/context-dot-dev/context-ruby-sdk/issues/1152)) ([d1fa73e](https://github.com/context-dot-dev/context-ruby-sdk/commit/d1fa73e0809ce7acb5668f413f40b902e539fe72))
9
+ * **scrape:** add cache age support to byte downloads ([#1171](https://github.com/context-dot-dev/context-ruby-sdk/issues/1171)) ([9b2704f](https://github.com/context-dot-dev/context-ruby-sdk/commit/9b2704f21f51249319a1536a535b881769da0864))
10
+ * **scrape:** add unified scrape API ([#1182](https://github.com/context-dot-dev/context-ruby-sdk/issues/1182)) ([f96de1a](https://github.com/context-dot-dev/context-ruby-sdk/commit/f96de1aceca6305f47851701708cba674ed5c30b))
11
+ * **scrape:** align timeout options and public SDK methods ([#1207](https://github.com/context-dot-dev/context-ruby-sdk/issues/1207)) ([f1f8442](https://github.com/context-dot-dev/context-ruby-sdk/commit/f1f84420192e0b686f973187d2efdadd4a1509cd))
12
+ * **scrape:** support country for image scraping ([#1172](https://github.com/context-dot-dev/context-ruby-sdk/issues/1172)) ([9b2704f](https://github.com/context-dot-dev/context-ruby-sdk/commit/9b2704f21f51249319a1536a535b881769da0864))
13
+ * **scrape:** support custom screenshot headers ([#1169](https://github.com/context-dot-dev/context-ruby-sdk/issues/1169)) ([ea364f2](https://github.com/context-dot-dev/context-ruby-sdk/commit/ea364f242b9120982ee69006305a1929464d4dfe))
14
+ * **scrape:** support waitForMs for byte downloads ([#1170](https://github.com/context-dot-dev/context-ruby-sdk/issues/1170)) ([267301b](https://github.com/context-dot-dev/context-ruby-sdk/commit/267301b3da971db51c63102242ed0dece4ba6630))
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * **scrape:** reuse legacy caches across all output formats ([#1197](https://github.com/context-dot-dev/context-ruby-sdk/issues/1197)) ([007ad3f](https://github.com/context-dot-dev/context-ruby-sdk/commit/007ad3f81ba753e74093d5ee05dfe8df2db06be9))
20
+
21
+ ## [2.18.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.17.1...v2.18.0) (2026-09-18)
22
+
23
+
24
+ ### Features
25
+
26
+ * **api:** enable ZDR on remaining AI endpoints via OpenAI ([#1099](https://github.com/context-dot-dev/context-ruby-sdk/issues/1099)) ([36e5487](https://github.com/context-dot-dev/context-ruby-sdk/commit/36e548724224b3198e49d248735916f3af6d1b61))
27
+ * **products:** extract ProductGroup variants with images ([#1124](https://github.com/context-dot-dev/context-ruby-sdk/issues/1124)) ([dd14116](https://github.com/context-dot-dev/context-ruby-sdk/commit/dd141167200666c0bbb658f9a83ffa8896411aae))
28
+ * **scrape:** add CSS extraction rules to HTML scraping ([#1146](https://github.com/context-dot-dev/context-ruby-sdk/issues/1146)) ([4ed406d](https://github.com/context-dot-dev/context-ruby-sdk/commit/4ed406dfa5bf0dd2ad8e6652fb85ef9ebe37ff07))
29
+ * **web:** add URL-based scrape screenshot endpoint ([#1150](https://github.com/context-dot-dev/context-ruby-sdk/issues/1150)) ([52c8043](https://github.com/context-dot-dev/context-ruby-sdk/commit/52c80435c9c767bdb6ff782c487ada1263d9f767))
30
+
31
+
32
+ ### Bug Fixes
33
+
34
+ * **api:** lower partial scrape timeout minimum to five seconds ([#1118](https://github.com/context-dot-dev/context-ruby-sdk/issues/1118)) ([871982b](https://github.com/context-dot-dev/context-ruby-sdk/commit/871982bff814f9cb698fc59f1e07c2d87c5a6dad))
35
+
3
36
  ## [2.17.1](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.17.0...v2.17.1) (2026-09-15)
4
37
 
5
38
 
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "context.dev", "~> 2.17.1"
20
+ gem "context.dev", "~> 2.19.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -24,9 +24,6 @@ module ContextDev
24
24
  # @return [ContextDev::Resources::Web]
25
25
  attr_reader :web
26
26
 
27
- # @return [ContextDev::Resources::AI]
28
- attr_reader :ai
29
-
30
27
  # @return [ContextDev::Resources::Brand]
31
28
  attr_reader :brand
32
29
 
@@ -125,7 +122,6 @@ module ContextDev
125
122
 
126
123
  @parse = ContextDev::Resources::Parse.new(client: self)
127
124
  @web = ContextDev::Resources::Web.new(client: self)
128
- @ai = ContextDev::Resources::AI.new(client: self)
129
125
  @brand = ContextDev::Resources::Brand.new(client: self)
130
126
  @industry = ContextDev::Resources::Industry.new(client: self)
131
127
  @utility = ContextDev::Resources::Utility.new(client: self)
@@ -43,7 +43,17 @@ module ContextDev
43
43
  # @return [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts, nil]
44
44
  optional :timeout_opts, -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts }
45
45
 
46
- # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
46
+ # @!attribute zdr
47
+ # Set to enabled to bypass shared caches and omit request and response content
48
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
49
+ # omitted. Requires zero data retention to be enabled for your organization
50
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
51
+ # Successful ZDR responses include X-Context-ZDR: true.
52
+ #
53
+ # @return [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr, nil]
54
+ optional :zdr, enum: -> { ContextDev::IndustryRetrieveNaicsParams::Zdr }
55
+
56
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
47
57
  # Some parameter documentations has been truncated, see
48
58
  # {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
49
59
  #
@@ -57,6 +67,8 @@ module ContextDev
57
67
  #
58
68
  # @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
59
69
  #
70
+ # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
71
+ #
60
72
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
61
73
 
62
74
  class TimeoutOpts < ContextDev::Internal::Type::BaseModel
@@ -103,6 +115,21 @@ module ContextDev
103
115
  # @return [Array<Symbol>]
104
116
  end
105
117
  end
118
+
119
+ # Set to enabled to bypass shared caches and omit request and response content
120
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
121
+ # omitted. Requires zero data retention to be enabled for your organization
122
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
123
+ # Successful ZDR responses include X-Context-ZDR: true.
124
+ module Zdr
125
+ extend ContextDev::Internal::Type::Enum
126
+
127
+ ENABLED = :enabled
128
+ DISABLED = :disabled
129
+
130
+ # @!method self.values
131
+ # @return [Array<Symbol>]
132
+ end
106
133
  end
107
134
  end
108
135
  end
@@ -50,7 +50,17 @@ module ContextDev
50
50
  # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
51
51
  optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
52
52
 
53
- # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
53
+ # @!attribute zdr
54
+ # Set to enabled to bypass shared caches and omit request and response content
55
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
56
+ # omitted. Requires zero data retention to be enabled for your organization
57
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
58
+ # Successful ZDR responses include X-Context-ZDR: true.
59
+ #
60
+ # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr, nil]
61
+ optional :zdr, enum: -> { ContextDev::IndustryRetrieveSicParams::Zdr }
62
+
63
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, zdr: nil, request_options: {})
54
64
  # Some parameter documentations has been truncated, see
55
65
  # {ContextDev::Models::IndustryRetrieveSicParams} for more details.
56
66
  #
@@ -66,6 +76,8 @@ module ContextDev
66
76
  #
67
77
  # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
68
78
  #
79
+ # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
80
+ #
69
81
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
70
82
 
71
83
  class TimeoutOpts < ContextDev::Internal::Type::BaseModel
@@ -125,6 +137,21 @@ module ContextDev
125
137
  # @!method self.values
126
138
  # @return [Array<Symbol>]
127
139
  end
140
+
141
+ # Set to enabled to bypass shared caches and omit request and response content
142
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
143
+ # omitted. Requires zero data retention to be enabled for your organization
144
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
145
+ # Successful ZDR responses include X-Context-ZDR: true.
146
+ module Zdr
147
+ extend ContextDev::Internal::Type::Enum
148
+
149
+ ENABLED = :enabled
150
+ DISABLED = :disabled
151
+
152
+ # @!method self.values
153
+ # @return [Array<Symbol>]
154
+ end
128
155
  end
129
156
  end
130
157
  end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#retrieve_run
6
+ class MonitorRetrieveRunParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute monitor_id
11
+ #
12
+ # @return [String]
13
+ required :monitor_id, String
14
+
15
+ # @!attribute run_id
16
+ #
17
+ # @return [String]
18
+ required :run_id, String
19
+
20
+ # @!method initialize(monitor_id:, run_id:, request_options: {})
21
+ # @param monitor_id [String]
22
+ # @param run_id [String]
23
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,232 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#retrieve_run
6
+ class MonitorRetrieveRunResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute baseline_created
13
+ # True when this run established the monitor's initial baseline; baseline runs
14
+ # perform no change detection.
15
+ #
16
+ # @return [Boolean]
17
+ required :baseline_created, ContextDev::Internal::Type::Boolean
18
+
19
+ # @!attribute change_detected
20
+ #
21
+ # @return [Boolean]
22
+ required :change_detected, ContextDev::Internal::Type::Boolean
23
+
24
+ # @!attribute change_detection_type
25
+ #
26
+ # @return [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType]
27
+ required :change_detection_type,
28
+ enum: -> { ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType }
29
+
30
+ # @!attribute credits_charged
31
+ # Credits charged for this run (0 for skipped/failed runs).
32
+ #
33
+ # @return [Integer]
34
+ required :credits_charged, Integer
35
+
36
+ # @!attribute monitor_id
37
+ #
38
+ # @return [String]
39
+ required :monitor_id, String
40
+
41
+ # @!attribute run_type
42
+ # The first run after monitor creation is a baseline run.
43
+ #
44
+ # @return [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::RunType]
45
+ required :run_type, enum: -> { ContextDev::Models::MonitorRetrieveRunResponse::RunType }
46
+
47
+ # @!attribute status
48
+ # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
49
+ # (insufficient credits, monitor paused, or superseded by a concurrent run).
50
+ #
51
+ # @return [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::Status]
52
+ required :status, enum: -> { ContextDev::Models::MonitorRetrieveRunResponse::Status }
53
+
54
+ # @!attribute target_type
55
+ #
56
+ # @return [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::TargetType]
57
+ required :target_type, enum: -> { ContextDev::Models::MonitorRetrieveRunResponse::TargetType }
58
+
59
+ # @!attribute change_id
60
+ #
61
+ # @return [String, nil]
62
+ optional :change_id, String, nil?: true
63
+
64
+ # @!attribute completed_at
65
+ #
66
+ # @return [Time, nil]
67
+ optional :completed_at, Time, nil?: true
68
+
69
+ # @!attribute error
70
+ #
71
+ # @return [ContextDev::Models::MonitorRetrieveRunResponse::Error, nil]
72
+ optional :error, -> { ContextDev::Models::MonitorRetrieveRunResponse::Error }, nil?: true
73
+
74
+ # @!attribute skip_reason
75
+ # Why a skipped run never executed; null unless status is `skipped`.
76
+ #
77
+ # @return [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::SkipReason, nil]
78
+ optional :skip_reason, enum: -> { ContextDev::Models::MonitorRetrieveRunResponse::SkipReason }, nil?: true
79
+
80
+ # @!attribute started_at
81
+ #
82
+ # @return [Time, nil]
83
+ optional :started_at, Time, nil?: true
84
+
85
+ # @!attribute webhook_deliveries
86
+ # All webhook deliveries attempted by this run — one per subscribed event that
87
+ # fired. Omitted when no webhook was attempted, including runs created before
88
+ # event selection was added.
89
+ #
90
+ # @return [Array<ContextDev::Models::WebhookDelivery>, nil]
91
+ optional :webhook_deliveries, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::WebhookDelivery] }
92
+
93
+ # @!attribute webhook_delivery
94
+ # @deprecated
95
+ #
96
+ # Deprecated: use `webhook_deliveries`, which records every attempt now that a run
97
+ # can deliver multiple events. Omitted when no webhook was attempted, including
98
+ # historical runs created before delivery tracking was added.
99
+ #
100
+ # @return [ContextDev::Models::WebhookDelivery, nil]
101
+ optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
102
+
103
+ # @!attribute webhook_delivery_ids
104
+ # Webhook delivery IDs for this run.
105
+ #
106
+ # @return [Array<String>, nil]
107
+ optional :webhook_delivery_ids, ContextDev::Internal::Type::ArrayOf[String]
108
+
109
+ # @!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)
110
+ # Some parameter documentations has been truncated, see
111
+ # {ContextDev::Models::MonitorRetrieveRunResponse} for more details.
112
+ #
113
+ # @param id [String]
114
+ #
115
+ # @param baseline_created [Boolean] True when this run established the monitor's initial baseline; baseline runs per
116
+ #
117
+ # @param change_detected [Boolean]
118
+ #
119
+ # @param change_detection_type [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::ChangeDetectionType]
120
+ #
121
+ # @param credits_charged [Integer] Credits charged for this run (0 for skipped/failed runs).
122
+ #
123
+ # @param monitor_id [String]
124
+ #
125
+ # @param run_type [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::RunType] The first run after monitor creation is a baseline run.
126
+ #
127
+ # @param status [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::Status] Lifecycle status of a run. `skipped` runs never executed — see `skip_reason` (in
128
+ #
129
+ # @param target_type [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::TargetType]
130
+ #
131
+ # @param change_id [String, nil]
132
+ #
133
+ # @param completed_at [Time, nil]
134
+ #
135
+ # @param error [ContextDev::Models::MonitorRetrieveRunResponse::Error, nil]
136
+ #
137
+ # @param skip_reason [Symbol, ContextDev::Models::MonitorRetrieveRunResponse::SkipReason, nil] Why a skipped run never executed; null unless status is `skipped`.
138
+ #
139
+ # @param started_at [Time, nil]
140
+ #
141
+ # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
142
+ #
143
+ # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
144
+ #
145
+ # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
146
+
147
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#change_detection_type
148
+ module ChangeDetectionType
149
+ extend ContextDev::Internal::Type::Enum
150
+
151
+ EXACT = :exact
152
+ SEMANTIC = :semantic
153
+
154
+ # @!method self.values
155
+ # @return [Array<Symbol>]
156
+ end
157
+
158
+ # The first run after monitor creation is a baseline run.
159
+ #
160
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#run_type
161
+ module RunType
162
+ extend ContextDev::Internal::Type::Enum
163
+
164
+ BASELINE = :baseline
165
+ SCHEDULED = :scheduled
166
+
167
+ # @!method self.values
168
+ # @return [Array<Symbol>]
169
+ end
170
+
171
+ # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
172
+ # (insufficient credits, monitor paused, or superseded by a concurrent run).
173
+ #
174
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#status
175
+ module Status
176
+ extend ContextDev::Internal::Type::Enum
177
+
178
+ QUEUED = :queued
179
+ RUNNING = :running
180
+ COMPLETED = :completed
181
+ FAILED = :failed
182
+ SKIPPED = :skipped
183
+
184
+ # @!method self.values
185
+ # @return [Array<Symbol>]
186
+ end
187
+
188
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#target_type
189
+ module TargetType
190
+ extend ContextDev::Internal::Type::Enum
191
+
192
+ PAGE = :page
193
+ SITEMAP = :sitemap
194
+ EXTRACT = :extract
195
+
196
+ # @!method self.values
197
+ # @return [Array<Symbol>]
198
+ end
199
+
200
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#error
201
+ class Error < ContextDev::Internal::Type::BaseModel
202
+ # @!attribute code
203
+ #
204
+ # @return [String]
205
+ required :code, String
206
+
207
+ # @!attribute message
208
+ #
209
+ # @return [String]
210
+ required :message, String
211
+
212
+ # @!method initialize(code:, message:)
213
+ # @param code [String]
214
+ # @param message [String]
215
+ end
216
+
217
+ # Why a skipped run never executed; null unless status is `skipped`.
218
+ #
219
+ # @see ContextDev::Models::MonitorRetrieveRunResponse#skip_reason
220
+ module SkipReason
221
+ extend ContextDev::Internal::Type::Enum
222
+
223
+ INSUFFICIENT_CREDITS = :insufficient_credits
224
+ MONITOR_PAUSED = :monitor_paused
225
+ SUPERSEDED = :superseded
226
+
227
+ # @!method self.values
228
+ # @return [Array<Symbol>]
229
+ end
230
+ end
231
+ end
232
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Monitors#rotate_webhook_secret
6
+ class MonitorRotateWebhookSecretParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute monitor_id
11
+ #
12
+ # @return [String]
13
+ required :monitor_id, String
14
+
15
+ # @!method initialize(monitor_id:, request_options: {})
16
+ # @param monitor_id [String]
17
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end