@digital8/security-registers-backend-ts-sdk 0.0.312 → 0.0.313

package/src/models/AuthProfileUpdateRequest.ts

@@ -49,6 +49,12 @@ export interface AuthProfileUpdateRequest {
      * @memberof AuthProfileUpdateRequest
      */
     signatureAssetId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AuthProfileUpdateRequest
+     */
+    profileImageAssetId?: number;
 }
 
 /**
@@ -73,6 +79,7 @@ export function AuthProfileUpdateRequestFromJSONTyped(json: any, ignoreDiscrimin
         'email': json['email'] == null ? undefined : json['email'],
         'mobile': json['mobile'] == null ? undefined : json['mobile'],
         'signatureAssetId': json['signature_asset_id'] == null ? undefined : json['signature_asset_id'],
+        'profileImageAssetId': json['profile_image_asset_id'] == null ? undefined : json['profile_image_asset_id'],
     };
 }
 
@@ -92,6 +99,7 @@ export function AuthProfileUpdateRequestToJSONTyped(value?: AuthProfileUpdateReq
         'email': value['email'],
         'mobile': value['mobile'],
         'signature_asset_id': value['signatureAssetId'],
+        'profile_image_asset_id': value['profileImageAssetId'],
     };
 }
 

package/src/models/AuthRegisterGuardRequestLicence.ts

@@ -73,11 +73,11 @@ export interface AuthRegisterGuardRequestLicence {
      */
     lastName: string;
     /**
-     * 
-     * @type {Date}
+     * ISO 8601 calendar date (Y-m-d) in the licence state's timezone. Time and timezone offset must be omitted.
+     * @type {string}
      * @memberof AuthRegisterGuardRequestLicence
      */
-    expiryDate: Date;
+    expiryDate: string;
     /**
      * 
      * @type {FrontAsset}
@@ -148,7 +148,7 @@ export function AuthRegisterGuardRequestLicenceFromJSONTyped(json: any, ignoreDi
         'licenceNumber': json['licence_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
-        'expiryDate': (new Date(json['expiry_date'])),
+        'expiryDate': json['expiry_date'],
         'frontAsset': FrontAssetFromJSON(json['front_asset']),
         'backAsset': json['back_asset'] == null ? undefined : BackAssetFromJSON(json['back_asset']),
         'rsaAsset': json['rsa_asset'] == null ? undefined : RsaAssetFromJSON(json['rsa_asset']),
@@ -171,7 +171,7 @@ export function AuthRegisterGuardRequestLicenceToJSONTyped(value?: AuthRegisterG
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
-        'expiry_date': ((value['expiryDate']).toISOString()),
+        'expiry_date': value['expiryDate'],
         'front_asset': FrontAssetToJSON(value['frontAsset']),
         'back_asset': BackAssetToJSON(value['backAsset']),
         'rsa_asset': RsaAssetToJSON(value['rsaAsset']),

package/src/models/CurrentRegisterResource.ts

@@ -13,14 +13,6 @@
  */
 
 import { mapValues } from '../runtime';
-import type { VenueLiteResource } from './VenueLiteResource';
-import {
-    VenueLiteResourceFromJSON,
-    VenueLiteResourceFromJSONTyped,
-    VenueLiteResourceToJSON,
-    VenueLiteResourceToJSONTyped,
-} from './VenueLiteResource';
-
 /**
  * 
  * @export
@@ -29,24 +21,43 @@ import {
 export interface CurrentRegisterResource {
     /**
      * 
-     * @type {VenueLiteResource}
+     * @type {number}
+     * @memberof CurrentRegisterResource
+     */
+    id?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CurrentRegisterResource
+     */
+    venueId?: number | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CurrentRegisterResource
+     */
+    startDateTime: Date;
+    /**
+     * 
+     * @type {number}
      * @memberof CurrentRegisterResource
      */
-    venue: VenueLiteResource | null;
+    latitude: number;
     /**
      * 
-     * @type {object}
+     * @type {number}
      * @memberof CurrentRegisterResource
      */
-    signOnDateTime: object;
+    longitude: number;
 }
 
 /**
  * Check if a given object implements the CurrentRegisterResource interface.
  */
 export function instanceOfCurrentRegisterResource(value: object): value is CurrentRegisterResource {
-    if (!('venue' in value) || value['venue'] === undefined) return false;
-    if (!('signOnDateTime' in value) || value['signOnDateTime'] === undefined) return false;
+    if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
+    if (!('latitude' in value) || value['latitude'] === undefined) return false;
+    if (!('longitude' in value) || value['longitude'] === undefined) return false;
     return true;
 }
 
@@ -60,8 +71,11 @@ export function CurrentRegisterResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'venue': VenueLiteResourceFromJSON(json['venue']),
-        'signOnDateTime': json['signOnDateTime'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'venueId': json['venueId'] == null ? undefined : json['venueId'],
+        'startDateTime': (new Date(json['startDateTime'])),
+        'latitude': json['latitude'],
+        'longitude': json['longitude'],
     };
 }
 
@@ -76,8 +90,11 @@ export function CurrentRegisterResourceToJSONTyped(value?: CurrentRegisterResour
 
     return {
         
-        'venue': VenueLiteResourceToJSON(value['venue']),
-        'signOnDateTime': value['signOnDateTime'],
+        'id': value['id'],
+        'venueId': value['venueId'],
+        'startDateTime': ((value['startDateTime']).toISOString()),
+        'latitude': value['latitude'],
+        'longitude': value['longitude'],
     };
 }
 

package/src/models/IncidentFieldSchemaResource.ts

@@ -27,10 +27,10 @@ export interface IncidentFieldSchemaResource {
     id?: number | null;
     /**
      * 
-     * @type {object}
+     * @type {string}
      * @memberof IncidentFieldSchemaResource
      */
-    state: object;
+    state: IncidentFieldSchemaResourceStateEnum;
     /**
      * 
      * @type {{ [key: string]: boolean; }}
@@ -51,6 +51,23 @@ export interface IncidentFieldSchemaResource {
     updatedAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const IncidentFieldSchemaResourceStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type IncidentFieldSchemaResourceStateEnum = typeof IncidentFieldSchemaResourceStateEnum[keyof typeof IncidentFieldSchemaResourceStateEnum];
+
+
 /**
  * Check if a given object implements the IncidentFieldSchemaResource interface.
  */

package/src/models/IncidentImageResource.ts

@@ -36,7 +36,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      * 
      * @type {number}
@@ -57,6 +57,7 @@ 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;
@@ -74,7 +75,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
         
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
+        'altText': json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/src/models/IncidentVideoResource.ts

@@ -30,7 +30,7 @@ export interface IncidentVideoResource {
      * @type {string}
      * @memberof IncidentVideoResource
      */
-    status: string;
+    status: IncidentVideoResourceStatusEnum;
     /**
      * 
      * @type {string}
@@ -69,6 +69,18 @@ export interface IncidentVideoResource {
     updatedAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const IncidentVideoResourceStatusEnum = {
+    Processing: 'processing',
+    Ready: 'ready',
+    Failed: 'failed'
+} as const;
+export type IncidentVideoResourceStatusEnum = typeof IncidentVideoResourceStatusEnum[keyof typeof IncidentVideoResourceStatusEnum];
+
+
 /**
  * Check if a given object implements the IncidentVideoResource interface.
  */

package/src/models/LicenceListResource.ts

@@ -41,10 +41,10 @@ export interface LicenceListResource {
     user: UserRelationResource | null;
     /**
      * 
-     * @type {object}
+     * @type {string}
      * @memberof LicenceListResource
      */
-    state: object;
+    state: LicenceListResourceStateEnum;
     /**
      * 
      * @type {string}
@@ -83,6 +83,23 @@ export interface LicenceListResource {
     createdAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const LicenceListResourceStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type LicenceListResourceStateEnum = typeof LicenceListResourceStateEnum[keyof typeof LicenceListResourceStateEnum];
+
+
 /**
  * Check if a given object implements the LicenceListResource interface.
  */

package/src/models/LicenceLiteResource.ts

@@ -33,12 +33,29 @@ export interface LicenceLiteResource {
     licenceNumber: string;
     /**
      * 
-     * @type {object}
+     * @type {string}
      * @memberof LicenceLiteResource
      */
-    state: object;
+    state: LicenceLiteResourceStateEnum;
 }
 
+
+/**
+ * @export
+ */
+export const LicenceLiteResourceStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type LicenceLiteResourceStateEnum = typeof LicenceLiteResourceStateEnum[keyof typeof LicenceLiteResourceStateEnum];
+
+
 /**
  * Check if a given object implements the LicenceLiteResource interface.
  */

package/src/models/LicenceResource.ts

@@ -41,10 +41,10 @@ export interface LicenceResource {
     user: UserRelationResource | null;
     /**
      * 
-     * @type {object}
+     * @type {string}
      * @memberof LicenceResource
      */
-    state: object;
+    state: LicenceResourceStateEnum;
     /**
      * 
      * @type {string}
@@ -113,6 +113,23 @@ export interface LicenceResource {
     updatedAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const LicenceResourceStateEnum = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type LicenceResourceStateEnum = typeof LicenceResourceStateEnum[keyof typeof LicenceResourceStateEnum];
+
+
 /**
  * Check if a given object implements the LicenceResource interface.
  */

package/src/models/LicencesStoreRequest.ts

@@ -65,11 +65,11 @@ export interface LicencesStoreRequest {
      */
     lastName: string;
     /**
-     * 
-     * @type {Date}
+     * ISO 8601 calendar date (Y-m-d) in the licence state's timezone. Time and timezone offset must be omitted.
+     * @type {string}
      * @memberof LicencesStoreRequest
      */
-    expiryDate: Date;
+    expiryDate: string;
     /**
      * 
      * @type {AuthRegisterGuardRequestProfileSignature}
@@ -142,7 +142,7 @@ export function LicencesStoreRequestFromJSONTyped(json: any, ignoreDiscriminator
         'licenceNumber': json['licence_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
-        'expiryDate': (new Date(json['expiry_date'])),
+        'expiryDate': json['expiry_date'],
         'frontAsset': AuthRegisterGuardRequestProfileSignatureFromJSON(json['front_asset']),
         'backAsset': json['back_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['back_asset']),
         'rsaAsset': json['rsa_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['rsa_asset']),
@@ -166,7 +166,7 @@ export function LicencesStoreRequestToJSONTyped(value?: LicencesStoreRequest | n
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
-        'expiry_date': ((value['expiryDate']).toISOString()),
+        'expiry_date': value['expiryDate'],
         'front_asset': AuthRegisterGuardRequestProfileSignatureToJSON(value['frontAsset']),
         'back_asset': LicencesStoreRequestBackAssetToJSON(value['backAsset']),
         'rsa_asset': LicencesStoreRequestBackAssetToJSON(value['rsaAsset']),

package/src/models/LicencesUpdateRequest.ts

@@ -52,11 +52,11 @@ export interface LicencesUpdateRequest {
      */
     lastName?: string;
     /**
-     * 
-     * @type {Date}
+     * ISO 8601 calendar date (Y-m-d) in the licence state's timezone. Time and timezone offset must be omitted.
+     * @type {string}
      * @memberof LicencesUpdateRequest
      */
-    expiryDate?: Date;
+    expiryDate?: string;
     /**
      * 
      * @type {LicencesStoreRequestBackAsset}
@@ -121,7 +121,7 @@ export function LicencesUpdateRequestFromJSONTyped(json: any, ignoreDiscriminato
         'licenceNumber': json['licence_number'] == null ? undefined : json['licence_number'],
         'firstName': json['first_name'] == null ? undefined : json['first_name'],
         'lastName': json['last_name'] == null ? undefined : json['last_name'],
-        'expiryDate': json['expiry_date'] == null ? undefined : (new Date(json['expiry_date'])),
+        'expiryDate': json['expiry_date'] == null ? undefined : json['expiry_date'],
         'frontAsset': json['front_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['front_asset']),
         'backAsset': json['back_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['back_asset']),
         'rsaAsset': json['rsa_asset'] == null ? undefined : LicencesStoreRequestBackAssetFromJSON(json['rsa_asset']),
@@ -144,7 +144,7 @@ export function LicencesUpdateRequestToJSONTyped(value?: LicencesUpdateRequest |
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
-        'expiry_date': value['expiryDate'] == null ? undefined : ((value['expiryDate']).toISOString()),
+        'expiry_date': value['expiryDate'],
         'front_asset': LicencesStoreRequestBackAssetToJSON(value['frontAsset']),
         'back_asset': LicencesStoreRequestBackAssetToJSON(value['backAsset']),
         'rsa_asset': LicencesStoreRequestBackAssetToJSON(value['rsaAsset']),

package/src/models/LicencesVerifyRequest.ts

@@ -44,7 +44,7 @@ export interface LicencesVerifyRequest {
      */
     lastName: string;
     /**
-     * 
+     * ISO 8601 local-with-offset, anchored to 00:00 in the licence state's timezone (e.g. 2026-05-13T00:00:00+11:00). The offset is required so verification against state systems uses the correct wall-clock day.
      * @type {string}
      * @memberof LicencesVerifyRequest
      */

package/src/models/MobileDeviceResource.ts

@@ -36,7 +36,7 @@ export interface MobileDeviceResource {
      * @type {string}
      * @memberof MobileDeviceResource
      */
-    platform: string;
+    platform: MobileDeviceResourcePlatformEnum;
     /**
      * 
      * @type {string}
@@ -87,6 +87,17 @@ export interface MobileDeviceResource {
     updatedAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const MobileDeviceResourcePlatformEnum = {
+    Ios: 'ios',
+    Android: 'android'
+} as const;
+export type MobileDeviceResourcePlatformEnum = typeof MobileDeviceResourcePlatformEnum[keyof typeof MobileDeviceResourcePlatformEnum];
+
+
 /**
  * Check if a given object implements the MobileDeviceResource interface.
  */

package/src/models/NotificationPreferenceResource.ts

@@ -38,7 +38,7 @@ export interface NotificationPreferenceResource {
      * @type {string}
      * @memberof NotificationPreferenceResource
      */
-    notificationType: string;
+    notificationType: NotificationPreferenceResourceNotificationTypeEnum;
     /**
      * 
      * @type {VenueLiteResource}
@@ -65,6 +65,20 @@ export interface NotificationPreferenceResource {
     updatedAt?: Date | null;
 }
 
+
+/**
+ * @export
+ */
+export const NotificationPreferenceResourceNotificationTypeEnum = {
+    IncidentAdded: 'incident_added',
+    NonSignOff: 'non_sign_off',
+    NonSignOn: 'non_sign_on',
+    SignOnRejected: 'sign_on_rejected',
+    LicenceUpdated: 'licence_updated'
+} as const;
+export type NotificationPreferenceResourceNotificationTypeEnum = typeof NotificationPreferenceResourceNotificationTypeEnum[keyof typeof NotificationPreferenceResourceNotificationTypeEnum];
+
+
 /**
  * Check if a given object implements the NotificationPreferenceResource interface.
  */

package/src/models/NotificationPreferencesStoreRequest.ts

@@ -45,7 +45,6 @@ export interface NotificationPreferencesStoreRequest {
  */
 export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
     IncidentAdded: 'incident_added',
-    IncidentPendingReminder: 'incident_pending_reminder',
     NonSignOff: 'non_sign_off',
     NonSignOn: 'non_sign_on',
     SignOnRejected: 'sign_on_rejected',

package/src/models/PdfExportQueuedResource.ts

@@ -30,7 +30,7 @@ export interface PdfExportQueuedResource {
      * @type {string}
      * @memberof PdfExportQueuedResource
      */
-    status: string;
+    status: PdfExportQueuedResourceStatusEnum;
     /**
      * 
      * @type {string}
@@ -39,6 +39,19 @@ export interface PdfExportQueuedResource {
     message: string;
 }
 
+
+/**
+ * @export
+ */
+export const PdfExportQueuedResourceStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed'
+} as const;
+export type PdfExportQueuedResourceStatusEnum = typeof PdfExportQueuedResourceStatusEnum[keyof typeof PdfExportQueuedResourceStatusEnum];
+
+
 /**
  * Check if a given object implements the PdfExportQueuedResource interface.
  */

package/src/models/PdfExportResource.ts

@@ -30,7 +30,7 @@ export interface PdfExportResource {
      * @type {string}
      * @memberof PdfExportResource
      */
-    status: string;
+    status: PdfExportResourceStatusEnum;
     /**
      * 
      * @type {string}
@@ -45,6 +45,19 @@ export interface PdfExportResource {
     downloadUrl: string;
 }
 
+
+/**
+ * @export
+ */
+export const PdfExportResourceStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed'
+} as const;
+export type PdfExportResourceStatusEnum = typeof PdfExportResourceStatusEnum[keyof typeof PdfExportResourceStatusEnum];
+
+
 /**
  * Check if a given object implements the PdfExportResource interface.
  */

package/src/models/RegisterListResource.ts

@@ -75,7 +75,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffStatus: number;
+    signOffStatus: RegisterListResourceSignOffStatusEnum;
     /**
      * 
      * @type {string}
@@ -165,7 +165,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLong: number;
+    signOffLong?: number | null;
     /**
      * 
      * @type {boolean}
@@ -174,6 +174,18 @@ export interface RegisterListResource {
     hasIncidents: boolean;
 }
 
+
+/**
+ * @export
+ */
+export const RegisterListResourceSignOffStatusEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+} as const;
+export type RegisterListResourceSignOffStatusEnum = typeof RegisterListResourceSignOffStatusEnum[keyof typeof RegisterListResourceSignOffStatusEnum];
+
+
 /**
  * Check if a given object implements the RegisterListResource interface.
  */
@@ -196,7 +208,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
     if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
     if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
     if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
-    if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
     if (!('hasIncidents' in value) || value['hasIncidents'] === undefined) return false;
     return true;
 }
@@ -232,7 +243,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
-        'signOffLong': json['signOffLong'],
+        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'hasIncidents': json['hasIncidents'],
     };
 }