@digital8/security-registers-backend-ts-sdk 0.0.390 → 0.0.392

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 (36) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +46 -1
  4. package/dist/apis/GeneralApi.js +225 -0
  5. package/dist/models/AssetResource.d.ts +1 -1
  6. package/dist/models/AssetResource.js +3 -1
  7. package/dist/models/NotificationPreferencesBulkRequest.d.ts +33 -0
  8. package/dist/models/NotificationPreferencesBulkRequest.js +52 -0
  9. package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.d.ts +56 -0
  10. package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.js +69 -0
  11. package/dist/models/NotificationTypeResource.d.ts +6 -0
  12. package/dist/models/NotificationTypeResource.js +4 -0
  13. package/dist/models/RegisterListResource.d.ts +5 -5
  14. package/dist/models/RegisterListResource.js +8 -7
  15. package/dist/models/RegisterResource.d.ts +1 -1
  16. package/dist/models/RegisterResource.js +3 -1
  17. package/dist/models/RosterLiteResource.d.ts +1 -1
  18. package/dist/models/RosterLiteResource.js +4 -3
  19. package/dist/models/RosterWithRegistersResource.d.ts +1 -1
  20. package/dist/models/RosterWithRegistersResource.js +3 -4
  21. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  22. package/dist/models/SecurityCompanyResource.js +1 -3
  23. package/dist/models/index.d.ts +2 -0
  24. package/dist/models/index.js +2 -0
  25. package/package.json +1 -1
  26. package/src/apis/GeneralApi.ts +198 -0
  27. package/src/models/AssetResource.ts +3 -2
  28. package/src/models/NotificationPreferencesBulkRequest.ts +74 -0
  29. package/src/models/NotificationPreferencesBulkRequestPreferencesInner.ts +98 -0
  30. package/src/models/NotificationTypeResource.ts +9 -0
  31. package/src/models/RegisterListResource.ts +11 -10
  32. package/src/models/RegisterResource.ts +3 -2
  33. package/src/models/RosterLiteResource.ts +4 -3
  34. package/src/models/RosterWithRegistersResource.ts +3 -4
  35. package/src/models/SecurityCompanyResource.ts +2 -3
  36. package/src/models/index.ts +2 -0
@@ -0,0 +1,98 @@
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 NotificationPreferencesBulkRequestPreferencesInner
20
+ */
21
+ export interface NotificationPreferencesBulkRequestPreferencesInner {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof NotificationPreferencesBulkRequestPreferencesInner
26
+ */
27
+ notificationType: NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum;
28
+ /**
29
+ *
30
+ * @type {number}
31
+ * @memberof NotificationPreferencesBulkRequestPreferencesInner
32
+ */
33
+ venueId?: number;
34
+ /**
35
+ *
36
+ * @type {boolean}
37
+ * @memberof NotificationPreferencesBulkRequestPreferencesInner
38
+ */
39
+ enabled: boolean;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum = {
47
+ IncidentAdded: 'incident_added',
48
+ IncidentPendingReminder: 'incident_pending_reminder',
49
+ NonSignOff: 'non_sign_off',
50
+ NonSignOn: 'non_sign_on',
51
+ SignOnRejected: 'sign_on_rejected',
52
+ LicenceUpdated: 'licence_updated'
53
+ } as const;
54
+ export type NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum = typeof NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum[keyof typeof NotificationPreferencesBulkRequestPreferencesInnerNotificationTypeEnum];
55
+
56
+
57
+ /**
58
+ * Check if a given object implements the NotificationPreferencesBulkRequestPreferencesInner interface.
59
+ */
60
+ export function instanceOfNotificationPreferencesBulkRequestPreferencesInner(value: object): value is NotificationPreferencesBulkRequestPreferencesInner {
61
+ if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
62
+ if (!('enabled' in value) || value['enabled'] === undefined) return false;
63
+ return true;
64
+ }
65
+
66
+ export function NotificationPreferencesBulkRequestPreferencesInnerFromJSON(json: any): NotificationPreferencesBulkRequestPreferencesInner {
67
+ return NotificationPreferencesBulkRequestPreferencesInnerFromJSONTyped(json, false);
68
+ }
69
+
70
+ export function NotificationPreferencesBulkRequestPreferencesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferencesBulkRequestPreferencesInner {
71
+ if (json == null) {
72
+ return json;
73
+ }
74
+ return {
75
+
76
+ 'notificationType': json['notification_type'],
77
+ 'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
78
+ 'enabled': json['enabled'],
79
+ };
80
+ }
81
+
82
+ export function NotificationPreferencesBulkRequestPreferencesInnerToJSON(json: any): NotificationPreferencesBulkRequestPreferencesInner {
83
+ return NotificationPreferencesBulkRequestPreferencesInnerToJSONTyped(json, false);
84
+ }
85
+
86
+ export function NotificationPreferencesBulkRequestPreferencesInnerToJSONTyped(value?: NotificationPreferencesBulkRequestPreferencesInner | null, ignoreDiscriminator: boolean = false): any {
87
+ if (value == null) {
88
+ return value;
89
+ }
90
+
91
+ return {
92
+
93
+ 'notification_type': value['notificationType'],
94
+ 'venue_id': value['venueId'],
95
+ 'enabled': value['enabled'],
96
+ };
97
+ }
98
+
@@ -31,6 +31,12 @@ export interface NotificationTypeResource {
31
31
  * @memberof NotificationTypeResource
32
32
  */
33
33
  label: string;
34
+ /**
35
+ *
36
+ * @type {boolean}
37
+ * @memberof NotificationTypeResource
38
+ */
39
+ supportsPerVenueOverride: boolean;
34
40
  }
35
41
 
36
42
  /**
@@ -39,6 +45,7 @@ export interface NotificationTypeResource {
39
45
  export function instanceOfNotificationTypeResource(value: object): value is NotificationTypeResource {
40
46
  if (!('value' in value) || value['value'] === undefined) return false;
41
47
  if (!('label' in value) || value['label'] === undefined) return false;
48
+ if (!('supportsPerVenueOverride' in value) || value['supportsPerVenueOverride'] === undefined) return false;
42
49
  return true;
43
50
  }
44
51
 
@@ -54,6 +61,7 @@ export function NotificationTypeResourceFromJSONTyped(json: any, ignoreDiscrimin
54
61
 
55
62
  'value': json['value'],
56
63
  'label': json['label'],
64
+ 'supportsPerVenueOverride': json['supportsPerVenueOverride'],
57
65
  };
58
66
  }
59
67
 
@@ -70,6 +78,7 @@ export function NotificationTypeResourceToJSONTyped(value?: NotificationTypeReso
70
78
 
71
79
  'value': value['value'],
72
80
  'label': value['label'],
81
+ 'supportsPerVenueOverride': value['supportsPerVenueOverride'],
73
82
  };
74
83
  }
75
84
 
@@ -63,13 +63,13 @@ export interface RegisterListResource {
63
63
  * @type {Date}
64
64
  * @memberof RegisterListResource
65
65
  */
66
- finishDateTime?: Date | null;
66
+ finishDateTime: Date;
67
67
  /**
68
68
  *
69
- * @type {object}
69
+ * @type {string}
70
70
  * @memberof RegisterListResource
71
71
  */
72
- shiftLength: object;
72
+ shiftLength: string;
73
73
  /**
74
74
  *
75
75
  * @type {number}
@@ -81,7 +81,7 @@ export interface RegisterListResource {
81
81
  * @type {string}
82
82
  * @memberof RegisterListResource
83
83
  */
84
- badgeNumber: string;
84
+ badgeNumber?: string | null;
85
85
  /**
86
86
  *
87
87
  * @type {Date}
@@ -171,7 +171,7 @@ export interface RegisterListResource {
171
171
  * @type {number}
172
172
  * @memberof RegisterListResource
173
173
  */
174
- signOffLong?: number | null;
174
+ signOffLong: number;
175
175
  /**
176
176
  *
177
177
  * @type {boolean}
@@ -199,9 +199,9 @@ export function instanceOfRegisterListResource(value: object): value is Register
199
199
  if (!('user' in value) || value['user'] === undefined) return false;
200
200
  if (!('venue' in value) || value['venue'] === undefined) return false;
201
201
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
202
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
202
203
  if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
203
204
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
204
- if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
205
205
  if (!('rampReadAt' in value) || value['rampReadAt'] === undefined) return false;
206
206
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
207
207
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -216,6 +216,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
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;
219
220
  if (!('hasIncidents' in value) || value['hasIncidents'] === undefined) return false;
220
221
  return true;
221
222
  }
@@ -234,10 +235,10 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
234
235
  'user': UserLiteResourceFromJSON(json['user']),
235
236
  'venue': VenueLiteResourceFromJSON(json['venue']),
236
237
  'startDateTime': (new Date(json['startDateTime'])),
237
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
238
+ 'finishDateTime': (new Date(json['finishDateTime'])),
238
239
  'shiftLength': json['shiftLength'],
239
240
  'signOffStatus': json['signOffStatus'],
240
- 'badgeNumber': json['badgeNumber'],
241
+ 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
241
242
  'rampReadAt': (new Date(json['rampReadAt'])),
242
243
  'licenceNumber': json['licenceNumber'],
243
244
  'licenceFirstName': json['licenceFirstName'],
@@ -252,7 +253,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
252
253
  'signOnLat': json['signOnLat'],
253
254
  'signOnLong': json['signOnLong'],
254
255
  'signOffLat': json['signOffLat'],
255
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
256
+ 'signOffLong': json['signOffLong'],
256
257
  'hasIncidents': json['hasIncidents'],
257
258
  };
258
259
  }
@@ -272,7 +273,7 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
272
273
  'user': UserLiteResourceToJSON(value['user']),
273
274
  'venue': VenueLiteResourceToJSON(value['venue']),
274
275
  'startDateTime': ((value['startDateTime']).toISOString()),
275
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
276
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
276
277
  'shiftLength': value['shiftLength'],
277
278
  'signOffStatus': value['signOffStatus'],
278
279
  'badgeNumber': value['badgeNumber'],
@@ -123,7 +123,7 @@ export interface RegisterResource {
123
123
  * @type {number}
124
124
  * @memberof RegisterResource
125
125
  */
126
- signOffLat?: number | null;
126
+ signOffLat: number;
127
127
  /**
128
128
  *
129
129
  * @type {number}
@@ -208,6 +208,7 @@ 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;
211
212
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
212
213
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
213
214
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -241,7 +242,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
241
242
  'firstAidImage': json['firstAidImage'],
242
243
  'signOnLat': json['signOnLat'],
243
244
  'signOnLong': json['signOnLong'],
244
- 'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
245
+ 'signOffLat': json['signOffLat'],
245
246
  'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
246
247
  'licenceNumber': json['licenceNumber'],
247
248
  'licenceExpiry': json['licenceExpiry'],
@@ -36,7 +36,7 @@ export interface RosterLiteResource {
36
36
  * @type {Date}
37
37
  * @memberof RosterLiteResource
38
38
  */
39
- finishDateTime?: Date | null;
39
+ finishDateTime: Date;
40
40
  }
41
41
 
42
42
  /**
@@ -44,6 +44,7 @@ export interface RosterLiteResource {
44
44
  */
45
45
  export function instanceOfRosterLiteResource(value: object): value is RosterLiteResource {
46
46
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
47
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
47
48
  return true;
48
49
  }
49
50
 
@@ -59,7 +60,7 @@ export function RosterLiteResourceFromJSONTyped(json: any, ignoreDiscriminator:
59
60
 
60
61
  'id': json['id'] == null ? undefined : json['id'],
61
62
  'startDateTime': (new Date(json['startDateTime'])),
62
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
63
+ 'finishDateTime': (new Date(json['finishDateTime'])),
63
64
  };
64
65
  }
65
66
 
@@ -76,7 +77,7 @@ export function RosterLiteResourceToJSONTyped(value?: RosterLiteResource | null,
76
77
 
77
78
  'id': value['id'],
78
79
  'startDateTime': ((value['startDateTime']).toISOString()),
79
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
80
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
80
81
  };
81
82
  }
82
83
 
@@ -76,7 +76,7 @@ export interface RosterWithRegistersResource {
76
76
  * @type {Date}
77
77
  * @memberof RosterWithRegistersResource
78
78
  */
79
- finishDateTime: Date;
79
+ finishDateTime?: Date | null;
80
80
  /**
81
81
  *
82
82
  * @type {boolean}
@@ -123,7 +123,6 @@ export function instanceOfRosterWithRegistersResource(value: object): value is R
123
123
  if (!('state' in value) || value['state'] === undefined) return false;
124
124
  if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
125
125
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
126
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
127
126
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
128
127
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
129
128
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -146,7 +145,7 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
146
145
  'state': json['state'],
147
146
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
148
147
  'startDateTime': (new Date(json['startDateTime'])),
149
- 'finishDateTime': (new Date(json['finishDateTime'])),
148
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
150
149
  'isCompliant': json['isCompliant'],
151
150
  'isComplete': json['isComplete'],
152
151
  'signOffStatus': json['signOffStatus'],
@@ -170,7 +169,7 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
170
169
  'state': value['state'],
171
170
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
172
171
  'startDateTime': ((value['startDateTime']).toISOString()),
173
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
172
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
174
173
  'isCompliant': value['isCompliant'],
175
174
  'isComplete': value['isComplete'],
176
175
  'signOffStatus': value['signOffStatus'],
@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
44
44
  * @type {string}
45
45
  * @memberof SecurityCompanyResource
46
46
  */
47
- email: string;
47
+ email?: string | null;
48
48
  /**
49
49
  *
50
50
  * @type {boolean}
@@ -82,7 +82,6 @@ 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;
86
85
  if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
87
86
  if (!('address' in value) || value['address'] === undefined) return false;
88
87
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -101,7 +100,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
101
100
 
102
101
  'id': json['id'] == null ? undefined : json['id'],
103
102
  'name': json['name'],
104
- 'email': json['email'],
103
+ 'email': json['email'] == null ? undefined : json['email'],
105
104
  'isEnabled': json['isEnabled'],
106
105
  'address': AddressResourceFromJSON(json['address']),
107
106
  'licenceNumber': json['licenceNumber'],
@@ -78,6 +78,8 @@ export * from './MobileInitResource';
78
78
  export * from './MobileInitResourceArrayResponse';
79
79
  export * from './NotificationPreferenceResource';
80
80
  export * from './NotificationPreferenceResourceArrayResponse';
81
+ export * from './NotificationPreferencesBulkRequest';
82
+ export * from './NotificationPreferencesBulkRequestPreferencesInner';
81
83
  export * from './NotificationPreferencesStoreRequest';
82
84
  export * from './NotificationTypeResource';
83
85
  export * from './NotificationTypeResourceArrayResponse';