@teemill/projects 1.58.0 → 1.59.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 +5 -2
- package/api.ts +161 -71
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +62 -6
- package/dist/api.js +129 -2
- 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 +62 -6
- package/dist/esm/api.js +128 -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/GenerateBrandContextRequest.md +22 -0
- package/docs/GenerateBrandContextRequestReferenceFileRefsInner.md +24 -0
- package/docs/ProjectUser.md +0 -2
- package/docs/ProjectsApi.md +60 -0
- package/docs/UpdateUserRequest.md +0 -2
- package/index.ts +1 -1
- package/package.json +1 -1
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,22 @@
|
|
|
1
|
+
# GenerateBrandContextRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**mainSiteUrl** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**referenceFileRefs** | [**Array<GenerateBrandContextRequestReferenceFileRefsInner>**](GenerateBrandContextRequestReferenceFileRefsInner.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GenerateBrandContextRequest } from '@teemill/projects';
|
|
15
|
+
|
|
16
|
+
const instance: GenerateBrandContextRequest = {
|
|
17
|
+
mainSiteUrl,
|
|
18
|
+
referenceFileRefs,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GenerateBrandContextRequestReferenceFileRefsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**driveSrc** | **string** | | [default to undefined]
|
|
9
|
+
**src** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**type** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GenerateBrandContextRequestReferenceFileRefsInner } from '@teemill/projects';
|
|
16
|
+
|
|
17
|
+
const instance: GenerateBrandContextRequestReferenceFileRefsInner = {
|
|
18
|
+
driveSrc,
|
|
19
|
+
src,
|
|
20
|
+
type,
|
|
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/ProjectUser.md
CHANGED
|
@@ -14,7 +14,6 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**email** | **string** | | [default to undefined]
|
|
15
15
|
**avatar** | [**ProjectUserAvatar**](ProjectUserAvatar.md) | | [default to undefined]
|
|
16
16
|
**twoFactorAuthentication** | [**TwoFactorAuthentication**](TwoFactorAuthentication.md) | | [default to undefined]
|
|
17
|
-
**providesSupport** | **boolean** | Whether the user provides support for the project | [optional] [default to undefined]
|
|
18
17
|
**lastAccessed** | **string** | | [optional] [default to undefined]
|
|
19
18
|
**createdAt** | **string** | | [default to undefined]
|
|
20
19
|
|
|
@@ -33,7 +32,6 @@ const instance: ProjectUser = {
|
|
|
33
32
|
email,
|
|
34
33
|
avatar,
|
|
35
34
|
twoFactorAuthentication,
|
|
36
|
-
providesSupport,
|
|
37
35
|
lastAccessed,
|
|
38
36
|
createdAt,
|
|
39
37
|
};
|
package/docs/ProjectsApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
21
21
|
|[**deleteUserGroup**](#deleteusergroup) | **DELETE** /v1/projects/{project}/user-groups/{userGroup} | Delete group|
|
|
22
22
|
|[**exportOkrs**](#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs|
|
|
23
23
|
|[**exportTasks**](#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks|
|
|
24
|
+
|[**generateBrandContext**](#generatebrandcontext) | **POST** /v1/projects/{project}/brand-context/generate | Generate or update brand context|
|
|
24
25
|
|[**getAuth**](#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens|
|
|
25
26
|
|[**getClients**](#getclients) | **GET** /v1/projects/{project}/users/{user}/clients | List clients|
|
|
26
27
|
|[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
|
|
@@ -1033,6 +1034,65 @@ const { status, data } = await apiInstance.exportTasks(
|
|
|
1033
1034
|
|
|
1034
1035
|
[[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)
|
|
1035
1036
|
|
|
1037
|
+
# **generateBrandContext**
|
|
1038
|
+
> Integration generateBrandContext()
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
### Example
|
|
1042
|
+
|
|
1043
|
+
```typescript
|
|
1044
|
+
import {
|
|
1045
|
+
ProjectsApi,
|
|
1046
|
+
Configuration,
|
|
1047
|
+
GenerateBrandContextRequest
|
|
1048
|
+
} from '@teemill/projects';
|
|
1049
|
+
|
|
1050
|
+
const configuration = new Configuration();
|
|
1051
|
+
const apiInstance = new ProjectsApi(configuration);
|
|
1052
|
+
|
|
1053
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
1054
|
+
let generateBrandContextRequest: GenerateBrandContextRequest; //Request body to generate or update brand context (optional)
|
|
1055
|
+
|
|
1056
|
+
const { status, data } = await apiInstance.generateBrandContext(
|
|
1057
|
+
project,
|
|
1058
|
+
generateBrandContextRequest
|
|
1059
|
+
);
|
|
1060
|
+
```
|
|
1061
|
+
|
|
1062
|
+
### Parameters
|
|
1063
|
+
|
|
1064
|
+
|Name | Type | Description | Notes|
|
|
1065
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1066
|
+
| **generateBrandContextRequest** | **GenerateBrandContextRequest**| Request body to generate or update brand context | |
|
|
1067
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
### Return type
|
|
1071
|
+
|
|
1072
|
+
**Integration**
|
|
1073
|
+
|
|
1074
|
+
### Authorization
|
|
1075
|
+
|
|
1076
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
1077
|
+
|
|
1078
|
+
### HTTP request headers
|
|
1079
|
+
|
|
1080
|
+
- **Content-Type**: application/json
|
|
1081
|
+
- **Accept**: application/json
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
### HTTP response details
|
|
1085
|
+
| Status code | Description | Response headers |
|
|
1086
|
+
|-------------|-------------|------------------|
|
|
1087
|
+
|**200** | Successfully retrieved a integration | - |
|
|
1088
|
+
|**400** | Failed validation | - |
|
|
1089
|
+
|**401** | Not authorised to access this resource | - |
|
|
1090
|
+
|**403** | Refuse to authorize | - |
|
|
1091
|
+
|**404** | Resource not found | - |
|
|
1092
|
+
|**500** | Unknown server error | - |
|
|
1093
|
+
|
|
1094
|
+
[[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)
|
|
1095
|
+
|
|
1036
1096
|
# **getAuth**
|
|
1037
1097
|
> AuthResponse getAuth()
|
|
1038
1098
|
|
|
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**lastName** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**username** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**avatar** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**providesSupport** | **boolean** | | [optional] [default to undefined]
|
|
13
12
|
|
|
14
13
|
## Example
|
|
15
14
|
|
|
@@ -21,7 +20,6 @@ const instance: UpdateUserRequest = {
|
|
|
21
20
|
lastName,
|
|
22
21
|
username,
|
|
23
22
|
avatar,
|
|
24
|
-
providesSupport,
|
|
25
23
|
};
|
|
26
24
|
```
|
|
27
25
|
|
package/index.ts
CHANGED