pescheck 0.0.1
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +193 -0
- data/Rakefile +10 -0
- data/docs/AuthenticationApi.md +217 -0
- data/docs/ChecksApi.md +147 -0
- data/docs/CustomTokenObtainPair.md +20 -0
- data/docs/DivisionReadOnly.md +46 -0
- data/docs/DivisionWrite.md +40 -0
- data/docs/DivisionsApi.md +369 -0
- data/docs/JWTGeneration.md +24 -0
- data/docs/JWTResponse.md +28 -0
- data/docs/OAuthApi.md +213 -0
- data/docs/OAuthApplication.md +26 -0
- data/docs/OAuthApplicationResponse.md +32 -0
- data/docs/PaginatedDivisionReadOnlyList.md +24 -0
- data/docs/PaginatedV2ProfileListItemList.md +24 -0
- data/docs/PaginatedV2ScreeningListItemList.md +24 -0
- data/docs/PatchedDivisionWrite.md +40 -0
- data/docs/PatchedV2ProfilePartialUpdate.md +20 -0
- data/docs/ProfilesApi.md +438 -0
- data/docs/ScreeningsApi.md +293 -0
- data/docs/TokenRefresh.md +20 -0
- data/docs/V2Candidate.md +36 -0
- data/docs/V2CheckField.md +26 -0
- data/docs/V2CheckInfo.md +40 -0
- data/docs/V2Document.md +28 -0
- data/docs/V2DocumentContent.md +20 -0
- data/docs/V2Money.md +20 -0
- data/docs/V2ProfileCheck.md +20 -0
- data/docs/V2ProfileCheckEntry.md +30 -0
- data/docs/V2ProfileCreate.md +22 -0
- data/docs/V2ProfileDetail.md +38 -0
- data/docs/V2ProfileListItem.md +30 -0
- data/docs/V2ProfileUpdate.md +22 -0
- data/docs/V2ProfileUpdateCheck.md +22 -0
- data/docs/V2ScreeningCheck.md +24 -0
- data/docs/V2ScreeningCheckEntry.md +34 -0
- data/docs/V2ScreeningCheckListItem.md +22 -0
- data/docs/V2ScreeningCreate.md +22 -0
- data/docs/V2ScreeningDetail.md +34 -0
- data/docs/V2ScreeningDetailProfile.md +20 -0
- data/docs/V2ScreeningListItem.md +34 -0
- data/docs/VerifyWebhook.md +18 -0
- data/docs/Webhook.md +26 -0
- data/docs/WebhookResponse.md +36 -0
- data/docs/WebhooksApi.md +290 -0
- data/git_push.sh +57 -0
- data/lib/pescheck/api/authentication_api.rb +220 -0
- data/lib/pescheck/api/checks_api.rb +144 -0
- data/lib/pescheck/api/divisions_api.rb +365 -0
- data/lib/pescheck/api/o_auth_api.rb +202 -0
- data/lib/pescheck/api/profiles_api.rb +432 -0
- data/lib/pescheck/api/screenings_api.rb +288 -0
- data/lib/pescheck/api/webhooks_api.rb +278 -0
- data/lib/pescheck/api_client.rb +441 -0
- data/lib/pescheck/api_error.rb +58 -0
- data/lib/pescheck/api_model_base.rb +88 -0
- data/lib/pescheck/configuration.rb +429 -0
- data/lib/pescheck/models/custom_token_obtain_pair.rb +191 -0
- data/lib/pescheck/models/division_read_only.rb +469 -0
- data/lib/pescheck/models/division_write.rb +436 -0
- data/lib/pescheck/models/jwt_generation.rb +213 -0
- data/lib/pescheck/models/jwt_response.rb +285 -0
- data/lib/pescheck/models/o_auth_application.rb +265 -0
- data/lib/pescheck/models/o_auth_application_response.rb +379 -0
- data/lib/pescheck/models/paginated_division_read_only_list.rb +216 -0
- data/lib/pescheck/models/paginated_v2_profile_list_item_list.rb +216 -0
- data/lib/pescheck/models/paginated_v2_screening_list_item_list.rb +216 -0
- data/lib/pescheck/models/patched_division_write.rb +360 -0
- data/lib/pescheck/models/patched_v2_profile_partial_update.rb +176 -0
- data/lib/pescheck/models/token_refresh.rb +173 -0
- data/lib/pescheck/models/v2_candidate.rb +390 -0
- data/lib/pescheck/models/v2_check_field.rb +246 -0
- data/lib/pescheck/models/v2_check_info.rb +438 -0
- data/lib/pescheck/models/v2_document.rb +308 -0
- data/lib/pescheck/models/v2_document_content.rb +175 -0
- data/lib/pescheck/models/v2_money.rb +210 -0
- data/lib/pescheck/models/v2_profile_check.rb +201 -0
- data/lib/pescheck/models/v2_profile_check_entry.rb +349 -0
- data/lib/pescheck/models/v2_profile_create.rb +212 -0
- data/lib/pescheck/models/v2_profile_detail.rb +401 -0
- data/lib/pescheck/models/v2_profile_list_item.rb +291 -0
- data/lib/pescheck/models/v2_profile_update.rb +213 -0
- data/lib/pescheck/models/v2_profile_update_check.rb +210 -0
- data/lib/pescheck/models/v2_screening_check.rb +221 -0
- data/lib/pescheck/models/v2_screening_check_entry.rb +376 -0
- data/lib/pescheck/models/v2_screening_check_list_item.rb +242 -0
- data/lib/pescheck/models/v2_screening_create.rb +201 -0
- data/lib/pescheck/models/v2_screening_detail.rb +348 -0
- data/lib/pescheck/models/v2_screening_detail_profile.rb +156 -0
- data/lib/pescheck/models/v2_screening_list_item.rb +330 -0
- data/lib/pescheck/models/verify_webhook.rb +166 -0
- data/lib/pescheck/models/webhook.rb +265 -0
- data/lib/pescheck/models/webhook_response.rb +353 -0
- data/lib/pescheck/version.rb +15 -0
- data/lib/pescheck.rb +83 -0
- data/pescheck.gemspec +41 -0
- data/spec/api/authentication_api_spec.rb +68 -0
- data/spec/api/checks_api_spec.rb +56 -0
- data/spec/api/divisions_api_spec.rb +94 -0
- data/spec/api/o_auth_api_spec.rb +67 -0
- data/spec/api/profiles_api_spec.rb +105 -0
- data/spec/api/screenings_api_spec.rb +81 -0
- data/spec/api/webhooks_api_spec.rb +81 -0
- data/spec/models/custom_token_obtain_pair_spec.rb +42 -0
- data/spec/models/division_read_only_spec.rb +120 -0
- data/spec/models/division_write_spec.rb +102 -0
- data/spec/models/jwt_generation_spec.rb +54 -0
- data/spec/models/jwt_response_spec.rb +66 -0
- data/spec/models/o_auth_application_response_spec.rb +86 -0
- data/spec/models/o_auth_application_spec.rb +68 -0
- data/spec/models/paginated_division_read_only_list_spec.rb +54 -0
- data/spec/models/paginated_v2_profile_list_item_list_spec.rb +54 -0
- data/spec/models/paginated_v2_screening_list_item_list_spec.rb +54 -0
- data/spec/models/patched_division_write_spec.rb +102 -0
- data/spec/models/patched_v2_profile_partial_update_spec.rb +42 -0
- data/spec/models/token_refresh_spec.rb +42 -0
- data/spec/models/v2_candidate_spec.rb +94 -0
- data/spec/models/v2_check_field_spec.rb +60 -0
- data/spec/models/v2_check_info_spec.rb +102 -0
- data/spec/models/v2_document_content_spec.rb +42 -0
- data/spec/models/v2_document_spec.rb +70 -0
- data/spec/models/v2_money_spec.rb +42 -0
- data/spec/models/v2_profile_check_entry_spec.rb +76 -0
- data/spec/models/v2_profile_check_spec.rb +46 -0
- data/spec/models/v2_profile_create_spec.rb +48 -0
- data/spec/models/v2_profile_detail_spec.rb +96 -0
- data/spec/models/v2_profile_list_item_spec.rb +72 -0
- data/spec/models/v2_profile_update_check_spec.rb +52 -0
- data/spec/models/v2_profile_update_spec.rb +48 -0
- data/spec/models/v2_screening_check_entry_spec.rb +88 -0
- data/spec/models/v2_screening_check_list_item_spec.rb +52 -0
- data/spec/models/v2_screening_check_spec.rb +58 -0
- data/spec/models/v2_screening_create_spec.rb +48 -0
- data/spec/models/v2_screening_detail_profile_spec.rb +42 -0
- data/spec/models/v2_screening_detail_spec.rb +84 -0
- data/spec/models/v2_screening_list_item_spec.rb +84 -0
- data/spec/models/verify_webhook_spec.rb +36 -0
- data/spec/models/webhook_response_spec.rb +90 -0
- data/spec/models/webhook_spec.rb +64 -0
- data/spec/spec_helper.rb +111 -0
- metadata +302 -0
data/lib/pescheck.rb
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
# Common files
|
|
14
|
+
require 'pescheck/api_client'
|
|
15
|
+
require 'pescheck/api_error'
|
|
16
|
+
require 'pescheck/api_model_base'
|
|
17
|
+
require 'pescheck/version'
|
|
18
|
+
require 'pescheck/configuration'
|
|
19
|
+
|
|
20
|
+
# Models
|
|
21
|
+
require 'pescheck/models/custom_token_obtain_pair'
|
|
22
|
+
require 'pescheck/models/division_read_only'
|
|
23
|
+
require 'pescheck/models/division_write'
|
|
24
|
+
require 'pescheck/models/jwt_generation'
|
|
25
|
+
require 'pescheck/models/jwt_response'
|
|
26
|
+
require 'pescheck/models/o_auth_application'
|
|
27
|
+
require 'pescheck/models/o_auth_application_response'
|
|
28
|
+
require 'pescheck/models/paginated_division_read_only_list'
|
|
29
|
+
require 'pescheck/models/paginated_v2_profile_list_item_list'
|
|
30
|
+
require 'pescheck/models/paginated_v2_screening_list_item_list'
|
|
31
|
+
require 'pescheck/models/patched_division_write'
|
|
32
|
+
require 'pescheck/models/patched_v2_profile_partial_update'
|
|
33
|
+
require 'pescheck/models/token_refresh'
|
|
34
|
+
require 'pescheck/models/v2_candidate'
|
|
35
|
+
require 'pescheck/models/v2_check_field'
|
|
36
|
+
require 'pescheck/models/v2_check_info'
|
|
37
|
+
require 'pescheck/models/v2_document'
|
|
38
|
+
require 'pescheck/models/v2_document_content'
|
|
39
|
+
require 'pescheck/models/v2_money'
|
|
40
|
+
require 'pescheck/models/v2_profile_check'
|
|
41
|
+
require 'pescheck/models/v2_profile_check_entry'
|
|
42
|
+
require 'pescheck/models/v2_profile_create'
|
|
43
|
+
require 'pescheck/models/v2_profile_detail'
|
|
44
|
+
require 'pescheck/models/v2_profile_list_item'
|
|
45
|
+
require 'pescheck/models/v2_profile_update'
|
|
46
|
+
require 'pescheck/models/v2_profile_update_check'
|
|
47
|
+
require 'pescheck/models/v2_screening_check'
|
|
48
|
+
require 'pescheck/models/v2_screening_check_entry'
|
|
49
|
+
require 'pescheck/models/v2_screening_check_list_item'
|
|
50
|
+
require 'pescheck/models/v2_screening_create'
|
|
51
|
+
require 'pescheck/models/v2_screening_detail'
|
|
52
|
+
require 'pescheck/models/v2_screening_detail_profile'
|
|
53
|
+
require 'pescheck/models/v2_screening_list_item'
|
|
54
|
+
require 'pescheck/models/verify_webhook'
|
|
55
|
+
require 'pescheck/models/webhook'
|
|
56
|
+
require 'pescheck/models/webhook_response'
|
|
57
|
+
|
|
58
|
+
# APIs
|
|
59
|
+
require 'pescheck/api/authentication_api'
|
|
60
|
+
require 'pescheck/api/checks_api'
|
|
61
|
+
require 'pescheck/api/divisions_api'
|
|
62
|
+
require 'pescheck/api/o_auth_api'
|
|
63
|
+
require 'pescheck/api/profiles_api'
|
|
64
|
+
require 'pescheck/api/screenings_api'
|
|
65
|
+
require 'pescheck/api/webhooks_api'
|
|
66
|
+
|
|
67
|
+
module Pescheck
|
|
68
|
+
class << self
|
|
69
|
+
# Customize default settings for the SDK using block.
|
|
70
|
+
# Pescheck.configure do |config|
|
|
71
|
+
# config.username = "xxx"
|
|
72
|
+
# config.password = "xxx"
|
|
73
|
+
# end
|
|
74
|
+
# If no block given, return the default Configuration object.
|
|
75
|
+
def configure
|
|
76
|
+
if block_given?
|
|
77
|
+
yield(Configuration.default)
|
|
78
|
+
else
|
|
79
|
+
Configuration.default
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
end
|
data/pescheck.gemspec
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
=begin
|
|
4
|
+
#Pescheck API
|
|
5
|
+
|
|
6
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
|
+
|
|
10
|
+
Generated by: https://openapi-generator.tech
|
|
11
|
+
Generator version: 7.23.0
|
|
12
|
+
|
|
13
|
+
=end
|
|
14
|
+
|
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
|
16
|
+
require "pescheck/version"
|
|
17
|
+
|
|
18
|
+
Gem::Specification.new do |s|
|
|
19
|
+
s.name = "pescheck"
|
|
20
|
+
s.version = Pescheck::VERSION
|
|
21
|
+
s.platform = Gem::Platform::RUBY
|
|
22
|
+
s.authors = ["OpenAPI-Generator"]
|
|
23
|
+
s.email = [""]
|
|
24
|
+
s.homepage = "https://openapi-generator.tech"
|
|
25
|
+
s.summary = "Pescheck API Ruby Gem"
|
|
26
|
+
s.description = "API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api"
|
|
27
|
+
s.license = "Unlicense"
|
|
28
|
+
s.required_ruby_version = ">= 2.7"
|
|
29
|
+
s.metadata = {}
|
|
30
|
+
|
|
31
|
+
s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
|
|
32
|
+
s.add_runtime_dependency 'faraday-multipart'
|
|
33
|
+
s.add_runtime_dependency 'marcel'
|
|
34
|
+
|
|
35
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
|
36
|
+
|
|
37
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
|
38
|
+
s.test_files = `find spec/*`.split("\n")
|
|
39
|
+
s.executables = []
|
|
40
|
+
s.require_paths = ["lib"]
|
|
41
|
+
end
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::AuthenticationApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'AuthenticationApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::AuthenticationApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of AuthenticationApi' do
|
|
30
|
+
it 'should create an instance of AuthenticationApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::AuthenticationApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for generate_jwt_token2
|
|
36
|
+
# 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/.
|
|
37
|
+
# @param jwt_generation
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @return [JWTResponse]
|
|
40
|
+
describe 'generate_jwt_token2 test' do
|
|
41
|
+
it 'should work' do
|
|
42
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# unit tests for jwt_create
|
|
47
|
+
# 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/.
|
|
48
|
+
# @param custom_token_obtain_pair
|
|
49
|
+
# @param [Hash] opts the optional parameters
|
|
50
|
+
# @return [CustomTokenObtainPair]
|
|
51
|
+
describe 'jwt_create test' do
|
|
52
|
+
it 'should work' do
|
|
53
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# unit tests for jwt_refresh_create
|
|
58
|
+
# Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
|
|
59
|
+
# @param token_refresh
|
|
60
|
+
# @param [Hash] opts the optional parameters
|
|
61
|
+
# @return [TokenRefresh]
|
|
62
|
+
describe 'jwt_refresh_create test' do
|
|
63
|
+
it 'should work' do
|
|
64
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::ChecksApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'ChecksApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::ChecksApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of ChecksApi' do
|
|
30
|
+
it 'should create an instance of ChecksApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::ChecksApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for v2_checks_list
|
|
36
|
+
# 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.
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @option opts [String] :check_type Restrict the list to a single check type.
|
|
39
|
+
# @return [Array<V2CheckInfo>]
|
|
40
|
+
describe 'v2_checks_list test' do
|
|
41
|
+
it 'should work' do
|
|
42
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# unit tests for v2_checks_retrieve
|
|
47
|
+
# @param check_type
|
|
48
|
+
# @param [Hash] opts the optional parameters
|
|
49
|
+
# @return [V2CheckInfo]
|
|
50
|
+
describe 'v2_checks_retrieve test' do
|
|
51
|
+
it 'should work' do
|
|
52
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
end
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::DivisionsApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'DivisionsApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::DivisionsApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of DivisionsApi' do
|
|
30
|
+
it 'should create an instance of DivisionsApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::DivisionsApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for v2_organisations_divisions_create
|
|
36
|
+
# 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.
|
|
37
|
+
# @param division_write
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @return [DivisionWrite]
|
|
40
|
+
describe 'v2_organisations_divisions_create test' do
|
|
41
|
+
it 'should work' do
|
|
42
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# unit tests for v2_organisations_divisions_list
|
|
47
|
+
# List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
|
|
48
|
+
# @param [Hash] opts the optional parameters
|
|
49
|
+
# @option opts [Integer] :page A page number within the paginated result set.
|
|
50
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
51
|
+
# @option opts [Boolean] :paginate Enable/disable pagination. When false, max 500 records returned.
|
|
52
|
+
# @return [PaginatedDivisionReadOnlyList]
|
|
53
|
+
describe 'v2_organisations_divisions_list test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# unit tests for v2_organisations_divisions_partial_update
|
|
60
|
+
# 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.
|
|
61
|
+
# @param id A UUID string identifying this organisation.
|
|
62
|
+
# @param [Hash] opts the optional parameters
|
|
63
|
+
# @option opts [PatchedDivisionWrite] :patched_division_write
|
|
64
|
+
# @return [DivisionWrite]
|
|
65
|
+
describe 'v2_organisations_divisions_partial_update test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# unit tests for v2_organisations_divisions_retrieve
|
|
72
|
+
# 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.
|
|
73
|
+
# @param id A UUID string identifying this organisation.
|
|
74
|
+
# @param [Hash] opts the optional parameters
|
|
75
|
+
# @return [DivisionReadOnly]
|
|
76
|
+
describe 'v2_organisations_divisions_retrieve test' do
|
|
77
|
+
it 'should work' do
|
|
78
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# unit tests for v2_organisations_divisions_update
|
|
83
|
+
# Update an existing division's contact, billing, and address details. Override also triggers a webhook on successful PUT and PATCH requests.
|
|
84
|
+
# @param id A UUID string identifying this organisation.
|
|
85
|
+
# @param division_write
|
|
86
|
+
# @param [Hash] opts the optional parameters
|
|
87
|
+
# @return [DivisionWrite]
|
|
88
|
+
describe 'v2_organisations_divisions_update test' do
|
|
89
|
+
it 'should work' do
|
|
90
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
end
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::OAuthApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'OAuthApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::OAuthApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of OAuthApi' do
|
|
30
|
+
it 'should create an instance of OAuthApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::OAuthApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for create_o_auth_application2
|
|
36
|
+
# Create OAuth application for API access
|
|
37
|
+
# @param o_auth_application
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @return [OAuthApplicationResponse]
|
|
40
|
+
describe 'create_o_auth_application2 test' do
|
|
41
|
+
it 'should work' do
|
|
42
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# unit tests for delete_o_auth_application2
|
|
47
|
+
# Delete an OAuth application
|
|
48
|
+
# @param application_id Application ID to delete
|
|
49
|
+
# @param [Hash] opts the optional parameters
|
|
50
|
+
# @return [nil]
|
|
51
|
+
describe 'delete_o_auth_application2 test' do
|
|
52
|
+
it 'should work' do
|
|
53
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# unit tests for list_o_auth_applications2
|
|
58
|
+
# List OAuth applications for the organization
|
|
59
|
+
# @param [Hash] opts the optional parameters
|
|
60
|
+
# @return [Array<OAuthApplicationResponse>]
|
|
61
|
+
describe 'list_o_auth_applications2 test' do
|
|
62
|
+
it 'should work' do
|
|
63
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
end
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::ProfilesApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'ProfilesApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::ProfilesApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of ProfilesApi' do
|
|
30
|
+
it 'should create an instance of ProfilesApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::ProfilesApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for v2_profiles_create
|
|
36
|
+
# @param v2_profile_create
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [V2ProfileDetail]
|
|
39
|
+
describe 'v2_profiles_create test' do
|
|
40
|
+
it 'should work' do
|
|
41
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# unit tests for v2_profiles_destroy
|
|
46
|
+
# @param id A UUID string identifying this profile.
|
|
47
|
+
# @param [Hash] opts the optional parameters
|
|
48
|
+
# @return [nil]
|
|
49
|
+
describe 'v2_profiles_destroy test' do
|
|
50
|
+
it 'should work' do
|
|
51
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# unit tests for v2_profiles_list
|
|
56
|
+
# @param [Hash] opts the optional parameters
|
|
57
|
+
# @option opts [String] :check_type Restrict to profiles containing at least one check of this type.
|
|
58
|
+
# @option opts [Boolean] :is_custom Restrict to custom (true) or system (false) profiles.
|
|
59
|
+
# @option opts [String] :name Restrict to profiles whose name contains this value (case-insensitive).
|
|
60
|
+
# @option opts [Integer] :page A page number within the paginated result set.
|
|
61
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
62
|
+
# @option opts [Boolean] :paginate Enable/disable pagination. When false, max 500 records returned.
|
|
63
|
+
# @option opts [String] :sort Which field to use when ordering the results.
|
|
64
|
+
# @return [PaginatedV2ProfileListItemList]
|
|
65
|
+
describe 'v2_profiles_list test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# unit tests for v2_profiles_partial_update
|
|
72
|
+
# Update name and/or description only. Use PUT to change the check list.
|
|
73
|
+
# @param id A UUID string identifying this profile.
|
|
74
|
+
# @param [Hash] opts the optional parameters
|
|
75
|
+
# @option opts [PatchedV2ProfilePartialUpdate] :patched_v2_profile_partial_update
|
|
76
|
+
# @return [V2ProfileDetail]
|
|
77
|
+
describe 'v2_profiles_partial_update test' do
|
|
78
|
+
it 'should work' do
|
|
79
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# unit tests for v2_profiles_retrieve
|
|
84
|
+
# @param id A UUID string identifying this profile.
|
|
85
|
+
# @param [Hash] opts the optional parameters
|
|
86
|
+
# @return [V2ProfileDetail]
|
|
87
|
+
describe 'v2_profiles_retrieve test' do
|
|
88
|
+
it 'should work' do
|
|
89
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# unit tests for v2_profiles_update
|
|
94
|
+
# Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
|
|
95
|
+
# @param id A UUID string identifying this profile.
|
|
96
|
+
# @param v2_profile_update
|
|
97
|
+
# @param [Hash] opts the optional parameters
|
|
98
|
+
# @return [V2ProfileDetail]
|
|
99
|
+
describe 'v2_profiles_update test' do
|
|
100
|
+
it 'should work' do
|
|
101
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
end
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Pescheck API
|
|
3
|
+
|
|
4
|
+
#API for Pescheck ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.23.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Pescheck::ScreeningsApi
|
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'ScreeningsApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@api_instance = Pescheck::ScreeningsApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of ScreeningsApi' do
|
|
30
|
+
it 'should create an instance of ScreeningsApi' do
|
|
31
|
+
expect(@api_instance).to be_instance_of(Pescheck::ScreeningsApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for v2_screenings_create
|
|
36
|
+
# @param v2_screening_create
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [V2ScreeningDetail]
|
|
39
|
+
describe 'v2_screenings_create test' do
|
|
40
|
+
it 'should work' do
|
|
41
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# unit tests for v2_screenings_documents_list
|
|
46
|
+
# Retrieve screening documents
|
|
47
|
+
# Documents attached to the screening's checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
|
|
48
|
+
# @param id
|
|
49
|
+
# @param [Hash] opts the optional parameters
|
|
50
|
+
# @option opts [String] :check_id Only documents from the check with this id.
|
|
51
|
+
# @option opts [String] :check_type Only documents from checks of this type.
|
|
52
|
+
# @return [Array<V2Document>]
|
|
53
|
+
describe 'v2_screenings_documents_list test' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# unit tests for v2_screenings_list
|
|
60
|
+
# @param [Hash] opts the optional parameters
|
|
61
|
+
# @option opts [Integer] :page A page number within the paginated result set.
|
|
62
|
+
# @option opts [Integer] :page_size Number of results to return per page.
|
|
63
|
+
# @option opts [Boolean] :paginate Enable/disable pagination. When false, max 500 records returned.
|
|
64
|
+
# @return [PaginatedV2ScreeningListItemList]
|
|
65
|
+
describe 'v2_screenings_list test' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
# unit tests for v2_screenings_retrieve
|
|
72
|
+
# @param id A UUID string identifying this screening.
|
|
73
|
+
# @param [Hash] opts the optional parameters
|
|
74
|
+
# @return [V2ScreeningDetail]
|
|
75
|
+
describe 'v2_screenings_retrieve test' do
|
|
76
|
+
it 'should work' do
|
|
77
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
end
|