@digital8/security-registers-backend-ts-sdk 0.0.781 → 0.0.783

package/src/models/{ResetPasswordAuthRequest.ts → AuthResetPasswordRequest.ts}

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 
@@ -16,44 +16,44 @@ import { mapValues } from '../runtime';
 /**
  * 
  * @export
- * @interface ResetPasswordAuthRequest
+ * @interface AuthResetPasswordRequest
  */
-export interface ResetPasswordAuthRequest {
+export interface AuthResetPasswordRequest {
     /**
      * 
      * @type {string}
-     * @memberof ResetPasswordAuthRequest
+     * @memberof AuthResetPasswordRequest
      */
     email: string;
     /**
      * 
      * @type {string}
-     * @memberof ResetPasswordAuthRequest
+     * @memberof AuthResetPasswordRequest
      */
     password: string;
     /**
      * 
      * @type {string}
-     * @memberof ResetPasswordAuthRequest
+     * @memberof AuthResetPasswordRequest
      */
     token: string;
 }
 
 /**
- * Check if a given object implements the ResetPasswordAuthRequest interface.
+ * Check if a given object implements the AuthResetPasswordRequest interface.
  */
-export function instanceOfResetPasswordAuthRequest(value: object): value is ResetPasswordAuthRequest {
+export function instanceOfAuthResetPasswordRequest(value: object): value is AuthResetPasswordRequest {
     if (!('email' in value) || value['email'] === undefined) return false;
     if (!('password' in value) || value['password'] === undefined) return false;
     if (!('token' in value) || value['token'] === undefined) return false;
     return true;
 }
 
-export function ResetPasswordAuthRequestFromJSON(json: any): ResetPasswordAuthRequest {
-    return ResetPasswordAuthRequestFromJSONTyped(json, false);
+export function AuthResetPasswordRequestFromJSON(json: any): AuthResetPasswordRequest {
+    return AuthResetPasswordRequestFromJSONTyped(json, false);
 }
 
-export function ResetPasswordAuthRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResetPasswordAuthRequest {
+export function AuthResetPasswordRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthResetPasswordRequest {
     if (json == null) {
         return json;
     }
@@ -65,11 +65,11 @@ export function ResetPasswordAuthRequestFromJSONTyped(json: any, ignoreDiscrimin
     };
 }
 
-export function ResetPasswordAuthRequestToJSON(json: any): ResetPasswordAuthRequest {
-    return ResetPasswordAuthRequestToJSONTyped(json, false);
+export function AuthResetPasswordRequestToJSON(json: any): AuthResetPasswordRequest {
+    return AuthResetPasswordRequestToJSONTyped(json, false);
 }
 
-export function ResetPasswordAuthRequestToJSONTyped(value?: ResetPasswordAuthRequest | null, ignoreDiscriminator: boolean = false): any {
+export function AuthResetPasswordRequestToJSONTyped(value?: AuthResetPasswordRequest | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/src/models/BackAsset.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/CurrentRegisterResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/CurrentRegisterResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/DevicesRegisterRequest.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 
@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { MobileDevicePlatform } from './MobileDevicePlatform';
+import {
+    MobileDevicePlatformFromJSON,
+    MobileDevicePlatformFromJSONTyped,
+    MobileDevicePlatformToJSON,
+    MobileDevicePlatformToJSONTyped,
+} from './MobileDevicePlatform';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface DevicesRegisterRequest {
     deviceId: string;
     /**
      * 
-     * @type {string}
+     * @type {MobileDevicePlatform}
      * @memberof DevicesRegisterRequest
      */
-    platform: DevicesRegisterRequestPlatformEnum;
+    platform: MobileDevicePlatform;
     /**
      * 
      * @type {string}
@@ -64,15 +72,6 @@ export interface DevicesRegisterRequest {
 }
 
 
-/**
- * @export
- */
-export const DevicesRegisterRequestPlatformEnum = {
-    Ios: 'ios',
-    Android: 'android'
-} as const;
-export type DevicesRegisterRequestPlatformEnum = typeof DevicesRegisterRequestPlatformEnum[keyof typeof DevicesRegisterRequestPlatformEnum];
-
 
 /**
  * Check if a given object implements the DevicesRegisterRequest interface.
@@ -94,7 +93,7 @@ export function DevicesRegisterRequestFromJSONTyped(json: any, ignoreDiscriminat
     return {
         
         'deviceId': json['device_id'],
-        'platform': json['platform'],
+        'platform': MobileDevicePlatformFromJSON(json['platform']),
         'osVersion': json['os_version'] == null ? undefined : json['os_version'],
         'appVersion': json['app_version'] == null ? undefined : json['app_version'],
         'model': json['model'] == null ? undefined : json['model'],
@@ -115,7 +114,7 @@ export function DevicesRegisterRequestToJSONTyped(value?: DevicesRegisterRequest
     return {
         
         'device_id': value['deviceId'],
-        'platform': value['platform'],
+        'platform': MobileDevicePlatformToJSON(value['platform']),
         'os_version': value['osVersion'],
         'app_version': value['appVersion'],
         'model': value['model'],

package/src/models/ExportQueuedResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 
@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PdfExportStatus } from './PdfExportStatus';
+import {
+    PdfExportStatusFromJSON,
+    PdfExportStatusFromJSONTyped,
+    PdfExportStatusToJSON,
+    PdfExportStatusToJSONTyped,
+} from './PdfExportStatus';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface ExportQueuedResource {
     id: number;
     /**
      * 
-     * @type {string}
+     * @type {PdfExportStatus}
      * @memberof ExportQueuedResource
      */
-    status: ExportQueuedResourceStatusEnum;
+    status: PdfExportStatus;
     /**
      * 
      * @type {string}
@@ -40,17 +48,6 @@ export interface ExportQueuedResource {
 }
 
 
-/**
- * @export
- */
-export const ExportQueuedResourceStatusEnum = {
-    Pending: 'pending',
-    Processing: 'processing',
-    Completed: 'completed',
-    Failed: 'failed'
-} as const;
-export type ExportQueuedResourceStatusEnum = typeof ExportQueuedResourceStatusEnum[keyof typeof ExportQueuedResourceStatusEnum];
-
 
 /**
  * Check if a given object implements the ExportQueuedResource interface.
@@ -73,7 +70,7 @@ export function ExportQueuedResourceFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'id': json['id'],
-        'status': json['status'],
+        'status': PdfExportStatusFromJSON(json['status']),
         'message': json['message'],
     };
 }
@@ -90,7 +87,7 @@ export function ExportQueuedResourceToJSONTyped(value?: ExportQueuedResource | n
     return {
         
         'id': value['id'],
-        'status': value['status'],
+        'status': PdfExportStatusToJSON(value['status']),
         'message': value['message'],
     };
 }

package/src/models/ExportQueuedResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/FirstAidAsset.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/FrontAsset.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/GenericResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldAuditResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldAuditResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldItemLiteResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldItemLiteResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldSchemaResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 
@@ -13,6 +13,21 @@
  */
 
 import { mapValues } from '../runtime';
+import type { IncidentSchemaType } from './IncidentSchemaType';
+import {
+    IncidentSchemaTypeFromJSON,
+    IncidentSchemaTypeFromJSONTyped,
+    IncidentSchemaTypeToJSON,
+    IncidentSchemaTypeToJSONTyped,
+} from './IncidentSchemaType';
+import type { LicenceState } from './LicenceState';
+import {
+    LicenceStateFromJSON,
+    LicenceStateFromJSONTyped,
+    LicenceStateToJSON,
+    LicenceStateToJSONTyped,
+} from './LicenceState';
+
 /**
  * 
  * @export
@@ -27,16 +42,16 @@ export interface IncidentFieldSchemaResource {
     id?: number | null;
     /**
      * 
-     * @type {string}
+     * @type {LicenceState}
      * @memberof IncidentFieldSchemaResource
      */
-    state: IncidentFieldSchemaResourceStateEnum;
+    state: LicenceState;
     /**
      * 
-     * @type {string}
+     * @type {IncidentSchemaType}
      * @memberof IncidentFieldSchemaResource
      */
-    type: IncidentFieldSchemaResourceTypeEnum;
+    type: IncidentSchemaType;
     /**
      * 
      * @type {object}
@@ -58,25 +73,6 @@ export interface IncidentFieldSchemaResource {
 }
 
 
-/**
- * @export
- */
-export const IncidentFieldSchemaResourceStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type IncidentFieldSchemaResourceStateEnum = typeof IncidentFieldSchemaResourceStateEnum[keyof typeof IncidentFieldSchemaResourceStateEnum];
-
-/**
- * @export
- */
-export const IncidentFieldSchemaResourceTypeEnum = {
-    Liquor: 'Liquor',
-    Gaming: 'Gaming'
-} as const;
-export type IncidentFieldSchemaResourceTypeEnum = typeof IncidentFieldSchemaResourceTypeEnum[keyof typeof IncidentFieldSchemaResourceTypeEnum];
-
 
 /**
  * Check if a given object implements the IncidentFieldSchemaResource interface.
@@ -99,8 +95,8 @@ export function IncidentFieldSchemaResourceFromJSONTyped(json: any, ignoreDiscri
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'state': json['state'],
-        'type': json['type'],
+        'state': LicenceStateFromJSON(json['state']),
+        'type': IncidentSchemaTypeFromJSON(json['type']),
         'jsonSchema': json['jsonSchema'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
@@ -119,8 +115,8 @@ export function IncidentFieldSchemaResourceToJSONTyped(value?: IncidentFieldSche
     return {
         
         'id': value['id'],
-        'state': value['state'],
-        'type': value['type'],
+        'state': LicenceStateToJSON(value['state']),
+        'type': IncidentSchemaTypeToJSON(value['type']),
         'jsonSchema': value['jsonSchema'],
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
         'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),

package/src/models/IncidentFieldSchemaResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldSchemasShowRequest.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentFieldsResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentImageResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 
@@ -36,7 +36,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -57,7 +57,6 @@ export interface IncidentImageResource {
 export function instanceOfIncidentImageResource(value: object): value is IncidentImageResource {
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('assetId' in value) || value['assetId'] === undefined) return false;
     if (!('url' in value) || value['url'] === undefined) return false;
     return true;
@@ -75,7 +74,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
         
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'],
+        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/src/models/IncidentImageResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentListResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentListResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentLiteResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentLiteResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentLiteResourceStaff.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentResource.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  * 

package/src/models/IncidentResourceArrayResponse.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * My API
- * API documentation for my Laravel app
+ * Security Registers API
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
  *
  * The version of the OpenAPI document: 1.0.0
  *