@pescheckit/pescheck-client 0.0.5

package/src/models/DivisionWrite.ts

@@ -0,0 +1,160 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface DivisionWrite
+ */
+export interface DivisionWrite {
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    city: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    address: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    postal: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    phone: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    contactName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    contactEmail: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DivisionWrite
+     */
+    invoiceEmail: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DivisionWrite
+     */
+    useParentOnEmail?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DivisionWrite
+     */
+    useParentOnBilling?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DivisionWrite
+     */
+    useParentOnReport?: boolean;
+}
+
+/**
+ * Check if a given object implements the DivisionWrite interface.
+ */
+export function instanceOfDivisionWrite(value: any): value is DivisionWrite {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('city' in value) || value['city'] === undefined) return false;
+    if (!('address' in value) || value['address'] === undefined) return false;
+    if (!('postal' in value) || value['postal'] === undefined) return false;
+    if (!('phone' in value) || value['phone'] === undefined) return false;
+    if ((!('contactName' in value) && !('contact_name' in value)) || (value['contactName'] === undefined && value['contact_name'] === undefined)) return false;
+    if ((!('contactEmail' in value) && !('contact_email' in value)) || (value['contactEmail'] === undefined && value['contact_email'] === undefined)) return false;
+    if ((!('invoiceEmail' in value) && !('invoice_email' in value)) || (value['invoiceEmail'] === undefined && value['invoice_email'] === undefined)) return false;
+    return true;
+}
+
+export function DivisionWriteFromJSON(json: any): DivisionWrite {
+    return DivisionWriteFromJSONTyped(json, false);
+}
+
+export function DivisionWriteFromJSONTyped(json: any, ignoreDiscriminator: boolean): DivisionWrite {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'],
+        'city': json['city'],
+        'address': json['address'],
+        'postal': json['postal'],
+        'phone': json['phone'],
+        'contactName': json['contact_name'],
+        'contactEmail': json['contact_email'],
+        'invoiceEmail': json['invoice_email'],
+        'useParentOnEmail': json['use_parent_on_email'] == null ? undefined : json['use_parent_on_email'],
+        'useParentOnBilling': json['use_parent_on_billing'] == null ? undefined : json['use_parent_on_billing'],
+        'useParentOnReport': json['use_parent_on_report'] == null ? undefined : json['use_parent_on_report'],
+    };
+}
+
+export function DivisionWriteToJSON(json: any): DivisionWrite {
+    return DivisionWriteToJSONTyped(json, false);
+}
+
+export function DivisionWriteToJSONTyped(value?: Omit<DivisionWrite, 'id'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'city': value['city'],
+        'address': value['address'],
+        'postal': value['postal'],
+        'phone': value['phone'],
+        'contact_name': value['contactName'],
+        'contact_email': value['contactEmail'],
+        'invoice_email': value['invoiceEmail'],
+        'use_parent_on_email': value['useParentOnEmail'],
+        'use_parent_on_billing': value['useParentOnBilling'],
+        'use_parent_on_report': value['useParentOnReport'],
+    };
+}
+

package/src/models/JWTGeneration.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for JWT token generation for API users
+ * @export
+ * @interface JWTGeneration
+ */
+export interface JWTGeneration {
+    /**
+     * Email address of the API user
+     * @type {string}
+     * @memberof JWTGeneration
+     */
+    email: string;
+    /**
+     * Password for the API user
+     * @type {string}
+     * @memberof JWTGeneration
+     */
+    password: string;
+    /**
+     * Organization ID to generate token for
+     * @type {string}
+     * @memberof JWTGeneration
+     */
+    organisationId?: string;
+    /**
+     * Division ID to generate token for (optional)
+     * @type {string}
+     * @memberof JWTGeneration
+     */
+    divisionId?: string;
+}
+
+/**
+ * Check if a given object implements the JWTGeneration interface.
+ */
+export function instanceOfJWTGeneration(value: any): value is JWTGeneration {
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('password' in value) || value['password'] === undefined) return false;
+    return true;
+}
+
+export function JWTGenerationFromJSON(json: any): JWTGeneration {
+    return JWTGenerationFromJSONTyped(json, false);
+}
+
+export function JWTGenerationFromJSONTyped(json: any, ignoreDiscriminator: boolean): JWTGeneration {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'],
+        'password': json['password'],
+        'organisationId': json['organisation_id'] == null ? undefined : json['organisation_id'],
+        'divisionId': json['division_id'] == null ? undefined : json['division_id'],
+    };
+}
+
+export function JWTGenerationToJSON(json: any): JWTGeneration {
+    return JWTGenerationToJSONTyped(json, false);
+}
+
+export function JWTGenerationToJSONTyped(value?: JWTGeneration | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+        'password': value['password'],
+        'organisation_id': value['organisationId'],
+        'division_id': value['divisionId'],
+    };
+}
+

package/src/models/JWTResponse.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for JWT token response
+ * @export
+ * @interface JWTResponse
+ */
+export interface JWTResponse {
+    /**
+     * JWT access token
+     * @type {string}
+     * @memberof JWTResponse
+     */
+    accessToken: string;
+    /**
+     * JWT refresh token
+     * @type {string}
+     * @memberof JWTResponse
+     */
+    refreshToken: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof JWTResponse
+     */
+    tokenType?: string;
+    /**
+     * Access token expiration in seconds
+     * @type {number}
+     * @memberof JWTResponse
+     */
+    expiresIn: number;
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof JWTResponse
+     */
+    organisation: string;
+    /**
+     * Organization ID
+     * @type {string}
+     * @memberof JWTResponse
+     */
+    organisationId: string;
+}
+
+/**
+ * Check if a given object implements the JWTResponse interface.
+ */
+export function instanceOfJWTResponse(value: any): value is JWTResponse {
+    if ((!('accessToken' in value) && !('access_token' in value)) || (value['accessToken'] === undefined && value['access_token'] === undefined)) return false;
+    if ((!('refreshToken' in value) && !('refresh_token' in value)) || (value['refreshToken'] === undefined && value['refresh_token'] === undefined)) return false;
+    if ((!('expiresIn' in value) && !('expires_in' in value)) || (value['expiresIn'] === undefined && value['expires_in'] === undefined)) return false;
+    if (!('organisation' in value) || value['organisation'] === undefined) return false;
+    if ((!('organisationId' in value) && !('organisation_id' in value)) || (value['organisationId'] === undefined && value['organisation_id'] === undefined)) return false;
+    return true;
+}
+
+export function JWTResponseFromJSON(json: any): JWTResponse {
+    return JWTResponseFromJSONTyped(json, false);
+}
+
+export function JWTResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): JWTResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'accessToken': json['access_token'],
+        'refreshToken': json['refresh_token'],
+        'tokenType': json['token_type'] == null ? undefined : json['token_type'],
+        'expiresIn': json['expires_in'],
+        'organisation': json['organisation'],
+        'organisationId': json['organisation_id'],
+    };
+}
+
+export function JWTResponseToJSON(json: any): JWTResponse {
+    return JWTResponseToJSONTyped(json, false);
+}
+
+export function JWTResponseToJSONTyped(value?: JWTResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'access_token': value['accessToken'],
+        'refresh_token': value['refreshToken'],
+        'token_type': value['tokenType'],
+        'expires_in': value['expiresIn'],
+        'organisation': value['organisation'],
+        'organisation_id': value['organisationId'],
+    };
+}
+

package/src/models/OAuthApplication.ts

@@ -0,0 +1,130 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for OAuth application creation requests
+ * @export
+ * @interface OAuthApplication
+ */
+export interface OAuthApplication {
+    /**
+     * Name for the OAuth application
+     * @type {string}
+     * @memberof OAuthApplication
+     */
+    name: string;
+    /**
+     * Client type (confidential recommended for server-to-server)
+     * 
+     * * `confidential` - Confidential
+     * * `public` - Public
+     * @type {OAuthApplicationClientTypeEnum}
+     * @memberof OAuthApplication
+     */
+    clientType?: OAuthApplicationClientTypeEnum;
+    /**
+     * 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
+     * @type {OAuthApplicationAuthorizationGrantTypeEnum}
+     * @memberof OAuthApplication
+     */
+    authorizationGrantType?: OAuthApplicationAuthorizationGrantTypeEnum;
+    /**
+     * Space-separated redirect URIs (optional for client_credentials)
+     * @type {string}
+     * @memberof OAuthApplication
+     */
+    redirectUris?: string;
+    /**
+     * Division ID to create application for (optional)
+     * @type {string}
+     * @memberof OAuthApplication
+     */
+    divisionId?: string;
+}
+
+
+/**
+ * @export
+ */
+export const OAuthApplicationClientTypeEnum = {
+    Confidential: 'confidential',
+    Public: 'public'
+} as const;
+export type OAuthApplicationClientTypeEnum = typeof OAuthApplicationClientTypeEnum[keyof typeof OAuthApplicationClientTypeEnum];
+
+/**
+ * @export
+ */
+export const OAuthApplicationAuthorizationGrantTypeEnum = {
+    AuthorizationCode: 'authorization-code',
+    Implicit: 'implicit',
+    Password: 'password',
+    ClientCredentials: 'client-credentials',
+    OpenidHybrid: 'openid-hybrid'
+} as const;
+export type OAuthApplicationAuthorizationGrantTypeEnum = typeof OAuthApplicationAuthorizationGrantTypeEnum[keyof typeof OAuthApplicationAuthorizationGrantTypeEnum];
+
+
+/**
+ * Check if a given object implements the OAuthApplication interface.
+ */
+export function instanceOfOAuthApplication(value: any): value is OAuthApplication {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function OAuthApplicationFromJSON(json: any): OAuthApplication {
+    return OAuthApplicationFromJSONTyped(json, false);
+}
+
+export function OAuthApplicationFromJSONTyped(json: any, ignoreDiscriminator: boolean): OAuthApplication {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'clientType': json['client_type'] == null ? undefined : json['client_type'],
+        'authorizationGrantType': json['authorization_grant_type'] == null ? undefined : json['authorization_grant_type'],
+        'redirectUris': json['redirect_uris'] == null ? undefined : json['redirect_uris'],
+        'divisionId': json['division_id'] == null ? undefined : json['division_id'],
+    };
+}
+
+export function OAuthApplicationToJSON(json: any): OAuthApplication {
+    return OAuthApplicationToJSONTyped(json, false);
+}
+
+export function OAuthApplicationToJSONTyped(value?: OAuthApplication | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'client_type': value['clientType'],
+        'authorization_grant_type': value['authorizationGrantType'],
+        'redirect_uris': value['redirectUris'],
+        'division_id': value['divisionId'],
+    };
+}
+

package/src/models/OAuthApplicationResponse.ts

@@ -0,0 +1,151 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for OAuth application responses
+ * @export
+ * @interface OAuthApplicationResponse
+ */
+export interface OAuthApplicationResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof OAuthApplicationResponse
+     */
+    readonly id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OAuthApplicationResponse
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OAuthApplicationResponse
+     */
+    clientId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OAuthApplicationResponse
+     */
+    readonly clientSecret: string;
+    /**
+     * * `confidential` - Confidential
+     * * `public` - Public
+     * @type {OAuthApplicationResponseClientTypeEnum}
+     * @memberof OAuthApplicationResponse
+     */
+    clientType: OAuthApplicationResponseClientTypeEnum;
+    /**
+     * * `authorization-code` - Authorization code
+     * * `implicit` - Implicit
+     * * `password` - Resource owner password-based
+     * * `client-credentials` - Client credentials
+     * * `openid-hybrid` - OpenID connect hybrid
+     * @type {OAuthApplicationResponseAuthorizationGrantTypeEnum}
+     * @memberof OAuthApplicationResponse
+     */
+    authorizationGrantType: OAuthApplicationResponseAuthorizationGrantTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof OAuthApplicationResponse
+     */
+    readonly created: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof OAuthApplicationResponse
+     */
+    readonly updated: Date;
+}
+
+
+/**
+ * @export
+ */
+export const OAuthApplicationResponseClientTypeEnum = {
+    Confidential: 'confidential',
+    Public: 'public'
+} as const;
+export type OAuthApplicationResponseClientTypeEnum = typeof OAuthApplicationResponseClientTypeEnum[keyof typeof OAuthApplicationResponseClientTypeEnum];
+
+/**
+ * @export
+ */
+export const OAuthApplicationResponseAuthorizationGrantTypeEnum = {
+    AuthorizationCode: 'authorization-code',
+    Implicit: 'implicit',
+    Password: 'password',
+    ClientCredentials: 'client-credentials',
+    OpenidHybrid: 'openid-hybrid'
+} as const;
+export type OAuthApplicationResponseAuthorizationGrantTypeEnum = typeof OAuthApplicationResponseAuthorizationGrantTypeEnum[keyof typeof OAuthApplicationResponseAuthorizationGrantTypeEnum];
+
+
+/**
+ * Check if a given object implements the OAuthApplicationResponse interface.
+ */
+export function instanceOfOAuthApplicationResponse(value: any): value is OAuthApplicationResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if ((!('clientSecret' in value) && !('client_secret' in value)) || (value['clientSecret'] === undefined && value['client_secret'] === undefined)) return false;
+    if ((!('clientType' in value) && !('client_type' in value)) || (value['clientType'] === undefined && value['client_type'] === undefined)) return false;
+    if ((!('authorizationGrantType' in value) && !('authorization_grant_type' in value)) || (value['authorizationGrantType'] === undefined && value['authorization_grant_type'] === undefined)) return false;
+    if (!('created' in value) || value['created'] === undefined) return false;
+    if (!('updated' in value) || value['updated'] === undefined) return false;
+    return true;
+}
+
+export function OAuthApplicationResponseFromJSON(json: any): OAuthApplicationResponse {
+    return OAuthApplicationResponseFromJSONTyped(json, false);
+}
+
+export function OAuthApplicationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OAuthApplicationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'clientId': json['client_id'] == null ? undefined : json['client_id'],
+        'clientSecret': json['client_secret'],
+        'clientType': json['client_type'],
+        'authorizationGrantType': json['authorization_grant_type'],
+        'created': (new Date(json['created'])),
+        'updated': (new Date(json['updated'])),
+    };
+}
+
+export function OAuthApplicationResponseToJSON(json: any): OAuthApplicationResponse {
+    return OAuthApplicationResponseToJSONTyped(json, false);
+}
+
+export function OAuthApplicationResponseToJSONTyped(value?: Omit<OAuthApplicationResponse, 'id'|'client_secret'|'created'|'updated'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'client_id': value['clientId'],
+        'client_type': value['clientType'],
+        'authorization_grant_type': value['authorizationGrantType'],
+    };
+}
+