@digital8/security-registers-backend-ts-sdk 0.0.204 → 0.0.206

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 +6 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +43 -5
  4. package/dist/apis/GeneralApi.js +222 -8
  5. package/dist/models/AddressResource.d.ts +1 -1
  6. package/dist/models/AddressResource.js +1 -3
  7. package/dist/models/AssetResource.d.ts +1 -1
  8. package/dist/models/AssetResource.js +3 -1
  9. package/dist/models/IncidentFieldSchemasShowRequest.d.ts +46 -0
  10. package/dist/models/IncidentFieldSchemasShowRequest.js +65 -0
  11. package/dist/models/NotificationPreferenceResource.d.ts +63 -0
  12. package/dist/models/NotificationPreferenceResource.js +67 -0
  13. package/dist/models/NotificationPreferenceResourceArrayResponse.d.ts +33 -0
  14. package/dist/models/NotificationPreferenceResourceArrayResponse.js +50 -0
  15. package/dist/models/NotificationPreferencesStoreRequest.d.ts +55 -0
  16. package/dist/models/NotificationPreferencesStoreRequest.js +68 -0
  17. package/dist/models/NotificationTypeResource.d.ts +38 -0
  18. package/dist/models/NotificationTypeResource.js +55 -0
  19. package/dist/models/NotificationTypeResourceArrayResponse.d.ts +33 -0
  20. package/dist/models/NotificationTypeResourceArrayResponse.js +50 -0
  21. package/dist/models/RegisterGroupedByRosterResource.d.ts +1 -1
  22. package/dist/models/RegisterGroupedByRosterResource.js +3 -4
  23. package/dist/models/RegisterListResource.d.ts +1 -1
  24. package/dist/models/RegisterListResource.js +3 -1
  25. package/dist/models/RosterResource.d.ts +1 -1
  26. package/dist/models/RosterResource.js +4 -3
  27. package/dist/models/RosterWithRegistersResource.d.ts +1 -1
  28. package/dist/models/RosterWithRegistersResource.js +3 -4
  29. package/dist/models/index.d.ts +6 -0
  30. package/dist/models/index.js +6 -0
  31. package/package.json +1 -1
  32. package/src/apis/GeneralApi.ts +191 -14
  33. package/src/models/AddressResource.ts +2 -3
  34. package/src/models/AssetResource.ts +3 -2
  35. package/src/models/IncidentFieldSchemasShowRequest.ts +83 -0
  36. package/src/models/NotificationPreferenceResource.ts +116 -0
  37. package/src/models/NotificationPreferenceResourceArrayResponse.ts +73 -0
  38. package/src/models/NotificationPreferencesStoreRequest.ts +97 -0
  39. package/src/models/NotificationTypeResource.ts +75 -0
  40. package/src/models/NotificationTypeResourceArrayResponse.ts +73 -0
  41. package/src/models/RegisterGroupedByRosterResource.ts +3 -4
  42. package/src/models/RegisterListResource.ts +3 -2
  43. package/src/models/RosterResource.ts +4 -3
  44. package/src/models/RosterWithRegistersResource.ts +3 -4
  45. package/src/models/index.ts +6 -0
@@ -0,0 +1,97 @@
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 NotificationPreferencesStoreRequest
20
+ */
21
+ export interface NotificationPreferencesStoreRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof NotificationPreferencesStoreRequest
26
+ */
27
+ notificationType: NotificationPreferencesStoreRequestNotificationTypeEnum;
28
+ /**
29
+ *
30
+ * @type {number}
31
+ * @memberof NotificationPreferencesStoreRequest
32
+ */
33
+ venueId?: number;
34
+ /**
35
+ *
36
+ * @type {boolean}
37
+ * @memberof NotificationPreferencesStoreRequest
38
+ */
39
+ enabled: boolean;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const NotificationPreferencesStoreRequestNotificationTypeEnum = {
47
+ IncidentAdded: 'incident_added',
48
+ NonSignOff: 'non_sign_off',
49
+ NonSignOn: 'non_sign_on',
50
+ SignOnRejected: 'sign_on_rejected',
51
+ LicenceUpdated: 'licence_updated'
52
+ } as const;
53
+ export type NotificationPreferencesStoreRequestNotificationTypeEnum = typeof NotificationPreferencesStoreRequestNotificationTypeEnum[keyof typeof NotificationPreferencesStoreRequestNotificationTypeEnum];
54
+
55
+
56
+ /**
57
+ * Check if a given object implements the NotificationPreferencesStoreRequest interface.
58
+ */
59
+ export function instanceOfNotificationPreferencesStoreRequest(value: object): value is NotificationPreferencesStoreRequest {
60
+ if (!('notificationType' in value) || value['notificationType'] === undefined) return false;
61
+ if (!('enabled' in value) || value['enabled'] === undefined) return false;
62
+ return true;
63
+ }
64
+
65
+ export function NotificationPreferencesStoreRequestFromJSON(json: any): NotificationPreferencesStoreRequest {
66
+ return NotificationPreferencesStoreRequestFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function NotificationPreferencesStoreRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationPreferencesStoreRequest {
70
+ if (json == null) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'notificationType': json['notification_type'],
76
+ 'venueId': json['venue_id'] == null ? undefined : json['venue_id'],
77
+ 'enabled': json['enabled'],
78
+ };
79
+ }
80
+
81
+ export function NotificationPreferencesStoreRequestToJSON(json: any): NotificationPreferencesStoreRequest {
82
+ return NotificationPreferencesStoreRequestToJSONTyped(json, false);
83
+ }
84
+
85
+ export function NotificationPreferencesStoreRequestToJSONTyped(value?: NotificationPreferencesStoreRequest | null, ignoreDiscriminator: boolean = false): any {
86
+ if (value == null) {
87
+ return value;
88
+ }
89
+
90
+ return {
91
+
92
+ 'notification_type': value['notificationType'],
93
+ 'venue_id': value['venueId'],
94
+ 'enabled': value['enabled'],
95
+ };
96
+ }
97
+
@@ -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 NotificationTypeResource
20
+ */
21
+ export interface NotificationTypeResource {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof NotificationTypeResource
26
+ */
27
+ value: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof NotificationTypeResource
32
+ */
33
+ label: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the NotificationTypeResource interface.
38
+ */
39
+ export function instanceOfNotificationTypeResource(value: object): value is NotificationTypeResource {
40
+ if (!('value' in value) || value['value'] === undefined) return false;
41
+ if (!('label' in value) || value['label'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function NotificationTypeResourceFromJSON(json: any): NotificationTypeResource {
46
+ return NotificationTypeResourceFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function NotificationTypeResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResource {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'value': json['value'],
56
+ 'label': json['label'],
57
+ };
58
+ }
59
+
60
+ export function NotificationTypeResourceToJSON(json: any): NotificationTypeResource {
61
+ return NotificationTypeResourceToJSONTyped(json, false);
62
+ }
63
+
64
+ export function NotificationTypeResourceToJSONTyped(value?: NotificationTypeResource | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'value': value['value'],
72
+ 'label': value['label'],
73
+ };
74
+ }
75
+
@@ -0,0 +1,73 @@
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 { NotificationTypeResource } from './NotificationTypeResource';
17
+ import {
18
+ NotificationTypeResourceFromJSON,
19
+ NotificationTypeResourceFromJSONTyped,
20
+ NotificationTypeResourceToJSON,
21
+ NotificationTypeResourceToJSONTyped,
22
+ } from './NotificationTypeResource';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface NotificationTypeResourceArrayResponse
28
+ */
29
+ export interface NotificationTypeResourceArrayResponse {
30
+ /**
31
+ *
32
+ * @type {Array<NotificationTypeResource>}
33
+ * @memberof NotificationTypeResourceArrayResponse
34
+ */
35
+ data?: Array<NotificationTypeResource>;
36
+ }
37
+
38
+ /**
39
+ * Check if a given object implements the NotificationTypeResourceArrayResponse interface.
40
+ */
41
+ export function instanceOfNotificationTypeResourceArrayResponse(value: object): value is NotificationTypeResourceArrayResponse {
42
+ return true;
43
+ }
44
+
45
+ export function NotificationTypeResourceArrayResponseFromJSON(json: any): NotificationTypeResourceArrayResponse {
46
+ return NotificationTypeResourceArrayResponseFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function NotificationTypeResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTypeResourceArrayResponse {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(NotificationTypeResourceFromJSON)),
56
+ };
57
+ }
58
+
59
+ export function NotificationTypeResourceArrayResponseToJSON(json: any): NotificationTypeResourceArrayResponse {
60
+ return NotificationTypeResourceArrayResponseToJSONTyped(json, false);
61
+ }
62
+
63
+ export function NotificationTypeResourceArrayResponseToJSONTyped(value?: NotificationTypeResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
64
+ if (value == null) {
65
+ return value;
66
+ }
67
+
68
+ return {
69
+
70
+ 'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(NotificationTypeResourceToJSON)),
71
+ };
72
+ }
73
+
@@ -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
  }
@@ -159,7 +159,7 @@ export interface RegisterListResource {
159
159
  * @type {number}
160
160
  * @memberof RegisterListResource
161
161
  */
162
- signOffLat?: number | null;
162
+ signOffLat: number;
163
163
  /**
164
164
  *
165
165
  * @type {number}
@@ -196,6 +196,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
196
196
  if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
197
197
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
198
198
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
199
+ if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
199
200
  if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
200
201
  if (!('incidents' in value) || value['incidents'] === undefined) return false;
201
202
  return true;
@@ -231,7 +232,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
231
232
  'firstAid': json['firstAid'],
232
233
  'signOnLat': json['signOnLat'],
233
234
  'signOnLong': json['signOnLong'],
234
- 'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
235
+ 'signOffLat': json['signOffLat'],
235
236
  'signOffLong': json['signOffLong'],
236
237
  'incidents': json['incidents'],
237
238
  };
@@ -70,7 +70,7 @@ export interface RosterResource {
70
70
  * @type {Date}
71
71
  * @memberof RosterResource
72
72
  */
73
- finishDateTime?: Date | null;
73
+ finishDateTime: Date;
74
74
  /**
75
75
  *
76
76
  * @type {boolean}
@@ -104,6 +104,7 @@ 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;
107
108
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
108
109
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
109
110
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -125,7 +126,7 @@ export function RosterResourceFromJSONTyped(json: any, ignoreDiscriminator: bool
125
126
  'venue': VenueLiteResourceFromJSON(json['venue']),
126
127
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
127
128
  'startDateTime': (new Date(json['startDateTime'])),
128
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
129
+ 'finishDateTime': (new Date(json['finishDateTime'])),
129
130
  'isCompliant': json['isCompliant'],
130
131
  'isComplete': json['isComplete'],
131
132
  'signOffStatus': json['signOffStatus'],
@@ -148,7 +149,7 @@ export function RosterResourceToJSONTyped(value?: RosterResource | null, ignoreD
148
149
  'venue': VenueLiteResourceToJSON(value['venue']),
149
150
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
150
151
  'startDateTime': ((value['startDateTime']).toISOString()),
151
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
152
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
152
153
  'isCompliant': value['isCompliant'],
153
154
  'isComplete': value['isComplete'],
154
155
  'signOffStatus': value['signOffStatus'],
@@ -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'],
@@ -13,6 +13,7 @@ export * from './CurrentRegisterResourceArrayResponse';
13
13
  export * from './GenericResponse';
14
14
  export * from './IncidentFieldSchemaResource';
15
15
  export * from './IncidentFieldSchemaResourceArrayResponse';
16
+ export * from './IncidentFieldSchemasShowRequest';
16
17
  export * from './IncidentFieldsResourceArrayResponse';
17
18
  export * from './IncidentResource';
18
19
  export * from './IncidentResourceArrayResponse';
@@ -31,6 +32,11 @@ export * from './LicencesStoreRequest';
31
32
  export * from './LicencesUpdateRequest';
32
33
  export * from './LicencesVerifyRequest';
33
34
  export * from './LoginAuthRequest';
35
+ export * from './NotificationPreferenceResource';
36
+ export * from './NotificationPreferenceResourceArrayResponse';
37
+ export * from './NotificationPreferencesStoreRequest';
38
+ export * from './NotificationTypeResource';
39
+ export * from './NotificationTypeResourceArrayResponse';
34
40
  export * from './PaginatedLicenceListResourceResponse';
35
41
  export * from './PaginatedLicenceResourceResponse';
36
42
  export * from './PaginatedRegisterGroupedByRosterResourceResponse';