@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.
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.34.1
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 keyphrase opportunities list.
201
+ */
202
+ export interface KeyphraseOpportunitiesResponseMetaFilters {
203
+ /**
204
+ * Filter by whether the keyphrase is assigned to content.
205
+ */
206
+ 'assigned': Array<KeyphraseOpportunitiesResponseMetaFiltersAssignedEnum>;
207
+ /**
208
+ * Filter by whether the keyphrase is attached to published content.
209
+ */
210
+ 'published': Array<KeyphraseOpportunitiesResponseMetaFiltersPublishedEnum>;
211
+ /**
212
+ * Filter by whether the keyphrase 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,33 @@ export interface KeyphraseOpportunity {
211
238
  * Monthly search volume for the keyphrase
212
239
  */
213
240
  'monthlyVolume': number | null;
241
+ /**
242
+ * Merchandising issues for this keyphrase opportunity.
243
+ */
244
+ 'merchIssues': Array<string>;
245
+ 'content': KeyphraseOpportunityContent | null;
246
+ }
247
+ /**
248
+ * Content the keyphrase is assigned to.
249
+ */
250
+ export interface KeyphraseOpportunityContent {
251
+ /**
252
+ * The type of content the keyphrase is assigned to.
253
+ */
254
+ 'type': KeyphraseOpportunityContentTypeEnum;
255
+ 'id': string;
256
+ /**
257
+ * The name of the attached content
258
+ */
259
+ 'name': string;
214
260
  }
261
+ export declare const KeyphraseOpportunityContentTypeEnum: {
262
+ readonly Product: "product";
263
+ readonly Collection: "collection";
264
+ readonly Blog: "blog";
265
+ readonly Page: "page";
266
+ };
267
+ export type KeyphraseOpportunityContentTypeEnum = typeof KeyphraseOpportunityContentTypeEnum[keyof typeof KeyphraseOpportunityContentTypeEnum];
215
268
  export interface ListDomains200Response {
216
269
  'domains': Array<Domain>;
217
270
  /**
@@ -1042,7 +1095,7 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
1042
1095
  * @param {string} project What project it is
1043
1096
  * @param {number} [pageToken] Page reference token
1044
1097
  * @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
1098
+ * @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.
1046
1099
  * @param {*} [options] Override http request option.
1047
1100
  * @throws {RequiredError}
1048
1101
  */
@@ -1063,7 +1116,7 @@ export declare const BlogsApiAxiosParamCreator: (configuration?: Configuration)
1063
1116
  * @param {string} project What project it is
1064
1117
  * @param {number} [pageToken] Page reference token
1065
1118
  * @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
1119
+ * @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.
1067
1120
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1068
1121
  * @param {*} [options] Override http request option.
1069
1122
  * @throws {RequiredError}
@@ -1097,7 +1150,7 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
1097
1150
  * @param {string} project What project it is
1098
1151
  * @param {number} [pageToken] Page reference token
1099
1152
  * @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
1153
+ * @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.
1101
1154
  * @param {*} [options] Override http request option.
1102
1155
  * @throws {RequiredError}
1103
1156
  */
@@ -1118,7 +1171,7 @@ export declare const BlogsApiFp: (configuration?: Configuration) => {
1118
1171
  * @param {string} project What project it is
1119
1172
  * @param {number} [pageToken] Page reference token
1120
1173
  * @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
1174
+ * @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.
1122
1175
  * @param {UpdateBlogsRequest} [updateBlogsRequest] Update blogs in bulk.
1123
1176
  * @param {*} [options] Override http request option.
1124
1177
  * @throws {RequiredError}
@@ -1209,7 +1262,7 @@ export interface BlogsApiListBlogsRequest {
1209
1262
  */
1210
1263
  readonly pageSize?: number;
1211
1264
  /**
1212
- * Search term to filter results
1265
+ * 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.
1213
1266
  */
1214
1267
  readonly search?: string;
1215
1268
  }
@@ -1244,7 +1297,7 @@ export interface BlogsApiUpdateBlogsRequest {
1244
1297
  */
1245
1298
  readonly pageSize?: number;
1246
1299
  /**
1247
- * Search term to filter results
1300
+ * 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.
1248
1301
  */
1249
1302
  readonly search?: string;
1250
1303
  /**
@@ -1717,21 +1770,21 @@ export declare class FooterApi extends BaseAPI {
1717
1770
  */
1718
1771
  export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?: Configuration) => {
1719
1772
  /**
1720
- * Remove a key phrase opportunity from the store.
1721
- * @summary Delete key phrase opportunity
1773
+ * Remove a keyphrase opportunity from the store.
1774
+ * @summary Delete keyphrase opportunity
1722
1775
  * @param {string} project What project it is
1723
- * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
1776
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1724
1777
  * @param {*} [options] Override http request option.
1725
1778
  * @throws {RequiredError}
1726
1779
  */
1727
1780
  deleteKeyphraseOpportunity: (project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
1781
  /**
1729
- * List the key phrases saved as opportunities for a store that are not attached to content.
1730
- * @summary List key phrase opportunities
1782
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1783
+ * @summary List keyphrase opportunities
1731
1784
  * @param {string} project What project it is
1732
1785
  * @param {number} [pageToken] Page reference token
1733
1786
  * @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
1787
+ * @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.
1735
1788
  * @param {*} [options] Override http request option.
1736
1789
  * @throws {RequiredError}
1737
1790
  */
@@ -1742,21 +1795,21 @@ export declare const KeyphraseOpportunitiesApiAxiosParamCreator: (configuration?
1742
1795
  */
1743
1796
  export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration) => {
1744
1797
  /**
1745
- * Remove a key phrase opportunity from the store.
1746
- * @summary Delete key phrase opportunity
1798
+ * Remove a keyphrase opportunity from the store.
1799
+ * @summary Delete keyphrase opportunity
1747
1800
  * @param {string} project What project it is
1748
- * @param {string} keyphraseOpportunityId Key phrase opportunity\&#39;s unique identifier
1801
+ * @param {string} keyphraseOpportunityId Keyphrase opportunity\&#39;s unique identifier
1749
1802
  * @param {*} [options] Override http request option.
1750
1803
  * @throws {RequiredError}
1751
1804
  */
1752
1805
  deleteKeyphraseOpportunity(project: string, keyphraseOpportunityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1753
1806
  /**
1754
- * List the key phrases saved as opportunities for a store that are not attached to content.
1755
- * @summary List key phrase opportunities
1807
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1808
+ * @summary List keyphrase opportunities
1756
1809
  * @param {string} project What project it is
1757
1810
  * @param {number} [pageToken] Page reference token
1758
1811
  * @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
1812
+ * @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.
1760
1813
  * @param {*} [options] Override http request option.
1761
1814
  * @throws {RequiredError}
1762
1815
  */
@@ -1767,16 +1820,16 @@ export declare const KeyphraseOpportunitiesApiFp: (configuration?: Configuration
1767
1820
  */
1768
1821
  export declare const KeyphraseOpportunitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1769
1822
  /**
1770
- * Remove a key phrase opportunity from the store.
1771
- * @summary Delete key phrase opportunity
1823
+ * Remove a keyphrase opportunity from the store.
1824
+ * @summary Delete keyphrase opportunity
1772
1825
  * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
1773
1826
  * @param {*} [options] Override http request option.
1774
1827
  * @throws {RequiredError}
1775
1828
  */
1776
1829
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1777
1830
  /**
1778
- * List the key phrases saved as opportunities for a store that are not attached to content.
1779
- * @summary List key phrase opportunities
1831
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1832
+ * @summary List keyphrase opportunities
1780
1833
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1781
1834
  * @param {*} [options] Override http request option.
1782
1835
  * @throws {RequiredError}
@@ -1792,7 +1845,7 @@ export interface KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest {
1792
1845
  */
1793
1846
  readonly project: string;
1794
1847
  /**
1795
- * Key phrase opportunity\&#39;s unique identifier
1848
+ * Keyphrase opportunity\&#39;s unique identifier
1796
1849
  */
1797
1850
  readonly keyphraseOpportunityId: string;
1798
1851
  }
@@ -1813,7 +1866,7 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
1813
1866
  */
1814
1867
  readonly pageSize?: number;
1815
1868
  /**
1816
- * Search term to filter results
1869
+ * 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.
1817
1870
  */
1818
1871
  readonly search?: string;
1819
1872
  }
@@ -1822,16 +1875,16 @@ export interface KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest {
1822
1875
  */
1823
1876
  export declare class KeyphraseOpportunitiesApi extends BaseAPI {
1824
1877
  /**
1825
- * Remove a key phrase opportunity from the store.
1826
- * @summary Delete key phrase opportunity
1878
+ * Remove a keyphrase opportunity from the store.
1879
+ * @summary Delete keyphrase opportunity
1827
1880
  * @param {KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest} requestParameters Request parameters.
1828
1881
  * @param {*} [options] Override http request option.
1829
1882
  * @throws {RequiredError}
1830
1883
  */
1831
1884
  deleteKeyphraseOpportunity(requestParameters: KeyphraseOpportunitiesApiDeleteKeyphraseOpportunityRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1832
1885
  /**
1833
- * List the key phrases saved as opportunities for a store that are not attached to content.
1834
- * @summary List key phrase opportunities
1886
+ * List keyphrases saved as opportunities for a store. Use search tags to filter by assignment, publication, and optimisation status.
1887
+ * @summary List keyphrase opportunities
1835
1888
  * @param {KeyphraseOpportunitiesApiListKeyphraseOpportunitiesRequest} requestParameters Request parameters.
1836
1889
  * @param {*} [options] Override http request option.
1837
1890
  * @throws {RequiredError}
@@ -1973,7 +2026,7 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
1973
2026
  * @param {string} project What project it is
1974
2027
  * @param {number} [pageToken] Page reference token
1975
2028
  * @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
2029
+ * @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.
1977
2030
  * @param {*} [options] Override http request option.
1978
2031
  * @throws {RequiredError}
1979
2032
  */
@@ -2003,7 +2056,7 @@ export declare const PagesApiAxiosParamCreator: (configuration?: Configuration)
2003
2056
  * @param {string} project What project it is
2004
2057
  * @param {number} [pageToken] Page reference token
2005
2058
  * @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
2059
+ * @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.
2007
2060
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
2008
2061
  * @param {*} [options] Override http request option.
2009
2062
  * @throws {RequiredError}
@@ -2037,7 +2090,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2037
2090
  * @param {string} project What project it is
2038
2091
  * @param {number} [pageToken] Page reference token
2039
2092
  * @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
2093
+ * @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.
2041
2094
  * @param {*} [options] Override http request option.
2042
2095
  * @throws {RequiredError}
2043
2096
  */
@@ -2067,7 +2120,7 @@ export declare const PagesApiFp: (configuration?: Configuration) => {
2067
2120
  * @param {string} project What project it is
2068
2121
  * @param {number} [pageToken] Page reference token
2069
2122
  * @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
2123
+ * @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.
2071
2124
  * @param {UpdatePagesRequest} [updatePagesRequest] Update pages in bulk.
2072
2125
  * @param {*} [options] Override http request option.
2073
2126
  * @throws {RequiredError}
@@ -2166,7 +2219,7 @@ export interface PagesApiListPagesRequest {
2166
2219
  */
2167
2220
  readonly pageSize?: number;
2168
2221
  /**
2169
- * Search term to filter results
2222
+ * 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.
2170
2223
  */
2171
2224
  readonly search?: string;
2172
2225
  }
@@ -2214,7 +2267,7 @@ export interface PagesApiUpdatePagesRequest {
2214
2267
  */
2215
2268
  readonly pageSize?: number;
2216
2269
  /**
2217
- * Search term to filter results
2270
+ * 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.
2218
2271
  */
2219
2272
  readonly search?: string;
2220
2273
  /**
@@ -2690,7 +2743,7 @@ export declare const ReviewsApiAxiosParamCreator: (configuration?: Configuration
2690
2743
  * @param {string} project What project it is
2691
2744
  * @param {number} [pageToken] Page reference token
2692
2745
  * @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
2746
+ * @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.
2694
2747
  * @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
2748
  * @param {string} [start] Start of date range to filter by
2696
2749
  * @param {string} [end] End of date range to filter by
@@ -2738,7 +2791,7 @@ export declare const ReviewsApiFp: (configuration?: Configuration) => {
2738
2791
  * @param {string} project What project it is
2739
2792
  * @param {number} [pageToken] Page reference token
2740
2793
  * @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
2794
+ * @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.
2742
2795
  * @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
2796
  * @param {string} [start] Start of date range to filter by
2744
2797
  * @param {string} [end] End of date range to filter by
@@ -2841,7 +2894,7 @@ export interface ReviewsApiListReviewsRequest {
2841
2894
  */
2842
2895
  readonly pageSize?: number;
2843
2896
  /**
2844
- * Search term to filter results
2897
+ * 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.
2845
2898
  */
2846
2899
  readonly search?: string;
2847
2900
  /**
@@ -2918,7 +2971,7 @@ export declare const RoutesApiAxiosParamCreator: (configuration?: Configuration)
2918
2971
  * @param {string} project What project it is
2919
2972
  * @param {number} [pageToken] Page reference token
2920
2973
  * @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
2974
+ * @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.
2922
2975
  * @param {*} [options] Override http request option.
2923
2976
  * @throws {RequiredError}
2924
2977
  */
@@ -2934,7 +2987,7 @@ export declare const RoutesApiFp: (configuration?: Configuration) => {
2934
2987
  * @param {string} project What project it is
2935
2988
  * @param {number} [pageToken] Page reference token
2936
2989
  * @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
2990
+ * @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.
2938
2991
  * @param {*} [options] Override http request option.
2939
2992
  * @throws {RequiredError}
2940
2993
  */
@@ -2970,7 +3023,7 @@ export interface RoutesApiListRoutesRequest {
2970
3023
  */
2971
3024
  readonly pageSize?: number;
2972
3025
  /**
2973
- * Search term to filter results
3026
+ * 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.
2974
3027
  */
2975
3028
  readonly search?: string;
2976
3029
  }
@@ -2997,7 +3050,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
2997
3050
  * @param {string} project What project it is
2998
3051
  * @param {number} [pageToken] Page reference token
2999
3052
  * @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
3053
+ * @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.
3001
3054
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3002
3055
  * @param {*} [options] Override http request option.
3003
3056
  * @throws {RequiredError}
@@ -3027,7 +3080,7 @@ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration)
3027
3080
  * @param {string} project What project it is
3028
3081
  * @param {number} [pageToken] Page reference token
3029
3082
  * @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
3083
+ * @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.
3031
3084
  * @param {*} [options] Override http request option.
3032
3085
  * @throws {RequiredError}
3033
3086
  */
@@ -3053,7 +3106,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
3053
3106
  * @param {string} project What project it is
3054
3107
  * @param {number} [pageToken] Page reference token
3055
3108
  * @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
3109
+ * @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.
3057
3110
  * @param {CreateSearchRedirectRequest} [createSearchRedirectRequest] Create search redirect
3058
3111
  * @param {*} [options] Override http request option.
3059
3112
  * @throws {RequiredError}
@@ -3083,7 +3136,7 @@ export declare const SearchApiFp: (configuration?: Configuration) => {
3083
3136
  * @param {string} project What project it is
3084
3137
  * @param {number} [pageToken] Page reference token
3085
3138
  * @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
3139
+ * @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.
3087
3140
  * @param {*} [options] Override http request option.
3088
3141
  * @throws {RequiredError}
3089
3142
  */
@@ -3161,7 +3214,7 @@ export interface SearchApiCreateSearchRedirectRequest {
3161
3214
  */
3162
3215
  readonly pageSize?: number;
3163
3216
  /**
3164
- * Search term to filter results
3217
+ * 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.
3165
3218
  */
3166
3219
  readonly search?: string;
3167
3220
  /**
@@ -3212,7 +3265,7 @@ export interface SearchApiListSearchRedirectsRequest {
3212
3265
  */
3213
3266
  readonly pageSize?: number;
3214
3267
  /**
3215
- * Search term to filter results
3268
+ * 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.
3216
3269
  */
3217
3270
  readonly search?: string;
3218
3271
  }