@wix/blog 1.0.118 → 1.0.119
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/blog-v3-category.types.d.ts +60 -32
- package/build/cjs/src/blog-v3-category.types.js.map +1 -1
- package/build/cjs/src/blog-v3-category.universal.d.ts +51 -34
- package/build/cjs/src/blog-v3-category.universal.js.map +1 -1
- package/build/cjs/src/blog-v3-post.types.d.ts +97 -29
- package/build/cjs/src/blog-v3-post.types.js.map +1 -1
- package/build/cjs/src/blog-v3-post.universal.d.ts +59 -10
- package/build/cjs/src/blog-v3-post.universal.js.map +1 -1
- package/build/cjs/src/blog-v3-tag.http.d.ts +1 -1
- package/build/cjs/src/blog-v3-tag.http.js +1 -1
- package/build/cjs/src/blog-v3-tag.http.js.map +1 -1
- package/build/cjs/src/blog-v3-tag.types.d.ts +57 -25
- package/build/cjs/src/blog-v3-tag.types.js.map +1 -1
- package/build/cjs/src/blog-v3-tag.universal.d.ts +70 -30
- package/build/cjs/src/blog-v3-tag.universal.js +1 -1
- package/build/cjs/src/blog-v3-tag.universal.js.map +1 -1
- package/build/es/src/blog-v3-category.types.d.ts +60 -32
- package/build/es/src/blog-v3-category.types.js.map +1 -1
- package/build/es/src/blog-v3-category.universal.d.ts +51 -34
- package/build/es/src/blog-v3-category.universal.js.map +1 -1
- package/build/es/src/blog-v3-post.types.d.ts +97 -29
- package/build/es/src/blog-v3-post.types.js.map +1 -1
- package/build/es/src/blog-v3-post.universal.d.ts +59 -10
- package/build/es/src/blog-v3-post.universal.js.map +1 -1
- package/build/es/src/blog-v3-tag.http.d.ts +1 -1
- package/build/es/src/blog-v3-tag.http.js +1 -1
- package/build/es/src/blog-v3-tag.http.js.map +1 -1
- package/build/es/src/blog-v3-tag.types.d.ts +57 -25
- package/build/es/src/blog-v3-tag.types.js.map +1 -1
- package/build/es/src/blog-v3-tag.universal.d.ts +70 -30
- package/build/es/src/blog-v3-tag.universal.js +1 -1
- package/build/es/src/blog-v3-tag.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -13,7 +13,6 @@ export interface Tag {
|
|
|
13
13
|
/**
|
|
14
14
|
* Tag label.
|
|
15
15
|
*
|
|
16
|
-
*
|
|
17
16
|
* A blog cannot have two tags with the same label.
|
|
18
17
|
*/
|
|
19
18
|
label?: string;
|
|
@@ -65,7 +64,6 @@ export interface Tag {
|
|
|
65
64
|
/**
|
|
66
65
|
* Tag language.
|
|
67
66
|
*
|
|
68
|
-
*
|
|
69
67
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
70
68
|
* @readonly
|
|
71
69
|
*/
|
|
@@ -95,14 +93,18 @@ export interface GetOrCreateTagResponse {
|
|
|
95
93
|
export interface CreateTagRequest {
|
|
96
94
|
/** Tag label. Unique per blog. */
|
|
97
95
|
label: string;
|
|
98
|
-
/**
|
|
96
|
+
/**
|
|
97
|
+
* Tag language.
|
|
98
|
+
*
|
|
99
|
+
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
100
|
+
*/
|
|
99
101
|
language?: string;
|
|
100
102
|
/** Preferred tag slug. For example, 'tag-slug'. */
|
|
101
103
|
slug?: string | null;
|
|
102
104
|
/**
|
|
103
|
-
* List of tag fields to be included if entities are present
|
|
104
|
-
* Base fieldset
|
|
105
|
-
*
|
|
105
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
106
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
107
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
106
108
|
*/
|
|
107
109
|
fieldsets?: Field[];
|
|
108
110
|
}
|
|
@@ -176,14 +178,22 @@ export interface BulkActionMetadata {
|
|
|
176
178
|
export interface GetTagByLabelRequest {
|
|
177
179
|
/** Tag label. */
|
|
178
180
|
label: string;
|
|
179
|
-
/**
|
|
181
|
+
/**
|
|
182
|
+
* Tag language.
|
|
183
|
+
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
184
|
+
*/
|
|
180
185
|
language?: string | null;
|
|
181
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
188
|
+
* This parameter will be removed on June 30, 2023.
|
|
189
|
+
*
|
|
190
|
+
* List of tag fields to be included in the response.
|
|
191
|
+
*/
|
|
182
192
|
fieldsToInclude?: Field[];
|
|
183
193
|
/**
|
|
184
|
-
* List of tag fields to be included if entities are present
|
|
185
|
-
* Base fieldset
|
|
186
|
-
*
|
|
194
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
195
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
196
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
187
197
|
*/
|
|
188
198
|
fieldsets?: Field[];
|
|
189
199
|
}
|
|
@@ -195,9 +205,9 @@ export interface GetTagRequest {
|
|
|
195
205
|
/** Tag ID. */
|
|
196
206
|
tagId: string;
|
|
197
207
|
/**
|
|
198
|
-
* List of tag fields to be included if entities are present
|
|
199
|
-
* Base fieldset
|
|
200
|
-
*
|
|
208
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
209
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
210
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
201
211
|
*/
|
|
202
212
|
fieldsets?: Field[];
|
|
203
213
|
}
|
|
@@ -209,9 +219,9 @@ export interface GetTagBySlugRequest {
|
|
|
209
219
|
/** Slug of the tag to retrieve. */
|
|
210
220
|
slug: string;
|
|
211
221
|
/**
|
|
212
|
-
* List of tag fields to be included if entities are present
|
|
213
|
-
* Base fieldset
|
|
214
|
-
*
|
|
222
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
223
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
224
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
215
225
|
*/
|
|
216
226
|
fieldsets?: Field[];
|
|
217
227
|
}
|
|
@@ -221,22 +231,40 @@ export interface GetTagBySlugResponse {
|
|
|
221
231
|
}
|
|
222
232
|
export interface QueryTagsRequest {
|
|
223
233
|
/**
|
|
234
|
+
* __Deprecated.__ Use `query` instead.
|
|
235
|
+
* This parameter will be removed on June 30, 2023.
|
|
236
|
+
*
|
|
224
237
|
* Filter object.
|
|
225
238
|
* For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).
|
|
226
239
|
*/
|
|
227
240
|
filter?: Record<string, any> | null;
|
|
228
|
-
/**
|
|
241
|
+
/**
|
|
242
|
+
* __Deprecated.__ Use `query` instead.
|
|
243
|
+
* This parameter will be removed on June 30, 2023.
|
|
244
|
+
*
|
|
245
|
+
* Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).
|
|
246
|
+
*/
|
|
229
247
|
sort?: Sorting[];
|
|
230
|
-
/**
|
|
248
|
+
/**
|
|
249
|
+
* __Deprecated.__ Use `query` instead.
|
|
250
|
+
* This parameter will be removed on June 30, 2023.
|
|
251
|
+
*
|
|
252
|
+
* Pagination options.
|
|
253
|
+
*/
|
|
231
254
|
paging?: Paging;
|
|
232
|
-
/**
|
|
255
|
+
/**
|
|
256
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
257
|
+
* This parameter will be removed on June 30, 2023.
|
|
258
|
+
*
|
|
259
|
+
* List of tag fields to be included in the response.
|
|
260
|
+
*/
|
|
233
261
|
fieldsToInclude?: Field[];
|
|
234
262
|
/** Query options. */
|
|
235
263
|
query?: PlatformQuery;
|
|
236
264
|
/**
|
|
237
|
-
* List of tag fields to be included if entities are present
|
|
238
|
-
* Base fieldset
|
|
239
|
-
*
|
|
265
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
266
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
267
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
240
268
|
*/
|
|
241
269
|
fieldsets?: Field[];
|
|
242
270
|
}
|
|
@@ -302,7 +330,12 @@ export interface CursorPaging {
|
|
|
302
330
|
export interface QueryTagsResponse {
|
|
303
331
|
/** List of tags. */
|
|
304
332
|
tags?: Tag[];
|
|
305
|
-
/**
|
|
333
|
+
/**
|
|
334
|
+
* __Deprecated.__ Use `pagingMetadata` instead.
|
|
335
|
+
* This property will be removed on June 30, 2023.
|
|
336
|
+
*
|
|
337
|
+
* Details on the paged set of results returned.
|
|
338
|
+
*/
|
|
306
339
|
metaData?: MetaData;
|
|
307
340
|
/** Details on the paged set of results returned. */
|
|
308
341
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -369,21 +402,25 @@ export interface DeleteTagRequest {
|
|
|
369
402
|
export interface DeleteTagResponse {
|
|
370
403
|
}
|
|
371
404
|
/**
|
|
372
|
-
* Creates a new tag with the provided label if the tag does not exist.
|
|
405
|
+
* Creates a new tag with the provided label if the tag does not already exist.
|
|
373
406
|
* @param label - Tag label. Unique per blog.
|
|
374
407
|
* @public
|
|
375
408
|
* @requiredField label
|
|
376
409
|
*/
|
|
377
410
|
export declare function createTag(label: string, options?: CreateTagOptions): Promise<CreateTagResponse>;
|
|
378
411
|
export interface CreateTagOptions {
|
|
379
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* Tag language.
|
|
414
|
+
*
|
|
415
|
+
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
416
|
+
*/
|
|
380
417
|
language?: string;
|
|
381
418
|
/** Preferred tag slug. For example, 'tag-slug'. */
|
|
382
419
|
slug?: string | null;
|
|
383
420
|
/**
|
|
384
|
-
* List of tag fields to be included if entities are present
|
|
385
|
-
* Base fieldset
|
|
386
|
-
*
|
|
421
|
+
* List of tag fields to be included in the response if the entities are present.
|
|
422
|
+
* Base default fieldset returns all core tag properties (all properties that are not a supported fieldset value).
|
|
423
|
+
* For example, when `URL` fieldset is selected, returned tag will include the set of base properties and the tag's preview url.
|
|
387
424
|
*/
|
|
388
425
|
fieldsets?: Field[];
|
|
389
426
|
}
|
|
@@ -399,7 +436,10 @@ export interface CreateTagOptions {
|
|
|
399
436
|
*/
|
|
400
437
|
export declare function getTagByLabel(label: string, options?: GetTagByLabelOptions): Promise<GetTagByLabelResponse>;
|
|
401
438
|
export interface GetTagByLabelOptions {
|
|
402
|
-
/**
|
|
439
|
+
/**
|
|
440
|
+
* Tag language.
|
|
441
|
+
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
442
|
+
*/
|
|
403
443
|
language?: string | null;
|
|
404
444
|
/** __Deprecated.__ Use GetTagByLabelOptions.fieldsets */
|
|
405
445
|
fieldsToInclude?: Field[];
|
|
@@ -73,7 +73,7 @@ const _queryTagsRequest = {};
|
|
|
73
73
|
const _queryTagsResponse = { tags: '_tag' };
|
|
74
74
|
const _tag = { url: 'wix.common.PageUrl' };
|
|
75
75
|
/**
|
|
76
|
-
* Creates a new tag with the provided label if the tag does not exist.
|
|
76
|
+
* Creates a new tag with the provided label if the tag does not already exist.
|
|
77
77
|
* @param label - Tag label. Unique per blog.
|
|
78
78
|
* @public
|
|
79
79
|
* @requiredField label
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blog-v3-tag.universal.js","sourceRoot":"","sources":["../../../src/blog-v3-tag.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,2EAA6D;AAC7D,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"blog-v3-tag.universal.js","sourceRoot":"","sources":["../../../src/blog-v3-tag.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,2EAA6D;AAC7D,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAiF5B,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,qCAAqC;IACrC,oBAAW,CAAA;AACb,CAAC,EAJW,KAAK,GAAL,aAAK,KAAL,aAAK,QAIhB;AAiND,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA0ID,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AAC3C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AAC/C,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AAC9C,MAAM,cAAc,GAAG,EAAE,CAAC;AAC1B,MAAM,eAAe,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACxC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC5C,MAAM,IAAI,GAAG,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC;AAE3C;;;;;GAKG;AACH,SAAsB,SAAS,CAC7B,KAAa,EACb,OAA0B;;QAE1B,MAAM,qBAAqB,GAAG;YAC5B,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,eAAe;YACzB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,iBAAiB;YAC7B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE,IAAI,EAAE;YACpB,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,sBAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE1D,KAAK,CAAC,qCAAqC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjE,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AArDD,8BAqDC;AAmBD;;;;;;;;;GASG;AACH,SAAsB,aAAa,CACjC,KAAa,EACb,OAA8B;;QAE9B,MAAM,qBAAqB,GAAG;YAC5B,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,eAAe;YACzB,eAAe,EAAE,sBAAsB;YACvC,SAAS,EAAE,gBAAgB;SAC5B,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,EAAE,IAAI,EAAE;YACpB,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,sBAAsB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE9D,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AArDD,sCAqDC;AAmBD;;;;;;;;;GASG;AACH,SAAsB,MAAM,CAC1B,KAAa,EACb,OAAuB;;QAEvB,MAAM,qBAAqB,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC;QAC7E,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,cAAc;YAC1B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,eAAe;YAC3B,UAAU,EAAE,EAAE,IAAI,EAAE;YACpB,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,MAAM,OAAO,GAAG,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEvD,KAAK,CAAC,kCAAkC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE9D,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;gBACP,SAAS;aACV,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AAhDD,wBAgDC;AAYD;;;;;;;;;;;GAWG;AACH,SAAsB,YAAY,CAChC,IAAY,EACZ,OAA6B;;QAE7B,MAAM,qBAAqB,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC;QAC5E,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,oBAAoB;YAChC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE,IAAI,EAAE;YACpB,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE7D,KAAK,CAAC,wCAAwC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEpE,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,MAAM;gBACN,SAAS;aACV,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AAhDD,oCAgDC;AAYD;;;;;;;;;;;;;;;aAea;AACb,SAAgB,SAAS;IACvB,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC7D,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,QAAQ;QACf,cAAc,EAAE,kBAAkB;KACnC,CAAC;IAEF,aAAa;IACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;IAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;QACzC,UAAU,EAAE,iBAAiB;QAC7B,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;QAC9B,UAAU,EAAE,kBAAkB;QAC9B,UAAU,EAAE,EAAE,IAAI,EAAE;QACpB,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1B,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,uDAAoB,CAAC;QAC1B,IAAI,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,MAAM,OAAO,GAAG,sBAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAE1D,OAAO,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,4CAAqC,CAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA9CD,8BA8CC;AA2DD;;;;;GAKG;AACH,SAAsB,SAAS,CAAC,KAAa;;QAC3C,MAAM,qBAAqB,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAChD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,iBAAiB;YAC7B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;YAC9B,UAAU,EAAE,kBAAkB;YAC9B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAE7C,MAAM,OAAO,GAAG,sBAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE1D,KAAK,CAAC,qCAAqC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEjE,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,OAAO;aACR,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AA5CD,8BA4CC"}
|
|
@@ -20,7 +20,12 @@ export interface Category {
|
|
|
20
20
|
description?: string | null;
|
|
21
21
|
/** Category title. */
|
|
22
22
|
title?: string;
|
|
23
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* __Deprecated.__ Use `coverImage` instead.
|
|
25
|
+
* This property will be removed on June 30, 2023.
|
|
26
|
+
*
|
|
27
|
+
* Category cover image or video.
|
|
28
|
+
*/
|
|
24
29
|
coverMedia?: CoverMedia;
|
|
25
30
|
/**
|
|
26
31
|
* Reserved for internal use.
|
|
@@ -28,19 +33,25 @@ export interface Category {
|
|
|
28
33
|
*/
|
|
29
34
|
oldRank?: number;
|
|
30
35
|
/**
|
|
36
|
+
* __Deprecated.__ Use `displayPosition` instead.
|
|
37
|
+
* This property will be removed on June 30, 2023.
|
|
38
|
+
*
|
|
31
39
|
* Category position in sequence.
|
|
32
|
-
* Reserved for internal use.
|
|
33
40
|
*/
|
|
34
41
|
rank?: number | null;
|
|
35
42
|
/**
|
|
36
|
-
* Category position in sequence. Categories with lower display position are displayed first. A position of `-1`
|
|
43
|
+
* Category position in sequence. Categories with a lower display position are displayed first. A position of `-1` appears at the end of the sequence.
|
|
37
44
|
*
|
|
38
45
|
* Default: `-1`
|
|
39
46
|
*/
|
|
40
47
|
displayPosition?: number | null;
|
|
41
48
|
/** ID of the category's translations. All translations of a single category will share the same `translationId`. */
|
|
42
49
|
translationId?: string | null;
|
|
43
|
-
/**
|
|
50
|
+
/**
|
|
51
|
+
* Category language.
|
|
52
|
+
*
|
|
53
|
+
* Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
54
|
+
*/
|
|
44
55
|
language?: string;
|
|
45
56
|
/** Category slug. For example, 'category-slug'. */
|
|
46
57
|
slug?: string;
|
|
@@ -158,9 +169,9 @@ export interface CreateCategoryRequest {
|
|
|
158
169
|
/** Category info. */
|
|
159
170
|
category: Category;
|
|
160
171
|
/**
|
|
161
|
-
* List of category fields to be included if entities are present
|
|
162
|
-
* Base fieldset
|
|
163
|
-
*
|
|
172
|
+
* List of category fields to be included in the response if the entities are present.
|
|
173
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
174
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
164
175
|
*/
|
|
165
176
|
fieldsets?: Field[];
|
|
166
177
|
}
|
|
@@ -186,9 +197,9 @@ export interface BulkCreateCategoriesRequest {
|
|
|
186
197
|
/** Whether to return the full created category entities in the response. */
|
|
187
198
|
returnFullEntity?: boolean;
|
|
188
199
|
/**
|
|
189
|
-
* List of category fields to be included if entities are present
|
|
190
|
-
* Base fieldset
|
|
191
|
-
*
|
|
200
|
+
* List of category fields to be included in the response if the entities are present.
|
|
201
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
202
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
192
203
|
*/
|
|
193
204
|
fieldsets?: Field[];
|
|
194
205
|
}
|
|
@@ -233,9 +244,9 @@ export interface UpdateCategoryRequest {
|
|
|
233
244
|
/** Field mask of fields to update. */
|
|
234
245
|
fieldMask?: string[];
|
|
235
246
|
/**
|
|
236
|
-
* List of category fields to be included if entities are present
|
|
237
|
-
* Base fieldset
|
|
238
|
-
*
|
|
247
|
+
* List of category fields to be included in the response if the entities are present.
|
|
248
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
249
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
239
250
|
*/
|
|
240
251
|
fieldsets?: Field[];
|
|
241
252
|
}
|
|
@@ -247,9 +258,9 @@ export interface GetCategoryRequest {
|
|
|
247
258
|
/** Category ID. */
|
|
248
259
|
categoryId: string;
|
|
249
260
|
/**
|
|
250
|
-
* List of category fields to be included if entities are present
|
|
251
|
-
* Base fieldset
|
|
252
|
-
*
|
|
261
|
+
* List of category fields to be included in the response if the entities are present.
|
|
262
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
263
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
253
264
|
*/
|
|
254
265
|
fieldsets?: Field[];
|
|
255
266
|
}
|
|
@@ -261,9 +272,9 @@ export interface GetCategoryBySlugRequest {
|
|
|
261
272
|
/** Slug of the category to retrieve. */
|
|
262
273
|
slug: string;
|
|
263
274
|
/**
|
|
264
|
-
* List of category fields to be included if entities are present
|
|
265
|
-
* Base fieldset
|
|
266
|
-
*
|
|
275
|
+
* List of category fields to be included in the response if the entities are present.
|
|
276
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
277
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
267
278
|
*/
|
|
268
279
|
fieldsets?: Field[];
|
|
269
280
|
}
|
|
@@ -275,9 +286,9 @@ export interface ListCategoriesRequest {
|
|
|
275
286
|
/** Pagination options. */
|
|
276
287
|
paging?: BlogPaging;
|
|
277
288
|
/**
|
|
278
|
-
* List of category fields to be included if entities are present
|
|
279
|
-
* Base fieldset
|
|
280
|
-
*
|
|
289
|
+
* List of category fields to be included in the response if the entities are present.
|
|
290
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
291
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
281
292
|
*/
|
|
282
293
|
fieldsets?: Field[];
|
|
283
294
|
}
|
|
@@ -311,23 +322,35 @@ export interface MetaData {
|
|
|
311
322
|
cursor?: string | null;
|
|
312
323
|
}
|
|
313
324
|
export interface QueryCategoriesRequest {
|
|
314
|
-
/** Pagination options. */
|
|
315
|
-
paging?: BlogPaging;
|
|
316
325
|
/**
|
|
317
|
-
*
|
|
318
|
-
*
|
|
326
|
+
* __Deprecated.__ Use `query` instead.
|
|
327
|
+
* This parameter will be removed on June 30, 2023.
|
|
328
|
+
*
|
|
329
|
+
* Pagination options.
|
|
319
330
|
*/
|
|
331
|
+
paging?: BlogPaging;
|
|
332
|
+
/** For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/wix-blog/blog/filter-and-sort). */
|
|
320
333
|
filter?: Record<string, any> | null;
|
|
321
|
-
/**
|
|
334
|
+
/**
|
|
335
|
+
* __Deprecated.__ Use `query` instead.
|
|
336
|
+
* This parameter will be removed on June 3, 2023.
|
|
337
|
+
*
|
|
338
|
+
* Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/wix-blog/blog/filter-and-sort).
|
|
339
|
+
*/
|
|
322
340
|
sort?: Sorting[];
|
|
323
|
-
/**
|
|
341
|
+
/**
|
|
342
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
343
|
+
* This parameter will be removed on June 30, 2023.
|
|
344
|
+
*
|
|
345
|
+
* List of category fields to be included in the response.
|
|
346
|
+
*/
|
|
324
347
|
fieldsToInclude?: Field[];
|
|
325
348
|
/** Query options. */
|
|
326
349
|
query?: PlatformQuery;
|
|
327
350
|
/**
|
|
328
|
-
* List of category fields to be included if entities are present
|
|
329
|
-
* Base fieldset
|
|
330
|
-
*
|
|
351
|
+
* List of category fields to be included in the response if the entities are present.
|
|
352
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
353
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
331
354
|
*/
|
|
332
355
|
fieldsets?: Field[];
|
|
333
356
|
}
|
|
@@ -389,7 +412,12 @@ export interface CursorPaging {
|
|
|
389
412
|
export interface QueryCategoriesResponse {
|
|
390
413
|
/** List of categories. */
|
|
391
414
|
categories?: Category[];
|
|
392
|
-
/**
|
|
415
|
+
/**
|
|
416
|
+
* __Deprecated.__ Use `pagingMetadata` instead.
|
|
417
|
+
* This property will be removed on June 30, 2023.
|
|
418
|
+
*
|
|
419
|
+
* Details on the paged set of results returned.
|
|
420
|
+
*/
|
|
393
421
|
metaData?: MetaData;
|
|
394
422
|
/** Details on the paged set of results returned. */
|
|
395
423
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blog-v3-category.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"blog-v3-category.types.js","sourceRoot":"","sources":["../../../src/blog-v3-category.types.ts"],"names":[],"mappings":"AA2LA,MAAM,CAAN,IAAY,KAWX;AAXD,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,6BAA6B;IAC7B,oBAAW,CAAA;IACX;;;OAGG;IACH,oCAA2B,CAAA;IAC3B,yBAAyB;IACzB,oBAAW,CAAA;AACb,CAAC,EAXW,KAAK,KAAL,KAAK,QAWhB;AAkMD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|
|
@@ -122,9 +122,9 @@ export interface CreateCategoryRequest {
|
|
|
122
122
|
/** Category info. */
|
|
123
123
|
category: Category;
|
|
124
124
|
/**
|
|
125
|
-
* List of category fields to be included if entities are present
|
|
126
|
-
* Base fieldset
|
|
127
|
-
*
|
|
125
|
+
* List of category fields to be included in the response if the entities are present.
|
|
126
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
127
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
128
128
|
*/
|
|
129
129
|
fieldsets?: Field[];
|
|
130
130
|
}
|
|
@@ -150,9 +150,9 @@ export interface BulkCreateCategoriesRequest {
|
|
|
150
150
|
/** Whether to return the full created category entities in the response. */
|
|
151
151
|
returnFullEntity?: boolean;
|
|
152
152
|
/**
|
|
153
|
-
* List of category fields to be included if entities are present
|
|
154
|
-
* Base fieldset
|
|
155
|
-
*
|
|
153
|
+
* List of category fields to be included in the response if the entities are present.
|
|
154
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
155
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
156
156
|
*/
|
|
157
157
|
fieldsets?: Field[];
|
|
158
158
|
}
|
|
@@ -197,9 +197,9 @@ export interface UpdateCategoryRequest {
|
|
|
197
197
|
/** Field mask of fields to update. */
|
|
198
198
|
fieldMask?: string[];
|
|
199
199
|
/**
|
|
200
|
-
* List of category fields to be included if entities are present
|
|
201
|
-
* Base fieldset
|
|
202
|
-
*
|
|
200
|
+
* List of category fields to be included in the response if the entities are present.
|
|
201
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
202
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
203
203
|
*/
|
|
204
204
|
fieldsets?: Field[];
|
|
205
205
|
}
|
|
@@ -211,9 +211,9 @@ export interface GetCategoryRequest {
|
|
|
211
211
|
/** Category ID. */
|
|
212
212
|
categoryId: string;
|
|
213
213
|
/**
|
|
214
|
-
* List of category fields to be included if entities are present
|
|
215
|
-
* Base fieldset
|
|
216
|
-
*
|
|
214
|
+
* List of category fields to be included in the response if the entities are present.
|
|
215
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
216
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
217
217
|
*/
|
|
218
218
|
fieldsets?: Field[];
|
|
219
219
|
}
|
|
@@ -225,9 +225,9 @@ export interface GetCategoryBySlugRequest {
|
|
|
225
225
|
/** Slug of the category to retrieve. */
|
|
226
226
|
slug: string;
|
|
227
227
|
/**
|
|
228
|
-
* List of category fields to be included if entities are present
|
|
229
|
-
* Base fieldset
|
|
230
|
-
*
|
|
228
|
+
* List of category fields to be included in the response if the entities are present.
|
|
229
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
230
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
231
231
|
*/
|
|
232
232
|
fieldsets?: Field[];
|
|
233
233
|
}
|
|
@@ -239,9 +239,9 @@ export interface ListCategoriesRequest {
|
|
|
239
239
|
/** Pagination options. */
|
|
240
240
|
paging?: BlogPaging;
|
|
241
241
|
/**
|
|
242
|
-
* List of category fields to be included if entities are present
|
|
243
|
-
* Base fieldset
|
|
244
|
-
*
|
|
242
|
+
* List of category fields to be included in the response if the entities are present.
|
|
243
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
244
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
245
245
|
*/
|
|
246
246
|
fieldsets?: Field[];
|
|
247
247
|
}
|
|
@@ -276,23 +276,35 @@ export interface MetaData {
|
|
|
276
276
|
cursor?: string | null;
|
|
277
277
|
}
|
|
278
278
|
export interface QueryCategoriesRequest {
|
|
279
|
-
/** Pagination options. */
|
|
280
|
-
paging?: BlogPaging;
|
|
281
279
|
/**
|
|
282
|
-
*
|
|
283
|
-
*
|
|
280
|
+
* __Deprecated.__ Use `query` instead.
|
|
281
|
+
* This parameter will be removed on June 30, 2023.
|
|
282
|
+
*
|
|
283
|
+
* Pagination options.
|
|
284
284
|
*/
|
|
285
|
+
paging?: BlogPaging;
|
|
286
|
+
/** For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/wix-blog/blog/filter-and-sort). */
|
|
285
287
|
filter?: Record<string, any> | null;
|
|
286
|
-
/**
|
|
288
|
+
/**
|
|
289
|
+
* __Deprecated.__ Use `query` instead.
|
|
290
|
+
* This parameter will be removed on June 3, 2023.
|
|
291
|
+
*
|
|
292
|
+
* Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/wix-blog/blog/filter-and-sort).
|
|
293
|
+
*/
|
|
287
294
|
sort?: Sorting[];
|
|
288
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* __Deprecated.__ Use `fieldsets` instead.
|
|
297
|
+
* This parameter will be removed on June 30, 2023.
|
|
298
|
+
*
|
|
299
|
+
* List of category fields to be included in the response.
|
|
300
|
+
*/
|
|
289
301
|
fieldsToInclude?: Field[];
|
|
290
302
|
/** Query options. */
|
|
291
303
|
query?: PlatformQuery;
|
|
292
304
|
/**
|
|
293
|
-
* List of category fields to be included if entities are present
|
|
294
|
-
* Base fieldset
|
|
295
|
-
*
|
|
305
|
+
* List of category fields to be included in the response if the entities are present.
|
|
306
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
307
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
296
308
|
*/
|
|
297
309
|
fieldsets?: Field[];
|
|
298
310
|
}
|
|
@@ -354,7 +366,12 @@ export interface CursorPaging {
|
|
|
354
366
|
export interface QueryCategoriesResponse {
|
|
355
367
|
/** List of categories. */
|
|
356
368
|
categories?: Category[];
|
|
357
|
-
/**
|
|
369
|
+
/**
|
|
370
|
+
* __Deprecated.__ Use `pagingMetadata` instead.
|
|
371
|
+
* This property will be removed on June 30, 2023.
|
|
372
|
+
*
|
|
373
|
+
* Details on the paged set of results returned.
|
|
374
|
+
*/
|
|
358
375
|
metaData?: MetaData;
|
|
359
376
|
/** Details on the paged set of results returned. */
|
|
360
377
|
pagingMetadata?: PagingMetadataV2;
|
|
@@ -393,9 +410,9 @@ export interface DeleteCategoryResponse {
|
|
|
393
410
|
export declare function createCategory(category: Category, options?: CreateCategoryOptions): Promise<CreateCategoryResponse>;
|
|
394
411
|
export interface CreateCategoryOptions {
|
|
395
412
|
/**
|
|
396
|
-
* List of category fields to be included if entities are present
|
|
397
|
-
* Base fieldset
|
|
398
|
-
*
|
|
413
|
+
* List of category fields to be included in the response if the entities are present.
|
|
414
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
415
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
399
416
|
*/
|
|
400
417
|
fieldsets?: Field[];
|
|
401
418
|
}
|
|
@@ -474,9 +491,9 @@ export interface UpdateCategoryOptions {
|
|
|
474
491
|
/** Field mask of fields to update. */
|
|
475
492
|
fieldMask?: string[];
|
|
476
493
|
/**
|
|
477
|
-
* List of category fields to be included if entities are present
|
|
478
|
-
* Base fieldset
|
|
479
|
-
*
|
|
494
|
+
* List of category fields to be included in the response if the entities are present.
|
|
495
|
+
* Base default fieldset returns all core category properties (all properties that are not a supported fieldset value).
|
|
496
|
+
* For example, when `URL` fieldset is selected, returned category will include the set of base properties and the category's preview url.
|
|
480
497
|
*/
|
|
481
498
|
fieldsets?: Field[];
|
|
482
499
|
}
|