@digital8/security-registers-backend-ts-sdk 0.0.143 → 0.0.145

package/src/apis/GeneralApi.ts

@@ -30,6 +30,7 @@ import type {
   PaginatedLicenceListResourceResponse,
   PaginatedRegisterListResourceResponse,
   PaginatedRosterListResourceResponse,
+  PaginatedRosterWithRegistersResourceResponse,
   PaginatedSecurityCompanyResourceResponse,
   PaginatedUserResourceResponse,
   PaginatedVenueResourceResponse,
@@ -42,8 +43,10 @@ import type {
   ResetPasswordAuthRequest,
   RosterLiteResourceArrayResponse,
   RosterResource,
+  RostersExportPdfRequest,
   RostersListAllRequest,
   RostersListRequest,
+  RostersListWithRegistersRequest,
   SecurityCompaniesAttachUsersRequest,
   SecurityCompaniesListAllRequest,
   SecurityCompaniesListRequest,
@@ -103,6 +106,8 @@ import {
     PaginatedRegisterListResourceResponseToJSON,
     PaginatedRosterListResourceResponseFromJSON,
     PaginatedRosterListResourceResponseToJSON,
+    PaginatedRosterWithRegistersResourceResponseFromJSON,
+    PaginatedRosterWithRegistersResourceResponseToJSON,
     PaginatedSecurityCompanyResourceResponseFromJSON,
     PaginatedSecurityCompanyResourceResponseToJSON,
     PaginatedUserResourceResponseFromJSON,
@@ -127,10 +132,14 @@ import {
     RosterLiteResourceArrayResponseToJSON,
     RosterResourceFromJSON,
     RosterResourceToJSON,
+    RostersExportPdfRequestFromJSON,
+    RostersExportPdfRequestToJSON,
     RostersListAllRequestFromJSON,
     RostersListAllRequestToJSON,
     RostersListRequestFromJSON,
     RostersListRequestToJSON,
+    RostersListWithRegistersRequestFromJSON,
+    RostersListWithRegistersRequestToJSON,
     SecurityCompaniesAttachUsersRequestFromJSON,
     SecurityCompaniesAttachUsersRequestToJSON,
     SecurityCompaniesListAllRequestFromJSON,
@@ -256,6 +265,10 @@ export interface ResetPasswordAuthOperationRequest {
     resetPasswordAuthRequest?: ResetPasswordAuthRequest;
 }
 
+export interface RostersExportPdfOperationRequest {
+    rostersExportPdfRequest?: RostersExportPdfRequest;
+}
+
 export interface RostersListOperationRequest {
     rostersListRequest?: RostersListRequest;
 }
@@ -264,6 +277,10 @@ export interface RostersListAllOperationRequest {
     rostersListAllRequest?: RostersListAllRequest;
 }
 
+export interface RostersListWithRegistersOperationRequest {
+    rostersListWithRegistersRequest?: RostersListWithRegistersRequest;
+}
+
 export interface RostersShowRequest {
     roster: number;
 }
@@ -1182,6 +1199,46 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: rosters.exportPdf
+     */
+    async rostersExportPdfRaw(requestParameters: RostersExportPdfOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        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/rosters/export-pdf`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RostersExportPdfRequestToJSON(requestParameters['rostersExportPdfRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: rosters.exportPdf
+     */
+    async rostersExportPdf(requestParameters: RostersExportPdfOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.rostersExportPdfRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: rosters.list
      */
@@ -1262,6 +1319,46 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: rosters.list.withRegisters
+     */
+    async rostersListWithRegistersRaw(requestParameters: RostersListWithRegistersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedRosterWithRegistersResourceResponse>> {
+        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/rosters/list/with-registers`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RostersListWithRegistersRequestToJSON(requestParameters['rostersListWithRegistersRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedRosterWithRegistersResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: rosters.list.withRegisters
+     */
+    async rostersListWithRegisters(requestParameters: RostersListWithRegistersOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedRosterWithRegistersResourceResponse> {
+        const response = await this.rostersListWithRegistersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: rosters.show
      */

package/src/models/AssetResource.ts

@@ -48,7 +48,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      * 
      * @type {number}
@@ -71,6 +71,7 @@ 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;
@@ -90,7 +91,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'] == null ? undefined : json['altText'],
+        'altText': json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
     };

package/src/models/IndexUserRequest.ts

@@ -45,10 +45,10 @@ export interface IndexUserRequest {
     perPage?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof IndexUserRequest
      */
-    page?: number;
+    page?: string;
     /**
      * 
      * @type {Array<string>}

package/src/models/LicencesListRequest.ts

@@ -45,10 +45,10 @@ export interface LicencesListRequest {
     perPage?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof LicencesListRequest
      */
-    page?: number;
+    page?: string;
     /**
      * 
      * @type {Array<string>}

package/src/models/PaginatedRosterWithRegistersResourceResponse.ts

@@ -0,0 +1,90 @@
+/* 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 { PagingMetadata } from './PagingMetadata';
+import {
+    PagingMetadataFromJSON,
+    PagingMetadataFromJSONTyped,
+    PagingMetadataToJSON,
+    PagingMetadataToJSONTyped,
+} from './PagingMetadata';
+import type { RosterWithRegistersResource } from './RosterWithRegistersResource';
+import {
+    RosterWithRegistersResourceFromJSON,
+    RosterWithRegistersResourceFromJSONTyped,
+    RosterWithRegistersResourceToJSON,
+    RosterWithRegistersResourceToJSONTyped,
+} from './RosterWithRegistersResource';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedRosterWithRegistersResourceResponse
+ */
+export interface PaginatedRosterWithRegistersResourceResponse {
+    /**
+     * 
+     * @type {Array<RosterWithRegistersResource>}
+     * @memberof PaginatedRosterWithRegistersResourceResponse
+     */
+    data: Array<RosterWithRegistersResource>;
+    /**
+     * 
+     * @type {PagingMetadata}
+     * @memberof PaginatedRosterWithRegistersResourceResponse
+     */
+    meta: PagingMetadata;
+}
+
+/**
+ * Check if a given object implements the PaginatedRosterWithRegistersResourceResponse interface.
+ */
+export function instanceOfPaginatedRosterWithRegistersResourceResponse(value: object): value is PaginatedRosterWithRegistersResourceResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedRosterWithRegistersResourceResponseFromJSON(json: any): PaginatedRosterWithRegistersResourceResponse {
+    return PaginatedRosterWithRegistersResourceResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedRosterWithRegistersResourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedRosterWithRegistersResourceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(RosterWithRegistersResourceFromJSON)),
+        'meta': PagingMetadataFromJSON(json['meta']),
+    };
+}
+
+export function PaginatedRosterWithRegistersResourceResponseToJSON(json: any): PaginatedRosterWithRegistersResourceResponse {
+    return PaginatedRosterWithRegistersResourceResponseToJSONTyped(json, false);
+}
+
+export function PaginatedRosterWithRegistersResourceResponseToJSONTyped(value?: PaginatedRosterWithRegistersResourceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(RosterWithRegistersResourceToJSON)),
+        'meta': PagingMetadataToJSON(value['meta']),
+    };
+}
+

package/src/models/RegisterListResource.ts

@@ -64,18 +64,114 @@ export interface RegisterListResource {
      * @memberof RegisterListResource
      */
     finishDateTime?: Date | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    shiftLength: object;
+    /**
+     * 
+     * @type {number}
+     * @memberof RegisterListResource
+     */
+    signOffStatus: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterListResource
+     */
+    badgeNumber?: string | null;
     /**
      * 
      * @type {string}
      * @memberof RegisterListResource
      */
     licenceNumber: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterListResource
+     */
+    licenceFirstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RegisterListResource
+     */
+    licenceLastName: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    licenceExpiry: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    signOnSignature: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    signOffSignature: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    licenceFront: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    licenceBack: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    rsa: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof RegisterListResource
+     */
+    firstAid: object;
     /**
      * 
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffStatus: number;
+    signOnLat: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RegisterListResource
+     */
+    signOnLong: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RegisterListResource
+     */
+    signOffLat: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RegisterListResource
+     */
+    signOffLong?: number | null;
+    /**
+     * 
+     * @type {Array<boolean>}
+     * @memberof RegisterListResource
+     */
+    incidents: Array<boolean>;
 }
 
 /**
@@ -85,8 +181,22 @@ export function instanceOfRegisterListResource(value: object): value is Register
     if (!('user' in value) || value['user'] === undefined) return false;
     if (!('venue' in value) || value['venue'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
+    if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
+    if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
+    if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
+    if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
+    if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
+    if (!('signOnSignature' in value) || value['signOnSignature'] === undefined) return false;
+    if (!('signOffSignature' in value) || value['signOffSignature'] === undefined) return false;
+    if (!('licenceFront' in value) || value['licenceFront'] === undefined) return false;
+    if (!('licenceBack' in value) || value['licenceBack'] === undefined) return false;
+    if (!('rsa' in value) || value['rsa'] === undefined) return false;
+    if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
+    if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
+    if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
+    if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
+    if (!('incidents' in value) || value['incidents'] === undefined) return false;
     return true;
 }
 
@@ -105,8 +215,24 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'startDateTime': (new Date(json['startDateTime'])),
         'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
-        'licenceNumber': json['licenceNumber'],
+        'shiftLength': json['shiftLength'],
         'signOffStatus': json['signOffStatus'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
+        'licenceNumber': json['licenceNumber'],
+        'licenceFirstName': json['licenceFirstName'],
+        'licenceLastName': json['licenceLastName'],
+        'licenceExpiry': json['licenceExpiry'],
+        'signOnSignature': json['signOnSignature'],
+        'signOffSignature': json['signOffSignature'],
+        'licenceFront': json['licenceFront'],
+        'licenceBack': json['licenceBack'],
+        'rsa': json['rsa'],
+        'firstAid': json['firstAid'],
+        'signOnLat': json['signOnLat'],
+        'signOnLong': json['signOnLong'],
+        'signOffLat': json['signOffLat'],
+        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
+        'incidents': json['incidents'],
     };
 }
 
@@ -126,8 +252,24 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
         'venue': VenueLiteResourceToJSON(value['venue']),
         'startDateTime': ((value['startDateTime']).toISOString()),
         'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
-        'licenceNumber': value['licenceNumber'],
+        'shiftLength': value['shiftLength'],
         'signOffStatus': value['signOffStatus'],
+        'badgeNumber': value['badgeNumber'],
+        'licenceNumber': value['licenceNumber'],
+        'licenceFirstName': value['licenceFirstName'],
+        'licenceLastName': value['licenceLastName'],
+        'licenceExpiry': value['licenceExpiry'],
+        'signOnSignature': value['signOnSignature'],
+        'signOffSignature': value['signOffSignature'],
+        'licenceFront': value['licenceFront'],
+        'licenceBack': value['licenceBack'],
+        'rsa': value['rsa'],
+        'firstAid': value['firstAid'],
+        'signOnLat': value['signOnLat'],
+        'signOnLong': value['signOnLong'],
+        'signOffLat': value['signOffLat'],
+        'signOffLong': value['signOffLong'],
+        'incidents': value['incidents'],
     };
 }
 

package/src/models/RegisterResource.ts

@@ -123,7 +123,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLat: number;
+    signOffLat?: number | null;
     /**
      * 
      * @type {number}
@@ -191,7 +191,6 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
     if (!('firstAidImage' in value) || value['firstAidImage'] === undefined) return false;
     if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
     if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
-    if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
     if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
     if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
@@ -224,7 +223,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'firstAidImage': json['firstAidImage'],
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
-        'signOffLat': json['signOffLat'],
+        'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
         'signOffLong': json['signOffLong'],
         'licenceNumber': json['licenceNumber'],
         'licenceExpiry': json['licenceExpiry'],

package/src/models/RegistersListRequest.ts

@@ -45,10 +45,10 @@ export interface RegistersListRequest {
     perPage?: number;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof RegistersListRequest
      */
-    page?: number;
+    page?: string;
     /**
      * 
      * @type {Array<string>}

package/src/models/RosterListResource.ts

@@ -63,7 +63,7 @@ export interface RosterListResource {
      * @type {Date}
      * @memberof RosterListResource
      */
-    finishDateTime?: Date | null;
+    finishDateTime: Date;
     /**
      * 
      * @type {boolean}
@@ -97,6 +97,7 @@ export function instanceOfRosterListResource(value: object): value is RosterList
     if (!('venue' in value) || value['venue'] === undefined) return false;
     if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
+    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
     if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -118,7 +119,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
+        'finishDateTime': (new Date(json['finishDateTime'])),
         'isCompliant': json['isCompliant'],
         'isComplete': json['isComplete'],
         'signOffStatus': json['signOffStatus'],
@@ -141,7 +142,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
         'venue': VenueLiteResourceToJSON(value['venue']),
         'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
+        'finishDateTime': ((value['finishDateTime']).toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
         'signOffStatus': value['signOffStatus'],

package/src/models/RosterLiteResource.ts

@@ -36,7 +36,7 @@ export interface RosterLiteResource {
      * @type {Date}
      * @memberof RosterLiteResource
      */
-    finishDateTime?: Date | null;
+    finishDateTime: Date;
 }
 
 /**
@@ -44,6 +44,7 @@ export interface RosterLiteResource {
  */
 export function instanceOfRosterLiteResource(value: object): value is RosterLiteResource {
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
+    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     return true;
 }
 
@@ -59,7 +60,7 @@ export function RosterLiteResourceFromJSONTyped(json: any, ignoreDiscriminator:
         
         'id': json['id'] == null ? undefined : json['id'],
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
+        'finishDateTime': (new Date(json['finishDateTime'])),
     };
 }
 
@@ -76,7 +77,7 @@ export function RosterLiteResourceToJSONTyped(value?: RosterLiteResource | null,
         
         'id': value['id'],
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
+        'finishDateTime': ((value['finishDateTime']).toISOString()),
     };
 }