export interface CustomField { /** * Custom field ID. * @readonly */ _id?: string | null; /** Custom field title. */ name?: string | null; /** * Custom field key. * @readonly */ key?: string | null; /** Privacy level of the custom field. */ defaultPrivacy?: Privacy; /** Type of information to provide for members. */ fieldType?: Type; /** Social network type. */ socialType?: SocialTypeType; /** * Field origin. * @readonly */ fieldOrigin?: Origin; /** * Which members will have the custom field on their account. * @readonly */ appliesTo?: AppliesTo; /** * A section which the field belongs to. * @readonly */ section?: Section; /** * Date and time when the field was created. * @readonly */ _createdDate?: Date | null; /** * Date and time when the field was updated. * @readonly */ _updatedDate?: Date | null; /** Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. */ revision?: string | null; } export declare enum Privacy { /** Unknown privacy. This value isn't used. */ UNKNOWN = "UNKNOWN", /** The information appears on the members' public profile pages. */ PUBLIC = "PUBLIC", /** Only the member can see this information. */ PRIVATE = "PRIVATE" } export declare enum Type { /** Unknown field type. This value isn't used. */ UNKNOWN = "UNKNOWN", /** A text box to write any type of text. */ TEXT = "TEXT", /** Only number can be entered into the field. */ NUMBER = "NUMBER", /** Only date can be entered into the field. */ DATE = "DATE", /** Only URL can be entered into the field. */ URL = "URL", /** Only link from the selected social media platform can be entered into the field. */ SOCIAL = "SOCIAL" } export declare enum SocialTypeType { /** Unknown social type. This value isn't used. */ UNKNOWN = "UNKNOWN", /** Facebook social media platform. */ FACEBOOK = "FACEBOOK", /** Instagram social media platform. */ INSTAGRAM = "INSTAGRAM", /** LinkedIn social media platform. */ LINKEDIN = "LINKEDIN", /** X (Twitter) social media platform. */ TWITTER = "TWITTER", /** Youtube social media platform. */ YOUTUBE = "YOUTUBE", /** Pinterest social media platform. */ PINTEREST = "PINTEREST", /** TikTok social media platform. */ TIKTOK = "TIKTOK", /** DeviantArt social media platform. */ DEVIANTART = "DEVIANTART", /** SoundCloud social media platform. */ SOUNDCLOUD = "SOUNDCLOUD", /** Tumblr social media platform. */ TUMBLR = "TUMBLR", /** Vimeo social media platform. */ VIMEO = "VIMEO", /** VKontakte social media platform. */ VKONTAKTE = "VKONTAKTE", /** Odnoklassniki social media platform. */ ODNOKLASSNIKI = "ODNOKLASSNIKI", /** Other social media platform. */ OTHER = "OTHER" } export declare enum Origin { /** Unknown field origin. This value isn't used. */ UNKNOWN = "UNKNOWN", /** Custom field created by a Wix user. */ CUSTOM = "CUSTOM", /** Contact type of field. These are default fields that are already provided by Members Area, such as: "birth date", "position", "company". */ CONTACT = "CONTACT", /** System type of field. These are default fields that are already provided by Members Area, such as: "first name", "last name", "email", "phone", "address", "title". */ SYSTEM = "SYSTEM" } export declare enum AppliesTo { /** Everyone will have this field. */ ALL_MEMBERS = "ALL_MEMBERS", /** Only the members you choose will have this field. Call the [Create Custom Field Application](https://dev.wix.com/docs/rest/crm/members-contacts/members/custom-fields/custom-field-applications/create-custom-field-application) to apply the field for specific members. */ SELECTED_MEMBERS = "SELECTED_MEMBERS" } export declare enum Section { /** General section. All custom fields and the following default fields are assigned to this section: "first name", "last name", "email", "phone", "birth date", "position", "company". */ GENERAL = "GENERAL", /** Social media section. The "social media" field is assigned to this section. */ SOCIAL = "SOCIAL", /** Display info section. The default "title" field is assigned to this section. */ DISPLAY_INFO = "DISPLAY_INFO", /** Address section. The default "address" field is assigned to this section. */ ADDRESS = "ADDRESS" } export interface CreateCustomFieldRequest { /** Custom field to create. */ field: CustomField; } export interface CreateCustomFieldResponse { /** Custom field. */ field?: CustomField; } export interface IncorrectFieldTypeData { incorrectType?: Type; correctType?: Type; } export interface IncorrectPrivacyData { incorrectPrivacy?: Privacy; correctPrivacy?: Privacy; } export interface InvalidSocialTypeData { invalidSocialType?: SocialTypeType; } export interface GetCustomFieldRequest { /** Custom field ID. */ _id: string | null; } export interface GetCustomFieldResponse { /** The requested custom field. */ field?: CustomField; } export interface ListCustomFieldsRequest { paging?: Paging; } export interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface ListCustomFieldsResponse { /** Retrieved fields. */ fields?: CustomField[]; /** Metadata for the paginated results. */ metadata?: PagingMetadata; } export interface PagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; } export interface UpdateCustomFieldRequest { /** Custom field details to update. */ field: CustomField; } export interface UpdateCustomFieldResponse { /** Updated custom field. */ field?: CustomField; } export interface DefaultPrivacyChanged { fromPrivacy?: Privacy; toPrivacy?: Privacy; } export interface ReservedFieldNameNonEditable { newName?: string; currentName?: string; } export interface DeleteCustomFieldRequest { /** ID of the custom field to delete. */ _id: string | null; /** Revision number. */ revision: string | null; } export interface DeleteCustomFieldResponse { } export interface HideCustomFieldRequest { /** ID of the custom field to hide. */ _id: string | null; /** Revision number. */ revision: string | null; } export interface HideCustomFieldResponse { } export interface UpdateCustomFieldsOrderRequest { /** IDs of the custom fields to be reodered. */ fieldIds: string[]; /** The section which the fields belong to. */ section?: Section; } export interface UpdateCustomFieldsOrderResponse { /** Reordered custom fields. */ fields?: CustomField[]; /** The section which the fields belong to. */ section?: Section; } export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** A meta site id. */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * TODO(meta-site): Change validation once validations are disabled for consumers * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659 */ assets?: Asset[]; } /** @oneof */ export interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; } export interface Asset { /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */ appDefId?: string; /** An instance id. For legacy reasons may be UUID or a string. */ instanceId?: string; /** An application state. */ state?: State; } export declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } export interface SiteCreated { /** A template identifier (empty if not created from a template). */ originTemplateId?: string; /** An account id of the owner. */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContext; /** * A meta site id from which this site was created. * * In case of a creation from a template it's a template id. * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site. */ originMetaSiteId?: string | null; /** A meta site name (URL slug). */ siteName?: string; /** A namespace. */ namespace?: Namespace; } export declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } export declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** 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. */ SHOUT_OUT = "SHOUT_OUT", /** 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. */ ALBUMS = "ALBUMS", /** 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. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** 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. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_SITE = "DEV_SITE", /** 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. */ LOGOS = "LOGOS", /** 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. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE" } /** Site transferred to another user. */ export interface SiteTransferred { /** A previous owner id (user that transfers meta site). */ oldOwnerId?: string; /** A new owner id (user that accepts meta site). */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ export interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } export interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatus; /** A reason (flow). */ deleteOrigin?: string; /** A service that deleted it. */ initiatorId?: string | null; } export declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE" } /** Restoration of the meta site. */ export interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ export interface SitePublished { } export interface SiteUnpublished { /** A list of URLs previously associated with the meta site. */ urls?: string[]; } export interface SiteMarkedAsTemplate { } export interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ export interface ServiceProvisioned { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** An instance id from which this instance is originated. */ originInstanceId?: string; /** A version. */ version?: string | null; /** The origin meta site id */ originMetaSiteId?: string | null; } export interface ServiceRemoved { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** A version. */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ export interface SiteRenamed { /** A new meta site name (URL slug). */ newSiteName?: string; /** A previous meta site name (URL slug). */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ export interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } export interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: Namespace; /** A new namespace. */ newNamespace?: Namespace; } /** Assigned Studio editor */ export interface StudioAssigned { } /** Unassigned Studio editor */ export interface StudioUnassigned { } export interface Empty { } export interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * Example: created/updated/deleted/started/completed/email_opened */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ export interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } export interface EntityCreatedEvent { entity?: string; } export interface RestoreInfo { deletedDate?: Date | null; } export interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntity?: string; } export interface EntityDeletedEvent { /** Entity that was deleted */ deletedEntity?: string | null; } export interface ActionEvent { body?: string; } export interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } export interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType; } /** @oneof */ export interface IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } export declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } export interface CustomFieldNonNullableFields { defaultPrivacy: Privacy; fieldType: Type; socialType: SocialTypeType; fieldOrigin: Origin; appliesTo: AppliesTo; section: Section; } export interface CreateCustomFieldResponseNonNullableFields { field?: CustomFieldNonNullableFields; } export interface GetCustomFieldResponseNonNullableFields { field?: CustomFieldNonNullableFields; } export interface ListCustomFieldsResponseNonNullableFields { fields: CustomFieldNonNullableFields[]; } export interface UpdateCustomFieldResponseNonNullableFields { field?: CustomFieldNonNullableFields; } export interface UpdateCustomFieldsOrderResponseNonNullableFields { fields: CustomFieldNonNullableFields[]; section: Section; } /** * Creates a custom field. * @param field - Custom field to create. * @public * @documentationMaturity preview * @requiredField field * @requiredField field.name * @permissionId MEMBERS.CUSTOM_FIELDS_CREATE * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @applicableIdentity APP * @returns Custom field. * @fqn com.wixpress.members.customfields.CustomFields.CreateCustomField */ export declare function createCustomField(field: CustomField): Promise; /** * Retrieves a custom field by ID. * @param _id - Custom field ID. * @public * @documentationMaturity preview * @requiredField _id * @permissionId MEMBERS.CUSTOM_FIELDS_READ * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @permissionScope Read Members and Contacts - all read permissions * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS * @permissionScope Read Members * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS * @permissionScope Manage Members and Contacts - all permissions * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn com.wixpress.members.customfields.CustomFields.GetCustomField */ export declare function getCustomField(_id: string | null): Promise; /** * Retrieves a list of custom fields and fields provided by Members Area, given the provided paging. * * The fields are ordered by section in the following sequence: * - `GENERAL` * - `DISPLAY_INFO` * - `SOCIAL` * * The fields in the same section are ordered by the field creation date. * * To change the order of fields in sections, call [Update Custom Fields Order](https://dev.wix.com/docs/rest/crm/members-contacts/members/custom-fields/custom-fields/update-custom-fields-order). * @public * @documentationMaturity preview * @fqn com.wixpress.members.customfields.CustomFields.ListCustomFields */ export declare function listCustomFields(options?: ListCustomFieldsOptions): Promise; export interface ListCustomFieldsOptions { paging?: Paging; } /** * Updates a custom field. * * For custom fields you can update the following fields: `name`, `defaultPrivacy`, `socialType`. * * For fields provided by the Members Area you can only update the `defaultPrivacy` field. * @param _id - Custom field ID. * @public * @documentationMaturity preview * @requiredField _id * @requiredField field * @requiredField field.revision * @permissionId MEMBERS.CUSTOM_FIELDS_UPDATE * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @applicableIdentity APP * @returns Updated custom field. * @fqn com.wixpress.members.customfields.CustomFields.UpdateCustomField */ export declare function updateCustomField(_id: string | null, field: UpdateCustomField): Promise; export interface UpdateCustomField { /** * Custom field ID. * @readonly */ _id?: string | null; /** Custom field title. */ name?: string | null; /** * Custom field key. * @readonly */ key?: string | null; /** Privacy level of the custom field. */ defaultPrivacy?: Privacy; /** Type of information to provide for members. */ fieldType?: Type; /** Social network type. */ socialType?: SocialTypeType; /** * Field origin. * @readonly */ fieldOrigin?: Origin; /** * Which members will have the custom field on their account. * @readonly */ appliesTo?: AppliesTo; /** * A section which the field belongs to. * @readonly */ section?: Section; /** * Date and time when the field was created. * @readonly */ _createdDate?: Date | null; /** * Date and time when the field was updated. * @readonly */ _updatedDate?: Date | null; /** Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. */ revision?: string | null; } /** * Deletes a custom field. * * The related custom field in the contacts list is also be removed. * @param _id - ID of the custom field to delete. * @param revision - Revision number. * @public * @documentationMaturity preview * @requiredField _id * @requiredField revision * @permissionId MEMBERS.CUSTOM_FIELDS_DELETE * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @applicableIdentity APP * @fqn com.wixpress.members.customfields.CustomFields.DeleteCustomField */ export declare function deleteCustomField(_id: string | null, revision: string | null): Promise; /** * Hides a custom field. * * The hidden field is removed from the members custom fields list, yet it's still available as a suggested field to add later. * * The related contacts custom field will still be available in the contacts list. * @param _id - ID of the custom field to hide. * @param revision - Revision number. * @public * @documentationMaturity preview * @requiredField _id * @requiredField revision * @permissionId MEMBERS.CUSTOM_FIELDS_HIDE * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @applicableIdentity APP * @fqn com.wixpress.members.customfields.CustomFields.HideCustomField */ export declare function hideCustomField(_id: string | null, revision: string | null): Promise; /** * Updates the custom fields order in a section. * @param fieldIds - IDs of the custom fields to be reodered. * @public * @documentationMaturity preview * @requiredField fieldIds * @permissionId MEMBERS.CUSTOM_FIELDS_UPDATE * @permissionScope Manage Members * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS * @applicableIdentity APP * @fqn com.wixpress.members.customfields.CustomFields.UpdateCustomFieldsOrder */ export declare function updateCustomFieldsOrder(fieldIds: string[], options?: UpdateCustomFieldsOrderOptions): Promise; export interface UpdateCustomFieldsOrderOptions { /** The section which the fields belong to. */ section?: Section; }