@digital8/security-registers-backend-ts-sdk 0.0.240 → 0.0.242

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 (32) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/GeneralApi.d.ts +11 -0
  3. package/dist/apis/GeneralApi.js +56 -0
  4. package/dist/models/AddressResource.d.ts +1 -1
  5. package/dist/models/AddressResource.js +3 -1
  6. package/dist/models/AssetResource.d.ts +1 -1
  7. package/dist/models/AssetResource.js +3 -1
  8. package/dist/models/RegisterGroupedByRosterResource.d.ts +1 -1
  9. package/dist/models/RegisterGroupedByRosterResource.js +3 -4
  10. package/dist/models/RegisterListResource.d.ts +2 -2
  11. package/dist/models/RegisterListResource.js +4 -4
  12. package/dist/models/RegisterResource.d.ts +1 -1
  13. package/dist/models/RegisterResource.js +3 -1
  14. package/dist/models/RosterListResource.d.ts +1 -1
  15. package/dist/models/RosterListResource.js +4 -3
  16. package/dist/models/RosterLiteResource.d.ts +1 -1
  17. package/dist/models/RosterLiteResource.js +3 -4
  18. package/dist/models/SecurityCompanyResource.d.ts +1 -1
  19. package/dist/models/SecurityCompanyResource.js +3 -1
  20. package/dist/models/VenueResource.d.ts +6 -0
  21. package/dist/models/VenueResource.js +4 -0
  22. package/package.json +1 -1
  23. package/src/apis/GeneralApi.ts +49 -0
  24. package/src/models/AddressResource.ts +3 -2
  25. package/src/models/AssetResource.ts +3 -2
  26. package/src/models/RegisterGroupedByRosterResource.ts +3 -4
  27. package/src/models/RegisterListResource.ts +5 -5
  28. package/src/models/RegisterResource.ts +3 -2
  29. package/src/models/RosterListResource.ts +4 -3
  30. package/src/models/RosterLiteResource.ts +3 -4
  31. package/src/models/SecurityCompanyResource.ts +3 -2
  32. package/src/models/VenueResource.ts +9 -0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @digital8/security-registers-backend-ts-sdk@0.0.240
1
+ ## @digital8/security-registers-backend-ts-sdk@0.0.242
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.240 --save
39
+ npm install @digital8/security-registers-backend-ts-sdk@0.0.242 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -216,6 +216,9 @@ export interface VenuesNearbyOperationRequest {
216
216
  export interface VenuesPublicStoreOperationRequest {
217
217
  venuesPublicStoreRequest?: VenuesPublicStoreRequest;
218
218
  }
219
+ export interface VenuesRotateKeyRequest {
220
+ venue: number;
221
+ }
219
222
  export interface VenuesShowRequest {
220
223
  venue: number;
221
224
  }
@@ -766,6 +769,14 @@ export declare class GeneralApi extends runtime.BaseAPI {
766
769
  * Auto-generated: venues.public.store
767
770
  */
768
771
  venuesPublicStore(requestParameters?: VenuesPublicStoreOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource>;
772
+ /**
773
+ * Auto-generated: venues.rotateKey
774
+ */
775
+ venuesRotateKeyRaw(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VenueResource>>;
776
+ /**
777
+ * Auto-generated: venues.rotateKey
778
+ */
779
+ venuesRotateKey(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource>;
769
780
  /**
770
781
  * Auto-generated: venues.show
771
782
  */
@@ -3813,6 +3813,62 @@ var GeneralApi = /** @class */ (function (_super) {
3813
3813
  });
3814
3814
  });
3815
3815
  };
3816
+ /**
3817
+ * Auto-generated: venues.rotateKey
3818
+ */
3819
+ GeneralApi.prototype.venuesRotateKeyRaw = function (requestParameters, initOverrides) {
3820
+ return __awaiter(this, void 0, void 0, function () {
3821
+ var queryParameters, headerParameters, token, tokenString, urlPath, response;
3822
+ return __generator(this, function (_a) {
3823
+ switch (_a.label) {
3824
+ case 0:
3825
+ if (requestParameters['venue'] == null) {
3826
+ throw new runtime.RequiredError('venue', 'Required parameter "venue" was null or undefined when calling venuesRotateKey().');
3827
+ }
3828
+ queryParameters = {};
3829
+ headerParameters = {};
3830
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3831
+ token = this.configuration.accessToken;
3832
+ return [4 /*yield*/, token("bearerAuth", [])];
3833
+ case 1:
3834
+ tokenString = _a.sent();
3835
+ if (tokenString) {
3836
+ headerParameters["Authorization"] = "Bearer ".concat(tokenString);
3837
+ }
3838
+ _a.label = 2;
3839
+ case 2:
3840
+ urlPath = "/api/venues/{venue}/rotate-key";
3841
+ urlPath = urlPath.replace("{".concat("venue", "}"), encodeURIComponent(String(requestParameters['venue'])));
3842
+ return [4 /*yield*/, this.request({
3843
+ path: urlPath,
3844
+ method: 'POST',
3845
+ headers: headerParameters,
3846
+ query: queryParameters,
3847
+ }, initOverrides)];
3848
+ case 3:
3849
+ response = _a.sent();
3850
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.VenueResourceFromJSON)(jsonValue); })];
3851
+ }
3852
+ });
3853
+ });
3854
+ };
3855
+ /**
3856
+ * Auto-generated: venues.rotateKey
3857
+ */
3858
+ GeneralApi.prototype.venuesRotateKey = function (requestParameters, initOverrides) {
3859
+ return __awaiter(this, void 0, void 0, function () {
3860
+ var response;
3861
+ return __generator(this, function (_a) {
3862
+ switch (_a.label) {
3863
+ case 0: return [4 /*yield*/, this.venuesRotateKeyRaw(requestParameters, initOverrides)];
3864
+ case 1:
3865
+ response = _a.sent();
3866
+ return [4 /*yield*/, response.value()];
3867
+ case 2: return [2 /*return*/, _a.sent()];
3868
+ }
3869
+ });
3870
+ });
3871
+ };
3816
3872
  /**
3817
3873
  * Auto-generated: venues.show
3818
3874
  */
@@ -32,7 +32,7 @@ export interface AddressResource {
32
32
  * @type {string}
33
33
  * @memberof AddressResource
34
34
  */
35
- addressLine2?: string | null;
35
+ addressLine2: string;
36
36
  /**
37
37
  *
38
38
  * @type {string}
@@ -24,6 +24,8 @@ exports.AddressResourceToJSONTyped = AddressResourceToJSONTyped;
24
24
  function instanceOfAddressResource(value) {
25
25
  if (!('addressLine1' in value) || value['addressLine1'] === undefined)
26
26
  return false;
27
+ if (!('addressLine2' in value) || value['addressLine2'] === undefined)
28
+ return false;
27
29
  if (!('suburb' in value) || value['suburb'] === undefined)
28
30
  return false;
29
31
  if (!('city' in value) || value['city'] === undefined)
@@ -48,7 +50,7 @@ function AddressResourceFromJSONTyped(json, ignoreDiscriminator) {
48
50
  return {
49
51
  'id': json['id'] == null ? undefined : json['id'],
50
52
  'addressLine1': json['addressLine1'],
51
- 'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
53
+ 'addressLine2': json['addressLine2'],
52
54
  'suburb': json['suburb'],
53
55
  'city': json['city'],
54
56
  'state': json['state'],
@@ -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}
@@ -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
  };
@@ -52,7 +52,7 @@ export interface RegisterGroupedByRosterResource {
52
52
  * @type {Date}
53
53
  * @memberof RegisterGroupedByRosterResource
54
54
  */
55
- finishDateTime: Date;
55
+ finishDateTime?: Date | null;
56
56
  /**
57
57
  *
58
58
  * @type {Array<RegisterListResource>}
@@ -32,8 +32,6 @@ 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;
37
35
  if (!('registers' in value) || value['registers'] === undefined)
38
36
  return false;
39
37
  return true;
@@ -51,7 +49,7 @@ function RegisterGroupedByRosterResourceFromJSONTyped(json, ignoreDiscriminator)
51
49
  'timezone': json['timezone'],
52
50
  'state': json['state'],
53
51
  'startDateTime': (new Date(json['startDateTime'])),
54
- 'finishDateTime': (new Date(json['finishDateTime'])),
52
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
55
53
  'registers': (json['registers'] == null ? null : json['registers'].map(RegisterListResource_1.RegisterListResourceFromJSON)),
56
54
  };
57
55
  }
@@ -59,6 +57,7 @@ function RegisterGroupedByRosterResourceToJSON(json) {
59
57
  return RegisterGroupedByRosterResourceToJSONTyped(json, false);
60
58
  }
61
59
  function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator) {
60
+ var _a;
62
61
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
63
62
  if (value == null) {
64
63
  return value;
@@ -69,7 +68,7 @@ function RegisterGroupedByRosterResourceToJSONTyped(value, ignoreDiscriminator)
69
68
  'timezone': value['timezone'],
70
69
  'state': value['state'],
71
70
  'startDateTime': ((value['startDateTime']).toISOString()),
72
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
71
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
73
72
  'registers': (value['registers'] == null ? null : value['registers'].map(RegisterListResource_1.RegisterListResourceToJSON)),
74
73
  };
75
74
  }
@@ -65,7 +65,7 @@ export interface RegisterListResource {
65
65
  * @type {string}
66
66
  * @memberof RegisterListResource
67
67
  */
68
- badgeNumber: string;
68
+ badgeNumber?: string | null;
69
69
  /**
70
70
  *
71
71
  * @type {string}
@@ -143,7 +143,7 @@ export interface RegisterListResource {
143
143
  * @type {number}
144
144
  * @memberof RegisterListResource
145
145
  */
146
- signOffLat?: number | null;
146
+ signOffLat: number;
147
147
  /**
148
148
  *
149
149
  * @type {number}
@@ -37,8 +37,6 @@ function instanceOfRegisterListResource(value) {
37
37
  return false;
38
38
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined)
39
39
  return false;
40
- if (!('badgeNumber' in value) || value['badgeNumber'] === undefined)
41
- return false;
42
40
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
43
41
  return false;
44
42
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined)
@@ -63,6 +61,8 @@ function instanceOfRegisterListResource(value) {
63
61
  return false;
64
62
  if (!('signOnLong' in value) || value['signOnLong'] === undefined)
65
63
  return false;
64
+ if (!('signOffLat' in value) || value['signOffLat'] === undefined)
65
+ return false;
66
66
  if (!('signOffLong' in value) || value['signOffLong'] === undefined)
67
67
  return false;
68
68
  if (!('incidents' in value) || value['incidents'] === undefined)
@@ -84,7 +84,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
84
84
  'finishDateTime': (new Date(json['finishDateTime'])),
85
85
  'shiftLength': json['shiftLength'],
86
86
  'signOffStatus': json['signOffStatus'],
87
- 'badgeNumber': json['badgeNumber'],
87
+ 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
88
88
  'licenceNumber': json['licenceNumber'],
89
89
  'licenceFirstName': json['licenceFirstName'],
90
90
  'licenceLastName': json['licenceLastName'],
@@ -97,7 +97,7 @@ function RegisterListResourceFromJSONTyped(json, ignoreDiscriminator) {
97
97
  'firstAid': json['firstAid'],
98
98
  'signOnLat': json['signOnLat'],
99
99
  'signOnLong': json['signOnLong'],
100
- 'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
100
+ 'signOffLat': json['signOffLat'],
101
101
  'signOffLong': json['signOffLong'],
102
102
  'incidents': (json['incidents'] == null ? null : json['incidents'].map(IncidentLiteResource_1.IncidentLiteResourceFromJSON)),
103
103
  };
@@ -112,7 +112,7 @@ export interface RegisterResource {
112
112
  * @type {number}
113
113
  * @memberof RegisterResource
114
114
  */
115
- signOffLong?: number | null;
115
+ signOffLong: number;
116
116
  /**
117
117
  *
118
118
  * @type {string}
@@ -52,6 +52,8 @@ function instanceOfRegisterResource(value) {
52
52
  return false;
53
53
  if (!('signOffLat' in value) || value['signOffLat'] === undefined)
54
54
  return false;
55
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined)
56
+ return false;
55
57
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined)
56
58
  return false;
57
59
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined)
@@ -85,7 +87,7 @@ function RegisterResourceFromJSONTyped(json, ignoreDiscriminator) {
85
87
  'signOnLat': json['signOnLat'],
86
88
  'signOnLong': json['signOnLong'],
87
89
  'signOffLat': json['signOffLat'],
88
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
90
+ 'signOffLong': json['signOffLong'],
89
91
  'licenceNumber': json['licenceNumber'],
90
92
  'licenceExpiry': json['licenceExpiry'],
91
93
  'licenceFirstName': json['licenceFirstName'],
@@ -46,7 +46,7 @@ export interface RosterListResource {
46
46
  * @type {Date}
47
47
  * @memberof RosterListResource
48
48
  */
49
- finishDateTime?: Date | null;
49
+ finishDateTime: Date;
50
50
  /**
51
51
  *
52
52
  * @type {boolean}
@@ -30,6 +30,8 @@ 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;
33
35
  if (!('isCompliant' in value) || value['isCompliant'] === undefined)
34
36
  return false;
35
37
  if (!('isComplete' in value) || value['isComplete'] === undefined)
@@ -52,7 +54,7 @@ function RosterListResourceFromJSONTyped(json, ignoreDiscriminator) {
52
54
  'venue': (0, VenueLiteResource_1.VenueLiteResourceFromJSON)(json['venue']),
53
55
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceFromJSON)(json['securityCompany']),
54
56
  'startDateTime': (new Date(json['startDateTime'])),
55
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
57
+ 'finishDateTime': (new Date(json['finishDateTime'])),
56
58
  'isCompliant': json['isCompliant'],
57
59
  'isComplete': json['isComplete'],
58
60
  'signOffStatus': json['signOffStatus'],
@@ -63,7 +65,6 @@ function RosterListResourceToJSON(json) {
63
65
  return RosterListResourceToJSONTyped(json, false);
64
66
  }
65
67
  function RosterListResourceToJSONTyped(value, ignoreDiscriminator) {
66
- var _a;
67
68
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
68
69
  if (value == null) {
69
70
  return value;
@@ -73,7 +74,7 @@ function RosterListResourceToJSONTyped(value, ignoreDiscriminator) {
73
74
  'venue': (0, VenueLiteResource_1.VenueLiteResourceToJSON)(value['venue']),
74
75
  'securityCompany': (0, SecurityCompanyLiteResource_1.SecurityCompanyLiteResourceToJSON)(value['securityCompany']),
75
76
  'startDateTime': ((value['startDateTime']).toISOString()),
76
- 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
77
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
77
78
  'isCompliant': value['isCompliant'],
78
79
  'isComplete': value['isComplete'],
79
80
  'signOffStatus': value['signOffStatus'],
@@ -32,7 +32,7 @@ export interface RosterLiteResource {
32
32
  * @type {Date}
33
33
  * @memberof RosterLiteResource
34
34
  */
35
- finishDateTime: Date;
35
+ finishDateTime?: Date | null;
36
36
  }
37
37
  /**
38
38
  * Check if a given object implements the RosterLiteResource interface.
@@ -24,8 +24,6 @@ exports.RosterLiteResourceToJSONTyped = RosterLiteResourceToJSONTyped;
24
24
  function instanceOfRosterLiteResource(value) {
25
25
  if (!('startDateTime' in value) || value['startDateTime'] === undefined)
26
26
  return false;
27
- if (!('finishDateTime' in value) || value['finishDateTime'] === undefined)
28
- return false;
29
27
  return true;
30
28
  }
31
29
  function RosterLiteResourceFromJSON(json) {
@@ -38,13 +36,14 @@ function RosterLiteResourceFromJSONTyped(json, ignoreDiscriminator) {
38
36
  return {
39
37
  'id': json['id'] == null ? undefined : json['id'],
40
38
  'startDateTime': (new Date(json['startDateTime'])),
41
- 'finishDateTime': (new Date(json['finishDateTime'])),
39
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
42
40
  };
43
41
  }
44
42
  function RosterLiteResourceToJSON(json) {
45
43
  return RosterLiteResourceToJSONTyped(json, false);
46
44
  }
47
45
  function RosterLiteResourceToJSONTyped(value, ignoreDiscriminator) {
46
+ var _a;
48
47
  if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
49
48
  if (value == null) {
50
49
  return value;
@@ -52,6 +51,6 @@ function RosterLiteResourceToJSONTyped(value, ignoreDiscriminator) {
52
51
  return {
53
52
  'id': value['id'],
54
53
  'startDateTime': ((value['startDateTime']).toISOString()),
55
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
54
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((_a = value['finishDateTime']) === null || _a === void 0 ? void 0 : _a.toISOString()),
56
55
  };
57
56
  }
@@ -33,7 +33,7 @@ export interface SecurityCompanyResource {
33
33
  * @type {string}
34
34
  * @memberof SecurityCompanyResource
35
35
  */
36
- email?: string | null;
36
+ email: string;
37
37
  /**
38
38
  *
39
39
  * @type {boolean}
@@ -25,6 +25,8 @@ var AddressResource_1 = require("./AddressResource");
25
25
  function instanceOfSecurityCompanyResource(value) {
26
26
  if (!('name' in value) || value['name'] === undefined)
27
27
  return false;
28
+ if (!('email' in value) || value['email'] === undefined)
29
+ return false;
28
30
  if (!('isEnabled' in value) || value['isEnabled'] === undefined)
29
31
  return false;
30
32
  if (!('address' in value) || value['address'] === undefined)
@@ -43,7 +45,7 @@ function SecurityCompanyResourceFromJSONTyped(json, ignoreDiscriminator) {
43
45
  return {
44
46
  'id': json['id'] == null ? undefined : json['id'],
45
47
  'name': json['name'],
46
- 'email': json['email'] == null ? undefined : json['email'],
48
+ 'email': json['email'],
47
49
  'isEnabled': json['isEnabled'],
48
50
  'address': (0, AddressResource_1.AddressResourceFromJSON)(json['address']),
49
51
  'licenceNumber': json['licenceNumber'],
@@ -36,6 +36,12 @@ export interface VenueResource {
36
36
  * @memberof VenueResource
37
37
  */
38
38
  venueCode: string;
39
+ /**
40
+ *
41
+ * @type {string}
42
+ * @memberof VenueResource
43
+ */
44
+ venueApiKey: string;
39
45
  /**
40
46
  *
41
47
  * @type {boolean}
@@ -29,6 +29,8 @@ function instanceOfVenueResource(value) {
29
29
  return false;
30
30
  if (!('venueCode' in value) || value['venueCode'] === undefined)
31
31
  return false;
32
+ if (!('venueApiKey' in value) || value['venueApiKey'] === undefined)
33
+ return false;
32
34
  if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined)
33
35
  return false;
34
36
  if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined)
@@ -62,6 +64,7 @@ function VenueResourceFromJSONTyped(json, ignoreDiscriminator) {
62
64
  'id': json['id'] == null ? undefined : json['id'],
63
65
  'name': json['name'],
64
66
  'venueCode': json['venueCode'],
67
+ 'venueApiKey': json['venueApiKey'],
65
68
  'badgeNumberRequired': json['badgeNumberRequired'],
66
69
  'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
67
70
  'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
@@ -90,6 +93,7 @@ function VenueResourceToJSONTyped(value, ignoreDiscriminator) {
90
93
  'id': value['id'],
91
94
  'name': value['name'],
92
95
  'venueCode': value['venueCode'],
96
+ 'venueApiKey': value['venueApiKey'],
93
97
  'badgeNumberRequired': value['badgeNumberRequired'],
94
98
  'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
95
99
  'primaryManagerId': value['primaryManagerId'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/security-registers-backend-ts-sdk",
3
- "version": "0.0.240",
3
+ "version": "0.0.242",
4
4
  "description": "OpenAPI client for @digital8/security-registers-backend-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -515,6 +515,10 @@ export interface VenuesPublicStoreOperationRequest {
515
515
  venuesPublicStoreRequest?: VenuesPublicStoreRequest;
516
516
  }
517
517
 
518
+ export interface VenuesRotateKeyRequest {
519
+ venue: number;
520
+ }
521
+
518
522
  export interface VenuesShowRequest {
519
523
  venue: number;
520
524
  }
@@ -3409,6 +3413,51 @@ export class GeneralApi extends runtime.BaseAPI {
3409
3413
  return await response.value();
3410
3414
  }
3411
3415
 
3416
+ /**
3417
+ * Auto-generated: venues.rotateKey
3418
+ */
3419
+ async venuesRotateKeyRaw(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VenueResource>> {
3420
+ if (requestParameters['venue'] == null) {
3421
+ throw new runtime.RequiredError(
3422
+ 'venue',
3423
+ 'Required parameter "venue" was null or undefined when calling venuesRotateKey().'
3424
+ );
3425
+ }
3426
+
3427
+ const queryParameters: any = {};
3428
+
3429
+ const headerParameters: runtime.HTTPHeaders = {};
3430
+
3431
+ if (this.configuration && this.configuration.accessToken) {
3432
+ const token = this.configuration.accessToken;
3433
+ const tokenString = await token("bearerAuth", []);
3434
+
3435
+ if (tokenString) {
3436
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
3437
+ }
3438
+ }
3439
+
3440
+ let urlPath = `/api/venues/{venue}/rotate-key`;
3441
+ urlPath = urlPath.replace(`{${"venue"}}`, encodeURIComponent(String(requestParameters['venue'])));
3442
+
3443
+ const response = await this.request({
3444
+ path: urlPath,
3445
+ method: 'POST',
3446
+ headers: headerParameters,
3447
+ query: queryParameters,
3448
+ }, initOverrides);
3449
+
3450
+ return new runtime.JSONApiResponse(response, (jsonValue) => VenueResourceFromJSON(jsonValue));
3451
+ }
3452
+
3453
+ /**
3454
+ * Auto-generated: venues.rotateKey
3455
+ */
3456
+ async venuesRotateKey(requestParameters: VenuesRotateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VenueResource> {
3457
+ const response = await this.venuesRotateKeyRaw(requestParameters, initOverrides);
3458
+ return await response.value();
3459
+ }
3460
+
3412
3461
  /**
3413
3462
  * Auto-generated: venues.show
3414
3463
  */
@@ -36,7 +36,7 @@ export interface AddressResource {
36
36
  * @type {string}
37
37
  * @memberof AddressResource
38
38
  */
39
- addressLine2?: string | null;
39
+ addressLine2: string;
40
40
  /**
41
41
  *
42
42
  * @type {string}
@@ -80,6 +80,7 @@ export interface AddressResource {
80
80
  */
81
81
  export function instanceOfAddressResource(value: object): value is AddressResource {
82
82
  if (!('addressLine1' in value) || value['addressLine1'] === undefined) return false;
83
+ if (!('addressLine2' in value) || value['addressLine2'] === undefined) return false;
83
84
  if (!('suburb' in value) || value['suburb'] === undefined) return false;
84
85
  if (!('city' in value) || value['city'] === undefined) return false;
85
86
  if (!('state' in value) || value['state'] === undefined) return false;
@@ -101,7 +102,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
101
102
 
102
103
  'id': json['id'] == null ? undefined : json['id'],
103
104
  'addressLine1': json['addressLine1'],
104
- 'addressLine2': json['addressLine2'] == null ? undefined : json['addressLine2'],
105
+ 'addressLine2': json['addressLine2'],
105
106
  'suburb': json['suburb'],
106
107
  'city': json['city'],
107
108
  'state': json['state'],
@@ -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
  };
@@ -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
  }
@@ -88,7 +88,7 @@ export interface RegisterListResource {
88
88
  * @type {string}
89
89
  * @memberof RegisterListResource
90
90
  */
91
- badgeNumber: string;
91
+ badgeNumber?: string | null;
92
92
  /**
93
93
  *
94
94
  * @type {string}
@@ -166,7 +166,7 @@ export interface RegisterListResource {
166
166
  * @type {number}
167
167
  * @memberof RegisterListResource
168
168
  */
169
- signOffLat?: number | null;
169
+ signOffLat: number;
170
170
  /**
171
171
  *
172
172
  * @type {number}
@@ -191,7 +191,6 @@ export function instanceOfRegisterListResource(value: object): value is Register
191
191
  if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
192
192
  if (!('shiftLength' in value) || value['shiftLength'] === undefined) return false;
193
193
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
194
- if (!('badgeNumber' in value) || value['badgeNumber'] === undefined) return false;
195
194
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
196
195
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
197
196
  if (!('licenceLastName' in value) || value['licenceLastName'] === undefined) return false;
@@ -204,6 +203,7 @@ export function instanceOfRegisterListResource(value: object): value is Register
204
203
  if (!('firstAid' in value) || value['firstAid'] === undefined) return false;
205
204
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
206
205
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
206
+ if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
207
207
  if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
208
208
  if (!('incidents' in value) || value['incidents'] === undefined) return false;
209
209
  return true;
@@ -226,7 +226,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
226
226
  'finishDateTime': (new Date(json['finishDateTime'])),
227
227
  'shiftLength': json['shiftLength'],
228
228
  'signOffStatus': json['signOffStatus'],
229
- 'badgeNumber': json['badgeNumber'],
229
+ 'badgeNumber': json['badgeNumber'] == null ? undefined : json['badgeNumber'],
230
230
  'licenceNumber': json['licenceNumber'],
231
231
  'licenceFirstName': json['licenceFirstName'],
232
232
  'licenceLastName': json['licenceLastName'],
@@ -239,7 +239,7 @@ export function RegisterListResourceFromJSONTyped(json: any, ignoreDiscriminator
239
239
  'firstAid': json['firstAid'],
240
240
  'signOnLat': json['signOnLat'],
241
241
  'signOnLong': json['signOnLong'],
242
- 'signOffLat': json['signOffLat'] == null ? undefined : json['signOffLat'],
242
+ 'signOffLat': json['signOffLat'],
243
243
  'signOffLong': json['signOffLong'],
244
244
  'incidents': (json['incidents'] == null ? null : (json['incidents'] as Array<any>).map(IncidentLiteResourceFromJSON)),
245
245
  };
@@ -129,7 +129,7 @@ export interface RegisterResource {
129
129
  * @type {number}
130
130
  * @memberof RegisterResource
131
131
  */
132
- signOffLong?: number | null;
132
+ signOffLong: number;
133
133
  /**
134
134
  *
135
135
  * @type {string}
@@ -192,6 +192,7 @@ export function instanceOfRegisterResource(value: object): value is RegisterReso
192
192
  if (!('signOnLat' in value) || value['signOnLat'] === undefined) return false;
193
193
  if (!('signOnLong' in value) || value['signOnLong'] === undefined) return false;
194
194
  if (!('signOffLat' in value) || value['signOffLat'] === undefined) return false;
195
+ if (!('signOffLong' in value) || value['signOffLong'] === undefined) return false;
195
196
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
196
197
  if (!('licenceExpiry' in value) || value['licenceExpiry'] === undefined) return false;
197
198
  if (!('licenceFirstName' in value) || value['licenceFirstName'] === undefined) return false;
@@ -224,7 +225,7 @@ export function RegisterResourceFromJSONTyped(json: any, ignoreDiscriminator: bo
224
225
  'signOnLat': json['signOnLat'],
225
226
  'signOnLong': json['signOnLong'],
226
227
  'signOffLat': json['signOffLat'],
227
- 'signOffLong': json['signOffLong'] == null ? undefined : json['signOffLong'],
228
+ 'signOffLong': json['signOffLong'],
228
229
  'licenceNumber': json['licenceNumber'],
229
230
  'licenceExpiry': json['licenceExpiry'],
230
231
  'licenceFirstName': json['licenceFirstName'],
@@ -63,7 +63,7 @@ export interface RosterListResource {
63
63
  * @type {Date}
64
64
  * @memberof RosterListResource
65
65
  */
66
- finishDateTime?: Date | null;
66
+ finishDateTime: Date;
67
67
  /**
68
68
  *
69
69
  * @type {boolean}
@@ -97,6 +97,7 @@ export function instanceOfRosterListResource(value: object): value is RosterList
97
97
  if (!('venue' in value) || value['venue'] === undefined) return false;
98
98
  if (!('securityCompany' in value) || value['securityCompany'] === undefined) return false;
99
99
  if (!('startDateTime' in value) || value['startDateTime'] === undefined) return false;
100
+ if (!('finishDateTime' in value) || value['finishDateTime'] === undefined) return false;
100
101
  if (!('isCompliant' in value) || value['isCompliant'] === undefined) return false;
101
102
  if (!('isComplete' in value) || value['isComplete'] === undefined) return false;
102
103
  if (!('signOffStatus' in value) || value['signOffStatus'] === undefined) return false;
@@ -118,7 +119,7 @@ export function RosterListResourceFromJSONTyped(json: any, ignoreDiscriminator:
118
119
  'venue': VenueLiteResourceFromJSON(json['venue']),
119
120
  'securityCompany': SecurityCompanyLiteResourceFromJSON(json['securityCompany']),
120
121
  'startDateTime': (new Date(json['startDateTime'])),
121
- 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
122
+ 'finishDateTime': (new Date(json['finishDateTime'])),
122
123
  'isCompliant': json['isCompliant'],
123
124
  'isComplete': json['isComplete'],
124
125
  'signOffStatus': json['signOffStatus'],
@@ -141,7 +142,7 @@ export function RosterListResourceToJSONTyped(value?: RosterListResource | null,
141
142
  'venue': VenueLiteResourceToJSON(value['venue']),
142
143
  'securityCompany': SecurityCompanyLiteResourceToJSON(value['securityCompany']),
143
144
  'startDateTime': ((value['startDateTime']).toISOString()),
144
- 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
145
+ 'finishDateTime': ((value['finishDateTime']).toISOString()),
145
146
  'isCompliant': value['isCompliant'],
146
147
  'isComplete': value['isComplete'],
147
148
  'signOffStatus': value['signOffStatus'],
@@ -36,7 +36,7 @@ export interface RosterLiteResource {
36
36
  * @type {Date}
37
37
  * @memberof RosterLiteResource
38
38
  */
39
- finishDateTime: Date;
39
+ finishDateTime?: Date | null;
40
40
  }
41
41
 
42
42
  /**
@@ -44,7 +44,6 @@ 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;
48
47
  return true;
49
48
  }
50
49
 
@@ -60,7 +59,7 @@ export function RosterLiteResourceFromJSONTyped(json: any, ignoreDiscriminator:
60
59
 
61
60
  'id': json['id'] == null ? undefined : json['id'],
62
61
  'startDateTime': (new Date(json['startDateTime'])),
63
- 'finishDateTime': (new Date(json['finishDateTime'])),
62
+ 'finishDateTime': json['finishDateTime'] == null ? undefined : (new Date(json['finishDateTime'])),
64
63
  };
65
64
  }
66
65
 
@@ -77,7 +76,7 @@ export function RosterLiteResourceToJSONTyped(value?: RosterLiteResource | null,
77
76
 
78
77
  'id': value['id'],
79
78
  'startDateTime': ((value['startDateTime']).toISOString()),
80
- 'finishDateTime': ((value['finishDateTime']).toISOString()),
79
+ 'finishDateTime': value['finishDateTime'] === null ? null : ((value['finishDateTime'] as any)?.toISOString()),
81
80
  };
82
81
  }
83
82
 
@@ -44,7 +44,7 @@ export interface SecurityCompanyResource {
44
44
  * @type {string}
45
45
  * @memberof SecurityCompanyResource
46
46
  */
47
- email?: string | null;
47
+ email: string;
48
48
  /**
49
49
  *
50
50
  * @type {boolean}
@@ -82,6 +82,7 @@ export interface SecurityCompanyResource {
82
82
  */
83
83
  export function instanceOfSecurityCompanyResource(value: object): value is SecurityCompanyResource {
84
84
  if (!('name' in value) || value['name'] === undefined) return false;
85
+ if (!('email' in value) || value['email'] === undefined) return false;
85
86
  if (!('isEnabled' in value) || value['isEnabled'] === undefined) return false;
86
87
  if (!('address' in value) || value['address'] === undefined) return false;
87
88
  if (!('licenceNumber' in value) || value['licenceNumber'] === undefined) return false;
@@ -100,7 +101,7 @@ export function SecurityCompanyResourceFromJSONTyped(json: any, ignoreDiscrimina
100
101
 
101
102
  'id': json['id'] == null ? undefined : json['id'],
102
103
  'name': json['name'],
103
- 'email': json['email'] == null ? undefined : json['email'],
104
+ 'email': json['email'],
104
105
  'isEnabled': json['isEnabled'],
105
106
  'address': AddressResourceFromJSON(json['address']),
106
107
  'licenceNumber': json['licenceNumber'],
@@ -59,6 +59,12 @@ export interface VenueResource {
59
59
  * @memberof VenueResource
60
60
  */
61
61
  venueCode: string;
62
+ /**
63
+ *
64
+ * @type {string}
65
+ * @memberof VenueResource
66
+ */
67
+ venueApiKey: string;
62
68
  /**
63
69
  *
64
70
  * @type {boolean}
@@ -145,6 +151,7 @@ export interface VenueResource {
145
151
  export function instanceOfVenueResource(value: object): value is VenueResource {
146
152
  if (!('name' in value) || value['name'] === undefined) return false;
147
153
  if (!('venueCode' in value) || value['venueCode'] === undefined) return false;
154
+ if (!('venueApiKey' in value) || value['venueApiKey'] === undefined) return false;
148
155
  if (!('badgeNumberRequired' in value) || value['badgeNumberRequired'] === undefined) return false;
149
156
  if (!('venueSignOnCodeRequired' in value) || value['venueSignOnCodeRequired'] === undefined) return false;
150
157
  if (!('primaryManager' in value) || value['primaryManager'] === undefined) return false;
@@ -171,6 +178,7 @@ export function VenueResourceFromJSONTyped(json: any, ignoreDiscriminator: boole
171
178
  'id': json['id'] == null ? undefined : json['id'],
172
179
  'name': json['name'],
173
180
  'venueCode': json['venueCode'],
181
+ 'venueApiKey': json['venueApiKey'],
174
182
  'badgeNumberRequired': json['badgeNumberRequired'],
175
183
  'venueSignOnCodeRequired': json['venueSignOnCodeRequired'],
176
184
  'primaryManagerId': json['primaryManagerId'] == null ? undefined : json['primaryManagerId'],
@@ -201,6 +209,7 @@ export function VenueResourceToJSONTyped(value?: VenueResource | null, ignoreDis
201
209
  'id': value['id'],
202
210
  'name': value['name'],
203
211
  'venueCode': value['venueCode'],
212
+ 'venueApiKey': value['venueApiKey'],
204
213
  'badgeNumberRequired': value['badgeNumberRequired'],
205
214
  'venueSignOnCodeRequired': value['venueSignOnCodeRequired'],
206
215
  'primaryManagerId': value['primaryManagerId'],