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