@gewis/grooster-backend-ts 1.1.0 → 1.2.1

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.
@@ -1,34 +1,41 @@
1
1
  # RosterShiftApi
2
2
 
3
- All URIs are relative to _http://localhost_
3
+ All URIs are relative to *http://localhost*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------------------------------------------- | ----------------------------- | ------------------------- |
7
- | [**createRosterShift**](#createrostershift) | **POST** /roster/shift | Create a new roster shift |
8
- | [**deleteRosterShift**](#deleterostershift) | **DELETE** /roster/shift/{id} | Deletes a roster shift |
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createRosterShift**](#createrostershift) | **POST** /roster/shift | Create a new roster shift|
8
+ |[**deleteRosterShift**](#deleterostershift) | **DELETE** /roster/shift/{id} | Deletes a roster shift|
9
9
 
10
10
  # **createRosterShift**
11
-
12
11
  > RosterShift createRosterShift(createParams)
13
12
 
13
+
14
14
  ### Example
15
15
 
16
16
  ```typescript
17
- import { RosterShiftApi, Configuration, RosterShiftCreateRequest } from "./api";
17
+ import {
18
+ RosterShiftApi,
19
+ Configuration,
20
+ RosterShiftCreateRequest
21
+ } from './api';
18
22
 
19
23
  const configuration = new Configuration();
20
24
  const apiInstance = new RosterShiftApi(configuration);
21
25
 
22
26
  let createParams: RosterShiftCreateRequest; //Roster shift input
23
27
 
24
- const { status, data } = await apiInstance.createRosterShift(createParams);
28
+ const { status, data } = await apiInstance.createRosterShift(
29
+ createParams
30
+ );
25
31
  ```
26
32
 
27
33
  ### Parameters
28
34
 
29
- | Name | Type | Description | Notes |
30
- | ---------------- | ---------------------------- | ------------------ | ----- |
31
- | **createParams** | **RosterShiftCreateRequest** | Roster shift input | |
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **createParams** | **RosterShiftCreateRequest**| Roster shift input | |
38
+
32
39
 
33
40
  ### Return type
34
41
 
@@ -40,40 +47,46 @@ const { status, data } = await apiInstance.createRosterShift(createParams);
40
47
 
41
48
  ### HTTP request headers
42
49
 
43
- - **Content-Type**: application/json
44
- - **Accept**: application/json
50
+ - **Content-Type**: application/json
51
+ - **Accept**: application/json
45
52
 
46
- ### HTTP response details
47
53
 
54
+ ### HTTP response details
48
55
  | Status code | Description | Response headers |
49
- | ----------- | ----------- | ---------------- |
50
- | **200** | OK | - |
51
- | **400** | Bad Request | - |
56
+ |-------------|-------------|------------------|
57
+ |**200** | OK | - |
58
+ |**400** | Bad Request | - |
52
59
 
53
60
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
54
61
 
55
62
  # **deleteRosterShift**
56
-
57
63
  > string deleteRosterShift()
58
64
 
65
+
59
66
  ### Example
60
67
 
61
68
  ```typescript
62
- import { RosterShiftApi, Configuration } from "./api";
69
+ import {
70
+ RosterShiftApi,
71
+ Configuration
72
+ } from './api';
63
73
 
64
74
  const configuration = new Configuration();
65
75
  const apiInstance = new RosterShiftApi(configuration);
66
76
 
67
77
  let id: number; //Roster Answer ID (default to undefined)
68
78
 
69
- const { status, data } = await apiInstance.deleteRosterShift(id);
79
+ const { status, data } = await apiInstance.deleteRosterShift(
80
+ id
81
+ );
70
82
  ```
71
83
 
72
84
  ### Parameters
73
85
 
74
- | Name | Type | Description | Notes |
75
- | ------ | ------------ | ---------------- | --------------------- |
76
- | **id** | [**number**] | Roster Answer ID | defaults to undefined |
86
+ |Name | Type | Description | Notes|
87
+ |------------- | ------------- | ------------- | -------------|
88
+ | **id** | [**number**] | Roster Answer ID | defaults to undefined|
89
+
77
90
 
78
91
  ### Return type
79
92
 
@@ -85,14 +98,15 @@ const { status, data } = await apiInstance.deleteRosterShift(id);
85
98
 
86
99
  ### HTTP request headers
87
100
 
88
- - **Content-Type**: Not defined
89
- - **Accept**: application/json
101
+ - **Content-Type**: Not defined
102
+ - **Accept**: application/json
90
103
 
91
- ### HTTP response details
92
104
 
105
+ ### HTTP response details
93
106
  | Status code | Description | Response headers |
94
- | ----------- | ----------- | ---------------- |
95
- | **200** | OK | - |
96
- | **400** | Bad Request | - |
107
+ |-------------|-------------|------------------|
108
+ |**200** | OK | - |
109
+ |**400** | Bad Request | - |
97
110
 
98
111
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
112
+
@@ -1,20 +1,21 @@
1
1
  # RosterShiftCreateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ------------ | ---------- | ----------- | --------------------------------- |
7
- | **name** | **string** | | [optional] [default to undefined] |
8
- | **rosterId** | **number** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [optional] [default to undefined]
9
+ **rosterId** | **number** | | [optional] [default to undefined]
9
10
 
10
11
  ## Example
11
12
 
12
13
  ```typescript
13
- import { RosterShiftCreateRequest } from "./api";
14
+ import { RosterShiftCreateRequest } from './api';
14
15
 
15
16
  const instance: RosterShiftCreateRequest = {
16
- name,
17
- rosterId,
17
+ name,
18
+ rosterId,
18
19
  };
19
20
  ```
20
21
 
@@ -1,28 +1,31 @@
1
1
  # RosterTemplate
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ------------- | ------------------------------------- | ----------- | --------------------------------- |
7
- | **createdAt** | **string** | | [optional] [default to undefined] |
8
- | **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined] |
9
- | **id** | **number** | | [optional] [default to undefined] |
10
- | **organId** | **number** | | [optional] [default to undefined] |
11
- | **shifts** | **Array<string>** | | [optional] [default to undefined] |
12
- | **updatedAt** | **string** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdAt** | **string** | | [optional] [default to undefined]
9
+ **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
10
+ **id** | **number** | | [optional] [default to undefined]
11
+ **name** | **string** | | [optional] [default to undefined]
12
+ **organId** | **number** | | [optional] [default to undefined]
13
+ **shifts** | **Array<string>** | | [optional] [default to undefined]
14
+ **updatedAt** | **string** | | [optional] [default to undefined]
13
15
 
14
16
  ## Example
15
17
 
16
18
  ```typescript
17
- import { RosterTemplate } from "./api";
19
+ import { RosterTemplate } from './api';
18
20
 
19
21
  const instance: RosterTemplate = {
20
- createdAt,
21
- deletedAt,
22
- id,
23
- organId,
24
- shifts,
25
- updatedAt,
22
+ createdAt,
23
+ deletedAt,
24
+ id,
25
+ name,
26
+ organId,
27
+ shifts,
28
+ updatedAt,
26
29
  };
27
30
  ```
28
31
 
@@ -1,20 +1,23 @@
1
1
  # RosterTemplateCreateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ----------- | ----------------------- | ----------- | --------------------------------- |
7
- | **organId** | **number** | | [optional] [default to undefined] |
8
- | **shifts** | **Array<string>** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **name** | **string** | | [optional] [default to undefined]
9
+ **organId** | **number** | | [optional] [default to undefined]
10
+ **shifts** | **Array<string>** | | [optional] [default to undefined]
9
11
 
10
12
  ## Example
11
13
 
12
14
  ```typescript
13
- import { RosterTemplateCreateRequest } from "./api";
15
+ import { RosterTemplateCreateRequest } from './api';
14
16
 
15
17
  const instance: RosterTemplateCreateRequest = {
16
- organId,
17
- shifts,
18
+ name,
19
+ organId,
20
+ shifts,
18
21
  };
19
22
  ```
20
23
 
@@ -1,20 +1,21 @@
1
1
  # RosterUpdateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | -------- | ---------- | ----------- | --------------------------------- |
7
- | **date** | **string** | | [optional] [default to undefined] |
8
- | **name** | **string** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **date** | **string** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
9
10
 
10
11
  ## Example
11
12
 
12
13
  ```typescript
13
- import { RosterUpdateRequest } from "./api";
14
+ import { RosterUpdateRequest } from './api';
14
15
 
15
16
  const instance: RosterUpdateRequest = {
16
- date,
17
- name,
17
+ date,
18
+ name,
18
19
  };
19
20
  ```
20
21
 
@@ -1,32 +1,33 @@
1
1
  # SavedShift
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ----------------- | ------------------------------------- | ----------- | --------------------------------- |
7
- | **createdAt** | **string** | | [optional] [default to undefined] |
8
- | **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined] |
9
- | **id** | **number** | | [optional] [default to undefined] |
10
- | **rosterId** | **number** | | [optional] [default to undefined] |
11
- | **rosterShift** | [**RosterShift**](RosterShift.md) | | [optional] [default to undefined] |
12
- | **rosterShiftId** | **number** | | [optional] [default to undefined] |
13
- | **updatedAt** | **string** | | [optional] [default to undefined] |
14
- | **users** | [**Array<User>**](User.md) | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdAt** | **string** | | [optional] [default to undefined]
9
+ **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
10
+ **id** | **number** | | [optional] [default to undefined]
11
+ **rosterId** | **number** | | [optional] [default to undefined]
12
+ **rosterShift** | [**RosterShift**](RosterShift.md) | | [optional] [default to undefined]
13
+ **rosterShiftId** | **number** | | [optional] [default to undefined]
14
+ **updatedAt** | **string** | | [optional] [default to undefined]
15
+ **users** | [**Array<User>**](User.md) | | [optional] [default to undefined]
15
16
 
16
17
  ## Example
17
18
 
18
19
  ```typescript
19
- import { SavedShift } from "./api";
20
+ import { SavedShift } from './api';
20
21
 
21
22
  const instance: SavedShift = {
22
- createdAt,
23
- deletedAt,
24
- id,
25
- rosterId,
26
- rosterShift,
27
- rosterShiftId,
28
- updatedAt,
29
- users,
23
+ createdAt,
24
+ deletedAt,
25
+ id,
26
+ rosterId,
27
+ rosterShift,
28
+ rosterShiftId,
29
+ updatedAt,
30
+ users,
30
31
  };
31
32
  ```
32
33
 
@@ -1,35 +1,41 @@
1
1
  # SavedShiftApi
2
2
 
3
- All URIs are relative to _http://localhost_
3
+ All URIs are relative to *http://localhost*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ----------------------------------------- | ---------------------------------- | ------------------------------------------ |
7
- | [**getSavedRoster**](#getsavedroster) | **GET** /roster/saved-shift/{id} | Get all saved shifts for a specific roster |
8
- | [**rosterSave**](#rostersave) | **POST** /roster/{id}/save | Save a specific roster |
9
- | [**updateSavedShift**](#updatesavedshift) | **PATCH** /roster/saved-shift/{id} | Update a specific saved shift |
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getSavedRoster**](#getsavedroster) | **GET** /roster/saved-shift/{id} | Get all saved shifts for a specific roster|
8
+ |[**rosterSave**](#rostersave) | **POST** /roster/{id}/save | Save a specific roster|
9
+ |[**updateSavedShift**](#updatesavedshift) | **PATCH** /roster/saved-shift/{id} | Update a specific saved shift|
10
10
 
11
11
  # **getSavedRoster**
12
-
13
12
  > Array<SavedShift> getSavedRoster()
14
13
 
14
+
15
15
  ### Example
16
16
 
17
17
  ```typescript
18
- import { SavedShiftApi, Configuration } from "./api";
18
+ import {
19
+ SavedShiftApi,
20
+ Configuration
21
+ } from './api';
19
22
 
20
23
  const configuration = new Configuration();
21
24
  const apiInstance = new SavedShiftApi(configuration);
22
25
 
23
26
  let id: number; //Roster ID (default to undefined)
24
27
 
25
- const { status, data } = await apiInstance.getSavedRoster(id);
28
+ const { status, data } = await apiInstance.getSavedRoster(
29
+ id
30
+ );
26
31
  ```
27
32
 
28
33
  ### Parameters
29
34
 
30
- | Name | Type | Description | Notes |
31
- | ------ | ------------ | ----------- | --------------------- |
32
- | **id** | [**number**] | Roster ID | defaults to undefined |
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **id** | [**number**] | Roster ID | defaults to undefined|
38
+
33
39
 
34
40
  ### Return type
35
41
 
@@ -41,41 +47,47 @@ const { status, data } = await apiInstance.getSavedRoster(id);
41
47
 
42
48
  ### HTTP request headers
43
49
 
44
- - **Content-Type**: Not defined
45
- - **Accept**: application/json
50
+ - **Content-Type**: Not defined
51
+ - **Accept**: application/json
46
52
 
47
- ### HTTP response details
48
53
 
49
- | Status code | Description | Response headers |
50
- | ----------- | -------------------- | ---------------- |
51
- | **200** | Saved Shifts | - |
52
- | **400** | Invalid request | - |
53
- | **404** | SavedShift not found | - |
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | Saved Shifts | - |
58
+ |**400** | Invalid request | - |
59
+ |**404** | SavedShift not found | - |
54
60
 
55
61
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
56
62
 
57
63
  # **rosterSave**
58
-
59
64
  > string rosterSave()
60
65
 
66
+
61
67
  ### Example
62
68
 
63
69
  ```typescript
64
- import { SavedShiftApi, Configuration } from "./api";
70
+ import {
71
+ SavedShiftApi,
72
+ Configuration
73
+ } from './api';
65
74
 
66
75
  const configuration = new Configuration();
67
76
  const apiInstance = new SavedShiftApi(configuration);
68
77
 
69
78
  let id: number; //Roster ID (default to undefined)
70
79
 
71
- const { status, data } = await apiInstance.rosterSave(id);
80
+ const { status, data } = await apiInstance.rosterSave(
81
+ id
82
+ );
72
83
  ```
73
84
 
74
85
  ### Parameters
75
86
 
76
- | Name | Type | Description | Notes |
77
- | ------ | ------------ | ----------- | --------------------- |
78
- | **id** | [**number**] | Roster ID | defaults to undefined |
87
+ |Name | Type | Description | Notes|
88
+ |------------- | ------------- | ------------- | -------------|
89
+ | **id** | [**number**] | Roster ID | defaults to undefined|
90
+
79
91
 
80
92
  ### Return type
81
93
 
@@ -87,27 +99,31 @@ const { status, data } = await apiInstance.rosterSave(id);
87
99
 
88
100
  ### HTTP request headers
89
101
 
90
- - **Content-Type**: Not defined
91
- - **Accept**: application/json
102
+ - **Content-Type**: Not defined
103
+ - **Accept**: application/json
92
104
 
93
- ### HTTP response details
94
105
 
106
+ ### HTTP response details
95
107
  | Status code | Description | Response headers |
96
- | ----------- | ----------- | ---------------- |
97
- | **200** | OK | - |
98
- | **400** | Bad Request | - |
99
- | **404** | Not Found | - |
108
+ |-------------|-------------|------------------|
109
+ |**200** | OK | - |
110
+ |**400** | Bad Request | - |
111
+ |**404** | Not Found | - |
100
112
 
101
113
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
102
114
 
103
115
  # **updateSavedShift**
104
-
105
116
  > SavedShift updateSavedShift(updateParams)
106
117
 
118
+
107
119
  ### Example
108
120
 
109
121
  ```typescript
110
- import { SavedShiftApi, Configuration, SavedShiftUpdateRequest } from "./api";
122
+ import {
123
+ SavedShiftApi,
124
+ Configuration,
125
+ SavedShiftUpdateRequest
126
+ } from './api';
111
127
 
112
128
  const configuration = new Configuration();
113
129
  const apiInstance = new SavedShiftApi(configuration);
@@ -115,15 +131,19 @@ const apiInstance = new SavedShiftApi(configuration);
115
131
  let id: number; //SavedShift ID (default to undefined)
116
132
  let updateParams: SavedShiftUpdateRequest; //Update data
117
133
 
118
- const { status, data } = await apiInstance.updateSavedShift(id, updateParams);
134
+ const { status, data } = await apiInstance.updateSavedShift(
135
+ id,
136
+ updateParams
137
+ );
119
138
  ```
120
139
 
121
140
  ### Parameters
122
141
 
123
- | Name | Type | Description | Notes |
124
- | ---------------- | --------------------------- | ------------- | --------------------- |
125
- | **updateParams** | **SavedShiftUpdateRequest** | Update data | |
126
- | **id** | [**number**] | SavedShift ID | defaults to undefined |
142
+ |Name | Type | Description | Notes|
143
+ |------------- | ------------- | ------------- | -------------|
144
+ | **updateParams** | **SavedShiftUpdateRequest**| Update data | |
145
+ | **id** | [**number**] | SavedShift ID | defaults to undefined|
146
+
127
147
 
128
148
  ### Return type
129
149
 
@@ -135,15 +155,16 @@ const { status, data } = await apiInstance.updateSavedShift(id, updateParams);
135
155
 
136
156
  ### HTTP request headers
137
157
 
138
- - **Content-Type**: application/json
139
- - **Accept**: application/json
158
+ - **Content-Type**: application/json
159
+ - **Accept**: application/json
140
160
 
141
- ### HTTP response details
142
161
 
143
- | Status code | Description | Response headers |
144
- | ----------- | -------------------- | ---------------- |
145
- | **200** | OK | - |
146
- | **400** | Invalid request | - |
147
- | **404** | SavedShift not found | - |
162
+ ### HTTP response details
163
+ | Status code | Description | Response headers |
164
+ |-------------|-------------|------------------|
165
+ |**200** | OK | - |
166
+ |**400** | Invalid request | - |
167
+ |**404** | SavedShift not found | - |
148
168
 
149
169
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
170
+
@@ -1,18 +1,19 @@
1
1
  # SavedShiftUpdateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | --------- | ----------------------- | ----------- | --------------------------------- |
7
- | **users** | **Array&lt;number&gt;** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **users** | **Array&lt;number&gt;** | | [optional] [default to undefined]
8
9
 
9
10
  ## Example
10
11
 
11
12
  ```typescript
12
- import { SavedShiftUpdateRequest } from "./api";
13
+ import { SavedShiftUpdateRequest } from './api';
13
14
 
14
15
  const instance: SavedShiftUpdateRequest = {
15
- users,
16
+ users,
16
17
  };
17
18
  ```
18
19
 
package/src/docs/User.md CHANGED
@@ -1,30 +1,31 @@
1
1
  # User
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ------------- | ------------------------------------- | ----------- | --------------------------------- |
7
- | **createdAt** | **string** | | [optional] [default to undefined] |
8
- | **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined] |
9
- | **gewis_id** | **number** | | [optional] [default to undefined] |
10
- | **id** | **number** | | [optional] [default to undefined] |
11
- | **name** | **string** | | [optional] [default to undefined] |
12
- | **organs** | [**Array&lt;Organ&gt;**](Organ.md) | | [optional] [default to undefined] |
13
- | **updatedAt** | **string** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdAt** | **string** | | [optional] [default to undefined]
9
+ **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
10
+ **gewis_id** | **number** | | [optional] [default to undefined]
11
+ **id** | **number** | | [optional] [default to undefined]
12
+ **name** | **string** | | [optional] [default to undefined]
13
+ **organs** | [**Array&lt;Organ&gt;**](Organ.md) | | [optional] [default to undefined]
14
+ **updatedAt** | **string** | | [optional] [default to undefined]
14
15
 
15
16
  ## Example
16
17
 
17
18
  ```typescript
18
- import { User } from "./api";
19
+ import { User } from './api';
19
20
 
20
21
  const instance: User = {
21
- createdAt,
22
- deletedAt,
23
- gewis_id,
24
- id,
25
- name,
26
- organs,
27
- updatedAt,
22
+ createdAt,
23
+ deletedAt,
24
+ gewis_id,
25
+ id,
26
+ name,
27
+ organs,
28
+ updatedAt,
28
29
  };
29
30
  ```
30
31