@digital8/security-registers-backend-ts-sdk 0.0.813 → 0.0.815

package/src/models/LicencesVerifyRequest.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 { LicenceState } from './LicenceState';
+import {
+    LicenceStateFromJSON,
+    LicenceStateFromJSONTyped,
+    LicenceStateToJSON,
+    LicenceStateToJSONTyped,
+} from './LicenceState';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface LicencesVerifyRequest {
     /**
      * 
-     * @type {string}
+     * @type {LicenceState}
      * @memberof LicencesVerifyRequest
      */
-    state: LicencesVerifyRequestStateEnum;
+    state: LicenceState;
     /**
      * 
      * @type {string}
@@ -52,16 +60,6 @@ export interface LicencesVerifyRequest {
 }
 
 
-/**
- * @export
- */
-export const LicencesVerifyRequestStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type LicencesVerifyRequestStateEnum = typeof LicencesVerifyRequestStateEnum[keyof typeof LicencesVerifyRequestStateEnum];
-
 
 /**
  * Check if a given object implements the LicencesVerifyRequest interface.
@@ -85,7 +83,7 @@ export function LicencesVerifyRequestFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'state': json['state'],
+        'state': LicenceStateFromJSON(json['state']),
         'licenceNumber': json['licence_number'],
         'givenName': json['given_name'],
         'lastName': json['last_name'],
@@ -104,7 +102,7 @@ export function LicencesVerifyRequestToJSONTyped(value?: LicencesVerifyRequest |
 
     return {
         
-        'state': value['state'],
+        'state': LicenceStateToJSON(value['state']),
         'licence_number': value['licenceNumber'],
         'given_name': value['givenName'],
         'last_name': value['lastName'],

package/src/models/LoginPlatform.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 LoginPlatform = {
+    App: 'app',
+    Web: 'web'
+} as const;
+export type LoginPlatform = typeof LoginPlatform[keyof typeof LoginPlatform];
+
+
+export function instanceOfLoginPlatform(value: any): boolean {
+    for (const key in LoginPlatform) {
+        if (Object.prototype.hasOwnProperty.call(LoginPlatform, key)) {
+            if (LoginPlatform[key as keyof typeof LoginPlatform] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function LoginPlatformFromJSON(json: any): LoginPlatform {
+    return LoginPlatformFromJSONTyped(json, false);
+}
+
+export function LoginPlatformFromJSONTyped(json: any, ignoreDiscriminator: boolean): LoginPlatform {
+    return json as LoginPlatform;
+}
+
+export function LoginPlatformToJSON(value?: LoginPlatform | null): any {
+    return value as any;
+}
+
+export function LoginPlatformToJSONTyped(value: any, ignoreDiscriminator: boolean): LoginPlatform {
+    return value as LoginPlatform;
+}
+

package/src/models/MobileAppConfigRequest.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 { MobileDevicePlatform } from './MobileDevicePlatform';
+import {
+    MobileDevicePlatformFromJSON,
+    MobileDevicePlatformFromJSONTyped,
+    MobileDevicePlatformToJSON,
+    MobileDevicePlatformToJSONTyped,
+} from './MobileDevicePlatform';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface MobileAppConfigRequest {
     /**
      * 
-     * @type {string}
+     * @type {MobileDevicePlatform}
      * @memberof MobileAppConfigRequest
      */
-    platform: MobileAppConfigRequestPlatformEnum;
+    platform: MobileDevicePlatform;
     /**
      * The app's current version as a semantic version string (e.g. "1.4.2").
      * @type {string}
@@ -34,15 +42,6 @@ export interface MobileAppConfigRequest {
 }
 
 
-/**
- * @export
- */
-export const MobileAppConfigRequestPlatformEnum = {
-    Ios: 'ios',
-    Android: 'android'
-} as const;
-export type MobileAppConfigRequestPlatformEnum = typeof MobileAppConfigRequestPlatformEnum[keyof typeof MobileAppConfigRequestPlatformEnum];
-
 
 /**
  * Check if a given object implements the MobileAppConfigRequest interface.
@@ -63,7 +62,7 @@ export function MobileAppConfigRequestFromJSONTyped(json: any, ignoreDiscriminat
     }
     return {
         
-        'platform': json['platform'],
+        'platform': MobileDevicePlatformFromJSON(json['platform']),
         'appVersion': json['app_version'],
     };
 }
@@ -79,7 +78,7 @@ export function MobileAppConfigRequestToJSONTyped(value?: MobileAppConfigRequest
 
     return {
         
-        'platform': value['platform'],
+        'platform': MobileDevicePlatformToJSON(value['platform']),
         'app_version': value['appVersion'],
     };
 }

package/src/models/MobileAppConfigResource.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 { MobileDevicePlatform } from './MobileDevicePlatform';
+import {
+    MobileDevicePlatformFromJSON,
+    MobileDevicePlatformFromJSONTyped,
+    MobileDevicePlatformToJSON,
+    MobileDevicePlatformToJSONTyped,
+} from './MobileDevicePlatform';
+
 /**
  * 
  * @export
@@ -21,10 +29,10 @@ import { mapValues } from '../runtime';
 export interface MobileAppConfigResource {
     /**
      * 
-     * @type {string}
+     * @type {MobileDevicePlatform}
      * @memberof MobileAppConfigResource
      */
-    platform: MobileAppConfigResourcePlatformEnum;
+    platform: MobileDevicePlatform;
     /**
      * 
      * @type {boolean}
@@ -46,15 +54,6 @@ export interface MobileAppConfigResource {
 }
 
 
-/**
- * @export
- */
-export const MobileAppConfigResourcePlatformEnum = {
-    Ios: 'ios',
-    Android: 'android'
-} as const;
-export type MobileAppConfigResourcePlatformEnum = typeof MobileAppConfigResourcePlatformEnum[keyof typeof MobileAppConfigResourcePlatformEnum];
-
 
 /**
  * Check if a given object implements the MobileAppConfigResource interface.
@@ -76,7 +75,7 @@ export function MobileAppConfigResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'platform': json['platform'],
+        'platform': MobileDevicePlatformFromJSON(json['platform']),
         'forceUpdate': json['forceUpdate'],
         'updateUrl': json['updateUrl'],
         'message': json['message'] == null ? undefined : json['message'],
@@ -94,7 +93,7 @@ export function MobileAppConfigResourceToJSONTyped(value?: MobileAppConfigResour
 
     return {
         
-        'platform': value['platform'],
+        'platform': MobileDevicePlatformToJSON(value['platform']),
         'forceUpdate': value['forceUpdate'],
         'updateUrl': value['updateUrl'],
         'message': value['message'],

package/src/models/MobileAppConfigResourceArrayResponse.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/MobileDevicePlatform.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 MobileDevicePlatform = {
+    Ios: 'ios',
+    Android: 'android'
+} as const;
+export type MobileDevicePlatform = typeof MobileDevicePlatform[keyof typeof MobileDevicePlatform];
+
+
+export function instanceOfMobileDevicePlatform(value: any): boolean {
+    for (const key in MobileDevicePlatform) {
+        if (Object.prototype.hasOwnProperty.call(MobileDevicePlatform, key)) {
+            if (MobileDevicePlatform[key as keyof typeof MobileDevicePlatform] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function MobileDevicePlatformFromJSON(json: any): MobileDevicePlatform {
+    return MobileDevicePlatformFromJSONTyped(json, false);
+}
+
+export function MobileDevicePlatformFromJSONTyped(json: any, ignoreDiscriminator: boolean): MobileDevicePlatform {
+    return json as MobileDevicePlatform;
+}
+
+export function MobileDevicePlatformToJSON(value?: MobileDevicePlatform | null): any {
+    return value as any;
+}
+
+export function MobileDevicePlatformToJSONTyped(value: any, ignoreDiscriminator: boolean): MobileDevicePlatform {
+    return value as MobileDevicePlatform;
+}
+

package/src/models/MobileDeviceResource.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 { MobileDevicePlatform } from './MobileDevicePlatform';
+import {
+    MobileDevicePlatformFromJSON,
+    MobileDevicePlatformFromJSONTyped,
+    MobileDevicePlatformToJSON,
+    MobileDevicePlatformToJSONTyped,
+} from './MobileDevicePlatform';
+
 /**
  * 
  * @export
@@ -33,10 +41,10 @@ export interface MobileDeviceResource {
     deviceId: string;
     /**
      * 
-     * @type {string}
+     * @type {MobileDevicePlatform}
      * @memberof MobileDeviceResource
      */
-    platform: MobileDeviceResourcePlatformEnum;
+    platform: MobileDevicePlatform;
     /**
      * 
      * @type {string}
@@ -88,15 +96,6 @@ export interface MobileDeviceResource {
 }
 
 
-/**
- * @export
- */
-export const MobileDeviceResourcePlatformEnum = {
-    Ios: 'ios',
-    Android: 'android'
-} as const;
-export type MobileDeviceResourcePlatformEnum = typeof MobileDeviceResourcePlatformEnum[keyof typeof MobileDeviceResourcePlatformEnum];
-
 
 /**
  * Check if a given object implements the MobileDeviceResource interface.
@@ -124,7 +123,7 @@ export function MobileDeviceResourceFromJSONTyped(json: any, ignoreDiscriminator
         
         'id': json['id'] == null ? undefined : json['id'],
         'deviceId': json['deviceId'],
-        'platform': json['platform'],
+        'platform': MobileDevicePlatformFromJSON(json['platform']),
         'osVersion': json['osVersion'],
         'appVersion': json['appVersion'],
         'model': json['model'],
@@ -149,7 +148,7 @@ export function MobileDeviceResourceToJSONTyped(value?: MobileDeviceResource | n
         
         'id': value['id'],
         'deviceId': value['deviceId'],
-        'platform': value['platform'],
+        'platform': MobileDevicePlatformToJSON(value['platform']),
         'osVersion': value['osVersion'],
         'appVersion': value['appVersion'],
         'model': value['model'],

package/src/models/MobileDeviceResourceArrayResponse.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/MobileInitResource.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/MobileInitResourceArrayResponse.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/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'],
     };