@wix/auto_sdk_members_members 1.0.60 → 1.0.62
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 +73 -28
- package/build/cjs/index.js +2 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{members-v1-member-members.universal-JdMli_Bi.d.ts → index.typings.d.ts} +587 -6
- package/build/cjs/index.typings.js +1539 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +3 -6
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +73 -28
- package/build/es/index.mjs +2 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/{members-v1-member-members.universal-JdMli_Bi.d.mts → index.typings.d.mts} +587 -6
- package/build/es/index.typings.mjs +1482 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +3 -6
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +73 -28
- package/build/internal/cjs/index.js +2 -0
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{members-v1-member-members.universal-JdMli_Bi.d.ts → index.typings.d.ts} +587 -6
- package/build/internal/cjs/index.typings.js +1539 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +3 -6
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +73 -28
- package/build/internal/es/index.mjs +2 -0
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{members-v1-member-members.universal-JdMli_Bi.d.mts → index.typings.d.mts} +587 -6
- package/build/internal/es/index.typings.mjs +1482 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +3 -6
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/internal/cjs/{members-v1-member-members.universal-JdMli_Bi.d.ts → index.typings.d.ts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
interface Member {
|
|
2
4
|
/**
|
|
3
5
|
* Member ID.
|
|
@@ -200,11 +202,7 @@ interface Profile {
|
|
|
200
202
|
* When left empty, the values default to `0`.
|
|
201
203
|
*/
|
|
202
204
|
cover?: Image;
|
|
203
|
-
/**
|
|
204
|
-
* Member title.
|
|
205
|
-
*
|
|
206
|
-
* Currently available through the API only.
|
|
207
|
-
*/
|
|
205
|
+
/** Member title. */
|
|
208
206
|
title?: string | null;
|
|
209
207
|
}
|
|
210
208
|
interface Image {
|
|
@@ -1518,6 +1516,50 @@ declare enum WebhookIdentityType {
|
|
|
1518
1516
|
}
|
|
1519
1517
|
/** @enumType */
|
|
1520
1518
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1519
|
+
type UpdateCurrentMemberSlugApplicationErrors = {
|
|
1520
|
+
code?: 'SLUG_ALREADY_EXISTS';
|
|
1521
|
+
description?: string;
|
|
1522
|
+
data?: SlugAlreadyExistsPayload;
|
|
1523
|
+
};
|
|
1524
|
+
type UpdateMemberSlugApplicationErrors = {
|
|
1525
|
+
code?: 'SLUG_ALREADY_EXISTS';
|
|
1526
|
+
description?: string;
|
|
1527
|
+
data?: SlugAlreadyExistsPayload;
|
|
1528
|
+
};
|
|
1529
|
+
type JoinCommunityApplicationErrors = {
|
|
1530
|
+
code?: 'COMMUNITY_JOIN_IMPOSSIBLE';
|
|
1531
|
+
description?: string;
|
|
1532
|
+
data?: Record<string, any>;
|
|
1533
|
+
};
|
|
1534
|
+
type GetMemberApplicationErrors = {
|
|
1535
|
+
code?: 'MEMBER_TO_MEMBER_BLOCKED';
|
|
1536
|
+
description?: string;
|
|
1537
|
+
data?: MemberToMemberBlockedPayload;
|
|
1538
|
+
};
|
|
1539
|
+
type BlockMemberApplicationErrors = {
|
|
1540
|
+
code?: 'MEMBER_SELF_BLOCK_FORBIDDEN';
|
|
1541
|
+
description?: string;
|
|
1542
|
+
data?: MemberSelfBlockForbiddenPayload;
|
|
1543
|
+
} | {
|
|
1544
|
+
code?: 'OWNER_MEMBER_BLOCK_FORBIDDEN';
|
|
1545
|
+
description?: string;
|
|
1546
|
+
data?: OwnerMemberBlockForbiddenPayload;
|
|
1547
|
+
} | {
|
|
1548
|
+
code?: 'ACTIVE_SUBSCRIPTION_MEMBER_BLOCK_FORBIDDEN';
|
|
1549
|
+
description?: string;
|
|
1550
|
+
data?: ActiveSubscriptionMemberBlockForbiddenPayload;
|
|
1551
|
+
};
|
|
1552
|
+
type DeleteMemberValidationErrors = {
|
|
1553
|
+
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1554
|
+
} | {
|
|
1555
|
+
ruleName?: 'ACTIVE_SUBSCRIPTION_MEMBER_DELETE_FORBIDDEN';
|
|
1556
|
+
};
|
|
1557
|
+
type DeleteMyMemberValidationErrors = {
|
|
1558
|
+
ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN';
|
|
1559
|
+
};
|
|
1560
|
+
type UpdateMemberValidationErrors = {
|
|
1561
|
+
ruleName?: 'INVALID_CUSTOM_FIELD_URL';
|
|
1562
|
+
};
|
|
1521
1563
|
interface BaseEventMetadata {
|
|
1522
1564
|
/**
|
|
1523
1565
|
* App instance ID.
|
|
@@ -1566,13 +1608,221 @@ interface MemberCreatedEnvelope {
|
|
|
1566
1608
|
entity: Member;
|
|
1567
1609
|
metadata: EventMetadata;
|
|
1568
1610
|
}
|
|
1611
|
+
/**
|
|
1612
|
+
* Triggered when a member is created.
|
|
1613
|
+
*
|
|
1614
|
+
* The site owner can configure the site to automatically approve members or require manual approval.
|
|
1615
|
+
*
|
|
1616
|
+
* A member who has been approved either automatically or manually has a `status` of `"APPROVED"`. A created member waiting for approval has a `status` of `"PENDING"`. A `"PENDING"` member can't log in to the site.
|
|
1617
|
+
* @permissionScope Manage Stores
|
|
1618
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1619
|
+
* @permissionScope Manage Members
|
|
1620
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1621
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
1622
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1623
|
+
* @permissionScope Manage Events
|
|
1624
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1625
|
+
* @permissionScope Manage Challenges
|
|
1626
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1627
|
+
* @permissionScope Manage Portfolio
|
|
1628
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1629
|
+
* @permissionScope Manage Blog
|
|
1630
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1631
|
+
* @permissionScope Access Verticals by Automations
|
|
1632
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1633
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
1634
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1635
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1636
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1637
|
+
* @permissionScope Read Members
|
|
1638
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1639
|
+
* @permissionScope Set Up Automations
|
|
1640
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1641
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1642
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1643
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1644
|
+
* @webhook
|
|
1645
|
+
* @eventType wix.members.v1.member_created
|
|
1646
|
+
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1647
|
+
* @slug created
|
|
1648
|
+
*/
|
|
1649
|
+
declare function onMemberCreated(handler: (event: MemberCreatedEnvelope) => void | Promise<void>): void;
|
|
1569
1650
|
interface MemberDeletedEnvelope {
|
|
1570
1651
|
metadata: EventMetadata;
|
|
1571
1652
|
}
|
|
1653
|
+
/**
|
|
1654
|
+
* Triggered when a member is deleted.
|
|
1655
|
+
* @permissionScope Manage Stores
|
|
1656
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1657
|
+
* @permissionScope Manage Members
|
|
1658
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1659
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
1660
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1661
|
+
* @permissionScope Manage Events
|
|
1662
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1663
|
+
* @permissionScope Manage Challenges
|
|
1664
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1665
|
+
* @permissionScope Manage Portfolio
|
|
1666
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1667
|
+
* @permissionScope Manage Blog
|
|
1668
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1669
|
+
* @permissionScope Access Verticals by Automations
|
|
1670
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1671
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
1672
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1673
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1674
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1675
|
+
* @permissionScope Read Members
|
|
1676
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1677
|
+
* @permissionScope Set Up Automations
|
|
1678
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1679
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1680
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1681
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1682
|
+
* @webhook
|
|
1683
|
+
* @eventType wix.members.v1.member_deleted
|
|
1684
|
+
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1685
|
+
* @slug deleted
|
|
1686
|
+
*/
|
|
1687
|
+
declare function onMemberDeleted(handler: (event: MemberDeletedEnvelope) => void | Promise<void>): void;
|
|
1572
1688
|
interface MemberUpdatedEnvelope {
|
|
1573
1689
|
entity: Member;
|
|
1574
1690
|
metadata: EventMetadata;
|
|
1575
1691
|
}
|
|
1692
|
+
/** @permissionScope Manage Stores
|
|
1693
|
+
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1694
|
+
* @permissionScope Manage Members
|
|
1695
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1696
|
+
* @permissionScope Manage Bookings Services and Settings
|
|
1697
|
+
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
1698
|
+
* @permissionScope Manage Events
|
|
1699
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1700
|
+
* @permissionScope Manage Challenges
|
|
1701
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
1702
|
+
* @permissionScope Manage Portfolio
|
|
1703
|
+
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1704
|
+
* @permissionScope Manage Blog
|
|
1705
|
+
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1706
|
+
* @permissionScope Access Verticals by Automations
|
|
1707
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
1708
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
1709
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
|
|
1710
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1711
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1712
|
+
* @permissionScope Read Members
|
|
1713
|
+
* @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
|
|
1714
|
+
* @permissionScope Set Up Automations
|
|
1715
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
1716
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1717
|
+
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
1718
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1719
|
+
* @webhook
|
|
1720
|
+
* @eventType wix.members.v1.member_updated
|
|
1721
|
+
* @serviceIdentifier com.wixpress.members.api.Members
|
|
1722
|
+
* @slug updated
|
|
1723
|
+
*/
|
|
1724
|
+
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
|
+
/**
|
|
1727
|
+
* Updates the currently logged in member's slug.
|
|
1728
|
+
*
|
|
1729
|
+
* The `slug` is the end of a member's URL that refers to a specific logged-in member. For example, if a member's URL is `https://example.com/member/{my-member-slug}`, the slug is `my-member-slug`. The slug is case-sensitive and is generally derived from the member's `nickname`; otherwise, it's derived from the `loginEmail`.
|
|
1730
|
+
*
|
|
1731
|
+
* > **Note:**
|
|
1732
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
1733
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1734
|
+
* @param slug - New slug.
|
|
1735
|
+
* @public
|
|
1736
|
+
* @requiredField slug
|
|
1737
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
1738
|
+
* @applicableIdentity APP
|
|
1739
|
+
* @applicableIdentity MEMBER
|
|
1740
|
+
* @fqn com.wixpress.members.api.Members.UpdateMySlug
|
|
1741
|
+
*/
|
|
1742
|
+
declare function updateCurrentMemberSlug(slug: string): Promise<NonNullablePaths<UpdateMySlugResponse, {
|
|
1743
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1744
|
+
}[MemberNonNullablePaths]> & {
|
|
1745
|
+
__applicationErrorsType?: UpdateCurrentMemberSlugApplicationErrors;
|
|
1746
|
+
}>;
|
|
1747
|
+
/**
|
|
1748
|
+
* Updates a member's slug.
|
|
1749
|
+
* @param _id - Member ID.
|
|
1750
|
+
* @param slug - New slug.
|
|
1751
|
+
* @public
|
|
1752
|
+
* @requiredField _id
|
|
1753
|
+
* @requiredField slug
|
|
1754
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
1755
|
+
* @applicableIdentity APP
|
|
1756
|
+
* @applicableIdentity MEMBER
|
|
1757
|
+
* @fqn com.wixpress.members.api.Members.UpdateMemberSlug
|
|
1758
|
+
*/
|
|
1759
|
+
declare function updateMemberSlug(_id: string, slug: string): Promise<NonNullablePaths<UpdateMemberSlugResponse, {
|
|
1760
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1761
|
+
}[MemberNonNullablePaths]> & {
|
|
1762
|
+
__applicationErrorsType?: UpdateMemberSlugApplicationErrors;
|
|
1763
|
+
}>;
|
|
1764
|
+
/**
|
|
1765
|
+
* Joins the current member to the site community and sets their profile to public.
|
|
1766
|
+
*
|
|
1767
|
+
* When a member's profile is public, they have access to the site's
|
|
1768
|
+
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
1769
|
+
* features, such as chat, forum, and followers,
|
|
1770
|
+
* and their profile is visible to other members and site visitors.
|
|
1771
|
+
*
|
|
1772
|
+
* > **Note:**
|
|
1773
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
1774
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1775
|
+
* @public
|
|
1776
|
+
* @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
|
|
1777
|
+
* @applicableIdentity APP
|
|
1778
|
+
* @applicableIdentity MEMBER
|
|
1779
|
+
* @returns Member profile.
|
|
1780
|
+
* @fqn com.wixpress.members.api.Members.JoinCommunity
|
|
1781
|
+
*/
|
|
1782
|
+
declare function joinCommunity(): Promise<NonNullablePaths<JoinCommunityResponse, {
|
|
1783
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1784
|
+
}[MemberNonNullablePaths]> & {
|
|
1785
|
+
__applicationErrorsType?: JoinCommunityApplicationErrors;
|
|
1786
|
+
}>;
|
|
1787
|
+
/**
|
|
1788
|
+
* Removes the current member from the site community and sets their profile to private.
|
|
1789
|
+
*
|
|
1790
|
+
* When a member's profile is private,
|
|
1791
|
+
* they do not have access to the site's
|
|
1792
|
+
* [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
|
|
1793
|
+
* features, such as chat, forum, and followers,
|
|
1794
|
+
* and their profile is hidden from other members and site visitors.
|
|
1795
|
+
*
|
|
1796
|
+
* > **Notes:**
|
|
1797
|
+
* > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
|
|
1798
|
+
*
|
|
1799
|
+
* > + Only logged-in members can call this method without elevated permissions.
|
|
1800
|
+
* > + To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
1801
|
+
* @public
|
|
1802
|
+
* @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
|
|
1803
|
+
* @applicableIdentity APP
|
|
1804
|
+
* @applicableIdentity MEMBER
|
|
1805
|
+
* @returns Member profile.
|
|
1806
|
+
* @fqn com.wixpress.members.api.Members.LeaveCommunity
|
|
1807
|
+
*/
|
|
1808
|
+
declare function leaveCommunity(): Promise<NonNullablePaths<LeaveCommunityResponse, {
|
|
1809
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1810
|
+
}[MemberNonNullablePaths]>>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Retrieves the current member.
|
|
1813
|
+
*
|
|
1814
|
+
* >**Note:**
|
|
1815
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
1816
|
+
* @public
|
|
1817
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1818
|
+
* @applicableIdentity APP
|
|
1819
|
+
* @applicableIdentity VISITOR
|
|
1820
|
+
* @returns Member profile.
|
|
1821
|
+
* @fqn com.wixpress.members.api.Members.GetMyMember
|
|
1822
|
+
*/
|
|
1823
|
+
declare function getCurrentMember(options?: GetCurrentMemberOptions): Promise<NonNullablePaths<GetMyMemberResponse, {
|
|
1824
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1825
|
+
}[MemberNonNullablePaths]>>;
|
|
1576
1826
|
interface GetCurrentMemberOptions {
|
|
1577
1827
|
/**
|
|
1578
1828
|
* Predefined set of fields to return.
|
|
@@ -1582,6 +1832,24 @@ interface GetCurrentMemberOptions {
|
|
|
1582
1832
|
*/
|
|
1583
1833
|
fieldsets?: SetWithLiterals[];
|
|
1584
1834
|
}
|
|
1835
|
+
/**
|
|
1836
|
+
* Retrieves a member by ID.
|
|
1837
|
+
*
|
|
1838
|
+
* >**Note:** The returned Member object contains only the fields that were explicitly added to the Member object. Custom Contact fields are **not** automatically added to the Member object. They must be [added to the Member object by the site owner](https://support.wix.com/en/article/site-members-customizing-your-member-profile-fields).
|
|
1839
|
+
*
|
|
1840
|
+
* @param _id - Member ID.
|
|
1841
|
+
* @public
|
|
1842
|
+
* @requiredField _id
|
|
1843
|
+
* @param options - Fieldset options.
|
|
1844
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1845
|
+
* @applicableIdentity APP
|
|
1846
|
+
* @applicableIdentity VISITOR
|
|
1847
|
+
* @returns The requested member.
|
|
1848
|
+
* @fqn com.wixpress.members.api.Members.GetMember
|
|
1849
|
+
*/
|
|
1850
|
+
declare function getMember(_id: string, options?: GetMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths> & {
|
|
1851
|
+
__applicationErrorsType?: GetMemberApplicationErrors;
|
|
1852
|
+
}>;
|
|
1585
1853
|
interface GetMemberOptions {
|
|
1586
1854
|
/**
|
|
1587
1855
|
* Predefined set of fields to return.
|
|
@@ -1591,6 +1859,18 @@ interface GetMemberOptions {
|
|
|
1591
1859
|
*/
|
|
1592
1860
|
fieldsets?: SetWithLiterals[];
|
|
1593
1861
|
}
|
|
1862
|
+
/**
|
|
1863
|
+
* Lists site members, given the provided paging and fieldsets.
|
|
1864
|
+
* @public
|
|
1865
|
+
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
1866
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1867
|
+
* @applicableIdentity APP
|
|
1868
|
+
* @applicableIdentity VISITOR
|
|
1869
|
+
* @fqn com.wixpress.members.api.Members.ListMembers
|
|
1870
|
+
*/
|
|
1871
|
+
declare function listMembers(options?: ListMembersOptions): Promise<NonNullablePaths<ListMembersResponse, {
|
|
1872
|
+
[P in MemberNonNullablePaths]: `members.${number}.${P}`;
|
|
1873
|
+
}[MemberNonNullablePaths]>>;
|
|
1594
1874
|
interface ListMembersOptions {
|
|
1595
1875
|
/** Paging options. */
|
|
1596
1876
|
paging?: Paging;
|
|
@@ -1604,6 +1884,33 @@ interface ListMembersOptions {
|
|
|
1604
1884
|
/** Sorting options. */
|
|
1605
1885
|
sorting?: Sorting[];
|
|
1606
1886
|
}
|
|
1887
|
+
/**
|
|
1888
|
+
* Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
|
|
1889
|
+
*
|
|
1890
|
+
* The returned object contains the query definition which is typically used to run the query using the `find()` method.
|
|
1891
|
+
*
|
|
1892
|
+
* 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.
|
|
1893
|
+
*
|
|
1894
|
+
* `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
|
|
1895
|
+
* - `skip`: `0`
|
|
1896
|
+
* - `limit`: `100`
|
|
1897
|
+
*
|
|
1898
|
+
* Currently supported fields for sorting:
|
|
1899
|
+
* - `profile.nickname`
|
|
1900
|
+
* - `contact.firstName`
|
|
1901
|
+
* - `contact.lastName`
|
|
1902
|
+
* - `createdDate`
|
|
1903
|
+
* - `lastLoginDate`
|
|
1904
|
+
*
|
|
1905
|
+
* 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`.
|
|
1906
|
+
* @public
|
|
1907
|
+
* @param options - Query options.
|
|
1908
|
+
* @permissionId MEMBERS.MEMBER_READ
|
|
1909
|
+
* @applicableIdentity APP
|
|
1910
|
+
* @applicableIdentity VISITOR
|
|
1911
|
+
* @fqn com.wixpress.members.api.Members.QueryMembers
|
|
1912
|
+
*/
|
|
1913
|
+
declare function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;
|
|
1607
1914
|
interface QueryMembersOptions {
|
|
1608
1915
|
/**
|
|
1609
1916
|
* Predefined sets of fields to return.
|
|
@@ -1671,6 +1978,119 @@ interface MembersQueryBuilder {
|
|
|
1671
1978
|
skip: (skip: number) => MembersQueryBuilder;
|
|
1672
1979
|
find: () => Promise<MembersQueryResult>;
|
|
1673
1980
|
}
|
|
1981
|
+
/**
|
|
1982
|
+
* Mutes a member.
|
|
1983
|
+
*
|
|
1984
|
+
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
1985
|
+
*
|
|
1986
|
+
* 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).
|
|
1987
|
+
* @param _id - ID of the member to mute.
|
|
1988
|
+
* @public
|
|
1989
|
+
* @requiredField _id
|
|
1990
|
+
* @permissionId MEMBERS.MEMBER_MUTE
|
|
1991
|
+
* @applicableIdentity APP
|
|
1992
|
+
* @fqn com.wixpress.members.api.Members.MuteMember
|
|
1993
|
+
*/
|
|
1994
|
+
declare function muteMember(_id: string): Promise<NonNullablePaths<MuteMemberResponse, {
|
|
1995
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
1996
|
+
}[MemberNonNullablePaths]>>;
|
|
1997
|
+
/**
|
|
1998
|
+
* Unmutes a member.
|
|
1999
|
+
*
|
|
2000
|
+
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
2001
|
+
*
|
|
2002
|
+
* 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).
|
|
2003
|
+
* @param _id - ID of the member to unmute.
|
|
2004
|
+
* @public
|
|
2005
|
+
* @requiredField _id
|
|
2006
|
+
* @permissionId MEMBERS.MEMBER_MUTE
|
|
2007
|
+
* @applicableIdentity APP
|
|
2008
|
+
* @fqn com.wixpress.members.api.Members.UnmuteMember
|
|
2009
|
+
*/
|
|
2010
|
+
declare function unmuteMember(_id: string): Promise<NonNullablePaths<UnmuteMemberResponse, {
|
|
2011
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2012
|
+
}[MemberNonNullablePaths]>>;
|
|
2013
|
+
/**
|
|
2014
|
+
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
2015
|
+
*
|
|
2016
|
+
* Call this API to:
|
|
2017
|
+
* - Approve a pending member.
|
|
2018
|
+
* - Unblock a blocked member.
|
|
2019
|
+
* @param _id - ID of the member to approve.
|
|
2020
|
+
* @public
|
|
2021
|
+
* @requiredField _id
|
|
2022
|
+
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
2023
|
+
* @applicableIdentity APP
|
|
2024
|
+
* @fqn com.wixpress.members.api.Members.ApproveMember
|
|
2025
|
+
*/
|
|
2026
|
+
declare function approveMember(_id: string): Promise<NonNullablePaths<ApproveMemberResponse, {
|
|
2027
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2028
|
+
}[MemberNonNullablePaths]>>;
|
|
2029
|
+
/**
|
|
2030
|
+
* Blocks a member.
|
|
2031
|
+
*
|
|
2032
|
+
* A blocked member can't log in to members-only pages.
|
|
2033
|
+
*
|
|
2034
|
+
* To unblock a member, call Approve Member.
|
|
2035
|
+
* @param _id - ID of a member to block.
|
|
2036
|
+
* @public
|
|
2037
|
+
* @requiredField _id
|
|
2038
|
+
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
2039
|
+
* @applicableIdentity APP
|
|
2040
|
+
* @fqn com.wixpress.members.api.Members.BlockMember
|
|
2041
|
+
*/
|
|
2042
|
+
declare function blockMember(_id: string): Promise<NonNullablePaths<BlockMemberResponse, {
|
|
2043
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2044
|
+
}[MemberNonNullablePaths]> & {
|
|
2045
|
+
__applicationErrorsType?: BlockMemberApplicationErrors;
|
|
2046
|
+
}>;
|
|
2047
|
+
/**
|
|
2048
|
+
* Disconnects a member.
|
|
2049
|
+
*
|
|
2050
|
+
* A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
|
|
2051
|
+
*
|
|
2052
|
+
* >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
|
|
2053
|
+
* @param _id - ID of a member to disconnect.
|
|
2054
|
+
* @public
|
|
2055
|
+
* @requiredField _id
|
|
2056
|
+
* @permissionId MEMBERS.MEMBER_DISCONNECT
|
|
2057
|
+
* @applicableIdentity APP
|
|
2058
|
+
* @fqn com.wixpress.members.api.Members.DisconnectMember
|
|
2059
|
+
*/
|
|
2060
|
+
declare function disconnectMember(_id: string): Promise<NonNullablePaths<DisconnectMemberResponse, {
|
|
2061
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2062
|
+
}[MemberNonNullablePaths]>>;
|
|
2063
|
+
/**
|
|
2064
|
+
* Deletes a member by ID.
|
|
2065
|
+
*
|
|
2066
|
+
* 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.
|
|
2067
|
+
* @param _id - ID of a member to delete.
|
|
2068
|
+
* @public
|
|
2069
|
+
* @requiredField _id
|
|
2070
|
+
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2071
|
+
* @applicableIdentity APP
|
|
2072
|
+
* @fqn com.wixpress.members.api.Members.DeleteMember
|
|
2073
|
+
*/
|
|
2074
|
+
declare function deleteMember(_id: string): Promise<void & {
|
|
2075
|
+
__validationErrorsType?: DeleteMemberValidationErrors;
|
|
2076
|
+
}>;
|
|
2077
|
+
/**
|
|
2078
|
+
* Deletes the current member.
|
|
2079
|
+
*
|
|
2080
|
+
* After calling this method, the member is logged out of the site.
|
|
2081
|
+
*
|
|
2082
|
+
* All content created by this member is transferred to another account. For example, if a Wix user had blog posts, those posts are transferred to the account specified in `contentAssignedId`, which then becomes the owner of those posts.
|
|
2083
|
+
*
|
|
2084
|
+
* >**Note:**
|
|
2085
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
2086
|
+
* @public
|
|
2087
|
+
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2088
|
+
* @applicableIdentity APP
|
|
2089
|
+
* @fqn com.wixpress.members.api.Members.DeleteMyMember
|
|
2090
|
+
*/
|
|
2091
|
+
declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void & {
|
|
2092
|
+
__validationErrorsType?: DeleteMyMemberValidationErrors;
|
|
2093
|
+
}>;
|
|
1674
2094
|
interface DeleteMyMemberOptions {
|
|
1675
2095
|
/**
|
|
1676
2096
|
* ID of a member receiving the deleted member's content.
|
|
@@ -1678,6 +2098,30 @@ interface DeleteMyMemberOptions {
|
|
|
1678
2098
|
*/
|
|
1679
2099
|
contentAssigneeId?: string | null;
|
|
1680
2100
|
}
|
|
2101
|
+
/**
|
|
2102
|
+
* Deletes multiple members by `memberId`.
|
|
2103
|
+
*
|
|
2104
|
+
* 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.
|
|
2105
|
+
* @param memberIds - IDs of members to be deleted.
|
|
2106
|
+
* @public
|
|
2107
|
+
* @requiredField memberIds
|
|
2108
|
+
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2109
|
+
* @applicableIdentity APP
|
|
2110
|
+
* @fqn com.wixpress.members.api.Members.BulkDeleteMembers
|
|
2111
|
+
*/
|
|
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`>>;
|
|
2113
|
+
/**
|
|
2114
|
+
* Deletes multiple members by the specified filter.
|
|
2115
|
+
*
|
|
2116
|
+
* 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.
|
|
2117
|
+
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2118
|
+
* @public
|
|
2119
|
+
* @requiredField filter
|
|
2120
|
+
* @permissionId MEMBERS.MEMBER_DELETE
|
|
2121
|
+
* @applicableIdentity APP
|
|
2122
|
+
* @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
|
|
2123
|
+
*/
|
|
2124
|
+
declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<NonNullablePaths<BulkDeleteMembersByFilterResponse, `jobId`>>;
|
|
1681
2125
|
interface BulkDeleteMembersByFilterOptions {
|
|
1682
2126
|
/**
|
|
1683
2127
|
* ID of a member receiving the deleted member's content.
|
|
@@ -1687,10 +2131,87 @@ interface BulkDeleteMembersByFilterOptions {
|
|
|
1687
2131
|
/** Plain text search. */
|
|
1688
2132
|
search?: Search;
|
|
1689
2133
|
}
|
|
2134
|
+
/**
|
|
2135
|
+
* Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
|
|
2136
|
+
*
|
|
2137
|
+
* Call this API to:
|
|
2138
|
+
* - Approve pending members.
|
|
2139
|
+
* - Unblock blocked members.
|
|
2140
|
+
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2141
|
+
* @public
|
|
2142
|
+
* @requiredField filter
|
|
2143
|
+
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
2144
|
+
* @applicableIdentity APP
|
|
2145
|
+
* @fqn com.wixpress.members.api.Members.BulkApproveMembers
|
|
2146
|
+
*/
|
|
2147
|
+
declare function bulkApproveMembers(filter: any): Promise<NonNullablePaths<BulkApproveMembersResponse, `jobId`>>;
|
|
2148
|
+
/**
|
|
2149
|
+
* Blocks multiple members by a specified filter.
|
|
2150
|
+
*
|
|
2151
|
+
* Blocked members can't log in to members-only pages.
|
|
2152
|
+
*
|
|
2153
|
+
* To unblock multiple members, call Bulk Approve Members.
|
|
2154
|
+
* @param filter - Query options. See API Query Language ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)) for more details.
|
|
2155
|
+
* @public
|
|
2156
|
+
* @requiredField filter
|
|
2157
|
+
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
2158
|
+
* @applicableIdentity APP
|
|
2159
|
+
* @fqn com.wixpress.members.api.Members.BulkBlockMembers
|
|
2160
|
+
*/
|
|
2161
|
+
declare function bulkBlockMembers(filter: any): Promise<NonNullablePaths<BulkBlockMembersResponse, `jobId`>>;
|
|
2162
|
+
/**
|
|
2163
|
+
* Creates a site member.
|
|
2164
|
+
*
|
|
2165
|
+
* After creation, you can call
|
|
2166
|
+
* [Send Set Password Email ([SDK](https://dev.wix.com/docs/sdk/backend-modules/members/authentication/send-set-password-email) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/members/member-authentication/send-set-password-email))
|
|
2167
|
+
* to email the member with a link to set their password.
|
|
2168
|
+
* The member can log in to the site
|
|
2169
|
+
* when they set their password for the first time.
|
|
2170
|
+
*
|
|
2171
|
+
* > **Note:**
|
|
2172
|
+
* > When creating multiple members,
|
|
2173
|
+
* > set your requests at least 1 second apart to keep below rate limits.
|
|
2174
|
+
* @public
|
|
2175
|
+
* @permissionId MEMBERS.MEMBER_CREATE
|
|
2176
|
+
* @applicableIdentity APP
|
|
2177
|
+
* @returns New member.
|
|
2178
|
+
* @fqn com.wixpress.members.api.Members.CreateMember
|
|
2179
|
+
*/
|
|
2180
|
+
declare function createMember(options?: CreateMemberOptions): Promise<NonNullablePaths<Member, MemberNonNullablePaths>>;
|
|
1690
2181
|
interface CreateMemberOptions {
|
|
1691
2182
|
/** Member to create. */
|
|
1692
2183
|
member?: Member;
|
|
1693
2184
|
}
|
|
2185
|
+
/**
|
|
2186
|
+
* Updates a member's properties.
|
|
2187
|
+
*
|
|
2188
|
+
* Only the requested fields are updated.
|
|
2189
|
+
* To clear a field's value, set an empty value with an empty string `""`.
|
|
2190
|
+
*
|
|
2191
|
+
* > **Note:**
|
|
2192
|
+
* > Updating the `contact.addresses`, `contact.emails`, or `contact.phones` array overwrites the entire array, so any existing values you want to retain must be passed in the `updateMember()` call along with the new values to add.
|
|
2193
|
+
* > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
|
|
2194
|
+
* >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
|
|
2195
|
+
* >- To clear `contact.emails`, use `deleteMemberEmails()`.
|
|
2196
|
+
* >- To clear `contact.phones`, use `deleteMemberPhones()`.
|
|
2197
|
+
*
|
|
2198
|
+
* > **Note:**
|
|
2199
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
2200
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2201
|
+
* @param _id - Member ID.
|
|
2202
|
+
* @public
|
|
2203
|
+
* @requiredField _id
|
|
2204
|
+
* @requiredField member
|
|
2205
|
+
* @param options - Member to update.
|
|
2206
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2207
|
+
* @applicableIdentity APP
|
|
2208
|
+
* @applicableIdentity MEMBER
|
|
2209
|
+
* @returns Updated member.
|
|
2210
|
+
* @fqn com.wixpress.members.api.Members.UpdateMember
|
|
2211
|
+
*/
|
|
2212
|
+
declare function updateMember(_id: string, member: UpdateMember): Promise<NonNullablePaths<Member, MemberNonNullablePaths> & {
|
|
2213
|
+
__validationErrorsType?: UpdateMemberValidationErrors;
|
|
2214
|
+
}>;
|
|
1694
2215
|
interface UpdateMember {
|
|
1695
2216
|
/**
|
|
1696
2217
|
* Member ID.
|
|
@@ -1752,5 +2273,65 @@ interface UpdateMember {
|
|
|
1752
2273
|
*/
|
|
1753
2274
|
lastLoginDate?: Date | null;
|
|
1754
2275
|
}
|
|
2276
|
+
/**
|
|
2277
|
+
* Clears a member's phone numbers.
|
|
2278
|
+
*
|
|
2279
|
+
* `deleteMemberPhones()` clears the `phones` array under the `contact` property.
|
|
2280
|
+
*
|
|
2281
|
+
* > **Note:**
|
|
2282
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
2283
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2284
|
+
* @param _id - ID of the member whose phone numbers will be deleted.
|
|
2285
|
+
* @public
|
|
2286
|
+
* @requiredField _id
|
|
2287
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2288
|
+
* @applicableIdentity APP
|
|
2289
|
+
* @applicableIdentity MEMBER
|
|
2290
|
+
* @fqn com.wixpress.members.api.Members.DeleteMemberPhones
|
|
2291
|
+
*/
|
|
2292
|
+
declare function deleteMemberPhones(_id: string): Promise<NonNullablePaths<DeleteMemberPhonesResponse, {
|
|
2293
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2294
|
+
}[MemberNonNullablePaths]>>;
|
|
2295
|
+
/**
|
|
2296
|
+
* Clears a member's email addresses.
|
|
2297
|
+
*
|
|
2298
|
+
* `deleteMemberEmails()` clears the `emails` array under the `contact` property.
|
|
2299
|
+
*
|
|
2300
|
+
* > **Notes:**
|
|
2301
|
+
* > A member can still log in with their `loginEmail`,
|
|
2302
|
+
* > which is not cleared when this method is called.
|
|
2303
|
+
*
|
|
2304
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
2305
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2306
|
+
* @param _id - ID of the member whose email addresses will be deleted.
|
|
2307
|
+
* @public
|
|
2308
|
+
* @requiredField _id
|
|
2309
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2310
|
+
* @applicableIdentity APP
|
|
2311
|
+
* @applicableIdentity MEMBER
|
|
2312
|
+
* @fqn com.wixpress.members.api.Members.DeleteMemberEmails
|
|
2313
|
+
*/
|
|
2314
|
+
declare function deleteMemberEmails(_id: string): Promise<NonNullablePaths<DeleteMemberEmailsResponse, {
|
|
2315
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2316
|
+
}[MemberNonNullablePaths]>>;
|
|
2317
|
+
/**
|
|
2318
|
+
* Deletes a member's street addresses.
|
|
2319
|
+
*
|
|
2320
|
+
* `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
|
|
2321
|
+
*
|
|
2322
|
+
* > **Note:**
|
|
2323
|
+
* > Only logged-in members can call this method without elevated permissions.
|
|
2324
|
+
* > To call this method as a different identity, [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions) are required.
|
|
2325
|
+
* @param _id - ID of the member whose street addresses will be deleted.
|
|
2326
|
+
* @public
|
|
2327
|
+
* @requiredField _id
|
|
2328
|
+
* @permissionId MEMBERS.MEMBER_UPDATE
|
|
2329
|
+
* @applicableIdentity APP
|
|
2330
|
+
* @applicableIdentity MEMBER
|
|
2331
|
+
* @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
|
|
2332
|
+
*/
|
|
2333
|
+
declare function deleteMemberAddresses(_id: string): Promise<NonNullablePaths<DeleteMemberAddressesResponse, {
|
|
2334
|
+
[P in MemberNonNullablePaths]: `member.${P}`;
|
|
2335
|
+
}[MemberNonNullablePaths]>>;
|
|
1755
2336
|
|
|
1756
|
-
export { type
|
|
2337
|
+
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 };
|