@digital8/security-registers-backend-ts-sdk 0.0.711 → 0.0.712

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 (129) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +2 -2
  3. package/dist/models/AustralianState.d.ts +31 -0
  4. package/dist/models/AustralianState.js +57 -0
  5. package/dist/models/AuthRegisterGuardRequestLicencesInner.d.ts +3 -11
  6. package/dist/models/AuthRegisterGuardRequestLicencesInner.js +3 -11
  7. package/dist/models/DevicesRegisterRequest.d.ts +3 -10
  8. package/dist/models/DevicesRegisterRequest.js +3 -10
  9. package/dist/models/ExportQueuedResource.d.ts +3 -12
  10. package/dist/models/ExportQueuedResource.js +3 -12
  11. package/dist/models/IncidentFieldSchemaResource.d.ts +6 -21
  12. package/dist/models/IncidentFieldSchemaResource.js +6 -20
  13. package/dist/models/IncidentSchemaType.d.ts +25 -0
  14. package/dist/models/IncidentSchemaType.js +51 -0
  15. package/dist/models/IncidentVideoResource.d.ts +3 -11
  16. package/dist/models/IncidentVideoResource.js +3 -11
  17. package/dist/models/IncidentVideoStatus.d.ts +26 -0
  18. package/dist/models/IncidentVideoStatus.js +52 -0
  19. package/dist/models/LicenceCheckLogResource.d.ts +3 -15
  20. package/dist/models/LicenceCheckLogResource.js +3 -15
  21. package/dist/models/LicenceCheckSource.d.ts +30 -0
  22. package/dist/models/LicenceCheckSource.js +56 -0
  23. package/dist/models/LicenceListResource.d.ts +3 -11
  24. package/dist/models/LicenceListResource.js +3 -11
  25. package/dist/models/LicenceLiteResource.d.ts +3 -11
  26. package/dist/models/LicenceLiteResource.js +3 -11
  27. package/dist/models/LicenceResource.d.ts +3 -11
  28. package/dist/models/LicenceResource.js +3 -11
  29. package/dist/models/LicenceState.d.ts +26 -0
  30. package/dist/models/LicenceState.js +52 -0
  31. package/dist/models/LicencesStoreRequest.d.ts +3 -11
  32. package/dist/models/LicencesStoreRequest.js +3 -11
  33. package/dist/models/LicencesUpdateRequest.d.ts +3 -11
  34. package/dist/models/LicencesUpdateRequest.js +3 -11
  35. package/dist/models/LicencesVerifyRequest.d.ts +3 -11
  36. package/dist/models/LicencesVerifyRequest.js +3 -11
  37. package/dist/models/LoginPlatform.d.ts +25 -0
  38. package/dist/models/LoginPlatform.js +51 -0
  39. package/dist/models/MobileAppConfigRequest.d.ts +3 -10
  40. package/dist/models/MobileAppConfigRequest.js +3 -10
  41. package/dist/models/MobileAppConfigResource.d.ts +3 -10
  42. package/dist/models/MobileAppConfigResource.js +3 -10
  43. package/dist/models/MobileDevicePlatform.d.ts +25 -0
  44. package/dist/models/MobileDevicePlatform.js +51 -0
  45. package/dist/models/MobileDeviceResource.d.ts +3 -10
  46. package/dist/models/MobileDeviceResource.js +3 -10
  47. package/dist/models/NotificationPreferenceResource.d.ts +3 -17
  48. package/dist/models/NotificationPreferenceResource.js +3 -17
  49. package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.d.ts +3 -17
  50. package/dist/models/NotificationPreferencesBulkRequestPreferencesInner.js +3 -17
  51. package/dist/models/NotificationPreferencesStoreRequest.d.ts +3 -17
  52. package/dist/models/NotificationPreferencesStoreRequest.js +3 -17
  53. package/dist/models/NotificationStatus.d.ts +25 -0
  54. package/dist/models/NotificationStatus.js +51 -0
  55. package/dist/models/NotificationType.d.ts +32 -0
  56. package/dist/models/NotificationType.js +58 -0
  57. package/dist/models/PdfExportDownloadType.d.ts +26 -0
  58. package/dist/models/PdfExportDownloadType.js +52 -0
  59. package/dist/models/PdfExportKind.d.ts +28 -0
  60. package/dist/models/PdfExportKind.js +54 -0
  61. package/dist/models/PdfExportResource.d.ts +3 -12
  62. package/dist/models/PdfExportResource.js +3 -12
  63. package/dist/models/PdfExportStatus.d.ts +27 -0
  64. package/dist/models/PdfExportStatus.js +53 -0
  65. package/dist/models/RecordSource.d.ts +28 -0
  66. package/dist/models/RecordSource.js +54 -0
  67. package/dist/models/RegisterListResource.d.ts +3 -11
  68. package/dist/models/RegisterListResource.js +3 -11
  69. package/dist/models/RegisterResource.d.ts +3 -11
  70. package/dist/models/RegisterResource.js +3 -11
  71. package/dist/models/RegistersUpdateRequest.d.ts +3 -11
  72. package/dist/models/RegistersUpdateRequest.js +3 -11
  73. package/dist/models/RosterListResource.d.ts +3 -11
  74. package/dist/models/RosterListResource.js +3 -11
  75. package/dist/models/RosterResource.d.ts +3 -11
  76. package/dist/models/RosterResource.js +3 -11
  77. package/dist/models/RosterWithRegistersResource.d.ts +3 -11
  78. package/dist/models/RosterWithRegistersResource.js +3 -11
  79. package/dist/models/RostersUpdateRequest.d.ts +3 -11
  80. package/dist/models/RostersUpdateRequest.js +3 -11
  81. package/dist/models/SignOffStatus.d.ts +26 -0
  82. package/dist/models/SignOffStatus.js +52 -0
  83. package/dist/models/UserRole.d.ts +29 -0
  84. package/dist/models/UserRole.js +55 -0
  85. package/dist/models/index.d.ts +15 -0
  86. package/dist/models/index.js +15 -0
  87. package/package.json +1 -1
  88. package/src/models/AustralianState.ts +59 -0
  89. package/src/models/AuthRegisterGuardRequestLicencesInner.ts +11 -14
  90. package/src/models/DevicesRegisterRequest.ts +12 -13
  91. package/src/models/ExportQueuedResource.ts +12 -15
  92. package/src/models/IncidentFieldSchemaResource.ts +23 -27
  93. package/src/models/IncidentSchemaType.ts +53 -0
  94. package/src/models/IncidentVideoResource.ts +12 -14
  95. package/src/models/IncidentVideoStatus.ts +54 -0
  96. package/src/models/LicenceCheckLogResource.ts +12 -18
  97. package/src/models/LicenceCheckSource.ts +58 -0
  98. package/src/models/LicenceListResource.ts +11 -14
  99. package/src/models/LicenceLiteResource.ts +12 -14
  100. package/src/models/LicenceResource.ts +11 -14
  101. package/src/models/LicenceState.ts +54 -0
  102. package/src/models/LicencesStoreRequest.ts +11 -14
  103. package/src/models/LicencesUpdateRequest.ts +11 -14
  104. package/src/models/LicencesVerifyRequest.ts +12 -14
  105. package/src/models/LoginPlatform.ts +53 -0
  106. package/src/models/MobileAppConfigRequest.ts +12 -13
  107. package/src/models/MobileAppConfigResource.ts +12 -13
  108. package/src/models/MobileDevicePlatform.ts +53 -0
  109. package/src/models/MobileDeviceResource.ts +12 -13
  110. package/src/models/NotificationPreferenceResource.ts +11 -20
  111. package/src/models/NotificationPreferencesBulkRequestPreferencesInner.ts +12 -20
  112. package/src/models/NotificationPreferencesStoreRequest.ts +12 -20
  113. package/src/models/NotificationStatus.ts +53 -0
  114. package/src/models/NotificationType.ts +60 -0
  115. package/src/models/PdfExportDownloadType.ts +54 -0
  116. package/src/models/PdfExportKind.ts +56 -0
  117. package/src/models/PdfExportResource.ts +12 -15
  118. package/src/models/PdfExportStatus.ts +55 -0
  119. package/src/models/RecordSource.ts +56 -0
  120. package/src/models/RegisterListResource.ts +11 -14
  121. package/src/models/RegisterResource.ts +11 -14
  122. package/src/models/RegistersUpdateRequest.ts +11 -14
  123. package/src/models/RosterListResource.ts +11 -14
  124. package/src/models/RosterResource.ts +11 -14
  125. package/src/models/RosterWithRegistersResource.ts +11 -14
  126. package/src/models/RostersUpdateRequest.ts +12 -14
  127. package/src/models/SignOffStatus.ts +54 -0
  128. package/src/models/UserRole.ts +57 -0
  129. package/src/models/index.ts +15 -0
@@ -13,6 +13,14 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { SignOffStatus } from './SignOffStatus';
17
+ import {
18
+ SignOffStatusFromJSON,
19
+ SignOffStatusFromJSONTyped,
20
+ SignOffStatusToJSON,
21
+ SignOffStatusToJSONTyped,
22
+ } from './SignOffStatus';
23
+
16
24
  /**
17
25
  *
18
26
  * @export
@@ -45,10 +53,10 @@ export interface RostersUpdateRequest {
45
53
  finishDateTime?: Date;
46
54
  /**
47
55
  *
48
- * @type {string}
56
+ * @type {SignOffStatus}
49
57
  * @memberof RostersUpdateRequest
50
58
  */
51
- signOffStatus?: RostersUpdateRequestSignOffStatusEnum;
59
+ signOffStatus?: SignOffStatus;
52
60
  /**
53
61
  *
54
62
  * @type {boolean}
@@ -64,16 +72,6 @@ export interface RostersUpdateRequest {
64
72
  }
65
73
 
66
74
 
67
- /**
68
- * @export
69
- */
70
- export const RostersUpdateRequestSignOffStatusEnum = {
71
- _0: '0',
72
- _1: '1',
73
- _2: '2'
74
- } as const;
75
- export type RostersUpdateRequestSignOffStatusEnum = typeof RostersUpdateRequestSignOffStatusEnum[keyof typeof RostersUpdateRequestSignOffStatusEnum];
76
-
77
75
 
78
76
  /**
79
77
  * Check if a given object implements the RostersUpdateRequest interface.
@@ -96,7 +94,7 @@ export function RostersUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator
96
94
  'securityCompanyId': json['security_company_id'] == null ? undefined : json['security_company_id'],
97
95
  'startDateTime': json['start_date_time'] == null ? undefined : (new Date(json['start_date_time'])),
98
96
  'finishDateTime': json['finish_date_time'] == null ? undefined : (new Date(json['finish_date_time'])),
99
- 'signOffStatus': json['sign_off_status'] == null ? undefined : json['sign_off_status'],
97
+ 'signOffStatus': json['sign_off_status'] == null ? undefined : SignOffStatusFromJSON(json['sign_off_status']),
100
98
  'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
101
99
  'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
102
100
  };
@@ -117,7 +115,7 @@ export function RostersUpdateRequestToJSONTyped(value?: RostersUpdateRequest | n
117
115
  'security_company_id': value['securityCompanyId'],
118
116
  'start_date_time': value['startDateTime'] == null ? undefined : ((value['startDateTime']).toISOString()),
119
117
  'finish_date_time': value['finishDateTime'] == null ? undefined : ((value['finishDateTime']).toISOString()),
120
- 'sign_off_status': value['signOffStatus'],
118
+ 'sign_off_status': SignOffStatusToJSON(value['signOffStatus']),
121
119
  'is_complete': value['isComplete'],
122
120
  'is_compliant': value['isCompliant'],
123
121
  };
@@ -0,0 +1,54 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Security Registers API
5
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
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
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const SignOffStatus = {
21
+ NUMBER_0: 0,
22
+ NUMBER_1: 1,
23
+ NUMBER_2: 2
24
+ } as const;
25
+ export type SignOffStatus = typeof SignOffStatus[keyof typeof SignOffStatus];
26
+
27
+
28
+ export function instanceOfSignOffStatus(value: any): boolean {
29
+ for (const key in SignOffStatus) {
30
+ if (Object.prototype.hasOwnProperty.call(SignOffStatus, key)) {
31
+ if (SignOffStatus[key as keyof typeof SignOffStatus] === value) {
32
+ return true;
33
+ }
34
+ }
35
+ }
36
+ return false;
37
+ }
38
+
39
+ export function SignOffStatusFromJSON(json: any): SignOffStatus {
40
+ return SignOffStatusFromJSONTyped(json, false);
41
+ }
42
+
43
+ export function SignOffStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignOffStatus {
44
+ return json as SignOffStatus;
45
+ }
46
+
47
+ export function SignOffStatusToJSON(value?: SignOffStatus | null): any {
48
+ return value as any;
49
+ }
50
+
51
+ export function SignOffStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): SignOffStatus {
52
+ return value as SignOffStatus;
53
+ }
54
+
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Security Registers API
5
+ * API for the Security Registers compliance platform: guard rosters, sign-on/off registers, incidents, and licence verification.
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
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const UserRole = {
21
+ Superadmin: 'superadmin',
22
+ Admin: 'admin',
23
+ SecurityCompanyManager: 'security_company_manager',
24
+ VenueManager: 'venue_manager',
25
+ VenueStaff: 'venue_staff',
26
+ VenueGuard: 'venue_guard'
27
+ } as const;
28
+ export type UserRole = typeof UserRole[keyof typeof UserRole];
29
+
30
+
31
+ export function instanceOfUserRole(value: any): boolean {
32
+ for (const key in UserRole) {
33
+ if (Object.prototype.hasOwnProperty.call(UserRole, key)) {
34
+ if (UserRole[key as keyof typeof UserRole] === value) {
35
+ return true;
36
+ }
37
+ }
38
+ }
39
+ return false;
40
+ }
41
+
42
+ export function UserRoleFromJSON(json: any): UserRole {
43
+ return UserRoleFromJSONTyped(json, false);
44
+ }
45
+
46
+ export function UserRoleFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserRole {
47
+ return json as UserRole;
48
+ }
49
+
50
+ export function UserRoleToJSON(value?: UserRole | null): any {
51
+ return value as any;
52
+ }
53
+
54
+ export function UserRoleToJSONTyped(value: any, ignoreDiscriminator: boolean): UserRole {
55
+ return value as UserRole;
56
+ }
57
+
@@ -9,6 +9,7 @@ export * from './AssetLiteResourceArrayResponse';
9
9
  export * from './AssetResource';
10
10
  export * from './AssetResourceArrayResponse';
11
11
  export * from './AssetsFileStoreRequest';
12
+ export * from './AustralianState';
12
13
  export * from './AuthChangePasswordRequest';
13
14
  export * from './AuthForgotPasswordRequest';
14
15
  export * from './AuthLoginWebRequest';
@@ -44,12 +45,14 @@ export * from './IncidentLiteResourceArrayResponse';
44
45
  export * from './IncidentLiteResourceStaff';
45
46
  export * from './IncidentResource';
46
47
  export * from './IncidentResourceArrayResponse';
48
+ export * from './IncidentSchemaType';
47
49
  export * from './IncidentVersionResource';
48
50
  export * from './IncidentVersionResourceArrayResponse';
49
51
  export * from './IncidentVideoResource';
50
52
  export * from './IncidentVideoResourceArrayResponse';
51
53
  export * from './IncidentVideoSignedUrlResource';
52
54
  export * from './IncidentVideoSignedUrlResourceArrayResponse';
55
+ export * from './IncidentVideoStatus';
53
56
  export * from './IncidentVideoUploadTokenResource';
54
57
  export * from './IncidentVideoUploadTokenResourceArrayResponse';
55
58
  export * from './IncidentVideosRecentRequest';
@@ -66,12 +69,14 @@ export * from './IncidentsVideosStoreRequest';
66
69
  export * from './IncidentsVideosUploadTokenRequest';
67
70
  export * from './LicenceCheckLogResource';
68
71
  export * from './LicenceCheckLogResourceArrayResponse';
72
+ export * from './LicenceCheckSource';
69
73
  export * from './LicenceListResource';
70
74
  export * from './LicenceListResourceArrayResponse';
71
75
  export * from './LicenceLiteResource';
72
76
  export * from './LicenceLiteResourceArrayResponse';
73
77
  export * from './LicenceResource';
74
78
  export * from './LicenceResourceArrayResponse';
79
+ export * from './LicenceState';
75
80
  export * from './LicenceVerificationFallbackSettingResource';
76
81
  export * from './LicenceVerificationFallbackSettingResourceArrayResponse';
77
82
  export * from './LicencesCheckLogsListRequest';
@@ -81,9 +86,11 @@ export * from './LicencesStoreRequest';
81
86
  export * from './LicencesStoreRequestBackAsset';
82
87
  export * from './LicencesUpdateRequest';
83
88
  export * from './LicencesVerifyRequest';
89
+ export * from './LoginPlatform';
84
90
  export * from './MobileAppConfigRequest';
85
91
  export * from './MobileAppConfigResource';
86
92
  export * from './MobileAppConfigResourceArrayResponse';
93
+ export * from './MobileDevicePlatform';
87
94
  export * from './MobileDeviceResource';
88
95
  export * from './MobileDeviceResourceArrayResponse';
89
96
  export * from './MobileInitResource';
@@ -93,6 +100,8 @@ export * from './NotificationPreferenceResourceArrayResponse';
93
100
  export * from './NotificationPreferencesBulkRequest';
94
101
  export * from './NotificationPreferencesBulkRequestPreferencesInner';
95
102
  export * from './NotificationPreferencesStoreRequest';
103
+ export * from './NotificationStatus';
104
+ export * from './NotificationType';
96
105
  export * from './NotificationTypeResource';
97
106
  export * from './NotificationTypeResourceArrayResponse';
98
107
  export * from './PaginatedIncidentListResourceResponse';
@@ -110,10 +119,14 @@ export * from './PaginatedSecurityCompanyResourceResponse';
110
119
  export * from './PaginatedUserResourceResponse';
111
120
  export * from './PaginatedVenueResourceResponse';
112
121
  export * from './PagingMetadata';
122
+ export * from './PdfExportDownloadType';
123
+ export * from './PdfExportKind';
113
124
  export * from './PdfExportResource';
114
125
  export * from './PdfExportResourceArrayResponse';
126
+ export * from './PdfExportStatus';
115
127
  export * from './RecentVideoListResource';
116
128
  export * from './RecentVideoListResourceArrayResponse';
129
+ export * from './RecordSource';
117
130
  export * from './RegisterGroupedByRosterResource';
118
131
  export * from './RegisterGroupedByRosterResourceArrayResponse';
119
132
  export * from './RegisterListResource';
@@ -152,6 +165,7 @@ export * from './SecurityCompanyLiteResourceArrayResponse';
152
165
  export * from './SecurityCompanyResource';
153
166
  export * from './SecurityCompanyResourceArrayResponse';
154
167
  export * from './SettingsLicenceVerificationFallbackUpdateRequest';
168
+ export * from './SignOffStatus';
155
169
  export * from './StoreUserRequest';
156
170
  export * from './UserAuthTokenResource';
157
171
  export * from './UserAuthTokenResourceArrayResponse';
@@ -161,6 +175,7 @@ export * from './UserRelationResource';
161
175
  export * from './UserRelationResourceArrayResponse';
162
176
  export * from './UserResource';
163
177
  export * from './UserResourceArrayResponse';
178
+ export * from './UserRole';
164
179
  export * from './UserVenueResource';
165
180
  export * from './UserVenueResourceArrayResponse';
166
181
  export * from './UsersAttachSecurityCompaniesRequest';