@digital8/security-registers-backend-ts-sdk 0.0.278 → 0.0.279

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 (45) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +12 -1
  4. package/dist/apis/GeneralApi.js +55 -0
  5. package/dist/models/AddressResource.d.ts +1 -1
  6. package/dist/models/AddressResource.js +3 -1
  7. package/dist/models/AssetLiteResource.d.ts +0 -12
  8. package/dist/models/AssetLiteResource.js +0 -6
  9. package/dist/models/AssetResource.d.ts +1 -13
  10. package/dist/models/AssetResource.js +3 -7
  11. package/dist/models/IncidentListResource.d.ts +95 -0
  12. package/dist/models/IncidentListResource.js +75 -0
  13. package/dist/models/IncidentListResourceArrayResponse.d.ts +33 -0
  14. package/dist/models/IncidentListResourceArrayResponse.js +50 -0
  15. package/dist/models/IncidentsListRequest.d.ts +151 -0
  16. package/dist/models/IncidentsListRequest.js +99 -0
  17. package/dist/models/PaginatedIncidentListResourceResponse.d.ts +40 -0
  18. package/dist/models/PaginatedIncidentListResourceResponse.js +57 -0
  19. package/dist/models/RegisterGroupedByRosterResource.d.ts +1 -1
  20. package/dist/models/RegisterGroupedByRosterResource.js +3 -4
  21. package/dist/models/RegisterListResource.d.ts +2 -2
  22. package/dist/models/RegisterListResource.js +2 -6
  23. package/dist/models/RegisterResource.d.ts +1 -13
  24. package/dist/models/RegisterResource.js +3 -9
  25. package/dist/models/RosterWithRegistersResource.d.ts +1 -1
  26. package/dist/models/RosterWithRegistersResource.js +3 -4
  27. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  28. package/dist/models/SecurityCompanyResource.js +1 -3
  29. package/dist/models/index.d.ts +4 -0
  30. package/dist/models/index.js +4 -0
  31. package/package.json +1 -1
  32. package/src/apis/GeneralApi.ts +50 -0
  33. package/src/models/AddressResource.ts +3 -2
  34. package/src/models/AssetLiteResource.ts +0 -17
  35. package/src/models/AssetResource.ts +3 -19
  36. package/src/models/IncidentListResource.ts +168 -0
  37. package/src/models/IncidentListResourceArrayResponse.ts +73 -0
  38. package/src/models/IncidentsListRequest.ts +222 -0
  39. package/src/models/PaginatedIncidentListResourceResponse.ts +90 -0
  40. package/src/models/RegisterGroupedByRosterResource.ts +3 -4
  41. package/src/models/RegisterListResource.ts +4 -6
  42. package/src/models/RegisterResource.ts +3 -20
  43. package/src/models/RosterWithRegistersResource.ts +3 -4
  44. package/src/models/SecurityCompanyResource.ts +2 -3
  45. package/src/models/index.ts +4 -0
@@ -0,0 +1,90 @@
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
+ import type { PagingMetadata } from './PagingMetadata';
17
+ import {
18
+ PagingMetadataFromJSON,
19
+ PagingMetadataFromJSONTyped,
20
+ PagingMetadataToJSON,
21
+ PagingMetadataToJSONTyped,
22
+ } from './PagingMetadata';
23
+ import type { IncidentListResource } from './IncidentListResource';
24
+ import {
25
+ IncidentListResourceFromJSON,
26
+ IncidentListResourceFromJSONTyped,
27
+ IncidentListResourceToJSON,
28
+ IncidentListResourceToJSONTyped,
29
+ } from './IncidentListResource';
30
+
31
+ /**
32
+ *
33
+ * @export
34
+ * @interface PaginatedIncidentListResourceResponse
35
+ */
36
+ export interface PaginatedIncidentListResourceResponse {
37
+ /**
38
+ *
39
+ * @type {Array<IncidentListResource>}
40
+ * @memberof PaginatedIncidentListResourceResponse
41
+ */
42
+ data: Array<IncidentListResource>;
43
+ /**
44
+ *
45
+ * @type {PagingMetadata}
46
+ * @memberof PaginatedIncidentListResourceResponse
47
+ */
48
+ meta: PagingMetadata;
49
+ }
50
+
51
+ /**
52
+ * Check if a given object implements the PaginatedIncidentListResourceResponse interface.
53
+ */
54
+ export function instanceOfPaginatedIncidentListResourceResponse(value: object): value is PaginatedIncidentListResourceResponse {
55
+ if (!('data' in value) || value['data'] === undefined) return false;
56
+ if (!('meta' in value) || value['meta'] === undefined) return false;
57
+ return true;
58
+ }
59
+
60
+ export function PaginatedIncidentListResourceResponseFromJSON(json: any): PaginatedIncidentListResourceResponse {
61
+ return PaginatedIncidentListResourceResponseFromJSONTyped(json, false);
62
+ }
63
+
64
+ export function PaginatedIncidentListResourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedIncidentListResourceResponse {
65
+ if (json == null) {
66
+ return json;
67
+ }
68
+ return {
69
+
70
+ 'data': ((json['data'] as Array<any>).map(IncidentListResourceFromJSON)),
71
+ 'meta': PagingMetadataFromJSON(json['meta']),
72
+ };
73
+ }
74
+
75
+ export function PaginatedIncidentListResourceResponseToJSON(json: any): PaginatedIncidentListResourceResponse {
76
+ return PaginatedIncidentListResourceResponseToJSONTyped(json, false);
77
+ }
78
+
79
+ export function PaginatedIncidentListResourceResponseToJSONTyped(value?: PaginatedIncidentListResourceResponse | null, ignoreDiscriminator: boolean = false): any {
80
+ if (value == null) {
81
+ return value;
82
+ }
83
+
84
+ return {
85
+
86
+ 'data': ((value['data'] as Array<any>).map(IncidentListResourceToJSON)),
87
+ 'meta': PagingMetadataToJSON(value['meta']),
88
+ };
89
+ }
90
+
@@ -69,7 +69,7 @@ export interface RegisterGroupedByRosterResource {
69
69
  * @type {Date}
70
70
  * @memberof RegisterGroupedByRosterResource
71
71
  */
72
- finishDateTime: Date;
72
+ finishDateTime?: Date | null;
73
73
  /**
74
74
  *
75
75
  * @type {Array<RegisterListResource>}
@@ -86,7 +86,6 @@ export function instanceOfRegisterGroupedByRosterResource(value: object): value
86
86
  if (!('timezone' in value) || value['timezone'] === undefined) return false;
87
87
  if (!('state' in value) || value['state'] === undefined) return false;
88
88
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
89
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
90
89
  if (!('registers' in value) || value['registers'] === undefined) return false;
91
90
  return true;
92
91
  }
@@ -106,7 +105,7 @@ export function RegisterGroupedByRosterResourceFromJSONTyped(json: any, ignoreDi
106
105
  'timezone': json['timezone'],
107
106
  'state': json['state'],
108
107
  'startDateTime': (new Date(json['startDateTime'])),
109
- 'finishDateTime': (new Date(json['finishDateTime'])),
108
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
110
109
  'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
111
110
  };
112
111
  }
@@ -127,7 +126,7 @@ export function RegisterGroupedByRosterResourceToJSONTyped(value?: RegisterGroup
127
126
  'timezone': value['timezone'],
128
127
  'state': value['state'],
129
128
  'startDateTime': ((value['startDateTime']).toISOString()),
130
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
129
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
131
130
  'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
132
131
  };
133
132
  }
@@ -88,7 +88,7 @@ export interface RegisterListResource {
88
88
  * @type {string}
89
89
  * @memberof RegisterListResource
90
90
  */
91
- badgeNumber: string;
91
+ badgeNumber?: string | null;
92
92
  /**
93
93
  *
94
94
  * @type {string}
@@ -172,7 +172,7 @@ export interface RegisterListResource {
172
172
  * @type {number}
173
173
  * @memberof RegisterListResource
174
174
  */
175
- signOffLong: number;
175
+ signOffLong?: number | null;
176
176
  /**
177
177
  *
178
178
  * @type {Array<IncidentLiteResource>}
@@ -190,7 +190,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
190
190
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
191
191
  if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
192
192
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
193
- if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
194
193
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
195
194
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
196
195
  if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
@@ -204,7 +203,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
204
203
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
205
204
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
206
205
  if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
207
- if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
208
206
  if (!('incidents' in value) || value['incidents'] === undefined) return false;
209
207
  return true;
210
208
  }
@@ -226,7 +224,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
226
224
  'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
227
225
  'shiftLength': json['shiftLength'],
228
226
  'signOffStatus': json['signOffStatus'],
229
- 'badgeNumber': json['badgeNumber'],
227
+ 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
230
228
  'licenceNumber': json['licenceNumber'],
231
229
  'licenceFirstName': json['licenceFirstName'],
232
230
  'licenceLastName': json['licenceLastName'],
@@ -240,7 +238,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
240
238
  'signOnLat': json['signOnLat'],
241
239
  'signOnLong': json['signOnLong'],
242
240
  'signOffLat': json['signOffLat'],
243
- 'signOffLong': json['signOffLong'],
241
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
244
242
  'incidents': (json['incidents'] == null ? null : (json['incidents'] as Array<any>).map(IncidentLiteResourceFromJSON)),
245
243
  };
246
244
  }
@@ -82,18 +82,6 @@ export interface RegisterResource {
82
82
  * @memberof RegisterResource
83
83
  */
84
84
  signOffSignature: object;
85
- /**
86
- *
87
- * @type {object}
88
- * @memberof RegisterResource
89
- */
90
- signOnPhoto: object;
91
- /**
92
- *
93
- * @type {object}
94
- * @memberof RegisterResource
95
- */
96
- signOffPhoto: object;
97
85
  /**
98
86
  *
99
87
  * @type {object}
@@ -141,7 +129,7 @@ export interface RegisterResource {
141
129
  * @type {number}
142
130
  * @memberof RegisterResource
143
131
  */
144
- signOffLong?: number | null;
132
+ signOffLong: number;
145
133
  /**
146
134
  *
147
135
  * @type {string}
@@ -197,14 +185,13 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
197
185
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
198
186
  if (!('signOnSignature' in value) || value['signOnSignature'] === undefined) return false;
199
187
  if (!('signOffSignature' in value) || value['signOffSignature'] === undefined) return false;
200
- if (!('signOnPhoto' in value) || value['signOnPhoto'] === undefined) return false;
201
- if (!('signOffPhoto' in value) || value['signOffPhoto'] === undefined) return false;
202
188
  if (!('licenceFront' in value) || value['licenceFront'] === undefined) return false;
203
189
  if (!('licenceBack' in value) || value['licenceBack'] === undefined) return false;
204
190
  if (!('rsaImage' in value) || value['rsaImage'] === undefined) return false;
205
191
  if (!('firstAidImage' in value) || value['firstAidImage'] === undefined) return false;
206
192
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
207
193
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
194
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
208
195
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
209
196
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
210
197
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -230,8 +217,6 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
230
217
  'signOffStatus': json['signOffStatus'],
231
218
  'signOnSignature': json['signOnSignature'],
232
219
  'signOffSignature': json['signOffSignature'],
233
- 'signOnPhoto': json['signOnPhoto'],
234
- 'signOffPhoto': json['signOffPhoto'],
235
220
  'licenceFront': json['licenceFront'],
236
221
  'licenceBack': json['licenceBack'],
237
222
  'rsaImage': json['rsaImage'],
@@ -239,7 +224,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
239
224
  'signOnLat': json['signOnLat'],
240
225
  'signOnLong': json['signOnLong'],
241
226
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
242
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
227
+ 'signOffLong': json['signOffLong'],
243
228
  'licenceNumber': json['licenceNumber'],
244
229
  'licenceExpiry': json['licenceExpiry'],
245
230
  'licenceFirstName': json['licenceFirstName'],
@@ -269,8 +254,6 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
269
254
  'signOffStatus': value['signOffStatus'],
270
255
  'signOnSignature': value['signOnSignature'],
271
256
  'signOffSignature': value['signOffSignature'],
272
- 'signOnPhoto': value['signOnPhoto'],
273
- 'signOffPhoto': value['signOffPhoto'],
274
257
  'licenceFront': value['licenceFront'],
275
258
  'licenceBack': value['licenceBack'],
276
259
  'rsaImage': value['rsaImage'],
@@ -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}
@@ -111,7 +111,6 @@ export function instanceOfRosterWithRegistersResource(value: object): value is R
111
111
  if (!('state' in value) || value['state'] === undefined) return false;
112
112
  if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
113
113
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
114
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
115
114
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
116
115
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
117
116
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -134,7 +133,7 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
134
133
  'state': json['state'],
135
134
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
136
135
  'startDateTime': (new Date(json['startDateTime'])),
137
- 'finishDateTime': (new Date(json['finishDateTime'])),
136
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
138
137
  'isCompliant': json['isCompliant'],
139
138
  'isComplete': json['isComplete'],
140
139
  'signOffStatus': json['signOffStatus'],
@@ -158,7 +157,7 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
158
157
  'state': value['state'],
159
158
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
160
159
  'startDateTime': ((value['startDateTime']).toISOString()),
161
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
160
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
162
161
  'isCompliant': value['isCompliant'],
163
162
  'isComplete': value['isComplete'],
164
163
  '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'],
@@ -19,6 +19,8 @@ export * from './IncidentFieldSchemasShowRequest';
19
19
  export * from './IncidentFieldsResourceArrayResponse';
20
20
  export * from './IncidentImageResource';
21
21
  export * from './IncidentImageResourceArrayResponse';
22
+ export * from './IncidentListResource';
23
+ export * from './IncidentListResourceArrayResponse';
22
24
  export * from './IncidentLiteResource';
23
25
  export * from './IncidentLiteResourceArrayResponse';
24
26
  export * from './IncidentLiteResourceStaff';
@@ -33,6 +35,7 @@ export * from './IncidentVideoSignedUrlResourceArrayResponse';
33
35
  export * from './IncidentVideoUploadTokenResource';
34
36
  export * from './IncidentVideoUploadTokenResourceArrayResponse';
35
37
  export * from './IncidentsApproveRequest';
38
+ export * from './IncidentsListRequest';
36
39
  export * from './IncidentsStoreRequest';
37
40
  export * from './IncidentsUpdateRequest';
38
41
  export * from './IncidentsVideosStoreRequest';
@@ -56,6 +59,7 @@ export * from './NotificationPreferenceResourceArrayResponse';
56
59
  export * from './NotificationPreferencesStoreRequest';
57
60
  export * from './NotificationTypeResource';
58
61
  export * from './NotificationTypeResourceArrayResponse';
62
+ export * from './PaginatedIncidentListResourceResponse';
59
63
  export * from './PaginatedLicenceListResourceResponse';
60
64
  export * from './PaginatedLicenceResourceResponse';
61
65
  export * from './PaginatedRegisterGroupedByRosterResourceResponse';