@digital8/security-registers-backend-ts-sdk 0.0.300 → 0.0.302

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 (57) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +3 -3
  4. package/dist/apis/GeneralApi.js +1 -1
  5. package/dist/models/IncidentImageResource.d.ts +1 -1
  6. package/dist/models/IncidentImageResource.js +1 -3
  7. package/dist/models/NearbyVenueResource.d.ts +62 -0
  8. package/dist/models/NearbyVenueResource.js +69 -0
  9. package/dist/models/NearbyVenueResourceArrayResponse.d.ts +33 -0
  10. package/dist/models/NearbyVenueResourceArrayResponse.js +50 -0
  11. package/dist/models/RegisterGroupedByRosterResource.d.ts +1 -1
  12. package/dist/models/RegisterGroupedByRosterResource.js +3 -4
  13. package/dist/models/RegisterListResource.d.ts +8 -2
  14. package/dist/models/RegisterListResource.js +10 -2
  15. package/dist/models/RegisterResource.d.ts +8 -2
  16. package/dist/models/RegisterResource.js +10 -2
  17. package/dist/models/RegistersCreateRequest.d.ts +6 -0
  18. package/dist/models/RegistersCreateRequest.js +2 -0
  19. package/dist/models/RegistersSignOnRequest.d.ts +6 -0
  20. package/dist/models/RegistersSignOnRequest.js +2 -0
  21. package/dist/models/RosterListResource.d.ts +1 -1
  22. package/dist/models/RosterListResource.js +3 -4
  23. package/dist/models/RosterLiteResource.d.ts +1 -1
  24. package/dist/models/RosterLiteResource.js +4 -3
  25. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  26. package/dist/models/SecurityCompanyResource.js +1 -3
  27. package/dist/models/VenueResource.d.ts +6 -0
  28. package/dist/models/VenueResource.js +4 -0
  29. package/dist/models/VenuesListAllRequest.d.ts +6 -0
  30. package/dist/models/VenuesListAllRequest.js +2 -0
  31. package/dist/models/VenuesListRequest.d.ts +6 -0
  32. package/dist/models/VenuesListRequest.js +2 -0
  33. package/dist/models/VenuesPublicStoreRequest.d.ts +6 -0
  34. package/dist/models/VenuesPublicStoreRequest.js +2 -0
  35. package/dist/models/VenuesUpdateRequest.d.ts +6 -0
  36. package/dist/models/VenuesUpdateRequest.js +2 -0
  37. package/dist/models/index.d.ts +2 -0
  38. package/dist/models/index.js +2 -0
  39. package/package.json +1 -1
  40. package/src/apis/GeneralApi.ts +6 -3
  41. package/src/models/IncidentImageResource.ts +2 -3
  42. package/src/models/NearbyVenueResource.ts +110 -0
  43. package/src/models/NearbyVenueResourceArrayResponse.ts +73 -0
  44. package/src/models/RegisterGroupedByRosterResource.ts +3 -4
  45. package/src/models/RegisterListResource.ts +15 -4
  46. package/src/models/RegisterResource.ts +15 -4
  47. package/src/models/RegistersCreateRequest.ts +8 -0
  48. package/src/models/RegistersSignOnRequest.ts +8 -0
  49. package/src/models/RosterListResource.ts +3 -4
  50. package/src/models/RosterLiteResource.ts +4 -3
  51. package/src/models/SecurityCompanyResource.ts +2 -3
  52. package/src/models/VenueResource.ts +9 -0
  53. package/src/models/VenuesListAllRequest.ts +8 -0
  54. package/src/models/VenuesListRequest.ts +8 -0
  55. package/src/models/VenuesPublicStoreRequest.ts +8 -0
  56. package/src/models/VenuesUpdateRequest.ts +8 -0
  57. package/src/models/index.ts +2 -0
@@ -85,6 +85,12 @@ export interface RegistersCreateRequest {
85
85
  * @memberof RegistersCreateRequest
86
86
  */
87
87
  badgeNumber?: string;
88
+ /**
89
+ *
90
+ * @type {boolean}
91
+ * @memberof RegistersCreateRequest
92
+ */
93
+ rampRead?: boolean;
88
94
  /**
89
95
  *
90
96
  * @type {boolean}
@@ -127,6 +133,7 @@ export function RegistersCreateRequestFromJSONTyped(json: any, ignoreDiscriminat
127
133
  'signOffLat': json['sign_off_lat'] == null ? undefined : json['sign_off_lat'],
128
134
  'signOffLong': json['sign_off_long'] == null ? undefined : json['sign_off_long'],
129
135
  'badgeNumber': json['badge_number'] == null ? undefined : json['badge_number'],
136
+ 'rampRead': json['ramp_read'] == null ? undefined : json['ramp_read'],
130
137
  'bypassActiveRegisterCheck': json['bypass_active_register_check'] == null ? undefined : json['bypass_active_register_check'],
131
138
  };
132
139
  }
@@ -153,6 +160,7 @@ export function RegistersCreateRequestToJSONTyped(value?: RegistersCreateRequest
153
160
  'sign_off_lat': value['signOffLat'],
154
161
  'sign_off_long': value['signOffLong'],
155
162
  'badge_number': value['badgeNumber'],
163
+ 'ramp_read': value['rampRead'],
156
164
  'bypass_active_register_check': value['bypassActiveRegisterCheck'],
157
165
  };
158
166
  }
@@ -61,6 +61,12 @@ export interface RegistersSignOnRequest {
61
61
  * @memberof RegistersSignOnRequest
62
62
  */
63
63
  badgeNumber?: string;
64
+ /**
65
+ *
66
+ * @type {boolean}
67
+ * @memberof RegistersSignOnRequest
68
+ */
69
+ rampRead?: boolean;
64
70
  }
65
71
 
66
72
  /**
@@ -92,6 +98,7 @@ export function RegistersSignOnRequestFromJSONTyped(json: any, ignoreDiscriminat
92
98
  'signatureAssetId': json['signature_asset_id'],
93
99
  'signOnCode': json['sign_on_code'] == null ? undefined : json['sign_on_code'],
94
100
  'badgeNumber': json['badge_number'] == null ? undefined : json['badge_number'],
101
+ 'rampRead': json['ramp_read'] == null ? undefined : json['ramp_read'],
95
102
  };
96
103
  }
97
104
 
@@ -113,6 +120,7 @@ export function RegistersSignOnRequestToJSONTyped(value?: RegistersSignOnRequest
113
120
  'signature_asset_id': value['signatureAssetId'],
114
121
  'sign_on_code': value['signOnCode'],
115
122
  'badge_number': value['badgeNumber'],
123
+ 'ramp_read': value['rampRead'],
116
124
  };
117
125
  }
118
126
 
@@ -63,7 +63,7 @@ export interface RosterListResource {
63
63
  * @type {Date}
64
64
  * @memberof RosterListResource
65
65
  */
66
- finishDateTime: Date;
66
+ finishDateTime?: Date | null;
67
67
  /**
68
68
  *
69
69
  * @type {boolean}
@@ -97,7 +97,6 @@ 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;
101
100
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
102
101
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
103
102
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -119,7 +118,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
119
118
  'venue': VenueLiteResourceFromJSON(json['venue']),
120
119
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
121
120
  'startDateTime': (new Date(json['startDateTime'])),
122
- 'finishDateTime': (new Date(json['finishDateTime'])),
121
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
123
122
  'isCompliant': json['isCompliant'],
124
123
  'isComplete': json['isComplete'],
125
124
  'signOffStatus': json['signOffStatus'],
@@ -142,7 +141,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
142
141
  'venue': VenueLiteResourceToJSON(value['venue']),
143
142
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
144
143
  'startDateTime': ((value['startDateTime']).toISOString()),
145
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
144
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
146
145
  'isCompliant': value['isCompliant'],
147
146
  'isComplete': value['isComplete'],
148
147
  'signOffStatus': value['signOffStatus'],
@@ -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
 
@@ -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'],
@@ -77,6 +77,12 @@ export interface VenueResource {
77
77
  * @memberof VenueResource
78
78
  */
79
79
  venueSignOnCodeRequired: boolean;
80
+ /**
81
+ *
82
+ * @type {boolean}
83
+ * @memberof VenueResource
84
+ */
85
+ rampReadingRequired: boolean;
80
86
  /**
81
87
  *
82
88
  * @type {number}
@@ -154,6 +160,7 @@ export function instanceOfVenueResource(value: object): value is VenueResource {
154
160
  if (!('venueApiKey' in value) || value['venueApiKey'] === undefined) return false;
155
161
  if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined) return false;
156
162
  if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined) return false;
163
+ if (!('rampReadingRequired' in value) || value['rampReadingRequired'] === undefined) return false;
157
164
  if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
158
165
  if (!('timezone' in value) || value['timezone'] === undefined) return false;
159
166
  if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
@@ -181,6 +188,7 @@ export function VenueResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
181
188
  'venueApiKey': json['venueApiKey'],
182
189
  'badgeNumberRequired': json['badgeNumberRequired'],
183
190
  'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
191
+ 'rampReadingRequired': json['rampReadingRequired'],
184
192
  'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
185
193
  'primaryManager': UserRelationResourceFromJSON(json['primaryManager']),
186
194
  'timezone': json['timezone'],
@@ -212,6 +220,7 @@ export function VenueResourceToJSONTyped(value?: VenueResource | null, ignoreDis
212
220
  'venueApiKey': value['venueApiKey'],
213
221
  'badgeNumberRequired': value['badgeNumberRequired'],
214
222
  'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
223
+ 'rampReadingRequired': value['rampReadingRequired'],
215
224
  'primaryManagerId': value['primaryManagerId'],
216
225
  'primaryManager': UserRelationResourceToJSON(value['primaryManager']),
217
226
  'timezone': value['timezone'],
@@ -73,6 +73,12 @@ export interface VenuesListAllRequest {
73
73
  * @memberof VenuesListAllRequest
74
74
  */
75
75
  venueSignOnCodeRequired?: Array<string>;
76
+ /**
77
+ *
78
+ * @type {Array<string>}
79
+ * @memberof VenuesListAllRequest
80
+ */
81
+ rampReadingRequired?: Array<string>;
76
82
  /**
77
83
  *
78
84
  * @type {Array<string>}
@@ -146,6 +152,7 @@ export function VenuesListAllRequestFromJSONTyped(json: any, ignoreDiscriminator
146
152
  'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
147
153
  'badgeNumberRequired': json['badge_number_required'] == null ? undefined : json['badge_number_required'],
148
154
  'venueSignOnCodeRequired': json['venue_sign_on_code_required'] == null ? undefined : json['venue_sign_on_code_required'],
155
+ 'rampReadingRequired': json['ramp_reading_required'] == null ? undefined : json['ramp_reading_required'],
149
156
  'primaryManagerId': json['primary_manager_id'] == null ? undefined : json['primary_manager_id'],
150
157
  'addressState': json['address-state'] == null ? undefined : json['address-state'],
151
158
  };
@@ -171,6 +178,7 @@ export function VenuesListAllRequestToJSONTyped(value?: VenuesListAllRequest | n
171
178
  'is_enabled': value['isEnabled'],
172
179
  'badge_number_required': value['badgeNumberRequired'],
173
180
  'venue_sign_on_code_required': value['venueSignOnCodeRequired'],
181
+ 'ramp_reading_required': value['rampReadingRequired'],
174
182
  'primary_manager_id': value['primaryManagerId'],
175
183
  'address-state': value['addressState'],
176
184
  };
@@ -67,6 +67,12 @@ export interface VenuesListRequest {
67
67
  * @memberof VenuesListRequest
68
68
  */
69
69
  venueSignOnCodeRequired?: Array<string>;
70
+ /**
71
+ *
72
+ * @type {Array<string>}
73
+ * @memberof VenuesListRequest
74
+ */
75
+ rampReadingRequired?: Array<string>;
70
76
  /**
71
77
  *
72
78
  * @type {Array<string>}
@@ -157,6 +163,7 @@ export function VenuesListRequestFromJSONTyped(json: any, ignoreDiscriminator: b
157
163
  'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
158
164
  'badgeNumberRequired': json['badge_number_required'] == null ? undefined : json['badge_number_required'],
159
165
  'venueSignOnCodeRequired': json['venue_sign_on_code_required'] == null ? undefined : json['venue_sign_on_code_required'],
166
+ 'rampReadingRequired': json['ramp_reading_required'] == null ? undefined : json['ramp_reading_required'],
160
167
  'primaryManagerId': json['primary_manager_id'] == null ? undefined : json['primary_manager_id'],
161
168
  'addressState': json['address-state'] == null ? undefined : json['address-state'],
162
169
  'relatedId': json['related_id'] == null ? undefined : json['related_id'],
@@ -184,6 +191,7 @@ export function VenuesListRequestToJSONTyped(value?: VenuesListRequest | null, i
184
191
  'is_enabled': value['isEnabled'],
185
192
  'badge_number_required': value['badgeNumberRequired'],
186
193
  'venue_sign_on_code_required': value['venueSignOnCodeRequired'],
194
+ 'ramp_reading_required': value['rampReadingRequired'],
187
195
  'primary_manager_id': value['primaryManagerId'],
188
196
  'address-state': value['addressState'],
189
197
  'related_id': value['relatedId'],
@@ -43,6 +43,12 @@ export interface VenuesPublicStoreRequest {
43
43
  * @memberof VenuesPublicStoreRequest
44
44
  */
45
45
  venueSignOnCodeRequired?: boolean;
46
+ /**
47
+ *
48
+ * @type {boolean}
49
+ * @memberof VenuesPublicStoreRequest
50
+ */
51
+ rampReadingRequired?: boolean;
46
52
  /**
47
53
  *
48
54
  * @type {boolean}
@@ -168,6 +174,7 @@ export function VenuesPublicStoreRequestFromJSONTyped(json: any, ignoreDiscrimin
168
174
  'venueCode': json['venue_code'],
169
175
  'badgeNumberRequired': json['badge_number_required'] == null ? undefined : json['badge_number_required'],
170
176
  'venueSignOnCodeRequired': json['venue_sign_on_code_required'] == null ? undefined : json['venue_sign_on_code_required'],
177
+ 'rampReadingRequired': json['ramp_reading_required'] == null ? undefined : json['ramp_reading_required'],
171
178
  'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
172
179
  'primaryManagerId': json['primary_manager_id'] == null ? undefined : json['primary_manager_id'],
173
180
  'geofenceRadius': json['geofence_radius'] == null ? undefined : json['geofence_radius'],
@@ -199,6 +206,7 @@ export function VenuesPublicStoreRequestToJSONTyped(value?: VenuesPublicStoreReq
199
206
  'venue_code': value['venueCode'],
200
207
  'badge_number_required': value['badgeNumberRequired'],
201
208
  'venue_sign_on_code_required': value['venueSignOnCodeRequired'],
209
+ 'ramp_reading_required': value['rampReadingRequired'],
202
210
  'is_enabled': value['isEnabled'],
203
211
  'primary_manager_id': value['primaryManagerId'],
204
212
  'geofence_radius': value['geofenceRadius'],
@@ -43,6 +43,12 @@ export interface VenuesUpdateRequest {
43
43
  * @memberof VenuesUpdateRequest
44
44
  */
45
45
  venueSignOnCodeRequired?: boolean;
46
+ /**
47
+ *
48
+ * @type {boolean}
49
+ * @memberof VenuesUpdateRequest
50
+ */
51
+ rampReadingRequired?: boolean;
46
52
  /**
47
53
  *
48
54
  * @type {number}
@@ -163,6 +169,7 @@ export function VenuesUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator:
163
169
  'venueCode': json['venue_code'] == null ? undefined : json['venue_code'],
164
170
  'badgeNumberRequired': json['badge_number_required'] == null ? undefined : json['badge_number_required'],
165
171
  'venueSignOnCodeRequired': json['venue_sign_on_code_required'] == null ? undefined : json['venue_sign_on_code_required'],
172
+ 'rampReadingRequired': json['ramp_reading_required'] == null ? undefined : json['ramp_reading_required'],
166
173
  'primaryManagerId': json['primary_manager_id'] == null ? undefined : json['primary_manager_id'],
167
174
  'securityCompanyId': json['security_company_id'] == null ? undefined : json['security_company_id'],
168
175
  'isEnabled': json['is_enabled'] == null ? undefined : json['is_enabled'],
@@ -194,6 +201,7 @@ export function VenuesUpdateRequestToJSONTyped(value?: VenuesUpdateRequest | nul
194
201
  'venue_code': value['venueCode'],
195
202
  'badge_number_required': value['badgeNumberRequired'],
196
203
  'venue_sign_on_code_required': value['venueSignOnCodeRequired'],
204
+ 'ramp_reading_required': value['rampReadingRequired'],
197
205
  'primary_manager_id': value['primaryManagerId'],
198
206
  'security_company_id': value['securityCompanyId'],
199
207
  'is_enabled': value['isEnabled'],
@@ -69,6 +69,8 @@ export * from './MobileDeviceResource';
69
69
  export * from './MobileDeviceResourceArrayResponse';
70
70
  export * from './MobileInitResource';
71
71
  export * from './MobileInitResourceArrayResponse';
72
+ export * from './NearbyVenueResource';
73
+ export * from './NearbyVenueResourceArrayResponse';
72
74
  export * from './NotificationPreferenceResource';
73
75
  export * from './NotificationPreferenceResourceArrayResponse';
74
76
  export * from './NotificationPreferencesStoreRequest';