context.dev 2.14.0 → 2.15.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 (178) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -0
  5. data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
  6. data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
  7. data/lib/context_dev/models/batch_cancel_response.rb +4 -4
  8. data/lib/context_dev/models/batch_delete_response.rb +7 -12
  9. data/lib/context_dev/models/batch_get_results_response.rb +7 -12
  10. data/lib/context_dev/models/batch_list_response.rb +7 -12
  11. data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
  12. data/lib/context_dev/models/batch_submit_params.rb +34 -3
  13. data/lib/context_dev/models/batch_submit_response.rb +4 -4
  14. data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
  15. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
  16. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
  17. data/lib/context_dev/models/brand_search_params.rb +3 -4
  18. data/lib/context_dev/models/brand_search_response.rb +7 -9
  19. data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
  20. data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
  21. data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
  22. data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
  23. data/lib/context_dev/models/monitor_create_params.rb +9 -1
  24. data/lib/context_dev/models/monitor_create_response.rb +9 -1
  25. data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
  26. data/lib/context_dev/models/monitor_list_response.rb +9 -1
  27. data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
  28. data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
  29. data/lib/context_dev/models/monitor_update_params.rb +9 -1
  30. data/lib/context_dev/models/monitor_update_response.rb +9 -1
  31. data/lib/context_dev/models/news_search_response.rb +7 -9
  32. data/lib/context_dev/models/parse_handle_params.rb +3 -4
  33. data/lib/context_dev/models/parse_handle_response.rb +7 -12
  34. data/lib/context_dev/models/person_enrich_response.rb +7 -12
  35. data/lib/context_dev/models/retry_config.rb +22 -0
  36. data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
  37. data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
  38. data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
  39. data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
  40. data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
  41. data/lib/context_dev/models/web_extract_response.rb +7 -9
  42. data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
  43. data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
  44. data/lib/context_dev/models/web_screenshot_params.rb +3 -4
  45. data/lib/context_dev/models/web_screenshot_response.rb +7 -9
  46. data/lib/context_dev/models/web_search_response.rb +7 -9
  47. data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
  48. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
  49. data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
  50. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
  51. data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
  52. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
  53. data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
  54. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +3 -4
  55. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
  56. data/lib/context_dev/models/webhook_delivery.rb +9 -1
  57. data/lib/context_dev/models/webhooks/attempt.rb +102 -0
  58. data/lib/context_dev/models/webhooks/delivery.rb +253 -0
  59. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
  60. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
  61. data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
  62. data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
  63. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
  64. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
  65. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
  66. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
  67. data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
  68. data/lib/context_dev/models.rb +4 -0
  69. data/lib/context_dev/resources/batch.rb +4 -2
  70. data/lib/context_dev/resources/brand.rb +2 -2
  71. data/lib/context_dev/resources/industry.rb +2 -2
  72. data/lib/context_dev/resources/parse.rb +1 -1
  73. data/lib/context_dev/resources/web.rb +8 -8
  74. data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
  75. data/lib/context_dev/resources/webhooks.rb +19 -0
  76. data/lib/context_dev/version.rb +1 -1
  77. data/lib/context_dev.rb +14 -0
  78. data/rbi/context_dev/client.rbi +3 -0
  79. data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
  80. data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
  81. data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
  82. data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
  83. data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
  84. data/rbi/context_dev/models/batch_list_response.rbi +7 -10
  85. data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
  86. data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
  87. data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
  88. data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
  89. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
  90. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
  91. data/rbi/context_dev/models/brand_search_params.rbi +4 -6
  92. data/rbi/context_dev/models/brand_search_response.rbi +7 -10
  93. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
  94. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
  95. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
  96. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
  97. data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
  98. data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
  99. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
  100. data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
  101. data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
  102. data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
  103. data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
  104. data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
  105. data/rbi/context_dev/models/news_search_response.rbi +7 -10
  106. data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
  107. data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
  108. data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
  109. data/rbi/context_dev/models/retry_config.rbi +35 -0
  110. data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
  111. data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
  112. data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
  113. data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
  114. data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
  115. data/rbi/context_dev/models/web_extract_response.rbi +7 -10
  116. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
  117. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
  118. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
  119. data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
  120. data/rbi/context_dev/models/web_search_response.rbi +7 -10
  121. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
  122. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
  123. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
  124. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
  125. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
  126. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
  127. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
  128. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +4 -6
  129. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
  130. data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
  131. data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
  132. data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
  133. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
  134. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
  135. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
  136. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
  137. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
  138. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
  139. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
  140. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
  141. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
  142. data/rbi/context_dev/models.rbi +4 -0
  143. data/rbi/context_dev/resources/batch.rbi +6 -1
  144. data/rbi/context_dev/resources/brand.rbi +4 -6
  145. data/rbi/context_dev/resources/industry.rbi +4 -6
  146. data/rbi/context_dev/resources/parse.rbi +2 -3
  147. data/rbi/context_dev/resources/web.rbi +16 -24
  148. data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
  149. data/rbi/context_dev/resources/webhooks.rbi +16 -0
  150. data/sig/context_dev/client.rbs +2 -0
  151. data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
  152. data/sig/context_dev/models/batch_submit_params.rbs +23 -0
  153. data/sig/context_dev/models/monitor_create_params.rbs +8 -1
  154. data/sig/context_dev/models/monitor_create_response.rbs +7 -0
  155. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
  156. data/sig/context_dev/models/monitor_list_response.rbs +7 -0
  157. data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
  158. data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
  159. data/sig/context_dev/models/monitor_update_params.rbs +8 -1
  160. data/sig/context_dev/models/monitor_update_response.rbs +7 -0
  161. data/sig/context_dev/models/retry_config.rbs +15 -0
  162. data/sig/context_dev/models/webhook_delivery.rbs +10 -3
  163. data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
  164. data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
  165. data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
  166. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
  167. data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
  168. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
  169. data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
  170. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
  171. data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
  172. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
  173. data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
  174. data/sig/context_dev/models.rbs +4 -0
  175. data/sig/context_dev/resources/batch.rbs +1 -0
  176. data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
  177. data/sig/context_dev/resources/webhooks.rbs +9 -0
  178. metadata +44 -2
@@ -13,8 +13,7 @@ module ContextDev
13
13
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandSearchResponse::Result] }
14
14
 
15
15
  # @!attribute key_metadata
16
- # Metadata about the API key used for the request. Included in every response
17
- # whenever a valid API key is provided, even when the response status is not 200.
16
+ # Credit usage, included whenever a valid API key is provided.
18
17
  #
19
18
  # @return [ContextDev::Models::BrandSearchResponse::KeyMetadata, nil]
20
19
  optional :key_metadata, -> { ContextDev::Models::BrandSearchResponse::KeyMetadata }
@@ -25,7 +24,7 @@ module ContextDev
25
24
  #
26
25
  # @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, name matches first, then domain matches, most popular
27
26
  #
28
- # @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
27
+ # @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
29
28
 
30
29
  class Result < ContextDev::Internal::Type::BaseModel
31
30
  # @!attribute domain
@@ -61,24 +60,23 @@ module ContextDev
61
60
  # @see ContextDev::Models::BrandSearchResponse#key_metadata
62
61
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
63
62
  # @!attribute credits_consumed
64
- # The number of credits consumed by this request.
63
+ # Credits used by this request.
65
64
  #
66
65
  # @return [Integer]
67
66
  required :credits_consumed, Integer
68
67
 
69
68
  # @!attribute credits_remaining
70
- # The number of credits remaining for your organization after this request.
69
+ # Credits remaining for your organization.
71
70
  #
72
71
  # @return [Integer]
73
72
  required :credits_remaining, Integer
74
73
 
75
74
  # @!method initialize(credits_consumed:, credits_remaining:)
76
- # Metadata about the API key used for the request. Included in every response
77
- # whenever a valid API key is provided, even when the response status is not 200.
75
+ # Credit usage, included whenever a valid API key is provided.
78
76
  #
79
- # @param credits_consumed [Integer] The number of credits consumed by this request.
77
+ # @param credits_consumed [Integer] Credits used by this request.
80
78
  #
81
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
79
+ # @param credits_remaining [Integer] Credits remaining for your organization.
82
80
  end
83
81
  end
84
82
  end
@@ -29,9 +29,8 @@ module ContextDev
29
29
  optional :min_results, Integer
30
30
 
31
31
  # @!attribute tags
32
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
33
- # recorded on the request's usage log and can be used to filter usage on the
34
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
32
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
33
+ # characters.
35
34
  #
36
35
  # @return [Array<String>, nil]
37
36
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -54,7 +53,7 @@ module ContextDev
54
53
  #
55
54
  # @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
56
55
  #
57
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
56
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
58
57
  #
59
58
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
60
59
  #
@@ -18,8 +18,7 @@ module ContextDev
18
18
  optional :domain, String
19
19
 
20
20
  # @!attribute key_metadata
21
- # Metadata about the API key used for the request. Included in every response
22
- # whenever a valid API key is provided, even when the response status is not 200.
21
+ # Credit usage, included whenever a valid API key is provided.
23
22
  #
24
23
  # @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
25
24
  optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata }
@@ -37,14 +36,11 @@ module ContextDev
37
36
  optional :type, String
38
37
 
39
38
  # @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
40
- # Some parameter documentations has been truncated, see
41
- # {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
42
- #
43
39
  # @param codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
44
40
  #
45
41
  # @param domain [String] Domain found for the brand
46
42
  #
47
- # @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
43
+ # @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
48
44
  #
49
45
  # @param status [String] Status of the response, e.g., 'ok'
50
46
  #
@@ -94,24 +90,23 @@ module ContextDev
94
90
  # @see ContextDev::Models::IndustryRetrieveNaicsResponse#key_metadata
95
91
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
96
92
  # @!attribute credits_consumed
97
- # The number of credits consumed by this request.
93
+ # Credits used by this request.
98
94
  #
99
95
  # @return [Integer]
100
96
  required :credits_consumed, Integer
101
97
 
102
98
  # @!attribute credits_remaining
103
- # The number of credits remaining for your organization after this request.
99
+ # Credits remaining for your organization.
104
100
  #
105
101
  # @return [Integer]
106
102
  required :credits_remaining, Integer
107
103
 
108
104
  # @!method initialize(credits_consumed:, credits_remaining:)
109
- # Metadata about the API key used for the request. Included in every response
110
- # whenever a valid API key is provided, even when the response status is not 200.
105
+ # Credit usage, included whenever a valid API key is provided.
111
106
  #
112
- # @param credits_consumed [Integer] The number of credits consumed by this request.
107
+ # @param credits_consumed [Integer] Credits used by this request.
113
108
  #
114
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
109
+ # @param credits_remaining [Integer] Credits remaining for your organization.
115
110
  end
116
111
  end
117
112
  end
@@ -28,9 +28,8 @@ module ContextDev
28
28
  optional :min_results, Integer
29
29
 
30
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.
31
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
32
+ # characters.
34
33
  #
35
34
  # @return [Array<String>, nil]
36
35
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -61,7 +60,7 @@ module ContextDev
61
60
  #
62
61
  # @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
63
62
  #
64
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
63
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
65
64
  #
66
65
  # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
67
66
  #
@@ -26,8 +26,7 @@ module ContextDev
26
26
  optional :domain, String
27
27
 
28
28
  # @!attribute key_metadata
29
- # Metadata about the API key used for the request. Included in every response
30
- # whenever a valid API key is provided, even when the response status is not 200.
29
+ # Credit usage, included whenever a valid API key is provided.
31
30
  #
32
31
  # @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil]
33
32
  optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
@@ -54,7 +53,7 @@ module ContextDev
54
53
  #
55
54
  # @param domain [String] Domain found for the brand
56
55
  #
57
- # @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
56
+ # @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
58
57
  #
59
58
  # @param status [String] Status of the response, e.g., 'ok'
60
59
  #
@@ -147,24 +146,23 @@ module ContextDev
147
146
  # @see ContextDev::Models::IndustryRetrieveSicResponse#key_metadata
148
147
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
149
148
  # @!attribute credits_consumed
150
- # The number of credits consumed by this request.
149
+ # Credits used by this request.
151
150
  #
152
151
  # @return [Integer]
153
152
  required :credits_consumed, Integer
154
153
 
155
154
  # @!attribute credits_remaining
156
- # The number of credits remaining for your organization after this request.
155
+ # Credits remaining for your organization.
157
156
  #
158
157
  # @return [Integer]
159
158
  required :credits_remaining, Integer
160
159
 
161
160
  # @!method initialize(credits_consumed:, credits_remaining:)
162
- # Metadata about the API key used for the request. Included in every response
163
- # whenever a valid API key is provided, even when the response status is not 200.
161
+ # Credit usage, included whenever a valid API key is provided.
164
162
  #
165
- # @param credits_consumed [Integer] The number of credits consumed by this request.
163
+ # @param credits_consumed [Integer] Credits used by this request.
166
164
  #
167
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
165
+ # @param credits_remaining [Integer] Credits remaining for your organization.
168
166
  end
169
167
  end
170
168
  end
@@ -386,13 +386,21 @@ module ContextDev
386
386
  optional :events,
387
387
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorCreateParams::Webhook::Event] }
388
388
 
389
- # @!method initialize(url:, events: nil)
389
+ # @!attribute retry_
390
+ # Webhook retry settings. Use {} for the default schedule.
391
+ #
392
+ # @return [ContextDev::Models::RetryConfig, nil]
393
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
394
+
395
+ # @!method initialize(url:, events: nil, retry_: nil)
390
396
  # Some parameter documentations has been truncated, see
391
397
  # {ContextDev::Models::MonitorCreateParams::Webhook} for more details.
392
398
  #
393
399
  # @param url [String] Webhook URL events are delivered to.
394
400
  #
395
401
  # @param events [Array<Symbol, ContextDev::Models::MonitorCreateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
402
+ #
403
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
396
404
 
397
405
  module Event
398
406
  extend ContextDev::Internal::Type::Enum
@@ -633,6 +633,12 @@ module ContextDev
633
633
  optional :events,
634
634
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorCreateResponse::Webhook::Event] }
635
635
 
636
+ # @!attribute retry_
637
+ # Webhook retry settings. Use {} for the default schedule.
638
+ #
639
+ # @return [ContextDev::Models::RetryConfig, nil]
640
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
641
+
636
642
  response_only do
637
643
  # @!attribute secret
638
644
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -645,7 +651,7 @@ module ContextDev
645
651
  optional :secret, String
646
652
  end
647
653
 
648
- # @!method initialize(url:, events: nil, secret: nil)
654
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
649
655
  # Some parameter documentations has been truncated, see
650
656
  # {ContextDev::Models::MonitorCreateResponse::Webhook} for more details.
651
657
  #
@@ -653,6 +659,8 @@ module ContextDev
653
659
  #
654
660
  # @param events [Array<Symbol, ContextDev::Models::MonitorCreateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
655
661
  #
662
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
663
+ #
656
664
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
657
665
 
658
666
  module Event
@@ -124,7 +124,13 @@ module ContextDev
124
124
  # @return [ContextDev::Models::WebhookDelivery, nil]
125
125
  optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
126
126
 
127
- # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil)
127
+ # @!attribute webhook_delivery_ids
128
+ # Webhook delivery IDs for this run.
129
+ #
130
+ # @return [Array<String>, nil]
131
+ optional :webhook_delivery_ids, ContextDev::Internal::Type::ArrayOf[String]
132
+
133
+ # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil, webhook_delivery_ids: nil)
128
134
  # Some parameter documentations has been truncated, see
129
135
  # {ContextDev::Models::MonitorListAccountRunsResponse::Data} for more details.
130
136
  #
@@ -159,6 +165,8 @@ module ContextDev
159
165
  # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
160
166
  #
161
167
  # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
168
+ #
169
+ # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
162
170
 
163
171
  # @see ContextDev::Models::MonitorListAccountRunsResponse::Data#change_detection_type
164
172
  module ChangeDetectionType
@@ -647,6 +647,12 @@ module ContextDev
647
647
  optional :events,
648
648
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorListResponse::Data::Webhook::Event] }
649
649
 
650
+ # @!attribute retry_
651
+ # Webhook retry settings. Use {} for the default schedule.
652
+ #
653
+ # @return [ContextDev::Models::RetryConfig, nil]
654
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
655
+
650
656
  response_only do
651
657
  # @!attribute secret
652
658
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -659,7 +665,7 @@ module ContextDev
659
665
  optional :secret, String
660
666
  end
661
667
 
662
- # @!method initialize(url:, events: nil, secret: nil)
668
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
663
669
  # Some parameter documentations has been truncated, see
664
670
  # {ContextDev::Models::MonitorListResponse::Data::Webhook} for more details.
665
671
  #
@@ -667,6 +673,8 @@ module ContextDev
667
673
  #
668
674
  # @param events [Array<Symbol, ContextDev::Models::MonitorListResponse::Data::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
669
675
  #
676
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
677
+ #
670
678
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
671
679
 
672
680
  module Event
@@ -124,7 +124,13 @@ module ContextDev
124
124
  # @return [ContextDev::Models::WebhookDelivery, nil]
125
125
  optional :webhook_delivery, -> { ContextDev::WebhookDelivery }
126
126
 
127
- # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil)
127
+ # @!attribute webhook_delivery_ids
128
+ # Webhook delivery IDs for this run.
129
+ #
130
+ # @return [Array<String>, nil]
131
+ optional :webhook_delivery_ids, ContextDev::Internal::Type::ArrayOf[String]
132
+
133
+ # @!method initialize(id:, baseline_created:, change_detected:, change_detection_type:, credits_charged:, monitor_id:, run_type:, status:, target_type:, change_id: nil, completed_at: nil, error: nil, skip_reason: nil, started_at: nil, webhook_deliveries: nil, webhook_delivery: nil, webhook_delivery_ids: nil)
128
134
  # Some parameter documentations has been truncated, see
129
135
  # {ContextDev::Models::MonitorListRunsResponse::Data} for more details.
130
136
  #
@@ -159,6 +165,8 @@ module ContextDev
159
165
  # @param webhook_deliveries [Array<ContextDev::Models::WebhookDelivery>] All webhook deliveries attempted by this run — one per subscribed event that fir
160
166
  #
161
167
  # @param webhook_delivery [ContextDev::Models::WebhookDelivery] Deprecated: use `webhook_deliveries`, which records every attempt now that a run
168
+ #
169
+ # @param webhook_delivery_ids [Array<String>] Webhook delivery IDs for this run.
162
170
 
163
171
  # @see ContextDev::Models::MonitorListRunsResponse::Data#change_detection_type
164
172
  module ChangeDetectionType
@@ -623,6 +623,12 @@ module ContextDev
623
623
  optional :events,
624
624
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorRetrieveResponse::Webhook::Event] }
625
625
 
626
+ # @!attribute retry_
627
+ # Webhook retry settings. Use {} for the default schedule.
628
+ #
629
+ # @return [ContextDev::Models::RetryConfig, nil]
630
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
631
+
626
632
  response_only do
627
633
  # @!attribute secret
628
634
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -635,7 +641,7 @@ module ContextDev
635
641
  optional :secret, String
636
642
  end
637
643
 
638
- # @!method initialize(url:, events: nil, secret: nil)
644
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
639
645
  # Some parameter documentations has been truncated, see
640
646
  # {ContextDev::Models::MonitorRetrieveResponse::Webhook} for more details.
641
647
  #
@@ -643,6 +649,8 @@ module ContextDev
643
649
  #
644
650
  # @param events [Array<Symbol, ContextDev::Models::MonitorRetrieveResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
645
651
  #
652
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
653
+ #
646
654
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
647
655
 
648
656
  module Event
@@ -391,7 +391,13 @@ module ContextDev
391
391
  optional :events,
392
392
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::MonitorUpdateParams::Webhook::Event] }
393
393
 
394
- # @!method initialize(url:, events: nil)
394
+ # @!attribute retry_
395
+ # Webhook retry settings. Use {} for the default schedule.
396
+ #
397
+ # @return [ContextDev::Models::RetryConfig, nil]
398
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
399
+
400
+ # @!method initialize(url:, events: nil, retry_: nil)
395
401
  # Some parameter documentations has been truncated, see
396
402
  # {ContextDev::Models::MonitorUpdateParams::Webhook} for more details.
397
403
  #
@@ -400,6 +406,8 @@ module ContextDev
400
406
  # @param url [String] Webhook URL events are delivered to.
401
407
  #
402
408
  # @param events [Array<Symbol, ContextDev::Models::MonitorUpdateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
409
+ #
410
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
403
411
 
404
412
  module Event
405
413
  extend ContextDev::Internal::Type::Enum
@@ -623,6 +623,12 @@ module ContextDev
623
623
  optional :events,
624
624
  -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::MonitorUpdateResponse::Webhook::Event] }
625
625
 
626
+ # @!attribute retry_
627
+ # Webhook retry settings. Use {} for the default schedule.
628
+ #
629
+ # @return [ContextDev::Models::RetryConfig, nil]
630
+ optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
631
+
626
632
  response_only do
627
633
  # @!attribute secret
628
634
  # Signing secret used to verify webhook authenticity. Each delivery includes an
@@ -635,7 +641,7 @@ module ContextDev
635
641
  optional :secret, String
636
642
  end
637
643
 
638
- # @!method initialize(url:, events: nil, secret: nil)
644
+ # @!method initialize(url:, events: nil, retry_: nil, secret: nil)
639
645
  # Some parameter documentations has been truncated, see
640
646
  # {ContextDev::Models::MonitorUpdateResponse::Webhook} for more details.
641
647
  #
@@ -643,6 +649,8 @@ module ContextDev
643
649
  #
644
650
  # @param events [Array<Symbol, ContextDev::Models::MonitorUpdateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
645
651
  #
652
+ # @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
653
+ #
646
654
  # @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
647
655
 
648
656
  module Event
@@ -30,8 +30,7 @@ module ContextDev
30
30
  required :next_cursor, String, nil?: true
31
31
 
32
32
  # @!attribute key_metadata
33
- # Metadata about the API key used for the request. Included in every response
34
- # whenever a valid API key is provided, even when the response status is not 200.
33
+ # Credit usage, included whenever a valid API key is provided.
35
34
  #
36
35
  # @return [ContextDev::Models::NewsSearchResponse::KeyMetadata, nil]
37
36
  optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
@@ -48,7 +47,7 @@ module ContextDev
48
47
  #
49
48
  # @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
50
49
  #
51
- # @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
50
+ # @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
52
51
 
53
52
  class Data < ContextDev::Internal::Type::BaseModel
54
53
  # @!attribute id
@@ -260,24 +259,23 @@ module ContextDev
260
259
  # @see ContextDev::Models::NewsSearchResponse#key_metadata
261
260
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
262
261
  # @!attribute credits_consumed
263
- # The number of credits consumed by this request.
262
+ # Credits used by this request.
264
263
  #
265
264
  # @return [Integer]
266
265
  required :credits_consumed, Integer
267
266
 
268
267
  # @!attribute credits_remaining
269
- # The number of credits remaining for your organization after this request.
268
+ # Credits remaining for your organization.
270
269
  #
271
270
  # @return [Integer]
272
271
  required :credits_remaining, Integer
273
272
 
274
273
  # @!method initialize(credits_consumed:, credits_remaining:)
275
- # Metadata about the API key used for the request. Included in every response
276
- # whenever a valid API key is provided, even when the response status is not 200.
274
+ # Credit usage, included whenever a valid API key is provided.
277
275
  #
278
- # @param credits_consumed [Integer] The number of credits consumed by this request.
276
+ # @param credits_consumed [Integer] Credits used by this request.
279
277
  #
280
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
278
+ # @param credits_remaining [Integer] Credits remaining for your organization.
281
279
  end
282
280
  end
283
281
  end
@@ -60,9 +60,8 @@ module ContextDev
60
60
  optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
61
61
 
62
62
  # @!attribute tags
63
- # Optional comma-separated caller-defined tags for tracking this request. Tags are
64
- # recorded on the request's usage log and can be used to filter usage on the
65
- # dashboard usage page. Up to 20 tags, each 1-50 characters.
63
+ # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
64
+ # characters.
66
65
  #
67
66
  # @return [Array<String>, nil]
68
67
  optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -102,7 +101,7 @@ module ContextDev
102
101
  #
103
102
  # @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
104
103
  #
105
- # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
104
+ # @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
106
105
  #
107
106
  # @param use_main_content_only [Boolean] Extract only the main content from HTML-like inputs
108
107
  #
@@ -23,23 +23,19 @@ module ContextDev
23
23
  required :type, enum: -> { ContextDev::Models::ParseHandleResponse::Type }
24
24
 
25
25
  # @!attribute key_metadata
26
- # Metadata about the API key used for the request. Included in every response
27
- # whenever a valid API key is provided, even when the response status is not 200.
26
+ # Credit usage, included whenever a valid API key is provided.
28
27
  #
29
28
  # @return [ContextDev::Models::ParseHandleResponse::KeyMetadata, nil]
30
29
  optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata }
31
30
 
32
31
  # @!method initialize(markdown:, success:, type:, key_metadata: nil)
33
- # Some parameter documentations has been truncated, see
34
- # {ContextDev::Models::ParseHandleResponse} for more details.
35
- #
36
32
  # @param markdown [String] Input bytes converted to GitHub Flavored Markdown
37
33
  #
38
34
  # @param success [Boolean, ContextDev::Models::ParseHandleResponse::Success] Indicates success
39
35
  #
40
36
  # @param type [Symbol, ContextDev::Models::ParseHandleResponse::Type] Detected content type used for parsing
41
37
  #
42
- # @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
38
+ # @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
43
39
 
44
40
  # Indicates success
45
41
  #
@@ -108,24 +104,23 @@ module ContextDev
108
104
  # @see ContextDev::Models::ParseHandleResponse#key_metadata
109
105
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
110
106
  # @!attribute credits_consumed
111
- # The number of credits consumed by this request.
107
+ # Credits used by this request.
112
108
  #
113
109
  # @return [Integer]
114
110
  required :credits_consumed, Integer
115
111
 
116
112
  # @!attribute credits_remaining
117
- # The number of credits remaining for your organization after this request.
113
+ # Credits remaining for your organization.
118
114
  #
119
115
  # @return [Integer]
120
116
  required :credits_remaining, Integer
121
117
 
122
118
  # @!method initialize(credits_consumed:, credits_remaining:)
123
- # Metadata about the API key used for the request. Included in every response
124
- # whenever a valid API key is provided, even when the response status is not 200.
119
+ # Credit usage, included whenever a valid API key is provided.
125
120
  #
126
- # @param credits_consumed [Integer] The number of credits consumed by this request.
121
+ # @param credits_consumed [Integer] Credits used by this request.
127
122
  #
128
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
123
+ # @param credits_remaining [Integer] Credits remaining for your organization.
129
124
  end
130
125
  end
131
126
  end
@@ -11,19 +11,15 @@ module ContextDev
11
11
  required :match, union: -> { ContextDev::Models::PersonEnrichResponse::Match }
12
12
 
13
13
  # @!attribute key_metadata
14
- # Metadata about the API key used for the request. Included in every response
15
- # whenever a valid API key is provided, even when the response status is not 200.
14
+ # Credit usage, included whenever a valid API key is provided.
16
15
  #
17
16
  # @return [ContextDev::Models::PersonEnrichResponse::KeyMetadata, nil]
18
17
  optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }
19
18
 
20
19
  # @!method initialize(match:, key_metadata: nil)
21
- # Some parameter documentations has been truncated, see
22
- # {ContextDev::Models::PersonEnrichResponse} for more details.
23
- #
24
20
  # @param match [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound] The highest-scoring person candidate.
25
21
  #
26
- # @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
22
+ # @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
27
23
 
28
24
  # The highest-scoring person candidate.
29
25
  #
@@ -617,24 +613,23 @@ module ContextDev
617
613
  # @see ContextDev::Models::PersonEnrichResponse#key_metadata
618
614
  class KeyMetadata < ContextDev::Internal::Type::BaseModel
619
615
  # @!attribute credits_consumed
620
- # The number of credits consumed by this request.
616
+ # Credits used by this request.
621
617
  #
622
618
  # @return [Integer]
623
619
  required :credits_consumed, Integer
624
620
 
625
621
  # @!attribute credits_remaining
626
- # The number of credits remaining for your organization after this request.
622
+ # Credits remaining for your organization.
627
623
  #
628
624
  # @return [Integer]
629
625
  required :credits_remaining, Integer
630
626
 
631
627
  # @!method initialize(credits_consumed:, credits_remaining:)
632
- # Metadata about the API key used for the request. Included in every response
633
- # whenever a valid API key is provided, even when the response status is not 200.
628
+ # Credit usage, included whenever a valid API key is provided.
634
629
  #
635
- # @param credits_consumed [Integer] The number of credits consumed by this request.
630
+ # @param credits_consumed [Integer] Credits used by this request.
636
631
  #
637
- # @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
632
+ # @param credits_remaining [Integer] Credits remaining for your organization.
638
633
  end
639
634
  end
640
635
  end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ class RetryConfig < ContextDev::Internal::Type::BaseModel
6
+ # @!attribute delays_seconds
7
+ # Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
8
+ # retries.
9
+ #
10
+ # @return [Array<Integer>, nil]
11
+ optional :delays_seconds, ContextDev::Internal::Type::ArrayOf[Integer]
12
+
13
+ # @!method initialize(delays_seconds: nil)
14
+ # Some parameter documentations has been truncated, see
15
+ # {ContextDev::Models::RetryConfig} for more details.
16
+ #
17
+ # Webhook retry settings. Use {} for the default schedule.
18
+ #
19
+ # @param delays_seconds [Array<Integer>] Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
20
+ end
21
+ end
22
+ end