@teemill/website 0.36.0 → 0.37.1

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.1
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.1 --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.1
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
  */
@@ -229,6 +235,18 @@ export interface KeyphraseOpportunitiesResponseMetaFilters {
229
235
  * Filter by whether the keyphrase is attached to optimised content.
230
236
  */
231
237
  'optimised': Array<KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum>;
238
+ /**
239
+ * Filter by whether the keyphrase is assigned to a collection with fewer than 12 products.
240
+ */
241
+ 'sparseCollection'?: Array<KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum>;
242
+ /**
243
+ * Filter by the type of content the keyphrase is assigned to.
244
+ */
245
+ 'assignedContentType'?: Array<KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum>;
246
+ /**
247
+ * Filter by the suggested content type for the keyphrase opportunity.
248
+ */
249
+ 'suggestedContentType'?: Array<KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum>;
232
250
  }
233
251
 
234
252
  export const KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = {
@@ -249,6 +267,24 @@ export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
249
267
  } as const;
250
268
 
251
269
  export type KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum];
270
+ export const KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum = {
271
+ True: 'true',
272
+ False: 'false',
273
+ } as const;
274
+
275
+ export type KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersSparseCollectionEnum];
276
+ export const KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum = {
277
+ Product: 'product',
278
+ Collection: 'collection',
279
+ } as const;
280
+
281
+ export type KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedContentTypeEnum];
282
+ export const KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum = {
283
+ Product: 'product',
284
+ Collection: 'collection',
285
+ } as const;
286
+
287
+ export type KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersSuggestedContentTypeEnum];
252
288
 
253
289
  export interface KeyphraseOpportunity {
254
290
  'id': string;
@@ -669,12 +705,6 @@ export interface SeoMetadata {
669
705
  */
670
706
  'description'?: string | null;
671
707
  }
672
- export interface SeoOptimisePages202Response {
673
- /**
674
- * A message describing the optimisation status
675
- */
676
- 'message'?: string;
677
- }
678
708
  export interface SeoOptimisePagesRequest {
679
709
  /**
680
710
  * A set of page IDs to AI SEO optimise.
@@ -1233,7 +1263,7 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
1233
1263
  * @param {string} project What project it is
1234
1264
  * @param {number} [pageToken] Page reference token
1235
1265
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1236
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1266
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1237
1267
  * @param {*} [options] Override http request option.
1238
1268
  * @throws {RequiredError}
1239
1269
  */
@@ -1343,7 +1373,7 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
1343
1373
  * @param {string} project What project it is
1344
1374
  * @param {number} [pageToken] Page reference token
1345
1375
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1346
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1376
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1347
1377
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1348
1378
  * @param {*} [options] Override http request option.
1349
1379
  * @throws {RequiredError}
@@ -1441,7 +1471,7 @@ export const BlogsApiFp = function(configuration?: Configuration) {
1441
1471
  * @param {string} project What project it is
1442
1472
  * @param {number} [pageToken] Page reference token
1443
1473
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1444
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1474
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1445
1475
  * @param {*} [options] Override http request option.
1446
1476
  * @throws {RequiredError}
1447
1477
  */
@@ -1472,7 +1502,7 @@ export const BlogsApiFp = function(configuration?: Configuration) {
1472
1502
  * @param {string} project What project it is
1473
1503
  * @param {number} [pageToken] Page reference token
1474
1504
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1475
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1505
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1476
1506
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1477
1507
  * @param {*} [options] Override http request option.
1478
1508
  * @throws {RequiredError}
@@ -1590,7 +1620,7 @@ export interface BlogsApiListBlogsRequest {
1590
1620
  readonly pageSize?: number
1591
1621
 
1592
1622
  /**
1593
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1623
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1594
1624
  */
1595
1625
  readonly search?: string
1596
1626
  }
@@ -1632,7 +1662,7 @@ export interface BlogsApiUpdateBlogsRequest {
1632
1662
  readonly pageSize?: number
1633
1663
 
1634
1664
  /**
1635
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
1665
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
1636
1666
  */
1637
1667
  readonly search?: string
1638
1668
 
@@ -2577,13 +2607,61 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
2577
2607
  options: localVarRequestOptions,
2578
2608
  };
2579
2609
  },
2610
+ /**
2611
+ * 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.
2612
+ * @summary Generate collection for a keyphrase opportunity
2613
+ * @param {string} project What project it is
2614
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2615
+ * @param {*} [options] Override http request option.
2616
+ * @throws {RequiredError}
2617
+ */
2618
+ generateCollectionForKeyphraseOpportunity: async (project: string, keyphraseOpportunityId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2619
+ // verify required parameter 'project' is not null or undefined
2620
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'project', project)
2621
+ // verify required parameter 'keyphraseOpportunityId' is not null or undefined
2622
+ assertParamExists('generateCollectionForKeyphraseOpportunity', 'keyphraseOpportunityId', keyphraseOpportunityId)
2623
+ const localVarPath = `/v1/website/keyphrase-opportunities/{keyphraseOpportunityId}/generate-collection`
2624
+ .replace('{keyphraseOpportunityId}', encodeURIComponent(String(keyphraseOpportunityId)));
2625
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2626
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2627
+ let baseOptions;
2628
+ if (configuration) {
2629
+ baseOptions = configuration.baseOptions;
2630
+ }
2631
+
2632
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2633
+ const localVarHeaderParameter = {} as any;
2634
+ const localVarQueryParameter = {} as any;
2635
+
2636
+ // authentication session-oauth required
2637
+ // oauth required
2638
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
2639
+
2640
+ // authentication api-key required
2641
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2642
+
2643
+ if (project !== undefined) {
2644
+ localVarQueryParameter['project'] = project;
2645
+ }
2646
+
2647
+ localVarHeaderParameter['Accept'] = 'application/json';
2648
+
2649
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2650
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2651
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2652
+
2653
+ return {
2654
+ url: toPathString(localVarUrlObj),
2655
+ options: localVarRequestOptions,
2656
+ };
2657
+ },
2580
2658
  /**
2581
2659
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2582
2660
  * @summary List keyphrase opportunities
2583
2661
  * @param {string} project What project it is
2584
2662
  * @param {number} [pageToken] Page reference token
2585
2663
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2586
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2664
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2587
2665
  * @param {*} [options] Override http request option.
2588
2666
  * @throws {RequiredError}
2589
2667
  */
@@ -2707,13 +2785,27 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2707
2785
  const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.deleteKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2708
2786
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2709
2787
  },
2788
+ /**
2789
+ * 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.
2790
+ * @summary Generate collection for a 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 generateCollectionForKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>> {
2797
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateCollectionForKeyphraseOpportunity(project, keyphraseOpportunityId, options);
2798
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2799
+ const localVarOperationServerBasePath = operationServerMap['KeyphraseOpportunitiesApi.generateCollectionForKeyphraseOpportunity']?.[localVarOperationServerIndex]?.url;
2800
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2801
+ },
2710
2802
  /**
2711
2803
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2712
2804
  * @summary List keyphrase opportunities
2713
2805
  * @param {string} project What project it is
2714
2806
  * @param {number} [pageToken] Page reference token
2715
2807
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2716
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2808
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2717
2809
  * @param {*} [options] Override http request option.
2718
2810
  * @throws {RequiredError}
2719
2811
  */
@@ -2756,6 +2848,16 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2756
2848
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
2757
2849
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2758
2850
  },
2851
+ /**
2852
+ * 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.
2853
+ * @summary Generate collection for a keyphrase opportunity
2854
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
2855
+ * @param {*} [options] Override http request option.
2856
+ * @throws {RequiredError}
2857
+ */
2858
+ generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response> {
2859
+ return localVarFp.generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2860
+ },
2759
2861
  /**
2760
2862
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2761
2863
  * @summary List keyphrase opportunities
@@ -2794,6 +2896,21 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
2794
2896
  readonly keyphraseOpportunityId: string
2795
2897
  }
2796
2898
 
2899
+ /**
2900
+ * Request parameters for generateCollectionForKeyphraseOpportunity operation in KeyphraseOpportunitiesApi.
2901
+ */
2902
+ export interface KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest {
2903
+ /**
2904
+ * What project it is
2905
+ */
2906
+ readonly project: string
2907
+
2908
+ /**
2909
+ * Keyphrase opportunity\&#39;s unique identifier
2910
+ */
2911
+ readonly keyphraseOpportunityId: string
2912
+ }
2913
+
2797
2914
  /**
2798
2915
  * Request parameters for listKeyphraseOpportunities operation in KeyphraseOpportunitiesApi.
2799
2916
  */
@@ -2814,7 +2931,7 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
2814
2931
  readonly pageSize?: number
2815
2932
 
2816
2933
  /**
2817
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
2934
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
2818
2935
  */
2819
2936
  readonly search?: string
2820
2937
  }
@@ -2849,6 +2966,17 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
2849
2966
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2850
2967
  }
2851
2968
 
2969
+ /**
2970
+ * 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.
2971
+ * @summary Generate collection for a keyphrase opportunity
2972
+ * @param {KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest} requestParameters Request parameters.
2973
+ * @param {*} [options] Override http request option.
2974
+ * @throws {RequiredError}
2975
+ */
2976
+ public generateCollectionForKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiGenerateCollectionForKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig) {
2977
+ return KeyphraseOpportunitiesApiFp(this.configuration).generateCollectionForKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
2978
+ }
2979
+
2852
2980
  /**
2853
2981
  * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2854
2982
  * @summary List keyphrase opportunities
@@ -3195,7 +3323,7 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
3195
3323
  * @param {string} project What project it is
3196
3324
  * @param {number} [pageToken] Page reference token
3197
3325
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3198
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3326
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3199
3327
  * @param {*} [options] Override http request option.
3200
3328
  * @throws {RequiredError}
3201
3329
  */
@@ -3352,7 +3480,7 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
3352
3480
  * @param {string} project What project it is
3353
3481
  * @param {number} [pageToken] Page reference token
3354
3482
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3355
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3483
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3356
3484
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
3357
3485
  * @param {*} [options] Override http request option.
3358
3486
  * @throws {RequiredError}
@@ -3450,7 +3578,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3450
3578
  * @param {string} project What project it is
3451
3579
  * @param {number} [pageToken] Page reference token
3452
3580
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3453
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3581
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3454
3582
  * @param {*} [options] Override http request option.
3455
3583
  * @throws {RequiredError}
3456
3584
  */
@@ -3468,7 +3596,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3468
3596
  * @param {*} [options] Override http request option.
3469
3597
  * @throws {RequiredError}
3470
3598
  */
3471
- async seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeoOptimisePages202Response>> {
3599
+ async seoOptimisePages(project: string, seoOptimisePagesRequest?: SeoOptimisePagesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response>> {
3472
3600
  const localVarAxiosArgs = await localVarAxiosParamCreator.seoOptimisePages(project, seoOptimisePagesRequest, options);
3473
3601
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3474
3602
  const localVarOperationServerBasePath = operationServerMap['PagesApi.seoOptimisePages']?.[localVarOperationServerIndex]?.url;
@@ -3495,7 +3623,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3495
3623
  * @param {string} project What project it is
3496
3624
  * @param {number} [pageToken] Page reference token
3497
3625
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3498
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3626
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3499
3627
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
3500
3628
  * @param {*} [options] Override http request option.
3501
3629
  * @throws {RequiredError}
@@ -3552,7 +3680,7 @@ export const PagesApiFactory = function (configuration?: Configuration, basePath
3552
3680
  * @param {*} [options] Override http request option.
3553
3681
  * @throws {RequiredError}
3554
3682
  */
3555
- seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SeoOptimisePages202Response> {
3683
+ seoOptimisePages(requestParameters: PagesApiSeoOptimisePagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateCollectionForKeyphraseOpportunity202Response> {
3556
3684
  return localVarFp.seoOptimisePages(requestParameters.project, requestParameters.seoOptimisePagesRequest, options).then((request) => request(axios, basePath));
3557
3685
  },
3558
3686
  /**
@@ -3623,7 +3751,7 @@ export interface PagesApiListPagesRequest {
3623
3751
  readonly pageSize?: number
3624
3752
 
3625
3753
  /**
3626
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3754
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3627
3755
  */
3628
3756
  readonly search?: string
3629
3757
  }
@@ -3680,7 +3808,7 @@ export interface PagesApiUpdatePagesRequest {
3680
3808
  readonly pageSize?: number
3681
3809
 
3682
3810
  /**
3683
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
3811
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
3684
3812
  */
3685
3813
  readonly search?: string
3686
3814
 
@@ -4679,7 +4807,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
4679
4807
  * @param {string} project What project it is
4680
4808
  * @param {number} [pageToken] Page reference token
4681
4809
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4682
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
4810
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
4683
4811
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
4684
4812
  * @param {string} [start] Start of date range to filter by
4685
4813
  * @param {string} [end] End of date range to filter by
@@ -4846,7 +4974,7 @@ export const ReviewsApiFp = function(configuration?: Configuration) {
4846
4974
  * @param {string} project What project it is
4847
4975
  * @param {number} [pageToken] Page reference token
4848
4976
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4849
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
4977
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
4850
4978
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
4851
4979
  * @param {string} [start] Start of date range to filter by
4852
4980
  * @param {string} [end] End of date range to filter by
@@ -4981,7 +5109,7 @@ export interface ReviewsApiListReviewsRequest {
4981
5109
  readonly pageSize?: number
4982
5110
 
4983
5111
  /**
4984
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5112
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
4985
5113
  */
4986
5114
  readonly search?: string
4987
5115
 
@@ -5080,7 +5208,7 @@ export const RoutesApiAxiosParamCreator = function (configuration?: Configuratio
5080
5208
  * @param {string} project What project it is
5081
5209
  * @param {number} [pageToken] Page reference token
5082
5210
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5083
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5211
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5084
5212
  * @param {*} [options] Override http request option.
5085
5213
  * @throws {RequiredError}
5086
5214
  */
@@ -5148,7 +5276,7 @@ export const RoutesApiFp = function(configuration?: Configuration) {
5148
5276
  * @param {string} project What project it is
5149
5277
  * @param {number} [pageToken] Page reference token
5150
5278
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5151
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5279
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5152
5280
  * @param {*} [options] Override http request option.
5153
5281
  * @throws {RequiredError}
5154
5282
  */
@@ -5200,7 +5328,7 @@ export interface RoutesApiListRoutesRequest {
5200
5328
  readonly pageSize?: number
5201
5329
 
5202
5330
  /**
5203
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5331
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5204
5332
  */
5205
5333
  readonly search?: string
5206
5334
  }
@@ -5234,7 +5362,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
5234
5362
  * @param {string} project What project it is
5235
5363
  * @param {number} [pageToken] Page reference token
5236
5364
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5237
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5365
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5238
5366
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
5239
5367
  * @param {*} [options] Override http request option.
5240
5368
  * @throws {RequiredError}
@@ -5392,7 +5520,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
5392
5520
  * @param {string} project What project it is
5393
5521
  * @param {number} [pageToken] Page reference token
5394
5522
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5395
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5523
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5396
5524
  * @param {*} [options] Override http request option.
5397
5525
  * @throws {RequiredError}
5398
5526
  */
@@ -5511,7 +5639,7 @@ export const SearchApiFp = function(configuration?: Configuration) {
5511
5639
  * @param {string} project What project it is
5512
5640
  * @param {number} [pageToken] Page reference token
5513
5641
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5514
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5642
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5515
5643
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
5516
5644
  * @param {*} [options] Override http request option.
5517
5645
  * @throws {RequiredError}
@@ -5556,7 +5684,7 @@ export const SearchApiFp = function(configuration?: Configuration) {
5556
5684
  * @param {string} project What project it is
5557
5685
  * @param {number} [pageToken] Page reference token
5558
5686
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5559
- * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5687
+ * @param {string} [search] Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5560
5688
  * @param {*} [options] Override http request option.
5561
5689
  * @throws {RequiredError}
5562
5690
  */
@@ -5663,7 +5791,7 @@ export interface SearchApiCreateSearchRedirectRequest {
5663
5791
  readonly pageSize?: number
5664
5792
 
5665
5793
  /**
5666
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5794
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5667
5795
  */
5668
5796
  readonly search?: string
5669
5797
 
@@ -5723,7 +5851,7 @@ export interface SearchApiListSearchRedirectsRequest {
5723
5851
  readonly pageSize?: number
5724
5852
 
5725
5853
  /**
5726
- * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false organic shirts. Multiple filters can be combined with spaces and commas.
5854
+ * Search term to filter results. Free text matches keyphrase text. Structured filters use key:value tags — e.g. assigned:false published:true,false optimised:false sparseCollection:true assignedContentType:product suggestedContentType:product,collection organic shirts. Multiple filters can be combined with spaces and commas.
5727
5855
  */
5728
5856
  readonly search?: string
5729
5857
  }
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.1
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.1
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.1
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).