@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,91 @@
1
+ /**
2
+ * Pescheck API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { type V2CheckInfo } from '../models/V2CheckInfo';
14
+ export interface V2ChecksListRequest {
15
+ checkType?: string;
16
+ }
17
+ export interface V2ChecksRetrieveRequest {
18
+ checkType: string;
19
+ }
20
+ /**
21
+ * ChecksApi - interface
22
+ *
23
+ * @export
24
+ * @interface ChecksApiInterface
25
+ */
26
+ export interface ChecksApiInterface {
27
+ /**
28
+ * Creates request options for v2ChecksList without sending the request
29
+ * @param {string} [checkType] Restrict the list to a single check type.
30
+ * @throws {RequiredError}
31
+ * @memberof ChecksApiInterface
32
+ */
33
+ v2ChecksListRequestOpts(requestParameters: V2ChecksListRequest): Promise<runtime.RequestOpts>;
34
+ /**
35
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
36
+ * @param {string} [checkType] Restrict the list to a single check type.
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ * @memberof ChecksApiInterface
40
+ */
41
+ v2ChecksListRaw(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2CheckInfo>>>;
42
+ /**
43
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
44
+ */
45
+ v2ChecksList(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2CheckInfo>>;
46
+ /**
47
+ * Creates request options for v2ChecksRetrieve without sending the request
48
+ * @param {string} checkType
49
+ * @throws {RequiredError}
50
+ * @memberof ChecksApiInterface
51
+ */
52
+ v2ChecksRetrieveRequestOpts(requestParameters: V2ChecksRetrieveRequest): Promise<runtime.RequestOpts>;
53
+ /**
54
+ *
55
+ * @param {string} checkType
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ * @memberof ChecksApiInterface
59
+ */
60
+ v2ChecksRetrieveRaw(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2CheckInfo>>;
61
+ /**
62
+ */
63
+ v2ChecksRetrieve(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2CheckInfo>;
64
+ }
65
+ /**
66
+ *
67
+ */
68
+ export declare class ChecksApi extends runtime.BaseAPI implements ChecksApiInterface {
69
+ /**
70
+ * Creates request options for v2ChecksList without sending the request
71
+ */
72
+ v2ChecksListRequestOpts(requestParameters: V2ChecksListRequest): Promise<runtime.RequestOpts>;
73
+ /**
74
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
75
+ */
76
+ v2ChecksListRaw(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2CheckInfo>>>;
77
+ /**
78
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
79
+ */
80
+ v2ChecksList(requestParameters?: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2CheckInfo>>;
81
+ /**
82
+ * Creates request options for v2ChecksRetrieve without sending the request
83
+ */
84
+ v2ChecksRetrieveRequestOpts(requestParameters: V2ChecksRetrieveRequest): Promise<runtime.RequestOpts>;
85
+ /**
86
+ */
87
+ v2ChecksRetrieveRaw(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2CheckInfo>>;
88
+ /**
89
+ */
90
+ v2ChecksRetrieve(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2CheckInfo>;
91
+ }
@@ -0,0 +1,116 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pescheck API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.ChecksApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const V2CheckInfo_1 = require("../models/V2CheckInfo");
28
+ /**
29
+ *
30
+ */
31
+ class ChecksApi extends runtime.BaseAPI {
32
+ /**
33
+ * Creates request options for v2ChecksList without sending the request
34
+ */
35
+ v2ChecksListRequestOpts(requestParameters) {
36
+ return __awaiter(this, void 0, void 0, function* () {
37
+ const queryParameters = {};
38
+ if (requestParameters['checkType'] != null) {
39
+ queryParameters['check_type'] = requestParameters['checkType'];
40
+ }
41
+ const headerParameters = {};
42
+ if (this.configuration && this.configuration.accessToken) {
43
+ // oauth required
44
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
45
+ }
46
+ let urlPath = `/api/v2/checks/`;
47
+ return {
48
+ path: urlPath,
49
+ method: 'GET',
50
+ headers: headerParameters,
51
+ query: queryParameters,
52
+ };
53
+ });
54
+ }
55
+ /**
56
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
57
+ */
58
+ v2ChecksListRaw(requestParameters, initOverrides) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ const requestOptions = yield this.v2ChecksListRequestOpts(requestParameters);
61
+ const response = yield this.request(requestOptions, initOverrides);
62
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(V2CheckInfo_1.V2CheckInfoFromJSON));
63
+ });
64
+ }
65
+ /**
66
+ * List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
67
+ */
68
+ v2ChecksList() {
69
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
70
+ const response = yield this.v2ChecksListRaw(requestParameters, initOverrides);
71
+ return yield response.value();
72
+ });
73
+ }
74
+ /**
75
+ * Creates request options for v2ChecksRetrieve without sending the request
76
+ */
77
+ v2ChecksRetrieveRequestOpts(requestParameters) {
78
+ return __awaiter(this, void 0, void 0, function* () {
79
+ if (requestParameters['checkType'] == null) {
80
+ throw new runtime.RequiredError('checkType', 'Required parameter "checkType" was null or undefined when calling v2ChecksRetrieve().');
81
+ }
82
+ const queryParameters = {};
83
+ const headerParameters = {};
84
+ if (this.configuration && this.configuration.accessToken) {
85
+ // oauth required
86
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
87
+ }
88
+ let urlPath = `/api/v2/checks/{check_type}/`;
89
+ urlPath = urlPath.replace('{check_type}', encodeURIComponent(String(requestParameters['checkType'])));
90
+ return {
91
+ path: urlPath,
92
+ method: 'GET',
93
+ headers: headerParameters,
94
+ query: queryParameters,
95
+ };
96
+ });
97
+ }
98
+ /**
99
+ */
100
+ v2ChecksRetrieveRaw(requestParameters, initOverrides) {
101
+ return __awaiter(this, void 0, void 0, function* () {
102
+ const requestOptions = yield this.v2ChecksRetrieveRequestOpts(requestParameters);
103
+ const response = yield this.request(requestOptions, initOverrides);
104
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2CheckInfo_1.V2CheckInfoFromJSON)(jsonValue));
105
+ });
106
+ }
107
+ /**
108
+ */
109
+ v2ChecksRetrieve(requestParameters, initOverrides) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ const response = yield this.v2ChecksRetrieveRaw(requestParameters, initOverrides);
112
+ return yield response.value();
113
+ });
114
+ }
115
+ }
116
+ exports.ChecksApi = ChecksApi;
@@ -0,0 +1,211 @@
1
+ /**
2
+ * Pescheck API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import { type DivisionReadOnly } from '../models/DivisionReadOnly';
14
+ import { type DivisionWrite } from '../models/DivisionWrite';
15
+ import { type PaginatedDivisionReadOnlyList } from '../models/PaginatedDivisionReadOnlyList';
16
+ import { type PatchedDivisionWrite } from '../models/PatchedDivisionWrite';
17
+ export interface V2OrganisationsDivisionsCreateRequest {
18
+ divisionWrite: Omit<DivisionWrite, 'id'>;
19
+ }
20
+ export interface V2OrganisationsDivisionsListRequest {
21
+ page?: number;
22
+ pageSize?: number;
23
+ paginate?: boolean;
24
+ }
25
+ export interface V2OrganisationsDivisionsPartialUpdateRequest {
26
+ id: string;
27
+ patchedDivisionWrite?: Omit<PatchedDivisionWrite, 'id'>;
28
+ }
29
+ export interface V2OrganisationsDivisionsRetrieveRequest {
30
+ id: string;
31
+ }
32
+ export interface V2OrganisationsDivisionsUpdateRequest {
33
+ id: string;
34
+ divisionWrite: Omit<DivisionWrite, 'id'>;
35
+ }
36
+ /**
37
+ * DivisionsApi - interface
38
+ *
39
+ * @export
40
+ * @interface DivisionsApiInterface
41
+ */
42
+ export interface DivisionsApiInterface {
43
+ /**
44
+ * Creates request options for v2OrganisationsDivisionsCreate without sending the request
45
+ * @param {DivisionWrite} divisionWrite
46
+ * @throws {RequiredError}
47
+ * @memberof DivisionsApiInterface
48
+ */
49
+ v2OrganisationsDivisionsCreateRequestOpts(requestParameters: V2OrganisationsDivisionsCreateRequest): Promise<runtime.RequestOpts>;
50
+ /**
51
+ * Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
52
+ * @param {DivisionWrite} divisionWrite
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ * @memberof DivisionsApiInterface
56
+ */
57
+ v2OrganisationsDivisionsCreateRaw(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
58
+ /**
59
+ * Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
60
+ */
61
+ v2OrganisationsDivisionsCreate(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
62
+ /**
63
+ * Creates request options for v2OrganisationsDivisionsList without sending the request
64
+ * @param {number} [page] A page number within the paginated result set.
65
+ * @param {number} [pageSize] Number of results to return per page.
66
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
67
+ * @throws {RequiredError}
68
+ * @memberof DivisionsApiInterface
69
+ */
70
+ v2OrganisationsDivisionsListRequestOpts(requestParameters: V2OrganisationsDivisionsListRequest): Promise<runtime.RequestOpts>;
71
+ /**
72
+ * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
73
+ * @param {number} [page] A page number within the paginated result set.
74
+ * @param {number} [pageSize] Number of results to return per page.
75
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ * @memberof DivisionsApiInterface
79
+ */
80
+ v2OrganisationsDivisionsListRaw(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDivisionReadOnlyList>>;
81
+ /**
82
+ * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
83
+ */
84
+ v2OrganisationsDivisionsList(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDivisionReadOnlyList>;
85
+ /**
86
+ * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
87
+ * @param {string} id A UUID string identifying this organisation.
88
+ * @param {PatchedDivisionWrite} [patchedDivisionWrite]
89
+ * @throws {RequiredError}
90
+ * @memberof DivisionsApiInterface
91
+ */
92
+ v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest): Promise<runtime.RequestOpts>;
93
+ /**
94
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
95
+ * @param {string} id A UUID string identifying this organisation.
96
+ * @param {PatchedDivisionWrite} [patchedDivisionWrite]
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ * @memberof DivisionsApiInterface
100
+ */
101
+ v2OrganisationsDivisionsPartialUpdateRaw(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
102
+ /**
103
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
104
+ */
105
+ v2OrganisationsDivisionsPartialUpdate(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
106
+ /**
107
+ * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
108
+ * @param {string} id A UUID string identifying this organisation.
109
+ * @throws {RequiredError}
110
+ * @memberof DivisionsApiInterface
111
+ */
112
+ v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters: V2OrganisationsDivisionsRetrieveRequest): Promise<runtime.RequestOpts>;
113
+ /**
114
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
115
+ * @param {string} id A UUID string identifying this organisation.
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ * @memberof DivisionsApiInterface
119
+ */
120
+ v2OrganisationsDivisionsRetrieveRaw(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionReadOnly>>;
121
+ /**
122
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
123
+ */
124
+ v2OrganisationsDivisionsRetrieve(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionReadOnly>;
125
+ /**
126
+ * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
127
+ * @param {string} id A UUID string identifying this organisation.
128
+ * @param {DivisionWrite} divisionWrite
129
+ * @throws {RequiredError}
130
+ * @memberof DivisionsApiInterface
131
+ */
132
+ v2OrganisationsDivisionsUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsUpdateRequest): Promise<runtime.RequestOpts>;
133
+ /**
134
+ * Update an existing division\'s contact, billing, and address details. Override also triggers a webhook on successful PUT and PATCH requests.
135
+ * @param {string} id A UUID string identifying this organisation.
136
+ * @param {DivisionWrite} divisionWrite
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ * @memberof DivisionsApiInterface
140
+ */
141
+ v2OrganisationsDivisionsUpdateRaw(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
142
+ /**
143
+ * Update an existing division\'s contact, billing, and address details. Override also triggers a webhook on successful PUT and PATCH requests.
144
+ */
145
+ v2OrganisationsDivisionsUpdate(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
146
+ }
147
+ /**
148
+ *
149
+ */
150
+ export declare class DivisionsApi extends runtime.BaseAPI implements DivisionsApiInterface {
151
+ /**
152
+ * Creates request options for v2OrganisationsDivisionsCreate without sending the request
153
+ */
154
+ v2OrganisationsDivisionsCreateRequestOpts(requestParameters: V2OrganisationsDivisionsCreateRequest): Promise<runtime.RequestOpts>;
155
+ /**
156
+ * Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
157
+ */
158
+ v2OrganisationsDivisionsCreateRaw(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
159
+ /**
160
+ * Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
161
+ */
162
+ v2OrganisationsDivisionsCreate(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
163
+ /**
164
+ * Creates request options for v2OrganisationsDivisionsList without sending the request
165
+ */
166
+ v2OrganisationsDivisionsListRequestOpts(requestParameters: V2OrganisationsDivisionsListRequest): Promise<runtime.RequestOpts>;
167
+ /**
168
+ * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
169
+ */
170
+ v2OrganisationsDivisionsListRaw(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDivisionReadOnlyList>>;
171
+ /**
172
+ * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
173
+ */
174
+ v2OrganisationsDivisionsList(requestParameters?: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDivisionReadOnlyList>;
175
+ /**
176
+ * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
177
+ */
178
+ v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest): Promise<runtime.RequestOpts>;
179
+ /**
180
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
181
+ */
182
+ v2OrganisationsDivisionsPartialUpdateRaw(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
183
+ /**
184
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
185
+ */
186
+ v2OrganisationsDivisionsPartialUpdate(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
187
+ /**
188
+ * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
189
+ */
190
+ v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters: V2OrganisationsDivisionsRetrieveRequest): Promise<runtime.RequestOpts>;
191
+ /**
192
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
193
+ */
194
+ v2OrganisationsDivisionsRetrieveRaw(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionReadOnly>>;
195
+ /**
196
+ * A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
197
+ */
198
+ v2OrganisationsDivisionsRetrieve(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionReadOnly>;
199
+ /**
200
+ * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
201
+ */
202
+ v2OrganisationsDivisionsUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsUpdateRequest): Promise<runtime.RequestOpts>;
203
+ /**
204
+ * Update an existing division\'s contact, billing, and address details. Override also triggers a webhook on successful PUT and PATCH requests.
205
+ */
206
+ v2OrganisationsDivisionsUpdateRaw(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
207
+ /**
208
+ * Update an existing division\'s contact, billing, and address details. Override also triggers a webhook on successful PUT and PATCH requests.
209
+ */
210
+ v2OrganisationsDivisionsUpdate(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
211
+ }