@teemill/website 0.33.1 → 0.34.1

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -50,6 +50,24 @@ export const AttributeThumbnailTypeEnum = {
     Color: 'color',
     Image: 'image',
 };
+export const KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = {
+    True: 'true',
+    False: 'false',
+};
+export const KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum = {
+    True: 'true',
+    False: 'false',
+};
+export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
+    True: 'true',
+    False: 'false',
+};
+export const KeyphraseOpportunityContentTypeEnum = {
+    Product: 'product',
+    Collection: 'collection',
+    Blog: 'blog',
+    Page: 'page',
+};
 export const PaymentAccountMethodEnum = {
     Stripe: 'stripe',
     Paypal: 'paypal',
@@ -205,7 +223,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -298,7 +316,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -391,7 +409,7 @@ export const BlogsApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -428,7 +446,7 @@ export const BlogsApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1229,10 +1247,10 @@ export class FooterApi extends BaseAPI {
 export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Remove a key phrase opportunity from the store.
-         * @summary Delete key phrase opportunity
+         * Remove a keyphrase opportunity from the store.
+         * @summary Delete keyphrase opportunity
          * @param {string} project What project it is
-         * @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
+         * @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1270,12 +1288,12 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
             };
         }),
         /**
-         * List the key phrases saved as opportunities for a store that are not attached to content.
-         * @summary List key phrase opportunities
+         * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
+         * @summary List keyphrase opportunities
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1327,10 +1345,10 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
     const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration);
     return {
         /**
-         * Remove a key phrase opportunity from the store.
-         * @summary Delete key phrase opportunity
+         * Remove a keyphrase opportunity from the store.
+         * @summary Delete keyphrase opportunity
          * @param {string} project What project it is
-         * @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
+         * @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1344,12 +1362,12 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
             });
         },
         /**
-         * List the key phrases saved as opportunities for a store that are not attached to content.
-         * @summary List key phrase opportunities
+         * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
+         * @summary List keyphrase opportunities
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1371,8 +1389,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
     const localVarFp = KeyphraseOpportunitiesApiFp(configuration);
     return {
         /**
-         * Remove a key phrase opportunity from the store.
-         * @summary Delete key phrase opportunity
+         * Remove a keyphrase opportunity from the store.
+         * @summary Delete keyphrase opportunity
          * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1381,8 +1399,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
             return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
         },
         /**
-         * List the key phrases saved as opportunities for a store that are not attached to content.
-         * @summary List key phrase opportunities
+         * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
+         * @summary List keyphrase opportunities
          * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1397,8 +1415,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
  */
 export class KeyphraseOpportunitiesApi extends BaseAPI {
     /**
-     * Remove a key phrase opportunity from the store.
-     * @summary Delete key phrase opportunity
+     * Remove a keyphrase opportunity from the store.
+     * @summary Delete keyphrase opportunity
      * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1407,8 +1425,8 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
         return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * List the key phrases saved as opportunities for a store that are not attached to content.
-     * @summary List key phrase opportunities
+     * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
+     * @summary List keyphrase opportunities
      * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1684,7 +1702,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1817,7 +1835,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1910,7 +1928,7 @@ export const PagesApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -1964,7 +1982,7 @@ export const PagesApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -2868,7 +2886,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @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.
          * @param {string} [start] Start of date range to filter by
          * @param {string} [end] End of date range to filter by
@@ -3020,7 +3038,7 @@ export const ReviewsApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @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.
          * @param {string} [start] Start of date range to filter by
          * @param {string} [end] End of date range to filter by
@@ -3160,7 +3178,7 @@ export const RoutesApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -3217,7 +3235,7 @@ export const RoutesApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -3276,7 +3294,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3410,7 +3428,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -3511,7 +3529,7 @@ export const SearchApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -3565,7 +3583,7 @@ export const SearchApiFp = function (configuration) {
          * @param {string} project What project it is
          * @param {number} [pageToken] Page reference token
          * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term to filter results
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.33.1
+ * The version of the OpenAPI document: 0.34.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/BlogsApi.md

@@ -142,7 +142,7 @@ const apiInstance = new BlogsApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 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)
-let search: string; //Search term to filter results (optional) (default to undefined)
+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)
 
 const { status, data } = await apiInstance.listBlogs(
     project,
@@ -159,7 +159,7 @@ const { status, data } = await apiInstance.listBlogs(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type
@@ -267,7 +267,7 @@ const apiInstance = new BlogsApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 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)
-let search: string; //Search term to filter results (optional) (default to undefined)
+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)
 let updateBlogsRequest: UpdateBlogsRequest; //Update blogs in bulk. (optional)
 
 const { status, data } = await apiInstance.updateBlogs(
@@ -287,7 +287,7 @@ const { status, data } = await apiInstance.updateBlogs(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type

package/docs/KeyphraseOpportunitiesApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.localhost:8080*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete key phrase opportunity|
-|[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List key phrase opportunities|
+|[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity|
+|[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities|
 
 # **deleteKeyphraseOpportunity**
 > deleteKeyphraseOpportunity()
 
-Remove a key phrase opportunity from the store.
+Remove a keyphrase opportunity from the store.
 
 ### Example
 
@@ -24,7 +24,7 @@ const configuration = new Configuration();
 const apiInstance = new KeyphraseOpportunitiesApi(configuration);
 
 let project: string; //What project it is (default to undefined)
-let keyphraseOpportunityId: string; //Key phrase opportunity\'s unique identifier (default to undefined)
+let keyphraseOpportunityId: string; //Keyphrase opportunity\'s unique identifier (default to undefined)
 
 const { status, data } = await apiInstance.deleteKeyphraseOpportunity(
     project,
@@ -37,7 +37,7 @@ const { status, data } = await apiInstance.deleteKeyphraseOpportunity(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
-| **keyphraseOpportunityId** | [**string**] | Key phrase opportunity\'s unique identifier | defaults to undefined|
+| **keyphraseOpportunityId** | [**string**] | Keyphrase opportunity\'s unique identifier | defaults to undefined|
 
 
 ### Return type
@@ -57,7 +57,7 @@ void (empty response body)
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**204** | Key phrase opportunity deleted |  -  |
+|**204** | Keyphrase opportunity deleted |  -  |
 |**401** | Not authorised to access this resource |  -  |
 |**403** | Refuse to authorize |  -  |
 |**404** | Resource not found |  -  |
@@ -68,7 +68,7 @@ void (empty response body)
 # **listKeyphraseOpportunities**
 > KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
 
-List the key phrases saved as opportunities for a store that are not attached to content.
+List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
 
 ### Example
 
@@ -84,7 +84,7 @@ const apiInstance = new KeyphraseOpportunitiesApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 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)
-let search: string; //Search term to filter results (optional) (default to undefined)
+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)
 
 const { status, data } = await apiInstance.listKeyphraseOpportunities(
     project,
@@ -101,7 +101,7 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.listKeyphraseOpportunities(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | A list of key phrase opportunities saved for the store that are not attached to content. |  -  |
+|**200** | A list of keyphrase opportunities saved for the store. |  -  |
 |**401** | Not authorised to access this resource |  -  |
 |**403** | Refuse to authorize |  -  |
 |**500** | Unknown server error |  -  |

package/docs/KeyphraseOpportunitiesResponseMeta.md

@@ -6,8 +6,9 @@ Object containing metadata about the keyphrase opportunities list.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**totalPhrases** | **number** | Total number of unique keyphrases stored against the project. | [default to undefined]
-**totalMonthlyVolume** | **number** | Combined monthly volume of all keyphrases stored against the project. | [default to undefined]
+**totalPhrases** | **number** | Total number of keyphrase opportunities matching the active phrase search and list filters. | [default to undefined]
+**totalMonthlyVolume** | **number** | Combined monthly search volume of keyphrase opportunities matching the active phrase search and list filters. | [default to undefined]
+**filters** | [**KeyphraseOpportunitiesResponseMetaFilters**](KeyphraseOpportunitiesResponseMetaFilters.md) |  | [default to undefined]
 
 ## Example
 
@@ -17,6 +18,7 @@ import { KeyphraseOpportunitiesResponseMeta } from '@teemill/website';
 const instance: KeyphraseOpportunitiesResponseMeta = {
     totalPhrases,
     totalMonthlyVolume,
+    filters,
 };
 ```
 

package/docs/KeyphraseOpportunitiesResponseMetaFilters.md

@@ -0,0 +1,25 @@
+# KeyphraseOpportunitiesResponseMetaFilters
+
+Filters that can be applied to the keyphrase opportunities list.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assigned** | **Array<string>** | Filter by whether the keyphrase is assigned to content. | [default to undefined]
+**published** | **Array<string>** | Filter by whether the keyphrase is attached to published content. | [default to undefined]
+**optimised** | **Array<string>** | Filter by whether the keyphrase is attached to optimised content. | [default to undefined]
+
+## Example
+
+```typescript
+import { KeyphraseOpportunitiesResponseMetaFilters } from '@teemill/website';
+
+const instance: KeyphraseOpportunitiesResponseMetaFilters = {
+    assigned,
+    published,
+    optimised,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/KeyphraseOpportunity.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **id** | **string** |  | [default to undefined]
 **phrase** | **string** | The keyphrase that has been identified as an opportunity | [default to undefined]
 **monthlyVolume** | **number** | Monthly search volume for the keyphrase | [default to undefined]
+**merchIssues** | **Array<string>** | Merchandising issues for this keyphrase opportunity. | [default to undefined]
+**content** | [**KeyphraseOpportunityContent**](KeyphraseOpportunityContent.md) |  | [default to undefined]
 
 ## Example
 
@@ -18,6 +20,8 @@ const instance: KeyphraseOpportunity = {
     id,
     phrase,
     monthlyVolume,
+    merchIssues,
+    content,
 };
 ```
 

package/docs/KeyphraseOpportunityContent.md

@@ -0,0 +1,25 @@
+# KeyphraseOpportunityContent
+
+Content the keyphrase is assigned to.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of content the keyphrase is assigned to. | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | The name of the attached content | [default to undefined]
+
+## Example
+
+```typescript
+import { KeyphraseOpportunityContent } from '@teemill/website';
+
+const instance: KeyphraseOpportunityContent = {
+    type,
+    id,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PagesApi.md

@@ -143,7 +143,7 @@ const apiInstance = new PagesApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 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)
-let search: string; //Search term to filter results (optional) (default to undefined)
+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)
 
 const { status, data } = await apiInstance.listPages(
     project,
@@ -160,7 +160,7 @@ const { status, data } = await apiInstance.listPages(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type
@@ -328,7 +328,7 @@ const apiInstance = new PagesApi(configuration);
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
 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)
-let search: string; //Search term to filter results (optional) (default to undefined)
+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)
 let updatePagesRequest: UpdatePagesRequest; //Update pages in bulk. (optional)
 
 const { status, data } = await apiInstance.updatePages(
@@ -348,7 +348,7 @@ const { status, data } = await apiInstance.updatePages(
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
-| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **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|
 
 
 ### Return type