@digital8/security-registers-backend-ts-sdk 0.0.282 → 0.0.284

package/src/apis/GeneralApi.ts

@@ -26,7 +26,7 @@ import type {
   IncidentVideoSignedUrlResource,
   IncidentVideoUploadTokenResource,
   IncidentsApproveRequest,
-  IncidentsExportPdfBulkRequest,
+  IncidentsListRequest,
   IncidentsStoreRequest,
   IncidentsUpdateRequest,
   IncidentsVideosStoreRequest,
@@ -45,6 +45,7 @@ import type {
   NotificationPreferenceResourceArrayResponse,
   NotificationPreferencesStoreRequest,
   NotificationTypeResourceArrayResponse,
+  PaginatedIncidentListResourceResponse,
   PaginatedLicenceListResourceResponse,
   PaginatedRegisterGroupedByRosterResourceResponse,
   PaginatedRosterListResourceResponse,
@@ -52,7 +53,6 @@ import type {
   PaginatedSecurityCompanyResourceResponse,
   PaginatedUserResourceResponse,
   PaginatedVenueResourceResponse,
-  PdfExportQueuedResource,
   PdfExportResource,
   RegisterLiteResourceArrayResponse,
   RegisterResource,
@@ -122,8 +122,8 @@ import {
     IncidentVideoUploadTokenResourceToJSON,
     IncidentsApproveRequestFromJSON,
     IncidentsApproveRequestToJSON,
-    IncidentsExportPdfBulkRequestFromJSON,
-    IncidentsExportPdfBulkRequestToJSON,
+    IncidentsListRequestFromJSON,
+    IncidentsListRequestToJSON,
     IncidentsStoreRequestFromJSON,
     IncidentsStoreRequestToJSON,
     IncidentsUpdateRequestFromJSON,
@@ -160,6 +160,8 @@ import {
     NotificationPreferencesStoreRequestToJSON,
     NotificationTypeResourceArrayResponseFromJSON,
     NotificationTypeResourceArrayResponseToJSON,
+    PaginatedIncidentListResourceResponseFromJSON,
+    PaginatedIncidentListResourceResponseToJSON,
     PaginatedLicenceListResourceResponseFromJSON,
     PaginatedLicenceListResourceResponseToJSON,
     PaginatedRegisterGroupedByRosterResourceResponseFromJSON,
@@ -174,8 +176,6 @@ import {
     PaginatedUserResourceResponseToJSON,
     PaginatedVenueResourceResponseFromJSON,
     PaginatedVenueResourceResponseToJSON,
-    PdfExportQueuedResourceFromJSON,
-    PdfExportQueuedResourceToJSON,
     PdfExportResourceFromJSON,
     PdfExportResourceToJSON,
     RegisterLiteResourceArrayResponseFromJSON,
@@ -281,20 +281,8 @@ export interface IncidentsApproveOperationRequest {
     incidentsApproveRequest?: IncidentsApproveRequest;
 }
 
-export interface IncidentsExportPdfRequest {
-    incident: number;
-}
-
-export interface IncidentsExportPdfBulkOperationRequest {
-    incidentsExportPdfBulkRequest?: IncidentsExportPdfBulkRequest;
-}
-
-export interface IncidentsExportPdfDownloadRequest {
-    pdfExport: number;
-}
-
-export interface IncidentsExportPdfStatusRequest {
-    pdfExport: number;
+export interface IncidentsListOperationRequest {
+    incidentsListRequest?: IncidentsListRequest;
 }
 
 export interface IncidentsShowRequest {
@@ -774,54 +762,9 @@ export class GeneralApi extends runtime.BaseAPI {
     }
 
     /**
-     * Auto-generated: incidents.exportPdf
+     * Auto-generated: incidents.list
      */
-    async incidentsExportPdfRaw(requestParameters: IncidentsExportPdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PdfExportQueuedResource>> {
-        if (requestParameters['incident'] == null) {
-            throw new runtime.RequiredError(
-                'incident',
-                'Required parameter "incident" was null or undefined when calling incidentsExportPdf().'
-            );
-        }
-
-        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}/export-pdf`;
-        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) => PdfExportQueuedResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf
-     */
-    async incidentsExportPdf(requestParameters: IncidentsExportPdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PdfExportQueuedResource> {
-        const response = await this.incidentsExportPdfRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf.bulk
-     */
-    async incidentsExportPdfBulkRaw(requestParameters: IncidentsExportPdfBulkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PdfExportQueuedResource>> {
+    async incidentsListRaw(requestParameters: IncidentsListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedIncidentListResourceResponse>> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -837,114 +780,24 @@ export class GeneralApi extends runtime.BaseAPI {
             }
         }
 
-        let urlPath = `/api/incidents/export-pdf/bulk`;
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: IncidentsExportPdfBulkRequestToJSON(requestParameters['incidentsExportPdfBulkRequest']),
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PdfExportQueuedResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf.bulk
-     */
-    async incidentsExportPdfBulk(requestParameters: IncidentsExportPdfBulkOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PdfExportQueuedResource> {
-        const response = await this.incidentsExportPdfBulkRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf.download
-     */
-    async incidentsExportPdfDownloadRaw(requestParameters: IncidentsExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
-        if (requestParameters['pdfExport'] == null) {
-            throw new runtime.RequiredError(
-                'pdfExport',
-                'Required parameter "pdfExport" was null or undefined when calling incidentsExportPdfDownload().'
-            );
-        }
-
-        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/export-pdf/{pdfExport}/download`;
-        urlPath = urlPath.replace(`{${"pdfExport"}}`, encodeURIComponent(String(requestParameters['pdfExport'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.BlobApiResponse(response);
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf.download
-     */
-    async incidentsExportPdfDownload(requestParameters: IncidentsExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
-        const response = await this.incidentsExportPdfDownloadRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Auto-generated: incidents.exportPdf.status
-     */
-    async incidentsExportPdfStatusRaw(requestParameters: IncidentsExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PdfExportResource>> {
-        if (requestParameters['pdfExport'] == null) {
-            throw new runtime.RequiredError(
-                'pdfExport',
-                'Required parameter "pdfExport" was null or undefined when calling incidentsExportPdfStatus().'
-            );
-        }
-
-        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/export-pdf/{pdfExport}/status`;
-        urlPath = urlPath.replace(`{${"pdfExport"}}`, encodeURIComponent(String(requestParameters['pdfExport'])));
+        let urlPath = `/api/incidents/list`;
 
         const response = await this.request({
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: IncidentsListRequestToJSON(requestParameters['incidentsListRequest']),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => PdfExportResourceFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedIncidentListResourceResponseFromJSON(jsonValue));
     }
 
     /**
-     * Auto-generated: incidents.exportPdf.status
+     * Auto-generated: incidents.list
      */
-    async incidentsExportPdfStatus(requestParameters: IncidentsExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PdfExportResource> {
-        const response = await this.incidentsExportPdfStatusRaw(requestParameters, initOverrides);
+    async incidentsList(requestParameters: IncidentsListOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedIncidentListResourceResponse> {
+        const response = await this.incidentsListRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/models/AddressResource.ts

@@ -36,7 +36,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    addressLine2: string;
+    addressLine2?: string | null;
     /**
      * 
      * @type {string}
@@ -80,7 +80,6 @@ export interface AddressResource {
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
     if (!('addressLine1' in value) || value['addressLine1'] === undefined) return false;
-    if (!('addressLine2' in value) || value['addressLine2'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('city' in value) || value['city'] === undefined) return false;
     if (!('state' in value) || value['state'] === undefined) return false;
@@ -102,7 +101,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'id': json['id'] == null ? undefined : json['id'],
         'addressLine1': json['addressLine1'],
-        'addressLine2': json['addressLine2'],
+        'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
         'suburb': json['suburb'],
         'city': json['city'],
         'state': json['state'],

package/src/models/AssetResource.ts

@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -71,7 +71,6 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
     if (!('filePath' in value) || value['filePath'] === undefined) return false;
     if (!('fileName' in value) || value['fileName'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     return true;
@@ -91,7 +90,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/src/models/IncidentListResource.ts

@@ -0,0 +1,177 @@
+/* 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 { VenueLiteResource } from './VenueLiteResource';
+import {
+    VenueLiteResourceFromJSON,
+    VenueLiteResourceFromJSONTyped,
+    VenueLiteResourceToJSON,
+    VenueLiteResourceToJSONTyped,
+} from './VenueLiteResource';
+import type { SecurityCompanyLiteResource } from './SecurityCompanyLiteResource';
+import {
+    SecurityCompanyLiteResourceFromJSON,
+    SecurityCompanyLiteResourceFromJSONTyped,
+    SecurityCompanyLiteResourceToJSON,
+    SecurityCompanyLiteResourceToJSONTyped,
+} from './SecurityCompanyLiteResource';
+import type { UserLiteResource } from './UserLiteResource';
+import {
+    UserLiteResourceFromJSON,
+    UserLiteResourceFromJSONTyped,
+    UserLiteResourceToJSON,
+    UserLiteResourceToJSONTyped,
+} from './UserLiteResource';
+
+/**
+ * 
+ * @export
+ * @interface IncidentListResource
+ */
+export interface IncidentListResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof IncidentListResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {VenueLiteResource}
+     * @memberof IncidentListResource
+     */
+    venue?: VenueLiteResource;
+    /**
+     * 
+     * @type {SecurityCompanyLiteResource}
+     * @memberof IncidentListResource
+     */
+    securityCompany?: SecurityCompanyLiteResource;
+    /**
+     * 
+     * @type {UserLiteResource}
+     * @memberof IncidentListResource
+     */
+    user?: UserLiteResource;
+    /**
+     * 
+     * @type {UserLiteResource}
+     * @memberof IncidentListResource
+     */
+    approvedByUser?: UserLiteResource;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentListResource
+     */
+    title?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentListResource
+     */
+    dutyManager?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IncidentListResource
+     */
+    incidentDateTime?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentListResource
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IncidentListResource
+     */
+    submittedByGuard: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IncidentListResource
+     */
+    approvedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IncidentListResource
+     */
+    createdAt?: Date | null;
+}
+
+/**
+ * Check if a given object implements the IncidentListResource interface.
+ */
+export function instanceOfIncidentListResource(value: object): value is IncidentListResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('submittedByGuard' in value) || value['submittedByGuard'] === undefined) return false;
+    return true;
+}
+
+export function IncidentListResourceFromJSON(json: any): IncidentListResource {
+    return IncidentListResourceFromJSONTyped(json, false);
+}
+
+export function IncidentListResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentListResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'venue': json['venue'] == null ? undefined : VenueLiteResourceFromJSON(json['venue']),
+        'securityCompany': json['securityCompany'] == null ? undefined : SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
+        'user': json['user'] == null ? undefined : UserLiteResourceFromJSON(json['user']),
+        'approvedByUser': json['approvedByUser'] == null ? undefined : UserLiteResourceFromJSON(json['approvedByUser']),
+        'title': json['title'] == null ? undefined : json['title'],
+        'dutyManager': json['dutyManager'] == null ? undefined : json['dutyManager'],
+        'incidentDateTime': json['incidentDateTime'] == null ? undefined : (new Date(json['incidentDateTime'])),
+        'state': json['state'] == null ? undefined : json['state'],
+        'submittedByGuard': json['submittedByGuard'],
+        'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+    };
+}
+
+export function IncidentListResourceToJSON(json: any): IncidentListResource {
+    return IncidentListResourceToJSONTyped(json, false);
+}
+
+export function IncidentListResourceToJSONTyped(value?: IncidentListResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'venue': VenueLiteResourceToJSON(value['venue']),
+        'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
+        'user': UserLiteResourceToJSON(value['user']),
+        'approvedByUser': UserLiteResourceToJSON(value['approvedByUser']),
+        'title': value['title'],
+        'dutyManager': value['dutyManager'],
+        'incidentDateTime': value['incidentDateTime'] === null ? null : ((value['incidentDateTime'] as any)?.toISOString()),
+        'state': value['state'],
+        'submittedByGuard': value['submittedByGuard'],
+        'approvedAt': value['approvedAt'] === null ? null : ((value['approvedAt'] as any)?.toISOString()),
+        'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
+    };
+}
+

package/src/models/IncidentListResourceArrayResponse.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 { IncidentListResource } from './IncidentListResource';
+import {
+    IncidentListResourceFromJSON,
+    IncidentListResourceFromJSONTyped,
+    IncidentListResourceToJSON,
+    IncidentListResourceToJSONTyped,
+} from './IncidentListResource';
+
+/**
+ * 
+ * @export
+ * @interface IncidentListResourceArrayResponse
+ */
+export interface IncidentListResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<IncidentListResource>}
+     * @memberof IncidentListResourceArrayResponse
+     */
+    data?: Array<IncidentListResource>;
+}
+
+/**
+ * Check if a given object implements the IncidentListResourceArrayResponse interface.
+ */
+export function instanceOfIncidentListResourceArrayResponse(value: object): value is IncidentListResourceArrayResponse {
+    return true;
+}
+
+export function IncidentListResourceArrayResponseFromJSON(json: any): IncidentListResourceArrayResponse {
+    return IncidentListResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function IncidentListResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentListResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(IncidentListResourceFromJSON)),
+    };
+}
+
+export function IncidentListResourceArrayResponseToJSON(json: any): IncidentListResourceArrayResponse {
+    return IncidentListResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function IncidentListResourceArrayResponseToJSONTyped(value?: IncidentListResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(IncidentListResourceToJSON)),
+    };
+}
+