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

package/src/models/RegistersUpdateRequest.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
  * 
@@ -20,6 +20,13 @@ import {
     LicencesStoreRequestBackAssetToJSON,
     LicencesStoreRequestBackAssetToJSONTyped,
 } from './LicencesStoreRequestBackAsset';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -53,10 +60,10 @@ export interface RegistersUpdateRequest {
     finishDateTime?: Date;
     /**
      * 
-     * @type {string}
+     * @type {SignOffStatus}
      * @memberof RegistersUpdateRequest
      */
-    signOffStatus?: RegistersUpdateRequestSignOffStatusEnum;
+    signOffStatus?: SignOffStatus;
     /**
      * 
      * @type {string}
@@ -108,16 +115,6 @@ export interface RegistersUpdateRequest {
 }
 
 
-/**
- * @export
- */
-export const RegistersUpdateRequestSignOffStatusEnum = {
-    _0: '0',
-    _1: '1',
-    _2: '2'
-} as const;
-export type RegistersUpdateRequestSignOffStatusEnum = typeof RegistersUpdateRequestSignOffStatusEnum[keyof typeof RegistersUpdateRequestSignOffStatusEnum];
-
 
 /**
  * Check if a given object implements the RegistersUpdateRequest interface.
@@ -140,7 +137,7 @@ export function RegistersUpdateRequestFromJSONTyped(json: any, ignoreDiscriminat
         'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
         'startDateTime': json['start_date_time'] == null ? undefined : (new Date(json['start_date_time'])),
         'finishDateTime': json['finish_date_time'] == null ? undefined : (new Date(json['finish_date_time'])),
-        'signOffStatus': json['sign_off_status'] == null ? undefined : json['sign_off_status'],
+        'signOffStatus': json['sign_off_status'] == null ? undefined : SignOffStatusFromJSON(json['sign_off_status']),
         'badgeNumber': json['badge_number'] == null ? undefined : json['badge_number'],
         'signOnLat': json['sign_on_lat'] == null ? undefined : json['sign_on_lat'],
         'signOnLong': json['sign_on_long'] == null ? undefined : json['sign_on_long'],
@@ -167,7 +164,7 @@ export function RegistersUpdateRequestToJSONTyped(value?: RegistersUpdateRequest
         'venue_id': value['venueId'],
         'start_date_time': value['startDateTime'] == null ? undefined : ((value['startDateTime']).toISOString()),
         'finish_date_time': value['finishDateTime'] == null ? undefined : ((value['finishDateTime']).toISOString()),
-        'sign_off_status': value['signOffStatus'],
+        'sign_off_status': SignOffStatusToJSON(value['signOffStatus']),
         'badge_number': value['badgeNumber'],
         'sign_on_lat': value['signOnLat'],
         'sign_on_long': value['signOnLong'],

package/src/models/RosterListResource.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 {
     SecurityCompanyLiteResourceToJSON,
     SecurityCompanyLiteResourceToJSONTyped,
 } from './SecurityCompanyLiteResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -78,10 +85,10 @@ export interface RosterListResource {
     isComplete: boolean;
     /**
      * 
-     * @type {number}
+     * @type {SignOffStatus}
      * @memberof RosterListResource
      */
-    signOffStatus: RosterListResourceSignOffStatusEnum;
+    signOffStatus: SignOffStatus;
     /**
      * 
      * @type {number}
@@ -97,16 +104,6 @@ export interface RosterListResource {
 }
 
 
-/**
- * @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.
@@ -140,7 +137,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
-        'signOffStatus': json['signOffStatus'],
+        'signOffStatus': SignOffStatusFromJSON(json['signOffStatus']),
         'registerCount': json['registerCount'],
         'incidentCount': json['incidentCount'],
     };
@@ -164,7 +161,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
-        'signOffStatus': value['signOffStatus'],
+        'signOffStatus': SignOffStatusToJSON(value['signOffStatus']),
         'registerCount': value['registerCount'],
         'incidentCount': value['incidentCount'],
     };

package/src/models/RosterListResourceArrayResponse.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/RosterLiteResource.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/RosterLiteResourceArrayResponse.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/RosterResource.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
  * 
@@ -34,6 +34,13 @@ import {
     RegisterResourceToJSON,
     RegisterResourceToJSONTyped,
 } from './RegisterResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -85,10 +92,10 @@ export interface RosterResource {
     isComplete: boolean;
     /**
      * 
-     * @type {number}
+     * @type {SignOffStatus}
      * @memberof RosterResource
      */
-    signOffStatus: RosterResourceSignOffStatusEnum;
+    signOffStatus: SignOffStatus;
     /**
      * 
      * @type {Array<RegisterResource>}
@@ -98,16 +105,6 @@ export interface RosterResource {
 }
 
 
-/**
- * @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.
@@ -140,7 +137,7 @@ export function RosterResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
-        'signOffStatus': json['signOffStatus'],
+        'signOffStatus': SignOffStatusFromJSON(json['signOffStatus']),
         'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterResourceFromJSON)),
     };
 }
@@ -163,7 +160,7 @@ export function RosterResourceToJSONTyped(value?: RosterResource | null, ignoreD
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
-        'signOffStatus': value['signOffStatus'],
+        'signOffStatus': SignOffStatusToJSON(value['signOffStatus']),
         'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterResourceToJSON)),
     };
 }

package/src/models/RosterResourceArrayResponse.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/RosterWithRegistersResource.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
  * 
@@ -34,6 +34,13 @@ import {
     RegisterListResourceToJSON,
     RegisterListResourceToJSONTyped,
 } from './RegisterListResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -91,10 +98,10 @@ export interface RosterWithRegistersResource {
     isComplete: boolean;
     /**
      * 
-     * @type {number}
+     * @type {SignOffStatus}
      * @memberof RosterWithRegistersResource
      */
-    signOffStatus: RosterWithRegistersResourceSignOffStatusEnum;
+    signOffStatus: SignOffStatus;
     /**
      * 
      * @type {Array<RegisterListResource>}
@@ -104,16 +111,6 @@ export interface RosterWithRegistersResource {
 }
 
 
-/**
- * @export
- */
-export const RosterWithRegistersResourceSignOffStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
-} as const;
-export type RosterWithRegistersResourceSignOffStatusEnum = typeof RosterWithRegistersResourceSignOffStatusEnum[keyof typeof RosterWithRegistersResourceSignOffStatusEnum];
-
 
 /**
  * Check if a given object implements the RosterWithRegistersResource interface.
@@ -148,7 +145,7 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
-        'signOffStatus': json['signOffStatus'],
+        'signOffStatus': SignOffStatusFromJSON(json['signOffStatus']),
         'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
     };
 }
@@ -172,7 +169,7 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
-        'signOffStatus': value['signOffStatus'],
+        'signOffStatus': SignOffStatusToJSON(value['signOffStatus']),
         'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
     };
 }

package/src/models/RosterWithRegistersResourceArrayResponse.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/RostersExportPdfRequest.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/RostersListAllRequest.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/RostersListRequest.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/RostersListWithRegistersRequest.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/RostersUpdateRequest.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 { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
+
 /**
  * 
  * @export
@@ -45,10 +53,10 @@ export interface RostersUpdateRequest {
     finishDateTime?: Date;
     /**
      * 
-     * @type {string}
+     * @type {SignOffStatus}
      * @memberof RostersUpdateRequest
      */
-    signOffStatus?: RostersUpdateRequestSignOffStatusEnum;
+    signOffStatus?: SignOffStatus;
     /**
      * 
      * @type {boolean}
@@ -64,16 +72,6 @@ export interface RostersUpdateRequest {
 }
 
 
-/**
- * @export
- */
-export const RostersUpdateRequestSignOffStatusEnum = {
-    _0: '0',
-    _1: '1',
-    _2: '2'
-} as const;
-export type RostersUpdateRequestSignOffStatusEnum = typeof RostersUpdateRequestSignOffStatusEnum[keyof typeof RostersUpdateRequestSignOffStatusEnum];
-
 
 /**
  * Check if a given object implements the RostersUpdateRequest interface.
@@ -96,7 +94,7 @@ export function RostersUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator
         'securityCompanyId': json['security_company_id'] == null ? undefined : json['security_company_id'],
         'startDateTime': json['start_date_time'] == null ? undefined : (new Date(json['start_date_time'])),
         'finishDateTime': json['finish_date_time'] == null ? undefined : (new Date(json['finish_date_time'])),
-        'signOffStatus': json['sign_off_status'] == null ? undefined : json['sign_off_status'],
+        'signOffStatus': json['sign_off_status'] == null ? undefined : SignOffStatusFromJSON(json['sign_off_status']),
         'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
         'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
     };
@@ -117,7 +115,7 @@ export function RostersUpdateRequestToJSONTyped(value?: RostersUpdateRequest | n
         'security_company_id': value['securityCompanyId'],
         'start_date_time': value['startDateTime'] == null ? undefined : ((value['startDateTime']).toISOString()),
         'finish_date_time': value['finishDateTime'] == null ? undefined : ((value['finishDateTime']).toISOString()),
-        'sign_off_status': value['signOffStatus'],
+        'sign_off_status': SignOffStatusToJSON(value['signOffStatus']),
         'is_complete': value['isComplete'],
         'is_compliant': value['isCompliant'],
     };

package/src/models/RsaAsset.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/SecurityCompaniesAttachUsersRequest.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/SecurityCompaniesListAllRequest.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/SecurityCompaniesListRequest.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/SecurityCompaniesStoreRequest.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/SecurityCompaniesUpdateRequest.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/SecurityCompanyLiteResource.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/SecurityCompanyLiteResourceArrayResponse.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/SecurityCompanyResource.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
  * 
@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
      * @type {string}
      * @memberof SecurityCompanyResource
      */
-    email: string;
+    email?: string | null;
     /**
      * 
      * @type {boolean}
@@ -82,7 +82,6 @@ export interface SecurityCompanyResource {
  */
 export function instanceOfSecurityCompanyResource(value: object): value is SecurityCompanyResource {
     if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('email' in value) || value['email'] === undefined) return false;
     if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
     if (!('address' in value) || value['address'] === undefined) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -101,7 +100,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
-        'email': json['email'],
+        'email': json['email'] == null ? undefined : json['email'],
         'isEnabled': json['isEnabled'],
         'address': AddressResourceFromJSON(json['address']),
         'licenceNumber': json['licenceNumber'],

package/src/models/SecurityCompanyResourceArrayResponse.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/SettingsLicenceVerificationFallbackUpdateRequest.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
  *