@teemill/website 0.31.5 → 0.33.1

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.31.5
+ * The version of the OpenAPI document: 0.33.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1223,6 +1223,200 @@ export class FooterApi extends BaseAPI {
         return FooterApiFp(this.configuration).updateFooter(requestParameters.project, requestParameters.updateFooterRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * KeyphraseOpportunitiesApi - axios parameter creator
+ */
+export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Remove a key phrase opportunity from the store.
+         * @summary Delete key phrase opportunity
+         * @param {string} project What project it is
+         * @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('deleteKeyphraseOpportunity', 'project', project);
+            // verify required parameter 'keyphraseOpportunityId' is not null or undefined
+            assertParamExists('deleteKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
+            const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}`
+                .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * List the key phrases saved as opportunities for a store that are not attached to content.
+         * @summary List key phrase 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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listKeyphraseOpportunities: (project_1, pageToken_1, pageSize_1, search_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, options = {}) {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listKeyphraseOpportunities', 'project', project);
+            const localVarPath = `/v1/website/keyphrase-opportunities`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication session-oauth required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
+            // authentication api-key required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * KeyphraseOpportunitiesApi - functional programming interface
+ */
+export const KeyphraseOpportunitiesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Remove a key phrase opportunity from the store.
+         * @summary Delete key phrase opportunity
+         * @param {string} project What project it is
+         * @param {string} keyphraseOpportunityId Key phrase opportunity\'s unique identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteKeyphraseOpportunity(project, keyphraseOpportunityId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * List the key phrases saved as opportunities for a store that are not attached to content.
+         * @summary List key phrase 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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listKeyphraseOpportunities(project, pageToken, pageSize, search, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listKeyphraseOpportunities(project, pageToken, pageSize, search, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.listKeyphraseOpportunities']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * KeyphraseOpportunitiesApi - factory interface
+ */
+export const KeyphraseOpportunitiesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = KeyphraseOpportunitiesApiFp(configuration);
+    return {
+        /**
+         * Remove a key phrase opportunity from the store.
+         * @summary Delete key phrase opportunity
+         * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteKeyphraseOpportunity(requestParameters, options) {
+            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
+         * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listKeyphraseOpportunities(requestParameters, options) {
+            return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * KeyphraseOpportunitiesApi - object-oriented interface
+ */
+export class KeyphraseOpportunitiesApi extends BaseAPI {
+    /**
+     * Remove a key phrase opportunity from the store.
+     * @summary Delete key phrase opportunity
+     * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteKeyphraseOpportunity(requestParameters, options) {
+        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
+     * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listKeyphraseOpportunities(requestParameters, options) {
+        return KeyphraseOpportunitiesApiFp(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * MenuApi - axios parameter creator
  */

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,6 +48,11 @@ export declare const setOAuthToObject: (object: any, name: string, scopes: strin
  * @export
  */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ * JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
+ * @export
+ */
+export declare const replaceWithSerializableTypeIfNeeded: (_key: string, value: unknown) => unknown;
 /**
  *
  * @export

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.31.5
+ * The version of the OpenAPI document: 0.33.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -91,7 +91,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
     if (parameter == null)
         return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key !== '' ? `${key}[]` : key));
         }
         else {
@@ -116,6 +116,16 @@ export const setSearchParams = function (url, ...objects) {
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
+/**
+ * JSON.stringify replacer used by generated API code (e.g. serializes Set as Array).
+ * @export
+ */
+export const replaceWithSerializableTypeIfNeeded = function (_key, value) {
+    if (value instanceof Set) {
+        return Array.from(value);
+    }
+    return value;
+};
 /**
  *
  * @export
@@ -126,7 +136,7 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
+        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
         : (value || "");
 };
 /**

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.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.31.5
+ * The version of the OpenAPI document: 0.33.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/KeyphraseOpportunitiesApi.md

@@ -0,0 +1,130 @@
+# KeyphraseOpportunitiesApi
+
+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()
+
+Remove a key phrase opportunity from the store.
+
+### Example
+
+```typescript
+import {
+    KeyphraseOpportunitiesApi,
+    Configuration
+} from '@teemill/website';
+
+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)
+
+const { status, data } = await apiInstance.deleteKeyphraseOpportunity(
+    project,
+    keyphraseOpportunityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | What project it is | defaults to undefined|
+| **keyphraseOpportunityId** | [**string**] | Key phrase opportunity\'s unique identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Key phrase opportunity deleted |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listKeyphraseOpportunities**
+> KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
+
+List the key phrases saved as opportunities for a store that are not attached to content.
+
+### Example
+
+```typescript
+import {
+    KeyphraseOpportunitiesApi,
+    Configuration
+} from '@teemill/website';
+
+const configuration = new Configuration();
+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)
+
+const { status, data } = await apiInstance.listKeyphraseOpportunities(
+    project,
+    pageToken,
+    pageSize,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+
+
+### Return type
+
+**KeyphraseOpportunitiesResponse**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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. |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/KeyphraseOpportunitiesResponse.md

@@ -0,0 +1,24 @@
+# KeyphraseOpportunitiesResponse
+
+
+## Properties
+
+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
+
+```typescript
+import { KeyphraseOpportunitiesResponse } from '@teemill/website';
+
+const instance: KeyphraseOpportunitiesResponse = {
+    keyphraseOpportunities,
+    meta,
+    nextPageToken,
+};
+```
+
+[[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/KeyphraseOpportunitiesResponseMeta.md

@@ -0,0 +1,23 @@
+# KeyphraseOpportunitiesResponseMeta
+
+Object containing metadata about the keyphrase opportunities list.
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { KeyphraseOpportunitiesResponseMeta } from '@teemill/website';
+
+const instance: KeyphraseOpportunitiesResponseMeta = {
+    totalPhrases,
+    totalMonthlyVolume,
+};
+```
+
+[[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

@@ -0,0 +1,24 @@
+# KeyphraseOpportunity
+
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { KeyphraseOpportunity } from '@teemill/website';
+
+const instance: KeyphraseOpportunity = {
+    id,
+    phrase,
+    monthlyVolume,
+};
+```
+
+[[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/index.ts

@@ -4,7 +4,7 @@
  * Website
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.31.5
+ * The version of the OpenAPI document: 0.33.1
  * 
  *
  * 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.31.5",
+  "version": "0.33.1",
   "description": "OpenAPI client for @teemill/website",
   "author": "OpenAPI-Generator Contributors",
   "repository": {