@wix/auto_sdk_members_members 1.0.59 → 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.
Files changed (119) hide show
  1. package/build/cjs/index.d.ts +380 -1
  2. package/build/cjs/index.js +1800 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/{es/src/members-v1-member-members.types.d.ts → cjs/members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
  5. package/build/cjs/meta.d.ts +708 -1
  6. package/build/cjs/meta.js +1236 -15
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/{internal/cjs/src/members-v1-member-members.public.d.ts → es/index.d.mts} +72 -33
  9. package/build/es/index.mjs +1743 -0
  10. package/build/es/index.mjs.map +1 -0
  11. package/build/{cjs/src/members-v1-member-members.types.d.ts → es/members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
  12. package/build/es/meta.d.mts +708 -0
  13. package/build/es/meta.mjs +1189 -0
  14. package/build/es/meta.mjs.map +1 -0
  15. package/build/internal/cjs/index.d.ts +380 -1
  16. package/build/internal/cjs/index.js +1800 -15
  17. package/build/internal/cjs/index.js.map +1 -1
  18. package/build/internal/cjs/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.ts} +413 -177
  19. package/build/internal/cjs/meta.d.ts +708 -1
  20. package/build/internal/cjs/meta.js +1236 -15
  21. package/build/internal/cjs/meta.js.map +1 -1
  22. package/build/{es/src/members-v1-member-members.public.d.ts → internal/es/index.d.mts} +72 -33
  23. package/build/internal/es/index.mjs +1743 -0
  24. package/build/internal/es/index.mjs.map +1 -0
  25. package/build/internal/es/{src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-JdMli_Bi.d.mts} +413 -177
  26. package/build/internal/es/meta.d.mts +708 -0
  27. package/build/internal/es/meta.mjs +1189 -0
  28. package/build/internal/es/meta.mjs.map +1 -0
  29. package/package.json +9 -8
  30. package/build/cjs/index.typings.d.ts +0 -1
  31. package/build/cjs/index.typings.js +0 -18
  32. package/build/cjs/index.typings.js.map +0 -1
  33. package/build/cjs/src/members-v1-member-members.context.d.ts +0 -46
  34. package/build/cjs/src/members-v1-member-members.context.js +0 -59
  35. package/build/cjs/src/members-v1-member-members.context.js.map +0 -1
  36. package/build/cjs/src/members-v1-member-members.http.d.ts +0 -229
  37. package/build/cjs/src/members-v1-member-members.http.js +0 -959
  38. package/build/cjs/src/members-v1-member-members.http.js.map +0 -1
  39. package/build/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  40. package/build/cjs/src/members-v1-member-members.meta.js +0 -484
  41. package/build/cjs/src/members-v1-member-members.meta.js.map +0 -1
  42. package/build/cjs/src/members-v1-member-members.public.d.ts +0 -341
  43. package/build/cjs/src/members-v1-member-members.public.js +0 -198
  44. package/build/cjs/src/members-v1-member-members.public.js.map +0 -1
  45. package/build/cjs/src/members-v1-member-members.types.js +0 -174
  46. package/build/cjs/src/members-v1-member-members.types.js.map +0 -1
  47. package/build/cjs/src/members-v1-member-members.universal.d.ts +0 -2539
  48. package/build/cjs/src/members-v1-member-members.universal.js +0 -1411
  49. package/build/cjs/src/members-v1-member-members.universal.js.map +0 -1
  50. package/build/es/index.d.ts +0 -1
  51. package/build/es/index.js +0 -2
  52. package/build/es/index.js.map +0 -1
  53. package/build/es/index.typings.d.ts +0 -1
  54. package/build/es/index.typings.js +0 -2
  55. package/build/es/index.typings.js.map +0 -1
  56. package/build/es/meta.d.ts +0 -1
  57. package/build/es/meta.js +0 -2
  58. package/build/es/meta.js.map +0 -1
  59. package/build/es/src/members-v1-member-members.context.d.ts +0 -46
  60. package/build/es/src/members-v1-member-members.context.js +0 -46
  61. package/build/es/src/members-v1-member-members.context.js.map +0 -1
  62. package/build/es/src/members-v1-member-members.http.d.ts +0 -229
  63. package/build/es/src/members-v1-member-members.http.js +0 -932
  64. package/build/es/src/members-v1-member-members.http.js.map +0 -1
  65. package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
  66. package/build/es/src/members-v1-member-members.meta.js +0 -434
  67. package/build/es/src/members-v1-member-members.meta.js.map +0 -1
  68. package/build/es/src/members-v1-member-members.public.js +0 -161
  69. package/build/es/src/members-v1-member-members.public.js.map +0 -1
  70. package/build/es/src/members-v1-member-members.types.js +0 -171
  71. package/build/es/src/members-v1-member-members.types.js.map +0 -1
  72. package/build/es/src/members-v1-member-members.universal.d.ts +0 -2539
  73. package/build/es/src/members-v1-member-members.universal.js +0 -1361
  74. package/build/es/src/members-v1-member-members.universal.js.map +0 -1
  75. package/build/internal/cjs/index.typings.d.ts +0 -1
  76. package/build/internal/cjs/index.typings.js +0 -18
  77. package/build/internal/cjs/index.typings.js.map +0 -1
  78. package/build/internal/cjs/src/members-v1-member-members.context.d.ts +0 -46
  79. package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
  80. package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
  81. package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
  82. package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
  83. package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
  84. package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  85. package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
  86. package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
  87. package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
  88. package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
  89. package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
  90. package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
  91. package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2539
  92. package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1411
  93. package/build/internal/cjs/src/members-v1-member-members.universal.js.map +0 -1
  94. package/build/internal/es/index.d.ts +0 -1
  95. package/build/internal/es/index.js +0 -2
  96. package/build/internal/es/index.js.map +0 -1
  97. package/build/internal/es/index.typings.d.ts +0 -1
  98. package/build/internal/es/index.typings.js +0 -2
  99. package/build/internal/es/index.typings.js.map +0 -1
  100. package/build/internal/es/meta.d.ts +0 -1
  101. package/build/internal/es/meta.js +0 -2
  102. package/build/internal/es/meta.js.map +0 -1
  103. package/build/internal/es/src/members-v1-member-members.context.d.ts +0 -46
  104. package/build/internal/es/src/members-v1-member-members.context.js +0 -46
  105. package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
  106. package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
  107. package/build/internal/es/src/members-v1-member-members.http.js +0 -932
  108. package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
  109. package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
  110. package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
  111. package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
  112. package/build/internal/es/src/members-v1-member-members.public.d.ts +0 -341
  113. package/build/internal/es/src/members-v1-member-members.public.js +0 -161
  114. package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
  115. package/build/internal/es/src/members-v1-member-members.types.js +0 -171
  116. package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
  117. package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2539
  118. package/build/internal/es/src/members-v1-member-members.universal.js +0 -1361
  119. package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
@@ -0,0 +1,708 @@
1
+ import { a2 as UpdateMySlugRequest$1, U as UpdateMySlugResponse$1, a4 as UpdateMemberSlugRequest$1, a as UpdateMemberSlugResponse$1, a5 as JoinCommunityRequest$1, J as JoinCommunityResponse$1, a7 as LeaveCommunityRequest$1, L as LeaveCommunityResponse$1, a9 as GetMyMemberRequest$1, b as GetMyMemberResponse$1, aa as GetMemberRequest$1, ab as GetMemberResponse$1, ad as ListMembersRequest$1, e as ListMembersResponse$1, ak as QueryMembersRequest$1, an as QueryMembersResponse$1, ao as MuteMemberRequest$1, g as MuteMemberResponse$1, aq as UnmuteMemberRequest$1, h as UnmuteMemberResponse$1, as as ApproveMemberRequest$1, A as ApproveMemberResponse$1, au as BlockMemberRequest$1, B as BlockMemberResponse$1, az as DisconnectMemberRequest$1, D as DisconnectMemberResponse$1, aA as DeleteMemberRequest$1, aB as DeleteMemberResponse$1, aG as DeleteMyMemberRequest$1, aH as DeleteMyMemberResponse$1, aI as BulkDeleteMembersRequest$1, j as BulkDeleteMembersResponse$1, aN as BulkDeleteMembersByFilterRequest$1, l as BulkDeleteMembersByFilterResponse$1, aO as BulkApproveMembersRequest$1, m as BulkApproveMembersResponse$1, aP as BulkBlockMembersRequest$1, n as BulkBlockMembersResponse$1, aQ as CreateMemberRequest$1, aR as CreateMemberResponse$1, aS as UpdateMemberRequest$1, aT as UpdateMemberResponse$1, aV as DeleteMemberPhonesRequest$1, p as DeleteMemberPhonesResponse$1, aW as DeleteMemberEmailsRequest$1, q as DeleteMemberEmailsResponse$1, aX as DeleteMemberAddressesRequest$1, r as DeleteMemberAddressesResponse$1 } from './members-v1-member-members.universal-JdMli_Bi.mjs';
2
+
3
+ interface Member {
4
+ /**
5
+ * Member ID.
6
+ * @format GUID
7
+ * @readonly
8
+ */
9
+ id?: string | null;
10
+ /**
11
+ * Email used by a member to log in to the site.
12
+ * @format EMAIL
13
+ */
14
+ loginEmail?: string | null;
15
+ /**
16
+ * Whether the email used by a member has been verified.
17
+ * @readonly
18
+ */
19
+ loginEmailVerified?: boolean | null;
20
+ /**
21
+ * Member site access status.
22
+ * @readonly
23
+ */
24
+ status?: StatusWithLiterals;
25
+ /**
26
+ * Contact ID.
27
+ * @format GUID
28
+ * @readonly
29
+ */
30
+ contactId?: string | null;
31
+ /**
32
+ * Member's contact information. Contact information is stored in the
33
+ * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
34
+ *
35
+ * The full set of contact data can be accessed and managed with the
36
+ * 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)).
37
+ */
38
+ contact?: Contact;
39
+ /** Profile display details. */
40
+ profile?: Profile;
41
+ /** Member privacy status. */
42
+ privacyStatus?: PrivacyStatusStatusWithLiterals;
43
+ /**
44
+ * Member activity status.
45
+ * @readonly
46
+ */
47
+ activityStatus?: ActivityStatusStatusWithLiterals;
48
+ /**
49
+ * Date and time when the member was created.
50
+ * @readonly
51
+ */
52
+ createdDate?: Date | null;
53
+ /**
54
+ * Date and time when the member was updated.
55
+ * @readonly
56
+ */
57
+ updatedDate?: Date | null;
58
+ /**
59
+ * Date and time when the member last logged in to the site.
60
+ * @readonly
61
+ */
62
+ lastLoginDate?: Date | null;
63
+ }
64
+ declare enum Status {
65
+ /** Insufficient permissions to get the status. */
66
+ UNKNOWN = "UNKNOWN",
67
+ /** Member is created and is waiting for approval by a Wix user. */
68
+ PENDING = "PENDING",
69
+ /** Member can log in to the site. */
70
+ APPROVED = "APPROVED",
71
+ /** Member is blocked and can't log in to the site. */
72
+ BLOCKED = "BLOCKED",
73
+ /** 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. */
74
+ OFFLINE = "OFFLINE"
75
+ }
76
+ /** @enumType */
77
+ type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE';
78
+ /** Contact info associated with the member. */
79
+ interface Contact {
80
+ /** Contact's first name. */
81
+ firstName?: string | null;
82
+ /** Contact's last name. */
83
+ lastName?: string | null;
84
+ /** List of phone numbers. */
85
+ phones?: string[] | null;
86
+ /**
87
+ * List of email addresses.
88
+ * @format EMAIL
89
+ */
90
+ emails?: string[] | null;
91
+ /** List of street addresses. */
92
+ addresses?: Address[];
93
+ /**
94
+ * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
95
+ *
96
+ * Example: `"2020-03-15"` for March 15, 2020.
97
+ * @maxLength 100
98
+ */
99
+ birthdate?: string | null;
100
+ /**
101
+ * Contact's company name.
102
+ * @maxLength 100
103
+ */
104
+ company?: string | null;
105
+ /**
106
+ * Contact's job title.
107
+ * @maxLength 100
108
+ */
109
+ jobTitle?: string | null;
110
+ /**
111
+ * Custom fields,
112
+ * where each key is the field key,
113
+ * and each value is the field's value for the member.
114
+ */
115
+ customFields?: Record<string, CustomField>;
116
+ }
117
+ /** Street address. */
118
+ interface Address extends AddressStreetOneOf {
119
+ /** Street address object, with number and name in separate fields. */
120
+ streetAddress?: StreetAddress;
121
+ /**
122
+ * Main address line, usually street and number, as free text.
123
+ * @maxLength 200
124
+ */
125
+ addressLine?: string | null;
126
+ /**
127
+ * Street address ID.
128
+ * @format GUID
129
+ * @readonly
130
+ */
131
+ id?: string | null;
132
+ /**
133
+ * Free text providing more detailed address information,
134
+ * such as apartment, suite, or floor.
135
+ */
136
+ addressLine2?: string | null;
137
+ /** City name. */
138
+ city?: string | null;
139
+ /**
140
+ * Code for a subdivision (such as state, prefecture, or province) in an
141
+ * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
142
+ */
143
+ subdivision?: string | null;
144
+ /**
145
+ * 2-letter country code in an
146
+ * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
147
+ */
148
+ country?: string | null;
149
+ /** Postal code. */
150
+ postalCode?: string | null;
151
+ }
152
+ /** @oneof */
153
+ interface AddressStreetOneOf {
154
+ /** Street address object, with number and name in separate fields. */
155
+ streetAddress?: StreetAddress;
156
+ /**
157
+ * Main address line, usually street and number, as free text.
158
+ * @maxLength 200
159
+ */
160
+ addressLine?: string | null;
161
+ }
162
+ interface StreetAddress {
163
+ /**
164
+ * Street number.
165
+ * @maxLength 100
166
+ */
167
+ number?: string;
168
+ /**
169
+ * Street name.
170
+ * @maxLength 200
171
+ */
172
+ name?: string;
173
+ }
174
+ interface CustomField {
175
+ /** Custom field name. */
176
+ name?: string | null;
177
+ /** Custom field value. */
178
+ value?: any;
179
+ }
180
+ /** Member Profile */
181
+ interface Profile {
182
+ /**
183
+ * Name that identifies the member to other members.
184
+ * Displayed on the member's profile page
185
+ * and interactions in the forum or blog.
186
+ */
187
+ nickname?: string | null;
188
+ /**
189
+ * Slug that determines the member's profile page URL.
190
+ * @readonly
191
+ */
192
+ slug?: string | null;
193
+ /** Member's profile photo. */
194
+ photo?: Image;
195
+ /**
196
+ * Member's cover photo,
197
+ * used as a background picture in a member's profile page.
198
+ *
199
+ * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
200
+ * When left empty, the values default to `0`.
201
+ */
202
+ cover?: Image;
203
+ /**
204
+ * Member title.
205
+ *
206
+ * Currently available through the API only.
207
+ */
208
+ title?: string | null;
209
+ }
210
+ interface Image {
211
+ /**
212
+ * Wix Media image ID,
213
+ * set when the member selects an image from Wix Media.
214
+ */
215
+ id?: string;
216
+ /** Image URL. */
217
+ url?: string;
218
+ /** Original image width. */
219
+ height?: number;
220
+ /** Original image height. */
221
+ width?: number;
222
+ /**
223
+ * X-axis offset.
224
+ *
225
+ * Default: `0`.
226
+ */
227
+ offsetX?: number | null;
228
+ /**
229
+ * Y-axis offset.
230
+ *
231
+ * Default: `0`.
232
+ */
233
+ offsetY?: number | null;
234
+ }
235
+ declare enum PrivacyStatusStatus {
236
+ /** Insufficient permissions to get the status. */
237
+ UNKNOWN = "UNKNOWN",
238
+ /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
239
+ PRIVATE = "PRIVATE",
240
+ /** Member is visible to everyone. */
241
+ PUBLIC = "PUBLIC"
242
+ }
243
+ /** @enumType */
244
+ type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC';
245
+ declare enum ActivityStatusStatus {
246
+ /** Insufficient permissions to get the status. */
247
+ UNKNOWN = "UNKNOWN",
248
+ /** Member can write forum posts and blog comments. */
249
+ ACTIVE = "ACTIVE",
250
+ /** Member can't write forum posts or blog comments. */
251
+ MUTED = "MUTED"
252
+ }
253
+ /** @enumType */
254
+ type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED';
255
+ interface UpdateMySlugRequest {
256
+ /**
257
+ * New slug.
258
+ * @maxLength 255
259
+ */
260
+ slug: string;
261
+ }
262
+ interface UpdateMySlugResponse {
263
+ /** Updated member. */
264
+ member?: Member;
265
+ }
266
+ interface UpdateMemberSlugRequest {
267
+ /**
268
+ * Member ID.
269
+ * @format GUID
270
+ */
271
+ id: string;
272
+ /**
273
+ * New slug.
274
+ * @maxLength 255
275
+ */
276
+ slug: string;
277
+ }
278
+ interface UpdateMemberSlugResponse {
279
+ /** Updated member. */
280
+ member?: Member;
281
+ }
282
+ interface JoinCommunityRequest {
283
+ }
284
+ /** Member profile. */
285
+ interface JoinCommunityResponse {
286
+ /** The updated member. */
287
+ member?: Member;
288
+ }
289
+ interface LeaveCommunityRequest {
290
+ }
291
+ /** Member profile. */
292
+ interface LeaveCommunityResponse {
293
+ /** The updated member. */
294
+ member?: Member;
295
+ }
296
+ interface GetMyMemberRequest {
297
+ /**
298
+ * Predefined set of fields to return.
299
+ *
300
+ * Default: `"PUBLIC"`.
301
+ * @maxSize 3
302
+ */
303
+ fieldsets?: SetWithLiterals[];
304
+ }
305
+ declare enum Set {
306
+ /**
307
+ * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
308
+ * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
309
+ */
310
+ PUBLIC = "PUBLIC",
311
+ /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */
312
+ EXTENDED = "EXTENDED",
313
+ /** Includes all fields. */
314
+ FULL = "FULL"
315
+ }
316
+ /** @enumType */
317
+ type SetWithLiterals = Set | 'PUBLIC' | 'EXTENDED' | 'FULL';
318
+ /** Member profile. */
319
+ interface GetMyMemberResponse {
320
+ /** The retrieved member. */
321
+ member?: Member;
322
+ }
323
+ interface GetMemberRequest {
324
+ /**
325
+ * Member ID.
326
+ * @format GUID
327
+ */
328
+ id: string;
329
+ /**
330
+ * Predefined set of fields to return.
331
+ *
332
+ * Defaults to `"PUBLIC"`.
333
+ * @maxSize 3
334
+ */
335
+ fieldsets?: SetWithLiterals[];
336
+ }
337
+ interface GetMemberResponse {
338
+ /** The requested member. */
339
+ member?: Member;
340
+ }
341
+ interface ListMembersRequest {
342
+ paging?: Paging;
343
+ /**
344
+ * Predefined sets of fields to return.
345
+ *
346
+ * Default: `"PUBLIC"`.
347
+ * @maxSize 3
348
+ */
349
+ fieldsets?: SetWithLiterals[];
350
+ sorting?: Sorting[];
351
+ }
352
+ interface Paging {
353
+ /** Number of items to load. */
354
+ limit?: number | null;
355
+ /** Number of items to skip in the current sort order. */
356
+ offset?: number | null;
357
+ }
358
+ interface Sorting {
359
+ /**
360
+ * Name of the field to sort by.
361
+ * @maxLength 512
362
+ */
363
+ fieldName?: string;
364
+ /** Sort order. */
365
+ order?: SortOrderWithLiterals;
366
+ }
367
+ declare enum SortOrder {
368
+ ASC = "ASC",
369
+ DESC = "DESC"
370
+ }
371
+ /** @enumType */
372
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
373
+ interface ListMembersResponse {
374
+ /** List of members. */
375
+ members?: Member[];
376
+ /** Metadata for the paginated results. */
377
+ metadata?: PagingMetadata;
378
+ }
379
+ interface PagingMetadata {
380
+ /** Number of items returned in the response. */
381
+ count?: number | null;
382
+ /** Offset that was requested. */
383
+ offset?: number | null;
384
+ /** Total number of items that match the query. */
385
+ total?: number | null;
386
+ /** Flag that indicates the server failed to calculate the `total` field. */
387
+ tooManyToCount?: boolean | null;
388
+ }
389
+ interface QueryMembersRequest {
390
+ /** Query options. */
391
+ query?: Query;
392
+ /**
393
+ * Predefined sets of fields to return.
394
+ *
395
+ * Default: `"PUBLIC"`.
396
+ * @maxSize 3
397
+ */
398
+ fieldsets?: SetWithLiterals[];
399
+ /** Plain text search. */
400
+ search?: Search;
401
+ }
402
+ interface Query {
403
+ /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
404
+ filter?: any;
405
+ /** Limit number of results */
406
+ paging?: Paging;
407
+ /** Sort the results */
408
+ sorting?: Sorting[];
409
+ }
410
+ /** Free text to match in searchable fields */
411
+ interface Search {
412
+ /**
413
+ * Search term or expression.
414
+ * @minLength 1
415
+ * @maxLength 100
416
+ */
417
+ expression?: string | null;
418
+ /**
419
+ * Currently supported fields for search:
420
+ *
421
+ * - `loginEmail`
422
+ * - `contact.firstName`
423
+ * - `contact.lastName`
424
+ * - `profile.title`
425
+ * - `profile.nickname`
426
+ * - `profile.slug`
427
+ *
428
+ * Default: `profile.nickname`.
429
+ * @maxSize 4
430
+ */
431
+ fields?: string[];
432
+ }
433
+ interface QueryMembersResponse {
434
+ /** List of members that met the query filter criteria. */
435
+ members?: Member[];
436
+ /** Metadata for the paginated results. */
437
+ metadata?: PagingMetadata;
438
+ }
439
+ interface MuteMemberRequest {
440
+ /**
441
+ * ID of the member to mute.
442
+ * @format GUID
443
+ */
444
+ id: string;
445
+ }
446
+ interface MuteMemberResponse {
447
+ /** Muted member. */
448
+ member?: Member;
449
+ }
450
+ interface UnmuteMemberRequest {
451
+ /**
452
+ * ID of the member to unmute.
453
+ * @format GUID
454
+ */
455
+ id: string;
456
+ }
457
+ interface UnmuteMemberResponse {
458
+ /** Unmuted member. */
459
+ member?: Member;
460
+ }
461
+ interface ApproveMemberRequest {
462
+ /**
463
+ * ID of the member to approve.
464
+ * @format GUID
465
+ */
466
+ id: string;
467
+ }
468
+ interface ApproveMemberResponse {
469
+ /** Approved member. */
470
+ member?: Member;
471
+ }
472
+ interface BlockMemberRequest {
473
+ /**
474
+ * ID of a member to block.
475
+ * @format GUID
476
+ */
477
+ id: string;
478
+ }
479
+ interface BlockMemberResponse {
480
+ /** Blocked member. */
481
+ member?: Member;
482
+ }
483
+ interface DisconnectMemberRequest {
484
+ /**
485
+ * ID of a member to disconnect.
486
+ * @format GUID
487
+ */
488
+ id: string;
489
+ }
490
+ interface DisconnectMemberResponse {
491
+ /** Disconnected member. */
492
+ member?: Member;
493
+ }
494
+ interface DeleteMemberRequest {
495
+ /**
496
+ * ID of a member to delete.
497
+ * @format GUID
498
+ */
499
+ id: string;
500
+ }
501
+ interface DeleteMemberResponse {
502
+ }
503
+ interface DeleteMyMemberRequest {
504
+ /**
505
+ * ID of a member receiving the deleted member's content.
506
+ * @format GUID
507
+ */
508
+ contentAssigneeId?: string | null;
509
+ }
510
+ interface DeleteMyMemberResponse {
511
+ }
512
+ interface BulkDeleteMembersRequest {
513
+ /**
514
+ * IDs of members to be deleted.
515
+ * @minSize 1
516
+ * @maxSize 100
517
+ * @format GUID
518
+ */
519
+ memberIds: string[];
520
+ }
521
+ interface BulkDeleteMembersResponse {
522
+ /** Result. */
523
+ results?: BulkMemberResult[];
524
+ /** Bulk action result metadata. */
525
+ bulkActionMetadata?: BulkActionMetadata;
526
+ }
527
+ interface ItemMetadata {
528
+ /**
529
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
530
+ * @maxLength 255
531
+ */
532
+ id?: string | null;
533
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
534
+ originalIndex?: number;
535
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
536
+ success?: boolean;
537
+ /** Details about the error in case of failure. */
538
+ error?: ApplicationError;
539
+ }
540
+ interface ApplicationError {
541
+ /** Error code. */
542
+ code?: string;
543
+ /** Description of the error. */
544
+ description?: string;
545
+ /** Data related to the error. */
546
+ data?: Record<string, any> | null;
547
+ }
548
+ interface BulkMemberResult {
549
+ itemMetadata?: ItemMetadata;
550
+ }
551
+ interface BulkActionMetadata {
552
+ /** Number of items that were successfully processed. */
553
+ totalSuccesses?: number;
554
+ /** Number of items that couldn't be processed. */
555
+ totalFailures?: number;
556
+ /** Number of failures without details because detailed failure threshold was exceeded. */
557
+ undetailedFailures?: number;
558
+ }
559
+ interface BulkDeleteMembersByFilterRequest {
560
+ /** 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. */
561
+ filter: any;
562
+ /**
563
+ * ID of a member receiving the deleted member's content.
564
+ * @format GUID
565
+ */
566
+ contentAssigneeId?: string | null;
567
+ /** Plain text search. */
568
+ search?: Search;
569
+ }
570
+ interface BulkDeleteMembersByFilterResponse {
571
+ /**
572
+ * Job ID.
573
+ * 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.
574
+ */
575
+ jobId?: string;
576
+ }
577
+ interface BulkApproveMembersRequest {
578
+ /** 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. */
579
+ filter: any;
580
+ }
581
+ interface BulkApproveMembersResponse {
582
+ /**
583
+ * Job ID.
584
+ * 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.
585
+ */
586
+ jobId?: string;
587
+ }
588
+ interface BulkBlockMembersRequest {
589
+ /** 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. */
590
+ filter: any;
591
+ }
592
+ interface BulkBlockMembersResponse {
593
+ /**
594
+ * Job ID.
595
+ * 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.
596
+ */
597
+ jobId?: string;
598
+ }
599
+ interface CreateMemberRequest {
600
+ /** Member to create. */
601
+ member?: Member;
602
+ }
603
+ interface CreateMemberResponse {
604
+ /** New member. */
605
+ member?: Member;
606
+ }
607
+ interface UpdateMemberRequest {
608
+ /** Member info to update. */
609
+ member?: Member;
610
+ }
611
+ interface UpdateMemberResponse {
612
+ /** Updated member. */
613
+ member?: Member;
614
+ }
615
+ interface DeleteMemberPhonesRequest {
616
+ /**
617
+ * ID of the member whose phone numbers will be deleted.
618
+ * @format GUID
619
+ */
620
+ id: string;
621
+ }
622
+ interface DeleteMemberPhonesResponse {
623
+ /** Updated member. */
624
+ member?: Member;
625
+ }
626
+ interface DeleteMemberEmailsRequest {
627
+ /**
628
+ * ID of the member whose email addresses will be deleted.
629
+ * @format GUID
630
+ */
631
+ id: string;
632
+ }
633
+ interface DeleteMemberEmailsResponse {
634
+ /** Updated member. */
635
+ member?: Member;
636
+ }
637
+ interface DeleteMemberAddressesRequest {
638
+ /**
639
+ * ID of the member whose street addresses will be deleted.
640
+ * @format GUID
641
+ */
642
+ id: string;
643
+ }
644
+ interface DeleteMemberAddressesResponse {
645
+ /** Updated member. */
646
+ member?: Member;
647
+ }
648
+
649
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
650
+ getUrl: (context: any) => string;
651
+ httpMethod: K;
652
+ path: string;
653
+ pathParams: M;
654
+ __requestType: T;
655
+ __originalRequestType: S;
656
+ __responseType: Q;
657
+ __originalResponseType: R;
658
+ };
659
+ declare function updateCurrentMemberSlug(): __PublicMethodMetaInfo<'POST', {}, UpdateMySlugRequest$1, UpdateMySlugRequest, UpdateMySlugResponse$1, UpdateMySlugResponse>;
660
+ declare function updateMemberSlug(): __PublicMethodMetaInfo<'POST', {
661
+ id: string;
662
+ }, UpdateMemberSlugRequest$1, UpdateMemberSlugRequest, UpdateMemberSlugResponse$1, UpdateMemberSlugResponse>;
663
+ declare function joinCommunity(): __PublicMethodMetaInfo<'POST', {}, JoinCommunityRequest$1, JoinCommunityRequest, JoinCommunityResponse$1, JoinCommunityResponse>;
664
+ declare function leaveCommunity(): __PublicMethodMetaInfo<'POST', {}, LeaveCommunityRequest$1, LeaveCommunityRequest, LeaveCommunityResponse$1, LeaveCommunityResponse>;
665
+ declare function getCurrentMember(): __PublicMethodMetaInfo<'GET', {}, GetMyMemberRequest$1, GetMyMemberRequest, GetMyMemberResponse$1, GetMyMemberResponse>;
666
+ declare function getMember(): __PublicMethodMetaInfo<'GET', {
667
+ id: string;
668
+ }, GetMemberRequest$1, GetMemberRequest, GetMemberResponse$1, GetMemberResponse>;
669
+ declare function listMembers(): __PublicMethodMetaInfo<'GET', {}, ListMembersRequest$1, ListMembersRequest, ListMembersResponse$1, ListMembersResponse>;
670
+ declare function queryMembers(): __PublicMethodMetaInfo<'POST', {}, QueryMembersRequest$1, QueryMembersRequest, QueryMembersResponse$1, QueryMembersResponse>;
671
+ declare function muteMember(): __PublicMethodMetaInfo<'POST', {
672
+ id: string;
673
+ }, MuteMemberRequest$1, MuteMemberRequest, MuteMemberResponse$1, MuteMemberResponse>;
674
+ declare function unmuteMember(): __PublicMethodMetaInfo<'POST', {
675
+ id: string;
676
+ }, UnmuteMemberRequest$1, UnmuteMemberRequest, UnmuteMemberResponse$1, UnmuteMemberResponse>;
677
+ declare function approveMember(): __PublicMethodMetaInfo<'POST', {
678
+ id: string;
679
+ }, ApproveMemberRequest$1, ApproveMemberRequest, ApproveMemberResponse$1, ApproveMemberResponse>;
680
+ declare function blockMember(): __PublicMethodMetaInfo<'POST', {
681
+ id: string;
682
+ }, BlockMemberRequest$1, BlockMemberRequest, BlockMemberResponse$1, BlockMemberResponse>;
683
+ declare function disconnectMember(): __PublicMethodMetaInfo<'POST', {
684
+ id: string;
685
+ }, DisconnectMemberRequest$1, DisconnectMemberRequest, DisconnectMemberResponse$1, DisconnectMemberResponse>;
686
+ declare function deleteMember(): __PublicMethodMetaInfo<'DELETE', {
687
+ id: string;
688
+ }, DeleteMemberRequest$1, DeleteMemberRequest, DeleteMemberResponse$1, DeleteMemberResponse>;
689
+ declare function deleteMyMember(): __PublicMethodMetaInfo<'DELETE', {}, DeleteMyMemberRequest$1, DeleteMyMemberRequest, DeleteMyMemberResponse$1, DeleteMyMemberResponse>;
690
+ declare function bulkDeleteMembers(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteMembersRequest$1, BulkDeleteMembersRequest, BulkDeleteMembersResponse$1, BulkDeleteMembersResponse>;
691
+ declare function bulkDeleteMembersByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteMembersByFilterRequest$1, BulkDeleteMembersByFilterRequest, BulkDeleteMembersByFilterResponse$1, BulkDeleteMembersByFilterResponse>;
692
+ declare function bulkApproveMembers(): __PublicMethodMetaInfo<'POST', {}, BulkApproveMembersRequest$1, BulkApproveMembersRequest, BulkApproveMembersResponse$1, BulkApproveMembersResponse>;
693
+ declare function bulkBlockMembers(): __PublicMethodMetaInfo<'POST', {}, BulkBlockMembersRequest$1, BulkBlockMembersRequest, BulkBlockMembersResponse$1, BulkBlockMembersResponse>;
694
+ declare function createMember(): __PublicMethodMetaInfo<'POST', {}, CreateMemberRequest$1, CreateMemberRequest, CreateMemberResponse$1, CreateMemberResponse>;
695
+ declare function updateMember(): __PublicMethodMetaInfo<'PATCH', {
696
+ memberId: string;
697
+ }, UpdateMemberRequest$1, UpdateMemberRequest, UpdateMemberResponse$1, UpdateMemberResponse>;
698
+ declare function deleteMemberPhones(): __PublicMethodMetaInfo<'DELETE', {
699
+ id: string;
700
+ }, DeleteMemberPhonesRequest$1, DeleteMemberPhonesRequest, DeleteMemberPhonesResponse$1, DeleteMemberPhonesResponse>;
701
+ declare function deleteMemberEmails(): __PublicMethodMetaInfo<'DELETE', {
702
+ id: string;
703
+ }, DeleteMemberEmailsRequest$1, DeleteMemberEmailsRequest, DeleteMemberEmailsResponse$1, DeleteMemberEmailsResponse>;
704
+ declare function deleteMemberAddresses(): __PublicMethodMetaInfo<'DELETE', {
705
+ id: string;
706
+ }, DeleteMemberAddressesRequest$1, DeleteMemberAddressesRequest, DeleteMemberAddressesResponse$1, DeleteMemberAddressesResponse>;
707
+
708
+ export { type __PublicMethodMetaInfo, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, queryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };