@wix/auto_sdk_members_members 1.0.13 → 1.0.15

package/build/internal/cjs/src/members-v1-member-members.types.d.ts

@@ -6,12 +6,12 @@ export interface Member {
      */
     id?: string | null;
     /**
-     * Email used by the member to log in to the site.
+     * Email used by a member to log in to the site.
      * @format EMAIL
      */
     loginEmail?: string | null;
     /**
-     * Whether the email used by the member has been verified.
+     * Whether the email used by a member has been verified.
      * @readonly
      */
     loginEmailVerified?: boolean | null;
@@ -31,7 +31,7 @@ export interface Member {
      * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
      *
      * The full set of contact data can be accessed and managed with the
-     * [Contacts API](https://dev.wix.com/api/rest/contacts/contacts).
+     * Contacts API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) | [REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction)).
      */
     contact?: Contact;
     /** Profile display details. */
@@ -62,28 +62,17 @@ export interface Member {
 export declare enum Status {
     /** Insufficient permissions to get the status. */
     UNKNOWN = "UNKNOWN",
-    /** Member created and is waiting for approval by site owner. */
+    /** Member is created and is waiting for approval by a Wix user. */
     PENDING = "PENDING",
     /** Member can log in to the site. */
     APPROVED = "APPROVED",
     /** Member is blocked and can't log in to the site. */
     BLOCKED = "BLOCKED",
-    /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and can't log in to the site. */
+    /** 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. */
     OFFLINE = "OFFLINE"
 }
 /** Contact info associated with the member. */
 export interface Contact {
-    /**
-     * Contact ID.
-     *
-     * > **Deprecation notice:**
-     * > This property has been replaced with `member.contactId`
-     * > and will be removed on June 11, 2021.
-     * @format GUID
-     * @readonly
-     * @deprecated
-     */
-    contactId?: string | null;
     /** Contact's first name. */
     firstName?: string | null;
     /** Contact's last name. */
@@ -201,7 +190,7 @@ export interface Profile {
     photo?: Image;
     /**
      * Member's cover photo,
-     * used as a background picture in members profile page.
+     * used as a background picture in a member's profile page.
      *
      * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
      * When left empty, the values default to `0`.
@@ -242,7 +231,7 @@ export interface Image {
 export declare enum PrivacyStatusStatus {
     /** Insufficient permissions to get the status. */
     UNKNOWN = "UNKNOWN",
-    /** Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions. */
+    /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
     PRIVATE = "PRIVATE",
     /** Member is visible to everyone. */
     PUBLIC = "PUBLIC"
@@ -403,7 +392,7 @@ export interface JoinCommunityResponse {
 }
 export interface MemberJoinedCommunity {
     /**
-     * Member id who joined the community
+     * ID of the member who joined the community.
      * @format GUID
      * @readonly
      */
@@ -418,7 +407,7 @@ export interface LeaveCommunityResponse {
 }
 export interface MemberLeftCommunity {
     /**
-     * Member id who left the community
+     * ID of the site member who left the community.
      * @format GUID
      * @readonly
      */
@@ -428,20 +417,7 @@ export interface GetMyMemberRequest {
     /**
      * Predefined set of fields to return.
      *
-     * - `"FULL"`: Returns all fields.
-     * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
-     *
-     * > **Note:**
-     * > When returning the `"PUBLIC"` fieldset,
-     * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
-     * > are returned as `"UNKNOWN"`.
-     * @deprecated
-     */
-    fieldSet?: Set;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: `PUBLIC`.
+     * Default: `"PUBLIC"`.
      * @maxSize 3
      */
     fieldsets?: Set[];
@@ -459,7 +435,7 @@ export declare enum Set {
 }
 /** Member profile. */
 export interface GetMyMemberResponse {
-    /** The requested member. */
+    /** The retrieved member. */
     member?: Member;
 }
 export interface GetMemberRequest {
@@ -471,7 +447,7 @@ export interface GetMemberRequest {
     /**
      * Predefined set of fields to return.
      *
-     * Defaults to `PUBLIC`.
+     * Defaults to `"PUBLIC"`.
      * @maxSize 3
      */
     fieldsets?: Set[];
@@ -492,7 +468,7 @@ export interface ListMembersRequest {
     /**
      * Predefined sets of fields to return.
      *
-     * Default: `PUBLIC`.
+     * Default: `"PUBLIC"`.
      * @maxSize 3
      */
     fieldsets?: Set[];
@@ -579,7 +555,7 @@ export interface QueryMembersRequest {
     /**
      * Predefined sets of fields to return.
      *
-     * Default: `PUBLIC`.
+     * Default: `"PUBLIC"`.
      * @maxSize 3
      */
     fieldsets?: Set[];
@@ -636,7 +612,7 @@ export interface MuteMemberResponse {
 }
 export interface MemberMuted {
     /**
-     * Member id who got muted
+     * ID of the member who got muted.
      * @format GUID
      * @readonly
      */
@@ -655,7 +631,7 @@ export interface UnmuteMemberResponse {
 }
 export interface MemberUnmuted {
     /**
-     * Member id who got unmuted
+     * ID of the member who got unmuted.
      * @format GUID
      * @readonly
      */
@@ -674,7 +650,7 @@ export interface ApproveMemberResponse {
 }
 export interface MemberApproved {
     /**
-     * Member id who got approved
+     * ID of the member who got approved.
      * @format GUID
      * @readonly
      */
@@ -693,7 +669,7 @@ export interface BlockMemberResponse {
 }
 export interface MemberBlocked {
     /**
-     * Member id who got blocked
+     * ID of the member who got blocked.
      * @format GUID
      * @readonly
      */
@@ -733,7 +709,7 @@ export interface DisconnectMemberResponse {
 }
 export interface DeleteMemberRequest {
     /**
-     * ID of the member to delete.
+     * ID of a member to delete.
      * @format GUID
      */
     id: string;
@@ -763,7 +739,7 @@ export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
 }
 export interface DeleteMyMemberRequest {
     /**
-     * ID of a member receiving deleted member's content.
+     * ID of a member receiving the deleted member's content.
      * @format GUID
      */
     contentAssigneeId?: string | null;
@@ -818,7 +794,7 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface BulkDeleteMembersByFilterRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    /** 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. */
     filter: any;
     /**
      * ID of a member receiving the deleted member's content.
@@ -831,29 +807,29 @@ export interface BulkDeleteMembersByFilterRequest {
 export interface BulkDeleteMembersByFilterResponse {
     /**
      * Job ID.
-     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     * 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.
      */
     jobId?: string;
 }
 export interface BulkApproveMembersRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    /** 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. */
     filter: any;
 }
 export interface BulkApproveMembersResponse {
     /**
      * Job ID.
-     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     * 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.
      */
     jobId?: string;
 }
 export interface BulkBlockMembersRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    /** 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. */
     filter: any;
 }
 export interface BulkBlockMembersResponse {
     /**
      * Job ID.
-     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     * 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.
      */
     jobId?: string;
 }
@@ -866,7 +842,7 @@ export interface CreateMemberResponse {
     member?: Member;
 }
 export interface UpdateMemberRequest {
-    /** Member to update. */
+    /** Member info to update. */
     member?: Member;
 }
 export interface UpdateMemberResponse {
@@ -1396,9 +1372,10 @@ export interface SiteUrlChanged {
  */
 export interface SitePurgedExternally {
     /**
-     * Either UUID or EmbeddedServiceType.
      * @maxLength 2048
      * @maxSize 100
+     * @deprecated
+     * @targetRemovalDate 2025-04-15
      */
     appDefId?: string[];
 }

package/build/internal/cjs/src/members-v1-member-members.types.js

@@ -5,20 +5,20 @@ var Status;
 (function (Status) {
     /** Insufficient permissions to get the status. */
     Status["UNKNOWN"] = "UNKNOWN";
-    /** Member created and is waiting for approval by site owner. */
+    /** Member is created and is waiting for approval by a Wix user. */
     Status["PENDING"] = "PENDING";
     /** Member can log in to the site. */
     Status["APPROVED"] = "APPROVED";
     /** Member is blocked and can't log in to the site. */
     Status["BLOCKED"] = "BLOCKED";
-    /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and can't log in to the site. */
+    /** 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. */
     Status["OFFLINE"] = "OFFLINE";
 })(Status || (exports.Status = Status = {}));
 var PrivacyStatusStatus;
 (function (PrivacyStatusStatus) {
     /** Insufficient permissions to get the status. */
     PrivacyStatusStatus["UNKNOWN"] = "UNKNOWN";
-    /** Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions. */
+    /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */
     PrivacyStatusStatus["PRIVATE"] = "PRIVATE";
     /** Member is visible to everyone. */
     PrivacyStatusStatus["PUBLIC"] = "PUBLIC";

package/build/internal/cjs/src/members-v1-member-members.types.js.map

@@ -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,gEAAgE;IAChE,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sDAAsD;IACtD,6BAAmB,CAAA;IACnB,gKAAgK;IAChK,6BAAmB,CAAA;AACrB,CAAC,EAXW,MAAM,sBAAN,MAAM,QAWjB;AAiLD,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,kDAAkD;IAClD,0CAAmB,CAAA;IACnB,0JAA0J;IAC1J,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;AAkND,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;AA4ND,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"}
+{"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"}