@wix/auto_sdk_members_members 1.0.59 → 1.0.61

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