@digital8/security-registers-backend-ts-sdk 0.0.708 → 0.0.709

package/src/models/AddressResource.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/AddressResourceArrayResponse.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/AssetFileForUploadResource.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/AssetFileForUploadResourceArrayResponse.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/AssetLiteResource.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/AssetLiteResourceArrayResponse.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/AssetResource.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
  * 
@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -83,7 +83,6 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
     if (!('filePath' in value) || value['filePath'] === undefined) return false;
     if (!('fileName' in value) || value['fileName'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     if (!('isExternal' in value) || value['isExternal'] === undefined) return false;
@@ -104,7 +103,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
         'isExternal': json['isExternal'],

package/src/models/AssetResourceArrayResponse.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/AssetsFileStoreRequest.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * 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 AssetsFileStoreRequest
+ */
+export interface AssetsFileStoreRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetsFileStoreRequest
+     */
+    fileName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetsFileStoreRequest
+     */
+    fileType: string;
+}
+
+/**
+ * Check if a given object implements the AssetsFileStoreRequest interface.
+ */
+export function instanceOfAssetsFileStoreRequest(value: object): value is AssetsFileStoreRequest {
+    if (!('fileName' in value) || value['fileName'] === undefined) return false;
+    if (!('fileType' in value) || value['fileType'] === undefined) return false;
+    return true;
+}
+
+export function AssetsFileStoreRequestFromJSON(json: any): AssetsFileStoreRequest {
+    return AssetsFileStoreRequestFromJSONTyped(json, false);
+}
+
+export function AssetsFileStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetsFileStoreRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fileName': json['file_name'],
+        'fileType': json['file_type'],
+    };
+}
+
+export function AssetsFileStoreRequestToJSON(json: any): AssetsFileStoreRequest {
+    return AssetsFileStoreRequestToJSONTyped(json, false);
+}
+
+export function AssetsFileStoreRequestToJSONTyped(value?: AssetsFileStoreRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'file_name': value['fileName'],
+        'file_type': value['fileType'],
+    };
+}
+

package/src/models/AustralianState.ts

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const AustralianState = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type AustralianState = typeof AustralianState[keyof typeof AustralianState];
+
+
+export function instanceOfAustralianState(value: any): boolean {
+    for (const key in AustralianState) {
+        if (Object.prototype.hasOwnProperty.call(AustralianState, key)) {
+            if (AustralianState[key as keyof typeof AustralianState] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AustralianStateFromJSON(json: any): AustralianState {
+    return AustralianStateFromJSONTyped(json, false);
+}
+
+export function AustralianStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AustralianState {
+    return json as AustralianState;
+}
+
+export function AustralianStateToJSON(value?: AustralianState | null): any {
+    return value as any;
+}
+
+export function AustralianStateToJSONTyped(value: any, ignoreDiscriminator: boolean): AustralianState {
+    return value as AustralianState;
+}
+

package/src/models/AuthChangePasswordRequest.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/AuthForgotPasswordRequest.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * 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 AuthForgotPasswordRequest
+ */
+export interface AuthForgotPasswordRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthForgotPasswordRequest
+     */
+    email: string;
+}
+
+/**
+ * Check if a given object implements the AuthForgotPasswordRequest interface.
+ */
+export function instanceOfAuthForgotPasswordRequest(value: object): value is AuthForgotPasswordRequest {
+    if (!('email' in value) || value['email'] === undefined) return false;
+    return true;
+}
+
+export function AuthForgotPasswordRequestFromJSON(json: any): AuthForgotPasswordRequest {
+    return AuthForgotPasswordRequestFromJSONTyped(json, false);
+}
+
+export function AuthForgotPasswordRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthForgotPasswordRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'],
+    };
+}
+
+export function AuthForgotPasswordRequestToJSON(json: any): AuthForgotPasswordRequest {
+    return AuthForgotPasswordRequestToJSONTyped(json, false);
+}
+
+export function AuthForgotPasswordRequestToJSONTyped(value?: AuthForgotPasswordRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+    };
+}
+

package/src/models/AuthLoginWebRequest.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/AuthProfileUpdateRequest.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/AuthRegisterGuardFileRequest.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/AuthRegisterGuardRequest.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/AuthRegisterGuardRequestLicencesInner.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
  * 
@@ -27,6 +27,13 @@ import {
     BackAssetToJSON,
     BackAssetToJSONTyped,
 } from './BackAsset';
+import type { LicenceState } from './LicenceState';
+import {
+    LicenceStateFromJSON,
+    LicenceStateFromJSONTyped,
+    LicenceStateToJSON,
+    LicenceStateToJSONTyped,
+} from './LicenceState';
 import type { FrontAsset } from './FrontAsset';
 import {
     FrontAssetFromJSON,
@@ -50,10 +57,10 @@ import {
 export interface AuthRegisterGuardRequestLicencesInner {
     /**
      * 
-     * @type {string}
+     * @type {LicenceState}
      * @memberof AuthRegisterGuardRequestLicencesInner
      */
-    state: AuthRegisterGuardRequestLicencesInnerStateEnum;
+    state: LicenceState;
     /**
      * 
      * @type {string}
@@ -105,16 +112,6 @@ export interface AuthRegisterGuardRequestLicencesInner {
 }
 
 
-/**
- * @export
- */
-export const AuthRegisterGuardRequestLicencesInnerStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type AuthRegisterGuardRequestLicencesInnerStateEnum = typeof AuthRegisterGuardRequestLicencesInnerStateEnum[keyof typeof AuthRegisterGuardRequestLicencesInnerStateEnum];
-
 
 /**
  * Check if a given object implements the AuthRegisterGuardRequestLicencesInner interface.
@@ -139,7 +136,7 @@ export function AuthRegisterGuardRequestLicencesInnerFromJSONTyped(json: any, ig
     }
     return {
         
-        'state': json['state'],
+        'state': LicenceStateFromJSON(json['state']),
         'licenceNumber': json['licence_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
@@ -162,7 +159,7 @@ export function AuthRegisterGuardRequestLicencesInnerToJSONTyped(value?: AuthReg
 
     return {
         
-        'state': value['state'],
+        'state': LicenceStateToJSON(value['state']),
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],

package/src/models/AuthRegisterGuardRequestProfileSignature.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/{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'],