@wix/auto_sdk_blog_categories 1.0.12 → 1.0.14

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.
Files changed (126) hide show
  1. package/build/{internal/cjs/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CZqdXr9y.d.mts} +81 -271
  2. package/build/{cjs/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CZqdXr9y.d.ts} +81 -271
  3. package/build/{cjs/src/blog-v3-category-categories.public.d.ts → index.d.mts} +36 -16
  4. package/build/{internal/cjs/src/blog-v3-category-categories.public.d.ts → index.d.ts} +36 -16
  5. package/build/index.js +938 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +902 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/blog-v3-category-categories.universal.d.ts → internal/blog-v3-category-categories.universal-CZqdXr9y.d.mts} +81 -271
  10. package/build/internal/{es/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CZqdXr9y.d.ts} +81 -271
  11. package/build/{es/src/blog-v3-category-categories.public.d.ts → internal/index.d.mts} +36 -16
  12. package/build/internal/{es/src/blog-v3-category-categories.public.d.ts → index.d.ts} +36 -16
  13. package/build/internal/index.js +938 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +902 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/{es/src/blog-v3-category-categories.types.d.ts → meta.d.mts} +65 -320
  18. package/build/{es/src/blog-v3-category-categories.types.d.ts → internal/meta.d.ts} +65 -320
  19. package/build/internal/meta.js +542 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +509 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{cjs/src/blog-v3-category-categories.types.d.ts → meta.d.mts} +65 -320
  24. package/build/{internal/cjs/src/blog-v3-category-categories.types.d.ts → meta.d.ts} +65 -320
  25. package/build/meta.js +542 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +509 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/blog-v3-category-categories.context.d.ts +0 -27
  40. package/build/cjs/src/blog-v3-category-categories.context.js +0 -33
  41. package/build/cjs/src/blog-v3-category-categories.context.js.map +0 -1
  42. package/build/cjs/src/blog-v3-category-categories.http.d.ts +0 -49
  43. package/build/cjs/src/blog-v3-category-categories.http.js +0 -408
  44. package/build/cjs/src/blog-v3-category-categories.http.js.map +0 -1
  45. package/build/cjs/src/blog-v3-category-categories.meta.d.ts +0 -27
  46. package/build/cjs/src/blog-v3-category-categories.meta.js +0 -161
  47. package/build/cjs/src/blog-v3-category-categories.meta.js.map +0 -1
  48. package/build/cjs/src/blog-v3-category-categories.public.js +0 -112
  49. package/build/cjs/src/blog-v3-category-categories.public.js.map +0 -1
  50. package/build/cjs/src/blog-v3-category-categories.types.js +0 -25
  51. package/build/cjs/src/blog-v3-category-categories.types.js.map +0 -1
  52. package/build/cjs/src/blog-v3-category-categories.universal.js +0 -499
  53. package/build/cjs/src/blog-v3-category-categories.universal.js.map +0 -1
  54. package/build/es/index.d.ts +0 -1
  55. package/build/es/index.js +0 -2
  56. package/build/es/index.js.map +0 -1
  57. package/build/es/index.typings.d.ts +0 -1
  58. package/build/es/index.typings.js +0 -2
  59. package/build/es/index.typings.js.map +0 -1
  60. package/build/es/meta.d.ts +0 -1
  61. package/build/es/meta.js +0 -2
  62. package/build/es/meta.js.map +0 -1
  63. package/build/es/package.json +0 -3
  64. package/build/es/src/blog-v3-category-categories.context.d.ts +0 -27
  65. package/build/es/src/blog-v3-category-categories.context.js +0 -27
  66. package/build/es/src/blog-v3-category-categories.context.js.map +0 -1
  67. package/build/es/src/blog-v3-category-categories.http.d.ts +0 -49
  68. package/build/es/src/blog-v3-category-categories.http.js +0 -398
  69. package/build/es/src/blog-v3-category-categories.http.js.map +0 -1
  70. package/build/es/src/blog-v3-category-categories.meta.d.ts +0 -27
  71. package/build/es/src/blog-v3-category-categories.meta.js +0 -128
  72. package/build/es/src/blog-v3-category-categories.meta.js.map +0 -1
  73. package/build/es/src/blog-v3-category-categories.public.js +0 -99
  74. package/build/es/src/blog-v3-category-categories.public.js.map +0 -1
  75. package/build/es/src/blog-v3-category-categories.types.js +0 -22
  76. package/build/es/src/blog-v3-category-categories.types.js.map +0 -1
  77. package/build/es/src/blog-v3-category-categories.universal.js +0 -466
  78. package/build/es/src/blog-v3-category-categories.universal.js.map +0 -1
  79. package/build/internal/cjs/index.d.ts +0 -1
  80. package/build/internal/cjs/index.js +0 -18
  81. package/build/internal/cjs/index.js.map +0 -1
  82. package/build/internal/cjs/index.typings.d.ts +0 -1
  83. package/build/internal/cjs/index.typings.js +0 -18
  84. package/build/internal/cjs/index.typings.js.map +0 -1
  85. package/build/internal/cjs/meta.d.ts +0 -1
  86. package/build/internal/cjs/meta.js +0 -18
  87. package/build/internal/cjs/meta.js.map +0 -1
  88. package/build/internal/cjs/src/blog-v3-category-categories.context.d.ts +0 -27
  89. package/build/internal/cjs/src/blog-v3-category-categories.context.js +0 -33
  90. package/build/internal/cjs/src/blog-v3-category-categories.context.js.map +0 -1
  91. package/build/internal/cjs/src/blog-v3-category-categories.http.d.ts +0 -49
  92. package/build/internal/cjs/src/blog-v3-category-categories.http.js +0 -408
  93. package/build/internal/cjs/src/blog-v3-category-categories.http.js.map +0 -1
  94. package/build/internal/cjs/src/blog-v3-category-categories.meta.d.ts +0 -27
  95. package/build/internal/cjs/src/blog-v3-category-categories.meta.js +0 -161
  96. package/build/internal/cjs/src/blog-v3-category-categories.meta.js.map +0 -1
  97. package/build/internal/cjs/src/blog-v3-category-categories.public.js +0 -112
  98. package/build/internal/cjs/src/blog-v3-category-categories.public.js.map +0 -1
  99. package/build/internal/cjs/src/blog-v3-category-categories.types.js +0 -25
  100. package/build/internal/cjs/src/blog-v3-category-categories.types.js.map +0 -1
  101. package/build/internal/cjs/src/blog-v3-category-categories.universal.js +0 -499
  102. package/build/internal/cjs/src/blog-v3-category-categories.universal.js.map +0 -1
  103. package/build/internal/es/index.d.ts +0 -1
  104. package/build/internal/es/index.js +0 -2
  105. package/build/internal/es/index.js.map +0 -1
  106. package/build/internal/es/index.typings.d.ts +0 -1
  107. package/build/internal/es/index.typings.js +0 -2
  108. package/build/internal/es/index.typings.js.map +0 -1
  109. package/build/internal/es/meta.d.ts +0 -1
  110. package/build/internal/es/meta.js +0 -2
  111. package/build/internal/es/meta.js.map +0 -1
  112. package/build/internal/es/src/blog-v3-category-categories.context.d.ts +0 -27
  113. package/build/internal/es/src/blog-v3-category-categories.context.js +0 -27
  114. package/build/internal/es/src/blog-v3-category-categories.context.js.map +0 -1
  115. package/build/internal/es/src/blog-v3-category-categories.http.d.ts +0 -49
  116. package/build/internal/es/src/blog-v3-category-categories.http.js +0 -398
  117. package/build/internal/es/src/blog-v3-category-categories.http.js.map +0 -1
  118. package/build/internal/es/src/blog-v3-category-categories.meta.d.ts +0 -27
  119. package/build/internal/es/src/blog-v3-category-categories.meta.js +0 -128
  120. package/build/internal/es/src/blog-v3-category-categories.meta.js.map +0 -1
  121. package/build/internal/es/src/blog-v3-category-categories.public.js +0 -99
  122. package/build/internal/es/src/blog-v3-category-categories.public.js.map +0 -1
  123. package/build/internal/es/src/blog-v3-category-categories.types.js +0 -22
  124. package/build/internal/es/src/blog-v3-category-categories.types.js.map +0 -1
  125. package/build/internal/es/src/blog-v3-category-categories.universal.js +0 -466
  126. package/build/internal/es/src/blog-v3-category-categories.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface Category {
1
+ interface Category {
3
2
  /**
4
3
  * Category ID.
5
4
  * @immutable
@@ -72,13 +71,13 @@ export interface Category {
72
71
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
73
72
  * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
74
73
  */
75
- export interface SeoSchema {
74
+ interface SeoSchema {
76
75
  /** SEO tag information. */
77
76
  tags?: Tag[];
78
77
  /** SEO general settings. */
79
78
  settings?: Settings;
80
79
  }
81
- export interface Keyword {
80
+ interface Keyword {
82
81
  /** Keyword value. */
83
82
  term?: string;
84
83
  /** Whether the keyword is the main focus keyword. */
@@ -89,7 +88,7 @@ export interface Keyword {
89
88
  */
90
89
  origin?: string | null;
91
90
  }
92
- export interface Tag {
91
+ interface Tag {
93
92
  /**
94
93
  * SEO tag type.
95
94
  *
@@ -111,7 +110,7 @@ export interface Tag {
111
110
  /** Whether the tag is disabled. */
112
111
  disabled?: boolean;
113
112
  }
114
- export interface Settings {
113
+ interface Settings {
115
114
  /**
116
115
  * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
117
116
  *
@@ -125,7 +124,7 @@ export interface Settings {
125
124
  */
126
125
  keywords?: Keyword[];
127
126
  }
128
- export interface FocalPoint {
127
+ interface FocalPoint {
129
128
  /** X-coordinate of the focal point. */
130
129
  x?: number;
131
130
  /** Y-coordinate of the focal point. */
@@ -135,7 +134,7 @@ export interface FocalPoint {
135
134
  /** crop by width */
136
135
  width?: number | null;
137
136
  }
138
- export interface CategoryTranslation {
137
+ interface CategoryTranslation {
139
138
  /**
140
139
  * Category ID.
141
140
  * @format GUID
@@ -154,11 +153,11 @@ export interface CategoryTranslation {
154
153
  /** URL of this category page. */
155
154
  url?: string;
156
155
  }
157
- export interface InitialCategoriesCopied {
156
+ interface InitialCategoriesCopied {
158
157
  /** Number of categories copied. */
159
158
  count?: number;
160
159
  }
161
- export interface CreateCategoryRequest {
160
+ interface CreateCategoryRequest {
162
161
  /** Category info. */
163
162
  category: Category;
164
163
  /**
@@ -171,7 +170,7 @@ export interface CreateCategoryRequest {
171
170
  */
172
171
  fieldsets?: FieldWithLiterals[];
173
172
  }
174
- export declare enum Field {
173
+ declare enum Field {
175
174
  UNKNOWN = "UNKNOWN",
176
175
  /** Includes category URL. */
177
176
  URL = "URL",
@@ -179,12 +178,12 @@ export declare enum Field {
179
178
  SEO = "SEO"
180
179
  }
181
180
  /** @enumType */
182
- export type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'SEO';
183
- export interface CreateCategoryResponse {
181
+ type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'SEO';
182
+ interface CreateCategoryResponse {
184
183
  /** Category info. */
185
184
  category?: Category;
186
185
  }
187
- export interface BulkCreateCategoriesRequest {
186
+ interface BulkCreateCategoriesRequest {
188
187
  /**
189
188
  * Categories to create.
190
189
  * @minSize 1
@@ -203,19 +202,19 @@ export interface BulkCreateCategoriesRequest {
203
202
  */
204
203
  fieldsets?: FieldWithLiterals[];
205
204
  }
206
- export interface BulkCreateCategoriesResponse {
205
+ interface BulkCreateCategoriesResponse {
207
206
  /** Categories created by bulk action. */
208
207
  results?: BulkCategoryResult[];
209
208
  /** Bulk action metadata. */
210
209
  bulkActionMetadata?: BulkActionMetadata;
211
210
  }
212
- export interface BulkCategoryResult {
211
+ interface BulkCategoryResult {
213
212
  /** Bulk actions metadata for category. */
214
213
  itemMetadata?: ItemMetadata;
215
214
  /** Optional created category. */
216
215
  item?: Category;
217
216
  }
218
- export interface ItemMetadata {
217
+ interface ItemMetadata {
219
218
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
220
219
  _id?: string | null;
221
220
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -225,7 +224,7 @@ export interface ItemMetadata {
225
224
  /** Details about the error in case of failure. */
226
225
  error?: ApplicationError;
227
226
  }
228
- export interface ApplicationError {
227
+ interface ApplicationError {
229
228
  /** Error code. */
230
229
  code?: string;
231
230
  /** Description of the error. */
@@ -233,7 +232,7 @@ export interface ApplicationError {
233
232
  /** Data related to the error. */
234
233
  data?: Record<string, any> | null;
235
234
  }
236
- export interface BulkActionMetadata {
235
+ interface BulkActionMetadata {
237
236
  /** Number of items that were successfully processed. */
238
237
  totalSuccesses?: number;
239
238
  /** Number of items that couldn't be processed. */
@@ -241,7 +240,7 @@ export interface BulkActionMetadata {
241
240
  /** Number of failures without details because detailed failure threshold was exceeded. */
242
241
  undetailedFailures?: number;
243
242
  }
244
- export interface BulkUpdateCategoriesRequest {
243
+ interface BulkUpdateCategoriesRequest {
245
244
  /**
246
245
  * Categories to update.
247
246
  * @minSize 1
@@ -260,19 +259,19 @@ export interface BulkUpdateCategoriesRequest {
260
259
  */
261
260
  fieldsets?: FieldWithLiterals[];
262
261
  }
263
- export interface MaskedCategory {
262
+ interface MaskedCategory {
264
263
  /** Category */
265
264
  category?: Category;
266
265
  /** Field mask of fields to update. */
267
266
  fieldMask?: string[];
268
267
  }
269
- export interface BulkUpdateCategoriesResponse {
268
+ interface BulkUpdateCategoriesResponse {
270
269
  /** Categories updated by bulk action. */
271
270
  results?: BulkCategoryResult[];
272
271
  /** Bulk action metadata. */
273
272
  bulkActionMetadata?: BulkActionMetadata;
274
273
  }
275
- export interface UpdateCategoryRequest {
274
+ interface UpdateCategoryRequest {
276
275
  /** Category info. */
277
276
  category: Category;
278
277
  /**
@@ -285,17 +284,17 @@ export interface UpdateCategoryRequest {
285
284
  */
286
285
  fieldsets?: FieldWithLiterals[];
287
286
  }
288
- export interface UpdateCategoryResponse {
287
+ interface UpdateCategoryResponse {
289
288
  /** Category info. */
290
289
  category?: Category;
291
290
  }
292
- export interface GetCategoriesCountByLanguageRequest {
291
+ interface GetCategoriesCountByLanguageRequest {
293
292
  }
294
- export interface GetCategoriesCountByLanguageResponse {
293
+ interface GetCategoriesCountByLanguageResponse {
295
294
  /** The language and it's count. */
296
295
  categoriesLanguageCount?: CategoryLanguageCount[];
297
296
  }
298
- export interface CategoryLanguageCount {
297
+ interface CategoryLanguageCount {
299
298
  /**
300
299
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
301
300
  * @format LANGUAGE_TAG
@@ -304,7 +303,7 @@ export interface CategoryLanguageCount {
304
303
  /** The count of Categories for the language. */
305
304
  categoryCount?: number | null;
306
305
  }
307
- export interface GetCategoryRequest {
306
+ interface GetCategoryRequest {
308
307
  /**
309
308
  * Category ID.
310
309
  * @minLength 1
@@ -321,11 +320,11 @@ export interface GetCategoryRequest {
321
320
  */
322
321
  fieldsets?: FieldWithLiterals[];
323
322
  }
324
- export interface GetCategoryResponse {
323
+ interface GetCategoryResponse {
325
324
  /** Category info. */
326
325
  category?: Category;
327
326
  }
328
- export interface GetCategoryBySlugRequest {
327
+ interface GetCategoryBySlugRequest {
329
328
  /**
330
329
  * Slug of the category to retrieve.
331
330
  * @minLength 1
@@ -348,11 +347,11 @@ export interface GetCategoryBySlugRequest {
348
347
  */
349
348
  language?: string | null;
350
349
  }
351
- export interface GetCategoryBySlugResponse {
350
+ interface GetCategoryBySlugResponse {
352
351
  /** Category info. */
353
352
  category?: Category;
354
353
  }
355
- export interface ListCategoriesRequest {
354
+ interface ListCategoriesRequest {
356
355
  /** Pagination options. */
357
356
  paging?: BlogPaging;
358
357
  /**
@@ -374,7 +373,7 @@ export interface ListCategoriesRequest {
374
373
  */
375
374
  language?: string | null;
376
375
  }
377
- export interface BlogPaging {
376
+ interface BlogPaging {
378
377
  /**
379
378
  * Number of items to skip in the current sort order.
380
379
  *
@@ -398,13 +397,13 @@ export interface BlogPaging {
398
397
  */
399
398
  cursor?: string | null;
400
399
  }
401
- export interface ListCategoriesResponse {
400
+ interface ListCategoriesResponse {
402
401
  /** List of categories. */
403
402
  categories?: Category[];
404
403
  /** Details on the paged set of results returned. */
405
404
  metaData?: MetaData;
406
405
  }
407
- export interface MetaData {
406
+ interface MetaData {
408
407
  /** Number of items returned in this response. */
409
408
  count?: number;
410
409
  /** Requested offset. */
@@ -417,7 +416,7 @@ export interface MetaData {
417
416
  */
418
417
  cursor?: string | null;
419
418
  }
420
- export interface QueryCategoriesRequest {
419
+ interface QueryCategoriesRequest {
421
420
  /** Query options. */
422
421
  query?: PlatformQuery;
423
422
  /**
@@ -430,7 +429,7 @@ export interface QueryCategoriesRequest {
430
429
  */
431
430
  fieldsets?: FieldWithLiterals[];
432
431
  }
433
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
432
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
434
433
  /** Paging options to limit and skip the number of items. */
435
434
  paging?: Paging;
436
435
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -452,13 +451,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
452
451
  sort?: Sorting[];
453
452
  }
454
453
  /** @oneof */
455
- export interface PlatformQueryPagingMethodOneOf {
454
+ interface PlatformQueryPagingMethodOneOf {
456
455
  /** Paging options to limit and skip the number of items. */
457
456
  paging?: Paging;
458
457
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
459
458
  cursorPaging?: CursorPaging;
460
459
  }
461
- export interface Sorting {
460
+ interface Sorting {
462
461
  /**
463
462
  * Name of the field to sort by.
464
463
  * @maxLength 512
@@ -467,13 +466,13 @@ export interface Sorting {
467
466
  /** Sort order. */
468
467
  order?: SortOrderWithLiterals;
469
468
  }
470
- export declare enum SortOrder {
469
+ declare enum SortOrder {
471
470
  ASC = "ASC",
472
471
  DESC = "DESC"
473
472
  }
474
473
  /** @enumType */
475
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
476
- export interface Paging {
474
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
475
+ interface Paging {
477
476
  /**
478
477
  * Number of items to load.
479
478
  * @max 100
@@ -482,7 +481,7 @@ export interface Paging {
482
481
  /** Number of items to skip in the current sort order. */
483
482
  offset?: number | null;
484
483
  }
485
- export interface CursorPaging {
484
+ interface CursorPaging {
486
485
  /**
487
486
  * Number of items to load.
488
487
  * @max 100
@@ -498,13 +497,13 @@ export interface CursorPaging {
498
497
  */
499
498
  cursor?: string | null;
500
499
  }
501
- export interface QueryCategoriesResponse {
500
+ interface QueryCategoriesResponse {
502
501
  /** List of categories. */
503
502
  categories?: Category[];
504
503
  /** Details on the paged set of results returned. */
505
504
  pagingMetadata?: PagingMetadataV2;
506
505
  }
507
- export interface PagingMetadataV2 {
506
+ interface PagingMetadataV2 {
508
507
  /** Number of items returned in the response. */
509
508
  count?: number | null;
510
509
  /** Offset that was requested. */
@@ -516,7 +515,7 @@ export interface PagingMetadataV2 {
516
515
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
517
516
  cursors?: Cursors;
518
517
  }
519
- export interface Cursors {
518
+ interface Cursors {
520
519
  /**
521
520
  * Cursor pointing to next page in the list of results.
522
521
  * @maxLength 2000
@@ -528,7 +527,7 @@ export interface Cursors {
528
527
  */
529
528
  prev?: string | null;
530
529
  }
531
- export interface BulkDeleteCategoryRequest {
530
+ interface BulkDeleteCategoryRequest {
532
531
  /**
533
532
  * Category IDs.
534
533
  * @minSize 1
@@ -539,9 +538,9 @@ export interface BulkDeleteCategoryRequest {
539
538
  /** Should delete bypassing the trash-bin. */
540
539
  permanent?: boolean;
541
540
  }
542
- export interface BulkDeleteCategoryResponse {
541
+ interface BulkDeleteCategoryResponse {
543
542
  }
544
- export interface DeleteCategoryRequest {
543
+ interface DeleteCategoryRequest {
545
544
  /**
546
545
  * Category ID.
547
546
  * @minLength 1
@@ -549,9 +548,9 @@ export interface DeleteCategoryRequest {
549
548
  */
550
549
  categoryId: string;
551
550
  }
552
- export interface DeleteCategoryResponse {
551
+ interface DeleteCategoryResponse {
553
552
  }
554
- export interface DomainEvent extends DomainEventBodyOneOf {
553
+ interface DomainEvent extends DomainEventBodyOneOf {
555
554
  createdEvent?: EntityCreatedEvent;
556
555
  updatedEvent?: EntityUpdatedEvent;
557
556
  deletedEvent?: EntityDeletedEvent;
@@ -586,19 +585,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
586
585
  entityEventSequence?: string | null;
587
586
  }
588
587
  /** @oneof */
589
- export interface DomainEventBodyOneOf {
588
+ interface DomainEventBodyOneOf {
590
589
  createdEvent?: EntityCreatedEvent;
591
590
  updatedEvent?: EntityUpdatedEvent;
592
591
  deletedEvent?: EntityDeletedEvent;
593
592
  actionEvent?: ActionEvent;
594
593
  }
595
- export interface EntityCreatedEvent {
594
+ interface EntityCreatedEvent {
596
595
  entity?: string;
597
596
  }
598
- export interface RestoreInfo {
597
+ interface RestoreInfo {
599
598
  deletedDate?: Date | null;
600
599
  }
601
- export interface EntityUpdatedEvent {
600
+ interface EntityUpdatedEvent {
602
601
  /**
603
602
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
604
603
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -606,14 +605,14 @@ export interface EntityUpdatedEvent {
606
605
  */
607
606
  currentEntity?: string;
608
607
  }
609
- export interface EntityDeletedEvent {
608
+ interface EntityDeletedEvent {
610
609
  /** Entity that was deleted. */
611
610
  deletedEntity?: string | null;
612
611
  }
613
- export interface ActionEvent {
612
+ interface ActionEvent {
614
613
  body?: string;
615
614
  }
616
- export interface MessageEnvelope {
615
+ interface MessageEnvelope {
617
616
  /**
618
617
  * App instance ID.
619
618
  * @format GUID
@@ -629,7 +628,7 @@ export interface MessageEnvelope {
629
628
  /** Stringify payload. */
630
629
  data?: string;
631
630
  }
632
- export interface IdentificationData extends IdentificationDataIdOneOf {
631
+ interface IdentificationData extends IdentificationDataIdOneOf {
633
632
  /**
634
633
  * ID of a site visitor that has not logged in to the site.
635
634
  * @format GUID
@@ -654,7 +653,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
654
653
  identityType?: WebhookIdentityTypeWithLiterals;
655
654
  }
656
655
  /** @oneof */
657
- export interface IdentificationDataIdOneOf {
656
+ interface IdentificationDataIdOneOf {
658
657
  /**
659
658
  * ID of a site visitor that has not logged in to the site.
660
659
  * @format GUID
@@ -676,7 +675,7 @@ export interface IdentificationDataIdOneOf {
676
675
  */
677
676
  appId?: string;
678
677
  }
679
- export declare enum WebhookIdentityType {
678
+ declare enum WebhookIdentityType {
680
679
  UNKNOWN = "UNKNOWN",
681
680
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
682
681
  MEMBER = "MEMBER",
@@ -684,8 +683,8 @@ export declare enum WebhookIdentityType {
684
683
  APP = "APP"
685
684
  }
686
685
  /** @enumType */
687
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
688
- export interface BaseEventMetadata {
686
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
687
+ interface BaseEventMetadata {
689
688
  /**
690
689
  * App instance ID.
691
690
  * @format GUID
@@ -699,7 +698,7 @@ export interface BaseEventMetadata {
699
698
  /** The identification type and identity data. */
700
699
  identity?: IdentificationData;
701
700
  }
702
- export interface EventMetadata extends BaseEventMetadata {
701
+ interface EventMetadata extends BaseEventMetadata {
703
702
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
704
703
  _id?: string;
705
704
  /**
@@ -729,78 +728,18 @@ export interface EventMetadata extends BaseEventMetadata {
729
728
  */
730
729
  entityEventSequence?: string | null;
731
730
  }
732
- export interface CategoryCreatedEnvelope {
731
+ interface CategoryCreatedEnvelope {
733
732
  entity: Category;
734
733
  metadata: EventMetadata;
735
734
  }
736
- /**
737
- * Triggered when a category is created.
738
- * @permissionScope Read Blog
739
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
740
- * @permissionScope Manage Blog
741
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
742
- * @permissionScope Read Draft Blog Posts
743
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
744
- * @permissionId BLOG.READ-CATEGORY
745
- * @webhook
746
- * @eventType wix.blog.v3.category_created
747
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
748
- * @slug created
749
- */
750
- export declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
751
- export interface CategoryDeletedEnvelope {
735
+ interface CategoryDeletedEnvelope {
752
736
  metadata: EventMetadata;
753
737
  }
754
- /**
755
- * Triggered when a category is deleted.
756
- * @permissionScope Read Blog
757
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
758
- * @permissionScope Manage Blog
759
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
760
- * @permissionScope Read Draft Blog Posts
761
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
762
- * @permissionId BLOG.READ-CATEGORY
763
- * @webhook
764
- * @eventType wix.blog.v3.category_deleted
765
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
766
- * @slug deleted
767
- */
768
- export declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
769
- export interface CategoryUpdatedEnvelope {
738
+ interface CategoryUpdatedEnvelope {
770
739
  entity: Category;
771
740
  metadata: EventMetadata;
772
741
  }
773
- /**
774
- * Triggered when a category is updated.
775
- * @permissionScope Read Blog
776
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
777
- * @permissionScope Manage Blog
778
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
779
- * @permissionScope Read Draft Blog Posts
780
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
781
- * @permissionId BLOG.READ-CATEGORY
782
- * @webhook
783
- * @eventType wix.blog.v3.category_updated
784
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
785
- * @slug updated
786
- */
787
- export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
788
- type CategoryNonNullablePaths = `_id` | `label` | `postCount` | `title` | `slug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
789
- /**
790
- * Creates a category.
791
- * @param category - Category info.
792
- * @public
793
- * @requiredField category
794
- * @requiredField category.label
795
- * @permissionId BLOG.CREATE-CATEGORY
796
- * @permissionScope Manage Blog
797
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
798
- * @applicableIdentity APP
799
- * @returns Category info.
800
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory
801
- */
802
- export declare function createCategory(category: NonNullablePaths<Category, `label`>, options?: CreateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
803
- export interface CreateCategoryOptions {
742
+ interface CreateCategoryOptions {
804
743
  /**
805
744
  * List of additional category fields to include in the response. By default
806
745
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -811,21 +750,7 @@ export interface CreateCategoryOptions {
811
750
  */
812
751
  fieldsets?: FieldWithLiterals[];
813
752
  }
814
- /**
815
- * Updates a category.
816
- * @param _id - Category ID.
817
- * @public
818
- * @requiredField _id
819
- * @requiredField category
820
- * @permissionId BLOG.EDIT-CATEGORY
821
- * @permissionScope Manage Blog
822
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
823
- * @applicableIdentity APP
824
- * @returns Category info.
825
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory
826
- */
827
- export declare function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise<NonNullablePaths<Category, CategoryNonNullablePaths>>;
828
- export interface UpdateCategory {
753
+ interface UpdateCategory {
829
754
  /**
830
755
  * Category ID.
831
756
  * @immutable
@@ -893,7 +818,7 @@ export interface UpdateCategory {
893
818
  */
894
819
  _updatedDate?: Date | null;
895
820
  }
896
- export interface UpdateCategoryOptions {
821
+ interface UpdateCategoryOptions {
897
822
  /**
898
823
  * List of additional category fields to include in the response. By default
899
824
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -904,27 +829,7 @@ export interface UpdateCategoryOptions {
904
829
  */
905
830
  fieldsets?: FieldWithLiterals[];
906
831
  }
907
- /**
908
- * Gets a category with the specified ID.
909
- * @param categoryId - Category ID.
910
- * @public
911
- * @requiredField categoryId
912
- * @param options - Options specifying which fields to return.
913
- * @permissionId BLOG.READ-CATEGORY
914
- * @permissionScope Read Blog
915
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
916
- * @permissionScope Manage Blog
917
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
918
- * @permissionScope Read Draft Blog Posts
919
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
920
- * @applicableIdentity APP
921
- * @applicableIdentity VISITOR
922
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory
923
- */
924
- export declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<NonNullablePaths<GetCategoryResponse, {
925
- [P in CategoryNonNullablePaths]: `category.${P}`;
926
- }[CategoryNonNullablePaths]>>;
927
- export interface GetCategoryOptions {
832
+ interface GetCategoryOptions {
928
833
  /**
929
834
  * List of additional category fields to include in the response. By default
930
835
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -935,33 +840,7 @@ export interface GetCategoryOptions {
935
840
  */
936
841
  fieldsets?: FieldWithLiterals[];
937
842
  }
938
- /**
939
- * Gets a category with the specified slug.
940
- *
941
- * The slug is at the end of the URL of a specific category.
942
- * For example, if a category's URL is `https://example.com/blog/categories/famous-cats`, the slug is `famous-cats`.
943
- * The slug is a case-sensitive string that is derived from the category's label, unless specified otherwise.
944
- * @public
945
- * @requiredField slug
946
- * @param slug - Slug of the category to retrieve.
947
- *
948
- * The end of a category's URL. For example, `'https:/example.com/blog/category/{my-category-slug}'`. Case sensitive and generally based on the category `label` if not specified.
949
- * @param options - Options specifying which fields to return.
950
- * @permissionId BLOG.READ-CATEGORY
951
- * @permissionScope Read Blog
952
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
953
- * @permissionScope Manage Blog
954
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
955
- * @permissionScope Read Draft Blog Posts
956
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
957
- * @applicableIdentity APP
958
- * @applicableIdentity VISITOR
959
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug
960
- */
961
- export declare function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise<NonNullablePaths<GetCategoryBySlugResponse, {
962
- [P in CategoryNonNullablePaths]: `category.${P}`;
963
- }[CategoryNonNullablePaths]>>;
964
- export interface GetCategoryBySlugOptions {
843
+ interface GetCategoryBySlugOptions {
965
844
  /**
966
845
  * List of additional category fields to include in the response. By default
967
846
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -978,36 +857,7 @@ export interface GetCategoryBySlugOptions {
978
857
  */
979
858
  language?: string | null;
980
859
  }
981
- /**
982
- * Retrieves a list of up to 100 categories per request.
983
- *
984
- * If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.
985
- *
986
- * The categoies are displayed in order of their `displayPosition`, starting with `0`. The `displayPosition` is the position in which the categories
987
- * are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu page with a `displayPosition` of `-1`.
988
- *
989
- * List Categories runs with these defaults, which you can override:
990
- * - `paging.limit` is `50`.
991
- * - `paging.offset` is `0`.
992
- *
993
- * List Categories is sorted by `displayPosition` in descending order. This cannot be overridden.
994
- * @public
995
- * @param options - Filter and paging options.
996
- * @permissionId BLOG.READ-CATEGORY
997
- * @permissionScope Read Blog
998
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
999
- * @permissionScope Manage Blog
1000
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1001
- * @permissionScope Read Draft Blog Posts
1002
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
1003
- * @applicableIdentity APP
1004
- * @applicableIdentity VISITOR
1005
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories
1006
- */
1007
- export declare function listCategories(options?: ListCategoriesOptions): Promise<NonNullablePaths<ListCategoriesResponse, {
1008
- [P in CategoryNonNullablePaths]: `categories.${number}.${P}`;
1009
- }[CategoryNonNullablePaths] | `metaData.count` | `metaData.offset` | `metaData.total`>>;
1010
- export interface ListCategoriesOptions {
860
+ interface ListCategoriesOptions {
1011
861
  /** Pagination options. */
1012
862
  paging?: BlogPaging;
1013
863
  /**
@@ -1029,36 +879,7 @@ export interface ListCategoriesOptions {
1029
879
  */
1030
880
  language?: string | null;
1031
881
  }
1032
- /**
1033
- * Creates a query to retrieve a list of categories.
1034
- *
1035
- *
1036
- * The Query Categories method builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending) object.
1037
- *
1038
- * The response contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/find) method.
1039
- *
1040
- * You can refine the query by chaining `CategoriesQueryBuilder` methods to the query. `CategoriesQueryBuilder` methods enable you to sort, filter, and control the results that Query Categories returns. Any methods chained to the Query Categories method are applied in the order that they are called.
1041
- *
1042
- * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.
1043
- * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)
1044
- * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)
1045
- *
1046
- * The following `CategoriesQueryBuilder` methods are supported for Query Categories. For a full description of the `Categories` object, see the response for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-result/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).
1047
- * @public
1048
- * @param options - Options specifying which fields to return.
1049
- * @permissionScope Read Blog
1050
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
1051
- * @permissionScope Manage Blog
1052
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1053
- * @permissionScope Read Draft Blog Posts
1054
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
1055
- * @permissionId BLOG.READ-CATEGORY
1056
- * @applicableIdentity APP
1057
- * @applicableIdentity VISITOR
1058
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories
1059
- */
1060
- export declare function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;
1061
- export interface QueryCategoriesOptions {
882
+ interface QueryCategoriesOptions {
1062
883
  /**
1063
884
 
1064
885
  * @maxSize 10
@@ -1074,13 +895,13 @@ interface QueryOffsetResult {
1074
895
  length: number;
1075
896
  pageSize: number;
1076
897
  }
1077
- export interface CategoriesQueryResult extends QueryOffsetResult {
898
+ interface CategoriesQueryResult extends QueryOffsetResult {
1078
899
  items: Category[];
1079
900
  query: CategoriesQueryBuilder;
1080
901
  next: () => Promise<CategoriesQueryResult>;
1081
902
  prev: () => Promise<CategoriesQueryResult>;
1082
903
  }
1083
- export interface CategoriesQueryBuilder {
904
+ interface CategoriesQueryBuilder {
1084
905
  /** @param propertyName - Property whose value is compared with `value`.
1085
906
  * @param value - Value to compare against.
1086
907
  */
@@ -1092,19 +913,19 @@ export interface CategoriesQueryBuilder {
1092
913
  /** @param propertyName - Property whose value is compared with `value`.
1093
914
  * @param value - Value to compare against.
1094
915
  */
1095
- ge: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;
916
+ ge: (propertyName: 'label' | 'postCount' | 'title' | 'displayPosition', value: any) => CategoriesQueryBuilder;
1096
917
  /** @param propertyName - Property whose value is compared with `value`.
1097
918
  * @param value - Value to compare against.
1098
919
  */
1099
- gt: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;
920
+ gt: (propertyName: 'label' | 'postCount' | 'title' | 'displayPosition', value: any) => CategoriesQueryBuilder;
1100
921
  /** @param propertyName - Property whose value is compared with `value`.
1101
922
  * @param value - Value to compare against.
1102
923
  */
1103
- le: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;
924
+ le: (propertyName: 'label' | 'postCount' | 'title' | 'displayPosition', value: any) => CategoriesQueryBuilder;
1104
925
  /** @param propertyName - Property whose value is compared with `value`.
1105
926
  * @param value - Value to compare against.
1106
927
  */
1107
- lt: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;
928
+ lt: (propertyName: 'label' | 'postCount' | 'title' | 'displayPosition', value: any) => CategoriesQueryBuilder;
1108
929
  /** @param propertyName - Property whose value is compared with `string`.
1109
930
  * @param string - String to compare against. Case-insensitive.
1110
931
  */
@@ -1121,16 +942,5 @@ export interface CategoriesQueryBuilder {
1121
942
  skip: (skip: number) => CategoriesQueryBuilder;
1122
943
  find: () => Promise<CategoriesQueryResult>;
1123
944
  }
1124
- /**
1125
- * Deletes a category.
1126
- * @param categoryId - Category ID.
1127
- * @public
1128
- * @requiredField categoryId
1129
- * @permissionId BLOG.DELETE-CATEGORY
1130
- * @permissionScope Manage Blog
1131
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1132
- * @applicableIdentity APP
1133
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory
1134
- */
1135
- export declare function deleteCategory(categoryId: string): Promise<void>;
1136
- export {};
945
+
946
+ export { type PagingMetadataV2 as $, type ApplicationError as A, type BulkCreateCategoriesRequest as B, type Category as C, type CategoryLanguageCount as D, type GetCategoryRequest as E, Field as F, type GetCategoryOptions as G, type GetCategoryBySlugRequest as H, type InitialCategoriesCopied as I, type ListCategoriesRequest as J, type Keyword as K, type ListCategoriesOptions as L, type MaskedCategory as M, type BlogPaging as N, type MetaData as O, type QueryCategoriesRequest as P, type QueryCategoriesOptions as Q, type PlatformQuery as R, SortOrder as S, type Tag as T, type UpdateCategory as U, type PlatformQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type Paging as Y, type CursorPaging as Z, type QueryCategoriesResponse as _, type CreateCategoryOptions as a, type Cursors as a0, type BulkDeleteCategoryRequest as a1, type BulkDeleteCategoryResponse as a2, type DeleteCategoryRequest as a3, type DeleteCategoryResponse as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type BaseEventMetadata as af, type EventMetadata as ag, type CategoriesQueryResult as ah, type UpdateCategoryOptions as b, type GetCategoryResponse as c, type GetCategoryBySlugOptions as d, type GetCategoryBySlugResponse as e, type ListCategoriesResponse as f, type CategoriesQueryBuilder as g, type CategoryCreatedEnvelope as h, type CategoryDeletedEnvelope as i, type CategoryUpdatedEnvelope as j, type SeoSchema as k, type Settings as l, type FocalPoint as m, type CategoryTranslation as n, type CreateCategoryRequest as o, type CreateCategoryResponse as p, type BulkCreateCategoriesResponse as q, type BulkCategoryResult as r, type ItemMetadata as s, type BulkActionMetadata as t, type BulkUpdateCategoriesRequest as u, type BulkUpdateCategoriesResponse as v, type UpdateCategoryRequest as w, type UpdateCategoryResponse as x, type GetCategoriesCountByLanguageRequest as y, type GetCategoriesCountByLanguageResponse as z };