@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/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Website
|
|
6
6
|
* Manage your PodOS Website
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.37.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1311,6 +1311,47 @@ const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
|
|
|
1311
1311
|
options: localVarRequestOptions,
|
|
1312
1312
|
};
|
|
1313
1313
|
}),
|
|
1314
|
+
/**
|
|
1315
|
+
* 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.
|
|
1316
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1317
|
+
* @param {string} project What project it is
|
|
1318
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1319
|
+
* @param {*} [options] Override http request option.
|
|
1320
|
+
* @throws {RequiredError}
|
|
1321
|
+
*/
|
|
1322
|
+
generateCollectionForKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
|
|
1323
|
+
// verify required parameter 'project' is not null or undefined
|
|
1324
|
+
(0, common_1.assertParamExists)('generateCollectionForKeyphraseOpportunity', 'project', project);
|
|
1325
|
+
// verify required parameter 'keyphraseOpportunityId' is not null or undefined
|
|
1326
|
+
(0, common_1.assertParamExists)('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
|
|
1327
|
+
const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
|
|
1328
|
+
.replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
|
|
1329
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1330
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1331
|
+
let baseOptions;
|
|
1332
|
+
if (configuration) {
|
|
1333
|
+
baseOptions = configuration.baseOptions;
|
|
1334
|
+
}
|
|
1335
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1336
|
+
const localVarHeaderParameter = {};
|
|
1337
|
+
const localVarQueryParameter = {};
|
|
1338
|
+
// authentication session-oauth required
|
|
1339
|
+
// oauth required
|
|
1340
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1341
|
+
// authentication api-key required
|
|
1342
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1343
|
+
if (project !== undefined) {
|
|
1344
|
+
localVarQueryParameter['project'] = project;
|
|
1345
|
+
}
|
|
1346
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1347
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1348
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1349
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1350
|
+
return {
|
|
1351
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1352
|
+
options: localVarRequestOptions,
|
|
1353
|
+
};
|
|
1354
|
+
}),
|
|
1314
1355
|
/**
|
|
1315
1356
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1316
1357
|
* @summary List keyphrase opportunities
|
|
@@ -1360,6 +1401,47 @@ const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
|
|
|
1360
1401
|
options: localVarRequestOptions,
|
|
1361
1402
|
};
|
|
1362
1403
|
}),
|
|
1404
|
+
/**
|
|
1405
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1406
|
+
* @summary Unassign keyphrase opportunity
|
|
1407
|
+
* @param {string} project What project it is
|
|
1408
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1409
|
+
* @param {*} [options] Override http request option.
|
|
1410
|
+
* @throws {RequiredError}
|
|
1411
|
+
*/
|
|
1412
|
+
unassignKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
|
|
1413
|
+
// verify required parameter 'project' is not null or undefined
|
|
1414
|
+
(0, common_1.assertParamExists)('unassignKeyphraseOpportunity', 'project', project);
|
|
1415
|
+
// verify required parameter 'keyphraseOpportunityId' is not null or undefined
|
|
1416
|
+
(0, common_1.assertParamExists)('unassignKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
|
|
1417
|
+
const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign`
|
|
1418
|
+
.replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
|
|
1419
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1420
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1421
|
+
let baseOptions;
|
|
1422
|
+
if (configuration) {
|
|
1423
|
+
baseOptions = configuration.baseOptions;
|
|
1424
|
+
}
|
|
1425
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
1426
|
+
const localVarHeaderParameter = {};
|
|
1427
|
+
const localVarQueryParameter = {};
|
|
1428
|
+
// authentication session-oauth required
|
|
1429
|
+
// oauth required
|
|
1430
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1431
|
+
// authentication api-key required
|
|
1432
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1433
|
+
if (project !== undefined) {
|
|
1434
|
+
localVarQueryParameter['project'] = project;
|
|
1435
|
+
}
|
|
1436
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1437
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1438
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1439
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1440
|
+
return {
|
|
1441
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1442
|
+
options: localVarRequestOptions,
|
|
1443
|
+
};
|
|
1444
|
+
}),
|
|
1363
1445
|
};
|
|
1364
1446
|
};
|
|
1365
1447
|
exports.KeyphraseOpportunitiesApiAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator;
|
|
@@ -1386,6 +1468,23 @@ const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1386
1468
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1387
1469
|
});
|
|
1388
1470
|
},
|
|
1471
|
+
/**
|
|
1472
|
+
* 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.
|
|
1473
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1474
|
+
* @param {string} project What project it is
|
|
1475
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1476
|
+
* @param {*} [options] Override http request option.
|
|
1477
|
+
* @throws {RequiredError}
|
|
1478
|
+
*/
|
|
1479
|
+
generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
|
|
1480
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1481
|
+
var _a, _b, _c;
|
|
1482
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
|
|
1483
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1484
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1485
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1486
|
+
});
|
|
1487
|
+
},
|
|
1389
1488
|
/**
|
|
1390
1489
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1391
1490
|
* @summary List keyphrase opportunities
|
|
@@ -1405,6 +1504,23 @@ const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1405
1504
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1406
1505
|
});
|
|
1407
1506
|
},
|
|
1507
|
+
/**
|
|
1508
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1509
|
+
* @summary Unassign keyphrase opportunity
|
|
1510
|
+
* @param {string} project What project it is
|
|
1511
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
*/
|
|
1515
|
+
unassignKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
|
|
1516
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1517
|
+
var _a, _b, _c;
|
|
1518
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.unassignKeyphraseOpportunity(project, keyphraseOpportunityId, options);
|
|
1519
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1520
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['KeyphraseOpportunitiesApi.unassignKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1521
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1522
|
+
});
|
|
1523
|
+
},
|
|
1408
1524
|
};
|
|
1409
1525
|
};
|
|
1410
1526
|
exports.KeyphraseOpportunitiesApiFp = KeyphraseOpportunitiesApiFp;
|
|
@@ -1424,6 +1540,16 @@ const KeyphraseOpportunitiesApiFactory = function (configuration, basePath, axio
|
|
|
1424
1540
|
deleteKeyphraseOpportunity(requestParameters, options) {
|
|
1425
1541
|
return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1426
1542
|
},
|
|
1543
|
+
/**
|
|
1544
|
+
* 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.
|
|
1545
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1546
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1547
|
+
* @param {*} [options] Override http request option.
|
|
1548
|
+
* @throws {RequiredError}
|
|
1549
|
+
*/
|
|
1550
|
+
generateCollectionForKeyphraseOpportunity(requestParameters, options) {
|
|
1551
|
+
return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1552
|
+
},
|
|
1427
1553
|
/**
|
|
1428
1554
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1429
1555
|
* @summary List keyphrase opportunities
|
|
@@ -1434,6 +1560,16 @@ const KeyphraseOpportunitiesApiFactory = function (configuration, basePath, axio
|
|
|
1434
1560
|
listKeyphraseOpportunities(requestParameters, options) {
|
|
1435
1561
|
return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1436
1562
|
},
|
|
1563
|
+
/**
|
|
1564
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1565
|
+
* @summary Unassign keyphrase opportunity
|
|
1566
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1567
|
+
* @param {*} [options] Override http request option.
|
|
1568
|
+
* @throws {RequiredError}
|
|
1569
|
+
*/
|
|
1570
|
+
unassignKeyphraseOpportunity(requestParameters, options) {
|
|
1571
|
+
return localVarFp.unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1572
|
+
},
|
|
1437
1573
|
};
|
|
1438
1574
|
};
|
|
1439
1575
|
exports.KeyphraseOpportunitiesApiFactory = KeyphraseOpportunitiesApiFactory;
|
|
@@ -1451,6 +1587,16 @@ class KeyphraseOpportunitiesApi extends base_1.BaseAPI {
|
|
|
1451
1587
|
deleteKeyphraseOpportunity(requestParameters, options) {
|
|
1452
1588
|
return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1453
1589
|
}
|
|
1590
|
+
/**
|
|
1591
|
+
* 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.
|
|
1592
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1593
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1594
|
+
* @param {*} [options] Override http request option.
|
|
1595
|
+
* @throws {RequiredError}
|
|
1596
|
+
*/
|
|
1597
|
+
generateCollectionForKeyphraseOpportunity(requestParameters, options) {
|
|
1598
|
+
return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1599
|
+
}
|
|
1454
1600
|
/**
|
|
1455
1601
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1456
1602
|
* @summary List keyphrase opportunities
|
|
@@ -1461,6 +1607,16 @@ class KeyphraseOpportunitiesApi extends base_1.BaseAPI {
|
|
|
1461
1607
|
listKeyphraseOpportunities(requestParameters, options) {
|
|
1462
1608
|
return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1463
1609
|
}
|
|
1610
|
+
/**
|
|
1611
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1612
|
+
* @summary Unassign keyphrase opportunity
|
|
1613
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1614
|
+
* @param {*} [options] Override http request option.
|
|
1615
|
+
* @throws {RequiredError}
|
|
1616
|
+
*/
|
|
1617
|
+
unassignKeyphraseOpportunity(requestParameters, options) {
|
|
1618
|
+
return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1619
|
+
}
|
|
1464
1620
|
}
|
|
1465
1621
|
exports.KeyphraseOpportunitiesApi = KeyphraseOpportunitiesApi;
|
|
1466
1622
|
/**
|
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
|
* Website
|
|
3
3
|
* Manage your PodOS Website
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.37.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -155,6 +155,12 @@ export interface FooterItem {
|
|
|
155
155
|
'link': string;
|
|
156
156
|
'order': number;
|
|
157
157
|
}
|
|
158
|
+
export interface GenerateCollectionForKeyphraseOpportunity202Response {
|
|
159
|
+
/**
|
|
160
|
+
* A message describing the generation status
|
|
161
|
+
*/
|
|
162
|
+
'message'?: string;
|
|
163
|
+
}
|
|
158
164
|
/**
|
|
159
165
|
* Image description
|
|
160
166
|
*/
|
|
@@ -637,12 +643,6 @@ export interface SeoMetadata {
|
|
|
637
643
|
*/
|
|
638
644
|
'description'?: string | null;
|
|
639
645
|
}
|
|
640
|
-
export interface SeoOptimisePages202Response {
|
|
641
|
-
/**
|
|
642
|
-
* A message describing the optimisation status
|
|
643
|
-
*/
|
|
644
|
-
'message'?: string;
|
|
645
|
-
}
|
|
646
646
|
export interface SeoOptimisePagesRequest {
|
|
647
647
|
/**
|
|
648
648
|
* A set of page IDs to AI SEO optimise.
|
|
@@ -1782,6 +1782,15 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
|
|
|
1782
1782
|
* @throws {RequiredError}
|
|
1783
1783
|
*/
|
|
1784
1784
|
deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1785
|
+
/**
|
|
1786
|
+
* 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.
|
|
1787
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1788
|
+
* @param {string} project What project it is
|
|
1789
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1790
|
+
* @param {*} [options] Override http request option.
|
|
1791
|
+
* @throws {RequiredError}
|
|
1792
|
+
*/
|
|
1793
|
+
generateCollectionForKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1785
1794
|
/**
|
|
1786
1795
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1787
1796
|
* @summary List keyphrase opportunities
|
|
@@ -1793,6 +1802,15 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
|
|
|
1793
1802
|
* @throws {RequiredError}
|
|
1794
1803
|
*/
|
|
1795
1804
|
listKeyphraseOpportunities: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1805
|
+
/**
|
|
1806
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1807
|
+
* @summary Unassign keyphrase opportunity
|
|
1808
|
+
* @param {string} project What project it is
|
|
1809
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1810
|
+
* @param {*} [options] Override http request option.
|
|
1811
|
+
* @throws {RequiredError}
|
|
1812
|
+
*/
|
|
1813
|
+
unassignKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1796
1814
|
};
|
|
1797
1815
|
/**
|
|
1798
1816
|
* KeyphraseOpportunitiesApi - functional programming interface
|
|
@@ -1807,6 +1825,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
|
|
|
1807
1825
|
* @throws {RequiredError}
|
|
1808
1826
|
*/
|
|
1809
1827
|
deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1828
|
+
/**
|
|
1829
|
+
* 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.
|
|
1830
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1831
|
+
* @param {string} project What project it is
|
|
1832
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1833
|
+
* @param {*} [options] Override http request option.
|
|
1834
|
+
* @throws {RequiredError}
|
|
1835
|
+
*/
|
|
1836
|
+
generateCollectionForKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
|
|
1810
1837
|
/**
|
|
1811
1838
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1812
1839
|
* @summary List keyphrase opportunities
|
|
@@ -1818,6 +1845,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
|
|
|
1818
1845
|
* @throws {RequiredError}
|
|
1819
1846
|
*/
|
|
1820
1847
|
listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>>;
|
|
1848
|
+
/**
|
|
1849
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1850
|
+
* @summary Unassign keyphrase opportunity
|
|
1851
|
+
* @param {string} project What project it is
|
|
1852
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1853
|
+
* @param {*} [options] Override http request option.
|
|
1854
|
+
* @throws {RequiredError}
|
|
1855
|
+
*/
|
|
1856
|
+
unassignKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1821
1857
|
};
|
|
1822
1858
|
/**
|
|
1823
1859
|
* KeyphraseOpportunitiesApi - factory interface
|
|
@@ -1831,6 +1867,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
|
|
|
1831
1867
|
* @throws {RequiredError}
|
|
1832
1868
|
*/
|
|
1833
1869
|
deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1870
|
+
/**
|
|
1871
|
+
* 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.
|
|
1872
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1873
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1874
|
+
* @param {*} [options] Override http request option.
|
|
1875
|
+
* @throws {RequiredError}
|
|
1876
|
+
*/
|
|
1877
|
+
generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
|
|
1834
1878
|
/**
|
|
1835
1879
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1836
1880
|
* @summary List keyphrase opportunities
|
|
@@ -1839,6 +1883,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
|
|
|
1839
1883
|
* @throws {RequiredError}
|
|
1840
1884
|
*/
|
|
1841
1885
|
listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse>;
|
|
1886
|
+
/**
|
|
1887
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1888
|
+
* @summary Unassign keyphrase opportunity
|
|
1889
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1890
|
+
* @param {*} [options] Override http request option.
|
|
1891
|
+
* @throws {RequiredError}
|
|
1892
|
+
*/
|
|
1893
|
+
unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1842
1894
|
};
|
|
1843
1895
|
/**
|
|
1844
1896
|
* Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
|
|
@@ -1853,6 +1905,19 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
|
|
|
1853
1905
|
*/
|
|
1854
1906
|
readonly keyphraseOpportunityId: string;
|
|
1855
1907
|
}
|
|
1908
|
+
/**
|
|
1909
|
+
* Request parameters for generateCollectionForKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
|
|
1910
|
+
*/
|
|
1911
|
+
export interface KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest {
|
|
1912
|
+
/**
|
|
1913
|
+
* What project it is
|
|
1914
|
+
*/
|
|
1915
|
+
readonly project: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* Keyphrase opportunity\'s unique identifier
|
|
1918
|
+
*/
|
|
1919
|
+
readonly keyphraseOpportunityId: string;
|
|
1920
|
+
}
|
|
1856
1921
|
/**
|
|
1857
1922
|
* Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
|
|
1858
1923
|
*/
|
|
@@ -1874,6 +1939,19 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
|
|
|
1874
1939
|
*/
|
|
1875
1940
|
readonly search?: string;
|
|
1876
1941
|
}
|
|
1942
|
+
/**
|
|
1943
|
+
* Request parameters for unassignKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
|
|
1944
|
+
*/
|
|
1945
|
+
export interface KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest {
|
|
1946
|
+
/**
|
|
1947
|
+
* What project it is
|
|
1948
|
+
*/
|
|
1949
|
+
readonly project: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* Keyphrase opportunity\'s unique identifier
|
|
1952
|
+
*/
|
|
1953
|
+
readonly keyphraseOpportunityId: string;
|
|
1954
|
+
}
|
|
1877
1955
|
/**
|
|
1878
1956
|
* KeyphraseOpportunitiesApi - object-oriented interface
|
|
1879
1957
|
*/
|
|
@@ -1886,6 +1964,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
|
1886
1964
|
* @throws {RequiredError}
|
|
1887
1965
|
*/
|
|
1888
1966
|
deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1967
|
+
/**
|
|
1968
|
+
* 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.
|
|
1969
|
+
* @summary Generate collection for a keyphrase opportunity
|
|
1970
|
+
* @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1971
|
+
* @param {*} [options] Override http request option.
|
|
1972
|
+
* @throws {RequiredError}
|
|
1973
|
+
*/
|
|
1974
|
+
generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
|
|
1889
1975
|
/**
|
|
1890
1976
|
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1891
1977
|
* @summary List keyphrase opportunities
|
|
@@ -1894,6 +1980,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
|
1894
1980
|
* @throws {RequiredError}
|
|
1895
1981
|
*/
|
|
1896
1982
|
listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KeyphraseOpportunitiesResponse, any, {}>>;
|
|
1983
|
+
/**
|
|
1984
|
+
* Detach the currently assigned content from a keyphrase opportunity.
|
|
1985
|
+
* @summary Unassign keyphrase opportunity
|
|
1986
|
+
* @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1987
|
+
* @param {*} [options] Override http request option.
|
|
1988
|
+
* @throws {RequiredError}
|
|
1989
|
+
*/
|
|
1990
|
+
unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1897
1991
|
}
|
|
1898
1992
|
/**
|
|
1899
1993
|
* MenuApi - axios parameter creator
|
|
@@ -2107,7 +2201,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
|
|
|
2107
2201
|
* @param {*} [options] Override http request option.
|
|
2108
2202
|
* @throws {RequiredError}
|
|
2109
2203
|
*/
|
|
2110
|
-
seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2204
|
+
seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
|
|
2111
2205
|
/**
|
|
2112
2206
|
*
|
|
2113
2207
|
* @summary Update website page
|
|
@@ -2166,7 +2260,7 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
|
|
|
2166
2260
|
* @param {*} [options] Override http request option.
|
|
2167
2261
|
* @throws {RequiredError}
|
|
2168
2262
|
*/
|
|
2169
|
-
seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2263
|
+
seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
|
|
2170
2264
|
/**
|
|
2171
2265
|
*
|
|
2172
2266
|
* @summary Update website page
|
|
@@ -2314,7 +2408,7 @@ export declare class PagesApi extends BaseAPI {
|
|
|
2314
2408
|
* @param {*} [options] Override http request option.
|
|
2315
2409
|
* @throws {RequiredError}
|
|
2316
2410
|
*/
|
|
2317
|
-
seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
2411
|
+
seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
|
|
2318
2412
|
/**
|
|
2319
2413
|
*
|
|
2320
2414
|
* @summary Update website page
|