@wix/auto_sdk_blog_categories 1.0.4 → 1.0.6

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 (134) hide show
  1. package/build/{internal/cjs/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CF5HyUlx.d.mts} +74 -313
  2. package/build/{cjs/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CF5HyUlx.d.ts} +74 -313
  3. package/build/index.d.mts +117 -0
  4. package/build/index.d.ts +117 -0
  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-CF5HyUlx.d.mts} +74 -313
  10. package/build/internal/{es/src/blog-v3-category-categories.universal.d.ts → blog-v3-category-categories.universal-CF5HyUlx.d.ts} +74 -313
  11. package/build/internal/index.d.mts +117 -0
  12. package/build/internal/index.d.ts +117 -0
  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/meta.d.mts +457 -0
  18. package/build/internal/meta.d.ts +457 -0
  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/meta.d.mts +457 -0
  24. package/build/meta.d.ts +457 -0
  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 +13 -12
  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.d.ts +0 -99
  49. package/build/cjs/src/blog-v3-category-categories.public.js +0 -112
  50. package/build/cjs/src/blog-v3-category-categories.public.js.map +0 -1
  51. package/build/cjs/src/blog-v3-category-categories.types.d.ts +0 -791
  52. package/build/cjs/src/blog-v3-category-categories.types.js +0 -25
  53. package/build/cjs/src/blog-v3-category-categories.types.js.map +0 -1
  54. package/build/cjs/src/blog-v3-category-categories.universal.js +0 -499
  55. package/build/cjs/src/blog-v3-category-categories.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/blog-v3-category-categories.context.d.ts +0 -27
  67. package/build/es/src/blog-v3-category-categories.context.js +0 -27
  68. package/build/es/src/blog-v3-category-categories.context.js.map +0 -1
  69. package/build/es/src/blog-v3-category-categories.http.d.ts +0 -49
  70. package/build/es/src/blog-v3-category-categories.http.js +0 -398
  71. package/build/es/src/blog-v3-category-categories.http.js.map +0 -1
  72. package/build/es/src/blog-v3-category-categories.meta.d.ts +0 -27
  73. package/build/es/src/blog-v3-category-categories.meta.js +0 -128
  74. package/build/es/src/blog-v3-category-categories.meta.js.map +0 -1
  75. package/build/es/src/blog-v3-category-categories.public.d.ts +0 -99
  76. package/build/es/src/blog-v3-category-categories.public.js +0 -99
  77. package/build/es/src/blog-v3-category-categories.public.js.map +0 -1
  78. package/build/es/src/blog-v3-category-categories.types.d.ts +0 -791
  79. package/build/es/src/blog-v3-category-categories.types.js +0 -22
  80. package/build/es/src/blog-v3-category-categories.types.js.map +0 -1
  81. package/build/es/src/blog-v3-category-categories.universal.js +0 -466
  82. package/build/es/src/blog-v3-category-categories.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/blog-v3-category-categories.context.d.ts +0 -27
  93. package/build/internal/cjs/src/blog-v3-category-categories.context.js +0 -33
  94. package/build/internal/cjs/src/blog-v3-category-categories.context.js.map +0 -1
  95. package/build/internal/cjs/src/blog-v3-category-categories.http.d.ts +0 -49
  96. package/build/internal/cjs/src/blog-v3-category-categories.http.js +0 -408
  97. package/build/internal/cjs/src/blog-v3-category-categories.http.js.map +0 -1
  98. package/build/internal/cjs/src/blog-v3-category-categories.meta.d.ts +0 -27
  99. package/build/internal/cjs/src/blog-v3-category-categories.meta.js +0 -161
  100. package/build/internal/cjs/src/blog-v3-category-categories.meta.js.map +0 -1
  101. package/build/internal/cjs/src/blog-v3-category-categories.public.d.ts +0 -99
  102. package/build/internal/cjs/src/blog-v3-category-categories.public.js +0 -112
  103. package/build/internal/cjs/src/blog-v3-category-categories.public.js.map +0 -1
  104. package/build/internal/cjs/src/blog-v3-category-categories.types.d.ts +0 -791
  105. package/build/internal/cjs/src/blog-v3-category-categories.types.js +0 -25
  106. package/build/internal/cjs/src/blog-v3-category-categories.types.js.map +0 -1
  107. package/build/internal/cjs/src/blog-v3-category-categories.universal.js +0 -499
  108. package/build/internal/cjs/src/blog-v3-category-categories.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/blog-v3-category-categories.context.d.ts +0 -27
  119. package/build/internal/es/src/blog-v3-category-categories.context.js +0 -27
  120. package/build/internal/es/src/blog-v3-category-categories.context.js.map +0 -1
  121. package/build/internal/es/src/blog-v3-category-categories.http.d.ts +0 -49
  122. package/build/internal/es/src/blog-v3-category-categories.http.js +0 -398
  123. package/build/internal/es/src/blog-v3-category-categories.http.js.map +0 -1
  124. package/build/internal/es/src/blog-v3-category-categories.meta.d.ts +0 -27
  125. package/build/internal/es/src/blog-v3-category-categories.meta.js +0 -128
  126. package/build/internal/es/src/blog-v3-category-categories.meta.js.map +0 -1
  127. package/build/internal/es/src/blog-v3-category-categories.public.d.ts +0 -99
  128. package/build/internal/es/src/blog-v3-category-categories.public.js +0 -99
  129. package/build/internal/es/src/blog-v3-category-categories.public.js.map +0 -1
  130. package/build/internal/es/src/blog-v3-category-categories.types.d.ts +0 -791
  131. package/build/internal/es/src/blog-v3-category-categories.types.js +0 -22
  132. package/build/internal/es/src/blog-v3-category-categories.types.js.map +0 -1
  133. package/build/internal/es/src/blog-v3-category-categories.universal.js +0 -466
  134. package/build/internal/es/src/blog-v3-category-categories.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface Category {
1
+ interface Category {
2
2
  /**
3
3
  * Category ID.
4
4
  * @immutable
@@ -71,13 +71,13 @@ export interface Category {
71
71
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
72
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.
73
73
  */
74
- export interface SeoSchema {
74
+ interface SeoSchema {
75
75
  /** SEO tag information. */
76
76
  tags?: Tag[];
77
77
  /** SEO general settings. */
78
78
  settings?: Settings;
79
79
  }
80
- export interface Keyword {
80
+ interface Keyword {
81
81
  /** Keyword value. */
82
82
  term?: string;
83
83
  /** Whether the keyword is the main focus keyword. */
@@ -88,7 +88,7 @@ export interface Keyword {
88
88
  */
89
89
  origin?: string | null;
90
90
  }
91
- export interface Tag {
91
+ interface Tag {
92
92
  /**
93
93
  * SEO tag type.
94
94
  *
@@ -110,7 +110,7 @@ export interface Tag {
110
110
  /** Whether the tag is disabled. */
111
111
  disabled?: boolean;
112
112
  }
113
- export interface Settings {
113
+ interface Settings {
114
114
  /**
115
115
  * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
116
116
  *
@@ -124,7 +124,7 @@ export interface Settings {
124
124
  */
125
125
  keywords?: Keyword[];
126
126
  }
127
- export interface FocalPoint {
127
+ interface FocalPoint {
128
128
  /** X-coordinate of the focal point. */
129
129
  x?: number;
130
130
  /** Y-coordinate of the focal point. */
@@ -134,7 +134,7 @@ export interface FocalPoint {
134
134
  /** crop by width */
135
135
  width?: number | null;
136
136
  }
137
- export interface CategoryTranslation {
137
+ interface CategoryTranslation {
138
138
  /**
139
139
  * Category ID.
140
140
  * @format GUID
@@ -153,11 +153,11 @@ export interface CategoryTranslation {
153
153
  /** URL of this category page. */
154
154
  url?: string;
155
155
  }
156
- export interface InitialCategoriesCopied {
156
+ interface InitialCategoriesCopied {
157
157
  /** Number of categories copied. */
158
158
  count?: number;
159
159
  }
160
- export interface CreateCategoryRequest {
160
+ interface CreateCategoryRequest {
161
161
  /** Category info. */
162
162
  category: Category;
163
163
  /**
@@ -170,18 +170,18 @@ export interface CreateCategoryRequest {
170
170
  */
171
171
  fieldsets?: Field[];
172
172
  }
173
- export declare enum Field {
173
+ declare enum Field {
174
174
  UNKNOWN = "UNKNOWN",
175
175
  /** Includes Category url. */
176
176
  URL = "URL",
177
177
  /** Includes SEO data. */
178
178
  SEO = "SEO"
179
179
  }
180
- export interface CreateCategoryResponse {
180
+ interface CreateCategoryResponse {
181
181
  /** Category info. */
182
182
  category?: Category;
183
183
  }
184
- export interface BulkCreateCategoriesRequest {
184
+ interface BulkCreateCategoriesRequest {
185
185
  /**
186
186
  * Categories to create.
187
187
  * @minSize 1
@@ -200,19 +200,19 @@ export interface BulkCreateCategoriesRequest {
200
200
  */
201
201
  fieldsets?: Field[];
202
202
  }
203
- export interface BulkCreateCategoriesResponse {
203
+ interface BulkCreateCategoriesResponse {
204
204
  /** Categories created by bulk action. */
205
205
  results?: BulkCategoryResult[];
206
206
  /** Bulk action metadata. */
207
207
  bulkActionMetadata?: BulkActionMetadata;
208
208
  }
209
- export interface BulkCategoryResult {
209
+ interface BulkCategoryResult {
210
210
  /** Bulk actions metadata for category. */
211
211
  itemMetadata?: ItemMetadata;
212
212
  /** Optional created category. */
213
213
  item?: Category;
214
214
  }
215
- export interface ItemMetadata {
215
+ interface ItemMetadata {
216
216
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
217
217
  _id?: string | null;
218
218
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -222,7 +222,7 @@ export interface ItemMetadata {
222
222
  /** Details about the error in case of failure. */
223
223
  error?: ApplicationError;
224
224
  }
225
- export interface ApplicationError {
225
+ interface ApplicationError {
226
226
  /** Error code. */
227
227
  code?: string;
228
228
  /** Description of the error. */
@@ -230,7 +230,7 @@ export interface ApplicationError {
230
230
  /** Data related to the error. */
231
231
  data?: Record<string, any> | null;
232
232
  }
233
- export interface BulkActionMetadata {
233
+ interface BulkActionMetadata {
234
234
  /** Number of items that were successfully processed. */
235
235
  totalSuccesses?: number;
236
236
  /** Number of items that couldn't be processed. */
@@ -238,7 +238,7 @@ export interface BulkActionMetadata {
238
238
  /** Number of failures without details because detailed failure threshold was exceeded. */
239
239
  undetailedFailures?: number;
240
240
  }
241
- export interface BulkUpdateCategoriesRequest {
241
+ interface BulkUpdateCategoriesRequest {
242
242
  /**
243
243
  * Categories to update.
244
244
  * @minSize 1
@@ -257,19 +257,19 @@ export interface BulkUpdateCategoriesRequest {
257
257
  */
258
258
  fieldsets?: Field[];
259
259
  }
260
- export interface MaskedCategory {
260
+ interface MaskedCategory {
261
261
  /** Category */
262
262
  category?: Category;
263
263
  /** Field mask of fields to update. */
264
264
  fieldMask?: string[];
265
265
  }
266
- export interface BulkUpdateCategoriesResponse {
266
+ interface BulkUpdateCategoriesResponse {
267
267
  /** Categories updated by bulk action. */
268
268
  results?: BulkCategoryResult[];
269
269
  /** Bulk action metadata. */
270
270
  bulkActionMetadata?: BulkActionMetadata;
271
271
  }
272
- export interface UpdateCategoryRequest {
272
+ interface UpdateCategoryRequest {
273
273
  /** Category info. */
274
274
  category: Category;
275
275
  /**
@@ -282,17 +282,17 @@ export interface UpdateCategoryRequest {
282
282
  */
283
283
  fieldsets?: Field[];
284
284
  }
285
- export interface UpdateCategoryResponse {
285
+ interface UpdateCategoryResponse {
286
286
  /** Category info. */
287
287
  category?: Category;
288
288
  }
289
- export interface GetCategoriesCountByLanguageRequest {
289
+ interface GetCategoriesCountByLanguageRequest {
290
290
  }
291
- export interface GetCategoriesCountByLanguageResponse {
291
+ interface GetCategoriesCountByLanguageResponse {
292
292
  /** The language and it's count. */
293
293
  categoriesLanguageCount?: CategoryLanguageCount[];
294
294
  }
295
- export interface CategoryLanguageCount {
295
+ interface CategoryLanguageCount {
296
296
  /**
297
297
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
298
298
  * @format LANGUAGE_TAG
@@ -301,7 +301,7 @@ export interface CategoryLanguageCount {
301
301
  /** The count of Categories for the language. */
302
302
  categoryCount?: number | null;
303
303
  }
304
- export interface GetCategoryRequest {
304
+ interface GetCategoryRequest {
305
305
  /**
306
306
  * Category ID.
307
307
  * @minLength 1
@@ -318,11 +318,11 @@ export interface GetCategoryRequest {
318
318
  */
319
319
  fieldsets?: Field[];
320
320
  }
321
- export interface GetCategoryResponse {
321
+ interface GetCategoryResponse {
322
322
  /** Category info. */
323
323
  category?: Category;
324
324
  }
325
- export interface GetCategoryBySlugRequest {
325
+ interface GetCategoryBySlugRequest {
326
326
  /**
327
327
  * Slug of the category to retrieve.
328
328
  * @minLength 1
@@ -345,11 +345,11 @@ export interface GetCategoryBySlugRequest {
345
345
  */
346
346
  language?: string | null;
347
347
  }
348
- export interface GetCategoryBySlugResponse {
348
+ interface GetCategoryBySlugResponse {
349
349
  /** Category info. */
350
350
  category?: Category;
351
351
  }
352
- export interface ListCategoriesRequest {
352
+ interface ListCategoriesRequest {
353
353
  /** Pagination options. */
354
354
  paging?: BlogPaging;
355
355
  /**
@@ -371,7 +371,7 @@ export interface ListCategoriesRequest {
371
371
  */
372
372
  language?: string | null;
373
373
  }
374
- export interface BlogPaging {
374
+ interface BlogPaging {
375
375
  /**
376
376
  * Number of items to skip in the current sort order.
377
377
  *
@@ -395,13 +395,13 @@ export interface BlogPaging {
395
395
  */
396
396
  cursor?: string | null;
397
397
  }
398
- export interface ListCategoriesResponse {
398
+ interface ListCategoriesResponse {
399
399
  /** List of categories. */
400
400
  categories?: Category[];
401
401
  /** Details on the paged set of results returned. */
402
402
  metaData?: MetaData;
403
403
  }
404
- export interface MetaData {
404
+ interface MetaData {
405
405
  /** Number of items returned in this response. */
406
406
  count?: number;
407
407
  /** Requested offset. */
@@ -414,7 +414,7 @@ export interface MetaData {
414
414
  */
415
415
  cursor?: string | null;
416
416
  }
417
- export interface QueryCategoriesRequest {
417
+ interface QueryCategoriesRequest {
418
418
  /** Query options. */
419
419
  query?: PlatformQuery;
420
420
  /**
@@ -427,7 +427,7 @@ export interface QueryCategoriesRequest {
427
427
  */
428
428
  fieldsets?: Field[];
429
429
  }
430
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
430
+ interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
431
431
  /** Paging options to limit and skip the number of items. */
432
432
  paging?: Paging;
433
433
  /** 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`. */
@@ -449,13 +449,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
449
449
  sort?: Sorting[];
450
450
  }
451
451
  /** @oneof */
452
- export interface PlatformQueryPagingMethodOneOf {
452
+ interface PlatformQueryPagingMethodOneOf {
453
453
  /** Paging options to limit and skip the number of items. */
454
454
  paging?: Paging;
455
455
  /** 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`. */
456
456
  cursorPaging?: CursorPaging;
457
457
  }
458
- export interface Sorting {
458
+ interface Sorting {
459
459
  /**
460
460
  * Name of the field to sort by.
461
461
  * @maxLength 512
@@ -464,11 +464,11 @@ export interface Sorting {
464
464
  /** Sort order. */
465
465
  order?: SortOrder;
466
466
  }
467
- export declare enum SortOrder {
467
+ declare enum SortOrder {
468
468
  ASC = "ASC",
469
469
  DESC = "DESC"
470
470
  }
471
- export interface Paging {
471
+ interface Paging {
472
472
  /**
473
473
  * Number of items to load.
474
474
  * @max 100
@@ -477,7 +477,7 @@ export interface Paging {
477
477
  /** Number of items to skip in the current sort order. */
478
478
  offset?: number | null;
479
479
  }
480
- export interface CursorPaging {
480
+ interface CursorPaging {
481
481
  /**
482
482
  * Number of items to load.
483
483
  * @max 100
@@ -493,13 +493,13 @@ export interface CursorPaging {
493
493
  */
494
494
  cursor?: string | null;
495
495
  }
496
- export interface QueryCategoriesResponse {
496
+ interface QueryCategoriesResponse {
497
497
  /** List of categories. */
498
498
  categories?: Category[];
499
499
  /** Details on the paged set of results returned. */
500
500
  pagingMetadata?: PagingMetadataV2;
501
501
  }
502
- export interface PagingMetadataV2 {
502
+ interface PagingMetadataV2 {
503
503
  /** Number of items returned in the response. */
504
504
  count?: number | null;
505
505
  /** Offset that was requested. */
@@ -511,7 +511,7 @@ export interface PagingMetadataV2 {
511
511
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
512
512
  cursors?: Cursors;
513
513
  }
514
- export interface Cursors {
514
+ interface Cursors {
515
515
  /**
516
516
  * Cursor pointing to next page in the list of results.
517
517
  * @maxLength 2000
@@ -523,7 +523,7 @@ export interface Cursors {
523
523
  */
524
524
  prev?: string | null;
525
525
  }
526
- export interface BulkDeleteCategoryRequest {
526
+ interface BulkDeleteCategoryRequest {
527
527
  /**
528
528
  * Category IDs.
529
529
  * @minSize 1
@@ -534,9 +534,9 @@ export interface BulkDeleteCategoryRequest {
534
534
  /** Should delete bypassing the trash-bin. */
535
535
  permanent?: boolean;
536
536
  }
537
- export interface BulkDeleteCategoryResponse {
537
+ interface BulkDeleteCategoryResponse {
538
538
  }
539
- export interface DeleteCategoryRequest {
539
+ interface DeleteCategoryRequest {
540
540
  /**
541
541
  * Category ID.
542
542
  * @minLength 1
@@ -544,9 +544,9 @@ export interface DeleteCategoryRequest {
544
544
  */
545
545
  categoryId: string;
546
546
  }
547
- export interface DeleteCategoryResponse {
547
+ interface DeleteCategoryResponse {
548
548
  }
549
- export interface DomainEvent extends DomainEventBodyOneOf {
549
+ interface DomainEvent extends DomainEventBodyOneOf {
550
550
  createdEvent?: EntityCreatedEvent;
551
551
  updatedEvent?: EntityUpdatedEvent;
552
552
  deletedEvent?: EntityDeletedEvent;
@@ -589,19 +589,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
589
589
  entityEventSequence?: string | null;
590
590
  }
591
591
  /** @oneof */
592
- export interface DomainEventBodyOneOf {
592
+ interface DomainEventBodyOneOf {
593
593
  createdEvent?: EntityCreatedEvent;
594
594
  updatedEvent?: EntityUpdatedEvent;
595
595
  deletedEvent?: EntityDeletedEvent;
596
596
  actionEvent?: ActionEvent;
597
597
  }
598
- export interface EntityCreatedEvent {
598
+ interface EntityCreatedEvent {
599
599
  entity?: string;
600
600
  }
601
- export interface RestoreInfo {
601
+ interface RestoreInfo {
602
602
  deletedDate?: Date | null;
603
603
  }
604
- export interface EntityUpdatedEvent {
604
+ interface EntityUpdatedEvent {
605
605
  /**
606
606
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
607
607
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -609,14 +609,14 @@ export interface EntityUpdatedEvent {
609
609
  */
610
610
  currentEntity?: string;
611
611
  }
612
- export interface EntityDeletedEvent {
612
+ interface EntityDeletedEvent {
613
613
  /** Entity that was deleted */
614
614
  deletedEntity?: string | null;
615
615
  }
616
- export interface ActionEvent {
616
+ interface ActionEvent {
617
617
  body?: string;
618
618
  }
619
- export interface MessageEnvelope {
619
+ interface MessageEnvelope {
620
620
  /**
621
621
  * App instance ID.
622
622
  * @format GUID
@@ -632,7 +632,7 @@ export interface MessageEnvelope {
632
632
  /** Stringify payload. */
633
633
  data?: string;
634
634
  }
635
- export interface IdentificationData extends IdentificationDataIdOneOf {
635
+ interface IdentificationData extends IdentificationDataIdOneOf {
636
636
  /**
637
637
  * ID of a site visitor that has not logged in to the site.
638
638
  * @format GUID
@@ -657,7 +657,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
657
657
  identityType?: WebhookIdentityType;
658
658
  }
659
659
  /** @oneof */
660
- export interface IdentificationDataIdOneOf {
660
+ interface IdentificationDataIdOneOf {
661
661
  /**
662
662
  * ID of a site visitor that has not logged in to the site.
663
663
  * @format GUID
@@ -679,71 +679,14 @@ export interface IdentificationDataIdOneOf {
679
679
  */
680
680
  appId?: string;
681
681
  }
682
- export declare enum WebhookIdentityType {
682
+ declare enum WebhookIdentityType {
683
683
  UNKNOWN = "UNKNOWN",
684
684
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
685
685
  MEMBER = "MEMBER",
686
686
  WIX_USER = "WIX_USER",
687
687
  APP = "APP"
688
688
  }
689
- interface TagNonNullableFields {
690
- type: string;
691
- children: string;
692
- custom: boolean;
693
- disabled: boolean;
694
- }
695
- interface KeywordNonNullableFields {
696
- term: string;
697
- isMain: boolean;
698
- }
699
- interface SettingsNonNullableFields {
700
- preventAutoRedirect: boolean;
701
- keywords: KeywordNonNullableFields[];
702
- }
703
- interface SeoSchemaNonNullableFields {
704
- tags: TagNonNullableFields[];
705
- settings?: SettingsNonNullableFields;
706
- }
707
- interface CategoryTranslationNonNullableFields {
708
- _id: string;
709
- url: string;
710
- }
711
- export interface CategoryNonNullableFields {
712
- _id: string;
713
- label: string;
714
- postCount: number;
715
- url: string;
716
- title: string;
717
- slug: string;
718
- seoData?: SeoSchemaNonNullableFields;
719
- coverImage: string;
720
- translations: CategoryTranslationNonNullableFields[];
721
- }
722
- export interface CreateCategoryResponseNonNullableFields {
723
- category?: CategoryNonNullableFields;
724
- }
725
- export interface UpdateCategoryResponseNonNullableFields {
726
- category?: CategoryNonNullableFields;
727
- }
728
- export interface GetCategoryResponseNonNullableFields {
729
- category?: CategoryNonNullableFields;
730
- }
731
- export interface GetCategoryBySlugResponseNonNullableFields {
732
- category?: CategoryNonNullableFields;
733
- }
734
- interface MetaDataNonNullableFields {
735
- count: number;
736
- offset: number;
737
- total: number;
738
- }
739
- export interface ListCategoriesResponseNonNullableFields {
740
- categories: CategoryNonNullableFields[];
741
- metaData?: MetaDataNonNullableFields;
742
- }
743
- export interface QueryCategoriesResponseNonNullableFields {
744
- categories: CategoryNonNullableFields[];
745
- }
746
- export interface BaseEventMetadata {
689
+ interface BaseEventMetadata {
747
690
  /**
748
691
  * App instance ID.
749
692
  * @format GUID
@@ -757,7 +700,7 @@ export interface BaseEventMetadata {
757
700
  /** The identification type and identity data. */
758
701
  identity?: IdentificationData;
759
702
  }
760
- export interface EventMetadata extends BaseEventMetadata {
703
+ interface EventMetadata extends BaseEventMetadata {
761
704
  /**
762
705
  * Unique event ID.
763
706
  * Allows clients to ignore duplicate webhooks.
@@ -795,77 +738,18 @@ export interface EventMetadata extends BaseEventMetadata {
795
738
  */
796
739
  entityEventSequence?: string | null;
797
740
  }
798
- export interface CategoryCreatedEnvelope {
741
+ interface CategoryCreatedEnvelope {
799
742
  entity: Category;
800
743
  metadata: EventMetadata;
801
744
  }
802
- /**
803
- * Triggered when a category is created.
804
- * @permissionScope Read Blog
805
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
806
- * @permissionScope Manage Blog
807
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
808
- * @permissionScope Read Draft Blog Posts
809
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
810
- * @permissionId BLOG.READ-CATEGORY
811
- * @webhook
812
- * @eventType wix.blog.v3.category_created
813
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
814
- * @slug created
815
- */
816
- export declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) => void | Promise<void>): void;
817
- export interface CategoryDeletedEnvelope {
745
+ interface CategoryDeletedEnvelope {
818
746
  metadata: EventMetadata;
819
747
  }
820
- /**
821
- * Triggered when a category is deleted.
822
- * @permissionScope Read Blog
823
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
824
- * @permissionScope Manage Blog
825
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
826
- * @permissionScope Read Draft Blog Posts
827
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
828
- * @permissionId BLOG.READ-CATEGORY
829
- * @webhook
830
- * @eventType wix.blog.v3.category_deleted
831
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
832
- * @slug deleted
833
- */
834
- export declare function onCategoryDeleted(handler: (event: CategoryDeletedEnvelope) => void | Promise<void>): void;
835
- export interface CategoryUpdatedEnvelope {
748
+ interface CategoryUpdatedEnvelope {
836
749
  entity: Category;
837
750
  metadata: EventMetadata;
838
751
  }
839
- /**
840
- * Triggered when a category is updated.
841
- * @permissionScope Read Blog
842
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
843
- * @permissionScope Manage Blog
844
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
845
- * @permissionScope Read Draft Blog Posts
846
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
847
- * @permissionId BLOG.READ-CATEGORY
848
- * @webhook
849
- * @eventType wix.blog.v3.category_updated
850
- * @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.CategoryService
851
- * @slug updated
852
- */
853
- export declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) => void | Promise<void>): void;
854
- /**
855
- * Creates a category.
856
- * @param category - Category info.
857
- * @public
858
- * @requiredField category
859
- * @requiredField category.label
860
- * @permissionId BLOG.CREATE-CATEGORY
861
- * @permissionScope Manage Blog
862
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
863
- * @applicableIdentity APP
864
- * @returns Category info.
865
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.CreateCategory
866
- */
867
- export declare function createCategory(category: Category, options?: CreateCategoryOptions): Promise<Category & CategoryNonNullableFields>;
868
- export interface CreateCategoryOptions {
752
+ interface CreateCategoryOptions {
869
753
  /**
870
754
  * List of additional category fields to include in the response. By default
871
755
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -876,21 +760,7 @@ export interface CreateCategoryOptions {
876
760
  */
877
761
  fieldsets?: Field[];
878
762
  }
879
- /**
880
- * Updates a category.
881
- * @param _id - Category ID.
882
- * @public
883
- * @requiredField _id
884
- * @requiredField category
885
- * @permissionId BLOG.EDIT-CATEGORY
886
- * @permissionScope Manage Blog
887
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
888
- * @applicableIdentity APP
889
- * @returns Category info.
890
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.UpdateCategory
891
- */
892
- export declare function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise<Category & CategoryNonNullableFields>;
893
- export interface UpdateCategory {
763
+ interface UpdateCategory {
894
764
  /**
895
765
  * Category ID.
896
766
  * @immutable
@@ -958,7 +828,7 @@ export interface UpdateCategory {
958
828
  */
959
829
  _updatedDate?: Date | null;
960
830
  }
961
- export interface UpdateCategoryOptions {
831
+ interface UpdateCategoryOptions {
962
832
  /**
963
833
  * List of additional category fields to include in the response. By default
964
834
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -969,25 +839,7 @@ export interface UpdateCategoryOptions {
969
839
  */
970
840
  fieldsets?: Field[];
971
841
  }
972
- /**
973
- * Gets a category with the specified ID.
974
- * @param categoryId - Category ID.
975
- * @public
976
- * @requiredField categoryId
977
- * @param options - Options specifying which fields to return.
978
- * @permissionId BLOG.READ-CATEGORY
979
- * @permissionScope Read Blog
980
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
981
- * @permissionScope Manage Blog
982
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
983
- * @permissionScope Read Draft Blog Posts
984
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
985
- * @applicableIdentity APP
986
- * @applicableIdentity VISITOR
987
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategory
988
- */
989
- export declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<GetCategoryResponse & GetCategoryResponseNonNullableFields>;
990
- export interface GetCategoryOptions {
842
+ interface GetCategoryOptions {
991
843
  /**
992
844
  * List of additional category fields to include in the response. By default
993
845
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -998,31 +850,7 @@ export interface GetCategoryOptions {
998
850
  */
999
851
  fieldsets?: Field[];
1000
852
  }
1001
- /**
1002
- * Gets a category with the specified slug.
1003
- *
1004
- * The slug is at the end of the URL of a specific category.
1005
- * For example, if a category's URL is `https://example.com/blog/categories/famous-cats`, the slug is `famous-cats`.
1006
- * The slug is a case-sensitive string that is derived from the category's label, unless specified otherwise.
1007
- * @public
1008
- * @requiredField slug
1009
- * @param slug - Slug of the category to retrieve.
1010
- *
1011
- * 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.
1012
- * @param options - Options specifying which fields to return.
1013
- * @permissionId BLOG.READ-CATEGORY
1014
- * @permissionScope Read Blog
1015
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
1016
- * @permissionScope Manage Blog
1017
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1018
- * @permissionScope Read Draft Blog Posts
1019
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
1020
- * @applicableIdentity APP
1021
- * @applicableIdentity VISITOR
1022
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.GetCategoryBySlug
1023
- */
1024
- export declare function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise<GetCategoryBySlugResponse & GetCategoryBySlugResponseNonNullableFields>;
1025
- export interface GetCategoryBySlugOptions {
853
+ interface GetCategoryBySlugOptions {
1026
854
  /**
1027
855
  * List of additional category fields to include in the response. By default
1028
856
  * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.
@@ -1039,34 +867,7 @@ export interface GetCategoryBySlugOptions {
1039
867
  */
1040
868
  language?: string | null;
1041
869
  }
1042
- /**
1043
- * Retrieves a list of up to 100 categories per request.
1044
- *
1045
- * If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.
1046
- *
1047
- * The categoies are displayed in order of their `displayPosition`, starting with `0`. The `displayPosition` is the position in which the categories
1048
- * 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`.
1049
- *
1050
- * List Categories runs with these defaults, which you can override:
1051
- * - `paging.limit` is `50`.
1052
- * - `paging.offset` is `0`.
1053
- *
1054
- * List Categories is sorted by `displayPosition` in descending order. This cannot be overridden.
1055
- * @public
1056
- * @param options - Filter and paging options.
1057
- * @permissionId BLOG.READ-CATEGORY
1058
- * @permissionScope Read Blog
1059
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
1060
- * @permissionScope Manage Blog
1061
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1062
- * @permissionScope Read Draft Blog Posts
1063
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
1064
- * @applicableIdentity APP
1065
- * @applicableIdentity VISITOR
1066
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.ListCategories
1067
- */
1068
- export declare function listCategories(options?: ListCategoriesOptions): Promise<ListCategoriesResponse & ListCategoriesResponseNonNullableFields>;
1069
- export interface ListCategoriesOptions {
870
+ interface ListCategoriesOptions {
1070
871
  /** Pagination options. */
1071
872
  paging?: BlogPaging;
1072
873
  /**
@@ -1088,36 +889,7 @@ export interface ListCategoriesOptions {
1088
889
  */
1089
890
  language?: string | null;
1090
891
  }
1091
- /**
1092
- * Creates a query to retrieve a list of categories.
1093
- *
1094
- *
1095
- * 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.
1096
- *
1097
- * 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.
1098
- *
1099
- * 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.
1100
- *
1101
- * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.
1102
- * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)
1103
- * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)
1104
- *
1105
- * 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).
1106
- * @public
1107
- * @param options - Options specifying which fields to return.
1108
- * @permissionScope Read Blog
1109
- * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
1110
- * @permissionScope Manage Blog
1111
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1112
- * @permissionScope Read Draft Blog Posts
1113
- * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
1114
- * @permissionId BLOG.READ-CATEGORY
1115
- * @applicableIdentity APP
1116
- * @applicableIdentity VISITOR
1117
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.QueryCategories
1118
- */
1119
- export declare function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;
1120
- export interface QueryCategoriesOptions {
892
+ interface QueryCategoriesOptions {
1121
893
  /**
1122
894
 
1123
895
  * @maxSize 10
@@ -1133,13 +905,13 @@ interface QueryOffsetResult {
1133
905
  length: number;
1134
906
  pageSize: number;
1135
907
  }
1136
- export interface CategoriesQueryResult extends QueryOffsetResult {
908
+ interface CategoriesQueryResult extends QueryOffsetResult {
1137
909
  items: Category[];
1138
910
  query: CategoriesQueryBuilder;
1139
911
  next: () => Promise<CategoriesQueryResult>;
1140
912
  prev: () => Promise<CategoriesQueryResult>;
1141
913
  }
1142
- export interface CategoriesQueryBuilder {
914
+ interface CategoriesQueryBuilder {
1143
915
  /** @param propertyName - Property whose value is compared with `value`.
1144
916
  * @param value - Value to compare against.
1145
917
  */
@@ -1180,16 +952,5 @@ export interface CategoriesQueryBuilder {
1180
952
  skip: (skip: number) => CategoriesQueryBuilder;
1181
953
  find: () => Promise<CategoriesQueryResult>;
1182
954
  }
1183
- /**
1184
- * Deletes a category.
1185
- * @param categoryId - Category ID.
1186
- * @public
1187
- * @requiredField categoryId
1188
- * @permissionId BLOG.DELETE-CATEGORY
1189
- * @permissionScope Manage Blog
1190
- * @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
1191
- * @applicableIdentity APP
1192
- * @fqn com.wixpress.npm.communities.platformized.blog.v3.CategoryService.DeleteCategory
1193
- */
1194
- export declare function deleteCategory(categoryId: string): Promise<void>;
1195
- export {};
955
+
956
+ export { type BulkDeleteCategoryResponse as $, type ApplicationError as A, type BulkCreateCategoriesRequest as B, type Category as C, type ListCategoriesRequest as D, type BlogPaging as E, Field as F, type GetCategoryOptions as G, type MetaData as H, type InitialCategoriesCopied as I, type QueryCategoriesRequest as J, type Keyword as K, type ListCategoriesOptions as L, type MaskedCategory as M, type PlatformQueryPagingMethodOneOf as N, type Sorting as O, type PlatformQuery as P, type QueryCategoriesOptions as Q, type Paging as R, SortOrder as S, type Tag as T, type UpdateCategory as U, type CursorPaging as V, WebhookIdentityType as W, type QueryCategoriesResponse as X, type PagingMetadataV2 as Y, type Cursors as Z, type BulkDeleteCategoryRequest as _, type CreateCategoryOptions as a, type DeleteCategoryRequest as a0, type DeleteCategoryResponse as a1, type DomainEvent as a2, type DomainEventBodyOneOf as a3, type EntityCreatedEvent as a4, type RestoreInfo as a5, type EntityUpdatedEvent as a6, type EntityDeletedEvent as a7, type ActionEvent as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type CategoryCreatedEnvelope as ae, type CategoryDeletedEnvelope as af, type CategoryUpdatedEnvelope 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 SeoSchema as h, type Settings as i, type FocalPoint as j, type CategoryTranslation as k, type CreateCategoryRequest as l, type CreateCategoryResponse as m, type BulkCreateCategoriesResponse as n, type BulkCategoryResult as o, type ItemMetadata as p, type BulkActionMetadata as q, type BulkUpdateCategoriesRequest as r, type BulkUpdateCategoriesResponse as s, type UpdateCategoryRequest as t, type UpdateCategoryResponse as u, type GetCategoriesCountByLanguageRequest as v, type GetCategoriesCountByLanguageResponse as w, type CategoryLanguageCount as x, type GetCategoryRequest as y, type GetCategoryBySlugRequest as z };