@digital8/security-registers-backend-ts-sdk 0.0.220 → 0.0.221

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 (51) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +12 -12
  4. package/dist/apis/GeneralApi.js +55 -56
  5. package/dist/models/AddressResource.d.ts +1 -1
  6. package/dist/models/AddressResource.js +1 -3
  7. package/dist/models/IncidentFieldsResourceArrayResponse.d.ts +32 -0
  8. package/dist/models/IncidentFieldsResourceArrayResponse.js +49 -0
  9. package/dist/models/IncidentImageResource.d.ts +56 -0
  10. package/dist/models/IncidentImageResource.js +65 -0
  11. package/dist/models/IncidentImageResourceArrayResponse.d.ts +33 -0
  12. package/dist/models/IncidentImageResourceArrayResponse.js +50 -0
  13. package/dist/models/IncidentResource.d.ts +104 -0
  14. package/dist/models/IncidentResource.js +96 -0
  15. package/dist/models/IncidentResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/IncidentResourceArrayResponse.js +50 -0
  17. package/dist/models/IncidentsStoreRequest.d.ts +38 -0
  18. package/dist/models/IncidentsStoreRequest.js +55 -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 +3 -3
  22. package/dist/models/RegisterListResource.js +4 -3
  23. package/dist/models/RegisterResource.d.ts +2 -2
  24. package/dist/models/RegisterResource.js +10 -6
  25. package/dist/models/RosterListResource.d.ts +1 -1
  26. package/dist/models/RosterListResource.js +4 -3
  27. package/dist/models/RosterResource.d.ts +1 -1
  28. package/dist/models/RosterResource.js +3 -4
  29. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  30. package/dist/models/SecurityCompanyResource.js +3 -1
  31. package/dist/models/VenueResource.d.ts +0 -6
  32. package/dist/models/VenueResource.js +0 -4
  33. package/dist/models/index.d.ts +6 -0
  34. package/dist/models/index.js +6 -0
  35. package/package.json +1 -1
  36. package/src/apis/GeneralApi.ts +50 -49
  37. package/src/models/AddressResource.ts +2 -3
  38. package/src/models/IncidentFieldsResourceArrayResponse.ts +65 -0
  39. package/src/models/IncidentImageResource.ts +101 -0
  40. package/src/models/IncidentImageResourceArrayResponse.ts +73 -0
  41. package/src/models/IncidentResource.ts +205 -0
  42. package/src/models/IncidentResourceArrayResponse.ts +73 -0
  43. package/src/models/IncidentsStoreRequest.ts +75 -0
  44. package/src/models/RegisterGroupedByRosterResource.ts +3 -4
  45. package/src/models/RegisterListResource.ts +6 -5
  46. package/src/models/RegisterResource.ts +7 -5
  47. package/src/models/RosterListResource.ts +4 -3
  48. package/src/models/RosterResource.ts +3 -4
  49. package/src/models/SecurityCompanyResource.ts +3 -2
  50. package/src/models/VenueResource.ts +0 -9
  51. package/src/models/index.ts +6 -0
@@ -0,0 +1,75 @@
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 IncidentsStoreRequest
20
+ */
21
+ export interface IncidentsStoreRequest {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof IncidentsStoreRequest
26
+ */
27
+ venueId: number;
28
+ /**
29
+ * Dynamic fields keyed by section key. Non-repeatable sections are objects of field_key => value; repeatable sections are arrays of such objects. Shape is driven by the venue state's IncidentFieldSchema.
30
+ * @type {object}
31
+ * @memberof IncidentsStoreRequest
32
+ */
33
+ fields: object;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the IncidentsStoreRequest interface.
38
+ */
39
+ export function instanceOfIncidentsStoreRequest(value: object): value is IncidentsStoreRequest {
40
+ if (!('venueId' in value) || value['venueId'] === undefined) return false;
41
+ if (!('fields' in value) || value['fields'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function IncidentsStoreRequestFromJSON(json: any): IncidentsStoreRequest {
46
+ return IncidentsStoreRequestFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function IncidentsStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IncidentsStoreRequest {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'venueId': json['venue_id'],
56
+ 'fields': json['fields'],
57
+ };
58
+ }
59
+
60
+ export function IncidentsStoreRequestToJSON(json: any): IncidentsStoreRequest {
61
+ return IncidentsStoreRequestToJSONTyped(json, false);
62
+ }
63
+
64
+ export function IncidentsStoreRequestToJSONTyped(value?: IncidentsStoreRequest | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'venue_id': value['venueId'],
72
+ 'fields': value['fields'],
73
+ };
74
+ }
75
+
@@ -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
  }
@@ -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}
@@ -181,6 +181,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
181
181
  if (!('user' in value) || value['user'] === undefined) return false;
182
182
  if (!('venue' in value) || value['venue'] === undefined) return false;
183
183
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
184
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
184
185
  if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
185
186
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
186
187
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -213,7 +214,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
213
214
  'user': UserLiteResourceFromJSON(json['user']),
214
215
  'venue': VenueLiteResourceFromJSON(json['venue']),
215
216
  'startDateTime': (new Date(json['startDateTime'])),
216
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
217
+ 'finishDateTime': (new Date(json['finishDateTime'])),
217
218
  'shiftLength': json['shiftLength'],
218
219
  'signOffStatus': json['signOffStatus'],
219
220
  'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
@@ -250,7 +251,7 @@ export function RegisterListResourceToJSONTyped(value?: RegisterListResource | n
250
251
  'user': UserLiteResourceToJSON(value['user']),
251
252
  'venue': VenueLiteResourceToJSON(value['venue']),
252
253
  'startDateTime': ((value['startDateTime']).toISOString()),
253
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
254
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
254
255
  'shiftLength': value['shiftLength'],
255
256
  'signOffStatus': value['signOffStatus'],
256
257
  'badgeNumber': value['badgeNumber'],
@@ -63,7 +63,7 @@ export interface RegisterResource {
63
63
  * @type {Date}
64
64
  * @memberof RegisterResource
65
65
  */
66
- finishDateTime?: Date | null;
66
+ finishDateTime: Date;
67
67
  /**
68
68
  *
69
69
  * @type {number}
@@ -129,7 +129,7 @@ export interface RegisterResource {
129
129
  * @type {number}
130
130
  * @memberof RegisterResource
131
131
  */
132
- signOffLong?: number | null;
132
+ signOffLong: number;
133
133
  /**
134
134
  *
135
135
  * @type {string}
@@ -181,6 +181,7 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
181
181
  if (!('venue' in value) || value['venue'] === undefined) return false;
182
182
  if (!('user' in value) || value['user'] === undefined) return false;
183
183
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
184
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
184
185
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
185
186
  if (!('signOnSignature' in value) || value['signOnSignature'] === undefined) return false;
186
187
  if (!('signOffSignature' in value) || value['signOffSignature'] === undefined) return false;
@@ -191,6 +192,7 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
191
192
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
192
193
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
193
194
  if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
195
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
194
196
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
195
197
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
196
198
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -212,7 +214,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
212
214
  'venue': VenueLiteResourceFromJSON(json['venue']),
213
215
  'user': UserLiteResourceFromJSON(json['user']),
214
216
  'startDateTime': (new Date(json['startDateTime'])),
215
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
217
+ 'finishDateTime': (new Date(json['finishDateTime'])),
216
218
  'signOffStatus': json['signOffStatus'],
217
219
  'signOnSignature': json['signOnSignature'],
218
220
  'signOffSignature': json['signOffSignature'],
@@ -223,7 +225,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
223
225
  'signOnLat': json['signOnLat'],
224
226
  'signOnLong': json['signOnLong'],
225
227
  'signOffLat': json['signOffLat'],
226
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
228
+ 'signOffLong': json['signOffLong'],
227
229
  'licenceNumber': json['licenceNumber'],
228
230
  'licenceExpiry': json['licenceExpiry'],
229
231
  'licenceFirstName': json['licenceFirstName'],
@@ -249,7 +251,7 @@ export function RegisterResourceToJSONTyped(value?: RegisterResource | null, ign
249
251
  'venue': VenueLiteResourceToJSON(value['venue']),
250
252
  'user': UserLiteResourceToJSON(value['user']),
251
253
  'startDateTime': ((value['startDateTime']).toISOString()),
252
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
254
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
253
255
  'signOffStatus': value['signOffStatus'],
254
256
  'signOnSignature': value['signOnSignature'],
255
257
  'signOffSignature': value['signOffSignature'],
@@ -63,7 +63,7 @@ export interface RosterListResource {
63
63
  * @type {Date}
64
64
  * @memberof RosterListResource
65
65
  */
66
- finishDateTime?: Date | null;
66
+ finishDateTime: Date;
67
67
  /**
68
68
  *
69
69
  * @type {boolean}
@@ -97,6 +97,7 @@ export function instanceOfRosterListResource(value: object): value is RosterList
97
97
  if (!('venue' in value) || value['venue'] === undefined) return false;
98
98
  if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
99
99
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
100
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
100
101
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
101
102
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
102
103
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -118,7 +119,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
118
119
  'venue': VenueLiteResourceFromJSON(json['venue']),
119
120
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
120
121
  'startDateTime': (new Date(json['startDateTime'])),
121
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
122
+ 'finishDateTime': (new Date(json['finishDateTime'])),
122
123
  'isCompliant': json['isCompliant'],
123
124
  'isComplete': json['isComplete'],
124
125
  'signOffStatus': json['signOffStatus'],
@@ -141,7 +142,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
141
142
  'venue': VenueLiteResourceToJSON(value['venue']),
142
143
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
143
144
  'startDateTime': ((value['startDateTime']).toISOString()),
144
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
145
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
145
146
  'isCompliant': value['isCompliant'],
146
147
  'isComplete': value['isComplete'],
147
148
  'signOffStatus': value['signOffStatus'],
@@ -70,7 +70,7 @@ export interface RosterResource {
70
70
  * @type {Date}
71
71
  * @memberof RosterResource
72
72
  */
73
- finishDateTime: Date;
73
+ finishDateTime?: Date | null;
74
74
  /**
75
75
  *
76
76
  * @type {boolean}
@@ -104,7 +104,6 @@ export function instanceOfRosterResource(value: object): value is RosterResource
104
104
  if (!('venue' in value) || value['venue'] === undefined) return false;
105
105
  if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
106
106
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
107
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
108
107
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
109
108
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
110
109
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -126,7 +125,7 @@ export function RosterResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
126
125
  'venue': VenueLiteResourceFromJSON(json['venue']),
127
126
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
128
127
  'startDateTime': (new Date(json['startDateTime'])),
129
- 'finishDateTime': (new Date(json['finishDateTime'])),
128
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
130
129
  'isCompliant': json['isCompliant'],
131
130
  'isComplete': json['isComplete'],
132
131
  'signOffStatus': json['signOffStatus'],
@@ -149,7 +148,7 @@ export function RosterResourceToJSONTyped(value?: RosterResource | null, ignoreD
149
148
  'venue': VenueLiteResourceToJSON(value['venue']),
150
149
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
151
150
  'startDateTime': ((value['startDateTime']).toISOString()),
152
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
151
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
153
152
  'isCompliant': value['isCompliant'],
154
153
  'isComplete': value['isComplete'],
155
154
  'signOffStatus': value['signOffStatus'],
@@ -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'],
@@ -59,12 +59,6 @@ export interface VenueResource {
59
59
  * @memberof VenueResource
60
60
  */
61
61
  venueCode: string;
62
- /**
63
- *
64
- * @type {string}
65
- * @memberof VenueResource
66
- */
67
- venueApiKey: string;
68
62
  /**
69
63
  *
70
64
  * @type {boolean}
@@ -151,7 +145,6 @@ export interface VenueResource {
151
145
  export function instanceOfVenueResource(value: object): value is VenueResource {
152
146
  if (!('name' in value) || value['name'] === undefined) return false;
153
147
  if (!('venueCode' in value) || value['venueCode'] === undefined) return false;
154
- if (!('venueApiKey' in value) || value['venueApiKey'] === undefined) return false;
155
148
  if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined) return false;
156
149
  if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined) return false;
157
150
  if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
@@ -178,7 +171,6 @@ export function VenueResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
178
171
  'id': json['id'] == null ? undefined : json['id'],
179
172
  'name': json['name'],
180
173
  'venueCode': json['venueCode'],
181
- 'venueApiKey': json['venueApiKey'],
182
174
  'badgeNumberRequired': json['badgeNumberRequired'],
183
175
  'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
184
176
  'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
@@ -209,7 +201,6 @@ export function VenueResourceToJSONTyped(value?: VenueResource | null, ignoreDis
209
201
  'id': value['id'],
210
202
  'name': value['name'],
211
203
  'venueCode': value['venueCode'],
212
- 'venueApiKey': value['venueApiKey'],
213
204
  'badgeNumberRequired': value['badgeNumberRequired'],
214
205
  'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
215
206
  'primaryManagerId': value['primaryManagerId'],
@@ -14,6 +14,12 @@ export * from './GenericResponse';
14
14
  export * from './IncidentFieldSchemaResource';
15
15
  export * from './IncidentFieldSchemaResourceArrayResponse';
16
16
  export * from './IncidentFieldSchemasShowRequest';
17
+ export * from './IncidentFieldsResourceArrayResponse';
18
+ export * from './IncidentImageResource';
19
+ export * from './IncidentImageResourceArrayResponse';
20
+ export * from './IncidentResource';
21
+ export * from './IncidentResourceArrayResponse';
22
+ export * from './IncidentsStoreRequest';
17
23
  export * from './IndexMinimalUserRequest';
18
24
  export * from './IndexUserRequest';
19
25
  export * from './LicenceListResource';