@wix/auto_sdk_events_categories 1.0.6 → 1.0.7
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/{es/src/events-v1-category-categories.types.d.ts → events-v1-category-categories.universal-DO_kYbme.d.mts} +219 -117
- package/build/{internal/cjs/src/events-v1-category-categories.types.d.ts → events-v1-category-categories.universal-DO_kYbme.d.ts} +219 -117
- package/build/index.d.mts +155 -0
- package/build/index.d.ts +155 -0
- package/build/index.js +1357 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1317 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/events-v1-category-categories.types.d.ts → internal/events-v1-category-categories.universal-DO_kYbme.d.mts} +219 -117
- package/build/internal/{es/src/events-v1-category-categories.types.d.ts → events-v1-category-categories.universal-DO_kYbme.d.ts} +219 -117
- package/build/internal/index.d.mts +155 -0
- package/build/internal/index.d.ts +155 -0
- package/build/internal/index.js +1357 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1317 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +404 -0
- package/build/internal/meta.d.ts +404 -0
- package/build/internal/meta.js +1083 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1044 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +404 -0
- package/build/meta.d.ts +404 -0
- package/build/meta.js +1083 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1044 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.context.d.ts +0 -17
- package/build/cjs/src/events-v1-category-categories.context.js +0 -24
- package/build/cjs/src/events-v1-category-categories.context.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.http.d.ts +0 -57
- package/build/cjs/src/events-v1-category-categories.http.js +0 -851
- package/build/cjs/src/events-v1-category-categories.http.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.meta.d.ts +0 -37
- package/build/cjs/src/events-v1-category-categories.meta.js +0 -275
- package/build/cjs/src/events-v1-category-categories.meta.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.public.d.ts +0 -141
- package/build/cjs/src/events-v1-category-categories.public.js +0 -89
- package/build/cjs/src/events-v1-category-categories.public.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.types.js +0 -33
- package/build/cjs/src/events-v1-category-categories.types.js.map +0 -1
- package/build/cjs/src/events-v1-category-categories.universal.d.ts +0 -963
- package/build/cjs/src/events-v1-category-categories.universal.js +0 -657
- package/build/cjs/src/events-v1-category-categories.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-v1-category-categories.context.d.ts +0 -17
- package/build/es/src/events-v1-category-categories.context.js +0 -17
- package/build/es/src/events-v1-category-categories.context.js.map +0 -1
- package/build/es/src/events-v1-category-categories.http.d.ts +0 -57
- package/build/es/src/events-v1-category-categories.http.js +0 -835
- package/build/es/src/events-v1-category-categories.http.js.map +0 -1
- package/build/es/src/events-v1-category-categories.meta.d.ts +0 -37
- package/build/es/src/events-v1-category-categories.meta.js +0 -236
- package/build/es/src/events-v1-category-categories.meta.js.map +0 -1
- package/build/es/src/events-v1-category-categories.public.d.ts +0 -141
- package/build/es/src/events-v1-category-categories.public.js +0 -69
- package/build/es/src/events-v1-category-categories.public.js.map +0 -1
- package/build/es/src/events-v1-category-categories.types.js +0 -30
- package/build/es/src/events-v1-category-categories.types.js.map +0 -1
- package/build/es/src/events-v1-category-categories.universal.d.ts +0 -963
- package/build/es/src/events-v1-category-categories.universal.js +0 -618
- package/build/es/src/events-v1-category-categories.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.context.d.ts +0 -17
- package/build/internal/cjs/src/events-v1-category-categories.context.js +0 -24
- package/build/internal/cjs/src/events-v1-category-categories.context.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.http.d.ts +0 -57
- package/build/internal/cjs/src/events-v1-category-categories.http.js +0 -851
- package/build/internal/cjs/src/events-v1-category-categories.http.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.meta.d.ts +0 -37
- package/build/internal/cjs/src/events-v1-category-categories.meta.js +0 -275
- package/build/internal/cjs/src/events-v1-category-categories.meta.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.public.d.ts +0 -141
- package/build/internal/cjs/src/events-v1-category-categories.public.js +0 -89
- package/build/internal/cjs/src/events-v1-category-categories.public.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.types.js +0 -33
- package/build/internal/cjs/src/events-v1-category-categories.types.js.map +0 -1
- package/build/internal/cjs/src/events-v1-category-categories.universal.d.ts +0 -963
- package/build/internal/cjs/src/events-v1-category-categories.universal.js +0 -657
- package/build/internal/cjs/src/events-v1-category-categories.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.context.d.ts +0 -17
- package/build/internal/es/src/events-v1-category-categories.context.js +0 -17
- package/build/internal/es/src/events-v1-category-categories.context.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.http.d.ts +0 -57
- package/build/internal/es/src/events-v1-category-categories.http.js +0 -835
- package/build/internal/es/src/events-v1-category-categories.http.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.meta.d.ts +0 -37
- package/build/internal/es/src/events-v1-category-categories.meta.js +0 -236
- package/build/internal/es/src/events-v1-category-categories.meta.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.public.d.ts +0 -141
- package/build/internal/es/src/events-v1-category-categories.public.js +0 -69
- package/build/internal/es/src/events-v1-category-categories.public.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.types.js +0 -30
- package/build/internal/es/src/events-v1-category-categories.types.js.map +0 -1
- package/build/internal/es/src/events-v1-category-categories.universal.d.ts +0 -963
- package/build/internal/es/src/events-v1-category-categories.universal.js +0 -618
- package/build/internal/es/src/events-v1-category-categories.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Category {
|
|
2
2
|
/**
|
|
3
3
|
* Category ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string;
|
|
8
8
|
/**
|
|
9
9
|
* Category name.
|
|
10
10
|
* @minLength 1
|
|
@@ -15,7 +15,7 @@ export interface Category {
|
|
|
15
15
|
* Date and time when category was created.
|
|
16
16
|
* @readonly
|
|
17
17
|
*/
|
|
18
|
-
|
|
18
|
+
_createdDate?: Date | null;
|
|
19
19
|
/**
|
|
20
20
|
* The total number of draft and published events assigned to the category.
|
|
21
21
|
* @readonly
|
|
@@ -23,26 +23,25 @@ export interface Category {
|
|
|
23
23
|
counts?: CategoryCounts;
|
|
24
24
|
/**
|
|
25
25
|
* Category state. Possible values:
|
|
26
|
-
*
|
|
27
|
-
* `
|
|
28
|
-
* `
|
|
29
|
-
* `
|
|
30
|
-
* `HIDDEN`: Category can't be seen.
|
|
26
|
+
* - `MANUAL`: Category is created manually by the user.
|
|
27
|
+
* - `AUTO`: Category is created automatically.
|
|
28
|
+
* - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
|
|
29
|
+
* - `HIDDEN`: Category can't be seen.
|
|
31
30
|
*
|
|
32
31
|
* Default: `MANUAL`.
|
|
33
32
|
*
|
|
34
|
-
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission
|
|
33
|
+
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use states other than `MANUAL`.
|
|
35
34
|
* @maxSize 3
|
|
36
35
|
*/
|
|
37
36
|
states?: State[];
|
|
38
37
|
}
|
|
39
|
-
|
|
40
|
-
/** Total number of draft events assigned to the category. */
|
|
41
|
-
assignedEventsCount?: number | null;
|
|
38
|
+
interface CategoryCounts {
|
|
42
39
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
40
|
+
assignedEventsCount?: number | null;
|
|
41
|
+
/** Total number of draft events assigned to the category. */
|
|
43
42
|
assignedDraftEventsCount?: number | null;
|
|
44
43
|
}
|
|
45
|
-
|
|
44
|
+
declare enum State {
|
|
46
45
|
/** Created manually by the user. */
|
|
47
46
|
MANUAL = "MANUAL",
|
|
48
47
|
/** Created automatically. */
|
|
@@ -52,15 +51,15 @@ export declare enum State {
|
|
|
52
51
|
/** Category is hidden. */
|
|
53
52
|
HIDDEN = "HIDDEN"
|
|
54
53
|
}
|
|
55
|
-
|
|
54
|
+
interface CreateCategoryRequest {
|
|
56
55
|
/** Category to create. */
|
|
57
56
|
category: Category;
|
|
58
57
|
}
|
|
59
|
-
|
|
58
|
+
interface CreateCategoryResponse {
|
|
60
59
|
/** Created category. */
|
|
61
60
|
category?: Category;
|
|
62
61
|
}
|
|
63
|
-
|
|
62
|
+
interface BulkCreateCategoryRequest {
|
|
64
63
|
/**
|
|
65
64
|
* Categories to create.
|
|
66
65
|
* @minSize 1
|
|
@@ -68,21 +67,21 @@ export interface BulkCreateCategoryRequest {
|
|
|
68
67
|
*/
|
|
69
68
|
categories: Category[];
|
|
70
69
|
}
|
|
71
|
-
|
|
70
|
+
interface BulkCreateCategoryResponse {
|
|
72
71
|
/** Bulk create results. */
|
|
73
72
|
results?: BulkCategoryResult[];
|
|
74
73
|
/** Metadata of results. */
|
|
75
74
|
bulkActionMetadata?: BulkActionMetadata;
|
|
76
75
|
}
|
|
77
|
-
|
|
76
|
+
interface BulkCategoryResult {
|
|
78
77
|
/** Metadata. */
|
|
79
78
|
itemMetadata?: ItemMetadata;
|
|
80
|
-
/**
|
|
79
|
+
/** Created categories. */
|
|
81
80
|
item?: Category;
|
|
82
81
|
}
|
|
83
|
-
|
|
82
|
+
interface ItemMetadata {
|
|
84
83
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
85
|
-
|
|
84
|
+
_id?: string | null;
|
|
86
85
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
87
86
|
originalIndex?: number;
|
|
88
87
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -90,7 +89,7 @@ export interface ItemMetadata {
|
|
|
90
89
|
/** Details about the error in case of failure. */
|
|
91
90
|
error?: ApplicationError;
|
|
92
91
|
}
|
|
93
|
-
|
|
92
|
+
interface ApplicationError {
|
|
94
93
|
/** Error code. */
|
|
95
94
|
code?: string;
|
|
96
95
|
/** Description of the error. */
|
|
@@ -98,32 +97,32 @@ export interface ApplicationError {
|
|
|
98
97
|
/** Data related to the error. */
|
|
99
98
|
data?: Record<string, any> | null;
|
|
100
99
|
}
|
|
101
|
-
|
|
100
|
+
interface BulkActionMetadata {
|
|
102
101
|
/** Number of items that were successfully processed. */
|
|
103
102
|
totalSuccesses?: number;
|
|
104
103
|
/** Number of items that couldn't be processed. */
|
|
105
104
|
totalFailures?: number;
|
|
106
|
-
/** Number of failures without details
|
|
105
|
+
/** Number of failures without details due to exceeding the threshold for detailed failures. */
|
|
107
106
|
undetailedFailures?: number;
|
|
108
107
|
}
|
|
109
|
-
|
|
108
|
+
interface UpdateCategoryRequest {
|
|
110
109
|
/** Category to update. */
|
|
111
110
|
category: Category;
|
|
112
111
|
}
|
|
113
|
-
|
|
112
|
+
interface UpdateCategoryResponse {
|
|
114
113
|
/** Updated category. */
|
|
115
114
|
category?: Category;
|
|
116
115
|
}
|
|
117
|
-
|
|
116
|
+
interface DeleteCategoryRequest {
|
|
118
117
|
/**
|
|
119
118
|
* ID of category to be deleted.
|
|
120
119
|
* @format GUID
|
|
121
120
|
*/
|
|
122
121
|
categoryId: string;
|
|
123
122
|
}
|
|
124
|
-
|
|
123
|
+
interface DeleteCategoryResponse {
|
|
125
124
|
}
|
|
126
|
-
|
|
125
|
+
interface QueryCategoriesRequest {
|
|
127
126
|
/** Options to use when querying categories. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
128
127
|
query: QueryV2;
|
|
129
128
|
/**
|
|
@@ -133,7 +132,7 @@ export interface QueryCategoriesRequest {
|
|
|
133
132
|
*/
|
|
134
133
|
fieldset?: CategoryFieldset[];
|
|
135
134
|
}
|
|
136
|
-
|
|
135
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
137
136
|
/**
|
|
138
137
|
* Pointer to page of results using offset.
|
|
139
138
|
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
@@ -149,14 +148,14 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
149
148
|
sort?: Sorting[];
|
|
150
149
|
}
|
|
151
150
|
/** @oneof */
|
|
152
|
-
|
|
151
|
+
interface QueryV2PagingMethodOneOf {
|
|
153
152
|
/**
|
|
154
153
|
* Pointer to page of results using offset.
|
|
155
154
|
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
156
155
|
*/
|
|
157
156
|
paging?: Paging;
|
|
158
157
|
}
|
|
159
|
-
|
|
158
|
+
interface Sorting {
|
|
160
159
|
/**
|
|
161
160
|
* Name of the field to sort by
|
|
162
161
|
* @maxLength 100
|
|
@@ -165,11 +164,11 @@ export interface Sorting {
|
|
|
165
164
|
/** Sort order (ASC/DESC). Defaults to ASC */
|
|
166
165
|
order?: SortOrder;
|
|
167
166
|
}
|
|
168
|
-
|
|
167
|
+
declare enum SortOrder {
|
|
169
168
|
ASC = "ASC",
|
|
170
169
|
DESC = "DESC"
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface Paging {
|
|
173
172
|
/**
|
|
174
173
|
* Number of items to load per page.
|
|
175
174
|
* @max 1000
|
|
@@ -178,17 +177,17 @@ export interface Paging {
|
|
|
178
177
|
/** Number of items to skip in the current sort order. */
|
|
179
178
|
offset?: number | null;
|
|
180
179
|
}
|
|
181
|
-
|
|
180
|
+
declare enum CategoryFieldset {
|
|
182
181
|
/** Include `assignedEventsCount` in the response. */
|
|
183
182
|
COUNTS = "COUNTS"
|
|
184
183
|
}
|
|
185
|
-
|
|
184
|
+
interface QueryCategoriesResponse {
|
|
186
185
|
/** List of categories. */
|
|
187
186
|
categories?: Category[];
|
|
188
187
|
/** Metadata for the paginated results. */
|
|
189
188
|
metaData?: PagingMetadataV2;
|
|
190
189
|
}
|
|
191
|
-
|
|
190
|
+
interface PagingMetadataV2 {
|
|
192
191
|
/** Number of items returned in the response. */
|
|
193
192
|
count?: number | null;
|
|
194
193
|
/** Offset that was requested. */
|
|
@@ -200,7 +199,7 @@ export interface PagingMetadataV2 {
|
|
|
200
199
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
201
200
|
cursors?: Cursors;
|
|
202
201
|
}
|
|
203
|
-
|
|
202
|
+
interface Cursors {
|
|
204
203
|
/**
|
|
205
204
|
* Cursor string pointing to the next page in the list of results.
|
|
206
205
|
* @maxLength 16000
|
|
@@ -212,7 +211,7 @@ export interface Cursors {
|
|
|
212
211
|
*/
|
|
213
212
|
prev?: string | null;
|
|
214
213
|
}
|
|
215
|
-
|
|
214
|
+
interface AssignEventsRequest {
|
|
216
215
|
/**
|
|
217
216
|
* ID of category to which events should be assigned.
|
|
218
217
|
* @format GUID
|
|
@@ -226,9 +225,9 @@ export interface AssignEventsRequest {
|
|
|
226
225
|
*/
|
|
227
226
|
eventId: string[];
|
|
228
227
|
}
|
|
229
|
-
|
|
228
|
+
interface AssignEventsResponse {
|
|
230
229
|
}
|
|
231
|
-
|
|
230
|
+
interface BulkAssignEventsRequest {
|
|
232
231
|
/**
|
|
233
232
|
* A list of category IDs to which events should be assigned.
|
|
234
233
|
* @format GUID
|
|
@@ -244,13 +243,13 @@ export interface BulkAssignEventsRequest {
|
|
|
244
243
|
*/
|
|
245
244
|
eventId: string[];
|
|
246
245
|
}
|
|
247
|
-
|
|
246
|
+
interface BulkAssignEventsResponse {
|
|
248
247
|
/** Bulk assign results. */
|
|
249
248
|
results?: BulkCategoryResult[];
|
|
250
249
|
/** Metadata of results. */
|
|
251
250
|
bulkActionMetadata?: BulkActionMetadata;
|
|
252
251
|
}
|
|
253
|
-
|
|
252
|
+
interface BulkAssignEventsAsyncRequest {
|
|
254
253
|
/**
|
|
255
254
|
* Category IDs.
|
|
256
255
|
* @format GUID
|
|
@@ -258,12 +257,16 @@ export interface BulkAssignEventsAsyncRequest {
|
|
|
258
257
|
* @maxSize 10
|
|
259
258
|
*/
|
|
260
259
|
categoryId: string[];
|
|
261
|
-
/**
|
|
260
|
+
/**
|
|
261
|
+
* Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:
|
|
262
|
+
* - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
263
|
+
* - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
264
|
+
*/
|
|
262
265
|
filter: Record<string, any> | null;
|
|
263
266
|
}
|
|
264
|
-
|
|
267
|
+
interface BulkAssignEventsAsyncResponse {
|
|
265
268
|
}
|
|
266
|
-
|
|
269
|
+
interface UnassignEventsRequest {
|
|
267
270
|
/**
|
|
268
271
|
* Category ID.
|
|
269
272
|
* @format GUID
|
|
@@ -277,9 +280,9 @@ export interface UnassignEventsRequest {
|
|
|
277
280
|
*/
|
|
278
281
|
eventId: string[];
|
|
279
282
|
}
|
|
280
|
-
|
|
283
|
+
interface UnassignEventsResponse {
|
|
281
284
|
}
|
|
282
|
-
|
|
285
|
+
interface BulkUnassignEventsRequest {
|
|
283
286
|
/**
|
|
284
287
|
* A list of category IDs.
|
|
285
288
|
* @format GUID
|
|
@@ -295,13 +298,13 @@ export interface BulkUnassignEventsRequest {
|
|
|
295
298
|
*/
|
|
296
299
|
eventId?: string[];
|
|
297
300
|
}
|
|
298
|
-
|
|
301
|
+
interface BulkUnassignEventsResponse {
|
|
299
302
|
/** Results. */
|
|
300
303
|
results?: BulkCategoryResult[];
|
|
301
|
-
/** Metadata. */
|
|
304
|
+
/** Metadata of results. */
|
|
302
305
|
bulkActionMetadata?: BulkActionMetadata;
|
|
303
306
|
}
|
|
304
|
-
|
|
307
|
+
interface BulkUnassignEventsAsyncRequest {
|
|
305
308
|
/**
|
|
306
309
|
* Category ID.
|
|
307
310
|
* @format GUID
|
|
@@ -309,23 +312,27 @@ export interface BulkUnassignEventsAsyncRequest {
|
|
|
309
312
|
* @maxSize 10
|
|
310
313
|
*/
|
|
311
314
|
categoryId: string[];
|
|
312
|
-
/**
|
|
315
|
+
/**
|
|
316
|
+
* Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:
|
|
317
|
+
* - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
318
|
+
* - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
319
|
+
*/
|
|
313
320
|
filter: Record<string, any> | null;
|
|
314
321
|
}
|
|
315
|
-
|
|
322
|
+
interface BulkUnassignEventsAsyncResponse {
|
|
316
323
|
}
|
|
317
|
-
|
|
324
|
+
interface ListEventCategoriesRequest {
|
|
318
325
|
/**
|
|
319
326
|
* Event ID.
|
|
320
327
|
* @format GUID
|
|
321
328
|
*/
|
|
322
329
|
eventId: string;
|
|
323
330
|
}
|
|
324
|
-
|
|
331
|
+
interface ListEventCategoriesResponse {
|
|
325
332
|
/** A list of categories. */
|
|
326
333
|
categories?: Category[];
|
|
327
334
|
}
|
|
328
|
-
|
|
335
|
+
interface ReorderCategoryEventsRequest extends ReorderCategoryEventsRequestReferenceEventOneOf {
|
|
329
336
|
/**
|
|
330
337
|
* Move the event before defined `eventId`.
|
|
331
338
|
* @format GUID
|
|
@@ -348,7 +355,7 @@ export interface ReorderCategoryEventsRequest extends ReorderCategoryEventsReque
|
|
|
348
355
|
eventId?: string;
|
|
349
356
|
}
|
|
350
357
|
/** @oneof */
|
|
351
|
-
|
|
358
|
+
interface ReorderCategoryEventsRequestReferenceEventOneOf {
|
|
352
359
|
/**
|
|
353
360
|
* Move the event before defined `eventId`.
|
|
354
361
|
* @format GUID
|
|
@@ -360,9 +367,9 @@ export interface ReorderCategoryEventsRequestReferenceEventOneOf {
|
|
|
360
367
|
*/
|
|
361
368
|
afterEventId?: string;
|
|
362
369
|
}
|
|
363
|
-
|
|
370
|
+
interface ReorderCategoryEventsResponse {
|
|
364
371
|
}
|
|
365
|
-
|
|
372
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
366
373
|
createdEvent?: EntityCreatedEvent;
|
|
367
374
|
updatedEvent?: EntityUpdatedEvent;
|
|
368
375
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -371,7 +378,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
371
378
|
* Unique event ID.
|
|
372
379
|
* Allows clients to ignore duplicate webhooks.
|
|
373
380
|
*/
|
|
374
|
-
|
|
381
|
+
_id?: string;
|
|
375
382
|
/**
|
|
376
383
|
* Assumes actions are also always typed to an entity_type
|
|
377
384
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -405,36 +412,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
405
412
|
entityEventSequence?: string | null;
|
|
406
413
|
}
|
|
407
414
|
/** @oneof */
|
|
408
|
-
|
|
415
|
+
interface DomainEventBodyOneOf {
|
|
409
416
|
createdEvent?: EntityCreatedEvent;
|
|
410
417
|
updatedEvent?: EntityUpdatedEvent;
|
|
411
418
|
deletedEvent?: EntityDeletedEvent;
|
|
412
419
|
actionEvent?: ActionEvent;
|
|
413
420
|
}
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
417
|
-
restoreInfo?: RestoreInfo;
|
|
421
|
+
interface EntityCreatedEvent {
|
|
422
|
+
entity?: string;
|
|
418
423
|
}
|
|
419
|
-
|
|
424
|
+
interface RestoreInfo {
|
|
420
425
|
deletedDate?: Date | null;
|
|
421
426
|
}
|
|
422
|
-
|
|
427
|
+
interface EntityUpdatedEvent {
|
|
423
428
|
/**
|
|
424
429
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
425
430
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
426
431
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
427
432
|
*/
|
|
428
|
-
|
|
433
|
+
currentEntity?: string;
|
|
429
434
|
}
|
|
430
|
-
|
|
435
|
+
interface EntityDeletedEvent {
|
|
431
436
|
/** Entity that was deleted */
|
|
432
|
-
|
|
437
|
+
deletedEntity?: string | null;
|
|
433
438
|
}
|
|
434
|
-
|
|
435
|
-
|
|
439
|
+
interface ActionEvent {
|
|
440
|
+
body?: string;
|
|
436
441
|
}
|
|
437
|
-
|
|
442
|
+
interface MessageEnvelope {
|
|
438
443
|
/**
|
|
439
444
|
* App instance ID.
|
|
440
445
|
* @format GUID
|
|
@@ -450,7 +455,7 @@ export interface MessageEnvelope {
|
|
|
450
455
|
/** Stringify payload. */
|
|
451
456
|
data?: string;
|
|
452
457
|
}
|
|
453
|
-
|
|
458
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
454
459
|
/**
|
|
455
460
|
* ID of a site visitor that has not logged in to the site.
|
|
456
461
|
* @format GUID
|
|
@@ -475,7 +480,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
475
480
|
identityType?: WebhookIdentityType;
|
|
476
481
|
}
|
|
477
482
|
/** @oneof */
|
|
478
|
-
|
|
483
|
+
interface IdentificationDataIdOneOf {
|
|
479
484
|
/**
|
|
480
485
|
* ID of a site visitor that has not logged in to the site.
|
|
481
486
|
* @format GUID
|
|
@@ -497,58 +502,155 @@ export interface IdentificationDataIdOneOf {
|
|
|
497
502
|
*/
|
|
498
503
|
appId?: string;
|
|
499
504
|
}
|
|
500
|
-
|
|
505
|
+
declare enum WebhookIdentityType {
|
|
501
506
|
UNKNOWN = "UNKNOWN",
|
|
502
507
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
503
508
|
MEMBER = "MEMBER",
|
|
504
509
|
WIX_USER = "WIX_USER",
|
|
505
510
|
APP = "APP"
|
|
506
511
|
}
|
|
507
|
-
interface
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
512
|
+
interface UpdateCategory {
|
|
513
|
+
/**
|
|
514
|
+
* Category ID.
|
|
515
|
+
* @format GUID
|
|
516
|
+
* @readonly
|
|
517
|
+
*/
|
|
518
|
+
_id?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Category name.
|
|
521
|
+
* @minLength 1
|
|
522
|
+
* @maxLength 30
|
|
523
|
+
*/
|
|
524
|
+
name?: string;
|
|
525
|
+
/**
|
|
526
|
+
* Date and time when category was created.
|
|
527
|
+
* @readonly
|
|
528
|
+
*/
|
|
529
|
+
_createdDate?: Date | null;
|
|
530
|
+
/**
|
|
531
|
+
* The total number of draft and published events assigned to the category.
|
|
532
|
+
* @readonly
|
|
533
|
+
*/
|
|
534
|
+
counts?: CategoryCounts;
|
|
535
|
+
/**
|
|
536
|
+
* Category state. Possible values:
|
|
537
|
+
* - `MANUAL`: Category is created manually by the user.
|
|
538
|
+
* - `AUTO`: Category is created automatically.
|
|
539
|
+
* - `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
|
|
540
|
+
* - `HIDDEN`: Category can't be seen.
|
|
541
|
+
*
|
|
542
|
+
* Default: `MANUAL`.
|
|
543
|
+
*
|
|
544
|
+
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission is required to use states other than `MANUAL`.
|
|
545
|
+
* @maxSize 3
|
|
546
|
+
*/
|
|
547
|
+
states?: State[];
|
|
532
548
|
}
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
549
|
+
interface QueryCategoriesOptions {
|
|
550
|
+
/**
|
|
551
|
+
* Predefined sets of fields to return.
|
|
552
|
+
* - `COUNTS`: Returns `assignedEventsCount`.
|
|
553
|
+
* @maxSize 1
|
|
554
|
+
*/
|
|
555
|
+
fieldset?: CategoryFieldset[] | undefined;
|
|
556
|
+
}
|
|
557
|
+
interface QueryOffsetResult {
|
|
558
|
+
currentPage: number | undefined;
|
|
559
|
+
totalPages: number | undefined;
|
|
560
|
+
totalCount: number | undefined;
|
|
561
|
+
hasNext: () => boolean;
|
|
562
|
+
hasPrev: () => boolean;
|
|
563
|
+
length: number;
|
|
564
|
+
pageSize: number;
|
|
565
|
+
}
|
|
566
|
+
interface CategoriesQueryResult extends QueryOffsetResult {
|
|
567
|
+
items: Category[];
|
|
568
|
+
query: CategoriesQueryBuilder;
|
|
569
|
+
next: () => Promise<CategoriesQueryResult>;
|
|
570
|
+
prev: () => Promise<CategoriesQueryResult>;
|
|
571
|
+
}
|
|
572
|
+
interface CategoriesQueryBuilder {
|
|
573
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
574
|
+
* @param value - Value to compare against.
|
|
575
|
+
*/
|
|
576
|
+
eq: (propertyName: '_id' | 'name', value: any) => CategoriesQueryBuilder;
|
|
577
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
578
|
+
* @param values - List of values to compare against.
|
|
579
|
+
*/
|
|
580
|
+
hasSome: (propertyName: 'states', value: any[]) => CategoriesQueryBuilder;
|
|
581
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
582
|
+
ascending: (...propertyNames: Array<'_createdDate'>) => CategoriesQueryBuilder;
|
|
583
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
584
|
+
descending: (...propertyNames: Array<'_createdDate'>) => CategoriesQueryBuilder;
|
|
585
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
586
|
+
limit: (limit: number) => CategoriesQueryBuilder;
|
|
587
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
588
|
+
skip: (skip: number) => CategoriesQueryBuilder;
|
|
589
|
+
find: () => Promise<CategoriesQueryResult>;
|
|
590
|
+
}
|
|
591
|
+
interface BulkAssignEventsOptions {
|
|
592
|
+
/**
|
|
593
|
+
* A list of events IDs.
|
|
594
|
+
* @format GUID
|
|
595
|
+
* @minSize 1
|
|
596
|
+
* @maxSize 1
|
|
597
|
+
*/
|
|
598
|
+
eventId: string[];
|
|
536
599
|
}
|
|
537
|
-
|
|
538
|
-
|
|
600
|
+
interface BulkAssignEventsAsyncOptions {
|
|
601
|
+
/**
|
|
602
|
+
* Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:
|
|
603
|
+
* - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
604
|
+
* - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
605
|
+
*/
|
|
606
|
+
filter: Record<string, any> | null;
|
|
539
607
|
}
|
|
540
|
-
|
|
541
|
-
|
|
608
|
+
interface BulkUnassignEventsOptions {
|
|
609
|
+
/**
|
|
610
|
+
* A list of events IDs.
|
|
611
|
+
* @format GUID
|
|
612
|
+
* @minSize 1
|
|
613
|
+
* @maxSize 1
|
|
614
|
+
*/
|
|
615
|
+
eventId?: string[];
|
|
542
616
|
}
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
617
|
+
interface BulkUnassignEventsAsyncOptions {
|
|
618
|
+
/**
|
|
619
|
+
* Criteria that must be met for an event to be considered for the bulk assign. Supported filters for this API:
|
|
620
|
+
* - `_id`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
621
|
+
* - `name`: [`eq()`](https://www.wix.com/velo/reference/wix-events-v2/categories/categoriesquerybuilder/eq)
|
|
622
|
+
*/
|
|
623
|
+
filter: Record<string, any> | null;
|
|
546
624
|
}
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
625
|
+
interface ReorderCategoryEventsOptions extends ReorderCategoryEventsOptionsReferenceEventOneOf {
|
|
626
|
+
/**
|
|
627
|
+
* Event ID.
|
|
628
|
+
* @format GUID
|
|
629
|
+
*/
|
|
630
|
+
eventId?: string;
|
|
631
|
+
/**
|
|
632
|
+
* Move the event before defined `eventId`.
|
|
633
|
+
* @format GUID
|
|
634
|
+
*/
|
|
635
|
+
beforeEventId?: string;
|
|
636
|
+
/**
|
|
637
|
+
* Move the event after defined `eventId`.
|
|
638
|
+
* @format GUID
|
|
639
|
+
*/
|
|
640
|
+
afterEventId?: string;
|
|
550
641
|
}
|
|
551
|
-
|
|
552
|
-
|
|
642
|
+
/** @oneof */
|
|
643
|
+
interface ReorderCategoryEventsOptionsReferenceEventOneOf {
|
|
644
|
+
/**
|
|
645
|
+
* Move the event before defined `eventId`.
|
|
646
|
+
* @format GUID
|
|
647
|
+
*/
|
|
648
|
+
beforeEventId?: string;
|
|
649
|
+
/**
|
|
650
|
+
* Move the event after defined `eventId`.
|
|
651
|
+
* @format GUID
|
|
652
|
+
*/
|
|
653
|
+
afterEventId?: string;
|
|
553
654
|
}
|
|
554
|
-
|
|
655
|
+
|
|
656
|
+
export { type EntityCreatedEvent as $, type ApplicationError as A, type BulkCreateCategoryResponse as B, type Category as C, type DeleteCategoryRequest as D, type AssignEventsResponse as E, type BulkAssignEventsRequest as F, type BulkAssignEventsAsyncRequest as G, type BulkAssignEventsAsyncResponse as H, type ItemMetadata as I, type UnassignEventsRequest as J, type UnassignEventsResponse as K, type ListEventCategoriesResponse as L, type BulkUnassignEventsRequest as M, type BulkUnassignEventsAsyncRequest as N, type BulkUnassignEventsAsyncResponse as O, type Paging as P, type QueryCategoriesOptions as Q, type ReorderCategoryEventsOptions as R, State as S, type ListEventCategoriesRequest as T, type UpdateCategory as U, type ReorderCategoryEventsRequest as V, WebhookIdentityType as W, type ReorderCategoryEventsRequestReferenceEventOneOf as X, type ReorderCategoryEventsResponse as Y, type DomainEvent as Z, type DomainEventBodyOneOf as _, type CategoriesQueryBuilder as a, type RestoreInfo as a0, type EntityUpdatedEvent as a1, type EntityDeletedEvent as a2, type ActionEvent as a3, type MessageEnvelope as a4, type IdentificationData as a5, type IdentificationDataIdOneOf as a6, type CategoriesQueryResult as a7, type ReorderCategoryEventsOptionsReferenceEventOneOf as a8, type BulkAssignEventsOptions as b, type BulkAssignEventsResponse as c, type BulkAssignEventsAsyncOptions as d, type BulkUnassignEventsOptions as e, type BulkUnassignEventsResponse as f, type BulkUnassignEventsAsyncOptions as g, SortOrder as h, CategoryFieldset as i, type CategoryCounts as j, type CreateCategoryRequest as k, type CreateCategoryResponse as l, type BulkCreateCategoryRequest as m, type BulkCategoryResult as n, type BulkActionMetadata as o, type UpdateCategoryRequest as p, type UpdateCategoryResponse as q, type DeleteCategoryResponse as r, type QueryCategoriesRequest as s, type QueryV2 as t, type QueryV2PagingMethodOneOf as u, type Sorting as v, type QueryCategoriesResponse as w, type PagingMetadataV2 as x, type Cursors as y, type AssignEventsRequest as z };
|