@teemill/website 0.13.0 → 0.15.0

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * Website API
  * Manage your PodOS Website
  *
- * The version of the OpenAPI document: 0.13.0
+ * The version of the OpenAPI document: 0.15.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -282,6 +282,12 @@ export interface Collection {
      * @memberof Collection
      */
     'slug'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Collection
+     */
+    'longDescription'?: string;
     /**
      *
      * @type {SeoMetadata}
@@ -294,6 +300,12 @@ export interface Collection {
      * @memberof Collection
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     * History of AI optimisations performed on the collection
+     * @type {Array<OptimisationHistoryItem>}
+     * @memberof Collection
+     */
+    'optimisationHistory'?: Array<OptimisationHistoryItem>;
 }
 /**
  *
@@ -314,6 +326,25 @@ export interface CollectionsResponse {
      */
     'nextPageToken'?: number | null;
 }
+/**
+ *
+ * @export
+ * @interface CreateSearchRedirectRequest
+ */
+export interface CreateSearchRedirectRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSearchRedirectRequest
+     */
+    'searchTerm': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateSearchRedirectRequest
+     */
+    'destinationUrl': string;
+}
 /**
  * Image description
  * @export
@@ -457,6 +488,25 @@ export interface MetaField {
      */
     'value': string;
 }
+/**
+ *
+ * @export
+ * @interface OptimisationHistoryItem
+ */
+export interface OptimisationHistoryItem {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof OptimisationHistoryItem
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OptimisationHistoryItem
+     */
+    'createdAt'?: string;
+}
 /**
  *
  * @export
@@ -493,6 +543,12 @@ export interface Page {
      * @memberof Page
      */
     'targetSearchPhraseData'?: TargetSearchPhraseData;
+    /**
+     * History of AI optimisations performed on the page
+     * @type {Array<OptimisationHistoryItem>}
+     * @memberof Page
+     */
+    'optimisationHistory'?: Array<OptimisationHistoryItem>;
 }
 /**
  *
@@ -819,6 +875,56 @@ export interface Route {
      */
     'published': boolean;
 }
+/**
+ *
+ * @export
+ * @interface SearchRedirect
+ */
+export interface SearchRedirect {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof SearchRedirect
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchRedirect
+     */
+    'searchTerm': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchRedirect
+     */
+    'destinationUrl': string;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchRedirect
+     */
+    'createdAt': string;
+}
+/**
+ *
+ * @export
+ * @interface SearchRedirectsResponse
+ */
+export interface SearchRedirectsResponse {
+    /**
+     *
+     * @type {Array<SearchRedirect>}
+     * @memberof SearchRedirectsResponse
+     */
+    'redirects': Array<SearchRedirect>;
+    /**
+     * The token referencing the next page number
+     * @type {number}
+     * @memberof SearchRedirectsResponse
+     */
+    'nextPageToken': number | null;
+}
 /**
  * SEO metadata for the product
  * @export
@@ -1303,6 +1409,12 @@ export interface UpdateCollectionRequest {
      * @memberof UpdateCollectionRequest
      */
     'slug'?: string;
+    /**
+     * Long-form description for the collection used for SEO.
+     * @type {string}
+     * @memberof UpdateCollectionRequest
+     */
+    'longDescription'?: string;
     /**
      *
      * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -1365,6 +1477,12 @@ export interface UpdateCollectionsRequestCollectionsInner {
      * @memberof UpdateCollectionsRequestCollectionsInner
      */
     'slug'?: string;
+    /**
+     * Long-form description for the collection used for SEO.
+     * @type {string}
+     * @memberof UpdateCollectionsRequestCollectionsInner
+     */
+    'longDescription'?: string;
     /**
      *
      * @type {UpdateCollectionsRequestCollectionsInnerSeoMetadata}
@@ -1785,6 +1903,25 @@ export interface UpdatePagesRequestPagesInner {
      */
     'targetSearchPhraseSynonyms'?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface UpdateSearchRedirectRequest
+ */
+export interface UpdateSearchRedirectRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateSearchRedirectRequest
+     */
+    'searchTerm'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateSearchRedirectRequest
+     */
+    'destinationUrl'?: string;
+}
 /**
  *
  * @export
@@ -3300,3 +3437,347 @@ export declare class RoutesApi extends BaseAPI {
      */
     listRoutes(requestParameters: RoutesApiListRoutesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRoutesResponse, any>>;
 }
+/**
+ * SearchApi - axios parameter creator
+ * @export
+ */
+export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create search redirect
+     * @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 {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSearchRedirect: (project: string, pageToken?: number, pageSize?: number, search?: string, createSearchRedirectRequest?: CreateSearchRedirectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSearchRedirect: (project: string, redirectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchRedirect: (project: string, redirectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List search redirects
+     * @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}
+     */
+    listSearchRedirects: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {UpdateSearchRedirectRequest} [updateSearchRedirectRequest] Update search redirect
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSearchRedirect: (project: string, redirectId: string, updateSearchRedirectRequest?: UpdateSearchRedirectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SearchApi - functional programming interface
+ * @export
+ */
+export declare const SearchApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Create search redirect
+     * @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 {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSearchRedirect(project: string, pageToken?: number, pageSize?: number, search?: string, createSearchRedirectRequest?: CreateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>>;
+    /**
+     *
+     * @summary Delete search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSearchRedirect(project: string, redirectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Get search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchRedirect(project: string, redirectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>>;
+    /**
+     *
+     * @summary List search redirects
+     * @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}
+     */
+    listSearchRedirects(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirectsResponse>>;
+    /**
+     *
+     * @summary Update search redirect
+     * @param {string} project What project it is
+     * @param {string} redirectId Redirect\&#39;s unique identifier
+     * @param {UpdateSearchRedirectRequest} [updateSearchRedirectRequest] Update search redirect
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSearchRedirect(project: string, redirectId: string, updateSearchRedirectRequest?: UpdateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchRedirect>>;
+};
+/**
+ * SearchApi - factory interface
+ * @export
+ */
+export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Create search redirect
+     * @param {SearchApiCreateSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSearchRedirect(requestParameters: SearchApiCreateSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect>;
+    /**
+     *
+     * @summary Delete search redirect
+     * @param {SearchApiDeleteSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSearchRedirect(requestParameters: SearchApiDeleteSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Get search redirect
+     * @param {SearchApiGetSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchRedirect(requestParameters: SearchApiGetSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect>;
+    /**
+     *
+     * @summary List search redirects
+     * @param {SearchApiListSearchRedirectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSearchRedirects(requestParameters: SearchApiListSearchRedirectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirectsResponse>;
+    /**
+     *
+     * @summary Update search redirect
+     * @param {SearchApiUpdateSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSearchRedirect(requestParameters: SearchApiUpdateSearchRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchRedirect>;
+};
+/**
+ * Request parameters for createSearchRedirect operation in SearchApi.
+ * @export
+ * @interface SearchApiCreateSearchRedirectRequest
+ */
+export interface SearchApiCreateSearchRedirectRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof SearchApiCreateSearchRedirect
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof SearchApiCreateSearchRedirect
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof SearchApiCreateSearchRedirect
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof SearchApiCreateSearchRedirect
+     */
+    readonly search?: string;
+    /**
+     * Create search redirect
+     * @type {CreateSearchRedirectRequest}
+     * @memberof SearchApiCreateSearchRedirect
+     */
+    readonly createSearchRedirectRequest?: CreateSearchRedirectRequest;
+}
+/**
+ * Request parameters for deleteSearchRedirect operation in SearchApi.
+ * @export
+ * @interface SearchApiDeleteSearchRedirectRequest
+ */
+export interface SearchApiDeleteSearchRedirectRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof SearchApiDeleteSearchRedirect
+     */
+    readonly project: string;
+    /**
+     * Redirect\&#39;s unique identifier
+     * @type {string}
+     * @memberof SearchApiDeleteSearchRedirect
+     */
+    readonly redirectId: string;
+}
+/**
+ * Request parameters for getSearchRedirect operation in SearchApi.
+ * @export
+ * @interface SearchApiGetSearchRedirectRequest
+ */
+export interface SearchApiGetSearchRedirectRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof SearchApiGetSearchRedirect
+     */
+    readonly project: string;
+    /**
+     * Redirect\&#39;s unique identifier
+     * @type {string}
+     * @memberof SearchApiGetSearchRedirect
+     */
+    readonly redirectId: string;
+}
+/**
+ * Request parameters for listSearchRedirects operation in SearchApi.
+ * @export
+ * @interface SearchApiListSearchRedirectsRequest
+ */
+export interface SearchApiListSearchRedirectsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof SearchApiListSearchRedirects
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof SearchApiListSearchRedirects
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof SearchApiListSearchRedirects
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter results
+     * @type {string}
+     * @memberof SearchApiListSearchRedirects
+     */
+    readonly search?: string;
+}
+/**
+ * Request parameters for updateSearchRedirect operation in SearchApi.
+ * @export
+ * @interface SearchApiUpdateSearchRedirectRequest
+ */
+export interface SearchApiUpdateSearchRedirectRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof SearchApiUpdateSearchRedirect
+     */
+    readonly project: string;
+    /**
+     * Redirect\&#39;s unique identifier
+     * @type {string}
+     * @memberof SearchApiUpdateSearchRedirect
+     */
+    readonly redirectId: string;
+    /**
+     * Update search redirect
+     * @type {UpdateSearchRedirectRequest}
+     * @memberof SearchApiUpdateSearchRedirect
+     */
+    readonly updateSearchRedirectRequest?: UpdateSearchRedirectRequest;
+}
+/**
+ * SearchApi - object-oriented interface
+ * @export
+ * @class SearchApi
+ * @extends {BaseAPI}
+ */
+export declare class SearchApi extends BaseAPI {
+    /**
+     *
+     * @summary Create search redirect
+     * @param {SearchApiCreateSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    createSearchRedirect(requestParameters: SearchApiCreateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchRedirect, any>>;
+    /**
+     *
+     * @summary Delete search redirect
+     * @param {SearchApiDeleteSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    deleteSearchRedirect(requestParameters: SearchApiDeleteSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Get search redirect
+     * @param {SearchApiGetSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    getSearchRedirect(requestParameters: SearchApiGetSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchRedirect, any>>;
+    /**
+     *
+     * @summary List search redirects
+     * @param {SearchApiListSearchRedirectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    listSearchRedirects(requestParameters: SearchApiListSearchRedirectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchRedirectsResponse, any>>;
+    /**
+     *
+     * @summary Update search redirect
+     * @param {SearchApiUpdateSearchRedirectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SearchApi
+     */
+    updateSearchRedirect(requestParameters: SearchApiUpdateSearchRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchRedirect, any>>;
+}