@digital8/security-registers-backend-ts-sdk 0.0.338 → 0.0.340

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/RegisterListResource.ts

@@ -75,13 +75,19 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffStatus: RegisterListResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
      * @type {string}
      * @memberof RegisterListResource
      */
     badgeNumber?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RegisterListResource
+     */
+    rampReadAt: Date;
     /**
      * 
      * @type {string}
@@ -165,7 +171,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLong: number;
+    signOffLong?: number | null;
     /**
      * 
      * @type {boolean}
@@ -174,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.
  */
@@ -196,6 +190,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
     if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === 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;
     if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
@@ -209,7 +204,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
     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 (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
     if (!('hasIncidents' in value) || value['hasIncidents'] === undefined) return false;
     return true;
 }
@@ -232,6 +226,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'shiftLength': json['shiftLength'],
         'signOffStatus': json['signOffStatus'],
         'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
+        'rampReadAt': (new Date(json['rampReadAt'])),
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
@@ -245,7 +240,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'],
-        'signOffLong': json['signOffLong'],
+        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'hasIncidents': json['hasIncidents'],
     };
 }
@@ -269,6 +264,7 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
         'shiftLength': value['shiftLength'],
         'signOffStatus': value['signOffStatus'],
         'badgeNumber': value['badgeNumber'],
+        'rampReadAt': ((value['rampReadAt']).toISOString()),
         'licenceNumber': value['licenceNumber'],
         'licenceFirstName': value['licenceFirstName'],
         'licenceLastName': value['licenceLastName'],

package/src/models/RegisterResource.ts

@@ -63,13 +63,13 @@ export interface RegisterResource {
      * @type {Date}
      * @memberof RegisterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffStatus: RegisterResourceSignOffStatusEnum;
+    signOffStatus: number;
     /**
      * 
      * @type {object}
@@ -123,13 +123,13 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLat: number;
+    signOffLat?: number | null;
     /**
      * 
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLong?: number | null;
+    signOffLong: number;
     /**
      * 
      * @type {string}
@@ -159,7 +159,13 @@ export interface RegisterResource {
      * @type {string}
      * @memberof RegisterResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RegisterResource
+     */
+    rampReadAt: Date;
     /**
      * 
      * @type {Date}
@@ -174,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.
  */
@@ -193,7 +187,6 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
     if (!('venue' in value) || value['venue'] === undefined) return false;
     if (!('user' in value) || value['user'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
     if (!('signOnSignature' in value) || value['signOnSignature'] === undefined) return false;
     if (!('signOffSignature' in value) || value['signOffSignature'] === undefined) return false;
@@ -203,12 +196,12 @@ 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 (!('signOffLong' in value) || value['signOffLong'] === 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;
 }
 
@@ -226,7 +219,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'user': UserLiteResourceFromJSON(json['user']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'signOffStatus': json['signOffStatus'],
         'signOnSignature': json['signOnSignature'],
         'signOffSignature': json['signOffSignature'],
@@ -236,13 +229,14 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'firstAidImage': json['firstAidImage'],
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
-        'signOffLat': json['signOffLat'],
-        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
+        'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
+        'signOffLong': 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'])),
     };
@@ -263,7 +257,7 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
         'venue': VenueLiteResourceToJSON(value['venue']),
         'user': UserLiteResourceToJSON(value['user']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'signOffStatus': value['signOffStatus'],
         'signOnSignature': value['signOnSignature'],
         'signOffSignature': value['signOffSignature'],
@@ -280,6 +274,7 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
         'licenceFirstName': value['licenceFirstName'],
         'licenceLastName': value['licenceLastName'],
         'badgeNumber': value['badgeNumber'],
+        'rampReadAt': ((value['rampReadAt']).toISOString()),
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
         'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),
     };

package/src/models/RegistersCreateRequest.ts

@@ -85,6 +85,12 @@ export interface RegistersCreateRequest {
      * @memberof RegistersCreateRequest
      */
     badgeNumber?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RegistersCreateRequest
+     */
+    rampRead?: boolean;
     /**
      * 
      * @type {boolean}
@@ -127,6 +133,7 @@ export function RegistersCreateRequestFromJSONTyped(json: any, ignoreDiscriminat
         'signOffLat': json['sign_off_lat'] == null ? undefined : json['sign_off_lat'],
         'signOffLong': json['sign_off_long'] == null ? undefined : json['sign_off_long'],
         'badgeNumber': json['badge_number'] == null ? undefined : json['badge_number'],
+        'rampRead': json['ramp_read'] == null ? undefined : json['ramp_read'],
         'bypassActiveRegisterCheck': json['bypass_active_register_check'] == null ? undefined : json['bypass_active_register_check'],
     };
 }
@@ -153,6 +160,7 @@ export function RegistersCreateRequestToJSONTyped(value?: RegistersCreateRequest
         'sign_off_lat': value['signOffLat'],
         'sign_off_long': value['signOffLong'],
         'badge_number': value['badgeNumber'],
+        'ramp_read': value['rampRead'],
         'bypass_active_register_check': value['bypassActiveRegisterCheck'],
     };
 }

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}
@@ -61,6 +61,12 @@ export interface RegistersSignOnRequest {
      * @memberof RegistersSignOnRequest
      */
     badgeNumber?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RegistersSignOnRequest
+     */
+    rampRead?: boolean;
 }
 
 /**
@@ -86,12 +92,13 @@ 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'],
         'signOnCode': json['sign_on_code'] == null ? undefined : json['sign_on_code'],
         'badgeNumber': json['badge_number'] == null ? undefined : json['badge_number'],
+        'rampRead': json['ramp_read'] == null ? undefined : json['ramp_read'],
     };
 }
 
@@ -107,12 +114,13 @@ 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'],
         'sign_on_code': value['signOnCode'],
         'badge_number': value['badgeNumber'],
+        'ramp_read': value['rampRead'],
     };
 }