@wix/members 1.0.11 → 1.0.12
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.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +2 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/src/members-v1-member.http.d.ts +167 -0
- package/build/cjs/src/members-v1-member.http.js +494 -0
- package/build/cjs/src/members-v1-member.http.js.map +1 -0
- package/build/cjs/src/members-v1-member.public.d.ts +17 -0
- package/build/cjs/src/members-v1-member.public.js +76 -0
- package/build/cjs/src/members-v1-member.public.js.map +1 -0
- package/build/cjs/src/members-v1-member.types.d.ts +931 -0
- package/build/cjs/src/members-v1-member.types.js +121 -0
- package/build/cjs/src/members-v1-member.types.js.map +1 -0
- package/build/cjs/src/members-v1-member.universal.d.ts +1379 -0
- package/build/cjs/src/members-v1-member.universal.js +842 -0
- package/build/cjs/src/members-v1-member.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -1
- package/build/es/src/members-v1-member.http.d.ts +167 -0
- package/build/es/src/members-v1-member.http.js +481 -0
- package/build/es/src/members-v1-member.http.js.map +1 -0
- package/build/es/src/members-v1-member.public.d.ts +17 -0
- package/build/es/src/members-v1-member.public.js +54 -0
- package/build/es/src/members-v1-member.public.js.map +1 -0
- package/build/es/src/members-v1-member.types.d.ts +931 -0
- package/build/es/src/members-v1-member.types.js +118 -0
- package/build/es/src/members-v1-member.types.js.map +1 -0
- package/build/es/src/members-v1-member.universal.d.ts +1379 -0
- package/build/es/src/members-v1-member.universal.js +810 -0
- package/build/es/src/members-v1-member.universal.js.map +1 -0
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
package/build/cjs/index.js
CHANGED
|
@@ -19,6 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
19
19
|
return result;
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.badges = void 0;
|
|
22
|
+
exports.members = exports.badges = void 0;
|
|
23
23
|
exports.badges = __importStar(require("./src/badges-v3-badge.public"));
|
|
24
|
+
exports.members = __importStar(require("./src/members-v1-member.public"));
|
|
24
25
|
//# sourceMappingURL=index.js.map
|
package/build/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAuD"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAuD;AACvD,0EAA0D"}
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
+
import { CreateMemberRequest, CreateMemberResponse, DeleteMemberAddressesRequest, DeleteMemberAddressesResponse, DeleteMemberEmailsRequest, DeleteMemberEmailsResponse, DeleteMemberPhonesRequest, DeleteMemberPhonesResponse, DeleteMemberRequest, DeleteMemberResponse, GetMemberRequest, GetMemberResponse, GetMyMemberRequest, GetMyMemberResponse, ListMembersRequest, ListMembersResponse, QueryMembersRequest, QueryMembersResponse, UpdateMemberRequest, UpdateMemberResponse } from './members-v1-member.types';
|
|
3
|
+
/**
|
|
4
|
+
* Retrieves the currently logged-in member.
|
|
5
|
+
*
|
|
6
|
+
* <!--ONLY:VELO
|
|
7
|
+
* This function returns a Promise that resolves to a member object.
|
|
8
|
+
*
|
|
9
|
+
* > **Note:**
|
|
10
|
+
* > This function replaces the deprecated
|
|
11
|
+
* > `wixUsersBackend.currentUser`.
|
|
12
|
+
* > The deprecated object will continue to work, but it will not receive updates.
|
|
13
|
+
* > To keep any existing code compatible with future changes, see the
|
|
14
|
+
* > [migration instructions](.wix-users-backend/currentuser#wix-users-backend_currentuser_migration-instructions).
|
|
15
|
+
* <!--END:ONLY:VELO-->
|
|
16
|
+
*/
|
|
17
|
+
export declare function getMyMember(payload: GetMyMemberRequest): RequestOptionsFactory<GetMyMemberResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieves a member by ID.
|
|
20
|
+
*
|
|
21
|
+
* - `PUBLIC` fieldset returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
22
|
+
* - `EXTENDED` fieldset returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
23
|
+
* - `FULL` fieldset returns all fields.
|
|
24
|
+
*/
|
|
25
|
+
export declare function getMember(payload: GetMemberRequest): RequestOptionsFactory<GetMemberResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Lists site members, given the provided paging and fieldsets.
|
|
28
|
+
*
|
|
29
|
+
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
30
|
+
* - `FULL` fieldset returns all fields.
|
|
31
|
+
*/
|
|
32
|
+
export declare function listMembers(payload: ListMembersRequest): RequestOptionsFactory<ListMembersResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging.
|
|
35
|
+
*
|
|
36
|
+
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
37
|
+
* - `FULL` fieldset returns all fields.
|
|
38
|
+
*
|
|
39
|
+
* Currently supported fields for filtering:
|
|
40
|
+
*
|
|
41
|
+
* - `id`
|
|
42
|
+
* - `profile.nickname`
|
|
43
|
+
* - `profile.slug`
|
|
44
|
+
* - `contact.firstName`
|
|
45
|
+
* - `contact.lastName`
|
|
46
|
+
* - `privacyStatus`
|
|
47
|
+
* - `loginEmail`
|
|
48
|
+
* - `createdDate`
|
|
49
|
+
* - `status`
|
|
50
|
+
* - `userId`
|
|
51
|
+
*
|
|
52
|
+
* Currently supported fields for sorting:
|
|
53
|
+
*
|
|
54
|
+
* - `profile.nickname`
|
|
55
|
+
* - `contact.firstName`
|
|
56
|
+
* - `contact.lastName`
|
|
57
|
+
* - `createdDate`
|
|
58
|
+
* - `lastLoginDate`
|
|
59
|
+
*/
|
|
60
|
+
export declare function queryMembers(payload: QueryMembersRequest): RequestOptionsFactory<QueryMembersResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* Deletes a member.
|
|
63
|
+
*
|
|
64
|
+
* <!--ONLY:VELO
|
|
65
|
+
* This function returns a Promise that resolves to a member object
|
|
66
|
+
* when the specified member is deleted.
|
|
67
|
+
*
|
|
68
|
+
* > **Note:**
|
|
69
|
+
* > This function replaces the deprecated
|
|
70
|
+
* > `wix-users-backend.deleteUser()`.
|
|
71
|
+
* > The deprecated function will continue to work, but it will not receive updates.
|
|
72
|
+
* > To keep any existing code compatible with future changes, see the
|
|
73
|
+
* > [migration instructions](.wix-users-backend/deleteuser#migration-instructions).
|
|
74
|
+
* <!--END:ONLY:VELO-->
|
|
75
|
+
*/
|
|
76
|
+
export declare function deleteMember(payload: DeleteMemberRequest): RequestOptionsFactory<DeleteMemberResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Creates a site member.
|
|
79
|
+
*
|
|
80
|
+
* <!--ONLY:REST-->
|
|
81
|
+
* After creation, you can use
|
|
82
|
+
* [Send Set Password Email](https://dev.wix.com/api/rest/members/member-authentication/send-set-password-email)
|
|
83
|
+
* to email the member with a link to set their password.
|
|
84
|
+
* The member can log in to the site
|
|
85
|
+
* when they set their password for the first time.
|
|
86
|
+
*
|
|
87
|
+
* > **Note:**
|
|
88
|
+
* > When creating multiple members,
|
|
89
|
+
* > set your requests at least 1 second apart to keep below rate limits.
|
|
90
|
+
* <!--END:ONLY:REST-->
|
|
91
|
+
*/
|
|
92
|
+
export declare function createMember(payload: CreateMemberRequest): RequestOptionsFactory<CreateMemberResponse>;
|
|
93
|
+
/**
|
|
94
|
+
* Updates a member's properties.
|
|
95
|
+
*
|
|
96
|
+
* <!--ONLY:REST-->
|
|
97
|
+
* To clear a field's value, set an empty value with an empty string `""`.
|
|
98
|
+
*
|
|
99
|
+
* To clear the member's addresses, emails, or phone numbers,
|
|
100
|
+
* use these endpoints:
|
|
101
|
+
*
|
|
102
|
+
* - To clear `contact.addresses`, use [`Delete Member Addresses`](https://dev.wix.com/api/rest/members/members/delete-member-addresses).
|
|
103
|
+
* - To clear `contact.emails`, use [`Delete Member Emails`](https://dev.wix.com/api/rest/members/members/delete-member-emails).
|
|
104
|
+
* - To clear `contact.phones`, use [`Delete Member Phones`](https://dev.wix.com/api/rest/members/members/delete-member-phones).
|
|
105
|
+
* <!--END:ONLY:REST-->
|
|
106
|
+
*
|
|
107
|
+
* <!--ONLY:VELO
|
|
108
|
+
* This function returns a Promise that resolves to a member object
|
|
109
|
+
* when the specified member is updated.
|
|
110
|
+
*
|
|
111
|
+
* > **Note:**
|
|
112
|
+
* > This function replaces the deprecated
|
|
113
|
+
* > `wixUsersBackend.updateUserFields()`.
|
|
114
|
+
* > The deprecated function will continue to work, but it will not receive updates.
|
|
115
|
+
* > To keep any existing code compatible with future changes, see the
|
|
116
|
+
* > [migration instructions](.wix-users-backend/updateuserfields#migration-instructions).
|
|
117
|
+
*
|
|
118
|
+
* Only the requested fields are updated.
|
|
119
|
+
*
|
|
120
|
+
* To clear the member's addresses, emails, or phone numbers,
|
|
121
|
+
* use these functions:
|
|
122
|
+
*
|
|
123
|
+
* - To clear `contact.addresses`, use [`deleteMemberAddresses()`](.wix-members-backend/members-obj/deletememberaddresses).
|
|
124
|
+
* - To clear `contact.emails`, use [`deleteMemberEmails()`](.wix-members-backend/members-obj/deletememberemails).
|
|
125
|
+
* - To clear `contact.phones`, use [`deleteMemberPhones()`](.wix-members-backend/members-obj/deletememberphones).
|
|
126
|
+
* <!--END:ONLY:VELO-->
|
|
127
|
+
*/
|
|
128
|
+
export declare function updateMember(payload: UpdateMemberRequest): RequestOptionsFactory<UpdateMemberResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* Clears a member's phone numbers.
|
|
131
|
+
*
|
|
132
|
+
* <!--ONLY:VELO
|
|
133
|
+
* This function returns a Promise that resolves to a member object
|
|
134
|
+
* when the specified member's phone numbers are cleared.
|
|
135
|
+
*
|
|
136
|
+
* `deleteMemberPhones()` clears the `phones` array under the `contact` property.
|
|
137
|
+
* <!--END:ONLY:VELO-->
|
|
138
|
+
*/
|
|
139
|
+
export declare function deleteMemberPhones(payload: DeleteMemberPhonesRequest): RequestOptionsFactory<DeleteMemberPhonesResponse>;
|
|
140
|
+
/**
|
|
141
|
+
* Clears a member's email addresses.
|
|
142
|
+
*
|
|
143
|
+
* <!--ONLY:VELO
|
|
144
|
+
* This function returns a Promise that resolves to a member object
|
|
145
|
+
* when the specified member's email addresses are cleared.
|
|
146
|
+
*
|
|
147
|
+
* `deleteMemberEmails()` clears the `emails` array under the `contact` property.
|
|
148
|
+
* Other member
|
|
149
|
+
* [`updatedMember()`](.wix-members-backend/members-obj/updatemember)
|
|
150
|
+
*
|
|
151
|
+
* > **Note:**
|
|
152
|
+
* > The member can still log in with their `loginEmail`,
|
|
153
|
+
* > which is not cleared when this function is called.
|
|
154
|
+
* <!--END:ONLY:VELO-->
|
|
155
|
+
*/
|
|
156
|
+
export declare function deleteMemberEmails(payload: DeleteMemberEmailsRequest): RequestOptionsFactory<DeleteMemberEmailsResponse>;
|
|
157
|
+
/**
|
|
158
|
+
* Deletes a member's street addresses.
|
|
159
|
+
*
|
|
160
|
+
* <!--ONLY:VELO
|
|
161
|
+
* This function returns a Promise that resolves to a member object
|
|
162
|
+
* when the specified member's addresses are cleared.
|
|
163
|
+
* <!--END:ONLY:VELO-->
|
|
164
|
+
*
|
|
165
|
+
* `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
|
|
166
|
+
*/
|
|
167
|
+
export declare function deleteMemberAddresses(payload: DeleteMemberAddressesRequest): RequestOptionsFactory<DeleteMemberAddressesResponse>;
|
|
@@ -0,0 +1,494 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.deleteMemberAddresses = exports.deleteMemberEmails = exports.deleteMemberPhones = exports.updateMember = exports.createMember = exports.deleteMember = exports.queryMembers = exports.listMembers = exports.getMember = exports.getMyMember = void 0;
|
|
4
|
+
const metro_runtime_1 = require("@wix/metro-runtime");
|
|
5
|
+
const ambassador_1 = require("@wix/metro-runtime/ambassador");
|
|
6
|
+
const metro_runtime_2 = require("@wix/metro-runtime");
|
|
7
|
+
const _createMemberRequest = { member: '_member' };
|
|
8
|
+
const _createMemberResponse = { member: '_member' };
|
|
9
|
+
const _deleteMemberAddressesRequest = {};
|
|
10
|
+
const _deleteMemberAddressesResponse = { member: '_member' };
|
|
11
|
+
const _deleteMemberEmailsRequest = {};
|
|
12
|
+
const _deleteMemberEmailsResponse = { member: '_member' };
|
|
13
|
+
const _deleteMemberPhonesRequest = {};
|
|
14
|
+
const _deleteMemberPhonesResponse = { member: '_member' };
|
|
15
|
+
const _deleteMemberRequest = {};
|
|
16
|
+
const _deleteMemberResponse = {};
|
|
17
|
+
const _getMemberRequest = {};
|
|
18
|
+
const _getMemberResponse = { member: '_member' };
|
|
19
|
+
const _getMyMemberRequest = {};
|
|
20
|
+
const _getMyMemberResponse = { member: '_member' };
|
|
21
|
+
const _listMembersRequest = {};
|
|
22
|
+
const _listMembersResponse = { members: '_member' };
|
|
23
|
+
const _member = {
|
|
24
|
+
createdDate: 'google.protobuf.Timestamp',
|
|
25
|
+
updatedDate: 'google.protobuf.Timestamp',
|
|
26
|
+
lastLoginDate: 'google.protobuf.Timestamp',
|
|
27
|
+
};
|
|
28
|
+
const _queryMembersRequest = {};
|
|
29
|
+
const _queryMembersResponse = { members: '_member' };
|
|
30
|
+
const _updateMemberRequest = { member: '_member' };
|
|
31
|
+
const _updateMemberResponse = { member: '_member' };
|
|
32
|
+
function resolveComWixpressMembersApiMembersUrl(opts) {
|
|
33
|
+
const domainToMappings = {
|
|
34
|
+
'www.wixapis.com': [
|
|
35
|
+
{
|
|
36
|
+
srcPath: '/members/v1/members',
|
|
37
|
+
destPath: '/v1/members',
|
|
38
|
+
},
|
|
39
|
+
],
|
|
40
|
+
'api._api_base_domain_': [
|
|
41
|
+
{
|
|
42
|
+
srcPath: '/members-ng-api',
|
|
43
|
+
destPath: '',
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
_: [
|
|
47
|
+
{
|
|
48
|
+
srcPath: '/_api/members/v1/members',
|
|
49
|
+
destPath: '/v1/members',
|
|
50
|
+
},
|
|
51
|
+
],
|
|
52
|
+
'www._base_domain_': [
|
|
53
|
+
{
|
|
54
|
+
srcPath: '/_api/members/v1/members',
|
|
55
|
+
destPath: '/v1/members',
|
|
56
|
+
},
|
|
57
|
+
],
|
|
58
|
+
'manage._base_domain_': [
|
|
59
|
+
{
|
|
60
|
+
srcPath: '/_api/members/v1/members',
|
|
61
|
+
destPath: '/v1/members',
|
|
62
|
+
},
|
|
63
|
+
],
|
|
64
|
+
'editor._base_domain_': [
|
|
65
|
+
{
|
|
66
|
+
srcPath: '/_api/members/v1/members',
|
|
67
|
+
destPath: '/v1/members',
|
|
68
|
+
},
|
|
69
|
+
],
|
|
70
|
+
'blocks._base_domain_': [
|
|
71
|
+
{
|
|
72
|
+
srcPath: '/_api/members/v1/members',
|
|
73
|
+
destPath: '/v1/members',
|
|
74
|
+
},
|
|
75
|
+
],
|
|
76
|
+
'create.editorx': [
|
|
77
|
+
{
|
|
78
|
+
srcPath: '/_api/members/v1/members',
|
|
79
|
+
destPath: '/v1/members',
|
|
80
|
+
},
|
|
81
|
+
],
|
|
82
|
+
'editor.wixapps.net': [
|
|
83
|
+
{
|
|
84
|
+
srcPath: '/_api/members/v1/members',
|
|
85
|
+
destPath: '/v1/members',
|
|
86
|
+
},
|
|
87
|
+
],
|
|
88
|
+
'*.dev.wix-code.com': [
|
|
89
|
+
{
|
|
90
|
+
srcPath: '/_api/members/v1/members',
|
|
91
|
+
destPath: '/v1/members',
|
|
92
|
+
},
|
|
93
|
+
],
|
|
94
|
+
'bo._base_domain_': [
|
|
95
|
+
{
|
|
96
|
+
srcPath: '/_api/members/v1/members',
|
|
97
|
+
destPath: '/v1/members',
|
|
98
|
+
},
|
|
99
|
+
],
|
|
100
|
+
};
|
|
101
|
+
return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Retrieves the currently logged-in member.
|
|
105
|
+
*
|
|
106
|
+
* <!--ONLY:VELO
|
|
107
|
+
* This function returns a Promise that resolves to a member object.
|
|
108
|
+
*
|
|
109
|
+
* > **Note:**
|
|
110
|
+
* > This function replaces the deprecated
|
|
111
|
+
* > `wixUsersBackend.currentUser`.
|
|
112
|
+
* > The deprecated object will continue to work, but it will not receive updates.
|
|
113
|
+
* > To keep any existing code compatible with future changes, see the
|
|
114
|
+
* > [migration instructions](.wix-users-backend/currentuser#wix-users-backend_currentuser_migration-instructions).
|
|
115
|
+
* <!--END:ONLY:VELO-->
|
|
116
|
+
*/
|
|
117
|
+
function getMyMember(payload) {
|
|
118
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getMyMemberRequest, {});
|
|
119
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getMyMemberResponse, { _member });
|
|
120
|
+
function __getMyMember({ host }) {
|
|
121
|
+
const serializedData = toReq(payload);
|
|
122
|
+
const metadata = {
|
|
123
|
+
entityFqdn: 'wix.members.v1.member',
|
|
124
|
+
method: 'GET',
|
|
125
|
+
methodFqn: 'com.wixpress.members.api.Members.GetMyMember',
|
|
126
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
127
|
+
protoPath: '/v1/members/my',
|
|
128
|
+
data: serializedData,
|
|
129
|
+
host,
|
|
130
|
+
}),
|
|
131
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
132
|
+
transformResponse: fromRes,
|
|
133
|
+
};
|
|
134
|
+
return metadata;
|
|
135
|
+
}
|
|
136
|
+
__getMyMember.fromReq = fromReq;
|
|
137
|
+
return __getMyMember;
|
|
138
|
+
}
|
|
139
|
+
exports.getMyMember = getMyMember;
|
|
140
|
+
/**
|
|
141
|
+
* Retrieves a member by ID.
|
|
142
|
+
*
|
|
143
|
+
* - `PUBLIC` fieldset returns `id`, `contactId`, and the `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
144
|
+
* - `EXTENDED` fieldset returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
|
|
145
|
+
* - `FULL` fieldset returns all fields.
|
|
146
|
+
*/
|
|
147
|
+
function getMember(payload) {
|
|
148
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getMemberRequest, {});
|
|
149
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getMemberResponse, { _member });
|
|
150
|
+
function __getMember({ host }) {
|
|
151
|
+
const serializedData = toReq(payload);
|
|
152
|
+
const metadata = {
|
|
153
|
+
entityFqdn: 'wix.members.v1.member',
|
|
154
|
+
method: 'GET',
|
|
155
|
+
methodFqn: 'com.wixpress.members.api.Members.GetMember',
|
|
156
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
157
|
+
protoPath: '/v1/members/{id}',
|
|
158
|
+
data: serializedData,
|
|
159
|
+
host,
|
|
160
|
+
}),
|
|
161
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
162
|
+
transformResponse: fromRes,
|
|
163
|
+
};
|
|
164
|
+
return metadata;
|
|
165
|
+
}
|
|
166
|
+
__getMember.fromReq = fromReq;
|
|
167
|
+
return __getMember;
|
|
168
|
+
}
|
|
169
|
+
exports.getMember = getMember;
|
|
170
|
+
/**
|
|
171
|
+
* Lists site members, given the provided paging and fieldsets.
|
|
172
|
+
*
|
|
173
|
+
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
174
|
+
* - `FULL` fieldset returns all fields.
|
|
175
|
+
*/
|
|
176
|
+
function listMembers(payload) {
|
|
177
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listMembersRequest, {});
|
|
178
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_listMembersResponse, { _member });
|
|
179
|
+
function __listMembers({ host }) {
|
|
180
|
+
const serializedData = toReq(payload);
|
|
181
|
+
const metadata = {
|
|
182
|
+
entityFqdn: 'wix.members.v1.member',
|
|
183
|
+
method: 'GET',
|
|
184
|
+
methodFqn: 'com.wixpress.members.api.Members.ListMembers',
|
|
185
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
186
|
+
protoPath: '/v1/members',
|
|
187
|
+
data: serializedData,
|
|
188
|
+
host,
|
|
189
|
+
}),
|
|
190
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
191
|
+
transformResponse: fromRes,
|
|
192
|
+
};
|
|
193
|
+
return metadata;
|
|
194
|
+
}
|
|
195
|
+
__listMembers.fromReq = fromReq;
|
|
196
|
+
return __listMembers;
|
|
197
|
+
}
|
|
198
|
+
exports.listMembers = listMembers;
|
|
199
|
+
/**
|
|
200
|
+
* Retrieves a list of up to 100 members, given the provided filters, fieldsets, sorting and paging.
|
|
201
|
+
*
|
|
202
|
+
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
203
|
+
* - `FULL` fieldset returns all fields.
|
|
204
|
+
*
|
|
205
|
+
* Currently supported fields for filtering:
|
|
206
|
+
*
|
|
207
|
+
* - `id`
|
|
208
|
+
* - `profile.nickname`
|
|
209
|
+
* - `profile.slug`
|
|
210
|
+
* - `contact.firstName`
|
|
211
|
+
* - `contact.lastName`
|
|
212
|
+
* - `privacyStatus`
|
|
213
|
+
* - `loginEmail`
|
|
214
|
+
* - `createdDate`
|
|
215
|
+
* - `status`
|
|
216
|
+
* - `userId`
|
|
217
|
+
*
|
|
218
|
+
* Currently supported fields for sorting:
|
|
219
|
+
*
|
|
220
|
+
* - `profile.nickname`
|
|
221
|
+
* - `contact.firstName`
|
|
222
|
+
* - `contact.lastName`
|
|
223
|
+
* - `createdDate`
|
|
224
|
+
* - `lastLoginDate`
|
|
225
|
+
*/
|
|
226
|
+
function queryMembers(payload) {
|
|
227
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryMembersRequest, {});
|
|
228
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_queryMembersResponse, { _member });
|
|
229
|
+
function __queryMembers({ host }) {
|
|
230
|
+
const serializedData = toReq(payload);
|
|
231
|
+
const metadata = {
|
|
232
|
+
entityFqdn: 'wix.members.v1.member',
|
|
233
|
+
method: 'POST',
|
|
234
|
+
methodFqn: 'com.wixpress.members.api.Members.QueryMembers',
|
|
235
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
236
|
+
protoPath: '/v1/members/query',
|
|
237
|
+
data: serializedData,
|
|
238
|
+
host,
|
|
239
|
+
}),
|
|
240
|
+
data: serializedData,
|
|
241
|
+
transformResponse: fromRes,
|
|
242
|
+
};
|
|
243
|
+
return metadata;
|
|
244
|
+
}
|
|
245
|
+
__queryMembers.fromReq = fromReq;
|
|
246
|
+
return __queryMembers;
|
|
247
|
+
}
|
|
248
|
+
exports.queryMembers = queryMembers;
|
|
249
|
+
/**
|
|
250
|
+
* Deletes a member.
|
|
251
|
+
*
|
|
252
|
+
* <!--ONLY:VELO
|
|
253
|
+
* This function returns a Promise that resolves to a member object
|
|
254
|
+
* when the specified member is deleted.
|
|
255
|
+
*
|
|
256
|
+
* > **Note:**
|
|
257
|
+
* > This function replaces the deprecated
|
|
258
|
+
* > `wix-users-backend.deleteUser()`.
|
|
259
|
+
* > The deprecated function will continue to work, but it will not receive updates.
|
|
260
|
+
* > To keep any existing code compatible with future changes, see the
|
|
261
|
+
* > [migration instructions](.wix-users-backend/deleteuser#migration-instructions).
|
|
262
|
+
* <!--END:ONLY:VELO-->
|
|
263
|
+
*/
|
|
264
|
+
function deleteMember(payload) {
|
|
265
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteMemberRequest, {});
|
|
266
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_deleteMemberResponse, {});
|
|
267
|
+
function __deleteMember({ host }) {
|
|
268
|
+
const serializedData = toReq(payload);
|
|
269
|
+
const metadata = {
|
|
270
|
+
entityFqdn: 'wix.members.v1.member',
|
|
271
|
+
method: 'DELETE',
|
|
272
|
+
methodFqn: 'com.wixpress.members.api.Members.DeleteMember',
|
|
273
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
274
|
+
protoPath: '/v1/members/{id}',
|
|
275
|
+
data: serializedData,
|
|
276
|
+
host,
|
|
277
|
+
}),
|
|
278
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
279
|
+
transformResponse: fromRes,
|
|
280
|
+
};
|
|
281
|
+
return metadata;
|
|
282
|
+
}
|
|
283
|
+
__deleteMember.fromReq = fromReq;
|
|
284
|
+
return __deleteMember;
|
|
285
|
+
}
|
|
286
|
+
exports.deleteMember = deleteMember;
|
|
287
|
+
/**
|
|
288
|
+
* Creates a site member.
|
|
289
|
+
*
|
|
290
|
+
* <!--ONLY:REST-->
|
|
291
|
+
* After creation, you can use
|
|
292
|
+
* [Send Set Password Email](https://dev.wix.com/api/rest/members/member-authentication/send-set-password-email)
|
|
293
|
+
* to email the member with a link to set their password.
|
|
294
|
+
* The member can log in to the site
|
|
295
|
+
* when they set their password for the first time.
|
|
296
|
+
*
|
|
297
|
+
* > **Note:**
|
|
298
|
+
* > When creating multiple members,
|
|
299
|
+
* > set your requests at least 1 second apart to keep below rate limits.
|
|
300
|
+
* <!--END:ONLY:REST-->
|
|
301
|
+
*/
|
|
302
|
+
function createMember(payload) {
|
|
303
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createMemberRequest, { _member });
|
|
304
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_createMemberResponse, { _member });
|
|
305
|
+
function __createMember({ host }) {
|
|
306
|
+
const serializedData = toReq(payload);
|
|
307
|
+
const metadata = {
|
|
308
|
+
entityFqdn: 'wix.members.v1.member',
|
|
309
|
+
method: 'POST',
|
|
310
|
+
methodFqn: 'com.wixpress.members.api.Members.CreateMember',
|
|
311
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
312
|
+
protoPath: '/v1/members',
|
|
313
|
+
data: serializedData,
|
|
314
|
+
host,
|
|
315
|
+
}),
|
|
316
|
+
data: serializedData,
|
|
317
|
+
transformResponse: fromRes,
|
|
318
|
+
};
|
|
319
|
+
return metadata;
|
|
320
|
+
}
|
|
321
|
+
__createMember.fromReq = fromReq;
|
|
322
|
+
return __createMember;
|
|
323
|
+
}
|
|
324
|
+
exports.createMember = createMember;
|
|
325
|
+
/**
|
|
326
|
+
* Updates a member's properties.
|
|
327
|
+
*
|
|
328
|
+
* <!--ONLY:REST-->
|
|
329
|
+
* To clear a field's value, set an empty value with an empty string `""`.
|
|
330
|
+
*
|
|
331
|
+
* To clear the member's addresses, emails, or phone numbers,
|
|
332
|
+
* use these endpoints:
|
|
333
|
+
*
|
|
334
|
+
* - To clear `contact.addresses`, use [`Delete Member Addresses`](https://dev.wix.com/api/rest/members/members/delete-member-addresses).
|
|
335
|
+
* - To clear `contact.emails`, use [`Delete Member Emails`](https://dev.wix.com/api/rest/members/members/delete-member-emails).
|
|
336
|
+
* - To clear `contact.phones`, use [`Delete Member Phones`](https://dev.wix.com/api/rest/members/members/delete-member-phones).
|
|
337
|
+
* <!--END:ONLY:REST-->
|
|
338
|
+
*
|
|
339
|
+
* <!--ONLY:VELO
|
|
340
|
+
* This function returns a Promise that resolves to a member object
|
|
341
|
+
* when the specified member is updated.
|
|
342
|
+
*
|
|
343
|
+
* > **Note:**
|
|
344
|
+
* > This function replaces the deprecated
|
|
345
|
+
* > `wixUsersBackend.updateUserFields()`.
|
|
346
|
+
* > The deprecated function will continue to work, but it will not receive updates.
|
|
347
|
+
* > To keep any existing code compatible with future changes, see the
|
|
348
|
+
* > [migration instructions](.wix-users-backend/updateuserfields#migration-instructions).
|
|
349
|
+
*
|
|
350
|
+
* Only the requested fields are updated.
|
|
351
|
+
*
|
|
352
|
+
* To clear the member's addresses, emails, or phone numbers,
|
|
353
|
+
* use these functions:
|
|
354
|
+
*
|
|
355
|
+
* - To clear `contact.addresses`, use [`deleteMemberAddresses()`](.wix-members-backend/members-obj/deletememberaddresses).
|
|
356
|
+
* - To clear `contact.emails`, use [`deleteMemberEmails()`](.wix-members-backend/members-obj/deletememberemails).
|
|
357
|
+
* - To clear `contact.phones`, use [`deleteMemberPhones()`](.wix-members-backend/members-obj/deletememberphones).
|
|
358
|
+
* <!--END:ONLY:VELO-->
|
|
359
|
+
*/
|
|
360
|
+
function updateMember(payload) {
|
|
361
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateMemberRequest, { _member });
|
|
362
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_updateMemberResponse, { _member });
|
|
363
|
+
function __updateMember({ host }) {
|
|
364
|
+
const serializedData = toReq(payload);
|
|
365
|
+
const metadata = {
|
|
366
|
+
entityFqdn: 'wix.members.v1.member',
|
|
367
|
+
method: 'PATCH',
|
|
368
|
+
methodFqn: 'com.wixpress.members.api.Members.UpdateMember',
|
|
369
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
370
|
+
protoPath: '/v1/members/{member.id}',
|
|
371
|
+
data: serializedData,
|
|
372
|
+
host,
|
|
373
|
+
}),
|
|
374
|
+
data: serializedData,
|
|
375
|
+
transformResponse: fromRes,
|
|
376
|
+
};
|
|
377
|
+
return metadata;
|
|
378
|
+
}
|
|
379
|
+
__updateMember.fromReq = fromReq;
|
|
380
|
+
return __updateMember;
|
|
381
|
+
}
|
|
382
|
+
exports.updateMember = updateMember;
|
|
383
|
+
/**
|
|
384
|
+
* Clears a member's phone numbers.
|
|
385
|
+
*
|
|
386
|
+
* <!--ONLY:VELO
|
|
387
|
+
* This function returns a Promise that resolves to a member object
|
|
388
|
+
* when the specified member's phone numbers are cleared.
|
|
389
|
+
*
|
|
390
|
+
* `deleteMemberPhones()` clears the `phones` array under the `contact` property.
|
|
391
|
+
* <!--END:ONLY:VELO-->
|
|
392
|
+
*/
|
|
393
|
+
function deleteMemberPhones(payload) {
|
|
394
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteMemberPhonesRequest, {});
|
|
395
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_deleteMemberPhonesResponse, {
|
|
396
|
+
_member,
|
|
397
|
+
});
|
|
398
|
+
function __deleteMemberPhones({ host }) {
|
|
399
|
+
const serializedData = toReq(payload);
|
|
400
|
+
const metadata = {
|
|
401
|
+
entityFqdn: 'wix.members.v1.member',
|
|
402
|
+
method: 'DELETE',
|
|
403
|
+
methodFqn: 'com.wixpress.members.api.Members.DeleteMemberPhones',
|
|
404
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
405
|
+
protoPath: '/v1/members/{id}/phones',
|
|
406
|
+
data: serializedData,
|
|
407
|
+
host,
|
|
408
|
+
}),
|
|
409
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
410
|
+
transformResponse: fromRes,
|
|
411
|
+
};
|
|
412
|
+
return metadata;
|
|
413
|
+
}
|
|
414
|
+
__deleteMemberPhones.fromReq = fromReq;
|
|
415
|
+
return __deleteMemberPhones;
|
|
416
|
+
}
|
|
417
|
+
exports.deleteMemberPhones = deleteMemberPhones;
|
|
418
|
+
/**
|
|
419
|
+
* Clears a member's email addresses.
|
|
420
|
+
*
|
|
421
|
+
* <!--ONLY:VELO
|
|
422
|
+
* This function returns a Promise that resolves to a member object
|
|
423
|
+
* when the specified member's email addresses are cleared.
|
|
424
|
+
*
|
|
425
|
+
* `deleteMemberEmails()` clears the `emails` array under the `contact` property.
|
|
426
|
+
* Other member
|
|
427
|
+
* [`updatedMember()`](.wix-members-backend/members-obj/updatemember)
|
|
428
|
+
*
|
|
429
|
+
* > **Note:**
|
|
430
|
+
* > The member can still log in with their `loginEmail`,
|
|
431
|
+
* > which is not cleared when this function is called.
|
|
432
|
+
* <!--END:ONLY:VELO-->
|
|
433
|
+
*/
|
|
434
|
+
function deleteMemberEmails(payload) {
|
|
435
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteMemberEmailsRequest, {});
|
|
436
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_deleteMemberEmailsResponse, {
|
|
437
|
+
_member,
|
|
438
|
+
});
|
|
439
|
+
function __deleteMemberEmails({ host }) {
|
|
440
|
+
const serializedData = toReq(payload);
|
|
441
|
+
const metadata = {
|
|
442
|
+
entityFqdn: 'wix.members.v1.member',
|
|
443
|
+
method: 'DELETE',
|
|
444
|
+
methodFqn: 'com.wixpress.members.api.Members.DeleteMemberEmails',
|
|
445
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
446
|
+
protoPath: '/v1/members/{id}/emails',
|
|
447
|
+
data: serializedData,
|
|
448
|
+
host,
|
|
449
|
+
}),
|
|
450
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
451
|
+
transformResponse: fromRes,
|
|
452
|
+
};
|
|
453
|
+
return metadata;
|
|
454
|
+
}
|
|
455
|
+
__deleteMemberEmails.fromReq = fromReq;
|
|
456
|
+
return __deleteMemberEmails;
|
|
457
|
+
}
|
|
458
|
+
exports.deleteMemberEmails = deleteMemberEmails;
|
|
459
|
+
/**
|
|
460
|
+
* Deletes a member's street addresses.
|
|
461
|
+
*
|
|
462
|
+
* <!--ONLY:VELO
|
|
463
|
+
* This function returns a Promise that resolves to a member object
|
|
464
|
+
* when the specified member's addresses are cleared.
|
|
465
|
+
* <!--END:ONLY:VELO-->
|
|
466
|
+
*
|
|
467
|
+
* `deleteMemberAddresses()` clears the `addresses` array under the `contact` property.
|
|
468
|
+
*/
|
|
469
|
+
function deleteMemberAddresses(payload) {
|
|
470
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteMemberAddressesRequest, {});
|
|
471
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_deleteMemberAddressesResponse, {
|
|
472
|
+
_member,
|
|
473
|
+
});
|
|
474
|
+
function __deleteMemberAddresses({ host }) {
|
|
475
|
+
const serializedData = toReq(payload);
|
|
476
|
+
const metadata = {
|
|
477
|
+
entityFqdn: 'wix.members.v1.member',
|
|
478
|
+
method: 'DELETE',
|
|
479
|
+
methodFqn: 'com.wixpress.members.api.Members.DeleteMemberAddresses',
|
|
480
|
+
url: resolveComWixpressMembersApiMembersUrl({
|
|
481
|
+
protoPath: '/v1/members/{id}/addresses',
|
|
482
|
+
data: serializedData,
|
|
483
|
+
host,
|
|
484
|
+
}),
|
|
485
|
+
params: (0, metro_runtime_1.toURLSearchParams)(serializedData),
|
|
486
|
+
transformResponse: fromRes,
|
|
487
|
+
};
|
|
488
|
+
return metadata;
|
|
489
|
+
}
|
|
490
|
+
__deleteMemberAddresses.fromReq = fromReq;
|
|
491
|
+
return __deleteMemberAddresses;
|
|
492
|
+
}
|
|
493
|
+
exports.deleteMemberAddresses = deleteMemberAddresses;
|
|
494
|
+
//# sourceMappingURL=members-v1-member.http.js.map
|