@digital8/security-registers-backend-ts-sdk 0.0.240 → 0.0.241

package/README.md

@@ -1,4 +1,4 @@
-## @digital8/security-registers-backend-ts-sdk@0.0.240
+## @digital8/security-registers-backend-ts-sdk@0.0.241
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @digital8/security-registers-backend-ts-sdk@0.0.240 --save
+npm install @digital8/security-registers-backend-ts-sdk@0.0.241 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/GeneralApi.d.ts

@@ -216,6 +216,9 @@ export interface VenuesNearbyOperationRequest {
 export interface VenuesPublicStoreOperationRequest {
     venuesPublicStoreRequest?: VenuesPublicStoreRequest;
 }
+export interface VenuesRotateKeyRequest {
+    venue: number;
+}
 export interface VenuesShowRequest {
     venue: number;
 }
@@ -766,6 +769,14 @@ export declare class GeneralApi extends runtime.BaseAPI {
      * Auto-generated: venues.public.store
      */
     venuesPublicStore(requestParameters?: VenuesPublicStoreOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource>;
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    venuesRotateKeyRaw(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VenueResource>>;
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    venuesRotateKey(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource>;
     /**
      * Auto-generated: venues.show
      */

package/dist/apis/GeneralApi.js

@@ -3813,6 +3813,62 @@ var GeneralApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    GeneralApi.prototype.venuesRotateKeyRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['venue'] == null) {
+                            throw new runtime.RequiredError('venue', 'Required parameter "venue" was null or undefined when calling venuesRotateKey().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearerAuth", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2:
+                        urlPath = "/api/venues/{venue}/rotate-key";
+                        urlPath = urlPath.replace("{".concat("venue", "}"), encodeURIComponent(String(requestParameters['venue'])));
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.VenueResourceFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    GeneralApi.prototype.venuesRotateKey = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.venuesRotateKeyRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Auto-generated: venues.show
      */

package/dist/models/AssetResource.d.ts

@@ -44,7 +44,7 @@ export interface AssetResource {
      * @type {string}
      * @memberof AssetResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      *
      * @type {number}

package/dist/models/AssetResource.js

@@ -30,6 +30,8 @@ function instanceOfAssetResource(value) {
         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)
@@ -48,7 +50,7 @@ function AssetResourceFromJSONTyped(json, ignoreDiscriminator) {
         '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/dist/models/IncidentImageResource.d.ts

@@ -32,7 +32,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      *
      * @type {number}

package/dist/models/IncidentImageResource.js

@@ -26,6 +26,8 @@ function instanceOfIncidentImageResource(value) {
         return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined)
         return false;
+    if (!('altText' in value) || value['altText'] === undefined)
+        return false;
     if (!('assetId' in value) || value['assetId'] === undefined)
         return false;
     if (!('url' in value) || value['url'] === undefined)
@@ -42,7 +44,7 @@ function IncidentImageResourceFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
+        'altText': json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/dist/models/RegisterGroupedByRosterResource.d.ts

@@ -52,7 +52,7 @@ export interface RegisterGroupedByRosterResource {
      * @type {Date}
      * @memberof RegisterGroupedByRosterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      *
      * @type {Array<RegisterListResource>}

package/dist/models/RegisterGroupedByRosterResource.js

@@ -32,8 +32,6 @@ function instanceOfRegisterGroupedByRosterResource(value) {
         return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined)
         return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
-        return false;
     if (!('registers' in value) || value['registers'] === undefined)
         return false;
     return true;
@@ -51,7 +49,7 @@ function RegisterGroupedByRosterResourceFromJSONTyped(json, ignoreDiscriminator)
         'timezone': json['timezone'],
         'state': json['state'],
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'registers': (json['registers'] == null ? null : json['registers'].map(RegisterListResource_1.RegisterListResourceFromJSON)),
     };
 }
@@ -59,6 +57,7 @@ function RegisterGroupedByRosterResourceToJSON(json) {
     return RegisterGroupedByRosterResourceToJSONTyped(json, false);
 }
 function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator) {
+    var _a;
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
@@ -69,7 +68,7 @@ function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator)
         'timezone': value['timezone'],
         'state': value['state'],
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
         'registers': (value['registers'] == null ? null : value['registers'].map(RegisterListResource_1.RegisterListResourceToJSON)),
     };
 }

package/dist/models/RegisterListResource.d.ts

@@ -47,13 +47,13 @@ export interface RegisterListResource {
      * @type {Date}
      * @memberof RegisterListResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      *
-     * @type {string}
+     * @type {object}
      * @memberof RegisterListResource
      */
-    shiftLength: string;
+    shiftLength: object;
     /**
      *
      * @type {number}
@@ -65,7 +65,7 @@ export interface RegisterListResource {
      * @type {string}
      * @memberof RegisterListResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      *
      * @type {string}
@@ -149,7 +149,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLong: number;
+    signOffLong?: number | null;
     /**
      *
      * @type {Array<IncidentLiteResource>}

package/dist/models/RegisterListResource.js

@@ -31,14 +31,10 @@ function instanceOfRegisterListResource(value) {
         return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined)
         return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
-        return false;
     if (!('shiftLength' in value) || value['shiftLength'] === undefined)
         return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined)
         return false;
-    if (!('badgeNumber' in value) || value['badgeNumber'] === undefined)
-        return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
         return false;
     if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined)
@@ -63,8 +59,6 @@ function instanceOfRegisterListResource(value) {
         return false;
     if (!('signOnLong' in value) || value['signOnLong'] === undefined)
         return false;
-    if (!('signOffLong' in value) || value['signOffLong'] === undefined)
-        return false;
     if (!('incidents' in value) || value['incidents'] === undefined)
         return false;
     return true;
@@ -81,10 +75,10 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
         'user': (0, UserLiteResource_1.UserLiteResourceFromJSON)(json['user']),
         'venue': (0, VenueLiteResource_1.VenueLiteResourceFromJSON)(json['venue']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'shiftLength': json['shiftLength'],
         'signOffStatus': json['signOffStatus'],
-        'badgeNumber': json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
@@ -98,7 +92,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
-        'signOffLong': json['signOffLong'],
+        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'incidents': (json['incidents'] == null ? null : json['incidents'].map(IncidentLiteResource_1.IncidentLiteResourceFromJSON)),
     };
 }
@@ -106,6 +100,7 @@ function RegisterListResourceToJSON(json) {
     return RegisterListResourceToJSONTyped(json, false);
 }
 function RegisterListResourceToJSONTyped(value, ignoreDiscriminator) {
+    var _a;
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
@@ -115,7 +110,7 @@ function RegisterListResourceToJSONTyped(value, ignoreDiscriminator) {
         'user': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['user']),
         'venue': (0, VenueLiteResource_1.VenueLiteResourceToJSON)(value['venue']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
         'shiftLength': value['shiftLength'],
         'signOffStatus': value['signOffStatus'],
         'badgeNumber': value['badgeNumber'],

package/dist/models/RegisterResource.d.ts

@@ -46,7 +46,7 @@ export interface RegisterResource {
      * @type {Date}
      * @memberof RegisterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      *
      * @type {number}
@@ -112,7 +112,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLong?: number | null;
+    signOffLong: number;
     /**
      *
      * @type {string}
@@ -142,7 +142,7 @@ export interface RegisterResource {
      * @type {string}
      * @memberof RegisterResource
      */
-    badgeNumber?: string | null;
+    badgeNumber: string;
     /**
      *
      * @type {Date}

package/dist/models/RegisterResource.js

@@ -30,8 +30,6 @@ function instanceOfRegisterResource(value) {
         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)
@@ -52,6 +50,8 @@ function instanceOfRegisterResource(value) {
         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)
@@ -60,6 +60,8 @@ function instanceOfRegisterResource(value) {
         return false;
     if (!('licenceLastName' in value) || value['licenceLastName'] === undefined)
         return false;
+    if (!('badgeNumber' in value) || value['badgeNumber'] === undefined)
+        return false;
     return true;
 }
 function RegisterResourceFromJSON(json) {
@@ -74,7 +76,7 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
         'venue': (0, VenueLiteResource_1.VenueLiteResourceFromJSON)(json['venue']),
         'user': (0, UserLiteResource_1.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'],
@@ -85,12 +87,12 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'],
-        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
+        'signOffLong': json['signOffLong'],
         'licenceNumber': json['licenceNumber'],
         'licenceExpiry': json['licenceExpiry'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
-        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
     };
@@ -99,7 +101,7 @@ function RegisterResourceToJSON(json) {
     return RegisterResourceToJSONTyped(json, false);
 }
 function RegisterResourceToJSONTyped(value, ignoreDiscriminator) {
-    var _a, _b;
+    var _a, _b, _c;
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
@@ -109,7 +111,7 @@ function RegisterResourceToJSONTyped(value, ignoreDiscriminator) {
         'venue': (0, VenueLiteResource_1.VenueLiteResourceToJSON)(value['venue']),
         'user': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['user']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
         'signOffStatus': value['signOffStatus'],
         'signOnSignature': value['signOnSignature'],
         'signOffSignature': value['signOffSignature'],
@@ -126,7 +128,7 @@ function RegisterResourceToJSONTyped(value, ignoreDiscriminator) {
         'licenceFirstName': value['licenceFirstName'],
         'licenceLastName': value['licenceLastName'],
         'badgeNumber': value['badgeNumber'],
-        'createdAt': value['createdAt'] === null ? null : ((_a = value['createdAt']) === null || _a === void 0 ? void 0 : _a.toISOString()),
-        'updatedAt': value['updatedAt'] === null ? null : ((_b = value['updatedAt']) === null || _b === void 0 ? void 0 : _b.toISOString()),
+        'createdAt': value['createdAt'] === null ? null : ((_b = value['createdAt']) === null || _b === void 0 ? void 0 : _b.toISOString()),
+        'updatedAt': value['updatedAt'] === null ? null : ((_c = value['updatedAt']) === null || _c === void 0 ? void 0 : _c.toISOString()),
     };
 }

package/dist/models/RosterResource.d.ts

@@ -47,7 +47,7 @@ export interface RosterResource {
      * @type {Date}
      * @memberof RosterResource
      */
-    finishDateTime?: Date | null;
+    finishDateTime: Date;
     /**
      *
      * @type {boolean}

package/dist/models/RosterResource.js

@@ -31,6 +31,8 @@ function instanceOfRosterResource(value) {
         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)
@@ -53,7 +55,7 @@ function RosterResourceFromJSONTyped(json, ignoreDiscriminator) {
         'venue': (0, VenueLiteResource_1.VenueLiteResourceFromJSON)(json['venue']),
         'securityCompany': (0, SecurityCompanyLiteResource_1.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'],
@@ -64,7 +66,6 @@ function RosterResourceToJSON(json) {
     return RosterResourceToJSONTyped(json, false);
 }
 function RosterResourceToJSONTyped(value, ignoreDiscriminator) {
-    var _a;
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
@@ -74,7 +75,7 @@ function RosterResourceToJSONTyped(value, ignoreDiscriminator) {
         'venue': (0, VenueLiteResource_1.VenueLiteResourceToJSON)(value['venue']),
         'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceToJSON)(value['securityCompany']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
+        'finishDateTime': ((value['finishDateTime']).toISOString()),
         'isCompliant': value['isCompliant'],
         'isComplete': value['isComplete'],
         'signOffStatus': value['signOffStatus'],

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/VenueResource.d.ts

@@ -36,6 +36,12 @@ export interface VenueResource {
      * @memberof VenueResource
      */
     venueCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VenueResource
+     */
+    venueApiKey: string;
     /**
      *
      * @type {boolean}

package/dist/models/VenueResource.js

@@ -29,6 +29,8 @@ function instanceOfVenueResource(value) {
         return false;
     if (!('venueCode' in value) || value['venueCode'] === undefined)
         return false;
+    if (!('venueApiKey' in value) || value['venueApiKey'] === undefined)
+        return false;
     if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined)
         return false;
     if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined)
@@ -62,6 +64,7 @@ function VenueResourceFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
         'venueCode': json['venueCode'],
+        'venueApiKey': json['venueApiKey'],
         'badgeNumberRequired': json['badgeNumberRequired'],
         'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
         'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
@@ -90,6 +93,7 @@ function VenueResourceToJSONTyped(value, ignoreDiscriminator) {
         'id': value['id'],
         'name': value['name'],
         'venueCode': value['venueCode'],
+        'venueApiKey': value['venueApiKey'],
         'badgeNumberRequired': value['badgeNumberRequired'],
         'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
         'primaryManagerId': value['primaryManagerId'],

package/package.json

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

package/src/apis/GeneralApi.ts

@@ -515,6 +515,10 @@ export interface VenuesPublicStoreOperationRequest {
     venuesPublicStoreRequest?: VenuesPublicStoreRequest;
 }
 
+export interface VenuesRotateKeyRequest {
+    venue: number;
+}
+
 export interface VenuesShowRequest {
     venue: number;
 }
@@ -3409,6 +3413,51 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    async venuesRotateKeyRaw(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VenueResource>> {
+        if (requestParameters['venue'] == null) {
+            throw new runtime.RequiredError(
+                'venue',
+                'Required parameter "venue" was null or undefined when calling venuesRotateKey().'
+            );
+        }
+
+        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/venues/{venue}/rotate-key`;
+        urlPath = urlPath.replace(`{${"venue"}}`, encodeURIComponent(String(requestParameters['venue'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => VenueResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: venues.rotateKey
+     */
+    async venuesRotateKey(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource> {
+        const response = await this.venuesRotateKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: venues.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/IncidentImageResource.ts

@@ -36,7 +36,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText?: string | null;
+    altText: string;
     /**
      * 
      * @type {number}
@@ -57,6 +57,7 @@ export interface IncidentImageResource {
 export function instanceOfIncidentImageResource(value: object): value is IncidentImageResource {
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
+    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('assetId' in value) || value['assetId'] === undefined) return false;
     if (!('url' in value) || value['url'] === undefined) return false;
     return true;
@@ -74,7 +75,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
         
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
+        'altText': json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/src/models/RegisterGroupedByRosterResource.ts

@@ -69,7 +69,7 @@ export interface RegisterGroupedByRosterResource {
      * @type {Date}
      * @memberof RegisterGroupedByRosterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {Array<RegisterListResource>}
@@ -86,7 +86,6 @@ export function instanceOfRegisterGroupedByRosterResource(value: object): value
     if (!('timezone' in value) || value['timezone'] === undefined) return false;
     if (!('state' in value) || value['state'] === undefined) return false;
     if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
-    if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('registers' in value) || value['registers'] === undefined) return false;
     return true;
 }
@@ -106,7 +105,7 @@ export function RegisterGroupedByRosterResourceFromJSONTyped(json: any, ignoreDi
         'timezone': json['timezone'],
         'state': json['state'],
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
     };
 }
@@ -127,7 +126,7 @@ export function RegisterGroupedByRosterResourceToJSONTyped(value?: RegisterGroup
         'timezone': value['timezone'],
         'state': value['state'],
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
     };
 }

package/src/models/RegisterListResource.ts

@@ -70,13 +70,13 @@ export interface RegisterListResource {
      * @type {Date}
      * @memberof RegisterListResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
-     * @type {string}
+     * @type {object}
      * @memberof RegisterListResource
      */
-    shiftLength: string;
+    shiftLength: object;
     /**
      * 
      * @type {number}
@@ -88,7 +88,7 @@ export interface RegisterListResource {
      * @type {string}
      * @memberof RegisterListResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      * 
      * @type {string}
@@ -172,7 +172,7 @@ export interface RegisterListResource {
      * @type {number}
      * @memberof RegisterListResource
      */
-    signOffLong: number;
+    signOffLong?: number | null;
     /**
      * 
      * @type {Array<IncidentLiteResource>}
@@ -188,10 +188,8 @@ 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 (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
     if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
     if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
-    if (!('badgeNumber' in value) || value['badgeNumber'] === 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;
@@ -204,7 +202,6 @@ 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 (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
     if (!('incidents' in value) || value['incidents'] === undefined) return false;
     return true;
 }
@@ -223,10 +220,10 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'user': UserLiteResourceFromJSON(json['user']),
         'venue': VenueLiteResourceFromJSON(json['venue']),
         'startDateTime': (new Date(json['startDateTime'])),
-        'finishDateTime': (new Date(json['finishDateTime'])),
+        'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
         'shiftLength': json['shiftLength'],
         'signOffStatus': json['signOffStatus'],
-        'badgeNumber': json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
@@ -240,7 +237,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
-        'signOffLong': json['signOffLong'],
+        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
         'incidents': (json['incidents'] == null ? null : (json['incidents'] as Array<any>).map(IncidentLiteResourceFromJSON)),
     };
 }
@@ -260,7 +257,7 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
         'user': UserLiteResourceToJSON(value['user']),
         'venue': VenueLiteResourceToJSON(value['venue']),
         'startDateTime': ((value['startDateTime']).toISOString()),
-        'finishDateTime': ((value['finishDateTime']).toISOString()),
+        'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
         'shiftLength': value['shiftLength'],
         'signOffStatus': value['signOffStatus'],
         'badgeNumber': value['badgeNumber'],

package/src/models/RegisterResource.ts

@@ -63,7 +63,7 @@ export interface RegisterResource {
      * @type {Date}
      * @memberof RegisterResource
      */
-    finishDateTime: Date;
+    finishDateTime?: Date | null;
     /**
      * 
      * @type {number}
@@ -129,7 +129,7 @@ export interface RegisterResource {
      * @type {number}
      * @memberof RegisterResource
      */
-    signOffLong?: number | null;
+    signOffLong: number;
     /**
      * 
      * @type {string}
@@ -159,7 +159,7 @@ export interface RegisterResource {
      * @type {string}
      * @memberof RegisterResource
      */
-    badgeNumber?: string | null;
+    badgeNumber: string;
     /**
      * 
      * @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;
@@ -192,10 +191,12 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
     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;
 }
 
@@ -213,7 +214,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'],
@@ -224,12 +225,12 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'signOnLat': json['signOnLat'],
         'signOnLong': json['signOnLong'],
         'signOffLat': json['signOffLat'],
-        'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
+        'signOffLong': json['signOffLong'],
         'licenceNumber': json['licenceNumber'],
         'licenceExpiry': json['licenceExpiry'],
         'licenceFirstName': json['licenceFirstName'],
         'licenceLastName': json['licenceLastName'],
-        'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
+        'badgeNumber': json['badgeNumber'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
         'updatedAt': json['updatedAt'] == null ? undefined : (new Date(json['updatedAt'])),
     };
@@ -250,7 +251,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'],

package/src/models/RosterResource.ts

@@ -70,7 +70,7 @@ export interface RosterResource {
      * @type {Date}
      * @memberof RosterResource
      */
-    finishDateTime?: Date | null;
+    finishDateTime: Date;
     /**
      * 
      * @type {boolean}
@@ -104,6 +104,7 @@ export function instanceOfRosterResource(value: object): value is RosterResource
     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;
@@ -125,7 +126,7 @@ export function RosterResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
         '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'],
@@ -148,7 +149,7 @@ export function RosterResourceToJSONTyped(value?: RosterResource | null, ignoreD
         '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/SecurityCompanyResource.ts

@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
      * @type {string}
      * @memberof SecurityCompanyResource
      */
-    email?: string | null;
+    email: string;
     /**
      * 
      * @type {boolean}
@@ -82,6 +82,7 @@ export interface SecurityCompanyResource {
  */
 export function instanceOfSecurityCompanyResource(value: object): value is SecurityCompanyResource {
     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) return false;
     if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -100,7 +101,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
-        'email': json['email'] == null ? undefined : json['email'],
+        'email': json['email'],
         'isEnabled': json['isEnabled'],
         'address': AddressResourceFromJSON(json['address']),
         'licenceNumber': json['licenceNumber'],

package/src/models/VenueResource.ts

@@ -59,6 +59,12 @@ export interface VenueResource {
      * @memberof VenueResource
      */
     venueCode: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof VenueResource
+     */
+    venueApiKey: string;
     /**
      * 
      * @type {boolean}
@@ -145,6 +151,7 @@ export interface VenueResource {
 export function instanceOfVenueResource(value: object): value is VenueResource {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('venueCode' in value) || value['venueCode'] === undefined) return false;
+    if (!('venueApiKey' in value) || value['venueApiKey'] === undefined) return false;
     if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined) return false;
     if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined) return false;
     if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
@@ -171,6 +178,7 @@ export function VenueResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
         'venueCode': json['venueCode'],
+        'venueApiKey': json['venueApiKey'],
         'badgeNumberRequired': json['badgeNumberRequired'],
         'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
         'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
@@ -201,6 +209,7 @@ export function VenueResourceToJSONTyped(value?: VenueResource | null, ignoreDis
         'id': value['id'],
         'name': value['name'],
         'venueCode': value['venueCode'],
+        'venueApiKey': value['venueApiKey'],
         'badgeNumberRequired': value['badgeNumberRequired'],
         'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
         'primaryManagerId': value['primaryManagerId'],