@digital8/security-registers-backend-ts-sdk 0.0.510 → 0.0.512
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.
- package/README.md +2 -2
- package/dist/models/IncidentImageResource.d.ts +1 -1
- package/dist/models/IncidentImageResource.js +3 -1
- package/dist/models/IncidentsStoreRequest.d.ts +6 -0
- package/dist/models/IncidentsStoreRequest.js +2 -0
- package/dist/models/NotificationPreferenceResource.d.ts +0 -1
- package/dist/models/NotificationPreferenceResource.js +0 -1
- package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.d.ts +0 -1
- package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.js +0 -1
- package/dist/models/NotificationPreferencesStoreRequest.d.ts +0 -1
- package/dist/models/NotificationPreferencesStoreRequest.js +0 -1
- package/dist/models/RegisterListResource.d.ts +1 -1
- package/dist/models/RegisterListResource.js +1 -3
- package/dist/models/RegisterResource.d.ts +2 -2
- package/dist/models/RegisterResource.js +6 -2
- package/package.json +1 -1
- package/src/models/IncidentImageResource.ts +3 -2
- package/src/models/IncidentsStoreRequest.ts +8 -0
- package/src/models/NotificationPreferenceResource.ts +0 -1
- package/src/models/NotificationPreferencesBulkRequestPreferencesInner.ts +0 -1
- package/src/models/NotificationPreferencesStoreRequest.ts +0 -1
- package/src/models/RegisterListResource.ts +2 -3
- package/src/models/RegisterResource.ts +6 -4
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @digital8/security-registers-backend-ts-sdk@0.0.
|
|
1
|
+
## @digital8/security-registers-backend-ts-sdk@0.0.512
|
|
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.
|
|
39
|
+
npm install @digital8/security-registers-backend-ts-sdk@0.0.512 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -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']
|
|
47
|
+
'altText': json['alt_text'],
|
|
46
48
|
'assetId': json['asset_id'],
|
|
47
49
|
'url': json['url'],
|
|
48
50
|
};
|
|
@@ -27,6 +27,12 @@ export interface IncidentsStoreRequest {
|
|
|
27
27
|
* @memberof IncidentsStoreRequest
|
|
28
28
|
*/
|
|
29
29
|
type: IncidentsStoreRequestTypeEnum;
|
|
30
|
+
/**
|
|
31
|
+
* The id of the user this incident will belong to. Required when the caller is an admin or super-admin (they can never own incidents themselves); ignored otherwise. Must reference a venue manager, venue staff, or venue guard who has access to the nominated venue.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof IncidentsStoreRequest
|
|
34
|
+
*/
|
|
35
|
+
userId?: number;
|
|
30
36
|
/**
|
|
31
37
|
* Dynamic fields keyed by section key. Each section is an object of field_key => value. Object fields with repeatable=true are submitted as `{ items: [ { ...subfields } ] }` (no id on create — server assigns one). Shape is driven by the venue state's IncidentFieldSchema.
|
|
32
38
|
* @type {object}
|
|
@@ -48,6 +48,7 @@ function IncidentsStoreRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
48
48
|
return {
|
|
49
49
|
'venueId': json['venue_id'],
|
|
50
50
|
'type': json['type'],
|
|
51
|
+
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
|
51
52
|
'fields': json['fields'],
|
|
52
53
|
};
|
|
53
54
|
}
|
|
@@ -62,6 +63,7 @@ function IncidentsStoreRequestToJSONTyped(value, ignoreDiscriminator) {
|
|
|
62
63
|
return {
|
|
63
64
|
'venue_id': value['venueId'],
|
|
64
65
|
'type': value['type'],
|
|
66
|
+
'user_id': value['userId'],
|
|
65
67
|
'fields': value['fields'],
|
|
66
68
|
};
|
|
67
69
|
}
|
|
@@ -63,7 +63,6 @@ export declare const NotificationPreferenceResourceNotificationTypeEnum: {
|
|
|
63
63
|
readonly NonSignOn: "non_sign_on";
|
|
64
64
|
readonly SignOnRejected: "sign_on_rejected";
|
|
65
65
|
readonly LicenceUpdated: "licence_updated";
|
|
66
|
-
readonly LicenceExpiringSoon: "licence_expiring_soon";
|
|
67
66
|
readonly ExportReady: "export_ready";
|
|
68
67
|
readonly ExportFailed: "export_failed";
|
|
69
68
|
};
|
|
@@ -30,7 +30,6 @@ exports.NotificationPreferenceResourceNotificationTypeEnum = {
|
|
|
30
30
|
NonSignOn: 'non_sign_on',
|
|
31
31
|
SignOnRejected: 'sign_on_rejected',
|
|
32
32
|
LicenceUpdated: 'licence_updated',
|
|
33
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
34
33
|
ExportReady: 'export_ready',
|
|
35
34
|
ExportFailed: 'export_failed'
|
|
36
35
|
};
|
|
@@ -44,7 +44,6 @@ export declare const NotificationPreferencesBulkRequestPreferencesInnerNotificat
|
|
|
44
44
|
readonly NonSignOn: "non_sign_on";
|
|
45
45
|
readonly SignOnRejected: "sign_on_rejected";
|
|
46
46
|
readonly LicenceUpdated: "licence_updated";
|
|
47
|
-
readonly LicenceExpiringSoon: "licence_expiring_soon";
|
|
48
47
|
readonly ExportReady: "export_ready";
|
|
49
48
|
readonly ExportFailed: "export_failed";
|
|
50
49
|
};
|
|
@@ -29,7 +29,6 @@ exports.NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum =
|
|
|
29
29
|
NonSignOn: 'non_sign_on',
|
|
30
30
|
SignOnRejected: 'sign_on_rejected',
|
|
31
31
|
LicenceUpdated: 'licence_updated',
|
|
32
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
33
32
|
ExportReady: 'export_ready',
|
|
34
33
|
ExportFailed: 'export_failed'
|
|
35
34
|
};
|
|
@@ -44,7 +44,6 @@ export declare const NotificationPreferencesStoreRequestNotificationTypeEnum: {
|
|
|
44
44
|
readonly NonSignOn: "non_sign_on";
|
|
45
45
|
readonly SignOnRejected: "sign_on_rejected";
|
|
46
46
|
readonly LicenceUpdated: "licence_updated";
|
|
47
|
-
readonly LicenceExpiringSoon: "licence_expiring_soon";
|
|
48
47
|
readonly ExportReady: "export_ready";
|
|
49
48
|
readonly ExportFailed: "export_failed";
|
|
50
49
|
};
|
|
@@ -29,7 +29,6 @@ exports.NotificationPreferencesStoreRequestNotificationTypeEnum = {
|
|
|
29
29
|
NonSignOn: 'non_sign_on',
|
|
30
30
|
SignOnRejected: 'sign_on_rejected',
|
|
31
31
|
LicenceUpdated: 'licence_updated',
|
|
32
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
33
32
|
ExportReady: 'export_ready',
|
|
34
33
|
ExportFailed: 'export_failed'
|
|
35
34
|
};
|
|
@@ -67,8 +67,6 @@ function instanceOfRegisterListResource(value) {
|
|
|
67
67
|
return false;
|
|
68
68
|
if (!('signOnLong' in value) || value['signOnLong'] === undefined)
|
|
69
69
|
return false;
|
|
70
|
-
if (!('signOffLat' in value) || value['signOffLat'] === undefined)
|
|
71
|
-
return false;
|
|
72
70
|
if (!('signOffLong' in value) || value['signOffLong'] === undefined)
|
|
73
71
|
return false;
|
|
74
72
|
if (!('hasIncidents' in value) || value['hasIncidents'] === undefined)
|
|
@@ -104,7 +102,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
104
102
|
'firstAid': json['firstAid'],
|
|
105
103
|
'signOnLat': json['signOnLat'],
|
|
106
104
|
'signOnLong': json['signOnLong'],
|
|
107
|
-
'signOffLat': json['signOffLat'],
|
|
105
|
+
'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
|
|
108
106
|
'signOffLong': json['signOffLong'],
|
|
109
107
|
'hasIncidents': json['hasIncidents'],
|
|
110
108
|
};
|
|
@@ -106,13 +106,13 @@ export interface RegisterResource {
|
|
|
106
106
|
* @type {number}
|
|
107
107
|
* @memberof RegisterResource
|
|
108
108
|
*/
|
|
109
|
-
signOffLat
|
|
109
|
+
signOffLat: number;
|
|
110
110
|
/**
|
|
111
111
|
*
|
|
112
112
|
* @type {number}
|
|
113
113
|
* @memberof RegisterResource
|
|
114
114
|
*/
|
|
115
|
-
signOffLong
|
|
115
|
+
signOffLong: number;
|
|
116
116
|
/**
|
|
117
117
|
*
|
|
118
118
|
* @type {string}
|
|
@@ -57,6 +57,10 @@ function instanceOfRegisterResource(value) {
|
|
|
57
57
|
return false;
|
|
58
58
|
if (!('signOnLong' in value) || value['signOnLong'] === undefined)
|
|
59
59
|
return false;
|
|
60
|
+
if (!('signOffLat' in value) || value['signOffLat'] === undefined)
|
|
61
|
+
return false;
|
|
62
|
+
if (!('signOffLong' in value) || value['signOffLong'] === undefined)
|
|
63
|
+
return false;
|
|
60
64
|
if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
|
|
61
65
|
return false;
|
|
62
66
|
if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined)
|
|
@@ -89,8 +93,8 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
89
93
|
'firstAidImage': json['firstAidImage'],
|
|
90
94
|
'signOnLat': json['signOnLat'],
|
|
91
95
|
'signOnLong': json['signOnLong'],
|
|
92
|
-
'signOffLat': json['signOffLat']
|
|
93
|
-
'signOffLong': json['signOffLong']
|
|
96
|
+
'signOffLat': json['signOffLat'],
|
|
97
|
+
'signOffLong': json['signOffLong'],
|
|
94
98
|
'licenceNumber': json['licenceNumber'],
|
|
95
99
|
'licenceExpiry': json['licenceExpiry'],
|
|
96
100
|
'licenceFirstName': json['licenceFirstName'],
|
package/package.json
CHANGED
|
@@ -36,7 +36,7 @@ export interface IncidentImageResource {
|
|
|
36
36
|
* @type {string}
|
|
37
37
|
* @memberof IncidentImageResource
|
|
38
38
|
*/
|
|
39
|
-
altText
|
|
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']
|
|
78
|
+
'altText': json['alt_text'],
|
|
78
79
|
'assetId': json['asset_id'],
|
|
79
80
|
'url': json['url'],
|
|
80
81
|
};
|
|
@@ -31,6 +31,12 @@ export interface IncidentsStoreRequest {
|
|
|
31
31
|
* @memberof IncidentsStoreRequest
|
|
32
32
|
*/
|
|
33
33
|
type: IncidentsStoreRequestTypeEnum;
|
|
34
|
+
/**
|
|
35
|
+
* The id of the user this incident will belong to. Required when the caller is an admin or super-admin (they can never own incidents themselves); ignored otherwise. Must reference a venue manager, venue staff, or venue guard who has access to the nominated venue.
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof IncidentsStoreRequest
|
|
38
|
+
*/
|
|
39
|
+
userId?: number;
|
|
34
40
|
/**
|
|
35
41
|
* Dynamic fields keyed by section key. Each section is an object of field_key => value. Object fields with repeatable=true are submitted as `{ items: [ { ...subfields } ] }` (no id on create — server assigns one). Shape is driven by the venue state's IncidentFieldSchema.
|
|
36
42
|
* @type {object}
|
|
@@ -72,6 +78,7 @@ export function IncidentsStoreRequestFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
72
78
|
|
|
73
79
|
'venueId': json['venue_id'],
|
|
74
80
|
'type': json['type'],
|
|
81
|
+
'userId': json['user_id'] == null ? undefined : json['user_id'],
|
|
75
82
|
'fields': json['fields'],
|
|
76
83
|
};
|
|
77
84
|
}
|
|
@@ -89,6 +96,7 @@ export function IncidentsStoreRequestToJSONTyped(value?: IncidentsStoreRequest |
|
|
|
89
96
|
|
|
90
97
|
'venue_id': value['venueId'],
|
|
91
98
|
'type': value['type'],
|
|
99
|
+
'user_id': value['userId'],
|
|
92
100
|
'fields': value['fields'],
|
|
93
101
|
};
|
|
94
102
|
}
|
|
@@ -76,7 +76,6 @@ export const NotificationPreferenceResourceNotificationTypeEnum = {
|
|
|
76
76
|
NonSignOn: 'non_sign_on',
|
|
77
77
|
SignOnRejected: 'sign_on_rejected',
|
|
78
78
|
LicenceUpdated: 'licence_updated',
|
|
79
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
80
79
|
ExportReady: 'export_ready',
|
|
81
80
|
ExportFailed: 'export_failed'
|
|
82
81
|
} as const;
|
|
@@ -50,7 +50,6 @@ export const NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeE
|
|
|
50
50
|
NonSignOn: 'non_sign_on',
|
|
51
51
|
SignOnRejected: 'sign_on_rejected',
|
|
52
52
|
LicenceUpdated: 'licence_updated',
|
|
53
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
54
53
|
ExportReady: 'export_ready',
|
|
55
54
|
ExportFailed: 'export_failed'
|
|
56
55
|
} as const;
|
|
@@ -50,7 +50,6 @@ export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
|
|
|
50
50
|
NonSignOn: 'non_sign_on',
|
|
51
51
|
SignOnRejected: 'sign_on_rejected',
|
|
52
52
|
LicenceUpdated: 'licence_updated',
|
|
53
|
-
LicenceExpiringSoon: 'licence_expiring_soon',
|
|
54
53
|
ExportReady: 'export_ready',
|
|
55
54
|
ExportFailed: 'export_failed'
|
|
56
55
|
} as const;
|
|
@@ -165,7 +165,7 @@ export interface RegisterListResource {
|
|
|
165
165
|
* @type {number}
|
|
166
166
|
* @memberof RegisterListResource
|
|
167
167
|
*/
|
|
168
|
-
signOffLat
|
|
168
|
+
signOffLat?: number | null;
|
|
169
169
|
/**
|
|
170
170
|
*
|
|
171
171
|
* @type {number}
|
|
@@ -213,7 +213,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
|
|
|
213
213
|
if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
|
|
214
214
|
if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
|
|
215
215
|
if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
|
|
216
|
-
if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
|
|
217
216
|
if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
|
|
218
217
|
if (!('hasIncidents' in value) || value['hasIncidents'] === undefined) return false;
|
|
219
218
|
return true;
|
|
@@ -250,7 +249,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
250
249
|
'firstAid': json['firstAid'],
|
|
251
250
|
'signOnLat': json['signOnLat'],
|
|
252
251
|
'signOnLong': json['signOnLong'],
|
|
253
|
-
'signOffLat': json['signOffLat'],
|
|
252
|
+
'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
|
|
254
253
|
'signOffLong': json['signOffLong'],
|
|
255
254
|
'hasIncidents': json['hasIncidents'],
|
|
256
255
|
};
|
|
@@ -123,13 +123,13 @@ export interface RegisterResource {
|
|
|
123
123
|
* @type {number}
|
|
124
124
|
* @memberof RegisterResource
|
|
125
125
|
*/
|
|
126
|
-
signOffLat
|
|
126
|
+
signOffLat: number;
|
|
127
127
|
/**
|
|
128
128
|
*
|
|
129
129
|
* @type {number}
|
|
130
130
|
* @memberof RegisterResource
|
|
131
131
|
*/
|
|
132
|
-
signOffLong
|
|
132
|
+
signOffLong: number;
|
|
133
133
|
/**
|
|
134
134
|
*
|
|
135
135
|
* @type {string}
|
|
@@ -208,6 +208,8 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
|
|
|
208
208
|
if (!('firstAidImage' in value) || value['firstAidImage'] === undefined) return false;
|
|
209
209
|
if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
|
|
210
210
|
if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
|
|
211
|
+
if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
|
|
212
|
+
if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
|
|
211
213
|
if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
|
|
212
214
|
if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
|
|
213
215
|
if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
|
|
@@ -239,8 +241,8 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
239
241
|
'firstAidImage': json['firstAidImage'],
|
|
240
242
|
'signOnLat': json['signOnLat'],
|
|
241
243
|
'signOnLong': json['signOnLong'],
|
|
242
|
-
'signOffLat': json['signOffLat']
|
|
243
|
-
'signOffLong': json['signOffLong']
|
|
244
|
+
'signOffLat': json['signOffLat'],
|
|
245
|
+
'signOffLong': json['signOffLong'],
|
|
244
246
|
'licenceNumber': json['licenceNumber'],
|
|
245
247
|
'licenceExpiry': json['licenceExpiry'],
|
|
246
248
|
'licenceFirstName': json['licenceFirstName'],
|