@wix/auto_sdk_members_members 1.0.63 → 1.0.65
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 +23 -52
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +35 -54
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +23 -52
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +35 -54
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +23 -52
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +35 -54
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +23 -52
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +35 -54
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1516,26 +1516,31 @@ declare enum WebhookIdentityType {
|
|
|
1516
1516
|
}
|
|
1517
1517
|
/** @enumType */
|
|
1518
1518
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1519
|
+
/** @docsIgnore */
|
|
1519
1520
|
type UpdateCurrentMemberSlugApplicationErrors = {
|
|
1520
1521
|
code?: 'SLUG_ALREADY_EXISTS';
|
|
1521
1522
|
description?: string;
|
|
1522
1523
|
data?: SlugAlreadyExistsPayload;
|
|
1523
1524
|
};
|
|
1525
|
+
/** @docsIgnore */
|
|
1524
1526
|
type UpdateMemberSlugApplicationErrors = {
|
|
1525
1527
|
code?: 'SLUG_ALREADY_EXISTS';
|
|
1526
1528
|
description?: string;
|
|
1527
1529
|
data?: SlugAlreadyExistsPayload;
|
|
1528
1530
|
};
|
|
1531
|
+
/** @docsIgnore */
|
|
1529
1532
|
type JoinCommunityApplicationErrors = {
|
|
1530
1533
|
code?: 'COMMUNITY_JOIN_IMPOSSIBLE';
|
|
1531
1534
|
description?: string;
|
|
1532
1535
|
data?: Record<string, any>;
|
|
1533
1536
|
};
|
|
1537
|
+
/** @docsIgnore */
|
|
1534
1538
|
type GetMemberApplicationErrors = {
|
|
1535
1539
|
code?: 'MEMBER_TO_MEMBER_BLOCKED';
|
|
1536
1540
|
description?: string;
|
|
1537
1541
|
data?: MemberToMemberBlockedPayload;
|
|
1538
1542
|
};
|
|
1543
|
+
/** @docsIgnore */
|
|
1539
1544
|
type BlockMemberApplicationErrors = {
|
|
1540
1545
|
code?: 'MEMBER_SELF_BLOCK_FORBIDDEN';
|
|
1541
1546
|
description?: string;
|
|
@@ -1549,14 +1554,17 @@ type BlockMemberApplicationErrors = {
|
|
|
1549
1554
|
description?: string;
|
|
1550
1555
|
data?: ActiveSubscriptionMemberBlockForbiddenPayload;
|
|
1551
1556
|
};
|
|
1557
|
+
/** @docsIgnore */
|
|
1552
1558
|
type DeleteMemberValidationErrors = {
|
|
1553
1559
|
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1554
1560
|
} | {
|
|
1555
1561
|
ruleName?: 'ACTIVE_SUBSCRIPTION_MEMBER_DELETE_FORBIDDEN';
|
|
1556
1562
|
};
|
|
1563
|
+
/** @docsIgnore */
|
|
1557
1564
|
type DeleteMyMemberValidationErrors = {
|
|
1558
1565
|
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1559
1566
|
};
|
|
1567
|
+
/** @docsIgnore */
|
|
1560
1568
|
type UpdateMemberValidationErrors = {
|
|
1561
1569
|
ruleName?: 'INVALID_CUSTOM_FIELD_URL';
|
|
1562
1570
|
};
|
|
@@ -1626,6 +1634,8 @@ interface MemberCreatedEnvelope {
|
|
|
1626
1634
|
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1627
1635
|
* @permissionScope Manage Portfolio
|
|
1628
1636
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1637
|
+
* @permissionScope View SEO Settings
|
|
1638
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1629
1639
|
* @permissionScope Manage Blog
|
|
1630
1640
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1631
1641
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1664,6 +1674,8 @@ interface MemberDeletedEnvelope {
|
|
|
1664
1674
|
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1665
1675
|
* @permissionScope Manage Portfolio
|
|
1666
1676
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1677
|
+
* @permissionScope View SEO Settings
|
|
1678
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1667
1679
|
* @permissionScope Manage Blog
|
|
1668
1680
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1669
1681
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1701,6 +1713,8 @@ interface MemberUpdatedEnvelope {
|
|
|
1701
1713
|
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1702
1714
|
* @permissionScope Manage Portfolio
|
|
1703
1715
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1716
|
+
* @permissionScope View SEO Settings
|
|
1717
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1704
1718
|
* @permissionScope Manage Blog
|
|
1705
1719
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1706
1720
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1722,7 +1736,6 @@ interface MemberUpdatedEnvelope {
|
|
|
1722
1736
|
* @slug updated
|
|
1723
1737
|
*/
|
|
1724
1738
|
declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope) => void | Promise<void>): void;
|
|
1725
|
-
type MemberNonNullablePaths = `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`;
|
|
1726
1739
|
/**
|
|
1727
1740
|
* Updates the currently logged in member's slug.
|
|
1728
1741
|
*
|
|
@@ -1739,9 +1752,7 @@ type MemberNonNullablePaths = `status` | `contact.phones` | `contact.emails` | `
|
|
|
1739
1752
|
* @applicableIdentity MEMBER
|
|
1740
1753
|
* @fqn com.wixpress.members.api.Members.UpdateMySlug
|
|
1741
1754
|
*/
|
|
1742
|
-
declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, {
|
|
1743
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1744
|
-
}[MemberNonNullablePaths]> & {
|
|
1755
|
+
declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, `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> & {
|
|
1745
1756
|
__applicationErrorsType?: UpdateCurrentMemberSlugApplicationErrors;
|
|
1746
1757
|
}>;
|
|
1747
1758
|
/**
|
|
@@ -1756,9 +1767,7 @@ declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths
|
|
|
1756
1767
|
* @applicableIdentity MEMBER
|
|
1757
1768
|
* @fqn com.wixpress.members.api.Members.UpdateMemberSlug
|
|
1758
1769
|
*/
|
|
1759
|
-
declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, {
|
|
1760
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1761
|
-
}[MemberNonNullablePaths]> & {
|
|
1770
|
+
declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, `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> & {
|
|
1762
1771
|
__applicationErrorsType?: UpdateMemberSlugApplicationErrors;
|
|
1763
1772
|
}>;
|
|
1764
1773
|
/**
|
|
@@ -1779,9 +1788,7 @@ declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullabl
|
|
|
1779
1788
|
* @returns Member profile.
|
|
1780
1789
|
* @fqn com.wixpress.members.api.Members.JoinCommunity
|
|
1781
1790
|
*/
|
|
1782
|
-
declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, {
|
|
1783
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1784
|
-
}[MemberNonNullablePaths]> & {
|
|
1791
|
+
declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, `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> & {
|
|
1785
1792
|
__applicationErrorsType?: JoinCommunityApplicationErrors;
|
|
1786
1793
|
}>;
|
|
1787
1794
|
/**
|
|
@@ -1805,9 +1812,7 @@ declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse
|
|
|
1805
1812
|
* @returns Member profile.
|
|
1806
1813
|
* @fqn com.wixpress.members.api.Members.LeaveCommunity
|
|
1807
1814
|
*/
|
|
1808
|
-
declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, {
|
|
1809
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1810
|
-
}[MemberNonNullablePaths]>>;
|
|
1815
|
+
declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, `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>>;
|
|
1811
1816
|
/**
|
|
1812
1817
|
* Retrieves the current member.
|
|
1813
1818
|
*
|
|
@@ -1816,13 +1821,10 @@ declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityRespon
|
|
|
1816
1821
|
* @public
|
|
1817
1822
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1818
1823
|
* @applicableIdentity APP
|
|
1819
|
-
* @applicableIdentity VISITOR
|
|
1820
1824
|
* @returns Member profile.
|
|
1821
1825
|
* @fqn com.wixpress.members.api.Members.GetMyMember
|
|
1822
1826
|
*/
|
|
1823
|
-
declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, {
|
|
1824
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1825
|
-
}[MemberNonNullablePaths]>>;
|
|
1827
|
+
declare function getCurrentMember(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>>;
|
|
1826
1828
|
interface GetCurrentMemberOptions {
|
|
1827
1829
|
/**
|
|
1828
1830
|
* Predefined set of fields to return.
|
|
@@ -1843,11 +1845,10 @@ interface GetCurrentMemberOptions {
|
|
|
1843
1845
|
* @param options - Fieldset options.
|
|
1844
1846
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1845
1847
|
* @applicableIdentity APP
|
|
1846
|
-
* @applicableIdentity VISITOR
|
|
1847
1848
|
* @returns The requested member.
|
|
1848
1849
|
* @fqn com.wixpress.members.api.Members.GetMember
|
|
1849
1850
|
*/
|
|
1850
|
-
declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member,
|
|
1851
|
+
declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member, `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`, 6> & {
|
|
1851
1852
|
__applicationErrorsType?: GetMemberApplicationErrors;
|
|
1852
1853
|
}>;
|
|
1853
1854
|
interface GetMemberOptions {
|
|
@@ -1865,12 +1866,9 @@ interface GetMemberOptions {
|
|
|
1865
1866
|
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
1866
1867
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1867
1868
|
* @applicableIdentity APP
|
|
1868
|
-
* @applicableIdentity VISITOR
|
|
1869
1869
|
* @fqn com.wixpress.members.api.Members.ListMembers
|
|
1870
1870
|
*/
|
|
1871
|
-
declare function listMembers(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, {
|
|
1872
|
-
[P in MemberNonNullablePaths]: `members.${number}.${P}`;
|
|
1873
|
-
}[MemberNonNullablePaths]>>;
|
|
1871
|
+
declare function listMembers(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>>;
|
|
1874
1872
|
interface ListMembersOptions {
|
|
1875
1873
|
/** Paging options. */
|
|
1876
1874
|
paging?: Paging;
|
|
@@ -1907,7 +1905,6 @@ interface ListMembersOptions {
|
|
|
1907
1905
|
* @param options - Query options.
|
|
1908
1906
|
* @permissionId MEMBERS.MEMBER_READ
|
|
1909
1907
|
* @applicableIdentity APP
|
|
1910
|
-
* @applicableIdentity VISITOR
|
|
1911
1908
|
* @fqn com.wixpress.members.api.Members.QueryMembers
|
|
1912
1909
|
*/
|
|
1913
1910
|
declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
@@ -1991,9 +1988,7 @@ interface MembersQueryBuilder {
|
|
|
1991
1988
|
* @applicableIdentity APP
|
|
1992
1989
|
* @fqn com.wixpress.members.api.Members.MuteMember
|
|
1993
1990
|
*/
|
|
1994
|
-
declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberResponse, {
|
|
1995
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1996
|
-
}[MemberNonNullablePaths]>>;
|
|
1991
|
+
declare function muteMember(_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>>;
|
|
1997
1992
|
/**
|
|
1998
1993
|
* Unmutes a member.
|
|
1999
1994
|
*
|
|
@@ -2007,9 +2002,7 @@ declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberRes
|
|
|
2007
2002
|
* @applicableIdentity APP
|
|
2008
2003
|
* @fqn com.wixpress.members.api.Members.UnmuteMember
|
|
2009
2004
|
*/
|
|
2010
|
-
declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, {
|
|
2011
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2012
|
-
}[MemberNonNullablePaths]>>;
|
|
2005
|
+
declare function unmuteMember(_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>>;
|
|
2013
2006
|
/**
|
|
2014
2007
|
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
2015
2008
|
*
|
|
@@ -2023,9 +2016,7 @@ declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMembe
|
|
|
2023
2016
|
* @applicableIdentity APP
|
|
2024
2017
|
* @fqn com.wixpress.members.api.Members.ApproveMember
|
|
2025
2018
|
*/
|
|
2026
|
-
declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, {
|
|
2027
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2028
|
-
}[MemberNonNullablePaths]>>;
|
|
2019
|
+
declare function approveMember(_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>>;
|
|
2029
2020
|
/**
|
|
2030
2021
|
* Blocks a member.
|
|
2031
2022
|
*
|
|
@@ -2039,9 +2030,7 @@ declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMem
|
|
|
2039
2030
|
* @applicableIdentity APP
|
|
2040
2031
|
* @fqn com.wixpress.members.api.Members.BlockMember
|
|
2041
2032
|
*/
|
|
2042
|
-
declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberResponse, {
|
|
2043
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2044
|
-
}[MemberNonNullablePaths]> & {
|
|
2033
|
+
declare function blockMember(_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> & {
|
|
2045
2034
|
__applicationErrorsType?: BlockMemberApplicationErrors;
|
|
2046
2035
|
}>;
|
|
2047
2036
|
/**
|
|
@@ -2057,9 +2046,7 @@ declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberR
|
|
|
2057
2046
|
* @applicableIdentity APP
|
|
2058
2047
|
* @fqn com.wixpress.members.api.Members.DisconnectMember
|
|
2059
2048
|
*/
|
|
2060
|
-
declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, {
|
|
2061
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2062
|
-
}[MemberNonNullablePaths]>>;
|
|
2049
|
+
declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, `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>>;
|
|
2063
2050
|
/**
|
|
2064
2051
|
* Deletes a member by ID.
|
|
2065
2052
|
*
|
|
@@ -2109,7 +2096,7 @@ interface DeleteMyMemberOptions {
|
|
|
2109
2096
|
* @applicableIdentity APP
|
|
2110
2097
|
* @fqn com.wixpress.members.api.Members.BulkDeleteMembers
|
|
2111
2098
|
*/
|
|
2112
|
-
declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePaths<BulkDeleteMembersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures
|
|
2099
|
+
declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePaths<BulkDeleteMembersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
2113
2100
|
/**
|
|
2114
2101
|
* Deletes multiple members by the specified filter.
|
|
2115
2102
|
*
|
|
@@ -2121,7 +2108,7 @@ declare function bulkDeleteMembers(memberIds: string[]): Promise<NonNullablePath
|
|
|
2121
2108
|
* @applicableIdentity APP
|
|
2122
2109
|
* @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
|
|
2123
2110
|
*/
|
|
2124
|
-
declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId
|
|
2111
|
+
declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`, 2>>;
|
|
2125
2112
|
interface BulkDeleteMembersByFilterOptions {
|
|
2126
2113
|
/**
|
|
2127
2114
|
* ID of a member receiving the deleted member's content.
|
|
@@ -2144,7 +2131,7 @@ interface BulkDeleteMembersByFilterOptions {
|
|
|
2144
2131
|
* @applicableIdentity APP
|
|
2145
2132
|
* @fqn com.wixpress.members.api.Members.BulkApproveMembers
|
|
2146
2133
|
*/
|
|
2147
|
-
declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId
|
|
2134
|
+
declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`, 2>>;
|
|
2148
2135
|
/**
|
|
2149
2136
|
* Blocks multiple members by a specified filter.
|
|
2150
2137
|
*
|
|
@@ -2158,7 +2145,7 @@ declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkA
|
|
|
2158
2145
|
* @applicableIdentity APP
|
|
2159
2146
|
* @fqn com.wixpress.members.api.Members.BulkBlockMembers
|
|
2160
2147
|
*/
|
|
2161
|
-
declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId
|
|
2148
|
+
declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`, 2>>;
|
|
2162
2149
|
/**
|
|
2163
2150
|
* Creates a site member.
|
|
2164
2151
|
*
|
|
@@ -2177,7 +2164,7 @@ declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlo
|
|
|
2177
2164
|
* @returns New member.
|
|
2178
2165
|
* @fqn com.wixpress.members.api.Members.CreateMember
|
|
2179
2166
|
*/
|
|
2180
|
-
declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member,
|
|
2167
|
+
declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member, `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`, 6>>;
|
|
2181
2168
|
interface CreateMemberOptions {
|
|
2182
2169
|
/** Member to create. */
|
|
2183
2170
|
member?: Member;
|
|
@@ -2209,7 +2196,7 @@ interface CreateMemberOptions {
|
|
|
2209
2196
|
* @returns Updated member.
|
|
2210
2197
|
* @fqn com.wixpress.members.api.Members.UpdateMember
|
|
2211
2198
|
*/
|
|
2212
|
-
declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member,
|
|
2199
|
+
declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member, `status` | `contact.phones` | `contact.emails` | `contact.addresses` | `contact.addresses.${number}.streetAddress.number` | `contact.addresses.${number}.streetAddress.name` | `profile.photo._id` | `profile.photo.url` | `profile.photo.height` | `profile.photo.width` | `privacyStatus` | `activityStatus`, 6> & {
|
|
2213
2200
|
__validationErrorsType?: UpdateMemberValidationErrors;
|
|
2214
2201
|
}>;
|
|
2215
2202
|
interface UpdateMember {
|
|
@@ -2289,9 +2276,7 @@ interface UpdateMember {
|
|
|
2289
2276
|
* @applicableIdentity MEMBER
|
|
2290
2277
|
* @fqn com.wixpress.members.api.Members.DeleteMemberPhones
|
|
2291
2278
|
*/
|
|
2292
|
-
declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, {
|
|
2293
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2294
|
-
}[MemberNonNullablePaths]>>;
|
|
2279
|
+
declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, `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>>;
|
|
2295
2280
|
/**
|
|
2296
2281
|
* Clears a member's email addresses.
|
|
2297
2282
|
*
|
|
@@ -2311,9 +2296,7 @@ declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<Delet
|
|
|
2311
2296
|
* @applicableIdentity MEMBER
|
|
2312
2297
|
* @fqn com.wixpress.members.api.Members.DeleteMemberEmails
|
|
2313
2298
|
*/
|
|
2314
|
-
declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, {
|
|
2315
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2316
|
-
}[MemberNonNullablePaths]>>;
|
|
2299
|
+
declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, `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>>;
|
|
2317
2300
|
/**
|
|
2318
2301
|
* Deletes a member's street addresses.
|
|
2319
2302
|
*
|
|
@@ -2330,8 +2313,6 @@ declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<Delet
|
|
|
2330
2313
|
* @applicableIdentity MEMBER
|
|
2331
2314
|
* @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
|
|
2332
2315
|
*/
|
|
2333
|
-
declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, {
|
|
2334
|
-
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2335
|
-
}[MemberNonNullablePaths]>>;
|
|
2316
|
+
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>>;
|
|
2336
2317
|
|
|
2337
2318
|
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 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, 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 };
|