@wix/auto_sdk_members_members 1.0.59 → 1.0.61
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-DiAMq6Kr.d.ts} +414 -182
- package/build/cjs/meta.d.ts +704 -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} +73 -34
- 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-DiAMq6Kr.d.mts} +414 -182
- package/build/es/meta.d.mts +704 -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-DiAMq6Kr.d.ts} +414 -182
- package/build/internal/cjs/meta.d.ts +704 -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} +73 -34
- 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-DiAMq6Kr.d.mts} +414 -182
- package/build/internal/es/meta.d.mts +704 -0
- package/build/internal/es/meta.mjs +1189 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- 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 -2539
- package/build/cjs/src/members-v1-member-members.universal.js +0 -1411
- 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 -2539
- package/build/es/src/members-v1-member-members.universal.js +0 -1361
- 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 -2539
- package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1411
- 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 -2539
- package/build/internal/es/src/members-v1-member-members.universal.js +0 -1361
- package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
package/build/cjs/index.d.ts
CHANGED
|
@@ -1 +1,380 @@
|
|
|
1
|
-
|
|
1
|
+
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
+
import { U as UpdateMySlugResponse, a as UpdateMemberSlugResponse, J as JoinCommunityResponse, L as LeaveCommunityResponse, G as GetCurrentMemberOptions, b as GetMyMemberResponse, c as GetMemberOptions, M as Member, d as ListMembersOptions, e as ListMembersResponse, Q as QueryMembersOptions, f as MembersQueryBuilder, g as MuteMemberResponse, h as UnmuteMemberResponse, A as ApproveMemberResponse, B as BlockMemberResponse, D as DisconnectMemberResponse, i as DeleteMyMemberOptions, j as BulkDeleteMembersResponse, k as BulkDeleteMembersByFilterOptions, l as BulkDeleteMembersByFilterResponse, m as BulkApproveMembersResponse, n as BulkBlockMembersResponse, C as CreateMemberOptions, o as UpdateMember, p as DeleteMemberPhonesResponse, q as DeleteMemberEmailsResponse, r as DeleteMemberAddressesResponse, s as MemberCreatedEnvelope, t as MemberDeletedEnvelope, u as MemberUpdatedEnvelope } from './members-v1-member-members.universal-DiAMq6Kr.js';
|
|
3
|
+
export { b3 as ActionEvent, ay as ActiveSubscriptionMemberBlockForbiddenPayload, aF as ActiveSubscriptionMemberDeleteForbiddenPayload, v as ActivityStatusStatus, H as Address, I as AddressStreetOneOf, Z as App, aK as ApplicationError, as as ApproveMemberRequest, b6 as Asset, by as BaseEventMetadata, au as BlockMemberRequest, aM as BulkActionMetadata, aO as BulkApproveMembersRequest, aP as BulkBlockMembersRequest, aN as BulkDeleteMembersByFilterRequest, aI as BulkDeleteMembersRequest, aL as BulkMemberResult, F as Contact, aD as ContentDeletionRequested, aC as ContentReassignmentRequested, aQ as CreateMemberRequest, aR as CreateMemberResponse, ag as CursorPaging, ai as CursorPagingMetadata, aj as Cursors, O as CustomField, a1 as CustomTag, ba as DeleteContext, aX as DeleteMemberAddressesRequest, aW as DeleteMemberEmailsRequest, aV as DeleteMemberPhonesRequest, aA as DeleteMemberRequest, aB as DeleteMemberResponse, aG as DeleteMyMemberRequest, aH as DeleteMyMemberResponse, E as DeleteStatus, az as DisconnectMemberRequest, aZ as DomainEvent, a_ as DomainEventBodyOneOf, aY as Empty, a$ as EntityCreatedEvent, b2 as EntityDeletedEvent, b1 as EntityUpdatedEvent, bz as EventMetadata, V as ExtendedFields, a0 as File, aa as GetMemberRequest, ab as GetMemberResponse, a9 as GetMyMemberRequest, bw as IdentificationData, bx as IdentificationDataIdOneOf, T as Image, aU as InvalidCustomFieldUrlPayload, X as InvalidateCache, Y as InvalidateCacheGetByOneOf, aJ as ItemMetadata, a5 as JoinCommunityRequest, a7 as LeaveCommunityRequest, ad as ListMembersRequest, at as MemberApproved, av as MemberBlocked, bu as MemberIdChanged, a6 as MemberJoinedCommunity, a8 as MemberLeftCommunity, ap as MemberMuted, bt as MemberOwnershipTransferred, aw as MemberSelfBlockForbiddenPayload, ac as MemberToMemberBlockedPayload, ar as MemberUnmuted, bA as MembersQueryResult, bv as MessageEnvelope, b4 as MetaSiteSpecialEvent, b5 as MetaSiteSpecialEventPayloadOneOf, ao as MuteMemberRequest, N as Namespace, bk as NamespaceChanged, bp as OdeditorAssigned, bq as OdeditorUnassigned, ax as OwnerMemberBlockForbiddenPayload, aE as OwnerOrContributorDeleteForbiddenPayload, _ as Page, ae as Paging, ah as PagingMetadata, br as PicassoAssigned, bs as PicassoUnassigned, P as PrivacyStatusStatus, R as Profile, al as Query, ak as QueryMembersRequest, an as QueryMembersResponse, b0 as RestoreInfo, am as Search, bg as ServiceProvisioned, bh as ServiceRemoved, w as Set, b7 as SiteCreated, z as SiteCreatedContext, b9 as SiteDeleted, bj as SiteHardDeleted, be as SiteMarkedAsTemplate, bf as SiteMarkedAsWixSite, bc as SitePublished, bo as SitePurgedExternally, bi as SiteRenamed, b8 as SiteTransferred, bb as SiteUndeleted, bd as SiteUnpublished, bn as SiteUrlChanged, a3 as SlugAlreadyExistsPayload, x as SortOrder, af as Sorting, y as State, S as Status, K as StreetAddress, bl as StudioAssigned, bm as StudioUnassigned, $ as URI, aq as UnmuteMemberRequest, aS as UpdateMemberRequest, aT as UpdateMemberResponse, a4 as UpdateMemberSlugRequest, a2 as UpdateMySlugRequest, W as WebhookIdentityType } from './members-v1-member-members.universal-DiAMq6Kr.js';
|
|
4
|
+
|
|
5
|
+
declare function updateCurrentMemberSlug$1(httpClient: HttpClient): UpdateCurrentMemberSlugSignature;
|
|
6
|
+
interface UpdateCurrentMemberSlugSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Updates the currently logged in member's slug.
|
|
9
|
+
*
|
|
10
|
+
* 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`.
|
|
11
|
+
*
|
|
12
|
+
* > **Note:**
|
|
13
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
14
|
+
* > 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.
|
|
15
|
+
* @param - New slug.
|
|
16
|
+
*/
|
|
17
|
+
(slug: string): Promise<UpdateMySlugResponse>;
|
|
18
|
+
}
|
|
19
|
+
declare function updateMemberSlug$1(httpClient: HttpClient): UpdateMemberSlugSignature;
|
|
20
|
+
interface UpdateMemberSlugSignature {
|
|
21
|
+
/**
|
|
22
|
+
* Updates a member's slug.
|
|
23
|
+
* @param - Member ID.
|
|
24
|
+
* @param - New slug.
|
|
25
|
+
*/
|
|
26
|
+
(_id: string, slug: string): Promise<UpdateMemberSlugResponse>;
|
|
27
|
+
}
|
|
28
|
+
declare function joinCommunity$1(httpClient: HttpClient): JoinCommunitySignature;
|
|
29
|
+
interface JoinCommunitySignature {
|
|
30
|
+
/**
|
|
31
|
+
* Joins the current member to the site community and sets their profile to public.
|
|
32
|
+
*
|
|
33
|
+
* When a member's profile is public, they have access to the site's
|
|
34
|
+
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
35
|
+
* features, such as chat, forum, and followers,
|
|
36
|
+
* and their profile is visible to other members and site visitors.
|
|
37
|
+
*
|
|
38
|
+
* > **Note:**
|
|
39
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
40
|
+
* > 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.
|
|
41
|
+
* @returns Member profile.
|
|
42
|
+
*/
|
|
43
|
+
(): Promise<JoinCommunityResponse>;
|
|
44
|
+
}
|
|
45
|
+
declare function leaveCommunity$1(httpClient: HttpClient): LeaveCommunitySignature;
|
|
46
|
+
interface LeaveCommunitySignature {
|
|
47
|
+
/**
|
|
48
|
+
* Removes the current member from the site community and sets their profile to private.
|
|
49
|
+
*
|
|
50
|
+
* When a member's profile is private,
|
|
51
|
+
* they do not have access to the site's
|
|
52
|
+
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
53
|
+
* features, such as chat, forum, and followers,
|
|
54
|
+
* and their profile is hidden from other members and site visitors.
|
|
55
|
+
*
|
|
56
|
+
* > **Notes:**
|
|
57
|
+
* > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
|
|
58
|
+
*
|
|
59
|
+
* > + Only logged-in members can call this method without elevated permissions.
|
|
60
|
+
* > + 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.
|
|
61
|
+
* @returns Member profile.
|
|
62
|
+
*/
|
|
63
|
+
(): Promise<LeaveCommunityResponse>;
|
|
64
|
+
}
|
|
65
|
+
declare function getCurrentMember$1(httpClient: HttpClient): GetCurrentMemberSignature;
|
|
66
|
+
interface GetCurrentMemberSignature {
|
|
67
|
+
/**
|
|
68
|
+
* Retrieves the current member.
|
|
69
|
+
*
|
|
70
|
+
* >**Note:**
|
|
71
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
72
|
+
* @returns Member profile.
|
|
73
|
+
*/
|
|
74
|
+
(options?: GetCurrentMemberOptions | undefined): Promise<GetMyMemberResponse>;
|
|
75
|
+
}
|
|
76
|
+
declare function getMember$1(httpClient: HttpClient): GetMemberSignature;
|
|
77
|
+
interface GetMemberSignature {
|
|
78
|
+
/**
|
|
79
|
+
* Retrieves a member by ID.
|
|
80
|
+
*
|
|
81
|
+
* >**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).
|
|
82
|
+
*
|
|
83
|
+
* @param - Member ID.
|
|
84
|
+
* @param - Fieldset options.
|
|
85
|
+
* @returns The requested member.
|
|
86
|
+
*/
|
|
87
|
+
(_id: string, options?: GetMemberOptions | undefined): Promise<Member>;
|
|
88
|
+
}
|
|
89
|
+
declare function listMembers$1(httpClient: HttpClient): ListMembersSignature;
|
|
90
|
+
interface ListMembersSignature {
|
|
91
|
+
/**
|
|
92
|
+
* Lists site members, given the provided paging and fieldsets.
|
|
93
|
+
* @param - Options for paging, sorting, and specifying fields to return.
|
|
94
|
+
*/
|
|
95
|
+
(options?: ListMembersOptions | undefined): Promise<ListMembersResponse>;
|
|
96
|
+
}
|
|
97
|
+
declare function queryMembers$1(httpClient: HttpClient): QueryMembersSignature;
|
|
98
|
+
interface QueryMembersSignature {
|
|
99
|
+
/**
|
|
100
|
+
* Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
|
|
101
|
+
*
|
|
102
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` method.
|
|
103
|
+
*
|
|
104
|
+
* 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.
|
|
105
|
+
*
|
|
106
|
+
* `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
|
|
107
|
+
* - `skip`: `0`
|
|
108
|
+
* - `limit`: `100`
|
|
109
|
+
*
|
|
110
|
+
* Currently supported fields for sorting:
|
|
111
|
+
* - `profile.nickname`
|
|
112
|
+
* - `contact.firstName`
|
|
113
|
+
* - `contact.lastName`
|
|
114
|
+
* - `createdDate`
|
|
115
|
+
* - `lastLoginDate`
|
|
116
|
+
*
|
|
117
|
+
* 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`.
|
|
118
|
+
* @param - Query options.
|
|
119
|
+
*/
|
|
120
|
+
(options?: QueryMembersOptions | undefined): MembersQueryBuilder;
|
|
121
|
+
}
|
|
122
|
+
declare function muteMember$1(httpClient: HttpClient): MuteMemberSignature;
|
|
123
|
+
interface MuteMemberSignature {
|
|
124
|
+
/**
|
|
125
|
+
* Mutes a member.
|
|
126
|
+
*
|
|
127
|
+
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
128
|
+
*
|
|
129
|
+
* 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).
|
|
130
|
+
* @param - ID of the member to mute.
|
|
131
|
+
*/
|
|
132
|
+
(_id: string): Promise<MuteMemberResponse>;
|
|
133
|
+
}
|
|
134
|
+
declare function unmuteMember$1(httpClient: HttpClient): UnmuteMemberSignature;
|
|
135
|
+
interface UnmuteMemberSignature {
|
|
136
|
+
/**
|
|
137
|
+
* Unmutes a member.
|
|
138
|
+
*
|
|
139
|
+
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
140
|
+
*
|
|
141
|
+
* 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).
|
|
142
|
+
* @param - ID of the member to unmute.
|
|
143
|
+
*/
|
|
144
|
+
(_id: string): Promise<UnmuteMemberResponse>;
|
|
145
|
+
}
|
|
146
|
+
declare function approveMember$1(httpClient: HttpClient): ApproveMemberSignature;
|
|
147
|
+
interface ApproveMemberSignature {
|
|
148
|
+
/**
|
|
149
|
+
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
150
|
+
*
|
|
151
|
+
* Call this API to:
|
|
152
|
+
* - Approve a pending member.
|
|
153
|
+
* - Unblock a blocked member.
|
|
154
|
+
* @param - ID of the member to approve.
|
|
155
|
+
*/
|
|
156
|
+
(_id: string): Promise<ApproveMemberResponse>;
|
|
157
|
+
}
|
|
158
|
+
declare function blockMember$1(httpClient: HttpClient): BlockMemberSignature;
|
|
159
|
+
interface BlockMemberSignature {
|
|
160
|
+
/**
|
|
161
|
+
* Blocks a member.
|
|
162
|
+
*
|
|
163
|
+
* A blocked member can't log in to members-only pages.
|
|
164
|
+
*
|
|
165
|
+
* To unblock a member, call Approve Member.
|
|
166
|
+
* @param - ID of a member to block.
|
|
167
|
+
*/
|
|
168
|
+
(_id: string): Promise<BlockMemberResponse>;
|
|
169
|
+
}
|
|
170
|
+
declare function disconnectMember$1(httpClient: HttpClient): DisconnectMemberSignature;
|
|
171
|
+
interface DisconnectMemberSignature {
|
|
172
|
+
/**
|
|
173
|
+
* Disconnects a member.
|
|
174
|
+
*
|
|
175
|
+
* A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
|
|
176
|
+
*
|
|
177
|
+
* >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
|
|
178
|
+
* @param - ID of a member to disconnect.
|
|
179
|
+
*/
|
|
180
|
+
(_id: string): Promise<DisconnectMemberResponse>;
|
|
181
|
+
}
|
|
182
|
+
declare function deleteMember$1(httpClient: HttpClient): DeleteMemberSignature;
|
|
183
|
+
interface DeleteMemberSignature {
|
|
184
|
+
/**
|
|
185
|
+
* Deletes a member by ID.
|
|
186
|
+
*
|
|
187
|
+
* 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.
|
|
188
|
+
* @param - ID of a member to delete.
|
|
189
|
+
*/
|
|
190
|
+
(_id: string): Promise<void>;
|
|
191
|
+
}
|
|
192
|
+
declare function deleteMyMember$1(httpClient: HttpClient): DeleteMyMemberSignature;
|
|
193
|
+
interface DeleteMyMemberSignature {
|
|
194
|
+
/**
|
|
195
|
+
* Deletes the current member.
|
|
196
|
+
*
|
|
197
|
+
* After calling this method, the member is logged out of the site.
|
|
198
|
+
*
|
|
199
|
+
* 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.
|
|
200
|
+
*
|
|
201
|
+
* >**Note:**
|
|
202
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
203
|
+
*/
|
|
204
|
+
(options?: DeleteMyMemberOptions | undefined): Promise<void>;
|
|
205
|
+
}
|
|
206
|
+
declare function bulkDeleteMembers$1(httpClient: HttpClient): BulkDeleteMembersSignature;
|
|
207
|
+
interface BulkDeleteMembersSignature {
|
|
208
|
+
/**
|
|
209
|
+
* Deletes multiple members by `memberId`.
|
|
210
|
+
*
|
|
211
|
+
* 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.
|
|
212
|
+
* @param - IDs of members to be deleted.
|
|
213
|
+
*/
|
|
214
|
+
(memberIds: string[]): Promise<BulkDeleteMembersResponse>;
|
|
215
|
+
}
|
|
216
|
+
declare function bulkDeleteMembersByFilter$1(httpClient: HttpClient): BulkDeleteMembersByFilterSignature;
|
|
217
|
+
interface BulkDeleteMembersByFilterSignature {
|
|
218
|
+
/**
|
|
219
|
+
* Deletes multiple members by the specified filter.
|
|
220
|
+
*
|
|
221
|
+
* 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.
|
|
222
|
+
* @param - 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.
|
|
223
|
+
*/
|
|
224
|
+
(filter: any, options?: BulkDeleteMembersByFilterOptions | undefined): Promise<BulkDeleteMembersByFilterResponse>;
|
|
225
|
+
}
|
|
226
|
+
declare function bulkApproveMembers$1(httpClient: HttpClient): BulkApproveMembersSignature;
|
|
227
|
+
interface BulkApproveMembersSignature {
|
|
228
|
+
/**
|
|
229
|
+
* Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
|
|
230
|
+
*
|
|
231
|
+
* Call this API to:
|
|
232
|
+
* - Approve pending members.
|
|
233
|
+
* - Unblock blocked members.
|
|
234
|
+
* @param - 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.
|
|
235
|
+
*/
|
|
236
|
+
(filter: any): Promise<BulkApproveMembersResponse>;
|
|
237
|
+
}
|
|
238
|
+
declare function bulkBlockMembers$1(httpClient: HttpClient): BulkBlockMembersSignature;
|
|
239
|
+
interface BulkBlockMembersSignature {
|
|
240
|
+
/**
|
|
241
|
+
* Blocks multiple members by a specified filter.
|
|
242
|
+
*
|
|
243
|
+
* Blocked members can't log in to members-only pages.
|
|
244
|
+
*
|
|
245
|
+
* To unblock multiple members, call Bulk Approve Members.
|
|
246
|
+
* @param - 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.
|
|
247
|
+
*/
|
|
248
|
+
(filter: any): Promise<BulkBlockMembersResponse>;
|
|
249
|
+
}
|
|
250
|
+
declare function createMember$1(httpClient: HttpClient): CreateMemberSignature;
|
|
251
|
+
interface CreateMemberSignature {
|
|
252
|
+
/**
|
|
253
|
+
* Creates a site member.
|
|
254
|
+
*
|
|
255
|
+
* After creation, you can call
|
|
256
|
+
* [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))
|
|
257
|
+
* to email the member with a link to set their password.
|
|
258
|
+
* The member can log in to the site
|
|
259
|
+
* when they set their password for the first time.
|
|
260
|
+
*
|
|
261
|
+
* > **Note:**
|
|
262
|
+
* > When creating multiple members,
|
|
263
|
+
* > set your requests at least 1 second apart to keep below rate limits.
|
|
264
|
+
* @returns New member.
|
|
265
|
+
*/
|
|
266
|
+
(options?: CreateMemberOptions | undefined): Promise<Member>;
|
|
267
|
+
}
|
|
268
|
+
declare function updateMember$1(httpClient: HttpClient): UpdateMemberSignature;
|
|
269
|
+
interface UpdateMemberSignature {
|
|
270
|
+
/**
|
|
271
|
+
* Updates a member's properties.
|
|
272
|
+
*
|
|
273
|
+
* Only the requested fields are updated.
|
|
274
|
+
* To clear a field's value, set an empty value with an empty string `""`.
|
|
275
|
+
*
|
|
276
|
+
* > **Note:**
|
|
277
|
+
* > 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.
|
|
278
|
+
* > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
|
|
279
|
+
* >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
|
|
280
|
+
* >- To clear `contact.emails`, use `deleteMemberEmails()`.
|
|
281
|
+
* >- To clear `contact.phones`, use `deleteMemberPhones()`.
|
|
282
|
+
*
|
|
283
|
+
* > **Note:**
|
|
284
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
285
|
+
* > 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.
|
|
286
|
+
* @param - Member ID.
|
|
287
|
+
* @param - Member to update.
|
|
288
|
+
* @returns Updated member.
|
|
289
|
+
*/
|
|
290
|
+
(_id: string, member: UpdateMember): Promise<Member>;
|
|
291
|
+
}
|
|
292
|
+
declare function deleteMemberPhones$1(httpClient: HttpClient): DeleteMemberPhonesSignature;
|
|
293
|
+
interface DeleteMemberPhonesSignature {
|
|
294
|
+
/**
|
|
295
|
+
* Clears a member's phone numbers.
|
|
296
|
+
*
|
|
297
|
+
* `deleteMemberPhones()` clears the `phones` array under the `contact` property.
|
|
298
|
+
*
|
|
299
|
+
* > **Note:**
|
|
300
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
301
|
+
* > 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.
|
|
302
|
+
* @param - ID of the member whose phone numbers will be deleted.
|
|
303
|
+
*/
|
|
304
|
+
(_id: string): Promise<DeleteMemberPhonesResponse>;
|
|
305
|
+
}
|
|
306
|
+
declare function deleteMemberEmails$1(httpClient: HttpClient): DeleteMemberEmailsSignature;
|
|
307
|
+
interface DeleteMemberEmailsSignature {
|
|
308
|
+
/**
|
|
309
|
+
* Clears a member's email addresses.
|
|
310
|
+
*
|
|
311
|
+
* `deleteMemberEmails()` clears the `emails` array under the `contact` property.
|
|
312
|
+
*
|
|
313
|
+
* > **Notes:**
|
|
314
|
+
* > A member can still log in with their `loginEmail`,
|
|
315
|
+
* > which is not cleared when this method is called.
|
|
316
|
+
*
|
|
317
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
318
|
+
* > 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.
|
|
319
|
+
* @param - ID of the member whose email addresses will be deleted.
|
|
320
|
+
*/
|
|
321
|
+
(_id: string): Promise<DeleteMemberEmailsResponse>;
|
|
322
|
+
}
|
|
323
|
+
declare function deleteMemberAddresses$1(httpClient: HttpClient): DeleteMemberAddressesSignature;
|
|
324
|
+
interface DeleteMemberAddressesSignature {
|
|
325
|
+
/**
|
|
326
|
+
* Deletes a member's street addresses.
|
|
327
|
+
*
|
|
328
|
+
* `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
|
|
329
|
+
*
|
|
330
|
+
* > **Note:**
|
|
331
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
332
|
+
* > 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.
|
|
333
|
+
* @param - ID of the member whose street addresses will be deleted.
|
|
334
|
+
*/
|
|
335
|
+
(_id: string): Promise<DeleteMemberAddressesResponse>;
|
|
336
|
+
}
|
|
337
|
+
declare const onMemberCreated$1: EventDefinition<MemberCreatedEnvelope, "wix.members.v1.member_created">;
|
|
338
|
+
declare const onMemberDeleted$1: EventDefinition<MemberDeletedEnvelope, "wix.members.v1.member_deleted">;
|
|
339
|
+
declare const onMemberUpdated$1: EventDefinition<MemberUpdatedEnvelope, "wix.members.v1.member_updated">;
|
|
340
|
+
|
|
341
|
+
declare const updateCurrentMemberSlug: MaybeContext<BuildRESTFunction<typeof updateCurrentMemberSlug$1> & typeof updateCurrentMemberSlug$1>;
|
|
342
|
+
declare const updateMemberSlug: MaybeContext<BuildRESTFunction<typeof updateMemberSlug$1> & typeof updateMemberSlug$1>;
|
|
343
|
+
declare const joinCommunity: MaybeContext<BuildRESTFunction<typeof joinCommunity$1> & typeof joinCommunity$1>;
|
|
344
|
+
declare const leaveCommunity: MaybeContext<BuildRESTFunction<typeof leaveCommunity$1> & typeof leaveCommunity$1>;
|
|
345
|
+
declare const getCurrentMember: MaybeContext<BuildRESTFunction<typeof getCurrentMember$1> & typeof getCurrentMember$1>;
|
|
346
|
+
declare const getMember: MaybeContext<BuildRESTFunction<typeof getMember$1> & typeof getMember$1>;
|
|
347
|
+
declare const listMembers: MaybeContext<BuildRESTFunction<typeof listMembers$1> & typeof listMembers$1>;
|
|
348
|
+
declare const queryMembers: MaybeContext<BuildRESTFunction<typeof queryMembers$1> & typeof queryMembers$1>;
|
|
349
|
+
declare const muteMember: MaybeContext<BuildRESTFunction<typeof muteMember$1> & typeof muteMember$1>;
|
|
350
|
+
declare const unmuteMember: MaybeContext<BuildRESTFunction<typeof unmuteMember$1> & typeof unmuteMember$1>;
|
|
351
|
+
declare const approveMember: MaybeContext<BuildRESTFunction<typeof approveMember$1> & typeof approveMember$1>;
|
|
352
|
+
declare const blockMember: MaybeContext<BuildRESTFunction<typeof blockMember$1> & typeof blockMember$1>;
|
|
353
|
+
declare const disconnectMember: MaybeContext<BuildRESTFunction<typeof disconnectMember$1> & typeof disconnectMember$1>;
|
|
354
|
+
declare const deleteMember: MaybeContext<BuildRESTFunction<typeof deleteMember$1> & typeof deleteMember$1>;
|
|
355
|
+
declare const deleteMyMember: MaybeContext<BuildRESTFunction<typeof deleteMyMember$1> & typeof deleteMyMember$1>;
|
|
356
|
+
declare const bulkDeleteMembers: MaybeContext<BuildRESTFunction<typeof bulkDeleteMembers$1> & typeof bulkDeleteMembers$1>;
|
|
357
|
+
declare const bulkDeleteMembersByFilter: MaybeContext<BuildRESTFunction<typeof bulkDeleteMembersByFilter$1> & typeof bulkDeleteMembersByFilter$1>;
|
|
358
|
+
declare const bulkApproveMembers: MaybeContext<BuildRESTFunction<typeof bulkApproveMembers$1> & typeof bulkApproveMembers$1>;
|
|
359
|
+
declare const bulkBlockMembers: MaybeContext<BuildRESTFunction<typeof bulkBlockMembers$1> & typeof bulkBlockMembers$1>;
|
|
360
|
+
declare const createMember: MaybeContext<BuildRESTFunction<typeof createMember$1> & typeof createMember$1>;
|
|
361
|
+
declare const updateMember: MaybeContext<BuildRESTFunction<typeof updateMember$1> & typeof updateMember$1>;
|
|
362
|
+
declare const deleteMemberPhones: MaybeContext<BuildRESTFunction<typeof deleteMemberPhones$1> & typeof deleteMemberPhones$1>;
|
|
363
|
+
declare const deleteMemberEmails: MaybeContext<BuildRESTFunction<typeof deleteMemberEmails$1> & typeof deleteMemberEmails$1>;
|
|
364
|
+
declare const deleteMemberAddresses: MaybeContext<BuildRESTFunction<typeof deleteMemberAddresses$1> & typeof deleteMemberAddresses$1>;
|
|
365
|
+
/**
|
|
366
|
+
* Triggered when a member is created.
|
|
367
|
+
*
|
|
368
|
+
* The site owner can configure the site to automatically approve members or require manual approval.
|
|
369
|
+
*
|
|
370
|
+
* 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.
|
|
371
|
+
*/
|
|
372
|
+
declare const onMemberCreated: BuildEventDefinition<typeof onMemberCreated$1>;
|
|
373
|
+
/**
|
|
374
|
+
* Triggered when a member is deleted.
|
|
375
|
+
*/
|
|
376
|
+
declare const onMemberDeleted: BuildEventDefinition<typeof onMemberDeleted$1>;
|
|
377
|
+
/** */
|
|
378
|
+
declare const onMemberUpdated: BuildEventDefinition<typeof onMemberUpdated$1>;
|
|
379
|
+
|
|
380
|
+
export { ApproveMemberResponse, BlockMemberResponse, BulkApproveMembersResponse, BulkBlockMembersResponse, BulkDeleteMembersByFilterOptions, BulkDeleteMembersByFilterResponse, BulkDeleteMembersResponse, CreateMemberOptions, DeleteMemberAddressesResponse, DeleteMemberEmailsResponse, DeleteMemberPhonesResponse, DeleteMyMemberOptions, DisconnectMemberResponse, GetCurrentMemberOptions, GetMemberOptions, GetMyMemberResponse, JoinCommunityResponse, LeaveCommunityResponse, ListMembersOptions, ListMembersResponse, Member, MemberCreatedEnvelope, MemberDeletedEnvelope, MemberUpdatedEnvelope, MembersQueryBuilder, MuteMemberResponse, QueryMembersOptions, UnmuteMemberResponse, UpdateMember, UpdateMemberSlugResponse, UpdateMySlugResponse, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, onMemberCreated, onMemberDeleted, onMemberUpdated, queryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };
|