@wix/auto_sdk_stores_collections 1.0.0 → 1.0.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/build/cjs/src/stores-catalog-v1-collection-collections.types.d.ts +55 -12
- package/build/cjs/src/stores-catalog-v1-collection-collections.types.js.map +1 -1
- package/build/cjs/src/stores-catalog-v1-collection-collections.universal.d.ts +55 -12
- package/build/cjs/src/stores-catalog-v1-collection-collections.universal.js.map +1 -1
- package/build/es/src/stores-catalog-v1-collection-collections.types.d.ts +55 -12
- package/build/es/src/stores-catalog-v1-collection-collections.types.js.map +1 -1
- package/build/es/src/stores-catalog-v1-collection-collections.universal.d.ts +55 -12
- package/build/es/src/stores-catalog-v1-collection-collections.universal.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v1-collection-collections.types.d.ts +55 -12
- package/build/internal/cjs/src/stores-catalog-v1-collection-collections.types.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v1-collection-collections.universal.d.ts +55 -12
- package/build/internal/cjs/src/stores-catalog-v1-collection-collections.universal.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v1-collection-collections.types.d.ts +55 -12
- package/build/internal/es/src/stores-catalog-v1-collection-collections.types.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v1-collection-collections.universal.d.ts +55 -12
- package/build/internal/es/src/stores-catalog-v1-collection-collections.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":";;;AAqFA,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AAwGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
_id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,2HAA6G;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,2HAA6G;AAwF7G,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AAwGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkJD;;;;;GAKG;AACH,SAAgB,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,IAAA,8DAAqC,EAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,IAAA,gEAAuC,EAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AAtDD,4CAsDC;AA8DD;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,GAAW;IAEX,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,sCAAsC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAW,CAAC;IAC3E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACxC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjCD,sCAiCC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CACvC,IAAY;IAIZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtE,MAAM,OAAO,GACX,sCAAsC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;YAC1C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,kDAoCC"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":"AAqFA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAwGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
_id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,sCAAsC,MAAM,oDAAoD,CAAC;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,sCAAsC,MAAM,oDAAoD,CAAC;AAwF7G,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAwGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkJD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,YAAY,CAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,qCAAqC,CAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,uCAAuC,CAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AA8DD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW;IAEX,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,sCAAsC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAW,CAAC;IAC3E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACxC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAAY;IAIZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtE,MAAM,OAAO,GACX,sCAAsC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;YAC1C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":";;;AAqFA,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AAwGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
_id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,2HAA6G;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,2HAA6G;AAwF7G,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,6BAAb,aAAa,QAYxB;AAwGD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkJD;;;;;GAKG;AACH,SAAgB,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,IAAA,8DAAqC,EAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,IAAA,gEAAuC,EAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AAtDD,4CAsDC;AA8DD;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,GAAW;IAEX,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,sCAAsC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAW,CAAC;IAC3E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACxC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAjCD,sCAiCC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CACvC,IAAY;IAIZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtE,MAAM,OAAO,GACX,sCAAsC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;YAC1C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AApCD,kDAoCC"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.types.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.types.ts"],"names":[],"mappings":"AAqFA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAwGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
export interface Collection {
|
|
2
2
|
/**
|
|
3
3
|
* Collection ID (generated automatically by the catalog).
|
|
4
|
+
* @minLength 35
|
|
5
|
+
* @maxLength 36
|
|
4
6
|
* @readonly
|
|
5
7
|
*/
|
|
6
8
|
_id?: string | null;
|
|
7
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Collection name.
|
|
11
|
+
* @minLength 1
|
|
12
|
+
* @maxLength 50
|
|
13
|
+
*/
|
|
8
14
|
name?: string | null;
|
|
9
15
|
/**
|
|
10
16
|
* Media items (images, videos etc) associated with this collection. Read only.
|
|
@@ -16,9 +22,16 @@ export interface Collection {
|
|
|
16
22
|
* @readonly
|
|
17
23
|
*/
|
|
18
24
|
numberOfProducts?: number;
|
|
19
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Collection description.
|
|
27
|
+
* @maxLength 600
|
|
28
|
+
*/
|
|
20
29
|
description?: string | null;
|
|
21
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* Collection slug.
|
|
32
|
+
* @minLength 1
|
|
33
|
+
* @maxLength 100
|
|
34
|
+
*/
|
|
22
35
|
slug?: string | null;
|
|
23
36
|
/** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
|
|
24
37
|
visible?: boolean | null;
|
|
@@ -51,7 +64,10 @@ export interface MediaItemItemOneOf {
|
|
|
51
64
|
video?: MediaItemVideo;
|
|
52
65
|
}
|
|
53
66
|
export interface MediaItemUrlAndSize {
|
|
54
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Media item URL.
|
|
69
|
+
* @format WEB_URL
|
|
70
|
+
*/
|
|
55
71
|
url?: string;
|
|
56
72
|
/** Media item width. */
|
|
57
73
|
width?: number;
|
|
@@ -97,7 +113,10 @@ export interface Keyword {
|
|
|
97
113
|
term?: string;
|
|
98
114
|
/** Whether the keyword is the main focus keyword. */
|
|
99
115
|
isMain?: boolean;
|
|
100
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* The source that added the keyword terms to the SEO settings.
|
|
118
|
+
* @maxLength 1000
|
|
119
|
+
*/
|
|
101
120
|
origin?: string | null;
|
|
102
121
|
}
|
|
103
122
|
export interface Tag {
|
|
@@ -130,7 +149,10 @@ export interface Settings {
|
|
|
130
149
|
* Default: `false` (Auto Redirect is enabled.)
|
|
131
150
|
*/
|
|
132
151
|
preventAutoRedirect?: boolean;
|
|
133
|
-
/**
|
|
152
|
+
/**
|
|
153
|
+
* User-selected keyword terms for a specific page.
|
|
154
|
+
* @maxSize 5
|
|
155
|
+
*/
|
|
134
156
|
keywords?: Keyword[];
|
|
135
157
|
}
|
|
136
158
|
export interface QueryCollectionsRequest {
|
|
@@ -154,7 +176,10 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
154
176
|
cursorPaging?: CursorPaging;
|
|
155
177
|
}
|
|
156
178
|
export interface Sorting {
|
|
157
|
-
/**
|
|
179
|
+
/**
|
|
180
|
+
* Name of the field to sort by.
|
|
181
|
+
* @maxLength 512
|
|
182
|
+
*/
|
|
158
183
|
fieldName?: string;
|
|
159
184
|
/** Sort order. */
|
|
160
185
|
order?: SortOrder;
|
|
@@ -164,23 +189,31 @@ export declare enum SortOrder {
|
|
|
164
189
|
DESC = "DESC"
|
|
165
190
|
}
|
|
166
191
|
export interface PlatformPaging {
|
|
167
|
-
/**
|
|
192
|
+
/**
|
|
193
|
+
* Number of items to load.
|
|
194
|
+
* @max 100
|
|
195
|
+
*/
|
|
168
196
|
limit?: number | null;
|
|
169
197
|
/** Number of items to skip in the current sort order. */
|
|
170
198
|
offset?: number | null;
|
|
171
199
|
}
|
|
172
200
|
export interface CursorPaging {
|
|
173
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Maximum number of items to return in the results.
|
|
203
|
+
* @max 100
|
|
204
|
+
*/
|
|
174
205
|
limit?: number | null;
|
|
175
206
|
/**
|
|
176
207
|
* Pointer to the next or previous page in the list of results.
|
|
177
208
|
*
|
|
178
209
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
179
210
|
* Not relevant for the first request.
|
|
211
|
+
* @maxLength 16000
|
|
180
212
|
*/
|
|
181
213
|
cursor?: string | null;
|
|
182
214
|
}
|
|
183
215
|
export interface QueryCollectionsResponse {
|
|
216
|
+
/** @maxSize 100 */
|
|
184
217
|
collections?: Collection[];
|
|
185
218
|
metadata?: PlatformPagingMetadata;
|
|
186
219
|
}
|
|
@@ -195,9 +228,15 @@ export interface PlatformPagingMetadata {
|
|
|
195
228
|
cursors?: Cursors;
|
|
196
229
|
}
|
|
197
230
|
export interface Cursors {
|
|
198
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* Cursor string pointing to the next page in the list of results.
|
|
233
|
+
* @maxLength 16000
|
|
234
|
+
*/
|
|
199
235
|
next?: string | null;
|
|
200
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Cursor pointing to the previous page in the list of results.
|
|
238
|
+
* @maxLength 16000
|
|
239
|
+
*/
|
|
201
240
|
prev?: string | null;
|
|
202
241
|
}
|
|
203
242
|
export interface GetCollectionRequest {
|
|
@@ -208,7 +247,11 @@ export interface GetCollectionResponse {
|
|
|
208
247
|
collection?: Collection;
|
|
209
248
|
}
|
|
210
249
|
export interface GetCollectionBySlugRequest {
|
|
211
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Slug of the collection to retrieve.
|
|
252
|
+
* @minLength 1
|
|
253
|
+
* @maxLength 100
|
|
254
|
+
*/
|
|
212
255
|
slug: string;
|
|
213
256
|
}
|
|
214
257
|
export interface GetCollectionBySlugResponse {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,sCAAsC,MAAM,oDAAoD,CAAC;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v1-collection-collections.universal.js","sourceRoot":"","sources":["../../../../src/stores-catalog-v1-collection-collections.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,sCAAsC,MAAM,oDAAoD,CAAC;AAwF7G,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,wBAAwB;IACxB,gCAAe,CAAA;IACf,2BAA2B;IAC3B,sCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAW,CAAA;AACb,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAwGD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAkJD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB;IAC9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,YAAY,CAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC/C,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAAuC,EAAE,EAAE;YAC9D,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAA2C,CAAC;YACnE,OAAO,qCAAqC,CAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAA0C,EAAE,EAAE;YACxE,MAAM,eAAe,GAAG,uCAAuC,CAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,WAAW;gBACnC,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC;AA8DD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW;IAEX,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAEnE,MAAM,OAAO,GAAG,sCAAsC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAW,CAAC;IAC3E,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE;YACxC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAAY;IAIZ,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtE,MAAM,OAAO,GACX,sCAAsC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;YAC1C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,MAAM,CAAC,CACT,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_stores_collections",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"fqdn": "wix.stores.catalog.v1.collection"
|
|
49
49
|
}
|
|
50
50
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
51
|
+
"falconPackageHash": "0049bec81766abf41443b41b7f06817533041b88dfacdd20a9a77a9f"
|
|
52
52
|
}
|