@teemill/projects 1.58.1 → 1.59.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.
- package/README.md +5 -2
- package/api.ts +103 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +55 -1
- package/dist/api.js +76 -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 +55 -1
- package/dist/esm/api.js +76 -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 +20 -0
- package/docs/GenerateBrandContextRequestReferenceFileRefsInner.md +24 -0
- package/docs/GenerateBrandContextResponse.md +22 -0
- package/docs/ProjectsApi.md +60 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/projects@1.
|
|
1
|
+
## @teemill/projects@1.59.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/projects@1.
|
|
39
|
+
npm install @teemill/projects@1.59.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -68,6 +68,7 @@ Class | Method | HTTP request | Description
|
|
|
68
68
|
*ProjectsApi* | [**deleteUserGroup**](docs/ProjectsApi.md#deleteusergroup) | **DELETE** /v1/projects/{project}/user-groups/{userGroup} | Delete group
|
|
69
69
|
*ProjectsApi* | [**exportOkrs**](docs/ProjectsApi.md#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs
|
|
70
70
|
*ProjectsApi* | [**exportTasks**](docs/ProjectsApi.md#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks
|
|
71
|
+
*ProjectsApi* | [**generateBrandContext**](docs/ProjectsApi.md#generatebrandcontext) | **POST** /v1/projects/{project}/brand-context/generate | Generate or update brand context
|
|
71
72
|
*ProjectsApi* | [**getAuth**](docs/ProjectsApi.md#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens
|
|
72
73
|
*ProjectsApi* | [**getClients**](docs/ProjectsApi.md#getclients) | **GET** /v1/projects/{project}/users/{user}/clients | List clients
|
|
73
74
|
*ProjectsApi* | [**getIntegration**](docs/ProjectsApi.md#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration
|
|
@@ -124,6 +125,8 @@ Class | Method | HTTP request | Description
|
|
|
124
125
|
- [CreateTaskRequestSource](docs/CreateTaskRequestSource.md)
|
|
125
126
|
- [CreateUserGroupRequest](docs/CreateUserGroupRequest.md)
|
|
126
127
|
- [ExportTasks202Response](docs/ExportTasks202Response.md)
|
|
128
|
+
- [GenerateBrandContextRequest](docs/GenerateBrandContextRequest.md)
|
|
129
|
+
- [GenerateBrandContextResponse](docs/GenerateBrandContextResponse.md)
|
|
127
130
|
- [GetClients200Response](docs/GetClients200Response.md)
|
|
128
131
|
- [GetLogs200Response](docs/GetLogs200Response.md)
|
|
129
132
|
- [Icon](docs/Icon.md)
|
package/api.ts
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.59.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -18,7 +18,7 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
18
18
|
import globalAxios from 'axios';
|
|
19
19
|
// Some imports not used depending on template conditions
|
|
20
20
|
// @ts-ignore
|
|
21
|
-
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from './common';
|
|
22
22
|
import type { RequestArgs } from './base';
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
|
|
@@ -140,6 +140,13 @@ export interface ExportTasks202Response {
|
|
|
140
140
|
*/
|
|
141
141
|
'message'?: string;
|
|
142
142
|
}
|
|
143
|
+
export interface GenerateBrandContextRequest {
|
|
144
|
+
'mainSiteUrl'?: string | null;
|
|
145
|
+
}
|
|
146
|
+
export interface GenerateBrandContextResponse {
|
|
147
|
+
'message': string;
|
|
148
|
+
'generationId': string;
|
|
149
|
+
}
|
|
143
150
|
export interface GetClients200Response {
|
|
144
151
|
'clients': Array<UserClient>;
|
|
145
152
|
}
|
|
@@ -1280,6 +1287,50 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1280
1287
|
options: localVarRequestOptions,
|
|
1281
1288
|
};
|
|
1282
1289
|
},
|
|
1290
|
+
/**
|
|
1291
|
+
*
|
|
1292
|
+
* @summary Generate or update brand context
|
|
1293
|
+
* @param {string} project Projects unique identifier
|
|
1294
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
generateBrandContext: async (project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1299
|
+
// verify required parameter 'project' is not null or undefined
|
|
1300
|
+
assertParamExists('generateBrandContext', 'project', project)
|
|
1301
|
+
const localVarPath = `/v1/projects/{project}/brand-context/generate`
|
|
1302
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
1303
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1304
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1305
|
+
let baseOptions;
|
|
1306
|
+
if (configuration) {
|
|
1307
|
+
baseOptions = configuration.baseOptions;
|
|
1308
|
+
}
|
|
1309
|
+
|
|
1310
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1311
|
+
const localVarHeaderParameter = {} as any;
|
|
1312
|
+
const localVarQueryParameter = {} as any;
|
|
1313
|
+
|
|
1314
|
+
// authentication session-oauth required
|
|
1315
|
+
// oauth required
|
|
1316
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1317
|
+
|
|
1318
|
+
// authentication api-key required
|
|
1319
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1320
|
+
|
|
1321
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1322
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1323
|
+
|
|
1324
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1325
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1326
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1327
|
+
localVarRequestOptions.data = serializeDataIfNeeded(generateBrandContextRequest, localVarRequestOptions, configuration)
|
|
1328
|
+
|
|
1329
|
+
return {
|
|
1330
|
+
url: toPathString(localVarUrlObj),
|
|
1331
|
+
options: localVarRequestOptions,
|
|
1332
|
+
};
|
|
1333
|
+
},
|
|
1283
1334
|
/**
|
|
1284
1335
|
* Lists the auth tokens for the project
|
|
1285
1336
|
* @summary List auth tokens
|
|
@@ -2939,6 +2990,20 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
2939
2990
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.exportTasks']?.[localVarOperationServerIndex]?.url;
|
|
2940
2991
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2941
2992
|
},
|
|
2993
|
+
/**
|
|
2994
|
+
*
|
|
2995
|
+
* @summary Generate or update brand context
|
|
2996
|
+
* @param {string} project Projects unique identifier
|
|
2997
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
2998
|
+
* @param {*} [options] Override http request option.
|
|
2999
|
+
* @throws {RequiredError}
|
|
3000
|
+
*/
|
|
3001
|
+
async generateBrandContext(project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateBrandContextResponse>> {
|
|
3002
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateBrandContext(project, generateBrandContextRequest, options);
|
|
3003
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3004
|
+
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.generateBrandContext']?.[localVarOperationServerIndex]?.url;
|
|
3005
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3006
|
+
},
|
|
2942
3007
|
/**
|
|
2943
3008
|
* Lists the auth tokens for the project
|
|
2944
3009
|
* @summary List auth tokens
|
|
@@ -3554,6 +3619,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3554
3619
|
exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3555
3620
|
return localVarFp.exportTasks(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3556
3621
|
},
|
|
3622
|
+
/**
|
|
3623
|
+
*
|
|
3624
|
+
* @summary Generate or update brand context
|
|
3625
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
3626
|
+
* @param {*} [options] Override http request option.
|
|
3627
|
+
* @throws {RequiredError}
|
|
3628
|
+
*/
|
|
3629
|
+
generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateBrandContextResponse> {
|
|
3630
|
+
return localVarFp.generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(axios, basePath));
|
|
3631
|
+
},
|
|
3557
3632
|
/**
|
|
3558
3633
|
* Lists the auth tokens for the project
|
|
3559
3634
|
* @summary List auth tokens
|
|
@@ -4097,6 +4172,21 @@ export interface ProjectsApiExportTasksRequest {
|
|
|
4097
4172
|
readonly project: string
|
|
4098
4173
|
}
|
|
4099
4174
|
|
|
4175
|
+
/**
|
|
4176
|
+
* Request parameters for generateBrandContext operation in ProjectsApi.
|
|
4177
|
+
*/
|
|
4178
|
+
export interface ProjectsApiGenerateBrandContextRequest {
|
|
4179
|
+
/**
|
|
4180
|
+
* Projects unique identifier
|
|
4181
|
+
*/
|
|
4182
|
+
readonly project: string
|
|
4183
|
+
|
|
4184
|
+
/**
|
|
4185
|
+
* Request body to generate or update brand context
|
|
4186
|
+
*/
|
|
4187
|
+
readonly generateBrandContextRequest?: GenerateBrandContextRequest
|
|
4188
|
+
}
|
|
4189
|
+
|
|
4100
4190
|
/**
|
|
4101
4191
|
* Request parameters for getAuth operation in ProjectsApi.
|
|
4102
4192
|
*/
|
|
@@ -4763,6 +4853,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
4763
4853
|
return ProjectsApiFp(this.configuration).exportTasks(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4764
4854
|
}
|
|
4765
4855
|
|
|
4856
|
+
/**
|
|
4857
|
+
*
|
|
4858
|
+
* @summary Generate or update brand context
|
|
4859
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
4860
|
+
* @param {*} [options] Override http request option.
|
|
4861
|
+
* @throws {RequiredError}
|
|
4862
|
+
*/
|
|
4863
|
+
public generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig) {
|
|
4864
|
+
return ProjectsApiFp(this.configuration).generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4865
|
+
}
|
|
4866
|
+
|
|
4766
4867
|
/**
|
|
4767
4868
|
* Lists the auth tokens for the project
|
|
4768
4869
|
* @summary List auth tokens
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Projects API
|
|
3
3
|
* Manage PodOS Projects
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.59.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -127,6 +127,13 @@ export interface ExportTasks202Response {
|
|
|
127
127
|
*/
|
|
128
128
|
'message'?: string;
|
|
129
129
|
}
|
|
130
|
+
export interface GenerateBrandContextRequest {
|
|
131
|
+
'mainSiteUrl'?: string | null;
|
|
132
|
+
}
|
|
133
|
+
export interface GenerateBrandContextResponse {
|
|
134
|
+
'message': string;
|
|
135
|
+
'generationId': string;
|
|
136
|
+
}
|
|
130
137
|
export interface GetClients200Response {
|
|
131
138
|
'clients': Array<UserClient>;
|
|
132
139
|
}
|
|
@@ -645,6 +652,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
645
652
|
* @throws {RequiredError}
|
|
646
653
|
*/
|
|
647
654
|
exportTasks: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
* @summary Generate or update brand context
|
|
658
|
+
* @param {string} project Projects unique identifier
|
|
659
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
generateBrandContext: (project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
648
664
|
/**
|
|
649
665
|
* Lists the auth tokens for the project
|
|
650
666
|
* @summary List auth tokens
|
|
@@ -1079,6 +1095,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1079
1095
|
* @throws {RequiredError}
|
|
1080
1096
|
*/
|
|
1081
1097
|
exportTasks(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1098
|
+
/**
|
|
1099
|
+
*
|
|
1100
|
+
* @summary Generate or update brand context
|
|
1101
|
+
* @param {string} project Projects unique identifier
|
|
1102
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
1103
|
+
* @param {*} [options] Override http request option.
|
|
1104
|
+
* @throws {RequiredError}
|
|
1105
|
+
*/
|
|
1106
|
+
generateBrandContext(project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateBrandContextResponse>>;
|
|
1082
1107
|
/**
|
|
1083
1108
|
* Lists the auth tokens for the project
|
|
1084
1109
|
* @summary List auth tokens
|
|
@@ -1501,6 +1526,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1501
1526
|
* @throws {RequiredError}
|
|
1502
1527
|
*/
|
|
1503
1528
|
exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1529
|
+
/**
|
|
1530
|
+
*
|
|
1531
|
+
* @summary Generate or update brand context
|
|
1532
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
1533
|
+
* @param {*} [options] Override http request option.
|
|
1534
|
+
* @throws {RequiredError}
|
|
1535
|
+
*/
|
|
1536
|
+
generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateBrandContextResponse>;
|
|
1504
1537
|
/**
|
|
1505
1538
|
* Lists the auth tokens for the project
|
|
1506
1539
|
* @summary List auth tokens
|
|
@@ -1951,6 +1984,19 @@ export interface ProjectsApiExportTasksRequest {
|
|
|
1951
1984
|
*/
|
|
1952
1985
|
readonly project: string;
|
|
1953
1986
|
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Request parameters for generateBrandContext operation in ProjectsApi.
|
|
1989
|
+
*/
|
|
1990
|
+
export interface ProjectsApiGenerateBrandContextRequest {
|
|
1991
|
+
/**
|
|
1992
|
+
* Projects unique identifier
|
|
1993
|
+
*/
|
|
1994
|
+
readonly project: string;
|
|
1995
|
+
/**
|
|
1996
|
+
* Request body to generate or update brand context
|
|
1997
|
+
*/
|
|
1998
|
+
readonly generateBrandContextRequest?: GenerateBrandContextRequest;
|
|
1999
|
+
}
|
|
1954
2000
|
/**
|
|
1955
2001
|
* Request parameters for getAuth operation in ProjectsApi.
|
|
1956
2002
|
*/
|
|
@@ -2502,6 +2548,14 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2502
2548
|
* @throws {RequiredError}
|
|
2503
2549
|
*/
|
|
2504
2550
|
exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2551
|
+
/**
|
|
2552
|
+
*
|
|
2553
|
+
* @summary Generate or update brand context
|
|
2554
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
2555
|
+
* @param {*} [options] Override http request option.
|
|
2556
|
+
* @throws {RequiredError}
|
|
2557
|
+
*/
|
|
2558
|
+
generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateBrandContextResponse, any, {}>>;
|
|
2505
2559
|
/**
|
|
2506
2560
|
* Lists the auth tokens for the project
|
|
2507
2561
|
* @summary List auth tokens
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Projects API
|
|
6
6
|
* Manage PodOS Projects
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.59.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -711,6 +711,44 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
711
711
|
options: localVarRequestOptions,
|
|
712
712
|
};
|
|
713
713
|
}),
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @summary Generate or update brand context
|
|
717
|
+
* @param {string} project Projects unique identifier
|
|
718
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
719
|
+
* @param {*} [options] Override http request option.
|
|
720
|
+
* @throws {RequiredError}
|
|
721
|
+
*/
|
|
722
|
+
generateBrandContext: (project_1, generateBrandContextRequest_1, ...args_1) => __awaiter(this, [project_1, generateBrandContextRequest_1, ...args_1], void 0, function* (project, generateBrandContextRequest, options = {}) {
|
|
723
|
+
// verify required parameter 'project' is not null or undefined
|
|
724
|
+
(0, common_1.assertParamExists)('generateBrandContext', 'project', project);
|
|
725
|
+
const localVarPath = `/v1/projects/{project}/brand-context/generate`
|
|
726
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
727
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
728
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
729
|
+
let baseOptions;
|
|
730
|
+
if (configuration) {
|
|
731
|
+
baseOptions = configuration.baseOptions;
|
|
732
|
+
}
|
|
733
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
734
|
+
const localVarHeaderParameter = {};
|
|
735
|
+
const localVarQueryParameter = {};
|
|
736
|
+
// authentication session-oauth required
|
|
737
|
+
// oauth required
|
|
738
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
739
|
+
// authentication api-key required
|
|
740
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
741
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
742
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
743
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
744
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
745
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
746
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateBrandContextRequest, localVarRequestOptions, configuration);
|
|
747
|
+
return {
|
|
748
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
749
|
+
options: localVarRequestOptions,
|
|
750
|
+
};
|
|
751
|
+
}),
|
|
714
752
|
/**
|
|
715
753
|
* Lists the auth tokens for the project
|
|
716
754
|
* @summary List auth tokens
|
|
@@ -2226,6 +2264,23 @@ const ProjectsApiFp = function (configuration) {
|
|
|
2226
2264
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2227
2265
|
});
|
|
2228
2266
|
},
|
|
2267
|
+
/**
|
|
2268
|
+
*
|
|
2269
|
+
* @summary Generate or update brand context
|
|
2270
|
+
* @param {string} project Projects unique identifier
|
|
2271
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
2272
|
+
* @param {*} [options] Override http request option.
|
|
2273
|
+
* @throws {RequiredError}
|
|
2274
|
+
*/
|
|
2275
|
+
generateBrandContext(project, generateBrandContextRequest, options) {
|
|
2276
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2277
|
+
var _a, _b, _c;
|
|
2278
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.generateBrandContext(project, generateBrandContextRequest, options);
|
|
2279
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2280
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProjectsApi.generateBrandContext']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2281
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2282
|
+
});
|
|
2283
|
+
},
|
|
2229
2284
|
/**
|
|
2230
2285
|
* Lists the auth tokens for the project
|
|
2231
2286
|
* @summary List auth tokens
|
|
@@ -2934,6 +2989,16 @@ const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2934
2989
|
exportTasks(requestParameters, options) {
|
|
2935
2990
|
return localVarFp.exportTasks(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2936
2991
|
},
|
|
2992
|
+
/**
|
|
2993
|
+
*
|
|
2994
|
+
* @summary Generate or update brand context
|
|
2995
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
2996
|
+
* @param {*} [options] Override http request option.
|
|
2997
|
+
* @throws {RequiredError}
|
|
2998
|
+
*/
|
|
2999
|
+
generateBrandContext(requestParameters, options) {
|
|
3000
|
+
return localVarFp.generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(axios, basePath));
|
|
3001
|
+
},
|
|
2937
3002
|
/**
|
|
2938
3003
|
* Lists the auth tokens for the project
|
|
2939
3004
|
* @summary List auth tokens
|
|
@@ -3421,6 +3486,16 @@ class ProjectsApi extends base_1.BaseAPI {
|
|
|
3421
3486
|
exportTasks(requestParameters, options) {
|
|
3422
3487
|
return (0, exports.ProjectsApiFp)(this.configuration).exportTasks(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3423
3488
|
}
|
|
3489
|
+
/**
|
|
3490
|
+
*
|
|
3491
|
+
* @summary Generate or update brand context
|
|
3492
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
3493
|
+
* @param {*} [options] Override http request option.
|
|
3494
|
+
* @throws {RequiredError}
|
|
3495
|
+
*/
|
|
3496
|
+
generateBrandContext(requestParameters, options) {
|
|
3497
|
+
return (0, exports.ProjectsApiFp)(this.configuration).generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3498
|
+
}
|
|
3424
3499
|
/**
|
|
3425
3500
|
* Lists the auth tokens for the project
|
|
3426
3501
|
* @summary List auth tokens
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Projects API
|
|
3
3
|
* Manage PodOS Projects
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.59.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -127,6 +127,13 @@ export interface ExportTasks202Response {
|
|
|
127
127
|
*/
|
|
128
128
|
'message'?: string;
|
|
129
129
|
}
|
|
130
|
+
export interface GenerateBrandContextRequest {
|
|
131
|
+
'mainSiteUrl'?: string | null;
|
|
132
|
+
}
|
|
133
|
+
export interface GenerateBrandContextResponse {
|
|
134
|
+
'message': string;
|
|
135
|
+
'generationId': string;
|
|
136
|
+
}
|
|
130
137
|
export interface GetClients200Response {
|
|
131
138
|
'clients': Array<UserClient>;
|
|
132
139
|
}
|
|
@@ -645,6 +652,15 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
645
652
|
* @throws {RequiredError}
|
|
646
653
|
*/
|
|
647
654
|
exportTasks: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
* @summary Generate or update brand context
|
|
658
|
+
* @param {string} project Projects unique identifier
|
|
659
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
generateBrandContext: (project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
648
664
|
/**
|
|
649
665
|
* Lists the auth tokens for the project
|
|
650
666
|
* @summary List auth tokens
|
|
@@ -1079,6 +1095,15 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1079
1095
|
* @throws {RequiredError}
|
|
1080
1096
|
*/
|
|
1081
1097
|
exportTasks(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1098
|
+
/**
|
|
1099
|
+
*
|
|
1100
|
+
* @summary Generate or update brand context
|
|
1101
|
+
* @param {string} project Projects unique identifier
|
|
1102
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
1103
|
+
* @param {*} [options] Override http request option.
|
|
1104
|
+
* @throws {RequiredError}
|
|
1105
|
+
*/
|
|
1106
|
+
generateBrandContext(project: string, generateBrandContextRequest?: GenerateBrandContextRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateBrandContextResponse>>;
|
|
1082
1107
|
/**
|
|
1083
1108
|
* Lists the auth tokens for the project
|
|
1084
1109
|
* @summary List auth tokens
|
|
@@ -1501,6 +1526,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1501
1526
|
* @throws {RequiredError}
|
|
1502
1527
|
*/
|
|
1503
1528
|
exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1529
|
+
/**
|
|
1530
|
+
*
|
|
1531
|
+
* @summary Generate or update brand context
|
|
1532
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
1533
|
+
* @param {*} [options] Override http request option.
|
|
1534
|
+
* @throws {RequiredError}
|
|
1535
|
+
*/
|
|
1536
|
+
generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateBrandContextResponse>;
|
|
1504
1537
|
/**
|
|
1505
1538
|
* Lists the auth tokens for the project
|
|
1506
1539
|
* @summary List auth tokens
|
|
@@ -1951,6 +1984,19 @@ export interface ProjectsApiExportTasksRequest {
|
|
|
1951
1984
|
*/
|
|
1952
1985
|
readonly project: string;
|
|
1953
1986
|
}
|
|
1987
|
+
/**
|
|
1988
|
+
* Request parameters for generateBrandContext operation in ProjectsApi.
|
|
1989
|
+
*/
|
|
1990
|
+
export interface ProjectsApiGenerateBrandContextRequest {
|
|
1991
|
+
/**
|
|
1992
|
+
* Projects unique identifier
|
|
1993
|
+
*/
|
|
1994
|
+
readonly project: string;
|
|
1995
|
+
/**
|
|
1996
|
+
* Request body to generate or update brand context
|
|
1997
|
+
*/
|
|
1998
|
+
readonly generateBrandContextRequest?: GenerateBrandContextRequest;
|
|
1999
|
+
}
|
|
1954
2000
|
/**
|
|
1955
2001
|
* Request parameters for getAuth operation in ProjectsApi.
|
|
1956
2002
|
*/
|
|
@@ -2502,6 +2548,14 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2502
2548
|
* @throws {RequiredError}
|
|
2503
2549
|
*/
|
|
2504
2550
|
exportTasks(requestParameters: ProjectsApiExportTasksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
2551
|
+
/**
|
|
2552
|
+
*
|
|
2553
|
+
* @summary Generate or update brand context
|
|
2554
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
2555
|
+
* @param {*} [options] Override http request option.
|
|
2556
|
+
* @throws {RequiredError}
|
|
2557
|
+
*/
|
|
2558
|
+
generateBrandContext(requestParameters: ProjectsApiGenerateBrandContextRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateBrandContextResponse, any, {}>>;
|
|
2505
2559
|
/**
|
|
2506
2560
|
* Lists the auth tokens for the project
|
|
2507
2561
|
* @summary List auth tokens
|
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.59.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -708,6 +708,44 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
708
708
|
options: localVarRequestOptions,
|
|
709
709
|
};
|
|
710
710
|
}),
|
|
711
|
+
/**
|
|
712
|
+
*
|
|
713
|
+
* @summary Generate or update brand context
|
|
714
|
+
* @param {string} project Projects unique identifier
|
|
715
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
716
|
+
* @param {*} [options] Override http request option.
|
|
717
|
+
* @throws {RequiredError}
|
|
718
|
+
*/
|
|
719
|
+
generateBrandContext: (project_1, generateBrandContextRequest_1, ...args_1) => __awaiter(this, [project_1, generateBrandContextRequest_1, ...args_1], void 0, function* (project, generateBrandContextRequest, options = {}) {
|
|
720
|
+
// verify required parameter 'project' is not null or undefined
|
|
721
|
+
assertParamExists('generateBrandContext', 'project', project);
|
|
722
|
+
const localVarPath = `/v1/projects/{project}/brand-context/generate`
|
|
723
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
724
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
725
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
726
|
+
let baseOptions;
|
|
727
|
+
if (configuration) {
|
|
728
|
+
baseOptions = configuration.baseOptions;
|
|
729
|
+
}
|
|
730
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
731
|
+
const localVarHeaderParameter = {};
|
|
732
|
+
const localVarQueryParameter = {};
|
|
733
|
+
// authentication session-oauth required
|
|
734
|
+
// oauth required
|
|
735
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
736
|
+
// authentication api-key required
|
|
737
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
738
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
739
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
740
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
741
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
742
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
743
|
+
localVarRequestOptions.data = serializeDataIfNeeded(generateBrandContextRequest, localVarRequestOptions, configuration);
|
|
744
|
+
return {
|
|
745
|
+
url: toPathString(localVarUrlObj),
|
|
746
|
+
options: localVarRequestOptions,
|
|
747
|
+
};
|
|
748
|
+
}),
|
|
711
749
|
/**
|
|
712
750
|
* Lists the auth tokens for the project
|
|
713
751
|
* @summary List auth tokens
|
|
@@ -2222,6 +2260,23 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
2222
2260
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2223
2261
|
});
|
|
2224
2262
|
},
|
|
2263
|
+
/**
|
|
2264
|
+
*
|
|
2265
|
+
* @summary Generate or update brand context
|
|
2266
|
+
* @param {string} project Projects unique identifier
|
|
2267
|
+
* @param {GenerateBrandContextRequest} [generateBrandContextRequest] Request body to generate or update brand context
|
|
2268
|
+
* @param {*} [options] Override http request option.
|
|
2269
|
+
* @throws {RequiredError}
|
|
2270
|
+
*/
|
|
2271
|
+
generateBrandContext(project, generateBrandContextRequest, options) {
|
|
2272
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2273
|
+
var _a, _b, _c;
|
|
2274
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.generateBrandContext(project, generateBrandContextRequest, options);
|
|
2275
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2276
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProjectsApi.generateBrandContext']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2277
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2278
|
+
});
|
|
2279
|
+
},
|
|
2225
2280
|
/**
|
|
2226
2281
|
* Lists the auth tokens for the project
|
|
2227
2282
|
* @summary List auth tokens
|
|
@@ -2929,6 +2984,16 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2929
2984
|
exportTasks(requestParameters, options) {
|
|
2930
2985
|
return localVarFp.exportTasks(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2931
2986
|
},
|
|
2987
|
+
/**
|
|
2988
|
+
*
|
|
2989
|
+
* @summary Generate or update brand context
|
|
2990
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
2991
|
+
* @param {*} [options] Override http request option.
|
|
2992
|
+
* @throws {RequiredError}
|
|
2993
|
+
*/
|
|
2994
|
+
generateBrandContext(requestParameters, options) {
|
|
2995
|
+
return localVarFp.generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(axios, basePath));
|
|
2996
|
+
},
|
|
2932
2997
|
/**
|
|
2933
2998
|
* Lists the auth tokens for the project
|
|
2934
2999
|
* @summary List auth tokens
|
|
@@ -3415,6 +3480,16 @@ export class ProjectsApi extends BaseAPI {
|
|
|
3415
3480
|
exportTasks(requestParameters, options) {
|
|
3416
3481
|
return ProjectsApiFp(this.configuration).exportTasks(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3417
3482
|
}
|
|
3483
|
+
/**
|
|
3484
|
+
*
|
|
3485
|
+
* @summary Generate or update brand context
|
|
3486
|
+
* @param {ProjectsApiGenerateBrandContextRequest} requestParameters Request parameters.
|
|
3487
|
+
* @param {*} [options] Override http request option.
|
|
3488
|
+
* @throws {RequiredError}
|
|
3489
|
+
*/
|
|
3490
|
+
generateBrandContext(requestParameters, options) {
|
|
3491
|
+
return ProjectsApiFp(this.configuration).generateBrandContext(requestParameters.project, requestParameters.generateBrandContextRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3492
|
+
}
|
|
3418
3493
|
/**
|
|
3419
3494
|
* Lists the auth tokens for the project
|
|
3420
3495
|
* @summary List auth tokens
|
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,20 @@
|
|
|
1
|
+
# GenerateBrandContextRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**mainSiteUrl** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GenerateBrandContextRequest } from '@teemill/projects';
|
|
14
|
+
|
|
15
|
+
const instance: GenerateBrandContextRequest = {
|
|
16
|
+
mainSiteUrl,
|
|
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)
|
|
@@ -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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GenerateBrandContextResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
**generationId** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GenerateBrandContextResponse } from '@teemill/projects';
|
|
15
|
+
|
|
16
|
+
const instance: GenerateBrandContextResponse = {
|
|
17
|
+
message,
|
|
18
|
+
generationId,
|
|
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)
|
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
|
+
> GenerateBrandContextResponse 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
|
+
**GenerateBrandContextResponse**
|
|
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 generated brand context | - |
|
|
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
|
|
package/index.ts
CHANGED