@wix/auto_sdk_members_members 1.0.58 → 1.0.60
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 +380 -1
- package/build/cjs/index.js +1800 -15
- package/build/cjs/index.js.map +1 -1
- package/build/{es/src/members-v1-member-members.types.d.ts → cjs/members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
- package/build/cjs/meta.d.ts +708 -1
- package/build/cjs/meta.js +1236 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{internal/cjs/src/members-v1-member-members.public.d.ts → es/index.d.mts} +72 -33
- package/build/es/index.mjs +1743 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/members-v1-member-members.types.d.ts → es/members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
- package/build/es/meta.d.mts +708 -0
- package/build/es/meta.mjs +1189 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +380 -1
- package/build/internal/cjs/index.js +1800 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
- package/build/internal/cjs/meta.d.ts +708 -1
- package/build/internal/cjs/meta.js +1236 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/{es/src/members-v1-member-members.public.d.ts → internal/es/index.d.mts} +72 -33
- package/build/internal/es/index.mjs +1743 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
- package/build/internal/es/meta.d.mts +708 -0
- package/build/internal/es/meta.mjs +1189 -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-v1-member-members.context.d.ts +0 -46
- package/build/cjs/src/members-v1-member-members.context.js +0 -59
- package/build/cjs/src/members-v1-member-members.context.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.http.d.ts +0 -229
- package/build/cjs/src/members-v1-member-members.http.js +0 -959
- package/build/cjs/src/members-v1-member-members.http.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/cjs/src/members-v1-member-members.meta.js +0 -484
- package/build/cjs/src/members-v1-member-members.meta.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.public.d.ts +0 -341
- package/build/cjs/src/members-v1-member-members.public.js +0 -198
- package/build/cjs/src/members-v1-member-members.public.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.types.js +0 -174
- package/build/cjs/src/members-v1-member-members.types.js.map +0 -1
- package/build/cjs/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/cjs/src/members-v1-member-members.universal.js +0 -1387
- package/build/cjs/src/members-v1-member-members.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-v1-member-members.context.d.ts +0 -46
- package/build/es/src/members-v1-member-members.context.js +0 -46
- package/build/es/src/members-v1-member-members.context.js.map +0 -1
- package/build/es/src/members-v1-member-members.http.d.ts +0 -229
- package/build/es/src/members-v1-member-members.http.js +0 -932
- package/build/es/src/members-v1-member-members.http.js.map +0 -1
- package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/es/src/members-v1-member-members.meta.js +0 -434
- package/build/es/src/members-v1-member-members.meta.js.map +0 -1
- package/build/es/src/members-v1-member-members.public.js +0 -161
- package/build/es/src/members-v1-member-members.public.js.map +0 -1
- package/build/es/src/members-v1-member-members.types.js +0 -171
- package/build/es/src/members-v1-member-members.types.js.map +0 -1
- package/build/es/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/es/src/members-v1-member-members.universal.js +0 -1337
- package/build/es/src/members-v1-member-members.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-v1-member-members.context.d.ts +0 -46
- package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
- package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
- package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
- package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
- package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
- package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
- package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
- package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1387
- package/build/internal/cjs/src/members-v1-member-members.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-v1-member-members.context.d.ts +0 -46
- package/build/internal/es/src/members-v1-member-members.context.js +0 -46
- package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
- package/build/internal/es/src/members-v1-member-members.http.js +0 -932
- package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
- package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
- package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.public.d.ts +0 -341
- package/build/internal/es/src/members-v1-member-members.public.js +0 -161
- package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.types.js +0 -171
- package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
- package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2509
- package/build/internal/es/src/members-v1-member-members.universal.js +0 -1337
- package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
|
@@ -1,2509 +0,0 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
-
export interface Member {
|
|
3
|
-
/**
|
|
4
|
-
* Member ID.
|
|
5
|
-
* @format GUID
|
|
6
|
-
* @readonly
|
|
7
|
-
*/
|
|
8
|
-
_id?: string | null;
|
|
9
|
-
/**
|
|
10
|
-
* Email used by a member to log in to the site.
|
|
11
|
-
* @format EMAIL
|
|
12
|
-
*/
|
|
13
|
-
loginEmail?: string | null;
|
|
14
|
-
/**
|
|
15
|
-
* Whether the email used by a member has been verified.
|
|
16
|
-
* @readonly
|
|
17
|
-
*/
|
|
18
|
-
loginEmailVerified?: boolean | null;
|
|
19
|
-
/**
|
|
20
|
-
* Member site access status.
|
|
21
|
-
* @readonly
|
|
22
|
-
*/
|
|
23
|
-
status?: StatusWithLiterals;
|
|
24
|
-
/**
|
|
25
|
-
* Contact ID.
|
|
26
|
-
* @format GUID
|
|
27
|
-
* @readonly
|
|
28
|
-
*/
|
|
29
|
-
contactId?: string | null;
|
|
30
|
-
/**
|
|
31
|
-
* Member's contact information. Contact information is stored in the
|
|
32
|
-
* [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).
|
|
33
|
-
*
|
|
34
|
-
* The full set of contact data can be accessed and managed with the
|
|
35
|
-
* Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
|
|
36
|
-
*/
|
|
37
|
-
contact?: Contact;
|
|
38
|
-
/** Profile display details. */
|
|
39
|
-
profile?: Profile;
|
|
40
|
-
/** Member privacy status. */
|
|
41
|
-
privacyStatus?: PrivacyStatusStatusWithLiterals;
|
|
42
|
-
/**
|
|
43
|
-
* Member activity status.
|
|
44
|
-
* @readonly
|
|
45
|
-
*/
|
|
46
|
-
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
47
|
-
/**
|
|
48
|
-
* Date and time when the member was created.
|
|
49
|
-
* @readonly
|
|
50
|
-
*/
|
|
51
|
-
_createdDate?: Date | null;
|
|
52
|
-
/**
|
|
53
|
-
* Date and time when the member was updated.
|
|
54
|
-
* @readonly
|
|
55
|
-
*/
|
|
56
|
-
_updatedDate?: Date | null;
|
|
57
|
-
/**
|
|
58
|
-
* Date and time when the member last logged in to the site.
|
|
59
|
-
* @readonly
|
|
60
|
-
*/
|
|
61
|
-
lastLoginDate?: Date | null;
|
|
62
|
-
}
|
|
63
|
-
export declare enum Status {
|
|
64
|
-
/** Insufficient permissions to get the status. */
|
|
65
|
-
UNKNOWN = "UNKNOWN",
|
|
66
|
-
/** Member is created and is waiting for approval by a Wix user. */
|
|
67
|
-
PENDING = "PENDING",
|
|
68
|
-
/** Member can log in to the site. */
|
|
69
|
-
APPROVED = "APPROVED",
|
|
70
|
-
/** Member is blocked and can't log in to the site. */
|
|
71
|
-
BLOCKED = "BLOCKED",
|
|
72
|
-
/** 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. */
|
|
73
|
-
OFFLINE = "OFFLINE"
|
|
74
|
-
}
|
|
75
|
-
/** @enumType */
|
|
76
|
-
export type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
|
|
77
|
-
/** Contact info associated with the member. */
|
|
78
|
-
export interface Contact {
|
|
79
|
-
/** Contact's first name. */
|
|
80
|
-
firstName?: string | null;
|
|
81
|
-
/** Contact's last name. */
|
|
82
|
-
lastName?: string | null;
|
|
83
|
-
/** List of phone numbers. */
|
|
84
|
-
phones?: string[] | null;
|
|
85
|
-
/**
|
|
86
|
-
* List of email addresses.
|
|
87
|
-
* @format EMAIL
|
|
88
|
-
*/
|
|
89
|
-
emails?: string[] | null;
|
|
90
|
-
/** List of street addresses. */
|
|
91
|
-
addresses?: Address[];
|
|
92
|
-
/**
|
|
93
|
-
* Contact's birthdate, formatted as `"YYYY-MM-DD"`.
|
|
94
|
-
*
|
|
95
|
-
* Example: `"2020-03-15"` for March 15, 2020.
|
|
96
|
-
* @maxLength 100
|
|
97
|
-
*/
|
|
98
|
-
birthdate?: string | null;
|
|
99
|
-
/**
|
|
100
|
-
* Contact's company name.
|
|
101
|
-
* @maxLength 100
|
|
102
|
-
*/
|
|
103
|
-
company?: string | null;
|
|
104
|
-
/**
|
|
105
|
-
* Contact's job title.
|
|
106
|
-
* @maxLength 100
|
|
107
|
-
*/
|
|
108
|
-
jobTitle?: string | null;
|
|
109
|
-
/**
|
|
110
|
-
* 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.
|
|
111
|
-
*
|
|
112
|
-
* > **Notes:**
|
|
113
|
-
* > - Only custom fields added to the member profile in the dashboard are available through the Members API. Empty fields are not returned.
|
|
114
|
-
* > - When updating a member, `name` is ignored.
|
|
115
|
-
*/
|
|
116
|
-
customFields?: Record<string, CustomField>;
|
|
117
|
-
}
|
|
118
|
-
/** Street address. */
|
|
119
|
-
export interface Address extends AddressStreetOneOf {
|
|
120
|
-
/** Street address object, with number and name in separate fields. */
|
|
121
|
-
streetAddress?: StreetAddress;
|
|
122
|
-
/**
|
|
123
|
-
* Main address line, usually street and number, as free text.
|
|
124
|
-
* @maxLength 200
|
|
125
|
-
*/
|
|
126
|
-
addressLine?: string | null;
|
|
127
|
-
/**
|
|
128
|
-
* Street address ID.
|
|
129
|
-
* @format GUID
|
|
130
|
-
* @readonly
|
|
131
|
-
*/
|
|
132
|
-
_id?: string | null;
|
|
133
|
-
/**
|
|
134
|
-
* Free text providing more detailed address information,
|
|
135
|
-
* such as apartment, suite, or floor.
|
|
136
|
-
*/
|
|
137
|
-
addressLine2?: string | null;
|
|
138
|
-
/** City name. */
|
|
139
|
-
city?: string | null;
|
|
140
|
-
/**
|
|
141
|
-
* Code for a subdivision (such as state, prefecture, or province) in an
|
|
142
|
-
* [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
|
|
143
|
-
*/
|
|
144
|
-
subdivision?: string | null;
|
|
145
|
-
/**
|
|
146
|
-
* 2-letter country code in an
|
|
147
|
-
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
148
|
-
*/
|
|
149
|
-
country?: string | null;
|
|
150
|
-
/** Postal code. */
|
|
151
|
-
postalCode?: string | null;
|
|
152
|
-
}
|
|
153
|
-
/** @oneof */
|
|
154
|
-
export interface AddressStreetOneOf {
|
|
155
|
-
/** Street address object, with number and name in separate fields. */
|
|
156
|
-
streetAddress?: StreetAddress;
|
|
157
|
-
/**
|
|
158
|
-
* Main address line, usually street and number, as free text.
|
|
159
|
-
* @maxLength 200
|
|
160
|
-
*/
|
|
161
|
-
addressLine?: string | null;
|
|
162
|
-
}
|
|
163
|
-
export interface StreetAddress {
|
|
164
|
-
/**
|
|
165
|
-
* Street number.
|
|
166
|
-
* @maxLength 100
|
|
167
|
-
*/
|
|
168
|
-
number?: string;
|
|
169
|
-
/**
|
|
170
|
-
* Street name.
|
|
171
|
-
* @maxLength 200
|
|
172
|
-
*/
|
|
173
|
-
name?: string;
|
|
174
|
-
}
|
|
175
|
-
export interface CustomField {
|
|
176
|
-
/** Custom field name. */
|
|
177
|
-
name?: string | null;
|
|
178
|
-
/** Custom field value. */
|
|
179
|
-
value?: any;
|
|
180
|
-
}
|
|
181
|
-
/** Member Profile */
|
|
182
|
-
export interface Profile {
|
|
183
|
-
/**
|
|
184
|
-
* Name that identifies the member to other members.
|
|
185
|
-
* Displayed on the member's profile page
|
|
186
|
-
* and interactions in the forum or blog.
|
|
187
|
-
*/
|
|
188
|
-
nickname?: string | null;
|
|
189
|
-
/**
|
|
190
|
-
* Slug that determines the member's profile page URL.
|
|
191
|
-
* @readonly
|
|
192
|
-
*/
|
|
193
|
-
slug?: string | null;
|
|
194
|
-
/** Member's profile photo. */
|
|
195
|
-
photo?: Image;
|
|
196
|
-
/**
|
|
197
|
-
* Member's cover photo,
|
|
198
|
-
* used as a background picture in a member's profile page.
|
|
199
|
-
*
|
|
200
|
-
* Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
|
|
201
|
-
* When left empty, the values default to `0`.
|
|
202
|
-
*/
|
|
203
|
-
cover?: Image;
|
|
204
|
-
/**
|
|
205
|
-
* Member title.
|
|
206
|
-
*
|
|
207
|
-
* Currently available through the API only.
|
|
208
|
-
*/
|
|
209
|
-
title?: string | null;
|
|
210
|
-
}
|
|
211
|
-
export interface Image {
|
|
212
|
-
/**
|
|
213
|
-
* Wix Media image ID,
|
|
214
|
-
* set when the member selects an image from Wix Media.
|
|
215
|
-
*/
|
|
216
|
-
_id?: string;
|
|
217
|
-
/** Image URL. */
|
|
218
|
-
url?: string;
|
|
219
|
-
/** Original image width. */
|
|
220
|
-
height?: number;
|
|
221
|
-
/** Original image height. */
|
|
222
|
-
width?: number;
|
|
223
|
-
/**
|
|
224
|
-
* X-axis offset.
|
|
225
|
-
*
|
|
226
|
-
* Default: `0`.
|
|
227
|
-
*/
|
|
228
|
-
offsetX?: number | null;
|
|
229
|
-
/**
|
|
230
|
-
* Y-axis offset.
|
|
231
|
-
*
|
|
232
|
-
* Default: `0`.
|
|
233
|
-
*/
|
|
234
|
-
offsetY?: number | null;
|
|
235
|
-
}
|
|
236
|
-
export declare enum PrivacyStatusStatus {
|
|
237
|
-
/** Insufficient permissions to get the status. */
|
|
238
|
-
UNKNOWN = "UNKNOWN",
|
|
239
|
-
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
240
|
-
PRIVATE = "PRIVATE",
|
|
241
|
-
/** Member is visible to everyone. */
|
|
242
|
-
PUBLIC = "PUBLIC"
|
|
243
|
-
}
|
|
244
|
-
/** @enumType */
|
|
245
|
-
export type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
|
|
246
|
-
export declare enum ActivityStatusStatus {
|
|
247
|
-
/** Insufficient permissions to get the status. */
|
|
248
|
-
UNKNOWN = "UNKNOWN",
|
|
249
|
-
/** Member can write forum posts and blog comments. */
|
|
250
|
-
ACTIVE = "ACTIVE",
|
|
251
|
-
/** Member can't write forum posts or blog comments. */
|
|
252
|
-
MUTED = "MUTED"
|
|
253
|
-
}
|
|
254
|
-
/** @enumType */
|
|
255
|
-
export type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
|
|
256
|
-
export interface ExtendedFields {
|
|
257
|
-
/**
|
|
258
|
-
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
259
|
-
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
260
|
-
*
|
|
261
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
262
|
-
*
|
|
263
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
264
|
-
*/
|
|
265
|
-
namespaces?: Record<string, Record<string, any>>;
|
|
266
|
-
}
|
|
267
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
268
|
-
/**
|
|
269
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
270
|
-
* @format GUID
|
|
271
|
-
*/
|
|
272
|
-
metaSiteId?: string;
|
|
273
|
-
/**
|
|
274
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
275
|
-
* @format GUID
|
|
276
|
-
*/
|
|
277
|
-
siteId?: string;
|
|
278
|
-
/** Invalidate by App */
|
|
279
|
-
app?: App;
|
|
280
|
-
/** Invalidate by page id */
|
|
281
|
-
page?: Page;
|
|
282
|
-
/** Invalidate by URI path */
|
|
283
|
-
uri?: URI;
|
|
284
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
285
|
-
file?: File;
|
|
286
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
287
|
-
customTag?: CustomTag;
|
|
288
|
-
/**
|
|
289
|
-
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
290
|
-
* @maxLength 256
|
|
291
|
-
*/
|
|
292
|
-
reason?: string | null;
|
|
293
|
-
/** Is local DS */
|
|
294
|
-
localDc?: boolean;
|
|
295
|
-
hardPurge?: boolean;
|
|
296
|
-
}
|
|
297
|
-
/** @oneof */
|
|
298
|
-
export interface InvalidateCacheGetByOneOf {
|
|
299
|
-
/**
|
|
300
|
-
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
301
|
-
* @format GUID
|
|
302
|
-
*/
|
|
303
|
-
metaSiteId?: string;
|
|
304
|
-
/**
|
|
305
|
-
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
306
|
-
* @format GUID
|
|
307
|
-
*/
|
|
308
|
-
siteId?: string;
|
|
309
|
-
/** Invalidate by App */
|
|
310
|
-
app?: App;
|
|
311
|
-
/** Invalidate by page id */
|
|
312
|
-
page?: Page;
|
|
313
|
-
/** Invalidate by URI path */
|
|
314
|
-
uri?: URI;
|
|
315
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
316
|
-
file?: File;
|
|
317
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
318
|
-
customTag?: CustomTag;
|
|
319
|
-
}
|
|
320
|
-
export interface App {
|
|
321
|
-
/**
|
|
322
|
-
* The AppDefId
|
|
323
|
-
* @minLength 1
|
|
324
|
-
*/
|
|
325
|
-
appDefId?: string;
|
|
326
|
-
/**
|
|
327
|
-
* The instance Id
|
|
328
|
-
* @format GUID
|
|
329
|
-
*/
|
|
330
|
-
instanceId?: string;
|
|
331
|
-
}
|
|
332
|
-
export interface Page {
|
|
333
|
-
/**
|
|
334
|
-
* the msid the page is on
|
|
335
|
-
* @format GUID
|
|
336
|
-
*/
|
|
337
|
-
metaSiteId?: string;
|
|
338
|
-
/**
|
|
339
|
-
* Invalidate by Page ID
|
|
340
|
-
* @minLength 1
|
|
341
|
-
*/
|
|
342
|
-
pageId?: string;
|
|
343
|
-
}
|
|
344
|
-
export interface URI {
|
|
345
|
-
/**
|
|
346
|
-
* the msid the URI is on
|
|
347
|
-
* @format GUID
|
|
348
|
-
*/
|
|
349
|
-
metaSiteId?: string;
|
|
350
|
-
/**
|
|
351
|
-
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
352
|
-
* @minLength 1
|
|
353
|
-
*/
|
|
354
|
-
uriPath?: string;
|
|
355
|
-
}
|
|
356
|
-
export interface File {
|
|
357
|
-
/**
|
|
358
|
-
* the msid the file is related to
|
|
359
|
-
* @format GUID
|
|
360
|
-
*/
|
|
361
|
-
metaSiteId?: string;
|
|
362
|
-
/**
|
|
363
|
-
* Invalidate by filename (for media files such as PDFs)
|
|
364
|
-
* @minLength 1
|
|
365
|
-
* @maxLength 256
|
|
366
|
-
*/
|
|
367
|
-
fileName?: string;
|
|
368
|
-
}
|
|
369
|
-
export interface CustomTag {
|
|
370
|
-
/**
|
|
371
|
-
* the msid the tag is related to
|
|
372
|
-
* @format GUID
|
|
373
|
-
*/
|
|
374
|
-
metaSiteId?: string;
|
|
375
|
-
/**
|
|
376
|
-
* Tag to invalidate by
|
|
377
|
-
* @minLength 1
|
|
378
|
-
* @maxLength 256
|
|
379
|
-
*/
|
|
380
|
-
tag?: string;
|
|
381
|
-
}
|
|
382
|
-
export interface UpdateMySlugRequest {
|
|
383
|
-
/**
|
|
384
|
-
* New slug.
|
|
385
|
-
* @maxLength 255
|
|
386
|
-
*/
|
|
387
|
-
slug: string;
|
|
388
|
-
}
|
|
389
|
-
export interface UpdateMySlugResponse {
|
|
390
|
-
/** Updated member. */
|
|
391
|
-
member?: Member;
|
|
392
|
-
}
|
|
393
|
-
export interface SlugAlreadyExistsPayload {
|
|
394
|
-
slug?: string;
|
|
395
|
-
}
|
|
396
|
-
export interface UpdateMemberSlugRequest {
|
|
397
|
-
/**
|
|
398
|
-
* Member ID.
|
|
399
|
-
* @format GUID
|
|
400
|
-
*/
|
|
401
|
-
_id: string;
|
|
402
|
-
/**
|
|
403
|
-
* New slug.
|
|
404
|
-
* @maxLength 255
|
|
405
|
-
*/
|
|
406
|
-
slug: string;
|
|
407
|
-
}
|
|
408
|
-
export interface UpdateMemberSlugResponse {
|
|
409
|
-
/** Updated member. */
|
|
410
|
-
member?: Member;
|
|
411
|
-
}
|
|
412
|
-
export interface JoinCommunityRequest {
|
|
413
|
-
}
|
|
414
|
-
/** Member profile. */
|
|
415
|
-
export interface JoinCommunityResponse {
|
|
416
|
-
/** The updated member. */
|
|
417
|
-
member?: Member;
|
|
418
|
-
}
|
|
419
|
-
export interface MemberJoinedCommunity {
|
|
420
|
-
/**
|
|
421
|
-
* ID of the member who joined the community.
|
|
422
|
-
* @format GUID
|
|
423
|
-
* @readonly
|
|
424
|
-
*/
|
|
425
|
-
memberId?: string;
|
|
426
|
-
}
|
|
427
|
-
export interface LeaveCommunityRequest {
|
|
428
|
-
}
|
|
429
|
-
/** Member profile. */
|
|
430
|
-
export interface LeaveCommunityResponse {
|
|
431
|
-
/** The updated member. */
|
|
432
|
-
member?: Member;
|
|
433
|
-
}
|
|
434
|
-
export interface MemberLeftCommunity {
|
|
435
|
-
/**
|
|
436
|
-
* ID of the site member who left the community.
|
|
437
|
-
* @format GUID
|
|
438
|
-
* @readonly
|
|
439
|
-
*/
|
|
440
|
-
memberId?: string;
|
|
441
|
-
}
|
|
442
|
-
export interface GetMyMemberRequest {
|
|
443
|
-
/**
|
|
444
|
-
* Predefined set of fields to return.
|
|
445
|
-
*
|
|
446
|
-
* Default: `"PUBLIC"`.
|
|
447
|
-
* @maxSize 3
|
|
448
|
-
*/
|
|
449
|
-
fieldsets?: SetWithLiterals[];
|
|
450
|
-
}
|
|
451
|
-
export declare enum Set {
|
|
452
|
-
/**
|
|
453
|
-
* Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
|
|
454
|
-
* `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
|
|
455
|
-
*/
|
|
456
|
-
PUBLIC = "PUBLIC",
|
|
457
|
-
/** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */
|
|
458
|
-
EXTENDED = "EXTENDED",
|
|
459
|
-
/** Includes all fields. */
|
|
460
|
-
FULL = "FULL"
|
|
461
|
-
}
|
|
462
|
-
/** @enumType */
|
|
463
|
-
export type SetWithLiterals = Set | 'PUBLIC' | 'EXTENDED' | 'FULL';
|
|
464
|
-
/** Member profile. */
|
|
465
|
-
export interface GetMyMemberResponse {
|
|
466
|
-
/** The retrieved member. */
|
|
467
|
-
member?: Member;
|
|
468
|
-
}
|
|
469
|
-
export interface GetMemberRequest {
|
|
470
|
-
/**
|
|
471
|
-
* Member ID.
|
|
472
|
-
* @format GUID
|
|
473
|
-
*/
|
|
474
|
-
_id: string;
|
|
475
|
-
/**
|
|
476
|
-
* Predefined set of fields to return.
|
|
477
|
-
*
|
|
478
|
-
* Defaults to `"PUBLIC"`.
|
|
479
|
-
* @maxSize 3
|
|
480
|
-
*/
|
|
481
|
-
fieldsets?: SetWithLiterals[];
|
|
482
|
-
}
|
|
483
|
-
export interface GetMemberResponse {
|
|
484
|
-
/** The requested member. */
|
|
485
|
-
member?: Member;
|
|
486
|
-
}
|
|
487
|
-
export interface MemberToMemberBlockedPayload {
|
|
488
|
-
/**
|
|
489
|
-
* Member ID.
|
|
490
|
-
* @format GUID
|
|
491
|
-
*/
|
|
492
|
-
memberId?: string;
|
|
493
|
-
}
|
|
494
|
-
export interface ListMembersRequest {
|
|
495
|
-
paging?: Paging;
|
|
496
|
-
/**
|
|
497
|
-
* Predefined sets of fields to return.
|
|
498
|
-
*
|
|
499
|
-
* Default: `"PUBLIC"`.
|
|
500
|
-
* @maxSize 3
|
|
501
|
-
*/
|
|
502
|
-
fieldsets?: SetWithLiterals[];
|
|
503
|
-
sorting?: Sorting[];
|
|
504
|
-
}
|
|
505
|
-
export interface Paging {
|
|
506
|
-
/** Number of items to load. */
|
|
507
|
-
limit?: number | null;
|
|
508
|
-
/** Number of items to skip in the current sort order. */
|
|
509
|
-
offset?: number | null;
|
|
510
|
-
}
|
|
511
|
-
export interface Sorting {
|
|
512
|
-
/**
|
|
513
|
-
* Name of the field to sort by.
|
|
514
|
-
* @maxLength 512
|
|
515
|
-
*/
|
|
516
|
-
fieldName?: string;
|
|
517
|
-
/** Sort order. */
|
|
518
|
-
order?: SortOrderWithLiterals;
|
|
519
|
-
}
|
|
520
|
-
export declare enum SortOrder {
|
|
521
|
-
ASC = "ASC",
|
|
522
|
-
DESC = "DESC"
|
|
523
|
-
}
|
|
524
|
-
/** @enumType */
|
|
525
|
-
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
526
|
-
export interface CursorPaging {
|
|
527
|
-
/**
|
|
528
|
-
* Maximum number of items to return in the results.
|
|
529
|
-
* @max 100
|
|
530
|
-
*/
|
|
531
|
-
limit?: number | null;
|
|
532
|
-
/**
|
|
533
|
-
* Pointer to the next or previous page in the list of results.
|
|
534
|
-
*
|
|
535
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
536
|
-
* Not relevant for the first request.
|
|
537
|
-
* @maxLength 16000
|
|
538
|
-
*/
|
|
539
|
-
cursor?: string | null;
|
|
540
|
-
}
|
|
541
|
-
export interface ListMembersResponse {
|
|
542
|
-
/** List of members. */
|
|
543
|
-
members?: Member[];
|
|
544
|
-
/** Metadata for the paginated results. */
|
|
545
|
-
metadata?: PagingMetadata;
|
|
546
|
-
}
|
|
547
|
-
export interface PagingMetadata {
|
|
548
|
-
/** Number of items returned in the response. */
|
|
549
|
-
count?: number | null;
|
|
550
|
-
/** Offset that was requested. */
|
|
551
|
-
offset?: number | null;
|
|
552
|
-
/** Total number of items that match the query. */
|
|
553
|
-
total?: number | null;
|
|
554
|
-
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
555
|
-
tooManyToCount?: boolean | null;
|
|
556
|
-
}
|
|
557
|
-
export interface CursorPagingMetadata {
|
|
558
|
-
/** Number of items returned in the response. */
|
|
559
|
-
count?: number | null;
|
|
560
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
561
|
-
cursors?: Cursors;
|
|
562
|
-
/**
|
|
563
|
-
* Whether there are more pages to retrieve following the current page.
|
|
564
|
-
*
|
|
565
|
-
* + `true`: Another page of results can be retrieved.
|
|
566
|
-
* + `false`: This is the last page.
|
|
567
|
-
*/
|
|
568
|
-
hasNext?: boolean | null;
|
|
569
|
-
}
|
|
570
|
-
export interface Cursors {
|
|
571
|
-
/**
|
|
572
|
-
* Cursor string pointing to the next page in the list of results.
|
|
573
|
-
* @maxLength 16000
|
|
574
|
-
*/
|
|
575
|
-
next?: string | null;
|
|
576
|
-
/**
|
|
577
|
-
* Cursor pointing to the previous page in the list of results.
|
|
578
|
-
* @maxLength 16000
|
|
579
|
-
*/
|
|
580
|
-
prev?: string | null;
|
|
581
|
-
}
|
|
582
|
-
export interface QueryMembersRequest {
|
|
583
|
-
/** Query options. */
|
|
584
|
-
query?: Query;
|
|
585
|
-
/**
|
|
586
|
-
* Predefined sets of fields to return.
|
|
587
|
-
*
|
|
588
|
-
* Default: `"PUBLIC"`.
|
|
589
|
-
* @maxSize 3
|
|
590
|
-
*/
|
|
591
|
-
fieldsets?: SetWithLiterals[];
|
|
592
|
-
/** Plain text search. */
|
|
593
|
-
search?: Search;
|
|
594
|
-
}
|
|
595
|
-
export interface Query {
|
|
596
|
-
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
597
|
-
filter?: any;
|
|
598
|
-
/** Limit number of results */
|
|
599
|
-
paging?: Paging;
|
|
600
|
-
/** Sort the results */
|
|
601
|
-
sorting?: Sorting[];
|
|
602
|
-
}
|
|
603
|
-
/** Free text to match in searchable fields */
|
|
604
|
-
export interface Search {
|
|
605
|
-
/**
|
|
606
|
-
* Search term or expression.
|
|
607
|
-
* @minLength 1
|
|
608
|
-
* @maxLength 100
|
|
609
|
-
*/
|
|
610
|
-
expression?: string | null;
|
|
611
|
-
/**
|
|
612
|
-
* Currently supported fields for search:
|
|
613
|
-
*
|
|
614
|
-
* - `loginEmail`
|
|
615
|
-
* - `contact.firstName`
|
|
616
|
-
* - `contact.lastName`
|
|
617
|
-
* - `profile.title`
|
|
618
|
-
* - `profile.nickname`
|
|
619
|
-
* - `profile.slug`
|
|
620
|
-
*
|
|
621
|
-
* Default: `profile.nickname`.
|
|
622
|
-
* @maxSize 4
|
|
623
|
-
*/
|
|
624
|
-
fields?: string[];
|
|
625
|
-
}
|
|
626
|
-
export interface QueryMembersResponse {
|
|
627
|
-
/** List of members that met the query filter criteria. */
|
|
628
|
-
members?: Member[];
|
|
629
|
-
/** Metadata for the paginated results. */
|
|
630
|
-
metadata?: PagingMetadata;
|
|
631
|
-
}
|
|
632
|
-
export interface MuteMemberRequest {
|
|
633
|
-
/**
|
|
634
|
-
* ID of the member to mute.
|
|
635
|
-
* @format GUID
|
|
636
|
-
*/
|
|
637
|
-
_id: string;
|
|
638
|
-
}
|
|
639
|
-
export interface MuteMemberResponse {
|
|
640
|
-
/** Muted member. */
|
|
641
|
-
member?: Member;
|
|
642
|
-
}
|
|
643
|
-
export interface MemberMuted {
|
|
644
|
-
/**
|
|
645
|
-
* ID of the member who got muted.
|
|
646
|
-
* @format GUID
|
|
647
|
-
* @readonly
|
|
648
|
-
*/
|
|
649
|
-
memberId?: string;
|
|
650
|
-
}
|
|
651
|
-
export interface UnmuteMemberRequest {
|
|
652
|
-
/**
|
|
653
|
-
* ID of the member to unmute.
|
|
654
|
-
* @format GUID
|
|
655
|
-
*/
|
|
656
|
-
_id: string;
|
|
657
|
-
}
|
|
658
|
-
export interface UnmuteMemberResponse {
|
|
659
|
-
/** Unmuted member. */
|
|
660
|
-
member?: Member;
|
|
661
|
-
}
|
|
662
|
-
export interface MemberUnmuted {
|
|
663
|
-
/**
|
|
664
|
-
* ID of the member who got unmuted.
|
|
665
|
-
* @format GUID
|
|
666
|
-
* @readonly
|
|
667
|
-
*/
|
|
668
|
-
memberId?: string;
|
|
669
|
-
}
|
|
670
|
-
export interface ApproveMemberRequest {
|
|
671
|
-
/**
|
|
672
|
-
* ID of the member to approve.
|
|
673
|
-
* @format GUID
|
|
674
|
-
*/
|
|
675
|
-
_id: string;
|
|
676
|
-
}
|
|
677
|
-
export interface ApproveMemberResponse {
|
|
678
|
-
/** Approved member. */
|
|
679
|
-
member?: Member;
|
|
680
|
-
}
|
|
681
|
-
export interface MemberApproved {
|
|
682
|
-
/**
|
|
683
|
-
* ID of the member who got approved.
|
|
684
|
-
* @format GUID
|
|
685
|
-
* @readonly
|
|
686
|
-
*/
|
|
687
|
-
memberId?: string;
|
|
688
|
-
}
|
|
689
|
-
export interface BlockMemberRequest {
|
|
690
|
-
/**
|
|
691
|
-
* ID of a member to block.
|
|
692
|
-
* @format GUID
|
|
693
|
-
*/
|
|
694
|
-
_id: string;
|
|
695
|
-
}
|
|
696
|
-
export interface BlockMemberResponse {
|
|
697
|
-
/** Blocked member. */
|
|
698
|
-
member?: Member;
|
|
699
|
-
}
|
|
700
|
-
export interface MemberBlocked {
|
|
701
|
-
/**
|
|
702
|
-
* ID of the member who got blocked.
|
|
703
|
-
* @format GUID
|
|
704
|
-
* @readonly
|
|
705
|
-
*/
|
|
706
|
-
memberId?: string;
|
|
707
|
-
}
|
|
708
|
-
export interface MemberSelfBlockForbiddenPayload {
|
|
709
|
-
/**
|
|
710
|
-
* Target's member ID.
|
|
711
|
-
* @format GUID
|
|
712
|
-
*/
|
|
713
|
-
memberId?: string;
|
|
714
|
-
}
|
|
715
|
-
export interface OwnerMemberBlockForbiddenPayload {
|
|
716
|
-
/**
|
|
717
|
-
* Owner's member ID.
|
|
718
|
-
* @format GUID
|
|
719
|
-
*/
|
|
720
|
-
memberId?: string;
|
|
721
|
-
}
|
|
722
|
-
export interface ActiveSubscriptionMemberBlockForbiddenPayload {
|
|
723
|
-
/**
|
|
724
|
-
* Active subscription member ID.
|
|
725
|
-
* @format GUID
|
|
726
|
-
*/
|
|
727
|
-
memberId?: string;
|
|
728
|
-
}
|
|
729
|
-
export interface DisconnectMemberRequest {
|
|
730
|
-
/**
|
|
731
|
-
* ID of a member to disconnect.
|
|
732
|
-
* @format GUID
|
|
733
|
-
*/
|
|
734
|
-
_id: string;
|
|
735
|
-
}
|
|
736
|
-
export interface DisconnectMemberResponse {
|
|
737
|
-
/** Disconnected member. */
|
|
738
|
-
member?: Member;
|
|
739
|
-
}
|
|
740
|
-
export interface DeleteMemberRequest {
|
|
741
|
-
/**
|
|
742
|
-
* ID of a member to delete.
|
|
743
|
-
* @format GUID
|
|
744
|
-
*/
|
|
745
|
-
_id: string;
|
|
746
|
-
}
|
|
747
|
-
export interface DeleteMemberResponse {
|
|
748
|
-
}
|
|
749
|
-
export interface ContentReassignmentRequested {
|
|
750
|
-
fromMember?: Member;
|
|
751
|
-
toMember?: Member;
|
|
752
|
-
}
|
|
753
|
-
export interface ContentDeletionRequested {
|
|
754
|
-
member?: Member;
|
|
755
|
-
}
|
|
756
|
-
export interface OwnerOrContributorDeleteForbiddenPayload {
|
|
757
|
-
/**
|
|
758
|
-
* Owner's or contributor's member ID.
|
|
759
|
-
* @format GUID
|
|
760
|
-
*/
|
|
761
|
-
memberId?: string;
|
|
762
|
-
}
|
|
763
|
-
export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
764
|
-
/**
|
|
765
|
-
* Active subscription member ID.
|
|
766
|
-
* @format GUID
|
|
767
|
-
*/
|
|
768
|
-
memberId?: string;
|
|
769
|
-
}
|
|
770
|
-
export interface DeleteMyMemberRequest {
|
|
771
|
-
/**
|
|
772
|
-
* ID of a member receiving the deleted member's content.
|
|
773
|
-
* @format GUID
|
|
774
|
-
*/
|
|
775
|
-
contentAssigneeId?: string | null;
|
|
776
|
-
}
|
|
777
|
-
export interface DeleteMyMemberResponse {
|
|
778
|
-
}
|
|
779
|
-
export interface BulkDeleteMembersRequest {
|
|
780
|
-
/**
|
|
781
|
-
* IDs of members to be deleted.
|
|
782
|
-
* @minSize 1
|
|
783
|
-
* @maxSize 100
|
|
784
|
-
* @format GUID
|
|
785
|
-
*/
|
|
786
|
-
memberIds: string[];
|
|
787
|
-
}
|
|
788
|
-
export interface BulkDeleteMembersResponse {
|
|
789
|
-
/** Result. */
|
|
790
|
-
results?: BulkMemberResult[];
|
|
791
|
-
/** Bulk action result metadata. */
|
|
792
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
793
|
-
}
|
|
794
|
-
export interface ItemMetadata {
|
|
795
|
-
/**
|
|
796
|
-
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
797
|
-
* @maxLength 255
|
|
798
|
-
*/
|
|
799
|
-
_id?: string | null;
|
|
800
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
801
|
-
originalIndex?: number;
|
|
802
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
803
|
-
success?: boolean;
|
|
804
|
-
/** Details about the error in case of failure. */
|
|
805
|
-
error?: ApplicationError;
|
|
806
|
-
}
|
|
807
|
-
export interface ApplicationError {
|
|
808
|
-
/** Error code. */
|
|
809
|
-
code?: string;
|
|
810
|
-
/** Description of the error. */
|
|
811
|
-
description?: string;
|
|
812
|
-
/** Data related to the error. */
|
|
813
|
-
data?: Record<string, any> | null;
|
|
814
|
-
}
|
|
815
|
-
export interface BulkMemberResult {
|
|
816
|
-
itemMetadata?: ItemMetadata;
|
|
817
|
-
}
|
|
818
|
-
export interface BulkActionMetadata {
|
|
819
|
-
/** Number of items that were successfully processed. */
|
|
820
|
-
totalSuccesses?: number;
|
|
821
|
-
/** Number of items that couldn't be processed. */
|
|
822
|
-
totalFailures?: number;
|
|
823
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
824
|
-
undetailedFailures?: number;
|
|
825
|
-
}
|
|
826
|
-
export interface BulkDeleteMembersByFilterRequest {
|
|
827
|
-
/** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
|
|
828
|
-
filter: any;
|
|
829
|
-
/**
|
|
830
|
-
* ID of a member receiving the deleted member's content.
|
|
831
|
-
* @format GUID
|
|
832
|
-
*/
|
|
833
|
-
contentAssigneeId?: string | null;
|
|
834
|
-
/** Plain text search. */
|
|
835
|
-
search?: Search;
|
|
836
|
-
}
|
|
837
|
-
export interface BulkDeleteMembersByFilterResponse {
|
|
838
|
-
/**
|
|
839
|
-
* Job ID.
|
|
840
|
-
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
841
|
-
*/
|
|
842
|
-
jobId?: string;
|
|
843
|
-
}
|
|
844
|
-
export interface BulkApproveMembersRequest {
|
|
845
|
-
/** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
|
|
846
|
-
filter: any;
|
|
847
|
-
}
|
|
848
|
-
export interface BulkApproveMembersResponse {
|
|
849
|
-
/**
|
|
850
|
-
* Job ID.
|
|
851
|
-
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
852
|
-
*/
|
|
853
|
-
jobId?: string;
|
|
854
|
-
}
|
|
855
|
-
export interface BulkBlockMembersRequest {
|
|
856
|
-
/** Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details. */
|
|
857
|
-
filter: any;
|
|
858
|
-
}
|
|
859
|
-
export interface BulkBlockMembersResponse {
|
|
860
|
-
/**
|
|
861
|
-
* Job ID.
|
|
862
|
-
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
863
|
-
*/
|
|
864
|
-
jobId?: string;
|
|
865
|
-
}
|
|
866
|
-
export interface CreateMemberRequest {
|
|
867
|
-
/** Member to create. */
|
|
868
|
-
member?: Member;
|
|
869
|
-
}
|
|
870
|
-
export interface CreateMemberResponse {
|
|
871
|
-
/** New member. */
|
|
872
|
-
member?: Member;
|
|
873
|
-
}
|
|
874
|
-
export interface UpdateMemberRequest {
|
|
875
|
-
/** Member info to update. */
|
|
876
|
-
member?: Member;
|
|
877
|
-
}
|
|
878
|
-
export interface UpdateMemberResponse {
|
|
879
|
-
/** Updated member. */
|
|
880
|
-
member?: Member;
|
|
881
|
-
}
|
|
882
|
-
export interface InvalidCustomFieldUrlPayload {
|
|
883
|
-
/** Custom field key and invalid URL. */
|
|
884
|
-
fields?: Record<string, string>;
|
|
885
|
-
}
|
|
886
|
-
export interface DeleteMemberPhonesRequest {
|
|
887
|
-
/**
|
|
888
|
-
* ID of the member whose phone numbers will be deleted.
|
|
889
|
-
* @format GUID
|
|
890
|
-
*/
|
|
891
|
-
_id: string;
|
|
892
|
-
}
|
|
893
|
-
export interface DeleteMemberPhonesResponse {
|
|
894
|
-
/** Updated member. */
|
|
895
|
-
member?: Member;
|
|
896
|
-
}
|
|
897
|
-
export interface DeleteMemberEmailsRequest {
|
|
898
|
-
/**
|
|
899
|
-
* ID of the member whose email addresses will be deleted.
|
|
900
|
-
* @format GUID
|
|
901
|
-
*/
|
|
902
|
-
_id: string;
|
|
903
|
-
}
|
|
904
|
-
export interface DeleteMemberEmailsResponse {
|
|
905
|
-
/** Updated member. */
|
|
906
|
-
member?: Member;
|
|
907
|
-
}
|
|
908
|
-
export interface DeleteMemberAddressesRequest {
|
|
909
|
-
/**
|
|
910
|
-
* ID of the member whose street addresses will be deleted.
|
|
911
|
-
* @format GUID
|
|
912
|
-
*/
|
|
913
|
-
_id: string;
|
|
914
|
-
}
|
|
915
|
-
export interface DeleteMemberAddressesResponse {
|
|
916
|
-
/** Updated member. */
|
|
917
|
-
member?: Member;
|
|
918
|
-
}
|
|
919
|
-
export interface Empty {
|
|
920
|
-
}
|
|
921
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
922
|
-
createdEvent?: EntityCreatedEvent;
|
|
923
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
924
|
-
deletedEvent?: EntityDeletedEvent;
|
|
925
|
-
actionEvent?: ActionEvent;
|
|
926
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
927
|
-
_id?: string;
|
|
928
|
-
/**
|
|
929
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
930
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
931
|
-
*/
|
|
932
|
-
entityFqdn?: string;
|
|
933
|
-
/**
|
|
934
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
935
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
936
|
-
*/
|
|
937
|
-
slug?: string;
|
|
938
|
-
/** ID of the entity associated with the event. */
|
|
939
|
-
entityId?: string;
|
|
940
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
941
|
-
eventTime?: Date | null;
|
|
942
|
-
/**
|
|
943
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
944
|
-
* (for example, GDPR).
|
|
945
|
-
*/
|
|
946
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
947
|
-
/** If present, indicates the action that triggered the event. */
|
|
948
|
-
originatedFrom?: string | null;
|
|
949
|
-
/**
|
|
950
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
951
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
952
|
-
*/
|
|
953
|
-
entityEventSequence?: string | null;
|
|
954
|
-
}
|
|
955
|
-
/** @oneof */
|
|
956
|
-
export interface DomainEventBodyOneOf {
|
|
957
|
-
createdEvent?: EntityCreatedEvent;
|
|
958
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
959
|
-
deletedEvent?: EntityDeletedEvent;
|
|
960
|
-
actionEvent?: ActionEvent;
|
|
961
|
-
}
|
|
962
|
-
export interface EntityCreatedEvent {
|
|
963
|
-
entity?: string;
|
|
964
|
-
}
|
|
965
|
-
export interface RestoreInfo {
|
|
966
|
-
deletedDate?: Date | null;
|
|
967
|
-
}
|
|
968
|
-
export interface EntityUpdatedEvent {
|
|
969
|
-
/**
|
|
970
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
971
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
972
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
973
|
-
*/
|
|
974
|
-
currentEntity?: string;
|
|
975
|
-
}
|
|
976
|
-
export interface EntityDeletedEvent {
|
|
977
|
-
/** Entity that was deleted. */
|
|
978
|
-
deletedEntity?: string | null;
|
|
979
|
-
}
|
|
980
|
-
export interface ActionEvent {
|
|
981
|
-
body?: string;
|
|
982
|
-
}
|
|
983
|
-
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
984
|
-
/** Emitted on a meta site creation. */
|
|
985
|
-
siteCreated?: SiteCreated;
|
|
986
|
-
/** Emitted on a meta site transfer completion. */
|
|
987
|
-
siteTransferred?: SiteTransferred;
|
|
988
|
-
/** Emitted on a meta site deletion. */
|
|
989
|
-
siteDeleted?: SiteDeleted;
|
|
990
|
-
/** Emitted on a meta site restoration. */
|
|
991
|
-
siteUndeleted?: SiteUndeleted;
|
|
992
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
993
|
-
sitePublished?: SitePublished;
|
|
994
|
-
/** Emitted on a meta site unpublish. */
|
|
995
|
-
siteUnpublished?: SiteUnpublished;
|
|
996
|
-
/** Emitted when meta site is marked as template. */
|
|
997
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
998
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
999
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1000
|
-
/** Emitted when an application is provisioned (installed). */
|
|
1001
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
1002
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
1003
|
-
serviceRemoved?: ServiceRemoved;
|
|
1004
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
1005
|
-
siteRenamedPayload?: SiteRenamed;
|
|
1006
|
-
/** Emitted when meta site was permanently deleted. */
|
|
1007
|
-
hardDeleted?: SiteHardDeleted;
|
|
1008
|
-
/** Emitted on a namespace change. */
|
|
1009
|
-
namespaceChanged?: NamespaceChanged;
|
|
1010
|
-
/** Emitted when Studio is attached. */
|
|
1011
|
-
studioAssigned?: StudioAssigned;
|
|
1012
|
-
/** Emitted when Studio is detached. */
|
|
1013
|
-
studioUnassigned?: StudioUnassigned;
|
|
1014
|
-
/**
|
|
1015
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1016
|
-
* the actual URL.
|
|
1017
|
-
*
|
|
1018
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1019
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1020
|
-
*/
|
|
1021
|
-
urlChanged?: SiteUrlChanged;
|
|
1022
|
-
/** Site is marked as PurgedExternally */
|
|
1023
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
1024
|
-
/** Emitted when Odeditor is attached. */
|
|
1025
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
1026
|
-
/** Emitted when Odeditor is detached. */
|
|
1027
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
1028
|
-
/** Emitted when Picasso is attached. */
|
|
1029
|
-
picassoAssigned?: PicassoAssigned;
|
|
1030
|
-
/** Emitted when Picasso is detached. */
|
|
1031
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
1032
|
-
/**
|
|
1033
|
-
* A meta site id.
|
|
1034
|
-
* @format GUID
|
|
1035
|
-
*/
|
|
1036
|
-
metaSiteId?: string;
|
|
1037
|
-
/** A meta site version. Monotonically increasing. */
|
|
1038
|
-
version?: string;
|
|
1039
|
-
/** A timestamp of the event. */
|
|
1040
|
-
timestamp?: string;
|
|
1041
|
-
/**
|
|
1042
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
1043
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1044
|
-
* @maxSize 4000
|
|
1045
|
-
*/
|
|
1046
|
-
assets?: Asset[];
|
|
1047
|
-
}
|
|
1048
|
-
/** @oneof */
|
|
1049
|
-
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
1050
|
-
/** Emitted on a meta site creation. */
|
|
1051
|
-
siteCreated?: SiteCreated;
|
|
1052
|
-
/** Emitted on a meta site transfer completion. */
|
|
1053
|
-
siteTransferred?: SiteTransferred;
|
|
1054
|
-
/** Emitted on a meta site deletion. */
|
|
1055
|
-
siteDeleted?: SiteDeleted;
|
|
1056
|
-
/** Emitted on a meta site restoration. */
|
|
1057
|
-
siteUndeleted?: SiteUndeleted;
|
|
1058
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1059
|
-
sitePublished?: SitePublished;
|
|
1060
|
-
/** Emitted on a meta site unpublish. */
|
|
1061
|
-
siteUnpublished?: SiteUnpublished;
|
|
1062
|
-
/** Emitted when meta site is marked as template. */
|
|
1063
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1064
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
1065
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1066
|
-
/** Emitted when an application is provisioned (installed). */
|
|
1067
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
1068
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
1069
|
-
serviceRemoved?: ServiceRemoved;
|
|
1070
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
1071
|
-
siteRenamedPayload?: SiteRenamed;
|
|
1072
|
-
/** Emitted when meta site was permanently deleted. */
|
|
1073
|
-
hardDeleted?: SiteHardDeleted;
|
|
1074
|
-
/** Emitted on a namespace change. */
|
|
1075
|
-
namespaceChanged?: NamespaceChanged;
|
|
1076
|
-
/** Emitted when Studio is attached. */
|
|
1077
|
-
studioAssigned?: StudioAssigned;
|
|
1078
|
-
/** Emitted when Studio is detached. */
|
|
1079
|
-
studioUnassigned?: StudioUnassigned;
|
|
1080
|
-
/**
|
|
1081
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1082
|
-
* the actual URL.
|
|
1083
|
-
*
|
|
1084
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1085
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1086
|
-
*/
|
|
1087
|
-
urlChanged?: SiteUrlChanged;
|
|
1088
|
-
/** Site is marked as PurgedExternally */
|
|
1089
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
1090
|
-
/** Emitted when Odeditor is attached. */
|
|
1091
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
1092
|
-
/** Emitted when Odeditor is detached. */
|
|
1093
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
1094
|
-
/** Emitted when Picasso is attached. */
|
|
1095
|
-
picassoAssigned?: PicassoAssigned;
|
|
1096
|
-
/** Emitted when Picasso is detached. */
|
|
1097
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
1098
|
-
}
|
|
1099
|
-
export interface Asset {
|
|
1100
|
-
/**
|
|
1101
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1102
|
-
* @maxLength 36
|
|
1103
|
-
*/
|
|
1104
|
-
appDefId?: string;
|
|
1105
|
-
/**
|
|
1106
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
1107
|
-
* @maxLength 200
|
|
1108
|
-
*/
|
|
1109
|
-
instanceId?: string;
|
|
1110
|
-
/** An application state. */
|
|
1111
|
-
state?: StateWithLiterals;
|
|
1112
|
-
}
|
|
1113
|
-
export declare enum State {
|
|
1114
|
-
UNKNOWN = "UNKNOWN",
|
|
1115
|
-
ENABLED = "ENABLED",
|
|
1116
|
-
DISABLED = "DISABLED",
|
|
1117
|
-
PENDING = "PENDING",
|
|
1118
|
-
DEMO = "DEMO"
|
|
1119
|
-
}
|
|
1120
|
-
/** @enumType */
|
|
1121
|
-
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1122
|
-
export interface SiteCreated {
|
|
1123
|
-
/**
|
|
1124
|
-
* A template identifier (empty if not created from a template).
|
|
1125
|
-
* @maxLength 36
|
|
1126
|
-
*/
|
|
1127
|
-
originTemplateId?: string;
|
|
1128
|
-
/**
|
|
1129
|
-
* An account id of the owner.
|
|
1130
|
-
* @format GUID
|
|
1131
|
-
*/
|
|
1132
|
-
ownerId?: string;
|
|
1133
|
-
/** A context in which meta site was created. */
|
|
1134
|
-
context?: SiteCreatedContextWithLiterals;
|
|
1135
|
-
/**
|
|
1136
|
-
* A meta site id from which this site was created.
|
|
1137
|
-
*
|
|
1138
|
-
* In case of a creation from a template it's a template id.
|
|
1139
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1140
|
-
* @format GUID
|
|
1141
|
-
*/
|
|
1142
|
-
originMetaSiteId?: string | null;
|
|
1143
|
-
/**
|
|
1144
|
-
* A meta site name (URL slug).
|
|
1145
|
-
* @maxLength 20
|
|
1146
|
-
*/
|
|
1147
|
-
siteName?: string;
|
|
1148
|
-
/** A namespace. */
|
|
1149
|
-
namespace?: NamespaceWithLiterals;
|
|
1150
|
-
}
|
|
1151
|
-
export declare enum SiteCreatedContext {
|
|
1152
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1153
|
-
OTHER = "OTHER",
|
|
1154
|
-
/** A meta site was created from template. */
|
|
1155
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1156
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
1157
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1158
|
-
/** A copy of existing meta site. */
|
|
1159
|
-
DUPLICATE = "DUPLICATE",
|
|
1160
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1161
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1162
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
1163
|
-
FLASH = "FLASH"
|
|
1164
|
-
}
|
|
1165
|
-
/** @enumType */
|
|
1166
|
-
export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1167
|
-
export declare enum Namespace {
|
|
1168
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1169
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1170
|
-
WIX = "WIX",
|
|
1171
|
-
/** 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. */
|
|
1172
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
1173
|
-
/** 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. */
|
|
1174
|
-
ALBUMS = "ALBUMS",
|
|
1175
|
-
/** 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. */
|
|
1176
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1177
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1178
|
-
HOTELS = "HOTELS",
|
|
1179
|
-
/** 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. */
|
|
1180
|
-
CLUBS = "CLUBS",
|
|
1181
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1182
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1183
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1184
|
-
DEV_SITE = "DEV_SITE",
|
|
1185
|
-
/** 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. */
|
|
1186
|
-
LOGOS = "LOGOS",
|
|
1187
|
-
/** 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. */
|
|
1188
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1189
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1190
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1191
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1192
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1193
|
-
/**
|
|
1194
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1195
|
-
*
|
|
1196
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1197
|
-
*/
|
|
1198
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
1199
|
-
/**
|
|
1200
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1201
|
-
* Will be accessible from Site List and will not have a website app.
|
|
1202
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1203
|
-
*/
|
|
1204
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1205
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1206
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1207
|
-
/** It is to be used in the Business First efforts. */
|
|
1208
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1209
|
-
/** Bookings business flow with no site. */
|
|
1210
|
-
ANYWHERE = "ANYWHERE",
|
|
1211
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
1212
|
-
HEADLESS = "HEADLESS",
|
|
1213
|
-
/**
|
|
1214
|
-
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1215
|
-
* The site will be used for account level CSM feature for enterprise
|
|
1216
|
-
*/
|
|
1217
|
-
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1218
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1219
|
-
RISE = "RISE",
|
|
1220
|
-
/**
|
|
1221
|
-
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1222
|
-
* There's a blank site behind the scene but it's blank).
|
|
1223
|
-
* The Mobile company will be the owner of this namespace.
|
|
1224
|
-
*/
|
|
1225
|
-
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1226
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1227
|
-
NOWNIA = "NOWNIA",
|
|
1228
|
-
/**
|
|
1229
|
-
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1230
|
-
* The Partners company owns this namespace.
|
|
1231
|
-
*/
|
|
1232
|
-
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1233
|
-
/** Codux Headless Sites */
|
|
1234
|
-
CODUX = "CODUX",
|
|
1235
|
-
/** Bobb - AI Design Creator. */
|
|
1236
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1237
|
-
/**
|
|
1238
|
-
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1239
|
-
* This site will hold all Blog posts related to the Marketing product.
|
|
1240
|
-
*/
|
|
1241
|
-
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1242
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1243
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1244
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1245
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1246
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1247
|
-
MIMIR = "MIMIR"
|
|
1248
|
-
}
|
|
1249
|
-
/** @enumType */
|
|
1250
|
-
export 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';
|
|
1251
|
-
/** Site transferred to another user. */
|
|
1252
|
-
export interface SiteTransferred {
|
|
1253
|
-
/**
|
|
1254
|
-
* A previous owner id (user that transfers meta site).
|
|
1255
|
-
* @format GUID
|
|
1256
|
-
*/
|
|
1257
|
-
oldOwnerId?: string;
|
|
1258
|
-
/**
|
|
1259
|
-
* A new owner id (user that accepts meta site).
|
|
1260
|
-
* @format GUID
|
|
1261
|
-
*/
|
|
1262
|
-
newOwnerId?: string;
|
|
1263
|
-
}
|
|
1264
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
1265
|
-
export interface SiteDeleted {
|
|
1266
|
-
/** A deletion context. */
|
|
1267
|
-
deleteContext?: DeleteContext;
|
|
1268
|
-
}
|
|
1269
|
-
export interface DeleteContext {
|
|
1270
|
-
/** When the meta site was deleted. */
|
|
1271
|
-
dateDeleted?: Date | null;
|
|
1272
|
-
/** A status. */
|
|
1273
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
1274
|
-
/**
|
|
1275
|
-
* A reason (flow).
|
|
1276
|
-
* @maxLength 255
|
|
1277
|
-
*/
|
|
1278
|
-
deleteOrigin?: string;
|
|
1279
|
-
/**
|
|
1280
|
-
* A service that deleted it.
|
|
1281
|
-
* @maxLength 255
|
|
1282
|
-
*/
|
|
1283
|
-
initiatorId?: string | null;
|
|
1284
|
-
}
|
|
1285
|
-
export declare enum DeleteStatus {
|
|
1286
|
-
UNKNOWN = "UNKNOWN",
|
|
1287
|
-
TRASH = "TRASH",
|
|
1288
|
-
DELETED = "DELETED",
|
|
1289
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
1290
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1291
|
-
}
|
|
1292
|
-
/** @enumType */
|
|
1293
|
-
export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1294
|
-
/** Restoration of the meta site. */
|
|
1295
|
-
export interface SiteUndeleted {
|
|
1296
|
-
}
|
|
1297
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1298
|
-
export interface SitePublished {
|
|
1299
|
-
}
|
|
1300
|
-
export interface SiteUnpublished {
|
|
1301
|
-
/**
|
|
1302
|
-
* A list of URLs previously associated with the meta site.
|
|
1303
|
-
* @maxLength 4000
|
|
1304
|
-
* @maxSize 10000
|
|
1305
|
-
*/
|
|
1306
|
-
urls?: string[];
|
|
1307
|
-
}
|
|
1308
|
-
export interface SiteMarkedAsTemplate {
|
|
1309
|
-
}
|
|
1310
|
-
export interface SiteMarkedAsWixSite {
|
|
1311
|
-
}
|
|
1312
|
-
/**
|
|
1313
|
-
* Represents a service provisioned a site.
|
|
1314
|
-
*
|
|
1315
|
-
* Note on `origin_instance_id`:
|
|
1316
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1317
|
-
* This is because of the following scenario:
|
|
1318
|
-
*
|
|
1319
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1320
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1321
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
1322
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1323
|
-
* your site remains consistent with what you initially received and does not include any
|
|
1324
|
-
* changes made to the original template afterward.
|
|
1325
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1326
|
-
*/
|
|
1327
|
-
export interface ServiceProvisioned {
|
|
1328
|
-
/**
|
|
1329
|
-
* Either UUID or EmbeddedServiceType.
|
|
1330
|
-
* @maxLength 36
|
|
1331
|
-
*/
|
|
1332
|
-
appDefId?: string;
|
|
1333
|
-
/**
|
|
1334
|
-
* Not only UUID. Something here could be something weird.
|
|
1335
|
-
* @maxLength 36
|
|
1336
|
-
*/
|
|
1337
|
-
instanceId?: string;
|
|
1338
|
-
/**
|
|
1339
|
-
* An instance id from which this instance is originated.
|
|
1340
|
-
* @maxLength 36
|
|
1341
|
-
*/
|
|
1342
|
-
originInstanceId?: string;
|
|
1343
|
-
/**
|
|
1344
|
-
* A version.
|
|
1345
|
-
* @maxLength 500
|
|
1346
|
-
*/
|
|
1347
|
-
version?: string | null;
|
|
1348
|
-
/**
|
|
1349
|
-
* The origin meta site id
|
|
1350
|
-
* @format GUID
|
|
1351
|
-
*/
|
|
1352
|
-
originMetaSiteId?: string | null;
|
|
1353
|
-
}
|
|
1354
|
-
export interface ServiceRemoved {
|
|
1355
|
-
/**
|
|
1356
|
-
* Either UUID or EmbeddedServiceType.
|
|
1357
|
-
* @maxLength 36
|
|
1358
|
-
*/
|
|
1359
|
-
appDefId?: string;
|
|
1360
|
-
/**
|
|
1361
|
-
* Not only UUID. Something here could be something weird.
|
|
1362
|
-
* @maxLength 36
|
|
1363
|
-
*/
|
|
1364
|
-
instanceId?: string;
|
|
1365
|
-
/**
|
|
1366
|
-
* A version.
|
|
1367
|
-
* @maxLength 500
|
|
1368
|
-
*/
|
|
1369
|
-
version?: string | null;
|
|
1370
|
-
}
|
|
1371
|
-
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1372
|
-
export interface SiteRenamed {
|
|
1373
|
-
/**
|
|
1374
|
-
* A new meta site name (URL slug).
|
|
1375
|
-
* @maxLength 20
|
|
1376
|
-
*/
|
|
1377
|
-
newSiteName?: string;
|
|
1378
|
-
/**
|
|
1379
|
-
* A previous meta site name (URL slug).
|
|
1380
|
-
* @maxLength 255
|
|
1381
|
-
*/
|
|
1382
|
-
oldSiteName?: string;
|
|
1383
|
-
}
|
|
1384
|
-
/**
|
|
1385
|
-
* Hard deletion of the meta site.
|
|
1386
|
-
*
|
|
1387
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1388
|
-
*/
|
|
1389
|
-
export interface SiteHardDeleted {
|
|
1390
|
-
/** A deletion context. */
|
|
1391
|
-
deleteContext?: DeleteContext;
|
|
1392
|
-
}
|
|
1393
|
-
export interface NamespaceChanged {
|
|
1394
|
-
/** A previous namespace. */
|
|
1395
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
1396
|
-
/** A new namespace. */
|
|
1397
|
-
newNamespace?: NamespaceWithLiterals;
|
|
1398
|
-
}
|
|
1399
|
-
/** Assigned Studio editor */
|
|
1400
|
-
export interface StudioAssigned {
|
|
1401
|
-
}
|
|
1402
|
-
/** Unassigned Studio editor */
|
|
1403
|
-
export interface StudioUnassigned {
|
|
1404
|
-
}
|
|
1405
|
-
/**
|
|
1406
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
1407
|
-
*
|
|
1408
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
1409
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
1410
|
-
*
|
|
1411
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1412
|
-
*/
|
|
1413
|
-
export interface SiteUrlChanged {
|
|
1414
|
-
}
|
|
1415
|
-
/**
|
|
1416
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1417
|
-
* Consumed by other teams to remove relevant data.
|
|
1418
|
-
*/
|
|
1419
|
-
export interface SitePurgedExternally {
|
|
1420
|
-
/**
|
|
1421
|
-
* @maxLength 2048
|
|
1422
|
-
* @maxSize 100
|
|
1423
|
-
* @deprecated
|
|
1424
|
-
* @targetRemovalDate 2025-04-15
|
|
1425
|
-
*/
|
|
1426
|
-
appDefId?: string[];
|
|
1427
|
-
}
|
|
1428
|
-
/** Assigned Odeditor */
|
|
1429
|
-
export interface OdeditorAssigned {
|
|
1430
|
-
}
|
|
1431
|
-
/** Unassigned Odeditor */
|
|
1432
|
-
export interface OdeditorUnassigned {
|
|
1433
|
-
}
|
|
1434
|
-
/** Assigned Picasso editor */
|
|
1435
|
-
export interface PicassoAssigned {
|
|
1436
|
-
}
|
|
1437
|
-
/** Unassigned Picasso */
|
|
1438
|
-
export interface PicassoUnassigned {
|
|
1439
|
-
}
|
|
1440
|
-
export interface MemberOwnershipTransferred {
|
|
1441
|
-
fromMember?: Member;
|
|
1442
|
-
toMember?: Member;
|
|
1443
|
-
}
|
|
1444
|
-
export interface MemberIdChanged {
|
|
1445
|
-
/** @format GUID */
|
|
1446
|
-
fromId?: string;
|
|
1447
|
-
/** @format GUID */
|
|
1448
|
-
toId?: string;
|
|
1449
|
-
}
|
|
1450
|
-
export interface MessageEnvelope {
|
|
1451
|
-
/**
|
|
1452
|
-
* App instance ID.
|
|
1453
|
-
* @format GUID
|
|
1454
|
-
*/
|
|
1455
|
-
instanceId?: string | null;
|
|
1456
|
-
/**
|
|
1457
|
-
* Event type.
|
|
1458
|
-
* @maxLength 150
|
|
1459
|
-
*/
|
|
1460
|
-
eventType?: string;
|
|
1461
|
-
/** The identification type and identity data. */
|
|
1462
|
-
identity?: IdentificationData;
|
|
1463
|
-
/** Stringify payload. */
|
|
1464
|
-
data?: string;
|
|
1465
|
-
}
|
|
1466
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1467
|
-
/**
|
|
1468
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1469
|
-
* @format GUID
|
|
1470
|
-
*/
|
|
1471
|
-
anonymousVisitorId?: string;
|
|
1472
|
-
/**
|
|
1473
|
-
* ID of a site visitor that has logged in to the site.
|
|
1474
|
-
* @format GUID
|
|
1475
|
-
*/
|
|
1476
|
-
memberId?: string;
|
|
1477
|
-
/**
|
|
1478
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1479
|
-
* @format GUID
|
|
1480
|
-
*/
|
|
1481
|
-
wixUserId?: string;
|
|
1482
|
-
/**
|
|
1483
|
-
* ID of an app.
|
|
1484
|
-
* @format GUID
|
|
1485
|
-
*/
|
|
1486
|
-
appId?: string;
|
|
1487
|
-
/** @readonly */
|
|
1488
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1489
|
-
}
|
|
1490
|
-
/** @oneof */
|
|
1491
|
-
export interface IdentificationDataIdOneOf {
|
|
1492
|
-
/**
|
|
1493
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1494
|
-
* @format GUID
|
|
1495
|
-
*/
|
|
1496
|
-
anonymousVisitorId?: string;
|
|
1497
|
-
/**
|
|
1498
|
-
* ID of a site visitor that has logged in to the site.
|
|
1499
|
-
* @format GUID
|
|
1500
|
-
*/
|
|
1501
|
-
memberId?: string;
|
|
1502
|
-
/**
|
|
1503
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1504
|
-
* @format GUID
|
|
1505
|
-
*/
|
|
1506
|
-
wixUserId?: string;
|
|
1507
|
-
/**
|
|
1508
|
-
* ID of an app.
|
|
1509
|
-
* @format GUID
|
|
1510
|
-
*/
|
|
1511
|
-
appId?: string;
|
|
1512
|
-
}
|
|
1513
|
-
export declare enum WebhookIdentityType {
|
|
1514
|
-
UNKNOWN = "UNKNOWN",
|
|
1515
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1516
|
-
MEMBER = "MEMBER",
|
|
1517
|
-
WIX_USER = "WIX_USER",
|
|
1518
|
-
APP = "APP"
|
|
1519
|
-
}
|
|
1520
|
-
/** @enumType */
|
|
1521
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1522
|
-
export interface BaseEventMetadata {
|
|
1523
|
-
/**
|
|
1524
|
-
* App instance ID.
|
|
1525
|
-
* @format GUID
|
|
1526
|
-
*/
|
|
1527
|
-
instanceId?: string | null;
|
|
1528
|
-
/**
|
|
1529
|
-
* Event type.
|
|
1530
|
-
* @maxLength 150
|
|
1531
|
-
*/
|
|
1532
|
-
eventType?: string;
|
|
1533
|
-
/** The identification type and identity data. */
|
|
1534
|
-
identity?: IdentificationData;
|
|
1535
|
-
}
|
|
1536
|
-
export interface EventMetadata extends BaseEventMetadata {
|
|
1537
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1538
|
-
_id?: string;
|
|
1539
|
-
/**
|
|
1540
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1541
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1542
|
-
*/
|
|
1543
|
-
entityFqdn?: string;
|
|
1544
|
-
/**
|
|
1545
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1546
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1547
|
-
*/
|
|
1548
|
-
slug?: string;
|
|
1549
|
-
/** ID of the entity associated with the event. */
|
|
1550
|
-
entityId?: string;
|
|
1551
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1552
|
-
eventTime?: Date | null;
|
|
1553
|
-
/**
|
|
1554
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1555
|
-
* (for example, GDPR).
|
|
1556
|
-
*/
|
|
1557
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1558
|
-
/** If present, indicates the action that triggered the event. */
|
|
1559
|
-
originatedFrom?: string | null;
|
|
1560
|
-
/**
|
|
1561
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1562
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1563
|
-
*/
|
|
1564
|
-
entityEventSequence?: string | null;
|
|
1565
|
-
}
|
|
1566
|
-
export interface MemberCreatedEnvelope {
|
|
1567
|
-
entity: Member;
|
|
1568
|
-
metadata: EventMetadata;
|
|
1569
|
-
}
|
|
1570
|
-
/**
|
|
1571
|
-
* Triggered when a member is created.
|
|
1572
|
-
*
|
|
1573
|
-
* The site owner can configure the site to automatically approve members or require manual approval.
|
|
1574
|
-
*
|
|
1575
|
-
* A member who has been approved either automatically or manually has a `status` of `"APPROVED"`. A created member waiting for approval has a `status` of `"PENDING"`. A `"PENDING"` member can't log in to the site.
|
|
1576
|
-
* @permissionScope Manage Stores
|
|
1577
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1578
|
-
* @permissionScope Manage Members
|
|
1579
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1580
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1581
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1582
|
-
* @permissionScope Manage Events
|
|
1583
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1584
|
-
* @permissionScope Manage Challenges
|
|
1585
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1586
|
-
* @permissionScope Manage Portfolio
|
|
1587
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1588
|
-
* @permissionScope Access Verticals by Automations
|
|
1589
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1590
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1591
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1592
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1593
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1594
|
-
* @permissionScope Read Members
|
|
1595
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1596
|
-
* @permissionScope Set Up Automations
|
|
1597
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1598
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1599
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1600
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1601
|
-
* @webhook
|
|
1602
|
-
* @eventType wix.members.v1.member_created
|
|
1603
|
-
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1604
|
-
* @slug created
|
|
1605
|
-
*/
|
|
1606
|
-
export declare function onMemberCreated(handler: (event: MemberCreatedEnvelope) => void | Promise<void>): void;
|
|
1607
|
-
export interface MemberDeletedEnvelope {
|
|
1608
|
-
metadata: EventMetadata;
|
|
1609
|
-
}
|
|
1610
|
-
/**
|
|
1611
|
-
* Triggered when a member is deleted.
|
|
1612
|
-
* @permissionScope Manage Stores
|
|
1613
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1614
|
-
* @permissionScope Manage Members
|
|
1615
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1616
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1617
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1618
|
-
* @permissionScope Manage Events
|
|
1619
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1620
|
-
* @permissionScope Manage Challenges
|
|
1621
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1622
|
-
* @permissionScope Manage Portfolio
|
|
1623
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1624
|
-
* @permissionScope Access Verticals by Automations
|
|
1625
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1626
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1627
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1628
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1629
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1630
|
-
* @permissionScope Read Members
|
|
1631
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1632
|
-
* @permissionScope Set Up Automations
|
|
1633
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1634
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1635
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1636
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1637
|
-
* @webhook
|
|
1638
|
-
* @eventType wix.members.v1.member_deleted
|
|
1639
|
-
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1640
|
-
* @slug deleted
|
|
1641
|
-
*/
|
|
1642
|
-
export declare function onMemberDeleted(handler: (event: MemberDeletedEnvelope) => void | Promise<void>): void;
|
|
1643
|
-
export interface MemberUpdatedEnvelope {
|
|
1644
|
-
entity: Member;
|
|
1645
|
-
metadata: EventMetadata;
|
|
1646
|
-
}
|
|
1647
|
-
/** @permissionScope Manage Stores
|
|
1648
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1649
|
-
* @permissionScope Manage Members
|
|
1650
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1651
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1652
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1653
|
-
* @permissionScope Manage Events
|
|
1654
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1655
|
-
* @permissionScope Manage Challenges
|
|
1656
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1657
|
-
* @permissionScope Manage Portfolio
|
|
1658
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1659
|
-
* @permissionScope Access Verticals by Automations
|
|
1660
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1661
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1662
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1663
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1664
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1665
|
-
* @permissionScope Read Members
|
|
1666
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1667
|
-
* @permissionScope Set Up Automations
|
|
1668
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1669
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1670
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1671
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1672
|
-
* @webhook
|
|
1673
|
-
* @eventType wix.members.v1.member_updated
|
|
1674
|
-
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1675
|
-
* @slug updated
|
|
1676
|
-
*/
|
|
1677
|
-
export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope) => void | Promise<void>): void;
|
|
1678
|
-
type MemberNonNullablePaths = `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`;
|
|
1679
|
-
/**
|
|
1680
|
-
* Updates the currently logged in member's slug.
|
|
1681
|
-
*
|
|
1682
|
-
* 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`.
|
|
1683
|
-
*
|
|
1684
|
-
* > **Note:**
|
|
1685
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
1686
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1687
|
-
* @param slug - New slug.
|
|
1688
|
-
* @public
|
|
1689
|
-
* @requiredField slug
|
|
1690
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
1691
|
-
* @permissionScope Manage Stores
|
|
1692
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1693
|
-
* @permissionScope Manage Members
|
|
1694
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1695
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1696
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1697
|
-
* @permissionScope Manage Events
|
|
1698
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1699
|
-
* @permissionScope Manage Challenges
|
|
1700
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1701
|
-
* @permissionScope Manage Portfolio
|
|
1702
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1703
|
-
* @permissionScope Access Verticals by Automations
|
|
1704
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1705
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1706
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1707
|
-
* @permissionScope Set Up Automations
|
|
1708
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1709
|
-
* @applicableIdentity APP
|
|
1710
|
-
* @applicableIdentity MEMBER
|
|
1711
|
-
* @fqn com.wixpress.members.api.Members.UpdateMySlug
|
|
1712
|
-
*/
|
|
1713
|
-
export declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, {
|
|
1714
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1715
|
-
}[MemberNonNullablePaths]>>;
|
|
1716
|
-
/**
|
|
1717
|
-
* Updates a member's slug.
|
|
1718
|
-
* @param _id - Member ID.
|
|
1719
|
-
* @param slug - New slug.
|
|
1720
|
-
* @public
|
|
1721
|
-
* @requiredField _id
|
|
1722
|
-
* @requiredField slug
|
|
1723
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
1724
|
-
* @permissionScope Manage Stores
|
|
1725
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1726
|
-
* @permissionScope Manage Members
|
|
1727
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1728
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1729
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1730
|
-
* @permissionScope Manage Events
|
|
1731
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1732
|
-
* @permissionScope Manage Challenges
|
|
1733
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1734
|
-
* @permissionScope Manage Portfolio
|
|
1735
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1736
|
-
* @permissionScope Access Verticals by Automations
|
|
1737
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1738
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1739
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1740
|
-
* @permissionScope Set Up Automations
|
|
1741
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1742
|
-
* @applicableIdentity APP
|
|
1743
|
-
* @applicableIdentity MEMBER
|
|
1744
|
-
* @fqn com.wixpress.members.api.Members.UpdateMemberSlug
|
|
1745
|
-
*/
|
|
1746
|
-
export declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, {
|
|
1747
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1748
|
-
}[MemberNonNullablePaths]>>;
|
|
1749
|
-
/**
|
|
1750
|
-
* Joins the current member to the site community and sets their profile to public.
|
|
1751
|
-
*
|
|
1752
|
-
* When a member's profile is public, they have access to the site's
|
|
1753
|
-
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
1754
|
-
* features, such as chat, forum, and followers,
|
|
1755
|
-
* and their profile is visible to other members and site visitors.
|
|
1756
|
-
*
|
|
1757
|
-
* > **Note:**
|
|
1758
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
1759
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1760
|
-
* @public
|
|
1761
|
-
* @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
|
|
1762
|
-
* @permissionScope Manage Members
|
|
1763
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1764
|
-
* @applicableIdentity APP
|
|
1765
|
-
* @applicableIdentity MEMBER
|
|
1766
|
-
* @returns Member profile.
|
|
1767
|
-
* @fqn com.wixpress.members.api.Members.JoinCommunity
|
|
1768
|
-
*/
|
|
1769
|
-
export declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, {
|
|
1770
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1771
|
-
}[MemberNonNullablePaths]>>;
|
|
1772
|
-
/**
|
|
1773
|
-
* Removes the current member from the site community and sets their profile to private.
|
|
1774
|
-
*
|
|
1775
|
-
* When a member's profile is private,
|
|
1776
|
-
* they do not have access to the site's
|
|
1777
|
-
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
1778
|
-
* features, such as chat, forum, and followers,
|
|
1779
|
-
* and their profile is hidden from other members and site visitors.
|
|
1780
|
-
*
|
|
1781
|
-
* > **Notes:**
|
|
1782
|
-
* > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
|
|
1783
|
-
*
|
|
1784
|
-
* > + Only logged-in members can call this method without elevated permissions.
|
|
1785
|
-
* > + To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1786
|
-
* @public
|
|
1787
|
-
* @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
|
|
1788
|
-
* @permissionScope Manage Members
|
|
1789
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1790
|
-
* @applicableIdentity APP
|
|
1791
|
-
* @applicableIdentity MEMBER
|
|
1792
|
-
* @returns Member profile.
|
|
1793
|
-
* @fqn com.wixpress.members.api.Members.LeaveCommunity
|
|
1794
|
-
*/
|
|
1795
|
-
export declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, {
|
|
1796
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1797
|
-
}[MemberNonNullablePaths]>>;
|
|
1798
|
-
/**
|
|
1799
|
-
* Retrieves the current member.
|
|
1800
|
-
*
|
|
1801
|
-
* >**Note:**
|
|
1802
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
1803
|
-
* @public
|
|
1804
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1805
|
-
* @permissionScope Manage Stores
|
|
1806
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1807
|
-
* @permissionScope Manage Members
|
|
1808
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1809
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1810
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1811
|
-
* @permissionScope Manage Events
|
|
1812
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1813
|
-
* @permissionScope Manage Challenges
|
|
1814
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1815
|
-
* @permissionScope Manage Portfolio
|
|
1816
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1817
|
-
* @permissionScope Access Verticals by Automations
|
|
1818
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1819
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1820
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1821
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1822
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1823
|
-
* @permissionScope Read Members
|
|
1824
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1825
|
-
* @permissionScope Set Up Automations
|
|
1826
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1827
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1828
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1829
|
-
* @applicableIdentity APP
|
|
1830
|
-
* @applicableIdentity VISITOR
|
|
1831
|
-
* @returns Member profile.
|
|
1832
|
-
* @fqn com.wixpress.members.api.Members.GetMyMember
|
|
1833
|
-
*/
|
|
1834
|
-
export declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, {
|
|
1835
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1836
|
-
}[MemberNonNullablePaths]>>;
|
|
1837
|
-
export interface GetCurrentMemberOptions {
|
|
1838
|
-
/**
|
|
1839
|
-
* Predefined set of fields to return.
|
|
1840
|
-
*
|
|
1841
|
-
* Default: `"PUBLIC"`.
|
|
1842
|
-
* @maxSize 3
|
|
1843
|
-
*/
|
|
1844
|
-
fieldsets?: SetWithLiterals[];
|
|
1845
|
-
}
|
|
1846
|
-
/**
|
|
1847
|
-
* Retrieves a member by ID.
|
|
1848
|
-
*
|
|
1849
|
-
* >**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).
|
|
1850
|
-
*
|
|
1851
|
-
* @param _id - Member ID.
|
|
1852
|
-
* @public
|
|
1853
|
-
* @requiredField _id
|
|
1854
|
-
* @param options - Fieldset options.
|
|
1855
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1856
|
-
* @permissionScope Manage Stores
|
|
1857
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1858
|
-
* @permissionScope Manage Members
|
|
1859
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1860
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1861
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1862
|
-
* @permissionScope Manage Events
|
|
1863
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1864
|
-
* @permissionScope Manage Challenges
|
|
1865
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1866
|
-
* @permissionScope Manage Portfolio
|
|
1867
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1868
|
-
* @permissionScope Access Verticals by Automations
|
|
1869
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1870
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1871
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1872
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1873
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1874
|
-
* @permissionScope Read Members
|
|
1875
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1876
|
-
* @permissionScope Set Up Automations
|
|
1877
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1878
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1879
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1880
|
-
* @applicableIdentity APP
|
|
1881
|
-
* @applicableIdentity VISITOR
|
|
1882
|
-
* @returns The requested member.
|
|
1883
|
-
* @fqn com.wixpress.members.api.Members.GetMember
|
|
1884
|
-
*/
|
|
1885
|
-
export declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
|
|
1886
|
-
export interface GetMemberOptions {
|
|
1887
|
-
/**
|
|
1888
|
-
* Predefined set of fields to return.
|
|
1889
|
-
*
|
|
1890
|
-
* Defaults to `"PUBLIC"`.
|
|
1891
|
-
* @maxSize 3
|
|
1892
|
-
*/
|
|
1893
|
-
fieldsets?: SetWithLiterals[];
|
|
1894
|
-
}
|
|
1895
|
-
/**
|
|
1896
|
-
* Lists site members, given the provided paging and fieldsets.
|
|
1897
|
-
* @public
|
|
1898
|
-
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
1899
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1900
|
-
* @permissionScope Manage Stores
|
|
1901
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1902
|
-
* @permissionScope Manage Members
|
|
1903
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1904
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1905
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1906
|
-
* @permissionScope Manage Events
|
|
1907
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1908
|
-
* @permissionScope Manage Challenges
|
|
1909
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1910
|
-
* @permissionScope Manage Portfolio
|
|
1911
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1912
|
-
* @permissionScope Access Verticals by Automations
|
|
1913
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1914
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1915
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1916
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1917
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1918
|
-
* @permissionScope Read Members
|
|
1919
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1920
|
-
* @permissionScope Set Up Automations
|
|
1921
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1922
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1923
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1924
|
-
* @applicableIdentity APP
|
|
1925
|
-
* @applicableIdentity VISITOR
|
|
1926
|
-
* @fqn com.wixpress.members.api.Members.ListMembers
|
|
1927
|
-
*/
|
|
1928
|
-
export declare function listMembers(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, {
|
|
1929
|
-
[P in MemberNonNullablePaths]: `members.${number}.${P}`;
|
|
1930
|
-
}[MemberNonNullablePaths]>>;
|
|
1931
|
-
export interface ListMembersOptions {
|
|
1932
|
-
/** Paging options. */
|
|
1933
|
-
paging?: Paging;
|
|
1934
|
-
/**
|
|
1935
|
-
* Predefined sets of fields to return.
|
|
1936
|
-
*
|
|
1937
|
-
* Default: `"PUBLIC"`.
|
|
1938
|
-
* @maxSize 3
|
|
1939
|
-
*/
|
|
1940
|
-
fieldsets?: SetWithLiterals[];
|
|
1941
|
-
/** Sorting options. */
|
|
1942
|
-
sorting?: Sorting[];
|
|
1943
|
-
}
|
|
1944
|
-
/**
|
|
1945
|
-
* Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
|
|
1946
|
-
*
|
|
1947
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` method.
|
|
1948
|
-
*
|
|
1949
|
-
* You can refine the query by chaining `MembersQueryBuilder` methods onto the query. `MembersQueryBuilder` methods enable you to sort, filter, and control the results that `queryMembers()` returns. The methods that are chained to `queryMembers()` are applied in the order they are called.
|
|
1950
|
-
*
|
|
1951
|
-
* `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
|
|
1952
|
-
* - `skip`: `0`
|
|
1953
|
-
* - `limit`: `50`
|
|
1954
|
-
*
|
|
1955
|
-
* Currently supported fields for sorting:
|
|
1956
|
-
* - `profile.nickname`
|
|
1957
|
-
* - `contact.firstName`
|
|
1958
|
-
* - `contact.lastName`
|
|
1959
|
-
* - `createdDate`
|
|
1960
|
-
* - `lastLoginDate`
|
|
1961
|
-
*
|
|
1962
|
-
* The following `MembersQueryBuilder` methods are supported for the `queryMembers()` method. For a full description of the Locations object, see the returned for the `items` property in `MembersQueryResult`.
|
|
1963
|
-
* @public
|
|
1964
|
-
* @param options - Query options.
|
|
1965
|
-
* @permissionScope Manage Stores
|
|
1966
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1967
|
-
* @permissionScope Manage Members
|
|
1968
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1969
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1970
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1971
|
-
* @permissionScope Manage Events
|
|
1972
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1973
|
-
* @permissionScope Manage Challenges
|
|
1974
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1975
|
-
* @permissionScope Manage Portfolio
|
|
1976
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1977
|
-
* @permissionScope Access Verticals by Automations
|
|
1978
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1979
|
-
* @permissionScope Read Members and Contacts - all read permissions
|
|
1980
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1981
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1982
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1983
|
-
* @permissionScope Read Members
|
|
1984
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1985
|
-
* @permissionScope Set Up Automations
|
|
1986
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1987
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
1988
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1989
|
-
* @permissionId MEMBERS.MEMBER_READ
|
|
1990
|
-
* @applicableIdentity APP
|
|
1991
|
-
* @applicableIdentity VISITOR
|
|
1992
|
-
* @fqn com.wixpress.members.api.Members.QueryMembers
|
|
1993
|
-
*/
|
|
1994
|
-
export declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
1995
|
-
export interface QueryMembersOptions {
|
|
1996
|
-
/**
|
|
1997
|
-
* Predefined sets of fields to return.
|
|
1998
|
-
*
|
|
1999
|
-
* Default: `"PUBLIC"`.
|
|
2000
|
-
* @maxSize 3
|
|
2001
|
-
*/
|
|
2002
|
-
fieldsets?: SetWithLiterals[] | undefined;
|
|
2003
|
-
/** Plain text search. */
|
|
2004
|
-
search?: Search | undefined;
|
|
2005
|
-
}
|
|
2006
|
-
interface QueryOffsetResult {
|
|
2007
|
-
currentPage: number | undefined;
|
|
2008
|
-
totalPages: number | undefined;
|
|
2009
|
-
totalCount: number | undefined;
|
|
2010
|
-
hasNext: () => boolean;
|
|
2011
|
-
hasPrev: () => boolean;
|
|
2012
|
-
length: number;
|
|
2013
|
-
pageSize: number;
|
|
2014
|
-
}
|
|
2015
|
-
export interface MembersQueryResult extends QueryOffsetResult {
|
|
2016
|
-
items: Member[];
|
|
2017
|
-
query: MembersQueryBuilder;
|
|
2018
|
-
next: () => Promise<MembersQueryResult>;
|
|
2019
|
-
prev: () => Promise<MembersQueryResult>;
|
|
2020
|
-
}
|
|
2021
|
-
export interface MembersQueryBuilder {
|
|
2022
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2023
|
-
* @param value - Value to compare against.
|
|
2024
|
-
*/
|
|
2025
|
-
eq: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
2026
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2027
|
-
* @param value - Value to compare against.
|
|
2028
|
-
*/
|
|
2029
|
-
ne: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
2030
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2031
|
-
* @param value - Value to compare against.
|
|
2032
|
-
*/
|
|
2033
|
-
ge: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
2034
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2035
|
-
* @param value - Value to compare against.
|
|
2036
|
-
*/
|
|
2037
|
-
gt: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
2038
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2039
|
-
* @param value - Value to compare against.
|
|
2040
|
-
*/
|
|
2041
|
-
le: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
2042
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
2043
|
-
* @param value - Value to compare against.
|
|
2044
|
-
*/
|
|
2045
|
-
lt: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: any) => MembersQueryBuilder;
|
|
2046
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
2047
|
-
* @param string - String to compare against. Case-insensitive.
|
|
2048
|
-
*/
|
|
2049
|
-
startsWith: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug', value: string) => MembersQueryBuilder;
|
|
2050
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
2051
|
-
* @param values - List of values to compare against.
|
|
2052
|
-
*/
|
|
2053
|
-
hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;
|
|
2054
|
-
in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;
|
|
2055
|
-
exists: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: boolean) => MembersQueryBuilder;
|
|
2056
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
2057
|
-
limit: (limit: number) => MembersQueryBuilder;
|
|
2058
|
-
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
2059
|
-
skip: (skip: number) => MembersQueryBuilder;
|
|
2060
|
-
find: () => Promise<MembersQueryResult>;
|
|
2061
|
-
}
|
|
2062
|
-
/**
|
|
2063
|
-
* Mutes a member.
|
|
2064
|
-
*
|
|
2065
|
-
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
2066
|
-
*
|
|
2067
|
-
* You can mute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
|
|
2068
|
-
* @param _id - ID of the member to mute.
|
|
2069
|
-
* @public
|
|
2070
|
-
* @requiredField _id
|
|
2071
|
-
* @permissionId MEMBERS.MEMBER_MUTE
|
|
2072
|
-
* @permissionScope Manage Members
|
|
2073
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2074
|
-
* @applicableIdentity APP
|
|
2075
|
-
* @fqn com.wixpress.members.api.Members.MuteMember
|
|
2076
|
-
*/
|
|
2077
|
-
export declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberResponse, {
|
|
2078
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2079
|
-
}[MemberNonNullablePaths]>>;
|
|
2080
|
-
/**
|
|
2081
|
-
* Unmutes a member.
|
|
2082
|
-
*
|
|
2083
|
-
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
2084
|
-
*
|
|
2085
|
-
* You can unmute members in [Wix Blog](https://dev.wix.com/docs/rest/business-solutions/blog/introduction) and [Wix Forum](https://dev.wix.com/docs/rest/business-solutions/forum/introduction).
|
|
2086
|
-
* @param _id - ID of the member to unmute.
|
|
2087
|
-
* @public
|
|
2088
|
-
* @requiredField _id
|
|
2089
|
-
* @permissionId MEMBERS.MEMBER_MUTE
|
|
2090
|
-
* @permissionScope Manage Members
|
|
2091
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2092
|
-
* @applicableIdentity APP
|
|
2093
|
-
* @fqn com.wixpress.members.api.Members.UnmuteMember
|
|
2094
|
-
*/
|
|
2095
|
-
export declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, {
|
|
2096
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2097
|
-
}[MemberNonNullablePaths]>>;
|
|
2098
|
-
/**
|
|
2099
|
-
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
2100
|
-
*
|
|
2101
|
-
* Call this API to:
|
|
2102
|
-
* - Approve a pending member.
|
|
2103
|
-
* - Unblock a blocked member.
|
|
2104
|
-
* @param _id - ID of the member to approve.
|
|
2105
|
-
* @public
|
|
2106
|
-
* @requiredField _id
|
|
2107
|
-
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
2108
|
-
* @permissionScope Manage Members
|
|
2109
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2110
|
-
* @applicableIdentity APP
|
|
2111
|
-
* @fqn com.wixpress.members.api.Members.ApproveMember
|
|
2112
|
-
*/
|
|
2113
|
-
export declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, {
|
|
2114
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2115
|
-
}[MemberNonNullablePaths]>>;
|
|
2116
|
-
/**
|
|
2117
|
-
* Blocks a member.
|
|
2118
|
-
*
|
|
2119
|
-
* A blocked member can't log in to members-only pages.
|
|
2120
|
-
*
|
|
2121
|
-
* To unblock a member, call Approve Member.
|
|
2122
|
-
* @param _id - ID of a member to block.
|
|
2123
|
-
* @public
|
|
2124
|
-
* @requiredField _id
|
|
2125
|
-
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
2126
|
-
* @permissionScope Manage Members
|
|
2127
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2128
|
-
* @applicableIdentity APP
|
|
2129
|
-
* @fqn com.wixpress.members.api.Members.BlockMember
|
|
2130
|
-
*/
|
|
2131
|
-
export declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberResponse, {
|
|
2132
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2133
|
-
}[MemberNonNullablePaths]>>;
|
|
2134
|
-
/**
|
|
2135
|
-
* Disconnects a member.
|
|
2136
|
-
*
|
|
2137
|
-
* A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
|
|
2138
|
-
*
|
|
2139
|
-
* >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
|
|
2140
|
-
* @param _id - ID of a member to disconnect.
|
|
2141
|
-
* @public
|
|
2142
|
-
* @requiredField _id
|
|
2143
|
-
* @permissionId MEMBERS.MEMBER_DISCONNECT
|
|
2144
|
-
* @permissionScope Manage Members
|
|
2145
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2146
|
-
* @permissionScope Manage Challenges
|
|
2147
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2148
|
-
* @applicableIdentity APP
|
|
2149
|
-
* @fqn com.wixpress.members.api.Members.DisconnectMember
|
|
2150
|
-
*/
|
|
2151
|
-
export declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, {
|
|
2152
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2153
|
-
}[MemberNonNullablePaths]>>;
|
|
2154
|
-
/**
|
|
2155
|
-
* Deletes a member by ID.
|
|
2156
|
-
*
|
|
2157
|
-
* All content created by this member is transferred to a site owner's account. For example, if a Wix user had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
|
|
2158
|
-
* @param _id - ID of a member to delete.
|
|
2159
|
-
* @public
|
|
2160
|
-
* @requiredField _id
|
|
2161
|
-
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2162
|
-
* @permissionScope Manage Members
|
|
2163
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2164
|
-
* @applicableIdentity APP
|
|
2165
|
-
* @fqn com.wixpress.members.api.Members.DeleteMember
|
|
2166
|
-
*/
|
|
2167
|
-
export declare function deleteMember(_id: string): Promise<void>;
|
|
2168
|
-
/**
|
|
2169
|
-
* Deletes the current member.
|
|
2170
|
-
*
|
|
2171
|
-
* After calling this method, the member is logged out of the site.
|
|
2172
|
-
*
|
|
2173
|
-
* All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the account specified in `contentAssignedId`, which then becomes the owner of those posts.
|
|
2174
|
-
*
|
|
2175
|
-
* >**Note:**
|
|
2176
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
2177
|
-
* @public
|
|
2178
|
-
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2179
|
-
* @permissionScope Manage Members
|
|
2180
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2181
|
-
* @applicableIdentity APP
|
|
2182
|
-
* @fqn com.wixpress.members.api.Members.DeleteMyMember
|
|
2183
|
-
*/
|
|
2184
|
-
export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
|
|
2185
|
-
export interface DeleteMyMemberOptions {
|
|
2186
|
-
/**
|
|
2187
|
-
* ID of a member receiving the deleted member's content.
|
|
2188
|
-
* @format GUID
|
|
2189
|
-
*/
|
|
2190
|
-
contentAssigneeId?: string | null;
|
|
2191
|
-
}
|
|
2192
|
-
/**
|
|
2193
|
-
* Deletes multiple members by `memberId`.
|
|
2194
|
-
*
|
|
2195
|
-
* All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
|
|
2196
|
-
* @param memberIds - IDs of members to be deleted.
|
|
2197
|
-
* @public
|
|
2198
|
-
* @requiredField memberIds
|
|
2199
|
-
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2200
|
-
* @permissionScope Manage Members
|
|
2201
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2202
|
-
* @applicableIdentity APP
|
|
2203
|
-
* @fqn com.wixpress.members.api.Members.BulkDeleteMembers
|
|
2204
|
-
*/
|
|
2205
|
-
export declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePaths<BulkDeleteMembersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2206
|
-
/**
|
|
2207
|
-
* Deletes multiple members by the specified filter.
|
|
2208
|
-
*
|
|
2209
|
-
* All content created by these members is transferred to a site owner's account. For example, if Wix users had blog posts, those posts are transferred to the site owner's account, which then becomes the owner of those posts.
|
|
2210
|
-
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2211
|
-
* @public
|
|
2212
|
-
* @requiredField filter
|
|
2213
|
-
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2214
|
-
* @permissionScope Manage Members
|
|
2215
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2216
|
-
* @applicableIdentity APP
|
|
2217
|
-
* @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
|
|
2218
|
-
*/
|
|
2219
|
-
export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`>>;
|
|
2220
|
-
export interface BulkDeleteMembersByFilterOptions {
|
|
2221
|
-
/**
|
|
2222
|
-
* ID of a member receiving the deleted member's content.
|
|
2223
|
-
* @format GUID
|
|
2224
|
-
*/
|
|
2225
|
-
contentAssigneeId?: string | null;
|
|
2226
|
-
/** Plain text search. */
|
|
2227
|
-
search?: Search;
|
|
2228
|
-
}
|
|
2229
|
-
/**
|
|
2230
|
-
* Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
|
|
2231
|
-
*
|
|
2232
|
-
* Call this API to:
|
|
2233
|
-
* - Approve pending members.
|
|
2234
|
-
* - Unblock blocked members.
|
|
2235
|
-
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2236
|
-
* @public
|
|
2237
|
-
* @requiredField filter
|
|
2238
|
-
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
2239
|
-
* @permissionScope Manage Members
|
|
2240
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2241
|
-
* @applicableIdentity APP
|
|
2242
|
-
* @fqn com.wixpress.members.api.Members.BulkApproveMembers
|
|
2243
|
-
*/
|
|
2244
|
-
export declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`>>;
|
|
2245
|
-
/**
|
|
2246
|
-
* Blocks multiple members by a specified filter.
|
|
2247
|
-
*
|
|
2248
|
-
* Blocked members can't log in to members-only pages.
|
|
2249
|
-
*
|
|
2250
|
-
* To unblock multiple members, call Bulk Approve Members.
|
|
2251
|
-
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2252
|
-
* @public
|
|
2253
|
-
* @requiredField filter
|
|
2254
|
-
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
2255
|
-
* @permissionScope Manage Members
|
|
2256
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2257
|
-
* @applicableIdentity APP
|
|
2258
|
-
* @fqn com.wixpress.members.api.Members.BulkBlockMembers
|
|
2259
|
-
*/
|
|
2260
|
-
export declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`>>;
|
|
2261
|
-
/**
|
|
2262
|
-
* Creates a site member.
|
|
2263
|
-
*
|
|
2264
|
-
* After creation, you can call
|
|
2265
|
-
* [Send Set Password Email ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/authentication/send-set-password-email) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/member-authentication/send-set-password-email))
|
|
2266
|
-
* to email the member with a link to set their password.
|
|
2267
|
-
* The member can log in to the site
|
|
2268
|
-
* when they set their password for the first time.
|
|
2269
|
-
*
|
|
2270
|
-
* > **Note:**
|
|
2271
|
-
* > When creating multiple members,
|
|
2272
|
-
* > set your requests at least 1 second apart to keep below rate limits.
|
|
2273
|
-
* @public
|
|
2274
|
-
* @permissionId MEMBERS.MEMBER_CREATE
|
|
2275
|
-
* @permissionScope Manage Members
|
|
2276
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2277
|
-
* @permissionScope Manage Challenges
|
|
2278
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2279
|
-
* @applicableIdentity APP
|
|
2280
|
-
* @returns New member.
|
|
2281
|
-
* @fqn com.wixpress.members.api.Members.CreateMember
|
|
2282
|
-
*/
|
|
2283
|
-
export declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
|
|
2284
|
-
export interface CreateMemberOptions {
|
|
2285
|
-
/** Member to create. */
|
|
2286
|
-
member?: Member;
|
|
2287
|
-
}
|
|
2288
|
-
/**
|
|
2289
|
-
* Updates a member's properties.
|
|
2290
|
-
*
|
|
2291
|
-
* Only the requested fields are updated.
|
|
2292
|
-
* To clear a field's value, set an empty value with an empty string `""`.
|
|
2293
|
-
*
|
|
2294
|
-
* > **Note:**
|
|
2295
|
-
* > 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.
|
|
2296
|
-
* > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
|
|
2297
|
-
* >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
|
|
2298
|
-
* >- To clear `contact.emails`, use `deleteMemberEmails()`.
|
|
2299
|
-
* >- To clear `contact.phones`, use `deleteMemberPhones()`.
|
|
2300
|
-
*
|
|
2301
|
-
* > **Note:**
|
|
2302
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
2303
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2304
|
-
* @param _id - Member ID.
|
|
2305
|
-
* @public
|
|
2306
|
-
* @requiredField _id
|
|
2307
|
-
* @requiredField member
|
|
2308
|
-
* @param options - Member to update.
|
|
2309
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2310
|
-
* @permissionScope Manage Stores
|
|
2311
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2312
|
-
* @permissionScope Manage Members
|
|
2313
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2314
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2315
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2316
|
-
* @permissionScope Manage Events
|
|
2317
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2318
|
-
* @permissionScope Manage Challenges
|
|
2319
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2320
|
-
* @permissionScope Manage Portfolio
|
|
2321
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2322
|
-
* @permissionScope Access Verticals by Automations
|
|
2323
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2324
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2325
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2326
|
-
* @permissionScope Set Up Automations
|
|
2327
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2328
|
-
* @applicableIdentity APP
|
|
2329
|
-
* @applicableIdentity MEMBER
|
|
2330
|
-
* @returns Updated member.
|
|
2331
|
-
* @fqn com.wixpress.members.api.Members.UpdateMember
|
|
2332
|
-
*/
|
|
2333
|
-
export declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
|
|
2334
|
-
export interface UpdateMember {
|
|
2335
|
-
/**
|
|
2336
|
-
* Member ID.
|
|
2337
|
-
* @format GUID
|
|
2338
|
-
* @readonly
|
|
2339
|
-
*/
|
|
2340
|
-
_id?: string | null;
|
|
2341
|
-
/**
|
|
2342
|
-
* Email used by a member to log in to the site.
|
|
2343
|
-
* @format EMAIL
|
|
2344
|
-
*/
|
|
2345
|
-
loginEmail?: string | null;
|
|
2346
|
-
/**
|
|
2347
|
-
* Whether the email used by a member has been verified.
|
|
2348
|
-
* @readonly
|
|
2349
|
-
*/
|
|
2350
|
-
loginEmailVerified?: boolean | null;
|
|
2351
|
-
/**
|
|
2352
|
-
* Member site access status.
|
|
2353
|
-
* @readonly
|
|
2354
|
-
*/
|
|
2355
|
-
status?: StatusWithLiterals;
|
|
2356
|
-
/**
|
|
2357
|
-
* Contact ID.
|
|
2358
|
-
* @format GUID
|
|
2359
|
-
* @readonly
|
|
2360
|
-
*/
|
|
2361
|
-
contactId?: string | null;
|
|
2362
|
-
/**
|
|
2363
|
-
* Member's contact information. Contact information is stored in the
|
|
2364
|
-
* [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).
|
|
2365
|
-
*
|
|
2366
|
-
* The full set of contact data can be accessed and managed with the
|
|
2367
|
-
* Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
|
|
2368
|
-
*/
|
|
2369
|
-
contact?: Contact;
|
|
2370
|
-
/** Profile display details. */
|
|
2371
|
-
profile?: Profile;
|
|
2372
|
-
/** Member privacy status. */
|
|
2373
|
-
privacyStatus?: PrivacyStatusStatusWithLiterals;
|
|
2374
|
-
/**
|
|
2375
|
-
* Member activity status.
|
|
2376
|
-
* @readonly
|
|
2377
|
-
*/
|
|
2378
|
-
activityStatus?: ActivityStatusStatusWithLiterals;
|
|
2379
|
-
/**
|
|
2380
|
-
* Date and time when the member was created.
|
|
2381
|
-
* @readonly
|
|
2382
|
-
*/
|
|
2383
|
-
_createdDate?: Date | null;
|
|
2384
|
-
/**
|
|
2385
|
-
* Date and time when the member was updated.
|
|
2386
|
-
* @readonly
|
|
2387
|
-
*/
|
|
2388
|
-
_updatedDate?: Date | null;
|
|
2389
|
-
/**
|
|
2390
|
-
* Date and time when the member last logged in to the site.
|
|
2391
|
-
* @readonly
|
|
2392
|
-
*/
|
|
2393
|
-
lastLoginDate?: Date | null;
|
|
2394
|
-
}
|
|
2395
|
-
/**
|
|
2396
|
-
* Clears a member's phone numbers.
|
|
2397
|
-
*
|
|
2398
|
-
* `deleteMemberPhones()` clears the `phones` array under the `contact` property.
|
|
2399
|
-
*
|
|
2400
|
-
* > **Note:**
|
|
2401
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
2402
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2403
|
-
* @param _id - ID of the member whose phone numbers will be deleted.
|
|
2404
|
-
* @public
|
|
2405
|
-
* @requiredField _id
|
|
2406
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2407
|
-
* @permissionScope Manage Stores
|
|
2408
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2409
|
-
* @permissionScope Manage Members
|
|
2410
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2411
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2412
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2413
|
-
* @permissionScope Manage Events
|
|
2414
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2415
|
-
* @permissionScope Manage Challenges
|
|
2416
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2417
|
-
* @permissionScope Manage Portfolio
|
|
2418
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2419
|
-
* @permissionScope Access Verticals by Automations
|
|
2420
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2421
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2422
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2423
|
-
* @permissionScope Set Up Automations
|
|
2424
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2425
|
-
* @applicableIdentity APP
|
|
2426
|
-
* @applicableIdentity MEMBER
|
|
2427
|
-
* @fqn com.wixpress.members.api.Members.DeleteMemberPhones
|
|
2428
|
-
*/
|
|
2429
|
-
export declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, {
|
|
2430
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2431
|
-
}[MemberNonNullablePaths]>>;
|
|
2432
|
-
/**
|
|
2433
|
-
* Clears a member's email addresses.
|
|
2434
|
-
*
|
|
2435
|
-
* `deleteMemberEmails()` clears the `emails` array under the `contact` property.
|
|
2436
|
-
*
|
|
2437
|
-
* > **Notes:**
|
|
2438
|
-
* > A member can still log in with their `loginEmail`,
|
|
2439
|
-
* > which is not cleared when this method is called.
|
|
2440
|
-
*
|
|
2441
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
2442
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2443
|
-
* @param _id - ID of the member whose email addresses will be deleted.
|
|
2444
|
-
* @public
|
|
2445
|
-
* @requiredField _id
|
|
2446
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2447
|
-
* @permissionScope Manage Stores
|
|
2448
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2449
|
-
* @permissionScope Manage Members
|
|
2450
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2451
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2452
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2453
|
-
* @permissionScope Manage Events
|
|
2454
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2455
|
-
* @permissionScope Manage Challenges
|
|
2456
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2457
|
-
* @permissionScope Manage Portfolio
|
|
2458
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2459
|
-
* @permissionScope Access Verticals by Automations
|
|
2460
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2461
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2462
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2463
|
-
* @permissionScope Set Up Automations
|
|
2464
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2465
|
-
* @applicableIdentity APP
|
|
2466
|
-
* @applicableIdentity MEMBER
|
|
2467
|
-
* @fqn com.wixpress.members.api.Members.DeleteMemberEmails
|
|
2468
|
-
*/
|
|
2469
|
-
export declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, {
|
|
2470
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2471
|
-
}[MemberNonNullablePaths]>>;
|
|
2472
|
-
/**
|
|
2473
|
-
* Deletes a member's street addresses.
|
|
2474
|
-
*
|
|
2475
|
-
* `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
|
|
2476
|
-
*
|
|
2477
|
-
* > **Note:**
|
|
2478
|
-
* > Only logged-in members can call this method without elevated permissions.
|
|
2479
|
-
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2480
|
-
* @param _id - ID of the member whose street addresses will be deleted.
|
|
2481
|
-
* @public
|
|
2482
|
-
* @requiredField _id
|
|
2483
|
-
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2484
|
-
* @permissionScope Manage Stores
|
|
2485
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
2486
|
-
* @permissionScope Manage Members
|
|
2487
|
-
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
2488
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
2489
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
2490
|
-
* @permissionScope Manage Events
|
|
2491
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2492
|
-
* @permissionScope Manage Challenges
|
|
2493
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
2494
|
-
* @permissionScope Manage Portfolio
|
|
2495
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
2496
|
-
* @permissionScope Access Verticals by Automations
|
|
2497
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
2498
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2499
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2500
|
-
* @permissionScope Set Up Automations
|
|
2501
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
2502
|
-
* @applicableIdentity APP
|
|
2503
|
-
* @applicableIdentity MEMBER
|
|
2504
|
-
* @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
|
|
2505
|
-
*/
|
|
2506
|
-
export declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, {
|
|
2507
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2508
|
-
}[MemberNonNullablePaths]>>;
|
|
2509
|
-
export {};
|