@digital8/security-registers-backend-ts-sdk 0.0.373 → 0.0.374

package/src/models/NearbyVenueResource.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * 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 NearbyVenueResource
+ */
+export interface NearbyVenueResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof NearbyVenueResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof NearbyVenueResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NearbyVenueResource
+     */
+    venueCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NearbyVenueResource
+     */
+    timezone: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NearbyVenueResource
+     */
+    rampReadingRequired: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NearbyVenueResource
+     */
+    hasReadRamp?: boolean | null;
+}
+
+/**
+ * Check if a given object implements the NearbyVenueResource interface.
+ */
+export function instanceOfNearbyVenueResource(value: object): value is NearbyVenueResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('venueCode' in value) || value['venueCode'] === undefined) return false;
+    if (!('timezone' in value) || value['timezone'] === undefined) return false;
+    if (!('rampReadingRequired' in value) || value['rampReadingRequired'] === undefined) return false;
+    return true;
+}
+
+export function NearbyVenueResourceFromJSON(json: any): NearbyVenueResource {
+    return NearbyVenueResourceFromJSONTyped(json, false);
+}
+
+export function NearbyVenueResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NearbyVenueResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'venueCode': json['venueCode'],
+        'timezone': json['timezone'],
+        'rampReadingRequired': json['rampReadingRequired'],
+        'hasReadRamp': json['hasReadRamp'] == null ? undefined : json['hasReadRamp'],
+    };
+}
+
+export function NearbyVenueResourceToJSON(json: any): NearbyVenueResource {
+    return NearbyVenueResourceToJSONTyped(json, false);
+}
+
+export function NearbyVenueResourceToJSONTyped(value?: NearbyVenueResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'venueCode': value['venueCode'],
+        'timezone': value['timezone'],
+        'rampReadingRequired': value['rampReadingRequired'],
+        'hasReadRamp': value['hasReadRamp'],
+    };
+}
+

package/src/models/NearbyVenueResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * 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';
+import type { NearbyVenueResource } from './NearbyVenueResource';
+import {
+    NearbyVenueResourceFromJSON,
+    NearbyVenueResourceFromJSONTyped,
+    NearbyVenueResourceToJSON,
+    NearbyVenueResourceToJSONTyped,
+} from './NearbyVenueResource';
+
+/**
+ * 
+ * @export
+ * @interface NearbyVenueResourceArrayResponse
+ */
+export interface NearbyVenueResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<NearbyVenueResource>}
+     * @memberof NearbyVenueResourceArrayResponse
+     */
+    data?: Array<NearbyVenueResource>;
+}
+
+/**
+ * Check if a given object implements the NearbyVenueResourceArrayResponse interface.
+ */
+export function instanceOfNearbyVenueResourceArrayResponse(value: object): value is NearbyVenueResourceArrayResponse {
+    return true;
+}
+
+export function NearbyVenueResourceArrayResponseFromJSON(json: any): NearbyVenueResourceArrayResponse {
+    return NearbyVenueResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function NearbyVenueResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NearbyVenueResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NearbyVenueResourceFromJSON)),
+    };
+}
+
+export function NearbyVenueResourceArrayResponseToJSON(json: any): NearbyVenueResourceArrayResponse {
+    return NearbyVenueResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function NearbyVenueResourceArrayResponseToJSONTyped(value?: NearbyVenueResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NearbyVenueResourceToJSON)),
+    };
+}
+

package/src/models/NotificationPreferenceResource.ts

@@ -38,7 +38,7 @@ export interface NotificationPreferenceResource {
      * @type {string}
      * @memberof NotificationPreferenceResource
      */
-    notificationType: NotificationPreferenceResourceNotificationTypeEnum;
+    notificationType: string;
     /**
      * 
      * @type {VenueLiteResource}
@@ -65,20 +65,6 @@ 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/PdfExportQueuedResource.ts

@@ -30,7 +30,7 @@ export interface PdfExportQueuedResource {
      * @type {string}
      * @memberof PdfExportQueuedResource
      */
-    status: PdfExportQueuedResourceStatusEnum;
+    status: string;
     /**
      * 
      * @type {string}
@@ -39,19 +39,6 @@ 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: PdfExportResourceStatusEnum;
+    status: string;
     /**
      * 
      * @type {string}
@@ -45,19 +45,6 @@ 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/RegisterGroupedByRosterResource.ts

@@ -69,7 +69,7 @@ export interface RegisterGroupedByRosterResource {
      * @type {Date}
      * @memberof RegisterGroupedByRosterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {Array<RegisterListResource>}
@@ -86,7 +86,6 @@ export function instanceOfRegisterGroupedByRosterResource(value: object): value
     if (!('timezone' in value) || value['timezone'] === undefined) return false;
     if (!('state' in value) || value['state'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('registers' in value) || value['registers'] === undefined) return false;
     return true;
 }
@@ -106,7 +105,7 @@ export function RegisterGroupedByRosterResourceFromJSONTyped(json: any, ignoreDi
         'timezone': json['timezone'],
         'state': json['state'],
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
     };
 }
@@ -127,7 +126,7 @@ export function RegisterGroupedByRosterResourceToJSONTyped(value?: RegisterGroup
         'timezone': value['timezone'],
         'state': value['state'],
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
     };
 }

package/src/models/RegisterListResource.ts

@@ -75,13 +75,13 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffStatus: RegisterListResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
      * @type {string}
      * @memberof RegisterListResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      * 
      * @type {Date}
@@ -180,18 +180,6 @@ 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.
  */
@@ -201,7 +189,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
     if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
-    if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
     if (!('rampReadAt' in value) || value['rampReadAt'] === undefined) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
     if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -236,7 +223,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'shiftLength': json['shiftLength'],
         'signOffStatus': json['signOffStatus'],
-        'badgeNumber': json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'rampReadAt': (new Date(json['rampReadAt'])),
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],

package/src/models/RegisterResource.ts

@@ -69,7 +69,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffStatus: RegisterResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
      * @type {object}
@@ -123,7 +123,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLat?: number | null;
+    signOffLat: number;
     /**
      * 
      * @type {number}
@@ -159,7 +159,7 @@ export interface RegisterResource {
      * @type {string}
      * @memberof RegisterResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      * 
      * @type {Date}
@@ -180,18 +180,6 @@ export interface RegisterResource {
     updatedAt?: Date | null;
 }
 
-
-/**
- * @export
- */
-export const RegisterResourceSignOffStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
-} as const;
-export type RegisterResourceSignOffStatusEnum = typeof RegisterResourceSignOffStatusEnum[keyof typeof RegisterResourceSignOffStatusEnum];
-
-
 /**
  * Check if a given object implements the RegisterResource interface.
  */
@@ -209,11 +197,11 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
     if (!('firstAidImage' in value) || value['firstAidImage'] === undefined) return false;
     if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
     if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
+    if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
     if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
     if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
     if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
-    if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
     if (!('rampReadAt' in value) || value['rampReadAt'] === undefined) return false;
     return true;
 }
@@ -242,13 +230,13 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'firstAidImage': json['firstAidImage'],
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
-        'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
+        'signOffLat': json['signOffLat'],
         'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'licenceNumber': json['licenceNumber'],
         'licenceExpiry': json['licenceExpiry'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
-        'badgeNumber': json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'rampReadAt': (new Date(json['rampReadAt'])),
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),

package/src/models/RegistersSignOffRequest.ts

@@ -26,11 +26,11 @@ export interface RegistersSignOffRequest {
      */
     registerId: number;
     /**
-     * ISO 8601 local-with-offset in the venue timezone (e.g. 2026-05-13T18:30:00+11:00). A literal Z / UTC suffix is not accepted — the offset is required to anchor the value to the venue's wall-clock time.
-     * @type {string}
+     * 
+     * @type {Date}
      * @memberof RegistersSignOffRequest
      */
-    finishDateTime: string;
+    finishDateTime: Date;
     /**
      * 
      * @type {number}
@@ -74,7 +74,7 @@ export function RegistersSignOffRequestFromJSONTyped(json: any, ignoreDiscrimina
     return {
         
         'registerId': json['register_id'],
-        'finishDateTime': json['finish_date_time'],
+        'finishDateTime': (new Date(json['finish_date_time'])),
         'latitude': json['latitude'],
         'longitude': json['longitude'],
         'signatureAssetId': json['signature_asset_id'],
@@ -93,7 +93,7 @@ export function RegistersSignOffRequestToJSONTyped(value?: RegistersSignOffReque
     return {
         
         'register_id': value['registerId'],
-        'finish_date_time': value['finishDateTime'],
+        'finish_date_time': ((value['finishDateTime']).toISOString()),
         'latitude': value['latitude'],
         'longitude': value['longitude'],
         'signature_asset_id': value['signatureAssetId'],

package/src/models/RegistersSignOnRequest.ts

@@ -26,11 +26,11 @@ export interface RegistersSignOnRequest {
      */
     venueId: number;
     /**
-     * ISO 8601 local-with-offset in the venue timezone (e.g. 2026-05-13T10:30:00+11:00). A literal Z / UTC suffix is not accepted — the offset is required to anchor the value to the venue's wall-clock time.
-     * @type {string}
+     * 
+     * @type {Date}
      * @memberof RegistersSignOnRequest
      */
-    startDateTime: string;
+    startDateTime: Date;
     /**
      * 
      * @type {number}
@@ -92,7 +92,7 @@ export function RegistersSignOnRequestFromJSONTyped(json: any, ignoreDiscriminat
     return {
         
         'venueId': json['venue_id'],
-        'startDateTime': json['start_date_time'],
+        'startDateTime': (new Date(json['start_date_time'])),
         'latitude': json['latitude'],
         'longitude': json['longitude'],
         'signatureAssetId': json['signature_asset_id'],
@@ -114,7 +114,7 @@ export function RegistersSignOnRequestToJSONTyped(value?: RegistersSignOnRequest
     return {
         
         'venue_id': value['venueId'],
-        'start_date_time': value['startDateTime'],
+        'start_date_time': ((value['startDateTime']).toISOString()),
         'latitude': value['latitude'],
         'longitude': value['longitude'],
         'signature_asset_id': value['signatureAssetId'],

package/src/models/RosterListResource.ts

@@ -81,33 +81,15 @@ export interface RosterListResource {
      * @type {number}
      * @memberof RosterListResource
      */
-    signOffStatus: RosterListResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
-     * @type {number}
-     * @memberof RosterListResource
-     */
-    registerCount: number;
-    /**
-     * 
-     * @type {number}
+     * @type {object}
      * @memberof RosterListResource
      */
-    incidentCount: number;
+    registerCount: object;
 }
 
-
-/**
- * @export
- */
-export const RosterListResourceSignOffStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
-} as const;
-export type RosterListResourceSignOffStatusEnum = typeof RosterListResourceSignOffStatusEnum[keyof typeof RosterListResourceSignOffStatusEnum];
-
-
 /**
  * Check if a given object implements the RosterListResource interface.
  */
@@ -120,7 +102,6 @@ export function instanceOfRosterListResource(value: object): value is RosterList
     if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
     if (!('registerCount' in value) || value['registerCount'] === undefined) return false;
-    if (!('incidentCount' in value) || value['incidentCount'] === undefined) return false;
     return true;
 }
 
@@ -143,7 +124,6 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'isComplete': json['isComplete'],
         'signOffStatus': json['signOffStatus'],
         'registerCount': json['registerCount'],
-        'incidentCount': json['incidentCount'],
     };
 }
 
@@ -167,7 +147,6 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
         'isComplete': value['isComplete'],
         'signOffStatus': value['signOffStatus'],
         'registerCount': value['registerCount'],
-        'incidentCount': value['incidentCount'],
     };
 }
 

package/src/models/RosterResource.ts

@@ -70,7 +70,7 @@ export interface RosterResource {
      * @type {Date}
      * @memberof RosterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {boolean}
@@ -88,7 +88,7 @@ export interface RosterResource {
      * @type {number}
      * @memberof RosterResource
      */
-    signOffStatus: RosterResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
      * @type {Array<RegisterResource>}
@@ -97,18 +97,6 @@ export interface RosterResource {
     registers: Array<RegisterResource> | null;
 }
 
-
-/**
- * @export
- */
-export const RosterResourceSignOffStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
-} as const;
-export type RosterResourceSignOffStatusEnum = typeof RosterResourceSignOffStatusEnum[keyof typeof RosterResourceSignOffStatusEnum];
-
-
 /**
  * Check if a given object implements the RosterResource interface.
  */
@@ -116,7 +104,6 @@ export function instanceOfRosterResource(value: object): value is RosterResource
     if (!('venue' in value) || value['venue'] === undefined) return false;
     if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
     if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -138,7 +125,7 @@ export function RosterResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
         'signOffStatus': json['signOffStatus'],
@@ -161,7 +148,7 @@ export function RosterResourceToJSONTyped(value?: RosterResource | null, ignoreD
         'venue': VenueLiteResourceToJSON(value['venue']),
         'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
         'signOffStatus': value['signOffStatus'],