@teemill/website 0.36.0 → 0.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -25,6 +25,7 @@ docs/Domain.md
25
25
  docs/Footer.md
26
26
  docs/FooterApi.md
27
27
  docs/FooterItem.md
28
+ docs/GenerateCollectionForKeyphraseOpportunity202Response.md
28
29
  docs/Image.md
29
30
  docs/KeyphraseOpportunitiesApi.md
30
31
  docs/KeyphraseOpportunitiesResponse.md
@@ -68,7 +69,6 @@ docs/SearchApi.md
68
69
  docs/SearchRedirect.md
69
70
  docs/SearchRedirectsResponse.md
70
71
  docs/SeoMetadata.md
71
- docs/SeoOptimisePages202Response.md
72
72
  docs/SeoOptimisePagesRequest.md
73
73
  docs/Stock.md
74
74
  docs/SubmenuInner.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/website@0.36.0
1
+ ## @teemill/website@0.37.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/website@0.36.0 --save
39
+ npm install @teemill/website@0.37.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -64,6 +64,7 @@ Class | Method | HTTP request | Description
64
64
  *FooterApi* | [**getFooter**](docs/FooterApi.md#getfooter) | **GET** /v1/website/footer | Get footer
65
65
  *FooterApi* | [**updateFooter**](docs/FooterApi.md#updatefooter) | **PUT** /v1/website/footer | Update footer
66
66
  *KeyphraseOpportunitiesApi* | [**deleteKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity
67
+ *KeyphraseOpportunitiesApi* | [**generateCollectionForKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#generatecollectionforkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection | Generate collection for a keyphrase opportunity
67
68
  *KeyphraseOpportunitiesApi* | [**listKeyphraseOpportunities**](docs/KeyphraseOpportunitiesApi.md#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities
68
69
  *KeyphraseOpportunitiesApi* | [**unassignKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#unassignkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign | Unassign keyphrase opportunity
69
70
  *MenuApi* | [**getMenu**](docs/MenuApi.md#getmenu) | **GET** /v1/website/menu | Get menu
@@ -115,6 +116,7 @@ Class | Method | HTTP request | Description
115
116
  - [Domain](docs/Domain.md)
116
117
  - [Footer](docs/Footer.md)
117
118
  - [FooterItem](docs/FooterItem.md)
119
+ - [GenerateCollectionForKeyphraseOpportunity202Response](docs/GenerateCollectionForKeyphraseOpportunity202Response.md)
118
120
  - [Image](docs/Image.md)
119
121
  - [KeyphraseOpportunitiesResponse](docs/KeyphraseOpportunitiesResponse.md)
120
122
  - [KeyphraseOpportunitiesResponseMeta](docs/KeyphraseOpportunitiesResponseMeta.md)
@@ -150,7 +152,6 @@ Class | Method | HTTP request | Description
150
152
  - [SearchRedirect](docs/SearchRedirect.md)
151
153
  - [SearchRedirectsResponse](docs/SearchRedirectsResponse.md)
152
154
  - [SeoMetadata](docs/SeoMetadata.md)
153
- - [SeoOptimisePages202Response](docs/SeoOptimisePages202Response.md)
154
155
  - [SeoOptimisePagesRequest](docs/SeoOptimisePagesRequest.md)
155
156
  - [Stock](docs/Stock.md)
156
157
  - [SubmenuInner](docs/SubmenuInner.md)
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -172,6 +172,12 @@ export interface FooterItem {
172
172
  'link': string;
173
173
  'order': number;
174
174
  }
175
+ export interface GenerateCollectionForKeyphraseOpportunity202Response {
176
+ /**
177
+ * A message describing the generation status
178
+ */
179
+ 'message'?: string;
180
+ }
175
181
  /**
176
182
  * Image description
177
183
  */
@@ -669,12 +675,6 @@ export interface SeoMetadata {
669
675
  */
670
676
  'description'?: string | null;
671
677
  }
672
- export interface SeoOptimisePages202Response {
673
- /**
674
- * A message describing the optimisation status
675
- */
676
- 'message'?: string;
677
- }
678
678
  export interface SeoOptimisePagesRequest {
679
679
  /**
680
680
  * A set of page IDs to AI SEO optimise.
@@ -2577,6 +2577,54 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
2577
2577
  options: localVarRequestOptions,
2578
2578
  };
2579
2579
  },
2580
+ /**
2581
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
2582
+ * @summary Generate collection for a keyphrase opportunity
2583
+ * @param {string} project What project it is
2584
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\'s unique identifier
2585
+ * @param {*} [options] Override http request option.
2586
+ * @throws {RequiredError}
2587
+ */
2588
+ generateCollectionForKeyphraseOpportunity: async (project: string, keyphraseOpportunityId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2589
+ // verify required parameter 'project' is not null or undefined
2590
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'project', project)
2591
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
2592
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId)
2593
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
2594
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
2595
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2596
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2597
+ let baseOptions;
2598
+ if (configuration) {
2599
+ baseOptions = configuration.baseOptions;
2600
+ }
2601
+
2602
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2603
+ const localVarHeaderParameter = {} as any;
2604
+ const localVarQueryParameter = {} as any;
2605
+
2606
+ // authentication session-oauth required
2607
+ // oauth required
2608
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2609
+
2610
+ // authentication api-key required
2611
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2612
+
2613
+ if (project !== undefined) {
2614
+ localVarQueryParameter['project'] = project;
2615
+ }
2616
+
2617
+ localVarHeaderParameter['Accept'] = 'application/json';
2618
+
2619
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2620
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2621
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2622
+
2623
+ return {
2624
+ url: toPathString(localVarUrlObj),
2625
+ options: localVarRequestOptions,
2626
+ };
2627
+ },
2580
2628
  /**
2581
2629
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2582
2630
  * @summary List keyphrase opportunities
@@ -2707,6 +2755,20 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2707
2755
  const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2708
2756
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2709
2757
  },
2758
+ /**
2759
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
2760
+ * @summary Generate collection for a keyphrase opportunity
2761
+ * @param {string} project What project it is
2762
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2763
+ * @param {*} [options] Override http request option.
2764
+ * @throws {RequiredError}
2765
+ */
2766
+ async generateCollectionForKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>> {
2767
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
2768
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2769
+ const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2770
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2771
+ },
2710
2772
  /**
2711
2773
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2712
2774
  * @summary List keyphrase opportunities
@@ -2756,6 +2818,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2756
2818
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
2757
2819
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2758
2820
  },
2821
+ /**
2822
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
2823
+ * @summary Generate collection for a keyphrase opportunity
2824
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
2825
+ * @param {*} [options] Override http request option.
2826
+ * @throws {RequiredError}
2827
+ */
2828
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response> {
2829
+ return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2830
+ },
2759
2831
  /**
2760
2832
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2761
2833
  * @summary List keyphrase opportunities
@@ -2794,6 +2866,21 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
2794
2866
  readonly keyphraseOpportunityId: string
2795
2867
  }
2796
2868
 
2869
+ /**
2870
+ * Request parameters for generateCollectionForKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
2871
+ */
2872
+ export interface KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest {
2873
+ /**
2874
+ * What project it is
2875
+ */
2876
+ readonly project: string
2877
+
2878
+ /**
2879
+ * Keyphrase opportunity\&#39;s unique identifier
2880
+ */
2881
+ readonly keyphraseOpportunityId: string
2882
+ }
2883
+
2797
2884
  /**
2798
2885
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
2799
2886
  */
@@ -2849,6 +2936,17 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
2849
2936
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2850
2937
  }
2851
2938
 
2939
+ /**
2940
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
2941
+ * @summary Generate collection for a keyphrase opportunity
2942
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
2943
+ * @param {*} [options] Override http request option.
2944
+ * @throws {RequiredError}
2945
+ */
2946
+ public generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig) {
2947
+ return KeyphraseOpportunitiesApiFp(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2948
+ }
2949
+
2852
2950
  /**
2853
2951
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2854
2952
  * @summary List keyphrase opportunities
@@ -3468,7 +3566,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3468
3566
  * @param {*} [options] Override http request option.
3469
3567
  * @throws {RequiredError}
3470
3568
  */
3471
- async seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimisePages202Response>> {
3569
+ async seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>> {
3472
3570
  const localVarAxiosArgs = await localVarAxiosParamCreator.seoOptimisePages(project, seoOptimisePagesRequest, options);
3473
3571
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3474
3572
  const localVarOperationServerBasePath = operationServerMap['PagesApi.seoOptimisePages']?.[localVarOperationServerIndex]?.url;
@@ -3552,7 +3650,7 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
3552
3650
  * @param {*} [options] Override http request option.
3553
3651
  * @throws {RequiredError}
3554
3652
  */
3555
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response> {
3653
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response> {
3556
3654
  return localVarFp.seoOptimisePages(requestParameters.project, requestParameters.seoOptimisePagesRequest, options).then((request) => request(axios, basePath));
3557
3655
  },
3558
3656
  /**
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Website
4
4
  * Manage your PodOS Website
5
5
  *
6
- * The version of the OpenAPI document: 0.36.0
6
+ * The version of the OpenAPI document: 0.37.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -155,6 +155,12 @@ export interface FooterItem {
155
155
  'link': string;
156
156
  'order': number;
157
157
  }
158
+ export interface GenerateCollectionForKeyphraseOpportunity202Response {
159
+ /**
160
+ * A message describing the generation status
161
+ */
162
+ 'message'?: string;
163
+ }
158
164
  /**
159
165
  * Image description
160
166
  */
@@ -637,12 +643,6 @@ export interface SeoMetadata {
637
643
  */
638
644
  'description'?: string | null;
639
645
  }
640
- export interface SeoOptimisePages202Response {
641
- /**
642
- * A message describing the optimisation status
643
- */
644
- 'message'?: string;
645
- }
646
646
  export interface SeoOptimisePagesRequest {
647
647
  /**
648
648
  * A set of page IDs to AI SEO optimise.
@@ -1782,6 +1782,15 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
1782
1782
  * @throws {RequiredError}
1783
1783
  */
1784
1784
  deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1785
+ /**
1786
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1787
+ * @summary Generate collection for a keyphrase opportunity
1788
+ * @param {string} project What project it is
1789
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1790
+ * @param {*} [options] Override http request option.
1791
+ * @throws {RequiredError}
1792
+ */
1793
+ generateCollectionForKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1785
1794
  /**
1786
1795
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1787
1796
  * @summary List keyphrase opportunities
@@ -1816,6 +1825,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1816
1825
  * @throws {RequiredError}
1817
1826
  */
1818
1827
  deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1828
+ /**
1829
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1830
+ * @summary Generate collection for a keyphrase opportunity
1831
+ * @param {string} project What project it is
1832
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1833
+ * @param {*} [options] Override http request option.
1834
+ * @throws {RequiredError}
1835
+ */
1836
+ generateCollectionForKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
1819
1837
  /**
1820
1838
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1821
1839
  * @summary List keyphrase opportunities
@@ -1849,6 +1867,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
1849
1867
  * @throws {RequiredError}
1850
1868
  */
1851
1869
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1870
+ /**
1871
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1872
+ * @summary Generate collection for a keyphrase opportunity
1873
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1874
+ * @param {*} [options] Override http request option.
1875
+ * @throws {RequiredError}
1876
+ */
1877
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
1852
1878
  /**
1853
1879
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1854
1880
  * @summary List keyphrase opportunities
@@ -1879,6 +1905,19 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
1879
1905
  */
1880
1906
  readonly keyphraseOpportunityId: string;
1881
1907
  }
1908
+ /**
1909
+ * Request parameters for generateCollectionForKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
1910
+ */
1911
+ export interface KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest {
1912
+ /**
1913
+ * What project it is
1914
+ */
1915
+ readonly project: string;
1916
+ /**
1917
+ * Keyphrase opportunity\&#39;s unique identifier
1918
+ */
1919
+ readonly keyphraseOpportunityId: string;
1920
+ }
1882
1921
  /**
1883
1922
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
1884
1923
  */
@@ -1925,6 +1964,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1925
1964
  * @throws {RequiredError}
1926
1965
  */
1927
1966
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1967
+ /**
1968
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1969
+ * @summary Generate collection for a keyphrase opportunity
1970
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1971
+ * @param {*} [options] Override http request option.
1972
+ * @throws {RequiredError}
1973
+ */
1974
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
1928
1975
  /**
1929
1976
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1930
1977
  * @summary List keyphrase opportunities
@@ -2154,7 +2201,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2154
2201
  * @param {*} [options] Override http request option.
2155
2202
  * @throws {RequiredError}
2156
2203
  */
2157
- seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimisePages202Response>>;
2204
+ seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
2158
2205
  /**
2159
2206
  *
2160
2207
  * @summary Update website page
@@ -2213,7 +2260,7 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
2213
2260
  * @param {*} [options] Override http request option.
2214
2261
  * @throws {RequiredError}
2215
2262
  */
2216
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response>;
2263
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
2217
2264
  /**
2218
2265
  *
2219
2266
  * @summary Update website page
@@ -2361,7 +2408,7 @@ export declare class PagesApi extends BaseAPI {
2361
2408
  * @param {*} [options] Override http request option.
2362
2409
  * @throws {RequiredError}
2363
2410
  */
2364
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimisePages202Response, any, {}>>;
2411
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
2365
2412
  /**
2366
2413
  *
2367
2414
  * @summary Update website page
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.36.0
8
+ * The version of the OpenAPI document: 0.37.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1311,6 +1311,47 @@ const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration) {
1311
1311
  options: localVarRequestOptions,
1312
1312
  };
1313
1313
  }),
1314
+ /**
1315
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1316
+ * @summary Generate collection for a keyphrase opportunity
1317
+ * @param {string} project What project it is
1318
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1319
+ * @param {*} [options] Override http request option.
1320
+ * @throws {RequiredError}
1321
+ */
1322
+ generateCollectionForKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
1323
+ // verify required parameter 'project' is not null or undefined
1324
+ (0, common_1.assertParamExists)('generateCollectionForKeyphraseOpportunity', 'project', project);
1325
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
1326
+ (0, common_1.assertParamExists)('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
1327
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
1328
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
1329
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1330
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1331
+ let baseOptions;
1332
+ if (configuration) {
1333
+ baseOptions = configuration.baseOptions;
1334
+ }
1335
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1336
+ const localVarHeaderParameter = {};
1337
+ const localVarQueryParameter = {};
1338
+ // authentication session-oauth required
1339
+ // oauth required
1340
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
1341
+ // authentication api-key required
1342
+ yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
1343
+ if (project !== undefined) {
1344
+ localVarQueryParameter['project'] = project;
1345
+ }
1346
+ localVarHeaderParameter['Accept'] = 'application/json';
1347
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1348
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1349
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1350
+ return {
1351
+ url: (0, common_1.toPathString)(localVarUrlObj),
1352
+ options: localVarRequestOptions,
1353
+ };
1354
+ }),
1314
1355
  /**
1315
1356
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1316
1357
  * @summary List keyphrase opportunities
@@ -1427,6 +1468,23 @@ const KeyphraseOpportunitiesApiFp = function (configuration) {
1427
1468
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1428
1469
  });
1429
1470
  },
1471
+ /**
1472
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1473
+ * @summary Generate collection for a keyphrase opportunity
1474
+ * @param {string} project What project it is
1475
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1476
+ * @param {*} [options] Override http request option.
1477
+ * @throws {RequiredError}
1478
+ */
1479
+ generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
1480
+ return __awaiter(this, void 0, void 0, function* () {
1481
+ var _a, _b, _c;
1482
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
1483
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1484
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1485
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1486
+ });
1487
+ },
1430
1488
  /**
1431
1489
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1432
1490
  * @summary List keyphrase opportunities
@@ -1482,6 +1540,16 @@ const KeyphraseOpportunitiesApiFactory = function (configuration, basePath, axio
1482
1540
  deleteKeyphraseOpportunity(requestParameters, options) {
1483
1541
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1484
1542
  },
1543
+ /**
1544
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1545
+ * @summary Generate collection for a keyphrase opportunity
1546
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1547
+ * @param {*} [options] Override http request option.
1548
+ * @throws {RequiredError}
1549
+ */
1550
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1551
+ return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1552
+ },
1485
1553
  /**
1486
1554
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1487
1555
  * @summary List keyphrase opportunities
@@ -1519,6 +1587,16 @@ class KeyphraseOpportunitiesApi extends base_1.BaseAPI {
1519
1587
  deleteKeyphraseOpportunity(requestParameters, options) {
1520
1588
  return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1521
1589
  }
1590
+ /**
1591
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1592
+ * @summary Generate collection for a keyphrase opportunity
1593
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1594
+ * @param {*} [options] Override http request option.
1595
+ * @throws {RequiredError}
1596
+ */
1597
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1598
+ return (0, exports.KeyphraseOpportunitiesApiFp)(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1599
+ }
1522
1600
  /**
1523
1601
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1524
1602
  * @summary List keyphrase opportunities
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.36.0
8
+ * The version of the OpenAPI document: 0.37.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.36.0
8
+ * The version of the OpenAPI document: 0.37.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -155,6 +155,12 @@ export interface FooterItem {
155
155
  'link': string;
156
156
  'order': number;
157
157
  }
158
+ export interface GenerateCollectionForKeyphraseOpportunity202Response {
159
+ /**
160
+ * A message describing the generation status
161
+ */
162
+ 'message'?: string;
163
+ }
158
164
  /**
159
165
  * Image description
160
166
  */
@@ -637,12 +643,6 @@ export interface SeoMetadata {
637
643
  */
638
644
  'description'?: string | null;
639
645
  }
640
- export interface SeoOptimisePages202Response {
641
- /**
642
- * A message describing the optimisation status
643
- */
644
- 'message'?: string;
645
- }
646
646
  export interface SeoOptimisePagesRequest {
647
647
  /**
648
648
  * A set of page IDs to AI SEO optimise.
@@ -1782,6 +1782,15 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
1782
1782
  * @throws {RequiredError}
1783
1783
  */
1784
1784
  deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1785
+ /**
1786
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1787
+ * @summary Generate collection for a keyphrase opportunity
1788
+ * @param {string} project What project it is
1789
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1790
+ * @param {*} [options] Override http request option.
1791
+ * @throws {RequiredError}
1792
+ */
1793
+ generateCollectionForKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1785
1794
  /**
1786
1795
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1787
1796
  * @summary List keyphrase opportunities
@@ -1816,6 +1825,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1816
1825
  * @throws {RequiredError}
1817
1826
  */
1818
1827
  deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1828
+ /**
1829
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1830
+ * @summary Generate collection for a keyphrase opportunity
1831
+ * @param {string} project What project it is
1832
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1833
+ * @param {*} [options] Override http request option.
1834
+ * @throws {RequiredError}
1835
+ */
1836
+ generateCollectionForKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
1819
1837
  /**
1820
1838
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1821
1839
  * @summary List keyphrase opportunities
@@ -1849,6 +1867,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
1849
1867
  * @throws {RequiredError}
1850
1868
  */
1851
1869
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1870
+ /**
1871
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1872
+ * @summary Generate collection for a keyphrase opportunity
1873
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1874
+ * @param {*} [options] Override http request option.
1875
+ * @throws {RequiredError}
1876
+ */
1877
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
1852
1878
  /**
1853
1879
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1854
1880
  * @summary List keyphrase opportunities
@@ -1879,6 +1905,19 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
1879
1905
  */
1880
1906
  readonly keyphraseOpportunityId: string;
1881
1907
  }
1908
+ /**
1909
+ * Request parameters for generateCollectionForKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
1910
+ */
1911
+ export interface KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest {
1912
+ /**
1913
+ * What project it is
1914
+ */
1915
+ readonly project: string;
1916
+ /**
1917
+ * Keyphrase opportunity\&#39;s unique identifier
1918
+ */
1919
+ readonly keyphraseOpportunityId: string;
1920
+ }
1882
1921
  /**
1883
1922
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
1884
1923
  */
@@ -1925,6 +1964,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1925
1964
  * @throws {RequiredError}
1926
1965
  */
1927
1966
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1967
+ /**
1968
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1969
+ * @summary Generate collection for a keyphrase opportunity
1970
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1971
+ * @param {*} [options] Override http request option.
1972
+ * @throws {RequiredError}
1973
+ */
1974
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
1928
1975
  /**
1929
1976
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1930
1977
  * @summary List keyphrase opportunities
@@ -2154,7 +2201,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2154
2201
  * @param {*} [options] Override http request option.
2155
2202
  * @throws {RequiredError}
2156
2203
  */
2157
- seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimisePages202Response>>;
2204
+ seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>>;
2158
2205
  /**
2159
2206
  *
2160
2207
  * @summary Update website page
@@ -2213,7 +2260,7 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
2213
2260
  * @param {*} [options] Override http request option.
2214
2261
  * @throws {RequiredError}
2215
2262
  */
2216
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response>;
2263
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
2217
2264
  /**
2218
2265
  *
2219
2266
  * @summary Update website page
@@ -2361,7 +2408,7 @@ export declare class PagesApi extends BaseAPI {
2361
2408
  * @param {*} [options] Override http request option.
2362
2409
  * @throws {RequiredError}
2363
2410
  */
2364
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimisePages202Response, any, {}>>;
2411
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
2365
2412
  /**
2366
2413
  *
2367
2414
  * @summary Update website page
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1287,6 +1287,47 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
1287
1287
  options: localVarRequestOptions,
1288
1288
  };
1289
1289
  }),
1290
+ /**
1291
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1292
+ * @summary Generate collection for a keyphrase opportunity
1293
+ * @param {string} project What project it is
1294
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1295
+ * @param {*} [options] Override http request option.
1296
+ * @throws {RequiredError}
1297
+ */
1298
+ generateCollectionForKeyphraseOpportunity: (project_1, keyphraseOpportunityId_1, ...args_1) => __awaiter(this, [project_1, keyphraseOpportunityId_1, ...args_1], void 0, function* (project, keyphraseOpportunityId, options = {}) {
1299
+ // verify required parameter 'project' is not null or undefined
1300
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'project', project);
1301
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
1302
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId);
1303
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
1304
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
1305
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1306
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1307
+ let baseOptions;
1308
+ if (configuration) {
1309
+ baseOptions = configuration.baseOptions;
1310
+ }
1311
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
1312
+ const localVarHeaderParameter = {};
1313
+ const localVarQueryParameter = {};
1314
+ // authentication session-oauth required
1315
+ // oauth required
1316
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1317
+ // authentication api-key required
1318
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1319
+ if (project !== undefined) {
1320
+ localVarQueryParameter['project'] = project;
1321
+ }
1322
+ localVarHeaderParameter['Accept'] = 'application/json';
1323
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1324
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1325
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1326
+ return {
1327
+ url: toPathString(localVarUrlObj),
1328
+ options: localVarRequestOptions,
1329
+ };
1330
+ }),
1290
1331
  /**
1291
1332
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1292
1333
  * @summary List keyphrase opportunities
@@ -1402,6 +1443,23 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
1402
1443
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1403
1444
  });
1404
1445
  },
1446
+ /**
1447
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1448
+ * @summary Generate collection for a keyphrase opportunity
1449
+ * @param {string} project What project it is
1450
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1451
+ * @param {*} [options] Override http request option.
1452
+ * @throws {RequiredError}
1453
+ */
1454
+ generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options) {
1455
+ return __awaiter(this, void 0, void 0, function* () {
1456
+ var _a, _b, _c;
1457
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
1458
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1459
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1460
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1461
+ });
1462
+ },
1405
1463
  /**
1406
1464
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1407
1465
  * @summary List keyphrase opportunities
@@ -1456,6 +1514,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
1456
1514
  deleteKeyphraseOpportunity(requestParameters, options) {
1457
1515
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1458
1516
  },
1517
+ /**
1518
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1519
+ * @summary Generate collection for a keyphrase opportunity
1520
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1521
+ * @param {*} [options] Override http request option.
1522
+ * @throws {RequiredError}
1523
+ */
1524
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1525
+ return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1526
+ },
1459
1527
  /**
1460
1528
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1461
1529
  * @summary List keyphrase opportunities
@@ -1492,6 +1560,16 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
1492
1560
  deleteKeyphraseOpportunity(requestParameters, options) {
1493
1561
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1494
1562
  }
1563
+ /**
1564
+ * Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
1565
+ * @summary Generate collection for a keyphrase opportunity
1566
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
1567
+ * @param {*} [options] Override http request option.
1568
+ * @throws {RequiredError}
1569
+ */
1570
+ generateCollectionForKeyphraseOpportunity(requestParameters, options) {
1571
+ return KeyphraseOpportunitiesApiFp(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1572
+ }
1495
1573
  /**
1496
1574
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1497
1575
  * @summary List keyphrase opportunities
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Website
4
4
  * Manage your PodOS Website
5
5
  *
6
- * The version of the OpenAPI document: 0.36.0
6
+ * The version of the OpenAPI document: 0.37.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.36.0
5
+ * The version of the OpenAPI document: 0.37.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.36.0
8
+ * The version of the OpenAPI document: 0.37.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,20 @@
1
+ # GenerateCollectionForKeyphraseOpportunity202Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | A message describing the generation status | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { GenerateCollectionForKeyphraseOpportunity202Response } from '@teemill/website';
14
+
15
+ const instance: GenerateCollectionForKeyphraseOpportunity202Response = {
16
+ message,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.localhost:8080*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteKeyphraseOpportunity**](#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity|
8
+ |[**generateCollectionForKeyphraseOpportunity**](#generatecollectionforkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection | Generate collection for a keyphrase opportunity|
8
9
  |[**listKeyphraseOpportunities**](#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities|
9
10
  |[**unassignKeyphraseOpportunity**](#unassignkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign | Unassign keyphrase opportunity|
10
11
 
@@ -66,6 +67,65 @@ void (empty response body)
66
67
 
67
68
  [[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)
68
69
 
70
+ # **generateCollectionForKeyphraseOpportunity**
71
+ > GenerateCollectionForKeyphraseOpportunity202Response generateCollectionForKeyphraseOpportunity()
72
+
73
+ Queue AI collection generation for a keyphrase opportunity. A new collection will be created with the primary keyphrase from the opportunity, a set of relevant products will be attached, and the collection will be AI SEO optimised.
74
+
75
+ ### Example
76
+
77
+ ```typescript
78
+ import {
79
+ KeyphraseOpportunitiesApi,
80
+ Configuration
81
+ } from '@teemill/website';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new KeyphraseOpportunitiesApi(configuration);
85
+
86
+ let project: string; //What project it is (default to undefined)
87
+ let keyphraseOpportunityId: string; //Keyphrase opportunity\'s unique identifier (default to undefined)
88
+
89
+ const { status, data } = await apiInstance.generateCollectionForKeyphraseOpportunity(
90
+ project,
91
+ keyphraseOpportunityId
92
+ );
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ |Name | Type | Description | Notes|
98
+ |------------- | ------------- | ------------- | -------------|
99
+ | **project** | [**string**] | What project it is | defaults to undefined|
100
+ | **keyphraseOpportunityId** | [**string**] | Keyphrase opportunity\&#39;s unique identifier | defaults to undefined|
101
+
102
+
103
+ ### Return type
104
+
105
+ **GenerateCollectionForKeyphraseOpportunity202Response**
106
+
107
+ ### Authorization
108
+
109
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: Not defined
114
+ - **Accept**: application/json
115
+
116
+
117
+ ### HTTP response details
118
+ | Status code | Description | Response headers |
119
+ |-------------|-------------|------------------|
120
+ |**202** | Collection generation queued. When complete, a notification will be sent to the PodOS Dashboard, which will include a link to the new collection. | - |
121
+ |**400** | Failed validation | - |
122
+ |**401** | Not authorised to access this resource | - |
123
+ |**403** | Refuse to authorize | - |
124
+ |**404** | Resource not found | - |
125
+ |**500** | Unknown server error | - |
126
+
127
+ [[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)
128
+
69
129
  # **listKeyphraseOpportunities**
70
130
  > KeyphraseOpportunitiesResponse listKeyphraseOpportunities()
71
131
 
package/docs/PagesApi.md CHANGED
@@ -188,7 +188,7 @@ const { status, data } = await apiInstance.listPages(
188
188
  [[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)
189
189
 
190
190
  # **seoOptimisePages**
191
- > SeoOptimisePages202Response seoOptimisePages()
191
+ > GenerateCollectionForKeyphraseOpportunity202Response seoOptimisePages()
192
192
 
193
193
  AI SEO optimises pages by a set of given IDs.
194
194
 
@@ -223,7 +223,7 @@ const { status, data } = await apiInstance.seoOptimisePages(
223
223
 
224
224
  ### Return type
225
225
 
226
- **SeoOptimisePages202Response**
226
+ **GenerateCollectionForKeyphraseOpportunity202Response**
227
227
 
228
228
  ### Authorization
229
229
 
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.36.0
7
+ * The version of the OpenAPI document: 0.37.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/website",
3
- "version": "0.36.0",
3
+ "version": "0.37.0",
4
4
  "description": "OpenAPI client for @teemill/website",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {