pescheck-client 0.0.5

data/docs/ScreeningsApi.md

@@ -0,0 +1,293 @@
+# Pescheck::ScreeningsApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_screenings_create**](ScreeningsApi.md#v2_screenings_create) | **POST** /api/v2/screenings/ |  |
+| [**v2_screenings_documents_list**](ScreeningsApi.md#v2_screenings_documents_list) | **GET** /api/v2/screenings/{id}/documents/ | Retrieve screening documents |
+| [**v2_screenings_list**](ScreeningsApi.md#v2_screenings_list) | **GET** /api/v2/screenings/ |  |
+| [**v2_screenings_retrieve**](ScreeningsApi.md#v2_screenings_retrieve) | **GET** /api/v2/screenings/{id}/ |  |
+
+
+## v2_screenings_create
+
+> <V2ScreeningDetail> v2_screenings_create(v2_screening_create)
+
+
+
+### 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::ScreeningsApi.new
+v2_screening_create = Pescheck::V2ScreeningCreate.new({profile_id: 'profile_id_example', candidate: Pescheck::V2Candidate.new({first_name: 'first_name_example', last_name: 'last_name_example', email: 'email_example'})}) # V2ScreeningCreate | 
+
+begin
+  
+  result = api_instance.v2_screenings_create(v2_screening_create)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_create: #{e}"
+end
+```
+
+#### Using the v2_screenings_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V2ScreeningDetail>, Integer, Hash)> v2_screenings_create_with_http_info(v2_screening_create)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_screenings_create_with_http_info(v2_screening_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V2ScreeningDetail>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v2_screening_create** | [**V2ScreeningCreate**](V2ScreeningCreate.md) |  |  |
+
+### Return type
+
+[**V2ScreeningDetail**](V2ScreeningDetail.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## v2_screenings_documents_list
+
+> <Array<V2Document>> v2_screenings_documents_list(id, opts)
+
+Retrieve screening documents
+
+Documents attached to the screening's checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+
+### 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::ScreeningsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  check_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Only documents from the check with this id.
+  check_type: 'check_type_example' # String | Only documents from checks of this type.
+}
+
+begin
+  # Retrieve screening documents
+  result = api_instance.v2_screenings_documents_list(id, opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_documents_list: #{e}"
+end
+```
+
+#### Using the v2_screenings_documents_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<V2Document>>, Integer, Hash)> v2_screenings_documents_list_with_http_info(id, opts)
+
+```ruby
+begin
+  # Retrieve screening documents
+  data, status_code, headers = api_instance.v2_screenings_documents_list_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<V2Document>>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_documents_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **check_id** | **String** | Only documents from the check with this id. | [optional] |
+| **check_type** | **String** | Only documents from checks of this type. | [optional] |
+
+### Return type
+
+[**Array&lt;V2Document&gt;**](V2Document.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_screenings_list
+
+> <PaginatedV2ScreeningListItemList> v2_screenings_list(opts)
+
+
+
+### 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::ScreeningsApi.new
+opts = {
+  page: 1, # Integer | A page number within the paginated result set.
+  page_size: 50, # Integer | Number of results to return per page.
+  paginate: true # Boolean | Enable/disable pagination. When false, max 500 records returned.
+}
+
+begin
+  
+  result = api_instance.v2_screenings_list(opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_list: #{e}"
+end
+```
+
+#### Using the v2_screenings_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedV2ScreeningListItemList>, Integer, Hash)> v2_screenings_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_screenings_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedV2ScreeningListItemList>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | A page number within the paginated result set. | [optional][default to 1] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional][default to 50] |
+| **paginate** | **Boolean** | Enable/disable pagination. When false, max 500 records returned. | [optional][default to true] |
+
+### Return type
+
+[**PaginatedV2ScreeningListItemList**](PaginatedV2ScreeningListItemList.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_screenings_retrieve
+
+> <V2ScreeningDetail> v2_screenings_retrieve(id)
+
+
+
+### 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::ScreeningsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | A UUID string identifying this screening.
+
+begin
+  
+  result = api_instance.v2_screenings_retrieve(id)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_retrieve: #{e}"
+end
+```
+
+#### Using the v2_screenings_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V2ScreeningDetail>, Integer, Hash)> v2_screenings_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_screenings_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V2ScreeningDetail>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ScreeningsApi->v2_screenings_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A UUID string identifying this screening. |  |
+
+### Return type
+
+[**V2ScreeningDetail**](V2ScreeningDetail.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TokenRefresh.md

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

data/docs/V2Candidate.md

@@ -0,0 +1,36 @@
+# Pescheck::V2Candidate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **initials** | **String** |  | [optional] |
+| **date_of_birth** | **String** |  | [optional] |
+| **gender** | **String** |  | [optional] |
+| **nationality** | **String** | ISO 3166-1 alpha-2 country code (e.g. \"NL\", \"DE\", \"US\").  * `AD` - AD * `AE` - AE * `AF` - AF * `AG` - AG * `AI` - AI * `AL` - AL * `AM` - AM * `AN` - AN * `AO` - AO * `AQ` - AQ * `AR` - AR * `AS` - AS * `AT` - AT * `AU` - AU * `AW` - AW * `AX` - AX * `AZ` - AZ * `BA` - BA * `BB` - BB * `BD` - BD * `BE` - BE * `BF` - BF * `BG` - BG * `BH` - BH * `BI` - BI * `BJ` - BJ * `BL` - BL * `BM` - BM * `BN` - BN * `BO` - BO * `BR` - BR * `BS` - BS * `BT` - BT * `BV` - BV * `BW` - BW * `BY` - BY * `BZ` - BZ * `CA` - CA * `CC` - CC * `CD` - CD * `CF` - CF * `CG` - CG * `CH` - CH * `CI` - CI * `CK` - CK * `CL` - CL * `CM` - CM * `CN` - CN * `CO` - CO * `CR` - CR * `CU` - CU * `CV` - CV * `CW` - CW * `CX` - CX * `CY` - CY * `CZ` - CZ * `DE` - DE * `DJ` - DJ * `DK` - DK * `DM` - DM * `DO` - DO * `DZ` - DZ * `EC` - EC * `EE` - EE * `EG` - EG * `EH` - EH * `ER` - ER * `ES` - ES * `ET` - ET * `FI` - FI * `FJ` - FJ * `FK` - FK * `FM` - FM * `FO` - FO * `FR` - FR * `GA` - GA * `GB` - GB * `GD` - GD * `GE` - GE * `GF` - GF * `GG` - GG * `GH` - GH * `GI` - GI * `GL` - GL * `GM` - GM * `GN` - GN * `GP` - GP * `GQ` - GQ * `GR` - GR * `GS` - GS * `GT` - GT * `GU` - GU * `GW` - GW * `GY` - GY * `HK` - HK * `HM` - HM * `HN` - HN * `HR` - HR * `HT` - HT * `HU` - HU * `ID` - ID * `IE` - IE * `IL` - IL * `IM` - IM * `IN` - IN * `IO` - IO * `IQ` - IQ * `IR` - IR * `IS` - IS * `IT` - IT * `JE` - JE * `JM` - JM * `JO` - JO * `JP` - JP * `KE` - KE * `KG` - KG * `KH` - KH * `KI` - KI * `KM` - KM * `KN` - KN * `KP` - KP * `KR` - KR * `KW` - KW * `KY` - KY * `KZ` - KZ * `LA` - LA * `LB` - LB * `LC` - LC * `LI` - LI * `LK` - LK * `LR` - LR * `LS` - LS * `LT` - LT * `LU` - LU * `LV` - LV * `LY` - LY * `MA` - MA * `MC` - MC * `MD` - MD * `ME` - ME * `MG` - MG * `MH` - MH * `MK` - MK * `ML` - ML * `MM` - MM * `MN` - MN * `MO` - MO * `MP` - MP * `MQ` - MQ * `MR` - MR * `MS` - MS * `MT` - MT * `MU` - MU * `MV` - MV * `MW` - MW * `MX` - MX * `MY` - MY * `MZ` - MZ * `NA` - NA * `NC` - NC * `NE` - NE * `NF` - NF * `NG` - NG * `NI` - NI * `NL` - NL * `NO` - NO * `NP` - NP * `NR` - NR * `NU` - NU * `NZ` - NZ * `OM` - OM * `PA` - PA * `PE` - PE * `PF` - PF * `PG` - PG * `PH` - PH * `PK` - PK * `PL` - PL * `PM` - PM * `PN` - PN * `PR` - PR * `PS` - PS * `PT` - PT * `PW` - PW * `PY` - PY * `QA` - QA * `RE` - RE * `RO` - RO * `RS` - RS * `RU` - RU * `RW` - RW * `SA` - SA * `SB` - SB * `SC` - SC * `SD` - SD * `SE` - SE * `SG` - SG * `SH` - SH * `SI` - SI * `SJ` - SJ * `SK` - SK * `SL` - SL * `SM` - SM * `SN` - SN * `SO` - SO * `SR` - SR * `ST` - ST * `SV` - SV * `SY` - SY * `SZ` - SZ * `TC` - TC * `TD` - TD * `TF` - TF * `TG` - TG * `TH` - TH * `TJ` - TJ * `TK` - TK * `TL` - TL * `TM` - TM * `TN` - TN * `TO` - TO * `TR` - TR * `TT` - TT * `TV` - TV * `TW` - TW * `TZ` - TZ * `UA` - UA * `UG` - UG * `UM` - UM * `US` - US * `UY` - UY * `UZ` - UZ * `VA` - VA * `VC` - VC * `VE` - VE * `VG` - VG * `VI` - VI * `VN` - VN * `VU` - VU * `WF` - WF * `WS` - WS * `XK` - XK * `YE` - YE * `YT` - YT * `ZA` - ZA * `ZM` - ZM * `ZW` - ZW | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **house_number** | **String** |  | [optional] |
+| **extension** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2Candidate.new(
+  first_name: null,
+  last_name: null,
+  email: null,
+  initials: null,
+  date_of_birth: null,
+  gender: null,
+  nationality: null,
+  postal_code: null,
+  house_number: null,
+  extension: null
+)
+```
+

data/docs/V2CheckField.md

@@ -0,0 +1,26 @@
+# Pescheck::V2CheckField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [readonly] |
+| **type** | **String** | \"string\" | \"integer\" | \"number\" | \"boolean\" | \"array\" | \"object\" | [readonly] |
+| **required** | **Boolean** | Whether the request body must include this field. | [readonly] |
+| **choices** | **Array<String>** | Allowed values, or null if the field isn't constrained to a set. | [readonly] |
+| **help_text** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2CheckField.new(
+  name: null,
+  type: null,
+  required: null,
+  choices: null,
+  help_text: null
+)
+```
+

data/docs/V2CheckInfo.md

@@ -0,0 +1,40 @@
+# Pescheck::V2CheckInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_type** | **String** |  | [readonly] |
+| **display_name** | **String** |  | [readonly] |
+| **description** | **String** |  | [readonly] |
+| **has_config** | **Boolean** |  | [readonly] |
+| **is_system_managed** | **Boolean** | True for checks added automatically (e.g. as a dependency) - clients neither add nor configure these. | [readonly] |
+| **requires_checks** | **Array<String>** | Other check types this check pulls in automatically when added. | [readonly] |
+| **supported_countries_of_work** | **Array<String>** |  | [readonly] |
+| **supported_countries_of_residence** | **Array<String>** |  | [readonly] |
+| **default_price** | [**V2Money**](V2Money.md) |  | [readonly] |
+| **config_fields** | [**Array<V2CheckField>**](V2CheckField.md) |  | [readonly] |
+| **input_fields** | [**Array<V2CheckField>**](V2CheckField.md) |  | [readonly] |
+| **candidate_fields** | [**Array<V2CheckField>**](V2CheckField.md) | Screening-level candidate facts this check needs (name, email, sometimes date of birth, etc.). | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2CheckInfo.new(
+  check_type: null,
+  display_name: null,
+  description: null,
+  has_config: null,
+  is_system_managed: null,
+  requires_checks: null,
+  supported_countries_of_work: null,
+  supported_countries_of_residence: null,
+  default_price: null,
+  config_fields: null,
+  input_fields: null,
+  candidate_fields: null
+)
+```
+

data/docs/V2Document.md

@@ -0,0 +1,28 @@
+# Pescheck::V2Document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **filename** | **String** |  | [readonly] |
+| **extension** | **String** |  | [readonly] |
+| **content** | [**V2DocumentContent**](V2DocumentContent.md) |  | [readonly] |
+| **metadata** | **Hash<String, Object>** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2Document.new(
+  check_id: null,
+  check_type: null,
+  filename: null,
+  extension: null,
+  content: null,
+  metadata: null
+)
+```
+

data/docs/V2DocumentContent.md

@@ -0,0 +1,20 @@
+# Pescheck::V2DocumentContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **data** | **String** | Base64-encoded file contents (type == base64). | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2DocumentContent.new(
+  type: null,
+  data: null
+)
+```
+

data/docs/V2Money.md

@@ -0,0 +1,20 @@
+# Pescheck::V2Money
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **String** |  |  |
+| **currency** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2Money.new(
+  amount: null,
+  currency: null
+)
+```
+

data/docs/V2ProfileCheck.md

@@ -0,0 +1,20 @@
+# Pescheck::V2ProfileCheck
+
+## 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] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileCheck.new(
+  check_type: null,
+  config: null
+)
+```
+

data/docs/V2ProfileCheckEntry.md

@@ -0,0 +1,30 @@
+# Pescheck::V2ProfileCheckEntry
+
+## 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] |
+| **display_name** | **String** |  | [readonly] |
+| **configured_price** | [**V2Money**](V2Money.md) |  | [readonly] |
+| **config** | **Hash<String, Object>** |  | [readonly] |
+| **input_fields** | **Array<Object>** |  | [readonly] |
+| **is_system_managed** | **Boolean** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileCheckEntry.new(
+  id: null,
+  check_type: null,
+  display_name: null,
+  configured_price: null,
+  config: null,
+  input_fields: null,
+  is_system_managed: null
+)
+```
+

data/docs/V2ProfileCreate.md

@@ -0,0 +1,22 @@
+# Pescheck::V2ProfileCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional][default to ''] |
+| **checks** | [**Array<V2ProfileCheck>**](V2ProfileCheck.md) |  |  |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileCreate.new(
+  name: null,
+  description: null,
+  checks: null
+)
+```
+

data/docs/V2ProfileDetail.md

@@ -0,0 +1,38 @@
+# Pescheck::V2ProfileDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **is_custom** | **Boolean** |  | [optional] |
+| **checks** | [**Array<V2ProfileCheckEntry>**](V2ProfileCheckEntry.md) |  | [readonly] |
+| **total_price** | [**V2Money**](V2Money.md) |  | [readonly] |
+| **supported_countries_of_work** | **Array<String>** |  | [readonly] |
+| **supported_countries_of_residence** | **Array<String>** |  | [readonly] |
+| **candidate_fields** | **Array<Object>** |  | [readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileDetail.new(
+  id: null,
+  name: null,
+  description: null,
+  is_custom: null,
+  checks: null,
+  total_price: null,
+  supported_countries_of_work: null,
+  supported_countries_of_residence: null,
+  candidate_fields: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/V2ProfileListItem.md

@@ -0,0 +1,30 @@
+# Pescheck::V2ProfileListItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **is_custom** | **Boolean** |  | [optional] |
+| **check_types** | **Array<String>** |  | [readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileListItem.new(
+  id: null,
+  name: null,
+  description: null,
+  is_custom: null,
+  check_types: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/V2ProfileUpdate.md

@@ -0,0 +1,22 @@
+# Pescheck::V2ProfileUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional][default to ''] |
+| **checks** | [**Array<V2ProfileUpdateCheck>**](V2ProfileUpdateCheck.md) |  |  |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::V2ProfileUpdate.new(
+  name: null,
+  description: null,
+  checks: null
+)
+```
+