@wix/crm 1.0.84 → 1.0.86

package/build/es/src/contacts-v4-extended-field.universal.d.ts

@@ -1,623 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/** Extended field that was found or created. */
-export interface ExtendedField {
-    /**
-     * Extended field namespace.
-     *
-     * Extended fields created by site collaborators or 3rd-party apps
-     * are automatically assigned to the `custom` namespace.
-     * @readonly
-     */
-    namespace?: string | null;
-    /**
-     * Extended field key.
-     *
-     * When accessing contact data,
-     * extended field data is available at `fields[key]`.
-     * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
-     *
-     * `key` is generated when the extended field is created
-     * and cannot be modified, even if `displayName` changes.
-     * @readonly
-     */
-    key?: string;
-    /** Display name shown in the Contact List. */
-    displayName?: string;
-    /**
-     * Type of data the field holds.
-     *
-     * One of:
-     * - `"TEXT"`: Accepts strings.
-     * - `"NUMBER"`: Accepts floats.
-     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
-     * @readonly
-     */
-    dataType?: FieldDataType;
-    /**
-     * Indicates whether the extended field is a system field or custom field.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
-     * @readonly
-     */
-    fieldType?: FieldType;
-    /**
-     * Date and time the field was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date and time the field was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * Field description, if the field is a system field.
-     * @readonly
-     */
-    description?: string | null;
-}
-export declare enum FieldDataType {
-    UNKNOWN_DATA_TYPE = "UNKNOWN_DATA_TYPE",
-    TEXT = "TEXT",
-    NUMBER = "NUMBER",
-    DATE = "DATE",
-    URL = "URL"
-}
-export declare enum FieldType {
-    UNKNOWN = "UNKNOWN",
-    SYSTEM = "SYSTEM",
-    USER_DEFINED = "USER_DEFINED"
-}
-/** Extended field filter options. */
-export interface ListExtendedFieldsRequest {
-    /** Filter for fields of the specified type. */
-    fieldType?: FieldType;
-    /**
-     * Filter for fields in the specified namespace.
-     * Fields created by site contributors or 3rd-party apps
-     * are automatically assigned to the `custom` namespace.
-     */
-    namespace?: string | null;
-    /** Filter for fields where `displayName` starts with the specified case-sensitive string. */
-    startsWith?: string | null;
-    /** Sorting options. */
-    sort?: Sorting;
-    /** Paging options. */
-    paging?: Paging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /**
-     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Defaults to `ASC`.
-     */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /**
-     * Number of items to return.
-     *
-     * Defaults to `100`.
-     */
-    limit?: number | null;
-    /**
-     * Number of items to skip in the current sort order.
-     *
-     * Defaults to `0`.
-     */
-    offset?: number | null;
-}
-/** List of extended fields. */
-export interface ListExtendedFieldsResponse {
-    /** List of extended fields. */
-    fields?: ExtendedField[];
-    /** Metadata for the page of results. */
-    metadata?: PagingMetadata;
-}
-export interface PagingMetadata {
-    /** Number of items returned. */
-    count?: number | null;
-    /** Requested offset. */
-    offset?: number | null;
-    /** Number of items that matched the query. */
-    total?: number | null;
-    /**
-     * Indicates if `total` calculation timed out before the response was sent.
-     * Typically this happens if there is a large set of results.
-     */
-    tooManyToCount?: boolean | null;
-}
-/** Custom field to find or create. */
-export interface FindOrCreateExtendedFieldRequest {
-    /**
-     * Display name to find or create.
-     *
-     * If an existing custom field is an exact match
-     * for the specified `displayName`,
-     * the existing field is returned.
-     * If not, a new field is created and returned.
-     */
-    displayName: string;
-    /**
-     * Type of data the field holds.
-     * Ignored if an existing field is an exact match
-     * for the specified display name. One of:
-     *
-     * - `"TEXT"`: Accepts strings.
-     * - `"NUMBER"`: Accepts floats.
-     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
-     */
-    dataType?: FieldDataType;
-}
-/** Extended field that was found or created. */
-export interface FindOrCreateExtendedFieldResponse {
-    /** Extended field that was found or created. */
-    field?: ExtendedField;
-    /**
-     * Indicates whether the extended field was just created or already existed.
-     *
-     * If the field was just created, returns `true`.
-     * If the field already existed, returns `false`.
-     */
-    newField?: boolean;
-}
-export interface GetExtendedFieldRequest {
-    /**
-     * Extended field key.
-     *
-     * When accessing contact data,
-     * extended field values are available at `fields[key]`.
-     * For example, if the key is "custom.notes",
-     * the value can be accessed at `fields["custom.notes"]`.
-     *
-     * Once set, `key` cannot be modified, even if `displayName` changes.
-     */
-    key: string;
-}
-/** The specified field. */
-export interface GetExtendedFieldResponse {
-    /** The specified field. */
-    field?: ExtendedField;
-}
-export interface GetExtendedFieldByLegacyIdRequest {
-    legacyId?: string;
-}
-export interface GetExtendedFieldByLegacyIdResponse {
-    field?: ExtendedField;
-}
-export interface UpdateExtendedFieldRequest {
-    /** Field to update. */
-    field?: ExtendedField;
-}
-/** Updated extended field. */
-export interface UpdateExtendedFieldResponse {
-    /** Updated extended field. */
-    field?: ExtendedField;
-}
-export interface DeleteExtendedFieldRequest {
-    /** Extended field key. */
-    key: string;
-}
-export interface DeleteExtendedFieldResponse {
-}
-export interface PurgeRequest {
-    instanceId?: string;
-}
-export interface PurgeResponse {
-    deletedItems?: number;
-}
-export interface GdprListRequest {
-    instanceId?: string;
-}
-export interface GdprListResponse {
-    fields?: ExtendedField[];
-}
-export interface QueryExtendedFieldsRequest {
-    /** Query options. */
-    query?: Query;
-}
-export interface Query {
-    /**
-     * ilter object.
-     *
-     * Possible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
-     *
-     * For a detailed list of supported filters, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter).
-     *
-     * Example: `{ "filter": {
-     * "displayName": {
-     * "$startsWith": "Referral"
-     * }
-     * }
-     * }`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sorting options. Currently supports sorting on one field only.
-     *
-     * Example: `{ "sort": [{"fieldName": "displayName", "order": "DESC"}] }`
-     */
-    sort?: Sorting[];
-    /** Pagination options. */
-    paging?: Paging;
-}
-export interface QueryExtendedFieldsResponse {
-    /** List of extended fields. */
-    fields?: ExtendedField[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PagingMetadata;
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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. */
-    eventTime?: Date;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface FindOrCreateExtendedFieldResponseNonNullableFields {
-    field?: {
-        key: string;
-        displayName: string;
-        dataType: FieldDataType;
-        fieldType: FieldType;
-    };
-    newField: boolean;
-}
-export interface GetExtendedFieldResponseNonNullableFields {
-    field?: {
-        key: string;
-        displayName: string;
-        dataType: FieldDataType;
-        fieldType: FieldType;
-    };
-}
-export interface UpdateExtendedFieldResponseNonNullableFields {
-    field?: {
-        key: string;
-        displayName: string;
-        dataType: FieldDataType;
-        fieldType: FieldType;
-    };
-}
-export interface QueryExtendedFieldsResponseNonNullableFields {
-    fields: {
-        key: string;
-        displayName: string;
-        dataType: FieldDataType;
-        fieldType: FieldType;
-    }[];
-}
-export declare const onExtendedFieldCreated: EventDefinition<DomainCreatedEvent<ExtendedField>, "wix.contacts.v4.extended_field_created">;
-export declare const onExtendedFieldUpdated: EventDefinition<DomainUpdatedEvent<ExtendedField>, "wix.contacts.v4.extended_field_updated">;
-export declare const onExtendedFieldDeleted: EventDefinition<DomainDeletedEvent<ExtendedField>, "wix.contacts.v4.extended_field_deleted">;
-/**
- * Retrieves a custom field with a given name, or creates one if it doesn't exist.
- *
- * The `findOrCreateExtendedField()` function returns a Promise that resolves when the specified custom field is found or created.
- *
- * Successful calls to `findOrCreateExtendedField()` always return an extended field, which can be passed to subsequent function calls.
- *
- * To find an existing extended field without potentially creating a new one, use `getExtendedField()` or `queryExtendedFields()`.
- *
- * @param displayName - Display name to find or create.
- *
- * If an existing custom field is an exact match
- * for the specified `displayName`,
- * the existing field is returned.
- * If not, a new field is created and returned.
- * @param dataType - Type of data the field holds.
- * Ignored if an existing field is an exact match
- * for the specified display name. One of:
- *
- * - `"TEXT"`: Accepts strings.
- * - `"NUMBER"`: Accepts floats.
- * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
- * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
- * @public
- * @documentationMaturity preview
- * @requiredField dataType
- * @requiredField displayName
- * @permissionScope Manage Contact Extended Fields
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns Extended field that was found or created.
- */
-export declare function findOrCreateExtendedField(displayName: string, dataType: FieldDataType): Promise<FindOrCreateExtendedFieldResponse & FindOrCreateExtendedFieldResponseNonNullableFields>;
-/**
- * Retrieves an extended field.
- *
- * The `getExtendedField()` function returns a Promise that resolves when the extended field is retrieved.
- *
- * @public
- * @documentationMaturity preview
- * @requiredField key
- * @param key - Extended field key.
- *
- * When accessing contact data,
- * extended field values are available at `fields[key]`.
- * For example, if the key is "custom.notes",
- * the value can be accessed at `fields["custom.notes"]`.
- *
- * Once set, `key` cannot be modified, even if `displayName` changes.
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Contact Extended Fields
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns The specified field.
- */
-export declare function getExtendedField(key: string): Promise<ExtendedField & NonNullable<GetExtendedFieldResponseNonNullableFields>['field']>;
-/**
- * Renames an extended field.
- *
- * The `renameExtendedField()` function returns a Promise that resolves when the specified extended field's display name is changed
- *
- * @public
- * @documentationMaturity preview
- * @requiredField field
- * @requiredField field.displayName
- * @requiredField key
- * @param key - Extended field key.
- *
- * When accessing contact data,
- * extended field values are available at `fields[key]`.
- * For example, if the key is "custom.notes",
- * the value can be accessed at `fields["custom.notes"]`.
- *
- * Once set, `key` cannot be modified, even if `displayName` changes.
- * @param field - Extended field to rename.
- * @permissionScope Manage Contact Extended Fields
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- * @returns Updated extended field.
- */
-export declare function renameExtendedField(key: string, field: RenameExtendedField): Promise<ExtendedField & NonNullable<UpdateExtendedFieldResponseNonNullableFields>['field']>;
-export interface RenameExtendedField {
-    /**
-     * Extended field namespace.
-     *
-     * Extended fields created by site collaborators or 3rd-party apps
-     * are automatically assigned to the `custom` namespace.
-     * @readonly
-     */
-    namespace?: string | null;
-    /** Display name shown in the Contact List. */
-    displayName?: string;
-    /**
-     * Type of data the field holds.
-     *
-     * One of:
-     * - `"TEXT"`: Accepts strings.
-     * - `"NUMBER"`: Accepts floats.
-     * - `"DATE"`: Accepts dates formatted as `YYYY-MM-DD`.
-     * - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
-     * @readonly
-     */
-    dataType?: FieldDataType;
-    /**
-     * Indicates whether the extended field is a system field or custom field.
-     *
-     * One of:
-     * - `"SYSTEM"`: System field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
-     * - `"USER_DEFINED"`: Custom field that can be modified by 3rd-party apps or site admins.
-     * @readonly
-     */
-    fieldType?: FieldType;
-    /**
-     * Date and time the field was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date and time the field was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /**
-     * Field description, if the field is a system field.
-     * @readonly
-     */
-    description?: string | null;
-}
-/**
- * Deletes an extended field.
- *
- * The `deleteExtendedField()` function returns a Promise that resolves when the specified extended field is deleted.
- *
- * When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
- *
- * @param key - Extended field key.
- * @public
- * @documentationMaturity preview
- * @requiredField key
- * @permissionScope Manage Contact Extended Fields
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- */
-export declare function deleteExtendedField(key: string): Promise<void>;
-/**
- * Creates a query to retrieve a list of extended fields.
- *
- * The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an `FieldsQueryBuilder` object.
- *
- * The returned object contains the query definition, which is used to run the query using the `find()` function.
- *
- * You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
- *
- * `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
- * - `skip()`
- * - `limit(50)`
- * - `descending('_createdDate')`
- *
- * The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the `items` property in `FieldsQueryResult`.
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Contact Extended Fields
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS
- * @permissionScope Manage Members and Contacts - all permissions
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
- * @applicableIdentity APP
- */
-export declare function queryExtendedFields(): FieldsQueryBuilder;
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface FieldsQueryResult extends QueryOffsetResult {
-    items: ExtendedField[];
-    query: FieldsQueryBuilder;
-    next: () => Promise<FieldsQueryResult>;
-    prev: () => Promise<FieldsQueryResult>;
-}
-export interface FieldsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    eq: (propertyName: 'namespace' | 'key' | 'displayName' | 'dataType' | 'fieldType' | '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ne: (propertyName: 'namespace' | 'key' | 'displayName' | 'dataType' | '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => FieldsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
-     */
-    startsWith: (propertyName: 'displayName', value: string) => FieldsQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: 'key' | 'displayName', value: any) => FieldsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    ascending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => FieldsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    descending: (...propertyNames: Array<'displayName' | '_createdDate' | '_updatedDate'>) => FieldsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
-    limit: (limit: number) => FieldsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results.
-     * @documentationMaturity preview
-     */
-    skip: (skip: number) => FieldsQueryBuilder;
-    /** @documentationMaturity preview */
-    find: () => Promise<FieldsQueryResult>;
-}
-export {};