@wix/auto_sdk_members_members 1.0.59 → 1.0.60

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