@teemill/website 0.33.1 → 0.34.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.
@@ -22,7 +22,6 @@ docs/CreateSearchRedirectRequest.md
22
22
  docs/CrossSellApi.md
23
23
  docs/DefaultApi.md
24
24
  docs/Domain.md
25
- docs/ExportPages202Response.md
26
25
  docs/Footer.md
27
26
  docs/FooterApi.md
28
27
  docs/FooterItem.md
@@ -30,7 +29,9 @@ docs/Image.md
30
29
  docs/KeyphraseOpportunitiesApi.md
31
30
  docs/KeyphraseOpportunitiesResponse.md
32
31
  docs/KeyphraseOpportunitiesResponseMeta.md
32
+ docs/KeyphraseOpportunitiesResponseMetaFilters.md
33
33
  docs/KeyphraseOpportunity.md
34
+ docs/KeyphraseOpportunityContent.md
34
35
  docs/ListDomains200Response.md
35
36
  docs/ListRoutesResponse.md
36
37
  docs/Menu.md
@@ -1 +1 @@
1
- 7.22.0
1
+ 7.23.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/website@0.33.1
1
+ ## @teemill/website@0.34.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.33.1 --save
39
+ npm install @teemill/website@0.34.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -63,8 +63,8 @@ Class | Method | HTTP request | Description
63
63
  *DefaultApi* | [**updateBrand**](docs/DefaultApi.md#updatebrand) | **PATCH** /v1/website/brand | Update brand
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
- *KeyphraseOpportunitiesApi* | [**deleteKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete key phrase opportunity
67
- *KeyphraseOpportunitiesApi* | [**listKeyphraseOpportunities**](docs/KeyphraseOpportunitiesApi.md#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List key phrase opportunities
66
+ *KeyphraseOpportunitiesApi* | [**deleteKeyphraseOpportunity**](docs/KeyphraseOpportunitiesApi.md#deletekeyphraseopportunity) | **DELETE** /v1/website/keyphrase-opportunities/{keyphraseOpportunityId} | Delete keyphrase opportunity
67
+ *KeyphraseOpportunitiesApi* | [**listKeyphraseOpportunities**](docs/KeyphraseOpportunitiesApi.md#listkeyphraseopportunities) | **GET** /v1/website/keyphrase-opportunities | List keyphrase opportunities
68
68
  *MenuApi* | [**getMenu**](docs/MenuApi.md#getmenu) | **GET** /v1/website/menu | Get menu
69
69
  *MenuApi* | [**updateMenu**](docs/MenuApi.md#updatemenu) | **PUT** /v1/website/menu | Update menu
70
70
  *PagesApi* | [**exportPages**](docs/PagesApi.md#exportpages) | **GET** /v1/website/pages/export | Export pages
@@ -112,13 +112,14 @@ Class | Method | HTTP request | Description
112
112
  - [CreateDomainRequest](docs/CreateDomainRequest.md)
113
113
  - [CreateSearchRedirectRequest](docs/CreateSearchRedirectRequest.md)
114
114
  - [Domain](docs/Domain.md)
115
- - [ExportPages202Response](docs/ExportPages202Response.md)
116
115
  - [Footer](docs/Footer.md)
117
116
  - [FooterItem](docs/FooterItem.md)
118
117
  - [Image](docs/Image.md)
119
118
  - [KeyphraseOpportunitiesResponse](docs/KeyphraseOpportunitiesResponse.md)
120
119
  - [KeyphraseOpportunitiesResponseMeta](docs/KeyphraseOpportunitiesResponseMeta.md)
120
+ - [KeyphraseOpportunitiesResponseMetaFilters](docs/KeyphraseOpportunitiesResponseMetaFilters.md)
121
121
  - [KeyphraseOpportunity](docs/KeyphraseOpportunity.md)
122
+ - [KeyphraseOpportunityContent](docs/KeyphraseOpportunityContent.md)
122
123
  - [ListDomains200Response](docs/ListDomains200Response.md)
123
124
  - [ListRoutesResponse](docs/ListRoutesResponse.md)
124
125
  - [Menu](docs/Menu.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.33.1
7
+ * The version of the OpenAPI document: 0.34.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -163,12 +163,6 @@ export interface Domain {
163
163
  'priority': number;
164
164
  'enabledAt': string | null;
165
165
  }
166
- export interface ExportPages202Response {
167
- /**
168
- * A message describing the export status
169
- */
170
- 'message'?: string;
171
- }
172
166
  export interface Footer {
173
167
  'items': Array<FooterItem>;
174
168
  }
@@ -210,14 +204,52 @@ export interface KeyphraseOpportunitiesResponse {
210
204
  */
211
205
  export interface KeyphraseOpportunitiesResponseMeta {
212
206
  /**
213
- * Total number of unique keyphrases stored against the project.
207
+ * Total number of keyphrase opportunities matching the active phrase search and list filters.
214
208
  */
215
209
  'totalPhrases': number;
216
210
  /**
217
- * Combined monthly volume of all keyphrases stored against the project.
211
+ * Combined monthly search volume of keyphrase opportunities matching the active phrase search and list filters.
218
212
  */
219
213
  'totalMonthlyVolume': number;
214
+ 'filters': KeyphraseOpportunitiesResponseMetaFilters;
215
+ }
216
+ /**
217
+ * Filters that can be applied to the keyphrase opportunities list.
218
+ */
219
+ export interface KeyphraseOpportunitiesResponseMetaFilters {
220
+ /**
221
+ * Filter by whether the keyphrase is assigned to content.
222
+ */
223
+ 'assigned': Array<KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum>;
224
+ /**
225
+ * Filter by whether the keyphrase is attached to published content.
226
+ */
227
+ 'published': Array<KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum>;
228
+ /**
229
+ * Filter by whether the keyphrase is attached to optimised content.
230
+ */
231
+ 'optimised': Array<KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum>;
220
232
  }
233
+
234
+ export const KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = {
235
+ True: 'true',
236
+ False: 'false',
237
+ } as const;
238
+
239
+ export type KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum];
240
+ export const KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum = {
241
+ True: 'true',
242
+ False: 'false',
243
+ } as const;
244
+
245
+ export type KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum];
246
+ export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
247
+ True: 'true',
248
+ False: 'false',
249
+ } as const;
250
+
251
+ export type KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum];
252
+
221
253
  export interface KeyphraseOpportunity {
222
254
  'id': string;
223
255
  /**
@@ -228,7 +260,36 @@ export interface KeyphraseOpportunity {
228
260
  * Monthly search volume for the keyphrase
229
261
  */
230
262
  'monthlyVolume': number | null;
263
+ /**
264
+ * Merchandising issues for this keyphrase opportunity.
265
+ */
266
+ 'merchIssues': Array<string>;
267
+ 'content': KeyphraseOpportunityContent | null;
268
+ }
269
+ /**
270
+ * Content the keyphrase is assigned to.
271
+ */
272
+ export interface KeyphraseOpportunityContent {
273
+ /**
274
+ * The type of content the keyphrase is assigned to.
275
+ */
276
+ 'type': KeyphraseOpportunityContentTypeEnum;
277
+ 'id': string;
278
+ /**
279
+ * The name of the attached content
280
+ */
281
+ 'name': string;
231
282
  }
283
+
284
+ export const KeyphraseOpportunityContentTypeEnum = {
285
+ Product: 'product',
286
+ Collection: 'collection',
287
+ Blog: 'blog',
288
+ Page: 'page',
289
+ } as const;
290
+
291
+ export type KeyphraseOpportunityContentTypeEnum = typeof KeyphraseOpportunityContentTypeEnum[keyof typeof KeyphraseOpportunityContentTypeEnum];
292
+
232
293
  export interface ListDomains200Response {
233
294
  'domains': Array<Domain>;
234
295
  /**
@@ -1168,7 +1229,7 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
1168
1229
  * @param {string} project What project it is
1169
1230
  * @param {number} [pageToken] Page reference token
1170
1231
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1171
- * @param {string} [search] Search term to filter results
1232
+ * @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.
1172
1233
  * @param {*} [options] Override http request option.
1173
1234
  * @throws {RequiredError}
1174
1235
  */
@@ -1278,7 +1339,7 @@ export const BlogsApiAxiosParamCreator = function (configuration?: Configuration
1278
1339
  * @param {string} project What project it is
1279
1340
  * @param {number} [pageToken] Page reference token
1280
1341
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1281
- * @param {string} [search] Search term to filter results
1342
+ * @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.
1282
1343
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1283
1344
  * @param {*} [options] Override http request option.
1284
1345
  * @throws {RequiredError}
@@ -1376,7 +1437,7 @@ export const BlogsApiFp = function(configuration?: Configuration) {
1376
1437
  * @param {string} project What project it is
1377
1438
  * @param {number} [pageToken] Page reference token
1378
1439
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1379
- * @param {string} [search] Search term to filter results
1440
+ * @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.
1380
1441
  * @param {*} [options] Override http request option.
1381
1442
  * @throws {RequiredError}
1382
1443
  */
@@ -1407,7 +1468,7 @@ export const BlogsApiFp = function(configuration?: Configuration) {
1407
1468
  * @param {string} project What project it is
1408
1469
  * @param {number} [pageToken] Page reference token
1409
1470
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1410
- * @param {string} [search] Search term to filter results
1471
+ * @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.
1411
1472
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1412
1473
  * @param {*} [options] Override http request option.
1413
1474
  * @throws {RequiredError}
@@ -1525,7 +1586,7 @@ export interface BlogsApiListBlogsRequest {
1525
1586
  readonly pageSize?: number
1526
1587
 
1527
1588
  /**
1528
- * Search term to filter results
1589
+ * 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.
1529
1590
  */
1530
1591
  readonly search?: string
1531
1592
  }
@@ -1567,7 +1628,7 @@ export interface BlogsApiUpdateBlogsRequest {
1567
1628
  readonly pageSize?: number
1568
1629
 
1569
1630
  /**
1570
- * Search term to filter results
1631
+ * 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.
1571
1632
  */
1572
1633
  readonly search?: string
1573
1634
 
@@ -2465,10 +2526,10 @@ export class FooterApi extends BaseAPI {
2465
2526
  export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuration?: Configuration) {
2466
2527
  return {
2467
2528
  /**
2468
- * Remove a key phrase opportunity from the store.
2469
- * @summary Delete key phrase opportunity
2529
+ * Remove a keyphrase opportunity from the store.
2530
+ * @summary Delete keyphrase opportunity
2470
2531
  * @param {string} project What project it is
2471
- * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
2532
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2472
2533
  * @param {*} [options] Override http request option.
2473
2534
  * @throws {RequiredError}
2474
2535
  */
@@ -2513,12 +2574,12 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
2513
2574
  };
2514
2575
  },
2515
2576
  /**
2516
- * List the key phrases saved as opportunities for a store that are not attached to content.
2517
- * @summary List key phrase opportunities
2577
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2578
+ * @summary List keyphrase opportunities
2518
2579
  * @param {string} project What project it is
2519
2580
  * @param {number} [pageToken] Page reference token
2520
2581
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2521
- * @param {string} [search] Search term to filter results
2582
+ * @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.
2522
2583
  * @param {*} [options] Override http request option.
2523
2584
  * @throws {RequiredError}
2524
2585
  */
@@ -2581,10 +2642,10 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2581
2642
  const localVarAxiosParamCreator = KeyphraseOpportunitiesApiAxiosParamCreator(configuration)
2582
2643
  return {
2583
2644
  /**
2584
- * Remove a key phrase opportunity from the store.
2585
- * @summary Delete key phrase opportunity
2645
+ * Remove a keyphrase opportunity from the store.
2646
+ * @summary Delete keyphrase opportunity
2586
2647
  * @param {string} project What project it is
2587
- * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
2648
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
2588
2649
  * @param {*} [options] Override http request option.
2589
2650
  * @throws {RequiredError}
2590
2651
  */
@@ -2595,12 +2656,12 @@ export const KeyphraseOpportunitiesApiFp = function(configuration?: Configuratio
2595
2656
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2596
2657
  },
2597
2658
  /**
2598
- * List the key phrases saved as opportunities for a store that are not attached to content.
2599
- * @summary List key phrase opportunities
2659
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2660
+ * @summary List keyphrase opportunities
2600
2661
  * @param {string} project What project it is
2601
2662
  * @param {number} [pageToken] Page reference token
2602
2663
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2603
- * @param {string} [search] Search term to filter results
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 organic shirts. Multiple filters can be combined with spaces and commas.
2604
2665
  * @param {*} [options] Override http request option.
2605
2666
  * @throws {RequiredError}
2606
2667
  */
@@ -2620,8 +2681,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2620
2681
  const localVarFp = KeyphraseOpportunitiesApiFp(configuration)
2621
2682
  return {
2622
2683
  /**
2623
- * Remove a key phrase opportunity from the store.
2624
- * @summary Delete key phrase opportunity
2684
+ * Remove a keyphrase opportunity from the store.
2685
+ * @summary Delete keyphrase opportunity
2625
2686
  * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
2626
2687
  * @param {*} [options] Override http request option.
2627
2688
  * @throws {RequiredError}
@@ -2630,8 +2691,8 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration?: Config
2630
2691
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
2631
2692
  },
2632
2693
  /**
2633
- * List the key phrases saved as opportunities for a store that are not attached to content.
2634
- * @summary List key phrase opportunities
2694
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2695
+ * @summary List keyphrase opportunities
2635
2696
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
2636
2697
  * @param {*} [options] Override http request option.
2637
2698
  * @throws {RequiredError}
@@ -2652,7 +2713,7 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
2652
2713
  readonly project: string
2653
2714
 
2654
2715
  /**
2655
- * Key phrase opportunity\&#39;s unique identifier
2716
+ * Keyphrase opportunity\&#39;s unique identifier
2656
2717
  */
2657
2718
  readonly keyphraseOpportunityId: string
2658
2719
  }
@@ -2677,7 +2738,7 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
2677
2738
  readonly pageSize?: number
2678
2739
 
2679
2740
  /**
2680
- * Search term to filter results
2741
+ * 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.
2681
2742
  */
2682
2743
  readonly search?: string
2683
2744
  }
@@ -2687,8 +2748,8 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
2687
2748
  */
2688
2749
  export class KeyphraseOpportunitiesApi extends BaseAPI {
2689
2750
  /**
2690
- * Remove a key phrase opportunity from the store.
2691
- * @summary Delete key phrase opportunity
2751
+ * Remove a keyphrase opportunity from the store.
2752
+ * @summary Delete keyphrase opportunity
2692
2753
  * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
2693
2754
  * @param {*} [options] Override http request option.
2694
2755
  * @throws {RequiredError}
@@ -2698,8 +2759,8 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
2698
2759
  }
2699
2760
 
2700
2761
  /**
2701
- * List the key phrases saved as opportunities for a store that are not attached to content.
2702
- * @summary List key phrase opportunities
2762
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
2763
+ * @summary List keyphrase opportunities
2703
2764
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
2704
2765
  * @param {*} [options] Override http request option.
2705
2766
  * @throws {RequiredError}
@@ -3032,7 +3093,7 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
3032
3093
  * @param {string} project What project it is
3033
3094
  * @param {number} [pageToken] Page reference token
3034
3095
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3035
- * @param {string} [search] Search term to filter results
3096
+ * @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.
3036
3097
  * @param {*} [options] Override http request option.
3037
3098
  * @throws {RequiredError}
3038
3099
  */
@@ -3189,7 +3250,7 @@ export const PagesApiAxiosParamCreator = function (configuration?: Configuration
3189
3250
  * @param {string} project What project it is
3190
3251
  * @param {number} [pageToken] Page reference token
3191
3252
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3192
- * @param {string} [search] Search term to filter results
3253
+ * @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.
3193
3254
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
3194
3255
  * @param {*} [options] Override http request option.
3195
3256
  * @throws {RequiredError}
@@ -3287,7 +3348,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3287
3348
  * @param {string} project What project it is
3288
3349
  * @param {number} [pageToken] Page reference token
3289
3350
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3290
- * @param {string} [search] Search term to filter results
3351
+ * @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.
3291
3352
  * @param {*} [options] Override http request option.
3292
3353
  * @throws {RequiredError}
3293
3354
  */
@@ -3332,7 +3393,7 @@ export const PagesApiFp = function(configuration?: Configuration) {
3332
3393
  * @param {string} project What project it is
3333
3394
  * @param {number} [pageToken] Page reference token
3334
3395
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3335
- * @param {string} [search] Search term to filter results
3396
+ * @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.
3336
3397
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
3337
3398
  * @param {*} [options] Override http request option.
3338
3399
  * @throws {RequiredError}
@@ -3460,7 +3521,7 @@ export interface PagesApiListPagesRequest {
3460
3521
  readonly pageSize?: number
3461
3522
 
3462
3523
  /**
3463
- * Search term to filter results
3524
+ * 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.
3464
3525
  */
3465
3526
  readonly search?: string
3466
3527
  }
@@ -3517,7 +3578,7 @@ export interface PagesApiUpdatePagesRequest {
3517
3578
  readonly pageSize?: number
3518
3579
 
3519
3580
  /**
3520
- * Search term to filter results
3581
+ * 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.
3521
3582
  */
3522
3583
  readonly search?: string
3523
3584
 
@@ -4516,7 +4577,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration?: Configurati
4516
4577
  * @param {string} project What project it is
4517
4578
  * @param {number} [pageToken] Page reference token
4518
4579
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4519
- * @param {string} [search] Search term to filter results
4580
+ * @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.
4520
4581
  * @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.
4521
4582
  * @param {string} [start] Start of date range to filter by
4522
4583
  * @param {string} [end] End of date range to filter by
@@ -4683,7 +4744,7 @@ export const ReviewsApiFp = function(configuration?: Configuration) {
4683
4744
  * @param {string} project What project it is
4684
4745
  * @param {number} [pageToken] Page reference token
4685
4746
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4686
- * @param {string} [search] Search term to filter results
4747
+ * @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.
4687
4748
  * @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.
4688
4749
  * @param {string} [start] Start of date range to filter by
4689
4750
  * @param {string} [end] End of date range to filter by
@@ -4818,7 +4879,7 @@ export interface ReviewsApiListReviewsRequest {
4818
4879
  readonly pageSize?: number
4819
4880
 
4820
4881
  /**
4821
- * Search term to filter results
4882
+ * 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.
4822
4883
  */
4823
4884
  readonly search?: string
4824
4885
 
@@ -4917,7 +4978,7 @@ export const RoutesApiAxiosParamCreator = function (configuration?: Configuratio
4917
4978
  * @param {string} project What project it is
4918
4979
  * @param {number} [pageToken] Page reference token
4919
4980
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4920
- * @param {string} [search] Search term to filter results
4981
+ * @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.
4921
4982
  * @param {*} [options] Override http request option.
4922
4983
  * @throws {RequiredError}
4923
4984
  */
@@ -4985,7 +5046,7 @@ export const RoutesApiFp = function(configuration?: Configuration) {
4985
5046
  * @param {string} project What project it is
4986
5047
  * @param {number} [pageToken] Page reference token
4987
5048
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
4988
- * @param {string} [search] Search term to filter results
5049
+ * @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.
4989
5050
  * @param {*} [options] Override http request option.
4990
5051
  * @throws {RequiredError}
4991
5052
  */
@@ -5037,7 +5098,7 @@ export interface RoutesApiListRoutesRequest {
5037
5098
  readonly pageSize?: number
5038
5099
 
5039
5100
  /**
5040
- * Search term to filter results
5101
+ * 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.
5041
5102
  */
5042
5103
  readonly search?: string
5043
5104
  }
@@ -5071,7 +5132,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
5071
5132
  * @param {string} project What project it is
5072
5133
  * @param {number} [pageToken] Page reference token
5073
5134
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5074
- * @param {string} [search] Search term to filter results
5135
+ * @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.
5075
5136
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
5076
5137
  * @param {*} [options] Override http request option.
5077
5138
  * @throws {RequiredError}
@@ -5229,7 +5290,7 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
5229
5290
  * @param {string} project What project it is
5230
5291
  * @param {number} [pageToken] Page reference token
5231
5292
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5232
- * @param {string} [search] Search term to filter results
5293
+ * @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.
5233
5294
  * @param {*} [options] Override http request option.
5234
5295
  * @throws {RequiredError}
5235
5296
  */
@@ -5348,7 +5409,7 @@ export const SearchApiFp = function(configuration?: Configuration) {
5348
5409
  * @param {string} project What project it is
5349
5410
  * @param {number} [pageToken] Page reference token
5350
5411
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5351
- * @param {string} [search] Search term to filter results
5412
+ * @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.
5352
5413
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
5353
5414
  * @param {*} [options] Override http request option.
5354
5415
  * @throws {RequiredError}
@@ -5393,7 +5454,7 @@ export const SearchApiFp = function(configuration?: Configuration) {
5393
5454
  * @param {string} project What project it is
5394
5455
  * @param {number} [pageToken] Page reference token
5395
5456
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
5396
- * @param {string} [search] Search term to filter results
5457
+ * @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.
5397
5458
  * @param {*} [options] Override http request option.
5398
5459
  * @throws {RequiredError}
5399
5460
  */
@@ -5500,7 +5561,7 @@ export interface SearchApiCreateSearchRedirectRequest {
5500
5561
  readonly pageSize?: number
5501
5562
 
5502
5563
  /**
5503
- * Search term to filter results
5564
+ * 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.
5504
5565
  */
5505
5566
  readonly search?: string
5506
5567
 
@@ -5560,7 +5621,7 @@ export interface SearchApiListSearchRedirectsRequest {
5560
5621
  readonly pageSize?: number
5561
5622
 
5562
5623
  /**
5563
- * Search term to filter results
5624
+ * 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.
5564
5625
  */
5565
5626
  readonly search?: string
5566
5627
  }
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.33.1
7
+ * The version of the OpenAPI document: 0.34.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.33.1
7
+ * The version of the OpenAPI document: 0.34.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.33.1
6
+ * The version of the OpenAPI document: 0.34.1
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).