@wix/auto_sdk_members_members 1.0.52 → 1.0.54

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.
Files changed (129) hide show
  1. package/build/{internal/cjs/src/members-v1-member-members.public.d.ts → index.d.mts} +70 -33
  2. package/build/{cjs/src/members-v1-member-members.public.d.ts → index.d.ts} +70 -33
  3. package/build/index.js +1800 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1740 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/{es/src/members-v1-member-members.public.d.ts → index.d.mts} +70 -33
  8. package/build/{es/src/members-v1-member-members.public.d.ts → internal/index.d.ts} +70 -33
  9. package/build/internal/index.js +1800 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1740 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{es/src/members-v1-member-members.types.d.ts → internal/members-v1-member-members.universal-CzPn3y3P.d.mts} +390 -162
  14. package/build/{cjs/src/members-v1-member-members.types.d.ts → internal/members-v1-member-members.universal-CzPn3y3P.d.ts} +390 -162
  15. package/build/internal/meta.d.mts +698 -0
  16. package/build/internal/meta.d.ts +698 -0
  17. package/build/internal/meta.js +1239 -0
  18. package/build/internal/meta.js.map +1 -0
  19. package/build/internal/meta.mjs +1189 -0
  20. package/build/internal/meta.mjs.map +1 -0
  21. package/build/{internal/cjs/src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-CzPn3y3P.d.mts} +390 -162
  22. package/build/{internal/es/src/members-v1-member-members.types.d.ts → members-v1-member-members.universal-CzPn3y3P.d.ts} +390 -162
  23. package/build/meta.d.mts +698 -0
  24. package/build/meta.d.ts +698 -0
  25. package/build/meta.js +1239 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1189 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/members-v1-member-members.context.d.ts +0 -46
  40. package/build/cjs/src/members-v1-member-members.context.js +0 -59
  41. package/build/cjs/src/members-v1-member-members.context.js.map +0 -1
  42. package/build/cjs/src/members-v1-member-members.http.d.ts +0 -229
  43. package/build/cjs/src/members-v1-member-members.http.js +0 -959
  44. package/build/cjs/src/members-v1-member-members.http.js.map +0 -1
  45. package/build/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  46. package/build/cjs/src/members-v1-member-members.meta.js +0 -484
  47. package/build/cjs/src/members-v1-member-members.meta.js.map +0 -1
  48. package/build/cjs/src/members-v1-member-members.public.js +0 -198
  49. package/build/cjs/src/members-v1-member-members.public.js.map +0 -1
  50. package/build/cjs/src/members-v1-member-members.types.js +0 -174
  51. package/build/cjs/src/members-v1-member-members.types.js.map +0 -1
  52. package/build/cjs/src/members-v1-member-members.universal.d.ts +0 -2418
  53. package/build/cjs/src/members-v1-member-members.universal.js +0 -1365
  54. package/build/cjs/src/members-v1-member-members.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/members-v1-member-members.context.d.ts +0 -46
  65. package/build/es/src/members-v1-member-members.context.js +0 -46
  66. package/build/es/src/members-v1-member-members.context.js.map +0 -1
  67. package/build/es/src/members-v1-member-members.http.d.ts +0 -229
  68. package/build/es/src/members-v1-member-members.http.js +0 -932
  69. package/build/es/src/members-v1-member-members.http.js.map +0 -1
  70. package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
  71. package/build/es/src/members-v1-member-members.meta.js +0 -434
  72. package/build/es/src/members-v1-member-members.meta.js.map +0 -1
  73. package/build/es/src/members-v1-member-members.public.js +0 -161
  74. package/build/es/src/members-v1-member-members.public.js.map +0 -1
  75. package/build/es/src/members-v1-member-members.types.js +0 -171
  76. package/build/es/src/members-v1-member-members.types.js.map +0 -1
  77. package/build/es/src/members-v1-member-members.universal.d.ts +0 -2418
  78. package/build/es/src/members-v1-member-members.universal.js +0 -1315
  79. package/build/es/src/members-v1-member-members.universal.js.map +0 -1
  80. package/build/internal/cjs/index.d.ts +0 -1
  81. package/build/internal/cjs/index.js +0 -18
  82. package/build/internal/cjs/index.js.map +0 -1
  83. package/build/internal/cjs/index.typings.d.ts +0 -1
  84. package/build/internal/cjs/index.typings.js +0 -18
  85. package/build/internal/cjs/index.typings.js.map +0 -1
  86. package/build/internal/cjs/meta.d.ts +0 -1
  87. package/build/internal/cjs/meta.js +0 -18
  88. package/build/internal/cjs/meta.js.map +0 -1
  89. package/build/internal/cjs/src/members-v1-member-members.context.d.ts +0 -46
  90. package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
  91. package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
  92. package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
  93. package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
  94. package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
  95. package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  96. package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
  97. package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
  98. package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
  99. package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
  100. package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
  101. package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
  102. package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2418
  103. package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1365
  104. package/build/internal/cjs/src/members-v1-member-members.universal.js.map +0 -1
  105. package/build/internal/es/index.d.ts +0 -1
  106. package/build/internal/es/index.js +0 -2
  107. package/build/internal/es/index.js.map +0 -1
  108. package/build/internal/es/index.typings.d.ts +0 -1
  109. package/build/internal/es/index.typings.js +0 -2
  110. package/build/internal/es/index.typings.js.map +0 -1
  111. package/build/internal/es/meta.d.ts +0 -1
  112. package/build/internal/es/meta.js +0 -2
  113. package/build/internal/es/meta.js.map +0 -1
  114. package/build/internal/es/src/members-v1-member-members.context.d.ts +0 -46
  115. package/build/internal/es/src/members-v1-member-members.context.js +0 -46
  116. package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
  117. package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
  118. package/build/internal/es/src/members-v1-member-members.http.js +0 -932
  119. package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
  120. package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
  121. package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
  122. package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
  123. package/build/internal/es/src/members-v1-member-members.public.js +0 -161
  124. package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
  125. package/build/internal/es/src/members-v1-member-members.types.js +0 -171
  126. package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
  127. package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2418
  128. package/build/internal/es/src/members-v1-member-members.universal.js +0 -1315
  129. package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
@@ -1,1315 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { queryBuilder } from '@wix/sdk-runtime/query-builder';
3
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
4
- import * as ambassadorWixMembersV1Member from './members-v1-member-members.http.js';
5
- export var Status;
6
- (function (Status) {
7
- /** Insufficient permissions to get the status. */
8
- Status["UNKNOWN"] = "UNKNOWN";
9
- /** Member is created and is waiting for approval by a Wix user. */
10
- Status["PENDING"] = "PENDING";
11
- /** Member can log in to the site. */
12
- Status["APPROVED"] = "APPROVED";
13
- /** Member is blocked and can't log in to the site. */
14
- Status["BLOCKED"] = "BLOCKED";
15
- /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. */
16
- Status["OFFLINE"] = "OFFLINE";
17
- })(Status || (Status = {}));
18
- export var PrivacyStatusStatus;
19
- (function (PrivacyStatusStatus) {
20
- /** Insufficient permissions to get the status. */
21
- PrivacyStatusStatus["UNKNOWN"] = "UNKNOWN";
22
- /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
23
- PrivacyStatusStatus["PRIVATE"] = "PRIVATE";
24
- /** Member is visible to everyone. */
25
- PrivacyStatusStatus["PUBLIC"] = "PUBLIC";
26
- })(PrivacyStatusStatus || (PrivacyStatusStatus = {}));
27
- export var ActivityStatusStatus;
28
- (function (ActivityStatusStatus) {
29
- /** Insufficient permissions to get the status. */
30
- ActivityStatusStatus["UNKNOWN"] = "UNKNOWN";
31
- /** Member can write forum posts and blog comments. */
32
- ActivityStatusStatus["ACTIVE"] = "ACTIVE";
33
- /** Member can't write forum posts or blog comments. */
34
- ActivityStatusStatus["MUTED"] = "MUTED";
35
- })(ActivityStatusStatus || (ActivityStatusStatus = {}));
36
- export var Set;
37
- (function (Set) {
38
- /**
39
- * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
40
- * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
41
- */
42
- Set["PUBLIC"] = "PUBLIC";
43
- /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */
44
- Set["EXTENDED"] = "EXTENDED";
45
- /** Includes all fields. */
46
- Set["FULL"] = "FULL";
47
- })(Set || (Set = {}));
48
- export var SortOrder;
49
- (function (SortOrder) {
50
- SortOrder["ASC"] = "ASC";
51
- SortOrder["DESC"] = "DESC";
52
- })(SortOrder || (SortOrder = {}));
53
- export var State;
54
- (function (State) {
55
- State["UNKNOWN"] = "UNKNOWN";
56
- State["ENABLED"] = "ENABLED";
57
- State["DISABLED"] = "DISABLED";
58
- State["PENDING"] = "PENDING";
59
- State["DEMO"] = "DEMO";
60
- })(State || (State = {}));
61
- export var SiteCreatedContext;
62
- (function (SiteCreatedContext) {
63
- /** A valid option, we don't expose all reasons why site might be created. */
64
- SiteCreatedContext["OTHER"] = "OTHER";
65
- /** A meta site was created from template. */
66
- SiteCreatedContext["FROM_TEMPLATE"] = "FROM_TEMPLATE";
67
- /** A meta site was created by copying of the transfferred meta site. */
68
- SiteCreatedContext["DUPLICATE_BY_SITE_TRANSFER"] = "DUPLICATE_BY_SITE_TRANSFER";
69
- /** A copy of existing meta site. */
70
- SiteCreatedContext["DUPLICATE"] = "DUPLICATE";
71
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
72
- SiteCreatedContext["OLD_SITE_TRANSFER"] = "OLD_SITE_TRANSFER";
73
- /** deprecated A meta site was created for Flash editor. */
74
- SiteCreatedContext["FLASH"] = "FLASH";
75
- })(SiteCreatedContext || (SiteCreatedContext = {}));
76
- export var Namespace;
77
- (function (Namespace) {
78
- Namespace["UNKNOWN_NAMESPACE"] = "UNKNOWN_NAMESPACE";
79
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
80
- Namespace["WIX"] = "WIX";
81
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
82
- Namespace["SHOUT_OUT"] = "SHOUT_OUT";
83
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
84
- Namespace["ALBUMS"] = "ALBUMS";
85
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
86
- Namespace["WIX_STORES_TEST_DRIVE"] = "WIX_STORES_TEST_DRIVE";
87
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
88
- Namespace["HOTELS"] = "HOTELS";
89
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
90
- Namespace["CLUBS"] = "CLUBS";
91
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
92
- Namespace["ONBOARDING_DRAFT"] = "ONBOARDING_DRAFT";
93
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
94
- Namespace["DEV_SITE"] = "DEV_SITE";
95
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
96
- Namespace["LOGOS"] = "LOGOS";
97
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
98
- Namespace["VIDEO_MAKER"] = "VIDEO_MAKER";
99
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
100
- Namespace["PARTNER_DASHBOARD"] = "PARTNER_DASHBOARD";
101
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
102
- Namespace["DEV_CENTER_COMPANY"] = "DEV_CENTER_COMPANY";
103
- /**
104
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
105
- *
106
- * Meta site with this namespace will *not* be shown in a user's site list by default.
107
- */
108
- Namespace["HTML_DRAFT"] = "HTML_DRAFT";
109
- /**
110
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
111
- * Will be accessible from Site List and will not have a website app.
112
- * Once the user attaches a site, the site will become a regular wixsite.
113
- */
114
- Namespace["SITELESS_BUSINESS"] = "SITELESS_BUSINESS";
115
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
116
- Namespace["CREATOR_ECONOMY"] = "CREATOR_ECONOMY";
117
- /** It is to be used in the Business First efforts. */
118
- Namespace["DASHBOARD_FIRST"] = "DASHBOARD_FIRST";
119
- /** Bookings business flow with no site. */
120
- Namespace["ANYWHERE"] = "ANYWHERE";
121
- /** Namespace for Headless Backoffice with no editor */
122
- Namespace["HEADLESS"] = "HEADLESS";
123
- /**
124
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
125
- * The site will be used for account level CSM feature for enterprise
126
- */
127
- Namespace["ACCOUNT_MASTER_CMS"] = "ACCOUNT_MASTER_CMS";
128
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
129
- Namespace["RISE"] = "RISE";
130
- /**
131
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
132
- * There's a blank site behind the scene but it's blank).
133
- * The Mobile company will be the owner of this namespace.
134
- */
135
- Namespace["BRANDED_FIRST"] = "BRANDED_FIRST";
136
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
137
- Namespace["NOWNIA"] = "NOWNIA";
138
- /**
139
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
140
- * The Partners company owns this namespace.
141
- */
142
- Namespace["UGC_TEMPLATE"] = "UGC_TEMPLATE";
143
- /** Codux Headless Sites */
144
- Namespace["CODUX"] = "CODUX";
145
- /** Bobb - AI Design Creator. */
146
- Namespace["MEDIA_DESIGN_CREATOR"] = "MEDIA_DESIGN_CREATOR";
147
- /**
148
- * Shared Blog Site is a unique single site across Enterprise account,
149
- * This site will hold all Blog posts related to the Marketing product.
150
- */
151
- Namespace["SHARED_BLOG_ENTERPRISE"] = "SHARED_BLOG_ENTERPRISE";
152
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
153
- Namespace["STANDALONE_FORMS"] = "STANDALONE_FORMS";
154
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
155
- Namespace["STANDALONE_EVENTS"] = "STANDALONE_EVENTS";
156
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
157
- Namespace["MIMIR"] = "MIMIR";
158
- })(Namespace || (Namespace = {}));
159
- export var DeleteStatus;
160
- (function (DeleteStatus) {
161
- DeleteStatus["UNKNOWN"] = "UNKNOWN";
162
- DeleteStatus["TRASH"] = "TRASH";
163
- DeleteStatus["DELETED"] = "DELETED";
164
- DeleteStatus["PENDING_PURGE"] = "PENDING_PURGE";
165
- DeleteStatus["PURGED_EXTERNALLY"] = "PURGED_EXTERNALLY";
166
- })(DeleteStatus || (DeleteStatus = {}));
167
- export var WebhookIdentityType;
168
- (function (WebhookIdentityType) {
169
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
170
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
171
- WebhookIdentityType["MEMBER"] = "MEMBER";
172
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
173
- WebhookIdentityType["APP"] = "APP";
174
- })(WebhookIdentityType || (WebhookIdentityType = {}));
175
- /**
176
- * Updates the currently logged in member's slug.
177
- *
178
- * 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`.
179
- *
180
- * > **Note:**
181
- * > Only logged-in members can call this method without elevated permissions.
182
- * > 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.
183
- * @param slug - New slug.
184
- * @public
185
- * @requiredField slug
186
- * @permissionId MEMBERS.MEMBER_UPDATE
187
- * @permissionScope Manage Members
188
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
189
- * @permissionScope Manage Bookings Services and Settings
190
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
191
- * @permissionScope Manage Events
192
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
193
- * @permissionScope Manage Challenges
194
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
195
- * @permissionScope Manage Portfolio
196
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
197
- * @permissionScope Access Verticals by Automations
198
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
199
- * @permissionScope Manage Restaurants - all permissions
200
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
201
- * @permissionScope Set Up Automations
202
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
203
- * @applicableIdentity APP
204
- * @applicableIdentity MEMBER
205
- * @fqn com.wixpress.members.api.Members.UpdateMySlug
206
- */
207
- export async function updateCurrentMemberSlug(slug) {
208
- // @ts-ignore
209
- const { httpClient, sideEffects } = arguments[1];
210
- const payload = renameKeysFromSDKRequestToRESTRequest({ slug: slug });
211
- const reqOpts = ambassadorWixMembersV1Member.updateMySlug(payload);
212
- sideEffects?.onSiteCall?.();
213
- try {
214
- const result = await httpClient.request(reqOpts);
215
- sideEffects?.onSuccess?.(result);
216
- return renameKeysFromRESTResponseToSDKResponse(result.data);
217
- }
218
- catch (err) {
219
- const transformedError = sdkTransformError(err, {
220
- spreadPathsToArguments: {},
221
- explicitPathsToArguments: { slug: '$[0]' },
222
- singleArgumentUnchanged: false,
223
- }, ['slug']);
224
- sideEffects?.onError?.(err);
225
- throw transformedError;
226
- }
227
- }
228
- /**
229
- * Updates a member's slug.
230
- * @param _id - Member ID.
231
- * @param slug - New slug.
232
- * @public
233
- * @requiredField _id
234
- * @requiredField slug
235
- * @permissionId MEMBERS.MEMBER_UPDATE
236
- * @permissionScope Manage Members
237
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
238
- * @permissionScope Manage Bookings Services and Settings
239
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
240
- * @permissionScope Manage Events
241
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
242
- * @permissionScope Manage Challenges
243
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
244
- * @permissionScope Manage Portfolio
245
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
246
- * @permissionScope Access Verticals by Automations
247
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
248
- * @permissionScope Manage Restaurants - all permissions
249
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
250
- * @permissionScope Set Up Automations
251
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
252
- * @applicableIdentity APP
253
- * @applicableIdentity MEMBER
254
- * @fqn com.wixpress.members.api.Members.UpdateMemberSlug
255
- */
256
- export async function updateMemberSlug(_id, slug) {
257
- // @ts-ignore
258
- const { httpClient, sideEffects } = arguments[2];
259
- const payload = renameKeysFromSDKRequestToRESTRequest({
260
- id: _id,
261
- slug: slug,
262
- });
263
- const reqOpts = ambassadorWixMembersV1Member.updateMemberSlug(payload);
264
- sideEffects?.onSiteCall?.();
265
- try {
266
- const result = await httpClient.request(reqOpts);
267
- sideEffects?.onSuccess?.(result);
268
- return renameKeysFromRESTResponseToSDKResponse(result.data);
269
- }
270
- catch (err) {
271
- const transformedError = sdkTransformError(err, {
272
- spreadPathsToArguments: {},
273
- explicitPathsToArguments: { id: '$[0]', slug: '$[1]' },
274
- singleArgumentUnchanged: false,
275
- }, ['_id', 'slug']);
276
- sideEffects?.onError?.(err);
277
- throw transformedError;
278
- }
279
- }
280
- /**
281
- * Joins the current member to the site community and sets their profile to public.
282
- *
283
- * When a member's profile is public, they have access to the site's
284
- * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
285
- * features, such as chat, forum, and followers,
286
- * and their profile is visible to other members and site visitors.
287
- *
288
- * > **Note:**
289
- * > Only logged-in members can call this method without elevated permissions.
290
- * > 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.
291
- * @public
292
- * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
293
- * @permissionScope Manage Members
294
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
295
- * @applicableIdentity APP
296
- * @applicableIdentity MEMBER
297
- * @returns Member profile.
298
- * @fqn com.wixpress.members.api.Members.JoinCommunity
299
- */
300
- export async function joinCommunity() {
301
- // @ts-ignore
302
- const { httpClient, sideEffects } = arguments[0];
303
- const payload = renameKeysFromSDKRequestToRESTRequest({});
304
- const reqOpts = ambassadorWixMembersV1Member.joinCommunity(payload);
305
- sideEffects?.onSiteCall?.();
306
- try {
307
- const result = await httpClient.request(reqOpts);
308
- sideEffects?.onSuccess?.(result);
309
- return renameKeysFromRESTResponseToSDKResponse(result.data);
310
- }
311
- catch (err) {
312
- const transformedError = sdkTransformError(err, {
313
- spreadPathsToArguments: {},
314
- explicitPathsToArguments: {},
315
- singleArgumentUnchanged: false,
316
- }, []);
317
- sideEffects?.onError?.(err);
318
- throw transformedError;
319
- }
320
- }
321
- /**
322
- * Removes the current member from the site community and sets their profile to private.
323
- *
324
- * When a member's profile is private,
325
- * they do not have access to the site's
326
- * [Members Area](https://support.wix.com/en/article/site-members-about-the-members-area)
327
- * features, such as chat, forum, and followers,
328
- * and their profile is hidden from other members and site visitors.
329
- *
330
- * > **Notes:**
331
- * > + If a member leaves the site's community, their content, such as forum posts and blog comments, remain publicly visible.
332
- *
333
- * > + Only logged-in members can call this method without elevated permissions.
334
- * > + 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.
335
- * @public
336
- * @permissionId MEMBERS.MEMBER_JOIN_COMMUNITY
337
- * @permissionScope Manage Members
338
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
339
- * @applicableIdentity APP
340
- * @applicableIdentity MEMBER
341
- * @returns Member profile.
342
- * @fqn com.wixpress.members.api.Members.LeaveCommunity
343
- */
344
- export async function leaveCommunity() {
345
- // @ts-ignore
346
- const { httpClient, sideEffects } = arguments[0];
347
- const payload = renameKeysFromSDKRequestToRESTRequest({});
348
- const reqOpts = ambassadorWixMembersV1Member.leaveCommunity(payload);
349
- sideEffects?.onSiteCall?.();
350
- try {
351
- const result = await httpClient.request(reqOpts);
352
- sideEffects?.onSuccess?.(result);
353
- return renameKeysFromRESTResponseToSDKResponse(result.data);
354
- }
355
- catch (err) {
356
- const transformedError = sdkTransformError(err, {
357
- spreadPathsToArguments: {},
358
- explicitPathsToArguments: {},
359
- singleArgumentUnchanged: false,
360
- }, []);
361
- sideEffects?.onError?.(err);
362
- throw transformedError;
363
- }
364
- }
365
- /**
366
- * Retrieves the current member.
367
- *
368
- * >**Note:**
369
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
370
- * @public
371
- * @permissionId MEMBERS.MEMBER_READ
372
- * @permissionScope Manage Members
373
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
374
- * @permissionScope Manage Bookings Services and Settings
375
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
376
- * @permissionScope Manage Events
377
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
378
- * @permissionScope Manage Challenges
379
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
380
- * @permissionScope Manage Portfolio
381
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
382
- * @permissionScope Access Verticals by Automations
383
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
384
- * @permissionScope Read Members and Contacts - all read permissions
385
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
386
- * @permissionScope Manage Restaurants - all permissions
387
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
388
- * @permissionScope Read Members
389
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
390
- * @permissionScope Set Up Automations
391
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
392
- * @permissionScope Manage Members and Contacts - all permissions
393
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
394
- * @applicableIdentity APP
395
- * @applicableIdentity VISITOR
396
- * @returns Member profile.
397
- * @fqn com.wixpress.members.api.Members.GetMyMember
398
- */
399
- export async function getCurrentMember(options) {
400
- // @ts-ignore
401
- const { httpClient, sideEffects } = arguments[1];
402
- const payload = renameKeysFromSDKRequestToRESTRequest({
403
- fieldsets: options?.fieldsets,
404
- });
405
- const reqOpts = ambassadorWixMembersV1Member.getMyMember(payload);
406
- sideEffects?.onSiteCall?.();
407
- try {
408
- const result = await httpClient.request(reqOpts);
409
- sideEffects?.onSuccess?.(result);
410
- return renameKeysFromRESTResponseToSDKResponse(result.data);
411
- }
412
- catch (err) {
413
- const transformedError = sdkTransformError(err, {
414
- spreadPathsToArguments: {},
415
- explicitPathsToArguments: { fieldsets: '$[0].fieldsets' },
416
- singleArgumentUnchanged: false,
417
- }, ['options']);
418
- sideEffects?.onError?.(err);
419
- throw transformedError;
420
- }
421
- }
422
- /**
423
- * Retrieves a member by ID.
424
- *
425
- * >**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).
426
- *
427
- * @param _id - Member ID.
428
- * @public
429
- * @requiredField _id
430
- * @param options - Fieldset options.
431
- * @permissionId MEMBERS.MEMBER_READ
432
- * @permissionScope Manage Members
433
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
434
- * @permissionScope Manage Bookings Services and Settings
435
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
436
- * @permissionScope Manage Events
437
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
438
- * @permissionScope Manage Challenges
439
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
440
- * @permissionScope Manage Portfolio
441
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
442
- * @permissionScope Access Verticals by Automations
443
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
444
- * @permissionScope Read Members and Contacts - all read permissions
445
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
446
- * @permissionScope Manage Restaurants - all permissions
447
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
448
- * @permissionScope Read Members
449
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
450
- * @permissionScope Set Up Automations
451
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
452
- * @permissionScope Manage Members and Contacts - all permissions
453
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
454
- * @applicableIdentity APP
455
- * @applicableIdentity VISITOR
456
- * @returns The requested member.
457
- * @fqn com.wixpress.members.api.Members.GetMember
458
- */
459
- export async function getMember(_id, options) {
460
- // @ts-ignore
461
- const { httpClient, sideEffects } = arguments[2];
462
- const payload = renameKeysFromSDKRequestToRESTRequest({
463
- id: _id,
464
- fieldsets: options?.fieldsets,
465
- });
466
- const reqOpts = ambassadorWixMembersV1Member.getMember(payload);
467
- sideEffects?.onSiteCall?.();
468
- try {
469
- const result = await httpClient.request(reqOpts);
470
- sideEffects?.onSuccess?.(result);
471
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
472
- }
473
- catch (err) {
474
- const transformedError = sdkTransformError(err, {
475
- spreadPathsToArguments: {},
476
- explicitPathsToArguments: { id: '$[0]', fieldsets: '$[1].fieldsets' },
477
- singleArgumentUnchanged: false,
478
- }, ['_id', 'options']);
479
- sideEffects?.onError?.(err);
480
- throw transformedError;
481
- }
482
- }
483
- /**
484
- * Lists site members, given the provided paging and fieldsets.
485
- * @public
486
- * @param options - Options for paging, sorting, and specifying fields to return.
487
- * @permissionId MEMBERS.MEMBER_READ
488
- * @permissionScope Manage Members
489
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
490
- * @permissionScope Manage Bookings Services and Settings
491
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
492
- * @permissionScope Manage Events
493
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
494
- * @permissionScope Manage Challenges
495
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
496
- * @permissionScope Manage Portfolio
497
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
498
- * @permissionScope Access Verticals by Automations
499
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
500
- * @permissionScope Read Members and Contacts - all read permissions
501
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
502
- * @permissionScope Manage Restaurants - all permissions
503
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
504
- * @permissionScope Read Members
505
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
506
- * @permissionScope Set Up Automations
507
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
508
- * @permissionScope Manage Members and Contacts - all permissions
509
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
510
- * @applicableIdentity APP
511
- * @applicableIdentity VISITOR
512
- * @fqn com.wixpress.members.api.Members.ListMembers
513
- */
514
- export async function listMembers(options) {
515
- // @ts-ignore
516
- const { httpClient, sideEffects } = arguments[1];
517
- const payload = renameKeysFromSDKRequestToRESTRequest({
518
- paging: options?.paging,
519
- fieldsets: options?.fieldsets,
520
- sorting: options?.sorting,
521
- });
522
- const reqOpts = ambassadorWixMembersV1Member.listMembers(payload);
523
- sideEffects?.onSiteCall?.();
524
- try {
525
- const result = await httpClient.request(reqOpts);
526
- sideEffects?.onSuccess?.(result);
527
- return renameKeysFromRESTResponseToSDKResponse(result.data);
528
- }
529
- catch (err) {
530
- const transformedError = sdkTransformError(err, {
531
- spreadPathsToArguments: {},
532
- explicitPathsToArguments: {
533
- paging: '$[0].paging',
534
- fieldsets: '$[0].fieldsets',
535
- sorting: '$[0].sorting',
536
- },
537
- singleArgumentUnchanged: false,
538
- }, ['options']);
539
- sideEffects?.onError?.(err);
540
- throw transformedError;
541
- }
542
- }
543
- /**
544
- * Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
545
- *
546
- * The returned object contains the query definition which is typically used to run the query using the `find()` method.
547
- *
548
- * 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.
549
- *
550
- * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
551
- * - `skip`: `0`
552
- * - `limit`: `50`
553
- *
554
- * Currently supported fields for sorting:
555
- * - `profile.nickname`
556
- * - `contact.firstName`
557
- * - `contact.lastName`
558
- * - `createdDate`
559
- * - `lastLoginDate`
560
- *
561
- * 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`.
562
- * @public
563
- * @param options - Query options.
564
- * @permissionScope Manage Members
565
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
566
- * @permissionScope Manage Bookings Services and Settings
567
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
568
- * @permissionScope Manage Events
569
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
570
- * @permissionScope Manage Challenges
571
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
572
- * @permissionScope Manage Portfolio
573
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
574
- * @permissionScope Access Verticals by Automations
575
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
576
- * @permissionScope Read Members and Contacts - all read permissions
577
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
578
- * @permissionScope Manage Restaurants - all permissions
579
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
580
- * @permissionScope Read Members
581
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
582
- * @permissionScope Set Up Automations
583
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
584
- * @permissionScope Manage Members and Contacts - all permissions
585
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
586
- * @permissionId MEMBERS.MEMBER_READ
587
- * @applicableIdentity APP
588
- * @applicableIdentity VISITOR
589
- * @fqn com.wixpress.members.api.Members.QueryMembers
590
- */
591
- export function queryMembers(options) {
592
- // @ts-ignore
593
- const { httpClient, sideEffects } = arguments[1];
594
- return queryBuilder({
595
- func: async (payload) => {
596
- const reqOpts = ambassadorWixMembersV1Member.queryMembers({
597
- ...payload,
598
- ...(options ?? {}),
599
- });
600
- sideEffects?.onSiteCall?.();
601
- try {
602
- const result = await httpClient.request(reqOpts);
603
- sideEffects?.onSuccess?.(result);
604
- return result;
605
- }
606
- catch (err) {
607
- sideEffects?.onError?.(err);
608
- throw err;
609
- }
610
- },
611
- requestTransformer: (query) => {
612
- const args = [query, options];
613
- return renameKeysFromSDKRequestToRESTRequest({
614
- ...args?.[1],
615
- query: args?.[0],
616
- });
617
- },
618
- responseTransformer: ({ data }) => {
619
- const transformedData = renameKeysFromRESTResponseToSDKResponse(data);
620
- return {
621
- items: transformedData?.members,
622
- pagingMetadata: transformedData?.metadata,
623
- };
624
- },
625
- errorTransformer: (err) => {
626
- const transformedError = sdkTransformError(err, {
627
- spreadPathsToArguments: {},
628
- explicitPathsToArguments: { query: '$[0]' },
629
- singleArgumentUnchanged: false,
630
- });
631
- throw transformedError;
632
- },
633
- pagingMethod: 'OFFSET',
634
- transformationPaths: {},
635
- });
636
- }
637
- /**
638
- * Mutes a member.
639
- *
640
- * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
641
- *
642
- * 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).
643
- * @param _id - ID of the member to mute.
644
- * @public
645
- * @requiredField _id
646
- * @permissionId MEMBERS.MEMBER_MUTE
647
- * @permissionScope Manage Members
648
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
649
- * @applicableIdentity APP
650
- * @fqn com.wixpress.members.api.Members.MuteMember
651
- */
652
- export async function muteMember(_id) {
653
- // @ts-ignore
654
- const { httpClient, sideEffects } = arguments[1];
655
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
656
- const reqOpts = ambassadorWixMembersV1Member.muteMember(payload);
657
- sideEffects?.onSiteCall?.();
658
- try {
659
- const result = await httpClient.request(reqOpts);
660
- sideEffects?.onSuccess?.(result);
661
- return renameKeysFromRESTResponseToSDKResponse(result.data);
662
- }
663
- catch (err) {
664
- const transformedError = sdkTransformError(err, {
665
- spreadPathsToArguments: {},
666
- explicitPathsToArguments: { id: '$[0]' },
667
- singleArgumentUnchanged: false,
668
- }, ['_id']);
669
- sideEffects?.onError?.(err);
670
- throw transformedError;
671
- }
672
- }
673
- /**
674
- * Unmutes a member.
675
- *
676
- * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
677
- *
678
- * 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).
679
- * @param _id - ID of the member to unmute.
680
- * @public
681
- * @requiredField _id
682
- * @permissionId MEMBERS.MEMBER_MUTE
683
- * @permissionScope Manage Members
684
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
685
- * @applicableIdentity APP
686
- * @fqn com.wixpress.members.api.Members.UnmuteMember
687
- */
688
- export async function unmuteMember(_id) {
689
- // @ts-ignore
690
- const { httpClient, sideEffects } = arguments[1];
691
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
692
- const reqOpts = ambassadorWixMembersV1Member.unmuteMember(payload);
693
- sideEffects?.onSiteCall?.();
694
- try {
695
- const result = await httpClient.request(reqOpts);
696
- sideEffects?.onSuccess?.(result);
697
- return renameKeysFromRESTResponseToSDKResponse(result.data);
698
- }
699
- catch (err) {
700
- const transformedError = sdkTransformError(err, {
701
- spreadPathsToArguments: {},
702
- explicitPathsToArguments: { id: '$[0]' },
703
- singleArgumentUnchanged: false,
704
- }, ['_id']);
705
- sideEffects?.onError?.(err);
706
- throw transformedError;
707
- }
708
- }
709
- /**
710
- * Changes member status to `"APPROVED"` and gives access to members-only pages.
711
- *
712
- * Call this API to:
713
- * - Approve a pending member.
714
- * - Unblock a blocked member.
715
- * @param _id - ID of the member to approve.
716
- * @public
717
- * @requiredField _id
718
- * @permissionId MEMBERS.MEMBER_APPROVE
719
- * @permissionScope Manage Members
720
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
721
- * @applicableIdentity APP
722
- * @fqn com.wixpress.members.api.Members.ApproveMember
723
- */
724
- export async function approveMember(_id) {
725
- // @ts-ignore
726
- const { httpClient, sideEffects } = arguments[1];
727
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
728
- const reqOpts = ambassadorWixMembersV1Member.approveMember(payload);
729
- sideEffects?.onSiteCall?.();
730
- try {
731
- const result = await httpClient.request(reqOpts);
732
- sideEffects?.onSuccess?.(result);
733
- return renameKeysFromRESTResponseToSDKResponse(result.data);
734
- }
735
- catch (err) {
736
- const transformedError = sdkTransformError(err, {
737
- spreadPathsToArguments: {},
738
- explicitPathsToArguments: { id: '$[0]' },
739
- singleArgumentUnchanged: false,
740
- }, ['_id']);
741
- sideEffects?.onError?.(err);
742
- throw transformedError;
743
- }
744
- }
745
- /**
746
- * Blocks a member.
747
- *
748
- * A blocked member can't log in to members-only pages.
749
- *
750
- * To unblock a member, call Approve Member.
751
- * @param _id - ID of a member to block.
752
- * @public
753
- * @requiredField _id
754
- * @permissionId MEMBERS.MEMBER_BLOCK
755
- * @permissionScope Manage Members
756
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
757
- * @applicableIdentity APP
758
- * @fqn com.wixpress.members.api.Members.BlockMember
759
- */
760
- export async function blockMember(_id) {
761
- // @ts-ignore
762
- const { httpClient, sideEffects } = arguments[1];
763
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
764
- const reqOpts = ambassadorWixMembersV1Member.blockMember(payload);
765
- sideEffects?.onSiteCall?.();
766
- try {
767
- const result = await httpClient.request(reqOpts);
768
- sideEffects?.onSuccess?.(result);
769
- return renameKeysFromRESTResponseToSDKResponse(result.data);
770
- }
771
- catch (err) {
772
- const transformedError = sdkTransformError(err, {
773
- spreadPathsToArguments: {},
774
- explicitPathsToArguments: { id: '$[0]' },
775
- singleArgumentUnchanged: false,
776
- }, ['_id']);
777
- sideEffects?.onError?.(err);
778
- throw transformedError;
779
- }
780
- }
781
- /**
782
- * Disconnects a member.
783
- *
784
- * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
785
- *
786
- * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
787
- * @param _id - ID of a member to disconnect.
788
- * @public
789
- * @requiredField _id
790
- * @permissionId MEMBERS.MEMBER_DISCONNECT
791
- * @permissionScope Manage Members
792
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
793
- * @permissionScope Manage Challenges
794
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
795
- * @applicableIdentity APP
796
- * @fqn com.wixpress.members.api.Members.DisconnectMember
797
- */
798
- export async function disconnectMember(_id) {
799
- // @ts-ignore
800
- const { httpClient, sideEffects } = arguments[1];
801
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
802
- const reqOpts = ambassadorWixMembersV1Member.disconnectMember(payload);
803
- sideEffects?.onSiteCall?.();
804
- try {
805
- const result = await httpClient.request(reqOpts);
806
- sideEffects?.onSuccess?.(result);
807
- return renameKeysFromRESTResponseToSDKResponse(result.data);
808
- }
809
- catch (err) {
810
- const transformedError = sdkTransformError(err, {
811
- spreadPathsToArguments: {},
812
- explicitPathsToArguments: { id: '$[0]' },
813
- singleArgumentUnchanged: false,
814
- }, ['_id']);
815
- sideEffects?.onError?.(err);
816
- throw transformedError;
817
- }
818
- }
819
- /**
820
- * Deletes a member by ID.
821
- *
822
- * 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.
823
- * @param _id - ID of a member to delete.
824
- * @public
825
- * @requiredField _id
826
- * @permissionId MEMBERS.MEMBER_DELETE
827
- * @permissionScope Manage Members
828
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
829
- * @applicableIdentity APP
830
- * @fqn com.wixpress.members.api.Members.DeleteMember
831
- */
832
- export async function deleteMember(_id) {
833
- // @ts-ignore
834
- const { httpClient, sideEffects } = arguments[1];
835
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
836
- const reqOpts = ambassadorWixMembersV1Member.deleteMember(payload);
837
- sideEffects?.onSiteCall?.();
838
- try {
839
- const result = await httpClient.request(reqOpts);
840
- sideEffects?.onSuccess?.(result);
841
- }
842
- catch (err) {
843
- const transformedError = sdkTransformError(err, {
844
- spreadPathsToArguments: {},
845
- explicitPathsToArguments: { id: '$[0]' },
846
- singleArgumentUnchanged: false,
847
- }, ['_id']);
848
- sideEffects?.onError?.(err);
849
- throw transformedError;
850
- }
851
- }
852
- /**
853
- * Deletes the current member.
854
- *
855
- * After calling this method, the member is logged out of the site.
856
- *
857
- * 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.
858
- *
859
- * >**Note:**
860
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
861
- * @public
862
- * @permissionId MEMBERS.MEMBER_DELETE
863
- * @permissionScope Manage Members
864
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
865
- * @applicableIdentity APP
866
- * @fqn com.wixpress.members.api.Members.DeleteMyMember
867
- */
868
- export async function deleteMyMember(options) {
869
- // @ts-ignore
870
- const { httpClient, sideEffects } = arguments[1];
871
- const payload = renameKeysFromSDKRequestToRESTRequest({
872
- contentAssigneeId: options?.contentAssigneeId,
873
- });
874
- const reqOpts = ambassadorWixMembersV1Member.deleteMyMember(payload);
875
- sideEffects?.onSiteCall?.();
876
- try {
877
- const result = await httpClient.request(reqOpts);
878
- sideEffects?.onSuccess?.(result);
879
- }
880
- catch (err) {
881
- const transformedError = sdkTransformError(err, {
882
- spreadPathsToArguments: {},
883
- explicitPathsToArguments: {
884
- contentAssigneeId: '$[0].contentAssigneeId',
885
- },
886
- singleArgumentUnchanged: false,
887
- }, ['options']);
888
- sideEffects?.onError?.(err);
889
- throw transformedError;
890
- }
891
- }
892
- /**
893
- * Deletes multiple members by `memberId`.
894
- *
895
- * 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.
896
- * @param memberIds - IDs of members to be deleted.
897
- * @public
898
- * @requiredField memberIds
899
- * @permissionId MEMBERS.MEMBER_DELETE
900
- * @permissionScope Manage Members
901
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
902
- * @applicableIdentity APP
903
- * @fqn com.wixpress.members.api.Members.BulkDeleteMembers
904
- */
905
- export async function bulkDeleteMembers(memberIds) {
906
- // @ts-ignore
907
- const { httpClient, sideEffects } = arguments[1];
908
- const payload = renameKeysFromSDKRequestToRESTRequest({
909
- memberIds: memberIds,
910
- });
911
- const reqOpts = ambassadorWixMembersV1Member.bulkDeleteMembers(payload);
912
- sideEffects?.onSiteCall?.();
913
- try {
914
- const result = await httpClient.request(reqOpts);
915
- sideEffects?.onSuccess?.(result);
916
- return renameKeysFromRESTResponseToSDKResponse(result.data);
917
- }
918
- catch (err) {
919
- const transformedError = sdkTransformError(err, {
920
- spreadPathsToArguments: {},
921
- explicitPathsToArguments: { memberIds: '$[0]' },
922
- singleArgumentUnchanged: false,
923
- }, ['memberIds']);
924
- sideEffects?.onError?.(err);
925
- throw transformedError;
926
- }
927
- }
928
- /**
929
- * Deletes multiple members by the specified filter.
930
- *
931
- * 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.
932
- * @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.
933
- * @public
934
- * @requiredField filter
935
- * @permissionId MEMBERS.MEMBER_DELETE
936
- * @permissionScope Manage Members
937
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
938
- * @applicableIdentity APP
939
- * @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
940
- */
941
- export async function bulkDeleteMembersByFilter(filter, options) {
942
- // @ts-ignore
943
- const { httpClient, sideEffects } = arguments[2];
944
- const payload = renameKeysFromSDKRequestToRESTRequest({
945
- filter: filter,
946
- contentAssigneeId: options?.contentAssigneeId,
947
- search: options?.search,
948
- });
949
- const reqOpts = ambassadorWixMembersV1Member.bulkDeleteMembersByFilter(payload);
950
- sideEffects?.onSiteCall?.();
951
- try {
952
- const result = await httpClient.request(reqOpts);
953
- sideEffects?.onSuccess?.(result);
954
- return renameKeysFromRESTResponseToSDKResponse(result.data);
955
- }
956
- catch (err) {
957
- const transformedError = sdkTransformError(err, {
958
- spreadPathsToArguments: {},
959
- explicitPathsToArguments: {
960
- filter: '$[0]',
961
- contentAssigneeId: '$[1].contentAssigneeId',
962
- search: '$[1].search',
963
- },
964
- singleArgumentUnchanged: false,
965
- }, ['filter', 'options']);
966
- sideEffects?.onError?.(err);
967
- throw transformedError;
968
- }
969
- }
970
- /**
971
- * Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
972
- *
973
- * Call this API to:
974
- * - Approve pending members.
975
- * - Unblock blocked members.
976
- * @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.
977
- * @public
978
- * @requiredField filter
979
- * @permissionId MEMBERS.MEMBER_APPROVE
980
- * @permissionScope Manage Members
981
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
982
- * @applicableIdentity APP
983
- * @fqn com.wixpress.members.api.Members.BulkApproveMembers
984
- */
985
- export async function bulkApproveMembers(filter) {
986
- // @ts-ignore
987
- const { httpClient, sideEffects } = arguments[1];
988
- const payload = renameKeysFromSDKRequestToRESTRequest({ filter: filter });
989
- const reqOpts = ambassadorWixMembersV1Member.bulkApproveMembers(payload);
990
- sideEffects?.onSiteCall?.();
991
- try {
992
- const result = await httpClient.request(reqOpts);
993
- sideEffects?.onSuccess?.(result);
994
- return renameKeysFromRESTResponseToSDKResponse(result.data);
995
- }
996
- catch (err) {
997
- const transformedError = sdkTransformError(err, {
998
- spreadPathsToArguments: {},
999
- explicitPathsToArguments: { filter: '$[0]' },
1000
- singleArgumentUnchanged: false,
1001
- }, ['filter']);
1002
- sideEffects?.onError?.(err);
1003
- throw transformedError;
1004
- }
1005
- }
1006
- /**
1007
- * Blocks multiple members by a specified filter.
1008
- *
1009
- * Blocked members can't log in to members-only pages.
1010
- *
1011
- * To unblock multiple members, call Bulk Approve Members.
1012
- * @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.
1013
- * @public
1014
- * @requiredField filter
1015
- * @permissionId MEMBERS.MEMBER_BLOCK
1016
- * @permissionScope Manage Members
1017
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1018
- * @applicableIdentity APP
1019
- * @fqn com.wixpress.members.api.Members.BulkBlockMembers
1020
- */
1021
- export async function bulkBlockMembers(filter) {
1022
- // @ts-ignore
1023
- const { httpClient, sideEffects } = arguments[1];
1024
- const payload = renameKeysFromSDKRequestToRESTRequest({ filter: filter });
1025
- const reqOpts = ambassadorWixMembersV1Member.bulkBlockMembers(payload);
1026
- sideEffects?.onSiteCall?.();
1027
- try {
1028
- const result = await httpClient.request(reqOpts);
1029
- sideEffects?.onSuccess?.(result);
1030
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1031
- }
1032
- catch (err) {
1033
- const transformedError = sdkTransformError(err, {
1034
- spreadPathsToArguments: {},
1035
- explicitPathsToArguments: { filter: '$[0]' },
1036
- singleArgumentUnchanged: false,
1037
- }, ['filter']);
1038
- sideEffects?.onError?.(err);
1039
- throw transformedError;
1040
- }
1041
- }
1042
- /**
1043
- * Creates a site member.
1044
- *
1045
- * After creation, you can call
1046
- * [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))
1047
- * to email the member with a link to set their password.
1048
- * The member can log in to the site
1049
- * when they set their password for the first time.
1050
- *
1051
- * > **Note:**
1052
- * > When creating multiple members,
1053
- * > set your requests at least 1 second apart to keep below rate limits.
1054
- * @public
1055
- * @permissionId MEMBERS.MEMBER_CREATE
1056
- * @permissionScope Manage Members
1057
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1058
- * @permissionScope Manage Challenges
1059
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1060
- * @applicableIdentity APP
1061
- * @returns New member.
1062
- * @fqn com.wixpress.members.api.Members.CreateMember
1063
- */
1064
- export async function createMember(options) {
1065
- // @ts-ignore
1066
- const { httpClient, sideEffects } = arguments[1];
1067
- const payload = renameKeysFromSDKRequestToRESTRequest({
1068
- member: options?.member,
1069
- });
1070
- const reqOpts = ambassadorWixMembersV1Member.createMember(payload);
1071
- sideEffects?.onSiteCall?.();
1072
- try {
1073
- const result = await httpClient.request(reqOpts);
1074
- sideEffects?.onSuccess?.(result);
1075
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
1076
- }
1077
- catch (err) {
1078
- const transformedError = sdkTransformError(err, {
1079
- spreadPathsToArguments: {},
1080
- explicitPathsToArguments: { member: '$[0].member' },
1081
- singleArgumentUnchanged: false,
1082
- }, ['options']);
1083
- sideEffects?.onError?.(err);
1084
- throw transformedError;
1085
- }
1086
- }
1087
- /**
1088
- * Updates a member's properties.
1089
- *
1090
- * Only the requested fields are updated.
1091
- * To clear a field's value, set an empty value with an empty string `""`.
1092
- *
1093
- * > **Note:**
1094
- * > 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.
1095
- * > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
1096
- * >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
1097
- * >- To clear `contact.emails`, use `deleteMemberEmails()`.
1098
- * >- To clear `contact.phones`, use `deleteMemberPhones()`.
1099
- *
1100
- * > **Note:**
1101
- * > Only logged-in members can call this method without elevated permissions.
1102
- * > 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.
1103
- * @param _id - Member ID.
1104
- * @public
1105
- * @requiredField _id
1106
- * @requiredField member
1107
- * @param options - Member to update.
1108
- * @permissionId MEMBERS.MEMBER_UPDATE
1109
- * @permissionScope Manage Members
1110
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1111
- * @permissionScope Manage Bookings Services and Settings
1112
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1113
- * @permissionScope Manage Events
1114
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1115
- * @permissionScope Manage Challenges
1116
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1117
- * @permissionScope Manage Portfolio
1118
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1119
- * @permissionScope Access Verticals by Automations
1120
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1121
- * @permissionScope Manage Restaurants - all permissions
1122
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1123
- * @permissionScope Set Up Automations
1124
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1125
- * @applicableIdentity APP
1126
- * @applicableIdentity MEMBER
1127
- * @returns Updated member.
1128
- * @fqn com.wixpress.members.api.Members.UpdateMember
1129
- */
1130
- export async function updateMember(_id, member) {
1131
- // @ts-ignore
1132
- const { httpClient, sideEffects } = arguments[2];
1133
- const payload = renameKeysFromSDKRequestToRESTRequest({
1134
- member: { ...member, id: _id },
1135
- });
1136
- const reqOpts = ambassadorWixMembersV1Member.updateMember(payload);
1137
- sideEffects?.onSiteCall?.();
1138
- try {
1139
- const result = await httpClient.request(reqOpts);
1140
- sideEffects?.onSuccess?.(result);
1141
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
1142
- }
1143
- catch (err) {
1144
- const transformedError = sdkTransformError(err, {
1145
- spreadPathsToArguments: { member: '$[1]' },
1146
- explicitPathsToArguments: { 'member.id': '$[0]' },
1147
- singleArgumentUnchanged: false,
1148
- }, ['_id', 'member']);
1149
- sideEffects?.onError?.(err);
1150
- throw transformedError;
1151
- }
1152
- }
1153
- /**
1154
- * Clears a member's phone numbers.
1155
- *
1156
- * `deleteMemberPhones()` clears the `phones` array under the `contact` property.
1157
- *
1158
- * > **Note:**
1159
- * > Only logged-in members can call this method without elevated permissions.
1160
- * > 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.
1161
- * @param _id - ID of the member whose phone numbers will be deleted.
1162
- * @public
1163
- * @requiredField _id
1164
- * @permissionId MEMBERS.MEMBER_UPDATE
1165
- * @permissionScope Manage Members
1166
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1167
- * @permissionScope Manage Bookings Services and Settings
1168
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1169
- * @permissionScope Manage Events
1170
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1171
- * @permissionScope Manage Challenges
1172
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1173
- * @permissionScope Manage Portfolio
1174
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1175
- * @permissionScope Access Verticals by Automations
1176
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1177
- * @permissionScope Manage Restaurants - all permissions
1178
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1179
- * @permissionScope Set Up Automations
1180
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1181
- * @applicableIdentity APP
1182
- * @applicableIdentity MEMBER
1183
- * @fqn com.wixpress.members.api.Members.DeleteMemberPhones
1184
- */
1185
- export async function deleteMemberPhones(_id) {
1186
- // @ts-ignore
1187
- const { httpClient, sideEffects } = arguments[1];
1188
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1189
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberPhones(payload);
1190
- sideEffects?.onSiteCall?.();
1191
- try {
1192
- const result = await httpClient.request(reqOpts);
1193
- sideEffects?.onSuccess?.(result);
1194
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1195
- }
1196
- catch (err) {
1197
- const transformedError = sdkTransformError(err, {
1198
- spreadPathsToArguments: {},
1199
- explicitPathsToArguments: { id: '$[0]' },
1200
- singleArgumentUnchanged: false,
1201
- }, ['_id']);
1202
- sideEffects?.onError?.(err);
1203
- throw transformedError;
1204
- }
1205
- }
1206
- /**
1207
- * Clears a member's email addresses.
1208
- *
1209
- * `deleteMemberEmails()` clears the `emails` array under the `contact` property.
1210
- *
1211
- * > **Notes:**
1212
- * > A member can still log in with their `loginEmail`,
1213
- * > which is not cleared when this method is called.
1214
- *
1215
- * > Only logged-in members can call this method without elevated permissions.
1216
- * > 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.
1217
- * @param _id - ID of the member whose email addresses will be deleted.
1218
- * @public
1219
- * @requiredField _id
1220
- * @permissionId MEMBERS.MEMBER_UPDATE
1221
- * @permissionScope Manage Members
1222
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1223
- * @permissionScope Manage Bookings Services and Settings
1224
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1225
- * @permissionScope Manage Events
1226
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1227
- * @permissionScope Manage Challenges
1228
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1229
- * @permissionScope Manage Portfolio
1230
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1231
- * @permissionScope Access Verticals by Automations
1232
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1233
- * @permissionScope Manage Restaurants - all permissions
1234
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1235
- * @permissionScope Set Up Automations
1236
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1237
- * @applicableIdentity APP
1238
- * @applicableIdentity MEMBER
1239
- * @fqn com.wixpress.members.api.Members.DeleteMemberEmails
1240
- */
1241
- export async function deleteMemberEmails(_id) {
1242
- // @ts-ignore
1243
- const { httpClient, sideEffects } = arguments[1];
1244
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1245
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberEmails(payload);
1246
- sideEffects?.onSiteCall?.();
1247
- try {
1248
- const result = await httpClient.request(reqOpts);
1249
- sideEffects?.onSuccess?.(result);
1250
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1251
- }
1252
- catch (err) {
1253
- const transformedError = sdkTransformError(err, {
1254
- spreadPathsToArguments: {},
1255
- explicitPathsToArguments: { id: '$[0]' },
1256
- singleArgumentUnchanged: false,
1257
- }, ['_id']);
1258
- sideEffects?.onError?.(err);
1259
- throw transformedError;
1260
- }
1261
- }
1262
- /**
1263
- * Deletes a member's street addresses.
1264
- *
1265
- * `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
1266
- *
1267
- * > **Note:**
1268
- * > Only logged-in members can call this method without elevated permissions.
1269
- * > 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.
1270
- * @param _id - ID of the member whose street addresses will be deleted.
1271
- * @public
1272
- * @requiredField _id
1273
- * @permissionId MEMBERS.MEMBER_UPDATE
1274
- * @permissionScope Manage Members
1275
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1276
- * @permissionScope Manage Bookings Services and Settings
1277
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1278
- * @permissionScope Manage Events
1279
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1280
- * @permissionScope Manage Challenges
1281
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1282
- * @permissionScope Manage Portfolio
1283
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1284
- * @permissionScope Access Verticals by Automations
1285
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1286
- * @permissionScope Manage Restaurants - all permissions
1287
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1288
- * @permissionScope Set Up Automations
1289
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1290
- * @applicableIdentity APP
1291
- * @applicableIdentity MEMBER
1292
- * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
1293
- */
1294
- export async function deleteMemberAddresses(_id) {
1295
- // @ts-ignore
1296
- const { httpClient, sideEffects } = arguments[1];
1297
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1298
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberAddresses(payload);
1299
- sideEffects?.onSiteCall?.();
1300
- try {
1301
- const result = await httpClient.request(reqOpts);
1302
- sideEffects?.onSuccess?.(result);
1303
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1304
- }
1305
- catch (err) {
1306
- const transformedError = sdkTransformError(err, {
1307
- spreadPathsToArguments: {},
1308
- explicitPathsToArguments: { id: '$[0]' },
1309
- singleArgumentUnchanged: false,
1310
- }, ['_id']);
1311
- sideEffects?.onError?.(err);
1312
- throw transformedError;
1313
- }
1314
- }
1315
- //# sourceMappingURL=members-v1-member-members.universal.js.map