@digital8/security-registers-backend-ts-sdk 0.0.199 → 0.0.200

package/src/models/AssetResource.ts

@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      * 
      * @type {number}
@@ -71,6 +71,7 @@ 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;
     return true;
@@ -90,7 +91,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'] == null ? undefined : json['altText'],
+        'altText': json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/src/models/NotificationPreferenceResource.ts

@@ -0,0 +1,116 @@
+/* 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 { VenueLiteResource } from './VenueLiteResource';
+import {
+    VenueLiteResourceFromJSON,
+    VenueLiteResourceFromJSONTyped,
+    VenueLiteResourceToJSON,
+    VenueLiteResourceToJSONTyped,
+} from './VenueLiteResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationPreferenceResource
+ */
+export interface NotificationPreferenceResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof NotificationPreferenceResource
+     */
+    id?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationPreferenceResource
+     */
+    notificationType: string;
+    /**
+     * 
+     * @type {VenueLiteResource}
+     * @memberof NotificationPreferenceResource
+     */
+    venue: VenueLiteResource | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferenceResource
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NotificationPreferenceResource
+     */
+    createdAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof NotificationPreferenceResource
+     */
+    updatedAt?: Date | null;
+}
+
+/**
+ * Check if a given object implements the NotificationPreferenceResource interface.
+ */
+export function instanceOfNotificationPreferenceResource(value: object): value is NotificationPreferenceResource {
+    if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
+    if (!('venue' in value) || value['venue'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function NotificationPreferenceResourceFromJSON(json: any): NotificationPreferenceResource {
+    return NotificationPreferenceResourceFromJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferenceResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'notificationType': json['notificationType'],
+        'venue': VenueLiteResourceFromJSON(json['venue']),
+        'enabled': json['enabled'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+        'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
+    };
+}
+
+export function NotificationPreferenceResourceToJSON(json: any): NotificationPreferenceResource {
+    return NotificationPreferenceResourceToJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceToJSONTyped(value?: NotificationPreferenceResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'notificationType': value['notificationType'],
+        'venue': VenueLiteResourceToJSON(value['venue']),
+        'enabled': value['enabled'],
+        'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
+        'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),
+    };
+}
+

package/src/models/NotificationPreferenceResourceArrayResponse.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 { NotificationPreferenceResource } from './NotificationPreferenceResource';
+import {
+    NotificationPreferenceResourceFromJSON,
+    NotificationPreferenceResourceFromJSONTyped,
+    NotificationPreferenceResourceToJSON,
+    NotificationPreferenceResourceToJSONTyped,
+} from './NotificationPreferenceResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationPreferenceResourceArrayResponse
+ */
+export interface NotificationPreferenceResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<NotificationPreferenceResource>}
+     * @memberof NotificationPreferenceResourceArrayResponse
+     */
+    data?: Array<NotificationPreferenceResource>;
+}
+
+/**
+ * Check if a given object implements the NotificationPreferenceResourceArrayResponse interface.
+ */
+export function instanceOfNotificationPreferenceResourceArrayResponse(value: object): value is NotificationPreferenceResourceArrayResponse {
+    return true;
+}
+
+export function NotificationPreferenceResourceArrayResponseFromJSON(json: any): NotificationPreferenceResourceArrayResponse {
+    return NotificationPreferenceResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferenceResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NotificationPreferenceResourceFromJSON)),
+    };
+}
+
+export function NotificationPreferenceResourceArrayResponseToJSON(json: any): NotificationPreferenceResourceArrayResponse {
+    return NotificationPreferenceResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function NotificationPreferenceResourceArrayResponseToJSONTyped(value?: NotificationPreferenceResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NotificationPreferenceResourceToJSON)),
+    };
+}
+

package/src/models/NotificationPreferencesStoreRequest.ts

@@ -0,0 +1,97 @@
+/* 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 NotificationPreferencesStoreRequest
+ */
+export interface NotificationPreferencesStoreRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    notificationType: NotificationPreferencesStoreRequestNotificationTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    venueId?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof NotificationPreferencesStoreRequest
+     */
+    enabled: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
+    IncidentAdded: 'incident_added',
+    NonSignOff: 'non_sign_off',
+    NonSignOn: 'non_sign_on',
+    SignOnRejected: 'sign_on_rejected',
+    LicenceUpdated: 'licence_updated'
+} as const;
+export type NotificationPreferencesStoreRequestNotificationTypeEnum = typeof NotificationPreferencesStoreRequestNotificationTypeEnum[keyof typeof NotificationPreferencesStoreRequestNotificationTypeEnum];
+
+
+/**
+ * Check if a given object implements the NotificationPreferencesStoreRequest interface.
+ */
+export function instanceOfNotificationPreferencesStoreRequest(value: object): value is NotificationPreferencesStoreRequest {
+    if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function NotificationPreferencesStoreRequestFromJSON(json: any): NotificationPreferencesStoreRequest {
+    return NotificationPreferencesStoreRequestFromJSONTyped(json, false);
+}
+
+export function NotificationPreferencesStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferencesStoreRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'notificationType': json['notification_type'],
+        'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
+        'enabled': json['enabled'],
+    };
+}
+
+export function NotificationPreferencesStoreRequestToJSON(json: any): NotificationPreferencesStoreRequest {
+    return NotificationPreferencesStoreRequestToJSONTyped(json, false);
+}
+
+export function NotificationPreferencesStoreRequestToJSONTyped(value?: NotificationPreferencesStoreRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'notification_type': value['notificationType'],
+        'venue_id': value['venueId'],
+        'enabled': value['enabled'],
+    };
+}
+

package/src/models/NotificationTypeResource.ts

@@ -0,0 +1,75 @@
+/* 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 NotificationTypeResource
+ */
+export interface NotificationTypeResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationTypeResource
+     */
+    value: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NotificationTypeResource
+     */
+    label: string;
+}
+
+/**
+ * Check if a given object implements the NotificationTypeResource interface.
+ */
+export function instanceOfNotificationTypeResource(value: object): value is NotificationTypeResource {
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('label' in value) || value['label'] === undefined) return false;
+    return true;
+}
+
+export function NotificationTypeResourceFromJSON(json: any): NotificationTypeResource {
+    return NotificationTypeResourceFromJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'value': json['value'],
+        'label': json['label'],
+    };
+}
+
+export function NotificationTypeResourceToJSON(json: any): NotificationTypeResource {
+    return NotificationTypeResourceToJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceToJSONTyped(value?: NotificationTypeResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'value': value['value'],
+        'label': value['label'],
+    };
+}
+

package/src/models/NotificationTypeResourceArrayResponse.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 { NotificationTypeResource } from './NotificationTypeResource';
+import {
+    NotificationTypeResourceFromJSON,
+    NotificationTypeResourceFromJSONTyped,
+    NotificationTypeResourceToJSON,
+    NotificationTypeResourceToJSONTyped,
+} from './NotificationTypeResource';
+
+/**
+ * 
+ * @export
+ * @interface NotificationTypeResourceArrayResponse
+ */
+export interface NotificationTypeResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<NotificationTypeResource>}
+     * @memberof NotificationTypeResourceArrayResponse
+     */
+    data?: Array<NotificationTypeResource>;
+}
+
+/**
+ * Check if a given object implements the NotificationTypeResourceArrayResponse interface.
+ */
+export function instanceOfNotificationTypeResourceArrayResponse(value: object): value is NotificationTypeResourceArrayResponse {
+    return true;
+}
+
+export function NotificationTypeResourceArrayResponseFromJSON(json: any): NotificationTypeResourceArrayResponse {
+    return NotificationTypeResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NotificationTypeResourceFromJSON)),
+    };
+}
+
+export function NotificationTypeResourceArrayResponseToJSON(json: any): NotificationTypeResourceArrayResponse {
+    return NotificationTypeResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function NotificationTypeResourceArrayResponseToJSONTyped(value?: NotificationTypeResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NotificationTypeResourceToJSON)),
+    };
+}
+

package/src/models/RegisterListResource.ts

@@ -159,7 +159,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLat?: number | null;
+    signOffLat: number;
     /**
      * 
      * @type {number}
@@ -196,6 +196,7 @@ 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 (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
     if (!('incidents' in value) || value['incidents'] === undefined) return false;
     return true;
 }
@@ -230,7 +231,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'firstAid': json['firstAid'],
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
-        'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
+        'signOffLat': json['signOffLat'],
         'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'incidents': json['incidents'],
     };

package/src/models/RosterListResource.ts

@@ -63,7 +63,7 @@ export interface RosterListResource {
      * @type {Date}
      * @memberof RosterListResource
      */
-    finishDateTime?: Date | null;
+    finishDateTime: Date;
     /**
      * 
      * @type {boolean}
@@ -97,6 +97,7 @@ export function instanceOfRosterListResource(value: object): value is RosterList
     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;
@@ -118,7 +119,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
+        'finishDateTime': (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
         'signOffStatus': json['signOffStatus'],
@@ -141,7 +142,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
         'venue': VenueLiteResourceToJSON(value['venue']),
         'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
+        'finishDateTime': ((value['finishDateTime']).toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
         'signOffStatus': value['signOffStatus'],

package/src/models/RosterWithRegistersResource.ts

@@ -76,7 +76,7 @@ export interface RosterWithRegistersResource {
      * @type {Date}
      * @memberof RosterWithRegistersResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {boolean}
@@ -111,7 +111,6 @@ export function instanceOfRosterWithRegistersResource(value: object): value is R
     if (!('state' in value) || value['state'] === 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;
@@ -134,7 +133,7 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
         'state': json['state'],
         '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'],
@@ -158,7 +157,7 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
         'state': value['state'],
         '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'],

package/src/models/SecurityCompanyResource.ts

@@ -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/index.ts

@@ -27,6 +27,11 @@ export * from './LicencesStoreRequest';
 export * from './LicencesUpdateRequest';
 export * from './LicencesVerifyRequest';
 export * from './LoginAuthRequest';
+export * from './NotificationPreferenceResource';
+export * from './NotificationPreferenceResourceArrayResponse';
+export * from './NotificationPreferencesStoreRequest';
+export * from './NotificationTypeResource';
+export * from './NotificationTypeResourceArrayResponse';
 export * from './PaginatedLicenceListResourceResponse';
 export * from './PaginatedLicenceResourceResponse';
 export * from './PaginatedRegisterGroupedByRosterResourceResponse';