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

package/src/models/NotificationPreferenceResource.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 {
     VenueLiteResourceToJSON,
     VenueLiteResourceToJSONTyped,
 } from './VenueLiteResource';
+import type { NotificationType } from './NotificationType';
+import {
+    NotificationTypeFromJSON,
+    NotificationTypeFromJSONTyped,
+    NotificationTypeToJSON,
+    NotificationTypeToJSONTyped,
+} from './NotificationType';
 
 /**
  * 
@@ -35,10 +42,10 @@ export interface NotificationPreferenceResource {
     id?: number | null;
     /**
      * 
-     * @type {string}
+     * @type {NotificationType}
      * @memberof NotificationPreferenceResource
      */
-    notificationType: NotificationPreferenceResourceNotificationTypeEnum;
+    notificationType: NotificationType;
     /**
      * 
      * @type {VenueLiteResource}
@@ -66,22 +73,6 @@ export interface NotificationPreferenceResource {
 }
 
 
-/**
- * @export
- */
-export const NotificationPreferenceResourceNotificationTypeEnum = {
-    IncidentAdded: 'incident_added',
-    IncidentPendingReminder: 'incident_pending_reminder',
-    NonSignOff: 'non_sign_off',
-    NonSignOn: 'non_sign_on',
-    SignOnRejected: 'sign_on_rejected',
-    LicenceUpdated: 'licence_updated',
-    LicenceExpiringSoon: 'licence_expiring_soon',
-    ExportReady: 'export_ready',
-    ExportFailed: 'export_failed'
-} as const;
-export type NotificationPreferenceResourceNotificationTypeEnum = typeof NotificationPreferenceResourceNotificationTypeEnum[keyof typeof NotificationPreferenceResourceNotificationTypeEnum];
-
 
 /**
  * Check if a given object implements the NotificationPreferenceResource interface.
@@ -104,7 +95,7 @@ export function NotificationPreferenceResourceFromJSONTyped(json: any, ignoreDis
     return {
         
         'id': json['id'] == null ? undefined : json['id'],
-        'notificationType': json['notificationType'],
+        'notificationType': NotificationTypeFromJSON(json['notificationType']),
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'enabled': json['enabled'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
@@ -124,7 +115,7 @@ export function NotificationPreferenceResourceToJSONTyped(value?: NotificationPr
     return {
         
         'id': value['id'],
-        'notificationType': value['notificationType'],
+        'notificationType': NotificationTypeToJSON(value['notificationType']),
         'venue': VenueLiteResourceToJSON(value['venue']),
         'enabled': value['enabled'],
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),

package/src/models/NotificationPreferenceResourceArrayResponse.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/NotificationPreferencesBulkRequest.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/NotificationPreferencesBulkRequestPreferencesInner.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 { NotificationType } from './NotificationType';
+import {
+    NotificationTypeFromJSON,
+    NotificationTypeFromJSONTyped,
+    NotificationTypeToJSON,
+    NotificationTypeToJSONTyped,
+} from './NotificationType';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface NotificationPreferencesBulkRequestPreferencesInner {
     /**
      * 
-     * @type {string}
+     * @type {NotificationType}
      * @memberof NotificationPreferencesBulkRequestPreferencesInner
      */
-    notificationType: NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum;
+    notificationType: NotificationType;
     /**
      * 
      * @type {number}
@@ -40,22 +48,6 @@ export interface NotificationPreferencesBulkRequestPreferencesInner {
 }
 
 
-/**
- * @export
- */
-export const NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum = {
-    IncidentAdded: 'incident_added',
-    IncidentPendingReminder: 'incident_pending_reminder',
-    NonSignOff: 'non_sign_off',
-    NonSignOn: 'non_sign_on',
-    SignOnRejected: 'sign_on_rejected',
-    LicenceUpdated: 'licence_updated',
-    LicenceExpiringSoon: 'licence_expiring_soon',
-    ExportReady: 'export_ready',
-    ExportFailed: 'export_failed'
-} as const;
-export type NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum = typeof NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum[keyof typeof NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum];
-
 
 /**
  * Check if a given object implements the NotificationPreferencesBulkRequestPreferencesInner interface.
@@ -76,7 +68,7 @@ export function NotificationPreferencesBulkRequestPreferencesInnerFromJSONTyped(
     }
     return {
         
-        'notificationType': json['notification_type'],
+        'notificationType': NotificationTypeFromJSON(json['notification_type']),
         'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
         'enabled': json['enabled'],
     };
@@ -93,7 +85,7 @@ export function NotificationPreferencesBulkRequestPreferencesInnerToJSONTyped(va
 
     return {
         
-        'notification_type': value['notificationType'],
+        'notification_type': NotificationTypeToJSON(value['notificationType']),
         'venue_id': value['venueId'],
         'enabled': value['enabled'],
     };

package/src/models/NotificationPreferencesStoreRequest.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 { NotificationType } from './NotificationType';
+import {
+    NotificationTypeFromJSON,
+    NotificationTypeFromJSONTyped,
+    NotificationTypeToJSON,
+    NotificationTypeToJSONTyped,
+} from './NotificationType';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface NotificationPreferencesStoreRequest {
     /**
      * 
-     * @type {string}
+     * @type {NotificationType}
      * @memberof NotificationPreferencesStoreRequest
      */
-    notificationType: NotificationPreferencesStoreRequestNotificationTypeEnum;
+    notificationType: NotificationType;
     /**
      * 
      * @type {number}
@@ -40,22 +48,6 @@ export interface NotificationPreferencesStoreRequest {
 }
 
 
-/**
- * @export
- */
-export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
-    IncidentAdded: 'incident_added',
-    IncidentPendingReminder: 'incident_pending_reminder',
-    NonSignOff: 'non_sign_off',
-    NonSignOn: 'non_sign_on',
-    SignOnRejected: 'sign_on_rejected',
-    LicenceUpdated: 'licence_updated',
-    LicenceExpiringSoon: 'licence_expiring_soon',
-    ExportReady: 'export_ready',
-    ExportFailed: 'export_failed'
-} as const;
-export type NotificationPreferencesStoreRequestNotificationTypeEnum = typeof NotificationPreferencesStoreRequestNotificationTypeEnum[keyof typeof NotificationPreferencesStoreRequestNotificationTypeEnum];
-
 
 /**
  * Check if a given object implements the NotificationPreferencesStoreRequest interface.
@@ -76,7 +68,7 @@ export function NotificationPreferencesStoreRequestFromJSONTyped(json: any, igno
     }
     return {
         
-        'notificationType': json['notification_type'],
+        'notificationType': NotificationTypeFromJSON(json['notification_type']),
         'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
         'enabled': json['enabled'],
     };
@@ -93,7 +85,7 @@ export function NotificationPreferencesStoreRequestToJSONTyped(value?: Notificat
 
     return {
         
-        'notification_type': value['notificationType'],
+        'notification_type': NotificationTypeToJSON(value['notificationType']),
         'venue_id': value['venueId'],
         'enabled': value['enabled'],
     };

package/src/models/NotificationStatus.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const NotificationStatus = {
+    Sent: 'sent',
+    Failed: 'failed'
+} as const;
+export type NotificationStatus = typeof NotificationStatus[keyof typeof NotificationStatus];
+
+
+export function instanceOfNotificationStatus(value: any): boolean {
+    for (const key in NotificationStatus) {
+        if (Object.prototype.hasOwnProperty.call(NotificationStatus, key)) {
+            if (NotificationStatus[key as keyof typeof NotificationStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function NotificationStatusFromJSON(json: any): NotificationStatus {
+    return NotificationStatusFromJSONTyped(json, false);
+}
+
+export function NotificationStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationStatus {
+    return json as NotificationStatus;
+}
+
+export function NotificationStatusToJSON(value?: NotificationStatus | null): any {
+    return value as any;
+}
+
+export function NotificationStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): NotificationStatus {
+    return value as NotificationStatus;
+}
+

package/src/models/NotificationType.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const NotificationType = {
+    IncidentAdded: 'incident_added',
+    IncidentPendingReminder: 'incident_pending_reminder',
+    NonSignOff: 'non_sign_off',
+    NonSignOn: 'non_sign_on',
+    SignOnRejected: 'sign_on_rejected',
+    LicenceUpdated: 'licence_updated',
+    LicenceExpiringSoon: 'licence_expiring_soon',
+    ExportReady: 'export_ready',
+    ExportFailed: 'export_failed'
+} as const;
+export type NotificationType = typeof NotificationType[keyof typeof NotificationType];
+
+
+export function instanceOfNotificationType(value: any): boolean {
+    for (const key in NotificationType) {
+        if (Object.prototype.hasOwnProperty.call(NotificationType, key)) {
+            if (NotificationType[key as keyof typeof NotificationType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function NotificationTypeFromJSON(json: any): NotificationType {
+    return NotificationTypeFromJSONTyped(json, false);
+}
+
+export function NotificationTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationType {
+    return json as NotificationType;
+}
+
+export function NotificationTypeToJSON(value?: NotificationType | null): any {
+    return value as any;
+}
+
+export function NotificationTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): NotificationType {
+    return value as NotificationType;
+}
+

package/src/models/NotificationTypeResource.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/NotificationTypeResourceArrayResponse.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/PaginatedIncidentListResourceResponse.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/PaginatedLicenceCheckLogResourceResponse.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/PaginatedLicenceListResourceResponse.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/PaginatedLicenceResourceResponse.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/PaginatedRecentVideoListResourceResponse.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/PaginatedRegisterGroupedByRosterResourceResponse.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/PaginatedRegisterListResourceResponse.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/PaginatedRegisterResourceResponse.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/PaginatedRosterListResourceResponse.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/PaginatedRosterResourceResponse.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/PaginatedRosterWithRegistersResourceResponse.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/PaginatedSecurityCompanyResourceResponse.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/PaginatedUserResourceResponse.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/PaginatedVenueResourceResponse.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/PagingMetadata.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
  * 
@@ -30,7 +30,7 @@ export interface PagingMetadata {
      * @type {number}
      * @memberof PagingMetadata
      */
-    from: number;
+    from: number | null;
     /**
      * 
      * @type {number}
@@ -39,10 +39,10 @@ export interface PagingMetadata {
     lastPage: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof PagingMetadata
      */
-    path: number;
+    path: string;
     /**
      * 
      * @type {number}
@@ -54,7 +54,7 @@ export interface PagingMetadata {
      * @type {number}
      * @memberof PagingMetadata
      */
-    to: number;
+    to: number | null;
     /**
      * 
      * @type {number}

package/src/models/PdfExportDownloadType.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const PdfExportDownloadType = {
+    Redirect: 'redirect',
+    Stream: 'stream',
+    Error: 'error'
+} as const;
+export type PdfExportDownloadType = typeof PdfExportDownloadType[keyof typeof PdfExportDownloadType];
+
+
+export function instanceOfPdfExportDownloadType(value: any): boolean {
+    for (const key in PdfExportDownloadType) {
+        if (Object.prototype.hasOwnProperty.call(PdfExportDownloadType, key)) {
+            if (PdfExportDownloadType[key as keyof typeof PdfExportDownloadType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PdfExportDownloadTypeFromJSON(json: any): PdfExportDownloadType {
+    return PdfExportDownloadTypeFromJSONTyped(json, false);
+}
+
+export function PdfExportDownloadTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PdfExportDownloadType {
+    return json as PdfExportDownloadType;
+}
+
+export function PdfExportDownloadTypeToJSON(value?: PdfExportDownloadType | null): any {
+    return value as any;
+}
+
+export function PdfExportDownloadTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): PdfExportDownloadType {
+    return value as PdfExportDownloadType;
+}
+