import { ListCustomFieldSuggestionsRequest as ListCustomFieldSuggestionsRequest$1, ListCustomFieldSuggestionsResponse as ListCustomFieldSuggestionsResponse$1, QueryCustomFieldSuggestionsRequest as QueryCustomFieldSuggestionsRequest$1, QueryCustomFieldSuggestionsResponse as QueryCustomFieldSuggestionsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** A custom field that can be suggested for Wix users to add to member profiles. */ interface CustomFieldSuggestion { /** * Custom field name. * @maxLength 150 */ name?: string | null; /** Privacy level of the custom field. */ defaultPrivacy?: PrivacyWithLiterals; /** Type of information to provide for members. */ fieldType?: TypeWithLiterals; /** Social network type. */ socialType?: SocialTypeTypeWithLiterals; /** Field origin. */ fieldOrigin?: OriginWithLiterals; /** * Custom field ID. * @format GUID */ customFieldId?: string | null; } 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" } /** @enumType */ type PrivacyWithLiterals = Privacy | 'UNKNOWN' | 'PUBLIC' | 'PRIVATE'; declare enum Type { /** Unknown field type. This value isn't used. */ UNKNOWN = "UNKNOWN", /** A text box to write text. */ TEXT = "TEXT", /** Only a number can be entered into the field. */ NUMBER = "NUMBER", /** Only a date can be entered into the field. */ DATE = "DATE", /** Only a URL can be entered into the field. */ URL = "URL", /** Only a link from the selected social media platform can be entered into the field. */ SOCIAL = "SOCIAL" } /** @enumType */ type TypeWithLiterals = Type | 'UNKNOWN' | 'TEXT' | 'NUMBER' | 'DATE' | 'URL' | 'SOCIAL'; 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 (formerly 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" } /** @enumType */ type SocialTypeTypeWithLiterals = SocialTypeType | 'UNKNOWN' | 'FACEBOOK' | 'INSTAGRAM' | 'LINKEDIN' | 'TWITTER' | 'YOUTUBE' | 'PINTEREST' | 'TIKTOK' | 'DEVIANTART' | 'SOUNDCLOUD' | 'TUMBLR' | 'VIMEO' | 'VKONTAKTE' | 'ODNOKLASSNIKI' | 'OTHER'; 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 fields, such as: "first name", "last name", "email", "phone", "address", and "title". Some system fields are only available from the dashboard. */ SYSTEM = "SYSTEM" } /** @enumType */ type OriginWithLiterals = Origin | 'UNKNOWN' | 'CUSTOM' | 'CONTACT' | 'SYSTEM'; interface ListCustomFieldSuggestionsRequest { paging?: Paging; sorting?: Sorting[]; } interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; /** * Origin point for geo-distance sorting on a GEO field * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first). */ origin?: AddressLocation; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface AddressLocation { /** Address latitude. */ latitude?: number | null; /** Address longitude. */ longitude?: number | null; } interface ListCustomFieldSuggestionsResponse { /** Custom field suggestions. */ suggestions?: CustomFieldSuggestion[]; /** Metadata for the paginated results. */ metadata?: PagingMetadata; } 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; } interface QueryCustomFieldSuggestionsRequest { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ query?: Query; } interface Query { /** * Filter object. * * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section). */ filter?: any; /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ paging?: Paging; /** * Sort object. * * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section). */ sorting?: Sorting[]; } interface QueryCustomFieldSuggestionsResponse { /** Custom field suggestion. */ suggestions?: CustomFieldSuggestion[]; /** Metadata for the paginated results. */ metadata?: PagingMetadata; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function listCustomFieldSuggestions(): __PublicMethodMetaInfo<'GET', {}, ListCustomFieldSuggestionsRequest$1, ListCustomFieldSuggestionsRequest, ListCustomFieldSuggestionsResponse$1, ListCustomFieldSuggestionsResponse>; declare function queryCustomFieldSuggestions(): __PublicMethodMetaInfo<'POST', {}, QueryCustomFieldSuggestionsRequest$1, QueryCustomFieldSuggestionsRequest, QueryCustomFieldSuggestionsResponse$1, QueryCustomFieldSuggestionsResponse>; export { type AddressLocation as AddressLocationOriginal, type CustomFieldSuggestion as CustomFieldSuggestionOriginal, type ListCustomFieldSuggestionsRequest as ListCustomFieldSuggestionsRequestOriginal, type ListCustomFieldSuggestionsResponse as ListCustomFieldSuggestionsResponseOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type PagingMetadata as PagingMetadataOriginal, type Paging as PagingOriginal, Privacy as PrivacyOriginal, type PrivacyWithLiterals as PrivacyWithLiteralsOriginal, type QueryCustomFieldSuggestionsRequest as QueryCustomFieldSuggestionsRequestOriginal, type QueryCustomFieldSuggestionsResponse as QueryCustomFieldSuggestionsResponseOriginal, type Query as QueryOriginal, SocialTypeType as SocialTypeTypeOriginal, type SocialTypeTypeWithLiterals as SocialTypeTypeWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type __PublicMethodMetaInfo, listCustomFieldSuggestions, queryCustomFieldSuggestions };