@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.
- package/.openapi-generator/FILES +97 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +200 -0
- package/dist/apis/AuthenticationApi.d.ts +131 -0
- package/dist/apis/AuthenticationApi.js +168 -0
- package/dist/apis/ChecksApi.d.ts +91 -0
- package/dist/apis/ChecksApi.js +116 -0
- package/dist/apis/DivisionsApi.d.ts +211 -0
- package/dist/apis/DivisionsApi.js +264 -0
- package/dist/apis/OAuthApi.d.ts +124 -0
- package/dist/apis/OAuthApi.js +159 -0
- package/dist/apis/ProfilesApi.d.ts +270 -0
- package/dist/apis/ProfilesApi.js +334 -0
- package/dist/apis/ScreeningsApi.d.ts +172 -0
- package/dist/apis/ScreeningsApi.js +216 -0
- package/dist/apis/WebhooksApi.d.ts +168 -0
- package/dist/apis/WebhooksApi.js +213 -0
- package/dist/apis/index.d.ts +7 -0
- package/dist/apis/index.js +25 -0
- package/dist/esm/apis/AuthenticationApi.d.ts +131 -0
- package/dist/esm/apis/AuthenticationApi.js +164 -0
- package/dist/esm/apis/ChecksApi.d.ts +91 -0
- package/dist/esm/apis/ChecksApi.js +112 -0
- package/dist/esm/apis/DivisionsApi.d.ts +211 -0
- package/dist/esm/apis/DivisionsApi.js +260 -0
- package/dist/esm/apis/OAuthApi.d.ts +124 -0
- package/dist/esm/apis/OAuthApi.js +155 -0
- package/dist/esm/apis/ProfilesApi.d.ts +270 -0
- package/dist/esm/apis/ProfilesApi.js +330 -0
- package/dist/esm/apis/ScreeningsApi.d.ts +172 -0
- package/dist/esm/apis/ScreeningsApi.js +212 -0
- package/dist/esm/apis/WebhooksApi.d.ts +168 -0
- package/dist/esm/apis/WebhooksApi.js +209 -0
- package/dist/esm/apis/index.d.ts +7 -0
- package/dist/esm/apis/index.js +9 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/CustomTokenObtainPair.d.ts +38 -0
- package/dist/esm/models/CustomTokenObtainPair.js +47 -0
- package/dist/esm/models/DivisionReadOnly.d.ts +116 -0
- package/dist/esm/models/DivisionReadOnly.js +73 -0
- package/dist/esm/models/DivisionWrite.d.ts +98 -0
- package/dist/esm/models/DivisionWrite.js +78 -0
- package/dist/esm/models/JWTGeneration.d.ts +50 -0
- package/dist/esm/models/JWTGeneration.js +51 -0
- package/dist/esm/models/JWTResponse.d.ts +62 -0
- package/dist/esm/models/JWTResponse.js +61 -0
- package/dist/esm/models/OAuthApplication.d.ts +84 -0
- package/dist/esm/models/OAuthApplication.js +68 -0
- package/dist/esm/models/OAuthApplicationResponse.d.ts +98 -0
- package/dist/esm/models/OAuthApplicationResponse.js +80 -0
- package/dist/esm/models/PaginatedDivisionReadOnlyList.d.ts +51 -0
- package/dist/esm/models/PaginatedDivisionReadOnlyList.js +56 -0
- package/dist/esm/models/PaginatedV2ProfileListItemList.d.ts +51 -0
- package/dist/esm/models/PaginatedV2ProfileListItemList.js +56 -0
- package/dist/esm/models/PaginatedV2ScreeningListItemList.d.ts +51 -0
- package/dist/esm/models/PaginatedV2ScreeningListItemList.js +56 -0
- package/dist/esm/models/PatchedDivisionWrite.d.ts +98 -0
- package/dist/esm/models/PatchedDivisionWrite.js +62 -0
- package/dist/esm/models/PatchedV2ProfilePartialUpdate.d.ts +39 -0
- package/dist/esm/models/PatchedV2ProfilePartialUpdate.js +43 -0
- package/dist/esm/models/TokenRefresh.d.ts +38 -0
- package/dist/esm/models/TokenRefresh.js +44 -0
- package/dist/esm/models/V2Candidate.d.ts +592 -0
- package/dist/esm/models/V2Candidate.js +318 -0
- package/dist/esm/models/V2CheckField.d.ts +56 -0
- package/dist/esm/models/V2CheckField.js +53 -0
- package/dist/esm/models/V2CheckInfo.d.ts +100 -0
- package/dist/esm/models/V2CheckInfo.js +76 -0
- package/dist/esm/models/V2Document.d.ts +115 -0
- package/dist/esm/models/V2Document.js +84 -0
- package/dist/esm/models/V2DocumentContent.d.ts +40 -0
- package/dist/esm/models/V2DocumentContent.js +45 -0
- package/dist/esm/models/V2Money.d.ts +38 -0
- package/dist/esm/models/V2Money.js +47 -0
- package/dist/esm/models/V2ProfileCheck.d.ts +85 -0
- package/dist/esm/models/V2ProfileCheck.js +68 -0
- package/dist/esm/models/V2ProfileCheckEntry.d.ts +120 -0
- package/dist/esm/models/V2ProfileCheckEntry.js +87 -0
- package/dist/esm/models/V2ProfileCreate.d.ts +45 -0
- package/dist/esm/models/V2ProfileCreate.js +50 -0
- package/dist/esm/models/V2ProfileDetail.d.ts +94 -0
- package/dist/esm/models/V2ProfileDetail.js +75 -0
- package/dist/esm/models/V2ProfileListItem.d.ts +68 -0
- package/dist/esm/models/V2ProfileListItem.js +61 -0
- package/dist/esm/models/V2ProfileUpdate.d.ts +47 -0
- package/dist/esm/models/V2ProfileUpdate.js +50 -0
- package/dist/esm/models/V2ProfileUpdateCheck.d.ts +96 -0
- package/dist/esm/models/V2ProfileUpdateCheck.js +74 -0
- package/dist/esm/models/V2ScreeningCheck.d.ts +95 -0
- package/dist/esm/models/V2ScreeningCheck.js +72 -0
- package/dist/esm/models/V2ScreeningCheckEntry.d.ts +135 -0
- package/dist/esm/models/V2ScreeningCheckEntry.js +92 -0
- package/dist/esm/models/V2ScreeningCheckListItem.d.ts +93 -0
- package/dist/esm/models/V2ScreeningCheckListItem.js +74 -0
- package/dist/esm/models/V2ScreeningCreate.d.ts +46 -0
- package/dist/esm/models/V2ScreeningCreate.js +51 -0
- package/dist/esm/models/V2ScreeningDetail.d.ts +83 -0
- package/dist/esm/models/V2ScreeningDetail.js +70 -0
- package/dist/esm/models/V2ScreeningDetailProfile.d.ts +38 -0
- package/dist/esm/models/V2ScreeningDetailProfile.js +43 -0
- package/dist/esm/models/V2ScreeningListItem.d.ts +85 -0
- package/dist/esm/models/V2ScreeningListItem.js +69 -0
- package/dist/esm/models/VerifyWebhook.d.ts +34 -0
- package/dist/esm/models/VerifyWebhook.js +43 -0
- package/dist/esm/models/Webhook.d.ts +71 -0
- package/dist/esm/models/Webhook.js +69 -0
- package/dist/esm/models/WebhookResponse.d.ts +87 -0
- package/dist/esm/models/WebhookResponse.js +51 -0
- package/dist/esm/models/index.d.ts +36 -0
- package/dist/esm/models/index.js +38 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +349 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/CustomTokenObtainPair.d.ts +38 -0
- package/dist/models/CustomTokenObtainPair.js +54 -0
- package/dist/models/DivisionReadOnly.d.ts +116 -0
- package/dist/models/DivisionReadOnly.js +80 -0
- package/dist/models/DivisionWrite.d.ts +98 -0
- package/dist/models/DivisionWrite.js +85 -0
- package/dist/models/JWTGeneration.d.ts +50 -0
- package/dist/models/JWTGeneration.js +58 -0
- package/dist/models/JWTResponse.d.ts +62 -0
- package/dist/models/JWTResponse.js +68 -0
- package/dist/models/OAuthApplication.d.ts +84 -0
- package/dist/models/OAuthApplication.js +76 -0
- package/dist/models/OAuthApplicationResponse.d.ts +98 -0
- package/dist/models/OAuthApplicationResponse.js +88 -0
- package/dist/models/PaginatedDivisionReadOnlyList.d.ts +51 -0
- package/dist/models/PaginatedDivisionReadOnlyList.js +63 -0
- package/dist/models/PaginatedV2ProfileListItemList.d.ts +51 -0
- package/dist/models/PaginatedV2ProfileListItemList.js +63 -0
- package/dist/models/PaginatedV2ScreeningListItemList.d.ts +51 -0
- package/dist/models/PaginatedV2ScreeningListItemList.js +63 -0
- package/dist/models/PatchedDivisionWrite.d.ts +98 -0
- package/dist/models/PatchedDivisionWrite.js +69 -0
- package/dist/models/PatchedV2ProfilePartialUpdate.d.ts +39 -0
- package/dist/models/PatchedV2ProfilePartialUpdate.js +50 -0
- package/dist/models/TokenRefresh.d.ts +38 -0
- package/dist/models/TokenRefresh.js +51 -0
- package/dist/models/V2Candidate.d.ts +592 -0
- package/dist/models/V2Candidate.js +326 -0
- package/dist/models/V2CheckField.d.ts +56 -0
- package/dist/models/V2CheckField.js +60 -0
- package/dist/models/V2CheckInfo.d.ts +100 -0
- package/dist/models/V2CheckInfo.js +83 -0
- package/dist/models/V2Document.d.ts +115 -0
- package/dist/models/V2Document.js +92 -0
- package/dist/models/V2DocumentContent.d.ts +40 -0
- package/dist/models/V2DocumentContent.js +52 -0
- package/dist/models/V2Money.d.ts +38 -0
- package/dist/models/V2Money.js +54 -0
- package/dist/models/V2ProfileCheck.d.ts +85 -0
- package/dist/models/V2ProfileCheck.js +76 -0
- package/dist/models/V2ProfileCheckEntry.d.ts +120 -0
- package/dist/models/V2ProfileCheckEntry.js +95 -0
- package/dist/models/V2ProfileCreate.d.ts +45 -0
- package/dist/models/V2ProfileCreate.js +57 -0
- package/dist/models/V2ProfileDetail.d.ts +94 -0
- package/dist/models/V2ProfileDetail.js +82 -0
- package/dist/models/V2ProfileListItem.d.ts +68 -0
- package/dist/models/V2ProfileListItem.js +68 -0
- package/dist/models/V2ProfileUpdate.d.ts +47 -0
- package/dist/models/V2ProfileUpdate.js +57 -0
- package/dist/models/V2ProfileUpdateCheck.d.ts +96 -0
- package/dist/models/V2ProfileUpdateCheck.js +82 -0
- package/dist/models/V2ScreeningCheck.d.ts +95 -0
- package/dist/models/V2ScreeningCheck.js +80 -0
- package/dist/models/V2ScreeningCheckEntry.d.ts +135 -0
- package/dist/models/V2ScreeningCheckEntry.js +100 -0
- package/dist/models/V2ScreeningCheckListItem.d.ts +93 -0
- package/dist/models/V2ScreeningCheckListItem.js +82 -0
- package/dist/models/V2ScreeningCreate.d.ts +46 -0
- package/dist/models/V2ScreeningCreate.js +58 -0
- package/dist/models/V2ScreeningDetail.d.ts +83 -0
- package/dist/models/V2ScreeningDetail.js +77 -0
- package/dist/models/V2ScreeningDetailProfile.d.ts +38 -0
- package/dist/models/V2ScreeningDetailProfile.js +50 -0
- package/dist/models/V2ScreeningListItem.d.ts +85 -0
- package/dist/models/V2ScreeningListItem.js +76 -0
- package/dist/models/VerifyWebhook.d.ts +34 -0
- package/dist/models/VerifyWebhook.js +50 -0
- package/dist/models/Webhook.d.ts +71 -0
- package/dist/models/Webhook.js +77 -0
- package/dist/models/WebhookResponse.d.ts +87 -0
- package/dist/models/WebhookResponse.js +58 -0
- package/dist/models/index.d.ts +36 -0
- package/dist/models/index.js +54 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +365 -0
- package/docs/AuthenticationApi.md +227 -0
- package/docs/ChecksApi.md +150 -0
- package/docs/CustomTokenObtainPair.md +37 -0
- package/docs/DivisionReadOnly.md +62 -0
- package/docs/DivisionWrite.md +56 -0
- package/docs/DivisionsApi.md +380 -0
- package/docs/JWTGeneration.md +41 -0
- package/docs/JWTResponse.md +45 -0
- package/docs/OAuthApi.md +222 -0
- package/docs/OAuthApplication.md +43 -0
- package/docs/OAuthApplicationResponse.md +49 -0
- package/docs/PaginatedDivisionReadOnlyList.md +40 -0
- package/docs/PaginatedV2ProfileListItemList.md +40 -0
- package/docs/PaginatedV2ScreeningListItemList.md +40 -0
- package/docs/PatchedDivisionWrite.md +56 -0
- package/docs/PatchedV2ProfilePartialUpdate.md +37 -0
- package/docs/ProfilesApi.md +456 -0
- package/docs/ScreeningsApi.md +302 -0
- package/docs/TokenRefresh.md +36 -0
- package/docs/V2Candidate.md +53 -0
- package/docs/V2CheckField.md +43 -0
- package/docs/V2CheckInfo.md +57 -0
- package/docs/V2Document.md +45 -0
- package/docs/V2DocumentContent.md +37 -0
- package/docs/V2Money.md +36 -0
- package/docs/V2ProfileCheck.md +37 -0
- package/docs/V2ProfileCheckEntry.md +46 -0
- package/docs/V2ProfileCreate.md +38 -0
- package/docs/V2ProfileDetail.md +54 -0
- package/docs/V2ProfileListItem.md +46 -0
- package/docs/V2ProfileUpdate.md +39 -0
- package/docs/V2ProfileUpdateCheck.md +39 -0
- package/docs/V2ScreeningCheck.md +41 -0
- package/docs/V2ScreeningCheckEntry.md +50 -0
- package/docs/V2ScreeningCheckListItem.md +39 -0
- package/docs/V2ScreeningCreate.md +38 -0
- package/docs/V2ScreeningDetail.md +50 -0
- package/docs/V2ScreeningDetailProfile.md +36 -0
- package/docs/V2ScreeningListItem.md +51 -0
- package/docs/VerifyWebhook.md +35 -0
- package/docs/Webhook.md +43 -0
- package/docs/WebhookResponse.md +53 -0
- package/docs/WebhooksApi.md +305 -0
- package/package.json +25 -0
- package/src/apis/AuthenticationApi.ts +285 -0
- package/src/apis/ChecksApi.ts +181 -0
- package/src/apis/DivisionsApi.ts +462 -0
- package/src/apis/OAuthApi.ts +256 -0
- package/src/apis/ProfilesApi.ts +583 -0
- package/src/apis/ScreeningsApi.ts +376 -0
- package/src/apis/WebhooksApi.ts +363 -0
- package/src/apis/index.ts +9 -0
- package/src/index.ts +5 -0
- package/src/models/CustomTokenObtainPair.ts +75 -0
- package/src/models/DivisionReadOnly.ts +177 -0
- package/src/models/DivisionWrite.ts +160 -0
- package/src/models/JWTGeneration.ts +91 -0
- package/src/models/JWTResponse.ts +110 -0
- package/src/models/OAuthApplication.ts +130 -0
- package/src/models/OAuthApplicationResponse.ts +151 -0
- package/src/models/PaginatedDivisionReadOnlyList.ts +101 -0
- package/src/models/PaginatedV2ProfileListItemList.ts +101 -0
- package/src/models/PaginatedV2ScreeningListItemList.ts +101 -0
- package/src/models/PatchedDivisionWrite.ts +152 -0
- package/src/models/PatchedV2ProfilePartialUpdate.ts +74 -0
- package/src/models/TokenRefresh.ts +73 -0
- package/src/models/V2Candidate.ts +649 -0
- package/src/models/V2CheckField.ts +97 -0
- package/src/models/V2CheckInfo.ts +168 -0
- package/src/models/V2Document.ts +166 -0
- package/src/models/V2DocumentContent.ts +76 -0
- package/src/models/V2Money.ts +75 -0
- package/src/models/V2ProfileCheck.ts +122 -0
- package/src/models/V2ProfileCheckEntry.ts +173 -0
- package/src/models/V2ProfileCreate.ts +91 -0
- package/src/models/V2ProfileDetail.ts +162 -0
- package/src/models/V2ProfileListItem.ts +115 -0
- package/src/models/V2ProfileUpdate.ts +93 -0
- package/src/models/V2ProfileUpdateCheck.ts +135 -0
- package/src/models/V2ScreeningCheck.ts +136 -0
- package/src/models/V2ScreeningCheckEntry.ts +181 -0
- package/src/models/V2ScreeningCheckListItem.ts +133 -0
- package/src/models/V2ScreeningCreate.ts +98 -0
- package/src/models/V2ScreeningDetail.ts +152 -0
- package/src/models/V2ScreeningDetailProfile.ts +73 -0
- package/src/models/V2ScreeningListItem.ts +154 -0
- package/src/models/VerifyWebhook.ts +68 -0
- package/src/models/Webhook.ts +118 -0
- package/src/models/WebhookResponse.ts +140 -0
- package/src/models/index.ts +38 -0
- package/src/runtime.ts +449 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,270 @@
|
|
|
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 PaginatedV2ProfileListItemList } from '../models/PaginatedV2ProfileListItemList';
|
|
14
|
+
import { type PatchedV2ProfilePartialUpdate } from '../models/PatchedV2ProfilePartialUpdate';
|
|
15
|
+
import { type V2ProfileCreate } from '../models/V2ProfileCreate';
|
|
16
|
+
import { type V2ProfileDetail } from '../models/V2ProfileDetail';
|
|
17
|
+
import { type V2ProfileUpdate } from '../models/V2ProfileUpdate';
|
|
18
|
+
export interface V2ProfilesCreateRequest {
|
|
19
|
+
v2ProfileCreate: V2ProfileCreate;
|
|
20
|
+
}
|
|
21
|
+
export interface V2ProfilesDestroyRequest {
|
|
22
|
+
id: string;
|
|
23
|
+
}
|
|
24
|
+
export interface V2ProfilesListRequest {
|
|
25
|
+
checkType?: V2ProfilesListCheckTypeEnum;
|
|
26
|
+
isCustom?: boolean;
|
|
27
|
+
name?: string;
|
|
28
|
+
page?: number;
|
|
29
|
+
pageSize?: number;
|
|
30
|
+
paginate?: boolean;
|
|
31
|
+
sort?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface V2ProfilesPartialUpdateRequest {
|
|
34
|
+
id: string;
|
|
35
|
+
patchedV2ProfilePartialUpdate?: PatchedV2ProfilePartialUpdate;
|
|
36
|
+
}
|
|
37
|
+
export interface V2ProfilesRetrieveRequest {
|
|
38
|
+
id: string;
|
|
39
|
+
}
|
|
40
|
+
export interface V2ProfilesUpdateRequest {
|
|
41
|
+
id: string;
|
|
42
|
+
v2ProfileUpdate: V2ProfileUpdate;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* ProfilesApi - interface
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @interface ProfilesApiInterface
|
|
49
|
+
*/
|
|
50
|
+
export interface ProfilesApiInterface {
|
|
51
|
+
/**
|
|
52
|
+
* Creates request options for v2ProfilesCreate without sending the request
|
|
53
|
+
* @param {V2ProfileCreate} v2ProfileCreate
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
* @memberof ProfilesApiInterface
|
|
56
|
+
*/
|
|
57
|
+
v2ProfilesCreateRequestOpts(requestParameters: V2ProfilesCreateRequest): Promise<runtime.RequestOpts>;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @param {V2ProfileCreate} v2ProfileCreate
|
|
61
|
+
* @param {*} [options] Override http request option.
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
* @memberof ProfilesApiInterface
|
|
64
|
+
*/
|
|
65
|
+
v2ProfilesCreateRaw(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
66
|
+
/**
|
|
67
|
+
*/
|
|
68
|
+
v2ProfilesCreate(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
69
|
+
/**
|
|
70
|
+
* Creates request options for v2ProfilesDestroy without sending the request
|
|
71
|
+
* @param {string} id A UUID string identifying this profile.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
* @memberof ProfilesApiInterface
|
|
74
|
+
*/
|
|
75
|
+
v2ProfilesDestroyRequestOpts(requestParameters: V2ProfilesDestroyRequest): Promise<runtime.RequestOpts>;
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @param {string} id A UUID string identifying this profile.
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
* @memberof ProfilesApiInterface
|
|
82
|
+
*/
|
|
83
|
+
v2ProfilesDestroyRaw(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
84
|
+
/**
|
|
85
|
+
*/
|
|
86
|
+
v2ProfilesDestroy(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
87
|
+
/**
|
|
88
|
+
* Creates request options for v2ProfilesList without sending the request
|
|
89
|
+
* @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.
|
|
90
|
+
* @param {boolean} [isCustom] Restrict to custom (true) or system (false) profiles.
|
|
91
|
+
* @param {string} [name] Restrict to profiles whose name contains this value (case-insensitive).
|
|
92
|
+
* @param {number} [page] A page number within the paginated result set.
|
|
93
|
+
* @param {number} [pageSize] Number of results to return per page.
|
|
94
|
+
* @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
|
|
95
|
+
* @param {string} [sort] Which field to use when ordering the results.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
* @memberof ProfilesApiInterface
|
|
98
|
+
*/
|
|
99
|
+
v2ProfilesListRequestOpts(requestParameters: V2ProfilesListRequest): Promise<runtime.RequestOpts>;
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* @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.
|
|
103
|
+
* @param {boolean} [isCustom] Restrict to custom (true) or system (false) profiles.
|
|
104
|
+
* @param {string} [name] Restrict to profiles whose name contains this value (case-insensitive).
|
|
105
|
+
* @param {number} [page] A page number within the paginated result set.
|
|
106
|
+
* @param {number} [pageSize] Number of results to return per page.
|
|
107
|
+
* @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
|
|
108
|
+
* @param {string} [sort] Which field to use when ordering the results.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
* @memberof ProfilesApiInterface
|
|
112
|
+
*/
|
|
113
|
+
v2ProfilesListRaw(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ProfileListItemList>>;
|
|
114
|
+
/**
|
|
115
|
+
*/
|
|
116
|
+
v2ProfilesList(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ProfileListItemList>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates request options for v2ProfilesPartialUpdate without sending the request
|
|
119
|
+
* @param {string} id A UUID string identifying this profile.
|
|
120
|
+
* @param {PatchedV2ProfilePartialUpdate} [patchedV2ProfilePartialUpdate]
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
* @memberof ProfilesApiInterface
|
|
123
|
+
*/
|
|
124
|
+
v2ProfilesPartialUpdateRequestOpts(requestParameters: V2ProfilesPartialUpdateRequest): Promise<runtime.RequestOpts>;
|
|
125
|
+
/**
|
|
126
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
127
|
+
* @param {string} id A UUID string identifying this profile.
|
|
128
|
+
* @param {PatchedV2ProfilePartialUpdate} [patchedV2ProfilePartialUpdate]
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
* @memberof ProfilesApiInterface
|
|
132
|
+
*/
|
|
133
|
+
v2ProfilesPartialUpdateRaw(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
134
|
+
/**
|
|
135
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
136
|
+
*/
|
|
137
|
+
v2ProfilesPartialUpdate(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
138
|
+
/**
|
|
139
|
+
* Creates request options for v2ProfilesRetrieve without sending the request
|
|
140
|
+
* @param {string} id A UUID string identifying this profile.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
* @memberof ProfilesApiInterface
|
|
143
|
+
*/
|
|
144
|
+
v2ProfilesRetrieveRequestOpts(requestParameters: V2ProfilesRetrieveRequest): Promise<runtime.RequestOpts>;
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
* @param {string} id A UUID string identifying this profile.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
* @memberof ProfilesApiInterface
|
|
151
|
+
*/
|
|
152
|
+
v2ProfilesRetrieveRaw(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
153
|
+
/**
|
|
154
|
+
*/
|
|
155
|
+
v2ProfilesRetrieve(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
156
|
+
/**
|
|
157
|
+
* Creates request options for v2ProfilesUpdate without sending the request
|
|
158
|
+
* @param {string} id A UUID string identifying this profile.
|
|
159
|
+
* @param {V2ProfileUpdate} v2ProfileUpdate
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
* @memberof ProfilesApiInterface
|
|
162
|
+
*/
|
|
163
|
+
v2ProfilesUpdateRequestOpts(requestParameters: V2ProfilesUpdateRequest): Promise<runtime.RequestOpts>;
|
|
164
|
+
/**
|
|
165
|
+
* 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.
|
|
166
|
+
* @param {string} id A UUID string identifying this profile.
|
|
167
|
+
* @param {V2ProfileUpdate} v2ProfileUpdate
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
* @memberof ProfilesApiInterface
|
|
171
|
+
*/
|
|
172
|
+
v2ProfilesUpdateRaw(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
173
|
+
/**
|
|
174
|
+
* 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.
|
|
175
|
+
*/
|
|
176
|
+
v2ProfilesUpdate(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
*/
|
|
181
|
+
export declare class ProfilesApi extends runtime.BaseAPI implements ProfilesApiInterface {
|
|
182
|
+
/**
|
|
183
|
+
* Creates request options for v2ProfilesCreate without sending the request
|
|
184
|
+
*/
|
|
185
|
+
v2ProfilesCreateRequestOpts(requestParameters: V2ProfilesCreateRequest): Promise<runtime.RequestOpts>;
|
|
186
|
+
/**
|
|
187
|
+
*/
|
|
188
|
+
v2ProfilesCreateRaw(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
189
|
+
/**
|
|
190
|
+
*/
|
|
191
|
+
v2ProfilesCreate(requestParameters: V2ProfilesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
192
|
+
/**
|
|
193
|
+
* Creates request options for v2ProfilesDestroy without sending the request
|
|
194
|
+
*/
|
|
195
|
+
v2ProfilesDestroyRequestOpts(requestParameters: V2ProfilesDestroyRequest): Promise<runtime.RequestOpts>;
|
|
196
|
+
/**
|
|
197
|
+
*/
|
|
198
|
+
v2ProfilesDestroyRaw(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
199
|
+
/**
|
|
200
|
+
*/
|
|
201
|
+
v2ProfilesDestroy(requestParameters: V2ProfilesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
202
|
+
/**
|
|
203
|
+
* Creates request options for v2ProfilesList without sending the request
|
|
204
|
+
*/
|
|
205
|
+
v2ProfilesListRequestOpts(requestParameters: V2ProfilesListRequest): Promise<runtime.RequestOpts>;
|
|
206
|
+
/**
|
|
207
|
+
*/
|
|
208
|
+
v2ProfilesListRaw(requestParameters: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ProfileListItemList>>;
|
|
209
|
+
/**
|
|
210
|
+
*/
|
|
211
|
+
v2ProfilesList(requestParameters?: V2ProfilesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ProfileListItemList>;
|
|
212
|
+
/**
|
|
213
|
+
* Creates request options for v2ProfilesPartialUpdate without sending the request
|
|
214
|
+
*/
|
|
215
|
+
v2ProfilesPartialUpdateRequestOpts(requestParameters: V2ProfilesPartialUpdateRequest): Promise<runtime.RequestOpts>;
|
|
216
|
+
/**
|
|
217
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
218
|
+
*/
|
|
219
|
+
v2ProfilesPartialUpdateRaw(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
220
|
+
/**
|
|
221
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
222
|
+
*/
|
|
223
|
+
v2ProfilesPartialUpdate(requestParameters: V2ProfilesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
224
|
+
/**
|
|
225
|
+
* Creates request options for v2ProfilesRetrieve without sending the request
|
|
226
|
+
*/
|
|
227
|
+
v2ProfilesRetrieveRequestOpts(requestParameters: V2ProfilesRetrieveRequest): Promise<runtime.RequestOpts>;
|
|
228
|
+
/**
|
|
229
|
+
*/
|
|
230
|
+
v2ProfilesRetrieveRaw(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
231
|
+
/**
|
|
232
|
+
*/
|
|
233
|
+
v2ProfilesRetrieve(requestParameters: V2ProfilesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
234
|
+
/**
|
|
235
|
+
* Creates request options for v2ProfilesUpdate without sending the request
|
|
236
|
+
*/
|
|
237
|
+
v2ProfilesUpdateRequestOpts(requestParameters: V2ProfilesUpdateRequest): Promise<runtime.RequestOpts>;
|
|
238
|
+
/**
|
|
239
|
+
* 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.
|
|
240
|
+
*/
|
|
241
|
+
v2ProfilesUpdateRaw(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ProfileDetail>>;
|
|
242
|
+
/**
|
|
243
|
+
* 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.
|
|
244
|
+
*/
|
|
245
|
+
v2ProfilesUpdate(requestParameters: V2ProfilesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ProfileDetail>;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* @export
|
|
249
|
+
*/
|
|
250
|
+
export declare const V2ProfilesListCheckTypeEnum: {
|
|
251
|
+
readonly Addresscheck: "addresscheck";
|
|
252
|
+
readonly Adversemediacheck: "adversemediacheck";
|
|
253
|
+
readonly Bigcheck: "bigcheck";
|
|
254
|
+
readonly Criminalrecordscheck: "criminalrecordscheck";
|
|
255
|
+
readonly Criminalrecordsuploadcheck: "criminalrecordsuploadcheck";
|
|
256
|
+
readonly Customintegritycheck: "customintegritycheck";
|
|
257
|
+
readonly Cvcheck: "cvcheck";
|
|
258
|
+
readonly Edrcheck: "edrcheck";
|
|
259
|
+
readonly Id2check: "id2check";
|
|
260
|
+
readonly Integritycheck: "integritycheck";
|
|
261
|
+
readonly Openhealthcarecheck: "openhealthcarecheck";
|
|
262
|
+
readonly Qualificationcheck: "qualificationcheck";
|
|
263
|
+
readonly Righttoworkcheck: "righttoworkcheck";
|
|
264
|
+
readonly Vogcheck: "vogcheck";
|
|
265
|
+
readonly Watchlist2check: "watchlist2check";
|
|
266
|
+
readonly Watchlistcheck: "watchlistcheck";
|
|
267
|
+
readonly Workreferencecheck: "workreferencecheck";
|
|
268
|
+
readonly Worldwidecreditcheck: "worldwidecreditcheck";
|
|
269
|
+
};
|
|
270
|
+
export type V2ProfilesListCheckTypeEnum = typeof V2ProfilesListCheckTypeEnum[keyof typeof V2ProfilesListCheckTypeEnum];
|
|
@@ -0,0 +1,334 @@
|
|
|
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.V2ProfilesListCheckTypeEnum = exports.ProfilesApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const PaginatedV2ProfileListItemList_1 = require("../models/PaginatedV2ProfileListItemList");
|
|
28
|
+
const PatchedV2ProfilePartialUpdate_1 = require("../models/PatchedV2ProfilePartialUpdate");
|
|
29
|
+
const V2ProfileCreate_1 = require("../models/V2ProfileCreate");
|
|
30
|
+
const V2ProfileDetail_1 = require("../models/V2ProfileDetail");
|
|
31
|
+
const V2ProfileUpdate_1 = require("../models/V2ProfileUpdate");
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
class ProfilesApi extends runtime.BaseAPI {
|
|
36
|
+
/**
|
|
37
|
+
* Creates request options for v2ProfilesCreate without sending the request
|
|
38
|
+
*/
|
|
39
|
+
v2ProfilesCreateRequestOpts(requestParameters) {
|
|
40
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
41
|
+
if (requestParameters['v2ProfileCreate'] == null) {
|
|
42
|
+
throw new runtime.RequiredError('v2ProfileCreate', 'Required parameter "v2ProfileCreate" was null or undefined when calling v2ProfilesCreate().');
|
|
43
|
+
}
|
|
44
|
+
const queryParameters = {};
|
|
45
|
+
const headerParameters = {};
|
|
46
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
47
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
48
|
+
// oauth required
|
|
49
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
50
|
+
}
|
|
51
|
+
let urlPath = `/api/v2/profiles/`;
|
|
52
|
+
return {
|
|
53
|
+
path: urlPath,
|
|
54
|
+
method: 'POST',
|
|
55
|
+
headers: headerParameters,
|
|
56
|
+
query: queryParameters,
|
|
57
|
+
body: (0, V2ProfileCreate_1.V2ProfileCreateToJSON)(requestParameters['v2ProfileCreate']),
|
|
58
|
+
};
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*/
|
|
63
|
+
v2ProfilesCreateRaw(requestParameters, initOverrides) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
+
const requestOptions = yield this.v2ProfilesCreateRequestOpts(requestParameters);
|
|
66
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
67
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ProfileDetail_1.V2ProfileDetailFromJSON)(jsonValue));
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
*/
|
|
72
|
+
v2ProfilesCreate(requestParameters, initOverrides) {
|
|
73
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
74
|
+
const response = yield this.v2ProfilesCreateRaw(requestParameters, initOverrides);
|
|
75
|
+
return yield response.value();
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Creates request options for v2ProfilesDestroy without sending the request
|
|
80
|
+
*/
|
|
81
|
+
v2ProfilesDestroyRequestOpts(requestParameters) {
|
|
82
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
83
|
+
if (requestParameters['id'] == null) {
|
|
84
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ProfilesDestroy().');
|
|
85
|
+
}
|
|
86
|
+
const queryParameters = {};
|
|
87
|
+
const headerParameters = {};
|
|
88
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
89
|
+
// oauth required
|
|
90
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
91
|
+
}
|
|
92
|
+
let urlPath = `/api/v2/profiles/{id}/`;
|
|
93
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
94
|
+
return {
|
|
95
|
+
path: urlPath,
|
|
96
|
+
method: 'DELETE',
|
|
97
|
+
headers: headerParameters,
|
|
98
|
+
query: queryParameters,
|
|
99
|
+
};
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
*/
|
|
104
|
+
v2ProfilesDestroyRaw(requestParameters, initOverrides) {
|
|
105
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
106
|
+
const requestOptions = yield this.v2ProfilesDestroyRequestOpts(requestParameters);
|
|
107
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
108
|
+
return new runtime.VoidApiResponse(response);
|
|
109
|
+
});
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
*/
|
|
113
|
+
v2ProfilesDestroy(requestParameters, initOverrides) {
|
|
114
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
115
|
+
yield this.v2ProfilesDestroyRaw(requestParameters, initOverrides);
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Creates request options for v2ProfilesList without sending the request
|
|
120
|
+
*/
|
|
121
|
+
v2ProfilesListRequestOpts(requestParameters) {
|
|
122
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
123
|
+
const queryParameters = {};
|
|
124
|
+
if (requestParameters['checkType'] != null) {
|
|
125
|
+
queryParameters['check_type'] = requestParameters['checkType'];
|
|
126
|
+
}
|
|
127
|
+
if (requestParameters['isCustom'] != null) {
|
|
128
|
+
queryParameters['is_custom'] = requestParameters['isCustom'];
|
|
129
|
+
}
|
|
130
|
+
if (requestParameters['name'] != null) {
|
|
131
|
+
queryParameters['name'] = requestParameters['name'];
|
|
132
|
+
}
|
|
133
|
+
if (requestParameters['page'] != null) {
|
|
134
|
+
queryParameters['page'] = requestParameters['page'];
|
|
135
|
+
}
|
|
136
|
+
if (requestParameters['pageSize'] != null) {
|
|
137
|
+
queryParameters['page_size'] = requestParameters['pageSize'];
|
|
138
|
+
}
|
|
139
|
+
if (requestParameters['paginate'] != null) {
|
|
140
|
+
queryParameters['paginate'] = requestParameters['paginate'];
|
|
141
|
+
}
|
|
142
|
+
if (requestParameters['sort'] != null) {
|
|
143
|
+
queryParameters['sort'] = requestParameters['sort'];
|
|
144
|
+
}
|
|
145
|
+
const headerParameters = {};
|
|
146
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
147
|
+
// oauth required
|
|
148
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
149
|
+
}
|
|
150
|
+
let urlPath = `/api/v2/profiles/`;
|
|
151
|
+
return {
|
|
152
|
+
path: urlPath,
|
|
153
|
+
method: 'GET',
|
|
154
|
+
headers: headerParameters,
|
|
155
|
+
query: queryParameters,
|
|
156
|
+
};
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
*/
|
|
161
|
+
v2ProfilesListRaw(requestParameters, initOverrides) {
|
|
162
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
163
|
+
const requestOptions = yield this.v2ProfilesListRequestOpts(requestParameters);
|
|
164
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
165
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, PaginatedV2ProfileListItemList_1.PaginatedV2ProfileListItemListFromJSON)(jsonValue));
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
*/
|
|
170
|
+
v2ProfilesList() {
|
|
171
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
172
|
+
const response = yield this.v2ProfilesListRaw(requestParameters, initOverrides);
|
|
173
|
+
return yield response.value();
|
|
174
|
+
});
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Creates request options for v2ProfilesPartialUpdate without sending the request
|
|
178
|
+
*/
|
|
179
|
+
v2ProfilesPartialUpdateRequestOpts(requestParameters) {
|
|
180
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
181
|
+
if (requestParameters['id'] == null) {
|
|
182
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ProfilesPartialUpdate().');
|
|
183
|
+
}
|
|
184
|
+
const queryParameters = {};
|
|
185
|
+
const headerParameters = {};
|
|
186
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
187
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
188
|
+
// oauth required
|
|
189
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
190
|
+
}
|
|
191
|
+
let urlPath = `/api/v2/profiles/{id}/`;
|
|
192
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
193
|
+
return {
|
|
194
|
+
path: urlPath,
|
|
195
|
+
method: 'PATCH',
|
|
196
|
+
headers: headerParameters,
|
|
197
|
+
query: queryParameters,
|
|
198
|
+
body: (0, PatchedV2ProfilePartialUpdate_1.PatchedV2ProfilePartialUpdateToJSON)(requestParameters['patchedV2ProfilePartialUpdate']),
|
|
199
|
+
};
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
204
|
+
*/
|
|
205
|
+
v2ProfilesPartialUpdateRaw(requestParameters, initOverrides) {
|
|
206
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
207
|
+
const requestOptions = yield this.v2ProfilesPartialUpdateRequestOpts(requestParameters);
|
|
208
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
209
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ProfileDetail_1.V2ProfileDetailFromJSON)(jsonValue));
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Update name and/or description only. Use PUT to change the check list.
|
|
214
|
+
*/
|
|
215
|
+
v2ProfilesPartialUpdate(requestParameters, initOverrides) {
|
|
216
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
217
|
+
const response = yield this.v2ProfilesPartialUpdateRaw(requestParameters, initOverrides);
|
|
218
|
+
return yield response.value();
|
|
219
|
+
});
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Creates request options for v2ProfilesRetrieve without sending the request
|
|
223
|
+
*/
|
|
224
|
+
v2ProfilesRetrieveRequestOpts(requestParameters) {
|
|
225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
226
|
+
if (requestParameters['id'] == null) {
|
|
227
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ProfilesRetrieve().');
|
|
228
|
+
}
|
|
229
|
+
const queryParameters = {};
|
|
230
|
+
const headerParameters = {};
|
|
231
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
232
|
+
// oauth required
|
|
233
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
234
|
+
}
|
|
235
|
+
let urlPath = `/api/v2/profiles/{id}/`;
|
|
236
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
237
|
+
return {
|
|
238
|
+
path: urlPath,
|
|
239
|
+
method: 'GET',
|
|
240
|
+
headers: headerParameters,
|
|
241
|
+
query: queryParameters,
|
|
242
|
+
};
|
|
243
|
+
});
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
*/
|
|
247
|
+
v2ProfilesRetrieveRaw(requestParameters, initOverrides) {
|
|
248
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
249
|
+
const requestOptions = yield this.v2ProfilesRetrieveRequestOpts(requestParameters);
|
|
250
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
251
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ProfileDetail_1.V2ProfileDetailFromJSON)(jsonValue));
|
|
252
|
+
});
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
*/
|
|
256
|
+
v2ProfilesRetrieve(requestParameters, initOverrides) {
|
|
257
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
258
|
+
const response = yield this.v2ProfilesRetrieveRaw(requestParameters, initOverrides);
|
|
259
|
+
return yield response.value();
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Creates request options for v2ProfilesUpdate without sending the request
|
|
264
|
+
*/
|
|
265
|
+
v2ProfilesUpdateRequestOpts(requestParameters) {
|
|
266
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
267
|
+
if (requestParameters['id'] == null) {
|
|
268
|
+
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2ProfilesUpdate().');
|
|
269
|
+
}
|
|
270
|
+
if (requestParameters['v2ProfileUpdate'] == null) {
|
|
271
|
+
throw new runtime.RequiredError('v2ProfileUpdate', 'Required parameter "v2ProfileUpdate" was null or undefined when calling v2ProfilesUpdate().');
|
|
272
|
+
}
|
|
273
|
+
const queryParameters = {};
|
|
274
|
+
const headerParameters = {};
|
|
275
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
276
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
277
|
+
// oauth required
|
|
278
|
+
headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
|
|
279
|
+
}
|
|
280
|
+
let urlPath = `/api/v2/profiles/{id}/`;
|
|
281
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
282
|
+
return {
|
|
283
|
+
path: urlPath,
|
|
284
|
+
method: 'PUT',
|
|
285
|
+
headers: headerParameters,
|
|
286
|
+
query: queryParameters,
|
|
287
|
+
body: (0, V2ProfileUpdate_1.V2ProfileUpdateToJSON)(requestParameters['v2ProfileUpdate']),
|
|
288
|
+
};
|
|
289
|
+
});
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* 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.
|
|
293
|
+
*/
|
|
294
|
+
v2ProfilesUpdateRaw(requestParameters, initOverrides) {
|
|
295
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
296
|
+
const requestOptions = yield this.v2ProfilesUpdateRequestOpts(requestParameters);
|
|
297
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
298
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, V2ProfileDetail_1.V2ProfileDetailFromJSON)(jsonValue));
|
|
299
|
+
});
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* 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.
|
|
303
|
+
*/
|
|
304
|
+
v2ProfilesUpdate(requestParameters, initOverrides) {
|
|
305
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
306
|
+
const response = yield this.v2ProfilesUpdateRaw(requestParameters, initOverrides);
|
|
307
|
+
return yield response.value();
|
|
308
|
+
});
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
exports.ProfilesApi = ProfilesApi;
|
|
312
|
+
/**
|
|
313
|
+
* @export
|
|
314
|
+
*/
|
|
315
|
+
exports.V2ProfilesListCheckTypeEnum = {
|
|
316
|
+
Addresscheck: 'addresscheck',
|
|
317
|
+
Adversemediacheck: 'adversemediacheck',
|
|
318
|
+
Bigcheck: 'bigcheck',
|
|
319
|
+
Criminalrecordscheck: 'criminalrecordscheck',
|
|
320
|
+
Criminalrecordsuploadcheck: 'criminalrecordsuploadcheck',
|
|
321
|
+
Customintegritycheck: 'customintegritycheck',
|
|
322
|
+
Cvcheck: 'cvcheck',
|
|
323
|
+
Edrcheck: 'edrcheck',
|
|
324
|
+
Id2check: 'id2check',
|
|
325
|
+
Integritycheck: 'integritycheck',
|
|
326
|
+
Openhealthcarecheck: 'openhealthcarecheck',
|
|
327
|
+
Qualificationcheck: 'qualificationcheck',
|
|
328
|
+
Righttoworkcheck: 'righttoworkcheck',
|
|
329
|
+
Vogcheck: 'vogcheck',
|
|
330
|
+
Watchlist2check: 'watchlist2check',
|
|
331
|
+
Watchlistcheck: 'watchlistcheck',
|
|
332
|
+
Workreferencecheck: 'workreferencecheck',
|
|
333
|
+
Worldwidecreditcheck: 'worldwidecreditcheck'
|
|
334
|
+
};
|