@digital8/security-registers-backend-ts-sdk 0.0.172 → 0.0.173

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 (23) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/GeneralApi.d.ts +22 -0
  3. package/dist/apis/GeneralApi.js +112 -0
  4. package/dist/models/AssetResource.d.ts +1 -1
  5. package/dist/models/AssetResource.js +3 -1
  6. package/dist/models/RegisterGroupedByRosterResource.d.ts +1 -1
  7. package/dist/models/RegisterGroupedByRosterResource.js +4 -3
  8. package/dist/models/RegisterListResource.d.ts +2 -2
  9. package/dist/models/RegisterListResource.js +6 -2
  10. package/dist/models/RegisterResource.d.ts +1 -1
  11. package/dist/models/RegisterResource.js +1 -3
  12. package/dist/models/RosterListResource.d.ts +1 -1
  13. package/dist/models/RosterListResource.js +3 -4
  14. package/dist/models/RosterWithRegistersResource.d.ts +1 -1
  15. package/dist/models/RosterWithRegistersResource.js +4 -3
  16. package/package.json +1 -1
  17. package/src/apis/GeneralApi.ts +98 -0
  18. package/src/models/AssetResource.ts +3 -2
  19. package/src/models/RegisterGroupedByRosterResource.ts +4 -3
  20. package/src/models/RegisterListResource.ts +6 -4
  21. package/src/models/RegisterResource.ts +2 -3
  22. package/src/models/RosterListResource.ts +3 -4
  23. package/src/models/RosterWithRegistersResource.ts +4 -3
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @digital8/security-registers-backend-ts-sdk@0.0.172
1
+ ## @digital8/security-registers-backend-ts-sdk@0.0.173
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @digital8/security-registers-backend-ts-sdk@0.0.172 --save
39
+ npm install @digital8/security-registers-backend-ts-sdk@0.0.173 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/dist/apis/GeneralApi.d.ts CHANGED
@@ -66,6 +66,12 @@ export interface ResetPasswordAuthOperationRequest {
66
66
  export interface RostersExportPdfOperationRequest {
67
67
  rostersExportPdfRequest?: RostersExportPdfRequest;
68
68
  }
69
+ export interface RostersExportPdfDownloadRequest {
70
+ pdfExport: number;
71
+ }
72
+ export interface RostersExportPdfStatusRequest {
73
+ pdfExport: number;
74
+ }
69
75
  export interface RostersListOperationRequest {
70
76
  rostersListRequest?: RostersListRequest;
71
77
  }
@@ -340,6 +346,22 @@ export declare class GeneralApi extends runtime.BaseAPI {
340
346
  * Auto-generated: rosters.exportPdf
341
347
  */
342
348
  rostersExportPdf(requestParameters?: RostersExportPdfOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse>;
349
+ /**
350
+ * Auto-generated: rosters.exportPdf.download
351
+ */
352
+ rostersExportPdfDownloadRaw(requestParameters: RostersExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
353
+ /**
354
+ * Auto-generated: rosters.exportPdf.download
355
+ */
356
+ rostersExportPdfDownload(requestParameters: RostersExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
357
+ /**
358
+ * Auto-generated: rosters.exportPdf.status
359
+ */
360
+ rostersExportPdfStatusRaw(requestParameters: RostersExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>>;
361
+ /**
362
+ * Auto-generated: rosters.exportPdf.status
363
+ */
364
+ rostersExportPdfStatus(requestParameters: RostersExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse>;
343
365
  /**
344
366
  * Auto-generated: rosters.list
345
367
  */
package/dist/apis/GeneralApi.js CHANGED
@@ -1176,6 +1176,118 @@ var GeneralApi = /** @class */ (function (_super) {
1176
1176
  });
1177
1177
  });
1178
1178
  };
1179
+ /**
1180
+ * Auto-generated: rosters.exportPdf.download
1181
+ */
1182
+ GeneralApi.prototype.rostersExportPdfDownloadRaw = function (requestParameters, initOverrides) {
1183
+ return __awaiter(this, void 0, void 0, function () {
1184
+ var queryParameters, headerParameters, token, tokenString, urlPath, response;
1185
+ return __generator(this, function (_a) {
1186
+ switch (_a.label) {
1187
+ case 0:
1188
+ if (requestParameters['pdfExport'] == null) {
1189
+ throw new runtime.RequiredError('pdfExport', 'Required parameter "pdfExport" was null or undefined when calling rostersExportPdfDownload().');
1190
+ }
1191
+ queryParameters = {};
1192
+ headerParameters = {};
1193
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1194
+ token = this.configuration.accessToken;
1195
+ return [4 /*yield*/, token("bearerAuth", [])];
1196
+ case 1:
1197
+ tokenString = _a.sent();
1198
+ if (tokenString) {
1199
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1200
+ }
1201
+ _a.label = 2;
1202
+ case 2:
1203
+ urlPath = "/api/rosters/export-pdf/{pdfExport}/download";
1204
+ urlPath = urlPath.replace("{".concat("pdfExport", "}"), encodeURIComponent(String(requestParameters['pdfExport'])));
1205
+ return [4 /*yield*/, this.request({
1206
+ path: urlPath,
1207
+ method: 'GET',
1208
+ headers: headerParameters,
1209
+ query: queryParameters,
1210
+ }, initOverrides)];
1211
+ case 3:
1212
+ response = _a.sent();
1213
+ return [2 /*return*/, new runtime.BlobApiResponse(response)];
1214
+ }
1215
+ });
1216
+ });
1217
+ };
1218
+ /**
1219
+ * Auto-generated: rosters.exportPdf.download
1220
+ */
1221
+ GeneralApi.prototype.rostersExportPdfDownload = function (requestParameters, initOverrides) {
1222
+ return __awaiter(this, void 0, void 0, function () {
1223
+ var response;
1224
+ return __generator(this, function (_a) {
1225
+ switch (_a.label) {
1226
+ case 0: return [4 /*yield*/, this.rostersExportPdfDownloadRaw(requestParameters, initOverrides)];
1227
+ case 1:
1228
+ response = _a.sent();
1229
+ return [4 /*yield*/, response.value()];
1230
+ case 2: return [2 /*return*/, _a.sent()];
1231
+ }
1232
+ });
1233
+ });
1234
+ };
1235
+ /**
1236
+ * Auto-generated: rosters.exportPdf.status
1237
+ */
1238
+ GeneralApi.prototype.rostersExportPdfStatusRaw = function (requestParameters, initOverrides) {
1239
+ return __awaiter(this, void 0, void 0, function () {
1240
+ var queryParameters, headerParameters, token, tokenString, urlPath, response;
1241
+ return __generator(this, function (_a) {
1242
+ switch (_a.label) {
1243
+ case 0:
1244
+ if (requestParameters['pdfExport'] == null) {
1245
+ throw new runtime.RequiredError('pdfExport', 'Required parameter "pdfExport" was null or undefined when calling rostersExportPdfStatus().');
1246
+ }
1247
+ queryParameters = {};
1248
+ headerParameters = {};
1249
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1250
+ token = this.configuration.accessToken;
1251
+ return [4 /*yield*/, token("bearerAuth", [])];
1252
+ case 1:
1253
+ tokenString = _a.sent();
1254
+ if (tokenString) {
1255
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
1256
+ }
1257
+ _a.label = 2;
1258
+ case 2:
1259
+ urlPath = "/api/rosters/export-pdf/{pdfExport}/status";
1260
+ urlPath = urlPath.replace("{".concat("pdfExport", "}"), encodeURIComponent(String(requestParameters['pdfExport'])));
1261
+ return [4 /*yield*/, this.request({
1262
+ path: urlPath,
1263
+ method: 'POST',
1264
+ headers: headerParameters,
1265
+ query: queryParameters,
1266
+ }, initOverrides)];
1267
+ case 3:
1268
+ response = _a.sent();
1269
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.GenericResponseFromJSON)(jsonValue); })];
1270
+ }
1271
+ });
1272
+ });
1273
+ };
1274
+ /**
1275
+ * Auto-generated: rosters.exportPdf.status
1276
+ */
1277
+ GeneralApi.prototype.rostersExportPdfStatus = function (requestParameters, initOverrides) {
1278
+ return __awaiter(this, void 0, void 0, function () {
1279
+ var response;
1280
+ return __generator(this, function (_a) {
1281
+ switch (_a.label) {
1282
+ case 0: return [4 /*yield*/, this.rostersExportPdfStatusRaw(requestParameters, initOverrides)];
1283
+ case 1:
1284
+ response = _a.sent();
1285
+ return [4 /*yield*/, response.value()];
1286
+ case 2: return [2 /*return*/, _a.sent()];
1287
+ }
1288
+ });
1289
+ });
1290
+ };
1179
1291
  /**
1180
1292
  * Auto-generated: rosters.list
1181
1293
  */
package/dist/models/AssetResource.d.ts CHANGED
@@ -44,7 +44,7 @@ export interface AssetResource {
44
44
  * @type {string}
45
45
  * @memberof AssetResource
46
46
  */
47
- altText?: string | null;
47
+ altText: string;
48
48
  /**
49
49
  *
50
50
  * @type {number}
package/dist/models/AssetResource.js CHANGED
@@ -30,6 +30,8 @@ function instanceOfAssetResource(value) {
30
30
  return false;
31
31
  if (!('mimeType' in value) || value['mimeType'] === undefined)
32
32
  return false;
33
+ if (!('altText' in value) || value['altText'] === undefined)
34
+ return false;
33
35
  if (!('index' in value) || value['index'] === undefined)
34
36
  return false;
35
37
  if (!('fileId' in value) || value['fileId'] === undefined)
@@ -48,7 +50,7 @@ function AssetResourceFromJSONTyped(json, ignoreDiscriminator) {
48
50
  'filePath': json['filePath'],
49
51
  'fileName': json['fileName'],
50
52
  'mimeType': json['mimeType'],
51
- 'altText': json['altText'] == null ? undefined : json['altText'],
53
+ 'altText': json['altText'],
52
54
  'index': json['index'],
53
55
  'fileId': json['fileId'],
54
56
  };
package/dist/models/RegisterGroupedByRosterResource.d.ts CHANGED
@@ -52,7 +52,7 @@ export interface RegisterGroupedByRosterResource {
52
52
  * @type {Date}
53
53
  * @memberof RegisterGroupedByRosterResource
54
54
  */
55
- finishDateTime?: Date | null;
55
+ finishDateTime: Date;
56
56
  /**
57
57
  *
58
58
  * @type {Array<RegisterListResource>}
package/dist/models/RegisterGroupedByRosterResource.js CHANGED
@@ -32,6 +32,8 @@ function instanceOfRegisterGroupedByRosterResource(value) {
32
32
  return false;
33
33
  if (!('startDateTime' in value) || value['startDateTime'] === undefined)
34
34
  return false;
35
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
36
+ return false;
35
37
  if (!('registers' in value) || value['registers'] === undefined)
36
38
  return false;
37
39
  return true;
@@ -49,7 +51,7 @@ function RegisterGroupedByRosterResourceFromJSONTyped(json, ignoreDiscriminator)
49
51
  'timezone': json['timezone'],
50
52
  'state': json['state'],
51
53
  'startDateTime': (new Date(json['startDateTime'])),
52
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
54
+ 'finishDateTime': (new Date(json['finishDateTime'])),
53
55
  'registers': (json['registers'] == null ? null : json['registers'].map(RegisterListResource_1.RegisterListResourceFromJSON)),
54
56
  };
55
57
  }
@@ -57,7 +59,6 @@ function RegisterGroupedByRosterResourceToJSON(json) {
57
59
  return RegisterGroupedByRosterResourceToJSONTyped(json, false);
58
60
  }
59
61
  function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator) {
60
- var _a;
61
62
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
62
63
  if (value == null) {
63
64
  return value;
@@ -68,7 +69,7 @@ function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator)
68
69
  'timezone': value['timezone'],
69
70
  'state': value['state'],
70
71
  'startDateTime': ((value['startDateTime']).toISOString()),
71
- 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
72
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
72
73
  'registers': (value['registers'] == null ? null : value['registers'].map(RegisterListResource_1.RegisterListResourceToJSON)),
73
74
  };
74
75
  }
package/dist/models/RegisterListResource.d.ts CHANGED
@@ -64,7 +64,7 @@ export interface RegisterListResource {
64
64
  * @type {string}
65
65
  * @memberof RegisterListResource
66
66
  */
67
- badgeNumber?: string | null;
67
+ badgeNumber: string;
68
68
  /**
69
69
  *
70
70
  * @type {string}
@@ -148,7 +148,7 @@ export interface RegisterListResource {
148
148
  * @type {number}
149
149
  * @memberof RegisterListResource
150
150
  */
151
- signOffLong?: number | null;
151
+ signOffLong: number;
152
152
  /**
153
153
  *
154
154
  * @type {Array<boolean>}
package/dist/models/RegisterListResource.js CHANGED
@@ -36,6 +36,8 @@ function instanceOfRegisterListResource(value) {
36
36
  return false;
37
37
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined)
38
38
  return false;
39
+ if (!('badgeNumber' in value) || value['badgeNumber'] === undefined)
40
+ return false;
39
41
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
40
42
  return false;
41
43
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined)
@@ -60,6 +62,8 @@ function instanceOfRegisterListResource(value) {
60
62
  return false;
61
63
  if (!('signOnLong' in value) || value['signOnLong'] === undefined)
62
64
  return false;
65
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined)
66
+ return false;
63
67
  if (!('incidents' in value) || value['incidents'] === undefined)
64
68
  return false;
65
69
  return true;
@@ -79,7 +83,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
79
83
  'finishDateTime': (new Date(json['finishDateTime'])),
80
84
  'shiftLength': json['shiftLength'],
81
85
  'signOffStatus': json['signOffStatus'],
82
- 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
86
+ 'badgeNumber': json['badgeNumber'],
83
87
  'licenceNumber': json['licenceNumber'],
84
88
  'licenceFirstName': json['licenceFirstName'],
85
89
  'licenceLastName': json['licenceLastName'],
@@ -93,7 +97,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
93
97
  'signOnLat': json['signOnLat'],
94
98
  'signOnLong': json['signOnLong'],
95
99
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
96
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
100
+ 'signOffLong': json['signOffLong'],
97
101
  'incidents': json['incidents'],
98
102
  };
99
103
  }
package/dist/models/RegisterResource.d.ts CHANGED
@@ -112,7 +112,7 @@ export interface RegisterResource {
112
112
  * @type {number}
113
113
  * @memberof RegisterResource
114
114
  */
115
- signOffLong: number;
115
+ signOffLong?: number | null;
116
116
  /**
117
117
  *
118
118
  * @type {string}
package/dist/models/RegisterResource.js CHANGED
@@ -50,8 +50,6 @@ function instanceOfRegisterResource(value) {
50
50
  return false;
51
51
  if (!('signOnLong' in value) || value['signOnLong'] === undefined)
52
52
  return false;
53
- if (!('signOffLong' in value) || value['signOffLong'] === undefined)
54
- return false;
55
53
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
56
54
  return false;
57
55
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined)
@@ -85,7 +83,7 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
85
83
  'signOnLat': json['signOnLat'],
86
84
  'signOnLong': json['signOnLong'],
87
85
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
88
- 'signOffLong': json['signOffLong'],
86
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
89
87
  'licenceNumber': json['licenceNumber'],
90
88
  'licenceExpiry': json['licenceExpiry'],
91
89
  'licenceFirstName': json['licenceFirstName'],
package/dist/models/RosterListResource.d.ts CHANGED
@@ -46,7 +46,7 @@ export interface RosterListResource {
46
46
  * @type {Date}
47
47
  * @memberof RosterListResource
48
48
  */
49
- finishDateTime: Date;
49
+ finishDateTime?: Date | null;
50
50
  /**
51
51
  *
52
52
  * @type {boolean}
package/dist/models/RosterListResource.js CHANGED
@@ -30,8 +30,6 @@ function instanceOfRosterListResource(value) {
30
30
  return false;
31
31
  if (!('startDateTime' in value) || value['startDateTime'] === undefined)
32
32
  return false;
33
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
34
- return false;
35
33
  if (!('isCompliant' in value) || value['isCompliant'] === undefined)
36
34
  return false;
37
35
  if (!('isComplete' in value) || value['isComplete'] === undefined)
@@ -54,7 +52,7 @@ function RosterListResourceFromJSONTyped(json, ignoreDiscriminator) {
54
52
  'venue': (0, VenueLiteResource_1.VenueLiteResourceFromJSON)(json['venue']),
55
53
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceFromJSON)(json['securityCompany']),
56
54
  'startDateTime': (new Date(json['startDateTime'])),
57
- 'finishDateTime': (new Date(json['finishDateTime'])),
55
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
58
56
  'isCompliant': json['isCompliant'],
59
57
  'isComplete': json['isComplete'],
60
58
  'signOffStatus': json['signOffStatus'],
@@ -65,6 +63,7 @@ function RosterListResourceToJSON(json) {
65
63
  return RosterListResourceToJSONTyped(json, false);
66
64
  }
67
65
  function RosterListResourceToJSONTyped(value, ignoreDiscriminator) {
66
+ var _a;
68
67
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
69
68
  if (value == null) {
70
69
  return value;
@@ -74,7 +73,7 @@ function RosterListResourceToJSONTyped(value, ignoreDiscriminator) {
74
73
  'venue': (0, VenueLiteResource_1.VenueLiteResourceToJSON)(value['venue']),
75
74
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceToJSON)(value['securityCompany']),
76
75
  'startDateTime': ((value['startDateTime']).toISOString()),
77
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
76
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
78
77
  'isCompliant': value['isCompliant'],
79
78
  'isComplete': value['isComplete'],
80
79
  'signOffStatus': value['signOffStatus'],
package/dist/models/RosterWithRegistersResource.d.ts CHANGED
@@ -53,7 +53,7 @@ export interface RosterWithRegistersResource {
53
53
  * @type {Date}
54
54
  * @memberof RosterWithRegistersResource
55
55
  */
56
- finishDateTime?: Date | null;
56
+ finishDateTime: Date;
57
57
  /**
58
58
  *
59
59
  * @type {boolean}
package/dist/models/RosterWithRegistersResource.js CHANGED
@@ -33,6 +33,8 @@ function instanceOfRosterWithRegistersResource(value) {
33
33
  return false;
34
34
  if (!('startDateTime' in value) || value['startDateTime'] === undefined)
35
35
  return false;
36
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
37
+ return false;
36
38
  if (!('isCompliant' in value) || value['isCompliant'] === undefined)
37
39
  return false;
38
40
  if (!('isComplete' in value) || value['isComplete'] === undefined)
@@ -56,7 +58,7 @@ function RosterWithRegistersResourceFromJSONTyped(json, ignoreDiscriminator) {
56
58
  'state': json['state'],
57
59
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceFromJSON)(json['securityCompany']),
58
60
  'startDateTime': (new Date(json['startDateTime'])),
59
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
61
+ 'finishDateTime': (new Date(json['finishDateTime'])),
60
62
  'isCompliant': json['isCompliant'],
61
63
  'isComplete': json['isComplete'],
62
64
  'signOffStatus': json['signOffStatus'],
@@ -67,7 +69,6 @@ function RosterWithRegistersResourceToJSON(json) {
67
69
  return RosterWithRegistersResourceToJSONTyped(json, false);
68
70
  }
69
71
  function RosterWithRegistersResourceToJSONTyped(value, ignoreDiscriminator) {
70
- var _a;
71
72
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
72
73
  if (value == null) {
73
74
  return value;
@@ -78,7 +79,7 @@ function RosterWithRegistersResourceToJSONTyped(value, ignoreDiscriminator) {
78
79
  'state': value['state'],
79
80
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceToJSON)(value['securityCompany']),
80
81
  'startDateTime': ((value['startDateTime']).toISOString()),
81
- 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
82
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
82
83
  'isCompliant': value['isCompliant'],
83
84
  'isComplete': value['isComplete'],
84
85
  'signOffStatus': value['signOffStatus'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/security-registers-backend-ts-sdk",
3
- "version": "0.0.172",
3
+ "version": "0.0.173",
4
4
  "description": "OpenAPI client for @digital8/security-registers-backend-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
package/src/apis/GeneralApi.ts CHANGED
@@ -269,6 +269,14 @@ export interface RostersExportPdfOperationRequest {
269
269
  rostersExportPdfRequest?: RostersExportPdfRequest;
270
270
  }
271
271
 
272
+ export interface RostersExportPdfDownloadRequest {
273
+ pdfExport: number;
274
+ }
275
+
276
+ export interface RostersExportPdfStatusRequest {
277
+ pdfExport: number;
278
+ }
279
+
272
280
  export interface RostersListOperationRequest {
273
281
  rostersListRequest?: RostersListRequest;
274
282
  }
@@ -1239,6 +1247,96 @@ export class GeneralApi extends runtime.BaseAPI {
1239
1247
  return await response.value();
1240
1248
  }
1241
1249
 
1250
+ /**
1251
+ * Auto-generated: rosters.exportPdf.download
1252
+ */
1253
+ async rostersExportPdfDownloadRaw(requestParameters: RostersExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
1254
+ if (requestParameters['pdfExport'] == null) {
1255
+ throw new runtime.RequiredError(
1256
+ 'pdfExport',
1257
+ 'Required parameter "pdfExport" was null or undefined when calling rostersExportPdfDownload().'
1258
+ );
1259
+ }
1260
+
1261
+ const queryParameters: any = {};
1262
+
1263
+ const headerParameters: runtime.HTTPHeaders = {};
1264
+
1265
+ if (this.configuration && this.configuration.accessToken) {
1266
+ const token = this.configuration.accessToken;
1267
+ const tokenString = await token("bearerAuth", []);
1268
+
1269
+ if (tokenString) {
1270
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1271
+ }
1272
+ }
1273
+
1274
+ let urlPath = `/api/rosters/export-pdf/{pdfExport}/download`;
1275
+ urlPath = urlPath.replace(`{${"pdfExport"}}`, encodeURIComponent(String(requestParameters['pdfExport'])));
1276
+
1277
+ const response = await this.request({
1278
+ path: urlPath,
1279
+ method: 'GET',
1280
+ headers: headerParameters,
1281
+ query: queryParameters,
1282
+ }, initOverrides);
1283
+
1284
+ return new runtime.BlobApiResponse(response);
1285
+ }
1286
+
1287
+ /**
1288
+ * Auto-generated: rosters.exportPdf.download
1289
+ */
1290
+ async rostersExportPdfDownload(requestParameters: RostersExportPdfDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
1291
+ const response = await this.rostersExportPdfDownloadRaw(requestParameters, initOverrides);
1292
+ return await response.value();
1293
+ }
1294
+
1295
+ /**
1296
+ * Auto-generated: rosters.exportPdf.status
1297
+ */
1298
+ async rostersExportPdfStatusRaw(requestParameters: RostersExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
1299
+ if (requestParameters['pdfExport'] == null) {
1300
+ throw new runtime.RequiredError(
1301
+ 'pdfExport',
1302
+ 'Required parameter "pdfExport" was null or undefined when calling rostersExportPdfStatus().'
1303
+ );
1304
+ }
1305
+
1306
+ const queryParameters: any = {};
1307
+
1308
+ const headerParameters: runtime.HTTPHeaders = {};
1309
+
1310
+ if (this.configuration && this.configuration.accessToken) {
1311
+ const token = this.configuration.accessToken;
1312
+ const tokenString = await token("bearerAuth", []);
1313
+
1314
+ if (tokenString) {
1315
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1316
+ }
1317
+ }
1318
+
1319
+ let urlPath = `/api/rosters/export-pdf/{pdfExport}/status`;
1320
+ urlPath = urlPath.replace(`{${"pdfExport"}}`, encodeURIComponent(String(requestParameters['pdfExport'])));
1321
+
1322
+ const response = await this.request({
1323
+ path: urlPath,
1324
+ method: 'POST',
1325
+ headers: headerParameters,
1326
+ query: queryParameters,
1327
+ }, initOverrides);
1328
+
1329
+ return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
1330
+ }
1331
+
1332
+ /**
1333
+ * Auto-generated: rosters.exportPdf.status
1334
+ */
1335
+ async rostersExportPdfStatus(requestParameters: RostersExportPdfStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
1336
+ const response = await this.rostersExportPdfStatusRaw(requestParameters, initOverrides);
1337
+ return await response.value();
1338
+ }
1339
+
1242
1340
  /**
1243
1341
  * Auto-generated: rosters.list
1244
1342
  */
package/src/models/AssetResource.ts CHANGED
@@ -48,7 +48,7 @@ export interface AssetResource {
48
48
  * @type {string}
49
49
  * @memberof AssetResource
50
50
  */
51
- altText?: string | null;
51
+ altText: string;
52
52
  /**
53
53
  *
54
54
  * @type {number}
@@ -71,6 +71,7 @@ export function instanceOfAssetResource(value: object): value is AssetResource {
71
71
  if (!('filePath' in value) || value['filePath'] === undefined) return false;
72
72
  if (!('fileName' in value) || value['fileName'] === undefined) return false;
73
73
  if (!('mimeType' in value) || value['mimeType'] === undefined) return false;
74
+ if (!('altText' in value) || value['altText'] === undefined) return false;
74
75
  if (!('index' in value) || value['index'] === undefined) return false;
75
76
  if (!('fileId' in value) || value['fileId'] === undefined) return false;
76
77
  return true;
@@ -90,7 +91,7 @@ export function AssetResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
90
91
  'filePath': json['filePath'],
91
92
  'fileName': json['fileName'],
92
93
  'mimeType': json['mimeType'],
93
- 'altText': json['altText'] == null ? undefined : json['altText'],
94
+ 'altText': json['altText'],
94
95
  'index': json['index'],
95
96
  'fileId': json['fileId'],
96
97
  };
package/src/models/RegisterGroupedByRosterResource.ts CHANGED
@@ -69,7 +69,7 @@ export interface RegisterGroupedByRosterResource {
69
69
  * @type {Date}
70
70
  * @memberof RegisterGroupedByRosterResource
71
71
  */
72
- finishDateTime?: Date | null;
72
+ finishDateTime: Date;
73
73
  /**
74
74
  *
75
75
  * @type {Array<RegisterListResource>}
@@ -86,6 +86,7 @@ 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;
89
90
  if (!('registers' in value) || value['registers'] === undefined) return false;
90
91
  return true;
91
92
  }
@@ -105,7 +106,7 @@ export function RegisterGroupedByRosterResourceFromJSONTyped(json: any, ignoreDi
105
106
  'timezone': json['timezone'],
106
107
  'state': json['state'],
107
108
  'startDateTime': (new Date(json['startDateTime'])),
108
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
109
+ 'finishDateTime': (new Date(json['finishDateTime'])),
109
110
  'registers': (json['registers'] == null ? null : (json['registers'] as Array<any>).map(RegisterListResourceFromJSON)),
110
111
  };
111
112
  }
@@ -126,7 +127,7 @@ export function RegisterGroupedByRosterResourceToJSONTyped(value?: RegisterGroup
126
127
  'timezone': value['timezone'],
127
128
  'state': value['state'],
128
129
  'startDateTime': ((value['startDateTime']).toISOString()),
129
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
130
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
130
131
  'registers': (value['registers'] == null ? null : (value['registers'] as Array<any>).map(RegisterListResourceToJSON)),
131
132
  };
132
133
  }
package/src/models/RegisterListResource.ts CHANGED
@@ -81,7 +81,7 @@ export interface RegisterListResource {
81
81
  * @type {string}
82
82
  * @memberof RegisterListResource
83
83
  */
84
- badgeNumber?: string | null;
84
+ badgeNumber: string;
85
85
  /**
86
86
  *
87
87
  * @type {string}
@@ -165,7 +165,7 @@ export interface RegisterListResource {
165
165
  * @type {number}
166
166
  * @memberof RegisterListResource
167
167
  */
168
- signOffLong?: number | null;
168
+ signOffLong: number;
169
169
  /**
170
170
  *
171
171
  * @type {Array<boolean>}
@@ -184,6 +184,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
184
184
  if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
185
185
  if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
186
186
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
187
+ if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
187
188
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
188
189
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
189
190
  if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
@@ -196,6 +197,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
196
197
  if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
197
198
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
198
199
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
200
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
199
201
  if (!('incidents' in value) || value['incidents'] === undefined) return false;
200
202
  return true;
201
203
  }
@@ -217,7 +219,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
217
219
  'finishDateTime': (new Date(json['finishDateTime'])),
218
220
  'shiftLength': json['shiftLength'],
219
221
  'signOffStatus': json['signOffStatus'],
220
- 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
222
+ 'badgeNumber': json['badgeNumber'],
221
223
  'licenceNumber': json['licenceNumber'],
222
224
  'licenceFirstName': json['licenceFirstName'],
223
225
  'licenceLastName': json['licenceLastName'],
@@ -231,7 +233,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
231
233
  'signOnLat': json['signOnLat'],
232
234
  'signOnLong': json['signOnLong'],
233
235
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
234
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
236
+ 'signOffLong': json['signOffLong'],
235
237
  'incidents': json['incidents'],
236
238
  };
237
239
  }
package/src/models/RegisterResource.ts CHANGED
@@ -129,7 +129,7 @@ export interface RegisterResource {
129
129
  * @type {number}
130
130
  * @memberof RegisterResource
131
131
  */
132
- signOffLong: number;
132
+ signOffLong?: number | null;
133
133
  /**
134
134
  *
135
135
  * @type {string}
@@ -191,7 +191,6 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
191
191
  if (!('firstAidImage' in value) || value['firstAidImage'] === undefined) return false;
192
192
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
193
193
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
194
- if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
195
194
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
196
195
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
197
196
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -224,7 +223,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
224
223
  'signOnLat': json['signOnLat'],
225
224
  'signOnLong': json['signOnLong'],
226
225
  'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
227
- 'signOffLong': json['signOffLong'],
226
+ 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
228
227
  'licenceNumber': json['licenceNumber'],
229
228
  'licenceExpiry': json['licenceExpiry'],
230
229
  'licenceFirstName': json['licenceFirstName'],
package/src/models/RosterListResource.ts CHANGED
@@ -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'],
package/src/models/RosterWithRegistersResource.ts CHANGED
@@ -76,7 +76,7 @@ export interface RosterWithRegistersResource {
76
76
  * @type {Date}
77
77
  * @memberof RosterWithRegistersResource
78
78
  */
79
- finishDateTime?: Date | null;
79
+ finishDateTime: Date;
80
80
  /**
81
81
  *
82
82
  * @type {boolean}
@@ -111,6 +111,7 @@ 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;
114
115
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
115
116
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
116
117
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -133,7 +134,7 @@ export function RosterWithRegistersResourceFromJSONTyped(json: any, ignoreDiscri
133
134
  'state': json['state'],
134
135
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
135
136
  'startDateTime': (new Date(json['startDateTime'])),
136
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
137
+ 'finishDateTime': (new Date(json['finishDateTime'])),
137
138
  'isCompliant': json['isCompliant'],
138
139
  'isComplete': json['isComplete'],
139
140
  'signOffStatus': json['signOffStatus'],
@@ -157,7 +158,7 @@ export function RosterWithRegistersResourceToJSONTyped(value?: RosterWithRegiste
157
158
  'state': value['state'],
158
159
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
159
160
  'startDateTime': ((value['startDateTime']).toISOString()),
160
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
161
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
161
162
  'isCompliant': value['isCompliant'],
162
163
  'isComplete': value['isComplete'],
163
164
  'signOffStatus': value['signOffStatus'],