@digital8/security-registers-backend-ts-sdk 0.0.781 → 0.0.783

package/src/models/ApiLogsListRequest.ts

@@ -0,0 +1,204 @@
+/* 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 { WebhookEndpoint } from './WebhookEndpoint';
+import {
+    WebhookEndpointFromJSON,
+    WebhookEndpointFromJSONTyped,
+    WebhookEndpointToJSON,
+    WebhookEndpointToJSONTyped,
+} from './WebhookEndpoint';
+
+/**
+ * 
+ * @export
+ * @interface ApiLogsListRequest
+ */
+export interface ApiLogsListRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiLogsListRequest
+     */
+    search?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiLogsListRequest
+     */
+    sortBy?: ApiLogsListRequestSortByEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiLogsListRequest
+     */
+    sortDirection?: ApiLogsListRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiLogsListRequest
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiLogsListRequest
+     */
+    page?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ApiLogsListRequest
+     */
+    venueId?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ApiLogsListRequest
+     */
+    guardId?: Array<string>;
+    /**
+     * 
+     * @type {Array<WebhookEndpoint>}
+     * @memberof ApiLogsListRequest
+     */
+    path?: Array<WebhookEndpoint>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ApiLogsListRequest
+     */
+    statusCode?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ApiLogsListRequest
+     */
+    isSuccessful?: Array<string>;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiLogsListRequest
+     */
+    beforeReceivedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiLogsListRequest
+     */
+    afterReceivedAt?: Date;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiLogsListRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiLogsListRequest
+     */
+    relatedType?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ApiLogsListRequest
+     */
+    includesRelations?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ApiLogsListRequestSortByEnum = {
+    ReceivedAt: 'received_at'
+} as const;
+export type ApiLogsListRequestSortByEnum = typeof ApiLogsListRequestSortByEnum[keyof typeof ApiLogsListRequestSortByEnum];
+
+/**
+ * @export
+ */
+export const ApiLogsListRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type ApiLogsListRequestSortDirectionEnum = typeof ApiLogsListRequestSortDirectionEnum[keyof typeof ApiLogsListRequestSortDirectionEnum];
+
+
+/**
+ * Check if a given object implements the ApiLogsListRequest interface.
+ */
+export function instanceOfApiLogsListRequest(value: object): value is ApiLogsListRequest {
+    return true;
+}
+
+export function ApiLogsListRequestFromJSON(json: any): ApiLogsListRequest {
+    return ApiLogsListRequestFromJSONTyped(json, false);
+}
+
+export function ApiLogsListRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiLogsListRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'search': json['search'] == null ? undefined : json['search'],
+        'sortBy': json['sort_by'] == null ? undefined : json['sort_by'],
+        'sortDirection': json['sort_direction'] == null ? undefined : json['sort_direction'],
+        'perPage': json['per_page'] == null ? undefined : json['per_page'],
+        'page': json['page'] == null ? undefined : json['page'],
+        'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
+        'guardId': json['guard_id'] == null ? undefined : json['guard_id'],
+        'path': json['path'] == null ? undefined : ((json['path'] as Array<any>).map(WebhookEndpointFromJSON)),
+        'statusCode': json['status_code'] == null ? undefined : json['status_code'],
+        'isSuccessful': json['is_successful'] == null ? undefined : json['is_successful'],
+        'beforeReceivedAt': json['before_received_at'] == null ? undefined : (new Date(json['before_received_at'])),
+        'afterReceivedAt': json['after_received_at'] == null ? undefined : (new Date(json['after_received_at'])),
+        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
+        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
+        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
+    };
+}
+
+export function ApiLogsListRequestToJSON(json: any): ApiLogsListRequest {
+    return ApiLogsListRequestToJSONTyped(json, false);
+}
+
+export function ApiLogsListRequestToJSONTyped(value?: ApiLogsListRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'search': value['search'],
+        'sort_by': value['sortBy'],
+        'sort_direction': value['sortDirection'],
+        'per_page': value['perPage'],
+        'page': value['page'],
+        'venue_id': value['venueId'],
+        'guard_id': value['guardId'],
+        'path': value['path'] == null ? undefined : ((value['path'] as Array<any>).map(WebhookEndpointToJSON)),
+        'status_code': value['statusCode'],
+        'is_successful': value['isSuccessful'],
+        'before_received_at': value['beforeReceivedAt'] == null ? undefined : ((value['beforeReceivedAt']).toISOString()),
+        'after_received_at': value['afterReceivedAt'] == null ? undefined : ((value['afterReceivedAt']).toISOString()),
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
+    };
+}
+

package/src/models/AssetFileForUploadResource.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/AssetFileForUploadResourceArrayResponse.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/AssetLiteResource.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/AssetLiteResourceArrayResponse.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/AssetResource.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/AssetResourceArrayResponse.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/AssetsFileStoreRequest.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface AssetsFileStoreRequest
+ */
+export interface AssetsFileStoreRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetsFileStoreRequest
+     */
+    fileName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AssetsFileStoreRequest
+     */
+    fileType: string;
+}
+
+/**
+ * Check if a given object implements the AssetsFileStoreRequest interface.
+ */
+export function instanceOfAssetsFileStoreRequest(value: object): value is AssetsFileStoreRequest {
+    if (!('fileName' in value) || value['fileName'] === undefined) return false;
+    if (!('fileType' in value) || value['fileType'] === undefined) return false;
+    return true;
+}
+
+export function AssetsFileStoreRequestFromJSON(json: any): AssetsFileStoreRequest {
+    return AssetsFileStoreRequestFromJSONTyped(json, false);
+}
+
+export function AssetsFileStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssetsFileStoreRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fileName': json['file_name'],
+        'fileType': json['file_type'],
+    };
+}
+
+export function AssetsFileStoreRequestToJSON(json: any): AssetsFileStoreRequest {
+    return AssetsFileStoreRequestToJSONTyped(json, false);
+}
+
+export function AssetsFileStoreRequestToJSONTyped(value?: AssetsFileStoreRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'file_name': value['fileName'],
+        'file_type': value['fileType'],
+    };
+}
+

package/src/models/AustralianState.ts

@@ -0,0 +1,59 @@
+/* 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 AustralianState = {
+    Qld: 'QLD',
+    Nsw: 'NSW',
+    Act: 'ACT',
+    Vic: 'VIC',
+    Tas: 'TAS',
+    Sa: 'SA',
+    Wa: 'WA',
+    Nt: 'NT'
+} as const;
+export type AustralianState = typeof AustralianState[keyof typeof AustralianState];
+
+
+export function instanceOfAustralianState(value: any): boolean {
+    for (const key in AustralianState) {
+        if (Object.prototype.hasOwnProperty.call(AustralianState, key)) {
+            if (AustralianState[key as keyof typeof AustralianState] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AustralianStateFromJSON(json: any): AustralianState {
+    return AustralianStateFromJSONTyped(json, false);
+}
+
+export function AustralianStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AustralianState {
+    return json as AustralianState;
+}
+
+export function AustralianStateToJSON(value?: AustralianState | null): any {
+    return value as any;
+}
+
+export function AustralianStateToJSONTyped(value: any, ignoreDiscriminator: boolean): AustralianState {
+    return value as AustralianState;
+}
+

package/src/models/AuthChangePasswordRequest.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/AuthForgotPasswordRequest.ts

@@ -0,0 +1,66 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface AuthForgotPasswordRequest
+ */
+export interface AuthForgotPasswordRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AuthForgotPasswordRequest
+     */
+    email: string;
+}
+
+/**
+ * Check if a given object implements the AuthForgotPasswordRequest interface.
+ */
+export function instanceOfAuthForgotPasswordRequest(value: object): value is AuthForgotPasswordRequest {
+    if (!('email' in value) || value['email'] === undefined) return false;
+    return true;
+}
+
+export function AuthForgotPasswordRequestFromJSON(json: any): AuthForgotPasswordRequest {
+    return AuthForgotPasswordRequestFromJSONTyped(json, false);
+}
+
+export function AuthForgotPasswordRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthForgotPasswordRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'email': json['email'],
+    };
+}
+
+export function AuthForgotPasswordRequestToJSON(json: any): AuthForgotPasswordRequest {
+    return AuthForgotPasswordRequestToJSONTyped(json, false);
+}
+
+export function AuthForgotPasswordRequestToJSONTyped(value?: AuthForgotPasswordRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'email': value['email'],
+    };
+}
+

package/src/models/AuthLoginWebRequest.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/AuthProfileUpdateRequest.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/AuthProfileUpdateRequestSignature.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/AuthRegisterGuardFileRequest.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/AuthRegisterGuardRequest.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/AuthRegisterGuardRequestLicencesInner.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 {
     BackAssetToJSON,
     BackAssetToJSONTyped,
 } from './BackAsset';
+import type { LicenceState } from './LicenceState';
+import {
+    LicenceStateFromJSON,
+    LicenceStateFromJSONTyped,
+    LicenceStateToJSON,
+    LicenceStateToJSONTyped,
+} from './LicenceState';
 import type { FrontAsset } from './FrontAsset';
 import {
     FrontAssetFromJSON,
@@ -50,10 +57,10 @@ import {
 export interface AuthRegisterGuardRequestLicencesInner {
     /**
      * 
-     * @type {string}
+     * @type {LicenceState}
      * @memberof AuthRegisterGuardRequestLicencesInner
      */
-    state: AuthRegisterGuardRequestLicencesInnerStateEnum;
+    state: LicenceState;
     /**
      * 
      * @type {string}
@@ -105,16 +112,6 @@ export interface AuthRegisterGuardRequestLicencesInner {
 }
 
 
-/**
- * @export
- */
-export const AuthRegisterGuardRequestLicencesInnerStateEnum = {
-    Qld: 'QLD',
-    Nsw: 'NSW',
-    Vic: 'VIC'
-} as const;
-export type AuthRegisterGuardRequestLicencesInnerStateEnum = typeof AuthRegisterGuardRequestLicencesInnerStateEnum[keyof typeof AuthRegisterGuardRequestLicencesInnerStateEnum];
-
 
 /**
  * Check if a given object implements the AuthRegisterGuardRequestLicencesInner interface.
@@ -139,7 +136,7 @@ export function AuthRegisterGuardRequestLicencesInnerFromJSONTyped(json: any, ig
     }
     return {
         
-        'state': json['state'],
+        'state': LicenceStateFromJSON(json['state']),
         'licenceNumber': json['licence_number'],
         'firstName': json['first_name'],
         'lastName': json['last_name'],
@@ -162,7 +159,7 @@ export function AuthRegisterGuardRequestLicencesInnerToJSONTyped(value?: AuthReg
 
     return {
         
-        'state': value['state'],
+        'state': LicenceStateToJSON(value['state']),
         'licence_number': value['licenceNumber'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],

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