@teemill/projects 1.42.0 → 1.44.0
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.
- package/README.md +6 -2
- package/api.ts +245 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +147 -1
- package/dist/api.js +154 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +147 -1
- package/dist/esm/api.js +154 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/OkrSummary.md +24 -0
- package/docs/ProjectsApi.md +119 -0
- package/docs/UpdateUserRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Projects API
|
|
5
5
|
* Manage PodOS Projects
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.44.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -742,6 +742,40 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
742
742
|
options: localVarRequestOptions,
|
|
743
743
|
};
|
|
744
744
|
}),
|
|
745
|
+
/**
|
|
746
|
+
* Get the AI-generated OKR summary for the project
|
|
747
|
+
* @summary Get OKR summary
|
|
748
|
+
* @param {string} project Projects unique identifier
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
getOkrSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
753
|
+
// verify required parameter 'project' is not null or undefined
|
|
754
|
+
assertParamExists('getOkrSummary', 'project', project);
|
|
755
|
+
const localVarPath = `/v1/projects/{project}/okrs/summary`
|
|
756
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
757
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
758
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
759
|
+
let baseOptions;
|
|
760
|
+
if (configuration) {
|
|
761
|
+
baseOptions = configuration.baseOptions;
|
|
762
|
+
}
|
|
763
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
764
|
+
const localVarHeaderParameter = {};
|
|
765
|
+
const localVarQueryParameter = {};
|
|
766
|
+
// authentication session-oauth required
|
|
767
|
+
// oauth required
|
|
768
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
769
|
+
// authentication api-key required
|
|
770
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
771
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
772
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
773
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
774
|
+
return {
|
|
775
|
+
url: toPathString(localVarUrlObj),
|
|
776
|
+
options: localVarRequestOptions,
|
|
777
|
+
};
|
|
778
|
+
}),
|
|
745
779
|
/**
|
|
746
780
|
* Get a project
|
|
747
781
|
* @summary Get project
|
|
@@ -1435,6 +1469,49 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
1435
1469
|
options: localVarRequestOptions,
|
|
1436
1470
|
};
|
|
1437
1471
|
}),
|
|
1472
|
+
/**
|
|
1473
|
+
* Update a project user
|
|
1474
|
+
* @summary Update a user
|
|
1475
|
+
* @param {string} project Projects unique identifier
|
|
1476
|
+
* @param {string} user the unique id of the user
|
|
1477
|
+
* @param {UpdateUserRequest} updateUserRequest Updated project user data
|
|
1478
|
+
* @param {*} [options] Override http request option.
|
|
1479
|
+
* @throws {RequiredError}
|
|
1480
|
+
*/
|
|
1481
|
+
updateUser: (project_1, user_1, updateUserRequest_1, ...args_1) => __awaiter(this, [project_1, user_1, updateUserRequest_1, ...args_1], void 0, function* (project, user, updateUserRequest, options = {}) {
|
|
1482
|
+
// verify required parameter 'project' is not null or undefined
|
|
1483
|
+
assertParamExists('updateUser', 'project', project);
|
|
1484
|
+
// verify required parameter 'user' is not null or undefined
|
|
1485
|
+
assertParamExists('updateUser', 'user', user);
|
|
1486
|
+
// verify required parameter 'updateUserRequest' is not null or undefined
|
|
1487
|
+
assertParamExists('updateUser', 'updateUserRequest', updateUserRequest);
|
|
1488
|
+
const localVarPath = `/v1/projects/{project}/users/{user}`
|
|
1489
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)))
|
|
1490
|
+
.replace(`{${"user"}}`, encodeURIComponent(String(user)));
|
|
1491
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1492
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1493
|
+
let baseOptions;
|
|
1494
|
+
if (configuration) {
|
|
1495
|
+
baseOptions = configuration.baseOptions;
|
|
1496
|
+
}
|
|
1497
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
1498
|
+
const localVarHeaderParameter = {};
|
|
1499
|
+
const localVarQueryParameter = {};
|
|
1500
|
+
// authentication session-oauth required
|
|
1501
|
+
// oauth required
|
|
1502
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1503
|
+
// authentication api-key required
|
|
1504
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1505
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1506
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1507
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1508
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1509
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateUserRequest, localVarRequestOptions, configuration);
|
|
1510
|
+
return {
|
|
1511
|
+
url: toPathString(localVarUrlObj),
|
|
1512
|
+
options: localVarRequestOptions,
|
|
1513
|
+
};
|
|
1514
|
+
}),
|
|
1438
1515
|
};
|
|
1439
1516
|
};
|
|
1440
1517
|
/**
|
|
@@ -1746,6 +1823,22 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
1746
1823
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1747
1824
|
});
|
|
1748
1825
|
},
|
|
1826
|
+
/**
|
|
1827
|
+
* Get the AI-generated OKR summary for the project
|
|
1828
|
+
* @summary Get OKR summary
|
|
1829
|
+
* @param {string} project Projects unique identifier
|
|
1830
|
+
* @param {*} [options] Override http request option.
|
|
1831
|
+
* @throws {RequiredError}
|
|
1832
|
+
*/
|
|
1833
|
+
getOkrSummary(project, options) {
|
|
1834
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1835
|
+
var _a, _b, _c;
|
|
1836
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOkrSummary(project, options);
|
|
1837
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1838
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProjectsApi.getOkrSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1839
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1840
|
+
});
|
|
1841
|
+
},
|
|
1749
1842
|
/**
|
|
1750
1843
|
* Get a project
|
|
1751
1844
|
* @summary Get project
|
|
@@ -2053,6 +2146,24 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
2053
2146
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2054
2147
|
});
|
|
2055
2148
|
},
|
|
2149
|
+
/**
|
|
2150
|
+
* Update a project user
|
|
2151
|
+
* @summary Update a user
|
|
2152
|
+
* @param {string} project Projects unique identifier
|
|
2153
|
+
* @param {string} user the unique id of the user
|
|
2154
|
+
* @param {UpdateUserRequest} updateUserRequest Updated project user data
|
|
2155
|
+
* @param {*} [options] Override http request option.
|
|
2156
|
+
* @throws {RequiredError}
|
|
2157
|
+
*/
|
|
2158
|
+
updateUser(project, user, updateUserRequest, options) {
|
|
2159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2160
|
+
var _a, _b, _c;
|
|
2161
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateUser(project, user, updateUserRequest, options);
|
|
2162
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2163
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProjectsApi.updateUser']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2164
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2165
|
+
});
|
|
2166
|
+
},
|
|
2056
2167
|
};
|
|
2057
2168
|
};
|
|
2058
2169
|
/**
|
|
@@ -2242,6 +2353,16 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2242
2353
|
getInvites(requestParameters, options) {
|
|
2243
2354
|
return localVarFp.getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
2244
2355
|
},
|
|
2356
|
+
/**
|
|
2357
|
+
* Get the AI-generated OKR summary for the project
|
|
2358
|
+
* @summary Get OKR summary
|
|
2359
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2360
|
+
* @param {*} [options] Override http request option.
|
|
2361
|
+
* @throws {RequiredError}
|
|
2362
|
+
*/
|
|
2363
|
+
getOkrSummary(requestParameters, options) {
|
|
2364
|
+
return localVarFp.getOkrSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2365
|
+
},
|
|
2245
2366
|
/**
|
|
2246
2367
|
* Get a project
|
|
2247
2368
|
* @summary Get project
|
|
@@ -2422,6 +2543,16 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2422
2543
|
updateTask(requestParameters, options) {
|
|
2423
2544
|
return localVarFp.updateTask(requestParameters.project, requestParameters.id, requestParameters.updateTaskRequest, options).then((request) => request(axios, basePath));
|
|
2424
2545
|
},
|
|
2546
|
+
/**
|
|
2547
|
+
* Update a project user
|
|
2548
|
+
* @summary Update a user
|
|
2549
|
+
* @param {ProjectsApiUpdateUserRequest} requestParameters Request parameters.
|
|
2550
|
+
* @param {*} [options] Override http request option.
|
|
2551
|
+
* @throws {RequiredError}
|
|
2552
|
+
*/
|
|
2553
|
+
updateUser(requestParameters, options) {
|
|
2554
|
+
return localVarFp.updateUser(requestParameters.project, requestParameters.user, requestParameters.updateUserRequest, options).then((request) => request(axios, basePath));
|
|
2555
|
+
},
|
|
2425
2556
|
};
|
|
2426
2557
|
};
|
|
2427
2558
|
/**
|
|
@@ -2629,6 +2760,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
2629
2760
|
getInvites(requestParameters, options) {
|
|
2630
2761
|
return ProjectsApiFp(this.configuration).getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
2631
2762
|
}
|
|
2763
|
+
/**
|
|
2764
|
+
* Get the AI-generated OKR summary for the project
|
|
2765
|
+
* @summary Get OKR summary
|
|
2766
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2767
|
+
* @param {*} [options] Override http request option.
|
|
2768
|
+
* @throws {RequiredError}
|
|
2769
|
+
* @memberof ProjectsApi
|
|
2770
|
+
*/
|
|
2771
|
+
getOkrSummary(requestParameters, options) {
|
|
2772
|
+
return ProjectsApiFp(this.configuration).getOkrSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2773
|
+
}
|
|
2632
2774
|
/**
|
|
2633
2775
|
* Get a project
|
|
2634
2776
|
* @summary Get project
|
|
@@ -2827,4 +2969,15 @@ export class ProjectsApi extends BaseAPI {
|
|
|
2827
2969
|
updateTask(requestParameters, options) {
|
|
2828
2970
|
return ProjectsApiFp(this.configuration).updateTask(requestParameters.project, requestParameters.id, requestParameters.updateTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2829
2971
|
}
|
|
2972
|
+
/**
|
|
2973
|
+
* Update a project user
|
|
2974
|
+
* @summary Update a user
|
|
2975
|
+
* @param {ProjectsApiUpdateUserRequest} requestParameters Request parameters.
|
|
2976
|
+
* @param {*} [options] Override http request option.
|
|
2977
|
+
* @throws {RequiredError}
|
|
2978
|
+
* @memberof ProjectsApi
|
|
2979
|
+
*/
|
|
2980
|
+
updateUser(requestParameters, options) {
|
|
2981
|
+
return ProjectsApiFp(this.configuration).updateUser(requestParameters.project, requestParameters.user, requestParameters.updateUserRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2982
|
+
}
|
|
2830
2983
|
}
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# OkrSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**content** | **string** | | [default to undefined]
|
|
10
|
+
**createdAt** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OkrSummary } from '@teemill/projects';
|
|
16
|
+
|
|
17
|
+
const instance: OkrSummary = {
|
|
18
|
+
id,
|
|
19
|
+
content,
|
|
20
|
+
createdAt,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ProjectsApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
22
22
|
|[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
|
|
23
23
|
|[**getIntegrations**](#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations|
|
|
24
24
|
|[**getInvites**](#getinvites) | **GET** /v1/projects/{project}/invites | List Invites|
|
|
25
|
+
|[**getOkrSummary**](#getokrsummary) | **GET** /v1/projects/{project}/okrs/summary | Get OKR summary|
|
|
25
26
|
|[**getProject**](#getproject) | **GET** /v1/projects/{project} | Get project|
|
|
26
27
|
|[**getProjects**](#getprojects) | **GET** /v1/projects | List projects|
|
|
27
28
|
|[**getTask**](#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task|
|
|
@@ -40,6 +41,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
40
41
|
|[**updateIntegration**](#updateintegration) | **PATCH** /v1/projects/{project}/integrations/{integration} | Update integration|
|
|
41
42
|
|[**updateProject**](#updateproject) | **PATCH** /v1/projects/{project} | Update project|
|
|
42
43
|
|[**updateTask**](#updatetask) | **PATCH** /v1/projects/{project}/tasks/{id} | Update Task|
|
|
44
|
+
|[**updateUser**](#updateuser) | **PATCH** /v1/projects/{project}/users/{user} | Update a user|
|
|
43
45
|
|
|
44
46
|
# **bulkUpdateTasks**
|
|
45
47
|
> ListTasksResponse bulkUpdateTasks(bulkUpdateTasksRequest)
|
|
@@ -1081,6 +1083,60 @@ const { status, data } = await apiInstance.getInvites(
|
|
|
1081
1083
|
|
|
1082
1084
|
[[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)
|
|
1083
1085
|
|
|
1086
|
+
# **getOkrSummary**
|
|
1087
|
+
> OkrSummary getOkrSummary()
|
|
1088
|
+
|
|
1089
|
+
Get the AI-generated OKR summary for the project
|
|
1090
|
+
|
|
1091
|
+
### Example
|
|
1092
|
+
|
|
1093
|
+
```typescript
|
|
1094
|
+
import {
|
|
1095
|
+
ProjectsApi,
|
|
1096
|
+
Configuration
|
|
1097
|
+
} from '@teemill/projects';
|
|
1098
|
+
|
|
1099
|
+
const configuration = new Configuration();
|
|
1100
|
+
const apiInstance = new ProjectsApi(configuration);
|
|
1101
|
+
|
|
1102
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
1103
|
+
|
|
1104
|
+
const { status, data } = await apiInstance.getOkrSummary(
|
|
1105
|
+
project
|
|
1106
|
+
);
|
|
1107
|
+
```
|
|
1108
|
+
|
|
1109
|
+
### Parameters
|
|
1110
|
+
|
|
1111
|
+
|Name | Type | Description | Notes|
|
|
1112
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1113
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
### Return type
|
|
1117
|
+
|
|
1118
|
+
**OkrSummary**
|
|
1119
|
+
|
|
1120
|
+
### Authorization
|
|
1121
|
+
|
|
1122
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
1123
|
+
|
|
1124
|
+
### HTTP request headers
|
|
1125
|
+
|
|
1126
|
+
- **Content-Type**: Not defined
|
|
1127
|
+
- **Accept**: application/json
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
### HTTP response details
|
|
1131
|
+
| Status code | Description | Response headers |
|
|
1132
|
+
|-------------|-------------|------------------|
|
|
1133
|
+
|**200** | A summary of the project\'s OKR progress. | - |
|
|
1134
|
+
|**401** | Not authorised to access this resource | - |
|
|
1135
|
+
|**403** | Refuse to authorize | - |
|
|
1136
|
+
|**500** | Unknown server error | - |
|
|
1137
|
+
|
|
1138
|
+
[[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)
|
|
1139
|
+
|
|
1084
1140
|
# **getProject**
|
|
1085
1141
|
> Project getProject()
|
|
1086
1142
|
|
|
@@ -2138,3 +2194,66 @@ const { status, data } = await apiInstance.updateTask(
|
|
|
2138
2194
|
|
|
2139
2195
|
[[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)
|
|
2140
2196
|
|
|
2197
|
+
# **updateUser**
|
|
2198
|
+
> ProjectUser updateUser(updateUserRequest)
|
|
2199
|
+
|
|
2200
|
+
Update a project user
|
|
2201
|
+
|
|
2202
|
+
### Example
|
|
2203
|
+
|
|
2204
|
+
```typescript
|
|
2205
|
+
import {
|
|
2206
|
+
ProjectsApi,
|
|
2207
|
+
Configuration,
|
|
2208
|
+
UpdateUserRequest
|
|
2209
|
+
} from '@teemill/projects';
|
|
2210
|
+
|
|
2211
|
+
const configuration = new Configuration();
|
|
2212
|
+
const apiInstance = new ProjectsApi(configuration);
|
|
2213
|
+
|
|
2214
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
2215
|
+
let user: string; //the unique id of the user (default to undefined)
|
|
2216
|
+
let updateUserRequest: UpdateUserRequest; //Updated project user data
|
|
2217
|
+
|
|
2218
|
+
const { status, data } = await apiInstance.updateUser(
|
|
2219
|
+
project,
|
|
2220
|
+
user,
|
|
2221
|
+
updateUserRequest
|
|
2222
|
+
);
|
|
2223
|
+
```
|
|
2224
|
+
|
|
2225
|
+
### Parameters
|
|
2226
|
+
|
|
2227
|
+
|Name | Type | Description | Notes|
|
|
2228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2229
|
+
| **updateUserRequest** | **UpdateUserRequest**| Updated project user data | |
|
|
2230
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
2231
|
+
| **user** | [**string**] | the unique id of the user | defaults to undefined|
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
### Return type
|
|
2235
|
+
|
|
2236
|
+
**ProjectUser**
|
|
2237
|
+
|
|
2238
|
+
### Authorization
|
|
2239
|
+
|
|
2240
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
2241
|
+
|
|
2242
|
+
### HTTP request headers
|
|
2243
|
+
|
|
2244
|
+
- **Content-Type**: application/json
|
|
2245
|
+
- **Accept**: application/json
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
### HTTP response details
|
|
2249
|
+
| Status code | Description | Response headers |
|
|
2250
|
+
|-------------|-------------|------------------|
|
|
2251
|
+
|**200** | Successfully retrieved a project user | - |
|
|
2252
|
+
|**400** | Failed validation | - |
|
|
2253
|
+
|**401** | Not authorised to access this resource | - |
|
|
2254
|
+
|**403** | Refuse to authorize | - |
|
|
2255
|
+
|**404** | Resource not found | - |
|
|
2256
|
+
|**500** | Unknown server error | - |
|
|
2257
|
+
|
|
2258
|
+
[[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)
|
|
2259
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateUserRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**providesSupport** | **boolean** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateUserRequest } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateUserRequest = {
|
|
16
|
+
providesSupport,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED