@wix/members 1.0.65 → 1.0.67
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/context.d.ts +3 -3
- package/build/cjs/context.js +3 -3
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +3 -3
- package/build/cjs/index.js +3 -3
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +3 -3
- package/build/cjs/meta.js +3 -3
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +3 -3
- package/build/es/context.js +3 -3
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +3 -3
- package/build/es/index.js +3 -3
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +3 -3
- package/build/es/meta.js +3 -3
- package/build/es/meta.js.map +1 -1
- package/package.json +13 -9
- package/build/cjs/index.typings.d.ts +0 -3
- package/build/cjs/index.typings.js +0 -30
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.context.d.ts +0 -13
- package/build/cjs/src/badges-v3-badge.context.js +0 -137
- package/build/cjs/src/badges-v3-badge.context.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.http.d.ts +0 -111
- package/build/cjs/src/badges-v3-badge.http.js +0 -492
- package/build/cjs/src/badges-v3-badge.http.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.meta.d.ts +0 -35
- package/build/cjs/src/badges-v3-badge.meta.js +0 -237
- package/build/cjs/src/badges-v3-badge.meta.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.public.d.ts +0 -25
- package/build/cjs/src/badges-v3-badge.public.js +0 -80
- package/build/cjs/src/badges-v3-badge.public.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.types.d.ts +0 -360
- package/build/cjs/src/badges-v3-badge.types.js +0 -9
- package/build/cjs/src/badges-v3-badge.types.js.map +0 -1
- package/build/cjs/src/badges-v3-badge.universal.d.ts +0 -633
- package/build/cjs/src/badges-v3-badge.universal.js +0 -759
- package/build/cjs/src/badges-v3-badge.universal.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.context.d.ts +0 -8
- package/build/cjs/src/identity-members-v1-member.context.js +0 -77
- package/build/cjs/src/identity-members-v1-member.context.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.http.d.ts +0 -56
- package/build/cjs/src/identity-members-v1-member.http.js +0 -679
- package/build/cjs/src/identity-members-v1-member.http.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.meta.d.ts +0 -20
- package/build/cjs/src/identity-members-v1-member.meta.js +0 -142
- package/build/cjs/src/identity-members-v1-member.meta.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.public.d.ts +0 -13
- package/build/cjs/src/identity-members-v1-member.public.js +0 -49
- package/build/cjs/src/identity-members-v1-member.public.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.types.d.ts +0 -737
- package/build/cjs/src/identity-members-v1-member.types.js +0 -48
- package/build/cjs/src/identity-members-v1-member.types.js.map +0 -1
- package/build/cjs/src/identity-members-v1-member.universal.d.ts +0 -894
- package/build/cjs/src/identity-members-v1-member.universal.js +0 -525
- package/build/cjs/src/identity-members-v1-member.universal.js.map +0 -1
- package/build/cjs/src/members-v1-member.context.d.ts +0 -15
- package/build/cjs/src/members-v1-member.context.js +0 -161
- package/build/cjs/src/members-v1-member.context.js.map +0 -1
- package/build/cjs/src/members-v1-member.http.d.ts +0 -146
- package/build/cjs/src/members-v1-member.http.js +0 -598
- package/build/cjs/src/members-v1-member.http.js.map +0 -1
- package/build/cjs/src/members-v1-member.meta.d.ts +0 -37
- package/build/cjs/src/members-v1-member.meta.js +0 -275
- package/build/cjs/src/members-v1-member.meta.js.map +0 -1
- package/build/cjs/src/members-v1-member.public.d.ts +0 -99
- package/build/cjs/src/members-v1-member.public.js +0 -98
- package/build/cjs/src/members-v1-member.public.js.map +0 -1
- package/build/cjs/src/members-v1-member.types.d.ts +0 -1426
- package/build/cjs/src/members-v1-member.types.js +0 -129
- package/build/cjs/src/members-v1-member.types.js.map +0 -1
- package/build/cjs/src/members-v1-member.universal.d.ts +0 -1907
- package/build/cjs/src/members-v1-member.universal.js +0 -1088
- package/build/cjs/src/members-v1-member.universal.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -3
- package/build/es/index.typings.js +0 -4
- package/build/es/index.typings.js.map +0 -1
- package/build/es/src/badges-v3-badge.context.d.ts +0 -13
- package/build/es/src/badges-v3-badge.context.js +0 -123
- package/build/es/src/badges-v3-badge.context.js.map +0 -1
- package/build/es/src/badges-v3-badge.http.d.ts +0 -111
- package/build/es/src/badges-v3-badge.http.js +0 -478
- package/build/es/src/badges-v3-badge.http.js.map +0 -1
- package/build/es/src/badges-v3-badge.meta.d.ts +0 -35
- package/build/es/src/badges-v3-badge.meta.js +0 -200
- package/build/es/src/badges-v3-badge.meta.js.map +0 -1
- package/build/es/src/badges-v3-badge.public.d.ts +0 -25
- package/build/es/src/badges-v3-badge.public.js +0 -60
- package/build/es/src/badges-v3-badge.public.js.map +0 -1
- package/build/es/src/badges-v3-badge.types.d.ts +0 -360
- package/build/es/src/badges-v3-badge.types.js +0 -6
- package/build/es/src/badges-v3-badge.types.js.map +0 -1
- package/build/es/src/badges-v3-badge.universal.d.ts +0 -633
- package/build/es/src/badges-v3-badge.universal.js +0 -722
- package/build/es/src/badges-v3-badge.universal.js.map +0 -1
- package/build/es/src/identity-members-v1-member.context.d.ts +0 -8
- package/build/es/src/identity-members-v1-member.context.js +0 -68
- package/build/es/src/identity-members-v1-member.context.js.map +0 -1
- package/build/es/src/identity-members-v1-member.http.d.ts +0 -56
- package/build/es/src/identity-members-v1-member.http.js +0 -670
- package/build/es/src/identity-members-v1-member.http.js.map +0 -1
- package/build/es/src/identity-members-v1-member.meta.d.ts +0 -20
- package/build/es/src/identity-members-v1-member.meta.js +0 -110
- package/build/es/src/identity-members-v1-member.meta.js.map +0 -1
- package/build/es/src/identity-members-v1-member.public.d.ts +0 -13
- package/build/es/src/identity-members-v1-member.public.js +0 -34
- package/build/es/src/identity-members-v1-member.public.js.map +0 -1
- package/build/es/src/identity-members-v1-member.types.d.ts +0 -737
- package/build/es/src/identity-members-v1-member.types.js +0 -45
- package/build/es/src/identity-members-v1-member.types.js.map +0 -1
- package/build/es/src/identity-members-v1-member.universal.d.ts +0 -894
- package/build/es/src/identity-members-v1-member.universal.js +0 -493
- package/build/es/src/identity-members-v1-member.universal.js.map +0 -1
- package/build/es/src/members-v1-member.context.d.ts +0 -15
- package/build/es/src/members-v1-member.context.js +0 -145
- package/build/es/src/members-v1-member.context.js.map +0 -1
- package/build/es/src/members-v1-member.http.d.ts +0 -146
- package/build/es/src/members-v1-member.http.js +0 -582
- package/build/es/src/members-v1-member.http.js.map +0 -1
- package/build/es/src/members-v1-member.meta.d.ts +0 -37
- package/build/es/src/members-v1-member.meta.js +0 -236
- package/build/es/src/members-v1-member.meta.js.map +0 -1
- package/build/es/src/members-v1-member.public.d.ts +0 -99
- package/build/es/src/members-v1-member.public.js +0 -70
- package/build/es/src/members-v1-member.public.js.map +0 -1
- package/build/es/src/members-v1-member.types.d.ts +0 -1426
- package/build/es/src/members-v1-member.types.js +0 -126
- package/build/es/src/members-v1-member.types.js.map +0 -1
- package/build/es/src/members-v1-member.universal.d.ts +0 -1907
- package/build/es/src/members-v1-member.universal.js +0 -1049
- package/build/es/src/members-v1-member.universal.js.map +0 -1
|
@@ -1,1907 +0,0 @@
|
|
|
1
|
-
import { EventDefinition } from '@wix/sdk-types';
|
|
2
|
-
export interface Member {
|
|
3
|
-
/**
|
|
4
|
-
* Member ID.
|
|
5
|
-
* @readonly
|
|
6
|
-
*/
|
|
7
|
-
_id?: string | null;
|
|
8
|
-
/** Email used by the member to log in to the site. */
|
|
9
|
-
loginEmail?: string | null;
|
|
10
|
-
/**
|
|
11
|
-
* Whether the email used by the member has been verified.
|
|
12
|
-
* @readonly
|
|
13
|
-
*/
|
|
14
|
-
loginEmailVerified?: boolean | null;
|
|
15
|
-
/**
|
|
16
|
-
* Member site access status.
|
|
17
|
-
*
|
|
18
|
-
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
19
|
-
* - `APPROVED`: Member can log in to the site.
|
|
20
|
-
* - `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.
|
|
21
|
-
* - `BLOCKED`: Member is blocked and cannot log in to the site.
|
|
22
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
23
|
-
* @readonly
|
|
24
|
-
*/
|
|
25
|
-
status?: Status;
|
|
26
|
-
/**
|
|
27
|
-
* Contact ID.
|
|
28
|
-
* @readonly
|
|
29
|
-
*/
|
|
30
|
-
contactId?: string | null;
|
|
31
|
-
/**
|
|
32
|
-
* Member's contact information. Contact information is stored in the
|
|
33
|
-
* [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
|
|
34
|
-
*/
|
|
35
|
-
contact?: Contact;
|
|
36
|
-
/** Profile display info. */
|
|
37
|
-
profile?: Profile;
|
|
38
|
-
/**
|
|
39
|
-
* Member privacy status.
|
|
40
|
-
*
|
|
41
|
-
* - `PUBLIC`: Member is visible to everyone.
|
|
42
|
-
* - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
|
|
43
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
44
|
-
*/
|
|
45
|
-
privacyStatus?: PrivacyStatusStatus;
|
|
46
|
-
/**
|
|
47
|
-
* Member activity status.
|
|
48
|
-
*
|
|
49
|
-
* - `ACTIVE`: Member can write forum posts and blog comments.
|
|
50
|
-
* - `MUTED`: Member cannot write forum posts or blog comments.
|
|
51
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
52
|
-
* @readonly
|
|
53
|
-
*/
|
|
54
|
-
activityStatus?: ActivityStatusStatus;
|
|
55
|
-
/**
|
|
56
|
-
* Date and time when the member was created.
|
|
57
|
-
* @readonly
|
|
58
|
-
*/
|
|
59
|
-
_createdDate?: Date;
|
|
60
|
-
/**
|
|
61
|
-
* Date and time when the member was updated.
|
|
62
|
-
* @readonly
|
|
63
|
-
*/
|
|
64
|
-
_updatedDate?: Date;
|
|
65
|
-
/**
|
|
66
|
-
* Date and time when the member last logged in to the site.
|
|
67
|
-
* @readonly
|
|
68
|
-
*/
|
|
69
|
-
lastLoginDate?: Date;
|
|
70
|
-
}
|
|
71
|
-
export declare enum Status {
|
|
72
|
-
UNKNOWN = "UNKNOWN",
|
|
73
|
-
PENDING = "PENDING",
|
|
74
|
-
APPROVED = "APPROVED",
|
|
75
|
-
BLOCKED = "BLOCKED",
|
|
76
|
-
OFFLINE = "OFFLINE"
|
|
77
|
-
}
|
|
78
|
-
/** Contact info associated with the member. */
|
|
79
|
-
export interface Contact {
|
|
80
|
-
/**
|
|
81
|
-
* @internal
|
|
82
|
-
* @internal
|
|
83
|
-
* @readonly
|
|
84
|
-
*/
|
|
85
|
-
contactId?: string | null;
|
|
86
|
-
/** Contact's first name. */
|
|
87
|
-
firstName?: string | null;
|
|
88
|
-
/** Contact's last name. */
|
|
89
|
-
lastName?: string | null;
|
|
90
|
-
/** List of phone numbers. */
|
|
91
|
-
phones?: string[] | null;
|
|
92
|
-
/** List of email addresses. */
|
|
93
|
-
emails?: string[] | null;
|
|
94
|
-
/** List of street addresses. */
|
|
95
|
-
addresses?: Address[];
|
|
96
|
-
/**
|
|
97
|
-
* Contact's birthdate, formatted as `"YYYY-MM-DD"`.
|
|
98
|
-
*
|
|
99
|
-
* Example: `"2020-03-15"` for March 15, 2020.
|
|
100
|
-
*/
|
|
101
|
-
birthdate?: string | null;
|
|
102
|
-
/** Contact's company name. */
|
|
103
|
-
company?: string | null;
|
|
104
|
-
/** Contact's job title. */
|
|
105
|
-
jobTitle?: string | null;
|
|
106
|
-
/**
|
|
107
|
-
* Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.
|
|
108
|
-
*
|
|
109
|
-
* > **Notes:**
|
|
110
|
-
* > - Only custom fields added to the member profile in the Dashboard are available through the Members API. Empty fields are not returned.
|
|
111
|
-
* > - When updating a member, `name` is ignored.
|
|
112
|
-
*/
|
|
113
|
-
customFields?: Record<string, CustomField>;
|
|
114
|
-
}
|
|
115
|
-
/** Street address. */
|
|
116
|
-
export interface Address extends AddressStreetOneOf {
|
|
117
|
-
/** Street address object, with number and name in separate fields. */
|
|
118
|
-
streetAddress?: StreetAddress;
|
|
119
|
-
/** Main address line, usually street and number, as free text. */
|
|
120
|
-
addressLine?: string | null;
|
|
121
|
-
/**
|
|
122
|
-
* Street address ID.
|
|
123
|
-
* @readonly
|
|
124
|
-
*/
|
|
125
|
-
_id?: string | null;
|
|
126
|
-
/**
|
|
127
|
-
* Free text providing more detailed address information,
|
|
128
|
-
* such as apartment, suite, or floor.
|
|
129
|
-
*/
|
|
130
|
-
addressLine2?: string | null;
|
|
131
|
-
/** City name. */
|
|
132
|
-
city?: string | null;
|
|
133
|
-
/**
|
|
134
|
-
* Code for a subdivision (such as state, prefecture, or province) in an
|
|
135
|
-
* [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
|
|
136
|
-
*/
|
|
137
|
-
subdivision?: string | null;
|
|
138
|
-
/**
|
|
139
|
-
* 2-letter country code in an
|
|
140
|
-
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
141
|
-
*/
|
|
142
|
-
country?: string | null;
|
|
143
|
-
/** Postal code. */
|
|
144
|
-
postalCode?: string | null;
|
|
145
|
-
}
|
|
146
|
-
/** @oneof */
|
|
147
|
-
export interface AddressStreetOneOf {
|
|
148
|
-
/** Street address object, with number and name in separate fields. */
|
|
149
|
-
streetAddress?: StreetAddress;
|
|
150
|
-
/** Main address line, usually street and number, as free text. */
|
|
151
|
-
addressLine?: string | null;
|
|
152
|
-
}
|
|
153
|
-
export interface StreetAddress {
|
|
154
|
-
/** Street number. */
|
|
155
|
-
number?: string;
|
|
156
|
-
/** Street name. */
|
|
157
|
-
name?: string;
|
|
158
|
-
}
|
|
159
|
-
export interface CustomField {
|
|
160
|
-
/** Custom field name. */
|
|
161
|
-
name?: string | null;
|
|
162
|
-
/** Custom field value. */
|
|
163
|
-
value?: any;
|
|
164
|
-
}
|
|
165
|
-
/** Member Profile */
|
|
166
|
-
export interface Profile {
|
|
167
|
-
/**
|
|
168
|
-
* Name that identifies the member to other members.
|
|
169
|
-
* Displayed on the member's profile page
|
|
170
|
-
* and interactions in the forum or blog.
|
|
171
|
-
*/
|
|
172
|
-
nickname?: string | null;
|
|
173
|
-
/**
|
|
174
|
-
* Slug that determines the member's profile page URL.
|
|
175
|
-
* @readonly
|
|
176
|
-
*/
|
|
177
|
-
slug?: string | null;
|
|
178
|
-
/** Member's profile photo. */
|
|
179
|
-
photo?: Image;
|
|
180
|
-
/**
|
|
181
|
-
* Member's cover photo,
|
|
182
|
-
* used as a background picture in members profile page.
|
|
183
|
-
*
|
|
184
|
-
* Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
|
|
185
|
-
* When left empty, the values default to `0`.
|
|
186
|
-
*/
|
|
187
|
-
cover?: Image;
|
|
188
|
-
/**
|
|
189
|
-
* Member title.
|
|
190
|
-
*
|
|
191
|
-
* Currently available through the API only.
|
|
192
|
-
*/
|
|
193
|
-
title?: string | null;
|
|
194
|
-
}
|
|
195
|
-
export interface Image {
|
|
196
|
-
/**
|
|
197
|
-
* Wix Media image ID,
|
|
198
|
-
* set when the member selects an image from Wix Media.
|
|
199
|
-
*/
|
|
200
|
-
_id?: string;
|
|
201
|
-
/** Image URL. */
|
|
202
|
-
url?: string;
|
|
203
|
-
/** Original image width. */
|
|
204
|
-
height?: number;
|
|
205
|
-
/** Original image height. */
|
|
206
|
-
width?: number;
|
|
207
|
-
/**
|
|
208
|
-
* X-axis offset.
|
|
209
|
-
*
|
|
210
|
-
* Default: `0`.
|
|
211
|
-
*/
|
|
212
|
-
offsetX?: number | null;
|
|
213
|
-
/**
|
|
214
|
-
* Y-axis offset.
|
|
215
|
-
*
|
|
216
|
-
* Default: `0`.
|
|
217
|
-
*/
|
|
218
|
-
offsetY?: number | null;
|
|
219
|
-
}
|
|
220
|
-
export declare enum PrivacyStatusStatus {
|
|
221
|
-
UNKNOWN = "UNKNOWN",
|
|
222
|
-
PRIVATE = "PRIVATE",
|
|
223
|
-
PUBLIC = "PUBLIC"
|
|
224
|
-
}
|
|
225
|
-
export declare enum ActivityStatusStatus {
|
|
226
|
-
UNKNOWN = "UNKNOWN",
|
|
227
|
-
ACTIVE = "ACTIVE",
|
|
228
|
-
MUTED = "MUTED"
|
|
229
|
-
}
|
|
230
|
-
export interface ExtendedFields {
|
|
231
|
-
/**
|
|
232
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
233
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
234
|
-
*
|
|
235
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
236
|
-
*
|
|
237
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
238
|
-
*/
|
|
239
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
240
|
-
}
|
|
241
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
242
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
243
|
-
metaSiteId?: string;
|
|
244
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
245
|
-
siteId?: string;
|
|
246
|
-
/** Invalidate by App */
|
|
247
|
-
app?: App;
|
|
248
|
-
/** Invalidate by page id */
|
|
249
|
-
page?: Page;
|
|
250
|
-
/** Invalidate by URI path */
|
|
251
|
-
uri?: URI;
|
|
252
|
-
/** tell us why you're invalidating the cache. You don't need to add your app name */
|
|
253
|
-
reason?: string | null;
|
|
254
|
-
/** Is local DS */
|
|
255
|
-
localDc?: boolean;
|
|
256
|
-
}
|
|
257
|
-
/** @oneof */
|
|
258
|
-
export interface InvalidateCacheGetByOneOf {
|
|
259
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
260
|
-
metaSiteId?: string;
|
|
261
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
262
|
-
siteId?: string;
|
|
263
|
-
/** Invalidate by App */
|
|
264
|
-
app?: App;
|
|
265
|
-
/** Invalidate by page id */
|
|
266
|
-
page?: Page;
|
|
267
|
-
/** Invalidate by URI path */
|
|
268
|
-
uri?: URI;
|
|
269
|
-
}
|
|
270
|
-
export interface App {
|
|
271
|
-
/** The AppDefId */
|
|
272
|
-
appDefId?: string;
|
|
273
|
-
/** The instance Id */
|
|
274
|
-
instanceId?: string;
|
|
275
|
-
}
|
|
276
|
-
export interface Page {
|
|
277
|
-
/** the msid the page is on */
|
|
278
|
-
metaSiteId?: string;
|
|
279
|
-
/** Invalidate by Page ID */
|
|
280
|
-
pageId?: string;
|
|
281
|
-
}
|
|
282
|
-
export interface URI {
|
|
283
|
-
/** the msid the URI is on */
|
|
284
|
-
metaSiteId?: string;
|
|
285
|
-
/** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
|
|
286
|
-
uriPath?: string;
|
|
287
|
-
}
|
|
288
|
-
export interface UpdateMySlugRequest {
|
|
289
|
-
/** New slug. */
|
|
290
|
-
slug: string;
|
|
291
|
-
}
|
|
292
|
-
export interface UpdateMySlugResponse {
|
|
293
|
-
/** Updated member. */
|
|
294
|
-
member?: Member;
|
|
295
|
-
}
|
|
296
|
-
export interface SlugAlreadyExistsPayload {
|
|
297
|
-
slug?: string;
|
|
298
|
-
}
|
|
299
|
-
export interface UpdateMemberSlugRequest {
|
|
300
|
-
/** ID of the member whose slug will be updated. */
|
|
301
|
-
_id?: string;
|
|
302
|
-
/** New slug. */
|
|
303
|
-
slug?: string;
|
|
304
|
-
}
|
|
305
|
-
export interface UpdateMemberSlugResponse {
|
|
306
|
-
/** Updated member. */
|
|
307
|
-
member?: Member;
|
|
308
|
-
}
|
|
309
|
-
export interface JoinCommunityRequest {
|
|
310
|
-
}
|
|
311
|
-
/** Member profile. */
|
|
312
|
-
export interface JoinCommunityResponse {
|
|
313
|
-
/** The updated member. */
|
|
314
|
-
member?: Member;
|
|
315
|
-
}
|
|
316
|
-
export interface MemberJoinedCommunity {
|
|
317
|
-
/**
|
|
318
|
-
* Member id who joined the community
|
|
319
|
-
* @readonly
|
|
320
|
-
*/
|
|
321
|
-
memberId?: string;
|
|
322
|
-
}
|
|
323
|
-
export interface LeaveCommunityRequest {
|
|
324
|
-
}
|
|
325
|
-
/** Member profile. */
|
|
326
|
-
export interface LeaveCommunityResponse {
|
|
327
|
-
/** The updated member. */
|
|
328
|
-
member?: Member;
|
|
329
|
-
}
|
|
330
|
-
export interface MemberLeftCommunity {
|
|
331
|
-
/**
|
|
332
|
-
* Member id who left the community
|
|
333
|
-
* @readonly
|
|
334
|
-
*/
|
|
335
|
-
memberId?: string;
|
|
336
|
-
}
|
|
337
|
-
export interface GetMyMemberRequest {
|
|
338
|
-
/**
|
|
339
|
-
* Predefined set of fields to return.
|
|
340
|
-
*
|
|
341
|
-
* - `"FULL"`: Returns all fields.
|
|
342
|
-
* - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
|
|
343
|
-
*
|
|
344
|
-
* > **Note:**
|
|
345
|
-
* > When returning the `"PUBLIC"` fieldset,
|
|
346
|
-
* > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
|
|
347
|
-
* > are returned as `"UNKNOWN"`.
|
|
348
|
-
*/
|
|
349
|
-
fieldSet?: Set;
|
|
350
|
-
/**
|
|
351
|
-
* Predefined set of fields to return. One of:
|
|
352
|
-
*
|
|
353
|
-
* - `FULL`: Returns all fields.
|
|
354
|
-
* - `PUBLIC`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
355
|
-
* - `EXTENDED`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
356
|
-
*
|
|
357
|
-
* Default: `PUBLIC`.
|
|
358
|
-
*/
|
|
359
|
-
fieldsets?: Set[];
|
|
360
|
-
}
|
|
361
|
-
export declare enum Set {
|
|
362
|
-
/** Public properties of the entity */
|
|
363
|
-
PUBLIC = "PUBLIC",
|
|
364
|
-
/** Extended properties of the entity */
|
|
365
|
-
EXTENDED = "EXTENDED",
|
|
366
|
-
/** Full entity defined in the doc */
|
|
367
|
-
FULL = "FULL"
|
|
368
|
-
}
|
|
369
|
-
/** Member profile. */
|
|
370
|
-
export interface GetMyMemberResponse {
|
|
371
|
-
/** The logged-in member. */
|
|
372
|
-
member?: Member;
|
|
373
|
-
}
|
|
374
|
-
export interface GetMemberRequest {
|
|
375
|
-
/** Member ID. */
|
|
376
|
-
_id: string;
|
|
377
|
-
/**
|
|
378
|
-
* @internal
|
|
379
|
-
* @internal */
|
|
380
|
-
fieldSet?: Set;
|
|
381
|
-
/**
|
|
382
|
-
* Predefined set of fields to return. One of:
|
|
383
|
-
* - `"FULL"`: Returns all fields.
|
|
384
|
-
* - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
385
|
-
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
386
|
-
*
|
|
387
|
-
*
|
|
388
|
-
*/
|
|
389
|
-
fieldsets?: Set[];
|
|
390
|
-
}
|
|
391
|
-
export interface GetMemberResponse {
|
|
392
|
-
/** The requested member. */
|
|
393
|
-
member?: Member;
|
|
394
|
-
}
|
|
395
|
-
export interface MemberToMemberBlockedPayload {
|
|
396
|
-
/** Member ID. */
|
|
397
|
-
memberId?: string;
|
|
398
|
-
}
|
|
399
|
-
export interface ListMembersRequest {
|
|
400
|
-
paging?: Paging;
|
|
401
|
-
/**
|
|
402
|
-
* @internal
|
|
403
|
-
* @internal */
|
|
404
|
-
fieldSet?: Set;
|
|
405
|
-
/**
|
|
406
|
-
* Predefined set of fields to return. One of:
|
|
407
|
-
* - `"FULL"`: Returns all fields.
|
|
408
|
-
* - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
409
|
-
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
410
|
-
*
|
|
411
|
-
* Default: `"PUBLIC"`.
|
|
412
|
-
*/
|
|
413
|
-
fieldsets?: Set[];
|
|
414
|
-
sorting?: Sorting[];
|
|
415
|
-
}
|
|
416
|
-
export interface Paging {
|
|
417
|
-
/** Number of items to load. */
|
|
418
|
-
limit?: number | null;
|
|
419
|
-
/** Number of items to skip in the current sort order. */
|
|
420
|
-
offset?: number | null;
|
|
421
|
-
}
|
|
422
|
-
export interface Sorting {
|
|
423
|
-
/** Name of the field to sort by. */
|
|
424
|
-
fieldName?: string;
|
|
425
|
-
/** Sort order. */
|
|
426
|
-
order?: SortOrder;
|
|
427
|
-
}
|
|
428
|
-
export declare enum SortOrder {
|
|
429
|
-
ASC = "ASC",
|
|
430
|
-
DESC = "DESC"
|
|
431
|
-
}
|
|
432
|
-
export interface CursorPaging {
|
|
433
|
-
/** Maximum number of items to return in the results. */
|
|
434
|
-
limit?: number | null;
|
|
435
|
-
/**
|
|
436
|
-
* Pointer to the next or previous page in the list of results.
|
|
437
|
-
*
|
|
438
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
439
|
-
* Not relevant for the first request.
|
|
440
|
-
*/
|
|
441
|
-
cursor?: string | null;
|
|
442
|
-
}
|
|
443
|
-
export interface ListMembersResponse {
|
|
444
|
-
/** List of members. */
|
|
445
|
-
members?: Member[];
|
|
446
|
-
/** Metadata for the paginated results. */
|
|
447
|
-
metadata?: PagingMetadata;
|
|
448
|
-
}
|
|
449
|
-
export interface PagingMetadata {
|
|
450
|
-
/** Number of items returned in the response. */
|
|
451
|
-
count?: number | null;
|
|
452
|
-
/** Offset that was requested. */
|
|
453
|
-
offset?: number | null;
|
|
454
|
-
/** Total number of items that match the query. */
|
|
455
|
-
total?: number | null;
|
|
456
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
457
|
-
tooManyToCount?: boolean | null;
|
|
458
|
-
}
|
|
459
|
-
export interface CursorPagingMetadata {
|
|
460
|
-
/** Number of items returned in the response. */
|
|
461
|
-
count?: number | null;
|
|
462
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
463
|
-
cursors?: Cursors;
|
|
464
|
-
/**
|
|
465
|
-
* Whether there are more pages to retrieve following the current page.
|
|
466
|
-
*
|
|
467
|
-
* + `true`: Another page of results can be retrieved.
|
|
468
|
-
* + `false`: This is the last page.
|
|
469
|
-
*/
|
|
470
|
-
hasNext?: boolean | null;
|
|
471
|
-
}
|
|
472
|
-
export interface Cursors {
|
|
473
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
474
|
-
next?: string | null;
|
|
475
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
476
|
-
prev?: string | null;
|
|
477
|
-
}
|
|
478
|
-
export interface QueryMembersRequest {
|
|
479
|
-
/** Query options. */
|
|
480
|
-
query?: Query;
|
|
481
|
-
/**
|
|
482
|
-
* @internal
|
|
483
|
-
* @internal */
|
|
484
|
-
fieldSet?: Set;
|
|
485
|
-
/**
|
|
486
|
-
* Predefined sets of fields to return.
|
|
487
|
-
*
|
|
488
|
-
* Defaults to `PUBLIC`.
|
|
489
|
-
*/
|
|
490
|
-
fieldsets?: Set[];
|
|
491
|
-
/** Plain text search. */
|
|
492
|
-
search?: Search;
|
|
493
|
-
}
|
|
494
|
-
export interface Query {
|
|
495
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
496
|
-
filter?: any;
|
|
497
|
-
/** Limit number of results */
|
|
498
|
-
paging?: Paging;
|
|
499
|
-
/** Sort the results */
|
|
500
|
-
sorting?: Sorting[];
|
|
501
|
-
}
|
|
502
|
-
/** Free text to match in searchable fields */
|
|
503
|
-
export interface Search {
|
|
504
|
-
/** Search term or expression */
|
|
505
|
-
expression?: string | null;
|
|
506
|
-
/**
|
|
507
|
-
* Currently supported fields for search:
|
|
508
|
-
*
|
|
509
|
-
* - `loginEmail`
|
|
510
|
-
* - `contact.firstName`
|
|
511
|
-
* - `contact.lastName`
|
|
512
|
-
* - `profile.title`
|
|
513
|
-
* - `profile.nickname`
|
|
514
|
-
* - `profile.slug`
|
|
515
|
-
*
|
|
516
|
-
* Default is `profile.nickname`
|
|
517
|
-
*/
|
|
518
|
-
fields?: string[];
|
|
519
|
-
}
|
|
520
|
-
export interface QueryMembersResponse {
|
|
521
|
-
/** List of members that met the query filter criteria. */
|
|
522
|
-
members?: Member[];
|
|
523
|
-
/** Metadata for the paginated results. */
|
|
524
|
-
metadata?: PagingMetadata;
|
|
525
|
-
}
|
|
526
|
-
export interface MuteMemberRequest {
|
|
527
|
-
_id?: string;
|
|
528
|
-
}
|
|
529
|
-
export interface MuteMemberResponse {
|
|
530
|
-
member?: Member;
|
|
531
|
-
}
|
|
532
|
-
export interface MemberMuted {
|
|
533
|
-
/**
|
|
534
|
-
* Member id who got muted
|
|
535
|
-
* @readonly
|
|
536
|
-
*/
|
|
537
|
-
memberId?: string;
|
|
538
|
-
}
|
|
539
|
-
export interface UnmuteMemberRequest {
|
|
540
|
-
_id?: string;
|
|
541
|
-
}
|
|
542
|
-
export interface UnmuteMemberResponse {
|
|
543
|
-
member?: Member;
|
|
544
|
-
}
|
|
545
|
-
export interface MemberUnmuted {
|
|
546
|
-
/**
|
|
547
|
-
* Member id who got unmuted
|
|
548
|
-
* @readonly
|
|
549
|
-
*/
|
|
550
|
-
memberId?: string;
|
|
551
|
-
}
|
|
552
|
-
export interface ApproveMemberRequest {
|
|
553
|
-
_id?: string;
|
|
554
|
-
}
|
|
555
|
-
export interface ApproveMemberResponse {
|
|
556
|
-
member?: Member;
|
|
557
|
-
}
|
|
558
|
-
export interface MemberApproved {
|
|
559
|
-
/**
|
|
560
|
-
* Member id who got approved
|
|
561
|
-
* @readonly
|
|
562
|
-
*/
|
|
563
|
-
memberId?: string;
|
|
564
|
-
}
|
|
565
|
-
export interface BlockMemberRequest {
|
|
566
|
-
_id?: string;
|
|
567
|
-
}
|
|
568
|
-
export interface BlockMemberResponse {
|
|
569
|
-
member?: Member;
|
|
570
|
-
}
|
|
571
|
-
export interface MemberBlocked {
|
|
572
|
-
/**
|
|
573
|
-
* Member id who got blocked
|
|
574
|
-
* @readonly
|
|
575
|
-
*/
|
|
576
|
-
memberId?: string;
|
|
577
|
-
}
|
|
578
|
-
export interface MemberSelfBlockForbiddenPayload {
|
|
579
|
-
/** Target's member ID. */
|
|
580
|
-
memberId?: string;
|
|
581
|
-
}
|
|
582
|
-
export interface OwnerMemberBlockForbiddenPayload {
|
|
583
|
-
/** Owner's member ID. */
|
|
584
|
-
memberId?: string;
|
|
585
|
-
}
|
|
586
|
-
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
587
|
-
/** Active subscription member ID. */
|
|
588
|
-
memberId?: string;
|
|
589
|
-
}
|
|
590
|
-
export interface DisconnectMemberRequest {
|
|
591
|
-
_id?: string;
|
|
592
|
-
}
|
|
593
|
-
export interface DisconnectMemberResponse {
|
|
594
|
-
member?: Member;
|
|
595
|
-
}
|
|
596
|
-
export interface DeleteMemberRequest {
|
|
597
|
-
/** ID of the member to delete. */
|
|
598
|
-
_id: string;
|
|
599
|
-
}
|
|
600
|
-
export interface DeleteMemberResponse {
|
|
601
|
-
}
|
|
602
|
-
export interface ContentReassignmentRequested {
|
|
603
|
-
fromMember?: Member;
|
|
604
|
-
toMember?: Member;
|
|
605
|
-
}
|
|
606
|
-
export interface ContentDeletionRequested {
|
|
607
|
-
member?: Member;
|
|
608
|
-
}
|
|
609
|
-
export interface DeleteMyMemberRequest {
|
|
610
|
-
/** ID of a member receiving deleted member's content */
|
|
611
|
-
contentAssigneeId?: string | null;
|
|
612
|
-
}
|
|
613
|
-
export interface DeleteMyMemberResponse {
|
|
614
|
-
}
|
|
615
|
-
export interface BulkDeleteMembersRequest {
|
|
616
|
-
/** Member ids to be deleted */
|
|
617
|
-
memberIds?: string[];
|
|
618
|
-
}
|
|
619
|
-
export interface BulkDeleteMembersResponse {
|
|
620
|
-
/** Results. */
|
|
621
|
-
results?: BulkMemberResult[];
|
|
622
|
-
/** Bulk action result metadata */
|
|
623
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
624
|
-
}
|
|
625
|
-
export interface ItemMetadata {
|
|
626
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
627
|
-
_id?: string | null;
|
|
628
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
629
|
-
originalIndex?: number;
|
|
630
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
631
|
-
success?: boolean;
|
|
632
|
-
/** Details about the error in case of failure. */
|
|
633
|
-
error?: ApplicationError;
|
|
634
|
-
}
|
|
635
|
-
export interface ApplicationError {
|
|
636
|
-
/** Error code. */
|
|
637
|
-
code?: string;
|
|
638
|
-
/** Description of the error. */
|
|
639
|
-
description?: string;
|
|
640
|
-
/** Data related to the error. */
|
|
641
|
-
data?: Record<string, any> | null;
|
|
642
|
-
}
|
|
643
|
-
export interface BulkMemberResult {
|
|
644
|
-
itemMetadata?: ItemMetadata;
|
|
645
|
-
}
|
|
646
|
-
export interface BulkActionMetadata {
|
|
647
|
-
/** Number of items that were successfully processed. */
|
|
648
|
-
totalSuccesses?: number;
|
|
649
|
-
/** Number of items that couldn't be processed. */
|
|
650
|
-
totalFailures?: number;
|
|
651
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
652
|
-
undetailedFailures?: number;
|
|
653
|
-
}
|
|
654
|
-
export interface BulkDeleteMembersByFilterRequest {
|
|
655
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
656
|
-
filter?: any;
|
|
657
|
-
/** ID of a member receiving deleted members' content. */
|
|
658
|
-
contentAssigneeId?: string | null;
|
|
659
|
-
/** Plain text search. */
|
|
660
|
-
search?: Search;
|
|
661
|
-
}
|
|
662
|
-
export interface BulkDeleteMembersByFilterResponse {
|
|
663
|
-
/** Token to be used to query an "async jobs service" */
|
|
664
|
-
jobId?: string;
|
|
665
|
-
}
|
|
666
|
-
export interface BulkApproveMembersRequest {
|
|
667
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
668
|
-
filter?: any;
|
|
669
|
-
}
|
|
670
|
-
export interface BulkApproveMembersResponse {
|
|
671
|
-
/** Token to be used to query an "async jobs service" */
|
|
672
|
-
jobId?: string;
|
|
673
|
-
}
|
|
674
|
-
export interface BulkBlockMembersRequest {
|
|
675
|
-
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
676
|
-
filter?: any;
|
|
677
|
-
}
|
|
678
|
-
export interface BulkBlockMembersResponse {
|
|
679
|
-
/** Token to be used to query an "async jobs service" */
|
|
680
|
-
jobId?: string;
|
|
681
|
-
}
|
|
682
|
-
export interface CreateMemberRequest {
|
|
683
|
-
/** Member to create. */
|
|
684
|
-
member: Member;
|
|
685
|
-
}
|
|
686
|
-
export interface CreateMemberResponse {
|
|
687
|
-
/** New member. */
|
|
688
|
-
member?: Member;
|
|
689
|
-
}
|
|
690
|
-
export interface UpdateMemberRequest {
|
|
691
|
-
/** Member to update. */
|
|
692
|
-
member?: Member;
|
|
693
|
-
}
|
|
694
|
-
export interface UpdateMemberResponse {
|
|
695
|
-
member?: Member;
|
|
696
|
-
}
|
|
697
|
-
export interface DeleteMemberPhonesRequest {
|
|
698
|
-
/** ID of the member whose phone numbers will be deleted. */
|
|
699
|
-
_id: string;
|
|
700
|
-
}
|
|
701
|
-
export interface DeleteMemberPhonesResponse {
|
|
702
|
-
/** Updated member. */
|
|
703
|
-
member?: Member;
|
|
704
|
-
}
|
|
705
|
-
export interface DeleteMemberEmailsRequest {
|
|
706
|
-
/** ID of the member whose email addresses will be deleted. */
|
|
707
|
-
_id: string;
|
|
708
|
-
}
|
|
709
|
-
export interface DeleteMemberEmailsResponse {
|
|
710
|
-
/** Updated member. */
|
|
711
|
-
member?: Member;
|
|
712
|
-
}
|
|
713
|
-
export interface DeleteMemberAddressesRequest {
|
|
714
|
-
/** ID of the member whose street addresses will be deleted. */
|
|
715
|
-
_id: string;
|
|
716
|
-
}
|
|
717
|
-
export interface DeleteMemberAddressesResponse {
|
|
718
|
-
/** Updated member. */
|
|
719
|
-
member?: Member;
|
|
720
|
-
}
|
|
721
|
-
export interface Empty {
|
|
722
|
-
}
|
|
723
|
-
export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
|
|
724
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
725
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
726
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
727
|
-
actionEvent?: ActionEvent<T>;
|
|
728
|
-
/**
|
|
729
|
-
* Unique event ID.
|
|
730
|
-
* Allows clients to ignore duplicate webhooks.
|
|
731
|
-
*/
|
|
732
|
-
_id?: string;
|
|
733
|
-
/**
|
|
734
|
-
* Assumes actions are also always typed to an entity_type
|
|
735
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
736
|
-
*/
|
|
737
|
-
entityFqdn?: string;
|
|
738
|
-
/**
|
|
739
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
740
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
741
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
742
|
-
*/
|
|
743
|
-
slug?: string;
|
|
744
|
-
/** ID of the entity associated with the event. */
|
|
745
|
-
entityId?: string;
|
|
746
|
-
/** Event timestamp. */
|
|
747
|
-
eventTime?: Date;
|
|
748
|
-
/**
|
|
749
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
750
|
-
* (for example, GDPR).
|
|
751
|
-
*/
|
|
752
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
753
|
-
/** If present, indicates the action that triggered the event. */
|
|
754
|
-
originatedFrom?: string | null;
|
|
755
|
-
/**
|
|
756
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
757
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
758
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
759
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
760
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
761
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
762
|
-
*/
|
|
763
|
-
entityEventSequence?: string | null;
|
|
764
|
-
}
|
|
765
|
-
export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
766
|
-
}
|
|
767
|
-
export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
|
|
768
|
-
}
|
|
769
|
-
export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
|
|
770
|
-
}
|
|
771
|
-
export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
|
|
772
|
-
}
|
|
773
|
-
/** @oneof */
|
|
774
|
-
export interface DomainEventBodyOneOf<T> {
|
|
775
|
-
createdEvent?: EntityCreatedEvent<T>;
|
|
776
|
-
updatedEvent?: EntityUpdatedEvent<T>;
|
|
777
|
-
deletedEvent?: EntityDeletedEvent<T>;
|
|
778
|
-
actionEvent?: ActionEvent<T>;
|
|
779
|
-
}
|
|
780
|
-
export interface EntityCreatedEvent<T> {
|
|
781
|
-
entity?: T;
|
|
782
|
-
}
|
|
783
|
-
export interface EntityUpdatedEvent<T> {
|
|
784
|
-
/**
|
|
785
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
786
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
787
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
788
|
-
*/
|
|
789
|
-
currentEntity?: T;
|
|
790
|
-
}
|
|
791
|
-
export interface EntityDeletedEvent<T> {
|
|
792
|
-
/** Entity that was deleted */
|
|
793
|
-
deletedEntity?: T | null;
|
|
794
|
-
}
|
|
795
|
-
export interface ActionEvent<T> {
|
|
796
|
-
body?: T;
|
|
797
|
-
}
|
|
798
|
-
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
799
|
-
/** Emitted on a meta site creation. */
|
|
800
|
-
siteCreated?: SiteCreated;
|
|
801
|
-
/** Emitted on a meta site transfer completion. */
|
|
802
|
-
siteTransferred?: SiteTransferred;
|
|
803
|
-
/** Emitted on a meta site deletion. */
|
|
804
|
-
siteDeleted?: SiteDeleted;
|
|
805
|
-
/** Emitted on a meta site restoration. */
|
|
806
|
-
siteUndeleted?: SiteUndeleted;
|
|
807
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
808
|
-
sitePublished?: SitePublished;
|
|
809
|
-
/** Emitted on a meta site unpublish. */
|
|
810
|
-
siteUnpublished?: SiteUnpublished;
|
|
811
|
-
/** Emitted when meta site is marked as template. */
|
|
812
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
813
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
814
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
815
|
-
/** Emitted when an application is provisioned (installed). */
|
|
816
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
817
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
818
|
-
serviceRemoved?: ServiceRemoved;
|
|
819
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
820
|
-
siteRenamedPayload?: SiteRenamed;
|
|
821
|
-
/** Emitted when meta site was permanently deleted. */
|
|
822
|
-
hardDeleted?: SiteHardDeleted;
|
|
823
|
-
/** Emitted on a namespace change. */
|
|
824
|
-
namespaceChanged?: NamespaceChanged;
|
|
825
|
-
/** Emitted when Studio is attached. */
|
|
826
|
-
studioAssigned?: StudioAssigned;
|
|
827
|
-
/** Emitted when Studio is detached. */
|
|
828
|
-
studioUnassigned?: StudioUnassigned;
|
|
829
|
-
/** A meta site id. */
|
|
830
|
-
metaSiteId?: string;
|
|
831
|
-
/** A meta site version. Monotonically increasing. */
|
|
832
|
-
version?: string;
|
|
833
|
-
/** A timestamp of the event. */
|
|
834
|
-
timestamp?: string;
|
|
835
|
-
/** A list of "assets" (applications). The same as MetaSiteContext. */
|
|
836
|
-
assets?: Asset[];
|
|
837
|
-
}
|
|
838
|
-
/** @oneof */
|
|
839
|
-
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
840
|
-
/** Emitted on a meta site creation. */
|
|
841
|
-
siteCreated?: SiteCreated;
|
|
842
|
-
/** Emitted on a meta site transfer completion. */
|
|
843
|
-
siteTransferred?: SiteTransferred;
|
|
844
|
-
/** Emitted on a meta site deletion. */
|
|
845
|
-
siteDeleted?: SiteDeleted;
|
|
846
|
-
/** Emitted on a meta site restoration. */
|
|
847
|
-
siteUndeleted?: SiteUndeleted;
|
|
848
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
849
|
-
sitePublished?: SitePublished;
|
|
850
|
-
/** Emitted on a meta site unpublish. */
|
|
851
|
-
siteUnpublished?: SiteUnpublished;
|
|
852
|
-
/** Emitted when meta site is marked as template. */
|
|
853
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
854
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
855
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
856
|
-
/** Emitted when an application is provisioned (installed). */
|
|
857
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
858
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
859
|
-
serviceRemoved?: ServiceRemoved;
|
|
860
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
861
|
-
siteRenamedPayload?: SiteRenamed;
|
|
862
|
-
/** Emitted when meta site was permanently deleted. */
|
|
863
|
-
hardDeleted?: SiteHardDeleted;
|
|
864
|
-
/** Emitted on a namespace change. */
|
|
865
|
-
namespaceChanged?: NamespaceChanged;
|
|
866
|
-
/** Emitted when Studio is attached. */
|
|
867
|
-
studioAssigned?: StudioAssigned;
|
|
868
|
-
/** Emitted when Studio is detached. */
|
|
869
|
-
studioUnassigned?: StudioUnassigned;
|
|
870
|
-
}
|
|
871
|
-
export interface Asset {
|
|
872
|
-
/** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
|
|
873
|
-
appDefId?: string;
|
|
874
|
-
/** An instance id. For legacy reasons may be UUID or a string. */
|
|
875
|
-
instanceId?: string;
|
|
876
|
-
/** An application state. */
|
|
877
|
-
state?: State;
|
|
878
|
-
}
|
|
879
|
-
export declare enum State {
|
|
880
|
-
UNKNOWN = "UNKNOWN",
|
|
881
|
-
ENABLED = "ENABLED",
|
|
882
|
-
DISABLED = "DISABLED",
|
|
883
|
-
PENDING = "PENDING",
|
|
884
|
-
DEMO = "DEMO"
|
|
885
|
-
}
|
|
886
|
-
export interface SiteCreated {
|
|
887
|
-
/** A template identifier (empty if not created from a template). */
|
|
888
|
-
originTemplateId?: string;
|
|
889
|
-
/** An account id of the owner. */
|
|
890
|
-
ownerId?: string;
|
|
891
|
-
/** A context in which meta site was created. */
|
|
892
|
-
context?: SiteCreatedContext;
|
|
893
|
-
/**
|
|
894
|
-
* A meta site id from which this site was created.
|
|
895
|
-
*
|
|
896
|
-
* In case of a creation from a template it's a template id.
|
|
897
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
898
|
-
*/
|
|
899
|
-
originMetaSiteId?: string | null;
|
|
900
|
-
/** A meta site name (URL slug). */
|
|
901
|
-
siteName?: string;
|
|
902
|
-
/** A namespace. */
|
|
903
|
-
namespace?: Namespace;
|
|
904
|
-
}
|
|
905
|
-
export declare enum SiteCreatedContext {
|
|
906
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
907
|
-
OTHER = "OTHER",
|
|
908
|
-
/** A meta site was created from template. */
|
|
909
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
910
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
911
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
912
|
-
/** A copy of existing meta site. */
|
|
913
|
-
DUPLICATE = "DUPLICATE",
|
|
914
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
915
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
916
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
917
|
-
FLASH = "FLASH"
|
|
918
|
-
}
|
|
919
|
-
export declare enum Namespace {
|
|
920
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
921
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
922
|
-
WIX = "WIX",
|
|
923
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
924
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
925
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
926
|
-
ALBUMS = "ALBUMS",
|
|
927
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
928
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
929
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
930
|
-
HOTELS = "HOTELS",
|
|
931
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
932
|
-
CLUBS = "CLUBS",
|
|
933
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
934
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
935
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
936
|
-
DEV_SITE = "DEV_SITE",
|
|
937
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
938
|
-
LOGOS = "LOGOS",
|
|
939
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
940
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
941
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
942
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
943
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
944
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
945
|
-
/**
|
|
946
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
947
|
-
*
|
|
948
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
949
|
-
*/
|
|
950
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
951
|
-
/**
|
|
952
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
953
|
-
* Will be accessible from Site List and will not have a website app.
|
|
954
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
955
|
-
*/
|
|
956
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
957
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
958
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
959
|
-
/** It is to be used in the Business First efforts. */
|
|
960
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
961
|
-
/** Bookings business flow with no site. */
|
|
962
|
-
ANYWHERE = "ANYWHERE",
|
|
963
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
964
|
-
HEADLESS = "HEADLESS",
|
|
965
|
-
/**
|
|
966
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
967
|
-
* The site will be used for account level CSM feature for enterprise
|
|
968
|
-
*/
|
|
969
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
970
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
971
|
-
RISE = "RISE",
|
|
972
|
-
/**
|
|
973
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
974
|
-
* There's a blank site behind the scene but it's blank).
|
|
975
|
-
* The Mobile company will be the owner of this namespace.
|
|
976
|
-
*/
|
|
977
|
-
BRANDED_FIRST = "BRANDED_FIRST"
|
|
978
|
-
}
|
|
979
|
-
/** Site transferred to another user. */
|
|
980
|
-
export interface SiteTransferred {
|
|
981
|
-
/** A previous owner id (user that transfers meta site). */
|
|
982
|
-
oldOwnerId?: string;
|
|
983
|
-
/** A new owner id (user that accepts meta site). */
|
|
984
|
-
newOwnerId?: string;
|
|
985
|
-
}
|
|
986
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
987
|
-
export interface SiteDeleted {
|
|
988
|
-
/** A deletion context. */
|
|
989
|
-
deleteContext?: DeleteContext;
|
|
990
|
-
}
|
|
991
|
-
export interface DeleteContext {
|
|
992
|
-
/** When the meta site was deleted. */
|
|
993
|
-
dateDeleted?: Date;
|
|
994
|
-
/** A status. */
|
|
995
|
-
deleteStatus?: DeleteStatus;
|
|
996
|
-
/** A reason (flow). */
|
|
997
|
-
deleteOrigin?: string;
|
|
998
|
-
/** A service that deleted it. */
|
|
999
|
-
initiatorId?: string | null;
|
|
1000
|
-
}
|
|
1001
|
-
export declare enum DeleteStatus {
|
|
1002
|
-
UNKNOWN = "UNKNOWN",
|
|
1003
|
-
TRASH = "TRASH",
|
|
1004
|
-
DELETED = "DELETED",
|
|
1005
|
-
PENDING_PURGE = "PENDING_PURGE"
|
|
1006
|
-
}
|
|
1007
|
-
/** Restoration of the meta site. */
|
|
1008
|
-
export interface SiteUndeleted {
|
|
1009
|
-
}
|
|
1010
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1011
|
-
export interface SitePublished {
|
|
1012
|
-
}
|
|
1013
|
-
export interface SiteUnpublished {
|
|
1014
|
-
/** A list of URLs previously associated with the meta site. */
|
|
1015
|
-
urls?: string[];
|
|
1016
|
-
}
|
|
1017
|
-
export interface SiteMarkedAsTemplate {
|
|
1018
|
-
}
|
|
1019
|
-
export interface SiteMarkedAsWixSite {
|
|
1020
|
-
}
|
|
1021
|
-
export interface ServiceProvisioned {
|
|
1022
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
1023
|
-
appDefId?: string;
|
|
1024
|
-
/** Not only UUID. Something here could be something weird. */
|
|
1025
|
-
instanceId?: string;
|
|
1026
|
-
/** An instance id from which this instance is originated. */
|
|
1027
|
-
originInstanceId?: string;
|
|
1028
|
-
/** A version. */
|
|
1029
|
-
version?: string | null;
|
|
1030
|
-
}
|
|
1031
|
-
export interface ServiceRemoved {
|
|
1032
|
-
/** Either UUID or EmbeddedServiceType. */
|
|
1033
|
-
appDefId?: string;
|
|
1034
|
-
/** Not only UUID. Something here could be something weird. */
|
|
1035
|
-
instanceId?: string;
|
|
1036
|
-
/** A version. */
|
|
1037
|
-
version?: string | null;
|
|
1038
|
-
}
|
|
1039
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1040
|
-
export interface SiteRenamed {
|
|
1041
|
-
/** A new meta site name (URL slug). */
|
|
1042
|
-
newSiteName?: string;
|
|
1043
|
-
/** A previous meta site name (URL slug). */
|
|
1044
|
-
oldSiteName?: string;
|
|
1045
|
-
}
|
|
1046
|
-
/**
|
|
1047
|
-
* Hard deletion of the meta site.
|
|
1048
|
-
*
|
|
1049
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1050
|
-
*/
|
|
1051
|
-
export interface SiteHardDeleted {
|
|
1052
|
-
/** A deletion context. */
|
|
1053
|
-
deleteContext?: DeleteContext;
|
|
1054
|
-
}
|
|
1055
|
-
export interface NamespaceChanged {
|
|
1056
|
-
/** A previous namespace. */
|
|
1057
|
-
oldNamespace?: Namespace;
|
|
1058
|
-
/** A new namespace. */
|
|
1059
|
-
newNamespace?: Namespace;
|
|
1060
|
-
}
|
|
1061
|
-
/** Assigned Studio editor */
|
|
1062
|
-
export interface StudioAssigned {
|
|
1063
|
-
}
|
|
1064
|
-
/** Unassigned Studio editor */
|
|
1065
|
-
export interface StudioUnassigned {
|
|
1066
|
-
}
|
|
1067
|
-
export interface MemberOwnershipTransferred {
|
|
1068
|
-
fromMember?: Member;
|
|
1069
|
-
toMember?: Member;
|
|
1070
|
-
}
|
|
1071
|
-
export interface MemberIdChanged {
|
|
1072
|
-
fromId?: string;
|
|
1073
|
-
toId?: string;
|
|
1074
|
-
}
|
|
1075
|
-
export interface UpdateMySlugResponseNonNullableFields {
|
|
1076
|
-
member?: {
|
|
1077
|
-
status: Status;
|
|
1078
|
-
contact?: {
|
|
1079
|
-
addresses: {
|
|
1080
|
-
streetAddress?: {
|
|
1081
|
-
number: string;
|
|
1082
|
-
name: string;
|
|
1083
|
-
};
|
|
1084
|
-
}[];
|
|
1085
|
-
};
|
|
1086
|
-
profile?: {
|
|
1087
|
-
photo?: {
|
|
1088
|
-
_id: string;
|
|
1089
|
-
url: string;
|
|
1090
|
-
height: number;
|
|
1091
|
-
width: number;
|
|
1092
|
-
};
|
|
1093
|
-
cover?: {
|
|
1094
|
-
_id: string;
|
|
1095
|
-
url: string;
|
|
1096
|
-
height: number;
|
|
1097
|
-
width: number;
|
|
1098
|
-
};
|
|
1099
|
-
};
|
|
1100
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1101
|
-
activityStatus: ActivityStatusStatus;
|
|
1102
|
-
};
|
|
1103
|
-
}
|
|
1104
|
-
export interface JoinCommunityResponseNonNullableFields {
|
|
1105
|
-
member?: {
|
|
1106
|
-
status: Status;
|
|
1107
|
-
contact?: {
|
|
1108
|
-
addresses: {
|
|
1109
|
-
streetAddress?: {
|
|
1110
|
-
number: string;
|
|
1111
|
-
name: string;
|
|
1112
|
-
};
|
|
1113
|
-
}[];
|
|
1114
|
-
};
|
|
1115
|
-
profile?: {
|
|
1116
|
-
photo?: {
|
|
1117
|
-
_id: string;
|
|
1118
|
-
url: string;
|
|
1119
|
-
height: number;
|
|
1120
|
-
width: number;
|
|
1121
|
-
};
|
|
1122
|
-
cover?: {
|
|
1123
|
-
_id: string;
|
|
1124
|
-
url: string;
|
|
1125
|
-
height: number;
|
|
1126
|
-
width: number;
|
|
1127
|
-
};
|
|
1128
|
-
};
|
|
1129
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1130
|
-
activityStatus: ActivityStatusStatus;
|
|
1131
|
-
};
|
|
1132
|
-
}
|
|
1133
|
-
export interface LeaveCommunityResponseNonNullableFields {
|
|
1134
|
-
member?: {
|
|
1135
|
-
status: Status;
|
|
1136
|
-
contact?: {
|
|
1137
|
-
addresses: {
|
|
1138
|
-
streetAddress?: {
|
|
1139
|
-
number: string;
|
|
1140
|
-
name: string;
|
|
1141
|
-
};
|
|
1142
|
-
}[];
|
|
1143
|
-
};
|
|
1144
|
-
profile?: {
|
|
1145
|
-
photo?: {
|
|
1146
|
-
_id: string;
|
|
1147
|
-
url: string;
|
|
1148
|
-
height: number;
|
|
1149
|
-
width: number;
|
|
1150
|
-
};
|
|
1151
|
-
cover?: {
|
|
1152
|
-
_id: string;
|
|
1153
|
-
url: string;
|
|
1154
|
-
height: number;
|
|
1155
|
-
width: number;
|
|
1156
|
-
};
|
|
1157
|
-
};
|
|
1158
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1159
|
-
activityStatus: ActivityStatusStatus;
|
|
1160
|
-
};
|
|
1161
|
-
}
|
|
1162
|
-
export interface GetMyMemberResponseNonNullableFields {
|
|
1163
|
-
member?: {
|
|
1164
|
-
status: Status;
|
|
1165
|
-
contact?: {
|
|
1166
|
-
addresses: {
|
|
1167
|
-
streetAddress?: {
|
|
1168
|
-
number: string;
|
|
1169
|
-
name: string;
|
|
1170
|
-
};
|
|
1171
|
-
}[];
|
|
1172
|
-
};
|
|
1173
|
-
profile?: {
|
|
1174
|
-
photo?: {
|
|
1175
|
-
_id: string;
|
|
1176
|
-
url: string;
|
|
1177
|
-
height: number;
|
|
1178
|
-
width: number;
|
|
1179
|
-
};
|
|
1180
|
-
cover?: {
|
|
1181
|
-
_id: string;
|
|
1182
|
-
url: string;
|
|
1183
|
-
height: number;
|
|
1184
|
-
width: number;
|
|
1185
|
-
};
|
|
1186
|
-
};
|
|
1187
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1188
|
-
activityStatus: ActivityStatusStatus;
|
|
1189
|
-
};
|
|
1190
|
-
}
|
|
1191
|
-
export interface GetMemberResponseNonNullableFields {
|
|
1192
|
-
member?: {
|
|
1193
|
-
status: Status;
|
|
1194
|
-
contact?: {
|
|
1195
|
-
addresses: {
|
|
1196
|
-
streetAddress?: {
|
|
1197
|
-
number: string;
|
|
1198
|
-
name: string;
|
|
1199
|
-
};
|
|
1200
|
-
}[];
|
|
1201
|
-
};
|
|
1202
|
-
profile?: {
|
|
1203
|
-
photo?: {
|
|
1204
|
-
_id: string;
|
|
1205
|
-
url: string;
|
|
1206
|
-
height: number;
|
|
1207
|
-
width: number;
|
|
1208
|
-
};
|
|
1209
|
-
cover?: {
|
|
1210
|
-
_id: string;
|
|
1211
|
-
url: string;
|
|
1212
|
-
height: number;
|
|
1213
|
-
width: number;
|
|
1214
|
-
};
|
|
1215
|
-
};
|
|
1216
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1217
|
-
activityStatus: ActivityStatusStatus;
|
|
1218
|
-
};
|
|
1219
|
-
}
|
|
1220
|
-
export interface ListMembersResponseNonNullableFields {
|
|
1221
|
-
members: {
|
|
1222
|
-
status: Status;
|
|
1223
|
-
contact?: {
|
|
1224
|
-
addresses: {
|
|
1225
|
-
streetAddress?: {
|
|
1226
|
-
number: string;
|
|
1227
|
-
name: string;
|
|
1228
|
-
};
|
|
1229
|
-
}[];
|
|
1230
|
-
};
|
|
1231
|
-
profile?: {
|
|
1232
|
-
photo?: {
|
|
1233
|
-
_id: string;
|
|
1234
|
-
url: string;
|
|
1235
|
-
height: number;
|
|
1236
|
-
width: number;
|
|
1237
|
-
};
|
|
1238
|
-
cover?: {
|
|
1239
|
-
_id: string;
|
|
1240
|
-
url: string;
|
|
1241
|
-
height: number;
|
|
1242
|
-
width: number;
|
|
1243
|
-
};
|
|
1244
|
-
};
|
|
1245
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1246
|
-
activityStatus: ActivityStatusStatus;
|
|
1247
|
-
}[];
|
|
1248
|
-
}
|
|
1249
|
-
export interface QueryMembersResponseNonNullableFields {
|
|
1250
|
-
members: {
|
|
1251
|
-
status: Status;
|
|
1252
|
-
contact?: {
|
|
1253
|
-
addresses: {
|
|
1254
|
-
streetAddress?: {
|
|
1255
|
-
number: string;
|
|
1256
|
-
name: string;
|
|
1257
|
-
};
|
|
1258
|
-
}[];
|
|
1259
|
-
};
|
|
1260
|
-
profile?: {
|
|
1261
|
-
photo?: {
|
|
1262
|
-
_id: string;
|
|
1263
|
-
url: string;
|
|
1264
|
-
height: number;
|
|
1265
|
-
width: number;
|
|
1266
|
-
};
|
|
1267
|
-
cover?: {
|
|
1268
|
-
_id: string;
|
|
1269
|
-
url: string;
|
|
1270
|
-
height: number;
|
|
1271
|
-
width: number;
|
|
1272
|
-
};
|
|
1273
|
-
};
|
|
1274
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1275
|
-
activityStatus: ActivityStatusStatus;
|
|
1276
|
-
}[];
|
|
1277
|
-
}
|
|
1278
|
-
export interface CreateMemberResponseNonNullableFields {
|
|
1279
|
-
member?: {
|
|
1280
|
-
status: Status;
|
|
1281
|
-
contact?: {
|
|
1282
|
-
addresses: {
|
|
1283
|
-
streetAddress?: {
|
|
1284
|
-
number: string;
|
|
1285
|
-
name: string;
|
|
1286
|
-
};
|
|
1287
|
-
}[];
|
|
1288
|
-
};
|
|
1289
|
-
profile?: {
|
|
1290
|
-
photo?: {
|
|
1291
|
-
_id: string;
|
|
1292
|
-
url: string;
|
|
1293
|
-
height: number;
|
|
1294
|
-
width: number;
|
|
1295
|
-
};
|
|
1296
|
-
cover?: {
|
|
1297
|
-
_id: string;
|
|
1298
|
-
url: string;
|
|
1299
|
-
height: number;
|
|
1300
|
-
width: number;
|
|
1301
|
-
};
|
|
1302
|
-
};
|
|
1303
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1304
|
-
activityStatus: ActivityStatusStatus;
|
|
1305
|
-
};
|
|
1306
|
-
}
|
|
1307
|
-
export interface UpdateMemberResponseNonNullableFields {
|
|
1308
|
-
member?: {
|
|
1309
|
-
status: Status;
|
|
1310
|
-
contact?: {
|
|
1311
|
-
addresses: {
|
|
1312
|
-
streetAddress?: {
|
|
1313
|
-
number: string;
|
|
1314
|
-
name: string;
|
|
1315
|
-
};
|
|
1316
|
-
}[];
|
|
1317
|
-
};
|
|
1318
|
-
profile?: {
|
|
1319
|
-
photo?: {
|
|
1320
|
-
_id: string;
|
|
1321
|
-
url: string;
|
|
1322
|
-
height: number;
|
|
1323
|
-
width: number;
|
|
1324
|
-
};
|
|
1325
|
-
cover?: {
|
|
1326
|
-
_id: string;
|
|
1327
|
-
url: string;
|
|
1328
|
-
height: number;
|
|
1329
|
-
width: number;
|
|
1330
|
-
};
|
|
1331
|
-
};
|
|
1332
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1333
|
-
activityStatus: ActivityStatusStatus;
|
|
1334
|
-
};
|
|
1335
|
-
}
|
|
1336
|
-
export interface DeleteMemberPhonesResponseNonNullableFields {
|
|
1337
|
-
member?: {
|
|
1338
|
-
status: Status;
|
|
1339
|
-
contact?: {
|
|
1340
|
-
addresses: {
|
|
1341
|
-
streetAddress?: {
|
|
1342
|
-
number: string;
|
|
1343
|
-
name: string;
|
|
1344
|
-
};
|
|
1345
|
-
}[];
|
|
1346
|
-
};
|
|
1347
|
-
profile?: {
|
|
1348
|
-
photo?: {
|
|
1349
|
-
_id: string;
|
|
1350
|
-
url: string;
|
|
1351
|
-
height: number;
|
|
1352
|
-
width: number;
|
|
1353
|
-
};
|
|
1354
|
-
cover?: {
|
|
1355
|
-
_id: string;
|
|
1356
|
-
url: string;
|
|
1357
|
-
height: number;
|
|
1358
|
-
width: number;
|
|
1359
|
-
};
|
|
1360
|
-
};
|
|
1361
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1362
|
-
activityStatus: ActivityStatusStatus;
|
|
1363
|
-
};
|
|
1364
|
-
}
|
|
1365
|
-
export interface DeleteMemberEmailsResponseNonNullableFields {
|
|
1366
|
-
member?: {
|
|
1367
|
-
status: Status;
|
|
1368
|
-
contact?: {
|
|
1369
|
-
addresses: {
|
|
1370
|
-
streetAddress?: {
|
|
1371
|
-
number: string;
|
|
1372
|
-
name: string;
|
|
1373
|
-
};
|
|
1374
|
-
}[];
|
|
1375
|
-
};
|
|
1376
|
-
profile?: {
|
|
1377
|
-
photo?: {
|
|
1378
|
-
_id: string;
|
|
1379
|
-
url: string;
|
|
1380
|
-
height: number;
|
|
1381
|
-
width: number;
|
|
1382
|
-
};
|
|
1383
|
-
cover?: {
|
|
1384
|
-
_id: string;
|
|
1385
|
-
url: string;
|
|
1386
|
-
height: number;
|
|
1387
|
-
width: number;
|
|
1388
|
-
};
|
|
1389
|
-
};
|
|
1390
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1391
|
-
activityStatus: ActivityStatusStatus;
|
|
1392
|
-
};
|
|
1393
|
-
}
|
|
1394
|
-
export interface DeleteMemberAddressesResponseNonNullableFields {
|
|
1395
|
-
member?: {
|
|
1396
|
-
status: Status;
|
|
1397
|
-
contact?: {
|
|
1398
|
-
addresses: {
|
|
1399
|
-
streetAddress?: {
|
|
1400
|
-
number: string;
|
|
1401
|
-
name: string;
|
|
1402
|
-
};
|
|
1403
|
-
}[];
|
|
1404
|
-
};
|
|
1405
|
-
profile?: {
|
|
1406
|
-
photo?: {
|
|
1407
|
-
_id: string;
|
|
1408
|
-
url: string;
|
|
1409
|
-
height: number;
|
|
1410
|
-
width: number;
|
|
1411
|
-
};
|
|
1412
|
-
cover?: {
|
|
1413
|
-
_id: string;
|
|
1414
|
-
url: string;
|
|
1415
|
-
height: number;
|
|
1416
|
-
width: number;
|
|
1417
|
-
};
|
|
1418
|
-
};
|
|
1419
|
-
privacyStatus: PrivacyStatusStatus;
|
|
1420
|
-
activityStatus: ActivityStatusStatus;
|
|
1421
|
-
};
|
|
1422
|
-
}
|
|
1423
|
-
export declare const onMemberUpdated: EventDefinition<DomainUpdatedEvent<Member>, "wix.members.v1.member_updated">;
|
|
1424
|
-
export declare const onMemberDeleted: EventDefinition<DomainDeletedEvent<Member>, "wix.members.v1.member_deleted">;
|
|
1425
|
-
export declare const onMemberCreated: EventDefinition<DomainCreatedEvent<Member>, "wix.members.v1.member_created">;
|
|
1426
|
-
/**
|
|
1427
|
-
* Updates the currently logged in member's slug.
|
|
1428
|
-
*
|
|
1429
|
-
* The `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`.
|
|
1430
|
-
*
|
|
1431
|
-
* > **Note:**
|
|
1432
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1433
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1434
|
-
* @param slug - New slug.
|
|
1435
|
-
* @public
|
|
1436
|
-
* @documentationMaturity preview
|
|
1437
|
-
* @requiredField slug
|
|
1438
|
-
* @permissionScope Manage Members
|
|
1439
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1440
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1441
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1442
|
-
* @applicableIdentity APP
|
|
1443
|
-
* @applicableIdentity MEMBER
|
|
1444
|
-
*/
|
|
1445
|
-
export declare function updateCurrentMemberSlug(slug: string): Promise<UpdateMySlugResponse & UpdateMySlugResponseNonNullableFields>;
|
|
1446
|
-
/**
|
|
1447
|
-
* Joins the currently logged-in member to the site community and sets their profile to public.
|
|
1448
|
-
*
|
|
1449
|
-
* When a member's profile is public, they have access to the site's
|
|
1450
|
-
* [Members Area](https://support.wix.com/en/article/about-members-area)
|
|
1451
|
-
* features — such as chat, forum, and followers —
|
|
1452
|
-
* and their profile is visible to other members and site visitors.
|
|
1453
|
-
*
|
|
1454
|
-
* > **Note:**
|
|
1455
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1456
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1457
|
-
* @public
|
|
1458
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1459
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1460
|
-
* @applicableIdentity APP
|
|
1461
|
-
* @applicableIdentity MEMBER
|
|
1462
|
-
* @returns Member profile.
|
|
1463
|
-
*/
|
|
1464
|
-
export declare function joinCommunity(): Promise<JoinCommunityResponse & JoinCommunityResponseNonNullableFields>;
|
|
1465
|
-
/**
|
|
1466
|
-
* Removes the currently logged-in member from the site community and sets their profile to private.
|
|
1467
|
-
*
|
|
1468
|
-
* When a member's profile is private,
|
|
1469
|
-
* they do not have access to the site's
|
|
1470
|
-
* [Members Area](https://support.wix.com/en/article/about-members-area)
|
|
1471
|
-
* features — such as chat, forum, and followers —
|
|
1472
|
-
* and their profile is hidden from other members and site visitors.
|
|
1473
|
-
*
|
|
1474
|
-
* > **Notes:**
|
|
1475
|
-
* > + If a member leaves the site's community, their content (such as forum posts and blog comments) remain publicly visible.
|
|
1476
|
-
*
|
|
1477
|
-
* > + Only logged-in members can call this function without elevated permissions.
|
|
1478
|
-
* > + To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1479
|
-
* @public
|
|
1480
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1481
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1482
|
-
* @applicableIdentity APP
|
|
1483
|
-
* @applicableIdentity MEMBER
|
|
1484
|
-
* @returns Member profile.
|
|
1485
|
-
*/
|
|
1486
|
-
export declare function leaveCommunity(): Promise<LeaveCommunityResponse & LeaveCommunityResponseNonNullableFields>;
|
|
1487
|
-
/**
|
|
1488
|
-
* Retrieves the currently logged-in member.
|
|
1489
|
-
* @public
|
|
1490
|
-
* @documentationMaturity preview
|
|
1491
|
-
* @permissionScope Manage Members
|
|
1492
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1493
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1494
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1495
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1496
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1497
|
-
* @permissionScope Read Members
|
|
1498
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1499
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1500
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1501
|
-
* @applicableIdentity APP
|
|
1502
|
-
* @applicableIdentity MEMBER
|
|
1503
|
-
* @applicableIdentity VISITOR
|
|
1504
|
-
* @returns Member profile.
|
|
1505
|
-
*/
|
|
1506
|
-
export declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<GetMyMemberResponse & GetMyMemberResponseNonNullableFields>;
|
|
1507
|
-
export interface GetCurrentMemberOptions {
|
|
1508
|
-
/**
|
|
1509
|
-
* Predefined set of fields to return.
|
|
1510
|
-
*
|
|
1511
|
-
* - `"FULL"`: Returns all fields.
|
|
1512
|
-
* - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
|
|
1513
|
-
*
|
|
1514
|
-
* > **Note:**
|
|
1515
|
-
* > When returning the `"PUBLIC"` fieldset,
|
|
1516
|
-
* > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
|
|
1517
|
-
* > are returned as `"UNKNOWN"`.
|
|
1518
|
-
*/
|
|
1519
|
-
fieldSet?: Set;
|
|
1520
|
-
/**
|
|
1521
|
-
* Predefined set of fields to return. One of:
|
|
1522
|
-
*
|
|
1523
|
-
* - `FULL`: Returns all fields.
|
|
1524
|
-
* - `PUBLIC`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
1525
|
-
* - `EXTENDED`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1526
|
-
*
|
|
1527
|
-
* Default: `PUBLIC`.
|
|
1528
|
-
*/
|
|
1529
|
-
fieldsets?: Set[];
|
|
1530
|
-
}
|
|
1531
|
-
/**
|
|
1532
|
-
* Retrieves a member by ID.
|
|
1533
|
-
*
|
|
1534
|
-
* >**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).
|
|
1535
|
-
*
|
|
1536
|
-
* @param _id - Member ID.
|
|
1537
|
-
* @public
|
|
1538
|
-
* @requiredField _id
|
|
1539
|
-
* @param options - Fieldset options.
|
|
1540
|
-
* @permissionScope Manage Members
|
|
1541
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1542
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1543
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1544
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1545
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1546
|
-
* @permissionScope Read Members
|
|
1547
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1548
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1549
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1550
|
-
* @applicableIdentity APP
|
|
1551
|
-
* @applicableIdentity MEMBER
|
|
1552
|
-
* @applicableIdentity VISITOR
|
|
1553
|
-
* @returns The requested member.
|
|
1554
|
-
*/
|
|
1555
|
-
export declare function getMember(_id: string, options?: GetMemberOptions): Promise<Member & NonNullable<GetMemberResponseNonNullableFields>['member']>;
|
|
1556
|
-
export interface GetMemberOptions {
|
|
1557
|
-
/** @internal */
|
|
1558
|
-
fieldSet?: Set;
|
|
1559
|
-
/**
|
|
1560
|
-
* Predefined set of fields to return. One of:
|
|
1561
|
-
* - `"FULL"`: Returns all fields.
|
|
1562
|
-
* - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
1563
|
-
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1564
|
-
*
|
|
1565
|
-
* Default: `"PUBLIC"`.
|
|
1566
|
-
*/
|
|
1567
|
-
fieldsets?: Set[];
|
|
1568
|
-
}
|
|
1569
|
-
/**
|
|
1570
|
-
* Lists site members, given the provided paging and fieldsets.
|
|
1571
|
-
*
|
|
1572
|
-
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
1573
|
-
* - `FULL` fieldset returns all fields.
|
|
1574
|
-
* @public
|
|
1575
|
-
* @documentationMaturity preview
|
|
1576
|
-
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
1577
|
-
* @permissionScope Manage Members
|
|
1578
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1579
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1580
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1581
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1582
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1583
|
-
* @permissionScope Read Members
|
|
1584
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1585
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1586
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1587
|
-
* @applicableIdentity APP
|
|
1588
|
-
* @applicableIdentity MEMBER
|
|
1589
|
-
* @applicableIdentity VISITOR
|
|
1590
|
-
*/
|
|
1591
|
-
export declare function listMembers(options?: ListMembersOptions): Promise<ListMembersResponse & ListMembersResponseNonNullableFields>;
|
|
1592
|
-
export interface ListMembersOptions {
|
|
1593
|
-
/** Paging options. */
|
|
1594
|
-
paging?: Paging;
|
|
1595
|
-
/**
|
|
1596
|
-
* @internal
|
|
1597
|
-
* @internal */
|
|
1598
|
-
fieldSet?: Set;
|
|
1599
|
-
/**
|
|
1600
|
-
* Predefined set of fields to return. One of:
|
|
1601
|
-
* - `"FULL"`: Returns all fields.
|
|
1602
|
-
* - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
1603
|
-
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1604
|
-
*
|
|
1605
|
-
* Default: `"PUBLIC"`.
|
|
1606
|
-
*/
|
|
1607
|
-
fieldsets?: Set[];
|
|
1608
|
-
/** Sorting options. */
|
|
1609
|
-
sorting?: Sorting[];
|
|
1610
|
-
}
|
|
1611
|
-
/**
|
|
1612
|
-
* Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
|
|
1613
|
-
*
|
|
1614
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` function.
|
|
1615
|
-
*
|
|
1616
|
-
* You can refine the query by chaining `MembersQueryBuilder` functions onto the query. `MembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns. The functions that are chained to `queryMembers()` are applied in the order they are called.
|
|
1617
|
-
*
|
|
1618
|
-
* `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
|
|
1619
|
-
* - `skip`: `0`
|
|
1620
|
-
* - `limit`: `50`
|
|
1621
|
-
*
|
|
1622
|
-
* Currently supported fields for sorting:
|
|
1623
|
-
* - `profile.nickname`
|
|
1624
|
-
* - `contact.firstName`
|
|
1625
|
-
* - `contact.lastName`
|
|
1626
|
-
* - `createdDate`
|
|
1627
|
-
* - `lastLoginDate`
|
|
1628
|
-
*
|
|
1629
|
-
* The following `MembersQueryBuilder` functions are supported for the `queryMembers()` function. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`.
|
|
1630
|
-
* @public
|
|
1631
|
-
* @documentationMaturity preview
|
|
1632
|
-
* @param options - Query options.
|
|
1633
|
-
* @permissionScope Manage Members
|
|
1634
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1635
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1636
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1637
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1638
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1639
|
-
* @permissionScope Read Members
|
|
1640
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1641
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1642
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1643
|
-
* @applicableIdentity APP
|
|
1644
|
-
* @applicableIdentity MEMBER
|
|
1645
|
-
* @applicableIdentity VISITOR
|
|
1646
|
-
*/
|
|
1647
|
-
export declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
1648
|
-
export interface QueryMembersOptions {
|
|
1649
|
-
/**
|
|
1650
|
-
* @internal
|
|
1651
|
-
* @internal */
|
|
1652
|
-
fieldSet?: Set | undefined;
|
|
1653
|
-
/**
|
|
1654
|
-
* Predefined set of fields to return. One of:
|
|
1655
|
-
* - `"FULL"`: Returns all fields.
|
|
1656
|
-
* - `"PUBLIC"`: Returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
1657
|
-
* - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
1658
|
-
*
|
|
1659
|
-
* Default: `"PUBLIC"`.
|
|
1660
|
-
*/
|
|
1661
|
-
fieldsets?: Set[] | undefined;
|
|
1662
|
-
/** Plain text search. */
|
|
1663
|
-
search?: Search | undefined;
|
|
1664
|
-
}
|
|
1665
|
-
interface QueryOffsetResult {
|
|
1666
|
-
currentPage: number | undefined;
|
|
1667
|
-
totalPages: number | undefined;
|
|
1668
|
-
totalCount: number | undefined;
|
|
1669
|
-
hasNext: () => boolean;
|
|
1670
|
-
hasPrev: () => boolean;
|
|
1671
|
-
length: number;
|
|
1672
|
-
pageSize: number;
|
|
1673
|
-
}
|
|
1674
|
-
export interface MembersQueryResult extends QueryOffsetResult {
|
|
1675
|
-
items: Member[];
|
|
1676
|
-
query: MembersQueryBuilder;
|
|
1677
|
-
next: () => Promise<MembersQueryResult>;
|
|
1678
|
-
prev: () => Promise<MembersQueryResult>;
|
|
1679
|
-
}
|
|
1680
|
-
export interface MembersQueryBuilder {
|
|
1681
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
1682
|
-
* @param value - Value to compare against.
|
|
1683
|
-
* @documentationMaturity preview
|
|
1684
|
-
*/
|
|
1685
|
-
eq: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1686
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
1687
|
-
* @param value - Value to compare against.
|
|
1688
|
-
* @documentationMaturity preview
|
|
1689
|
-
*/
|
|
1690
|
-
ne: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1691
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
1692
|
-
* @param string - String to compare against. Case-insensitive.
|
|
1693
|
-
* @documentationMaturity preview
|
|
1694
|
-
*/
|
|
1695
|
-
startsWith: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
|
|
1696
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
1697
|
-
* @param values - List of values to compare against.
|
|
1698
|
-
* @documentationMaturity preview
|
|
1699
|
-
*/
|
|
1700
|
-
hasSome: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
|
|
1701
|
-
/** @documentationMaturity preview */
|
|
1702
|
-
in: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
1703
|
-
/** @documentationMaturity preview */
|
|
1704
|
-
exists: (propertyName: '_id' | 'loginEmail' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
|
|
1705
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1706
|
-
* @documentationMaturity preview
|
|
1707
|
-
*/
|
|
1708
|
-
limit: (limit: number) => MembersQueryBuilder;
|
|
1709
|
-
/** @param skip - Number of items to skip in the query results before returning the results.
|
|
1710
|
-
* @documentationMaturity preview
|
|
1711
|
-
*/
|
|
1712
|
-
skip: (skip: number) => MembersQueryBuilder;
|
|
1713
|
-
/** @documentationMaturity preview */
|
|
1714
|
-
find: () => Promise<MembersQueryResult>;
|
|
1715
|
-
}
|
|
1716
|
-
/**
|
|
1717
|
-
* Deletes a member.
|
|
1718
|
-
*
|
|
1719
|
-
* The `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted.
|
|
1720
|
-
*
|
|
1721
|
-
* >**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored.
|
|
1722
|
-
* @param _id - ID of the member to delete.
|
|
1723
|
-
* @public
|
|
1724
|
-
* @requiredField _id
|
|
1725
|
-
* @permissionScope Manage Members
|
|
1726
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1727
|
-
* @applicableIdentity APP
|
|
1728
|
-
*/
|
|
1729
|
-
export declare function deleteMember(_id: string): Promise<void>;
|
|
1730
|
-
/**
|
|
1731
|
-
* Creates a site member.
|
|
1732
|
-
*
|
|
1733
|
-
* After creation, you can use the `sendSetPasswordEmail()` function in the Members Authentication API to email the member with a link to set their password.
|
|
1734
|
-
* The member can log in to the site once they set their password for the first time.
|
|
1735
|
-
*
|
|
1736
|
-
* > **Note:**
|
|
1737
|
-
* > When creating multiple members, set your requests at least 1 second apart to keep below rate limits.
|
|
1738
|
-
* @param member - Member to create.
|
|
1739
|
-
* @public
|
|
1740
|
-
* @documentationMaturity preview
|
|
1741
|
-
* @requiredField member
|
|
1742
|
-
* @requiredField member.loginEmail
|
|
1743
|
-
* @permissionScope Manage Members
|
|
1744
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1745
|
-
* @applicableIdentity APP
|
|
1746
|
-
* @returns New member.
|
|
1747
|
-
*/
|
|
1748
|
-
export declare function createMember(member: Member): Promise<Member & NonNullable<CreateMemberResponseNonNullableFields>['member']>;
|
|
1749
|
-
/**
|
|
1750
|
-
* Updates a member's properties.
|
|
1751
|
-
*
|
|
1752
|
-
* Only the requested fields are updated.
|
|
1753
|
-
* To clear a field's value, set an empty value with an empty string `""`.
|
|
1754
|
-
*
|
|
1755
|
-
* > **Note:**
|
|
1756
|
-
* > Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add.
|
|
1757
|
-
* > However, passing an empty array will have no effect, and these functions must be used to clear all data from the respective array:
|
|
1758
|
-
* >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
|
|
1759
|
-
* >- To clear `contact.emails`, use `deleteMemberEmails()`.
|
|
1760
|
-
* >- To clear `contact.phones`, use `deleteMemberPhones()`.
|
|
1761
|
-
*
|
|
1762
|
-
* > **Note:**
|
|
1763
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1764
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1765
|
-
* @param _id - Member ID.
|
|
1766
|
-
* @public
|
|
1767
|
-
* @requiredField _id
|
|
1768
|
-
* @requiredField member
|
|
1769
|
-
* @param options - Member to update.
|
|
1770
|
-
* @permissionScope Manage Members
|
|
1771
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1772
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1773
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1774
|
-
* @applicableIdentity APP
|
|
1775
|
-
* @applicableIdentity MEMBER
|
|
1776
|
-
*/
|
|
1777
|
-
export declare function updateMember(_id: string | null, member: UpdateMember): Promise<Member & NonNullable<UpdateMemberResponseNonNullableFields>['member']>;
|
|
1778
|
-
export interface UpdateMember {
|
|
1779
|
-
/**
|
|
1780
|
-
* Member ID.
|
|
1781
|
-
* @readonly
|
|
1782
|
-
*/
|
|
1783
|
-
_id?: string | null;
|
|
1784
|
-
/** Email used by the member to log in to the site. */
|
|
1785
|
-
loginEmail?: string | null;
|
|
1786
|
-
/**
|
|
1787
|
-
* Whether the email used by the member has been verified.
|
|
1788
|
-
* @readonly
|
|
1789
|
-
*/
|
|
1790
|
-
loginEmailVerified?: boolean | null;
|
|
1791
|
-
/**
|
|
1792
|
-
* Member site access status.
|
|
1793
|
-
*
|
|
1794
|
-
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
1795
|
-
* - `APPROVED`: Member can log in to the site.
|
|
1796
|
-
* - `OFFLINE`: Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and cannot log in to the site.
|
|
1797
|
-
* - `BLOCKED`: Member is blocked and cannot log in to the site.
|
|
1798
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
1799
|
-
* @readonly
|
|
1800
|
-
*/
|
|
1801
|
-
status?: Status;
|
|
1802
|
-
/**
|
|
1803
|
-
* Contact ID.
|
|
1804
|
-
* @readonly
|
|
1805
|
-
*/
|
|
1806
|
-
contactId?: string | null;
|
|
1807
|
-
/**
|
|
1808
|
-
* Member's contact information. Contact information is stored in the
|
|
1809
|
-
* [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
|
|
1810
|
-
*/
|
|
1811
|
-
contact?: Contact;
|
|
1812
|
-
/** Profile display info. */
|
|
1813
|
-
profile?: Profile;
|
|
1814
|
-
/**
|
|
1815
|
-
* Member privacy status.
|
|
1816
|
-
*
|
|
1817
|
-
* - `PUBLIC`: Member is visible to everyone.
|
|
1818
|
-
* - `PRIVATE`: Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions.
|
|
1819
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
1820
|
-
*/
|
|
1821
|
-
privacyStatus?: PrivacyStatusStatus;
|
|
1822
|
-
/**
|
|
1823
|
-
* Member activity status.
|
|
1824
|
-
*
|
|
1825
|
-
* - `ACTIVE`: Member can write forum posts and blog comments.
|
|
1826
|
-
* - `MUTED`: Member cannot write forum posts or blog comments.
|
|
1827
|
-
* - `UNKNOWN`: Insufficient permissions to get the status.
|
|
1828
|
-
* @readonly
|
|
1829
|
-
*/
|
|
1830
|
-
activityStatus?: ActivityStatusStatus;
|
|
1831
|
-
/**
|
|
1832
|
-
* Date and time when the member was created.
|
|
1833
|
-
* @readonly
|
|
1834
|
-
*/
|
|
1835
|
-
_createdDate?: Date;
|
|
1836
|
-
/**
|
|
1837
|
-
* Date and time when the member was updated.
|
|
1838
|
-
* @readonly
|
|
1839
|
-
*/
|
|
1840
|
-
_updatedDate?: Date;
|
|
1841
|
-
/**
|
|
1842
|
-
* Date and time when the member last logged in to the site.
|
|
1843
|
-
* @readonly
|
|
1844
|
-
*/
|
|
1845
|
-
lastLoginDate?: Date;
|
|
1846
|
-
}
|
|
1847
|
-
/**
|
|
1848
|
-
* Clears a member's phone numbers.
|
|
1849
|
-
*
|
|
1850
|
-
* The `deleteMemberPhones()` function clears the `phones` array under the `contact` property.
|
|
1851
|
-
*
|
|
1852
|
-
* > **Note:**
|
|
1853
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1854
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1855
|
-
* @param _id - ID of the member whose phone numbers will be deleted.
|
|
1856
|
-
* @public
|
|
1857
|
-
* @requiredField _id
|
|
1858
|
-
* @permissionScope Manage Members
|
|
1859
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1860
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1861
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1862
|
-
* @applicableIdentity APP
|
|
1863
|
-
* @applicableIdentity MEMBER
|
|
1864
|
-
*/
|
|
1865
|
-
export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPhonesResponse & DeleteMemberPhonesResponseNonNullableFields>;
|
|
1866
|
-
/**
|
|
1867
|
-
* Clears a member's email addresses.
|
|
1868
|
-
*
|
|
1869
|
-
* The `deleteMemberEmails()` function clears the `emails` array under the `contact` property.
|
|
1870
|
-
*
|
|
1871
|
-
* > **Notes:**
|
|
1872
|
-
* > A member can still log in with their `loginEmail`,
|
|
1873
|
-
* > which is not cleared when this function is called.
|
|
1874
|
-
*
|
|
1875
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1876
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1877
|
-
* @param _id - ID of the member whose email addresses will be deleted.
|
|
1878
|
-
* @public
|
|
1879
|
-
* @requiredField _id
|
|
1880
|
-
* @permissionScope Manage Members
|
|
1881
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1882
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1883
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1884
|
-
* @applicableIdentity APP
|
|
1885
|
-
* @applicableIdentity MEMBER
|
|
1886
|
-
*/
|
|
1887
|
-
export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEmailsResponse & DeleteMemberEmailsResponseNonNullableFields>;
|
|
1888
|
-
/**
|
|
1889
|
-
* Deletes a member's street addresses.
|
|
1890
|
-
*
|
|
1891
|
-
* The `deleteMemberAddresses()` function clears the `addresses` array under the `contact` property.
|
|
1892
|
-
*
|
|
1893
|
-
* > **Note:**
|
|
1894
|
-
* > Only logged-in members can call this function without elevated permissions.
|
|
1895
|
-
* > To call this function as a different identity, [elevated permissions](https://www.wix.com/velo/reference/wix-auth/elevate) are required.
|
|
1896
|
-
* @param _id - ID of the member whose street addresses will be deleted.
|
|
1897
|
-
* @public
|
|
1898
|
-
* @requiredField _id
|
|
1899
|
-
* @permissionScope Manage Members
|
|
1900
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1901
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1902
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1903
|
-
* @applicableIdentity APP
|
|
1904
|
-
* @applicableIdentity MEMBER
|
|
1905
|
-
*/
|
|
1906
|
-
export declare function deleteMemberAddresses(_id: string): Promise<DeleteMemberAddressesResponse & DeleteMemberAddressesResponseNonNullableFields>;
|
|
1907
|
-
export {};
|