@wix/auto_sdk_members_members 1.0.88 → 1.0.90
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 +58 -36
- package/build/cjs/index.js +55 -10
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +110 -21
- package/build/cjs/index.typings.js +36 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +11 -9
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +58 -36
- package/build/es/index.mjs +55 -10
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +110 -21
- package/build/es/index.typings.mjs +35 -8
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +11 -9
- package/build/es/meta.mjs +1 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +58 -36
- package/build/internal/cjs/index.js +55 -10
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +110 -21
- package/build/internal/cjs/index.typings.js +36 -8
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +11 -9
- package/build/internal/cjs/meta.js +1 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +58 -36
- package/build/internal/es/index.mjs +55 -10
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +110 -21
- package/build/internal/es/index.typings.mjs +35 -8
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +11 -9
- package/build/internal/es/meta.mjs +1 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +4 -4
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { UpdateMySlugResponse, UpdateCurrentMemberSlugApplicationErrors, UpdateMemberSlugResponse, UpdateMemberSlugApplicationErrors, JoinCommunityResponse, JoinCommunityApplicationErrors, LeaveCommunityResponse, GetCurrentMemberOptions, GetMyMemberResponse, GetMemberOptions, Member, GetMemberApplicationErrors, ListMembersOptions, ListMembersResponse,
|
|
3
|
-
export { ActionEvent, ActiveSubscriptionMemberBlockForbiddenPayload, ActiveSubscriptionMemberDeleteForbiddenPayload, ActivityStatusStatus, ActivityStatusStatusWithLiterals, Address, AddressStreetOneOf, App, ApplicationError, ApproveMemberRequest, Asset, BaseEventMetadata, BlockMemberRequest, BulkActionMetadata, BulkApproveMembersRequest, BulkBlockMembersRequest, BulkDeleteMembersByFilterRequest, BulkDeleteMembersRequest, BulkMemberResult, Contact, ContentDeletionRequested, ContentReassignmentRequested, CreateMemberRequest, CreateMemberResponse, CursorPaging, CursorPagingMetadata, Cursors, CustomField, CustomTag, DeleteContext, DeleteMemberAddressesRequest, DeleteMemberEmailsRequest, DeleteMemberPhonesRequest, DeleteMemberRequest, DeleteMemberResponse, DeleteMyMemberRequest, DeleteMyMemberResponse, DeleteStatus, DeleteStatusWithLiterals, DisconnectMemberRequest, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, GetMemberRequest, GetMemberResponse, GetMyMemberRequest, IdentificationData, IdentificationDataIdOneOf, Image, InvalidCustomFieldUrlPayload, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, JoinCommunityRequest, LeaveCommunityRequest, ListMembersRequest, MemberApproved, MemberBlocked, MemberIdChanged, MemberJoinedCommunity, MemberLeftCommunity, MemberMuted, MemberOwnershipTransferred, MemberSelfBlockForbiddenPayload, MemberToMemberBlockedPayload, MemberUnmuted, MembersQueryResult, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MuteMemberRequest, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, OwnerMemberBlockForbiddenPayload, OwnerOrContributorDeleteForbiddenPayload, Page, Paging, PagingMetadata, PicassoAssigned, PicassoUnassigned, PrivacyStatusStatus, PrivacyStatusStatusWithLiterals, Profile, QueryMembersRequest, QueryMembersResponse, RestoreInfo, Search, ServiceProvisioned, ServiceRemoved, Set, SetWithLiterals, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SlugAlreadyExistsPayload, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, Status, StatusWithLiterals, StreetAddress, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, URI, UnmuteMemberRequest, UpdateMemberRequest, UpdateMemberResponse, UpdateMemberSlugRequest, UpdateMySlugRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
|
|
2
|
+
import { UpdateMySlugResponse, UpdateCurrentMemberSlugApplicationErrors, UpdateMemberSlugResponse, UpdateMemberSlugApplicationErrors, JoinCommunityResponse, JoinCommunityApplicationErrors, LeaveCommunityResponse, GetCurrentMemberOptions, GetMyMemberResponse, GetMemberOptions, Member, GetMemberApplicationErrors, ListMembersOptions, ListMembersResponse, MuteMemberResponse, UnmuteMemberResponse, ApproveMemberResponse, BlockMemberResponse, BlockMemberApplicationErrors, DisconnectMemberResponse, DeleteMemberValidationErrors, DeleteMyMemberOptions, DeleteMyMemberValidationErrors, BulkDeleteMembersResponse, BulkDeleteMembersByFilterOptions, BulkDeleteMembersByFilterResponse, BulkApproveMembersResponse, BulkBlockMembersResponse, CreateMemberOptions, UpdateMember, UpdateMemberValidationErrors, DeleteMemberPhonesResponse, DeleteMemberEmailsResponse, DeleteMemberAddressesResponse, MemberCreatedEnvelope, MemberDeletedEnvelope, MemberUpdatedEnvelope, MemberQuery, QueryMembersOptions, typedQueryMembers, MembersQueryBuilder } from './index.typings.js';
|
|
3
|
+
export { ActionEvent, ActiveSubscriptionMemberBlockForbiddenPayload, ActiveSubscriptionMemberDeleteForbiddenPayload, ActivityStatusStatus, ActivityStatusStatusWithLiterals, Address, AddressStreetOneOf, App, ApplicationError, ApproveMemberRequest, Asset, BaseEventMetadata, BlockMemberRequest, BulkActionMetadata, BulkApproveMembersRequest, BulkBlockMembersRequest, BulkDeleteMembersByFilterRequest, BulkDeleteMembersRequest, BulkMemberResult, CommonQueryWithEntityContext, Contact, ContentDeletionRequested, ContentReassignmentRequested, CreateMemberRequest, CreateMemberResponse, CursorPaging, CursorPagingMetadata, Cursors, CustomField, CustomTag, DeleteContext, DeleteMemberAddressesRequest, DeleteMemberEmailsRequest, DeleteMemberPhonesRequest, DeleteMemberRequest, DeleteMemberResponse, DeleteMyMemberRequest, DeleteMyMemberResponse, DeleteStatus, DeleteStatusWithLiterals, DisconnectMemberRequest, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, File, GetMemberRequest, GetMemberResponse, GetMyMemberRequest, IdentificationData, IdentificationDataIdOneOf, Image, InvalidCustomFieldUrlPayload, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, JoinCommunityRequest, LeaveCommunityRequest, ListMembersRequest, MemberApproved, MemberBlocked, MemberIdChanged, MemberJoinedCommunity, MemberLeftCommunity, MemberMuted, MemberOwnershipTransferred, MemberQuerySpec, MemberSelfBlockForbiddenPayload, MemberToMemberBlockedPayload, MemberUnmuted, MembersQueryResult, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MuteMemberRequest, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, OwnerMemberBlockForbiddenPayload, OwnerOrContributorDeleteForbiddenPayload, Page, Paging, PagingMetadata, PicassoAssigned, PicassoUnassigned, PrivacyStatusStatus, PrivacyStatusStatusWithLiterals, Profile, Query, QueryMembersRequest, QueryMembersResponse, RestoreInfo, Search, ServiceProvisioned, ServiceRemoved, Set, SetWithLiterals, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SlugAlreadyExistsPayload, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, Status, StatusWithLiterals, StreetAddress, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, URI, UnmuteMemberRequest, UpdateMemberRequest, UpdateMemberResponse, UpdateMemberSlugRequest, UpdateMySlugRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function updateCurrentMemberSlug$1(httpClient: HttpClient): UpdateCurrentMemberSlugSignature;
|
|
6
6
|
interface UpdateCurrentMemberSlugSignature {
|
|
@@ -22,6 +22,8 @@ declare function updateMemberSlug$1(httpClient: HttpClient): UpdateMemberSlugSig
|
|
|
22
22
|
interface UpdateMemberSlugSignature {
|
|
23
23
|
/**
|
|
24
24
|
* Updates a member's slug.
|
|
25
|
+
*
|
|
26
|
+
* To update the current member's slug, call [Update My Slug](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/update-my-slug).
|
|
25
27
|
* @param - Member ID.
|
|
26
28
|
* @param - New slug.
|
|
27
29
|
*/
|
|
@@ -75,6 +77,8 @@ interface GetCurrentMemberSignature {
|
|
|
75
77
|
*
|
|
76
78
|
* >**Note:**
|
|
77
79
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
80
|
+
*
|
|
81
|
+
* To retrieve a member by `ID`, call [Get Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/get-member).
|
|
78
82
|
* @returns Member profile.
|
|
79
83
|
*/
|
|
80
84
|
(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
|
|
@@ -104,32 +108,6 @@ interface ListMembersSignature {
|
|
|
104
108
|
*/
|
|
105
109
|
(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, `members` | `members.${number}.status` | `members.${number}.profile.photo._id` | `members.${number}.profile.photo.url` | `members.${number}.profile.photo.height` | `members.${number}.profile.photo.width` | `members.${number}.privacyStatus` | `members.${number}.activityStatus`, 6>>;
|
|
106
110
|
}
|
|
107
|
-
declare function queryMembers$1(httpClient: HttpClient): QueryMembersSignature;
|
|
108
|
-
interface QueryMembersSignature {
|
|
109
|
-
/**
|
|
110
|
-
* Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
|
|
111
|
-
*
|
|
112
|
-
* The returned object contains the query definition which is typically used to run the query using the `find()` method.
|
|
113
|
-
*
|
|
114
|
-
* 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.
|
|
115
|
-
*
|
|
116
|
-
* `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
|
|
117
|
-
* - `skip`: `0`
|
|
118
|
-
* - `limit`: `100`
|
|
119
|
-
*
|
|
120
|
-
* Currently supported fields for sorting:
|
|
121
|
-
* - `profile.nickname`
|
|
122
|
-
* - `contact.firstName`
|
|
123
|
-
* - `contact.lastName`
|
|
124
|
-
* - `createdDate`
|
|
125
|
-
* - `lastLoginDate`
|
|
126
|
-
*
|
|
127
|
-
* 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`.
|
|
128
|
-
* @param - Query options.
|
|
129
|
-
* @param - Query options.
|
|
130
|
-
*/
|
|
131
|
-
(query: Query, options?: QueryMembersOptions): MembersQueryBuilder;
|
|
132
|
-
}
|
|
133
111
|
declare function muteMember$1(httpClient: HttpClient): MuteMemberSignature;
|
|
134
112
|
interface MuteMemberSignature {
|
|
135
113
|
/**
|
|
@@ -138,6 +116,8 @@ interface MuteMemberSignature {
|
|
|
138
116
|
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
139
117
|
*
|
|
140
118
|
* 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).
|
|
119
|
+
*
|
|
120
|
+
* To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member).
|
|
141
121
|
* @param - ID of the member to mute.
|
|
142
122
|
*/
|
|
143
123
|
(_id: string): Promise<NonNullablePaths<MuteMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
|
|
@@ -150,6 +130,8 @@ interface UnmuteMemberSignature {
|
|
|
150
130
|
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
151
131
|
*
|
|
152
132
|
* 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).
|
|
133
|
+
*
|
|
134
|
+
* To mute a member, call [Mute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/mute-member).
|
|
153
135
|
* @param - ID of the member to unmute.
|
|
154
136
|
*/
|
|
155
137
|
(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
|
|
@@ -162,6 +144,10 @@ interface ApproveMemberSignature {
|
|
|
162
144
|
* Call this API to:
|
|
163
145
|
* - Approve a pending member.
|
|
164
146
|
* - Unblock a blocked member.
|
|
147
|
+
*
|
|
148
|
+
* To approve multiple members, call [Bulk Approve Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-approve-members).
|
|
149
|
+
*
|
|
150
|
+
* To block a member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
|
|
165
151
|
* @param - ID of the member to approve.
|
|
166
152
|
*/
|
|
167
153
|
(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7>>;
|
|
@@ -173,7 +159,9 @@ interface BlockMemberSignature {
|
|
|
173
159
|
*
|
|
174
160
|
* A blocked member can't log in to members-only pages.
|
|
175
161
|
*
|
|
176
|
-
* To
|
|
162
|
+
* To block multiple members, call [Bulk Block Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-block-members).
|
|
163
|
+
*
|
|
164
|
+
* To unblock a member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
177
165
|
* @param - ID of a member to block.
|
|
178
166
|
*/
|
|
179
167
|
(_id: string): Promise<NonNullablePaths<BlockMemberResponse, `member.status` | `member.contact.phones` | `member.contact.emails` | `member.contact.addresses` | `member.contact.addresses.${number}.streetAddress.number` | `member.contact.addresses.${number}.streetAddress.name` | `member.profile.photo._id` | `member.profile.photo.url` | `member.profile.photo.height` | `member.profile.photo.width` | `member.privacyStatus` | `member.activityStatus`, 7> & {
|
|
@@ -198,6 +186,12 @@ interface DeleteMemberSignature {
|
|
|
198
186
|
* Deletes a member by ID.
|
|
199
187
|
*
|
|
200
188
|
* 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.
|
|
189
|
+
*
|
|
190
|
+
* To delete the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
|
|
191
|
+
*
|
|
192
|
+
* To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
|
|
193
|
+
*
|
|
194
|
+
* To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
|
|
201
195
|
* @param - ID of a member to delete.
|
|
202
196
|
*/
|
|
203
197
|
(_id: string): Promise<void & {
|
|
@@ -215,6 +209,12 @@ interface DeleteMyMemberSignature {
|
|
|
215
209
|
*
|
|
216
210
|
* >**Note:**
|
|
217
211
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
212
|
+
*
|
|
213
|
+
* To delete a member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
|
|
214
|
+
*
|
|
215
|
+
* To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
|
|
216
|
+
*
|
|
217
|
+
* To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
|
|
218
218
|
*/
|
|
219
219
|
(options?: DeleteMyMemberOptions): Promise<void & {
|
|
220
220
|
__validationErrorsType?: DeleteMyMemberValidationErrors;
|
|
@@ -226,6 +226,12 @@ interface BulkDeleteMembersSignature {
|
|
|
226
226
|
* Deletes multiple members by `memberId`.
|
|
227
227
|
*
|
|
228
228
|
* 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.
|
|
229
|
+
*
|
|
230
|
+
* To delete only the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
|
|
231
|
+
*
|
|
232
|
+
* To delete a single member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
|
|
233
|
+
*
|
|
234
|
+
* To delete multiple members by a specified filter, call [Bulk Delete Members By Filter](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members-by-filter).
|
|
229
235
|
* @param - IDs of members to be deleted.
|
|
230
236
|
*/
|
|
231
237
|
(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`, 6>>;
|
|
@@ -236,7 +242,13 @@ interface BulkDeleteMembersByFilterSignature {
|
|
|
236
242
|
* Deletes multiple members by the specified filter.
|
|
237
243
|
*
|
|
238
244
|
* 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.
|
|
239
|
-
*
|
|
245
|
+
*
|
|
246
|
+
* To delete only the current member, call [Delete My Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-my-member).
|
|
247
|
+
*
|
|
248
|
+
* To delete a single member by `ID`, call [Delete Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/delete-member).
|
|
249
|
+
*
|
|
250
|
+
* To delete multiple members by `memberId`, call [Bulk Delete Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-delete-members).
|
|
251
|
+
* @param - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
240
252
|
*/
|
|
241
253
|
(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`, 2>>;
|
|
242
254
|
}
|
|
@@ -248,7 +260,9 @@ interface BulkApproveMembersSignature {
|
|
|
248
260
|
* Call this API to:
|
|
249
261
|
* - Approve pending members.
|
|
250
262
|
* - Unblock blocked members.
|
|
251
|
-
*
|
|
263
|
+
*
|
|
264
|
+
* To approve a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
265
|
+
* @param - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
252
266
|
*/
|
|
253
267
|
(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`, 2>>;
|
|
254
268
|
}
|
|
@@ -259,8 +273,12 @@ interface BulkBlockMembersSignature {
|
|
|
259
273
|
*
|
|
260
274
|
* Blocked members can't log in to members-only pages.
|
|
261
275
|
*
|
|
262
|
-
* To
|
|
263
|
-
*
|
|
276
|
+
* To block a single member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
|
|
277
|
+
*
|
|
278
|
+
* To unblock a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
279
|
+
*
|
|
280
|
+
* To unblock multiple members, call [Bulk Approve Members](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/bulk-approve-members).
|
|
281
|
+
* @param - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
264
282
|
*/
|
|
265
283
|
(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`, 2>>;
|
|
266
284
|
}
|
|
@@ -270,7 +288,7 @@ interface CreateMemberSignature {
|
|
|
270
288
|
* Creates a site member.
|
|
271
289
|
*
|
|
272
290
|
* After creation, you can call
|
|
273
|
-
* [Send Set Password Email
|
|
291
|
+
* [Send Set Password Email](https://dev.wix.com/docs/rest/crm/members-contacts/members/member-authentication/send-set-password-email)
|
|
274
292
|
* to email the member with a link to set their password.
|
|
275
293
|
* The member can log in to the site
|
|
276
294
|
* when they set their password for the first time.
|
|
@@ -357,6 +375,10 @@ declare const onMemberCreated$1: EventDefinition<MemberCreatedEnvelope, "wix.mem
|
|
|
357
375
|
declare const onMemberDeleted$1: EventDefinition<MemberDeletedEnvelope, "wix.members.v1.member_deleted">;
|
|
358
376
|
declare const onMemberUpdated$1: EventDefinition<MemberUpdatedEnvelope, "wix.members.v1.member_updated">;
|
|
359
377
|
|
|
378
|
+
declare function customQueryMembers(httpClient: HttpClient): {
|
|
379
|
+
(query: MemberQuery, options?: QueryMembersOptions): ReturnType<typeof typedQueryMembers>;
|
|
380
|
+
(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
381
|
+
};
|
|
360
382
|
declare const updateCurrentMemberSlug: MaybeContext<BuildRESTFunction<typeof updateCurrentMemberSlug$1> & typeof updateCurrentMemberSlug$1>;
|
|
361
383
|
declare const updateMemberSlug: MaybeContext<BuildRESTFunction<typeof updateMemberSlug$1> & typeof updateMemberSlug$1>;
|
|
362
384
|
declare const joinCommunity: MaybeContext<BuildRESTFunction<typeof joinCommunity$1> & typeof joinCommunity$1>;
|
|
@@ -364,7 +386,6 @@ declare const leaveCommunity: MaybeContext<BuildRESTFunction<typeof leaveCommuni
|
|
|
364
386
|
declare const getCurrentMember: MaybeContext<BuildRESTFunction<typeof getCurrentMember$1> & typeof getCurrentMember$1>;
|
|
365
387
|
declare const getMember: MaybeContext<BuildRESTFunction<typeof getMember$1> & typeof getMember$1>;
|
|
366
388
|
declare const listMembers: MaybeContext<BuildRESTFunction<typeof listMembers$1> & typeof listMembers$1>;
|
|
367
|
-
declare const queryMembers: MaybeContext<BuildRESTFunction<typeof queryMembers$1> & typeof queryMembers$1>;
|
|
368
389
|
declare const muteMember: MaybeContext<BuildRESTFunction<typeof muteMember$1> & typeof muteMember$1>;
|
|
369
390
|
declare const unmuteMember: MaybeContext<BuildRESTFunction<typeof unmuteMember$1> & typeof unmuteMember$1>;
|
|
370
391
|
declare const approveMember: MaybeContext<BuildRESTFunction<typeof approveMember$1> & typeof approveMember$1>;
|
|
@@ -381,6 +402,7 @@ declare const updateMember: MaybeContext<BuildRESTFunction<typeof updateMember$1
|
|
|
381
402
|
declare const deleteMemberPhones: MaybeContext<BuildRESTFunction<typeof deleteMemberPhones$1> & typeof deleteMemberPhones$1>;
|
|
382
403
|
declare const deleteMemberEmails: MaybeContext<BuildRESTFunction<typeof deleteMemberEmails$1> & typeof deleteMemberEmails$1>;
|
|
383
404
|
declare const deleteMemberAddresses: MaybeContext<BuildRESTFunction<typeof deleteMemberAddresses$1> & typeof deleteMemberAddresses$1>;
|
|
405
|
+
declare const queryMembers: MaybeContext<BuildRESTFunction<typeof customQueryMembers> & typeof customQueryMembers>;
|
|
384
406
|
/**
|
|
385
407
|
* Triggered when a member is created.
|
|
386
408
|
*
|
|
@@ -396,4 +418,4 @@ declare const onMemberDeleted: BuildEventDefinition<typeof onMemberDeleted$1> &
|
|
|
396
418
|
/** */
|
|
397
419
|
declare const onMemberUpdated: BuildEventDefinition<typeof onMemberUpdated$1> & typeof onMemberUpdated$1;
|
|
398
420
|
|
|
399
|
-
export { ApproveMemberResponse, BlockMemberApplicationErrors, BlockMemberResponse, BulkApproveMembersResponse, BulkBlockMembersResponse, BulkDeleteMembersByFilterOptions, BulkDeleteMembersByFilterResponse, BulkDeleteMembersResponse, CreateMemberOptions, DeleteMemberAddressesResponse, DeleteMemberEmailsResponse, DeleteMemberPhonesResponse, DeleteMemberValidationErrors, DeleteMyMemberOptions, DeleteMyMemberValidationErrors, DisconnectMemberResponse, GetCurrentMemberOptions, GetMemberApplicationErrors, GetMemberOptions, GetMyMemberResponse, JoinCommunityApplicationErrors, JoinCommunityResponse, LeaveCommunityResponse, ListMembersOptions, ListMembersResponse, Member, MemberCreatedEnvelope, MemberDeletedEnvelope, MemberUpdatedEnvelope, MembersQueryBuilder, MuteMemberResponse,
|
|
421
|
+
export { ApproveMemberResponse, BlockMemberApplicationErrors, BlockMemberResponse, BulkApproveMembersResponse, BulkBlockMembersResponse, BulkDeleteMembersByFilterOptions, BulkDeleteMembersByFilterResponse, BulkDeleteMembersResponse, CreateMemberOptions, DeleteMemberAddressesResponse, DeleteMemberEmailsResponse, DeleteMemberPhonesResponse, DeleteMemberValidationErrors, DeleteMyMemberOptions, DeleteMyMemberValidationErrors, DisconnectMemberResponse, GetCurrentMemberOptions, GetMemberApplicationErrors, GetMemberOptions, GetMyMemberResponse, JoinCommunityApplicationErrors, JoinCommunityResponse, LeaveCommunityResponse, ListMembersOptions, ListMembersResponse, Member, MemberCreatedEnvelope, MemberDeletedEnvelope, MemberQuery, MemberUpdatedEnvelope, MembersQueryBuilder, MuteMemberResponse, QueryMembersOptions, UnmuteMemberResponse, UpdateCurrentMemberSlugApplicationErrors, UpdateMember, UpdateMemberSlugApplicationErrors, UpdateMemberSlugResponse, UpdateMemberValidationErrors, 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 };
|
package/build/cjs/index.js
CHANGED
|
@@ -955,6 +955,7 @@ var Namespace = /* @__PURE__ */ ((Namespace2) => {
|
|
|
955
955
|
Namespace2["MIMIR"] = "MIMIR";
|
|
956
956
|
Namespace2["TWINS"] = "TWINS";
|
|
957
957
|
Namespace2["NANO"] = "NANO";
|
|
958
|
+
Namespace2["BASE44"] = "BASE44";
|
|
958
959
|
return Namespace2;
|
|
959
960
|
})(Namespace || {});
|
|
960
961
|
var DeleteStatus = /* @__PURE__ */ ((DeleteStatus2) => {
|
|
@@ -1150,14 +1151,13 @@ async function listMembers2(options) {
|
|
|
1150
1151
|
throw transformedError;
|
|
1151
1152
|
}
|
|
1152
1153
|
}
|
|
1153
|
-
function queryMembers2(
|
|
1154
|
-
const { httpClient, sideEffects } = arguments[
|
|
1154
|
+
function queryMembers2(options) {
|
|
1155
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
1155
1156
|
return (0, import_query_builder.queryBuilder)({
|
|
1156
1157
|
func: async (payload) => {
|
|
1157
1158
|
const reqOpts = queryMembers({
|
|
1158
1159
|
...payload,
|
|
1159
|
-
...options ?? {}
|
|
1160
|
-
query
|
|
1160
|
+
...options ?? {}
|
|
1161
1161
|
});
|
|
1162
1162
|
sideEffects?.onSiteCall?.();
|
|
1163
1163
|
try {
|
|
@@ -1169,11 +1169,11 @@ function queryMembers2(query, options) {
|
|
|
1169
1169
|
throw err;
|
|
1170
1170
|
}
|
|
1171
1171
|
},
|
|
1172
|
-
requestTransformer: (
|
|
1173
|
-
const args = [
|
|
1172
|
+
requestTransformer: (query) => {
|
|
1173
|
+
const args = [query, options];
|
|
1174
1174
|
return (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
|
|
1175
|
-
|
|
1176
|
-
|
|
1175
|
+
...args?.[1],
|
|
1176
|
+
query: args?.[0]
|
|
1177
1177
|
});
|
|
1178
1178
|
},
|
|
1179
1179
|
responseTransformer: ({ data }) => {
|
|
@@ -1197,6 +1197,32 @@ function queryMembers2(query, options) {
|
|
|
1197
1197
|
transformationPaths: {}
|
|
1198
1198
|
});
|
|
1199
1199
|
}
|
|
1200
|
+
async function typedQueryMembers(query, options) {
|
|
1201
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
1202
|
+
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
|
|
1203
|
+
query,
|
|
1204
|
+
...options
|
|
1205
|
+
});
|
|
1206
|
+
const reqOpts = queryMembers(payload);
|
|
1207
|
+
sideEffects?.onSiteCall?.();
|
|
1208
|
+
try {
|
|
1209
|
+
const result = await httpClient.request(reqOpts);
|
|
1210
|
+
sideEffects?.onSuccess?.(result);
|
|
1211
|
+
return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
|
|
1212
|
+
} catch (err) {
|
|
1213
|
+
const transformedError = (0, import_transform_error.transformError)(
|
|
1214
|
+
err,
|
|
1215
|
+
{
|
|
1216
|
+
spreadPathsToArguments: {},
|
|
1217
|
+
explicitPathsToArguments: { query: "$[0]" },
|
|
1218
|
+
singleArgumentUnchanged: false
|
|
1219
|
+
},
|
|
1220
|
+
["query", "options"]
|
|
1221
|
+
);
|
|
1222
|
+
sideEffects?.onError?.(err);
|
|
1223
|
+
throw transformedError;
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1200
1226
|
async function muteMember2(_id) {
|
|
1201
1227
|
const { httpClient, sideEffects } = arguments[1];
|
|
1202
1228
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ id: _id });
|
|
@@ -1635,7 +1661,14 @@ function listMembers3(httpClient) {
|
|
|
1635
1661
|
);
|
|
1636
1662
|
}
|
|
1637
1663
|
function queryMembers3(httpClient) {
|
|
1638
|
-
return (
|
|
1664
|
+
return (options) => queryMembers2(
|
|
1665
|
+
options,
|
|
1666
|
+
// @ts-ignore
|
|
1667
|
+
{ httpClient }
|
|
1668
|
+
);
|
|
1669
|
+
}
|
|
1670
|
+
function typedQueryMembers2(httpClient) {
|
|
1671
|
+
return (query, options) => typedQueryMembers(
|
|
1639
1672
|
query,
|
|
1640
1673
|
options,
|
|
1641
1674
|
// @ts-ignore
|
|
@@ -1811,6 +1844,18 @@ var onMemberUpdated = (0, import_sdk_types.EventDefinition)(
|
|
|
1811
1844
|
// src/members-v1-member-members.context.ts
|
|
1812
1845
|
var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
|
|
1813
1846
|
var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
|
|
1847
|
+
var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
|
|
1848
|
+
function customQueryMembers(httpClient) {
|
|
1849
|
+
const router = (0, import_query_method_router.createQueryOverloadRouter)({
|
|
1850
|
+
builderQueryFunction: (options) => queryMembers3(httpClient)(options),
|
|
1851
|
+
typedQueryFunction: (query, options) => typedQueryMembers2(httpClient)(query, options),
|
|
1852
|
+
hasOptionsParameter: true
|
|
1853
|
+
});
|
|
1854
|
+
function overloadedQuery(queryOrOptions, options) {
|
|
1855
|
+
return router(...arguments);
|
|
1856
|
+
}
|
|
1857
|
+
return overloadedQuery;
|
|
1858
|
+
}
|
|
1814
1859
|
var updateCurrentMemberSlug3 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateCurrentMemberSlug2);
|
|
1815
1860
|
var updateMemberSlug4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateMemberSlug3);
|
|
1816
1861
|
var joinCommunity4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(joinCommunity3);
|
|
@@ -1818,7 +1863,6 @@ var leaveCommunity4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)
|
|
|
1818
1863
|
var getCurrentMember3 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getCurrentMember2);
|
|
1819
1864
|
var getMember4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getMember3);
|
|
1820
1865
|
var listMembers4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(listMembers3);
|
|
1821
|
-
var queryMembers4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(queryMembers3);
|
|
1822
1866
|
var muteMember4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(muteMember3);
|
|
1823
1867
|
var unmuteMember4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(unmuteMember3);
|
|
1824
1868
|
var approveMember4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(approveMember3);
|
|
@@ -1835,6 +1879,7 @@ var updateMember4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(u
|
|
|
1835
1879
|
var deleteMemberPhones4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteMemberPhones3);
|
|
1836
1880
|
var deleteMemberEmails4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteMemberEmails3);
|
|
1837
1881
|
var deleteMemberAddresses4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteMemberAddresses3);
|
|
1882
|
+
var queryMembers4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryMembers);
|
|
1838
1883
|
var onMemberCreated2 = (0, import_event_definition_modules.createEventModule)(onMemberCreated);
|
|
1839
1884
|
var onMemberDeleted2 = (0, import_event_definition_modules.createEventModule)(onMemberDeleted);
|
|
1840
1885
|
var onMemberUpdated2 = (0, import_event_definition_modules.createEventModule)(onMemberUpdated);
|