pescheck-client 0.0.5

data/docs/V2ProfileUpdateCheck.md

@@ -0,0 +1,22 @@
+# Pescheck::V2ProfileUpdateCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 |  |
+| **config** | **Hash<String, Object>** |  | [optional] |
+| **profile_check_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileUpdateCheck.new(
+  check_type: null,
+  config: null,
+  profile_check_id: null
+)
+```
+

data/docs/V2ScreeningCheck.md

@@ -0,0 +1,24 @@
+# Pescheck::V2ScreeningCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 |  |
+| **config** | **Hash<String, Object>** |  | [optional] |
+| **profile_check_id** | **String** | Disambiguator. Use when the profile has multiple ProfileChecks of the same check_type. | [optional] |
+| **input** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningCheck.new(
+  check_type: null,
+  config: null,
+  profile_check_id: null,
+  input: null
+)
+```
+

data/docs/V2ScreeningCheckEntry.md

@@ -0,0 +1,34 @@
+# Pescheck::V2ScreeningCheckEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **profile_check_id** | **String** |  | [readonly] |
+| **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] |
+| **display_name** | **String** |  | [readonly] |
+| **status** | **String** |  | [readonly] |
+| **config** | **Hash<String, Object>** |  | [readonly] |
+| **input** | **Hash<String, Object>** |  | [readonly] |
+| **output** | **Hash<String, Object>** |  | [readonly] |
+| **candidate_wizard_url** | **String** | Deep link to this check's candidate wizard step. Null when the check has no dedicated candidate step. | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningCheckEntry.new(
+  id: null,
+  profile_check_id: null,
+  check_type: null,
+  display_name: null,
+  status: null,
+  config: null,
+  input: null,
+  output: null,
+  candidate_wizard_url: null
+)
+```
+

data/docs/V2ScreeningCheckListItem.md

@@ -0,0 +1,22 @@
+# Pescheck::V2ScreeningCheckListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **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] |
+| **status** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningCheckListItem.new(
+  id: null,
+  check_type: null,
+  status: null
+)
+```
+

data/docs/V2ScreeningCreate.md

@@ -0,0 +1,22 @@
+# Pescheck::V2ScreeningCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **candidate** | [**V2Candidate**](V2Candidate.md) |  |  |
+| **checks** | [**Array<V2ScreeningCheck>**](V2ScreeningCheck.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningCreate.new(
+  profile_id: null,
+  candidate: null,
+  checks: null
+)
+```
+

data/docs/V2ScreeningDetail.md

@@ -0,0 +1,34 @@
+# Pescheck::V2ScreeningDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **status** | **String** |  | [readonly] |
+| **profile** | [**V2ScreeningDetailProfile**](V2ScreeningDetailProfile.md) |  |  |
+| **candidate** | [**V2Candidate**](V2Candidate.md) |  | [readonly] |
+| **checks** | [**Array<V2ScreeningCheckEntry>**](V2ScreeningCheckEntry.md) |  | [readonly] |
+| **candidate_wizard_url** | **String** | Public wizard URL for the candidate. Null when no check needs candidate input. | [readonly] |
+| **dashboard_url** | **String** | Dashboard URL for this screening. | [readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningDetail.new(
+  id: null,
+  status: null,
+  profile: null,
+  candidate: null,
+  checks: null,
+  candidate_wizard_url: null,
+  dashboard_url: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/V2ScreeningDetailProfile.md

@@ -0,0 +1,20 @@
+# Pescheck::V2ScreeningDetailProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningDetailProfile.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/V2ScreeningListItem.md

@@ -0,0 +1,34 @@
+# Pescheck::V2ScreeningListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **status** | **String** |  | [optional] |
+| **profile** | [**V2ScreeningDetailProfile**](V2ScreeningDetailProfile.md) |  |  |
+| **candidate** | [**V2Candidate**](V2Candidate.md) |  | [readonly] |
+| **checks** | [**Array<V2ScreeningCheckListItem>**](V2ScreeningCheckListItem.md) |  | [readonly] |
+| **candidate_wizard_url** | **String** |  | [readonly] |
+| **dashboard_url** | **String** |  | [readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ScreeningListItem.new(
+  id: null,
+  status: null,
+  profile: null,
+  candidate: null,
+  checks: null,
+  candidate_wizard_url: null,
+  dashboard_url: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/VerifyWebhook.md

@@ -0,0 +1,18 @@
+# Pescheck::VerifyWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_code** | **String** | The verification code delivered to the webhook URL on creation. |  |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::VerifyWebhook.new(
+  verification_code: null
+)
+```
+

data/docs/Webhook.md

@@ -0,0 +1,26 @@
+# Pescheck::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Descriptive name for this webhook |  |
+| **url** | **String** | HTTPS URL where webhook events will be sent |  |
+| **events** | **Array<String>** | List of events to subscribe to. Valid events: check.status_changed, screening.status_changed, screening.archived, package.created, package.updated, profile.created, profile.updated, division.created, division.updated |  |
+| **active** | **Boolean** | Whether the webhook is active | [optional][default to true] |
+| **division_id** | **String** | Division ID to create webhook for (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::Webhook.new(
+  name: null,
+  url: null,
+  events: null,
+  active: null,
+  division_id: null
+)
+```
+

data/docs/WebhookResponse.md

@@ -0,0 +1,36 @@
+# Pescheck::WebhookResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** |  |  |
+| **url** | **String** |  |  |
+| **events** | **Object** |  | [readonly] |
+| **active** | **Boolean** |  | [optional] |
+| **verified** | **Boolean** |  | [readonly] |
+| **token** | **String** |  | [optional][readonly] |
+| **organisation_name** | **String** |  | [optional][readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::WebhookResponse.new(
+  id: null,
+  name: null,
+  url: null,
+  events: null,
+  active: null,
+  verified: null,
+  token: null,
+  organisation_name: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/WebhooksApi.md

@@ -0,0 +1,290 @@
+# Pescheck::WebhooksApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook2**](WebhooksApi.md#create_webhook2) | **POST** /api/v2/webhooks/ |  |
+| [**delete_webhook2**](WebhooksApi.md#delete_webhook2) | **DELETE** /api/v2/webhooks/{webhook_id}/ |  |
+| [**list_webhooks2**](WebhooksApi.md#list_webhooks2) | **GET** /api/v2/webhooks/list/ |  |
+| [**verify_webhook2**](WebhooksApi.md#verify_webhook2) | **POST** /api/v2/webhooks/{webhook_id}/verify/ |  |
+
+
+## create_webhook2
+
+> <WebhookResponse> create_webhook2(webhook, opts)
+
+
+
+Create webhook for event notifications.          **Authentication Notes:**         - OAuth2: Organization is automatically determined from the OAuth application         - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter          **Valid Events:**         - `check.started` - Check has been initiated         - `check.completed` - Check has been completed successfully         - `check.failed` - Check has failed         - `screening.created` - New screening has been created         - `screening.completed` - Screening has been completed         - `screening.archived` - Screening has been archived         - `package.created` - New package has been created         - `package.updated` - Package has been updated         - `division.created` - New division has been created         - `division.updated` - Division has been updated          Limited to 5 webhooks per organization/division.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pescheck-client'
+# setup authorization
+Pescheck.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Pescheck::WebhooksApi.new
+webhook = Pescheck::Webhook.new({name: 'name_example', url: 'url_example', events: ['check.status_changed']}) # Webhook | 
+opts = {
+  x_organization_id: 'x_organization_id_example', # String | Organization ID (for JWT/Session auth only)
+  organization_id: 'organization_id_example' # String | Organization ID (for JWT/Session auth only)
+}
+
+begin
+  
+  result = api_instance.create_webhook2(webhook, opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->create_webhook2: #{e}"
+end
+```
+
+#### Using the create_webhook2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookResponse>, Integer, Hash)> create_webhook2_with_http_info(webhook, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_webhook2_with_http_info(webhook, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookResponse>
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->create_webhook2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook** | [**Webhook**](Webhook.md) |  |  |
+| **x_organization_id** | **String** | Organization ID (for JWT/Session auth only) | [optional] |
+| **organization_id** | **String** | Organization ID (for JWT/Session auth only) | [optional] |
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## delete_webhook2
+
+> delete_webhook2(webhook_id)
+
+
+
+Delete a webhook
+
+### Examples
+
+```ruby
+require 'time'
+require 'pescheck-client'
+# setup authorization
+Pescheck.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Pescheck::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook ID to delete
+
+begin
+  
+  api_instance.delete_webhook2(webhook_id)
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->delete_webhook2: #{e}"
+end
+```
+
+#### Using the delete_webhook2_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_webhook2_with_http_info(webhook_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_webhook2_with_http_info(webhook_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->delete_webhook2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** | Webhook ID to delete |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list_webhooks2
+
+> <Array<WebhookResponse>> list_webhooks2
+
+
+
+List webhooks for the organization
+
+### Examples
+
+```ruby
+require 'time'
+require 'pescheck-client'
+# setup authorization
+Pescheck.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Pescheck::WebhooksApi.new
+
+begin
+  
+  result = api_instance.list_webhooks2
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->list_webhooks2: #{e}"
+end
+```
+
+#### Using the list_webhooks2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<WebhookResponse>>, Integer, Hash)> list_webhooks2_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.list_webhooks2_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<WebhookResponse>>
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->list_webhooks2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;WebhookResponse&gt;**](WebhookResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verify_webhook2
+
+> verify_webhook2(webhook_id, verify_webhook)
+
+
+
+Verify webhook ownership
+
+### Examples
+
+```ruby
+require 'time'
+require 'pescheck-client'
+# setup authorization
+Pescheck.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = Pescheck::WebhooksApi.new
+webhook_id = 'webhook_id_example' # String | Webhook ID
+verify_webhook = Pescheck::VerifyWebhook.new({verification_code: 'verification_code_example'}) # VerifyWebhook | 
+
+begin
+  
+  api_instance.verify_webhook2(webhook_id, verify_webhook)
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->verify_webhook2: #{e}"
+end
+```
+
+#### Using the verify_webhook2_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> verify_webhook2_with_http_info(webhook_id, verify_webhook)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.verify_webhook2_with_http_info(webhook_id, verify_webhook)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Pescheck::ApiError => e
+  puts "Error when calling WebhooksApi->verify_webhook2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_id** | **String** | Webhook ID |  |
+| **verify_webhook** | [**VerifyWebhook**](VerifyWebhook.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: Not defined
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="pescheckit"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="pescheck-clients"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'