@teemill/website 0.36.0 → 0.37.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/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.36.0
7
+ * The version of the OpenAPI document: 0.37.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,6 +62,18 @@ export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
62
62
  True: 'true',
63
63
  False: 'false',
64
64
  };
65
+ export const KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum = {
66
+ True: 'true',
67
+ False: 'false',
68
+ };
69
+ export const KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum = {
70
+ Product: 'product',
71
+ Collection: 'collection',
72
+ };
73
+ export const KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum = {
74
+ Product: 'product',
75
+ Collection: 'collection',
76
+ };
65
77
  export const KeyphraseOpportunityContentTypeEnum = {
66
78
  Product: 'product',
67
79
  Collection: 'collection',
@@ -223,7 +235,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
223
235
  * @param {string} project What project it is
224
236
  * @param {number} [pageToken] Page reference token
225
237
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
226
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
238
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
227
239
  * @param {*} [options] Override http request option.
228
240
  * @throws {RequiredError}
229
241
  */
@@ -316,7 +328,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
316
328
  * @param {string} project What project it is
317
329
  * @param {number} [pageToken] Page reference token
318
330
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
319
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
331
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
320
332
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
321
333
  * @param {*} [options] Override http request option.
322
334
  * @throws {RequiredError}
@@ -409,7 +421,7 @@ export const BlogsApiFp = function (configuration) {
409
421
  * @param {string} project What project it is
410
422
  * @param {number} [pageToken] Page reference token
411
423
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
412
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
424
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
413
425
  * @param {*} [options] Override http request option.
414
426
  * @throws {RequiredError}
415
427
  */
@@ -446,7 +458,7 @@ export const BlogsApiFp = function (configuration) {
446
458
  * @param {string} project What project it is
447
459
  * @param {number} [pageToken] Page reference token
448
460
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
449
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
461
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
450
462
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
451
463
  * @param {*} [options] Override http request option.
452
464
  * @throws {RequiredError}
@@ -1287,13 +1299,54 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
1287
1299
  options: localVarRequestOptions,
1288
1300
  };
1289
1301
  }),
1302
+ /**
1303
+ * 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.
1304
+ * @summary Generate collection for a keyphrase opportunity
1305
+ * @param {string} project What project it is
1306
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
1307
+ * @param {*} [options] Override http request option.
1308
+ * @throws {RequiredError}
1309
+ */
1310
+ generateCollectionForKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
1311
+ // verify required parameter 'project' is not null or undefined
1312
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'project', project);
1313
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
1314
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
1315
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
1316
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
1317
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1318
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1319
+ let baseOptions;
1320
+ if (configuration) {
1321
+ baseOptions = configuration.baseOptions;
1322
+ }
1323
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1324
+ const localVarHeaderParameter = {};
1325
+ const localVarQueryParameter = {};
1326
+ // authentication session-oauth required
1327
+ // oauth required
1328
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1329
+ // authentication api-key required
1330
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1331
+ if (project !== undefined) {
1332
+ localVarQueryParameter['project'] = project;
1333
+ }
1334
+ localVarHeaderParameter['Accept'] = 'application/json';
1335
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1336
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1337
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1338
+ return {
1339
+ url: toPathString(localVarUrlObj),
1340
+ options: localVarRequestOptions,
1341
+ };
1342
+ }),
1290
1343
  /**
1291
1344
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1292
1345
  * @summary List keyphrase opportunities
1293
1346
  * @param {string} project What project it is
1294
1347
  * @param {number} [pageToken] Page reference token
1295
1348
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1296
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1349
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1297
1350
  * @param {*} [options] Override http request option.
1298
1351
  * @throws {RequiredError}
1299
1352
  */
@@ -1402,13 +1455,30 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
1402
1455
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1403
1456
  });
1404
1457
  },
1458
+ /**
1459
+ * 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.
1460
+ * @summary Generate collection for a keyphrase opportunity
1461
+ * @param {string} project What project it is
1462
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
1463
+ * @param {*} [options] Override http request option.
1464
+ * @throws {RequiredError}
1465
+ */
1466
+ generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
1467
+ return __awaiter(this, void 0, void 0, function* () {
1468
+ var _a, _b, _c;
1469
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
1470
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1471
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1472
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1473
+ });
1474
+ },
1405
1475
  /**
1406
1476
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1407
1477
  * @summary List keyphrase opportunities
1408
1478
  * @param {string} project What project it is
1409
1479
  * @param {number} [pageToken] Page reference token
1410
1480
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1411
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1481
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1412
1482
  * @param {*} [options] Override http request option.
1413
1483
  * @throws {RequiredError}
1414
1484
  */
@@ -1456,6 +1526,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
1456
1526
  deleteKeyphraseOpportunity(requestParameters, options) {
1457
1527
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1458
1528
  },
1529
+ /**
1530
+ * 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.
1531
+ * @summary Generate collection for a keyphrase opportunity
1532
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1533
+ * @param {*} [options] Override http request option.
1534
+ * @throws {RequiredError}
1535
+ */
1536
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1537
+ return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1538
+ },
1459
1539
  /**
1460
1540
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1461
1541
  * @summary List keyphrase opportunities
@@ -1492,6 +1572,16 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
1492
1572
  deleteKeyphraseOpportunity(requestParameters, options) {
1493
1573
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1494
1574
  }
1575
+ /**
1576
+ * 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.
1577
+ * @summary Generate collection for a keyphrase opportunity
1578
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1579
+ * @param {*} [options] Override http request option.
1580
+ * @throws {RequiredError}
1581
+ */
1582
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1583
+ return KeyphraseOpportunitiesApiFp(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1584
+ }
1495
1585
  /**
1496
1586
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1497
1587
  * @summary List keyphrase opportunities
@@ -1780,7 +1870,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
1780
1870
  * @param {string} project What project it is
1781
1871
  * @param {number} [pageToken] Page reference token
1782
1872
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1783
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1873
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1784
1874
  * @param {*} [options] Override http request option.
1785
1875
  * @throws {RequiredError}
1786
1876
  */
@@ -1913,7 +2003,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
1913
2003
  * @param {string} project What project it is
1914
2004
  * @param {number} [pageToken] Page reference token
1915
2005
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1916
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2006
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1917
2007
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
1918
2008
  * @param {*} [options] Override http request option.
1919
2009
  * @throws {RequiredError}
@@ -2006,7 +2096,7 @@ export const PagesApiFp = function (configuration) {
2006
2096
  * @param {string} project What project it is
2007
2097
  * @param {number} [pageToken] Page reference token
2008
2098
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2009
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2099
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2010
2100
  * @param {*} [options] Override http request option.
2011
2101
  * @throws {RequiredError}
2012
2102
  */
@@ -2060,7 +2150,7 @@ export const PagesApiFp = function (configuration) {
2060
2150
  * @param {string} project What project it is
2061
2151
  * @param {number} [pageToken] Page reference token
2062
2152
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2063
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2153
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2064
2154
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
2065
2155
  * @param {*} [options] Override http request option.
2066
2156
  * @throws {RequiredError}
@@ -2964,7 +3054,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
2964
3054
  * @param {string} project What project it is
2965
3055
  * @param {number} [pageToken] Page reference token
2966
3056
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2967
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3057
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2968
3058
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2969
3059
  * @param {string} [start] Start of date range to filter by
2970
3060
  * @param {string} [end] End of date range to filter by
@@ -3116,7 +3206,7 @@ export const ReviewsApiFp = function (configuration) {
3116
3206
  * @param {string} project What project it is
3117
3207
  * @param {number} [pageToken] Page reference token
3118
3208
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3119
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3209
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3120
3210
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3121
3211
  * @param {string} [start] Start of date range to filter by
3122
3212
  * @param {string} [end] End of date range to filter by
@@ -3256,7 +3346,7 @@ export const RoutesApiAxiosParamCreator = function (configuration) {
3256
3346
  * @param {string} project What project it is
3257
3347
  * @param {number} [pageToken] Page reference token
3258
3348
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3259
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3349
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3260
3350
  * @param {*} [options] Override http request option.
3261
3351
  * @throws {RequiredError}
3262
3352
  */
@@ -3313,7 +3403,7 @@ export const RoutesApiFp = function (configuration) {
3313
3403
  * @param {string} project What project it is
3314
3404
  * @param {number} [pageToken] Page reference token
3315
3405
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3316
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3406
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3317
3407
  * @param {*} [options] Override http request option.
3318
3408
  * @throws {RequiredError}
3319
3409
  */
@@ -3372,7 +3462,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
3372
3462
  * @param {string} project What project it is
3373
3463
  * @param {number} [pageToken] Page reference token
3374
3464
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3375
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3465
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3376
3466
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3377
3467
  * @param {*} [options] Override http request option.
3378
3468
  * @throws {RequiredError}
@@ -3506,7 +3596,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
3506
3596
  * @param {string} project What project it is
3507
3597
  * @param {number} [pageToken] Page reference token
3508
3598
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3509
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3599
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3510
3600
  * @param {*} [options] Override http request option.
3511
3601
  * @throws {RequiredError}
3512
3602
  */
@@ -3607,7 +3697,7 @@ export const SearchApiFp = function (configuration) {
3607
3697
  * @param {string} project What project it is
3608
3698
  * @param {number} [pageToken] Page reference token
3609
3699
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3610
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3700
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3611
3701
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3612
3702
  * @param {*} [options] Override http request option.
3613
3703
  * @throws {RequiredError}
@@ -3661,7 +3751,7 @@ export const SearchApiFp = function (configuration) {
3661
3751
  * @param {string} project What project it is
3662
3752
  * @param {number} [pageToken] Page reference token
3663
3753
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3664
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3754
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3665
3755
  * @param {*} [options] Override http request option.
3666
3756
  * @throws {RequiredError}
3667
3757
  */
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.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.36.0
7
+ * The version of the OpenAPI document: 0.37.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Website
4
4
  * Manage your PodOS Website
5
5
  *
6
- * The version of the OpenAPI document: 0.36.0
6
+ * The version of the OpenAPI document: 0.37.1
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.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.36.0
7
+ * The version of the OpenAPI document: 0.37.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.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.36.0
5
+ * The version of the OpenAPI document: 0.37.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.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.36.0
8
+ * The version of the OpenAPI document: 0.37.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/BlogsApi.md CHANGED
@@ -142,7 +142,7 @@ const apiInstance = new BlogsApi(configuration);
142
142
  let project: string; //What project it is (default to undefined)
143
143
  let pageToken: number; //Page reference token (optional) (default to 1)
144
144
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
145
- let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
145
+ let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
146
146
 
147
147
  const { status, data } = await apiInstance.listBlogs(
148
148
  project,
@@ -159,7 +159,7 @@ const { status, data } = await apiInstance.listBlogs(
159
159
  | **project** | [**string**] | What project it is | defaults to undefined|
160
160
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
161
161
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
162
- | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
162
+ | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
163
163
 
164
164
 
165
165
  ### Return type
@@ -267,7 +267,7 @@ const apiInstance = new BlogsApi(configuration);
267
267
  let project: string; //What project it is (default to undefined)
268
268
  let pageToken: number; //Page reference token (optional) (default to 1)
269
269
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
270
- let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
270
+ let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
271
271
  let updateBlogsRequest: UpdateBlogsRequest; //Update blogs in bulk. (optional)
272
272
 
273
273
  const { status, data } = await apiInstance.updateBlogs(
@@ -287,7 +287,7 @@ const { status, data } = await apiInstance.updateBlogs(
287
287
  | **project** | [**string**] | What project it is | defaults to undefined|
288
288
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
289
289
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
290
- | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
290
+ | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
291
291
 
292
292
 
293
293
  ### Return type
@@ -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,6 +5,7 @@ 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|
9
10
  |[**unassignKeyphraseOpportunity**](#unassignkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign | Unassign keyphrase opportunity|
10
11
 
@@ -66,6 +67,65 @@ void (empty response body)
66
67
 
67
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)
68
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\&#39;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
+
69
129
  # **listKeyphraseOpportunities**
70
130
  > KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
71
131
 
@@ -85,7 +145,7 @@ const apiInstance = new KeyphraseOpportunitiesApi(configuration);
85
145
  let project: string; //What project it is (default to undefined)
86
146
  let pageToken: number; //Page reference token (optional) (default to 1)
87
147
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
88
- let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
148
+ let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
89
149
 
90
150
  const { status, data } = await apiInstance.listKeyphraseOpportunities(
91
151
  project,
@@ -102,7 +162,7 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
102
162
  | **project** | [**string**] | What project it is | defaults to undefined|
103
163
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
104
164
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
105
- | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
165
+ | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
106
166
 
107
167
 
108
168
  ### Return type
@@ -9,6 +9,9 @@ Name | Type | Description | Notes
9
9
  **assigned** | **Array&lt;string&gt;** | Filter by whether the keyphrase is assigned to content. | [default to undefined]
10
10
  **published** | **Array&lt;string&gt;** | Filter by whether the keyphrase is attached to published content. | [default to undefined]
11
11
  **optimised** | **Array&lt;string&gt;** | Filter by whether the keyphrase is attached to optimised content. | [default to undefined]
12
+ **sparseCollection** | **Array&lt;string&gt;** | Filter by whether the keyphrase is assigned to a collection with fewer than 12 products. | [optional] [default to undefined]
13
+ **assignedContentType** | **Array&lt;string&gt;** | Filter by the type of content the keyphrase is assigned to. | [optional] [default to undefined]
14
+ **suggestedContentType** | **Array&lt;string&gt;** | Filter by the suggested content type for the keyphrase opportunity. | [optional] [default to undefined]
12
15
 
13
16
  ## Example
14
17
 
@@ -19,6 +22,9 @@ const instance: KeyphraseOpportunitiesResponseMetaFilters = {
19
22
  assigned,
20
23
  published,
21
24
  optimised,
25
+ sparseCollection,
26
+ assignedContentType,
27
+ suggestedContentType,
22
28
  };
23
29
  ```
24
30
 
package/docs/PagesApi.md CHANGED
@@ -143,7 +143,7 @@ const apiInstance = new PagesApi(configuration);
143
143
  let project: string; //What project it is (default to undefined)
144
144
  let pageToken: number; //Page reference token (optional) (default to 1)
145
145
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
146
- let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
146
+ let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
147
147
 
148
148
  const { status, data } = await apiInstance.listPages(
149
149
  project,
@@ -160,7 +160,7 @@ const { status, data } = await apiInstance.listPages(
160
160
  | **project** | [**string**] | What project it is | defaults to undefined|
161
161
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
162
162
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
163
- | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
163
+ | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
164
164
 
165
165
 
166
166
  ### Return type
@@ -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
- > SeoOptimisePages202Response seoOptimisePages()
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
- **SeoOptimisePages202Response**
226
+ **GenerateCollectionForKeyphraseOpportunity202Response**
227
227
 
228
228
  ### Authorization
229
229
 
@@ -328,7 +328,7 @@ const apiInstance = new PagesApi(configuration);
328
328
  let project: string; //What project it is (default to undefined)
329
329
  let pageToken: number; //Page reference token (optional) (default to 1)
330
330
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
331
- let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
331
+ let search: string; //Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. (optional) (default to undefined)
332
332
  let updatePagesRequest: UpdatePagesRequest; //Update pages in bulk. (optional)
333
333
 
334
334
  const { status, data } = await apiInstance.updatePages(
@@ -348,7 +348,7 @@ const { status, data } = await apiInstance.updatePages(
348
348
  | **project** | [**string**] | What project it is | defaults to undefined|
349
349
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
350
350
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
351
- | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
351
+ | **search** | [**string**] | Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas. | (optional) defaults to undefined|
352
352
 
353
353
 
354
354
  ### Return type