@digital8/security-registers-backend-ts-sdk 0.0.628 → 0.0.629

package/.openapi-generator/FILES

@@ -64,6 +64,7 @@ src/models/IncidentsExportPdfRequest.ts
 src/models/IncidentsListRequest.ts
 src/models/IncidentsStoreRequest.ts
 src/models/IncidentsUpdateRequest.ts
+src/models/IncidentsUpdateTitleRequest.ts
 src/models/IncidentsVideosStoreRequest.ts
 src/models/IncidentsVideosUploadTokenRequest.ts
 src/models/IndexMinimalUserRequest.ts

package/README.md

@@ -1,4 +1,4 @@
-## @digital8/security-registers-backend-ts-sdk@0.0.628
+## @digital8/security-registers-backend-ts-sdk@0.0.629
 
 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.628 --save
+npm install @digital8/security-registers-backend-ts-sdk@0.0.629 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/GeneralApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AssetFileForUploadResource, AuthChangePasswordRequest, AuthLoginWebRequest, AuthProfileUpdateRequest, AuthRegisterGuardFileRequest, AuthRegisterGuardRequest, DevicesRegisterRequest, ExportQueuedResource, GenericResponse, IncidentFieldSchemaResource, IncidentFieldSchemasShowRequest, IncidentResource, IncidentVersionResource, IncidentVersionResourceArrayResponse, IncidentVideoResource, IncidentVideoResourceArrayResponse, IncidentVideoSignedUrlResource, IncidentVideoUploadTokenResource, IncidentVideosRecentRequest, IncidentsApproveRequest, IncidentsEligibleOwnersRequest, IncidentsExportCsvBulkRequest, IncidentsExportPdfBulkRequest, IncidentsExportPdfRequest, IncidentsListRequest, IncidentsStoreRequest, IncidentsUpdateRequest, IncidentsVideosStoreRequest, IncidentsVideosUploadTokenRequest, IndexMinimalUserRequest, IndexUserRequest, LicenceLiteResourceArrayResponse, LicenceResource, LicenceVerificationFallbackSettingResourceArrayResponse, LicencesCheckLogsListRequest, LicencesListAllRequest, LicencesListRequest, LicencesStoreRequest, LicencesUpdateRequest, LicencesVerifyRequest, MobileAppConfigRequest, MobileAppConfigResource, MobileDeviceResource, MobileInitResource, NotificationPreferenceResource, NotificationPreferenceResourceArrayResponse, NotificationPreferencesBulkRequest, NotificationPreferencesStoreRequest, NotificationTypeResourceArrayResponse, PaginatedIncidentListResourceResponse, PaginatedLicenceCheckLogResourceResponse, PaginatedLicenceListResourceResponse, PaginatedRecentVideoListResourceResponse, PaginatedRegisterGroupedByRosterResourceResponse, PaginatedRosterListResourceResponse, PaginatedRosterWithRegistersResourceResponse, PaginatedSecurityCompanyResourceResponse, PaginatedUserResourceResponse, PaginatedVenueResourceResponse, PdfExportResource, RegisterLiteResourceArrayResponse, RegisterResource, RegistersCreateRequest, RegistersListAllRequest, RegistersListRequest, RegistersSignOffRequest, RegistersSignOnRequest, RegistersUpdateRequest, ResetPasswordAuthRequest, RosterLiteResourceArrayResponse, RosterResource, RostersExportPdfRequest, RostersListAllRequest, RostersListRequest, RostersListWithRegistersRequest, RostersUpdateRequest, SecurityCompaniesAttachUsersRequest, SecurityCompaniesListAllRequest, SecurityCompaniesListRequest, SecurityCompaniesStoreRequest, SecurityCompaniesUpdateRequest, SecurityCompanyLiteResourceArrayResponse, SecurityCompanyResource, SendForgotPasswordLinkAuthRequest, SettingsLicenceVerificationFallbackUpdateRequest, StoreAssetFileRequest, StoreUserRequest, UpdateUserRequest, UserAuthTokenResource, UserLiteResourceArrayResponse, UserResource, UserVenueResourceArrayResponse, UsersAttachSecurityCompaniesRequest, UsersAttachVenuesRequest, UsersCreateWithRoleRequest, UsersDetachVenuesRequest, UsersRegisterVenueManagerRequest, VenueGuardScheduleResourceArrayResponse, VenueLiteResourceArrayResponse, VenueResource, VenuesAttachUsersRequest, VenuesGetVenuesForUserRequest, VenuesGuardScheduleUpdateRequest, VenuesListAllRequest, VenuesListForUserRequest, VenuesListRequest, VenuesNearbyRequest, VenuesPublicStoreRequest, VenuesUpdateRequest, VerifyLicenceResource } from '../models/index';
+import type { AssetFileForUploadResource, AuthChangePasswordRequest, AuthLoginWebRequest, AuthProfileUpdateRequest, AuthRegisterGuardFileRequest, AuthRegisterGuardRequest, DevicesRegisterRequest, ExportQueuedResource, GenericResponse, IncidentFieldSchemaResource, IncidentFieldSchemasShowRequest, IncidentResource, IncidentVersionResource, IncidentVersionResourceArrayResponse, IncidentVideoResource, IncidentVideoResourceArrayResponse, IncidentVideoSignedUrlResource, IncidentVideoUploadTokenResource, IncidentVideosRecentRequest, IncidentsApproveRequest, IncidentsEligibleOwnersRequest, IncidentsExportCsvBulkRequest, IncidentsExportPdfBulkRequest, IncidentsExportPdfRequest, IncidentsListRequest, IncidentsStoreRequest, IncidentsUpdateRequest, IncidentsUpdateTitleRequest, IncidentsVideosStoreRequest, IncidentsVideosUploadTokenRequest, IndexMinimalUserRequest, IndexUserRequest, LicenceLiteResourceArrayResponse, LicenceResource, LicenceVerificationFallbackSettingResourceArrayResponse, LicencesCheckLogsListRequest, LicencesListAllRequest, LicencesListRequest, LicencesStoreRequest, LicencesUpdateRequest, LicencesVerifyRequest, MobileAppConfigRequest, MobileAppConfigResource, MobileDeviceResource, MobileInitResource, NotificationPreferenceResource, NotificationPreferenceResourceArrayResponse, NotificationPreferencesBulkRequest, NotificationPreferencesStoreRequest, NotificationTypeResourceArrayResponse, PaginatedIncidentListResourceResponse, PaginatedLicenceCheckLogResourceResponse, PaginatedLicenceListResourceResponse, PaginatedRecentVideoListResourceResponse, PaginatedRegisterGroupedByRosterResourceResponse, PaginatedRosterListResourceResponse, PaginatedRosterWithRegistersResourceResponse, PaginatedSecurityCompanyResourceResponse, PaginatedUserResourceResponse, PaginatedVenueResourceResponse, PdfExportResource, RegisterLiteResourceArrayResponse, RegisterResource, RegistersCreateRequest, RegistersListAllRequest, RegistersListRequest, RegistersSignOffRequest, RegistersSignOnRequest, RegistersUpdateRequest, ResetPasswordAuthRequest, RosterLiteResourceArrayResponse, RosterResource, RostersExportPdfRequest, RostersListAllRequest, RostersListRequest, RostersListWithRegistersRequest, RostersUpdateRequest, SecurityCompaniesAttachUsersRequest, SecurityCompaniesListAllRequest, SecurityCompaniesListRequest, SecurityCompaniesStoreRequest, SecurityCompaniesUpdateRequest, SecurityCompanyLiteResourceArrayResponse, SecurityCompanyResource, SendForgotPasswordLinkAuthRequest, SettingsLicenceVerificationFallbackUpdateRequest, StoreAssetFileRequest, StoreUserRequest, UpdateUserRequest, UserAuthTokenResource, UserLiteResourceArrayResponse, UserResource, UserVenueResourceArrayResponse, UsersAttachSecurityCompaniesRequest, UsersAttachVenuesRequest, UsersCreateWithRoleRequest, UsersDetachVenuesRequest, UsersRegisterVenueManagerRequest, VenueGuardScheduleResourceArrayResponse, VenueLiteResourceArrayResponse, VenueResource, VenuesAttachUsersRequest, VenuesGetVenuesForUserRequest, VenuesGuardScheduleUpdateRequest, VenuesListAllRequest, VenuesListForUserRequest, VenuesListRequest, VenuesNearbyRequest, VenuesPublicStoreRequest, VenuesUpdateRequest, VerifyLicenceResource } from '../models/index';
 export interface AuthChangePasswordOperationRequest {
     authChangePasswordRequest?: AuthChangePasswordRequest;
 }
@@ -96,6 +96,10 @@ export interface IncidentsUpdateOperationRequest {
     incident: number;
     incidentsUpdateRequest?: IncidentsUpdateRequest;
 }
+export interface IncidentsUpdateTitleOperationRequest {
+    incident: number;
+    incidentsUpdateTitleRequest?: IncidentsUpdateTitleRequest;
+}
 export interface IncidentsVersionsRequest {
     incident: number;
 }
@@ -581,6 +585,14 @@ export declare class GeneralApi extends runtime.BaseAPI {
      * Auto-generated: incidents.update
      */
     incidentsUpdate(requestParameters: IncidentsUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource>;
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    incidentsUpdateTitleRaw(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>>;
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    incidentsUpdateTitle(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource>;
     /**
      * Auto-generated: incidents.versions
      */

package/dist/apis/GeneralApi.js

@@ -1633,6 +1633,64 @@ var GeneralApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    GeneralApi.prototype.incidentsUpdateTitleRaw = 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['incident'] == null) {
+                            throw new runtime.RequiredError('incident', 'Required parameter "incident" was null or undefined when calling incidentsUpdateTitle().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        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/incidents/{incident}/title";
+                        urlPath = urlPath.replace("{".concat("incident", "}"), encodeURIComponent(String(requestParameters['incident'])));
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, index_1.IncidentsUpdateTitleRequestToJSON)(requestParameters['incidentsUpdateTitleRequest']),
+                            }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.IncidentResourceFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    GeneralApi.prototype.incidentsUpdateTitle = 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.incidentsUpdateTitleRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Auto-generated: incidents.versions
      */

package/dist/models/AddressResource.d.ts

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

package/dist/models/AddressResource.js

@@ -24,6 +24,8 @@ exports.AddressResourceToJSONTyped = AddressResourceToJSONTyped;
 function instanceOfAddressResource(value) {
     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)
@@ -48,7 +50,7 @@ function AddressResourceFromJSONTyped(json, ignoreDiscriminator) {
     return {
         '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/dist/models/AssetResource.d.ts

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

package/dist/models/AssetResource.js

@@ -30,8 +30,6 @@ 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)
@@ -52,7 +50,7 @@ function AssetResourceFromJSONTyped(json, ignoreDiscriminator) {
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
         'isExternal': json['isExternal'],

package/dist/models/IncidentImageResource.d.ts

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

package/dist/models/IncidentImageResource.js

@@ -26,8 +26,6 @@ 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)
@@ -44,7 +42,7 @@ function IncidentImageResourceFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'],
+        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/dist/models/IncidentResource.d.ts

@@ -71,6 +71,12 @@ export interface IncidentResource {
      * @memberof IncidentResource
      */
     incidentFieldSchema: IncidentFieldSchemaResource | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IncidentResource
+     */
+    title: string;
     /**
      *
      * @type {string}

package/dist/models/IncidentResource.js

@@ -46,6 +46,8 @@ function instanceOfIncidentResource(value) {
         return false;
     if (!('incidentFieldSchema' in value) || value['incidentFieldSchema'] === undefined)
         return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
     if (!('fields' in value) || value['fields'] === undefined)
         return false;
     if (!('fieldAudits' in value) || value['fieldAudits'] === undefined)
@@ -70,6 +72,7 @@ function IncidentResourceFromJSONTyped(json, ignoreDiscriminator) {
         'user': (0, UserLiteResource_1.UserLiteResourceFromJSON)(json['user']),
         'primaryManager': (0, UserLiteResource_1.UserLiteResourceFromJSON)(json['primaryManager']),
         'incidentFieldSchema': (0, IncidentFieldSchemaResource_1.IncidentFieldSchemaResourceFromJSON)(json['incidentFieldSchema']),
+        'title': json['title'],
         'approvedBy': json['approvedBy'] == null ? undefined : json['approvedBy'],
         'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
@@ -98,6 +101,7 @@ function IncidentResourceToJSONTyped(value, ignoreDiscriminator) {
         'user': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['user']),
         'primaryManager': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['primaryManager']),
         'incidentFieldSchema': (0, IncidentFieldSchemaResource_1.IncidentFieldSchemaResourceToJSON)(value['incidentFieldSchema']),
+        'title': value['title'],
         'approvedBy': value['approvedBy'],
         'approvedAt': value['approvedAt'] === null ? null : ((_a = value['approvedAt']) === null || _a === void 0 ? void 0 : _a.toISOString()),
         'createdAt': value['createdAt'] === null ? null : ((_b = value['createdAt']) === null || _b === void 0 ? void 0 : _b.toISOString()),

package/dist/models/IncidentsStoreRequest.d.ts

@@ -39,6 +39,12 @@ export interface IncidentsStoreRequest {
      * @memberof IncidentsStoreRequest
      */
     fields: object;
+    /**
+     * Optional incident title (manager-owned metadata, not a schema field). Only non-guard (portal) callers may set it; a guard supplying a title is rejected.
+     * @type {string}
+     * @memberof IncidentsStoreRequest
+     */
+    title?: string | null;
 }
 /**
  * @export

package/dist/models/IncidentsStoreRequest.js

@@ -50,6 +50,7 @@ function IncidentsStoreRequestFromJSONTyped(json, ignoreDiscriminator) {
         'type': json['type'],
         'userId': json['user_id'] == null ? undefined : json['user_id'],
         'fields': json['fields'],
+        'title': json['title'] == null ? undefined : json['title'],
     };
 }
 function IncidentsStoreRequestToJSON(json) {
@@ -65,5 +66,6 @@ function IncidentsStoreRequestToJSONTyped(value, ignoreDiscriminator) {
         'type': value['type'],
         'user_id': value['userId'],
         'fields': value['fields'],
+        'title': value['title'],
     };
 }

package/dist/models/IncidentsUpdateRequest.d.ts

@@ -21,6 +21,12 @@ export interface IncidentsUpdateRequest {
      * @memberof IncidentsUpdateRequest
      */
     fields: object;
+    /**
+     * Optional incident title (manager-owned metadata, not a schema field). Only non-guard (portal) callers may set it; a guard supplying a title is rejected. Omit to leave the existing title untouched; send null to clear it. Follows the same edit-locks as the field update.
+     * @type {string}
+     * @memberof IncidentsUpdateRequest
+     */
+    title?: string | null;
 }
 /**
  * Check if a given object implements the IncidentsUpdateRequest interface.

package/dist/models/IncidentsUpdateRequest.js

@@ -35,6 +35,7 @@ function IncidentsUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'fields': json['fields'],
+        'title': json['title'] == null ? undefined : json['title'],
     };
 }
 function IncidentsUpdateRequestToJSON(json) {
@@ -47,5 +48,6 @@ function IncidentsUpdateRequestToJSONTyped(value, ignoreDiscriminator) {
     }
     return {
         'fields': value['fields'],
+        'title': value['title'],
     };
 }

package/dist/models/IncidentsUpdateTitleRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 IncidentsUpdateTitleRequest
+ */
+export interface IncidentsUpdateTitleRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof IncidentsUpdateTitleRequest
+     */
+    title?: string;
+}
+/**
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
+ */
+export declare function instanceOfIncidentsUpdateTitleRequest(value: object): value is IncidentsUpdateTitleRequest;
+export declare function IncidentsUpdateTitleRequestFromJSON(json: any): IncidentsUpdateTitleRequest;
+export declare function IncidentsUpdateTitleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentsUpdateTitleRequest;
+export declare function IncidentsUpdateTitleRequestToJSON(json: any): IncidentsUpdateTitleRequest;
+export declare function IncidentsUpdateTitleRequestToJSONTyped(value?: IncidentsUpdateTitleRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IncidentsUpdateTitleRequest.js

@@ -0,0 +1,49 @@
+"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.instanceOfIncidentsUpdateTitleRequest = instanceOfIncidentsUpdateTitleRequest;
+exports.IncidentsUpdateTitleRequestFromJSON = IncidentsUpdateTitleRequestFromJSON;
+exports.IncidentsUpdateTitleRequestFromJSONTyped = IncidentsUpdateTitleRequestFromJSONTyped;
+exports.IncidentsUpdateTitleRequestToJSON = IncidentsUpdateTitleRequestToJSON;
+exports.IncidentsUpdateTitleRequestToJSONTyped = IncidentsUpdateTitleRequestToJSONTyped;
+/**
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
+ */
+function instanceOfIncidentsUpdateTitleRequest(value) {
+    return true;
+}
+function IncidentsUpdateTitleRequestFromJSON(json) {
+    return IncidentsUpdateTitleRequestFromJSONTyped(json, false);
+}
+function IncidentsUpdateTitleRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+function IncidentsUpdateTitleRequestToJSON(json) {
+    return IncidentsUpdateTitleRequestToJSONTyped(json, false);
+}
+function IncidentsUpdateTitleRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+    };
+}

package/dist/models/RegisterListResource.d.ts

@@ -64,7 +64,7 @@ export interface RegisterListResource {
      * @type {string}
      * @memberof RegisterListResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      *
      * @type {Date}

package/dist/models/RegisterListResource.js

@@ -43,8 +43,6 @@ function instanceOfRegisterListResource(value) {
         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)
@@ -92,7 +90,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
         'rampReadAt': json['rampReadAt'] == null ? undefined : (new Date(json['rampReadAt'])),
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],

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

@@ -56,6 +56,7 @@ export * from './IncidentsExportPdfRequest';
 export * from './IncidentsListRequest';
 export * from './IncidentsStoreRequest';
 export * from './IncidentsUpdateRequest';
+export * from './IncidentsUpdateTitleRequest';
 export * from './IncidentsVideosStoreRequest';
 export * from './IncidentsVideosUploadTokenRequest';
 export * from './IndexMinimalUserRequest';

package/dist/models/index.js

@@ -74,6 +74,7 @@ __exportStar(require("./IncidentsExportPdfRequest"), exports);
 __exportStar(require("./IncidentsListRequest"), exports);
 __exportStar(require("./IncidentsStoreRequest"), exports);
 __exportStar(require("./IncidentsUpdateRequest"), exports);
+__exportStar(require("./IncidentsUpdateTitleRequest"), exports);
 __exportStar(require("./IncidentsVideosStoreRequest"), exports);
 __exportStar(require("./IncidentsVideosUploadTokenRequest"), exports);
 __exportStar(require("./IndexMinimalUserRequest"), exports);

package/package.json

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

package/src/apis/GeneralApi.ts

@@ -42,6 +42,7 @@ import type {
   IncidentsListRequest,
   IncidentsStoreRequest,
   IncidentsUpdateRequest,
+  IncidentsUpdateTitleRequest,
   IncidentsVideosStoreRequest,
   IncidentsVideosUploadTokenRequest,
   IndexMinimalUserRequest,
@@ -181,6 +182,8 @@ import {
     IncidentsStoreRequestToJSON,
     IncidentsUpdateRequestFromJSON,
     IncidentsUpdateRequestToJSON,
+    IncidentsUpdateTitleRequestFromJSON,
+    IncidentsUpdateTitleRequestToJSON,
     IncidentsVideosStoreRequestFromJSON,
     IncidentsVideosStoreRequestToJSON,
     IncidentsVideosUploadTokenRequestFromJSON,
@@ -461,6 +464,11 @@ export interface IncidentsUpdateOperationRequest {
     incidentsUpdateRequest?: IncidentsUpdateRequest;
 }
 
+export interface IncidentsUpdateTitleOperationRequest {
+    incident: number;
+    incidentsUpdateTitleRequest?: IncidentsUpdateTitleRequest;
+}
+
 export interface IncidentsVersionsRequest {
     incident: number;
 }
@@ -1995,6 +2003,54 @@ export class GeneralApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    async incidentsUpdateTitleRaw(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>> {
+        if (requestParameters['incident'] == null) {
+            throw new runtime.RequiredError(
+                'incident',
+                'Required parameter "incident" was null or undefined when calling incidentsUpdateTitle().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/incidents/{incident}/title`;
+        urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IncidentsUpdateTitleRequestToJSON(requestParameters['incidentsUpdateTitleRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IncidentResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: incidents.updateTitle
+     */
+    async incidentsUpdateTitle(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource> {
+        const response = await this.incidentsUpdateTitleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: incidents.versions
      */

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;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -83,7 +83,6 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
     if (!('filePath' in value) || value['filePath'] === undefined) return false;
     if (!('fileName' in value) || value['fileName'] === undefined) return false;
     if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
-    if (!('altText' in value) || value['altText'] === undefined) return false;
     if (!('index' in value) || value['index'] === undefined) return false;
     if (!('fileId' in value) || value['fileId'] === undefined) return false;
     if (!('isExternal' in value) || value['isExternal'] === undefined) return false;
@@ -104,7 +103,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
         'filePath': json['filePath'],
         'fileName': json['fileName'],
         'mimeType': json['mimeType'],
-        'altText': json['altText'],
+        'altText': json['altText'] == null ? undefined : json['altText'],
         'index': json['index'],
         'fileId': json['fileId'],
         'isExternal': json['isExternal'],

package/src/models/IncidentImageResource.ts

@@ -36,7 +36,7 @@ export interface IncidentImageResource {
      * @type {string}
      * @memberof IncidentImageResource
      */
-    altText: string;
+    altText?: string | null;
     /**
      * 
      * @type {number}
@@ -57,7 +57,6 @@ 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;
@@ -75,7 +74,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
         
         'fileId': json['file_id'],
         'mimeType': json['mime_type'],
-        'altText': json['alt_text'],
+        'altText': json['alt_text'] == null ? undefined : json['alt_text'],
         'assetId': json['asset_id'],
         'url': json['url'],
     };

package/src/models/IncidentResource.ts

@@ -124,6 +124,12 @@ export interface IncidentResource {
      * @memberof IncidentResource
      */
     incidentFieldSchema: IncidentFieldSchemaResource | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentResource
+     */
+    title: string;
     /**
      * 
      * @type {string}
@@ -186,6 +192,7 @@ export function instanceOfIncidentResource(value: object): value is IncidentReso
     if (!('user' in value) || value['user'] === undefined) return false;
     if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
     if (!('incidentFieldSchema' in value) || value['incidentFieldSchema'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
     if (!('fields' in value) || value['fields'] === undefined) return false;
     if (!('fieldAudits' in value) || value['fieldAudits'] === undefined) return false;
     if (!('videos' in value) || value['videos'] === undefined) return false;
@@ -210,6 +217,7 @@ export function IncidentResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
         'user': UserLiteResourceFromJSON(json['user']),
         'primaryManager': UserLiteResourceFromJSON(json['primaryManager']),
         'incidentFieldSchema': IncidentFieldSchemaResourceFromJSON(json['incidentFieldSchema']),
+        'title': json['title'],
         'approvedBy': json['approvedBy'] == null ? undefined : json['approvedBy'],
         'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
@@ -240,6 +248,7 @@ export function IncidentResourceToJSONTyped(value?: IncidentResource | null, ign
         'user': UserLiteResourceToJSON(value['user']),
         'primaryManager': UserLiteResourceToJSON(value['primaryManager']),
         'incidentFieldSchema': IncidentFieldSchemaResourceToJSON(value['incidentFieldSchema']),
+        'title': value['title'],
         'approvedBy': value['approvedBy'],
         'approvedAt': value['approvedAt'] === null ? null : ((value['approvedAt'] as any)?.toISOString()),
         'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),

package/src/models/IncidentsStoreRequest.ts

@@ -43,6 +43,12 @@ export interface IncidentsStoreRequest {
      * @memberof IncidentsStoreRequest
      */
     fields: object;
+    /**
+     * Optional incident title (manager-owned metadata, not a schema field). Only non-guard (portal) callers may set it; a guard supplying a title is rejected.
+     * @type {string}
+     * @memberof IncidentsStoreRequest
+     */
+    title?: string | null;
 }
 
 
@@ -80,6 +86,7 @@ export function IncidentsStoreRequestFromJSONTyped(json: any, ignoreDiscriminato
         'type': json['type'],
         'userId': json['user_id'] == null ? undefined : json['user_id'],
         'fields': json['fields'],
+        'title': json['title'] == null ? undefined : json['title'],
     };
 }
 
@@ -98,6 +105,7 @@ export function IncidentsStoreRequestToJSONTyped(value?: IncidentsStoreRequest |
         'type': value['type'],
         'user_id': value['userId'],
         'fields': value['fields'],
+        'title': value['title'],
     };
 }
 

package/src/models/IncidentsUpdateRequest.ts

@@ -25,6 +25,12 @@ export interface IncidentsUpdateRequest {
      * @memberof IncidentsUpdateRequest
      */
     fields: object;
+    /**
+     * Optional incident title (manager-owned metadata, not a schema field). Only non-guard (portal) callers may set it; a guard supplying a title is rejected. Omit to leave the existing title untouched; send null to clear it. Follows the same edit-locks as the field update.
+     * @type {string}
+     * @memberof IncidentsUpdateRequest
+     */
+    title?: string | null;
 }
 
 /**
@@ -46,6 +52,7 @@ export function IncidentsUpdateRequestFromJSONTyped(json: any, ignoreDiscriminat
     return {
         
         'fields': json['fields'],
+        'title': json['title'] == null ? undefined : json['title'],
     };
 }
 
@@ -61,6 +68,7 @@ export function IncidentsUpdateRequestToJSONTyped(value?: IncidentsUpdateRequest
     return {
         
         'fields': value['fields'],
+        'title': value['title'],
     };
 }
 

package/src/models/IncidentsUpdateTitleRequest.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface IncidentsUpdateTitleRequest
+ */
+export interface IncidentsUpdateTitleRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IncidentsUpdateTitleRequest
+     */
+    title?: string;
+}
+
+/**
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
+ */
+export function instanceOfIncidentsUpdateTitleRequest(value: object): value is IncidentsUpdateTitleRequest {
+    return true;
+}
+
+export function IncidentsUpdateTitleRequestFromJSON(json: any): IncidentsUpdateTitleRequest {
+    return IncidentsUpdateTitleRequestFromJSONTyped(json, false);
+}
+
+export function IncidentsUpdateTitleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentsUpdateTitleRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+
+export function IncidentsUpdateTitleRequestToJSON(json: any): IncidentsUpdateTitleRequest {
+    return IncidentsUpdateTitleRequestToJSONTyped(json, false);
+}
+
+export function IncidentsUpdateTitleRequestToJSONTyped(value?: IncidentsUpdateTitleRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'title': value['title'],
+    };
+}
+

package/src/models/RegisterListResource.ts

@@ -81,7 +81,7 @@ export interface RegisterListResource {
      * @type {string}
      * @memberof RegisterListResource
      */
-    badgeNumber: string;
+    badgeNumber?: string | null;
     /**
      * 
      * @type {Date}
@@ -207,7 +207,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
     if (!('startDateTime' in value) || value['startDateTime'] === 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;
@@ -243,7 +242,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
         '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'],
         'rampReadAt': json['rampReadAt'] == null ? undefined : (new Date(json['rampReadAt'])),
         'licenceNumber': json['licenceNumber'],
         'licenceFirstName': json['licenceFirstName'],

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/index.ts

@@ -58,6 +58,7 @@ export * from './IncidentsExportPdfRequest';
 export * from './IncidentsListRequest';
 export * from './IncidentsStoreRequest';
 export * from './IncidentsUpdateRequest';
+export * from './IncidentsUpdateTitleRequest';
 export * from './IncidentsVideosStoreRequest';
 export * from './IncidentsVideosUploadTokenRequest';
 export * from './IndexMinimalUserRequest';