pescheck-client 0.4.1 → 0.4.3

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 (34) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -0
  3. data/docs/AuthenticationApi.md +2 -2
  4. data/docs/CustomTokenObtainPair.md +2 -0
  5. data/docs/V2Document.md +1 -1
  6. data/docs/V2ProfileCheck.md +1 -1
  7. data/docs/V2ProfileCheckEntry.md +1 -1
  8. data/docs/V2ProfileUpdateCheck.md +1 -1
  9. data/docs/V2ScreeningCheck.md +1 -1
  10. data/docs/V2ScreeningCheckEntry.md +1 -1
  11. data/docs/V2ScreeningCheckListItem.md +1 -1
  12. data/docs/V2ScreeningCreate.md +3 -1
  13. data/docs/V2ScreeningDetail.md +2 -0
  14. data/docs/V2ScreeningNote.md +24 -0
  15. data/docs/V2ScreeningNoteInput.md +22 -0
  16. data/lib/pescheck-client/api/authentication_api.rb +4 -4
  17. data/lib/pescheck-client/api/profiles_api.rb +1 -1
  18. data/lib/pescheck-client/models/custom_token_obtain_pair.rb +12 -2
  19. data/lib/pescheck-client/models/v2_document.rb +3 -3
  20. data/lib/pescheck-client/models/v2_profile_check.rb +3 -3
  21. data/lib/pescheck-client/models/v2_profile_check_entry.rb +3 -3
  22. data/lib/pescheck-client/models/v2_profile_update_check.rb +3 -3
  23. data/lib/pescheck-client/models/v2_screening_check.rb +3 -3
  24. data/lib/pescheck-client/models/v2_screening_check_entry.rb +3 -3
  25. data/lib/pescheck-client/models/v2_screening_check_list_item.rb +3 -3
  26. data/lib/pescheck-client/models/v2_screening_create.rb +15 -4
  27. data/lib/pescheck-client/models/v2_screening_detail.rb +29 -1
  28. data/lib/pescheck-client/models/v2_screening_note.rb +229 -0
  29. data/lib/pescheck-client/models/v2_screening_note_input.rb +220 -0
  30. data/lib/pescheck-client/version.rb +1 -1
  31. data/lib/pescheck-client.rb +2 -0
  32. data/spec/models/v2_screening_note_input_spec.rb +52 -0
  33. data/spec/models/v2_screening_note_spec.rb +54 -0
  34. metadata +10 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2b64e4be5032d2ed714e57c73fe6d3d7575019841aeba43e981ddb680e10bb25
4
- data.tar.gz: c6ed3118e42c21963c32b3105249f123cc456a3cdbc061952f5644d888b69c22
3
+ metadata.gz: cbf25e5cbec40d507d974672a21cadc5b283419b6a82edc9cc6c35cfaf8ac5d0
4
+ data.tar.gz: 3589b36e2f33e56e5b0bc75ebd6e8d9d3a9b29a58f43f6b75dbda99fcc66abed
5
5
  SHA512:
6
- metadata.gz: 329cad683e87a7deb6e0fb2490381b827e0267aac4163026cbcc9191d3e451d9d5c0f87e666523f7ee17d1f762ab3d3755a6417da079bcdc7bdd6dcc0016d90c
7
- data.tar.gz: 0d5998b9c3c06c0b4e1fad16a9f071b94b07fc4fbdf8d0a70ff331dac7e4fc271f1764941344831130031cc452dd8aea69e97e2569d9ff644a392f31991f213e
6
+ metadata.gz: 01a3883aeed04b70a76eecf4193f12ed3f41d9cd2dbc0673e6ff493fdd08bbe526ca6501796c382e3de0aa81343b1849a7e22d1ba24a33dd07c1c8f49cf343d8
7
+ data.tar.gz: 07c017dba7904d34a1c6d98f7d5ea534b6f9b6bc05cde64368324ab806260d98872955d1ec06d0ea145fdc9cbb765729ec39111cd55ba42a6155649e7b74f659
data/README.md CHANGED
@@ -151,6 +151,8 @@ Class | Method | HTTP request | Description
151
151
  - [Pescheck::V2ScreeningDetail](docs/V2ScreeningDetail.md)
152
152
  - [Pescheck::V2ScreeningDetailProfile](docs/V2ScreeningDetailProfile.md)
153
153
  - [Pescheck::V2ScreeningListItem](docs/V2ScreeningListItem.md)
154
+ - [Pescheck::V2ScreeningNote](docs/V2ScreeningNote.md)
155
+ - [Pescheck::V2ScreeningNoteInput](docs/V2ScreeningNoteInput.md)
154
156
  - [Pescheck::VerifyWebhook](docs/VerifyWebhook.md)
155
157
  - [Pescheck::Webhook](docs/Webhook.md)
156
158
  - [Pescheck::WebhookResponse](docs/WebhookResponse.md)
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.pescheck.io*
15
15
 
16
16
 
17
17
 
18
- Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org). For a plain login, use POST /api/jwt/.
18
+ Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id. Without it, your single organization is used; accounts with access to more than one organization must specify one. For a plain login, use POST /api/jwt/.
19
19
 
20
20
  ### Examples
21
21
 
@@ -84,7 +84,7 @@ end
84
84
 
85
85
 
86
86
 
87
- Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available). For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
87
+ Log in with email + password. Returns a JWT pair scoped to one organization. Pass organization_id to select the organization or division to act for; it is required when your account has access to more than one. Without it, your single organization is used.
88
88
 
89
89
  ### Examples
90
90
 
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **organization_id** | **String** | Organization or division ID to scope the token to. Required when your account has access to more than one organization. | [optional] |
7
8
  | **email** | **String** | | |
8
9
  | **password** | **String** | | |
9
10
 
@@ -13,6 +14,7 @@
13
14
  require 'pescheck-client'
14
15
 
15
16
  instance = Pescheck::CustomTokenObtainPair.new(
17
+ organization_id: null,
16
18
  email: null,
17
19
  password: null
18
20
  )
data/docs/V2Document.md CHANGED
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **check_id** | **String** | | [readonly] |
8
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
8
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
9
9
  | **filename** | **String** | | [readonly] |
10
10
  | **extension** | **String** | | [readonly] |
11
11
  | **content** | [**V2DocumentContent**](V2DocumentContent.md) | | [readonly] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
7
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
8
8
  | **config** | **Hash<String, Object>** | | [optional] |
9
9
 
10
10
  ## Example
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [readonly] |
8
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
8
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
9
9
  | **display_name** | **String** | | [readonly] |
10
10
  | **configured_price** | [**V2Money**](V2Money.md) | | [readonly] |
11
11
  | **config** | **Hash<String, Object>** | | [readonly] |
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
7
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
8
8
  | **config** | **Hash<String, Object>** | | [optional] |
9
9
  | **profile_check_id** | **String** | | [optional] |
10
10
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
7
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | |
8
8
  | **config** | **Hash<String, Object>** | | [optional] |
9
9
  | **profile_check_id** | **String** | Disambiguator. Use when the profile has multiple ProfileChecks of the same check_type. | [optional] |
10
10
  | **input** | **Object** | | [optional] |
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [readonly] |
8
8
  | **profile_check_id** | **String** | | [readonly] |
9
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
9
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
10
10
  | **display_name** | **String** | | [readonly] |
11
11
  | **status** | **String** | | [readonly] |
12
12
  | **config** | **Hash<String, Object>** | | [readonly] |
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [readonly] |
8
- | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
8
+ | **check_type** | **String** | * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [readonly] |
9
9
  | **status** | **String** | | [readonly] |
10
10
 
11
11
  ## Example
@@ -7,6 +7,7 @@
7
7
  | **profile_id** | **String** | | |
8
8
  | **candidate** | [**V2Candidate**](V2Candidate.md) | | |
9
9
  | **checks** | [**Array<V2ScreeningCheck>**](V2ScreeningCheck.md) | | [optional] |
10
+ | **screening_notes** | [**Array<V2ScreeningNoteInput>**](V2ScreeningNoteInput.md) | | [optional] |
10
11
 
11
12
  ## Example
12
13
 
@@ -16,7 +17,8 @@ require 'pescheck-client'
16
17
  instance = Pescheck::V2ScreeningCreate.new(
17
18
  profile_id: null,
18
19
  candidate: null,
19
- checks: null
20
+ checks: null,
21
+ screening_notes: null
20
22
  )
21
23
  ```
22
24
 
@@ -9,6 +9,7 @@
9
9
  | **profile** | [**V2ScreeningDetailProfile**](V2ScreeningDetailProfile.md) | | |
10
10
  | **candidate** | [**V2Candidate**](V2Candidate.md) | | [readonly] |
11
11
  | **checks** | [**Array<V2ScreeningCheckEntry>**](V2ScreeningCheckEntry.md) | | [readonly] |
12
+ | **screening_notes** | [**Array<V2ScreeningNote>**](V2ScreeningNote.md) | | [readonly] |
12
13
  | **candidate_wizard_url** | **String** | Public wizard URL for the candidate. Null when no check needs candidate input. | [readonly] |
13
14
  | **dashboard_url** | **String** | Dashboard URL for this screening. | [readonly] |
14
15
  | **created_at** | **Time** | | [readonly] |
@@ -25,6 +26,7 @@ instance = Pescheck::V2ScreeningDetail.new(
25
26
  profile: null,
26
27
  candidate: null,
27
28
  checks: null,
29
+ screening_notes: null,
28
30
  candidate_wizard_url: null,
29
31
  dashboard_url: null,
30
32
  created_at: null,
@@ -0,0 +1,24 @@
1
+ # Pescheck::V2ScreeningNote
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **note** | **String** | | |
8
+ | **check_type** | **String** | | |
9
+ | **check_id** | **String** | | |
10
+ | **created_at** | **Time** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pescheck-client'
16
+
17
+ instance = Pescheck::V2ScreeningNote.new(
18
+ note: null,
19
+ check_type: null,
20
+ check_id: null,
21
+ created_at: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # Pescheck::V2ScreeningNoteInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **note** | **String** | | |
8
+ | **profile_check_id** | **String** | Links the note to the Check spawned from this ProfileCheck. Wins over check_type. | [optional] |
9
+ | **check_type** | **String** | Scope the note to a check type. Ignored when profile_check_id is given. * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pescheck-client'
15
+
16
+ instance = Pescheck::V2ScreeningNoteInput.new(
17
+ note: null,
18
+ profile_check_id: null,
19
+ check_type: null
20
+ )
21
+ ```
22
+
@@ -19,7 +19,7 @@ module Pescheck
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org). For a plain login, use POST /api/jwt/.
22
+ # Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id. Without it, your single organization is used; accounts with access to more than one organization must specify one. For a plain login, use POST /api/jwt/.
23
23
  # @param jwt_generation [JWTGeneration]
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [JWTResponse]
@@ -28,7 +28,7 @@ module Pescheck
28
28
  data
29
29
  end
30
30
 
31
- # Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org). For a plain login, use POST /api/jwt/.
31
+ # Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id. Without it, your single organization is used; accounts with access to more than one organization must specify one. For a plain login, use POST /api/jwt/.
32
32
  # @param jwt_generation [JWTGeneration]
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(JWTResponse, Integer, Hash)>] JWTResponse data, response status code and response headers
@@ -85,7 +85,7 @@ module Pescheck
85
85
  return data, status_code, headers
86
86
  end
87
87
 
88
- # Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available). For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
88
+ # Log in with email + password. Returns a JWT pair scoped to one organization. Pass organization_id to select the organization or division to act for; it is required when your account has access to more than one. Without it, your single organization is used.
89
89
  # @param custom_token_obtain_pair [CustomTokenObtainPair]
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [CustomTokenObtainPair]
@@ -94,7 +94,7 @@ module Pescheck
94
94
  data
95
95
  end
96
96
 
97
- # Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available). For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
97
+ # Log in with email + password. Returns a JWT pair scoped to one organization. Pass organization_id to select the organization or division to act for; it is required when your account has access to more than one. Without it, your single organization is used.
98
98
  # @param custom_token_obtain_pair [CustomTokenObtainPair]
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [Array<(CustomTokenObtainPair, Integer, Hash)>] CustomTokenObtainPair data, response status code and response headers
@@ -167,7 +167,7 @@ module Pescheck
167
167
  if @api_client.config.debugging
168
168
  @api_client.config.logger.debug 'Calling API: ProfilesApi.v2_profiles_list ...'
169
169
  end
170
- allowable_values = ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"]
170
+ allowable_values = ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"]
171
171
  if @api_client.config.client_side_validation && opts[:'check_type'] && !allowable_values.include?(opts[:'check_type'])
172
172
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{allowable_values}"
173
173
  end
@@ -14,8 +14,11 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Pescheck
17
- # Custom JWT serializer that includes organization information in the token.
17
+ # Custom JWT serializer that scopes the token to one organization. The organization comes from the optional ``organization_id`` field, or from the user's single organization when the field is absent. Users with access to multiple organizations must pass ``organization_id`` explicitly; the token is never scoped implicitly (e.g. via the last viewed organization, which is mutable web-UI state).
18
18
  class CustomTokenObtainPair < ApiModelBase
19
+ # Organization or division ID to scope the token to. Required when your account has access to more than one organization.
20
+ attr_accessor :organization_id
21
+
19
22
  attr_accessor :email
20
23
 
21
24
  attr_accessor :password
@@ -23,6 +26,7 @@ module Pescheck
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
29
+ :'organization_id' => :'organization_id',
26
30
  :'email' => :'email',
27
31
  :'password' => :'password'
28
32
  }
@@ -41,6 +45,7 @@ module Pescheck
41
45
  # Attribute type mapping.
42
46
  def self.openapi_types
43
47
  {
48
+ :'organization_id' => :'String',
44
49
  :'email' => :'String',
45
50
  :'password' => :'String'
46
51
  }
@@ -68,6 +73,10 @@ module Pescheck
68
73
  h[k.to_sym] = v
69
74
  }
70
75
 
76
+ if attributes.key?(:'organization_id')
77
+ self.organization_id = attributes[:'organization_id']
78
+ end
79
+
71
80
  if attributes.key?(:'email')
72
81
  self.email = attributes[:'email']
73
82
  else
@@ -131,6 +140,7 @@ module Pescheck
131
140
  def ==(o)
132
141
  return true if self.equal?(o)
133
142
  self.class == o.class &&
143
+ organization_id == o.organization_id &&
134
144
  email == o.email &&
135
145
  password == o.password
136
146
  end
@@ -144,7 +154,7 @@ module Pescheck
144
154
  # Calculates hash code according to all attributes.
145
155
  # @return [Integer] Hash code
146
156
  def hash
147
- [email, password].hash
157
+ [organization_id, email, password].hash
148
158
  end
149
159
 
150
160
  # Builds the object from hash
@@ -18,7 +18,7 @@ module Pescheck
18
18
  class V2Document < ApiModelBase
19
19
  attr_accessor :check_id
20
20
 
21
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
21
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
22
22
  attr_accessor :check_type
23
23
 
24
24
  attr_accessor :filename
@@ -180,7 +180,7 @@ module Pescheck
180
180
  def valid?
181
181
  warn '[DEPRECATED] the `valid?` method is obsolete'
182
182
  return false if @check_type.nil?
183
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
183
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
184
184
  return false unless check_type_validator.valid?(@check_type)
185
185
  return false if @filename.nil?
186
186
  return false if @extension.nil?
@@ -192,7 +192,7 @@ module Pescheck
192
192
  # Custom attribute writer method checking allowed values (enum).
193
193
  # @param [Object] check_type Object to be assigned
194
194
  def check_type=(check_type)
195
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
195
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
196
196
  unless validator.valid?(check_type)
197
197
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
198
198
  end
@@ -16,7 +16,7 @@ require 'time'
16
16
  module Pescheck
17
17
  # Input serializer for one `{check_type, config}` profile-check entry. Used by profile create directly. Subclass with `PARTIAL_CONFIG = True` for screening overrides where only the fields actually being changed should be validated.
18
18
  class V2ProfileCheck < ApiModelBase
19
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
19
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
20
20
  attr_accessor :check_type
21
21
 
22
22
  attr_accessor :config
@@ -121,7 +121,7 @@ module Pescheck
121
121
  def valid?
122
122
  warn '[DEPRECATED] the `valid?` method is obsolete'
123
123
  return false if @check_type.nil?
124
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
124
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
125
125
  return false unless check_type_validator.valid?(@check_type)
126
126
  true
127
127
  end
@@ -129,7 +129,7 @@ module Pescheck
129
129
  # Custom attribute writer method checking allowed values (enum).
130
130
  # @param [Object] check_type Object to be assigned
131
131
  def check_type=(check_type)
132
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
132
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
133
133
  unless validator.valid?(check_type)
134
134
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
135
135
  end
@@ -17,7 +17,7 @@ module Pescheck
17
17
  class V2ProfileCheckEntry < ApiModelBase
18
18
  attr_accessor :id
19
19
 
20
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
20
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
21
21
  attr_accessor :check_type
22
22
 
23
23
  attr_accessor :display_name
@@ -195,7 +195,7 @@ module Pescheck
195
195
  def valid?
196
196
  warn '[DEPRECATED] the `valid?` method is obsolete'
197
197
  return false if @check_type.nil?
198
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
198
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
199
199
  return false unless check_type_validator.valid?(@check_type)
200
200
  return false if @display_name.nil?
201
201
  return false if @configured_price.nil?
@@ -208,7 +208,7 @@ module Pescheck
208
208
  # Custom attribute writer method checking allowed values (enum).
209
209
  # @param [Object] check_type Object to be assigned
210
210
  def check_type=(check_type)
211
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
211
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
212
212
  unless validator.valid?(check_type)
213
213
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
214
214
  end
@@ -16,7 +16,7 @@ require 'time'
16
16
  module Pescheck
17
17
  # Profile update entry. Same shape as create plus optional profile_check_id for in-place update of an existing check. Absent profile_check_id = add new.
18
18
  class V2ProfileUpdateCheck < ApiModelBase
19
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
19
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
20
20
  attr_accessor :check_type
21
21
 
22
22
  attr_accessor :config
@@ -129,7 +129,7 @@ module Pescheck
129
129
  def valid?
130
130
  warn '[DEPRECATED] the `valid?` method is obsolete'
131
131
  return false if @check_type.nil?
132
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
132
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
133
133
  return false unless check_type_validator.valid?(@check_type)
134
134
  true
135
135
  end
@@ -137,7 +137,7 @@ module Pescheck
137
137
  # Custom attribute writer method checking allowed values (enum).
138
138
  # @param [Object] check_type Object to be assigned
139
139
  def check_type=(check_type)
140
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
140
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
141
141
  unless validator.valid?(check_type)
142
142
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
143
143
  end
@@ -16,7 +16,7 @@ require 'time'
16
16
  module Pescheck
17
17
  # Per-screening entry: identifies a target ProfileCheck (by check_type when unambiguous, or via profile_check_id when the profile has multiple ProfileChecks of the same type) and supplies optional `config` patch + per-check `input`.
18
18
  class V2ScreeningCheck < ApiModelBase
19
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
19
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `id2check` - id2check * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
20
20
  attr_accessor :check_type
21
21
 
22
22
  attr_accessor :config
@@ -139,7 +139,7 @@ module Pescheck
139
139
  def valid?
140
140
  warn '[DEPRECATED] the `valid?` method is obsolete'
141
141
  return false if @check_type.nil?
142
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
142
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
143
143
  return false unless check_type_validator.valid?(@check_type)
144
144
  true
145
145
  end
@@ -147,7 +147,7 @@ module Pescheck
147
147
  # Custom attribute writer method checking allowed values (enum).
148
148
  # @param [Object] check_type Object to be assigned
149
149
  def check_type=(check_type)
150
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
150
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "id2check", "integritycheck", "openhealthcarecheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
151
151
  unless validator.valid?(check_type)
152
152
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
153
153
  end
@@ -19,7 +19,7 @@ module Pescheck
19
19
 
20
20
  attr_accessor :profile_check_id
21
21
 
22
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
22
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
23
23
  attr_accessor :check_type
24
24
 
25
25
  attr_accessor :display_name
@@ -224,7 +224,7 @@ module Pescheck
224
224
  warn '[DEPRECATED] the `valid?` method is obsolete'
225
225
  return false if @id.nil?
226
226
  return false if @check_type.nil?
227
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
227
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
228
228
  return false unless check_type_validator.valid?(@check_type)
229
229
  return false if @display_name.nil?
230
230
  return false if @status.nil?
@@ -247,7 +247,7 @@ module Pescheck
247
247
  # Custom attribute writer method checking allowed values (enum).
248
248
  # @param [Object] check_type Object to be assigned
249
249
  def check_type=(check_type)
250
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
250
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
251
251
  unless validator.valid?(check_type)
252
252
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
253
253
  end
@@ -18,7 +18,7 @@ module Pescheck
18
18
  class V2ScreeningCheckListItem < ApiModelBase
19
19
  attr_accessor :id
20
20
 
21
- # * `addresscheck` - addresscheck * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
21
+ # * `addresscheck` - addresscheck * `adversemedia2check` - adversemedia2check * `adversemediacheck` - adversemediacheck * `bigcheck` - bigcheck * `criminalrecordscheck` - criminalrecordscheck * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck * `customintegritycheck` - customintegritycheck * `cvcheck` - cvcheck * `edrcheck` - edrcheck * `focumcheck` - focumcheck * `id2check` - id2check * `idcheck` - idcheck * `integritycheck` - integritycheck * `openhealthcarecheck` - openhealthcarecheck * `permissioncheck` - permissioncheck * `pescheckadversemediacheck` - pescheckadversemediacheck * `qualificationcheck` - qualificationcheck * `righttoworkcheck` - righttoworkcheck * `vogcheck` - vogcheck * `watchlist2check` - watchlist2check * `watchlistcheck` - watchlistcheck * `workreferencecheck` - workreferencecheck * `worldwidecreditcheck` - worldwidecreditcheck
22
22
  attr_accessor :check_type
23
23
 
24
24
  attr_accessor :status
@@ -140,7 +140,7 @@ module Pescheck
140
140
  warn '[DEPRECATED] the `valid?` method is obsolete'
141
141
  return false if @id.nil?
142
142
  return false if @check_type.nil?
143
- check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
143
+ check_type_validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
144
144
  return false unless check_type_validator.valid?(@check_type)
145
145
  return false if @status.nil?
146
146
  true
@@ -159,7 +159,7 @@ module Pescheck
159
159
  # Custom attribute writer method checking allowed values (enum).
160
160
  # @param [Object] check_type Object to be assigned
161
161
  def check_type=(check_type)
162
- validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
162
+ validator = EnumAttributeValidator.new('String', ["addresscheck", "adversemedia2check", "adversemediacheck", "bigcheck", "criminalrecordscheck", "criminalrecordsuploadcheck", "customintegritycheck", "cvcheck", "edrcheck", "focumcheck", "id2check", "idcheck", "integritycheck", "openhealthcarecheck", "permissioncheck", "pescheckadversemediacheck", "qualificationcheck", "righttoworkcheck", "vogcheck", "watchlist2check", "watchlistcheck", "workreferencecheck", "worldwidecreditcheck"])
163
163
  unless validator.valid?(check_type)
164
164
  fail ArgumentError, "invalid value for \"check_type\", must be one of #{validator.allowable_values}."
165
165
  end