@digital8/security-registers-backend-ts-sdk 0.0.144 → 0.0.145

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 (54) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +2 -2
  3. package/dist/apis/GeneralApi.d.ts +23 -1
  4. package/dist/apis/GeneralApi.js +110 -0
  5. package/dist/models/AddressResource.d.ts +1 -1
  6. package/dist/models/AddressResource.js +1 -3
  7. package/dist/models/AssetResource.d.ts +1 -1
  8. package/dist/models/AssetResource.js +3 -1
  9. package/dist/models/IndexUserRequest.d.ts +2 -2
  10. package/dist/models/LicencesListRequest.d.ts +2 -2
  11. package/dist/models/PaginatedRosterWithRegistersResourceResponse.d.ts +40 -0
  12. package/dist/models/PaginatedRosterWithRegistersResourceResponse.js +57 -0
  13. package/dist/models/RegisterListResource.d.ts +97 -1
  14. package/dist/models/RegisterListResource.js +63 -3
  15. package/dist/models/RegisterResource.d.ts +2 -2
  16. package/dist/models/RegisterResource.js +8 -8
  17. package/dist/models/RegistersListRequest.d.ts +2 -2
  18. package/dist/models/RosterLiteResource.d.ts +1 -1
  19. package/dist/models/RosterLiteResource.js +4 -3
  20. package/dist/models/RosterResource.d.ts +1 -1
  21. package/dist/models/RosterResource.js +3 -4
  22. package/dist/models/RosterWithRegistersResource.d.ts +89 -0
  23. package/dist/models/RosterWithRegistersResource.js +87 -0
  24. package/dist/models/RosterWithRegistersResourceArrayResponse.d.ts +33 -0
  25. package/dist/models/RosterWithRegistersResourceArrayResponse.js +50 -0
  26. package/dist/models/RostersExportPdfRequest.d.ts +94 -0
  27. package/dist/models/RostersExportPdfRequest.js +87 -0
  28. package/dist/models/RostersListRequest.d.ts +2 -2
  29. package/dist/models/RostersListWithRegistersRequest.d.ts +162 -0
  30. package/dist/models/RostersListWithRegistersRequest.js +116 -0
  31. package/dist/models/SecurityCompaniesListRequest.d.ts +2 -2
  32. package/dist/models/VenuesListRequest.d.ts +2 -2
  33. package/dist/models/index.d.ts +5 -0
  34. package/dist/models/index.js +5 -0
  35. package/package.json +1 -1
  36. package/src/apis/GeneralApi.ts +97 -0
  37. package/src/models/AddressResource.ts +2 -3
  38. package/src/models/AssetResource.ts +3 -2
  39. package/src/models/IndexUserRequest.ts +2 -2
  40. package/src/models/LicencesListRequest.ts +2 -2
  41. package/src/models/PaginatedRosterWithRegistersResourceResponse.ts +90 -0
  42. package/src/models/RegisterListResource.ts +146 -4
  43. package/src/models/RegisterResource.ts +6 -6
  44. package/src/models/RegistersListRequest.ts +2 -2
  45. package/src/models/RosterLiteResource.ts +4 -3
  46. package/src/models/RosterResource.ts +3 -4
  47. package/src/models/RosterWithRegistersResource.ts +167 -0
  48. package/src/models/RosterWithRegistersResourceArrayResponse.ts +73 -0
  49. package/src/models/RostersExportPdfRequest.ts +150 -0
  50. package/src/models/RostersListRequest.ts +2 -2
  51. package/src/models/RostersListWithRegistersRequest.ts +231 -0
  52. package/src/models/SecurityCompaniesListRequest.ts +2 -2
  53. package/src/models/VenuesListRequest.ts +2 -2
  54. package/src/models/index.ts +5 -0
@@ -0,0 +1,150 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * My API
5
+ * API documentation for my Laravel app
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface RostersExportPdfRequest
20
+ */
21
+ export interface RostersExportPdfRequest {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof RostersExportPdfRequest
26
+ */
27
+ venueId: number;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof RostersExportPdfRequest
32
+ */
33
+ state?: RostersExportPdfRequestStateEnum;
34
+ /**
35
+ *
36
+ * @type {number}
37
+ * @memberof RostersExportPdfRequest
38
+ */
39
+ guardId?: number;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof RostersExportPdfRequest
44
+ */
45
+ securityCompanyId?: number;
46
+ /**
47
+ *
48
+ * @type {Array<string>}
49
+ * @memberof RostersExportPdfRequest
50
+ */
51
+ isComplete?: Array<string>;
52
+ /**
53
+ *
54
+ * @type {Array<string>}
55
+ * @memberof RostersExportPdfRequest
56
+ */
57
+ isCompliant?: Array<string>;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof RostersExportPdfRequest
62
+ */
63
+ bookNumber: string;
64
+ /**
65
+ *
66
+ * @type {Date}
67
+ * @memberof RostersExportPdfRequest
68
+ */
69
+ afterStartDateTime: Date;
70
+ /**
71
+ *
72
+ * @type {Date}
73
+ * @memberof RostersExportPdfRequest
74
+ */
75
+ beforeStartDateTime: Date;
76
+ }
77
+
78
+
79
+ /**
80
+ * @export
81
+ */
82
+ export const RostersExportPdfRequestStateEnum = {
83
+ Qld: 'QLD',
84
+ Nsw: 'NSW',
85
+ Act: 'ACT',
86
+ Vic: 'VIC',
87
+ Tas: 'TAS',
88
+ Sa: 'SA',
89
+ Wa: 'WA',
90
+ Nt: 'NT'
91
+ } as const;
92
+ export type RostersExportPdfRequestStateEnum = typeof RostersExportPdfRequestStateEnum[keyof typeof RostersExportPdfRequestStateEnum];
93
+
94
+
95
+ /**
96
+ * Check if a given object implements the RostersExportPdfRequest interface.
97
+ */
98
+ export function instanceOfRostersExportPdfRequest(value: object): value is RostersExportPdfRequest {
99
+ if (!('venueId' in value) || value['venueId'] === undefined) return false;
100
+ if (!('bookNumber' in value) || value['bookNumber'] === undefined) return false;
101
+ if (!('afterStartDateTime' in value) || value['afterStartDateTime'] === undefined) return false;
102
+ if (!('beforeStartDateTime' in value) || value['beforeStartDateTime'] === undefined) return false;
103
+ return true;
104
+ }
105
+
106
+ export function RostersExportPdfRequestFromJSON(json: any): RostersExportPdfRequest {
107
+ return RostersExportPdfRequestFromJSONTyped(json, false);
108
+ }
109
+
110
+ export function RostersExportPdfRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersExportPdfRequest {
111
+ if (json == null) {
112
+ return json;
113
+ }
114
+ return {
115
+
116
+ 'venueId': json['venue_id'],
117
+ 'state': json['state'] == null ? undefined : json['state'],
118
+ 'guardId': json['guard_id'] == null ? undefined : json['guard_id'],
119
+ 'securityCompanyId': json['security_company_id'] == null ? undefined : json['security_company_id'],
120
+ 'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
121
+ 'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
122
+ 'bookNumber': json['book_number'],
123
+ 'afterStartDateTime': (new Date(json['after_start_date_time'])),
124
+ 'beforeStartDateTime': (new Date(json['before_start_date_time'])),
125
+ };
126
+ }
127
+
128
+ export function RostersExportPdfRequestToJSON(json: any): RostersExportPdfRequest {
129
+ return RostersExportPdfRequestToJSONTyped(json, false);
130
+ }
131
+
132
+ export function RostersExportPdfRequestToJSONTyped(value?: RostersExportPdfRequest | null, ignoreDiscriminator: boolean = false): any {
133
+ if (value == null) {
134
+ return value;
135
+ }
136
+
137
+ return {
138
+
139
+ 'venue_id': value['venueId'],
140
+ 'state': value['state'],
141
+ 'guard_id': value['guardId'],
142
+ 'security_company_id': value['securityCompanyId'],
143
+ 'is_complete': value['isComplete'],
144
+ 'is_compliant': value['isCompliant'],
145
+ 'book_number': value['bookNumber'],
146
+ 'after_start_date_time': ((value['afterStartDateTime']).toISOString()),
147
+ 'before_start_date_time': ((value['beforeStartDateTime']).toISOString()),
148
+ };
149
+ }
150
+
@@ -45,10 +45,10 @@ export interface RostersListRequest {
45
45
  perPage?: number;
46
46
  /**
47
47
  *
48
- * @type {number}
48
+ * @type {string}
49
49
  * @memberof RostersListRequest
50
50
  */
51
- page?: number;
51
+ page?: string;
52
52
  /**
53
53
  *
54
54
  * @type {Array<string>}
@@ -0,0 +1,231 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * My API
5
+ * API documentation for my Laravel app
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface RostersListWithRegistersRequest
20
+ */
21
+ export interface RostersListWithRegistersRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof RostersListWithRegistersRequest
26
+ */
27
+ search?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof RostersListWithRegistersRequest
32
+ */
33
+ sortBy?: RostersListWithRegistersRequestSortByEnum;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof RostersListWithRegistersRequest
38
+ */
39
+ sortDirection?: RostersListWithRegistersRequestSortDirectionEnum;
40
+ /**
41
+ *
42
+ * @type {number}
43
+ * @memberof RostersListWithRegistersRequest
44
+ */
45
+ perPage?: number;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof RostersListWithRegistersRequest
50
+ */
51
+ page?: string;
52
+ /**
53
+ *
54
+ * @type {Array<string>}
55
+ * @memberof RostersListWithRegistersRequest
56
+ */
57
+ isComplete?: Array<string>;
58
+ /**
59
+ *
60
+ * @type {Array<string>}
61
+ * @memberof RostersListWithRegistersRequest
62
+ */
63
+ isCompliant?: Array<string>;
64
+ /**
65
+ *
66
+ * @type {Date}
67
+ * @memberof RostersListWithRegistersRequest
68
+ */
69
+ beforeStartDateTime?: Date;
70
+ /**
71
+ *
72
+ * @type {Date}
73
+ * @memberof RostersListWithRegistersRequest
74
+ */
75
+ afterStartDateTime?: Date;
76
+ /**
77
+ *
78
+ * @type {Date}
79
+ * @memberof RostersListWithRegistersRequest
80
+ */
81
+ beforeFinishDateTime?: Date;
82
+ /**
83
+ *
84
+ * @type {Date}
85
+ * @memberof RostersListWithRegistersRequest
86
+ */
87
+ afterFinishDateTime?: Date;
88
+ /**
89
+ *
90
+ * @type {number}
91
+ * @memberof RostersListWithRegistersRequest
92
+ */
93
+ relatedId?: number;
94
+ /**
95
+ *
96
+ * @type {string}
97
+ * @memberof RostersListWithRegistersRequest
98
+ */
99
+ relatedType?: RostersListWithRegistersRequestRelatedTypeEnum;
100
+ /**
101
+ *
102
+ * @type {boolean}
103
+ * @memberof RostersListWithRegistersRequest
104
+ */
105
+ includesRelations?: boolean;
106
+ /**
107
+ *
108
+ * @type {string}
109
+ * @memberof RostersListWithRegistersRequest
110
+ */
111
+ state?: RostersListWithRegistersRequestStateEnum;
112
+ /**
113
+ *
114
+ * @type {number}
115
+ * @memberof RostersListWithRegistersRequest
116
+ */
117
+ guardId?: number;
118
+ }
119
+
120
+
121
+ /**
122
+ * @export
123
+ */
124
+ export const RostersListWithRegistersRequestSortByEnum = {
125
+ VenueName: 'venue-name',
126
+ SecurityCompanyName: 'securityCompany-name',
127
+ StartDateTime: 'start_date_time',
128
+ FinishDateTime: 'finish_date_time'
129
+ } as const;
130
+ export type RostersListWithRegistersRequestSortByEnum = typeof RostersListWithRegistersRequestSortByEnum[keyof typeof RostersListWithRegistersRequestSortByEnum];
131
+
132
+ /**
133
+ * @export
134
+ */
135
+ export const RostersListWithRegistersRequestSortDirectionEnum = {
136
+ Asc: 'asc',
137
+ Desc: 'desc'
138
+ } as const;
139
+ export type RostersListWithRegistersRequestSortDirectionEnum = typeof RostersListWithRegistersRequestSortDirectionEnum[keyof typeof RostersListWithRegistersRequestSortDirectionEnum];
140
+
141
+ /**
142
+ * @export
143
+ */
144
+ export const RostersListWithRegistersRequestRelatedTypeEnum = {
145
+ Venue: 'venue',
146
+ SecurityCompany: 'securityCompany'
147
+ } as const;
148
+ export type RostersListWithRegistersRequestRelatedTypeEnum = typeof RostersListWithRegistersRequestRelatedTypeEnum[keyof typeof RostersListWithRegistersRequestRelatedTypeEnum];
149
+
150
+ /**
151
+ * @export
152
+ */
153
+ export const RostersListWithRegistersRequestStateEnum = {
154
+ Qld: 'QLD',
155
+ Nsw: 'NSW',
156
+ Act: 'ACT',
157
+ Vic: 'VIC',
158
+ Tas: 'TAS',
159
+ Sa: 'SA',
160
+ Wa: 'WA',
161
+ Nt: 'NT'
162
+ } as const;
163
+ export type RostersListWithRegistersRequestStateEnum = typeof RostersListWithRegistersRequestStateEnum[keyof typeof RostersListWithRegistersRequestStateEnum];
164
+
165
+
166
+ /**
167
+ * Check if a given object implements the RostersListWithRegistersRequest interface.
168
+ */
169
+ export function instanceOfRostersListWithRegistersRequest(value: object): value is RostersListWithRegistersRequest {
170
+ return true;
171
+ }
172
+
173
+ export function RostersListWithRegistersRequestFromJSON(json: any): RostersListWithRegistersRequest {
174
+ return RostersListWithRegistersRequestFromJSONTyped(json, false);
175
+ }
176
+
177
+ export function RostersListWithRegistersRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RostersListWithRegistersRequest {
178
+ if (json == null) {
179
+ return json;
180
+ }
181
+ return {
182
+
183
+ 'search': json['search'] == null ? undefined : json['search'],
184
+ 'sortBy': json['sort_by'] == null ? undefined : json['sort_by'],
185
+ 'sortDirection': json['sort_direction'] == null ? undefined : json['sort_direction'],
186
+ 'perPage': json['per_page'] == null ? undefined : json['per_page'],
187
+ 'page': json['page'] == null ? undefined : json['page'],
188
+ 'isComplete': json['is_complete'] == null ? undefined : json['is_complete'],
189
+ 'isCompliant': json['is_compliant'] == null ? undefined : json['is_compliant'],
190
+ 'beforeStartDateTime': json['before_start_date_time'] == null ? undefined : (new Date(json['before_start_date_time'])),
191
+ 'afterStartDateTime': json['after_start_date_time'] == null ? undefined : (new Date(json['after_start_date_time'])),
192
+ 'beforeFinishDateTime': json['before_finish_date_time'] == null ? undefined : (new Date(json['before_finish_date_time'])),
193
+ 'afterFinishDateTime': json['after_finish_date_time'] == null ? undefined : (new Date(json['after_finish_date_time'])),
194
+ 'relatedId': json['related_id'] == null ? undefined : json['related_id'],
195
+ 'relatedType': json['related_type'] == null ? undefined : json['related_type'],
196
+ 'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
197
+ 'state': json['state'] == null ? undefined : json['state'],
198
+ 'guardId': json['guard_id'] == null ? undefined : json['guard_id'],
199
+ };
200
+ }
201
+
202
+ export function RostersListWithRegistersRequestToJSON(json: any): RostersListWithRegistersRequest {
203
+ return RostersListWithRegistersRequestToJSONTyped(json, false);
204
+ }
205
+
206
+ export function RostersListWithRegistersRequestToJSONTyped(value?: RostersListWithRegistersRequest | null, ignoreDiscriminator: boolean = false): any {
207
+ if (value == null) {
208
+ return value;
209
+ }
210
+
211
+ return {
212
+
213
+ 'search': value['search'],
214
+ 'sort_by': value['sortBy'],
215
+ 'sort_direction': value['sortDirection'],
216
+ 'per_page': value['perPage'],
217
+ 'page': value['page'],
218
+ 'is_complete': value['isComplete'],
219
+ 'is_compliant': value['isCompliant'],
220
+ 'before_start_date_time': value['beforeStartDateTime'] == null ? undefined : ((value['beforeStartDateTime']).toISOString()),
221
+ 'after_start_date_time': value['afterStartDateTime'] == null ? undefined : ((value['afterStartDateTime']).toISOString()),
222
+ 'before_finish_date_time': value['beforeFinishDateTime'] == null ? undefined : ((value['beforeFinishDateTime']).toISOString()),
223
+ 'after_finish_date_time': value['afterFinishDateTime'] == null ? undefined : ((value['afterFinishDateTime']).toISOString()),
224
+ 'related_id': value['relatedId'],
225
+ 'related_type': value['relatedType'],
226
+ 'includes_relations': value['includesRelations'],
227
+ 'state': value['state'],
228
+ 'guard_id': value['guardId'],
229
+ };
230
+ }
231
+
@@ -45,10 +45,10 @@ export interface SecurityCompaniesListRequest {
45
45
  perPage?: number;
46
46
  /**
47
47
  *
48
- * @type {number}
48
+ * @type {string}
49
49
  * @memberof SecurityCompaniesListRequest
50
50
  */
51
- page?: number;
51
+ page?: string;
52
52
  /**
53
53
  *
54
54
  * @type {Array<string>}
@@ -45,10 +45,10 @@ export interface VenuesListRequest {
45
45
  perPage?: number;
46
46
  /**
47
47
  *
48
- * @type {number}
48
+ * @type {string}
49
49
  * @memberof VenuesListRequest
50
50
  */
51
- page?: number;
51
+ page?: string;
52
52
  /**
53
53
  *
54
54
  * @type {Array<string>}
@@ -31,6 +31,7 @@ export * from './PaginatedRegisterListResourceResponse';
31
31
  export * from './PaginatedRegisterResourceResponse';
32
32
  export * from './PaginatedRosterListResourceResponse';
33
33
  export * from './PaginatedRosterResourceResponse';
34
+ export * from './PaginatedRosterWithRegistersResourceResponse';
34
35
  export * from './PaginatedSecurityCompanyResourceResponse';
35
36
  export * from './PaginatedUserResourceResponse';
36
37
  export * from './PaginatedVenueResourceResponse';
@@ -52,8 +53,12 @@ export * from './RosterLiteResource';
52
53
  export * from './RosterLiteResourceArrayResponse';
53
54
  export * from './RosterResource';
54
55
  export * from './RosterResourceArrayResponse';
56
+ export * from './RosterWithRegistersResource';
57
+ export * from './RosterWithRegistersResourceArrayResponse';
58
+ export * from './RostersExportPdfRequest';
55
59
  export * from './RostersListAllRequest';
56
60
  export * from './RostersListRequest';
61
+ export * from './RostersListWithRegistersRequest';
57
62
  export * from './SecurityCompaniesAttachUsersRequest';
58
63
  export * from './SecurityCompaniesListAllRequest';
59
64
  export * from './SecurityCompaniesListRequest';