@digital8/security-registers-backend-ts-sdk 0.0.207 → 0.0.209

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/security-registers-backend-ts-sdk",
-  "version": "0.0.207",
+  "version": "0.0.209",
   "description": "OpenAPI client for @digital8/security-registers-backend-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/GeneralApi.ts

@@ -21,6 +21,7 @@ import type {
   IncidentFieldSchemasShowRequest,
   IncidentResource,
   IncidentsStoreRequest,
+  IncidentsUpdateRequest,
   IndexMinimalUserRequest,
   IndexUserRequest,
   LicenceLiteResourceArrayResponse,
@@ -100,6 +101,8 @@ import {
     IncidentResourceToJSON,
     IncidentsStoreRequestFromJSON,
     IncidentsStoreRequestToJSON,
+    IncidentsUpdateRequestFromJSON,
+    IncidentsUpdateRequestToJSON,
     IndexMinimalUserRequestFromJSON,
     IndexMinimalUserRequestToJSON,
     IndexUserRequestFromJSON,
@@ -240,10 +243,32 @@ export interface IncidentFieldSchemasShowOperationRequest {
     incidentFieldSchemasShowRequest?: IncidentFieldSchemasShowRequest;
 }
 
+export interface IncidentsApproveRequest {
+    incident: number;
+}
+
 export interface IncidentsStoreOperationRequest {
     incidentsStoreRequest?: IncidentsStoreRequest;
 }
 
+export interface IncidentsUnapproveRequest {
+    incident: number;
+}
+
+export interface IncidentsUpdateOperationRequest {
+    incident: number;
+    incidentsUpdateRequest?: IncidentsUpdateRequest;
+}
+
+export interface IncidentsVersionsRequest {
+    incident: number;
+}
+
+export interface IncidentsVersionsShowRequest {
+    incident: number;
+    version: number;
+}
+
 export interface IndexMinimalUserOperationRequest {
     indexMinimalUserRequest?: IndexMinimalUserRequest;
 }
@@ -617,6 +642,51 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: incidents.approve
+     */
+    async incidentsApproveRaw(requestParameters: IncidentsApproveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsApprove().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/approve`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IncidentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.approve
+     */
+    async incidentsApprove(requestParameters: IncidentsApproveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource> {
+        const response = await this.incidentsApproveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: incidents.store
      */
@@ -657,6 +727,197 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: incidents.unapprove
+     */
+    async incidentsUnapproveRaw(requestParameters: IncidentsUnapproveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsUnapprove().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/unapprove`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IncidentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.unapprove
+     */
+    async incidentsUnapprove(requestParameters: IncidentsUnapproveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource> {
+        const response = await this.incidentsUnapproveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: incidents.update
+     */
+    async incidentsUpdateRaw(requestParameters: IncidentsUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsUpdate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/update`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IncidentsUpdateRequestToJSON(requestParameters['incidentsUpdateRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IncidentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.update
+     */
+    async incidentsUpdate(requestParameters: IncidentsUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource> {
+        const response = await this.incidentsUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: incidents.versions
+     */
+    async incidentsVersionsRaw(requestParameters: IncidentsVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsVersions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/versions`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.versions
+     */
+    async incidentsVersions(requestParameters: IncidentsVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.incidentsVersionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: incidents.versions.show
+     */
+    async incidentsVersionsShowRaw(requestParameters: IncidentsVersionsShowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsVersionsShow().'
+            );
+        }
+
+        if (requestParameters['version'] == null) {
+            throw new runtime.RequiredError(
+                'version',
+                'Required parameter "version" was null or undefined when calling incidentsVersionsShow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/versions/{version}`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+        urlPath = urlPath.replace(`{${"version"}}`, encodeURIComponent(String(requestParameters['version'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.versions.show
+     */
+    async incidentsVersionsShow(requestParameters: IncidentsVersionsShowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.incidentsVersionsShowRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: indexMinimalUser
      */

package/src/models/IncidentFieldAuditResource.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * 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 IncidentFieldAuditResource
+ */
+export interface IncidentFieldAuditResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentFieldAuditResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentFieldAuditResource
+     */
+    sectionKey: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentFieldAuditResource
+     */
+    fieldKey: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentFieldAuditResource
+     */
+    previousValue: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof IncidentFieldAuditResource
+     */
+    changedAt: object;
+}
+
+/**
+ * Check if a given object implements the IncidentFieldAuditResource interface.
+ */
+export function instanceOfIncidentFieldAuditResource(value: object): value is IncidentFieldAuditResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('sectionKey' in value) || value['sectionKey'] === undefined) return false;
+    if (!('fieldKey' in value) || value['fieldKey'] === undefined) return false;
+    if (!('previousValue' in value) || value['previousValue'] === undefined) return false;
+    if (!('changedAt' in value) || value['changedAt'] === undefined) return false;
+    return true;
+}
+
+export function IncidentFieldAuditResourceFromJSON(json: any): IncidentFieldAuditResource {
+    return IncidentFieldAuditResourceFromJSONTyped(json, false);
+}
+
+export function IncidentFieldAuditResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentFieldAuditResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'sectionKey': json['sectionKey'],
+        'fieldKey': json['fieldKey'],
+        'previousValue': json['previousValue'],
+        'changedAt': json['changedAt'],
+    };
+}
+
+export function IncidentFieldAuditResourceToJSON(json: any): IncidentFieldAuditResource {
+    return IncidentFieldAuditResourceToJSONTyped(json, false);
+}
+
+export function IncidentFieldAuditResourceToJSONTyped(value?: IncidentFieldAuditResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'sectionKey': value['sectionKey'],
+        'fieldKey': value['fieldKey'],
+        'previousValue': value['previousValue'],
+        'changedAt': value['changedAt'],
+    };
+}
+

package/src/models/IncidentFieldAuditResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * 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 { IncidentFieldAuditResource } from './IncidentFieldAuditResource';
+import {
+    IncidentFieldAuditResourceFromJSON,
+    IncidentFieldAuditResourceFromJSONTyped,
+    IncidentFieldAuditResourceToJSON,
+    IncidentFieldAuditResourceToJSONTyped,
+} from './IncidentFieldAuditResource';
+
+/**
+ * 
+ * @export
+ * @interface IncidentFieldAuditResourceArrayResponse
+ */
+export interface IncidentFieldAuditResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<IncidentFieldAuditResource>}
+     * @memberof IncidentFieldAuditResourceArrayResponse
+     */
+    data?: Array<IncidentFieldAuditResource>;
+}
+
+/**
+ * Check if a given object implements the IncidentFieldAuditResourceArrayResponse interface.
+ */
+export function instanceOfIncidentFieldAuditResourceArrayResponse(value: object): value is IncidentFieldAuditResourceArrayResponse {
+    return true;
+}
+
+export function IncidentFieldAuditResourceArrayResponseFromJSON(json: any): IncidentFieldAuditResourceArrayResponse {
+    return IncidentFieldAuditResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function IncidentFieldAuditResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentFieldAuditResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(IncidentFieldAuditResourceFromJSON)),
+    };
+}
+
+export function IncidentFieldAuditResourceArrayResponseToJSON(json: any): IncidentFieldAuditResourceArrayResponse {
+    return IncidentFieldAuditResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function IncidentFieldAuditResourceArrayResponseToJSONTyped(value?: IncidentFieldAuditResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(IncidentFieldAuditResourceToJSON)),
+    };
+}
+

package/src/models/IncidentResource.ts

@@ -34,6 +34,13 @@ import {
     RosterLiteResourceToJSON,
     RosterLiteResourceToJSONTyped,
 } from './RosterLiteResource';
+import type { IncidentFieldAuditResource } from './IncidentFieldAuditResource';
+import {
+    IncidentFieldAuditResourceFromJSON,
+    IncidentFieldAuditResourceFromJSONTyped,
+    IncidentFieldAuditResourceToJSON,
+    IncidentFieldAuditResourceToJSONTyped,
+} from './IncidentFieldAuditResource';
 import type { SecurityCompanyLiteResource } from './SecurityCompanyLiteResource';
 import {
     SecurityCompanyLiteResourceFromJSON,
@@ -134,6 +141,12 @@ export interface IncidentResource {
      * @memberof IncidentResource
      */
     fields: object;
+    /**
+     * 
+     * @type {Array<IncidentFieldAuditResource>}
+     * @memberof IncidentResource
+     */
+    fieldAudits: Array<IncidentFieldAuditResource> | null;
 }
 
 /**
@@ -149,6 +162,7 @@ export function instanceOfIncidentResource(value: object): value is IncidentReso
     if (!('approvedByUser' in value) || value['approvedByUser'] === undefined) return false;
     if (!('incidentFieldSchema' in value) || value['incidentFieldSchema'] === undefined) return false;
     if (!('fields' in value) || value['fields'] === undefined) return false;
+    if (!('fieldAudits' in value) || value['fieldAudits'] === undefined) return false;
     return true;
 }
 
@@ -174,6 +188,7 @@ export function IncidentResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
         'fields': json['fields'],
+        'fieldAudits': (json['fieldAudits'] == null ? null : (json['fieldAudits'] as Array<any>).map(IncidentFieldAuditResourceFromJSON)),
     };
 }
 
@@ -200,6 +215,7 @@ export function IncidentResourceToJSONTyped(value?: IncidentResource | null, ign
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
         'updatedAt': value['updatedAt'] === null ? null : ((value['updatedAt'] as any)?.toISOString()),
         'fields': value['fields'],
+        'fieldAudits': (value['fieldAudits'] == null ? null : (value['fieldAudits'] as Array<any>).map(IncidentFieldAuditResourceToJSON)),
     };
 }
 

package/src/models/IncidentVersionResource.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * 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 { UserLiteResource } from './UserLiteResource';
+import {
+    UserLiteResourceFromJSON,
+    UserLiteResourceFromJSONTyped,
+    UserLiteResourceToJSON,
+    UserLiteResourceToJSONTyped,
+} from './UserLiteResource';
+
+/**
+ * 
+ * @export
+ * @interface IncidentVersionResource
+ */
+export interface IncidentVersionResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentVersionResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentVersionResource
+     */
+    incidentId?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentVersionResource
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentVersionResource
+     */
+    userId?: number | null;
+    /**
+     * 
+     * @type {UserLiteResource}
+     * @memberof IncidentVersionResource
+     */
+    user: UserLiteResource | null;
+    /**
+     * 
+     * @type {Array<boolean>}
+     * @memberof IncidentVersionResource
+     */
+    fieldData: Array<boolean>;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IncidentVersionResource
+     */
+    createdAt: Date;
+}
+
+/**
+ * Check if a given object implements the IncidentVersionResource interface.
+ */
+export function instanceOfIncidentVersionResource(value: object): value is IncidentVersionResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('user' in value) || value['user'] === undefined) return false;
+    if (!('fieldData' in value) || value['fieldData'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function IncidentVersionResourceFromJSON(json: any): IncidentVersionResource {
+    return IncidentVersionResourceFromJSONTyped(json, false);
+}
+
+export function IncidentVersionResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentVersionResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'incidentId': json['incidentId'] == null ? undefined : json['incidentId'],
+        'versionNumber': json['versionNumber'],
+        'userId': json['userId'] == null ? undefined : json['userId'],
+        'user': UserLiteResourceFromJSON(json['user']),
+        'fieldData': json['fieldData'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+
+export function IncidentVersionResourceToJSON(json: any): IncidentVersionResource {
+    return IncidentVersionResourceToJSONTyped(json, false);
+}
+
+export function IncidentVersionResourceToJSONTyped(value?: IncidentVersionResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'incidentId': value['incidentId'],
+        'versionNumber': value['versionNumber'],
+        'userId': value['userId'],
+        'user': UserLiteResourceToJSON(value['user']),
+        'fieldData': value['fieldData'],
+        'createdAt': ((value['createdAt']).toISOString()),
+    };
+}
+