context.dev 2.8.0 → 2.10.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 (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +10 -0
  5. data/lib/context_dev/models/batch_delete_params.rb +22 -0
  6. data/lib/context_dev/models/batch_delete_response.rb +60 -0
  7. data/lib/context_dev/models/batch_get_results_response.rb +46 -4
  8. data/lib/context_dev/models/batch_list_response.rb +13 -4
  9. data/lib/context_dev/models/batch_retrieve_response.rb +13 -4
  10. data/lib/context_dev/models/batch_submit_params.rb +2080 -26
  11. data/lib/context_dev/models/batch_submit_response.rb +125 -531
  12. data/lib/context_dev/models/brand_retrieve_response.rb +50 -1
  13. data/lib/context_dev/models/brand_search_params.rb +41 -3
  14. data/lib/context_dev/models/brand_search_response.rb +3 -2
  15. data/lib/context_dev/models/crawl_controls.rb +21 -15
  16. data/lib/context_dev/models/news_search_params.rb +467 -0
  17. data/lib/context_dev/models/news_search_response.rb +238 -0
  18. data/lib/context_dev/models/parse_handle_params.rb +20 -147
  19. data/lib/context_dev/models/person_enrich_params.rb +176 -0
  20. data/lib/context_dev/models/person_enrich_response.rb +641 -0
  21. data/lib/context_dev/models/utility_prefetch_params.rb +19 -16
  22. data/lib/context_dev/models/utility_prefetch_response.rb +4 -5
  23. data/lib/context_dev/models/web_screenshot_params.rb +3 -30
  24. data/lib/context_dev/models/web_search_response.rb +1 -0
  25. data/lib/context_dev/models/web_web_crawl_md_params.rb +5 -4
  26. data/lib/context_dev/models/web_web_crawl_md_response.rb +30 -1
  27. data/lib/context_dev/models/web_web_scrape_html_params.rb +20 -156
  28. data/lib/context_dev/models/web_web_scrape_html_response.rb +30 -1
  29. data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -124
  30. data/lib/context_dev/models/web_web_scrape_md_params.rb +40 -241
  31. data/lib/context_dev/models/web_web_scrape_md_response.rb +41 -2
  32. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +11 -1
  33. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +3 -2
  34. data/lib/context_dev/models.rb +6 -0
  35. data/lib/context_dev/resources/batch.rb +33 -7
  36. data/lib/context_dev/resources/brand.rb +10 -10
  37. data/lib/context_dev/resources/news.rb +51 -0
  38. data/lib/context_dev/resources/parse.rb +5 -5
  39. data/lib/context_dev/resources/people.rb +56 -0
  40. data/lib/context_dev/resources/utility.rb +7 -6
  41. data/lib/context_dev/resources/web.rb +46 -24
  42. data/lib/context_dev/version.rb +1 -1
  43. data/lib/context_dev.rb +8 -0
  44. data/rbi/context_dev/client.rbi +8 -0
  45. data/rbi/context_dev/models/batch_delete_params.rbi +40 -0
  46. data/rbi/context_dev/models/batch_delete_response.rbi +116 -0
  47. data/rbi/context_dev/models/batch_get_results_response.rbi +85 -3
  48. data/rbi/context_dev/models/batch_list_response.rbi +24 -8
  49. data/rbi/context_dev/models/batch_retrieve_response.rbi +24 -8
  50. data/rbi/context_dev/models/batch_submit_params.rbi +6421 -44
  51. data/rbi/context_dev/models/batch_submit_response.rbi +184 -1151
  52. data/rbi/context_dev/models/brand_retrieve_response.rbi +152 -0
  53. data/rbi/context_dev/models/brand_search_params.rbi +71 -2
  54. data/rbi/context_dev/models/brand_search_response.rbi +4 -2
  55. data/rbi/context_dev/models/crawl_controls.rbi +22 -28
  56. data/rbi/context_dev/models/news_search_params.rbi +1294 -0
  57. data/rbi/context_dev/models/news_search_response.rbi +423 -0
  58. data/rbi/context_dev/models/parse_handle_params.rbi +30 -323
  59. data/rbi/context_dev/models/person_enrich_params.rbi +332 -0
  60. data/rbi/context_dev/models/person_enrich_response.rbi +1295 -0
  61. data/rbi/context_dev/models/utility_prefetch_params.rbi +24 -16
  62. data/rbi/context_dev/models/utility_prefetch_response.rbi +8 -6
  63. data/rbi/context_dev/models/web_screenshot_params.rbi +4 -71
  64. data/rbi/context_dev/models/web_search_response.rbi +5 -0
  65. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +8 -6
  66. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +67 -0
  67. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +30 -363
  68. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +65 -0
  69. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +16 -287
  70. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +57 -558
  71. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +80 -0
  72. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +15 -0
  73. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +4 -2
  74. data/rbi/context_dev/models.rbi +6 -0
  75. data/rbi/context_dev/resources/batch.rbi +32 -10
  76. data/rbi/context_dev/resources/brand.rbi +14 -8
  77. data/rbi/context_dev/resources/news.rbi +46 -0
  78. data/rbi/context_dev/resources/parse.rbi +10 -26
  79. data/rbi/context_dev/resources/people.rbi +47 -0
  80. data/rbi/context_dev/resources/utility.rbi +8 -6
  81. data/rbi/context_dev/resources/web.rbi +49 -66
  82. data/sig/context_dev/client.rbs +4 -0
  83. data/sig/context_dev/models/batch_delete_params.rbs +23 -0
  84. data/sig/context_dev/models/batch_delete_response.rbs +57 -0
  85. data/sig/context_dev/models/batch_get_results_response.rbs +30 -2
  86. data/sig/context_dev/models/batch_list_response.rbs +16 -2
  87. data/sig/context_dev/models/batch_retrieve_response.rbs +16 -2
  88. data/sig/context_dev/models/batch_submit_params.rbs +2666 -15
  89. data/sig/context_dev/models/batch_submit_response.rbs +78 -466
  90. data/sig/context_dev/models/brand_retrieve_response.rbs +62 -0
  91. data/sig/context_dev/models/brand_search_params.rbs +38 -1
  92. data/sig/context_dev/models/crawl_controls.rbs +16 -16
  93. data/sig/context_dev/models/news_search_params.rbs +532 -0
  94. data/sig/context_dev/models/news_search_response.rbs +206 -0
  95. data/sig/context_dev/models/parse_handle_params.rbs +25 -90
  96. data/sig/context_dev/models/person_enrich_params.rbs +199 -0
  97. data/sig/context_dev/models/person_enrich_response.rbs +638 -0
  98. data/sig/context_dev/models/utility_prefetch_params.rbs +2 -1
  99. data/sig/context_dev/models/utility_prefetch_response.rbs +2 -1
  100. data/sig/context_dev/models/web_screenshot_params.rbs +5 -18
  101. data/sig/context_dev/models/web_search_response.rbs +2 -0
  102. data/sig/context_dev/models/web_web_crawl_md_response.rbs +21 -0
  103. data/sig/context_dev/models/web_web_scrape_html_params.rbs +24 -94
  104. data/sig/context_dev/models/web_web_scrape_html_response.rbs +21 -0
  105. data/sig/context_dev/models/web_web_scrape_images_params.rbs +20 -72
  106. data/sig/context_dev/models/web_web_scrape_md_params.rbs +46 -148
  107. data/sig/context_dev/models/web_web_scrape_md_response.rbs +28 -0
  108. data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +7 -0
  109. data/sig/context_dev/models.rbs +6 -0
  110. data/sig/context_dev/resources/batch.rbs +8 -2
  111. data/sig/context_dev/resources/brand.rbs +3 -0
  112. data/sig/context_dev/resources/news.rbs +17 -0
  113. data/sig/context_dev/resources/parse.rbs +5 -5
  114. data/sig/context_dev/resources/people.rbs +19 -0
  115. data/sig/context_dev/resources/web.rbs +13 -11
  116. metadata +26 -2
@@ -4,584 +4,179 @@ module ContextDev
4
4
  module Models
5
5
  # @see ContextDev::Resources::Batch#submit
6
6
  class BatchSubmitResponse < ContextDev::Internal::Type::BaseModel
7
- # @!attribute code
8
- # HTTP status code.
7
+ # @!attribute id
8
+ # Batch ID. Poll GET /batch/{batch_id} with it.
9
9
  #
10
- # @return [Integer, ContextDev::Models::BatchSubmitResponse::Code]
11
- required :code, enum: -> { ContextDev::Models::BatchSubmitResponse::Code }
10
+ # @return [String]
11
+ required :id, String
12
12
 
13
- # @!attribute metadata
14
- # Additional response details.
13
+ # @!attribute crawl
14
+ # The crawl controls as submitted, so the limits requested can be compared against
15
+ # what the crawl reached.
15
16
  #
16
- # @return [ContextDev::Models::BatchSubmitResponse::Metadata]
17
- required :metadata, -> { ContextDev::Models::BatchSubmitResponse::Metadata }
17
+ # @return [ContextDev::Models::CrawlControls, nil]
18
+ required :crawl, -> { ContextDev::CrawlControls }, nil?: true
18
19
 
19
- # @!attribute person
20
- # Retrieved person profile.
20
+ # @!attribute created_at
21
+ # When the batch was created.
21
22
  #
22
- # @return [ContextDev::Models::BatchSubmitResponse::Person]
23
- required :person, -> { ContextDev::Models::BatchSubmitResponse::Person }
23
+ # @return [String]
24
+ required :created_at, String
25
+
26
+ # @!attribute credits
27
+ # What accepting this batch cost.
28
+ #
29
+ # @return [ContextDev::Models::BatchSubmitResponse::Credits]
30
+ required :credits, -> { ContextDev::Models::BatchSubmitResponse::Credits }
31
+
32
+ # @!attribute format_
33
+ # What each page will be returned as.
34
+ #
35
+ # @return [Symbol, ContextDev::Models::BatchSubmitResponse::Format]
36
+ required :format_, enum: -> { ContextDev::Models::BatchSubmitResponse::Format }, api_name: :format
37
+
38
+ # @!attribute input
39
+ # What submission took in, and what it charged for.
40
+ #
41
+ # @return [ContextDev::Models::Intake]
42
+ required :input, -> { ContextDev::Intake }
43
+
44
+ # @!attribute invalid_urls
45
+ # Rejected URLs, up to 100. These are not charged.
46
+ #
47
+ # @return [Array<ContextDev::Models::BatchSubmitResponse::InvalidURL>]
48
+ required :invalid_urls,
49
+ -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BatchSubmitResponse::InvalidURL] }
50
+
51
+ # @!attribute mode
52
+ # How pages will be selected.
53
+ #
54
+ # @return [Symbol, ContextDev::Models::BatchSubmitResponse::Mode]
55
+ required :mode, enum: -> { ContextDev::Models::BatchSubmitResponse::Mode }
24
56
 
25
57
  # @!attribute status
26
- # Response status.
58
+ # Always `queued`. An accepted batch has not started yet.
27
59
  #
28
60
  # @return [Symbol, ContextDev::Models::BatchSubmitResponse::Status]
29
61
  required :status, enum: -> { ContextDev::Models::BatchSubmitResponse::Status }
30
62
 
63
+ # @!attribute tags
64
+ # Tags stored on the batch.
65
+ #
66
+ # @return [Array<String>]
67
+ required :tags, ContextDev::Internal::Type::ArrayOf[String]
68
+
31
69
  # @!attribute key_metadata
32
- # Metadata about the API key used for the request. Included in every response
33
- # whenever a valid API key is provided, even when the response status is not 200.
70
+ # API key usage for this request.
34
71
  #
35
72
  # @return [ContextDev::Models::BatchSubmitResponse::KeyMetadata, nil]
36
73
  optional :key_metadata, -> { ContextDev::Models::BatchSubmitResponse::KeyMetadata }
37
74
 
38
- # @!method initialize(code:, metadata:, person:, status:, key_metadata: nil)
75
+ # @!attribute webhook_secret
76
+ # Signing secret for the completion webhook, returned only here and never again.
77
+ # Store it now; it is not repeated by GET /batch/{batch_id}.
78
+ #
79
+ # @return [String, nil]
80
+ optional :webhook_secret, String
81
+
82
+ # @!method initialize(id:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
39
83
  # Some parameter documentations has been truncated, see
40
84
  # {ContextDev::Models::BatchSubmitResponse} for more details.
41
85
  #
42
- # @param code [Integer, ContextDev::Models::BatchSubmitResponse::Code] HTTP status code.
86
+ # @param id [String] Batch ID. Poll GET /batch/{batch_id} with it.
43
87
  #
44
- # @param metadata [ContextDev::Models::BatchSubmitResponse::Metadata] Additional response details.
88
+ # @param crawl [ContextDev::Models::CrawlControls, nil] The crawl controls as submitted, so the limits requested can be compared against
45
89
  #
46
- # @param person [ContextDev::Models::BatchSubmitResponse::Person] Retrieved person profile.
90
+ # @param created_at [String] When the batch was created.
47
91
  #
48
- # @param status [Symbol, ContextDev::Models::BatchSubmitResponse::Status] Response status.
92
+ # @param credits [ContextDev::Models::BatchSubmitResponse::Credits] What accepting this batch cost.
49
93
  #
50
- # @param key_metadata [ContextDev::Models::BatchSubmitResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
51
-
52
- # HTTP status code.
94
+ # @param format_ [Symbol, ContextDev::Models::BatchSubmitResponse::Format] What each page will be returned as.
53
95
  #
54
- # @see ContextDev::Models::BatchSubmitResponse#code
55
- module Code
56
- extend ContextDev::Internal::Type::Enum
57
-
58
- CODE_200 = 200
59
-
60
- # @!method self.values
61
- # @return [Array<Integer>]
62
- end
63
-
64
- # @see ContextDev::Models::BatchSubmitResponse#metadata
65
- class Metadata < ContextDev::Internal::Type::BaseModel
66
- # @!attribute identifiers
67
- # Identifiers returned for the person.
68
- #
69
- # @return [ContextDev::Models::BatchSubmitResponse::Metadata::Identifiers]
70
- required :identifiers, -> { ContextDev::Models::BatchSubmitResponse::Metadata::Identifiers }
71
-
72
- # @!attribute sources_attempted
73
- # Source categories checked.
74
- #
75
- # @return [Array<Symbol, ContextDev::Models::BatchSubmitResponse::Metadata::SourcesAttempted>]
76
- required :sources_attempted,
77
- -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::BatchSubmitResponse::Metadata::SourcesAttempted] },
78
- api_name: :sourcesAttempted
79
-
80
- # @!attribute sources_succeeded
81
- # Source categories with data.
82
- #
83
- # @return [Array<Symbol, ContextDev::Models::BatchSubmitResponse::Metadata::SourcesSucceeded>]
84
- required :sources_succeeded,
85
- -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::Models::BatchSubmitResponse::Metadata::SourcesSucceeded] },
86
- api_name: :sourcesSucceeded
87
-
88
- # @!attribute urls_analyzed
89
- # URLs reviewed for this profile.
90
- #
91
- # @return [Array<String>]
92
- required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String], api_name: :urlsAnalyzed
96
+ # @param input [ContextDev::Models::Intake] What submission took in, and what it charged for.
97
+ #
98
+ # @param invalid_urls [Array<ContextDev::Models::BatchSubmitResponse::InvalidURL>] Rejected URLs, up to 100. These are not charged.
99
+ #
100
+ # @param mode [Symbol, ContextDev::Models::BatchSubmitResponse::Mode] How pages will be selected.
101
+ #
102
+ # @param status [Symbol, ContextDev::Models::BatchSubmitResponse::Status] Always `queued`. An accepted batch has not started yet.
103
+ #
104
+ # @param tags [Array<String>] Tags stored on the batch.
105
+ #
106
+ # @param key_metadata [ContextDev::Models::BatchSubmitResponse::KeyMetadata] API key usage for this request.
107
+ #
108
+ # @param webhook_secret [String] Signing secret for the completion webhook, returned only here and never again. S
93
109
 
94
- # @!attribute personal_website_url
95
- # Personal website URL, when found.
110
+ # @see ContextDev::Models::BatchSubmitResponse#credits
111
+ class Credits < ContextDev::Internal::Type::BaseModel
112
+ # @!attribute reserved
113
+ # Credits just debited from your balance. Whatever the batch does not spend is
114
+ # refunded when it settles.
96
115
  #
97
- # @return [String, nil]
98
- optional :personal_website_url, String, api_name: :personalWebsiteUrl
116
+ # @return [Integer]
117
+ required :reserved, Integer
99
118
 
100
- # @!method initialize(identifiers:, sources_attempted:, sources_succeeded:, urls_analyzed:, personal_website_url: nil)
101
- # Additional response details.
102
- #
103
- # @param identifiers [ContextDev::Models::BatchSubmitResponse::Metadata::Identifiers] Identifiers returned for the person.
104
- #
105
- # @param sources_attempted [Array<Symbol, ContextDev::Models::BatchSubmitResponse::Metadata::SourcesAttempted>] Source categories checked.
106
- #
107
- # @param sources_succeeded [Array<Symbol, ContextDev::Models::BatchSubmitResponse::Metadata::SourcesSucceeded>] Source categories with data.
119
+ # @!method initialize(reserved:)
120
+ # Some parameter documentations has been truncated, see
121
+ # {ContextDev::Models::BatchSubmitResponse::Credits} for more details.
108
122
  #
109
- # @param urls_analyzed [Array<String>] URLs reviewed for this profile.
123
+ # What accepting this batch cost.
110
124
  #
111
- # @param personal_website_url [String] Personal website URL, when found.
112
-
113
- # @see ContextDev::Models::BatchSubmitResponse::Metadata#identifiers
114
- class Identifiers < ContextDev::Internal::Type::BaseModel
115
- # @!attribute linkedin_url
116
- # LinkedIn profile URL.
117
- #
118
- # @return [String, nil]
119
- optional :linkedin_url, String, api_name: :linkedinUrl
120
-
121
- # @!method initialize(linkedin_url: nil)
122
- # Identifiers returned for the person.
123
- #
124
- # @param linkedin_url [String] LinkedIn profile URL.
125
- end
126
-
127
- module SourcesAttempted
128
- extend ContextDev::Internal::Type::Enum
129
-
130
- LINKEDIN = :linkedin
131
- CV = :cv
132
- MANUAL = :manual
133
- GITHUB = :github
134
- OTHER = :other
135
-
136
- # @!method self.values
137
- # @return [Array<Symbol>]
138
- end
125
+ # @param reserved [Integer] Credits just debited from your balance. Whatever the batch does not spend is ref
126
+ end
139
127
 
140
- module SourcesSucceeded
141
- extend ContextDev::Internal::Type::Enum
128
+ # What each page will be returned as.
129
+ #
130
+ # @see ContextDev::Models::BatchSubmitResponse#format_
131
+ module Format
132
+ extend ContextDev::Internal::Type::Enum
142
133
 
143
- LINKEDIN = :linkedin
144
- CV = :cv
145
- MANUAL = :manual
146
- GITHUB = :github
147
- OTHER = :other
134
+ MARKDOWN = :markdown
135
+ HTML = :html
148
136
 
149
- # @!method self.values
150
- # @return [Array<Symbol>]
151
- end
137
+ # @!method self.values
138
+ # @return [Array<Symbol>]
152
139
  end
153
140
 
154
- # @see ContextDev::Models::BatchSubmitResponse#person
155
- class Person < ContextDev::Internal::Type::BaseModel
156
- # @!attribute education
157
- # Education history.
141
+ class InvalidURL < ContextDev::Internal::Type::BaseModel
142
+ # @!attribute reason
143
+ # Why it was rejected.
158
144
  #
159
- # @return [Array<ContextDev::Models::BatchSubmitResponse::Person::Education>]
160
- required :education,
161
- -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BatchSubmitResponse::Person::Education] }
145
+ # @return [String]
146
+ required :reason, String
162
147
 
163
- # @!attribute experience
164
- # Work history.
148
+ # @!attribute url
149
+ # Rejected URL.
165
150
  #
166
- # @return [Array<ContextDev::Models::BatchSubmitResponse::Person::Experience>]
167
- required :experience,
168
- -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BatchSubmitResponse::Person::Experience] }
151
+ # @return [String]
152
+ required :url, String
169
153
 
170
- # @!attribute profile
171
- # Core profile details.
172
- #
173
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Profile]
174
- required :profile, -> { ContextDev::Models::BatchSubmitResponse::Person::Profile }
175
-
176
- # @!attribute skills
177
- # Listed skills.
178
- #
179
- # @return [Array<ContextDev::Models::BatchSubmitResponse::Person::Skill>]
180
- required :skills,
181
- -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BatchSubmitResponse::Person::Skill] }
182
-
183
- # @!method initialize(education:, experience:, profile:, skills:)
184
- # Retrieved person profile.
185
- #
186
- # @param education [Array<ContextDev::Models::BatchSubmitResponse::Person::Education>] Education history.
187
- #
188
- # @param experience [Array<ContextDev::Models::BatchSubmitResponse::Person::Experience>] Work history.
154
+ # @!method initialize(reason:, url:)
155
+ # @param reason [String] Why it was rejected.
189
156
  #
190
- # @param profile [ContextDev::Models::BatchSubmitResponse::Person::Profile] Core profile details.
191
- #
192
- # @param skills [Array<ContextDev::Models::BatchSubmitResponse::Person::Skill>] Listed skills.
193
-
194
- class Education < ContextDev::Internal::Type::BaseModel
195
- # @!attribute institution
196
- # School or institution name.
197
- #
198
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Institution]
199
- required :institution, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Institution }
200
-
201
- # @!attribute dates
202
- # Education dates.
203
- #
204
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates, nil]
205
- optional :dates, -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates }
206
-
207
- # @!attribute description
208
- # Additional education details.
209
- #
210
- # @return [String, nil]
211
- optional :description, String
212
-
213
- # @!attribute field_of_study
214
- # Area of study.
215
- #
216
- # @return [String, nil]
217
- optional :field_of_study, String, api_name: :fieldOfStudy
218
-
219
- # @!attribute qualification
220
- # Degree, certificate, or credential.
221
- #
222
- # @return [String, nil]
223
- optional :qualification, String
224
-
225
- # @!method initialize(institution:, dates: nil, description: nil, field_of_study: nil, qualification: nil)
226
- # @param institution [ContextDev::Models::BatchSubmitResponse::Person::Education::Institution] School or institution name.
227
- #
228
- # @param dates [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates] Education dates.
229
- #
230
- # @param description [String] Additional education details.
231
- #
232
- # @param field_of_study [String] Area of study.
233
- #
234
- # @param qualification [String] Degree, certificate, or credential.
235
-
236
- # @see ContextDev::Models::BatchSubmitResponse::Person::Education#institution
237
- class Institution < ContextDev::Internal::Type::BaseModel
238
- # @!attribute display_
239
- # Display name.
240
- #
241
- # @return [String]
242
- required :display_, String, api_name: :display
243
-
244
- # @!attribute normalized
245
- # Standardized name, when available.
246
- #
247
- # @return [String, nil]
248
- optional :normalized, String
249
-
250
- # @!method initialize(display_:, normalized: nil)
251
- # School or institution name.
252
- #
253
- # @param display_ [String] Display name.
254
- #
255
- # @param normalized [String] Standardized name, when available.
256
- end
257
-
258
- # @see ContextDev::Models::BatchSubmitResponse::Person::Education#dates
259
- class Dates < ContextDev::Internal::Type::BaseModel
260
- # @!attribute end_date
261
- # End date, when known.
262
- #
263
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate, nil]
264
- optional :end_date,
265
- -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate },
266
- api_name: :endDate
267
-
268
- # @!attribute is_current
269
- # Whether the entry is current.
270
- #
271
- # @return [Boolean, nil]
272
- optional :is_current, ContextDev::Internal::Type::Boolean, api_name: :isCurrent
273
-
274
- # @!attribute start_date
275
- # Start date, when known.
276
- #
277
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate, nil]
278
- optional :start_date,
279
- -> { ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate },
280
- api_name: :startDate
281
-
282
- # @!method initialize(end_date: nil, is_current: nil, start_date: nil)
283
- # Education dates.
284
- #
285
- # @param end_date [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::EndDate] End date, when known.
286
- #
287
- # @param is_current [Boolean] Whether the entry is current.
288
- #
289
- # @param start_date [ContextDev::Models::BatchSubmitResponse::Person::Education::Dates::StartDate] Start date, when known.
290
-
291
- # @see ContextDev::Models::BatchSubmitResponse::Person::Education::Dates#end_date
292
- class EndDate < ContextDev::Internal::Type::BaseModel
293
- # @!attribute year
294
- # Year value.
295
- #
296
- # @return [Integer]
297
- required :year, Integer
298
-
299
- # @!attribute day
300
- # Day value, when known.
301
- #
302
- # @return [Integer, nil]
303
- optional :day, Integer
304
-
305
- # @!attribute month
306
- # Month value, when known.
307
- #
308
- # @return [Integer, nil]
309
- optional :month, Integer
310
-
311
- # @!method initialize(year:, day: nil, month: nil)
312
- # End date, when known.
313
- #
314
- # @param year [Integer] Year value.
315
- #
316
- # @param day [Integer] Day value, when known.
317
- #
318
- # @param month [Integer] Month value, when known.
319
- end
320
-
321
- # @see ContextDev::Models::BatchSubmitResponse::Person::Education::Dates#start_date
322
- class StartDate < ContextDev::Internal::Type::BaseModel
323
- # @!attribute year
324
- # Year value.
325
- #
326
- # @return [Integer]
327
- required :year, Integer
328
-
329
- # @!attribute day
330
- # Day value, when known.
331
- #
332
- # @return [Integer, nil]
333
- optional :day, Integer
334
-
335
- # @!attribute month
336
- # Month value, when known.
337
- #
338
- # @return [Integer, nil]
339
- optional :month, Integer
340
-
341
- # @!method initialize(year:, day: nil, month: nil)
342
- # Start date, when known.
343
- #
344
- # @param year [Integer] Year value.
345
- #
346
- # @param day [Integer] Day value, when known.
347
- #
348
- # @param month [Integer] Month value, when known.
349
- end
350
- end
351
- end
352
-
353
- class Experience < ContextDev::Internal::Type::BaseModel
354
- # @!attribute company
355
- # Company or organization name.
356
- #
357
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Experience::Company]
358
- required :company, -> { ContextDev::Models::BatchSubmitResponse::Person::Experience::Company }
359
-
360
- # @!attribute title
361
- # Role or job title.
362
- #
363
- # @return [String]
364
- required :title, String
365
-
366
- # @!attribute dates
367
- # Role dates.
368
- #
369
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates, nil]
370
- optional :dates, -> { ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates }
371
-
372
- # @!attribute description
373
- # Role description.
374
- #
375
- # @return [String, nil]
376
- optional :description, String
377
-
378
- # @!method initialize(company:, title:, dates: nil, description: nil)
379
- # @param company [ContextDev::Models::BatchSubmitResponse::Person::Experience::Company] Company or organization name.
380
- #
381
- # @param title [String] Role or job title.
382
- #
383
- # @param dates [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates] Role dates.
384
- #
385
- # @param description [String] Role description.
386
-
387
- # @see ContextDev::Models::BatchSubmitResponse::Person::Experience#company
388
- class Company < ContextDev::Internal::Type::BaseModel
389
- # @!attribute display_
390
- # Display name.
391
- #
392
- # @return [String]
393
- required :display_, String, api_name: :display
394
-
395
- # @!attribute normalized
396
- # Standardized name, when available.
397
- #
398
- # @return [String, nil]
399
- optional :normalized, String
400
-
401
- # @!method initialize(display_:, normalized: nil)
402
- # Company or organization name.
403
- #
404
- # @param display_ [String] Display name.
405
- #
406
- # @param normalized [String] Standardized name, when available.
407
- end
408
-
409
- # @see ContextDev::Models::BatchSubmitResponse::Person::Experience#dates
410
- class Dates < ContextDev::Internal::Type::BaseModel
411
- # @!attribute end_date
412
- # End date, when known.
413
- #
414
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::EndDate, nil]
415
- optional :end_date,
416
- -> { ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::EndDate },
417
- api_name: :endDate
418
-
419
- # @!attribute is_current
420
- # Whether the entry is current.
421
- #
422
- # @return [Boolean, nil]
423
- optional :is_current, ContextDev::Internal::Type::Boolean, api_name: :isCurrent
424
-
425
- # @!attribute start_date
426
- # Start date, when known.
427
- #
428
- # @return [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::StartDate, nil]
429
- optional :start_date,
430
- -> { ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::StartDate },
431
- api_name: :startDate
432
-
433
- # @!method initialize(end_date: nil, is_current: nil, start_date: nil)
434
- # Role dates.
435
- #
436
- # @param end_date [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::EndDate] End date, when known.
437
- #
438
- # @param is_current [Boolean] Whether the entry is current.
439
- #
440
- # @param start_date [ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates::StartDate] Start date, when known.
441
-
442
- # @see ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates#end_date
443
- class EndDate < ContextDev::Internal::Type::BaseModel
444
- # @!attribute year
445
- # Year value.
446
- #
447
- # @return [Integer]
448
- required :year, Integer
449
-
450
- # @!attribute day
451
- # Day value, when known.
452
- #
453
- # @return [Integer, nil]
454
- optional :day, Integer
455
-
456
- # @!attribute month
457
- # Month value, when known.
458
- #
459
- # @return [Integer, nil]
460
- optional :month, Integer
461
-
462
- # @!method initialize(year:, day: nil, month: nil)
463
- # End date, when known.
464
- #
465
- # @param year [Integer] Year value.
466
- #
467
- # @param day [Integer] Day value, when known.
468
- #
469
- # @param month [Integer] Month value, when known.
470
- end
471
-
472
- # @see ContextDev::Models::BatchSubmitResponse::Person::Experience::Dates#start_date
473
- class StartDate < ContextDev::Internal::Type::BaseModel
474
- # @!attribute year
475
- # Year value.
476
- #
477
- # @return [Integer]
478
- required :year, Integer
479
-
480
- # @!attribute day
481
- # Day value, when known.
482
- #
483
- # @return [Integer, nil]
484
- optional :day, Integer
485
-
486
- # @!attribute month
487
- # Month value, when known.
488
- #
489
- # @return [Integer, nil]
490
- optional :month, Integer
491
-
492
- # @!method initialize(year:, day: nil, month: nil)
493
- # Start date, when known.
494
- #
495
- # @param year [Integer] Year value.
496
- #
497
- # @param day [Integer] Day value, when known.
498
- #
499
- # @param month [Integer] Month value, when known.
500
- end
501
- end
502
- end
503
-
504
- # @see ContextDev::Models::BatchSubmitResponse::Person#profile
505
- class Profile < ContextDev::Internal::Type::BaseModel
506
- # @!attribute full_name
507
- # Person's full name.
508
- #
509
- # @return [String, nil]
510
- optional :full_name, String, api_name: :fullName
511
-
512
- # @!attribute headline
513
- # Short professional headline.
514
- #
515
- # @return [String, nil]
516
- optional :headline, String
517
-
518
- # @!attribute location
519
- # Person's listed location.
520
- #
521
- # @return [String, nil]
522
- optional :location, String
523
-
524
- # @!attribute profile_picture_url
525
- # Profile image URL.
526
- #
527
- # @return [String, nil]
528
- optional :profile_picture_url, String, api_name: :profilePictureUrl
529
-
530
- # @!attribute summary
531
- # Brief profile summary.
532
- #
533
- # @return [String, nil]
534
- optional :summary, String
535
-
536
- # @!method initialize(full_name: nil, headline: nil, location: nil, profile_picture_url: nil, summary: nil)
537
- # Core profile details.
538
- #
539
- # @param full_name [String] Person's full name.
540
- #
541
- # @param headline [String] Short professional headline.
542
- #
543
- # @param location [String] Person's listed location.
544
- #
545
- # @param profile_picture_url [String] Profile image URL.
546
- #
547
- # @param summary [String] Brief profile summary.
548
- end
549
-
550
- class Skill < ContextDev::Internal::Type::BaseModel
551
- # @!attribute name
552
- # Skill name.
553
- #
554
- # @return [String]
555
- required :name, String
157
+ # @param url [String] Rejected URL.
158
+ end
556
159
 
557
- # @!attribute normalized
558
- # Standardized skill name, when available.
559
- #
560
- # @return [String, nil]
561
- optional :normalized, String
160
+ # How pages will be selected.
161
+ #
162
+ # @see ContextDev::Models::BatchSubmitResponse#mode
163
+ module Mode
164
+ extend ContextDev::Internal::Type::Enum
562
165
 
563
- # @!attribute proficiency
564
- # Skill proficiency, when available.
565
- #
566
- # @return [String, nil]
567
- optional :proficiency, String
166
+ SCRAPE = :scrape
167
+ CRAWL = :crawl
568
168
 
569
- # @!method initialize(name:, normalized: nil, proficiency: nil)
570
- # @param name [String] Skill name.
571
- #
572
- # @param normalized [String] Standardized skill name, when available.
573
- #
574
- # @param proficiency [String] Skill proficiency, when available.
575
- end
169
+ # @!method self.values
170
+ # @return [Array<Symbol>]
576
171
  end
577
172
 
578
- # Response status.
173
+ # Always `queued`. An accepted batch has not started yet.
579
174
  #
580
175
  # @see ContextDev::Models::BatchSubmitResponse#status
581
176
  module Status
582
177
  extend ContextDev::Internal::Type::Enum
583
178
 
584
- OK = :ok
179
+ QUEUED = :queued
585
180
 
586
181
  # @!method self.values
587
182
  # @return [Array<Symbol>]
@@ -602,8 +197,7 @@ module ContextDev
602
197
  required :credits_remaining, Integer
603
198
 
604
199
  # @!method initialize(credits_consumed:, credits_remaining:)
605
- # Metadata about the API key used for the request. Included in every response
606
- # whenever a valid API key is provided, even when the response status is not 200.
200
+ # API key usage for this request.
607
201
  #
608
202
  # @param credits_consumed [Integer] The number of credits consumed by this request.
609
203
  #