pescheck-client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0acfad783a9e449311a76af2f805827306ee976b150848280d28860e96c962b5
+  data.tar.gz: cc683af13a7e16784dae9b5e959983b886541897c7a14c23e45f722f5eb3b87f
+SHA512:
+  metadata.gz: dfe66b1212ab7b16935ee23d24e847dc355f1049e9865ea96a69741c35ba5bd8786065f3cae724d9e982f3b39dd2230db2f2ace41457e26d46e92d1cf98953b1
+  data.tar.gz: 3f12acc189a599ae737c319ab9b2f8a71756a02f15de8cbcc58719ba6918c13f11ef69783eb6e276d991172ce6e03730e291dec20bb5e4a0201c1c2d74ac0fc2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,182 @@
+# pescheck-client
+
+Pescheck - the Ruby gem for the Pescheck API
+
+Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0.0
+- Package version: 0.0.5
+- Generator version: 7.23.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pescheck-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pescheck-client-0.0.5.gem
+```
+
+(for development, run `gem install --dev ./pescheck-client-0.0.5.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pescheck-client', '~> 0.0.5'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/pescheckit/pescheck-clients, then add the following in the Gemfile:
+
+    gem 'pescheck-client', :git => 'https://github.com/pescheckit/pescheck-clients.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pescheck-client'
+
+# Setup authorization
+Pescheck.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = Pescheck::AuthenticationApi.new
+jwt_generation = Pescheck::JWTGeneration.new({email: 'email_example', password: 'password_example'}) # JWTGeneration | 
+
+begin
+  result = api_instance.generate_jwt_token2(jwt_generation)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Exception when calling AuthenticationApi->generate_jwt_token2: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.pescheck.io*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Pescheck::AuthenticationApi* | [**generate_jwt_token2**](docs/AuthenticationApi.md#generate_jwt_token2) | **POST** /api/v2/jwt/generate/ | 
+*Pescheck::AuthenticationApi* | [**jwt_create**](docs/AuthenticationApi.md#jwt_create) | **POST** /api/jwt/ | 
+*Pescheck::AuthenticationApi* | [**jwt_refresh_create**](docs/AuthenticationApi.md#jwt_refresh_create) | **POST** /api/jwt/refresh/ | 
+*Pescheck::ChecksApi* | [**v2_checks_list**](docs/ChecksApi.md#v2_checks_list) | **GET** /api/v2/checks/ | 
+*Pescheck::ChecksApi* | [**v2_checks_retrieve**](docs/ChecksApi.md#v2_checks_retrieve) | **GET** /api/v2/checks/{check_type}/ | 
+*Pescheck::DivisionsApi* | [**v2_organisations_divisions_create**](docs/DivisionsApi.md#v2_organisations_divisions_create) | **POST** /api/v2/organisations/divisions/ | 
+*Pescheck::DivisionsApi* | [**v2_organisations_divisions_list**](docs/DivisionsApi.md#v2_organisations_divisions_list) | **GET** /api/v2/organisations/divisions/ | 
+*Pescheck::DivisionsApi* | [**v2_organisations_divisions_partial_update**](docs/DivisionsApi.md#v2_organisations_divisions_partial_update) | **PATCH** /api/v2/organisations/divisions/{id}/ | 
+*Pescheck::DivisionsApi* | [**v2_organisations_divisions_retrieve**](docs/DivisionsApi.md#v2_organisations_divisions_retrieve) | **GET** /api/v2/organisations/divisions/{id}/ | 
+*Pescheck::DivisionsApi* | [**v2_organisations_divisions_update**](docs/DivisionsApi.md#v2_organisations_divisions_update) | **PUT** /api/v2/organisations/divisions/{id}/ | 
+*Pescheck::OAuthApi* | [**create_o_auth_application2**](docs/OAuthApi.md#create_o_auth_application2) | **POST** /api/v2/oauth/applications/ | 
+*Pescheck::OAuthApi* | [**delete_o_auth_application2**](docs/OAuthApi.md#delete_o_auth_application2) | **DELETE** /api/v2/oauth/applications/{application_id}/ | 
+*Pescheck::OAuthApi* | [**list_o_auth_applications2**](docs/OAuthApi.md#list_o_auth_applications2) | **GET** /api/v2/oauth/applications/list/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_create**](docs/ProfilesApi.md#v2_profiles_create) | **POST** /api/v2/profiles/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_destroy**](docs/ProfilesApi.md#v2_profiles_destroy) | **DELETE** /api/v2/profiles/{id}/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_list**](docs/ProfilesApi.md#v2_profiles_list) | **GET** /api/v2/profiles/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_partial_update**](docs/ProfilesApi.md#v2_profiles_partial_update) | **PATCH** /api/v2/profiles/{id}/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_retrieve**](docs/ProfilesApi.md#v2_profiles_retrieve) | **GET** /api/v2/profiles/{id}/ | 
+*Pescheck::ProfilesApi* | [**v2_profiles_update**](docs/ProfilesApi.md#v2_profiles_update) | **PUT** /api/v2/profiles/{id}/ | 
+*Pescheck::ScreeningsApi* | [**v2_screenings_create**](docs/ScreeningsApi.md#v2_screenings_create) | **POST** /api/v2/screenings/ | 
+*Pescheck::ScreeningsApi* | [**v2_screenings_documents_list**](docs/ScreeningsApi.md#v2_screenings_documents_list) | **GET** /api/v2/screenings/{id}/documents/ | Retrieve screening documents
+*Pescheck::ScreeningsApi* | [**v2_screenings_list**](docs/ScreeningsApi.md#v2_screenings_list) | **GET** /api/v2/screenings/ | 
+*Pescheck::ScreeningsApi* | [**v2_screenings_retrieve**](docs/ScreeningsApi.md#v2_screenings_retrieve) | **GET** /api/v2/screenings/{id}/ | 
+*Pescheck::WebhooksApi* | [**create_webhook2**](docs/WebhooksApi.md#create_webhook2) | **POST** /api/v2/webhooks/ | 
+*Pescheck::WebhooksApi* | [**delete_webhook2**](docs/WebhooksApi.md#delete_webhook2) | **DELETE** /api/v2/webhooks/{webhook_id}/ | 
+*Pescheck::WebhooksApi* | [**list_webhooks2**](docs/WebhooksApi.md#list_webhooks2) | **GET** /api/v2/webhooks/list/ | 
+*Pescheck::WebhooksApi* | [**verify_webhook2**](docs/WebhooksApi.md#verify_webhook2) | **POST** /api/v2/webhooks/{webhook_id}/verify/ | 
+
+
+## Documentation for Models
+
+ - [Pescheck::CustomTokenObtainPair](docs/CustomTokenObtainPair.md)
+ - [Pescheck::DivisionReadOnly](docs/DivisionReadOnly.md)
+ - [Pescheck::DivisionWrite](docs/DivisionWrite.md)
+ - [Pescheck::JWTGeneration](docs/JWTGeneration.md)
+ - [Pescheck::JWTResponse](docs/JWTResponse.md)
+ - [Pescheck::OAuthApplication](docs/OAuthApplication.md)
+ - [Pescheck::OAuthApplicationResponse](docs/OAuthApplicationResponse.md)
+ - [Pescheck::PaginatedDivisionReadOnlyList](docs/PaginatedDivisionReadOnlyList.md)
+ - [Pescheck::PaginatedV2ProfileListItemList](docs/PaginatedV2ProfileListItemList.md)
+ - [Pescheck::PaginatedV2ScreeningListItemList](docs/PaginatedV2ScreeningListItemList.md)
+ - [Pescheck::PatchedDivisionWrite](docs/PatchedDivisionWrite.md)
+ - [Pescheck::PatchedV2ProfilePartialUpdate](docs/PatchedV2ProfilePartialUpdate.md)
+ - [Pescheck::TokenRefresh](docs/TokenRefresh.md)
+ - [Pescheck::V2Candidate](docs/V2Candidate.md)
+ - [Pescheck::V2CheckField](docs/V2CheckField.md)
+ - [Pescheck::V2CheckInfo](docs/V2CheckInfo.md)
+ - [Pescheck::V2Document](docs/V2Document.md)
+ - [Pescheck::V2DocumentContent](docs/V2DocumentContent.md)
+ - [Pescheck::V2Money](docs/V2Money.md)
+ - [Pescheck::V2ProfileCheck](docs/V2ProfileCheck.md)
+ - [Pescheck::V2ProfileCheckEntry](docs/V2ProfileCheckEntry.md)
+ - [Pescheck::V2ProfileCreate](docs/V2ProfileCreate.md)
+ - [Pescheck::V2ProfileDetail](docs/V2ProfileDetail.md)
+ - [Pescheck::V2ProfileListItem](docs/V2ProfileListItem.md)
+ - [Pescheck::V2ProfileUpdate](docs/V2ProfileUpdate.md)
+ - [Pescheck::V2ProfileUpdateCheck](docs/V2ProfileUpdateCheck.md)
+ - [Pescheck::V2ScreeningCheck](docs/V2ScreeningCheck.md)
+ - [Pescheck::V2ScreeningCheckEntry](docs/V2ScreeningCheckEntry.md)
+ - [Pescheck::V2ScreeningCheckListItem](docs/V2ScreeningCheckListItem.md)
+ - [Pescheck::V2ScreeningCreate](docs/V2ScreeningCreate.md)
+ - [Pescheck::V2ScreeningDetail](docs/V2ScreeningDetail.md)
+ - [Pescheck::V2ScreeningDetailProfile](docs/V2ScreeningDetailProfile.md)
+ - [Pescheck::V2ScreeningListItem](docs/V2ScreeningListItem.md)
+ - [Pescheck::VerifyWebhook](docs/VerifyWebhook.md)
+ - [Pescheck::Webhook](docs/Webhook.md)
+ - [Pescheck::WebhookResponse](docs/WebhookResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### cookieAuth
+
+
+- **Type**: API key
+- **API key parameter name**: __Secure-sessionid
+- **Location**: 
+
+### jwtAuth
+
+- **Type**: Bearer authentication (JWT)
+
+### oauth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - read:api: read groups
+  - create:api: create groups
+  - update:api: update groups
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AuthenticationApi.md

@@ -0,0 +1,217 @@
+# Pescheck::AuthenticationApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_jwt_token2**](AuthenticationApi.md#generate_jwt_token2) | **POST** /api/v2/jwt/generate/ |  |
+| [**jwt_create**](AuthenticationApi.md#jwt_create) | **POST** /api/jwt/ |  |
+| [**jwt_refresh_create**](AuthenticationApi.md#jwt_refresh_create) | **POST** /api/jwt/refresh/ |  |
+
+
+## generate_jwt_token2
+
+> <JWTResponse> generate_jwt_token2(jwt_generation)
+
+
+
+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/.
+
+### 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::AuthenticationApi.new
+jwt_generation = Pescheck::JWTGeneration.new({email: 'email_example', password: 'password_example'}) # JWTGeneration | 
+
+begin
+  
+  result = api_instance.generate_jwt_token2(jwt_generation)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->generate_jwt_token2: #{e}"
+end
+```
+
+#### Using the generate_jwt_token2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JWTResponse>, Integer, Hash)> generate_jwt_token2_with_http_info(jwt_generation)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.generate_jwt_token2_with_http_info(jwt_generation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JWTResponse>
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->generate_jwt_token2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jwt_generation** | [**JWTGeneration**](JWTGeneration.md) |  |  |
+
+### Return type
+
+[**JWTResponse**](JWTResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## jwt_create
+
+> <CustomTokenObtainPair> jwt_create(custom_token_obtain_pair)
+
+
+
+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/.
+
+### 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::AuthenticationApi.new
+custom_token_obtain_pair = Pescheck::CustomTokenObtainPair.new({email: 'email_example', password: 'password_example'}) # CustomTokenObtainPair | 
+
+begin
+  
+  result = api_instance.jwt_create(custom_token_obtain_pair)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->jwt_create: #{e}"
+end
+```
+
+#### Using the jwt_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomTokenObtainPair>, Integer, Hash)> jwt_create_with_http_info(custom_token_obtain_pair)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jwt_create_with_http_info(custom_token_obtain_pair)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomTokenObtainPair>
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->jwt_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom_token_obtain_pair** | [**CustomTokenObtainPair**](CustomTokenObtainPair.md) |  |  |
+
+### Return type
+
+[**CustomTokenObtainPair**](CustomTokenObtainPair.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## jwt_refresh_create
+
+> <TokenRefresh> jwt_refresh_create(token_refresh)
+
+
+
+Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+
+### 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::AuthenticationApi.new
+token_refresh = Pescheck::TokenRefresh.new({refresh: 'refresh_example'}) # TokenRefresh | 
+
+begin
+  
+  result = api_instance.jwt_refresh_create(token_refresh)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->jwt_refresh_create: #{e}"
+end
+```
+
+#### Using the jwt_refresh_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenRefresh>, Integer, Hash)> jwt_refresh_create_with_http_info(token_refresh)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.jwt_refresh_create_with_http_info(token_refresh)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenRefresh>
+rescue Pescheck::ApiError => e
+  puts "Error when calling AuthenticationApi->jwt_refresh_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token_refresh** | [**TokenRefresh**](TokenRefresh.md) |  |  |
+
+### Return type
+
+[**TokenRefresh**](TokenRefresh.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+

data/docs/ChecksApi.md

@@ -0,0 +1,147 @@
+# Pescheck::ChecksApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_checks_list**](ChecksApi.md#v2_checks_list) | **GET** /api/v2/checks/ |  |
+| [**v2_checks_retrieve**](ChecksApi.md#v2_checks_retrieve) | **GET** /api/v2/checks/{check_type}/ |  |
+
+
+## v2_checks_list
+
+> <Array<V2CheckInfo>> v2_checks_list(opts)
+
+
+
+List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
+
+### 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::ChecksApi.new
+opts = {
+  check_type: 'check_type_example' # String | Restrict the list to a single check type.
+}
+
+begin
+  
+  result = api_instance.v2_checks_list(opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ChecksApi->v2_checks_list: #{e}"
+end
+```
+
+#### Using the v2_checks_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<V2CheckInfo>>, Integer, Hash)> v2_checks_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_checks_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<V2CheckInfo>>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ChecksApi->v2_checks_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_type** | **String** | Restrict the list to a single check type. | [optional] |
+
+### Return type
+
+[**Array&lt;V2CheckInfo&gt;**](V2CheckInfo.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_checks_retrieve
+
+> <V2CheckInfo> v2_checks_retrieve(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::ChecksApi.new
+check_type = 'check_type_example' # String | 
+
+begin
+  
+  result = api_instance.v2_checks_retrieve(check_type)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling ChecksApi->v2_checks_retrieve: #{e}"
+end
+```
+
+#### Using the v2_checks_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V2CheckInfo>, Integer, Hash)> v2_checks_retrieve_with_http_info(check_type)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_checks_retrieve_with_http_info(check_type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V2CheckInfo>
+rescue Pescheck::ApiError => e
+  puts "Error when calling ChecksApi->v2_checks_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_type** | **String** |  |  |
+
+### Return type
+
+[**V2CheckInfo**](V2CheckInfo.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CustomTokenObtainPair.md

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

data/docs/DivisionReadOnly.md

@@ -0,0 +1,46 @@
+# Pescheck::DivisionReadOnly
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** |  | [optional] |
+| **parent** | **String** |  | [readonly] |
+| **created_at** | **Time** |  | [readonly] |
+| **updated_at** | **Time** |  | [readonly] |
+| **city** | **String** |  | [optional] |
+| **address** | **String** |  | [optional] |
+| **postal** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **contact_name** | **String** |  | [optional] |
+| **contact_email** | **String** |  | [optional] |
+| **invoice_email** | **String** |  | [optional] |
+| **use_parent_on_email** | **Boolean** |  | [optional] |
+| **use_parent_on_billing** | **Boolean** |  | [optional] |
+| **use_parent_on_report** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::DivisionReadOnly.new(
+  id: null,
+  name: null,
+  parent: null,
+  created_at: null,
+  updated_at: null,
+  city: null,
+  address: null,
+  postal: null,
+  phone: null,
+  contact_name: null,
+  contact_email: null,
+  invoice_email: null,
+  use_parent_on_email: null,
+  use_parent_on_billing: null,
+  use_parent_on_report: null
+)
+```
+

data/docs/DivisionWrite.md

@@ -0,0 +1,40 @@
+# Pescheck::DivisionWrite
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **name** | **String** |  |  |
+| **city** | **String** |  |  |
+| **address** | **String** |  |  |
+| **postal** | **String** |  |  |
+| **phone** | **String** |  |  |
+| **contact_name** | **String** |  |  |
+| **contact_email** | **String** |  |  |
+| **invoice_email** | **String** |  |  |
+| **use_parent_on_email** | **Boolean** |  | [optional] |
+| **use_parent_on_billing** | **Boolean** |  | [optional] |
+| **use_parent_on_report** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::DivisionWrite.new(
+  id: null,
+  name: null,
+  city: null,
+  address: null,
+  postal: null,
+  phone: null,
+  contact_name: null,
+  contact_email: null,
+  invoice_email: null,
+  use_parent_on_email: null,
+  use_parent_on_billing: null,
+  use_parent_on_report: null
+)
+```
+