@digital8/security-registers-backend-ts-sdk 0.0.177 → 0.0.179

package/dist/models/RostersUpdateRequest.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface RostersUpdateRequest
+ */
+export interface RostersUpdateRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof RostersUpdateRequest
+     */
+    venueId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RostersUpdateRequest
+     */
+    securityCompanyId?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof RostersUpdateRequest
+     */
+    startDateTime?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof RostersUpdateRequest
+     */
+    finishDateTime?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof RostersUpdateRequest
+     */
+    signOffStatus?: RostersUpdateRequestSignOffStatusEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RostersUpdateRequest
+     */
+    isComplete?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RostersUpdateRequest
+     */
+    isCompliant?: boolean;
+}
+/**
+ * @export
+ */
+export declare const RostersUpdateRequestSignOffStatusEnum: {
+    readonly _0: "0";
+    readonly _1: "1";
+    readonly _2: "2";
+};
+export type RostersUpdateRequestSignOffStatusEnum = typeof RostersUpdateRequestSignOffStatusEnum[keyof typeof RostersUpdateRequestSignOffStatusEnum];
+/**
+ * Check if a given object implements the RostersUpdateRequest interface.
+ */
+export declare function instanceOfRostersUpdateRequest(value: object): value is RostersUpdateRequest;
+export declare function RostersUpdateRequestFromJSON(json: any): RostersUpdateRequest;
+export declare function RostersUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersUpdateRequest;
+export declare function RostersUpdateRequestToJSON(json: any): RostersUpdateRequest;
+export declare function RostersUpdateRequestToJSONTyped(value?: RostersUpdateRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RostersUpdateRequest.js

@@ -0,0 +1,70 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RostersUpdateRequestSignOffStatusEnum = void 0;
+exports.instanceOfRostersUpdateRequest = instanceOfRostersUpdateRequest;
+exports.RostersUpdateRequestFromJSON = RostersUpdateRequestFromJSON;
+exports.RostersUpdateRequestFromJSONTyped = RostersUpdateRequestFromJSONTyped;
+exports.RostersUpdateRequestToJSON = RostersUpdateRequestToJSON;
+exports.RostersUpdateRequestToJSONTyped = RostersUpdateRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.RostersUpdateRequestSignOffStatusEnum = {
+    _0: '0',
+    _1: '1',
+    _2: '2'
+};
+/**
+ * Check if a given object implements the RostersUpdateRequest interface.
+ */
+function instanceOfRostersUpdateRequest(value) {
+    return true;
+}
+function RostersUpdateRequestFromJSON(json) {
+    return RostersUpdateRequestFromJSONTyped(json, false);
+}
+function RostersUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
+        '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'],
+        'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
+        'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
+    };
+}
+function RostersUpdateRequestToJSON(json) {
+    return RostersUpdateRequestToJSONTyped(json, false);
+}
+function RostersUpdateRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'venue_id': value['venueId'],
+        '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'],
+        'is_complete': value['isComplete'],
+        'is_compliant': value['isCompliant'],
+    };
+}

package/dist/models/SecurityCompanyResource.d.ts

@@ -33,7 +33,7 @@ export interface SecurityCompanyResource {
      * @type {string}
      * @memberof SecurityCompanyResource
      */
-    email?: string | null;
+    email: string;
     /**
      *
      * @type {boolean}

package/dist/models/SecurityCompanyResource.js

@@ -25,6 +25,8 @@ var AddressResource_1 = require("./AddressResource");
 function instanceOfSecurityCompanyResource(value) {
     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)
@@ -43,7 +45,7 @@ function SecurityCompanyResourceFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
-        'email': json['email'] == null ? undefined : json['email'],
+        'email': json['email'],
         'isEnabled': json['isEnabled'],
         'address': (0, AddressResource_1.AddressResourceFromJSON)(json['address']),
         'licenceNumber': json['licenceNumber'],

package/dist/models/index.d.ts

@@ -47,6 +47,7 @@ export * from './RegistersListAllRequest';
 export * from './RegistersListRequest';
 export * from './RegistersSignOffRequest';
 export * from './RegistersSignOnRequest';
+export * from './RegistersUpdateRequest';
 export * from './ResetPasswordAuthRequest';
 export * from './RosterListResource';
 export * from './RosterListResourceArrayResponse';
@@ -60,6 +61,7 @@ export * from './RostersExportPdfRequest';
 export * from './RostersListAllRequest';
 export * from './RostersListRequest';
 export * from './RostersListWithRegistersRequest';
+export * from './RostersUpdateRequest';
 export * from './SecurityCompaniesAttachUsersRequest';
 export * from './SecurityCompaniesListAllRequest';
 export * from './SecurityCompaniesListRequest';

package/dist/models/index.js

@@ -65,6 +65,7 @@ __exportStar(require("./RegistersListAllRequest"), exports);
 __exportStar(require("./RegistersListRequest"), exports);
 __exportStar(require("./RegistersSignOffRequest"), exports);
 __exportStar(require("./RegistersSignOnRequest"), exports);
+__exportStar(require("./RegistersUpdateRequest"), exports);
 __exportStar(require("./ResetPasswordAuthRequest"), exports);
 __exportStar(require("./RosterListResource"), exports);
 __exportStar(require("./RosterListResourceArrayResponse"), exports);
@@ -78,6 +79,7 @@ __exportStar(require("./RostersExportPdfRequest"), exports);
 __exportStar(require("./RostersListAllRequest"), exports);
 __exportStar(require("./RostersListRequest"), exports);
 __exportStar(require("./RostersListWithRegistersRequest"), exports);
+__exportStar(require("./RostersUpdateRequest"), exports);
 __exportStar(require("./SecurityCompaniesAttachUsersRequest"), exports);
 __exportStar(require("./SecurityCompaniesListAllRequest"), exports);
 __exportStar(require("./SecurityCompaniesListRequest"), exports);

package/package.json

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

package/src/apis/GeneralApi.ts

@@ -40,6 +40,7 @@ import type {
   RegistersListRequest,
   RegistersSignOffRequest,
   RegistersSignOnRequest,
+  RegistersUpdateRequest,
   ResetPasswordAuthRequest,
   RosterLiteResourceArrayResponse,
   RosterResource,
@@ -47,6 +48,7 @@ import type {
   RostersListAllRequest,
   RostersListRequest,
   RostersListWithRegistersRequest,
+  RostersUpdateRequest,
   SecurityCompaniesAttachUsersRequest,
   SecurityCompaniesListAllRequest,
   SecurityCompaniesListRequest,
@@ -126,6 +128,8 @@ import {
     RegistersSignOffRequestToJSON,
     RegistersSignOnRequestFromJSON,
     RegistersSignOnRequestToJSON,
+    RegistersUpdateRequestFromJSON,
+    RegistersUpdateRequestToJSON,
     ResetPasswordAuthRequestFromJSON,
     ResetPasswordAuthRequestToJSON,
     RosterLiteResourceArrayResponseFromJSON,
@@ -140,6 +144,8 @@ import {
     RostersListRequestToJSON,
     RostersListWithRegistersRequestFromJSON,
     RostersListWithRegistersRequestToJSON,
+    RostersUpdateRequestFromJSON,
+    RostersUpdateRequestToJSON,
     SecurityCompaniesAttachUsersRequestFromJSON,
     SecurityCompaniesAttachUsersRequestToJSON,
     SecurityCompaniesListAllRequestFromJSON,
@@ -261,6 +267,11 @@ export interface RegistersSignOnOperationRequest {
     registersSignOnRequest?: RegistersSignOnRequest;
 }
 
+export interface RegistersUpdateOperationRequest {
+    register: number;
+    registersUpdateRequest?: RegistersUpdateRequest;
+}
+
 export interface ResetPasswordAuthOperationRequest {
     resetPasswordAuthRequest?: ResetPasswordAuthRequest;
 }
@@ -285,6 +296,11 @@ export interface RostersShowRequest {
     roster: number;
 }
 
+export interface RostersUpdateOperationRequest {
+    roster: number;
+    rostersUpdateRequest?: RostersUpdateRequest;
+}
+
 export interface SecurityCompaniesAttachUsersOperationRequest {
     securityCompany: number;
     securityCompaniesAttachUsersRequest?: SecurityCompaniesAttachUsersRequest;
@@ -1159,6 +1175,54 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: registers.update
+     */
+    async registersUpdateRaw(requestParameters: RegistersUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RegisterResource>> {
+        if (requestParameters['register'] == null) {
+            throw new runtime.RequiredError(
+                'register',
+                'Required parameter "register" was null or undefined when calling registersUpdate().'
+            );
+        }
+
+        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/registers/{register}/update`;
+        urlPath = urlPath.replace(`{${"register"}}`, encodeURIComponent(String(requestParameters['register'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RegistersUpdateRequestToJSON(requestParameters['registersUpdateRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RegisterResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: registers.update
+     */
+    async registersUpdate(requestParameters: RegistersUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RegisterResource> {
+        const response = await this.registersUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: resetPasswordAuth
      */
@@ -1404,6 +1468,54 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: rosters.update
+     */
+    async rostersUpdateRaw(requestParameters: RostersUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RosterResource>> {
+        if (requestParameters['roster'] == null) {
+            throw new runtime.RequiredError(
+                'roster',
+                'Required parameter "roster" was null or undefined when calling rostersUpdate().'
+            );
+        }
+
+        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/{roster}/update`;
+        urlPath = urlPath.replace(`{${"roster"}}`, encodeURIComponent(String(requestParameters['roster'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RostersUpdateRequestToJSON(requestParameters['rostersUpdateRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RosterResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: rosters.update
+     */
+    async rostersUpdate(requestParameters: RostersUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RosterResource> {
+        const response = await this.rostersUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: securityCompanies.attachUsers
      */

package/src/models/AddressResource.ts

@@ -36,7 +36,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    addressLine2?: string | null;
+    addressLine2: string;
     /**
      * 
      * @type {string}
@@ -80,6 +80,7 @@ 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;
@@ -101,7 +102,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         'id': json['id'] == null ? undefined : json['id'],
         'addressLine1': json['addressLine1'],
-        'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
+        'addressLine2': 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 | 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/RegisterListResource.ts

@@ -159,7 +159,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLat?: number | null;
+    signOffLat: number;
     /**
      * 
      * @type {number}
@@ -195,6 +195,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
     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;
 }
@@ -229,7 +230,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'firstAid': json['firstAid'],
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
-        'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
+        'signOffLat': json['signOffLat'],
         'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'incidents': json['incidents'],
     };

package/src/models/RegisterResource.ts

@@ -63,7 +63,7 @@ export interface RegisterResource {
      * @type {Date}
      * @memberof RegisterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {number}
@@ -123,7 +123,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLat: number;
+    signOffLat?: number | null;
     /**
      * 
      * @type {number}
@@ -159,7 +159,7 @@ export interface RegisterResource {
      * @type {string}
      * @memberof RegisterResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      * 
      * @type {Date}
@@ -181,7 +181,6 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
     if (!('venue' in value) || value['venue'] === undefined) return false;
     if (!('user' in value) || value['user'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
     if (!('signOnSignature' in value) || value['signOnSignature'] === undefined) return false;
     if (!('signOffSignature' in value) || value['signOffSignature'] === undefined) return false;
@@ -191,13 +190,11 @@ 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;
     if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
     if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
-    if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
     return true;
 }
 
@@ -215,7 +212,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'user': UserLiteResourceFromJSON(json['user']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'signOffStatus': json['signOffStatus'],
         'signOnSignature': json['signOnSignature'],
         'signOffSignature': json['signOffSignature'],
@@ -225,13 +222,13 @@ 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'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
-        'badgeNumber': json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
     };
@@ -252,7 +249,7 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
         'venue': VenueLiteResourceToJSON(value['venue']),
         'user': UserLiteResourceToJSON(value['user']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'signOffStatus': value['signOffStatus'],
         'signOnSignature': value['signOnSignature'],
         'signOffSignature': value['signOffSignature'],