@digital8/security-registers-backend-ts-sdk 0.0.762 → 0.0.764

package/src/models/PaginatedVenueListResourceResponse.ts

@@ -0,0 +1,90 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { PagingMetadata } from './PagingMetadata';
+import {
+    PagingMetadataFromJSON,
+    PagingMetadataFromJSONTyped,
+    PagingMetadataToJSON,
+    PagingMetadataToJSONTyped,
+} from './PagingMetadata';
+import type { VenueListResource } from './VenueListResource';
+import {
+    VenueListResourceFromJSON,
+    VenueListResourceFromJSONTyped,
+    VenueListResourceToJSON,
+    VenueListResourceToJSONTyped,
+} from './VenueListResource';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedVenueListResourceResponse
+ */
+export interface PaginatedVenueListResourceResponse {
+    /**
+     * 
+     * @type {Array<VenueListResource>}
+     * @memberof PaginatedVenueListResourceResponse
+     */
+    data: Array<VenueListResource>;
+    /**
+     * 
+     * @type {PagingMetadata}
+     * @memberof PaginatedVenueListResourceResponse
+     */
+    meta: PagingMetadata;
+}
+
+/**
+ * Check if a given object implements the PaginatedVenueListResourceResponse interface.
+ */
+export function instanceOfPaginatedVenueListResourceResponse(value: object): value is PaginatedVenueListResourceResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedVenueListResourceResponseFromJSON(json: any): PaginatedVenueListResourceResponse {
+    return PaginatedVenueListResourceResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedVenueListResourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedVenueListResourceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(VenueListResourceFromJSON)),
+        'meta': PagingMetadataFromJSON(json['meta']),
+    };
+}
+
+export function PaginatedVenueListResourceResponseToJSON(json: any): PaginatedVenueListResourceResponse {
+    return PaginatedVenueListResourceResponseToJSONTyped(json, false);
+}
+
+export function PaginatedVenueListResourceResponseToJSONTyped(value?: PaginatedVenueListResourceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(VenueListResourceToJSON)),
+        'meta': PagingMetadataToJSON(value['meta']),
+    };
+}
+

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;
+}
+

package/src/models/PdfExportKind.ts

@@ -0,0 +1,56 @@
+/* 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 PdfExportKind = {
+    Roster: 'roster',
+    IncidentSingle: 'incident_single',
+    IncidentBulk: 'incident_bulk',
+    IncidentCsvSingle: 'incident_csv_single',
+    IncidentCsvBulk: 'incident_csv_bulk'
+} as const;
+export type PdfExportKind = typeof PdfExportKind[keyof typeof PdfExportKind];
+
+
+export function instanceOfPdfExportKind(value: any): boolean {
+    for (const key in PdfExportKind) {
+        if (Object.prototype.hasOwnProperty.call(PdfExportKind, key)) {
+            if (PdfExportKind[key as keyof typeof PdfExportKind] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PdfExportKindFromJSON(json: any): PdfExportKind {
+    return PdfExportKindFromJSONTyped(json, false);
+}
+
+export function PdfExportKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): PdfExportKind {
+    return json as PdfExportKind;
+}
+
+export function PdfExportKindToJSON(value?: PdfExportKind | null): any {
+    return value as any;
+}
+
+export function PdfExportKindToJSONTyped(value: any, ignoreDiscriminator: boolean): PdfExportKind {
+    return value as PdfExportKind;
+}
+

package/src/models/PdfExportResource.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 { PdfExportStatus } from './PdfExportStatus';
+import {
+    PdfExportStatusFromJSON,
+    PdfExportStatusFromJSONTyped,
+    PdfExportStatusToJSON,
+    PdfExportStatusToJSONTyped,
+} from './PdfExportStatus';
+
 /**
  * 
  * @export
@@ -27,10 +35,10 @@ export interface PdfExportResource {
     id: number;
     /**
      * 
-     * @type {string}
+     * @type {PdfExportStatus}
      * @memberof PdfExportResource
      */
-    status: PdfExportResourceStatusEnum;
+    status: PdfExportStatus;
     /**
      * 
      * @type {string}
@@ -42,21 +50,10 @@ export interface PdfExportResource {
      * @type {string}
      * @memberof PdfExportResource
      */
-    downloadUrl: string;
+    downloadUrl?: string | null;
 }
 
 
-/**
- * @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.
@@ -64,7 +61,6 @@ export type PdfExportResourceStatusEnum = typeof PdfExportResourceStatusEnum[key
 export function instanceOfPdfExportResource(value: object): value is PdfExportResource {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
-    if (!('downloadUrl' in value) || value['downloadUrl'] === undefined) return false;
     return true;
 }
 
@@ -79,9 +75,9 @@ export function PdfExportResourceFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'id': json['id'],
-        'status': json['status'],
+        'status': PdfExportStatusFromJSON(json['status']),
         'errorMessage': json['errorMessage'] == null ? undefined : json['errorMessage'],
-        'downloadUrl': json['downloadUrl'],
+        'downloadUrl': json['downloadUrl'] == null ? undefined : json['downloadUrl'],
     };
 }
 
@@ -97,7 +93,7 @@ export function PdfExportResourceToJSONTyped(value?: PdfExportResource | null, i
     return {
         
         'id': value['id'],
-        'status': value['status'],
+        'status': PdfExportStatusToJSON(value['status']),
         'errorMessage': value['errorMessage'],
         'downloadUrl': value['downloadUrl'],
     };

package/src/models/PdfExportResourceArrayResponse.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/PdfExportStatus.ts

@@ -0,0 +1,55 @@
+/* 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 PdfExportStatus = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed'
+} as const;
+export type PdfExportStatus = typeof PdfExportStatus[keyof typeof PdfExportStatus];
+
+
+export function instanceOfPdfExportStatus(value: any): boolean {
+    for (const key in PdfExportStatus) {
+        if (Object.prototype.hasOwnProperty.call(PdfExportStatus, key)) {
+            if (PdfExportStatus[key as keyof typeof PdfExportStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PdfExportStatusFromJSON(json: any): PdfExportStatus {
+    return PdfExportStatusFromJSONTyped(json, false);
+}
+
+export function PdfExportStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PdfExportStatus {
+    return json as PdfExportStatus;
+}
+
+export function PdfExportStatusToJSON(value?: PdfExportStatus | null): any {
+    return value as any;
+}
+
+export function PdfExportStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PdfExportStatus {
+    return value as PdfExportStatus;
+}
+

package/src/models/RecordSource.ts

@@ -0,0 +1,56 @@
+/* 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 RecordSource = {
+    Mobile: 'mobile',
+    Web: 'web',
+    Manual: 'manual',
+    Guardhouse: 'guardhouse',
+    Legacy: 'legacy'
+} as const;
+export type RecordSource = typeof RecordSource[keyof typeof RecordSource];
+
+
+export function instanceOfRecordSource(value: any): boolean {
+    for (const key in RecordSource) {
+        if (Object.prototype.hasOwnProperty.call(RecordSource, key)) {
+            if (RecordSource[key as keyof typeof RecordSource] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function RecordSourceFromJSON(json: any): RecordSource {
+    return RecordSourceFromJSONTyped(json, false);
+}
+
+export function RecordSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecordSource {
+    return json as RecordSource;
+}
+
+export function RecordSourceToJSON(value?: RecordSource | null): any {
+    return value as any;
+}
+
+export function RecordSourceToJSONTyped(value: any, ignoreDiscriminator: boolean): RecordSource {
+    return value as RecordSource;
+}
+

package/src/models/RegisterGroupedByRosterResource.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/RegisterGroupedByRosterResourceArrayResponse.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/RegisterListResource.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 {
     UserLiteResourceToJSON,
     UserLiteResourceToJSONTyped,
 } from './UserLiteResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -72,10 +79,10 @@ export interface RegisterListResource {
     shiftLength: object;
     /**
      * 
-     * @type {number}
+     * @type {SignOffStatus}
      * @memberof RegisterListResource
      */
-    signOffStatus: RegisterListResourceSignOffStatusEnum;
+    signOffStatus: SignOffStatus;
     /**
      * 
      * @type {string}
@@ -187,16 +194,6 @@ export interface RegisterListResource {
 }
 
 
-/**
- * @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.
@@ -240,7 +237,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'startDateTime': (new Date(json['startDateTime'])),
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'shiftLength': json['shiftLength'],
-        'signOffStatus': json['signOffStatus'],
+        'signOffStatus': SignOffStatusFromJSON(json['signOffStatus']),
         'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'rampReadAt': json['rampReadAt'] == null ? undefined : (new Date(json['rampReadAt'])),
         'licenceNumber': json['licenceNumber'],
@@ -279,7 +276,7 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
         'startDateTime': ((value['startDateTime']).toISOString()),
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'shiftLength': value['shiftLength'],
-        'signOffStatus': value['signOffStatus'],
+        'signOffStatus': SignOffStatusToJSON(value['signOffStatus']),
         'badgeNumber': value['badgeNumber'],
         'rampReadAt': value['rampReadAt'] === null ? null : ((value['rampReadAt'] as any)?.toISOString()),
         'licenceNumber': value['licenceNumber'],

package/src/models/RegisterListResourceArrayResponse.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/RegisterLiteResource.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/RegisterLiteResourceArrayResponse.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/RegisterResource.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 {
     UserLiteResourceToJSON,
     UserLiteResourceToJSONTyped,
 } from './UserLiteResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -66,10 +73,10 @@ export interface RegisterResource {
     finishDateTime?: Date | null;
     /**
      * 
-     * @type {number}
+     * @type {SignOffStatus}
      * @memberof RegisterResource
      */
-    signOffStatus: RegisterResourceSignOffStatusEnum;
+    signOffStatus: SignOffStatus;
     /**
      * 
      * @type {object}
@@ -187,16 +194,6 @@ export interface RegisterResource {
 }
 
 
-/**
- * @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.
@@ -237,7 +234,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'user': UserLiteResourceFromJSON(json['user']),
         'startDateTime': (new Date(json['startDateTime'])),
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
-        'signOffStatus': json['signOffStatus'],
+        'signOffStatus': SignOffStatusFromJSON(json['signOffStatus']),
         'signOnSignature': json['signOnSignature'],
         'signOffSignature': json['signOffSignature'],
         'rampReadSignature': json['rampReadSignature'],
@@ -276,7 +273,7 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
         'user': UserLiteResourceToJSON(value['user']),
         'startDateTime': ((value['startDateTime']).toISOString()),
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
-        'signOffStatus': value['signOffStatus'],
+        'signOffStatus': SignOffStatusToJSON(value['signOffStatus']),
         'signOnSignature': value['signOnSignature'],
         'signOffSignature': value['signOffSignature'],
         'rampReadSignature': value['rampReadSignature'],

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