@wix/auto_sdk_members_user-member 1.0.18 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +25 -1
- package/build/cjs/index.js +239 -15
- package/build/cjs/index.js.map +1 -1
- package/build/{internal/cjs/src/members-usermembers-v1-user-member-user-member.universal.d.ts → cjs/members-usermembers-v1-user-member-user-member.universal-BTMQfAFl.d.ts} +63 -83
- package/build/cjs/meta.d.ts +226 -1
- package/build/cjs/meta.js +97 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +25 -0
- package/build/es/index.mjs +210 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/members-usermembers-v1-user-member-user-member.universal.d.ts → es/members-usermembers-v1-user-member-user-member.universal-BTMQfAFl.d.mts} +63 -83
- package/build/es/meta.d.mts +226 -0
- package/build/es/meta.mjs +73 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +25 -1
- package/build/internal/cjs/index.js +239 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/{es/src/members-usermembers-v1-user-member-user-member.universal.d.ts → cjs/members-usermembers-v1-user-member-user-member.universal-BTMQfAFl.d.ts} +63 -83
- package/build/internal/cjs/meta.d.ts +226 -1
- package/build/internal/cjs/meta.js +97 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +25 -0
- package/build/internal/es/index.mjs +210 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{es/src/members-usermembers-v1-user-member-user-member.universal.d.ts → internal/es/members-usermembers-v1-user-member-user-member.universal-BTMQfAFl.d.mts} +63 -83
- package/build/internal/es/meta.d.mts +226 -0
- package/build/internal/es/meta.mjs +73 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- 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/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.context.js +0 -16
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.js +0 -66
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.js +0 -47
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.js +0 -21
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.js +0 -156
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.universal.js +0 -249
- package/build/cjs/src/members-usermembers-v1-user-member-user-member.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/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
- package/build/es/src/members-usermembers-v1-user-member-user-member.context.js +0 -5
- package/build/es/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
- package/build/es/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
- package/build/es/src/members-usermembers-v1-user-member-user-member.http.js +0 -62
- package/build/es/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
- package/build/es/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
- package/build/es/src/members-usermembers-v1-user-member-user-member.meta.js +0 -20
- package/build/es/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
- package/build/es/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
- package/build/es/src/members-usermembers-v1-user-member-user-member.public.js +0 -9
- package/build/es/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
- package/build/es/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
- package/build/es/src/members-usermembers-v1-user-member-user-member.types.js +0 -153
- package/build/es/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
- package/build/es/src/members-usermembers-v1-user-member-user-member.universal.js +0 -222
- package/build/es/src/members-usermembers-v1-user-member-user-member.universal.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/src/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.context.js +0 -16
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.js +0 -66
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.js +0 -47
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.public.js +0 -21
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.js +0 -156
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.universal.js +0 -249
- package/build/internal/cjs/src/members-usermembers-v1-user-member-user-member.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/members-usermembers-v1-user-member-user-member.context.d.ts +0 -5
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.context.js +0 -5
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.context.js.map +0 -1
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.d.ts +0 -15
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.js +0 -62
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.http.js.map +0 -1
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.d.ts +0 -13
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.js +0 -20
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.meta.js.map +0 -1
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.d.ts +0 -23
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.js +0 -9
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.public.js.map +0 -1
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.d.ts +0 -733
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.js +0 -153
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.types.js.map +0 -1
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.universal.js +0 -222
- package/build/internal/es/src/members-usermembers-v1-user-member-user-member.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface UserMember {
|
|
2
2
|
/**
|
|
3
3
|
* Profile ID.
|
|
4
4
|
* @format GUID
|
|
@@ -62,7 +62,7 @@ export interface UserMember {
|
|
|
62
62
|
*/
|
|
63
63
|
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
64
64
|
}
|
|
65
|
-
|
|
65
|
+
interface Image {
|
|
66
66
|
/**
|
|
67
67
|
* Wix Media image ID,
|
|
68
68
|
* set when the member selects an image from Wix Media.
|
|
@@ -87,7 +87,7 @@ export interface Image {
|
|
|
87
87
|
*/
|
|
88
88
|
offsetY?: number | null;
|
|
89
89
|
}
|
|
90
|
-
|
|
90
|
+
declare enum PrivacyStatusStatus {
|
|
91
91
|
/** Unknown status. This value isn't used. */
|
|
92
92
|
UNKNOWN = "UNKNOWN",
|
|
93
93
|
/** User member is hidden from everyone who visits the site. The member is returned only to Wix users and apps with the appropriate permissions. */
|
|
@@ -96,8 +96,8 @@ export declare enum PrivacyStatusStatus {
|
|
|
96
96
|
PUBLIC = "PUBLIC"
|
|
97
97
|
}
|
|
98
98
|
/** @enumType */
|
|
99
|
-
|
|
100
|
-
|
|
99
|
+
type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
|
|
100
|
+
declare enum Status {
|
|
101
101
|
/** Unknown status. This value isn't used. */
|
|
102
102
|
UNKNOWN = "UNKNOWN",
|
|
103
103
|
/** User member is created and is waiting for the approval. */
|
|
@@ -110,8 +110,8 @@ export declare enum Status {
|
|
|
110
110
|
OFFLINE = "OFFLINE"
|
|
111
111
|
}
|
|
112
112
|
/** @enumType */
|
|
113
|
-
|
|
114
|
-
|
|
113
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
|
|
114
|
+
declare enum ActivityStatusStatus {
|
|
115
115
|
/** Unknown status. This value isn't used. */
|
|
116
116
|
UNKNOWN = "UNKNOWN",
|
|
117
117
|
/** User member can participate in site activities, such as writing blog posts and forum comments. */
|
|
@@ -120,12 +120,12 @@ export declare enum ActivityStatusStatus {
|
|
|
120
120
|
MUTED = "MUTED"
|
|
121
121
|
}
|
|
122
122
|
/** @enumType */
|
|
123
|
-
|
|
124
|
-
|
|
123
|
+
type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
124
|
+
interface QueryUserMembersRequest {
|
|
125
125
|
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
126
126
|
query?: CursorQuery;
|
|
127
127
|
}
|
|
128
|
-
|
|
128
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
129
129
|
/** 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`. */
|
|
130
130
|
cursorPaging?: CursorPaging;
|
|
131
131
|
/**
|
|
@@ -144,25 +144,25 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
144
144
|
sort?: Sorting[];
|
|
145
145
|
}
|
|
146
146
|
/** @oneof */
|
|
147
|
-
|
|
147
|
+
interface CursorQueryPagingMethodOneOf {
|
|
148
148
|
/** 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`. */
|
|
149
149
|
cursorPaging?: CursorPaging;
|
|
150
150
|
}
|
|
151
|
-
|
|
151
|
+
interface Sorting {
|
|
152
152
|
/** Name of the field to sort by. */
|
|
153
153
|
fieldName?: string;
|
|
154
154
|
/** Sort order. */
|
|
155
155
|
order?: SortOrderWithLiterals;
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
declare enum SortOrder {
|
|
158
158
|
/** Sorting is in ascending order. */
|
|
159
159
|
ASC = "ASC",
|
|
160
160
|
/** Sorting is in descending order. */
|
|
161
161
|
DESC = "DESC"
|
|
162
162
|
}
|
|
163
163
|
/** @enumType */
|
|
164
|
-
|
|
165
|
-
|
|
164
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
165
|
+
interface CursorPaging {
|
|
166
166
|
/**
|
|
167
167
|
* Number of items to load.
|
|
168
168
|
* @max 100
|
|
@@ -177,13 +177,13 @@ export interface CursorPaging {
|
|
|
177
177
|
*/
|
|
178
178
|
cursor?: string | null;
|
|
179
179
|
}
|
|
180
|
-
|
|
180
|
+
interface QueryUserMembersResponse {
|
|
181
181
|
/** Retrieved user members. */
|
|
182
182
|
userMembers?: UserMember[];
|
|
183
183
|
/** Metadata for the paginated results. */
|
|
184
184
|
metadata?: CursorPagingMetadata;
|
|
185
185
|
}
|
|
186
|
-
|
|
186
|
+
interface CursorPagingMetadata {
|
|
187
187
|
/** Number of items returned in current page. */
|
|
188
188
|
count?: number | null;
|
|
189
189
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -196,7 +196,7 @@ export interface CursorPagingMetadata {
|
|
|
196
196
|
*/
|
|
197
197
|
hasNext?: boolean | null;
|
|
198
198
|
}
|
|
199
|
-
|
|
199
|
+
interface Cursors {
|
|
200
200
|
/**
|
|
201
201
|
* Cursor string pointing to the next page in the list of results.
|
|
202
202
|
* @maxLength 16000
|
|
@@ -208,7 +208,7 @@ export interface Cursors {
|
|
|
208
208
|
*/
|
|
209
209
|
prev?: string | null;
|
|
210
210
|
}
|
|
211
|
-
|
|
211
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
212
212
|
createdEvent?: EntityCreatedEvent;
|
|
213
213
|
updatedEvent?: EntityUpdatedEvent;
|
|
214
214
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -243,19 +243,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
243
243
|
entityEventSequence?: string | null;
|
|
244
244
|
}
|
|
245
245
|
/** @oneof */
|
|
246
|
-
|
|
246
|
+
interface DomainEventBodyOneOf {
|
|
247
247
|
createdEvent?: EntityCreatedEvent;
|
|
248
248
|
updatedEvent?: EntityUpdatedEvent;
|
|
249
249
|
deletedEvent?: EntityDeletedEvent;
|
|
250
250
|
actionEvent?: ActionEvent;
|
|
251
251
|
}
|
|
252
|
-
|
|
252
|
+
interface EntityCreatedEvent {
|
|
253
253
|
entity?: string;
|
|
254
254
|
}
|
|
255
|
-
|
|
255
|
+
interface RestoreInfo {
|
|
256
256
|
deletedDate?: Date | null;
|
|
257
257
|
}
|
|
258
|
-
|
|
258
|
+
interface EntityUpdatedEvent {
|
|
259
259
|
/**
|
|
260
260
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
261
261
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -263,16 +263,16 @@ export interface EntityUpdatedEvent {
|
|
|
263
263
|
*/
|
|
264
264
|
currentEntity?: string;
|
|
265
265
|
}
|
|
266
|
-
|
|
266
|
+
interface EntityDeletedEvent {
|
|
267
267
|
/** Entity that was deleted. */
|
|
268
268
|
deletedEntity?: string | null;
|
|
269
269
|
}
|
|
270
|
-
|
|
270
|
+
interface ActionEvent {
|
|
271
271
|
body?: string;
|
|
272
272
|
}
|
|
273
|
-
|
|
273
|
+
interface Empty {
|
|
274
274
|
}
|
|
275
|
-
|
|
275
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
276
276
|
/** Emitted on a meta site creation. */
|
|
277
277
|
siteCreated?: SiteCreated;
|
|
278
278
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -338,7 +338,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
338
338
|
assets?: Asset[];
|
|
339
339
|
}
|
|
340
340
|
/** @oneof */
|
|
341
|
-
|
|
341
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
342
342
|
/** Emitted on a meta site creation. */
|
|
343
343
|
siteCreated?: SiteCreated;
|
|
344
344
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -388,7 +388,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
388
388
|
/** Emitted when Picasso is detached. */
|
|
389
389
|
picassoUnassigned?: PicassoUnassigned;
|
|
390
390
|
}
|
|
391
|
-
|
|
391
|
+
interface Asset {
|
|
392
392
|
/**
|
|
393
393
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
394
394
|
* @maxLength 36
|
|
@@ -402,7 +402,7 @@ export interface Asset {
|
|
|
402
402
|
/** An application state. */
|
|
403
403
|
state?: StateWithLiterals;
|
|
404
404
|
}
|
|
405
|
-
|
|
405
|
+
declare enum State {
|
|
406
406
|
UNKNOWN = "UNKNOWN",
|
|
407
407
|
ENABLED = "ENABLED",
|
|
408
408
|
DISABLED = "DISABLED",
|
|
@@ -410,8 +410,8 @@ export declare enum State {
|
|
|
410
410
|
DEMO = "DEMO"
|
|
411
411
|
}
|
|
412
412
|
/** @enumType */
|
|
413
|
-
|
|
414
|
-
|
|
413
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
414
|
+
interface SiteCreated {
|
|
415
415
|
/**
|
|
416
416
|
* A template identifier (empty if not created from a template).
|
|
417
417
|
* @maxLength 36
|
|
@@ -440,7 +440,7 @@ export interface SiteCreated {
|
|
|
440
440
|
/** A namespace. */
|
|
441
441
|
namespace?: NamespaceWithLiterals;
|
|
442
442
|
}
|
|
443
|
-
|
|
443
|
+
declare enum SiteCreatedContext {
|
|
444
444
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
445
445
|
OTHER = "OTHER",
|
|
446
446
|
/** A meta site was created from template. */
|
|
@@ -455,8 +455,8 @@ export declare enum SiteCreatedContext {
|
|
|
455
455
|
FLASH = "FLASH"
|
|
456
456
|
}
|
|
457
457
|
/** @enumType */
|
|
458
|
-
|
|
459
|
-
|
|
458
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
459
|
+
declare enum Namespace {
|
|
460
460
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
461
461
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
462
462
|
WIX = "WIX",
|
|
@@ -539,9 +539,9 @@ export declare enum Namespace {
|
|
|
539
539
|
MIMIR = "MIMIR"
|
|
540
540
|
}
|
|
541
541
|
/** @enumType */
|
|
542
|
-
|
|
542
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
543
543
|
/** Site transferred to another user. */
|
|
544
|
-
|
|
544
|
+
interface SiteTransferred {
|
|
545
545
|
/**
|
|
546
546
|
* A previous owner id (user that transfers meta site).
|
|
547
547
|
* @format GUID
|
|
@@ -554,11 +554,11 @@ export interface SiteTransferred {
|
|
|
554
554
|
newOwnerId?: string;
|
|
555
555
|
}
|
|
556
556
|
/** Soft deletion of the meta site. Could be restored. */
|
|
557
|
-
|
|
557
|
+
interface SiteDeleted {
|
|
558
558
|
/** A deletion context. */
|
|
559
559
|
deleteContext?: DeleteContext;
|
|
560
560
|
}
|
|
561
|
-
|
|
561
|
+
interface DeleteContext {
|
|
562
562
|
/** When the meta site was deleted. */
|
|
563
563
|
dateDeleted?: Date | null;
|
|
564
564
|
/** A status. */
|
|
@@ -574,7 +574,7 @@ export interface DeleteContext {
|
|
|
574
574
|
*/
|
|
575
575
|
initiatorId?: string | null;
|
|
576
576
|
}
|
|
577
|
-
|
|
577
|
+
declare enum DeleteStatus {
|
|
578
578
|
UNKNOWN = "UNKNOWN",
|
|
579
579
|
TRASH = "TRASH",
|
|
580
580
|
DELETED = "DELETED",
|
|
@@ -582,14 +582,14 @@ export declare enum DeleteStatus {
|
|
|
582
582
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
583
583
|
}
|
|
584
584
|
/** @enumType */
|
|
585
|
-
|
|
585
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
586
586
|
/** Restoration of the meta site. */
|
|
587
|
-
|
|
587
|
+
interface SiteUndeleted {
|
|
588
588
|
}
|
|
589
589
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
590
|
-
|
|
590
|
+
interface SitePublished {
|
|
591
591
|
}
|
|
592
|
-
|
|
592
|
+
interface SiteUnpublished {
|
|
593
593
|
/**
|
|
594
594
|
* A list of URLs previously associated with the meta site.
|
|
595
595
|
* @maxLength 4000
|
|
@@ -597,9 +597,9 @@ export interface SiteUnpublished {
|
|
|
597
597
|
*/
|
|
598
598
|
urls?: string[];
|
|
599
599
|
}
|
|
600
|
-
|
|
600
|
+
interface SiteMarkedAsTemplate {
|
|
601
601
|
}
|
|
602
|
-
|
|
602
|
+
interface SiteMarkedAsWixSite {
|
|
603
603
|
}
|
|
604
604
|
/**
|
|
605
605
|
* Represents a service provisioned a site.
|
|
@@ -616,7 +616,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
616
616
|
* changes made to the original template afterward.
|
|
617
617
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
618
618
|
*/
|
|
619
|
-
|
|
619
|
+
interface ServiceProvisioned {
|
|
620
620
|
/**
|
|
621
621
|
* Either UUID or EmbeddedServiceType.
|
|
622
622
|
* @maxLength 36
|
|
@@ -643,7 +643,7 @@ export interface ServiceProvisioned {
|
|
|
643
643
|
*/
|
|
644
644
|
originMetaSiteId?: string | null;
|
|
645
645
|
}
|
|
646
|
-
|
|
646
|
+
interface ServiceRemoved {
|
|
647
647
|
/**
|
|
648
648
|
* Either UUID or EmbeddedServiceType.
|
|
649
649
|
* @maxLength 36
|
|
@@ -661,7 +661,7 @@ export interface ServiceRemoved {
|
|
|
661
661
|
version?: string | null;
|
|
662
662
|
}
|
|
663
663
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
664
|
-
|
|
664
|
+
interface SiteRenamed {
|
|
665
665
|
/**
|
|
666
666
|
* A new meta site name (URL slug).
|
|
667
667
|
* @maxLength 20
|
|
@@ -678,21 +678,21 @@ export interface SiteRenamed {
|
|
|
678
678
|
*
|
|
679
679
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
680
680
|
*/
|
|
681
|
-
|
|
681
|
+
interface SiteHardDeleted {
|
|
682
682
|
/** A deletion context. */
|
|
683
683
|
deleteContext?: DeleteContext;
|
|
684
684
|
}
|
|
685
|
-
|
|
685
|
+
interface NamespaceChanged {
|
|
686
686
|
/** A previous namespace. */
|
|
687
687
|
oldNamespace?: NamespaceWithLiterals;
|
|
688
688
|
/** A new namespace. */
|
|
689
689
|
newNamespace?: NamespaceWithLiterals;
|
|
690
690
|
}
|
|
691
691
|
/** Assigned Studio editor */
|
|
692
|
-
|
|
692
|
+
interface StudioAssigned {
|
|
693
693
|
}
|
|
694
694
|
/** Unassigned Studio editor */
|
|
695
|
-
|
|
695
|
+
interface StudioUnassigned {
|
|
696
696
|
}
|
|
697
697
|
/**
|
|
698
698
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -702,13 +702,13 @@ export interface StudioUnassigned {
|
|
|
702
702
|
*
|
|
703
703
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
704
704
|
*/
|
|
705
|
-
|
|
705
|
+
interface SiteUrlChanged {
|
|
706
706
|
}
|
|
707
707
|
/**
|
|
708
708
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
709
709
|
* Consumed by other teams to remove relevant data.
|
|
710
710
|
*/
|
|
711
|
-
|
|
711
|
+
interface SitePurgedExternally {
|
|
712
712
|
/**
|
|
713
713
|
* @maxLength 2048
|
|
714
714
|
* @maxSize 100
|
|
@@ -718,38 +718,17 @@ export interface SitePurgedExternally {
|
|
|
718
718
|
appDefId?: string[];
|
|
719
719
|
}
|
|
720
720
|
/** Assigned Odeditor */
|
|
721
|
-
|
|
721
|
+
interface OdeditorAssigned {
|
|
722
722
|
}
|
|
723
723
|
/** Unassigned Odeditor */
|
|
724
|
-
|
|
724
|
+
interface OdeditorUnassigned {
|
|
725
725
|
}
|
|
726
726
|
/** Assigned Picasso editor */
|
|
727
|
-
|
|
727
|
+
interface PicassoAssigned {
|
|
728
728
|
}
|
|
729
729
|
/** Unassigned Picasso */
|
|
730
|
-
|
|
730
|
+
interface PicassoUnassigned {
|
|
731
731
|
}
|
|
732
|
-
/**
|
|
733
|
-
* Creates a query to retrieve a list of user members.
|
|
734
|
-
*
|
|
735
|
-
* The `queryUserMembers()` method builds a query to retrieve a list of user members and returns a [`UserMembersQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/members/user-member/user-members-query-builder/ascending) object.
|
|
736
|
-
*
|
|
737
|
-
* The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/members/user-member/user-members-query-builder/find) method.
|
|
738
|
-
*
|
|
739
|
-
* You can refine the query by chaining `UserMembersQueryBuilder` methods onto the query. `UserMembersQueryBuilder` methods enable you to sort, filter, and control the results `queryUserMembers()` returns.
|
|
740
|
-
*
|
|
741
|
-
* `queryUserMembers()` runs with these `UserMembersQueryBuilder` defaults, which you can override:
|
|
742
|
-
*
|
|
743
|
-
* - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/members/user-member/user-members-query-builder/limit)
|
|
744
|
-
* @public
|
|
745
|
-
* @documentationMaturity preview
|
|
746
|
-
* @permissionScope SCOPE.DC-MEMBERS.READ-USER-MEMBERS
|
|
747
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-USER-MEMBERS
|
|
748
|
-
* @permissionId MEMBERS.USER_MEMBER_READ
|
|
749
|
-
* @applicableIdentity APP
|
|
750
|
-
* @fqn wix.members.usermembers.v1.UserMembers.QueryUserMembers
|
|
751
|
-
*/
|
|
752
|
-
export declare function queryUserMembers(): UserMembersQueryBuilder;
|
|
753
732
|
interface QueryCursorResult {
|
|
754
733
|
cursors: Cursors;
|
|
755
734
|
hasNext: () => boolean;
|
|
@@ -757,13 +736,13 @@ interface QueryCursorResult {
|
|
|
757
736
|
length: number;
|
|
758
737
|
pageSize: number;
|
|
759
738
|
}
|
|
760
|
-
|
|
739
|
+
interface UserMembersQueryResult extends QueryCursorResult {
|
|
761
740
|
items: UserMember[];
|
|
762
741
|
query: UserMembersQueryBuilder;
|
|
763
742
|
next: () => Promise<UserMembersQueryResult>;
|
|
764
743
|
prev: () => Promise<UserMembersQueryResult>;
|
|
765
744
|
}
|
|
766
|
-
|
|
745
|
+
interface UserMembersQueryBuilder {
|
|
767
746
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
768
747
|
* @param value - Value to compare against.
|
|
769
748
|
* @documentationMaturity preview
|
|
@@ -827,4 +806,5 @@ export interface UserMembersQueryBuilder {
|
|
|
827
806
|
/** @documentationMaturity preview */
|
|
828
807
|
find: () => Promise<UserMembersQueryResult>;
|
|
829
808
|
}
|
|
830
|
-
|
|
809
|
+
|
|
810
|
+
export { ActivityStatusStatus as A, type SiteMarkedAsWixSite as B, type CursorQuery as C, DeleteStatus as D, type EntityCreatedEvent as E, type ServiceProvisioned as F, type ServiceRemoved as G, type SiteRenamed as H, type Image as I, type SiteHardDeleted as J, type NamespaceChanged as K, type StudioAssigned as L, type MetaSiteSpecialEvent as M, Namespace as N, type StudioUnassigned as O, PrivacyStatusStatus as P, type QueryUserMembersRequest as Q, type RestoreInfo as R, Status as S, type SiteUrlChanged as T, type UserMembersQueryBuilder as U, type SitePurgedExternally as V, type OdeditorAssigned as W, type OdeditorUnassigned as X, type PicassoAssigned as Y, type PicassoUnassigned as Z, type UserMembersQueryResult as _, SortOrder as a, State as b, SiteCreatedContext as c, type UserMember as d, type CursorQueryPagingMethodOneOf as e, type Sorting as f, type CursorPaging as g, type QueryUserMembersResponse as h, type CursorPagingMetadata as i, type Cursors as j, type DomainEvent as k, type DomainEventBodyOneOf as l, type EntityUpdatedEvent as m, type EntityDeletedEvent as n, type ActionEvent as o, type Empty as p, type MetaSiteSpecialEventPayloadOneOf as q, type Asset as r, type SiteCreated as s, type SiteTransferred as t, type SiteDeleted as u, type DeleteContext as v, type SiteUndeleted as w, type SitePublished as x, type SiteUnpublished as y, type SiteMarkedAsTemplate as z };
|
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1 +1,226 @@
|
|
|
1
|
-
|
|
1
|
+
import { Q as QueryUserMembersRequest$1, h as QueryUserMembersResponse$1 } from './members-usermembers-v1-user-member-user-member.universal-BTMQfAFl.js';
|
|
2
|
+
|
|
3
|
+
interface UserMember {
|
|
4
|
+
/**
|
|
5
|
+
* Profile ID.
|
|
6
|
+
* @format GUID
|
|
7
|
+
* @readonly
|
|
8
|
+
*/
|
|
9
|
+
memberId?: string | null;
|
|
10
|
+
/**
|
|
11
|
+
* User ID.
|
|
12
|
+
* @format GUID
|
|
13
|
+
* @readonly
|
|
14
|
+
*/
|
|
15
|
+
userId?: string | null;
|
|
16
|
+
/**
|
|
17
|
+
* Contact ID.
|
|
18
|
+
* @format GUID
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
contactId?: string | null;
|
|
22
|
+
/**
|
|
23
|
+
* Instance ID of the installed [Wix Members Area app](https://www.wix.com/app-market/web-solution/members-area) on the Wix site.
|
|
24
|
+
* @format GUID
|
|
25
|
+
* @readonly
|
|
26
|
+
*/
|
|
27
|
+
siteMembersInstanceId?: string | null;
|
|
28
|
+
/**
|
|
29
|
+
* Metasite ID.
|
|
30
|
+
* @format GUID
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
metaSiteId?: string | null;
|
|
34
|
+
/** User member profile picture. */
|
|
35
|
+
photo?: Image;
|
|
36
|
+
/**
|
|
37
|
+
* User member nickname.
|
|
38
|
+
* @readonly
|
|
39
|
+
*/
|
|
40
|
+
nickname?: string | null;
|
|
41
|
+
/**
|
|
42
|
+
* User member profile privacy status.
|
|
43
|
+
* @readonly
|
|
44
|
+
*/
|
|
45
|
+
privacyStatus?: PrivacyStatusStatusWithLiterals;
|
|
46
|
+
/**
|
|
47
|
+
* Date and time the user member was created.
|
|
48
|
+
* @readonly
|
|
49
|
+
*/
|
|
50
|
+
createdDate?: Date | null;
|
|
51
|
+
/**
|
|
52
|
+
* Date and time the user member was updated.
|
|
53
|
+
* @readonly
|
|
54
|
+
*/
|
|
55
|
+
updatedDate?: Date | null;
|
|
56
|
+
/**
|
|
57
|
+
* User member site access status.
|
|
58
|
+
* @readonly
|
|
59
|
+
*/
|
|
60
|
+
status?: StatusWithLiterals;
|
|
61
|
+
/**
|
|
62
|
+
* User member activity status.
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
66
|
+
}
|
|
67
|
+
interface Image {
|
|
68
|
+
/**
|
|
69
|
+
* Wix Media image ID,
|
|
70
|
+
* set when the member selects an image from Wix Media.
|
|
71
|
+
*/
|
|
72
|
+
id?: string;
|
|
73
|
+
/** Image URL. */
|
|
74
|
+
url?: string;
|
|
75
|
+
/** Original image width. */
|
|
76
|
+
height?: number;
|
|
77
|
+
/** Original image height. */
|
|
78
|
+
width?: number;
|
|
79
|
+
/**
|
|
80
|
+
* X-axis offset.
|
|
81
|
+
*
|
|
82
|
+
* Default: `0`.
|
|
83
|
+
*/
|
|
84
|
+
offsetX?: number | null;
|
|
85
|
+
/**
|
|
86
|
+
* Y-axis offset.
|
|
87
|
+
*
|
|
88
|
+
* Default: `0`.
|
|
89
|
+
*/
|
|
90
|
+
offsetY?: number | null;
|
|
91
|
+
}
|
|
92
|
+
declare enum PrivacyStatusStatus {
|
|
93
|
+
/** Unknown status. This value isn't used. */
|
|
94
|
+
UNKNOWN = "UNKNOWN",
|
|
95
|
+
/** User member is hidden from everyone who visits the site. The member is returned only to Wix users and apps with the appropriate permissions. */
|
|
96
|
+
PRIVATE = "PRIVATE",
|
|
97
|
+
/** User member is visible to everyone. */
|
|
98
|
+
PUBLIC = "PUBLIC"
|
|
99
|
+
}
|
|
100
|
+
/** @enumType */
|
|
101
|
+
type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
|
|
102
|
+
declare enum Status {
|
|
103
|
+
/** Unknown status. This value isn't used. */
|
|
104
|
+
UNKNOWN = "UNKNOWN",
|
|
105
|
+
/** User member is created and is waiting for the approval. */
|
|
106
|
+
PENDING = "PENDING",
|
|
107
|
+
/** User member is approved and can log in to the site. */
|
|
108
|
+
APPROVED = "APPROVED",
|
|
109
|
+
/** User member is approved and can't log in to the site. */
|
|
110
|
+
BLOCKED = "BLOCKED",
|
|
111
|
+
/** User member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. */
|
|
112
|
+
OFFLINE = "OFFLINE"
|
|
113
|
+
}
|
|
114
|
+
/** @enumType */
|
|
115
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
|
|
116
|
+
declare enum ActivityStatusStatus {
|
|
117
|
+
/** Unknown status. This value isn't used. */
|
|
118
|
+
UNKNOWN = "UNKNOWN",
|
|
119
|
+
/** User member can participate in site activities, such as writing blog posts and forum comments. */
|
|
120
|
+
ACTIVE = "ACTIVE",
|
|
121
|
+
/** User member can't participate in site activities, such as writing blog posts and forum comments. */
|
|
122
|
+
MUTED = "MUTED"
|
|
123
|
+
}
|
|
124
|
+
/** @enumType */
|
|
125
|
+
type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
126
|
+
interface QueryUserMembersRequest {
|
|
127
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
128
|
+
query?: CursorQuery;
|
|
129
|
+
}
|
|
130
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
131
|
+
/** 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`. */
|
|
132
|
+
cursorPaging?: CursorPaging;
|
|
133
|
+
/**
|
|
134
|
+
* Filter object in the following format:
|
|
135
|
+
* `"filter" : {
|
|
136
|
+
* "fieldName1": "value1",
|
|
137
|
+
* "fieldName2":{"$operator":"value2"}
|
|
138
|
+
* }`
|
|
139
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
140
|
+
*/
|
|
141
|
+
filter?: Record<string, any> | null;
|
|
142
|
+
/**
|
|
143
|
+
* Sort object in the following format:
|
|
144
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
145
|
+
*/
|
|
146
|
+
sort?: Sorting[];
|
|
147
|
+
}
|
|
148
|
+
/** @oneof */
|
|
149
|
+
interface CursorQueryPagingMethodOneOf {
|
|
150
|
+
/** 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`. */
|
|
151
|
+
cursorPaging?: CursorPaging;
|
|
152
|
+
}
|
|
153
|
+
interface Sorting {
|
|
154
|
+
/** Name of the field to sort by. */
|
|
155
|
+
fieldName?: string;
|
|
156
|
+
/** Sort order. */
|
|
157
|
+
order?: SortOrderWithLiterals;
|
|
158
|
+
}
|
|
159
|
+
declare enum SortOrder {
|
|
160
|
+
/** Sorting is in ascending order. */
|
|
161
|
+
ASC = "ASC",
|
|
162
|
+
/** Sorting is in descending order. */
|
|
163
|
+
DESC = "DESC"
|
|
164
|
+
}
|
|
165
|
+
/** @enumType */
|
|
166
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
167
|
+
interface CursorPaging {
|
|
168
|
+
/**
|
|
169
|
+
* Number of items to load.
|
|
170
|
+
* @max 100
|
|
171
|
+
*/
|
|
172
|
+
limit?: number | null;
|
|
173
|
+
/**
|
|
174
|
+
* Pointer to the next or previous page in the list of results.
|
|
175
|
+
*
|
|
176
|
+
* You can get the relevant cursor token
|
|
177
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
178
|
+
* Not relevant for the first request.
|
|
179
|
+
*/
|
|
180
|
+
cursor?: string | null;
|
|
181
|
+
}
|
|
182
|
+
interface QueryUserMembersResponse {
|
|
183
|
+
/** Retrieved user members. */
|
|
184
|
+
userMembers?: UserMember[];
|
|
185
|
+
/** Metadata for the paginated results. */
|
|
186
|
+
metadata?: CursorPagingMetadata;
|
|
187
|
+
}
|
|
188
|
+
interface CursorPagingMetadata {
|
|
189
|
+
/** Number of items returned in current page. */
|
|
190
|
+
count?: number | null;
|
|
191
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
192
|
+
cursors?: Cursors;
|
|
193
|
+
/**
|
|
194
|
+
* Whether there are more pages to retrieve following the current page.
|
|
195
|
+
*
|
|
196
|
+
* + `true`: Another page of results can be retrieved.
|
|
197
|
+
* + `false`: This is the last page.
|
|
198
|
+
*/
|
|
199
|
+
hasNext?: boolean | null;
|
|
200
|
+
}
|
|
201
|
+
interface Cursors {
|
|
202
|
+
/**
|
|
203
|
+
* Cursor string pointing to the next page in the list of results.
|
|
204
|
+
* @maxLength 16000
|
|
205
|
+
*/
|
|
206
|
+
next?: string | null;
|
|
207
|
+
/**
|
|
208
|
+
* Cursor pointing to the previous page in the list of results.
|
|
209
|
+
* @maxLength 16000
|
|
210
|
+
*/
|
|
211
|
+
prev?: string | null;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
215
|
+
getUrl: (context: any) => string;
|
|
216
|
+
httpMethod: K;
|
|
217
|
+
path: string;
|
|
218
|
+
pathParams: M;
|
|
219
|
+
__requestType: T;
|
|
220
|
+
__originalRequestType: S;
|
|
221
|
+
__responseType: Q;
|
|
222
|
+
__originalResponseType: R;
|
|
223
|
+
};
|
|
224
|
+
declare function queryUserMembers(): __PublicMethodMetaInfo<'POST', {}, QueryUserMembersRequest$1, QueryUserMembersRequest, QueryUserMembersResponse$1, QueryUserMembersResponse>;
|
|
225
|
+
|
|
226
|
+
export { type __PublicMethodMetaInfo, queryUserMembers };
|