@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,172 @@
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 PaginatedV2ScreeningListItemList } from '../models/PaginatedV2ScreeningListItemList';
14
+ import { type V2Document } from '../models/V2Document';
15
+ import { type V2ScreeningCreate } from '../models/V2ScreeningCreate';
16
+ import { type V2ScreeningDetail } from '../models/V2ScreeningDetail';
17
+ export interface V2ScreeningsCreateRequest {
18
+ v2ScreeningCreate: V2ScreeningCreate;
19
+ }
20
+ export interface V2ScreeningsDocumentsListRequest {
21
+ id: string;
22
+ checkId?: string;
23
+ checkType?: string;
24
+ }
25
+ export interface V2ScreeningsListRequest {
26
+ page?: number;
27
+ pageSize?: number;
28
+ paginate?: boolean;
29
+ }
30
+ export interface V2ScreeningsRetrieveRequest {
31
+ id: string;
32
+ }
33
+ /**
34
+ * ScreeningsApi - interface
35
+ *
36
+ * @export
37
+ * @interface ScreeningsApiInterface
38
+ */
39
+ export interface ScreeningsApiInterface {
40
+ /**
41
+ * Creates request options for v2ScreeningsCreate without sending the request
42
+ * @param {V2ScreeningCreate} v2ScreeningCreate
43
+ * @throws {RequiredError}
44
+ * @memberof ScreeningsApiInterface
45
+ */
46
+ v2ScreeningsCreateRequestOpts(requestParameters: V2ScreeningsCreateRequest): Promise<runtime.RequestOpts>;
47
+ /**
48
+ *
49
+ * @param {V2ScreeningCreate} v2ScreeningCreate
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ * @memberof ScreeningsApiInterface
53
+ */
54
+ v2ScreeningsCreateRaw(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
55
+ /**
56
+ */
57
+ v2ScreeningsCreate(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
58
+ /**
59
+ * Creates request options for v2ScreeningsDocumentsList without sending the request
60
+ * @param {string} id
61
+ * @param {string} [checkId] Only documents from the check with this id.
62
+ * @param {string} [checkType] Only documents from checks of this type.
63
+ * @throws {RequiredError}
64
+ * @memberof ScreeningsApiInterface
65
+ */
66
+ v2ScreeningsDocumentsListRequestOpts(requestParameters: V2ScreeningsDocumentsListRequest): Promise<runtime.RequestOpts>;
67
+ /**
68
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
69
+ * @summary Retrieve screening documents
70
+ * @param {string} id
71
+ * @param {string} [checkId] Only documents from the check with this id.
72
+ * @param {string} [checkType] Only documents from checks of this type.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ * @memberof ScreeningsApiInterface
76
+ */
77
+ v2ScreeningsDocumentsListRaw(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2Document>>>;
78
+ /**
79
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
80
+ * Retrieve screening documents
81
+ */
82
+ v2ScreeningsDocumentsList(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2Document>>;
83
+ /**
84
+ * Creates request options for v2ScreeningsList without sending the request
85
+ * @param {number} [page] A page number within the paginated result set.
86
+ * @param {number} [pageSize] Number of results to return per page.
87
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
88
+ * @throws {RequiredError}
89
+ * @memberof ScreeningsApiInterface
90
+ */
91
+ v2ScreeningsListRequestOpts(requestParameters: V2ScreeningsListRequest): Promise<runtime.RequestOpts>;
92
+ /**
93
+ *
94
+ * @param {number} [page] A page number within the paginated result set.
95
+ * @param {number} [pageSize] Number of results to return per page.
96
+ * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ * @memberof ScreeningsApiInterface
100
+ */
101
+ v2ScreeningsListRaw(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ScreeningListItemList>>;
102
+ /**
103
+ */
104
+ v2ScreeningsList(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ScreeningListItemList>;
105
+ /**
106
+ * Creates request options for v2ScreeningsRetrieve without sending the request
107
+ * @param {string} id A UUID string identifying this screening.
108
+ * @throws {RequiredError}
109
+ * @memberof ScreeningsApiInterface
110
+ */
111
+ v2ScreeningsRetrieveRequestOpts(requestParameters: V2ScreeningsRetrieveRequest): Promise<runtime.RequestOpts>;
112
+ /**
113
+ *
114
+ * @param {string} id A UUID string identifying this screening.
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ * @memberof ScreeningsApiInterface
118
+ */
119
+ v2ScreeningsRetrieveRaw(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
120
+ /**
121
+ */
122
+ v2ScreeningsRetrieve(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
123
+ }
124
+ /**
125
+ *
126
+ */
127
+ export declare class ScreeningsApi extends runtime.BaseAPI implements ScreeningsApiInterface {
128
+ /**
129
+ * Creates request options for v2ScreeningsCreate without sending the request
130
+ */
131
+ v2ScreeningsCreateRequestOpts(requestParameters: V2ScreeningsCreateRequest): Promise<runtime.RequestOpts>;
132
+ /**
133
+ */
134
+ v2ScreeningsCreateRaw(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
135
+ /**
136
+ */
137
+ v2ScreeningsCreate(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
138
+ /**
139
+ * Creates request options for v2ScreeningsDocumentsList without sending the request
140
+ */
141
+ v2ScreeningsDocumentsListRequestOpts(requestParameters: V2ScreeningsDocumentsListRequest): Promise<runtime.RequestOpts>;
142
+ /**
143
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
144
+ * Retrieve screening documents
145
+ */
146
+ v2ScreeningsDocumentsListRaw(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2Document>>>;
147
+ /**
148
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
149
+ * Retrieve screening documents
150
+ */
151
+ v2ScreeningsDocumentsList(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2Document>>;
152
+ /**
153
+ * Creates request options for v2ScreeningsList without sending the request
154
+ */
155
+ v2ScreeningsListRequestOpts(requestParameters: V2ScreeningsListRequest): Promise<runtime.RequestOpts>;
156
+ /**
157
+ */
158
+ v2ScreeningsListRaw(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ScreeningListItemList>>;
159
+ /**
160
+ */
161
+ v2ScreeningsList(requestParameters?: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ScreeningListItemList>;
162
+ /**
163
+ * Creates request options for v2ScreeningsRetrieve without sending the request
164
+ */
165
+ v2ScreeningsRetrieveRequestOpts(requestParameters: V2ScreeningsRetrieveRequest): Promise<runtime.RequestOpts>;
166
+ /**
167
+ */
168
+ v2ScreeningsRetrieveRaw(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
169
+ /**
170
+ */
171
+ v2ScreeningsRetrieve(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
172
+ }
@@ -0,0 +1,216 @@
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.ScreeningsApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const PaginatedV2ScreeningListItemList_1 = require("../models/PaginatedV2ScreeningListItemList");
28
+ const V2Document_1 = require("../models/V2Document");
29
+ const V2ScreeningCreate_1 = require("../models/V2ScreeningCreate");
30
+ const V2ScreeningDetail_1 = require("../models/V2ScreeningDetail");
31
+ /**
32
+ *
33
+ */
34
+ class ScreeningsApi extends runtime.BaseAPI {
35
+ /**
36
+ * Creates request options for v2ScreeningsCreate without sending the request
37
+ */
38
+ v2ScreeningsCreateRequestOpts(requestParameters) {
39
+ return __awaiter(this, void 0, void 0, function* () {
40
+ if (requestParameters['v2ScreeningCreate'] == null) {
41
+ throw new runtime.RequiredError('v2ScreeningCreate', 'Required parameter "v2ScreeningCreate" was null or undefined when calling v2ScreeningsCreate().');
42
+ }
43
+ const queryParameters = {};
44
+ const headerParameters = {};
45
+ headerParameters['Content-Type'] = 'application/json';
46
+ if (this.configuration && this.configuration.accessToken) {
47
+ // oauth required
48
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
49
+ }
50
+ let urlPath = `/api/v2/screenings/`;
51
+ return {
52
+ path: urlPath,
53
+ method: 'POST',
54
+ headers: headerParameters,
55
+ query: queryParameters,
56
+ body: (0, V2ScreeningCreate_1.V2ScreeningCreateToJSON)(requestParameters['v2ScreeningCreate']),
57
+ };
58
+ });
59
+ }
60
+ /**
61
+ */
62
+ v2ScreeningsCreateRaw(requestParameters, initOverrides) {
63
+ return __awaiter(this, void 0, void 0, function* () {
64
+ const requestOptions = yield this.v2ScreeningsCreateRequestOpts(requestParameters);
65
+ const response = yield this.request(requestOptions, initOverrides);
66
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ScreeningDetail_1.V2ScreeningDetailFromJSON)(jsonValue));
67
+ });
68
+ }
69
+ /**
70
+ */
71
+ v2ScreeningsCreate(requestParameters, initOverrides) {
72
+ return __awaiter(this, void 0, void 0, function* () {
73
+ const response = yield this.v2ScreeningsCreateRaw(requestParameters, initOverrides);
74
+ return yield response.value();
75
+ });
76
+ }
77
+ /**
78
+ * Creates request options for v2ScreeningsDocumentsList without sending the request
79
+ */
80
+ v2ScreeningsDocumentsListRequestOpts(requestParameters) {
81
+ return __awaiter(this, void 0, void 0, function* () {
82
+ if (requestParameters['id'] == null) {
83
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ScreeningsDocumentsList().');
84
+ }
85
+ const queryParameters = {};
86
+ if (requestParameters['checkId'] != null) {
87
+ queryParameters['check_id'] = requestParameters['checkId'];
88
+ }
89
+ if (requestParameters['checkType'] != null) {
90
+ queryParameters['check_type'] = requestParameters['checkType'];
91
+ }
92
+ const headerParameters = {};
93
+ if (this.configuration && this.configuration.accessToken) {
94
+ // oauth required
95
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
96
+ }
97
+ let urlPath = `/api/v2/screenings/{id}/documents/`;
98
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
99
+ return {
100
+ path: urlPath,
101
+ method: 'GET',
102
+ headers: headerParameters,
103
+ query: queryParameters,
104
+ };
105
+ });
106
+ }
107
+ /**
108
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
109
+ * Retrieve screening documents
110
+ */
111
+ v2ScreeningsDocumentsListRaw(requestParameters, initOverrides) {
112
+ return __awaiter(this, void 0, void 0, function* () {
113
+ const requestOptions = yield this.v2ScreeningsDocumentsListRequestOpts(requestParameters);
114
+ const response = yield this.request(requestOptions, initOverrides);
115
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(V2Document_1.V2DocumentFromJSON));
116
+ });
117
+ }
118
+ /**
119
+ * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
120
+ * Retrieve screening documents
121
+ */
122
+ v2ScreeningsDocumentsList(requestParameters, initOverrides) {
123
+ return __awaiter(this, void 0, void 0, function* () {
124
+ const response = yield this.v2ScreeningsDocumentsListRaw(requestParameters, initOverrides);
125
+ return yield response.value();
126
+ });
127
+ }
128
+ /**
129
+ * Creates request options for v2ScreeningsList without sending the request
130
+ */
131
+ v2ScreeningsListRequestOpts(requestParameters) {
132
+ return __awaiter(this, void 0, void 0, function* () {
133
+ const queryParameters = {};
134
+ if (requestParameters['page'] != null) {
135
+ queryParameters['page'] = requestParameters['page'];
136
+ }
137
+ if (requestParameters['pageSize'] != null) {
138
+ queryParameters['page_size'] = requestParameters['pageSize'];
139
+ }
140
+ if (requestParameters['paginate'] != null) {
141
+ queryParameters['paginate'] = requestParameters['paginate'];
142
+ }
143
+ const headerParameters = {};
144
+ if (this.configuration && this.configuration.accessToken) {
145
+ // oauth required
146
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
147
+ }
148
+ let urlPath = `/api/v2/screenings/`;
149
+ return {
150
+ path: urlPath,
151
+ method: 'GET',
152
+ headers: headerParameters,
153
+ query: queryParameters,
154
+ };
155
+ });
156
+ }
157
+ /**
158
+ */
159
+ v2ScreeningsListRaw(requestParameters, initOverrides) {
160
+ return __awaiter(this, void 0, void 0, function* () {
161
+ const requestOptions = yield this.v2ScreeningsListRequestOpts(requestParameters);
162
+ const response = yield this.request(requestOptions, initOverrides);
163
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, PaginatedV2ScreeningListItemList_1.PaginatedV2ScreeningListItemListFromJSON)(jsonValue));
164
+ });
165
+ }
166
+ /**
167
+ */
168
+ v2ScreeningsList() {
169
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
170
+ const response = yield this.v2ScreeningsListRaw(requestParameters, initOverrides);
171
+ return yield response.value();
172
+ });
173
+ }
174
+ /**
175
+ * Creates request options for v2ScreeningsRetrieve without sending the request
176
+ */
177
+ v2ScreeningsRetrieveRequestOpts(requestParameters) {
178
+ return __awaiter(this, void 0, void 0, function* () {
179
+ if (requestParameters['id'] == null) {
180
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ScreeningsRetrieve().');
181
+ }
182
+ const queryParameters = {};
183
+ const headerParameters = {};
184
+ if (this.configuration && this.configuration.accessToken) {
185
+ // oauth required
186
+ headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
187
+ }
188
+ let urlPath = `/api/v2/screenings/{id}/`;
189
+ urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
190
+ return {
191
+ path: urlPath,
192
+ method: 'GET',
193
+ headers: headerParameters,
194
+ query: queryParameters,
195
+ };
196
+ });
197
+ }
198
+ /**
199
+ */
200
+ v2ScreeningsRetrieveRaw(requestParameters, initOverrides) {
201
+ return __awaiter(this, void 0, void 0, function* () {
202
+ const requestOptions = yield this.v2ScreeningsRetrieveRequestOpts(requestParameters);
203
+ const response = yield this.request(requestOptions, initOverrides);
204
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ScreeningDetail_1.V2ScreeningDetailFromJSON)(jsonValue));
205
+ });
206
+ }
207
+ /**
208
+ */
209
+ v2ScreeningsRetrieve(requestParameters, initOverrides) {
210
+ return __awaiter(this, void 0, void 0, function* () {
211
+ const response = yield this.v2ScreeningsRetrieveRaw(requestParameters, initOverrides);
212
+ return yield response.value();
213
+ });
214
+ }
215
+ }
216
+ exports.ScreeningsApi = ScreeningsApi;
@@ -0,0 +1,168 @@
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 VerifyWebhook } from '../models/VerifyWebhook';
14
+ import { type Webhook } from '../models/Webhook';
15
+ import { type WebhookResponse } from '../models/WebhookResponse';
16
+ export interface CreateWebhook2Request {
17
+ webhook: Webhook;
18
+ xOrganizationId?: string;
19
+ organizationId?: string;
20
+ }
21
+ export interface DeleteWebhook2Request {
22
+ webhookId: string;
23
+ }
24
+ export interface VerifyWebhook2Request {
25
+ webhookId: string;
26
+ verifyWebhook: VerifyWebhook;
27
+ }
28
+ /**
29
+ * WebhooksApi - interface
30
+ *
31
+ * @export
32
+ * @interface WebhooksApiInterface
33
+ */
34
+ export interface WebhooksApiInterface {
35
+ /**
36
+ * Creates request options for createWebhook2 without sending the request
37
+ * @param {Webhook} webhook
38
+ * @param {string} [xOrganizationId] Organization ID (for JWT/Session auth only)
39
+ * @param {string} [organizationId] Organization ID (for JWT/Session auth only)
40
+ * @throws {RequiredError}
41
+ * @memberof WebhooksApiInterface
42
+ */
43
+ createWebhook2RequestOpts(requestParameters: CreateWebhook2Request): Promise<runtime.RequestOpts>;
44
+ /**
45
+ * Create webhook for event notifications. **Authentication Notes:** - OAuth2: Organization is automatically determined from the OAuth application - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter **Valid Events:** - `check.started` - Check has been initiated - `check.completed` - Check has been completed successfully - `check.failed` - Check has failed - `screening.created` - New screening has been created - `screening.completed` - Screening has been completed - `screening.archived` - Screening has been archived - `package.created` - New package has been created - `package.updated` - Package has been updated - `division.created` - New division has been created - `division.updated` - Division has been updated Limited to 5 webhooks per organization/division.
46
+ * @param {Webhook} webhook
47
+ * @param {string} [xOrganizationId] Organization ID (for JWT/Session auth only)
48
+ * @param {string} [organizationId] Organization ID (for JWT/Session auth only)
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ * @memberof WebhooksApiInterface
52
+ */
53
+ createWebhook2Raw(requestParameters: CreateWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookResponse>>;
54
+ /**
55
+ * Create webhook for event notifications. **Authentication Notes:** - OAuth2: Organization is automatically determined from the OAuth application - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter **Valid Events:** - `check.started` - Check has been initiated - `check.completed` - Check has been completed successfully - `check.failed` - Check has failed - `screening.created` - New screening has been created - `screening.completed` - Screening has been completed - `screening.archived` - Screening has been archived - `package.created` - New package has been created - `package.updated` - Package has been updated - `division.created` - New division has been created - `division.updated` - Division has been updated Limited to 5 webhooks per organization/division.
56
+ */
57
+ createWebhook2(requestParameters: CreateWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
58
+ /**
59
+ * Creates request options for deleteWebhook2 without sending the request
60
+ * @param {string} webhookId Webhook ID to delete
61
+ * @throws {RequiredError}
62
+ * @memberof WebhooksApiInterface
63
+ */
64
+ deleteWebhook2RequestOpts(requestParameters: DeleteWebhook2Request): Promise<runtime.RequestOpts>;
65
+ /**
66
+ * Delete a webhook
67
+ * @param {string} webhookId Webhook ID to delete
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ * @memberof WebhooksApiInterface
71
+ */
72
+ deleteWebhook2Raw(requestParameters: DeleteWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
73
+ /**
74
+ * Delete a webhook
75
+ */
76
+ deleteWebhook2(requestParameters: DeleteWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
77
+ /**
78
+ * Creates request options for listWebhooks2 without sending the request
79
+ * @throws {RequiredError}
80
+ * @memberof WebhooksApiInterface
81
+ */
82
+ listWebhooks2RequestOpts(): Promise<runtime.RequestOpts>;
83
+ /**
84
+ * List webhooks for the organization
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ * @memberof WebhooksApiInterface
88
+ */
89
+ listWebhooks2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookResponse>>>;
90
+ /**
91
+ * List webhooks for the organization
92
+ */
93
+ listWebhooks2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookResponse>>;
94
+ /**
95
+ * Creates request options for verifyWebhook2 without sending the request
96
+ * @param {string} webhookId Webhook ID
97
+ * @param {VerifyWebhook} verifyWebhook
98
+ * @throws {RequiredError}
99
+ * @memberof WebhooksApiInterface
100
+ */
101
+ verifyWebhook2RequestOpts(requestParameters: VerifyWebhook2Request): Promise<runtime.RequestOpts>;
102
+ /**
103
+ * Verify webhook ownership
104
+ * @param {string} webhookId Webhook ID
105
+ * @param {VerifyWebhook} verifyWebhook
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ * @memberof WebhooksApiInterface
109
+ */
110
+ verifyWebhook2Raw(requestParameters: VerifyWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
111
+ /**
112
+ * Verify webhook ownership
113
+ */
114
+ verifyWebhook2(requestParameters: VerifyWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
115
+ }
116
+ /**
117
+ *
118
+ */
119
+ export declare class WebhooksApi extends runtime.BaseAPI implements WebhooksApiInterface {
120
+ /**
121
+ * Creates request options for createWebhook2 without sending the request
122
+ */
123
+ createWebhook2RequestOpts(requestParameters: CreateWebhook2Request): Promise<runtime.RequestOpts>;
124
+ /**
125
+ * Create webhook for event notifications. **Authentication Notes:** - OAuth2: Organization is automatically determined from the OAuth application - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter **Valid Events:** - `check.started` - Check has been initiated - `check.completed` - Check has been completed successfully - `check.failed` - Check has failed - `screening.created` - New screening has been created - `screening.completed` - Screening has been completed - `screening.archived` - Screening has been archived - `package.created` - New package has been created - `package.updated` - Package has been updated - `division.created` - New division has been created - `division.updated` - Division has been updated Limited to 5 webhooks per organization/division.
126
+ */
127
+ createWebhook2Raw(requestParameters: CreateWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookResponse>>;
128
+ /**
129
+ * Create webhook for event notifications. **Authentication Notes:** - OAuth2: Organization is automatically determined from the OAuth application - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter **Valid Events:** - `check.started` - Check has been initiated - `check.completed` - Check has been completed successfully - `check.failed` - Check has failed - `screening.created` - New screening has been created - `screening.completed` - Screening has been completed - `screening.archived` - Screening has been archived - `package.created` - New package has been created - `package.updated` - Package has been updated - `division.created` - New division has been created - `division.updated` - Division has been updated Limited to 5 webhooks per organization/division.
130
+ */
131
+ createWebhook2(requestParameters: CreateWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
132
+ /**
133
+ * Creates request options for deleteWebhook2 without sending the request
134
+ */
135
+ deleteWebhook2RequestOpts(requestParameters: DeleteWebhook2Request): Promise<runtime.RequestOpts>;
136
+ /**
137
+ * Delete a webhook
138
+ */
139
+ deleteWebhook2Raw(requestParameters: DeleteWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
140
+ /**
141
+ * Delete a webhook
142
+ */
143
+ deleteWebhook2(requestParameters: DeleteWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
144
+ /**
145
+ * Creates request options for listWebhooks2 without sending the request
146
+ */
147
+ listWebhooks2RequestOpts(): Promise<runtime.RequestOpts>;
148
+ /**
149
+ * List webhooks for the organization
150
+ */
151
+ listWebhooks2Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<WebhookResponse>>>;
152
+ /**
153
+ * List webhooks for the organization
154
+ */
155
+ listWebhooks2(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<WebhookResponse>>;
156
+ /**
157
+ * Creates request options for verifyWebhook2 without sending the request
158
+ */
159
+ verifyWebhook2RequestOpts(requestParameters: VerifyWebhook2Request): Promise<runtime.RequestOpts>;
160
+ /**
161
+ * Verify webhook ownership
162
+ */
163
+ verifyWebhook2Raw(requestParameters: VerifyWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
164
+ /**
165
+ * Verify webhook ownership
166
+ */
167
+ verifyWebhook2(requestParameters: VerifyWebhook2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
168
+ }