@wix/auto_sdk_members_members 1.0.51 → 1.0.53

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 (130) hide show
  1. package/build/{es/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/internal/{cjs/src/members-v1-member-members.public.d.ts → 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 -2432
  53. package/build/cjs/src/members-v1-member-members.universal.js +0 -1373
  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/package.json +0 -3
  65. package/build/es/src/members-v1-member-members.context.d.ts +0 -46
  66. package/build/es/src/members-v1-member-members.context.js +0 -46
  67. package/build/es/src/members-v1-member-members.context.js.map +0 -1
  68. package/build/es/src/members-v1-member-members.http.d.ts +0 -229
  69. package/build/es/src/members-v1-member-members.http.js +0 -932
  70. package/build/es/src/members-v1-member-members.http.js.map +0 -1
  71. package/build/es/src/members-v1-member-members.meta.d.ts +0 -60
  72. package/build/es/src/members-v1-member-members.meta.js +0 -434
  73. package/build/es/src/members-v1-member-members.meta.js.map +0 -1
  74. package/build/es/src/members-v1-member-members.public.js +0 -161
  75. package/build/es/src/members-v1-member-members.public.js.map +0 -1
  76. package/build/es/src/members-v1-member-members.types.js +0 -171
  77. package/build/es/src/members-v1-member-members.types.js.map +0 -1
  78. package/build/es/src/members-v1-member-members.universal.d.ts +0 -2432
  79. package/build/es/src/members-v1-member-members.universal.js +0 -1323
  80. package/build/es/src/members-v1-member-members.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/members-v1-member-members.context.d.ts +0 -46
  91. package/build/internal/cjs/src/members-v1-member-members.context.js +0 -59
  92. package/build/internal/cjs/src/members-v1-member-members.context.js.map +0 -1
  93. package/build/internal/cjs/src/members-v1-member-members.http.d.ts +0 -229
  94. package/build/internal/cjs/src/members-v1-member-members.http.js +0 -959
  95. package/build/internal/cjs/src/members-v1-member-members.http.js.map +0 -1
  96. package/build/internal/cjs/src/members-v1-member-members.meta.d.ts +0 -60
  97. package/build/internal/cjs/src/members-v1-member-members.meta.js +0 -484
  98. package/build/internal/cjs/src/members-v1-member-members.meta.js.map +0 -1
  99. package/build/internal/cjs/src/members-v1-member-members.public.js +0 -198
  100. package/build/internal/cjs/src/members-v1-member-members.public.js.map +0 -1
  101. package/build/internal/cjs/src/members-v1-member-members.types.js +0 -174
  102. package/build/internal/cjs/src/members-v1-member-members.types.js.map +0 -1
  103. package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +0 -2432
  104. package/build/internal/cjs/src/members-v1-member-members.universal.js +0 -1373
  105. package/build/internal/cjs/src/members-v1-member-members.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/members-v1-member-members.context.d.ts +0 -46
  116. package/build/internal/es/src/members-v1-member-members.context.js +0 -46
  117. package/build/internal/es/src/members-v1-member-members.context.js.map +0 -1
  118. package/build/internal/es/src/members-v1-member-members.http.d.ts +0 -229
  119. package/build/internal/es/src/members-v1-member-members.http.js +0 -932
  120. package/build/internal/es/src/members-v1-member-members.http.js.map +0 -1
  121. package/build/internal/es/src/members-v1-member-members.meta.d.ts +0 -60
  122. package/build/internal/es/src/members-v1-member-members.meta.js +0 -434
  123. package/build/internal/es/src/members-v1-member-members.meta.js.map +0 -1
  124. package/build/internal/es/src/members-v1-member-members.public.js +0 -161
  125. package/build/internal/es/src/members-v1-member-members.public.js.map +0 -1
  126. package/build/internal/es/src/members-v1-member-members.types.js +0 -171
  127. package/build/internal/es/src/members-v1-member-members.types.js.map +0 -1
  128. package/build/internal/es/src/members-v1-member-members.universal.d.ts +0 -2432
  129. package/build/internal/es/src/members-v1-member-members.universal.js +0 -1323
  130. package/build/internal/es/src/members-v1-member-members.universal.js.map +0 -1
@@ -1,1323 +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 Picasso private app mega scope
393
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
394
- * @permissionScope Manage Members and Contacts - all permissions
395
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
396
- * @applicableIdentity APP
397
- * @applicableIdentity VISITOR
398
- * @returns Member profile.
399
- * @fqn com.wixpress.members.api.Members.GetMyMember
400
- */
401
- export async function getCurrentMember(options) {
402
- // @ts-ignore
403
- const { httpClient, sideEffects } = arguments[1];
404
- const payload = renameKeysFromSDKRequestToRESTRequest({
405
- fieldsets: options?.fieldsets,
406
- });
407
- const reqOpts = ambassadorWixMembersV1Member.getMyMember(payload);
408
- sideEffects?.onSiteCall?.();
409
- try {
410
- const result = await httpClient.request(reqOpts);
411
- sideEffects?.onSuccess?.(result);
412
- return renameKeysFromRESTResponseToSDKResponse(result.data);
413
- }
414
- catch (err) {
415
- const transformedError = sdkTransformError(err, {
416
- spreadPathsToArguments: {},
417
- explicitPathsToArguments: { fieldsets: '$[0].fieldsets' },
418
- singleArgumentUnchanged: false,
419
- }, ['options']);
420
- sideEffects?.onError?.(err);
421
- throw transformedError;
422
- }
423
- }
424
- /**
425
- * Retrieves a member by ID.
426
- *
427
- * >**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).
428
- *
429
- * @param _id - Member ID.
430
- * @public
431
- * @requiredField _id
432
- * @param options - Fieldset options.
433
- * @permissionId MEMBERS.MEMBER_READ
434
- * @permissionScope Manage Members
435
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
436
- * @permissionScope Manage Bookings Services and Settings
437
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
438
- * @permissionScope Manage Events
439
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
440
- * @permissionScope Manage Challenges
441
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
442
- * @permissionScope Manage Portfolio
443
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
444
- * @permissionScope Access Verticals by Automations
445
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
446
- * @permissionScope Read Members and Contacts - all read permissions
447
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
448
- * @permissionScope Manage Restaurants - all permissions
449
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
450
- * @permissionScope Read Members
451
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
452
- * @permissionScope Set Up Automations
453
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
454
- * @permissionScope Picasso private app mega scope
455
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
456
- * @permissionScope Manage Members and Contacts - all permissions
457
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
458
- * @applicableIdentity APP
459
- * @applicableIdentity VISITOR
460
- * @returns The requested member.
461
- * @fqn com.wixpress.members.api.Members.GetMember
462
- */
463
- export async function getMember(_id, options) {
464
- // @ts-ignore
465
- const { httpClient, sideEffects } = arguments[2];
466
- const payload = renameKeysFromSDKRequestToRESTRequest({
467
- id: _id,
468
- fieldsets: options?.fieldsets,
469
- });
470
- const reqOpts = ambassadorWixMembersV1Member.getMember(payload);
471
- sideEffects?.onSiteCall?.();
472
- try {
473
- const result = await httpClient.request(reqOpts);
474
- sideEffects?.onSuccess?.(result);
475
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
476
- }
477
- catch (err) {
478
- const transformedError = sdkTransformError(err, {
479
- spreadPathsToArguments: {},
480
- explicitPathsToArguments: { id: '$[0]', fieldsets: '$[1].fieldsets' },
481
- singleArgumentUnchanged: false,
482
- }, ['_id', 'options']);
483
- sideEffects?.onError?.(err);
484
- throw transformedError;
485
- }
486
- }
487
- /**
488
- * Lists site members, given the provided paging and fieldsets.
489
- * @public
490
- * @param options - Options for paging, sorting, and specifying fields to return.
491
- * @permissionId MEMBERS.MEMBER_READ
492
- * @permissionScope Manage Members
493
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
494
- * @permissionScope Manage Bookings Services and Settings
495
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
496
- * @permissionScope Manage Events
497
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
498
- * @permissionScope Manage Challenges
499
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
500
- * @permissionScope Manage Portfolio
501
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
502
- * @permissionScope Access Verticals by Automations
503
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
504
- * @permissionScope Read Members and Contacts - all read permissions
505
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
506
- * @permissionScope Manage Restaurants - all permissions
507
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
508
- * @permissionScope Read Members
509
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
510
- * @permissionScope Set Up Automations
511
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
512
- * @permissionScope Picasso private app mega scope
513
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
514
- * @permissionScope Manage Members and Contacts - all permissions
515
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
516
- * @applicableIdentity APP
517
- * @applicableIdentity VISITOR
518
- * @fqn com.wixpress.members.api.Members.ListMembers
519
- */
520
- export async function listMembers(options) {
521
- // @ts-ignore
522
- const { httpClient, sideEffects } = arguments[1];
523
- const payload = renameKeysFromSDKRequestToRESTRequest({
524
- paging: options?.paging,
525
- fieldsets: options?.fieldsets,
526
- sorting: options?.sorting,
527
- });
528
- const reqOpts = ambassadorWixMembersV1Member.listMembers(payload);
529
- sideEffects?.onSiteCall?.();
530
- try {
531
- const result = await httpClient.request(reqOpts);
532
- sideEffects?.onSuccess?.(result);
533
- return renameKeysFromRESTResponseToSDKResponse(result.data);
534
- }
535
- catch (err) {
536
- const transformedError = sdkTransformError(err, {
537
- spreadPathsToArguments: {},
538
- explicitPathsToArguments: {
539
- paging: '$[0].paging',
540
- fieldsets: '$[0].fieldsets',
541
- sorting: '$[0].sorting',
542
- },
543
- singleArgumentUnchanged: false,
544
- }, ['options']);
545
- sideEffects?.onError?.(err);
546
- throw transformedError;
547
- }
548
- }
549
- /**
550
- * Retrieves a list of up to 100 members, given the specified filters, fieldsets, sorting and paging, and returns a `MembersQueryBuilder` object.
551
- *
552
- * The returned object contains the query definition which is typically used to run the query using the `find()` method.
553
- *
554
- * 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.
555
- *
556
- * `queryMembers()` runs with the following `MembersQueryBuilder` defaults that you can override:
557
- * - `skip`: `0`
558
- * - `limit`: `50`
559
- *
560
- * Currently supported fields for sorting:
561
- * - `profile.nickname`
562
- * - `contact.firstName`
563
- * - `contact.lastName`
564
- * - `createdDate`
565
- * - `lastLoginDate`
566
- *
567
- * 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`.
568
- * @public
569
- * @param options - Query options.
570
- * @permissionScope Manage Members
571
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
572
- * @permissionScope Manage Bookings Services and Settings
573
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
574
- * @permissionScope Manage Events
575
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
576
- * @permissionScope Manage Challenges
577
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
578
- * @permissionScope Manage Portfolio
579
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
580
- * @permissionScope Access Verticals by Automations
581
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
582
- * @permissionScope Read Members and Contacts - all read permissions
583
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
584
- * @permissionScope Manage Restaurants - all permissions
585
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
586
- * @permissionScope Read Members
587
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
588
- * @permissionScope Set Up Automations
589
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
590
- * @permissionScope Picasso private app mega scope
591
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
592
- * @permissionScope Manage Members and Contacts - all permissions
593
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
594
- * @permissionId MEMBERS.MEMBER_READ
595
- * @applicableIdentity APP
596
- * @applicableIdentity VISITOR
597
- * @fqn com.wixpress.members.api.Members.QueryMembers
598
- */
599
- export function queryMembers(options) {
600
- // @ts-ignore
601
- const { httpClient, sideEffects } = arguments[1];
602
- return queryBuilder({
603
- func: async (payload) => {
604
- const reqOpts = ambassadorWixMembersV1Member.queryMembers({
605
- ...payload,
606
- ...(options ?? {}),
607
- });
608
- sideEffects?.onSiteCall?.();
609
- try {
610
- const result = await httpClient.request(reqOpts);
611
- sideEffects?.onSuccess?.(result);
612
- return result;
613
- }
614
- catch (err) {
615
- sideEffects?.onError?.(err);
616
- throw err;
617
- }
618
- },
619
- requestTransformer: (query) => {
620
- const args = [query, options];
621
- return renameKeysFromSDKRequestToRESTRequest({
622
- ...args?.[1],
623
- query: args?.[0],
624
- });
625
- },
626
- responseTransformer: ({ data }) => {
627
- const transformedData = renameKeysFromRESTResponseToSDKResponse(data);
628
- return {
629
- items: transformedData?.members,
630
- pagingMetadata: transformedData?.metadata,
631
- };
632
- },
633
- errorTransformer: (err) => {
634
- const transformedError = sdkTransformError(err, {
635
- spreadPathsToArguments: {},
636
- explicitPathsToArguments: { query: '$[0]' },
637
- singleArgumentUnchanged: false,
638
- });
639
- throw transformedError;
640
- },
641
- pagingMethod: 'OFFSET',
642
- transformationPaths: {},
643
- });
644
- }
645
- /**
646
- * Mutes a member.
647
- *
648
- * Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
649
- *
650
- * 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).
651
- * @param _id - ID of the member to mute.
652
- * @public
653
- * @requiredField _id
654
- * @permissionId MEMBERS.MEMBER_MUTE
655
- * @permissionScope Manage Members
656
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
657
- * @applicableIdentity APP
658
- * @fqn com.wixpress.members.api.Members.MuteMember
659
- */
660
- export async function muteMember(_id) {
661
- // @ts-ignore
662
- const { httpClient, sideEffects } = arguments[1];
663
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
664
- const reqOpts = ambassadorWixMembersV1Member.muteMember(payload);
665
- sideEffects?.onSiteCall?.();
666
- try {
667
- const result = await httpClient.request(reqOpts);
668
- sideEffects?.onSuccess?.(result);
669
- return renameKeysFromRESTResponseToSDKResponse(result.data);
670
- }
671
- catch (err) {
672
- const transformedError = sdkTransformError(err, {
673
- spreadPathsToArguments: {},
674
- explicitPathsToArguments: { id: '$[0]' },
675
- singleArgumentUnchanged: false,
676
- }, ['_id']);
677
- sideEffects?.onError?.(err);
678
- throw transformedError;
679
- }
680
- }
681
- /**
682
- * Unmutes a member.
683
- *
684
- * Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
685
- *
686
- * 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).
687
- * @param _id - ID of the member to unmute.
688
- * @public
689
- * @requiredField _id
690
- * @permissionId MEMBERS.MEMBER_MUTE
691
- * @permissionScope Manage Members
692
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
693
- * @applicableIdentity APP
694
- * @fqn com.wixpress.members.api.Members.UnmuteMember
695
- */
696
- export async function unmuteMember(_id) {
697
- // @ts-ignore
698
- const { httpClient, sideEffects } = arguments[1];
699
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
700
- const reqOpts = ambassadorWixMembersV1Member.unmuteMember(payload);
701
- sideEffects?.onSiteCall?.();
702
- try {
703
- const result = await httpClient.request(reqOpts);
704
- sideEffects?.onSuccess?.(result);
705
- return renameKeysFromRESTResponseToSDKResponse(result.data);
706
- }
707
- catch (err) {
708
- const transformedError = sdkTransformError(err, {
709
- spreadPathsToArguments: {},
710
- explicitPathsToArguments: { id: '$[0]' },
711
- singleArgumentUnchanged: false,
712
- }, ['_id']);
713
- sideEffects?.onError?.(err);
714
- throw transformedError;
715
- }
716
- }
717
- /**
718
- * Changes member status to `"APPROVED"` and gives access to members-only pages.
719
- *
720
- * Call this API to:
721
- * - Approve a pending member.
722
- * - Unblock a blocked member.
723
- * @param _id - ID of the member to approve.
724
- * @public
725
- * @requiredField _id
726
- * @permissionId MEMBERS.MEMBER_APPROVE
727
- * @permissionScope Manage Members
728
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
729
- * @applicableIdentity APP
730
- * @fqn com.wixpress.members.api.Members.ApproveMember
731
- */
732
- export async function approveMember(_id) {
733
- // @ts-ignore
734
- const { httpClient, sideEffects } = arguments[1];
735
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
736
- const reqOpts = ambassadorWixMembersV1Member.approveMember(payload);
737
- sideEffects?.onSiteCall?.();
738
- try {
739
- const result = await httpClient.request(reqOpts);
740
- sideEffects?.onSuccess?.(result);
741
- return renameKeysFromRESTResponseToSDKResponse(result.data);
742
- }
743
- catch (err) {
744
- const transformedError = sdkTransformError(err, {
745
- spreadPathsToArguments: {},
746
- explicitPathsToArguments: { id: '$[0]' },
747
- singleArgumentUnchanged: false,
748
- }, ['_id']);
749
- sideEffects?.onError?.(err);
750
- throw transformedError;
751
- }
752
- }
753
- /**
754
- * Blocks a member.
755
- *
756
- * A blocked member can't log in to members-only pages.
757
- *
758
- * To unblock a member, call Approve Member.
759
- * @param _id - ID of a member to block.
760
- * @public
761
- * @requiredField _id
762
- * @permissionId MEMBERS.MEMBER_BLOCK
763
- * @permissionScope Manage Members
764
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
765
- * @applicableIdentity APP
766
- * @fqn com.wixpress.members.api.Members.BlockMember
767
- */
768
- export async function blockMember(_id) {
769
- // @ts-ignore
770
- const { httpClient, sideEffects } = arguments[1];
771
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
772
- const reqOpts = ambassadorWixMembersV1Member.blockMember(payload);
773
- sideEffects?.onSiteCall?.();
774
- try {
775
- const result = await httpClient.request(reqOpts);
776
- sideEffects?.onSuccess?.(result);
777
- return renameKeysFromRESTResponseToSDKResponse(result.data);
778
- }
779
- catch (err) {
780
- const transformedError = sdkTransformError(err, {
781
- spreadPathsToArguments: {},
782
- explicitPathsToArguments: { id: '$[0]' },
783
- singleArgumentUnchanged: false,
784
- }, ['_id']);
785
- sideEffects?.onError?.(err);
786
- throw transformedError;
787
- }
788
- }
789
- /**
790
- * Disconnects a member.
791
- *
792
- * A disconnected member can't log in to members-only pages, and the member isn't visible in the dashboard.
793
- *
794
- * >**Note:** This action is irreversible. To connect the same member again, you have to create a member with a new slug.
795
- * @param _id - ID of a member to disconnect.
796
- * @public
797
- * @requiredField _id
798
- * @permissionId MEMBERS.MEMBER_DISCONNECT
799
- * @permissionScope Manage Members
800
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
801
- * @permissionScope Manage Challenges
802
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
803
- * @applicableIdentity APP
804
- * @fqn com.wixpress.members.api.Members.DisconnectMember
805
- */
806
- export async function disconnectMember(_id) {
807
- // @ts-ignore
808
- const { httpClient, sideEffects } = arguments[1];
809
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
810
- const reqOpts = ambassadorWixMembersV1Member.disconnectMember(payload);
811
- sideEffects?.onSiteCall?.();
812
- try {
813
- const result = await httpClient.request(reqOpts);
814
- sideEffects?.onSuccess?.(result);
815
- return renameKeysFromRESTResponseToSDKResponse(result.data);
816
- }
817
- catch (err) {
818
- const transformedError = sdkTransformError(err, {
819
- spreadPathsToArguments: {},
820
- explicitPathsToArguments: { id: '$[0]' },
821
- singleArgumentUnchanged: false,
822
- }, ['_id']);
823
- sideEffects?.onError?.(err);
824
- throw transformedError;
825
- }
826
- }
827
- /**
828
- * Deletes a member by ID.
829
- *
830
- * 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.
831
- * @param _id - ID of a member to delete.
832
- * @public
833
- * @requiredField _id
834
- * @permissionId MEMBERS.MEMBER_DELETE
835
- * @permissionScope Manage Members
836
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
837
- * @applicableIdentity APP
838
- * @fqn com.wixpress.members.api.Members.DeleteMember
839
- */
840
- export async function deleteMember(_id) {
841
- // @ts-ignore
842
- const { httpClient, sideEffects } = arguments[1];
843
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
844
- const reqOpts = ambassadorWixMembersV1Member.deleteMember(payload);
845
- sideEffects?.onSiteCall?.();
846
- try {
847
- const result = await httpClient.request(reqOpts);
848
- sideEffects?.onSuccess?.(result);
849
- }
850
- catch (err) {
851
- const transformedError = sdkTransformError(err, {
852
- spreadPathsToArguments: {},
853
- explicitPathsToArguments: { id: '$[0]' },
854
- singleArgumentUnchanged: false,
855
- }, ['_id']);
856
- sideEffects?.onError?.(err);
857
- throw transformedError;
858
- }
859
- }
860
- /**
861
- * Deletes the current member.
862
- *
863
- * After calling this method, the member is logged out of the site.
864
- *
865
- * 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.
866
- *
867
- * >**Note:**
868
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
869
- * @public
870
- * @permissionId MEMBERS.MEMBER_DELETE
871
- * @permissionScope Manage Members
872
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
873
- * @applicableIdentity APP
874
- * @fqn com.wixpress.members.api.Members.DeleteMyMember
875
- */
876
- export async function deleteMyMember(options) {
877
- // @ts-ignore
878
- const { httpClient, sideEffects } = arguments[1];
879
- const payload = renameKeysFromSDKRequestToRESTRequest({
880
- contentAssigneeId: options?.contentAssigneeId,
881
- });
882
- const reqOpts = ambassadorWixMembersV1Member.deleteMyMember(payload);
883
- sideEffects?.onSiteCall?.();
884
- try {
885
- const result = await httpClient.request(reqOpts);
886
- sideEffects?.onSuccess?.(result);
887
- }
888
- catch (err) {
889
- const transformedError = sdkTransformError(err, {
890
- spreadPathsToArguments: {},
891
- explicitPathsToArguments: {
892
- contentAssigneeId: '$[0].contentAssigneeId',
893
- },
894
- singleArgumentUnchanged: false,
895
- }, ['options']);
896
- sideEffects?.onError?.(err);
897
- throw transformedError;
898
- }
899
- }
900
- /**
901
- * Deletes multiple members by `memberId`.
902
- *
903
- * 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.
904
- * @param memberIds - IDs of members to be deleted.
905
- * @public
906
- * @requiredField memberIds
907
- * @permissionId MEMBERS.MEMBER_DELETE
908
- * @permissionScope Manage Members
909
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
910
- * @applicableIdentity APP
911
- * @fqn com.wixpress.members.api.Members.BulkDeleteMembers
912
- */
913
- export async function bulkDeleteMembers(memberIds) {
914
- // @ts-ignore
915
- const { httpClient, sideEffects } = arguments[1];
916
- const payload = renameKeysFromSDKRequestToRESTRequest({
917
- memberIds: memberIds,
918
- });
919
- const reqOpts = ambassadorWixMembersV1Member.bulkDeleteMembers(payload);
920
- sideEffects?.onSiteCall?.();
921
- try {
922
- const result = await httpClient.request(reqOpts);
923
- sideEffects?.onSuccess?.(result);
924
- return renameKeysFromRESTResponseToSDKResponse(result.data);
925
- }
926
- catch (err) {
927
- const transformedError = sdkTransformError(err, {
928
- spreadPathsToArguments: {},
929
- explicitPathsToArguments: { memberIds: '$[0]' },
930
- singleArgumentUnchanged: false,
931
- }, ['memberIds']);
932
- sideEffects?.onError?.(err);
933
- throw transformedError;
934
- }
935
- }
936
- /**
937
- * Deletes multiple members by the specified filter.
938
- *
939
- * 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.
940
- * @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.
941
- * @public
942
- * @requiredField filter
943
- * @permissionId MEMBERS.MEMBER_DELETE
944
- * @permissionScope Manage Members
945
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
946
- * @applicableIdentity APP
947
- * @fqn com.wixpress.members.api.Members.BulkDeleteMembersByFilter
948
- */
949
- export async function bulkDeleteMembersByFilter(filter, options) {
950
- // @ts-ignore
951
- const { httpClient, sideEffects } = arguments[2];
952
- const payload = renameKeysFromSDKRequestToRESTRequest({
953
- filter: filter,
954
- contentAssigneeId: options?.contentAssigneeId,
955
- search: options?.search,
956
- });
957
- const reqOpts = ambassadorWixMembersV1Member.bulkDeleteMembersByFilter(payload);
958
- sideEffects?.onSiteCall?.();
959
- try {
960
- const result = await httpClient.request(reqOpts);
961
- sideEffects?.onSuccess?.(result);
962
- return renameKeysFromRESTResponseToSDKResponse(result.data);
963
- }
964
- catch (err) {
965
- const transformedError = sdkTransformError(err, {
966
- spreadPathsToArguments: {},
967
- explicitPathsToArguments: {
968
- filter: '$[0]',
969
- contentAssigneeId: '$[1].contentAssigneeId',
970
- search: '$[1].search',
971
- },
972
- singleArgumentUnchanged: false,
973
- }, ['filter', 'options']);
974
- sideEffects?.onError?.(err);
975
- throw transformedError;
976
- }
977
- }
978
- /**
979
- * Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
980
- *
981
- * Call this API to:
982
- * - Approve pending members.
983
- * - Unblock blocked members.
984
- * @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.
985
- * @public
986
- * @requiredField filter
987
- * @permissionId MEMBERS.MEMBER_APPROVE
988
- * @permissionScope Manage Members
989
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
990
- * @applicableIdentity APP
991
- * @fqn com.wixpress.members.api.Members.BulkApproveMembers
992
- */
993
- export async function bulkApproveMembers(filter) {
994
- // @ts-ignore
995
- const { httpClient, sideEffects } = arguments[1];
996
- const payload = renameKeysFromSDKRequestToRESTRequest({ filter: filter });
997
- const reqOpts = ambassadorWixMembersV1Member.bulkApproveMembers(payload);
998
- sideEffects?.onSiteCall?.();
999
- try {
1000
- const result = await httpClient.request(reqOpts);
1001
- sideEffects?.onSuccess?.(result);
1002
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1003
- }
1004
- catch (err) {
1005
- const transformedError = sdkTransformError(err, {
1006
- spreadPathsToArguments: {},
1007
- explicitPathsToArguments: { filter: '$[0]' },
1008
- singleArgumentUnchanged: false,
1009
- }, ['filter']);
1010
- sideEffects?.onError?.(err);
1011
- throw transformedError;
1012
- }
1013
- }
1014
- /**
1015
- * Blocks multiple members by a specified filter.
1016
- *
1017
- * Blocked members can't log in to members-only pages.
1018
- *
1019
- * To unblock multiple members, call Bulk Approve Members.
1020
- * @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.
1021
- * @public
1022
- * @requiredField filter
1023
- * @permissionId MEMBERS.MEMBER_BLOCK
1024
- * @permissionScope Manage Members
1025
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1026
- * @applicableIdentity APP
1027
- * @fqn com.wixpress.members.api.Members.BulkBlockMembers
1028
- */
1029
- export async function bulkBlockMembers(filter) {
1030
- // @ts-ignore
1031
- const { httpClient, sideEffects } = arguments[1];
1032
- const payload = renameKeysFromSDKRequestToRESTRequest({ filter: filter });
1033
- const reqOpts = ambassadorWixMembersV1Member.bulkBlockMembers(payload);
1034
- sideEffects?.onSiteCall?.();
1035
- try {
1036
- const result = await httpClient.request(reqOpts);
1037
- sideEffects?.onSuccess?.(result);
1038
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1039
- }
1040
- catch (err) {
1041
- const transformedError = sdkTransformError(err, {
1042
- spreadPathsToArguments: {},
1043
- explicitPathsToArguments: { filter: '$[0]' },
1044
- singleArgumentUnchanged: false,
1045
- }, ['filter']);
1046
- sideEffects?.onError?.(err);
1047
- throw transformedError;
1048
- }
1049
- }
1050
- /**
1051
- * Creates a site member.
1052
- *
1053
- * After creation, you can call
1054
- * [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))
1055
- * to email the member with a link to set their password.
1056
- * The member can log in to the site
1057
- * when they set their password for the first time.
1058
- *
1059
- * > **Note:**
1060
- * > When creating multiple members,
1061
- * > set your requests at least 1 second apart to keep below rate limits.
1062
- * @public
1063
- * @permissionId MEMBERS.MEMBER_CREATE
1064
- * @permissionScope Manage Members
1065
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1066
- * @permissionScope Manage Challenges
1067
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1068
- * @applicableIdentity APP
1069
- * @returns New member.
1070
- * @fqn com.wixpress.members.api.Members.CreateMember
1071
- */
1072
- export async function createMember(options) {
1073
- // @ts-ignore
1074
- const { httpClient, sideEffects } = arguments[1];
1075
- const payload = renameKeysFromSDKRequestToRESTRequest({
1076
- member: options?.member,
1077
- });
1078
- const reqOpts = ambassadorWixMembersV1Member.createMember(payload);
1079
- sideEffects?.onSiteCall?.();
1080
- try {
1081
- const result = await httpClient.request(reqOpts);
1082
- sideEffects?.onSuccess?.(result);
1083
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
1084
- }
1085
- catch (err) {
1086
- const transformedError = sdkTransformError(err, {
1087
- spreadPathsToArguments: {},
1088
- explicitPathsToArguments: { member: '$[0].member' },
1089
- singleArgumentUnchanged: false,
1090
- }, ['options']);
1091
- sideEffects?.onError?.(err);
1092
- throw transformedError;
1093
- }
1094
- }
1095
- /**
1096
- * Updates a member's properties.
1097
- *
1098
- * Only the requested fields are updated.
1099
- * To clear a field's value, set an empty value with an empty string `""`.
1100
- *
1101
- * > **Note:**
1102
- * > 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.
1103
- * > However, passing an empty array will have no effect, and these methods must be used to clear all data from the respective array:
1104
- * >- To clear `contact.addresses`, use `deleteMemberAddresses()`.
1105
- * >- To clear `contact.emails`, use `deleteMemberEmails()`.
1106
- * >- To clear `contact.phones`, use `deleteMemberPhones()`.
1107
- *
1108
- * > **Note:**
1109
- * > Only logged-in members can call this method without elevated permissions.
1110
- * > 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.
1111
- * @param _id - Member ID.
1112
- * @public
1113
- * @requiredField _id
1114
- * @requiredField member
1115
- * @param options - Member to update.
1116
- * @permissionId MEMBERS.MEMBER_UPDATE
1117
- * @permissionScope Manage Members
1118
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1119
- * @permissionScope Manage Bookings Services and Settings
1120
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1121
- * @permissionScope Manage Events
1122
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1123
- * @permissionScope Manage Challenges
1124
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1125
- * @permissionScope Manage Portfolio
1126
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1127
- * @permissionScope Access Verticals by Automations
1128
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1129
- * @permissionScope Manage Restaurants - all permissions
1130
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1131
- * @permissionScope Set Up Automations
1132
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1133
- * @applicableIdentity APP
1134
- * @applicableIdentity MEMBER
1135
- * @returns Updated member.
1136
- * @fqn com.wixpress.members.api.Members.UpdateMember
1137
- */
1138
- export async function updateMember(_id, member) {
1139
- // @ts-ignore
1140
- const { httpClient, sideEffects } = arguments[2];
1141
- const payload = renameKeysFromSDKRequestToRESTRequest({
1142
- member: { ...member, id: _id },
1143
- });
1144
- const reqOpts = ambassadorWixMembersV1Member.updateMember(payload);
1145
- sideEffects?.onSiteCall?.();
1146
- try {
1147
- const result = await httpClient.request(reqOpts);
1148
- sideEffects?.onSuccess?.(result);
1149
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.member;
1150
- }
1151
- catch (err) {
1152
- const transformedError = sdkTransformError(err, {
1153
- spreadPathsToArguments: { member: '$[1]' },
1154
- explicitPathsToArguments: { 'member.id': '$[0]' },
1155
- singleArgumentUnchanged: false,
1156
- }, ['_id', 'member']);
1157
- sideEffects?.onError?.(err);
1158
- throw transformedError;
1159
- }
1160
- }
1161
- /**
1162
- * Clears a member's phone numbers.
1163
- *
1164
- * `deleteMemberPhones()` clears the `phones` array under the `contact` property.
1165
- *
1166
- * > **Note:**
1167
- * > Only logged-in members can call this method without elevated permissions.
1168
- * > 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.
1169
- * @param _id - ID of the member whose phone numbers will be deleted.
1170
- * @public
1171
- * @requiredField _id
1172
- * @permissionId MEMBERS.MEMBER_UPDATE
1173
- * @permissionScope Manage Members
1174
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1175
- * @permissionScope Manage Bookings Services and Settings
1176
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1177
- * @permissionScope Manage Events
1178
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1179
- * @permissionScope Manage Challenges
1180
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1181
- * @permissionScope Manage Portfolio
1182
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1183
- * @permissionScope Access Verticals by Automations
1184
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1185
- * @permissionScope Manage Restaurants - all permissions
1186
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1187
- * @permissionScope Set Up Automations
1188
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1189
- * @applicableIdentity APP
1190
- * @applicableIdentity MEMBER
1191
- * @fqn com.wixpress.members.api.Members.DeleteMemberPhones
1192
- */
1193
- export async function deleteMemberPhones(_id) {
1194
- // @ts-ignore
1195
- const { httpClient, sideEffects } = arguments[1];
1196
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1197
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberPhones(payload);
1198
- sideEffects?.onSiteCall?.();
1199
- try {
1200
- const result = await httpClient.request(reqOpts);
1201
- sideEffects?.onSuccess?.(result);
1202
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1203
- }
1204
- catch (err) {
1205
- const transformedError = sdkTransformError(err, {
1206
- spreadPathsToArguments: {},
1207
- explicitPathsToArguments: { id: '$[0]' },
1208
- singleArgumentUnchanged: false,
1209
- }, ['_id']);
1210
- sideEffects?.onError?.(err);
1211
- throw transformedError;
1212
- }
1213
- }
1214
- /**
1215
- * Clears a member's email addresses.
1216
- *
1217
- * `deleteMemberEmails()` clears the `emails` array under the `contact` property.
1218
- *
1219
- * > **Notes:**
1220
- * > A member can still log in with their `loginEmail`,
1221
- * > which is not cleared when this method is called.
1222
- *
1223
- * > Only logged-in members can call this method without elevated permissions.
1224
- * > 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.
1225
- * @param _id - ID of the member whose email addresses will be deleted.
1226
- * @public
1227
- * @requiredField _id
1228
- * @permissionId MEMBERS.MEMBER_UPDATE
1229
- * @permissionScope Manage Members
1230
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1231
- * @permissionScope Manage Bookings Services and Settings
1232
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1233
- * @permissionScope Manage Events
1234
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1235
- * @permissionScope Manage Challenges
1236
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1237
- * @permissionScope Manage Portfolio
1238
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1239
- * @permissionScope Access Verticals by Automations
1240
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1241
- * @permissionScope Manage Restaurants - all permissions
1242
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1243
- * @permissionScope Set Up Automations
1244
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1245
- * @applicableIdentity APP
1246
- * @applicableIdentity MEMBER
1247
- * @fqn com.wixpress.members.api.Members.DeleteMemberEmails
1248
- */
1249
- export async function deleteMemberEmails(_id) {
1250
- // @ts-ignore
1251
- const { httpClient, sideEffects } = arguments[1];
1252
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1253
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberEmails(payload);
1254
- sideEffects?.onSiteCall?.();
1255
- try {
1256
- const result = await httpClient.request(reqOpts);
1257
- sideEffects?.onSuccess?.(result);
1258
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1259
- }
1260
- catch (err) {
1261
- const transformedError = sdkTransformError(err, {
1262
- spreadPathsToArguments: {},
1263
- explicitPathsToArguments: { id: '$[0]' },
1264
- singleArgumentUnchanged: false,
1265
- }, ['_id']);
1266
- sideEffects?.onError?.(err);
1267
- throw transformedError;
1268
- }
1269
- }
1270
- /**
1271
- * Deletes a member's street addresses.
1272
- *
1273
- * `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
1274
- *
1275
- * > **Note:**
1276
- * > Only logged-in members can call this method without elevated permissions.
1277
- * > 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.
1278
- * @param _id - ID of the member whose street addresses will be deleted.
1279
- * @public
1280
- * @requiredField _id
1281
- * @permissionId MEMBERS.MEMBER_UPDATE
1282
- * @permissionScope Manage Members
1283
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
1284
- * @permissionScope Manage Bookings Services and Settings
1285
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1286
- * @permissionScope Manage Events
1287
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1288
- * @permissionScope Manage Challenges
1289
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1290
- * @permissionScope Manage Portfolio
1291
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1292
- * @permissionScope Access Verticals by Automations
1293
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1294
- * @permissionScope Manage Restaurants - all permissions
1295
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1296
- * @permissionScope Set Up Automations
1297
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1298
- * @applicableIdentity APP
1299
- * @applicableIdentity MEMBER
1300
- * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses
1301
- */
1302
- export async function deleteMemberAddresses(_id) {
1303
- // @ts-ignore
1304
- const { httpClient, sideEffects } = arguments[1];
1305
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1306
- const reqOpts = ambassadorWixMembersV1Member.deleteMemberAddresses(payload);
1307
- sideEffects?.onSiteCall?.();
1308
- try {
1309
- const result = await httpClient.request(reqOpts);
1310
- sideEffects?.onSuccess?.(result);
1311
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1312
- }
1313
- catch (err) {
1314
- const transformedError = sdkTransformError(err, {
1315
- spreadPathsToArguments: {},
1316
- explicitPathsToArguments: { id: '$[0]' },
1317
- singleArgumentUnchanged: false,
1318
- }, ['_id']);
1319
- sideEffects?.onError?.(err);
1320
- throw transformedError;
1321
- }
1322
- }
1323
- //# sourceMappingURL=members-v1-member-members.universal.js.map