@pescheckit/pescheck-client 0.0.5

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 (285) hide show
  1. package/.openapi-generator/FILES +97 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +200 -0
  5. package/dist/apis/AuthenticationApi.d.ts +131 -0
  6. package/dist/apis/AuthenticationApi.js +168 -0
  7. package/dist/apis/ChecksApi.d.ts +91 -0
  8. package/dist/apis/ChecksApi.js +116 -0
  9. package/dist/apis/DivisionsApi.d.ts +211 -0
  10. package/dist/apis/DivisionsApi.js +264 -0
  11. package/dist/apis/OAuthApi.d.ts +124 -0
  12. package/dist/apis/OAuthApi.js +159 -0
  13. package/dist/apis/ProfilesApi.d.ts +270 -0
  14. package/dist/apis/ProfilesApi.js +334 -0
  15. package/dist/apis/ScreeningsApi.d.ts +172 -0
  16. package/dist/apis/ScreeningsApi.js +216 -0
  17. package/dist/apis/WebhooksApi.d.ts +168 -0
  18. package/dist/apis/WebhooksApi.js +213 -0
  19. package/dist/apis/index.d.ts +7 -0
  20. package/dist/apis/index.js +25 -0
  21. package/dist/esm/apis/AuthenticationApi.d.ts +131 -0
  22. package/dist/esm/apis/AuthenticationApi.js +164 -0
  23. package/dist/esm/apis/ChecksApi.d.ts +91 -0
  24. package/dist/esm/apis/ChecksApi.js +112 -0
  25. package/dist/esm/apis/DivisionsApi.d.ts +211 -0
  26. package/dist/esm/apis/DivisionsApi.js +260 -0
  27. package/dist/esm/apis/OAuthApi.d.ts +124 -0
  28. package/dist/esm/apis/OAuthApi.js +155 -0
  29. package/dist/esm/apis/ProfilesApi.d.ts +270 -0
  30. package/dist/esm/apis/ProfilesApi.js +330 -0
  31. package/dist/esm/apis/ScreeningsApi.d.ts +172 -0
  32. package/dist/esm/apis/ScreeningsApi.js +212 -0
  33. package/dist/esm/apis/WebhooksApi.d.ts +168 -0
  34. package/dist/esm/apis/WebhooksApi.js +209 -0
  35. package/dist/esm/apis/index.d.ts +7 -0
  36. package/dist/esm/apis/index.js +9 -0
  37. package/dist/esm/index.d.ts +3 -0
  38. package/dist/esm/index.js +5 -0
  39. package/dist/esm/models/CustomTokenObtainPair.d.ts +38 -0
  40. package/dist/esm/models/CustomTokenObtainPair.js +47 -0
  41. package/dist/esm/models/DivisionReadOnly.d.ts +116 -0
  42. package/dist/esm/models/DivisionReadOnly.js +73 -0
  43. package/dist/esm/models/DivisionWrite.d.ts +98 -0
  44. package/dist/esm/models/DivisionWrite.js +78 -0
  45. package/dist/esm/models/JWTGeneration.d.ts +50 -0
  46. package/dist/esm/models/JWTGeneration.js +51 -0
  47. package/dist/esm/models/JWTResponse.d.ts +62 -0
  48. package/dist/esm/models/JWTResponse.js +61 -0
  49. package/dist/esm/models/OAuthApplication.d.ts +84 -0
  50. package/dist/esm/models/OAuthApplication.js +68 -0
  51. package/dist/esm/models/OAuthApplicationResponse.d.ts +98 -0
  52. package/dist/esm/models/OAuthApplicationResponse.js +80 -0
  53. package/dist/esm/models/PaginatedDivisionReadOnlyList.d.ts +51 -0
  54. package/dist/esm/models/PaginatedDivisionReadOnlyList.js +56 -0
  55. package/dist/esm/models/PaginatedV2ProfileListItemList.d.ts +51 -0
  56. package/dist/esm/models/PaginatedV2ProfileListItemList.js +56 -0
  57. package/dist/esm/models/PaginatedV2ScreeningListItemList.d.ts +51 -0
  58. package/dist/esm/models/PaginatedV2ScreeningListItemList.js +56 -0
  59. package/dist/esm/models/PatchedDivisionWrite.d.ts +98 -0
  60. package/dist/esm/models/PatchedDivisionWrite.js +62 -0
  61. package/dist/esm/models/PatchedV2ProfilePartialUpdate.d.ts +39 -0
  62. package/dist/esm/models/PatchedV2ProfilePartialUpdate.js +43 -0
  63. package/dist/esm/models/TokenRefresh.d.ts +38 -0
  64. package/dist/esm/models/TokenRefresh.js +44 -0
  65. package/dist/esm/models/V2Candidate.d.ts +592 -0
  66. package/dist/esm/models/V2Candidate.js +318 -0
  67. package/dist/esm/models/V2CheckField.d.ts +56 -0
  68. package/dist/esm/models/V2CheckField.js +53 -0
  69. package/dist/esm/models/V2CheckInfo.d.ts +100 -0
  70. package/dist/esm/models/V2CheckInfo.js +76 -0
  71. package/dist/esm/models/V2Document.d.ts +115 -0
  72. package/dist/esm/models/V2Document.js +84 -0
  73. package/dist/esm/models/V2DocumentContent.d.ts +40 -0
  74. package/dist/esm/models/V2DocumentContent.js +45 -0
  75. package/dist/esm/models/V2Money.d.ts +38 -0
  76. package/dist/esm/models/V2Money.js +47 -0
  77. package/dist/esm/models/V2ProfileCheck.d.ts +85 -0
  78. package/dist/esm/models/V2ProfileCheck.js +68 -0
  79. package/dist/esm/models/V2ProfileCheckEntry.d.ts +120 -0
  80. package/dist/esm/models/V2ProfileCheckEntry.js +87 -0
  81. package/dist/esm/models/V2ProfileCreate.d.ts +45 -0
  82. package/dist/esm/models/V2ProfileCreate.js +50 -0
  83. package/dist/esm/models/V2ProfileDetail.d.ts +94 -0
  84. package/dist/esm/models/V2ProfileDetail.js +75 -0
  85. package/dist/esm/models/V2ProfileListItem.d.ts +68 -0
  86. package/dist/esm/models/V2ProfileListItem.js +61 -0
  87. package/dist/esm/models/V2ProfileUpdate.d.ts +47 -0
  88. package/dist/esm/models/V2ProfileUpdate.js +50 -0
  89. package/dist/esm/models/V2ProfileUpdateCheck.d.ts +96 -0
  90. package/dist/esm/models/V2ProfileUpdateCheck.js +74 -0
  91. package/dist/esm/models/V2ScreeningCheck.d.ts +95 -0
  92. package/dist/esm/models/V2ScreeningCheck.js +72 -0
  93. package/dist/esm/models/V2ScreeningCheckEntry.d.ts +135 -0
  94. package/dist/esm/models/V2ScreeningCheckEntry.js +92 -0
  95. package/dist/esm/models/V2ScreeningCheckListItem.d.ts +93 -0
  96. package/dist/esm/models/V2ScreeningCheckListItem.js +74 -0
  97. package/dist/esm/models/V2ScreeningCreate.d.ts +46 -0
  98. package/dist/esm/models/V2ScreeningCreate.js +51 -0
  99. package/dist/esm/models/V2ScreeningDetail.d.ts +83 -0
  100. package/dist/esm/models/V2ScreeningDetail.js +70 -0
  101. package/dist/esm/models/V2ScreeningDetailProfile.d.ts +38 -0
  102. package/dist/esm/models/V2ScreeningDetailProfile.js +43 -0
  103. package/dist/esm/models/V2ScreeningListItem.d.ts +85 -0
  104. package/dist/esm/models/V2ScreeningListItem.js +69 -0
  105. package/dist/esm/models/VerifyWebhook.d.ts +34 -0
  106. package/dist/esm/models/VerifyWebhook.js +43 -0
  107. package/dist/esm/models/Webhook.d.ts +71 -0
  108. package/dist/esm/models/Webhook.js +69 -0
  109. package/dist/esm/models/WebhookResponse.d.ts +87 -0
  110. package/dist/esm/models/WebhookResponse.js +51 -0
  111. package/dist/esm/models/index.d.ts +36 -0
  112. package/dist/esm/models/index.js +38 -0
  113. package/dist/esm/runtime.d.ts +184 -0
  114. package/dist/esm/runtime.js +349 -0
  115. package/dist/index.d.ts +3 -0
  116. package/dist/index.js +21 -0
  117. package/dist/models/CustomTokenObtainPair.d.ts +38 -0
  118. package/dist/models/CustomTokenObtainPair.js +54 -0
  119. package/dist/models/DivisionReadOnly.d.ts +116 -0
  120. package/dist/models/DivisionReadOnly.js +80 -0
  121. package/dist/models/DivisionWrite.d.ts +98 -0
  122. package/dist/models/DivisionWrite.js +85 -0
  123. package/dist/models/JWTGeneration.d.ts +50 -0
  124. package/dist/models/JWTGeneration.js +58 -0
  125. package/dist/models/JWTResponse.d.ts +62 -0
  126. package/dist/models/JWTResponse.js +68 -0
  127. package/dist/models/OAuthApplication.d.ts +84 -0
  128. package/dist/models/OAuthApplication.js +76 -0
  129. package/dist/models/OAuthApplicationResponse.d.ts +98 -0
  130. package/dist/models/OAuthApplicationResponse.js +88 -0
  131. package/dist/models/PaginatedDivisionReadOnlyList.d.ts +51 -0
  132. package/dist/models/PaginatedDivisionReadOnlyList.js +63 -0
  133. package/dist/models/PaginatedV2ProfileListItemList.d.ts +51 -0
  134. package/dist/models/PaginatedV2ProfileListItemList.js +63 -0
  135. package/dist/models/PaginatedV2ScreeningListItemList.d.ts +51 -0
  136. package/dist/models/PaginatedV2ScreeningListItemList.js +63 -0
  137. package/dist/models/PatchedDivisionWrite.d.ts +98 -0
  138. package/dist/models/PatchedDivisionWrite.js +69 -0
  139. package/dist/models/PatchedV2ProfilePartialUpdate.d.ts +39 -0
  140. package/dist/models/PatchedV2ProfilePartialUpdate.js +50 -0
  141. package/dist/models/TokenRefresh.d.ts +38 -0
  142. package/dist/models/TokenRefresh.js +51 -0
  143. package/dist/models/V2Candidate.d.ts +592 -0
  144. package/dist/models/V2Candidate.js +326 -0
  145. package/dist/models/V2CheckField.d.ts +56 -0
  146. package/dist/models/V2CheckField.js +60 -0
  147. package/dist/models/V2CheckInfo.d.ts +100 -0
  148. package/dist/models/V2CheckInfo.js +83 -0
  149. package/dist/models/V2Document.d.ts +115 -0
  150. package/dist/models/V2Document.js +92 -0
  151. package/dist/models/V2DocumentContent.d.ts +40 -0
  152. package/dist/models/V2DocumentContent.js +52 -0
  153. package/dist/models/V2Money.d.ts +38 -0
  154. package/dist/models/V2Money.js +54 -0
  155. package/dist/models/V2ProfileCheck.d.ts +85 -0
  156. package/dist/models/V2ProfileCheck.js +76 -0
  157. package/dist/models/V2ProfileCheckEntry.d.ts +120 -0
  158. package/dist/models/V2ProfileCheckEntry.js +95 -0
  159. package/dist/models/V2ProfileCreate.d.ts +45 -0
  160. package/dist/models/V2ProfileCreate.js +57 -0
  161. package/dist/models/V2ProfileDetail.d.ts +94 -0
  162. package/dist/models/V2ProfileDetail.js +82 -0
  163. package/dist/models/V2ProfileListItem.d.ts +68 -0
  164. package/dist/models/V2ProfileListItem.js +68 -0
  165. package/dist/models/V2ProfileUpdate.d.ts +47 -0
  166. package/dist/models/V2ProfileUpdate.js +57 -0
  167. package/dist/models/V2ProfileUpdateCheck.d.ts +96 -0
  168. package/dist/models/V2ProfileUpdateCheck.js +82 -0
  169. package/dist/models/V2ScreeningCheck.d.ts +95 -0
  170. package/dist/models/V2ScreeningCheck.js +80 -0
  171. package/dist/models/V2ScreeningCheckEntry.d.ts +135 -0
  172. package/dist/models/V2ScreeningCheckEntry.js +100 -0
  173. package/dist/models/V2ScreeningCheckListItem.d.ts +93 -0
  174. package/dist/models/V2ScreeningCheckListItem.js +82 -0
  175. package/dist/models/V2ScreeningCreate.d.ts +46 -0
  176. package/dist/models/V2ScreeningCreate.js +58 -0
  177. package/dist/models/V2ScreeningDetail.d.ts +83 -0
  178. package/dist/models/V2ScreeningDetail.js +77 -0
  179. package/dist/models/V2ScreeningDetailProfile.d.ts +38 -0
  180. package/dist/models/V2ScreeningDetailProfile.js +50 -0
  181. package/dist/models/V2ScreeningListItem.d.ts +85 -0
  182. package/dist/models/V2ScreeningListItem.js +76 -0
  183. package/dist/models/VerifyWebhook.d.ts +34 -0
  184. package/dist/models/VerifyWebhook.js +50 -0
  185. package/dist/models/Webhook.d.ts +71 -0
  186. package/dist/models/Webhook.js +77 -0
  187. package/dist/models/WebhookResponse.d.ts +87 -0
  188. package/dist/models/WebhookResponse.js +58 -0
  189. package/dist/models/index.d.ts +36 -0
  190. package/dist/models/index.js +54 -0
  191. package/dist/runtime.d.ts +184 -0
  192. package/dist/runtime.js +365 -0
  193. package/docs/AuthenticationApi.md +227 -0
  194. package/docs/ChecksApi.md +150 -0
  195. package/docs/CustomTokenObtainPair.md +37 -0
  196. package/docs/DivisionReadOnly.md +62 -0
  197. package/docs/DivisionWrite.md +56 -0
  198. package/docs/DivisionsApi.md +380 -0
  199. package/docs/JWTGeneration.md +41 -0
  200. package/docs/JWTResponse.md +45 -0
  201. package/docs/OAuthApi.md +222 -0
  202. package/docs/OAuthApplication.md +43 -0
  203. package/docs/OAuthApplicationResponse.md +49 -0
  204. package/docs/PaginatedDivisionReadOnlyList.md +40 -0
  205. package/docs/PaginatedV2ProfileListItemList.md +40 -0
  206. package/docs/PaginatedV2ScreeningListItemList.md +40 -0
  207. package/docs/PatchedDivisionWrite.md +56 -0
  208. package/docs/PatchedV2ProfilePartialUpdate.md +37 -0
  209. package/docs/ProfilesApi.md +456 -0
  210. package/docs/ScreeningsApi.md +302 -0
  211. package/docs/TokenRefresh.md +36 -0
  212. package/docs/V2Candidate.md +53 -0
  213. package/docs/V2CheckField.md +43 -0
  214. package/docs/V2CheckInfo.md +57 -0
  215. package/docs/V2Document.md +45 -0
  216. package/docs/V2DocumentContent.md +37 -0
  217. package/docs/V2Money.md +36 -0
  218. package/docs/V2ProfileCheck.md +37 -0
  219. package/docs/V2ProfileCheckEntry.md +46 -0
  220. package/docs/V2ProfileCreate.md +38 -0
  221. package/docs/V2ProfileDetail.md +54 -0
  222. package/docs/V2ProfileListItem.md +46 -0
  223. package/docs/V2ProfileUpdate.md +39 -0
  224. package/docs/V2ProfileUpdateCheck.md +39 -0
  225. package/docs/V2ScreeningCheck.md +41 -0
  226. package/docs/V2ScreeningCheckEntry.md +50 -0
  227. package/docs/V2ScreeningCheckListItem.md +39 -0
  228. package/docs/V2ScreeningCreate.md +38 -0
  229. package/docs/V2ScreeningDetail.md +50 -0
  230. package/docs/V2ScreeningDetailProfile.md +36 -0
  231. package/docs/V2ScreeningListItem.md +51 -0
  232. package/docs/VerifyWebhook.md +35 -0
  233. package/docs/Webhook.md +43 -0
  234. package/docs/WebhookResponse.md +53 -0
  235. package/docs/WebhooksApi.md +305 -0
  236. package/package.json +25 -0
  237. package/src/apis/AuthenticationApi.ts +285 -0
  238. package/src/apis/ChecksApi.ts +181 -0
  239. package/src/apis/DivisionsApi.ts +462 -0
  240. package/src/apis/OAuthApi.ts +256 -0
  241. package/src/apis/ProfilesApi.ts +583 -0
  242. package/src/apis/ScreeningsApi.ts +376 -0
  243. package/src/apis/WebhooksApi.ts +363 -0
  244. package/src/apis/index.ts +9 -0
  245. package/src/index.ts +5 -0
  246. package/src/models/CustomTokenObtainPair.ts +75 -0
  247. package/src/models/DivisionReadOnly.ts +177 -0
  248. package/src/models/DivisionWrite.ts +160 -0
  249. package/src/models/JWTGeneration.ts +91 -0
  250. package/src/models/JWTResponse.ts +110 -0
  251. package/src/models/OAuthApplication.ts +130 -0
  252. package/src/models/OAuthApplicationResponse.ts +151 -0
  253. package/src/models/PaginatedDivisionReadOnlyList.ts +101 -0
  254. package/src/models/PaginatedV2ProfileListItemList.ts +101 -0
  255. package/src/models/PaginatedV2ScreeningListItemList.ts +101 -0
  256. package/src/models/PatchedDivisionWrite.ts +152 -0
  257. package/src/models/PatchedV2ProfilePartialUpdate.ts +74 -0
  258. package/src/models/TokenRefresh.ts +73 -0
  259. package/src/models/V2Candidate.ts +649 -0
  260. package/src/models/V2CheckField.ts +97 -0
  261. package/src/models/V2CheckInfo.ts +168 -0
  262. package/src/models/V2Document.ts +166 -0
  263. package/src/models/V2DocumentContent.ts +76 -0
  264. package/src/models/V2Money.ts +75 -0
  265. package/src/models/V2ProfileCheck.ts +122 -0
  266. package/src/models/V2ProfileCheckEntry.ts +173 -0
  267. package/src/models/V2ProfileCreate.ts +91 -0
  268. package/src/models/V2ProfileDetail.ts +162 -0
  269. package/src/models/V2ProfileListItem.ts +115 -0
  270. package/src/models/V2ProfileUpdate.ts +93 -0
  271. package/src/models/V2ProfileUpdateCheck.ts +135 -0
  272. package/src/models/V2ScreeningCheck.ts +136 -0
  273. package/src/models/V2ScreeningCheckEntry.ts +181 -0
  274. package/src/models/V2ScreeningCheckListItem.ts +133 -0
  275. package/src/models/V2ScreeningCreate.ts +98 -0
  276. package/src/models/V2ScreeningDetail.ts +152 -0
  277. package/src/models/V2ScreeningDetailProfile.ts +73 -0
  278. package/src/models/V2ScreeningListItem.ts +154 -0
  279. package/src/models/VerifyWebhook.ts +68 -0
  280. package/src/models/Webhook.ts +118 -0
  281. package/src/models/WebhookResponse.ts +140 -0
  282. package/src/models/index.ts +38 -0
  283. package/src/runtime.ts +449 -0
  284. package/tsconfig.esm.json +7 -0
  285. package/tsconfig.json +16 -0
@@ -0,0 +1,583 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Pescheck API
5
+ * Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type PaginatedV2ProfileListItemList,
18
+ PaginatedV2ProfileListItemListFromJSON,
19
+ PaginatedV2ProfileListItemListToJSON,
20
+ } from '../models/PaginatedV2ProfileListItemList';
21
+ import {
22
+ type PatchedV2ProfilePartialUpdate,
23
+ PatchedV2ProfilePartialUpdateFromJSON,
24
+ PatchedV2ProfilePartialUpdateToJSON,
25
+ } from '../models/PatchedV2ProfilePartialUpdate';
26
+ import {
27
+ type V2ProfileCreate,
28
+ V2ProfileCreateFromJSON,
29
+ V2ProfileCreateToJSON,
30
+ } from '../models/V2ProfileCreate';
31
+ import {
32
+ type V2ProfileDetail,
33
+ V2ProfileDetailFromJSON,
34
+ V2ProfileDetailToJSON,
35
+ } from '../models/V2ProfileDetail';
36
+ import {
37
+ type V2ProfileUpdate,
38
+ V2ProfileUpdateFromJSON,
39
+ V2ProfileUpdateToJSON,
40
+ } from '../models/V2ProfileUpdate';
41
+
42
+ export interface V2ProfilesCreateRequest {
43
+ v2ProfileCreate: V2ProfileCreate;
44
+ }
45
+
46
+ export interface V2ProfilesDestroyRequest {
47
+ id: string;
48
+ }
49
+
50
+ export interface V2ProfilesListRequest {
51
+ checkType?: V2ProfilesListCheckTypeEnum;
52
+ isCustom?: boolean;
53
+ name?: string;
54
+ page?: number;
55
+ pageSize?: number;
56
+ paginate?: boolean;
57
+ sort?: string;
58
+ }
59
+
60
+ export interface V2ProfilesPartialUpdateRequest {
61
+ id: string;
62
+ patchedV2ProfilePartialUpdate?: PatchedV2ProfilePartialUpdate;
63
+ }
64
+
65
+ export interface V2ProfilesRetrieveRequest {
66
+ id: string;
67
+ }
68
+
69
+ export interface V2ProfilesUpdateRequest {
70
+ id: string;
71
+ v2ProfileUpdate: V2ProfileUpdate;
72
+ }
73
+
74
+ /**
75
+ * ProfilesApi - interface
76
+ *
77
+ * @export
78
+ * @interface ProfilesApiInterface
79
+ */
80
+ export interface ProfilesApiInterface {
81
+ /**
82
+ * Creates request options for v2ProfilesCreate without sending the request
83
+ * @param {V2ProfileCreate} v2ProfileCreate
84
+ * @throws {RequiredError}
85
+ * @memberof ProfilesApiInterface
86
+ */
87
+ v2ProfilesCreateRequestOpts(requestParameters: V2ProfilesCreateRequest): Promise<runtime.RequestOpts>;
88
+
89
+ /**
90
+ *
91
+ * @param {V2ProfileCreate} v2ProfileCreate
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ * @memberof ProfilesApiInterface
95
+ */
96
+ v2ProfilesCreateRaw(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
97
+
98
+ /**
99
+ */
100
+ v2ProfilesCreate(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
101
+
102
+ /**
103
+ * Creates request options for v2ProfilesDestroy without sending the request
104
+ * @param {string} id A UUID string identifying this profile.
105
+ * @throws {RequiredError}
106
+ * @memberof ProfilesApiInterface
107
+ */
108
+ v2ProfilesDestroyRequestOpts(requestParameters: V2ProfilesDestroyRequest): Promise<runtime.RequestOpts>;
109
+
110
+ /**
111
+ *
112
+ * @param {string} id A UUID string identifying this profile.
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ * @memberof ProfilesApiInterface
116
+ */
117
+ v2ProfilesDestroyRaw(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
118
+
119
+ /**
120
+ */
121
+ v2ProfilesDestroy(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
122
+
123
+ /**
124
+ * Creates request options for v2ProfilesList without sending the request
125
+ * @param {'addresscheck' | 'adversemediacheck' | 'bigcheck' | 'criminalrecordscheck' | 'criminalrecordsuploadcheck' | 'customintegritycheck' | 'cvcheck' | 'edrcheck' | 'id2check' | 'integritycheck' | 'openhealthcarecheck' | 'qualificationcheck' | 'righttoworkcheck' | 'vogcheck' | 'watchlist2check' | 'watchlistcheck' | 'workreferencecheck' | 'worldwidecreditcheck'} [checkType] Restrict to profiles containing at least one check of this type.
126
+ * @param {boolean} [isCustom] Restrict to custom (true) or system (false) profiles.
127
+ * @param {string} [name] Restrict to profiles whose name contains this value (case-insensitive).
128
+ * @param {number} [page] A page number within the paginated result set.
129
+ * @param {number} [pageSize] Number of results to return per page.
130
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
131
+ * @param {string} [sort] Which field to use when ordering the results.
132
+ * @throws {RequiredError}
133
+ * @memberof ProfilesApiInterface
134
+ */
135
+ v2ProfilesListRequestOpts(requestParameters: V2ProfilesListRequest): Promise<runtime.RequestOpts>;
136
+
137
+ /**
138
+ *
139
+ * @param {'addresscheck' | 'adversemediacheck' | 'bigcheck' | 'criminalrecordscheck' | 'criminalrecordsuploadcheck' | 'customintegritycheck' | 'cvcheck' | 'edrcheck' | 'id2check' | 'integritycheck' | 'openhealthcarecheck' | 'qualificationcheck' | 'righttoworkcheck' | 'vogcheck' | 'watchlist2check' | 'watchlistcheck' | 'workreferencecheck' | 'worldwidecreditcheck'} [checkType] Restrict to profiles containing at least one check of this type.
140
+ * @param {boolean} [isCustom] Restrict to custom (true) or system (false) profiles.
141
+ * @param {string} [name] Restrict to profiles whose name contains this value (case-insensitive).
142
+ * @param {number} [page] A page number within the paginated result set.
143
+ * @param {number} [pageSize] Number of results to return per page.
144
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
145
+ * @param {string} [sort] Which field to use when ordering the results.
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ * @memberof ProfilesApiInterface
149
+ */
150
+ v2ProfilesListRaw(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ProfileListItemList>>;
151
+
152
+ /**
153
+ */
154
+ v2ProfilesList(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ProfileListItemList>;
155
+
156
+ /**
157
+ * Creates request options for v2ProfilesPartialUpdate without sending the request
158
+ * @param {string} id A UUID string identifying this profile.
159
+ * @param {PatchedV2ProfilePartialUpdate} [patchedV2ProfilePartialUpdate]
160
+ * @throws {RequiredError}
161
+ * @memberof ProfilesApiInterface
162
+ */
163
+ v2ProfilesPartialUpdateRequestOpts(requestParameters: V2ProfilesPartialUpdateRequest): Promise<runtime.RequestOpts>;
164
+
165
+ /**
166
+ * Update name and/or description only. Use PUT to change the check list.
167
+ * @param {string} id A UUID string identifying this profile.
168
+ * @param {PatchedV2ProfilePartialUpdate} [patchedV2ProfilePartialUpdate]
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ * @memberof ProfilesApiInterface
172
+ */
173
+ v2ProfilesPartialUpdateRaw(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
174
+
175
+ /**
176
+ * Update name and/or description only. Use PUT to change the check list.
177
+ */
178
+ v2ProfilesPartialUpdate(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
179
+
180
+ /**
181
+ * Creates request options for v2ProfilesRetrieve without sending the request
182
+ * @param {string} id A UUID string identifying this profile.
183
+ * @throws {RequiredError}
184
+ * @memberof ProfilesApiInterface
185
+ */
186
+ v2ProfilesRetrieveRequestOpts(requestParameters: V2ProfilesRetrieveRequest): Promise<runtime.RequestOpts>;
187
+
188
+ /**
189
+ *
190
+ * @param {string} id A UUID string identifying this profile.
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ * @memberof ProfilesApiInterface
194
+ */
195
+ v2ProfilesRetrieveRaw(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
196
+
197
+ /**
198
+ */
199
+ v2ProfilesRetrieve(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
200
+
201
+ /**
202
+ * Creates request options for v2ProfilesUpdate without sending the request
203
+ * @param {string} id A UUID string identifying this profile.
204
+ * @param {V2ProfileUpdate} v2ProfileUpdate
205
+ * @throws {RequiredError}
206
+ * @memberof ProfilesApiInterface
207
+ */
208
+ v2ProfilesUpdateRequestOpts(requestParameters: V2ProfilesUpdateRequest): Promise<runtime.RequestOpts>;
209
+
210
+ /**
211
+ * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
212
+ * @param {string} id A UUID string identifying this profile.
213
+ * @param {V2ProfileUpdate} v2ProfileUpdate
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ * @memberof ProfilesApiInterface
217
+ */
218
+ v2ProfilesUpdateRaw(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
219
+
220
+ /**
221
+ * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
222
+ */
223
+ v2ProfilesUpdate(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
224
+
225
+ }
226
+
227
+ /**
228
+ *
229
+ */
230
+ export class ProfilesApi extends runtime.BaseAPI implements ProfilesApiInterface {
231
+
232
+ /**
233
+ * Creates request options for v2ProfilesCreate without sending the request
234
+ */
235
+ async v2ProfilesCreateRequestOpts(requestParameters: V2ProfilesCreateRequest): Promise<runtime.RequestOpts> {
236
+ if (requestParameters['v2ProfileCreate'] == null) {
237
+ throw new runtime.RequiredError(
238
+ 'v2ProfileCreate',
239
+ 'Required parameter "v2ProfileCreate" was null or undefined when calling v2ProfilesCreate().'
240
+ );
241
+ }
242
+
243
+ const queryParameters: any = {};
244
+
245
+ const headerParameters: runtime.HTTPHeaders = {};
246
+
247
+ headerParameters['Content-Type'] = 'application/json';
248
+
249
+ if (this.configuration && this.configuration.accessToken) {
250
+ // oauth required
251
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
252
+ }
253
+
254
+
255
+ let urlPath = `/api/v2/profiles/`;
256
+
257
+ return {
258
+ path: urlPath,
259
+ method: 'POST',
260
+ headers: headerParameters,
261
+ query: queryParameters,
262
+ body: V2ProfileCreateToJSON(requestParameters['v2ProfileCreate']),
263
+ };
264
+ }
265
+
266
+ /**
267
+ */
268
+ async v2ProfilesCreateRaw(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>> {
269
+ const requestOptions = await this.v2ProfilesCreateRequestOpts(requestParameters);
270
+ const response = await this.request(requestOptions, initOverrides);
271
+
272
+ return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
273
+ }
274
+
275
+ /**
276
+ */
277
+ async v2ProfilesCreate(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail> {
278
+ const response = await this.v2ProfilesCreateRaw(requestParameters, initOverrides);
279
+ return await response.value();
280
+ }
281
+
282
+ /**
283
+ * Creates request options for v2ProfilesDestroy without sending the request
284
+ */
285
+ async v2ProfilesDestroyRequestOpts(requestParameters: V2ProfilesDestroyRequest): Promise<runtime.RequestOpts> {
286
+ if (requestParameters['id'] == null) {
287
+ throw new runtime.RequiredError(
288
+ 'id',
289
+ 'Required parameter "id" was null or undefined when calling v2ProfilesDestroy().'
290
+ );
291
+ }
292
+
293
+ const queryParameters: any = {};
294
+
295
+ const headerParameters: runtime.HTTPHeaders = {};
296
+
297
+ if (this.configuration && this.configuration.accessToken) {
298
+ // oauth required
299
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
300
+ }
301
+
302
+
303
+ let urlPath = `/api/v2/profiles/{id}/`;
304
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
305
+
306
+ return {
307
+ path: urlPath,
308
+ method: 'DELETE',
309
+ headers: headerParameters,
310
+ query: queryParameters,
311
+ };
312
+ }
313
+
314
+ /**
315
+ */
316
+ async v2ProfilesDestroyRaw(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
317
+ const requestOptions = await this.v2ProfilesDestroyRequestOpts(requestParameters);
318
+ const response = await this.request(requestOptions, initOverrides);
319
+
320
+ return new runtime.VoidApiResponse(response);
321
+ }
322
+
323
+ /**
324
+ */
325
+ async v2ProfilesDestroy(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
326
+ await this.v2ProfilesDestroyRaw(requestParameters, initOverrides);
327
+ }
328
+
329
+ /**
330
+ * Creates request options for v2ProfilesList without sending the request
331
+ */
332
+ async v2ProfilesListRequestOpts(requestParameters: V2ProfilesListRequest): Promise<runtime.RequestOpts> {
333
+ const queryParameters: any = {};
334
+
335
+ if (requestParameters['checkType'] != null) {
336
+ queryParameters['check_type'] = requestParameters['checkType'];
337
+ }
338
+
339
+ if (requestParameters['isCustom'] != null) {
340
+ queryParameters['is_custom'] = requestParameters['isCustom'];
341
+ }
342
+
343
+ if (requestParameters['name'] != null) {
344
+ queryParameters['name'] = requestParameters['name'];
345
+ }
346
+
347
+ if (requestParameters['page'] != null) {
348
+ queryParameters['page'] = requestParameters['page'];
349
+ }
350
+
351
+ if (requestParameters['pageSize'] != null) {
352
+ queryParameters['page_size'] = requestParameters['pageSize'];
353
+ }
354
+
355
+ if (requestParameters['paginate'] != null) {
356
+ queryParameters['paginate'] = requestParameters['paginate'];
357
+ }
358
+
359
+ if (requestParameters['sort'] != null) {
360
+ queryParameters['sort'] = requestParameters['sort'];
361
+ }
362
+
363
+ const headerParameters: runtime.HTTPHeaders = {};
364
+
365
+ if (this.configuration && this.configuration.accessToken) {
366
+ // oauth required
367
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
368
+ }
369
+
370
+
371
+ let urlPath = `/api/v2/profiles/`;
372
+
373
+ return {
374
+ path: urlPath,
375
+ method: 'GET',
376
+ headers: headerParameters,
377
+ query: queryParameters,
378
+ };
379
+ }
380
+
381
+ /**
382
+ */
383
+ async v2ProfilesListRaw(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ProfileListItemList>> {
384
+ const requestOptions = await this.v2ProfilesListRequestOpts(requestParameters);
385
+ const response = await this.request(requestOptions, initOverrides);
386
+
387
+ return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedV2ProfileListItemListFromJSON(jsonValue));
388
+ }
389
+
390
+ /**
391
+ */
392
+ async v2ProfilesList(requestParameters: V2ProfilesListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ProfileListItemList> {
393
+ const response = await this.v2ProfilesListRaw(requestParameters, initOverrides);
394
+ return await response.value();
395
+ }
396
+
397
+ /**
398
+ * Creates request options for v2ProfilesPartialUpdate without sending the request
399
+ */
400
+ async v2ProfilesPartialUpdateRequestOpts(requestParameters: V2ProfilesPartialUpdateRequest): Promise<runtime.RequestOpts> {
401
+ if (requestParameters['id'] == null) {
402
+ throw new runtime.RequiredError(
403
+ 'id',
404
+ 'Required parameter "id" was null or undefined when calling v2ProfilesPartialUpdate().'
405
+ );
406
+ }
407
+
408
+ const queryParameters: any = {};
409
+
410
+ const headerParameters: runtime.HTTPHeaders = {};
411
+
412
+ headerParameters['Content-Type'] = 'application/json';
413
+
414
+ if (this.configuration && this.configuration.accessToken) {
415
+ // oauth required
416
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
417
+ }
418
+
419
+
420
+ let urlPath = `/api/v2/profiles/{id}/`;
421
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
422
+
423
+ return {
424
+ path: urlPath,
425
+ method: 'PATCH',
426
+ headers: headerParameters,
427
+ query: queryParameters,
428
+ body: PatchedV2ProfilePartialUpdateToJSON(requestParameters['patchedV2ProfilePartialUpdate']),
429
+ };
430
+ }
431
+
432
+ /**
433
+ * Update name and/or description only. Use PUT to change the check list.
434
+ */
435
+ async v2ProfilesPartialUpdateRaw(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>> {
436
+ const requestOptions = await this.v2ProfilesPartialUpdateRequestOpts(requestParameters);
437
+ const response = await this.request(requestOptions, initOverrides);
438
+
439
+ return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
440
+ }
441
+
442
+ /**
443
+ * Update name and/or description only. Use PUT to change the check list.
444
+ */
445
+ async v2ProfilesPartialUpdate(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail> {
446
+ const response = await this.v2ProfilesPartialUpdateRaw(requestParameters, initOverrides);
447
+ return await response.value();
448
+ }
449
+
450
+ /**
451
+ * Creates request options for v2ProfilesRetrieve without sending the request
452
+ */
453
+ async v2ProfilesRetrieveRequestOpts(requestParameters: V2ProfilesRetrieveRequest): Promise<runtime.RequestOpts> {
454
+ if (requestParameters['id'] == null) {
455
+ throw new runtime.RequiredError(
456
+ 'id',
457
+ 'Required parameter "id" was null or undefined when calling v2ProfilesRetrieve().'
458
+ );
459
+ }
460
+
461
+ const queryParameters: any = {};
462
+
463
+ const headerParameters: runtime.HTTPHeaders = {};
464
+
465
+ if (this.configuration && this.configuration.accessToken) {
466
+ // oauth required
467
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
468
+ }
469
+
470
+
471
+ let urlPath = `/api/v2/profiles/{id}/`;
472
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
473
+
474
+ return {
475
+ path: urlPath,
476
+ method: 'GET',
477
+ headers: headerParameters,
478
+ query: queryParameters,
479
+ };
480
+ }
481
+
482
+ /**
483
+ */
484
+ async v2ProfilesRetrieveRaw(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>> {
485
+ const requestOptions = await this.v2ProfilesRetrieveRequestOpts(requestParameters);
486
+ const response = await this.request(requestOptions, initOverrides);
487
+
488
+ return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
489
+ }
490
+
491
+ /**
492
+ */
493
+ async v2ProfilesRetrieve(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail> {
494
+ const response = await this.v2ProfilesRetrieveRaw(requestParameters, initOverrides);
495
+ return await response.value();
496
+ }
497
+
498
+ /**
499
+ * Creates request options for v2ProfilesUpdate without sending the request
500
+ */
501
+ async v2ProfilesUpdateRequestOpts(requestParameters: V2ProfilesUpdateRequest): Promise<runtime.RequestOpts> {
502
+ if (requestParameters['id'] == null) {
503
+ throw new runtime.RequiredError(
504
+ 'id',
505
+ 'Required parameter "id" was null or undefined when calling v2ProfilesUpdate().'
506
+ );
507
+ }
508
+
509
+ if (requestParameters['v2ProfileUpdate'] == null) {
510
+ throw new runtime.RequiredError(
511
+ 'v2ProfileUpdate',
512
+ 'Required parameter "v2ProfileUpdate" was null or undefined when calling v2ProfilesUpdate().'
513
+ );
514
+ }
515
+
516
+ const queryParameters: any = {};
517
+
518
+ const headerParameters: runtime.HTTPHeaders = {};
519
+
520
+ headerParameters['Content-Type'] = 'application/json';
521
+
522
+ if (this.configuration && this.configuration.accessToken) {
523
+ // oauth required
524
+ headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
525
+ }
526
+
527
+
528
+ let urlPath = `/api/v2/profiles/{id}/`;
529
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
530
+
531
+ return {
532
+ path: urlPath,
533
+ method: 'PUT',
534
+ headers: headerParameters,
535
+ query: queryParameters,
536
+ body: V2ProfileUpdateToJSON(requestParameters['v2ProfileUpdate']),
537
+ };
538
+ }
539
+
540
+ /**
541
+ * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
542
+ */
543
+ async v2ProfilesUpdateRaw(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>> {
544
+ const requestOptions = await this.v2ProfilesUpdateRequestOpts(requestParameters);
545
+ const response = await this.request(requestOptions, initOverrides);
546
+
547
+ return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
548
+ }
549
+
550
+ /**
551
+ * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
552
+ */
553
+ async v2ProfilesUpdate(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail> {
554
+ const response = await this.v2ProfilesUpdateRaw(requestParameters, initOverrides);
555
+ return await response.value();
556
+ }
557
+
558
+ }
559
+
560
+ /**
561
+ * @export
562
+ */
563
+ export const V2ProfilesListCheckTypeEnum = {
564
+ Addresscheck: 'addresscheck',
565
+ Adversemediacheck: 'adversemediacheck',
566
+ Bigcheck: 'bigcheck',
567
+ Criminalrecordscheck: 'criminalrecordscheck',
568
+ Criminalrecordsuploadcheck: 'criminalrecordsuploadcheck',
569
+ Customintegritycheck: 'customintegritycheck',
570
+ Cvcheck: 'cvcheck',
571
+ Edrcheck: 'edrcheck',
572
+ Id2check: 'id2check',
573
+ Integritycheck: 'integritycheck',
574
+ Openhealthcarecheck: 'openhealthcarecheck',
575
+ Qualificationcheck: 'qualificationcheck',
576
+ Righttoworkcheck: 'righttoworkcheck',
577
+ Vogcheck: 'vogcheck',
578
+ Watchlist2check: 'watchlist2check',
579
+ Watchlistcheck: 'watchlistcheck',
580
+ Workreferencecheck: 'workreferencecheck',
581
+ Worldwidecreditcheck: 'worldwidecreditcheck'
582
+ } as const;
583
+ export type V2ProfilesListCheckTypeEnum = typeof V2ProfilesListCheckTypeEnum[keyof typeof V2ProfilesListCheckTypeEnum];