context.dev 2.15.0 → 2.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +2 -2
  4. data/lib/context_dev/client.rb +6 -0
  5. data/lib/context_dev/internal/type/base_model.rb +2 -2
  6. data/lib/context_dev/models/ai_extract_product_response.rb +10 -1
  7. data/lib/context_dev/models/ai_extract_products_response.rb +10 -1
  8. data/lib/context_dev/models/batch_cancel_response.rb +10 -1
  9. data/lib/context_dev/models/batch_delete_response.rb +13 -1
  10. data/lib/context_dev/models/batch_get_results_response.rb +13 -1
  11. data/lib/context_dev/models/batch_list_response.rb +13 -1
  12. data/lib/context_dev/models/batch_retrieve_response.rb +10 -1
  13. data/lib/context_dev/models/batch_submit_response.rb +10 -1
  14. data/lib/context_dev/models/brand_retrieve_response.rb +10 -1
  15. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +10 -1
  16. data/lib/context_dev/models/brand_search_response.rb +10 -1
  17. data/lib/context_dev/models/industry_retrieve_naics_response.rb +13 -1
  18. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -1
  19. data/lib/context_dev/models/log_list_params.rb +108 -0
  20. data/lib/context_dev/models/log_list_response.rb +174 -0
  21. data/lib/context_dev/models/log_retrieve_params.rb +22 -0
  22. data/lib/context_dev/models/log_retrieve_response.rb +226 -0
  23. data/lib/context_dev/models/news_search_response.rb +10 -1
  24. data/lib/context_dev/models/parse_handle_response.rb +13 -1
  25. data/lib/context_dev/models/person_enrich_response.rb +13 -1
  26. data/lib/context_dev/models/utility_prefetch_response.rb +13 -1
  27. data/lib/context_dev/models/web_extract_competitors_response.rb +13 -1
  28. data/lib/context_dev/models/web_extract_fonts_response.rb +10 -1
  29. data/lib/context_dev/models/web_extract_response.rb +10 -1
  30. data/lib/context_dev/models/web_extract_styleguide_response.rb +10 -1
  31. data/lib/context_dev/models/web_screenshot_params.rb +2 -1
  32. data/lib/context_dev/models/web_screenshot_response.rb +10 -1
  33. data/lib/context_dev/models/web_search_response.rb +10 -1
  34. data/lib/context_dev/models/web_web_crawl_md_response.rb +10 -1
  35. data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -1
  36. data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -1
  37. data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -1
  38. data/lib/context_dev/models/web_web_scrape_images_response.rb +10 -1
  39. data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -1
  40. data/lib/context_dev/models/web_web_scrape_md_response.rb +10 -1
  41. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +10 -1
  42. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +13 -1
  43. data/lib/context_dev/models/webhooks/delivery_list_response.rb +13 -1
  44. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +13 -1
  45. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +13 -1
  46. data/lib/context_dev/models.rb +4 -0
  47. data/lib/context_dev/resources/logs.rb +83 -0
  48. data/lib/context_dev/version.rb +1 -1
  49. data/lib/context_dev.rb +5 -0
  50. data/rbi/context_dev/client.rbi +5 -0
  51. data/rbi/context_dev/models/ai_extract_product_response.rbi +10 -0
  52. data/rbi/context_dev/models/ai_extract_products_response.rbi +10 -0
  53. data/rbi/context_dev/models/batch_cancel_response.rbi +10 -0
  54. data/rbi/context_dev/models/batch_delete_response.rbi +10 -0
  55. data/rbi/context_dev/models/batch_get_results_response.rbi +10 -0
  56. data/rbi/context_dev/models/batch_list_response.rbi +10 -0
  57. data/rbi/context_dev/models/batch_retrieve_response.rbi +10 -0
  58. data/rbi/context_dev/models/batch_submit_response.rbi +10 -0
  59. data/rbi/context_dev/models/brand_retrieve_response.rbi +10 -0
  60. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +10 -0
  61. data/rbi/context_dev/models/brand_search_response.rbi +10 -0
  62. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +10 -0
  63. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +10 -0
  64. data/rbi/context_dev/models/log_list_params.rbi +162 -0
  65. data/rbi/context_dev/models/log_list_response.rbi +246 -0
  66. data/rbi/context_dev/models/log_retrieve_params.rbi +40 -0
  67. data/rbi/context_dev/models/log_retrieve_response.rbi +370 -0
  68. data/rbi/context_dev/models/news_search_response.rbi +10 -0
  69. data/rbi/context_dev/models/parse_handle_response.rbi +10 -0
  70. data/rbi/context_dev/models/person_enrich_response.rbi +10 -0
  71. data/rbi/context_dev/models/utility_prefetch_response.rbi +10 -0
  72. data/rbi/context_dev/models/web_extract_competitors_response.rbi +10 -0
  73. data/rbi/context_dev/models/web_extract_fonts_response.rbi +10 -0
  74. data/rbi/context_dev/models/web_extract_response.rbi +10 -0
  75. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +10 -0
  76. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -2
  77. data/rbi/context_dev/models/web_screenshot_response.rbi +10 -0
  78. data/rbi/context_dev/models/web_search_response.rbi +10 -0
  79. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +10 -0
  80. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +6 -2
  81. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +10 -0
  82. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +6 -2
  83. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +10 -0
  84. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +6 -2
  85. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +10 -0
  86. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +10 -0
  87. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +10 -0
  88. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +10 -0
  89. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +10 -0
  90. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +10 -0
  91. data/rbi/context_dev/models.rbi +4 -0
  92. data/rbi/context_dev/resources/logs.rbi +76 -0
  93. data/rbi/context_dev/resources/web.rbi +11 -4
  94. data/sig/context_dev/client.rbs +2 -0
  95. data/sig/context_dev/models/ai_extract_product_response.rbs +5 -0
  96. data/sig/context_dev/models/ai_extract_products_response.rbs +5 -0
  97. data/sig/context_dev/models/batch_cancel_response.rbs +5 -0
  98. data/sig/context_dev/models/batch_delete_response.rbs +5 -0
  99. data/sig/context_dev/models/batch_get_results_response.rbs +5 -0
  100. data/sig/context_dev/models/batch_list_response.rbs +5 -0
  101. data/sig/context_dev/models/batch_retrieve_response.rbs +5 -0
  102. data/sig/context_dev/models/batch_submit_response.rbs +5 -0
  103. data/sig/context_dev/models/brand_retrieve_response.rbs +5 -0
  104. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +5 -0
  105. data/sig/context_dev/models/brand_search_response.rbs +5 -0
  106. data/sig/context_dev/models/industry_retrieve_naics_response.rbs +5 -0
  107. data/sig/context_dev/models/industry_retrieve_sic_response.rbs +5 -0
  108. data/sig/context_dev/models/log_list_params.rbs +98 -0
  109. data/sig/context_dev/models/log_list_response.rbs +135 -0
  110. data/sig/context_dev/models/log_retrieve_params.rbs +23 -0
  111. data/sig/context_dev/models/log_retrieve_response.rbs +179 -0
  112. data/sig/context_dev/models/news_search_response.rbs +5 -0
  113. data/sig/context_dev/models/parse_handle_response.rbs +5 -0
  114. data/sig/context_dev/models/person_enrich_response.rbs +5 -0
  115. data/sig/context_dev/models/utility_prefetch_response.rbs +5 -0
  116. data/sig/context_dev/models/web_extract_competitors_response.rbs +5 -0
  117. data/sig/context_dev/models/web_extract_fonts_response.rbs +5 -0
  118. data/sig/context_dev/models/web_extract_response.rbs +5 -0
  119. data/sig/context_dev/models/web_extract_styleguide_response.rbs +5 -0
  120. data/sig/context_dev/models/web_screenshot_response.rbs +5 -0
  121. data/sig/context_dev/models/web_search_response.rbs +5 -0
  122. data/sig/context_dev/models/web_web_crawl_md_response.rbs +5 -0
  123. data/sig/context_dev/models/web_web_scrape_html_response.rbs +5 -0
  124. data/sig/context_dev/models/web_web_scrape_images_response.rbs +5 -0
  125. data/sig/context_dev/models/web_web_scrape_md_response.rbs +5 -0
  126. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +5 -0
  127. data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +5 -0
  128. data/sig/context_dev/models/webhooks/delivery_list_response.rbs +5 -0
  129. data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +7 -0
  130. data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +5 -0
  131. data/sig/context_dev/models.rbs +4 -0
  132. data/sig/context_dev/resources/logs.rbs +27 -0
  133. metadata +17 -2
@@ -0,0 +1,174 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#list
6
+ class LogListResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ # Log entries, newest first.
9
+ #
10
+ # @return [Array<ContextDev::Models::LogListResponse::Data>]
11
+ required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::LogListResponse::Data] }
12
+
13
+ # @!attribute has_more
14
+ # Whether a next page exists.
15
+ #
16
+ # @return [Boolean]
17
+ required :has_more, ContextDev::Internal::Type::Boolean
18
+
19
+ # @!attribute limit
20
+ # Entries per page.
21
+ #
22
+ # @return [Integer]
23
+ required :limit, Integer
24
+
25
+ # @!attribute page
26
+ # Current page number.
27
+ #
28
+ # @return [Integer]
29
+ required :page, Integer
30
+
31
+ # @!attribute request_id
32
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ # it when contacting support about a failed request.
34
+ #
35
+ # @return [String]
36
+ required :request_id, String
37
+
38
+ # @!attribute key_metadata
39
+ # Credit usage, included whenever a valid API key is provided.
40
+ #
41
+ # @return [ContextDev::Models::LogListResponse::KeyMetadata, nil]
42
+ optional :key_metadata, -> { ContextDev::Models::LogListResponse::KeyMetadata }
43
+
44
+ # @!method initialize(data:, has_more:, limit:, page:, request_id:, key_metadata: nil)
45
+ # Some parameter documentations has been truncated, see
46
+ # {ContextDev::Models::LogListResponse} for more details.
47
+ #
48
+ # @param data [Array<ContextDev::Models::LogListResponse::Data>] Log entries, newest first.
49
+ #
50
+ # @param has_more [Boolean] Whether a next page exists.
51
+ #
52
+ # @param limit [Integer] Entries per page.
53
+ #
54
+ # @param page [Integer] Current page number.
55
+ #
56
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
57
+ #
58
+ # @param key_metadata [ContextDev::Models::LogListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
59
+
60
+ class Data < ContextDev::Internal::Type::BaseModel
61
+ # @!attribute credits_used
62
+ # Credits charged for this request.
63
+ #
64
+ # @return [Integer]
65
+ required :credits_used, Integer
66
+
67
+ # @!attribute error_code
68
+ # The `error_code` from the response, or null on success.
69
+ #
70
+ # @return [String, nil]
71
+ required :error_code, String, nil?: true
72
+
73
+ # @!attribute key_id
74
+ # ID of the API key that made the request.
75
+ #
76
+ # @return [String, nil]
77
+ required :key_id, String, nil?: true
78
+
79
+ # @!attribute latency_ms
80
+ # Server-side processing time in milliseconds.
81
+ #
82
+ # @return [Float]
83
+ required :latency_ms, Float
84
+
85
+ # @!attribute method_
86
+ # HTTP method.
87
+ #
88
+ # @return [String]
89
+ required :method_, String, api_name: :method
90
+
91
+ # @!attribute path
92
+ # Endpoint path as called.
93
+ #
94
+ # @return [String]
95
+ required :path, String
96
+
97
+ # @!attribute request_id
98
+ # Request ID of the logged API call.
99
+ #
100
+ # @return [String]
101
+ required :request_id, String
102
+
103
+ # @!attribute status_code
104
+ # HTTP status code returned.
105
+ #
106
+ # @return [Integer]
107
+ required :status_code, Integer
108
+
109
+ # @!attribute tags
110
+ # Request tags supplied by the caller.
111
+ #
112
+ # @return [Array<String>]
113
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
114
+
115
+ # @!attribute timestamp
116
+ # When the request completed.
117
+ #
118
+ # @return [Time]
119
+ required :timestamp, Time
120
+
121
+ # @!attribute zdr
122
+ # Whether the request was made under zero data retention.
123
+ #
124
+ # @return [Boolean]
125
+ required :zdr, ContextDev::Internal::Type::Boolean
126
+
127
+ # @!method initialize(credits_used:, error_code:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, zdr:)
128
+ # @param credits_used [Integer] Credits charged for this request.
129
+ #
130
+ # @param error_code [String, nil] The `error_code` from the response, or null on success.
131
+ #
132
+ # @param key_id [String, nil] ID of the API key that made the request.
133
+ #
134
+ # @param latency_ms [Float] Server-side processing time in milliseconds.
135
+ #
136
+ # @param method_ [String] HTTP method.
137
+ #
138
+ # @param path [String] Endpoint path as called.
139
+ #
140
+ # @param request_id [String] Request ID of the logged API call.
141
+ #
142
+ # @param status_code [Integer] HTTP status code returned.
143
+ #
144
+ # @param tags [Array<String>] Request tags supplied by the caller.
145
+ #
146
+ # @param timestamp [Time] When the request completed.
147
+ #
148
+ # @param zdr [Boolean] Whether the request was made under zero data retention.
149
+ end
150
+
151
+ # @see ContextDev::Models::LogListResponse#key_metadata
152
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
153
+ # @!attribute credits_consumed
154
+ # Credits used by this request.
155
+ #
156
+ # @return [Integer]
157
+ required :credits_consumed, Integer
158
+
159
+ # @!attribute credits_remaining
160
+ # Credits remaining for your organization.
161
+ #
162
+ # @return [Integer]
163
+ required :credits_remaining, Integer
164
+
165
+ # @!method initialize(credits_consumed:, credits_remaining:)
166
+ # Credit usage, included whenever a valid API key is provided.
167
+ #
168
+ # @param credits_consumed [Integer] Credits used by this request.
169
+ #
170
+ # @param credits_remaining [Integer] Credits remaining for your organization.
171
+ end
172
+ end
173
+ end
174
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#retrieve
6
+ class LogRetrieveParams < ContextDev::Internal::Type::BaseModel
7
+ extend ContextDev::Internal::Type::RequestParameters::Converter
8
+ include ContextDev::Internal::Type::RequestParameters
9
+
10
+ # @!attribute request_id
11
+ # The request ID of the logged API call.
12
+ #
13
+ # @return [String]
14
+ required :request_id, String
15
+
16
+ # @!method initialize(request_id:, request_options: {})
17
+ # @param request_id [String] The request ID of the logged API call.
18
+ #
19
+ # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,226 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ContextDev
4
+ module Models
5
+ # @see ContextDev::Resources::Logs#retrieve
6
+ class LogRetrieveResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [ContextDev::Models::LogRetrieveResponse::Data]
10
+ required :data, -> { ContextDev::Models::LogRetrieveResponse::Data }
11
+
12
+ # @!attribute request_id
13
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
14
+ # it when contacting support about a failed request.
15
+ #
16
+ # @return [String]
17
+ required :request_id, String
18
+
19
+ # @!attribute key_metadata
20
+ # Credit usage, included whenever a valid API key is provided.
21
+ #
22
+ # @return [ContextDev::Models::LogRetrieveResponse::KeyMetadata, nil]
23
+ optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::KeyMetadata }
24
+
25
+ # @!method initialize(data:, request_id:, key_metadata: nil)
26
+ # Some parameter documentations has been truncated, see
27
+ # {ContextDev::Models::LogRetrieveResponse} for more details.
28
+ #
29
+ # @param data [ContextDev::Models::LogRetrieveResponse::Data]
30
+ #
31
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
32
+ #
33
+ # @param key_metadata [ContextDev::Models::LogRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
34
+
35
+ # @see ContextDev::Models::LogRetrieveResponse#data
36
+ class Data < ContextDev::Internal::Type::BaseModel
37
+ # @!attribute credits_used
38
+ # Credits charged for this request.
39
+ #
40
+ # @return [Integer]
41
+ required :credits_used, Integer
42
+
43
+ # @!attribute error_code
44
+ # The `error_code` from the response, or null on success.
45
+ #
46
+ # @return [String, nil]
47
+ required :error_code, String, nil?: true
48
+
49
+ # @!attribute input
50
+ # What was sent with the request.
51
+ #
52
+ # @return [ContextDev::Models::LogRetrieveResponse::Data::Input]
53
+ required :input, -> { ContextDev::Models::LogRetrieveResponse::Data::Input }
54
+
55
+ # @!attribute key_id
56
+ # ID of the API key that made the request.
57
+ #
58
+ # @return [String, nil]
59
+ required :key_id, String, nil?: true
60
+
61
+ # @!attribute latency_ms
62
+ # Server-side processing time in milliseconds.
63
+ #
64
+ # @return [Float]
65
+ required :latency_ms, Float
66
+
67
+ # @!attribute method_
68
+ # HTTP method.
69
+ #
70
+ # @return [String]
71
+ required :method_, String, api_name: :method
72
+
73
+ # @!attribute path
74
+ # Endpoint path as called.
75
+ #
76
+ # @return [String]
77
+ required :path, String
78
+
79
+ # @!attribute request_id
80
+ # Request ID of the logged API call.
81
+ #
82
+ # @return [String]
83
+ required :request_id, String
84
+
85
+ # @!attribute status_code
86
+ # HTTP status code returned.
87
+ #
88
+ # @return [Integer]
89
+ required :status_code, Integer
90
+
91
+ # @!attribute tags
92
+ # Request tags supplied by the caller.
93
+ #
94
+ # @return [Array<String>]
95
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
96
+
97
+ # @!attribute timestamp
98
+ # When the request completed.
99
+ #
100
+ # @return [Time]
101
+ required :timestamp, Time
102
+
103
+ # @!attribute user_agent
104
+ # User-Agent header of the request.
105
+ #
106
+ # @return [String, nil]
107
+ required :user_agent, String, nil?: true
108
+
109
+ # @!attribute zdr
110
+ # Whether the request was made under zero data retention.
111
+ #
112
+ # @return [Boolean]
113
+ required :zdr, ContextDev::Internal::Type::Boolean
114
+
115
+ # @!attribute key_metadata
116
+ # Credit usage, included whenever a valid API key is provided.
117
+ #
118
+ # @return [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata, nil]
119
+ optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata }
120
+
121
+ # @!attribute response
122
+ # The retained JSON response with credentials redacted, or null when unavailable.
123
+ #
124
+ # @return [Object, nil]
125
+ optional :response, ContextDev::Internal::Type::Unknown
126
+
127
+ # @!method initialize(credits_used:, error_code:, input:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, user_agent:, zdr:, key_metadata: nil, response: nil)
128
+ # @param credits_used [Integer] Credits charged for this request.
129
+ #
130
+ # @param error_code [String, nil] The `error_code` from the response, or null on success.
131
+ #
132
+ # @param input [ContextDev::Models::LogRetrieveResponse::Data::Input] What was sent with the request.
133
+ #
134
+ # @param key_id [String, nil] ID of the API key that made the request.
135
+ #
136
+ # @param latency_ms [Float] Server-side processing time in milliseconds.
137
+ #
138
+ # @param method_ [String] HTTP method.
139
+ #
140
+ # @param path [String] Endpoint path as called.
141
+ #
142
+ # @param request_id [String] Request ID of the logged API call.
143
+ #
144
+ # @param status_code [Integer] HTTP status code returned.
145
+ #
146
+ # @param tags [Array<String>] Request tags supplied by the caller.
147
+ #
148
+ # @param timestamp [Time] When the request completed.
149
+ #
150
+ # @param user_agent [String, nil] User-Agent header of the request.
151
+ #
152
+ # @param zdr [Boolean] Whether the request was made under zero data retention.
153
+ #
154
+ # @param key_metadata [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata] Credit usage, included whenever a valid API key is provided.
155
+ #
156
+ # @param response [Object] The retained JSON response with credentials redacted, or null when unavailable.
157
+
158
+ # @see ContextDev::Models::LogRetrieveResponse::Data#input
159
+ class Input < ContextDev::Internal::Type::BaseModel
160
+ # @!attribute query
161
+ # Query parameters as sent.
162
+ #
163
+ # @return [Hash{Symbol=>Object}]
164
+ required :query, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
165
+
166
+ # @!attribute body
167
+ # Request body with credentials and uploaded content redacted.
168
+ #
169
+ # @return [Object, nil]
170
+ optional :body, ContextDev::Internal::Type::Unknown
171
+
172
+ # @!method initialize(query:, body: nil)
173
+ # What was sent with the request.
174
+ #
175
+ # @param query [Hash{Symbol=>Object}] Query parameters as sent.
176
+ #
177
+ # @param body [Object] Request body with credentials and uploaded content redacted.
178
+ end
179
+
180
+ # @see ContextDev::Models::LogRetrieveResponse::Data#key_metadata
181
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
182
+ # @!attribute credits_consumed
183
+ # Credits used by this request.
184
+ #
185
+ # @return [Integer]
186
+ required :credits_consumed, Integer
187
+
188
+ # @!attribute credits_remaining
189
+ # Credits remaining for your organization.
190
+ #
191
+ # @return [Integer]
192
+ required :credits_remaining, Integer
193
+
194
+ # @!method initialize(credits_consumed:, credits_remaining:)
195
+ # Credit usage, included whenever a valid API key is provided.
196
+ #
197
+ # @param credits_consumed [Integer] Credits used by this request.
198
+ #
199
+ # @param credits_remaining [Integer] Credits remaining for your organization.
200
+ end
201
+ end
202
+
203
+ # @see ContextDev::Models::LogRetrieveResponse#key_metadata
204
+ class KeyMetadata < ContextDev::Internal::Type::BaseModel
205
+ # @!attribute credits_consumed
206
+ # Credits used by this request.
207
+ #
208
+ # @return [Integer]
209
+ required :credits_consumed, Integer
210
+
211
+ # @!attribute credits_remaining
212
+ # Credits remaining for your organization.
213
+ #
214
+ # @return [Integer]
215
+ required :credits_remaining, Integer
216
+
217
+ # @!method initialize(credits_consumed:, credits_remaining:)
218
+ # Credit usage, included whenever a valid API key is provided.
219
+ #
220
+ # @param credits_consumed [Integer] Credits used by this request.
221
+ #
222
+ # @param credits_remaining [Integer] Credits remaining for your organization.
223
+ end
224
+ end
225
+ end
226
+ end
@@ -29,13 +29,20 @@ module ContextDev
29
29
  # @return [String, nil]
30
30
  required :next_cursor, String, nil?: true
31
31
 
32
+ # @!attribute request_id
33
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
34
+ # it when contacting support about a failed request.
35
+ #
36
+ # @return [String]
37
+ required :request_id, String
38
+
32
39
  # @!attribute key_metadata
33
40
  # Credit usage, included whenever a valid API key is provided.
34
41
  #
35
42
  # @return [ContextDev::Models::NewsSearchResponse::KeyMetadata, nil]
36
43
  optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
37
44
 
38
- # @!method initialize(data:, has_more:, meta:, next_cursor:, key_metadata: nil)
45
+ # @!method initialize(data:, has_more:, meta:, next_cursor:, request_id:, key_metadata: nil)
39
46
  # Some parameter documentations has been truncated, see
40
47
  # {ContextDev::Models::NewsSearchResponse} for more details.
41
48
  #
@@ -47,6 +54,8 @@ module ContextDev
47
54
  #
48
55
  # @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
49
56
  #
57
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
58
+ #
50
59
  # @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
51
60
 
52
61
  class Data < ContextDev::Internal::Type::BaseModel
@@ -10,6 +10,13 @@ module ContextDev
10
10
  # @return [String]
11
11
  required :markdown, String
12
12
 
13
+ # @!attribute request_id
14
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
+ # it when contacting support about a failed request.
16
+ #
17
+ # @return [String]
18
+ required :request_id, String
19
+
13
20
  # @!attribute success
14
21
  # Indicates success
15
22
  #
@@ -28,9 +35,14 @@ module ContextDev
28
35
  # @return [ContextDev::Models::ParseHandleResponse::KeyMetadata, nil]
29
36
  optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata }
30
37
 
31
- # @!method initialize(markdown:, success:, type:, key_metadata: nil)
38
+ # @!method initialize(markdown:, request_id:, success:, type:, key_metadata: nil)
39
+ # Some parameter documentations has been truncated, see
40
+ # {ContextDev::Models::ParseHandleResponse} for more details.
41
+ #
32
42
  # @param markdown [String] Input bytes converted to GitHub Flavored Markdown
33
43
  #
44
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
45
+ #
34
46
  # @param success [Boolean, ContextDev::Models::ParseHandleResponse::Success] Indicates success
35
47
  #
36
48
  # @param type [Symbol, ContextDev::Models::ParseHandleResponse::Type] Detected content type used for parsing
@@ -10,15 +10,27 @@ module ContextDev
10
10
  # @return [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound]
11
11
  required :match, union: -> { ContextDev::Models::PersonEnrichResponse::Match }
12
12
 
13
+ # @!attribute request_id
14
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
15
+ # it when contacting support about a failed request.
16
+ #
17
+ # @return [String]
18
+ required :request_id, String
19
+
13
20
  # @!attribute key_metadata
14
21
  # Credit usage, included whenever a valid API key is provided.
15
22
  #
16
23
  # @return [ContextDev::Models::PersonEnrichResponse::KeyMetadata, nil]
17
24
  optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }
18
25
 
19
- # @!method initialize(match:, key_metadata: nil)
26
+ # @!method initialize(match:, request_id:, key_metadata: nil)
27
+ # Some parameter documentations has been truncated, see
28
+ # {ContextDev::Models::PersonEnrichResponse} for more details.
29
+ #
20
30
  # @param match [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound] The highest-scoring person candidate.
21
31
  #
32
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
33
+ #
22
34
  # @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
23
35
 
24
36
  # The highest-scoring person candidate.
@@ -4,6 +4,13 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Utility#prefetch
6
6
  class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel
7
+ # @!attribute request_id
8
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
9
+ # it when contacting support about a failed request.
10
+ #
11
+ # @return [String]
12
+ required :request_id, String
13
+
7
14
  # @!attribute domain
8
15
  # The domain that was queued for prefetching
9
16
  #
@@ -34,7 +41,12 @@ module ContextDev
34
41
  # @return [Symbol, ContextDev::Models::UtilityPrefetchResponse::Type, nil]
35
42
  optional :type, enum: -> { ContextDev::Models::UtilityPrefetchResponse::Type }
36
43
 
37
- # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
44
+ # @!method initialize(request_id:, domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
45
+ # Some parameter documentations has been truncated, see
46
+ # {ContextDev::Models::UtilityPrefetchResponse} for more details.
47
+ #
48
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
49
+ #
38
50
  # @param domain [String] The domain that was queued for prefetching
39
51
  #
40
52
  # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
@@ -17,6 +17,13 @@ module ContextDev
17
17
  # @return [String]
18
18
  required :domain, String
19
19
 
20
+ # @!attribute request_id
21
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
22
+ # it when contacting support about a failed request.
23
+ #
24
+ # @return [String]
25
+ required :request_id, String
26
+
20
27
  # @!attribute status
21
28
  # Status of the response.
22
29
  #
@@ -35,11 +42,16 @@ module ContextDev
35
42
  # @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil]
36
43
  optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
37
44
 
38
- # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil)
45
+ # @!method initialize(competitors:, domain:, request_id:, status:, target:, key_metadata: nil)
46
+ # Some parameter documentations has been truncated, see
47
+ # {ContextDev::Models::WebExtractCompetitorsResponse} for more details.
48
+ #
39
49
  # @param competitors [Array<ContextDev::Models::WebExtractCompetitorsResponse::Competitor>] Direct competitors ordered by relevance and confidence.
40
50
  #
41
51
  # @param domain [String] Normalized input domain.
42
52
  #
53
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
54
+ #
43
55
  # @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response.
44
56
  #
45
57
  # @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
@@ -31,6 +31,13 @@ module ContextDev
31
31
  required :fonts,
32
32
  -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractFontsResponse::Font] }
33
33
 
34
+ # @!attribute request_id
35
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
36
+ # it when contacting support about a failed request.
37
+ #
38
+ # @return [String]
39
+ required :request_id, String
40
+
34
41
  # @!attribute status
35
42
  # Status of the response, e.g., 'ok'
36
43
  #
@@ -53,7 +60,7 @@ module ContextDev
53
60
  # @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil]
54
61
  optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata }
55
62
 
56
- # @!method initialize(cache_metadata:, code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil)
63
+ # @!method initialize(cache_metadata:, code:, domain:, fonts:, request_id:, status:, font_links: nil, key_metadata: nil)
57
64
  # Some parameter documentations has been truncated, see
58
65
  # {ContextDev::Models::WebExtractFontsResponse} for more details.
59
66
  #
@@ -65,6 +72,8 @@ module ContextDev
65
72
  #
66
73
  # @param fonts [Array<ContextDev::Models::WebExtractFontsResponse::Font>] Array of font usage information
67
74
  #
75
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
76
+ #
68
77
  # @param status [String] Status of the response, e.g., 'ok'
69
78
  #
70
79
  # @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n
@@ -23,6 +23,13 @@ module ContextDev
23
23
  # @return [ContextDev::Models::WebExtractResponse::Metadata]
24
24
  required :metadata, -> { ContextDev::Models::WebExtractResponse::Metadata }
25
25
 
26
+ # @!attribute request_id
27
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
28
+ # it when contacting support about a failed request.
29
+ #
30
+ # @return [String]
31
+ required :request_id, String
32
+
26
33
  # @!attribute status
27
34
  # Status of the response, e.g., 'ok'
28
35
  #
@@ -47,7 +54,7 @@ module ContextDev
47
54
  # @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil]
48
55
  optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }
49
56
 
50
- # @!method initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil)
57
+ # @!method initialize(cache_metadata:, data:, metadata:, request_id:, status:, url:, urls_analyzed:, key_metadata: nil)
51
58
  # Some parameter documentations has been truncated, see
52
59
  # {ContextDev::Models::WebExtractResponse} for more details.
53
60
  #
@@ -57,6 +64,8 @@ module ContextDev
57
64
  #
58
65
  # @param metadata [ContextDev::Models::WebExtractResponse::Metadata]
59
66
  #
67
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
68
+ #
60
69
  # @param status [String] Status of the response, e.g., 'ok'
61
70
  #
62
71
  # @param url [String] The starting URL that was analyzed
@@ -12,6 +12,13 @@ module ContextDev
12
12
  # @return [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata]
13
13
  required :cache_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata }
14
14
 
15
+ # @!attribute request_id
16
+ # Unique id of this API call, also sent in the X-Request-Id response header. Quote
17
+ # it when contacting support about a failed request.
18
+ #
19
+ # @return [String]
20
+ required :request_id, String
21
+
15
22
  # @!attribute code
16
23
  # HTTP status code
17
24
  #
@@ -42,12 +49,14 @@ module ContextDev
42
49
  # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil]
43
50
  optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide }
44
51
 
45
- # @!method initialize(cache_metadata:, code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
52
+ # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil)
46
53
  # Some parameter documentations has been truncated, see
47
54
  # {ContextDev::Models::WebExtractStyleguideResponse} for more details.
48
55
  #
49
56
  # @param cache_metadata [ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
50
57
  #
58
+ # @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
59
+ #
51
60
  # @param code [Integer] HTTP status code
52
61
  #
53
62
  # @param domain [String] The normalized domain that was processed
@@ -116,7 +116,8 @@ module ContextDev
116
116
  # @!attribute wait_for_ms
117
117
  # Optional browser wait time in milliseconds after initial page load before taking
118
118
  # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
119
- # omitted.
119
+ # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
120
+ # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
120
121
  #
121
122
  # @return [Integer, nil]
122
123
  optional :wait_for_ms, Integer, nil?: true