@teemill/website 0.35.1 → 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.35.1
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.35.1 --save
39
+ npm install @teemill/website@0.37.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -64,7 +64,9 @@ 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
69
+ *KeyphraseOpportunitiesApi* | [**unassignKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#unassignkeyphraseopportunity) | **POST** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign | Unassign keyphrase opportunity
68
70
  *MenuApi* | [**getMenu**](docs/MenuApi.md#getmenu) | **GET** /v1/website/menu | Get menu
69
71
  *MenuApi* | [**updateMenu**](docs/MenuApi.md#updatemenu) | **PUT** /v1/website/menu | Update menu
70
72
  *PagesApi* | [**exportPages**](docs/PagesApi.md#exportpages) | **GET** /v1/website/pages/export | Export pages
@@ -114,6 +116,7 @@ Class | Method | HTTP request | Description
114
116
  - [Domain](docs/Domain.md)
115
117
  - [Footer](docs/Footer.md)
116
118
  - [FooterItem](docs/FooterItem.md)
119
+ - [GenerateCollectionForKeyphraseOpportunity202Response](docs/GenerateCollectionForKeyphraseOpportunity202Response.md)
117
120
  - [Image](docs/Image.md)
118
121
  - [KeyphraseOpportunitiesResponse](docs/KeyphraseOpportunitiesResponse.md)
119
122
  - [KeyphraseOpportunitiesResponseMeta](docs/KeyphraseOpportunitiesResponseMeta.md)
@@ -149,7 +152,6 @@ Class | Method | HTTP request | Description
149
152
  - [SearchRedirect](docs/SearchRedirect.md)
150
153
  - [SearchRedirectsResponse](docs/SearchRedirectsResponse.md)
151
154
  - [SeoMetadata](docs/SeoMetadata.md)
152
- - [SeoOptimisePages202Response](docs/SeoOptimisePages202Response.md)
153
155
  - [SeoOptimisePagesRequest](docs/SeoOptimisePagesRequest.md)
154
156
  - [Stock](docs/Stock.md)
155
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.35.1
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
@@ -2631,6 +2679,54 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
2631
2679
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2632
2680
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2633
2681
 
2682
+ return {
2683
+ url: toPathString(localVarUrlObj),
2684
+ options: localVarRequestOptions,
2685
+ };
2686
+ },
2687
+ /**
2688
+ * Detach the currently assigned content from a keyphrase opportunity.
2689
+ * @summary Unassign keyphrase opportunity
2690
+ * @param {string} project What project it is
2691
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2692
+ * @param {*} [options] Override http request option.
2693
+ * @throws {RequiredError}
2694
+ */
2695
+ unassignKeyphraseOpportunity: async (project: string, keyphraseOpportunityId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2696
+ // verify required parameter 'project' is not null or undefined
2697
+ assertParamExists('unassignKeyphraseOpportunity', 'project', project)
2698
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
2699
+ assertParamExists('unassignKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId)
2700
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/unassign`
2701
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
2702
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2703
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2704
+ let baseOptions;
2705
+ if (configuration) {
2706
+ baseOptions = configuration.baseOptions;
2707
+ }
2708
+
2709
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2710
+ const localVarHeaderParameter = {} as any;
2711
+ const localVarQueryParameter = {} as any;
2712
+
2713
+ // authentication session-oauth required
2714
+ // oauth required
2715
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2716
+
2717
+ // authentication api-key required
2718
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2719
+
2720
+ if (project !== undefined) {
2721
+ localVarQueryParameter['project'] = project;
2722
+ }
2723
+
2724
+ localVarHeaderParameter['Accept'] = 'application/json';
2725
+
2726
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2727
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2728
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2729
+
2634
2730
  return {
2635
2731
  url: toPathString(localVarUrlObj),
2636
2732
  options: localVarRequestOptions,
@@ -2659,6 +2755,20 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2659
2755
  const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2660
2756
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2661
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
+ },
2662
2772
  /**
2663
2773
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2664
2774
  * @summary List keyphrase opportunities
@@ -2675,6 +2785,20 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2675
2785
  const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.listKeyphraseOpportunities']?.[localVarOperationServerIndex]?.url;
2676
2786
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2677
2787
  },
2788
+ /**
2789
+ * Detach the currently assigned content from a keyphrase opportunity.
2790
+ * @summary Unassign keyphrase opportunity
2791
+ * @param {string} project What project it is
2792
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2793
+ * @param {*} [options] Override http request option.
2794
+ * @throws {RequiredError}
2795
+ */
2796
+ async unassignKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
2797
+ const localVarAxiosArgs = await localVarAxiosParamCreator.unassignKeyphraseOpportunity(project, keyphraseOpportunityId, options);
2798
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2799
+ const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.unassignKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2800
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2801
+ },
2678
2802
  }
2679
2803
  };
2680
2804
 
@@ -2694,6 +2818,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2694
2818
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
2695
2819
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2696
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
+ },
2697
2831
  /**
2698
2832
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2699
2833
  * @summary List keyphrase opportunities
@@ -2704,6 +2838,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2704
2838
  listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse> {
2705
2839
  return localVarFp.listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
2706
2840
  },
2841
+ /**
2842
+ * Detach the currently assigned content from a keyphrase opportunity.
2843
+ * @summary Unassign keyphrase opportunity
2844
+ * @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
2845
+ * @param {*} [options] Override http request option.
2846
+ * @throws {RequiredError}
2847
+ */
2848
+ unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
2849
+ return localVarFp.unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2850
+ },
2707
2851
  };
2708
2852
  };
2709
2853
 
@@ -2722,6 +2866,21 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
2722
2866
  readonly keyphraseOpportunityId: string
2723
2867
  }
2724
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
+
2725
2884
  /**
2726
2885
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
2727
2886
  */
@@ -2747,6 +2906,21 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
2747
2906
  readonly search?: string
2748
2907
  }
2749
2908
 
2909
+ /**
2910
+ * Request parameters for unassignKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
2911
+ */
2912
+ export interface KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest {
2913
+ /**
2914
+ * What project it is
2915
+ */
2916
+ readonly project: string
2917
+
2918
+ /**
2919
+ * Keyphrase opportunity\&#39;s unique identifier
2920
+ */
2921
+ readonly keyphraseOpportunityId: string
2922
+ }
2923
+
2750
2924
  /**
2751
2925
  * KeyphraseOpportunitiesApi - object-oriented interface
2752
2926
  */
@@ -2762,6 +2936,17 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
2762
2936
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2763
2937
  }
2764
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
+
2765
2950
  /**
2766
2951
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2767
2952
  * @summary List keyphrase opportunities
@@ -2772,6 +2957,17 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
2772
2957
  public listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig) {
2773
2958
  return KeyphraseOpportunitiesApiFp(this.configuration).listKeyphraseOpportunities(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
2774
2959
  }
2960
+
2961
+ /**
2962
+ * Detach the currently assigned content from a keyphrase opportunity.
2963
+ * @summary Unassign keyphrase opportunity
2964
+ * @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
2965
+ * @param {*} [options] Override http request option.
2966
+ * @throws {RequiredError}
2967
+ */
2968
+ public unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig) {
2969
+ return KeyphraseOpportunitiesApiFp(this.configuration).unassignKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2970
+ }
2775
2971
  }
2776
2972
 
2777
2973
 
@@ -3370,7 +3566,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3370
3566
  * @param {*} [options] Override http request option.
3371
3567
  * @throws {RequiredError}
3372
3568
  */
3373
- 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>> {
3374
3570
  const localVarAxiosArgs = await localVarAxiosParamCreator.seoOptimisePages(project, seoOptimisePagesRequest, options);
3375
3571
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3376
3572
  const localVarOperationServerBasePath = operationServerMap['PagesApi.seoOptimisePages']?.[localVarOperationServerIndex]?.url;
@@ -3454,7 +3650,7 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
3454
3650
  * @param {*} [options] Override http request option.
3455
3651
  * @throws {RequiredError}
3456
3652
  */
3457
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response> {
3653
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response> {
3458
3654
  return localVarFp.seoOptimisePages(requestParameters.project, requestParameters.seoOptimisePagesRequest, options).then((request) => request(axios, basePath));
3459
3655
  },
3460
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.35.1
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.35.1
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.35.1
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.35.1
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
@@ -1793,6 +1802,15 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
1793
1802
  * @throws {RequiredError}
1794
1803
  */
1795
1804
  listKeyphraseOpportunities: (project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1805
+ /**
1806
+ * Detach the currently assigned content from a keyphrase opportunity.
1807
+ * @summary Unassign keyphrase opportunity
1808
+ * @param {string} project What project it is
1809
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1810
+ * @param {*} [options] Override http request option.
1811
+ * @throws {RequiredError}
1812
+ */
1813
+ unassignKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1796
1814
  };
1797
1815
  /**
1798
1816
  * KeyphraseOpportunitiesApi - functional programming interface
@@ -1807,6 +1825,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1807
1825
  * @throws {RequiredError}
1808
1826
  */
1809
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>>;
1810
1837
  /**
1811
1838
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1812
1839
  * @summary List keyphrase opportunities
@@ -1818,6 +1845,15 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1818
1845
  * @throws {RequiredError}
1819
1846
  */
1820
1847
  listKeyphraseOpportunities(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KeyphraseOpportunitiesResponse>>;
1848
+ /**
1849
+ * Detach the currently assigned content from a keyphrase opportunity.
1850
+ * @summary Unassign keyphrase opportunity
1851
+ * @param {string} project What project it is
1852
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1853
+ * @param {*} [options] Override http request option.
1854
+ * @throws {RequiredError}
1855
+ */
1856
+ unassignKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1821
1857
  };
1822
1858
  /**
1823
1859
  * KeyphraseOpportunitiesApi - factory interface
@@ -1831,6 +1867,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
1831
1867
  * @throws {RequiredError}
1832
1868
  */
1833
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>;
1834
1878
  /**
1835
1879
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1836
1880
  * @summary List keyphrase opportunities
@@ -1839,6 +1883,14 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
1839
1883
  * @throws {RequiredError}
1840
1884
  */
1841
1885
  listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<KeyphraseOpportunitiesResponse>;
1886
+ /**
1887
+ * Detach the currently assigned content from a keyphrase opportunity.
1888
+ * @summary Unassign keyphrase opportunity
1889
+ * @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
1890
+ * @param {*} [options] Override http request option.
1891
+ * @throws {RequiredError}
1892
+ */
1893
+ unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1842
1894
  };
1843
1895
  /**
1844
1896
  * Request parameters for deleteKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
@@ -1853,6 +1905,19 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
1853
1905
  */
1854
1906
  readonly keyphraseOpportunityId: string;
1855
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
+ }
1856
1921
  /**
1857
1922
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
1858
1923
  */
@@ -1874,6 +1939,19 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
1874
1939
  */
1875
1940
  readonly search?: string;
1876
1941
  }
1942
+ /**
1943
+ * Request parameters for unassignKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
1944
+ */
1945
+ export interface KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest {
1946
+ /**
1947
+ * What project it is
1948
+ */
1949
+ readonly project: string;
1950
+ /**
1951
+ * Keyphrase opportunity\&#39;s unique identifier
1952
+ */
1953
+ readonly keyphraseOpportunityId: string;
1954
+ }
1877
1955
  /**
1878
1956
  * KeyphraseOpportunitiesApi - object-oriented interface
1879
1957
  */
@@ -1886,6 +1964,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1886
1964
  * @throws {RequiredError}
1887
1965
  */
1888
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, {}>>;
1889
1975
  /**
1890
1976
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1891
1977
  * @summary List keyphrase opportunities
@@ -1894,6 +1980,14 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1894
1980
  * @throws {RequiredError}
1895
1981
  */
1896
1982
  listKeyphraseOpportunities(requestParameters: KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KeyphraseOpportunitiesResponse, any, {}>>;
1983
+ /**
1984
+ * Detach the currently assigned content from a keyphrase opportunity.
1985
+ * @summary Unassign keyphrase opportunity
1986
+ * @param {KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest} requestParameters Request parameters.
1987
+ * @param {*} [options] Override http request option.
1988
+ * @throws {RequiredError}
1989
+ */
1990
+ unassignKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiUnassignKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1897
1991
  }
1898
1992
  /**
1899
1993
  * MenuApi - axios parameter creator
@@ -2107,7 +2201,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2107
2201
  * @param {*} [options] Override http request option.
2108
2202
  * @throws {RequiredError}
2109
2203
  */
2110
- 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>>;
2111
2205
  /**
2112
2206
  *
2113
2207
  * @summary Update website page
@@ -2166,7 +2260,7 @@ export declare const PagesApiFactory: (configuration?: Configuration, basePath?:
2166
2260
  * @param {*} [options] Override http request option.
2167
2261
  * @throws {RequiredError}
2168
2262
  */
2169
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response>;
2263
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>;
2170
2264
  /**
2171
2265
  *
2172
2266
  * @summary Update website page
@@ -2314,7 +2408,7 @@ export declare class PagesApi extends BaseAPI {
2314
2408
  * @param {*} [options] Override http request option.
2315
2409
  * @throws {RequiredError}
2316
2410
  */
2317
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SeoOptimisePages202Response, any, {}>>;
2411
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateCollectionForKeyphraseOpportunity202Response, any, {}>>;
2318
2412
  /**
2319
2413
  *
2320
2414
  * @summary Update website page