pescheck-client 0.0.5

data/docs/DivisionsApi.md

@@ -0,0 +1,369 @@
+# Pescheck::DivisionsApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v2_organisations_divisions_create**](DivisionsApi.md#v2_organisations_divisions_create) | **POST** /api/v2/organisations/divisions/ |  |
+| [**v2_organisations_divisions_list**](DivisionsApi.md#v2_organisations_divisions_list) | **GET** /api/v2/organisations/divisions/ |  |
+| [**v2_organisations_divisions_partial_update**](DivisionsApi.md#v2_organisations_divisions_partial_update) | **PATCH** /api/v2/organisations/divisions/{id}/ |  |
+| [**v2_organisations_divisions_retrieve**](DivisionsApi.md#v2_organisations_divisions_retrieve) | **GET** /api/v2/organisations/divisions/{id}/ |  |
+| [**v2_organisations_divisions_update**](DivisionsApi.md#v2_organisations_divisions_update) | **PUT** /api/v2/organisations/divisions/{id}/ |  |
+
+
+## v2_organisations_divisions_create
+
+> <DivisionWrite> v2_organisations_divisions_create(division_write)
+
+
+
+Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
+
+### 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::DivisionsApi.new
+division_write = Pescheck::DivisionWrite.new({name: 'name_example', city: 'city_example', address: 'address_example', postal: 'postal_example', phone: 'phone_example', contact_name: 'contact_name_example', contact_email: 'contact_email_example', invoice_email: 'invoice_email_example'}) # DivisionWrite | 
+
+begin
+  
+  result = api_instance.v2_organisations_divisions_create(division_write)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_create: #{e}"
+end
+```
+
+#### Using the v2_organisations_divisions_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DivisionWrite>, Integer, Hash)> v2_organisations_divisions_create_with_http_info(division_write)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_organisations_divisions_create_with_http_info(division_write)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DivisionWrite>
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **division_write** | [**DivisionWrite**](DivisionWrite.md) |  |  |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## v2_organisations_divisions_list
+
+> <PaginatedDivisionReadOnlyList> v2_organisations_divisions_list(opts)
+
+
+
+List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+
+### 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::DivisionsApi.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_organisations_divisions_list(opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_list: #{e}"
+end
+```
+
+#### Using the v2_organisations_divisions_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedDivisionReadOnlyList>, Integer, Hash)> v2_organisations_divisions_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_organisations_divisions_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedDivisionReadOnlyList>
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_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
+
+[**PaginatedDivisionReadOnlyList**](PaginatedDivisionReadOnlyList.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_organisations_divisions_partial_update
+
+> <DivisionWrite> v2_organisations_divisions_partial_update(id, opts)
+
+
+
+A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
+
+### 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::DivisionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | A UUID string identifying this organisation.
+opts = {
+  patched_division_write: Pescheck::PatchedDivisionWrite.new # PatchedDivisionWrite | 
+}
+
+begin
+  
+  result = api_instance.v2_organisations_divisions_partial_update(id, opts)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_partial_update: #{e}"
+end
+```
+
+#### Using the v2_organisations_divisions_partial_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DivisionWrite>, Integer, Hash)> v2_organisations_divisions_partial_update_with_http_info(id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_organisations_divisions_partial_update_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DivisionWrite>
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_partial_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A UUID string identifying this organisation. |  |
+| **patched_division_write** | [**PatchedDivisionWrite**](PatchedDivisionWrite.md) |  | [optional] |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## v2_organisations_divisions_retrieve
+
+> <DivisionReadOnly> v2_organisations_divisions_retrieve(id)
+
+
+
+A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
+
+### 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::DivisionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | A UUID string identifying this organisation.
+
+begin
+  
+  result = api_instance.v2_organisations_divisions_retrieve(id)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_retrieve: #{e}"
+end
+```
+
+#### Using the v2_organisations_divisions_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DivisionReadOnly>, Integer, Hash)> v2_organisations_divisions_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_organisations_divisions_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DivisionReadOnly>
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A UUID string identifying this organisation. |  |
+
+### Return type
+
+[**DivisionReadOnly**](DivisionReadOnly.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v2_organisations_divisions_update
+
+> <DivisionWrite> v2_organisations_divisions_update(id, division_write)
+
+
+
+Update an existing division's contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+
+### 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::DivisionsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | A UUID string identifying this organisation.
+division_write = Pescheck::DivisionWrite.new({name: 'name_example', city: 'city_example', address: 'address_example', postal: 'postal_example', phone: 'phone_example', contact_name: 'contact_name_example', contact_email: 'contact_email_example', invoice_email: 'invoice_email_example'}) # DivisionWrite | 
+
+begin
+  
+  result = api_instance.v2_organisations_divisions_update(id, division_write)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_update: #{e}"
+end
+```
+
+#### Using the v2_organisations_divisions_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DivisionWrite>, Integer, Hash)> v2_organisations_divisions_update_with_http_info(id, division_write)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v2_organisations_divisions_update_with_http_info(id, division_write)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DivisionWrite>
+rescue Pescheck::ApiError => e
+  puts "Error when calling DivisionsApi->v2_organisations_divisions_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A UUID string identifying this organisation. |  |
+| **division_write** | [**DivisionWrite**](DivisionWrite.md) |  |  |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+

data/docs/JWTGeneration.md

@@ -0,0 +1,24 @@
+# Pescheck::JWTGeneration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address of the API user |  |
+| **password** | **String** | Password for the API user |  |
+| **organisation_id** | **String** | Organization ID to generate token for | [optional] |
+| **division_id** | **String** | Division ID to generate token for (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::JWTGeneration.new(
+  email: null,
+  password: null,
+  organisation_id: null,
+  division_id: null
+)
+```
+

data/docs/JWTResponse.md

@@ -0,0 +1,28 @@
+# Pescheck::JWTResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** | JWT access token |  |
+| **refresh_token** | **String** | JWT refresh token |  |
+| **token_type** | **String** |  | [optional][default to 'Bearer'] |
+| **expires_in** | **Integer** | Access token expiration in seconds |  |
+| **organisation** | **String** | Organization name |  |
+| **organisation_id** | **String** | Organization ID |  |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::JWTResponse.new(
+  access_token: null,
+  refresh_token: null,
+  token_type: null,
+  expires_in: null,
+  organisation: null,
+  organisation_id: null
+)
+```
+

data/docs/OAuthApi.md

@@ -0,0 +1,213 @@
+# Pescheck::OAuthApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_o_auth_application2**](OAuthApi.md#create_o_auth_application2) | **POST** /api/v2/oauth/applications/ |  |
+| [**delete_o_auth_application2**](OAuthApi.md#delete_o_auth_application2) | **DELETE** /api/v2/oauth/applications/{application_id}/ |  |
+| [**list_o_auth_applications2**](OAuthApi.md#list_o_auth_applications2) | **GET** /api/v2/oauth/applications/list/ |  |
+
+
+## create_o_auth_application2
+
+> <OAuthApplicationResponse> create_o_auth_application2(o_auth_application)
+
+
+
+Create OAuth application for API access
+
+### 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::OAuthApi.new
+o_auth_application = Pescheck::OAuthApplication.new({name: 'name_example'}) # OAuthApplication | 
+
+begin
+  
+  result = api_instance.create_o_auth_application2(o_auth_application)
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->create_o_auth_application2: #{e}"
+end
+```
+
+#### Using the create_o_auth_application2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthApplicationResponse>, Integer, Hash)> create_o_auth_application2_with_http_info(o_auth_application)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_o_auth_application2_with_http_info(o_auth_application)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthApplicationResponse>
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->create_o_auth_application2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **o_auth_application** | [**OAuthApplication**](OAuthApplication.md) |  |  |
+
+### Return type
+
+[**OAuthApplicationResponse**](OAuthApplicationResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## delete_o_auth_application2
+
+> delete_o_auth_application2(application_id)
+
+
+
+Delete an OAuth application
+
+### 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::OAuthApi.new
+application_id = 'application_id_example' # String | Application ID to delete
+
+begin
+  
+  api_instance.delete_o_auth_application2(application_id)
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->delete_o_auth_application2: #{e}"
+end
+```
+
+#### Using the delete_o_auth_application2_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_o_auth_application2_with_http_info(application_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_o_auth_application2_with_http_info(application_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->delete_o_auth_application2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **application_id** | **String** | Application 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_o_auth_applications2
+
+> <Array<OAuthApplicationResponse>> list_o_auth_applications2
+
+
+
+List OAuth applications 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::OAuthApi.new
+
+begin
+  
+  result = api_instance.list_o_auth_applications2
+  p result
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->list_o_auth_applications2: #{e}"
+end
+```
+
+#### Using the list_o_auth_applications2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<OAuthApplicationResponse>>, Integer, Hash)> list_o_auth_applications2_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.list_o_auth_applications2_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<OAuthApplicationResponse>>
+rescue Pescheck::ApiError => e
+  puts "Error when calling OAuthApi->list_o_auth_applications2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;OAuthApplicationResponse&gt;**](OAuthApplicationResponse.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OAuthApplication.md

@@ -0,0 +1,26 @@
+# Pescheck::OAuthApplication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for the OAuth application |  |
+| **client_type** | **String** | Client type (confidential recommended for server-to-server)  * `confidential` - Confidential * `public` - Public | [optional][default to 'confidential'] |
+| **authorization_grant_type** | **String** | Grant type (client_credentials for API access)  * `authorization-code` - Authorization code * `implicit` - Implicit * `password` - Resource owner password-based * `client-credentials` - Client credentials * `openid-hybrid` - OpenID connect hybrid | [optional][default to 'client-credentials'] |
+| **redirect_uris** | **String** | Space-separated redirect URIs (optional for client_credentials) | [optional] |
+| **division_id** | **String** | Division ID to create application for (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::OAuthApplication.new(
+  name: null,
+  client_type: null,
+  authorization_grant_type: null,
+  redirect_uris: null,
+  division_id: null
+)
+```
+

data/docs/OAuthApplicationResponse.md

@@ -0,0 +1,32 @@
+# Pescheck::OAuthApplicationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [readonly] |
+| **name** | **String** |  | [optional] |
+| **client_id** | **String** |  | [optional] |
+| **client_secret** | **String** |  | [readonly] |
+| **client_type** | **String** | * `confidential` - Confidential * `public` - Public |  |
+| **authorization_grant_type** | **String** | * `authorization-code` - Authorization code * `implicit` - Implicit * `password` - Resource owner password-based * `client-credentials` - Client credentials * `openid-hybrid` - OpenID connect hybrid |  |
+| **created** | **Time** |  | [readonly] |
+| **updated** | **Time** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pescheck-client'
+
+instance = Pescheck::OAuthApplicationResponse.new(
+  id: null,
+  name: null,
+  client_id: null,
+  client_secret: null,
+  client_type: null,
+  authorization_grant_type: null,
+  created: null,
+  updated: null
+)
+```
+