@teemill/website 0.34.0 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/api.ts +63 -54
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +63 -54
- package/dist/api.js +39 -37
- 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 +63 -54
- package/dist/esm/api.js +39 -37
- 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/BlogsApi.md +4 -4
- package/docs/KeyphraseOpportunitiesApi.md +10 -10
- package/docs/KeyphraseOpportunitiesResponseMetaFilters.md +4 -4
- package/docs/KeyphraseOpportunity.md +1 -1
- package/docs/KeyphraseOpportunityContent.md +5 -3
- package/docs/PagesApi.md +4 -4
- package/docs/ReviewsApi.md +2 -2
- package/docs/RoutesApi.md +2 -2
- package/docs/SearchApi.md +4 -4
- 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.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -65,6 +65,8 @@ export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
|
|
|
65
65
|
export const KeyphraseOpportunityContentTypeEnum = {
|
|
66
66
|
Product: 'product',
|
|
67
67
|
Collection: 'collection',
|
|
68
|
+
Blog: 'blog',
|
|
69
|
+
Page: 'page',
|
|
68
70
|
};
|
|
69
71
|
export const PaymentAccountMethodEnum = {
|
|
70
72
|
Stripe: 'stripe',
|
|
@@ -221,7 +223,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
|
|
|
221
223
|
* @param {string} project What project it is
|
|
222
224
|
* @param {number} [pageToken] Page reference token
|
|
223
225
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
224
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
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.
|
|
225
227
|
* @param {*} [options] Override http request option.
|
|
226
228
|
* @throws {RequiredError}
|
|
227
229
|
*/
|
|
@@ -314,7 +316,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
|
|
|
314
316
|
* @param {string} project What project it is
|
|
315
317
|
* @param {number} [pageToken] Page reference token
|
|
316
318
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
317
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
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.
|
|
318
320
|
* @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
|
|
319
321
|
* @param {*} [options] Override http request option.
|
|
320
322
|
* @throws {RequiredError}
|
|
@@ -407,7 +409,7 @@ export const BlogsApiFp = function (configuration) {
|
|
|
407
409
|
* @param {string} project What project it is
|
|
408
410
|
* @param {number} [pageToken] Page reference token
|
|
409
411
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
410
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
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.
|
|
411
413
|
* @param {*} [options] Override http request option.
|
|
412
414
|
* @throws {RequiredError}
|
|
413
415
|
*/
|
|
@@ -444,7 +446,7 @@ export const BlogsApiFp = function (configuration) {
|
|
|
444
446
|
* @param {string} project What project it is
|
|
445
447
|
* @param {number} [pageToken] Page reference token
|
|
446
448
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
447
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
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.
|
|
448
450
|
* @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
|
|
449
451
|
* @param {*} [options] Override http request option.
|
|
450
452
|
* @throws {RequiredError}
|
|
@@ -1245,10 +1247,10 @@ export class FooterApi extends BaseAPI {
|
|
|
1245
1247
|
export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
|
|
1246
1248
|
return {
|
|
1247
1249
|
/**
|
|
1248
|
-
* Remove a
|
|
1249
|
-
* @summary Delete
|
|
1250
|
+
* Remove a keyphrase opportunity from the store.
|
|
1251
|
+
* @summary Delete keyphrase opportunity
|
|
1250
1252
|
* @param {string} project What project it is
|
|
1251
|
-
* @param {string} keyphraseOpportunityId
|
|
1253
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1252
1254
|
* @param {*} [options] Override http request option.
|
|
1253
1255
|
* @throws {RequiredError}
|
|
1254
1256
|
*/
|
|
@@ -1286,12 +1288,12 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
|
|
|
1286
1288
|
};
|
|
1287
1289
|
}),
|
|
1288
1290
|
/**
|
|
1289
|
-
* List
|
|
1290
|
-
* @summary List
|
|
1291
|
+
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1292
|
+
* @summary List keyphrase opportunities
|
|
1291
1293
|
* @param {string} project What project it is
|
|
1292
1294
|
* @param {number} [pageToken] Page reference token
|
|
1293
1295
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1294
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
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.
|
|
1295
1297
|
* @param {*} [options] Override http request option.
|
|
1296
1298
|
* @throws {RequiredError}
|
|
1297
1299
|
*/
|
|
@@ -1343,10 +1345,10 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1343
1345
|
const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration);
|
|
1344
1346
|
return {
|
|
1345
1347
|
/**
|
|
1346
|
-
* Remove a
|
|
1347
|
-
* @summary Delete
|
|
1348
|
+
* Remove a keyphrase opportunity from the store.
|
|
1349
|
+
* @summary Delete keyphrase opportunity
|
|
1348
1350
|
* @param {string} project What project it is
|
|
1349
|
-
* @param {string} keyphraseOpportunityId
|
|
1351
|
+
* @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
|
|
1350
1352
|
* @param {*} [options] Override http request option.
|
|
1351
1353
|
* @throws {RequiredError}
|
|
1352
1354
|
*/
|
|
@@ -1360,12 +1362,12 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
|
|
|
1360
1362
|
});
|
|
1361
1363
|
},
|
|
1362
1364
|
/**
|
|
1363
|
-
* List
|
|
1364
|
-
* @summary List
|
|
1365
|
+
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1366
|
+
* @summary List keyphrase opportunities
|
|
1365
1367
|
* @param {string} project What project it is
|
|
1366
1368
|
* @param {number} [pageToken] Page reference token
|
|
1367
1369
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1368
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
1370
|
+
* @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.
|
|
1369
1371
|
* @param {*} [options] Override http request option.
|
|
1370
1372
|
* @throws {RequiredError}
|
|
1371
1373
|
*/
|
|
@@ -1387,8 +1389,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
|
|
|
1387
1389
|
const localVarFp = KeyphraseOpportunitiesApiFp(configuration);
|
|
1388
1390
|
return {
|
|
1389
1391
|
/**
|
|
1390
|
-
* Remove a
|
|
1391
|
-
* @summary Delete
|
|
1392
|
+
* Remove a keyphrase opportunity from the store.
|
|
1393
|
+
* @summary Delete keyphrase opportunity
|
|
1392
1394
|
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1393
1395
|
* @param {*} [options] Override http request option.
|
|
1394
1396
|
* @throws {RequiredError}
|
|
@@ -1397,8 +1399,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
|
|
|
1397
1399
|
return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
|
|
1398
1400
|
},
|
|
1399
1401
|
/**
|
|
1400
|
-
* List
|
|
1401
|
-
* @summary List
|
|
1402
|
+
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1403
|
+
* @summary List keyphrase opportunities
|
|
1402
1404
|
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
1403
1405
|
* @param {*} [options] Override http request option.
|
|
1404
1406
|
* @throws {RequiredError}
|
|
@@ -1413,8 +1415,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
|
|
|
1413
1415
|
*/
|
|
1414
1416
|
export class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
1415
1417
|
/**
|
|
1416
|
-
* Remove a
|
|
1417
|
-
* @summary Delete
|
|
1418
|
+
* Remove a keyphrase opportunity from the store.
|
|
1419
|
+
* @summary Delete keyphrase opportunity
|
|
1418
1420
|
* @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
|
|
1419
1421
|
* @param {*} [options] Override http request option.
|
|
1420
1422
|
* @throws {RequiredError}
|
|
@@ -1423,8 +1425,8 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
|
|
|
1423
1425
|
return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
|
|
1424
1426
|
}
|
|
1425
1427
|
/**
|
|
1426
|
-
* List
|
|
1427
|
-
* @summary List
|
|
1428
|
+
* List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
1429
|
+
* @summary List keyphrase opportunities
|
|
1428
1430
|
* @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
|
|
1429
1431
|
* @param {*} [options] Override http request option.
|
|
1430
1432
|
* @throws {RequiredError}
|
|
@@ -1700,7 +1702,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
|
|
|
1700
1702
|
* @param {string} project What project it is
|
|
1701
1703
|
* @param {number} [pageToken] Page reference token
|
|
1702
1704
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1703
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
1705
|
+
* @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.
|
|
1704
1706
|
* @param {*} [options] Override http request option.
|
|
1705
1707
|
* @throws {RequiredError}
|
|
1706
1708
|
*/
|
|
@@ -1833,7 +1835,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
|
|
|
1833
1835
|
* @param {string} project What project it is
|
|
1834
1836
|
* @param {number} [pageToken] Page reference token
|
|
1835
1837
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1836
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
1838
|
+
* @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.
|
|
1837
1839
|
* @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
|
|
1838
1840
|
* @param {*} [options] Override http request option.
|
|
1839
1841
|
* @throws {RequiredError}
|
|
@@ -1926,7 +1928,7 @@ export const PagesApiFp = function (configuration) {
|
|
|
1926
1928
|
* @param {string} project What project it is
|
|
1927
1929
|
* @param {number} [pageToken] Page reference token
|
|
1928
1930
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1929
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
1931
|
+
* @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.
|
|
1930
1932
|
* @param {*} [options] Override http request option.
|
|
1931
1933
|
* @throws {RequiredError}
|
|
1932
1934
|
*/
|
|
@@ -1980,7 +1982,7 @@ export const PagesApiFp = function (configuration) {
|
|
|
1980
1982
|
* @param {string} project What project it is
|
|
1981
1983
|
* @param {number} [pageToken] Page reference token
|
|
1982
1984
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1983
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
1985
|
+
* @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.
|
|
1984
1986
|
* @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
|
|
1985
1987
|
* @param {*} [options] Override http request option.
|
|
1986
1988
|
* @throws {RequiredError}
|
|
@@ -2884,7 +2886,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
|
|
|
2884
2886
|
* @param {string} project What project it is
|
|
2885
2887
|
* @param {number} [pageToken] Page reference token
|
|
2886
2888
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2887
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
2889
|
+
* @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.
|
|
2888
2890
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2889
2891
|
* @param {string} [start] Start of date range to filter by
|
|
2890
2892
|
* @param {string} [end] End of date range to filter by
|
|
@@ -3036,7 +3038,7 @@ export const ReviewsApiFp = function (configuration) {
|
|
|
3036
3038
|
* @param {string} project What project it is
|
|
3037
3039
|
* @param {number} [pageToken] Page reference token
|
|
3038
3040
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3039
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3041
|
+
* @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.
|
|
3040
3042
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3041
3043
|
* @param {string} [start] Start of date range to filter by
|
|
3042
3044
|
* @param {string} [end] End of date range to filter by
|
|
@@ -3176,7 +3178,7 @@ export const RoutesApiAxiosParamCreator = function (configuration) {
|
|
|
3176
3178
|
* @param {string} project What project it is
|
|
3177
3179
|
* @param {number} [pageToken] Page reference token
|
|
3178
3180
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3179
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3181
|
+
* @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.
|
|
3180
3182
|
* @param {*} [options] Override http request option.
|
|
3181
3183
|
* @throws {RequiredError}
|
|
3182
3184
|
*/
|
|
@@ -3233,7 +3235,7 @@ export const RoutesApiFp = function (configuration) {
|
|
|
3233
3235
|
* @param {string} project What project it is
|
|
3234
3236
|
* @param {number} [pageToken] Page reference token
|
|
3235
3237
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3236
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3238
|
+
* @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.
|
|
3237
3239
|
* @param {*} [options] Override http request option.
|
|
3238
3240
|
* @throws {RequiredError}
|
|
3239
3241
|
*/
|
|
@@ -3292,7 +3294,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
3292
3294
|
* @param {string} project What project it is
|
|
3293
3295
|
* @param {number} [pageToken] Page reference token
|
|
3294
3296
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3295
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3297
|
+
* @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.
|
|
3296
3298
|
* @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
|
|
3297
3299
|
* @param {*} [options] Override http request option.
|
|
3298
3300
|
* @throws {RequiredError}
|
|
@@ -3426,7 +3428,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
|
|
|
3426
3428
|
* @param {string} project What project it is
|
|
3427
3429
|
* @param {number} [pageToken] Page reference token
|
|
3428
3430
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3429
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3431
|
+
* @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.
|
|
3430
3432
|
* @param {*} [options] Override http request option.
|
|
3431
3433
|
* @throws {RequiredError}
|
|
3432
3434
|
*/
|
|
@@ -3527,7 +3529,7 @@ export const SearchApiFp = function (configuration) {
|
|
|
3527
3529
|
* @param {string} project What project it is
|
|
3528
3530
|
* @param {number} [pageToken] Page reference token
|
|
3529
3531
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3530
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3532
|
+
* @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.
|
|
3531
3533
|
* @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
|
|
3532
3534
|
* @param {*} [options] Override http request option.
|
|
3533
3535
|
* @throws {RequiredError}
|
|
@@ -3581,7 +3583,7 @@ export const SearchApiFp = function (configuration) {
|
|
|
3581
3583
|
* @param {string} project What project it is
|
|
3582
3584
|
* @param {number} [pageToken] Page reference token
|
|
3583
3585
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3584
|
-
* @param {string} [search] Search term to filter results. Free text matches
|
|
3586
|
+
* @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.
|
|
3585
3587
|
* @param {*} [options] Override http request option.
|
|
3586
3588
|
* @throws {RequiredError}
|
|
3587
3589
|
*/
|
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
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
|
|
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)
|
|
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
|
|
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|
|
|
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
|
|
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)
|
|
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
|
|
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|
|
|
291
291
|
|
|
292
292
|
|
|
293
293
|
### Return type
|
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete
|
|
8
|
-
|[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List
|
|
7
|
+
|[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity|
|
|
8
|
+
|[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities|
|
|
9
9
|
|
|
10
10
|
# **deleteKeyphraseOpportunity**
|
|
11
11
|
> deleteKeyphraseOpportunity()
|
|
12
12
|
|
|
13
|
-
Remove a
|
|
13
|
+
Remove a keyphrase opportunity from the store.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -24,7 +24,7 @@ const configuration = new Configuration();
|
|
|
24
24
|
const apiInstance = new KeyphraseOpportunitiesApi(configuration);
|
|
25
25
|
|
|
26
26
|
let project: string; //What project it is (default to undefined)
|
|
27
|
-
let keyphraseOpportunityId: string; //
|
|
27
|
+
let keyphraseOpportunityId: string; //Keyphrase opportunity\'s unique identifier (default to undefined)
|
|
28
28
|
|
|
29
29
|
const { status, data } = await apiInstance.deleteKeyphraseOpportunity(
|
|
30
30
|
project,
|
|
@@ -37,7 +37,7 @@ const { status, data } = await apiInstance.deleteKeyphraseOpportunity(
|
|
|
37
37
|
|Name | Type | Description | Notes|
|
|
38
38
|
|------------- | ------------- | ------------- | -------------|
|
|
39
39
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
40
|
-
| **keyphraseOpportunityId** | [**string**] |
|
|
40
|
+
| **keyphraseOpportunityId** | [**string**] | Keyphrase opportunity\'s unique identifier | defaults to undefined|
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### Return type
|
|
@@ -57,7 +57,7 @@ void (empty response body)
|
|
|
57
57
|
### HTTP response details
|
|
58
58
|
| Status code | Description | Response headers |
|
|
59
59
|
|-------------|-------------|------------------|
|
|
60
|
-
|**204** |
|
|
60
|
+
|**204** | Keyphrase opportunity deleted | - |
|
|
61
61
|
|**401** | Not authorised to access this resource | - |
|
|
62
62
|
|**403** | Refuse to authorize | - |
|
|
63
63
|
|**404** | Resource not found | - |
|
|
@@ -68,7 +68,7 @@ void (empty response body)
|
|
|
68
68
|
# **listKeyphraseOpportunities**
|
|
69
69
|
> KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
|
|
70
70
|
|
|
71
|
-
List
|
|
71
|
+
List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -84,7 +84,7 @@ const apiInstance = new KeyphraseOpportunitiesApi(configuration);
|
|
|
84
84
|
let project: string; //What project it is (default to undefined)
|
|
85
85
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
86
86
|
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)
|
|
87
|
-
let search: string; //Search term to filter results. Free text matches
|
|
87
|
+
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)
|
|
88
88
|
|
|
89
89
|
const { status, data } = await apiInstance.listKeyphraseOpportunities(
|
|
90
90
|
project,
|
|
@@ -101,7 +101,7 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
|
|
|
101
101
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
102
102
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
103
103
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
104
|
-
| **search** | [**string**] | Search term to filter results. Free text matches
|
|
104
|
+
| **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|
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
|
|
|
121
121
|
### HTTP response details
|
|
122
122
|
| Status code | Description | Response headers |
|
|
123
123
|
|-------------|-------------|------------------|
|
|
124
|
-
|**200** | A list of
|
|
124
|
+
|**200** | A list of keyphrase opportunities saved for the store. | - |
|
|
125
125
|
|**401** | Not authorised to access this resource | - |
|
|
126
126
|
|**403** | Refuse to authorize | - |
|
|
127
127
|
|**500** | Unknown server error | - |
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# KeyphraseOpportunitiesResponseMetaFilters
|
|
2
2
|
|
|
3
|
-
Filters that can be applied to the
|
|
3
|
+
Filters that can be applied to the keyphrase opportunities list.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**assigned** | **Array<string>** | Filter by whether the
|
|
10
|
-
**published** | **Array<string>** | Filter by whether the
|
|
11
|
-
**optimised** | **Array<string>** | Filter by whether the
|
|
9
|
+
**assigned** | **Array<string>** | Filter by whether the keyphrase is assigned to content. | [default to undefined]
|
|
10
|
+
**published** | **Array<string>** | Filter by whether the keyphrase is attached to published content. | [default to undefined]
|
|
11
|
+
**optimised** | **Array<string>** | Filter by whether the keyphrase is attached to optimised content. | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**phrase** | **string** | The keyphrase that has been identified as an opportunity | [default to undefined]
|
|
10
10
|
**monthlyVolume** | **number** | Monthly search volume for the keyphrase | [default to undefined]
|
|
11
|
-
**merchIssues** | **Array<string>** | Merchandising issues for this
|
|
11
|
+
**merchIssues** | **Array<string>** | Merchandising issues for this keyphrase opportunity. | [default to undefined]
|
|
12
12
|
**content** | [**KeyphraseOpportunityContent**](KeyphraseOpportunityContent.md) | | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
# KeyphraseOpportunityContent
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Content the keyphrase is assigned to.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**type** | **string** |
|
|
9
|
+
**type** | **string** | The type of content the keyphrase is assigned to. | [default to undefined]
|
|
10
10
|
**id** | **string** | | [default to undefined]
|
|
11
|
-
**name** | **string** | The name of the
|
|
11
|
+
**name** | **string** | The name of the attached content | [default to undefined]
|
|
12
|
+
**slug** | **string** | The URL slug of the attached content, if applicable. | [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -19,6 +20,7 @@ const instance: KeyphraseOpportunityContent = {
|
|
|
19
20
|
type,
|
|
20
21
|
id,
|
|
21
22
|
name,
|
|
23
|
+
slug,
|
|
22
24
|
};
|
|
23
25
|
```
|
|
24
26
|
|
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
|
|
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)
|
|
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
|
|
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|
|
|
164
164
|
|
|
165
165
|
|
|
166
166
|
### Return type
|
|
@@ -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
|
|
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)
|
|
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
|
|
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|
|
|
352
352
|
|
|
353
353
|
|
|
354
354
|
### Return type
|
package/docs/ReviewsApi.md
CHANGED
|
@@ -147,7 +147,7 @@ const apiInstance = new ReviewsApi(configuration);
|
|
|
147
147
|
let project: string; //What project it is (default to undefined)
|
|
148
148
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
149
149
|
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)
|
|
150
|
-
let search: string; //Search term to filter results. Free text matches
|
|
150
|
+
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)
|
|
151
151
|
let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
|
|
152
152
|
let start: string; //Start of date range to filter by (optional) (default to undefined)
|
|
153
153
|
let end: string; //End of date range to filter by (optional) (default to undefined)
|
|
@@ -170,7 +170,7 @@ const { status, data } = await apiInstance.listReviews(
|
|
|
170
170
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
171
171
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
172
172
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
173
|
-
| **search** | [**string**] | Search term to filter results. Free text matches
|
|
173
|
+
| **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|
|
|
174
174
|
| **sortBy** | **Array<string>** | An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. | (optional) defaults to undefined|
|
|
175
175
|
| **start** | [**string**] | Start of date range to filter by | (optional) defaults to undefined|
|
|
176
176
|
| **end** | [**string**] | End of date range to filter by | (optional) defaults to undefined|
|
package/docs/RoutesApi.md
CHANGED
|
@@ -24,7 +24,7 @@ const apiInstance = new RoutesApi(configuration);
|
|
|
24
24
|
let project: string; //What project it is (default to undefined)
|
|
25
25
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
26
26
|
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)
|
|
27
|
-
let search: string; //Search term to filter results. Free text matches
|
|
27
|
+
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)
|
|
28
28
|
|
|
29
29
|
const { status, data } = await apiInstance.listRoutes(
|
|
30
30
|
project,
|
|
@@ -41,7 +41,7 @@ const { status, data } = await apiInstance.listRoutes(
|
|
|
41
41
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
42
42
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
43
43
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
44
|
-
| **search** | [**string**] | Search term to filter results. Free text matches
|
|
44
|
+
| **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|
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### Return type
|