@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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
|
+
import { QuerySpec, Query as Query$1, NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
3
|
interface Member {
|
|
4
4
|
/**
|
|
@@ -34,7 +34,7 @@ interface Member {
|
|
|
34
34
|
* [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).
|
|
35
35
|
*
|
|
36
36
|
* The full set of contact data can be accessed and managed with the
|
|
37
|
-
* Contacts API
|
|
37
|
+
* [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction).
|
|
38
38
|
*/
|
|
39
39
|
contact?: Contact;
|
|
40
40
|
/** Profile display details. */
|
|
@@ -823,7 +823,7 @@ interface BulkActionMetadata {
|
|
|
823
823
|
undetailedFailures?: number;
|
|
824
824
|
}
|
|
825
825
|
interface BulkDeleteMembersByFilterRequest {
|
|
826
|
-
/** Query options. See API Query Language
|
|
826
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
827
827
|
filter: any;
|
|
828
828
|
/**
|
|
829
829
|
* ID of a member receiving the deleted member's content.
|
|
@@ -836,29 +836,29 @@ interface BulkDeleteMembersByFilterRequest {
|
|
|
836
836
|
interface BulkDeleteMembersByFilterResponse {
|
|
837
837
|
/**
|
|
838
838
|
* Job ID.
|
|
839
|
-
* Specify this ID when calling Get Async Job
|
|
839
|
+
* Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
|
|
840
840
|
*/
|
|
841
841
|
jobId?: string;
|
|
842
842
|
}
|
|
843
843
|
interface BulkApproveMembersRequest {
|
|
844
|
-
/** Query options. See API Query Language
|
|
844
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
845
845
|
filter: any;
|
|
846
846
|
}
|
|
847
847
|
interface BulkApproveMembersResponse {
|
|
848
848
|
/**
|
|
849
849
|
* Job ID.
|
|
850
|
-
* Specify this ID when calling Get Async Job
|
|
850
|
+
* Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
|
|
851
851
|
*/
|
|
852
852
|
jobId?: string;
|
|
853
853
|
}
|
|
854
854
|
interface BulkBlockMembersRequest {
|
|
855
|
-
/** Query options. See API Query Language
|
|
855
|
+
/** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
|
|
856
856
|
filter: any;
|
|
857
857
|
}
|
|
858
858
|
interface BulkBlockMembersResponse {
|
|
859
859
|
/**
|
|
860
860
|
* Job ID.
|
|
861
|
-
* Specify this ID when calling Get Async Job
|
|
861
|
+
* Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
|
|
862
862
|
*/
|
|
863
863
|
jobId?: string;
|
|
864
864
|
}
|
|
@@ -1263,10 +1263,12 @@ declare enum Namespace {
|
|
|
1263
1263
|
/** Wix Twins platform. */
|
|
1264
1264
|
TWINS = "TWINS",
|
|
1265
1265
|
/** Wix Nano. */
|
|
1266
|
-
NANO = "NANO"
|
|
1266
|
+
NANO = "NANO",
|
|
1267
|
+
/** Base44 headless sites. */
|
|
1268
|
+
BASE44 = "BASE44"
|
|
1267
1269
|
}
|
|
1268
1270
|
/** @enumType */
|
|
1269
|
-
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
|
|
1271
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44';
|
|
1270
1272
|
/** Site transferred to another user. */
|
|
1271
1273
|
interface SiteTransferred {
|
|
1272
1274
|
/**
|
|
@@ -1785,6 +1787,8 @@ declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths
|
|
|
1785
1787
|
}>;
|
|
1786
1788
|
/**
|
|
1787
1789
|
* Updates a member's slug.
|
|
1790
|
+
*
|
|
1791
|
+
* 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).
|
|
1788
1792
|
* @param _id - Member ID.
|
|
1789
1793
|
* @param slug - New slug.
|
|
1790
1794
|
* @public
|
|
@@ -1846,6 +1850,8 @@ declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityRespon
|
|
|
1846
1850
|
*
|
|
1847
1851
|
* >**Note:**
|
|
1848
1852
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
1853
|
+
*
|
|
1854
|
+
* 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).
|
|
1849
1855
|
* @public
|
|
1850
1856
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1851
1857
|
* @applicableIdentity APP
|
|
@@ -1932,14 +1938,12 @@ interface ListMembersOptions {
|
|
|
1932
1938
|
*
|
|
1933
1939
|
* 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`.
|
|
1934
1940
|
* @public
|
|
1935
|
-
* @requiredField query
|
|
1936
1941
|
* @param options - Query options.
|
|
1937
|
-
* @param query - Query options.
|
|
1938
1942
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1939
1943
|
* @applicableIdentity APP
|
|
1940
1944
|
* @fqn com.wixpress.members.api.Members.QueryMembers
|
|
1941
1945
|
*/
|
|
1942
|
-
declare function queryMembers(
|
|
1946
|
+
declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
1943
1947
|
interface QueryMembersOptions {
|
|
1944
1948
|
/**
|
|
1945
1949
|
* Predefined sets of fields to return.
|
|
@@ -2007,12 +2011,59 @@ interface MembersQueryBuilder {
|
|
|
2007
2011
|
skip: (skip: number) => MembersQueryBuilder;
|
|
2008
2012
|
find: () => Promise<MembersQueryResult>;
|
|
2009
2013
|
}
|
|
2014
|
+
/**
|
|
2015
|
+
* @hidden
|
|
2016
|
+
* @fqn com.wixpress.members.api.Members.QueryMembers
|
|
2017
|
+
* @requiredField query
|
|
2018
|
+
*/
|
|
2019
|
+
declare function typedQueryMembers(query: MemberQuery, options?: QueryMembersOptions): Promise<NonNullablePaths<QueryMembersResponse, `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>>;
|
|
2020
|
+
interface MemberQuerySpec extends QuerySpec {
|
|
2021
|
+
paging: 'offset';
|
|
2022
|
+
wql: [
|
|
2023
|
+
{
|
|
2024
|
+
fields: [
|
|
2025
|
+
'_id',
|
|
2026
|
+
'contact.firstName',
|
|
2027
|
+
'contact.lastName',
|
|
2028
|
+
'contactId',
|
|
2029
|
+
'loginEmail',
|
|
2030
|
+
'privacyStatus',
|
|
2031
|
+
'profile.nickname',
|
|
2032
|
+
'profile.slug'
|
|
2033
|
+
];
|
|
2034
|
+
operators: '*';
|
|
2035
|
+
sort: 'NONE';
|
|
2036
|
+
}
|
|
2037
|
+
];
|
|
2038
|
+
}
|
|
2039
|
+
type CommonQueryWithEntityContext = Query$1<Member, MemberQuerySpec>;
|
|
2040
|
+
type MemberQuery = {
|
|
2041
|
+
/**
|
|
2042
|
+
Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
2043
|
+
*/
|
|
2044
|
+
filter?: CommonQueryWithEntityContext['filter'];
|
|
2045
|
+
/**
|
|
2046
|
+
Limit number of results
|
|
2047
|
+
*/
|
|
2048
|
+
paging?: {
|
|
2049
|
+
/**
|
|
2050
|
+
Number of items to load.
|
|
2051
|
+
*/
|
|
2052
|
+
limit?: NonNullable<CommonQueryWithEntityContext['paging']>['limit'] | null;
|
|
2053
|
+
/**
|
|
2054
|
+
Number of items to skip in the current sort order.
|
|
2055
|
+
*/
|
|
2056
|
+
offset?: NonNullable<CommonQueryWithEntityContext['paging']>['offset'] | null;
|
|
2057
|
+
};
|
|
2058
|
+
};
|
|
2010
2059
|
/**
|
|
2011
2060
|
* Mutes a member.
|
|
2012
2061
|
*
|
|
2013
2062
|
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
2014
2063
|
*
|
|
2015
2064
|
* 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).
|
|
2065
|
+
*
|
|
2066
|
+
* To unmute a member, call [Unmute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/unmute-member).
|
|
2016
2067
|
* @param _id - ID of the member to mute.
|
|
2017
2068
|
* @public
|
|
2018
2069
|
* @requiredField _id
|
|
@@ -2027,6 +2078,8 @@ declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberRes
|
|
|
2027
2078
|
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
2028
2079
|
*
|
|
2029
2080
|
* 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).
|
|
2081
|
+
*
|
|
2082
|
+
* To mute a member, call [Mute Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/mute-member).
|
|
2030
2083
|
* @param _id - ID of the member to unmute.
|
|
2031
2084
|
* @public
|
|
2032
2085
|
* @requiredField _id
|
|
@@ -2041,6 +2094,10 @@ declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMembe
|
|
|
2041
2094
|
* Call this API to:
|
|
2042
2095
|
* - Approve a pending member.
|
|
2043
2096
|
* - Unblock a blocked member.
|
|
2097
|
+
*
|
|
2098
|
+
* 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).
|
|
2099
|
+
*
|
|
2100
|
+
* To block a member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
|
|
2044
2101
|
* @param _id - ID of the member to approve.
|
|
2045
2102
|
* @public
|
|
2046
2103
|
* @requiredField _id
|
|
@@ -2054,7 +2111,9 @@ declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMem
|
|
|
2054
2111
|
*
|
|
2055
2112
|
* A blocked member can't log in to members-only pages.
|
|
2056
2113
|
*
|
|
2057
|
-
* To
|
|
2114
|
+
* 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).
|
|
2115
|
+
*
|
|
2116
|
+
* To unblock a member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
2058
2117
|
* @param _id - ID of a member to block.
|
|
2059
2118
|
* @public
|
|
2060
2119
|
* @requiredField _id
|
|
@@ -2083,6 +2142,12 @@ declare function disconnectMember(_id: string): Promise<NonNullablePaths<Disconn
|
|
|
2083
2142
|
* Deletes a member by ID.
|
|
2084
2143
|
*
|
|
2085
2144
|
* 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.
|
|
2145
|
+
*
|
|
2146
|
+
* 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).
|
|
2147
|
+
*
|
|
2148
|
+
* 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).
|
|
2149
|
+
*
|
|
2150
|
+
* 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).
|
|
2086
2151
|
* @param _id - ID of a member to delete.
|
|
2087
2152
|
* @public
|
|
2088
2153
|
* @requiredField _id
|
|
@@ -2102,6 +2167,12 @@ declare function deleteMember(_id: string): Promise<void & {
|
|
|
2102
2167
|
*
|
|
2103
2168
|
* >**Note:**
|
|
2104
2169
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
2170
|
+
*
|
|
2171
|
+
* 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).
|
|
2172
|
+
*
|
|
2173
|
+
* 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).
|
|
2174
|
+
*
|
|
2175
|
+
* 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).
|
|
2105
2176
|
* @public
|
|
2106
2177
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2107
2178
|
* @applicableIdentity APP
|
|
@@ -2121,6 +2192,12 @@ interface DeleteMyMemberOptions {
|
|
|
2121
2192
|
* Deletes multiple members by `memberId`.
|
|
2122
2193
|
*
|
|
2123
2194
|
* 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.
|
|
2195
|
+
*
|
|
2196
|
+
* 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).
|
|
2197
|
+
*
|
|
2198
|
+
* 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).
|
|
2199
|
+
*
|
|
2200
|
+
* 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).
|
|
2124
2201
|
* @param memberIds - IDs of members to be deleted.
|
|
2125
2202
|
* @public
|
|
2126
2203
|
* @requiredField memberIds
|
|
@@ -2133,7 +2210,13 @@ declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePath
|
|
|
2133
2210
|
* Deletes multiple members by the specified filter.
|
|
2134
2211
|
*
|
|
2135
2212
|
* 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.
|
|
2136
|
-
*
|
|
2213
|
+
*
|
|
2214
|
+
* 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).
|
|
2215
|
+
*
|
|
2216
|
+
* 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).
|
|
2217
|
+
*
|
|
2218
|
+
* 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).
|
|
2219
|
+
* @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
2137
2220
|
* @public
|
|
2138
2221
|
* @requiredField filter
|
|
2139
2222
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -2156,7 +2239,9 @@ interface BulkDeleteMembersByFilterOptions {
|
|
|
2156
2239
|
* Call this API to:
|
|
2157
2240
|
* - Approve pending members.
|
|
2158
2241
|
* - Unblock blocked members.
|
|
2159
|
-
*
|
|
2242
|
+
*
|
|
2243
|
+
* To approve a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
2244
|
+
* @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
2160
2245
|
* @public
|
|
2161
2246
|
* @requiredField filter
|
|
2162
2247
|
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
@@ -2169,8 +2254,12 @@ declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkA
|
|
|
2169
2254
|
*
|
|
2170
2255
|
* Blocked members can't log in to members-only pages.
|
|
2171
2256
|
*
|
|
2172
|
-
* To
|
|
2173
|
-
*
|
|
2257
|
+
* To block a single member, call [Block Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/block-member).
|
|
2258
|
+
*
|
|
2259
|
+
* To unblock a single member, call [Approve Member](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/approve-member).
|
|
2260
|
+
*
|
|
2261
|
+
* 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).
|
|
2262
|
+
* @param filter - Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details.
|
|
2174
2263
|
* @public
|
|
2175
2264
|
* @requiredField filter
|
|
2176
2265
|
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
@@ -2182,7 +2271,7 @@ declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlo
|
|
|
2182
2271
|
* Creates a site member.
|
|
2183
2272
|
*
|
|
2184
2273
|
* After creation, you can call
|
|
2185
|
-
* [Send Set Password Email
|
|
2274
|
+
* [Send Set Password Email](https://dev.wix.com/docs/rest/crm/members-contacts/members/member-authentication/send-set-password-email)
|
|
2186
2275
|
* to email the member with a link to set their password.
|
|
2187
2276
|
* The member can log in to the site
|
|
2188
2277
|
* when they set their password for the first time.
|
|
@@ -2265,7 +2354,7 @@ interface UpdateMember {
|
|
|
2265
2354
|
* [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).
|
|
2266
2355
|
*
|
|
2267
2356
|
* The full set of contact data can be accessed and managed with the
|
|
2268
|
-
* Contacts API
|
|
2357
|
+
* [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction).
|
|
2269
2358
|
*/
|
|
2270
2359
|
contact?: Contact;
|
|
2271
2360
|
/** Profile display details. */
|
|
@@ -2348,4 +2437,4 @@ declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<Delet
|
|
|
2348
2437
|
*/
|
|
2349
2438
|
declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, `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>>;
|
|
2350
2439
|
|
|
2351
|
-
export { type ActionEvent, type ActiveSubscriptionMemberBlockForbiddenPayload, type ActiveSubscriptionMemberDeleteForbiddenPayload, ActivityStatusStatus, type ActivityStatusStatusWithLiterals, type Address, type AddressStreetOneOf, type App, type ApplicationError, type ApproveMemberRequest, type ApproveMemberResponse, type Asset, type BaseEventMetadata, type BlockMemberApplicationErrors, type BlockMemberRequest, type BlockMemberResponse, type BulkActionMetadata, type BulkApproveMembersRequest, type BulkApproveMembersResponse, type BulkBlockMembersRequest, type BulkBlockMembersResponse, type BulkDeleteMembersByFilterOptions, type BulkDeleteMembersByFilterRequest, type BulkDeleteMembersByFilterResponse, type BulkDeleteMembersRequest, type BulkDeleteMembersResponse, type BulkMemberResult, type Contact, type ContentDeletionRequested, type ContentReassignmentRequested, type CreateMemberOptions, type CreateMemberRequest, type CreateMemberResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomField, type CustomTag, type DeleteContext, type DeleteMemberAddressesRequest, type DeleteMemberAddressesResponse, type DeleteMemberEmailsRequest, type DeleteMemberEmailsResponse, type DeleteMemberPhonesRequest, type DeleteMemberPhonesResponse, type DeleteMemberRequest, type DeleteMemberResponse, type DeleteMemberValidationErrors, type DeleteMyMemberOptions, type DeleteMyMemberRequest, type DeleteMyMemberResponse, type DeleteMyMemberValidationErrors, DeleteStatus, type DeleteStatusWithLiterals, type DisconnectMemberRequest, type DisconnectMemberResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetCurrentMemberOptions, type GetMemberApplicationErrors, type GetMemberOptions, type GetMemberRequest, type GetMemberResponse, type GetMyMemberRequest, type GetMyMemberResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type InvalidCustomFieldUrlPayload, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type JoinCommunityApplicationErrors, type JoinCommunityRequest, type JoinCommunityResponse, type LeaveCommunityRequest, type LeaveCommunityResponse, type ListMembersOptions, type ListMembersRequest, type ListMembersResponse, type Member, type MemberApproved, type MemberBlocked, type MemberCreatedEnvelope, type MemberDeletedEnvelope, type MemberIdChanged, type MemberJoinedCommunity, type MemberLeftCommunity, type MemberMuted, type MemberOwnershipTransferred, type MemberSelfBlockForbiddenPayload, type MemberToMemberBlockedPayload, type MemberUnmuted, type MemberUpdatedEnvelope, type MembersQueryBuilder, type MembersQueryResult, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MuteMemberRequest, type MuteMemberResponse, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type OwnerMemberBlockForbiddenPayload, type OwnerOrContributorDeleteForbiddenPayload, type Page, type Paging, type PagingMetadata, type PicassoAssigned, type PicassoUnassigned, PrivacyStatusStatus, type PrivacyStatusStatusWithLiterals, type Profile, type Query, type QueryMembersOptions, type QueryMembersRequest, type QueryMembersResponse, type RestoreInfo, type Search, type ServiceProvisioned, type ServiceRemoved, Set, type SetWithLiterals, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, type SlugAlreadyExistsPayload, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type URI, type UnmuteMemberRequest, type UnmuteMemberResponse, type UpdateCurrentMemberSlugApplicationErrors, type UpdateMember, type UpdateMemberRequest, type UpdateMemberResponse, type UpdateMemberSlugApplicationErrors, type UpdateMemberSlugRequest, type UpdateMemberSlugResponse, type UpdateMemberValidationErrors, type UpdateMySlugRequest, type UpdateMySlugResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, 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 };
|
|
2440
|
+
export { type ActionEvent, type ActiveSubscriptionMemberBlockForbiddenPayload, type ActiveSubscriptionMemberDeleteForbiddenPayload, ActivityStatusStatus, type ActivityStatusStatusWithLiterals, type Address, type AddressStreetOneOf, type App, type ApplicationError, type ApproveMemberRequest, type ApproveMemberResponse, type Asset, type BaseEventMetadata, type BlockMemberApplicationErrors, type BlockMemberRequest, type BlockMemberResponse, type BulkActionMetadata, type BulkApproveMembersRequest, type BulkApproveMembersResponse, type BulkBlockMembersRequest, type BulkBlockMembersResponse, type BulkDeleteMembersByFilterOptions, type BulkDeleteMembersByFilterRequest, type BulkDeleteMembersByFilterResponse, type BulkDeleteMembersRequest, type BulkDeleteMembersResponse, type BulkMemberResult, type CommonQueryWithEntityContext, type Contact, type ContentDeletionRequested, type ContentReassignmentRequested, type CreateMemberOptions, type CreateMemberRequest, type CreateMemberResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomField, type CustomTag, type DeleteContext, type DeleteMemberAddressesRequest, type DeleteMemberAddressesResponse, type DeleteMemberEmailsRequest, type DeleteMemberEmailsResponse, type DeleteMemberPhonesRequest, type DeleteMemberPhonesResponse, type DeleteMemberRequest, type DeleteMemberResponse, type DeleteMemberValidationErrors, type DeleteMyMemberOptions, type DeleteMyMemberRequest, type DeleteMyMemberResponse, type DeleteMyMemberValidationErrors, DeleteStatus, type DeleteStatusWithLiterals, type DisconnectMemberRequest, type DisconnectMemberResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type File, type GetCurrentMemberOptions, type GetMemberApplicationErrors, type GetMemberOptions, type GetMemberRequest, type GetMemberResponse, type GetMyMemberRequest, type GetMyMemberResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type InvalidCustomFieldUrlPayload, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type JoinCommunityApplicationErrors, type JoinCommunityRequest, type JoinCommunityResponse, type LeaveCommunityRequest, type LeaveCommunityResponse, type ListMembersOptions, type ListMembersRequest, type ListMembersResponse, type Member, type MemberApproved, type MemberBlocked, type MemberCreatedEnvelope, type MemberDeletedEnvelope, type MemberIdChanged, type MemberJoinedCommunity, type MemberLeftCommunity, type MemberMuted, type MemberOwnershipTransferred, type MemberQuery, type MemberQuerySpec, type MemberSelfBlockForbiddenPayload, type MemberToMemberBlockedPayload, type MemberUnmuted, type MemberUpdatedEnvelope, type MembersQueryBuilder, type MembersQueryResult, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MuteMemberRequest, type MuteMemberResponse, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type OwnerMemberBlockForbiddenPayload, type OwnerOrContributorDeleteForbiddenPayload, type Page, type Paging, type PagingMetadata, type PicassoAssigned, type PicassoUnassigned, PrivacyStatusStatus, type PrivacyStatusStatusWithLiterals, type Profile, type Query, type QueryMembersOptions, type QueryMembersRequest, type QueryMembersResponse, type RestoreInfo, type Search, type ServiceProvisioned, type ServiceRemoved, Set, type SetWithLiterals, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, type SlugAlreadyExistsPayload, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type URI, type UnmuteMemberRequest, type UnmuteMemberResponse, type UpdateCurrentMemberSlugApplicationErrors, type UpdateMember, type UpdateMemberRequest, type UpdateMemberResponse, type UpdateMemberSlugApplicationErrors, type UpdateMemberSlugRequest, type UpdateMemberSlugResponse, type UpdateMemberValidationErrors, type UpdateMySlugRequest, type UpdateMySlugResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, onMemberCreated, onMemberDeleted, onMemberUpdated, queryMembers, typedQueryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };
|
|
@@ -890,6 +890,7 @@ var Namespace = /* @__PURE__ */ ((Namespace2) => {
|
|
|
890
890
|
Namespace2["MIMIR"] = "MIMIR";
|
|
891
891
|
Namespace2["TWINS"] = "TWINS";
|
|
892
892
|
Namespace2["NANO"] = "NANO";
|
|
893
|
+
Namespace2["BASE44"] = "BASE44";
|
|
893
894
|
return Namespace2;
|
|
894
895
|
})(Namespace || {});
|
|
895
896
|
var DeleteStatus = /* @__PURE__ */ ((DeleteStatus2) => {
|
|
@@ -1085,14 +1086,13 @@ async function listMembers2(options) {
|
|
|
1085
1086
|
throw transformedError;
|
|
1086
1087
|
}
|
|
1087
1088
|
}
|
|
1088
|
-
function queryMembers2(
|
|
1089
|
-
const { httpClient, sideEffects } = arguments[
|
|
1089
|
+
function queryMembers2(options) {
|
|
1090
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
1090
1091
|
return queryBuilder({
|
|
1091
1092
|
func: async (payload) => {
|
|
1092
1093
|
const reqOpts = queryMembers({
|
|
1093
1094
|
...payload,
|
|
1094
|
-
...options ?? {}
|
|
1095
|
-
query
|
|
1095
|
+
...options ?? {}
|
|
1096
1096
|
});
|
|
1097
1097
|
sideEffects?.onSiteCall?.();
|
|
1098
1098
|
try {
|
|
@@ -1104,11 +1104,11 @@ function queryMembers2(query, options) {
|
|
|
1104
1104
|
throw err;
|
|
1105
1105
|
}
|
|
1106
1106
|
},
|
|
1107
|
-
requestTransformer: (
|
|
1108
|
-
const args = [
|
|
1107
|
+
requestTransformer: (query) => {
|
|
1108
|
+
const args = [query, options];
|
|
1109
1109
|
return renameKeysFromSDKRequestToRESTRequest({
|
|
1110
|
-
|
|
1111
|
-
|
|
1110
|
+
...args?.[1],
|
|
1111
|
+
query: args?.[0]
|
|
1112
1112
|
});
|
|
1113
1113
|
},
|
|
1114
1114
|
responseTransformer: ({ data }) => {
|
|
@@ -1132,6 +1132,32 @@ function queryMembers2(query, options) {
|
|
|
1132
1132
|
transformationPaths: {}
|
|
1133
1133
|
});
|
|
1134
1134
|
}
|
|
1135
|
+
async function typedQueryMembers(query, options) {
|
|
1136
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
1137
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
1138
|
+
query,
|
|
1139
|
+
...options
|
|
1140
|
+
});
|
|
1141
|
+
const reqOpts = queryMembers(payload);
|
|
1142
|
+
sideEffects?.onSiteCall?.();
|
|
1143
|
+
try {
|
|
1144
|
+
const result = await httpClient.request(reqOpts);
|
|
1145
|
+
sideEffects?.onSuccess?.(result);
|
|
1146
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
|
1147
|
+
} catch (err) {
|
|
1148
|
+
const transformedError = sdkTransformError(
|
|
1149
|
+
err,
|
|
1150
|
+
{
|
|
1151
|
+
spreadPathsToArguments: {},
|
|
1152
|
+
explicitPathsToArguments: { query: "$[0]" },
|
|
1153
|
+
singleArgumentUnchanged: false
|
|
1154
|
+
},
|
|
1155
|
+
["query", "options"]
|
|
1156
|
+
);
|
|
1157
|
+
sideEffects?.onError?.(err);
|
|
1158
|
+
throw transformedError;
|
|
1159
|
+
}
|
|
1160
|
+
}
|
|
1135
1161
|
async function muteMember2(_id) {
|
|
1136
1162
|
const { httpClient, sideEffects } = arguments[1];
|
|
1137
1163
|
const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
|
|
@@ -1549,6 +1575,7 @@ export {
|
|
|
1549
1575
|
listMembers2 as listMembers,
|
|
1550
1576
|
muteMember2 as muteMember,
|
|
1551
1577
|
queryMembers2 as queryMembers,
|
|
1578
|
+
typedQueryMembers,
|
|
1552
1579
|
unmuteMember2 as unmuteMember,
|
|
1553
1580
|
updateCurrentMemberSlug,
|
|
1554
1581
|
updateMember2 as updateMember,
|