@digital8/security-registers-backend-ts-sdk 0.0.630 → 0.0.632

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +13 -1
  4. package/dist/apis/GeneralApi.js +58 -0
  5. package/dist/models/IncidentImageResource.d.ts +1 -1
  6. package/dist/models/IncidentImageResource.js +3 -1
  7. package/dist/models/IncidentResource.d.ts +6 -0
  8. package/dist/models/IncidentResource.js +4 -0
  9. package/dist/models/IncidentsStoreRequest.d.ts +6 -0
  10. package/dist/models/IncidentsStoreRequest.js +2 -0
  11. package/dist/models/IncidentsUpdateRequest.d.ts +6 -0
  12. package/dist/models/IncidentsUpdateRequest.js +2 -0
  13. package/dist/models/IncidentsUpdateTitleRequest.d.ts +32 -0
  14. package/dist/models/IncidentsUpdateTitleRequest.js +49 -0
  15. package/dist/models/RegisterListResource.d.ts +1 -1
  16. package/dist/models/RegisterListResource.js +1 -3
  17. package/dist/models/RegisterResource.d.ts +1 -1
  18. package/dist/models/RegisterResource.js +1 -3
  19. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  20. package/dist/models/SecurityCompanyResource.js +3 -1
  21. package/dist/models/index.d.ts +1 -0
  22. package/dist/models/index.js +1 -0
  23. package/package.json +1 -1
  24. package/src/apis/GeneralApi.ts +56 -0
  25. package/src/models/IncidentImageResource.ts +3 -2
  26. package/src/models/IncidentResource.ts +9 -0
  27. package/src/models/IncidentsStoreRequest.ts +8 -0
  28. package/src/models/IncidentsUpdateRequest.ts +8 -0
  29. package/src/models/IncidentsUpdateTitleRequest.ts +65 -0
  30. package/src/models/RegisterListResource.ts +2 -3
  31. package/src/models/RegisterResource.ts +2 -3
  32. package/src/models/SecurityCompanyResource.ts +3 -2
  33. package/src/models/index.ts +1 -0
@@ -64,6 +64,7 @@ src/models/IncidentsExportPdfRequest.ts
64
64
  src/models/IncidentsListRequest.ts
65
65
  src/models/IncidentsStoreRequest.ts
66
66
  src/models/IncidentsUpdateRequest.ts
67
+ src/models/IncidentsUpdateTitleRequest.ts
67
68
  src/models/IncidentsVideosStoreRequest.ts
68
69
  src/models/IncidentsVideosUploadTokenRequest.ts
69
70
  src/models/IndexMinimalUserRequest.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @digital8/security-registers-backend-ts-sdk@0.0.630
1
+ ## @digital8/security-registers-backend-ts-sdk@0.0.632
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @digital8/security-registers-backend-ts-sdk@0.0.630 --save
39
+ npm install @digital8/security-registers-backend-ts-sdk@0.0.632 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- 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';
13
+ 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';
14
14
  export interface AuthChangePasswordOperationRequest {
15
15
  authChangePasswordRequest?: AuthChangePasswordRequest;
16
16
  }
@@ -96,6 +96,10 @@ export interface IncidentsUpdateOperationRequest {
96
96
  incident: number;
97
97
  incidentsUpdateRequest?: IncidentsUpdateRequest;
98
98
  }
99
+ export interface IncidentsUpdateTitleOperationRequest {
100
+ incident: number;
101
+ incidentsUpdateTitleRequest?: IncidentsUpdateTitleRequest;
102
+ }
99
103
  export interface IncidentsVersionsRequest {
100
104
  incident: number;
101
105
  }
@@ -581,6 +585,14 @@ export declare class GeneralApi extends runtime.BaseAPI {
581
585
  * Auto-generated: incidents.update
582
586
  */
583
587
  incidentsUpdate(requestParameters: IncidentsUpdateOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource>;
588
+ /**
589
+ * Auto-generated: incidents.updateTitle
590
+ */
591
+ incidentsUpdateTitleRaw(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>>;
592
+ /**
593
+ * Auto-generated: incidents.updateTitle
594
+ */
595
+ incidentsUpdateTitle(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource>;
584
596
  /**
585
597
  * Auto-generated: incidents.versions
586
598
  */
@@ -1633,6 +1633,64 @@ var GeneralApi = /** @class */ (function (_super) {
1633
1633
  });
1634
1634
  });
1635
1635
  };
1636
+ /**
1637
+ * Auto-generated: incidents.updateTitle
1638
+ */
1639
+ GeneralApi.prototype.incidentsUpdateTitleRaw = function (requestParameters, initOverrides) {
1640
+ return __awaiter(this, void 0, void 0, function () {
1641
+ var queryParameters, headerParameters, token, tokenString, urlPath, response;
1642
+ return __generator(this, function (_a) {
1643
+ switch (_a.label) {
1644
+ case 0:
1645
+ if (requestParameters['incident'] == null) {
1646
+ throw new runtime.RequiredError('incident', 'Required parameter "incident" was null or undefined when calling incidentsUpdateTitle().');
1647
+ }
1648
+ queryParameters = {};
1649
+ headerParameters = {};
1650
+ headerParameters['Content-Type'] = 'application/json';
1651
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1652
+ token = this.configuration.accessToken;
1653
+ return [4 /*yield*/, token("bearerAuth", [])];
1654
+ case 1:
1655
+ tokenString = _a.sent();
1656
+ if (tokenString) {
1657
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1658
+ }
1659
+ _a.label = 2;
1660
+ case 2:
1661
+ urlPath = "/api/incidents/{incident}/title";
1662
+ urlPath = urlPath.replace("{".concat("incident", "}"), encodeURIComponent(String(requestParameters['incident'])));
1663
+ return [4 /*yield*/, this.request({
1664
+ path: urlPath,
1665
+ method: 'POST',
1666
+ headers: headerParameters,
1667
+ query: queryParameters,
1668
+ body: (0, index_1.IncidentsUpdateTitleRequestToJSON)(requestParameters['incidentsUpdateTitleRequest']),
1669
+ }, initOverrides)];
1670
+ case 3:
1671
+ response = _a.sent();
1672
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.IncidentResourceFromJSON)(jsonValue); })];
1673
+ }
1674
+ });
1675
+ });
1676
+ };
1677
+ /**
1678
+ * Auto-generated: incidents.updateTitle
1679
+ */
1680
+ GeneralApi.prototype.incidentsUpdateTitle = function (requestParameters, initOverrides) {
1681
+ return __awaiter(this, void 0, void 0, function () {
1682
+ var response;
1683
+ return __generator(this, function (_a) {
1684
+ switch (_a.label) {
1685
+ case 0: return [4 /*yield*/, this.incidentsUpdateTitleRaw(requestParameters, initOverrides)];
1686
+ case 1:
1687
+ response = _a.sent();
1688
+ return [4 /*yield*/, response.value()];
1689
+ case 2: return [2 /*return*/, _a.sent()];
1690
+ }
1691
+ });
1692
+ });
1693
+ };
1636
1694
  /**
1637
1695
  * Auto-generated: incidents.versions
1638
1696
  */
@@ -32,7 +32,7 @@ export interface IncidentImageResource {
32
32
  * @type {string}
33
33
  * @memberof IncidentImageResource
34
34
  */
35
- altText?: string | null;
35
+ altText: string;
36
36
  /**
37
37
  *
38
38
  * @type {number}
@@ -26,6 +26,8 @@ function instanceOfIncidentImageResource(value) {
26
26
  return false;
27
27
  if (!('mimeType' in value) || value['mimeType'] === undefined)
28
28
  return false;
29
+ if (!('altText' in value) || value['altText'] === undefined)
30
+ return false;
29
31
  if (!('assetId' in value) || value['assetId'] === undefined)
30
32
  return false;
31
33
  if (!('url' in value) || value['url'] === undefined)
@@ -42,7 +44,7 @@ function IncidentImageResourceFromJSONTyped(json, ignoreDiscriminator) {
42
44
  return {
43
45
  'fileId': json['file_id'],
44
46
  'mimeType': json['mime_type'],
45
- 'altText': json['alt_text'] == null ? undefined : json['alt_text'],
47
+ 'altText': json['alt_text'],
46
48
  'assetId': json['asset_id'],
47
49
  'url': json['url'],
48
50
  };
@@ -71,6 +71,12 @@ export interface IncidentResource {
71
71
  * @memberof IncidentResource
72
72
  */
73
73
  incidentFieldSchema: IncidentFieldSchemaResource | null;
74
+ /**
75
+ *
76
+ * @type {string}
77
+ * @memberof IncidentResource
78
+ */
79
+ title: string;
74
80
  /**
75
81
  *
76
82
  * @type {string}
@@ -46,6 +46,8 @@ function instanceOfIncidentResource(value) {
46
46
  return false;
47
47
  if (!('incidentFieldSchema' in value) || value['incidentFieldSchema'] === undefined)
48
48
  return false;
49
+ if (!('title' in value) || value['title'] === undefined)
50
+ return false;
49
51
  if (!('fields' in value) || value['fields'] === undefined)
50
52
  return false;
51
53
  if (!('fieldAudits' in value) || value['fieldAudits'] === undefined)
@@ -70,6 +72,7 @@ function IncidentResourceFromJSONTyped(json, ignoreDiscriminator) {
70
72
  'user': (0, UserLiteResource_1.UserLiteResourceFromJSON)(json['user']),
71
73
  'primaryManager': (0, UserLiteResource_1.UserLiteResourceFromJSON)(json['primaryManager']),
72
74
  'incidentFieldSchema': (0, IncidentFieldSchemaResource_1.IncidentFieldSchemaResourceFromJSON)(json['incidentFieldSchema']),
75
+ 'title': json['title'],
73
76
  'approvedBy': json['approvedBy'] == null ? undefined : json['approvedBy'],
74
77
  'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
75
78
  'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
@@ -98,6 +101,7 @@ function IncidentResourceToJSONTyped(value, ignoreDiscriminator) {
98
101
  'user': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['user']),
99
102
  'primaryManager': (0, UserLiteResource_1.UserLiteResourceToJSON)(value['primaryManager']),
100
103
  'incidentFieldSchema': (0, IncidentFieldSchemaResource_1.IncidentFieldSchemaResourceToJSON)(value['incidentFieldSchema']),
104
+ 'title': value['title'],
101
105
  'approvedBy': value['approvedBy'],
102
106
  'approvedAt': value['approvedAt'] === null ? null : ((_a = value['approvedAt']) === null || _a === void 0 ? void 0 : _a.toISOString()),
103
107
  'createdAt': value['createdAt'] === null ? null : ((_b = value['createdAt']) === null || _b === void 0 ? void 0 : _b.toISOString()),
@@ -39,6 +39,12 @@ export interface IncidentsStoreRequest {
39
39
  * @memberof IncidentsStoreRequest
40
40
  */
41
41
  fields: object;
42
+ /**
43
+ * 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.
44
+ * @type {string}
45
+ * @memberof IncidentsStoreRequest
46
+ */
47
+ title?: string | null;
42
48
  }
43
49
  /**
44
50
  * @export
@@ -50,6 +50,7 @@ function IncidentsStoreRequestFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'type': json['type'],
51
51
  'userId': json['user_id'] == null ? undefined : json['user_id'],
52
52
  'fields': json['fields'],
53
+ 'title': json['title'] == null ? undefined : json['title'],
53
54
  };
54
55
  }
55
56
  function IncidentsStoreRequestToJSON(json) {
@@ -65,5 +66,6 @@ function IncidentsStoreRequestToJSONTyped(value, ignoreDiscriminator) {
65
66
  'type': value['type'],
66
67
  'user_id': value['userId'],
67
68
  'fields': value['fields'],
69
+ 'title': value['title'],
68
70
  };
69
71
  }
@@ -21,6 +21,12 @@ export interface IncidentsUpdateRequest {
21
21
  * @memberof IncidentsUpdateRequest
22
22
  */
23
23
  fields: object;
24
+ /**
25
+ * 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.
26
+ * @type {string}
27
+ * @memberof IncidentsUpdateRequest
28
+ */
29
+ title?: string | null;
24
30
  }
25
31
  /**
26
32
  * Check if a given object implements the IncidentsUpdateRequest interface.
@@ -35,6 +35,7 @@ function IncidentsUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
35
35
  }
36
36
  return {
37
37
  'fields': json['fields'],
38
+ 'title': json['title'] == null ? undefined : json['title'],
38
39
  };
39
40
  }
40
41
  function IncidentsUpdateRequestToJSON(json) {
@@ -47,5 +48,6 @@ function IncidentsUpdateRequestToJSONTyped(value, ignoreDiscriminator) {
47
48
  }
48
49
  return {
49
50
  'fields': value['fields'],
51
+ 'title': value['title'],
50
52
  };
51
53
  }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * My API
3
+ * API documentation for my Laravel app
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface IncidentsUpdateTitleRequest
16
+ */
17
+ export interface IncidentsUpdateTitleRequest {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof IncidentsUpdateTitleRequest
22
+ */
23
+ title?: string;
24
+ }
25
+ /**
26
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
27
+ */
28
+ export declare function instanceOfIncidentsUpdateTitleRequest(value: object): value is IncidentsUpdateTitleRequest;
29
+ export declare function IncidentsUpdateTitleRequestFromJSON(json: any): IncidentsUpdateTitleRequest;
30
+ export declare function IncidentsUpdateTitleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentsUpdateTitleRequest;
31
+ export declare function IncidentsUpdateTitleRequestToJSON(json: any): IncidentsUpdateTitleRequest;
32
+ export declare function IncidentsUpdateTitleRequestToJSONTyped(value?: IncidentsUpdateTitleRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * My API
6
+ * API documentation for my Laravel app
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfIncidentsUpdateTitleRequest = instanceOfIncidentsUpdateTitleRequest;
17
+ exports.IncidentsUpdateTitleRequestFromJSON = IncidentsUpdateTitleRequestFromJSON;
18
+ exports.IncidentsUpdateTitleRequestFromJSONTyped = IncidentsUpdateTitleRequestFromJSONTyped;
19
+ exports.IncidentsUpdateTitleRequestToJSON = IncidentsUpdateTitleRequestToJSON;
20
+ exports.IncidentsUpdateTitleRequestToJSONTyped = IncidentsUpdateTitleRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
23
+ */
24
+ function instanceOfIncidentsUpdateTitleRequest(value) {
25
+ return true;
26
+ }
27
+ function IncidentsUpdateTitleRequestFromJSON(json) {
28
+ return IncidentsUpdateTitleRequestFromJSONTyped(json, false);
29
+ }
30
+ function IncidentsUpdateTitleRequestFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'title': json['title'] == null ? undefined : json['title'],
36
+ };
37
+ }
38
+ function IncidentsUpdateTitleRequestToJSON(json) {
39
+ return IncidentsUpdateTitleRequestToJSONTyped(json, false);
40
+ }
41
+ function IncidentsUpdateTitleRequestToJSONTyped(value, ignoreDiscriminator) {
42
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'title': value['title'],
48
+ };
49
+ }
@@ -160,7 +160,7 @@ export interface RegisterListResource {
160
160
  * @type {number}
161
161
  * @memberof RegisterListResource
162
162
  */
163
- signOffLong: number;
163
+ signOffLong?: number | null;
164
164
  /**
165
165
  *
166
166
  * @type {boolean}
@@ -69,8 +69,6 @@ function instanceOfRegisterListResource(value) {
69
69
  return false;
70
70
  if (!('signOnLong' in value) || value['signOnLong'] === undefined)
71
71
  return false;
72
- if (!('signOffLong' in value) || value['signOffLong'] === undefined)
73
- return false;
74
72
  if (!('hasIncidents' in value) || value['hasIncidents'] === undefined)
75
73
  return false;
76
74
  return true;
@@ -106,7 +104,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
106
104
  'signOnLat': json['signOnLat'],
107
105
  'signOnLong': json['signOnLong'],
108
106
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
109
- 'signOffLong': json['signOffLong'],
107
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
110
108
  'hasIncidents': json['hasIncidents'],
111
109
  };
112
110
  }
@@ -118,7 +118,7 @@ export interface RegisterResource {
118
118
  * @type {number}
119
119
  * @memberof RegisterResource
120
120
  */
121
- signOffLong: number;
121
+ signOffLong?: number | null;
122
122
  /**
123
123
  *
124
124
  * @type {string}
@@ -61,8 +61,6 @@ function instanceOfRegisterResource(value) {
61
61
  return false;
62
62
  if (!('signOffLat' in value) || value['signOffLat'] === undefined)
63
63
  return false;
64
- if (!('signOffLong' in value) || value['signOffLong'] === undefined)
65
- return false;
66
64
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
67
65
  return false;
68
66
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined)
@@ -97,7 +95,7 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
97
95
  'signOnLat': json['signOnLat'],
98
96
  'signOnLong': json['signOnLong'],
99
97
  'signOffLat': json['signOffLat'],
100
- 'signOffLong': json['signOffLong'],
98
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
101
99
  'licenceNumber': json['licenceNumber'],
102
100
  'licenceExpiry': json['licenceExpiry'],
103
101
  'licenceFirstName': json['licenceFirstName'],
@@ -33,7 +33,7 @@ export interface SecurityCompanyResource {
33
33
  * @type {string}
34
34
  * @memberof SecurityCompanyResource
35
35
  */
36
- email?: string | null;
36
+ email: string;
37
37
  /**
38
38
  *
39
39
  * @type {boolean}
@@ -25,6 +25,8 @@ var AddressResource_1 = require("./AddressResource");
25
25
  function instanceOfSecurityCompanyResource(value) {
26
26
  if (!('name' in value) || value['name'] === undefined)
27
27
  return false;
28
+ if (!('email' in value) || value['email'] === undefined)
29
+ return false;
28
30
  if (!('isEnabled' in value) || value['isEnabled'] === undefined)
29
31
  return false;
30
32
  if (!('address' in value) || value['address'] === undefined)
@@ -43,7 +45,7 @@ function SecurityCompanyResourceFromJSONTyped(json, ignoreDiscriminator) {
43
45
  return {
44
46
  'id': json['id'] == null ? undefined : json['id'],
45
47
  'name': json['name'],
46
- 'email': json['email'] == null ? undefined : json['email'],
48
+ 'email': json['email'],
47
49
  'isEnabled': json['isEnabled'],
48
50
  'address': (0, AddressResource_1.AddressResourceFromJSON)(json['address']),
49
51
  'licenceNumber': json['licenceNumber'],
@@ -56,6 +56,7 @@ export * from './IncidentsExportPdfRequest';
56
56
  export * from './IncidentsListRequest';
57
57
  export * from './IncidentsStoreRequest';
58
58
  export * from './IncidentsUpdateRequest';
59
+ export * from './IncidentsUpdateTitleRequest';
59
60
  export * from './IncidentsVideosStoreRequest';
60
61
  export * from './IncidentsVideosUploadTokenRequest';
61
62
  export * from './IndexMinimalUserRequest';
@@ -74,6 +74,7 @@ __exportStar(require("./IncidentsExportPdfRequest"), exports);
74
74
  __exportStar(require("./IncidentsListRequest"), exports);
75
75
  __exportStar(require("./IncidentsStoreRequest"), exports);
76
76
  __exportStar(require("./IncidentsUpdateRequest"), exports);
77
+ __exportStar(require("./IncidentsUpdateTitleRequest"), exports);
77
78
  __exportStar(require("./IncidentsVideosStoreRequest"), exports);
78
79
  __exportStar(require("./IncidentsVideosUploadTokenRequest"), exports);
79
80
  __exportStar(require("./IndexMinimalUserRequest"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/security-registers-backend-ts-sdk",
3
- "version": "0.0.630",
3
+ "version": "0.0.632",
4
4
  "description": "OpenAPI client for @digital8/security-registers-backend-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -42,6 +42,7 @@ import type {
42
42
  IncidentsListRequest,
43
43
  IncidentsStoreRequest,
44
44
  IncidentsUpdateRequest,
45
+ IncidentsUpdateTitleRequest,
45
46
  IncidentsVideosStoreRequest,
46
47
  IncidentsVideosUploadTokenRequest,
47
48
  IndexMinimalUserRequest,
@@ -181,6 +182,8 @@ import {
181
182
  IncidentsStoreRequestToJSON,
182
183
  IncidentsUpdateRequestFromJSON,
183
184
  IncidentsUpdateRequestToJSON,
185
+ IncidentsUpdateTitleRequestFromJSON,
186
+ IncidentsUpdateTitleRequestToJSON,
184
187
  IncidentsVideosStoreRequestFromJSON,
185
188
  IncidentsVideosStoreRequestToJSON,
186
189
  IncidentsVideosUploadTokenRequestFromJSON,
@@ -461,6 +464,11 @@ export interface IncidentsUpdateOperationRequest {
461
464
  incidentsUpdateRequest?: IncidentsUpdateRequest;
462
465
  }
463
466
 
467
+ export interface IncidentsUpdateTitleOperationRequest {
468
+ incident: number;
469
+ incidentsUpdateTitleRequest?: IncidentsUpdateTitleRequest;
470
+ }
471
+
464
472
  export interface IncidentsVersionsRequest {
465
473
  incident: number;
466
474
  }
@@ -1995,6 +2003,54 @@ export class GeneralApi extends runtime.BaseAPI {
1995
2003
  return await response.value();
1996
2004
  }
1997
2005
 
2006
+ /**
2007
+ * Auto-generated: incidents.updateTitle
2008
+ */
2009
+ async incidentsUpdateTitleRaw(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IncidentResource>> {
2010
+ if (requestParameters['incident'] == null) {
2011
+ throw new runtime.RequiredError(
2012
+ 'incident',
2013
+ 'Required parameter "incident" was null or undefined when calling incidentsUpdateTitle().'
2014
+ );
2015
+ }
2016
+
2017
+ const queryParameters: any = {};
2018
+
2019
+ const headerParameters: runtime.HTTPHeaders = {};
2020
+
2021
+ headerParameters['Content-Type'] = 'application/json';
2022
+
2023
+ if (this.configuration && this.configuration.accessToken) {
2024
+ const token = this.configuration.accessToken;
2025
+ const tokenString = await token("bearerAuth", []);
2026
+
2027
+ if (tokenString) {
2028
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2029
+ }
2030
+ }
2031
+
2032
+ let urlPath = `/api/incidents/{incident}/title`;
2033
+ urlPath = urlPath.replace(`{${"incident"}}`, encodeURIComponent(String(requestParameters['incident'])));
2034
+
2035
+ const response = await this.request({
2036
+ path: urlPath,
2037
+ method: 'POST',
2038
+ headers: headerParameters,
2039
+ query: queryParameters,
2040
+ body: IncidentsUpdateTitleRequestToJSON(requestParameters['incidentsUpdateTitleRequest']),
2041
+ }, initOverrides);
2042
+
2043
+ return new runtime.JSONApiResponse(response, (jsonValue) => IncidentResourceFromJSON(jsonValue));
2044
+ }
2045
+
2046
+ /**
2047
+ * Auto-generated: incidents.updateTitle
2048
+ */
2049
+ async incidentsUpdateTitle(requestParameters: IncidentsUpdateTitleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IncidentResource> {
2050
+ const response = await this.incidentsUpdateTitleRaw(requestParameters, initOverrides);
2051
+ return await response.value();
2052
+ }
2053
+
1998
2054
  /**
1999
2055
  * Auto-generated: incidents.versions
2000
2056
  */
@@ -36,7 +36,7 @@ export interface IncidentImageResource {
36
36
  * @type {string}
37
37
  * @memberof IncidentImageResource
38
38
  */
39
- altText?: string | null;
39
+ altText: string;
40
40
  /**
41
41
  *
42
42
  * @type {number}
@@ -57,6 +57,7 @@ export interface IncidentImageResource {
57
57
  export function instanceOfIncidentImageResource(value: object): value is IncidentImageResource {
58
58
  if (!('fileId' in value) || value['fileId'] === undefined) return false;
59
59
  if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
60
+ if (!('altText' in value) || value['altText'] === undefined) return false;
60
61
  if (!('assetId' in value) || value['assetId'] === undefined) return false;
61
62
  if (!('url' in value) || value['url'] === undefined) return false;
62
63
  return true;
@@ -74,7 +75,7 @@ export function IncidentImageResourceFromJSONTyped(json: any, ignoreDiscriminato
74
75
 
75
76
  'fileId': json['file_id'],
76
77
  'mimeType': json['mime_type'],
77
- 'altText': json['alt_text'] == null ? undefined : json['alt_text'],
78
+ 'altText': json['alt_text'],
78
79
  'assetId': json['asset_id'],
79
80
  'url': json['url'],
80
81
  };
@@ -124,6 +124,12 @@ export interface IncidentResource {
124
124
  * @memberof IncidentResource
125
125
  */
126
126
  incidentFieldSchema: IncidentFieldSchemaResource | null;
127
+ /**
128
+ *
129
+ * @type {string}
130
+ * @memberof IncidentResource
131
+ */
132
+ title: string;
127
133
  /**
128
134
  *
129
135
  * @type {string}
@@ -186,6 +192,7 @@ export function instanceOfIncidentResource(value: object): value is IncidentReso
186
192
  if (!('user' in value) || value['user'] === undefined) return false;
187
193
  if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
188
194
  if (!('incidentFieldSchema' in value) || value['incidentFieldSchema'] === undefined) return false;
195
+ if (!('title' in value) || value['title'] === undefined) return false;
189
196
  if (!('fields' in value) || value['fields'] === undefined) return false;
190
197
  if (!('fieldAudits' in value) || value['fieldAudits'] === undefined) return false;
191
198
  if (!('videos' in value) || value['videos'] === undefined) return false;
@@ -210,6 +217,7 @@ export function IncidentResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
210
217
  'user': UserLiteResourceFromJSON(json['user']),
211
218
  'primaryManager': UserLiteResourceFromJSON(json['primaryManager']),
212
219
  'incidentFieldSchema': IncidentFieldSchemaResourceFromJSON(json['incidentFieldSchema']),
220
+ 'title': json['title'],
213
221
  'approvedBy': json['approvedBy'] == null ? undefined : json['approvedBy'],
214
222
  'approvedAt': json['approvedAt'] == null ? undefined : (new Date(json['approvedAt'])),
215
223
  'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
@@ -240,6 +248,7 @@ export function IncidentResourceToJSONTyped(value?: IncidentResource | null, ign
240
248
  'user': UserLiteResourceToJSON(value['user']),
241
249
  'primaryManager': UserLiteResourceToJSON(value['primaryManager']),
242
250
  'incidentFieldSchema': IncidentFieldSchemaResourceToJSON(value['incidentFieldSchema']),
251
+ 'title': value['title'],
243
252
  'approvedBy': value['approvedBy'],
244
253
  'approvedAt': value['approvedAt'] === null ? null : ((value['approvedAt'] as any)?.toISOString()),
245
254
  'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
@@ -43,6 +43,12 @@ export interface IncidentsStoreRequest {
43
43
  * @memberof IncidentsStoreRequest
44
44
  */
45
45
  fields: object;
46
+ /**
47
+ * 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.
48
+ * @type {string}
49
+ * @memberof IncidentsStoreRequest
50
+ */
51
+ title?: string | null;
46
52
  }
47
53
 
48
54
 
@@ -80,6 +86,7 @@ export function IncidentsStoreRequestFromJSONTyped(json: any, ignoreDiscriminato
80
86
  'type': json['type'],
81
87
  'userId': json['user_id'] == null ? undefined : json['user_id'],
82
88
  'fields': json['fields'],
89
+ 'title': json['title'] == null ? undefined : json['title'],
83
90
  };
84
91
  }
85
92
 
@@ -98,6 +105,7 @@ export function IncidentsStoreRequestToJSONTyped(value?: IncidentsStoreRequest |
98
105
  'type': value['type'],
99
106
  'user_id': value['userId'],
100
107
  'fields': value['fields'],
108
+ 'title': value['title'],
101
109
  };
102
110
  }
103
111
 
@@ -25,6 +25,12 @@ export interface IncidentsUpdateRequest {
25
25
  * @memberof IncidentsUpdateRequest
26
26
  */
27
27
  fields: object;
28
+ /**
29
+ * 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.
30
+ * @type {string}
31
+ * @memberof IncidentsUpdateRequest
32
+ */
33
+ title?: string | null;
28
34
  }
29
35
 
30
36
  /**
@@ -46,6 +52,7 @@ export function IncidentsUpdateRequestFromJSONTyped(json: any, ignoreDiscriminat
46
52
  return {
47
53
 
48
54
  'fields': json['fields'],
55
+ 'title': json['title'] == null ? undefined : json['title'],
49
56
  };
50
57
  }
51
58
 
@@ -61,6 +68,7 @@ export function IncidentsUpdateRequestToJSONTyped(value?: IncidentsUpdateRequest
61
68
  return {
62
69
 
63
70
  'fields': value['fields'],
71
+ 'title': value['title'],
64
72
  };
65
73
  }
66
74
 
@@ -0,0 +1,65 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * My API
5
+ * API documentation for my Laravel app
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface IncidentsUpdateTitleRequest
20
+ */
21
+ export interface IncidentsUpdateTitleRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof IncidentsUpdateTitleRequest
26
+ */
27
+ title?: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the IncidentsUpdateTitleRequest interface.
32
+ */
33
+ export function instanceOfIncidentsUpdateTitleRequest(value: object): value is IncidentsUpdateTitleRequest {
34
+ return true;
35
+ }
36
+
37
+ export function IncidentsUpdateTitleRequestFromJSON(json: any): IncidentsUpdateTitleRequest {
38
+ return IncidentsUpdateTitleRequestFromJSONTyped(json, false);
39
+ }
40
+
41
+ export function IncidentsUpdateTitleRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentsUpdateTitleRequest {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+
47
+ 'title': json['title'] == null ? undefined : json['title'],
48
+ };
49
+ }
50
+
51
+ export function IncidentsUpdateTitleRequestToJSON(json: any): IncidentsUpdateTitleRequest {
52
+ return IncidentsUpdateTitleRequestToJSONTyped(json, false);
53
+ }
54
+
55
+ export function IncidentsUpdateTitleRequestToJSONTyped(value?: IncidentsUpdateTitleRequest | null, ignoreDiscriminator: boolean = false): any {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+
60
+ return {
61
+
62
+ 'title': value['title'],
63
+ };
64
+ }
65
+
@@ -177,7 +177,7 @@ export interface RegisterListResource {
177
177
  * @type {number}
178
178
  * @memberof RegisterListResource
179
179
  */
180
- signOffLong: number;
180
+ signOffLong?: number | null;
181
181
  /**
182
182
  *
183
183
  * @type {boolean}
@@ -220,7 +220,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
220
220
  if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
221
221
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
222
222
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
223
- if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
224
223
  if (!('hasIncidents' in value) || value['hasIncidents'] === undefined) return false;
225
224
  return true;
226
225
  }
@@ -258,7 +257,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
258
257
  'signOnLat': json['signOnLat'],
259
258
  'signOnLong': json['signOnLong'],
260
259
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
261
- 'signOffLong': json['signOffLong'],
260
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
262
261
  'hasIncidents': json['hasIncidents'],
263
262
  };
264
263
  }
@@ -135,7 +135,7 @@ export interface RegisterResource {
135
135
  * @type {number}
136
136
  * @memberof RegisterResource
137
137
  */
138
- signOffLong: number;
138
+ signOffLong?: number | null;
139
139
  /**
140
140
  *
141
141
  * @type {string}
@@ -216,7 +216,6 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
216
216
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
217
217
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
218
218
  if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
219
- if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
220
219
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
221
220
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
222
221
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -250,7 +249,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
250
249
  'signOnLat': json['signOnLat'],
251
250
  'signOnLong': json['signOnLong'],
252
251
  'signOffLat': json['signOffLat'],
253
- 'signOffLong': json['signOffLong'],
252
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
254
253
  'licenceNumber': json['licenceNumber'],
255
254
  'licenceExpiry': json['licenceExpiry'],
256
255
  'licenceFirstName': json['licenceFirstName'],
@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
44
44
  * @type {string}
45
45
  * @memberof SecurityCompanyResource
46
46
  */
47
- email?: string | null;
47
+ email: string;
48
48
  /**
49
49
  *
50
50
  * @type {boolean}
@@ -82,6 +82,7 @@ export interface SecurityCompanyResource {
82
82
  */
83
83
  export function instanceOfSecurityCompanyResource(value: object): value is SecurityCompanyResource {
84
84
  if (!('name' in value) || value['name'] === undefined) return false;
85
+ if (!('email' in value) || value['email'] === undefined) return false;
85
86
  if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
86
87
  if (!('address' in value) || value['address'] === undefined) return false;
87
88
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -100,7 +101,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
100
101
 
101
102
  'id': json['id'] == null ? undefined : json['id'],
102
103
  'name': json['name'],
103
- 'email': json['email'] == null ? undefined : json['email'],
104
+ 'email': json['email'],
104
105
  'isEnabled': json['isEnabled'],
105
106
  'address': AddressResourceFromJSON(json['address']),
106
107
  'licenceNumber': json['licenceNumber'],
@@ -58,6 +58,7 @@ export * from './IncidentsExportPdfRequest';
58
58
  export * from './IncidentsListRequest';
59
59
  export * from './IncidentsStoreRequest';
60
60
  export * from './IncidentsUpdateRequest';
61
+ export * from './IncidentsUpdateTitleRequest';
61
62
  export * from './IncidentsVideosStoreRequest';
62
63
  export * from './IncidentsVideosUploadTokenRequest';
63
64
  export * from './IndexMinimalUserRequest';