@teemill/website 0.35.1 → 0.37.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/.openapi-generator/FILES +1 -1
- package/README.md +5 -3
- package/api.ts +205 -9
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +104 -10
- package/dist/api.js +157 -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 +104 -10
- package/dist/esm/api.js +157 -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/GenerateCollectionForKeyphraseOpportunity202Response.md +20 -0
- package/docs/KeyphraseOpportunitiesApi.md +120 -0
- package/docs/PagesApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Website
|
|
5
5
|
* Manage your PodOS Website
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.37.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1287,6 +1287,47 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
|
|
|
1287
1287
|
options: localVarRequestOptions,
|
|
1288
1288
|
};
|
|
1289
1289
|
}),
|
|
1290
|
+
/**
|
|
1291
|
+
* Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
|
|
1292
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1293
|
+
* @param {string} project What project it is
|
|
1294
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
generateCollectionForKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
|
|
1299
|
+
// verify required parameter 'project' is not null or undefined
|
|
1300
|
+
assertParamExists('generateCollectionForKeyphraseOpportunity', 'project', project);
|
|
1301
|
+
// verify required parameter 'keyphraseOpportunityId' is not null or undefined
|
|
1302
|
+
assertParamExists('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
|
|
1303
|
+
const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
|
|
1304
|
+
.replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
|
|
1305
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1306
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1307
|
+
let baseOptions;
|
|
1308
|
+
if (configuration) {
|
|
1309
|
+
baseOptions = configuration.baseOptions;
|
|
1310
|
+
}
|
|
1311
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1312
|
+
const localVarHeaderParameter = {};
|
|
1313
|
+
const localVarQueryParameter = {};
|
|
1314
|
+
// authentication session-oauth required
|
|
1315
|
+
// oauth required
|
|
1316
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1317
|
+
// authentication api-key required
|
|
1318
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1319
|
+
if (project !== undefined) {
|
|
1320
|
+
localVarQueryParameter['project'] = project;
|
|
1321
|
+
}
|
|
1322
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1323
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1324
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1325
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1326
|
+
return {
|
|
1327
|
+
url: toPathString(localVarUrlObj),
|
|
1328
|
+
options: localVarRequestOptions,
|
|
1329
|
+
};
|
|
1330
|
+
}),
|
|
1290
1331
|
/**
|
|
1291
1332
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1292
1333
|
* @summary List keyphrase opportunities
|
|
@@ -1336,6 +1377,47 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
|
|
|
1336
1377
|
options: localVarRequestOptions,
|
|
1337
1378
|
};
|
|
1338
1379
|
}),
|
|
1380
|
+
/**
|
|
1381
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1382
|
+
* @summary Unassign keyphrase opportunity
|
|
1383
|
+
* @param {string} project What project it is
|
|
1384
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1385
|
+
* @param {*} [options] Override http request option.
|
|
1386
|
+
* @throws {RequiredError}
|
|
1387
|
+
*/
|
|
1388
|
+
unassignKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
|
|
1389
|
+
// verify required parameter 'project' is not null or undefined
|
|
1390
|
+
assertParamExists('unassignKeyphraseOpportunity', 'project', project);
|
|
1391
|
+
// verify required parameter 'keyphraseOpportunityId' is not null or undefined
|
|
1392
|
+
assertParamExists('unassignKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
|
|
1393
|
+
const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign`
|
|
1394
|
+
.replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
|
|
1395
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1396
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1397
|
+
let baseOptions;
|
|
1398
|
+
if (configuration) {
|
|
1399
|
+
baseOptions = configuration.baseOptions;
|
|
1400
|
+
}
|
|
1401
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1402
|
+
const localVarHeaderParameter = {};
|
|
1403
|
+
const localVarQueryParameter = {};
|
|
1404
|
+
// authentication session-oauth required
|
|
1405
|
+
// oauth required
|
|
1406
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1407
|
+
// authentication api-key required
|
|
1408
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1409
|
+
if (project !== undefined) {
|
|
1410
|
+
localVarQueryParameter['project'] = project;
|
|
1411
|
+
}
|
|
1412
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1413
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1414
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1415
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1416
|
+
return {
|
|
1417
|
+
url: toPathString(localVarUrlObj),
|
|
1418
|
+
options: localVarRequestOptions,
|
|
1419
|
+
};
|
|
1420
|
+
}),
|
|
1339
1421
|
};
|
|
1340
1422
|
};
|
|
1341
1423
|
/**
|
|
@@ -1361,6 +1443,23 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1361
1443
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1362
1444
|
});
|
|
1363
1445
|
},
|
|
1446
|
+
/**
|
|
1447
|
+
* Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
|
|
1448
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1449
|
+
* @param {string} project What project it is
|
|
1450
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1451
|
+
* @param {*} [options] Override http request option.
|
|
1452
|
+
* @throws {RequiredError}
|
|
1453
|
+
*/
|
|
1454
|
+
generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
|
|
1455
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1456
|
+
var _a, _b, _c;
|
|
1457
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
|
|
1458
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1459
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1460
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1461
|
+
});
|
|
1462
|
+
},
|
|
1364
1463
|
/**
|
|
1365
1464
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1366
1465
|
* @summary List keyphrase opportunities
|
|
@@ -1380,6 +1479,23 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1380
1479
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1381
1480
|
});
|
|
1382
1481
|
},
|
|
1482
|
+
/**
|
|
1483
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1484
|
+
* @summary Unassign keyphrase opportunity
|
|
1485
|
+
* @param {string} project What project it is
|
|
1486
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1487
|
+
* @param {*} [options] Override http request option.
|
|
1488
|
+
* @throws {RequiredError}
|
|
1489
|
+
*/
|
|
1490
|
+
unassignKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
|
|
1491
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1492
|
+
var _a, _b, _c;
|
|
1493
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.unassignKeyphraseOpportunity(project, keyphraseOpportunityId, options);
|
|
1494
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1495
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.unassignKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1496
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1497
|
+
});
|
|
1498
|
+
},
|
|
1383
1499
|
};
|
|
1384
1500
|
};
|
|
1385
1501
|
/**
|
|
@@ -1398,6 +1514,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
|
|
|
1398
1514
|
deleteKeyphraseOpportunity(requestParameters, options) {
|
|
1399
1515
|
return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1400
1516
|
},
|
|
1517
|
+
/**
|
|
1518
|
+
* Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
|
|
1519
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1520
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1521
|
+
* @param {*} [options] Override http request option.
|
|
1522
|
+
* @throws {RequiredError}
|
|
1523
|
+
*/
|
|
1524
|
+
generateCollectionForKeyphraseOpportunity(requestParameters, options) {
|
|
1525
|
+
return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1526
|
+
},
|
|
1401
1527
|
/**
|
|
1402
1528
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1403
1529
|
* @summary List keyphrase opportunities
|
|
@@ -1408,6 +1534,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
|
|
|
1408
1534
|
listKeyphraseOpportunities(requestParameters, options) {
|
|
1409
1535
|
return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1410
1536
|
},
|
|
1537
|
+
/**
|
|
1538
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1539
|
+
* @summary Unassign keyphrase opportunity
|
|
1540
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1541
|
+
* @param {*} [options] Override http request option.
|
|
1542
|
+
* @throws {RequiredError}
|
|
1543
|
+
*/
|
|
1544
|
+
unassignKeyphraseOpportunity(requestParameters, options) {
|
|
1545
|
+
return localVarFp.unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1546
|
+
},
|
|
1411
1547
|
};
|
|
1412
1548
|
};
|
|
1413
1549
|
/**
|
|
@@ -1424,6 +1560,16 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
|
1424
1560
|
deleteKeyphraseOpportunity(requestParameters, options) {
|
|
1425
1561
|
return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1426
1562
|
}
|
|
1563
|
+
/**
|
|
1564
|
+
* Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
|
|
1565
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1566
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1567
|
+
* @param {*} [options] Override http request option.
|
|
1568
|
+
* @throws {RequiredError}
|
|
1569
|
+
*/
|
|
1570
|
+
generateCollectionForKeyphraseOpportunity(requestParameters, options) {
|
|
1571
|
+
return KeyphraseOpportunitiesApiFp(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1572
|
+
}
|
|
1427
1573
|
/**
|
|
1428
1574
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1429
1575
|
* @summary List keyphrase opportunities
|
|
@@ -1434,6 +1580,16 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
|
1434
1580
|
listKeyphraseOpportunities(requestParameters, options) {
|
|
1435
1581
|
return KeyphraseOpportunitiesApiFp(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1436
1582
|
}
|
|
1583
|
+
/**
|
|
1584
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1585
|
+
* @summary Unassign keyphrase opportunity
|
|
1586
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1587
|
+
* @param {*} [options] Override http request option.
|
|
1588
|
+
* @throws {RequiredError}
|
|
1589
|
+
*/
|
|
1590
|
+
unassignKeyphraseOpportunity(requestParameters, options) {
|
|
1591
|
+
return KeyphraseOpportunitiesApiFp(this.configuration).unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1592
|
+
}
|
|
1437
1593
|
}
|
|
1438
1594
|
/**
|
|
1439
1595
|
* MenuApi - axios parameter creator
|
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
|
+
# GenerateCollectionForKeyphraseOpportunity202Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | A message describing the generation status | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GenerateCollectionForKeyphraseOpportunity202Response } from '@teemill/website';
|
|
14
|
+
|
|
15
|
+
const instance: GenerateCollectionForKeyphraseOpportunity202Response = {
|
|
16
|
+
message,
|
|
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)
|
|
@@ -5,7 +5,9 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity|
|
|
8
|
+
|[**generateCollectionForKeyphraseOpportunity**](#generatecollectionforkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection | Generate collection for a keyphrase opportunity|
|
|
8
9
|
|[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities|
|
|
10
|
+
|[**unassignKeyphraseOpportunity**](#unassignkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign | Unassign keyphrase opportunity|
|
|
9
11
|
|
|
10
12
|
# **deleteKeyphraseOpportunity**
|
|
11
13
|
> deleteKeyphraseOpportunity()
|
|
@@ -65,6 +67,65 @@ void (empty response body)
|
|
|
65
67
|
|
|
66
68
|
[[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)
|
|
67
69
|
|
|
70
|
+
# **generateCollectionForKeyphraseOpportunity**
|
|
71
|
+
> GenerateCollectionForKeyphraseOpportunity202Response generateCollectionForKeyphraseOpportunity()
|
|
72
|
+
|
|
73
|
+
Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
KeyphraseOpportunitiesApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@teemill/website';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new KeyphraseOpportunitiesApi(configuration);
|
|
85
|
+
|
|
86
|
+
let project: string; //What project it is (default to undefined)
|
|
87
|
+
let keyphraseOpportunityId: string; //Keyphrase opportunity\'s unique identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.generateCollectionForKeyphraseOpportunity(
|
|
90
|
+
project,
|
|
91
|
+
keyphraseOpportunityId
|
|
92
|
+
);
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
|Name | Type | Description | Notes|
|
|
98
|
+
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
100
|
+
| **keyphraseOpportunityId** | [**string**] | Keyphrase opportunity\'s unique identifier | defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**GenerateCollectionForKeyphraseOpportunity202Response**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**202** | Collection generation queued. When complete, a notification will be sent to the PodOS Dashboard, which will include a link to the new collection. | - |
|
|
121
|
+
|**400** | Failed validation | - |
|
|
122
|
+
|**401** | Not authorised to access this resource | - |
|
|
123
|
+
|**403** | Refuse to authorize | - |
|
|
124
|
+
|**404** | Resource not found | - |
|
|
125
|
+
|**500** | Unknown server error | - |
|
|
126
|
+
|
|
127
|
+
[[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)
|
|
128
|
+
|
|
68
129
|
# **listKeyphraseOpportunities**
|
|
69
130
|
> KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
|
|
70
131
|
|
|
@@ -128,3 +189,62 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
|
|
|
128
189
|
|
|
129
190
|
[[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)
|
|
130
191
|
|
|
192
|
+
# **unassignKeyphraseOpportunity**
|
|
193
|
+
> unassignKeyphraseOpportunity()
|
|
194
|
+
|
|
195
|
+
Detach the currently assigned content from a keyphrase opportunity.
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
KeyphraseOpportunitiesApi,
|
|
202
|
+
Configuration
|
|
203
|
+
} from '@teemill/website';
|
|
204
|
+
|
|
205
|
+
const configuration = new Configuration();
|
|
206
|
+
const apiInstance = new KeyphraseOpportunitiesApi(configuration);
|
|
207
|
+
|
|
208
|
+
let project: string; //What project it is (default to undefined)
|
|
209
|
+
let keyphraseOpportunityId: string; //Keyphrase opportunity\'s unique identifier (default to undefined)
|
|
210
|
+
|
|
211
|
+
const { status, data } = await apiInstance.unassignKeyphraseOpportunity(
|
|
212
|
+
project,
|
|
213
|
+
keyphraseOpportunityId
|
|
214
|
+
);
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Parameters
|
|
218
|
+
|
|
219
|
+
|Name | Type | Description | Notes|
|
|
220
|
+
|------------- | ------------- | ------------- | -------------|
|
|
221
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
222
|
+
| **keyphraseOpportunityId** | [**string**] | Keyphrase opportunity\'s unique identifier | defaults to undefined|
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
void (empty response body)
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: Not defined
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
### HTTP response details
|
|
240
|
+
| Status code | Description | Response headers |
|
|
241
|
+
|-------------|-------------|------------------|
|
|
242
|
+
|**204** | Keyphrase opportunity unassigned | - |
|
|
243
|
+
|**400** | Failed validation | - |
|
|
244
|
+
|**401** | Not authorised to access this resource | - |
|
|
245
|
+
|**403** | Refuse to authorize | - |
|
|
246
|
+
|**404** | Resource not found | - |
|
|
247
|
+
|**500** | Unknown server error | - |
|
|
248
|
+
|
|
249
|
+
[[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)
|
|
250
|
+
|
package/docs/PagesApi.md
CHANGED
|
@@ -188,7 +188,7 @@ const { status, data } = await apiInstance.listPages(
|
|
|
188
188
|
[[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)
|
|
189
189
|
|
|
190
190
|
# **seoOptimisePages**
|
|
191
|
-
>
|
|
191
|
+
> GenerateCollectionForKeyphraseOpportunity202Response seoOptimisePages()
|
|
192
192
|
|
|
193
193
|
AI SEO optimises pages by a set of given IDs.
|
|
194
194
|
|
|
@@ -223,7 +223,7 @@ const { status, data } = await apiInstance.seoOptimisePages(
|
|
|
223
223
|
|
|
224
224
|
### Return type
|
|
225
225
|
|
|
226
|
-
**
|
|
226
|
+
**GenerateCollectionForKeyphraseOpportunity202Response**
|
|
227
227
|
|
|
228
228
|
### Authorization
|
|
229
229
|
|
package/index.ts
CHANGED