merge_ats_client 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (297) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +208 -0
  4. data/Rakefile +10 -0
  5. data/config.json +2 -0
  6. data/docs/AccessRoleEnum.md +15 -0
  7. data/docs/AccountIntegration.md +28 -0
  8. data/docs/AccountToken.md +18 -0
  9. data/docs/AccountTokenApi.md +79 -0
  10. data/docs/ActivitiesApi.md +181 -0
  11. data/docs/Activity.md +34 -0
  12. data/docs/ActivityTypeEnum.md +15 -0
  13. data/docs/Application.md +38 -0
  14. data/docs/ApplicationRequest.md +34 -0
  15. data/docs/ApplicationsApi.md +351 -0
  16. data/docs/Attachment.md +28 -0
  17. data/docs/AttachmentsApi.md +177 -0
  18. data/docs/AvailableActions.md +22 -0
  19. data/docs/AvailableActionsApi.md +79 -0
  20. data/docs/Candidate.md +54 -0
  21. data/docs/CandidateRequest.md +46 -0
  22. data/docs/CandidatesApi.md +259 -0
  23. data/docs/DataPassthrough.md +24 -0
  24. data/docs/DataPassthroughRequest.md +26 -0
  25. data/docs/Department.md +24 -0
  26. data/docs/DepartmentsApi.md +175 -0
  27. data/docs/DisabilityStatusEnum.md +15 -0
  28. data/docs/EEOC.md +34 -0
  29. data/docs/EeocsApi.md +181 -0
  30. data/docs/EmailAddress.md +20 -0
  31. data/docs/EmailAddressRequest.md +20 -0
  32. data/docs/EmailAddressTypeEnum.md +15 -0
  33. data/docs/EndUserDetails.md +24 -0
  34. data/docs/EndUserDetailsRequest.md +26 -0
  35. data/docs/GenderEnum.md +15 -0
  36. data/docs/GenerateKeyApi.md +79 -0
  37. data/docs/GenerateRemoteKeyRequest.md +18 -0
  38. data/docs/InterviewsApi.md +185 -0
  39. data/docs/Job.md +40 -0
  40. data/docs/JobInterviewStage.md +26 -0
  41. data/docs/JobInterviewStagesApi.md +181 -0
  42. data/docs/JobStatusEnum.md +15 -0
  43. data/docs/JobsApi.md +179 -0
  44. data/docs/LinkToken.md +20 -0
  45. data/docs/LinkTokenApi.md +79 -0
  46. data/docs/MethodEnum.md +15 -0
  47. data/docs/ModelOperation.md +22 -0
  48. data/docs/Offer.md +36 -0
  49. data/docs/OfferStatusEnum.md +15 -0
  50. data/docs/OffersApi.md +183 -0
  51. data/docs/Office.md +26 -0
  52. data/docs/OfficesApi.md +175 -0
  53. data/docs/OverallRecommendationEnum.md +15 -0
  54. data/docs/PaginatedActivityList.md +22 -0
  55. data/docs/PaginatedApplicationList.md +22 -0
  56. data/docs/PaginatedAttachmentList.md +22 -0
  57. data/docs/PaginatedCandidateList.md +22 -0
  58. data/docs/PaginatedDepartmentList.md +22 -0
  59. data/docs/PaginatedEEOCList.md +22 -0
  60. data/docs/PaginatedJobInterviewStageList.md +22 -0
  61. data/docs/PaginatedJobList.md +22 -0
  62. data/docs/PaginatedOfferList.md +22 -0
  63. data/docs/PaginatedOfficeList.md +22 -0
  64. data/docs/PaginatedRejectReasonList.md +22 -0
  65. data/docs/PaginatedRemoteUserList.md +22 -0
  66. data/docs/PaginatedScheduledInterviewList.md +22 -0
  67. data/docs/PaginatedScorecardList.md +22 -0
  68. data/docs/PaginatedTagList.md +22 -0
  69. data/docs/PassthroughApi.md +81 -0
  70. data/docs/PatchedApplicationRequest.md +34 -0
  71. data/docs/PhoneNumber.md +20 -0
  72. data/docs/PhoneNumberRequest.md +20 -0
  73. data/docs/PhoneNumberTypeEnum.md +15 -0
  74. data/docs/RaceEnum.md +15 -0
  75. data/docs/RegenerateKeyApi.md +79 -0
  76. data/docs/RejectReason.md +24 -0
  77. data/docs/RejectReasonsApi.md +175 -0
  78. data/docs/RemoteData.md +20 -0
  79. data/docs/RemoteDataRequest.md +20 -0
  80. data/docs/RemoteKey.md +20 -0
  81. data/docs/RemoteKeyForRegeneration.md +18 -0
  82. data/docs/RemoteKeyForRegenerationRequest.md +18 -0
  83. data/docs/RemoteResponse.md +26 -0
  84. data/docs/RemoteUser.md +34 -0
  85. data/docs/ScheduledInterview.md +42 -0
  86. data/docs/ScheduledInterviewStatusEnum.md +15 -0
  87. data/docs/Scorecard.md +34 -0
  88. data/docs/ScorecardsApi.md +185 -0
  89. data/docs/SyncStatus.md +28 -0
  90. data/docs/SyncStatusApi.md +79 -0
  91. data/docs/Tag.md +22 -0
  92. data/docs/TagsApi.md +97 -0
  93. data/docs/Url.md +20 -0
  94. data/docs/UrlRequest.md +20 -0
  95. data/docs/UrlTypeEnum.md +15 -0
  96. data/docs/UsersApi.md +175 -0
  97. data/docs/VeteranStatusEnum.md +15 -0
  98. data/docs/VisibilityEnum.md +15 -0
  99. data/git_push.sh +58 -0
  100. data/lib/merge_ats_client.rb +131 -0
  101. data/lib/merge_ats_client/api/account_token_api.rb +83 -0
  102. data/lib/merge_ats_client/api/activities_api.rb +196 -0
  103. data/lib/merge_ats_client/api/applications_api.rb +366 -0
  104. data/lib/merge_ats_client/api/attachments_api.rb +182 -0
  105. data/lib/merge_ats_client/api/available_actions_api.rb +84 -0
  106. data/lib/merge_ats_client/api/candidates_api.rb +269 -0
  107. data/lib/merge_ats_client/api/departments_api.rb +179 -0
  108. data/lib/merge_ats_client/api/eeocs_api.rb +196 -0
  109. data/lib/merge_ats_client/api/generate_key_api.rb +85 -0
  110. data/lib/merge_ats_client/api/interviews_api.rb +202 -0
  111. data/lib/merge_ats_client/api/job_interview_stages_api.rb +196 -0
  112. data/lib/merge_ats_client/api/jobs_api.rb +193 -0
  113. data/lib/merge_ats_client/api/link_token_api.rb +85 -0
  114. data/lib/merge_ats_client/api/offers_api.rb +199 -0
  115. data/lib/merge_ats_client/api/offices_api.rb +179 -0
  116. data/lib/merge_ats_client/api/passthrough_api.rb +92 -0
  117. data/lib/merge_ats_client/api/regenerate_key_api.rb +85 -0
  118. data/lib/merge_ats_client/api/reject_reasons_api.rb +179 -0
  119. data/lib/merge_ats_client/api/scorecards_api.rb +202 -0
  120. data/lib/merge_ats_client/api/sync_status_api.rb +84 -0
  121. data/lib/merge_ats_client/api/tags_api.rb +108 -0
  122. data/lib/merge_ats_client/api/users_api.rb +179 -0
  123. data/lib/merge_ats_client/api_client.rb +390 -0
  124. data/lib/merge_ats_client/api_error.rb +57 -0
  125. data/lib/merge_ats_client/configuration.rb +279 -0
  126. data/lib/merge_ats_client/models/access_role_enum.rb +38 -0
  127. data/lib/merge_ats_client/models/account_integration.rb +325 -0
  128. data/lib/merge_ats_client/models/account_token.rb +223 -0
  129. data/lib/merge_ats_client/models/activity.rb +308 -0
  130. data/lib/merge_ats_client/models/activity_type_enum.rb +36 -0
  131. data/lib/merge_ats_client/models/application.rb +330 -0
  132. data/lib/merge_ats_client/models/application_request.rb +309 -0
  133. data/lib/merge_ats_client/models/attachment.rb +289 -0
  134. data/lib/merge_ats_client/models/available_actions.rb +249 -0
  135. data/lib/merge_ats_client/models/candidate.rb +420 -0
  136. data/lib/merge_ats_client/models/candidate_request.rb +377 -0
  137. data/lib/merge_ats_client/models/data_passthrough.rb +262 -0
  138. data/lib/merge_ats_client/models/data_passthrough_request.rb +271 -0
  139. data/lib/merge_ats_client/models/department.rb +253 -0
  140. data/lib/merge_ats_client/models/disability_status_enum.rb +36 -0
  141. data/lib/merge_ats_client/models/eeoc.rb +308 -0
  142. data/lib/merge_ats_client/models/email_address.rb +247 -0
  143. data/lib/merge_ats_client/models/email_address_request.rb +247 -0
  144. data/lib/merge_ats_client/models/email_address_type_enum.rb +36 -0
  145. data/lib/merge_ats_client/models/end_user_details.rb +289 -0
  146. data/lib/merge_ats_client/models/end_user_details_request.rb +298 -0
  147. data/lib/merge_ats_client/models/gender_enum.rb +38 -0
  148. data/lib/merge_ats_client/models/generate_remote_key_request.rb +224 -0
  149. data/lib/merge_ats_client/models/job.rb +341 -0
  150. data/lib/merge_ats_client/models/job_interview_stage.rb +264 -0
  151. data/lib/merge_ats_client/models/job_status_enum.rb +38 -0
  152. data/lib/merge_ats_client/models/link_token.rb +237 -0
  153. data/lib/merge_ats_client/models/method_enum.rb +40 -0
  154. data/lib/merge_ats_client/models/model_operation.rb +256 -0
  155. data/lib/merge_ats_client/models/offer.rb +319 -0
  156. data/lib/merge_ats_client/models/offer_status_enum.rb +42 -0
  157. data/lib/merge_ats_client/models/office.rb +264 -0
  158. data/lib/merge_ats_client/models/overall_recommendation_enum.rb +38 -0
  159. data/lib/merge_ats_client/models/paginated_activity_list.rb +240 -0
  160. data/lib/merge_ats_client/models/paginated_application_list.rb +240 -0
  161. data/lib/merge_ats_client/models/paginated_attachment_list.rb +240 -0
  162. data/lib/merge_ats_client/models/paginated_candidate_list.rb +240 -0
  163. data/lib/merge_ats_client/models/paginated_department_list.rb +240 -0
  164. data/lib/merge_ats_client/models/paginated_eeoc_list.rb +240 -0
  165. data/lib/merge_ats_client/models/paginated_job_interview_stage_list.rb +240 -0
  166. data/lib/merge_ats_client/models/paginated_job_list.rb +240 -0
  167. data/lib/merge_ats_client/models/paginated_offer_list.rb +240 -0
  168. data/lib/merge_ats_client/models/paginated_office_list.rb +240 -0
  169. data/lib/merge_ats_client/models/paginated_reject_reason_list.rb +240 -0
  170. data/lib/merge_ats_client/models/paginated_remote_user_list.rb +240 -0
  171. data/lib/merge_ats_client/models/paginated_scheduled_interview_list.rb +240 -0
  172. data/lib/merge_ats_client/models/paginated_scorecard_list.rb +240 -0
  173. data/lib/merge_ats_client/models/paginated_tag_list.rb +240 -0
  174. data/lib/merge_ats_client/models/patched_application_request.rb +309 -0
  175. data/lib/merge_ats_client/models/phone_number.rb +232 -0
  176. data/lib/merge_ats_client/models/phone_number_request.rb +232 -0
  177. data/lib/merge_ats_client/models/phone_number_type_enum.rb +38 -0
  178. data/lib/merge_ats_client/models/race_enum.rb +41 -0
  179. data/lib/merge_ats_client/models/reject_reason.rb +253 -0
  180. data/lib/merge_ats_client/models/remote_data.rb +234 -0
  181. data/lib/merge_ats_client/models/remote_data_request.rb +234 -0
  182. data/lib/merge_ats_client/models/remote_key.rb +238 -0
  183. data/lib/merge_ats_client/models/remote_key_for_regeneration.rb +224 -0
  184. data/lib/merge_ats_client/models/remote_key_for_regeneration_request.rb +224 -0
  185. data/lib/merge_ats_client/models/remote_response.rb +279 -0
  186. data/lib/merge_ats_client/models/remote_user.rb +323 -0
  187. data/lib/merge_ats_client/models/scheduled_interview.rb +352 -0
  188. data/lib/merge_ats_client/models/scheduled_interview_status_enum.rb +36 -0
  189. data/lib/merge_ats_client/models/scorecard.rb +308 -0
  190. data/lib/merge_ats_client/models/sync_status.rb +294 -0
  191. data/lib/merge_ats_client/models/tag.rb +244 -0
  192. data/lib/merge_ats_client/models/url.rb +247 -0
  193. data/lib/merge_ats_client/models/url_request.rb +247 -0
  194. data/lib/merge_ats_client/models/url_type_enum.rb +39 -0
  195. data/lib/merge_ats_client/models/veteran_status_enum.rb +36 -0
  196. data/lib/merge_ats_client/models/visibility_enum.rb +36 -0
  197. data/lib/merge_ats_client/version.rb +15 -0
  198. data/merge_ats_client-1.0.0.gem +0 -0
  199. data/merge_ats_client.gemspec +38 -0
  200. data/pull_request_template.md +22 -0
  201. data/spec/api/account_token_api_spec.rb +46 -0
  202. data/spec/api/activities_api_spec.rb +68 -0
  203. data/spec/api/applications_api_spec.rb +72 -0
  204. data/spec/api/attachments_api_spec.rb +66 -0
  205. data/spec/api/available_actions_api_spec.rb +46 -0
  206. data/spec/api/candidates_api_spec.rb +67 -0
  207. data/spec/api/departments_api_spec.rb +65 -0
  208. data/spec/api/eeocs_api_spec.rb +68 -0
  209. data/spec/api/interviews_api_spec.rb +70 -0
  210. data/spec/api/job_interview_stages_api_spec.rb +68 -0
  211. data/spec/api/jobs_api_spec.rb +67 -0
  212. data/spec/api/link_token_api_spec.rb +46 -0
  213. data/spec/api/offers_api_spec.rb +69 -0
  214. data/spec/api/offices_api_spec.rb +65 -0
  215. data/spec/api/passthrough_api_spec.rb +47 -0
  216. data/spec/api/regenerate_key_api_spec.rb +48 -0
  217. data/spec/api/reject_reasons_api_spec.rb +65 -0
  218. data/spec/api/scorecards_api_spec.rb +70 -0
  219. data/spec/api/sync_status_api_spec.rb +45 -0
  220. data/spec/api/tags_api_spec.rb +53 -0
  221. data/spec/api/users_api_spec.rb +65 -0
  222. data/spec/api_client_spec.rb +226 -0
  223. data/spec/configuration_spec.rb +42 -0
  224. data/spec/models/access_role_enum_spec.rb +28 -0
  225. data/spec/models/account_integration_spec.rb +58 -0
  226. data/spec/models/account_token_spec.rb +34 -0
  227. data/spec/models/activity_spec.rb +76 -0
  228. data/spec/models/activity_type_enum_spec.rb +28 -0
  229. data/spec/models/application_request_spec.rb +82 -0
  230. data/spec/models/application_spec.rb +94 -0
  231. data/spec/models/attachment_spec.rb +52 -0
  232. data/spec/models/available_actions_spec.rb +46 -0
  233. data/spec/models/candidate_request_spec.rb +118 -0
  234. data/spec/models/candidate_spec.rb +136 -0
  235. data/spec/models/data_passthrough_request_spec.rb +58 -0
  236. data/spec/models/data_passthrough_spec.rb +52 -0
  237. data/spec/models/department_spec.rb +46 -0
  238. data/spec/models/disability_status_enum_spec.rb +28 -0
  239. data/spec/models/eeoc_spec.rb +76 -0
  240. data/spec/models/email_address_request_spec.rb +40 -0
  241. data/spec/models/email_address_spec.rb +40 -0
  242. data/spec/models/email_address_type_enum_spec.rb +28 -0
  243. data/spec/models/end_user_details_request_spec.rb +56 -0
  244. data/spec/models/end_user_details_spec.rb +56 -0
  245. data/spec/models/gender_enum_spec.rb +28 -0
  246. data/spec/models/generate_remote_key_request_spec.rb +34 -0
  247. data/spec/models/job_interview_stage_spec.rb +52 -0
  248. data/spec/models/job_spec.rb +88 -0
  249. data/spec/models/job_status_enum_spec.rb +28 -0
  250. data/spec/models/link_token_spec.rb +40 -0
  251. data/spec/models/method_enum_spec.rb +28 -0
  252. data/spec/models/model_operation_spec.rb +40 -0
  253. data/spec/models/offer_spec.rb +82 -0
  254. data/spec/models/offer_status_enum_spec.rb +28 -0
  255. data/spec/models/office_spec.rb +52 -0
  256. data/spec/models/overall_recommendation_enum_spec.rb +28 -0
  257. data/spec/models/paginated_activity_list_spec.rb +46 -0
  258. data/spec/models/paginated_application_list_spec.rb +46 -0
  259. data/spec/models/paginated_attachment_list_spec.rb +46 -0
  260. data/spec/models/paginated_candidate_list_spec.rb +46 -0
  261. data/spec/models/paginated_department_list_spec.rb +46 -0
  262. data/spec/models/paginated_eeoc_list_spec.rb +46 -0
  263. data/spec/models/paginated_job_interview_stage_list_spec.rb +46 -0
  264. data/spec/models/paginated_job_list_spec.rb +46 -0
  265. data/spec/models/paginated_offer_list_spec.rb +46 -0
  266. data/spec/models/paginated_office_list_spec.rb +46 -0
  267. data/spec/models/paginated_reject_reason_list_spec.rb +46 -0
  268. data/spec/models/paginated_remote_user_list_spec.rb +46 -0
  269. data/spec/models/paginated_scheduled_interview_list_spec.rb +46 -0
  270. data/spec/models/paginated_scorecard_list_spec.rb +46 -0
  271. data/spec/models/paginated_tag_list_spec.rb +46 -0
  272. data/spec/models/patched_application_request_spec.rb +82 -0
  273. data/spec/models/phone_number_request_spec.rb +40 -0
  274. data/spec/models/phone_number_spec.rb +40 -0
  275. data/spec/models/phone_number_type_enum_spec.rb +28 -0
  276. data/spec/models/race_enum_spec.rb +28 -0
  277. data/spec/models/reject_reason_spec.rb +46 -0
  278. data/spec/models/remote_data_spec.rb +40 -0
  279. data/spec/models/remote_key_for_regeneration_request_spec.rb +34 -0
  280. data/spec/models/remote_key_for_regeneration_spec.rb +34 -0
  281. data/spec/models/remote_key_spec.rb +40 -0
  282. data/spec/models/remote_response_spec.rb +58 -0
  283. data/spec/models/remote_user_spec.rb +76 -0
  284. data/spec/models/scheduled_interview_spec.rb +100 -0
  285. data/spec/models/scheduled_interview_status_enum_spec.rb +28 -0
  286. data/spec/models/scorecard_spec.rb +76 -0
  287. data/spec/models/sync_status_spec.rb +64 -0
  288. data/spec/models/tag_spec.rb +40 -0
  289. data/spec/models/url_request_spec.rb +40 -0
  290. data/spec/models/url_spec.rb +40 -0
  291. data/spec/models/url_type_enum_spec.rb +28 -0
  292. data/spec/models/veteran_status_enum_spec.rb +28 -0
  293. data/spec/models/visibility_enum_spec.rb +28 -0
  294. data/spec/spec_helper.rb +111 -0
  295. data/test_ats.rb +22 -0
  296. data/test_signature.rb +32 -0
  297. metadata +473 -0
@@ -0,0 +1,18 @@
1
+ # MergeATSClient::RemoteKeyForRegeneration
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_ats_client'
13
+
14
+ instance = MergeATSClient::RemoteKeyForRegeneration.new(
15
+ name: Remote Deployment Key 1
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MergeATSClient::RemoteKeyForRegenerationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'merge_ats_client'
13
+
14
+ instance = MergeATSClient::RemoteKeyForRegenerationRequest.new(
15
+ name: Remote Deployment Key 1
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # MergeATSClient::RemoteResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **method** | **String** | | |
8
+ | **path** | **String** | | |
9
+ | **status** | **Integer** | | |
10
+ | **response** | [**Hash<String, AnyType>**](AnyType.md) | | |
11
+ | **headers** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'merge_ats_client'
17
+
18
+ instance = MergeATSClient::RemoteResponse.new(
19
+ method: GET,
20
+ path: /scooters,
21
+ status: 200,
22
+ response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
23
+ headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
24
+ )
25
+ ```
26
+
@@ -0,0 +1,34 @@
1
+ # MergeATSClient::RemoteUser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **first_name** | **String** | The user's first name. | [optional] |
10
+ | **last_name** | **String** | The user's last name. | [optional] |
11
+ | **email** | **String** | The user's email. | [optional] |
12
+ | **disabled** | **Boolean** | Whether the user's account had been disabled. | [optional] |
13
+ | **remote_created_at** | **Time** | When the third party's user was created. | [optional] |
14
+ | **access_role** | [**AccessRoleEnum**](AccessRoleEnum.md) | The user's role. | [optional] |
15
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'merge_ats_client'
21
+
22
+ instance = MergeATSClient::RemoteUser.new(
23
+ id: b82302de-852e-4e60-b050-edf9da3b7c02,
24
+ remote_id: 344321,
25
+ first_name: Shensi,
26
+ last_name: Ding,
27
+ email: hello@merge.dev,
28
+ disabled: null,
29
+ remote_created_at: null,
30
+ access_role: SUPER_ADMIN,
31
+ remote_data: [{"path":"/users","data":["Varies by platform"]}]
32
+ )
33
+ ```
34
+
@@ -0,0 +1,42 @@
1
+ # MergeATSClient::ScheduledInterview
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **application** | **String** | The application being interviewed. | [optional] |
10
+ | **job_interview_stage** | **String** | The stage of the interview. | [optional] |
11
+ | **organizer** | **String** | The user organizing the interview. | [optional] |
12
+ | **interviewers** | **Array<String>** | | [optional] |
13
+ | **location** | **String** | The interview's location. | [optional] |
14
+ | **start_at** | **Time** | When the interview was started. | [optional] |
15
+ | **end_at** | **Time** | When the interview was ended. | [optional] |
16
+ | **remote_created_at** | **Time** | When the third party's interview was created. | [optional] |
17
+ | **remote_updated_at** | **Time** | When the third party's interview was updated. | [optional] |
18
+ | **status** | [**ScheduledInterviewStatusEnum**](ScheduledInterviewStatusEnum.md) | The interview's status. | [optional] |
19
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'merge_ats_client'
25
+
26
+ instance = MergeATSClient::ScheduledInterview.new(
27
+ id: b8faf072-98b9-4445-8a9a-6b4950efca19,
28
+ remote_id: 3,
29
+ application: 92e8a369-fffe-430d-b93a-f7e8a16563f1,
30
+ job_interview_stage: 2f7adb59-3fe6-4b5b-aef6-563f72bd13dc,
31
+ organizer: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
32
+ interviewers: ["f9813dd5-e70b-484c-91d8-00acd6065b07","89a86fcf-d540-4e6b-ac3d-ce07c4ec9b3c"],
33
+ location: Embarcadero Center 2,
34
+ start_at: null,
35
+ end_at: null,
36
+ remote_created_at: null,
37
+ remote_updated_at: null,
38
+ status: SCHEDULED,
39
+ remote_data: [{"path":"/interviews","data":["Varies by platform"]}]
40
+ )
41
+ ```
42
+
@@ -0,0 +1,15 @@
1
+ # MergeATSClient::ScheduledInterviewStatusEnum
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'merge_ats_client'
12
+
13
+ instance = MergeATSClient::ScheduledInterviewStatusEnum.new()
14
+ ```
15
+
data/docs/Scorecard.md ADDED
@@ -0,0 +1,34 @@
1
+ # MergeATSClient::Scorecard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional][readonly] |
8
+ | **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
9
+ | **application** | **String** | The application being scored. | [optional] |
10
+ | **interview** | **String** | The interview being scored. | [optional] |
11
+ | **interviewer** | **String** | The interviewer doing the scoring. | [optional] |
12
+ | **remote_created_at** | **Time** | When the third party's scorecard was created. | [optional] |
13
+ | **submitted_at** | **Time** | When the scorecard was submitted. | [optional] |
14
+ | **overall_recommendation** | [**OverallRecommendationEnum**](OverallRecommendationEnum.md) | The inteviewer's recommendation. | [optional] |
15
+ | **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'merge_ats_client'
21
+
22
+ instance = MergeATSClient::Scorecard.new(
23
+ id: 3eab2f17-eeb1-450d-97f0-029d8be1e06f,
24
+ remote_id: 22234,
25
+ application: 2872ba14-4084-492b-be96-e5eee6fc33ef,
26
+ interview: 52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633,
27
+ interviewer: bbb519a3-246e-4b95-b6b3-dba16107ba6b,
28
+ remote_created_at: null,
29
+ submitted_at: null,
30
+ overall_recommendation: STRONG_YES,
31
+ remote_data: [{"path":"/ratings","data":["Varies by platform"]}]
32
+ )
33
+ ```
34
+
@@ -0,0 +1,185 @@
1
+ # MergeATSClient::ScorecardsApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/ats/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**scorecards_list**](ScorecardsApi.md#scorecards_list) | **GET** /scorecards | |
8
+ | [**scorecards_retrieve**](ScorecardsApi.md#scorecards_retrieve) | **GET** /scorecards/{id} | |
9
+
10
+
11
+ ## scorecards_list
12
+
13
+ > <PaginatedScorecardList> scorecards_list(x_account_token, opts)
14
+
15
+
16
+
17
+ Returns a list of `Scorecard` objects.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'merge_ats_client'
24
+ # setup authorization
25
+ MergeATSClient.configure do |config|
26
+ # Configure API key authorization: tokenAuth
27
+ config.api_key['Authorization'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['Authorization'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = MergeATSClient::ScorecardsApi.new
33
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
34
+ opts = {
35
+ application_id: 'application_id_example', # String | If provided, will only return scorecards for this application.
36
+ created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
37
+ created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
38
+ cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
39
+ expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
40
+ include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
41
+ interview_id: 'interview_id_example', # String | If provided, will only return scorecards for this interview.
42
+ interviewer_id: 'interviewer_id_example', # String | If provided, will only return scorecards for this interviewer.
43
+ modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
44
+ modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
45
+ page_size: 56, # Integer | Number of results to return per page.
46
+ remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
47
+ }
48
+
49
+ begin
50
+
51
+ result = api_instance.scorecards_list(x_account_token, opts)
52
+ p result
53
+ rescue MergeATSClient::ApiError => e
54
+ puts "Error when calling ScorecardsApi->scorecards_list: #{e}"
55
+ end
56
+ ```
57
+
58
+ #### Using the scorecards_list_with_http_info variant
59
+
60
+ This returns an Array which contains the response data, status code and headers.
61
+
62
+ > <Array(<PaginatedScorecardList>, Integer, Hash)> scorecards_list_with_http_info(x_account_token, opts)
63
+
64
+ ```ruby
65
+ begin
66
+
67
+ data, status_code, headers = api_instance.scorecards_list_with_http_info(x_account_token, opts)
68
+ p status_code # => 2xx
69
+ p headers # => { ... }
70
+ p data # => <PaginatedScorecardList>
71
+ rescue MergeATSClient::ApiError => e
72
+ puts "Error when calling ScorecardsApi->scorecards_list_with_http_info: #{e}"
73
+ end
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Name | Type | Description | Notes |
79
+ | ---- | ---- | ----------- | ----- |
80
+ | **x_account_token** | **String** | Token identifying the end user. | |
81
+ | **application_id** | **String** | If provided, will only return scorecards for this application. | [optional] |
82
+ | **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
83
+ | **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
84
+ | **cursor** | **String** | The pagination cursor value. | [optional] |
85
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
86
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
87
+ | **interview_id** | **String** | If provided, will only return scorecards for this interview. | [optional] |
88
+ | **interviewer_id** | **String** | If provided, will only return scorecards for this interviewer. | [optional] |
89
+ | **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
90
+ | **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
91
+ | **page_size** | **Integer** | Number of results to return per page. | [optional] |
92
+ | **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
93
+
94
+ ### Return type
95
+
96
+ [**PaginatedScorecardList**](PaginatedScorecardList.md)
97
+
98
+ ### Authorization
99
+
100
+ [tokenAuth](../README.md#tokenAuth)
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+ ## scorecards_retrieve
109
+
110
+ > <Scorecard> scorecards_retrieve(x_account_token, id, opts)
111
+
112
+
113
+
114
+ Returns a `Scorecard` object with the given `id`.
115
+
116
+ ### Examples
117
+
118
+ ```ruby
119
+ require 'time'
120
+ require 'merge_ats_client'
121
+ # setup authorization
122
+ MergeATSClient.configure do |config|
123
+ # Configure API key authorization: tokenAuth
124
+ config.api_key['Authorization'] = 'YOUR API KEY'
125
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
126
+ # config.api_key_prefix['Authorization'] = 'Bearer'
127
+ end
128
+
129
+ api_instance = MergeATSClient::ScorecardsApi.new
130
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
131
+ id = TODO # String |
132
+ opts = {
133
+ expand: 'application', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
134
+ include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
135
+ }
136
+
137
+ begin
138
+
139
+ result = api_instance.scorecards_retrieve(x_account_token, id, opts)
140
+ p result
141
+ rescue MergeATSClient::ApiError => e
142
+ puts "Error when calling ScorecardsApi->scorecards_retrieve: #{e}"
143
+ end
144
+ ```
145
+
146
+ #### Using the scorecards_retrieve_with_http_info variant
147
+
148
+ This returns an Array which contains the response data, status code and headers.
149
+
150
+ > <Array(<Scorecard>, Integer, Hash)> scorecards_retrieve_with_http_info(x_account_token, id, opts)
151
+
152
+ ```ruby
153
+ begin
154
+
155
+ data, status_code, headers = api_instance.scorecards_retrieve_with_http_info(x_account_token, id, opts)
156
+ p status_code # => 2xx
157
+ p headers # => { ... }
158
+ p data # => <Scorecard>
159
+ rescue MergeATSClient::ApiError => e
160
+ puts "Error when calling ScorecardsApi->scorecards_retrieve_with_http_info: #{e}"
161
+ end
162
+ ```
163
+
164
+ ### Parameters
165
+
166
+ | Name | Type | Description | Notes |
167
+ | ---- | ---- | ----------- | ----- |
168
+ | **x_account_token** | **String** | Token identifying the end user. | |
169
+ | **id** | [**String**](.md) | | |
170
+ | **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
171
+ | **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
172
+
173
+ ### Return type
174
+
175
+ [**Scorecard**](Scorecard.md)
176
+
177
+ ### Authorization
178
+
179
+ [tokenAuth](../README.md#tokenAuth)
180
+
181
+ ### HTTP request headers
182
+
183
+ - **Content-Type**: Not defined
184
+ - **Accept**: application/json
185
+
@@ -0,0 +1,28 @@
1
+ # MergeATSClient::SyncStatus
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model_name** | **String** | | |
8
+ | **model_id** | **String** | | |
9
+ | **last_sync_start** | **Time** | | |
10
+ | **next_sync_start** | **Time** | | |
11
+ | **status** | **String** | | |
12
+ | **is_initial_sync** | **Boolean** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'merge_ats_client'
18
+
19
+ instance = MergeATSClient::SyncStatus.new(
20
+ model_name: Candidate,
21
+ model_id: ats.Candidate,
22
+ last_sync_start: 2021-03-30T19:44:18.695973Z,
23
+ next_sync_start: 2021-03-30T20:44:18.662942Z,
24
+ status: SYNCING,
25
+ is_initial_sync: true
26
+ )
27
+ ```
28
+
@@ -0,0 +1,79 @@
1
+ # MergeATSClient::SyncStatusApi
2
+
3
+ All URIs are relative to *https://api.merge.dev/api/ats/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**sync_status_retrieve**](SyncStatusApi.md#sync_status_retrieve) | **GET** /sync-status | |
8
+
9
+
10
+ ## sync_status_retrieve
11
+
12
+ > <SyncStatus> sync_status_retrieve(x_account_token)
13
+
14
+
15
+
16
+ Get syncing status.
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'merge_ats_client'
23
+ # setup authorization
24
+ MergeATSClient.configure do |config|
25
+ # Configure API key authorization: tokenAuth
26
+ config.api_key['Authorization'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ # config.api_key_prefix['Authorization'] = 'Bearer'
29
+ end
30
+
31
+ api_instance = MergeATSClient::SyncStatusApi.new
32
+ x_account_token = 'x_account_token_example' # String | Token identifying the end user.
33
+
34
+ begin
35
+
36
+ result = api_instance.sync_status_retrieve(x_account_token)
37
+ p result
38
+ rescue MergeATSClient::ApiError => e
39
+ puts "Error when calling SyncStatusApi->sync_status_retrieve: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the sync_status_retrieve_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(<SyncStatus>, Integer, Hash)> sync_status_retrieve_with_http_info(x_account_token)
48
+
49
+ ```ruby
50
+ begin
51
+
52
+ data, status_code, headers = api_instance.sync_status_retrieve_with_http_info(x_account_token)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <SyncStatus>
56
+ rescue MergeATSClient::ApiError => e
57
+ puts "Error when calling SyncStatusApi->sync_status_retrieve_with_http_info: #{e}"
58
+ end
59
+ ```
60
+
61
+ ### Parameters
62
+
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **x_account_token** | **String** | Token identifying the end user. | |
66
+
67
+ ### Return type
68
+
69
+ [**SyncStatus**](SyncStatus.md)
70
+
71
+ ### Authorization
72
+
73
+ [tokenAuth](../README.md#tokenAuth)
74
+
75
+ ### HTTP request headers
76
+
77
+ - **Content-Type**: Not defined
78
+ - **Accept**: application/json
79
+