@digital8/security-registers-backend-ts-sdk 0.0.752 → 0.0.754

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
  * 
@@ -20,13 +20,6 @@ import {
     VenueLiteResourceToJSON,
     VenueLiteResourceToJSONTyped,
 } from './VenueLiteResource';
-import type { SecurityCompanyLiteResource } from './SecurityCompanyLiteResource';
-import {
-    SecurityCompanyLiteResourceFromJSON,
-    SecurityCompanyLiteResourceFromJSONTyped,
-    SecurityCompanyLiteResourceToJSON,
-    SecurityCompanyLiteResourceToJSONTyped,
-} from './SecurityCompanyLiteResource';
 import type { RegisterListResource } from './RegisterListResource';
 import {
     RegisterListResourceFromJSON,
@@ -34,6 +27,20 @@ import {
     RegisterListResourceToJSON,
     RegisterListResourceToJSONTyped,
 } from './RegisterListResource';
+import type { SecurityCompanyListResource } from './SecurityCompanyListResource';
+import {
+    SecurityCompanyListResourceFromJSON,
+    SecurityCompanyListResourceFromJSONTyped,
+    SecurityCompanyListResourceToJSON,
+    SecurityCompanyListResourceToJSONTyped,
+} from './SecurityCompanyListResource';
+import type { SignOffStatus } from './SignOffStatus';
+import {
+    SignOffStatusFromJSON,
+    SignOffStatusFromJSONTyped,
+    SignOffStatusToJSON,
+    SignOffStatusToJSONTyped,
+} from './SignOffStatus';
 
 /**
  * 
@@ -61,10 +68,10 @@ export interface RosterWithRegistersResource {
     state: object;
     /**
      * 
-     * @type {SecurityCompanyLiteResource}
+     * @type {SecurityCompanyListResource}
      * @memberof RosterWithRegistersResource
      */
-    securityCompany: SecurityCompanyLiteResource | null;
+    securityCompany: SecurityCompanyListResource | null;
     /**
      * 
      * @type {Date}
@@ -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.
@@ -143,12 +140,12 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
         'id': json['id'] == null ? undefined : json['id'],
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'state': json['state'],
-        'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
+        'securityCompany': SecurityCompanyListResourceFromJSON(json['securityCompany']),
         'startDateTime': (new Date(json['startDateTime'])),
         '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)),
     };
 }
@@ -167,12 +164,12 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
         'id': value['id'],
         'venue': VenueLiteResourceToJSON(value['venue']),
         'state': value['state'],
-        'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
+        'securityCompany': SecurityCompanyListResourceToJSON(value['securityCompany']),
         'startDateTime': ((value['startDateTime']).toISOString()),
         '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/SecurityCompanyListResource.ts

@@ -0,0 +1,117 @@
+/* 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 { AddressResource } from './AddressResource';
+import {
+    AddressResourceFromJSON,
+    AddressResourceFromJSONTyped,
+    AddressResourceToJSON,
+    AddressResourceToJSONTyped,
+} from './AddressResource';
+
+/**
+ * 
+ * @export
+ * @interface SecurityCompanyListResource
+ */
+export interface SecurityCompanyListResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof SecurityCompanyListResource
+     */
+    id?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityCompanyListResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityCompanyListResource
+     */
+    email?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SecurityCompanyListResource
+     */
+    isEnabled: boolean;
+    /**
+     * 
+     * @type {AddressResource}
+     * @memberof SecurityCompanyListResource
+     */
+    address: AddressResource | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SecurityCompanyListResource
+     */
+    licenceNumber: string;
+}
+
+/**
+ * Check if a given object implements the SecurityCompanyListResource interface.
+ */
+export function instanceOfSecurityCompanyListResource(value: object): value is SecurityCompanyListResource {
+    if (!('name' in value) || value['name'] === 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;
+    return true;
+}
+
+export function SecurityCompanyListResourceFromJSON(json: any): SecurityCompanyListResource {
+    return SecurityCompanyListResourceFromJSONTyped(json, false);
+}
+
+export function SecurityCompanyListResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecurityCompanyListResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'isEnabled': json['isEnabled'],
+        'address': AddressResourceFromJSON(json['address']),
+        'licenceNumber': json['licenceNumber'],
+    };
+}
+
+export function SecurityCompanyListResourceToJSON(json: any): SecurityCompanyListResource {
+    return SecurityCompanyListResourceToJSONTyped(json, false);
+}
+
+export function SecurityCompanyListResourceToJSONTyped(value?: SecurityCompanyListResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'email': value['email'],
+        'isEnabled': value['isEnabled'],
+        'address': AddressResourceToJSON(value['address']),
+        'licenceNumber': value['licenceNumber'],
+    };
+}
+

package/src/models/SecurityCompanyListResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* 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 { SecurityCompanyListResource } from './SecurityCompanyListResource';
+import {
+    SecurityCompanyListResourceFromJSON,
+    SecurityCompanyListResourceFromJSONTyped,
+    SecurityCompanyListResourceToJSON,
+    SecurityCompanyListResourceToJSONTyped,
+} from './SecurityCompanyListResource';
+
+/**
+ * 
+ * @export
+ * @interface SecurityCompanyListResourceArrayResponse
+ */
+export interface SecurityCompanyListResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<SecurityCompanyListResource>}
+     * @memberof SecurityCompanyListResourceArrayResponse
+     */
+    data?: Array<SecurityCompanyListResource>;
+}
+
+/**
+ * Check if a given object implements the SecurityCompanyListResourceArrayResponse interface.
+ */
+export function instanceOfSecurityCompanyListResourceArrayResponse(value: object): value is SecurityCompanyListResourceArrayResponse {
+    return true;
+}
+
+export function SecurityCompanyListResourceArrayResponseFromJSON(json: any): SecurityCompanyListResourceArrayResponse {
+    return SecurityCompanyListResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function SecurityCompanyListResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecurityCompanyListResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(SecurityCompanyListResourceFromJSON)),
+    };
+}
+
+export function SecurityCompanyListResourceArrayResponseToJSON(json: any): SecurityCompanyListResourceArrayResponse {
+    return SecurityCompanyListResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function SecurityCompanyListResourceArrayResponseToJSONTyped(value?: SecurityCompanyListResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(SecurityCompanyListResourceToJSON)),
+    };
+}
+

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
  * 

package/src/models/SignOffStatus.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 SignOffStatus = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+} as const;
+export type SignOffStatus = typeof SignOffStatus[keyof typeof SignOffStatus];
+
+
+export function instanceOfSignOffStatus(value: any): boolean {
+    for (const key in SignOffStatus) {
+        if (Object.prototype.hasOwnProperty.call(SignOffStatus, key)) {
+            if (SignOffStatus[key as keyof typeof SignOffStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SignOffStatusFromJSON(json: any): SignOffStatus {
+    return SignOffStatusFromJSONTyped(json, false);
+}
+
+export function SignOffStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignOffStatus {
+    return json as SignOffStatus;
+}
+
+export function SignOffStatusToJSON(value?: SignOffStatus | null): any {
+    return value as any;
+}
+
+export function SignOffStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): SignOffStatus {
+    return value as SignOffStatus;
+}
+

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