@teemill/website 0.33.1 → 0.34.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.
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.33.1
8
+ * The version of the OpenAPI document: 0.34.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.34.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -146,12 +146,6 @@ export interface Domain {
146
146
  'priority': number;
147
147
  'enabledAt': string | null;
148
148
  }
149
- export interface ExportPages202Response {
150
- /**
151
- * A message describing the export status
152
- */
153
- 'message'?: string;
154
- }
155
149
  export interface Footer {
156
150
  'items': Array<FooterItem>;
157
151
  }
@@ -193,14 +187,47 @@ export interface KeyphraseOpportunitiesResponse {
193
187
  */
194
188
  export interface KeyphraseOpportunitiesResponseMeta {
195
189
  /**
196
- * Total number of unique keyphrases stored against the project.
190
+ * Total number of keyphrase opportunities matching the active phrase search and list filters.
197
191
  */
198
192
  'totalPhrases': number;
199
193
  /**
200
- * Combined monthly volume of all keyphrases stored against the project.
194
+ * Combined monthly search volume of keyphrase opportunities matching the active phrase search and list filters.
201
195
  */
202
196
  'totalMonthlyVolume': number;
197
+ 'filters': KeyphraseOpportunitiesResponseMetaFilters;
198
+ }
199
+ /**
200
+ * Filters that can be applied to the key phrase opportunities list.
201
+ */
202
+ export interface KeyphraseOpportunitiesResponseMetaFilters {
203
+ /**
204
+ * Filter by whether the key phrase is assigned to content.
205
+ */
206
+ 'assigned': Array<KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum>;
207
+ /**
208
+ * Filter by whether the key phrase is attached to published content.
209
+ */
210
+ 'published': Array<KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum>;
211
+ /**
212
+ * Filter by whether the key phrase is attached to optimised content.
213
+ */
214
+ 'optimised': Array<KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum>;
203
215
  }
216
+ export declare const KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum: {
217
+ readonly True: "true";
218
+ readonly False: "false";
219
+ };
220
+ export type KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum];
221
+ export declare const KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum: {
222
+ readonly True: "true";
223
+ readonly False: "false";
224
+ };
225
+ export type KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum];
226
+ export declare const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum: {
227
+ readonly True: "true";
228
+ readonly False: "false";
229
+ };
230
+ export type KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum[keyof typeof KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum];
204
231
  export interface KeyphraseOpportunity {
205
232
  'id': string;
206
233
  /**
@@ -211,7 +238,28 @@ export interface KeyphraseOpportunity {
211
238
  * Monthly search volume for the keyphrase
212
239
  */
213
240
  'monthlyVolume': number | null;
241
+ /**
242
+ * Merchandising issues for this key phrase opportunity.
243
+ */
244
+ 'merchIssues': Array<string>;
245
+ 'content': KeyphraseOpportunityContent | null;
214
246
  }
247
+ /**
248
+ * Product or collection the key phrase is assigned to.
249
+ */
250
+ export interface KeyphraseOpportunityContent {
251
+ 'type': KeyphraseOpportunityContentTypeEnum;
252
+ 'id': string;
253
+ /**
254
+ * The name of the product or collection
255
+ */
256
+ 'name': string;
257
+ }
258
+ export declare const KeyphraseOpportunityContentTypeEnum: {
259
+ readonly Product: "product";
260
+ readonly Collection: "collection";
261
+ };
262
+ export type KeyphraseOpportunityContentTypeEnum = typeof KeyphraseOpportunityContentTypeEnum[keyof typeof KeyphraseOpportunityContentTypeEnum];
215
263
  export interface ListDomains200Response {
216
264
  'domains': Array<Domain>;
217
265
  /**
@@ -1042,7 +1090,7 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
1042
1090
  * @param {string} project What project it is
1043
1091
  * @param {number} [pageToken] Page reference token
1044
1092
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1045
- * @param {string} [search] Search term to filter results
1093
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1046
1094
  * @param {*} [options] Override http request option.
1047
1095
  * @throws {RequiredError}
1048
1096
  */
@@ -1063,7 +1111,7 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
1063
1111
  * @param {string} project What project it is
1064
1112
  * @param {number} [pageToken] Page reference token
1065
1113
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1066
- * @param {string} [search] Search term to filter results
1114
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1067
1115
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1068
1116
  * @param {*} [options] Override http request option.
1069
1117
  * @throws {RequiredError}
@@ -1097,7 +1145,7 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
1097
1145
  * @param {string} project What project it is
1098
1146
  * @param {number} [pageToken] Page reference token
1099
1147
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1100
- * @param {string} [search] Search term to filter results
1148
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1101
1149
  * @param {*} [options] Override http request option.
1102
1150
  * @throws {RequiredError}
1103
1151
  */
@@ -1118,7 +1166,7 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
1118
1166
  * @param {string} project What project it is
1119
1167
  * @param {number} [pageToken] Page reference token
1120
1168
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1121
- * @param {string} [search] Search term to filter results
1169
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1122
1170
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1123
1171
  * @param {*} [options] Override http request option.
1124
1172
  * @throws {RequiredError}
@@ -1209,7 +1257,7 @@ export interface BlogsApiListBlogsRequest {
1209
1257
  */
1210
1258
  readonly pageSize?: number;
1211
1259
  /**
1212
- * Search term to filter results
1260
+ * Search term to filter results. Free text matches key phrase 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.
1213
1261
  */
1214
1262
  readonly search?: string;
1215
1263
  }
@@ -1244,7 +1292,7 @@ export interface BlogsApiUpdateBlogsRequest {
1244
1292
  */
1245
1293
  readonly pageSize?: number;
1246
1294
  /**
1247
- * Search term to filter results
1295
+ * Search term to filter results. Free text matches key phrase 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.
1248
1296
  */
1249
1297
  readonly search?: string;
1250
1298
  /**
@@ -1726,12 +1774,12 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
1726
1774
  */
1727
1775
  deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
1776
  /**
1729
- * List the key phrases saved as opportunities for a store that are not attached to content.
1777
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1730
1778
  * @summary List key phrase opportunities
1731
1779
  * @param {string} project What project it is
1732
1780
  * @param {number} [pageToken] Page reference token
1733
1781
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1734
- * @param {string} [search] Search term to filter results
1782
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1735
1783
  * @param {*} [options] Override http request option.
1736
1784
  * @throws {RequiredError}
1737
1785
  */
@@ -1751,12 +1799,12 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1751
1799
  */
1752
1800
  deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1753
1801
  /**
1754
- * List the key phrases saved as opportunities for a store that are not attached to content.
1802
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1755
1803
  * @summary List key phrase opportunities
1756
1804
  * @param {string} project What project it is
1757
1805
  * @param {number} [pageToken] Page reference token
1758
1806
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1759
- * @param {string} [search] Search term to filter results
1807
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1760
1808
  * @param {*} [options] Override http request option.
1761
1809
  * @throws {RequiredError}
1762
1810
  */
@@ -1775,7 +1823,7 @@ export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configur
1775
1823
  */
1776
1824
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1777
1825
  /**
1778
- * List the key phrases saved as opportunities for a store that are not attached to content.
1826
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1779
1827
  * @summary List key phrase opportunities
1780
1828
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1781
1829
  * @param {*} [options] Override http request option.
@@ -1813,7 +1861,7 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
1813
1861
  */
1814
1862
  readonly pageSize?: number;
1815
1863
  /**
1816
- * Search term to filter results
1864
+ * Search term to filter results. Free text matches key phrase 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.
1817
1865
  */
1818
1866
  readonly search?: string;
1819
1867
  }
@@ -1830,7 +1878,7 @@ export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1830
1878
  */
1831
1879
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1832
1880
  /**
1833
- * List the key phrases saved as opportunities for a store that are not attached to content.
1881
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1834
1882
  * @summary List key phrase opportunities
1835
1883
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1836
1884
  * @param {*} [options] Override http request option.
@@ -1973,7 +2021,7 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
1973
2021
  * @param {string} project What project it is
1974
2022
  * @param {number} [pageToken] Page reference token
1975
2023
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1976
- * @param {string} [search] Search term to filter results
2024
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1977
2025
  * @param {*} [options] Override http request option.
1978
2026
  * @throws {RequiredError}
1979
2027
  */
@@ -2003,7 +2051,7 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
2003
2051
  * @param {string} project What project it is
2004
2052
  * @param {number} [pageToken] Page reference token
2005
2053
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2006
- * @param {string} [search] Search term to filter results
2054
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2007
2055
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
2008
2056
  * @param {*} [options] Override http request option.
2009
2057
  * @throws {RequiredError}
@@ -2037,7 +2085,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2037
2085
  * @param {string} project What project it is
2038
2086
  * @param {number} [pageToken] Page reference token
2039
2087
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2040
- * @param {string} [search] Search term to filter results
2088
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2041
2089
  * @param {*} [options] Override http request option.
2042
2090
  * @throws {RequiredError}
2043
2091
  */
@@ -2067,7 +2115,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2067
2115
  * @param {string} project What project it is
2068
2116
  * @param {number} [pageToken] Page reference token
2069
2117
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2070
- * @param {string} [search] Search term to filter results
2118
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2071
2119
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
2072
2120
  * @param {*} [options] Override http request option.
2073
2121
  * @throws {RequiredError}
@@ -2166,7 +2214,7 @@ export interface PagesApiListPagesRequest {
2166
2214
  */
2167
2215
  readonly pageSize?: number;
2168
2216
  /**
2169
- * Search term to filter results
2217
+ * Search term to filter results. Free text matches key phrase 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.
2170
2218
  */
2171
2219
  readonly search?: string;
2172
2220
  }
@@ -2214,7 +2262,7 @@ export interface PagesApiUpdatePagesRequest {
2214
2262
  */
2215
2263
  readonly pageSize?: number;
2216
2264
  /**
2217
- * Search term to filter results
2265
+ * Search term to filter results. Free text matches key phrase 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.
2218
2266
  */
2219
2267
  readonly search?: string;
2220
2268
  /**
@@ -2690,7 +2738,7 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
2690
2738
  * @param {string} project What project it is
2691
2739
  * @param {number} [pageToken] Page reference token
2692
2740
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2693
- * @param {string} [search] Search term to filter results
2741
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2694
2742
  * @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.
2695
2743
  * @param {string} [start] Start of date range to filter by
2696
2744
  * @param {string} [end] End of date range to filter by
@@ -2738,7 +2786,7 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
2738
2786
  * @param {string} project What project it is
2739
2787
  * @param {number} [pageToken] Page reference token
2740
2788
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2741
- * @param {string} [search] Search term to filter results
2789
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2742
2790
  * @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.
2743
2791
  * @param {string} [start] Start of date range to filter by
2744
2792
  * @param {string} [end] End of date range to filter by
@@ -2841,7 +2889,7 @@ export interface ReviewsApiListReviewsRequest {
2841
2889
  */
2842
2890
  readonly pageSize?: number;
2843
2891
  /**
2844
- * Search term to filter results
2892
+ * Search term to filter results. Free text matches key phrase 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.
2845
2893
  */
2846
2894
  readonly search?: string;
2847
2895
  /**
@@ -2918,7 +2966,7 @@ export declare const RoutesApiAxiosParamCreator: (configuration?: Configuration)
2918
2966
  * @param {string} project What project it is
2919
2967
  * @param {number} [pageToken] Page reference token
2920
2968
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2921
- * @param {string} [search] Search term to filter results
2969
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2922
2970
  * @param {*} [options] Override http request option.
2923
2971
  * @throws {RequiredError}
2924
2972
  */
@@ -2934,7 +2982,7 @@ export declare const RoutesApiFp: (configuration?: Configuration) => {
2934
2982
  * @param {string} project What project it is
2935
2983
  * @param {number} [pageToken] Page reference token
2936
2984
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2937
- * @param {string} [search] Search term to filter results
2985
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2938
2986
  * @param {*} [options] Override http request option.
2939
2987
  * @throws {RequiredError}
2940
2988
  */
@@ -2970,7 +3018,7 @@ export interface RoutesApiListRoutesRequest {
2970
3018
  */
2971
3019
  readonly pageSize?: number;
2972
3020
  /**
2973
- * Search term to filter results
3021
+ * Search term to filter results. Free text matches key phrase 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.
2974
3022
  */
2975
3023
  readonly search?: string;
2976
3024
  }
@@ -2997,7 +3045,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
2997
3045
  * @param {string} project What project it is
2998
3046
  * @param {number} [pageToken] Page reference token
2999
3047
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3000
- * @param {string} [search] Search term to filter results
3048
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3001
3049
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3002
3050
  * @param {*} [options] Override http request option.
3003
3051
  * @throws {RequiredError}
@@ -3027,7 +3075,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
3027
3075
  * @param {string} project What project it is
3028
3076
  * @param {number} [pageToken] Page reference token
3029
3077
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3030
- * @param {string} [search] Search term to filter results
3078
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3031
3079
  * @param {*} [options] Override http request option.
3032
3080
  * @throws {RequiredError}
3033
3081
  */
@@ -3053,7 +3101,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
3053
3101
  * @param {string} project What project it is
3054
3102
  * @param {number} [pageToken] Page reference token
3055
3103
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3056
- * @param {string} [search] Search term to filter results
3104
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3057
3105
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3058
3106
  * @param {*} [options] Override http request option.
3059
3107
  * @throws {RequiredError}
@@ -3083,7 +3131,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
3083
3131
  * @param {string} project What project it is
3084
3132
  * @param {number} [pageToken] Page reference token
3085
3133
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3086
- * @param {string} [search] Search term to filter results
3134
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3087
3135
  * @param {*} [options] Override http request option.
3088
3136
  * @throws {RequiredError}
3089
3137
  */
@@ -3161,7 +3209,7 @@ export interface SearchApiCreateSearchRedirectRequest {
3161
3209
  */
3162
3210
  readonly pageSize?: number;
3163
3211
  /**
3164
- * Search term to filter results
3212
+ * Search term to filter results. Free text matches key phrase 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.
3165
3213
  */
3166
3214
  readonly search?: string;
3167
3215
  /**
@@ -3212,7 +3260,7 @@ export interface SearchApiListSearchRedirectsRequest {
3212
3260
  */
3213
3261
  readonly pageSize?: number;
3214
3262
  /**
3215
- * Search term to filter results
3263
+ * Search term to filter results. Free text matches key phrase 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.
3216
3264
  */
3217
3265
  readonly search?: string;
3218
3266
  }
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.34.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -50,6 +50,22 @@ export const AttributeThumbnailTypeEnum = {
50
50
  Color: 'color',
51
51
  Image: 'image',
52
52
  };
53
+ export const KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum = {
54
+ True: 'true',
55
+ False: 'false',
56
+ };
57
+ export const KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum = {
58
+ True: 'true',
59
+ False: 'false',
60
+ };
61
+ export const KeyphraseOpportunitiesResponseMetaFiltersOptimisedEnum = {
62
+ True: 'true',
63
+ False: 'false',
64
+ };
65
+ export const KeyphraseOpportunityContentTypeEnum = {
66
+ Product: 'product',
67
+ Collection: 'collection',
68
+ };
53
69
  export const PaymentAccountMethodEnum = {
54
70
  Stripe: 'stripe',
55
71
  Paypal: 'paypal',
@@ -205,7 +221,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
205
221
  * @param {string} project What project it is
206
222
  * @param {number} [pageToken] Page reference token
207
223
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
208
- * @param {string} [search] Search term to filter results
224
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
209
225
  * @param {*} [options] Override http request option.
210
226
  * @throws {RequiredError}
211
227
  */
@@ -298,7 +314,7 @@ export const BlogsApiAxiosParamCreator = function (configuration) {
298
314
  * @param {string} project What project it is
299
315
  * @param {number} [pageToken] Page reference token
300
316
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
301
- * @param {string} [search] Search term to filter results
317
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
302
318
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
303
319
  * @param {*} [options] Override http request option.
304
320
  * @throws {RequiredError}
@@ -391,7 +407,7 @@ export const BlogsApiFp = function (configuration) {
391
407
  * @param {string} project What project it is
392
408
  * @param {number} [pageToken] Page reference token
393
409
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
394
- * @param {string} [search] Search term to filter results
410
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
395
411
  * @param {*} [options] Override http request option.
396
412
  * @throws {RequiredError}
397
413
  */
@@ -428,7 +444,7 @@ export const BlogsApiFp = function (configuration) {
428
444
  * @param {string} project What project it is
429
445
  * @param {number} [pageToken] Page reference token
430
446
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
431
- * @param {string} [search] Search term to filter results
447
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
432
448
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
433
449
  * @param {*} [options] Override http request option.
434
450
  * @throws {RequiredError}
@@ -1270,12 +1286,12 @@ export const KeyphraseOpportunitiesApiAxiosParamCreator = function (configuratio
1270
1286
  };
1271
1287
  }),
1272
1288
  /**
1273
- * List the key phrases saved as opportunities for a store that are not attached to content.
1289
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1274
1290
  * @summary List key phrase opportunities
1275
1291
  * @param {string} project What project it is
1276
1292
  * @param {number} [pageToken] Page reference token
1277
1293
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1278
- * @param {string} [search] Search term to filter results
1294
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1279
1295
  * @param {*} [options] Override http request option.
1280
1296
  * @throws {RequiredError}
1281
1297
  */
@@ -1344,12 +1360,12 @@ export const KeyphraseOpportunitiesApiFp = function (configuration) {
1344
1360
  });
1345
1361
  },
1346
1362
  /**
1347
- * List the key phrases saved as opportunities for a store that are not attached to content.
1363
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1348
1364
  * @summary List key phrase opportunities
1349
1365
  * @param {string} project What project it is
1350
1366
  * @param {number} [pageToken] Page reference token
1351
1367
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1352
- * @param {string} [search] Search term to filter results
1368
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1353
1369
  * @param {*} [options] Override http request option.
1354
1370
  * @throws {RequiredError}
1355
1371
  */
@@ -1381,7 +1397,7 @@ export const KeyphraseOpportunitiesApiFactory = function (configuration, basePat
1381
1397
  return localVarFp.deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(axios, basePath));
1382
1398
  },
1383
1399
  /**
1384
- * List the key phrases saved as opportunities for a store that are not attached to content.
1400
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1385
1401
  * @summary List key phrase opportunities
1386
1402
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1387
1403
  * @param {*} [options] Override http request option.
@@ -1407,7 +1423,7 @@ export class KeyphraseOpportunitiesApi extends BaseAPI {
1407
1423
  return KeyphraseOpportunitiesApiFp(this.configuration).deleteKeyphraseOpportunity(requestParameters.project, requestParameters.keyphraseOpportunityId, options).then((request) => request(this.axios, this.basePath));
1408
1424
  }
1409
1425
  /**
1410
- * List the key phrases saved as opportunities for a store that are not attached to content.
1426
+ * List key phrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1411
1427
  * @summary List key phrase opportunities
1412
1428
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1413
1429
  * @param {*} [options] Override http request option.
@@ -1684,7 +1700,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
1684
1700
  * @param {string} project What project it is
1685
1701
  * @param {number} [pageToken] Page reference token
1686
1702
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1687
- * @param {string} [search] Search term to filter results
1703
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1688
1704
  * @param {*} [options] Override http request option.
1689
1705
  * @throws {RequiredError}
1690
1706
  */
@@ -1817,7 +1833,7 @@ export const PagesApiAxiosParamCreator = function (configuration) {
1817
1833
  * @param {string} project What project it is
1818
1834
  * @param {number} [pageToken] Page reference token
1819
1835
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1820
- * @param {string} [search] Search term to filter results
1836
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1821
1837
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
1822
1838
  * @param {*} [options] Override http request option.
1823
1839
  * @throws {RequiredError}
@@ -1910,7 +1926,7 @@ export const PagesApiFp = function (configuration) {
1910
1926
  * @param {string} project What project it is
1911
1927
  * @param {number} [pageToken] Page reference token
1912
1928
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1913
- * @param {string} [search] Search term to filter results
1929
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1914
1930
  * @param {*} [options] Override http request option.
1915
1931
  * @throws {RequiredError}
1916
1932
  */
@@ -1964,7 +1980,7 @@ export const PagesApiFp = function (configuration) {
1964
1980
  * @param {string} project What project it is
1965
1981
  * @param {number} [pageToken] Page reference token
1966
1982
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1967
- * @param {string} [search] Search term to filter results
1983
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
1968
1984
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
1969
1985
  * @param {*} [options] Override http request option.
1970
1986
  * @throws {RequiredError}
@@ -2868,7 +2884,7 @@ export const ReviewsApiAxiosParamCreator = function (configuration) {
2868
2884
  * @param {string} project What project it is
2869
2885
  * @param {number} [pageToken] Page reference token
2870
2886
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2871
- * @param {string} [search] Search term to filter results
2887
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
2872
2888
  * @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.
2873
2889
  * @param {string} [start] Start of date range to filter by
2874
2890
  * @param {string} [end] End of date range to filter by
@@ -3020,7 +3036,7 @@ export const ReviewsApiFp = function (configuration) {
3020
3036
  * @param {string} project What project it is
3021
3037
  * @param {number} [pageToken] Page reference token
3022
3038
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3023
- * @param {string} [search] Search term to filter results
3039
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3024
3040
  * @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.
3025
3041
  * @param {string} [start] Start of date range to filter by
3026
3042
  * @param {string} [end] End of date range to filter by
@@ -3160,7 +3176,7 @@ export const RoutesApiAxiosParamCreator = function (configuration) {
3160
3176
  * @param {string} project What project it is
3161
3177
  * @param {number} [pageToken] Page reference token
3162
3178
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3163
- * @param {string} [search] Search term to filter results
3179
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3164
3180
  * @param {*} [options] Override http request option.
3165
3181
  * @throws {RequiredError}
3166
3182
  */
@@ -3217,7 +3233,7 @@ export const RoutesApiFp = function (configuration) {
3217
3233
  * @param {string} project What project it is
3218
3234
  * @param {number} [pageToken] Page reference token
3219
3235
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3220
- * @param {string} [search] Search term to filter results
3236
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3221
3237
  * @param {*} [options] Override http request option.
3222
3238
  * @throws {RequiredError}
3223
3239
  */
@@ -3276,7 +3292,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
3276
3292
  * @param {string} project What project it is
3277
3293
  * @param {number} [pageToken] Page reference token
3278
3294
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3279
- * @param {string} [search] Search term to filter results
3295
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3280
3296
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3281
3297
  * @param {*} [options] Override http request option.
3282
3298
  * @throws {RequiredError}
@@ -3410,7 +3426,7 @@ export const SearchApiAxiosParamCreator = function (configuration) {
3410
3426
  * @param {string} project What project it is
3411
3427
  * @param {number} [pageToken] Page reference token
3412
3428
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3413
- * @param {string} [search] Search term to filter results
3429
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3414
3430
  * @param {*} [options] Override http request option.
3415
3431
  * @throws {RequiredError}
3416
3432
  */
@@ -3511,7 +3527,7 @@ export const SearchApiFp = function (configuration) {
3511
3527
  * @param {string} project What project it is
3512
3528
  * @param {number} [pageToken] Page reference token
3513
3529
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3514
- * @param {string} [search] Search term to filter results
3530
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3515
3531
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3516
3532
  * @param {*} [options] Override http request option.
3517
3533
  * @throws {RequiredError}
@@ -3565,7 +3581,7 @@ export const SearchApiFp = function (configuration) {
3565
3581
  * @param {string} project What project it is
3566
3582
  * @param {number} [pageToken] Page reference token
3567
3583
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3568
- * @param {string} [search] Search term to filter results
3584
+ * @param {string} [search] Search term to filter results. Free text matches key phrase 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.
3569
3585
  * @param {*} [options] Override http request option.
3570
3586
  * @throws {RequiredError}
3571
3587
  */
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.34.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).