@teemill/website 0.32.0 → 0.34.0

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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.32.0
+ * The version of the OpenAPI document: 0.34.0
  *
  *
  * 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 key phrase 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 key phrase 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 key phrase 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 key phrase 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

@@ -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 key phrases 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 key phrase 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 key phrase 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 key phrase opportunities saved for the store. |  -  |
 |**401** | Not authorised to access this resource |  -  |
 |**403** | Refuse to authorize |  -  |
 |**500** | Unknown server error |  -  |

package/docs/KeyphraseOpportunitiesResponse.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **keyphraseOpportunities** | [**Array<KeyphraseOpportunity>**](KeyphraseOpportunity.md) |  | [default to undefined]
+**meta** | [**KeyphraseOpportunitiesResponseMeta**](KeyphraseOpportunitiesResponseMeta.md) |  | [default to undefined]
 **nextPageToken** | **number** | The token referencing the next page number | [default to undefined]
 
 ## Example
@@ -15,6 +16,7 @@ import { KeyphraseOpportunitiesResponse } from '@teemill/website';
 
 const instance: KeyphraseOpportunitiesResponse = {
     keyphraseOpportunities,
+    meta,
     nextPageToken,
 };
 ```

package/docs/KeyphraseOpportunitiesResponseMeta.md

@@ -0,0 +1,25 @@
+# KeyphraseOpportunitiesResponseMeta
+
+Object containing metadata about the keyphrase opportunities list.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```typescript
+import { KeyphraseOpportunitiesResponseMeta } from '@teemill/website';
+
+const instance: KeyphraseOpportunitiesResponseMeta = {
+    totalPhrases,
+    totalMonthlyVolume,
+    filters,
+};
+```
+
+[[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/KeyphraseOpportunitiesResponseMetaFilters.md

@@ -0,0 +1,25 @@
+# KeyphraseOpportunitiesResponseMetaFilters
+
+Filters that can be applied to the key phrase opportunities list.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assigned** | **Array<string>** | Filter by whether the key phrase is assigned to content. | [default to undefined]
+**published** | **Array<string>** | Filter by whether the key phrase is attached to published content. | [default to undefined]
+**optimised** | **Array<string>** | Filter by whether the key phrase 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

@@ -6,8 +6,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** |  | [default to undefined]
-**phrase** | **string** |  | [default to undefined]
-**monthlyVolume** | **number** |  | [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 key phrase 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
+
+Product or collection the key phrase is assigned to.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | The name of the product or collection | [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 key phrase 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 key phrase 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 key phrase 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 key phrase 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/ReviewsApi.md

@@ -147,7 +147,7 @@ const apiInstance = new ReviewsApi(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 key phrase 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 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)
 let start: string; //Start of date range to filter by (optional) (default to undefined)
 let end: string; //End of date range to filter by (optional) (default to undefined)
@@ -170,7 +170,7 @@ const { status, data } = await apiInstance.listReviews(
 | **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 key phrase 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|
 | **sortBy** | **Array&lt;string&gt;** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
 | **start** | [**string**] | Start of date range to filter by | (optional) defaults to undefined|
 | **end** | [**string**] | End of date range to filter by | (optional) defaults to undefined|

package/docs/RoutesApi.md

@@ -24,7 +24,7 @@ const apiInstance = new RoutesApi(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 key phrase 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.listRoutes(
     project,
@@ -41,7 +41,7 @@ const { status, data } = await apiInstance.listRoutes(
 | **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 key phrase 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/SearchApi.md

@@ -29,7 +29,7 @@ const apiInstance = new SearchApi(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 key phrase 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 createSearchRedirectRequest: CreateSearchRedirectRequest; //Create search redirect (optional)
 
 const { status, data } = await apiInstance.createSearchRedirect(
@@ -49,7 +49,7 @@ const { status, data } = await apiInstance.createSearchRedirect(
 | **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 key phrase 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
@@ -210,7 +210,7 @@ const apiInstance = new SearchApi(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 key phrase 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.listSearchRedirects(
     project,
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.listSearchRedirects(
 | **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 key phrase 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/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/website",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "OpenAPI client for @teemill/website",
   "author": "OpenAPI-Generator Contributors",
   "repository": {