@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,14 +1,13 @@
1
1
  # AuthApi
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
- | [**authCallbackGet**](#authcallbackget) | **GET** /auth/callback | Handle OAuth2 Callback |
8
- | [**authRedirectGet**](#authredirectget) | **GET** /auth/redirect | Redirect to OIDC provider |
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**authCallbackGet**](#authcallbackget) | **GET** /auth/callback | Handle OAuth2 Callback|
8
+ |[**authRedirectGet**](#authredirectget) | **GET** /auth/redirect | Redirect to OIDC provider|
9
9
 
10
10
  # **authCallbackGet**
11
-
12
11
  > { [key: string]: string; } authCallbackGet()
13
12
 
14
13
  Validates state, exchanges code for token, and returns user info
@@ -16,7 +15,10 @@ Validates state, exchanges code for token, and returns user info
16
15
  ### Example
17
16
 
18
17
  ```typescript
19
- import { AuthApi, Configuration } from "./api";
18
+ import {
19
+ AuthApi,
20
+ Configuration
21
+ } from './api';
20
22
 
21
23
  const configuration = new Configuration();
22
24
  const apiInstance = new AuthApi(configuration);
@@ -24,15 +26,19 @@ const apiInstance = new AuthApi(configuration);
24
26
  let state: string; //State returned from provider (default to undefined)
25
27
  let code: string; //Authorization code from provider (default to undefined)
26
28
 
27
- const { status, data } = await apiInstance.authCallbackGet(state, code);
29
+ const { status, data } = await apiInstance.authCallbackGet(
30
+ state,
31
+ code
32
+ );
28
33
  ```
29
34
 
30
35
  ### Parameters
31
36
 
32
- | Name | Type | Description | Notes |
33
- | --------- | ------------ | -------------------------------- | --------------------- |
34
- | **state** | [**string**] | State returned from provider | defaults to undefined |
35
- | **code** | [**string**] | Authorization code from provider | defaults to undefined |
37
+ |Name | Type | Description | Notes|
38
+ |------------- | ------------- | ------------- | -------------|
39
+ | **state** | [**string**] | State returned from provider | defaults to undefined|
40
+ | **code** | [**string**] | Authorization code from provider | defaults to undefined|
41
+
36
42
 
37
43
  ### Return type
38
44
 
@@ -44,21 +50,20 @@ No authorization required
44
50
 
45
51
  ### HTTP request headers
46
52
 
47
- - **Content-Type**: Not defined
48
- - **Accept**: _/_
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: */*
49
55
 
50
- ### HTTP response details
51
56
 
52
- | Status code | Description | Response headers |
53
- | ----------- | ------------------------------------- | ---------------- |
54
- | **200** | User info and token | - |
55
- | **400** | Bad request: missing or invalid state | - |
56
- | **500** | Internal server error | - |
57
+ ### HTTP response details
58
+ | Status code | Description | Response headers |
59
+ |-------------|-------------|------------------|
60
+ |**200** | User info and token | - |
61
+ |**400** | Bad request: missing or invalid state | - |
62
+ |**500** | Internal server error | - |
57
63
 
58
64
  [[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)
59
65
 
60
66
  # **authRedirectGet**
61
-
62
67
  > string authRedirectGet()
63
68
 
64
69
  Generates state, sets a cookie, and redirects to Google OIDC
@@ -66,21 +71,27 @@ Generates state, sets a cookie, and redirects to Google OIDC
66
71
  ### Example
67
72
 
68
73
  ```typescript
69
- import { AuthApi, Configuration } from "./api";
74
+ import {
75
+ AuthApi,
76
+ Configuration
77
+ } from './api';
70
78
 
71
79
  const configuration = new Configuration();
72
80
  const apiInstance = new AuthApi(configuration);
73
81
 
74
82
  let state: string; //State returned from provider (default to undefined)
75
83
 
76
- const { status, data } = await apiInstance.authRedirectGet(state);
84
+ const { status, data } = await apiInstance.authRedirectGet(
85
+ state
86
+ );
77
87
  ```
78
88
 
79
89
  ### Parameters
80
90
 
81
- | Name | Type | Description | Notes |
82
- | --------- | ------------ | ---------------------------- | --------------------- |
83
- | **state** | [**string**] | State returned from provider | defaults to undefined |
91
+ |Name | Type | Description | Notes|
92
+ |------------- | ------------- | ------------- | -------------|
93
+ | **state** | [**string**] | State returned from provider | defaults to undefined|
94
+
84
95
 
85
96
  ### Return type
86
97
 
@@ -92,14 +103,15 @@ No authorization required
92
103
 
93
104
  ### HTTP request headers
94
105
 
95
- - **Content-Type**: Not defined
96
- - **Accept**: _/_
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: */*
97
108
 
98
- ### HTTP response details
99
109
 
100
- | Status code | Description | Response headers |
101
- | ----------- | ---------------- | ---------------- |
102
- | **200** | redirect | - |
103
- | **500** | pkg server error | - |
110
+ ### HTTP response details
111
+ | Status code | Description | Response headers |
112
+ |-------------|-------------|------------------|
113
+ |**200** | redirect | - |
114
+ |**500** | pkg server error | - |
104
115
 
105
116
  [[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)
117
+
@@ -1,20 +1,21 @@
1
1
  # GormDeletedAt
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | --------- | ----------- | --------------------------------- | --------------------------------- |
7
- | **time** | **string** | | [optional] [default to undefined] |
8
- | **valid** | **boolean** | Valid is true if Time is not NULL | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **time** | **string** | | [optional] [default to undefined]
9
+ **valid** | **boolean** | Valid is true if Time is not NULL | [optional] [default to undefined]
9
10
 
10
11
  ## Example
11
12
 
12
13
  ```typescript
13
- import { GormDeletedAt } from "./api";
14
+ import { GormDeletedAt } from './api';
14
15
 
15
16
  const instance: GormDeletedAt = {
16
- time,
17
- valid,
17
+ time,
18
+ valid,
18
19
  };
19
20
  ```
20
21
 
package/src/docs/Organ.md CHANGED
@@ -4,27 +4,27 @@ An organ that users can be part of.
4
4
 
5
5
  ## Properties
6
6
 
7
- | Name | Type | Description | Notes |
8
- | ------------- | ------------------------------------- | ----------- | --------------------------------- |
9
- | **createdAt** | **string** | | [optional] [default to undefined] |
10
- | **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined] |
11
- | **id** | **number** | | [optional] [default to undefined] |
12
- | **name** | **string** | | [optional] [default to undefined] |
13
- | **updatedAt** | **string** | | [optional] [default to undefined] |
14
- | **users** | [**Array<User>**](User.md) | | [optional] [default to undefined] |
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **createdAt** | **string** | | [optional] [default to undefined]
10
+ **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
11
+ **id** | **number** | | [optional] [default to undefined]
12
+ **name** | **string** | | [optional] [default to undefined]
13
+ **updatedAt** | **string** | | [optional] [default to undefined]
14
+ **users** | [**Array<User>**](User.md) | | [optional] [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
18
18
  ```typescript
19
- import { Organ } from "./api";
19
+ import { Organ } from './api';
20
20
 
21
21
  const instance: Organ = {
22
- createdAt,
23
- deletedAt,
24
- id,
25
- name,
26
- updatedAt,
27
- users,
22
+ createdAt,
23
+ deletedAt,
24
+ id,
25
+ name,
26
+ updatedAt,
27
+ users,
28
28
  };
29
29
  ```
30
30
 
@@ -1,40 +1,41 @@
1
1
  # Roster
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ---------------- | ------------------------------------------------ | ----------- | --------------------------------- |
7
- | **createdAt** | **string** | | [optional] [default to undefined] |
8
- | **date** | **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
- | **organ** | [**Organ**](Organ.md) | | [optional] [default to undefined] |
13
- | **organId** | **number** | | [optional] [default to undefined] |
14
- | **rosterAnswer** | [**Array<RosterAnswer>**](RosterAnswer.md) | | [optional] [default to undefined] |
15
- | **rosterShift** | [**Array<RosterShift>**](RosterShift.md) | | [optional] [default to undefined] |
16
- | **saved** | **boolean** | | [optional] [default to undefined] |
17
- | **updatedAt** | **string** | | [optional] [default to undefined] |
18
- | **values** | **Array<string>** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **createdAt** | **string** | | [optional] [default to undefined]
9
+ **date** | **string** | | [optional] [default to undefined]
10
+ **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
11
+ **id** | **number** | | [optional] [default to undefined]
12
+ **name** | **string** | | [optional] [default to undefined]
13
+ **organ** | [**Organ**](Organ.md) | | [optional] [default to undefined]
14
+ **organId** | **number** | | [optional] [default to undefined]
15
+ **rosterAnswer** | [**Array<RosterAnswer>**](RosterAnswer.md) | | [optional] [default to undefined]
16
+ **rosterShift** | [**Array<RosterShift>**](RosterShift.md) | | [optional] [default to undefined]
17
+ **saved** | **boolean** | | [optional] [default to undefined]
18
+ **updatedAt** | **string** | | [optional] [default to undefined]
19
+ **values** | **Array<string>** | | [optional] [default to undefined]
19
20
 
20
21
  ## Example
21
22
 
22
23
  ```typescript
23
- import { Roster } from "./api";
24
+ import { Roster } from './api';
24
25
 
25
26
  const instance: Roster = {
26
- createdAt,
27
- date,
28
- deletedAt,
29
- id,
30
- name,
31
- organ,
32
- organId,
33
- rosterAnswer,
34
- rosterShift,
35
- saved,
36
- updatedAt,
37
- values,
27
+ createdAt,
28
+ date,
29
+ deletedAt,
30
+ id,
31
+ name,
32
+ organ,
33
+ organId,
34
+ rosterAnswer,
35
+ rosterShift,
36
+ saved,
37
+ updatedAt,
38
+ values,
38
39
  };
39
40
  ```
40
41
 
@@ -1,32 +1,33 @@
1
1
  # RosterAnswer
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
- | **rosterShiftId** | **number** | | [optional] [default to undefined] |
12
- | **updatedAt** | **string** | | [optional] [default to undefined] |
13
- | **userId** | **number** | | [optional] [default to undefined] |
14
- | **value** | **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
+ **rosterId** | **number** | | [optional] [default to undefined]
12
+ **rosterShiftId** | **number** | | [optional] [default to undefined]
13
+ **updatedAt** | **string** | | [optional] [default to undefined]
14
+ **userId** | **number** | | [optional] [default to undefined]
15
+ **value** | **string** | | [optional] [default to undefined]
15
16
 
16
17
  ## Example
17
18
 
18
19
  ```typescript
19
- import { RosterAnswer } from "./api";
20
+ import { RosterAnswer } from './api';
20
21
 
21
22
  const instance: RosterAnswer = {
22
- createdAt,
23
- deletedAt,
24
- id,
25
- rosterId,
26
- rosterShiftId,
27
- updatedAt,
28
- userId,
29
- value,
23
+ createdAt,
24
+ deletedAt,
25
+ id,
26
+ rosterId,
27
+ rosterShiftId,
28
+ updatedAt,
29
+ userId,
30
+ value,
30
31
  };
31
32
  ```
32
33
 
@@ -1,38 +1,41 @@
1
1
  # RosterAnswerApi
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
- | [**createRosterAnswer**](#createrosteranswer) | **POST** /roster/answer | Create a new roster shift answer |
8
- | [**updateRosterAnswer**](#updaterosteranswer) | **PATCH** /roster/answer/{id} | Updates a roster answer with the new value |
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createRosterAnswer**](#createrosteranswer) | **POST** /roster/answer | Create a new roster shift answer|
8
+ |[**updateRosterAnswer**](#updaterosteranswer) | **PATCH** /roster/answer/{id} | Updates a roster answer with the new value|
9
9
 
10
10
  # **createRosterAnswer**
11
-
12
11
  > RosterAnswer createRosterAnswer(createParams)
13
12
 
13
+
14
14
  ### Example
15
15
 
16
16
  ```typescript
17
17
  import {
18
- RosterAnswerApi,
19
- Configuration,
20
- RosterAnswerCreateRequest,
21
- } from "./api";
18
+ RosterAnswerApi,
19
+ Configuration,
20
+ RosterAnswerCreateRequest
21
+ } from './api';
22
22
 
23
23
  const configuration = new Configuration();
24
24
  const apiInstance = new RosterAnswerApi(configuration);
25
25
 
26
26
  let createParams: RosterAnswerCreateRequest; //Roster answer input
27
27
 
28
- const { status, data } = await apiInstance.createRosterAnswer(createParams);
28
+ const { status, data } = await apiInstance.createRosterAnswer(
29
+ createParams
30
+ );
29
31
  ```
30
32
 
31
33
  ### Parameters
32
34
 
33
- | Name | Type | Description | Notes |
34
- | ---------------- | ----------------------------- | ------------------- | ----- |
35
- | **createParams** | **RosterAnswerCreateRequest** | Roster answer input | |
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **createParams** | **RosterAnswerCreateRequest**| Roster answer input | |
38
+
36
39
 
37
40
  ### Return type
38
41
 
@@ -44,30 +47,30 @@ const { status, data } = await apiInstance.createRosterAnswer(createParams);
44
47
 
45
48
  ### HTTP request headers
46
49
 
47
- - **Content-Type**: application/json
48
- - **Accept**: application/json
50
+ - **Content-Type**: application/json
51
+ - **Accept**: application/json
49
52
 
50
- ### HTTP response details
51
53
 
54
+ ### HTTP response details
52
55
  | Status code | Description | Response headers |
53
- | ----------- | ----------- | ---------------- |
54
- | **200** | OK | - |
55
- | **400** | Bad Request | - |
56
+ |-------------|-------------|------------------|
57
+ |**200** | OK | - |
58
+ |**400** | Bad Request | - |
56
59
 
57
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)
58
61
 
59
62
  # **updateRosterAnswer**
60
-
61
63
  > RosterAnswer updateRosterAnswer(updateParams)
62
64
 
65
+
63
66
  ### Example
64
67
 
65
68
  ```typescript
66
69
  import {
67
- RosterAnswerApi,
68
- Configuration,
69
- RosterAnswerUpdateRequest,
70
- } from "./api";
70
+ RosterAnswerApi,
71
+ Configuration,
72
+ RosterAnswerUpdateRequest
73
+ } from './api';
71
74
 
72
75
  const configuration = new Configuration();
73
76
  const apiInstance = new RosterAnswerApi(configuration);
@@ -75,15 +78,19 @@ const apiInstance = new RosterAnswerApi(configuration);
75
78
  let id: number; //Roster Answer ID (default to undefined)
76
79
  let updateParams: RosterAnswerUpdateRequest; //New answer value
77
80
 
78
- const { status, data } = await apiInstance.updateRosterAnswer(id, updateParams);
81
+ const { status, data } = await apiInstance.updateRosterAnswer(
82
+ id,
83
+ updateParams
84
+ );
79
85
  ```
80
86
 
81
87
  ### Parameters
82
88
 
83
- | Name | Type | Description | Notes |
84
- | ---------------- | ----------------------------- | ---------------- | --------------------- |
85
- | **updateParams** | **RosterAnswerUpdateRequest** | New answer value | |
86
- | **id** | [**number**] | Roster Answer ID | defaults to undefined |
89
+ |Name | Type | Description | Notes|
90
+ |------------- | ------------- | ------------- | -------------|
91
+ | **updateParams** | **RosterAnswerUpdateRequest**| New answer value | |
92
+ | **id** | [**number**] | Roster Answer ID | defaults to undefined|
93
+
87
94
 
88
95
  ### Return type
89
96
 
@@ -95,15 +102,16 @@ const { status, data } = await apiInstance.updateRosterAnswer(id, updateParams);
95
102
 
96
103
  ### HTTP request headers
97
104
 
98
- - **Content-Type**: application/json
99
- - **Accept**: application/json
105
+ - **Content-Type**: application/json
106
+ - **Accept**: application/json
100
107
 
101
- ### HTTP response details
102
108
 
109
+ ### HTTP response details
103
110
  | Status code | Description | Response headers |
104
- | ----------- | ----------- | ---------------- |
105
- | **200** | OK | - |
106
- | **400** | Bad Request | - |
107
- | **404** | Not Found | - |
111
+ |-------------|-------------|------------------|
112
+ |**200** | OK | - |
113
+ |**400** | Bad Request | - |
114
+ |**404** | Not Found | - |
108
115
 
109
116
  [[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)
117
+
@@ -1,24 +1,25 @@
1
1
  # RosterAnswerCreateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ----------------- | ---------- | ----------- | --------------------------------- |
7
- | **rosterId** | **number** | | [optional] [default to undefined] |
8
- | **rosterShiftId** | **number** | | [optional] [default to undefined] |
9
- | **userId** | **number** | | [optional] [default to undefined] |
10
- | **value** | **string** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **rosterId** | **number** | | [optional] [default to undefined]
9
+ **rosterShiftId** | **number** | | [optional] [default to undefined]
10
+ **userId** | **number** | | [optional] [default to undefined]
11
+ **value** | **string** | | [optional] [default to undefined]
11
12
 
12
13
  ## Example
13
14
 
14
15
  ```typescript
15
- import { RosterAnswerCreateRequest } from "./api";
16
+ import { RosterAnswerCreateRequest } from './api';
16
17
 
17
18
  const instance: RosterAnswerCreateRequest = {
18
- rosterId,
19
- rosterShiftId,
20
- userId,
21
- value,
19
+ rosterId,
20
+ rosterShiftId,
21
+ userId,
22
+ value,
22
23
  };
23
24
  ```
24
25
 
@@ -1,18 +1,19 @@
1
1
  # RosterAnswerUpdateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | --------- | ---------- | ----------- | --------------------------------- |
7
- | **value** | **string** | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **value** | **string** | | [optional] [default to undefined]
8
9
 
9
10
  ## Example
10
11
 
11
12
  ```typescript
12
- import { RosterAnswerUpdateRequest } from "./api";
13
+ import { RosterAnswerUpdateRequest } from './api';
13
14
 
14
15
  const instance: RosterAnswerUpdateRequest = {
15
- value,
16
+ value,
16
17
  };
17
18
  ```
18
19