@wix/auto_sdk_members_members 1.0.13 → 1.0.15
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/src/members-v1-member-members.context.d.ts +1 -1
- package/build/cjs/src/members-v1-member-members.context.js +1 -1
- package/build/cjs/src/members-v1-member-members.http.d.ts +8 -13
- package/build/cjs/src/members-v1-member-members.http.js +8 -13
- package/build/cjs/src/members-v1-member-members.http.js.map +1 -1
- package/build/cjs/src/members-v1-member-members.public.d.ts +11 -14
- package/build/cjs/src/members-v1-member-members.public.js.map +1 -1
- package/build/cjs/src/members-v1-member-members.types.d.ts +29 -52
- package/build/cjs/src/members-v1-member-members.types.js +3 -3
- package/build/cjs/src/members-v1-member-members.types.js.map +1 -1
- package/build/cjs/src/members-v1-member-members.universal.d.ts +40 -68
- package/build/cjs/src/members-v1-member-members.universal.js +15 -22
- package/build/cjs/src/members-v1-member-members.universal.js.map +1 -1
- package/build/es/src/members-v1-member-members.context.d.ts +1 -1
- package/build/es/src/members-v1-member-members.context.js +1 -1
- package/build/es/src/members-v1-member-members.http.d.ts +8 -13
- package/build/es/src/members-v1-member-members.http.js +8 -13
- package/build/es/src/members-v1-member-members.http.js.map +1 -1
- package/build/es/src/members-v1-member-members.public.d.ts +11 -14
- package/build/es/src/members-v1-member-members.public.js.map +1 -1
- package/build/es/src/members-v1-member-members.types.d.ts +29 -52
- package/build/es/src/members-v1-member-members.types.js +3 -3
- package/build/es/src/members-v1-member-members.types.js.map +1 -1
- package/build/es/src/members-v1-member-members.universal.d.ts +40 -68
- package/build/es/src/members-v1-member-members.universal.js +15 -22
- package/build/es/src/members-v1-member-members.universal.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.context.d.ts +1 -1
- package/build/internal/cjs/src/members-v1-member-members.context.js +1 -1
- package/build/internal/cjs/src/members-v1-member-members.http.d.ts +8 -13
- package/build/internal/cjs/src/members-v1-member-members.http.js +8 -13
- package/build/internal/cjs/src/members-v1-member-members.http.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.public.d.ts +11 -14
- package/build/internal/cjs/src/members-v1-member-members.public.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.types.d.ts +29 -52
- package/build/internal/cjs/src/members-v1-member-members.types.js +3 -3
- package/build/internal/cjs/src/members-v1-member-members.types.js.map +1 -1
- package/build/internal/cjs/src/members-v1-member-members.universal.d.ts +40 -76
- package/build/internal/cjs/src/members-v1-member-members.universal.js +15 -22
- package/build/internal/cjs/src/members-v1-member-members.universal.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.context.d.ts +1 -1
- package/build/internal/es/src/members-v1-member-members.context.js +1 -1
- package/build/internal/es/src/members-v1-member-members.http.d.ts +8 -13
- package/build/internal/es/src/members-v1-member-members.http.js +8 -13
- package/build/internal/es/src/members-v1-member-members.http.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.public.d.ts +11 -14
- package/build/internal/es/src/members-v1-member-members.public.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.types.d.ts +29 -52
- package/build/internal/es/src/members-v1-member-members.types.js +3 -3
- package/build/internal/es/src/members-v1-member-members.types.js.map +1 -1
- package/build/internal/es/src/members-v1-member-members.universal.d.ts +40 -76
- package/build/internal/es/src/members-v1-member-members.universal.js +15 -22
- package/build/internal/es/src/members-v1-member-members.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -5,20 +5,20 @@ var Status;
|
|
|
5
5
|
(function (Status) {
|
|
6
6
|
/** Insufficient permissions to get the status. */
|
|
7
7
|
Status["UNKNOWN"] = "UNKNOWN";
|
|
8
|
-
/** Member created and is waiting for approval by
|
|
8
|
+
/** Member is created and is waiting for approval by a Wix user. */
|
|
9
9
|
Status["PENDING"] = "PENDING";
|
|
10
10
|
/** Member can log in to the site. */
|
|
11
11
|
Status["APPROVED"] = "APPROVED";
|
|
12
12
|
/** Member is blocked and can't log in to the site. */
|
|
13
13
|
Status["BLOCKED"] = "BLOCKED";
|
|
14
|
-
/** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-
|
|
14
|
+
/** 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. */
|
|
15
15
|
Status["OFFLINE"] = "OFFLINE";
|
|
16
16
|
})(Status || (exports.Status = Status = {}));
|
|
17
17
|
var PrivacyStatusStatus;
|
|
18
18
|
(function (PrivacyStatusStatus) {
|
|
19
19
|
/** Insufficient permissions to get the status. */
|
|
20
20
|
PrivacyStatusStatus["UNKNOWN"] = "UNKNOWN";
|
|
21
|
-
/** Member is hidden from site visitors and other site members. Member is returned only to
|
|
21
|
+
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
22
22
|
PrivacyStatusStatus["PRIVATE"] = "PRIVATE";
|
|
23
23
|
/** Member is visible to everyone. */
|
|
24
24
|
PrivacyStatusStatus["PUBLIC"] = "PUBLIC";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"members-v1-member-members.types.js","sourceRoot":"","sources":["../../../src/members-v1-member-members.types.ts"],"names":[],"mappings":";;;AA8DA,IAAY,MAWX;AAXD,WAAY,MAAM;IAChB,kDAAkD;IAClD,6BAAmB,CAAA;IACnB,
|
|
1
|
+
{"version":3,"file":"members-v1-member-members.types.js","sourceRoot":"","sources":["../../../src/members-v1-member-members.types.ts"],"names":[],"mappings":";;;AA8DA,IAAY,MAWX;AAXD,WAAY,MAAM;IAChB,kDAAkD;IAClD,6BAAmB,CAAA;IACnB,mEAAmE;IACnE,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sDAAsD;IACtD,6BAAmB,CAAA;IACnB,kKAAkK;IAClK,6BAAmB,CAAA;AACrB,CAAC,EAXW,MAAM,sBAAN,MAAM,QAWjB;AAsKD,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,kDAAkD;IAClD,0CAAmB,CAAA;IACnB,wGAAwG;IACxG,0CAAmB,CAAA;IACnB,qCAAqC;IACrC,wCAAiB,CAAA;AACnB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AAED,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,kDAAkD;IAClD,2CAAmB,CAAA;IACnB,sDAAsD;IACtD,yCAAiB,CAAA;IACjB,uDAAuD;IACvD,uCAAe,CAAA;AACjB,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B;AAqMD,IAAY,GAUX;AAVD,WAAY,GAAG;IACb;;;OAGG;IACH,wBAAiB,CAAA;IACjB,oJAAoJ;IACpJ,4BAAqB,CAAA;IACrB,2BAA2B;IAC3B,oBAAa,CAAA;AACf,CAAC,EAVW,GAAG,mBAAH,GAAG,QAUd;AAiED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAwoBD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAgCD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA+EX;AA/ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;IACjD,uHAAuH;IACvH,kDAAqC,CAAA;IACrC,wHAAwH;IACxH,oDAAuC,CAAA;AACzC,CAAC,EA/EW,SAAS,yBAAT,SAAS,QA+EpB;AAuCD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;IAC/B,uDAAuC,CAAA;AACzC,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA6ND,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -6,12 +6,12 @@ export interface Member {
|
|
|
6
6
|
*/
|
|
7
7
|
_id?: string | null;
|
|
8
8
|
/**
|
|
9
|
-
* Email used by
|
|
9
|
+
* Email used by a member to log in to the site.
|
|
10
10
|
* @format EMAIL
|
|
11
11
|
*/
|
|
12
12
|
loginEmail?: string | null;
|
|
13
13
|
/**
|
|
14
|
-
* Whether the email used by
|
|
14
|
+
* Whether the email used by a member has been verified.
|
|
15
15
|
* @readonly
|
|
16
16
|
*/
|
|
17
17
|
loginEmailVerified?: boolean | null;
|
|
@@ -59,13 +59,13 @@ export interface Member {
|
|
|
59
59
|
export declare enum Status {
|
|
60
60
|
/** Insufficient permissions to get the status. */
|
|
61
61
|
UNKNOWN = "UNKNOWN",
|
|
62
|
-
/** Member created and is waiting for approval by
|
|
62
|
+
/** Member is created and is waiting for approval by a Wix user. */
|
|
63
63
|
PENDING = "PENDING",
|
|
64
64
|
/** Member can log in to the site. */
|
|
65
65
|
APPROVED = "APPROVED",
|
|
66
66
|
/** Member is blocked and can't log in to the site. */
|
|
67
67
|
BLOCKED = "BLOCKED",
|
|
68
|
-
/** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-
|
|
68
|
+
/** 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. */
|
|
69
69
|
OFFLINE = "OFFLINE"
|
|
70
70
|
}
|
|
71
71
|
/** Contact info associated with the member. */
|
|
@@ -189,7 +189,7 @@ export interface Profile {
|
|
|
189
189
|
photo?: Image;
|
|
190
190
|
/**
|
|
191
191
|
* Member's cover photo,
|
|
192
|
-
* used as a background picture in
|
|
192
|
+
* used as a background picture in a member's profile page.
|
|
193
193
|
*
|
|
194
194
|
* Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
|
|
195
195
|
* When left empty, the values default to `0`.
|
|
@@ -230,7 +230,7 @@ export interface Image {
|
|
|
230
230
|
export declare enum PrivacyStatusStatus {
|
|
231
231
|
/** Insufficient permissions to get the status. */
|
|
232
232
|
UNKNOWN = "UNKNOWN",
|
|
233
|
-
/** Member is hidden from site visitors and other site members. Member is returned only to
|
|
233
|
+
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
234
234
|
PRIVATE = "PRIVATE",
|
|
235
235
|
/** Member is visible to everyone. */
|
|
236
236
|
PUBLIC = "PUBLIC"
|
|
@@ -391,7 +391,7 @@ export interface JoinCommunityResponse {
|
|
|
391
391
|
}
|
|
392
392
|
export interface MemberJoinedCommunity {
|
|
393
393
|
/**
|
|
394
|
-
*
|
|
394
|
+
* ID of the member who joined the community.
|
|
395
395
|
* @format GUID
|
|
396
396
|
* @readonly
|
|
397
397
|
*/
|
|
@@ -406,7 +406,7 @@ export interface LeaveCommunityResponse {
|
|
|
406
406
|
}
|
|
407
407
|
export interface MemberLeftCommunity {
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* ID of the site member who left the community.
|
|
410
410
|
* @format GUID
|
|
411
411
|
* @readonly
|
|
412
412
|
*/
|
|
@@ -416,20 +416,7 @@ export interface GetMyMemberRequest {
|
|
|
416
416
|
/**
|
|
417
417
|
* Predefined set of fields to return.
|
|
418
418
|
*
|
|
419
|
-
*
|
|
420
|
-
* - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
|
|
421
|
-
*
|
|
422
|
-
* > **Note:**
|
|
423
|
-
* > When returning the `"PUBLIC"` fieldset,
|
|
424
|
-
* > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
|
|
425
|
-
* > are returned as `"UNKNOWN"`.
|
|
426
|
-
* @deprecated
|
|
427
|
-
*/
|
|
428
|
-
fieldSet?: Set;
|
|
429
|
-
/**
|
|
430
|
-
* Predefined set of fields to return.
|
|
431
|
-
*
|
|
432
|
-
* Default: `PUBLIC`.
|
|
419
|
+
* Default: `"PUBLIC"`.
|
|
433
420
|
* @maxSize 3
|
|
434
421
|
*/
|
|
435
422
|
fieldsets?: Set[];
|
|
@@ -573,7 +560,7 @@ export interface QueryMembersRequest {
|
|
|
573
560
|
/**
|
|
574
561
|
* Predefined sets of fields to return.
|
|
575
562
|
*
|
|
576
|
-
* Default: `PUBLIC`.
|
|
563
|
+
* Default: `"PUBLIC"`.
|
|
577
564
|
* @maxSize 3
|
|
578
565
|
*/
|
|
579
566
|
fieldsets?: Set[];
|
|
@@ -630,7 +617,7 @@ export interface MuteMemberResponse {
|
|
|
630
617
|
}
|
|
631
618
|
export interface MemberMuted {
|
|
632
619
|
/**
|
|
633
|
-
*
|
|
620
|
+
* ID of the member who got muted.
|
|
634
621
|
* @format GUID
|
|
635
622
|
* @readonly
|
|
636
623
|
*/
|
|
@@ -649,7 +636,7 @@ export interface UnmuteMemberResponse {
|
|
|
649
636
|
}
|
|
650
637
|
export interface MemberUnmuted {
|
|
651
638
|
/**
|
|
652
|
-
*
|
|
639
|
+
* ID of the member who got unmuted.
|
|
653
640
|
* @format GUID
|
|
654
641
|
* @readonly
|
|
655
642
|
*/
|
|
@@ -668,7 +655,7 @@ export interface ApproveMemberResponse {
|
|
|
668
655
|
}
|
|
669
656
|
export interface MemberApproved {
|
|
670
657
|
/**
|
|
671
|
-
*
|
|
658
|
+
* ID of the member who got approved.
|
|
672
659
|
* @format GUID
|
|
673
660
|
* @readonly
|
|
674
661
|
*/
|
|
@@ -687,7 +674,7 @@ export interface BlockMemberResponse {
|
|
|
687
674
|
}
|
|
688
675
|
export interface MemberBlocked {
|
|
689
676
|
/**
|
|
690
|
-
*
|
|
677
|
+
* ID of the member who got blocked.
|
|
691
678
|
* @format GUID
|
|
692
679
|
* @readonly
|
|
693
680
|
*/
|
|
@@ -727,7 +714,7 @@ export interface DisconnectMemberResponse {
|
|
|
727
714
|
}
|
|
728
715
|
export interface DeleteMemberRequest {
|
|
729
716
|
/**
|
|
730
|
-
* ID of
|
|
717
|
+
* ID of a member to delete.
|
|
731
718
|
* @format GUID
|
|
732
719
|
*/
|
|
733
720
|
_id: string;
|
|
@@ -757,7 +744,7 @@ export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
|
|
|
757
744
|
}
|
|
758
745
|
export interface DeleteMyMemberRequest {
|
|
759
746
|
/**
|
|
760
|
-
* ID of a member receiving deleted member's content.
|
|
747
|
+
* ID of a member receiving the deleted member's content.
|
|
761
748
|
* @format GUID
|
|
762
749
|
*/
|
|
763
750
|
contentAssigneeId?: string | null;
|
|
@@ -812,7 +799,7 @@ export interface BulkActionMetadata {
|
|
|
812
799
|
undetailedFailures?: number;
|
|
813
800
|
}
|
|
814
801
|
export interface BulkDeleteMembersByFilterRequest {
|
|
815
|
-
/** Query options. See
|
|
802
|
+
/** 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. */
|
|
816
803
|
filter: any;
|
|
817
804
|
/**
|
|
818
805
|
* ID of a member receiving the deleted member's content.
|
|
@@ -825,29 +812,29 @@ export interface BulkDeleteMembersByFilterRequest {
|
|
|
825
812
|
export interface BulkDeleteMembersByFilterResponse {
|
|
826
813
|
/**
|
|
827
814
|
* Job ID.
|
|
828
|
-
*
|
|
815
|
+
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
829
816
|
*/
|
|
830
817
|
jobId?: string;
|
|
831
818
|
}
|
|
832
819
|
export interface BulkApproveMembersRequest {
|
|
833
|
-
/** Query options. See
|
|
820
|
+
/** 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. */
|
|
834
821
|
filter: any;
|
|
835
822
|
}
|
|
836
823
|
export interface BulkApproveMembersResponse {
|
|
837
824
|
/**
|
|
838
825
|
* Job ID.
|
|
839
|
-
*
|
|
826
|
+
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
840
827
|
*/
|
|
841
828
|
jobId?: string;
|
|
842
829
|
}
|
|
843
830
|
export interface BulkBlockMembersRequest {
|
|
844
|
-
/** Query options. See
|
|
831
|
+
/** 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. */
|
|
845
832
|
filter: any;
|
|
846
833
|
}
|
|
847
834
|
export interface BulkBlockMembersResponse {
|
|
848
835
|
/**
|
|
849
836
|
* Job ID.
|
|
850
|
-
*
|
|
837
|
+
* Specify this ID when calling Get Async Job ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/get-async-job) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)) to retrieve job details and metadata.
|
|
851
838
|
*/
|
|
852
839
|
jobId?: string;
|
|
853
840
|
}
|
|
@@ -1388,9 +1375,10 @@ export interface SiteUrlChanged {
|
|
|
1388
1375
|
*/
|
|
1389
1376
|
export interface SitePurgedExternally {
|
|
1390
1377
|
/**
|
|
1391
|
-
* Either UUID or EmbeddedServiceType.
|
|
1392
1378
|
* @maxLength 2048
|
|
1393
1379
|
* @maxSize 100
|
|
1380
|
+
* @deprecated
|
|
1381
|
+
* @targetRemovalDate 2025-04-15
|
|
1394
1382
|
*/
|
|
1395
1383
|
appDefId?: string[];
|
|
1396
1384
|
}
|
|
@@ -1646,7 +1634,7 @@ export interface MemberCreatedEnvelope {
|
|
|
1646
1634
|
*
|
|
1647
1635
|
* The site owner can configure the site to automatically approve members or require manual approval.
|
|
1648
1636
|
*
|
|
1649
|
-
* A member who has been approved either automatically or manually has a `status` of `APPROVED`. A created member waiting for approval has a `status` of `PENDING`. A `PENDING` member
|
|
1637
|
+
* A member who has been approved either automatically or manually has a `status` of `"APPROVED"`. A created member waiting for approval has a `status` of `"PENDING"`. A `"PENDING"` member can't log in to the site.
|
|
1650
1638
|
* @permissionScope Manage Members
|
|
1651
1639
|
* @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
|
|
1652
1640
|
* @permissionScope Manage Bookings Services and Settings
|
|
@@ -1777,7 +1765,7 @@ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope)
|
|
|
1777
1765
|
*/
|
|
1778
1766
|
export declare function updateCurrentMemberSlug(slug: string): Promise<UpdateMySlugResponse & UpdateMySlugResponseNonNullableFields>;
|
|
1779
1767
|
/**
|
|
1780
|
-
* Updates
|
|
1768
|
+
* Updates a member's slug.
|
|
1781
1769
|
* @param _id - Member ID.
|
|
1782
1770
|
* @param slug - New slug.
|
|
1783
1771
|
* @public
|
|
@@ -1886,20 +1874,7 @@ export interface GetCurrentMemberOptions {
|
|
|
1886
1874
|
/**
|
|
1887
1875
|
* Predefined set of fields to return.
|
|
1888
1876
|
*
|
|
1889
|
-
*
|
|
1890
|
-
* - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
|
|
1891
|
-
*
|
|
1892
|
-
* > **Note:**
|
|
1893
|
-
* > When returning the `"PUBLIC"` fieldset,
|
|
1894
|
-
* > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
|
|
1895
|
-
* > are returned as `"UNKNOWN"`.
|
|
1896
|
-
* @deprecated
|
|
1897
|
-
*/
|
|
1898
|
-
fieldSet?: Set;
|
|
1899
|
-
/**
|
|
1900
|
-
* Predefined set of fields to return.
|
|
1901
|
-
*
|
|
1902
|
-
* Default: `PUBLIC`.
|
|
1877
|
+
* Default: `"PUBLIC"`.
|
|
1903
1878
|
* @maxSize 3
|
|
1904
1879
|
*/
|
|
1905
1880
|
fieldsets?: Set[];
|
|
@@ -1956,9 +1931,6 @@ export interface GetMemberOptions {
|
|
|
1956
1931
|
}
|
|
1957
1932
|
/**
|
|
1958
1933
|
* Lists site members, given the provided paging and fieldsets.
|
|
1959
|
-
*
|
|
1960
|
-
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
1961
|
-
* - `FULL` fieldset returns all fields.
|
|
1962
1934
|
* @public
|
|
1963
1935
|
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
1964
1936
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -2111,7 +2083,7 @@ export interface MembersQueryBuilder {
|
|
|
2111
2083
|
/**
|
|
2112
2084
|
* Mutes a member.
|
|
2113
2085
|
*
|
|
2114
|
-
* Muted members can't engage with a community. For example, leave comments, like
|
|
2086
|
+
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
2115
2087
|
*
|
|
2116
2088
|
* 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).
|
|
2117
2089
|
* @param _id - ID of the member to mute.
|
|
@@ -2127,7 +2099,7 @@ export declare function muteMember(_id: string): Promise<MuteMemberResponse & Mu
|
|
|
2127
2099
|
/**
|
|
2128
2100
|
* Unmutes a member.
|
|
2129
2101
|
*
|
|
2130
|
-
* Unmuted members can engage with the
|
|
2102
|
+
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
2131
2103
|
*
|
|
2132
2104
|
* 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).
|
|
2133
2105
|
* @param _id - ID of the member to unmute.
|
|
@@ -2141,7 +2113,7 @@ export declare function muteMember(_id: string): Promise<MuteMemberResponse & Mu
|
|
|
2141
2113
|
*/
|
|
2142
2114
|
export declare function unmuteMember(_id: string): Promise<UnmuteMemberResponse & UnmuteMemberResponseNonNullableFields>;
|
|
2143
2115
|
/**
|
|
2144
|
-
* Changes member status to `APPROVED` and gives access to members-only pages.
|
|
2116
|
+
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
2145
2117
|
*
|
|
2146
2118
|
* Call this API to:
|
|
2147
2119
|
* - Approve a pending member.
|
|
@@ -2196,7 +2168,7 @@ export declare function disconnectMember(_id: string): Promise<DisconnectMemberR
|
|
|
2196
2168
|
* The `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted.
|
|
2197
2169
|
*
|
|
2198
2170
|
* >**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored.
|
|
2199
|
-
* @param _id - ID of
|
|
2171
|
+
* @param _id - ID of a member to delete.
|
|
2200
2172
|
* @public
|
|
2201
2173
|
* @requiredField _id
|
|
2202
2174
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -2207,11 +2179,11 @@ export declare function disconnectMember(_id: string): Promise<DisconnectMemberR
|
|
|
2207
2179
|
*/
|
|
2208
2180
|
export declare function deleteMember(_id: string): Promise<void>;
|
|
2209
2181
|
/**
|
|
2210
|
-
* Deletes the
|
|
2182
|
+
* Deletes the current member.
|
|
2211
2183
|
*
|
|
2212
2184
|
* After calling this method, the member is logged out of the site.
|
|
2213
2185
|
*
|
|
2214
|
-
* 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 specified
|
|
2186
|
+
* 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.
|
|
2215
2187
|
*
|
|
2216
2188
|
* >**Note:**
|
|
2217
2189
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
@@ -2225,7 +2197,7 @@ export declare function deleteMember(_id: string): Promise<void>;
|
|
|
2225
2197
|
export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
|
|
2226
2198
|
export interface DeleteMyMemberOptions {
|
|
2227
2199
|
/**
|
|
2228
|
-
* ID of a member receiving deleted member's content.
|
|
2200
|
+
* ID of a member receiving the deleted member's content.
|
|
2229
2201
|
* @format GUID
|
|
2230
2202
|
*/
|
|
2231
2203
|
contentAssigneeId?: string | null;
|
|
@@ -2248,7 +2220,7 @@ export declare function bulkDeleteMembers(memberIds: string[]): Promise<BulkDele
|
|
|
2248
2220
|
* Deletes multiple members by the specified filter.
|
|
2249
2221
|
*
|
|
2250
2222
|
* 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.
|
|
2251
|
-
* @param filter - Query options. See
|
|
2223
|
+
* @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.
|
|
2252
2224
|
* @public
|
|
2253
2225
|
* @requiredField filter
|
|
2254
2226
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -2268,12 +2240,12 @@ export interface BulkDeleteMembersByFilterOptions {
|
|
|
2268
2240
|
search?: Search;
|
|
2269
2241
|
}
|
|
2270
2242
|
/**
|
|
2271
|
-
* Changes status of multiple members to `APPROVED`, and gives access to members-only pages.
|
|
2243
|
+
* Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
|
|
2272
2244
|
*
|
|
2273
2245
|
* Call this API to:
|
|
2274
2246
|
* - Approve pending members.
|
|
2275
2247
|
* - Unblock blocked members.
|
|
2276
|
-
* @param filter - Query options. See
|
|
2248
|
+
* @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.
|
|
2277
2249
|
* @public
|
|
2278
2250
|
* @requiredField filter
|
|
2279
2251
|
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
@@ -2289,7 +2261,7 @@ export declare function bulkApproveMembers(filter: any): Promise<BulkApproveMemb
|
|
|
2289
2261
|
* Blocked members can't log in to members-only pages.
|
|
2290
2262
|
*
|
|
2291
2263
|
* To unblock multiple members, call Bulk Approve Members.
|
|
2292
|
-
* @param filter - Query options. See
|
|
2264
|
+
* @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.
|
|
2293
2265
|
* @public
|
|
2294
2266
|
* @requiredField filter
|
|
2295
2267
|
* @permissionId MEMBERS.MEMBER_BLOCK
|
|
@@ -2374,12 +2346,12 @@ export interface UpdateMember {
|
|
|
2374
2346
|
*/
|
|
2375
2347
|
_id?: string | null;
|
|
2376
2348
|
/**
|
|
2377
|
-
* Email used by
|
|
2349
|
+
* Email used by a member to log in to the site.
|
|
2378
2350
|
* @format EMAIL
|
|
2379
2351
|
*/
|
|
2380
2352
|
loginEmail?: string | null;
|
|
2381
2353
|
/**
|
|
2382
|
-
* Whether the email used by
|
|
2354
|
+
* Whether the email used by a member has been verified.
|
|
2383
2355
|
* @readonly
|
|
2384
2356
|
*/
|
|
2385
2357
|
loginEmailVerified?: boolean | null;
|
|
@@ -32,20 +32,20 @@ var Status;
|
|
|
32
32
|
(function (Status) {
|
|
33
33
|
/** Insufficient permissions to get the status. */
|
|
34
34
|
Status["UNKNOWN"] = "UNKNOWN";
|
|
35
|
-
/** Member created and is waiting for approval by
|
|
35
|
+
/** Member is created and is waiting for approval by a Wix user. */
|
|
36
36
|
Status["PENDING"] = "PENDING";
|
|
37
37
|
/** Member can log in to the site. */
|
|
38
38
|
Status["APPROVED"] = "APPROVED";
|
|
39
39
|
/** Member is blocked and can't log in to the site. */
|
|
40
40
|
Status["BLOCKED"] = "BLOCKED";
|
|
41
|
-
/** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-
|
|
41
|
+
/** 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. */
|
|
42
42
|
Status["OFFLINE"] = "OFFLINE";
|
|
43
43
|
})(Status || (exports.Status = Status = {}));
|
|
44
44
|
var PrivacyStatusStatus;
|
|
45
45
|
(function (PrivacyStatusStatus) {
|
|
46
46
|
/** Insufficient permissions to get the status. */
|
|
47
47
|
PrivacyStatusStatus["UNKNOWN"] = "UNKNOWN";
|
|
48
|
-
/** Member is hidden from site visitors and other site members. Member is returned only to
|
|
48
|
+
/** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
|
|
49
49
|
PrivacyStatusStatus["PRIVATE"] = "PRIVATE";
|
|
50
50
|
/** Member is visible to everyone. */
|
|
51
51
|
PrivacyStatusStatus["PUBLIC"] = "PUBLIC";
|
|
@@ -251,7 +251,7 @@ async function updateCurrentMemberSlug(slug) {
|
|
|
251
251
|
}
|
|
252
252
|
exports.updateCurrentMemberSlug = updateCurrentMemberSlug;
|
|
253
253
|
/**
|
|
254
|
-
* Updates
|
|
254
|
+
* Updates a member's slug.
|
|
255
255
|
* @param _id - Member ID.
|
|
256
256
|
* @param slug - New slug.
|
|
257
257
|
* @public
|
|
@@ -425,7 +425,6 @@ async function getCurrentMember(options) {
|
|
|
425
425
|
// @ts-ignore
|
|
426
426
|
const { httpClient, sideEffects } = arguments[1];
|
|
427
427
|
const payload = (0, rename_all_nested_keys_1.renameKeysFromSDKRequestToRESTRequest)({
|
|
428
|
-
fieldSet: options?.fieldSet,
|
|
429
428
|
fieldsets: options?.fieldsets,
|
|
430
429
|
});
|
|
431
430
|
const reqOpts = ambassadorWixMembersV1Member.getMyMember(payload);
|
|
@@ -438,10 +437,7 @@ async function getCurrentMember(options) {
|
|
|
438
437
|
catch (err) {
|
|
439
438
|
const transformedError = (0, transform_error_1.transformError)(err, {
|
|
440
439
|
spreadPathsToArguments: {},
|
|
441
|
-
explicitPathsToArguments: {
|
|
442
|
-
fieldSet: '$[0].fieldSet',
|
|
443
|
-
fieldsets: '$[0].fieldsets',
|
|
444
|
-
},
|
|
440
|
+
explicitPathsToArguments: { fieldsets: '$[0].fieldsets' },
|
|
445
441
|
singleArgumentUnchanged: false,
|
|
446
442
|
}, ['options']);
|
|
447
443
|
sideEffects?.onError?.(err);
|
|
@@ -513,9 +509,6 @@ async function getMember(_id, options) {
|
|
|
513
509
|
exports.getMember = getMember;
|
|
514
510
|
/**
|
|
515
511
|
* Lists site members, given the provided paging and fieldsets.
|
|
516
|
-
*
|
|
517
|
-
* - `PUBLIC` fieldset returns `id` and `profile` object. `status`, `privacyStatus` and `activityStatus` are returned as `UNKNOWN`.
|
|
518
|
-
* - `FULL` fieldset returns all fields.
|
|
519
512
|
* @public
|
|
520
513
|
* @param options - Options for paging, sorting, and specifying fields to return.
|
|
521
514
|
* @permissionId MEMBERS.MEMBER_READ
|
|
@@ -673,7 +666,7 @@ exports.queryMembers = queryMembers;
|
|
|
673
666
|
/**
|
|
674
667
|
* Mutes a member.
|
|
675
668
|
*
|
|
676
|
-
* Muted members can't engage with a community. For example, leave comments, like
|
|
669
|
+
* Muted members can't engage with a community. For example, they can't leave comments, like posts or comments, or share content.
|
|
677
670
|
*
|
|
678
671
|
* 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).
|
|
679
672
|
* @param _id - ID of the member to mute.
|
|
@@ -710,7 +703,7 @@ exports.muteMember = muteMember;
|
|
|
710
703
|
/**
|
|
711
704
|
* Unmutes a member.
|
|
712
705
|
*
|
|
713
|
-
* Unmuted members can engage with the
|
|
706
|
+
* Unmuted members can engage with the community. For example, leave comments, like posts or comments, and share content.
|
|
714
707
|
*
|
|
715
708
|
* 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).
|
|
716
709
|
* @param _id - ID of the member to unmute.
|
|
@@ -745,7 +738,7 @@ async function unmuteMember(_id) {
|
|
|
745
738
|
}
|
|
746
739
|
exports.unmuteMember = unmuteMember;
|
|
747
740
|
/**
|
|
748
|
-
* Changes member status to `APPROVED` and gives access to members-only pages.
|
|
741
|
+
* Changes member status to `"APPROVED"` and gives access to members-only pages.
|
|
749
742
|
*
|
|
750
743
|
* Call this API to:
|
|
751
744
|
* - Approve a pending member.
|
|
@@ -863,7 +856,7 @@ exports.disconnectMember = disconnectMember;
|
|
|
863
856
|
* The `deleteMember()` function returns a Promise that resolves to a member object when the specified member is deleted.
|
|
864
857
|
*
|
|
865
858
|
* >**Note:** This function permanently deletes a member. Once deleted, a member cannot be restored.
|
|
866
|
-
* @param _id - ID of
|
|
859
|
+
* @param _id - ID of a member to delete.
|
|
867
860
|
* @public
|
|
868
861
|
* @requiredField _id
|
|
869
862
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -894,11 +887,11 @@ async function deleteMember(_id) {
|
|
|
894
887
|
}
|
|
895
888
|
exports.deleteMember = deleteMember;
|
|
896
889
|
/**
|
|
897
|
-
* Deletes the
|
|
890
|
+
* Deletes the current member.
|
|
898
891
|
*
|
|
899
892
|
* After calling this method, the member is logged out of the site.
|
|
900
893
|
*
|
|
901
|
-
* 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 specified
|
|
894
|
+
* 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.
|
|
902
895
|
*
|
|
903
896
|
* >**Note:**
|
|
904
897
|
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
|
|
@@ -975,7 +968,7 @@ exports.bulkDeleteMembers = bulkDeleteMembers;
|
|
|
975
968
|
* Deletes multiple members by the specified filter.
|
|
976
969
|
*
|
|
977
970
|
* 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.
|
|
978
|
-
* @param filter - Query options. See
|
|
971
|
+
* @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.
|
|
979
972
|
* @public
|
|
980
973
|
* @requiredField filter
|
|
981
974
|
* @permissionId MEMBERS.MEMBER_DELETE
|
|
@@ -1015,12 +1008,12 @@ async function bulkDeleteMembersByFilter(filter, options) {
|
|
|
1015
1008
|
}
|
|
1016
1009
|
exports.bulkDeleteMembersByFilter = bulkDeleteMembersByFilter;
|
|
1017
1010
|
/**
|
|
1018
|
-
* Changes status of multiple members to `APPROVED`, and gives access to members-only pages.
|
|
1011
|
+
* Changes status of multiple members to `"APPROVED"`, and gives access to members-only pages.
|
|
1019
1012
|
*
|
|
1020
1013
|
* Call this API to:
|
|
1021
1014
|
* - Approve pending members.
|
|
1022
1015
|
* - Unblock blocked members.
|
|
1023
|
-
* @param filter - Query options. See
|
|
1016
|
+
* @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.
|
|
1024
1017
|
* @public
|
|
1025
1018
|
* @requiredField filter
|
|
1026
1019
|
* @permissionId MEMBERS.MEMBER_APPROVE
|
|
@@ -1057,7 +1050,7 @@ exports.bulkApproveMembers = bulkApproveMembers;
|
|
|
1057
1050
|
* Blocked members can't log in to members-only pages.
|
|
1058
1051
|
*
|
|
1059
1052
|
* To unblock multiple members, call Bulk Approve Members.
|
|
1060
|
-
* @param filter - Query options. See
|
|
1053
|
+
* @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.
|
|
1061
1054
|
* @public
|
|
1062
1055
|
* @requiredField filter
|
|
1063
1056
|
* @permissionId MEMBERS.MEMBER_BLOCK
|