@wix/crm 1.0.0 → 1.0.2

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

@@ -0,0 +1,476 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** Extended field that was found or created. */
+export interface ExtendedField {
+    /**
+     * Extended field namespace.
+     *
+     * Extended fields created by site contributors 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 `extendedFields[key]`.
+     * For example, if the key is "custom.notes",
+     * the value can be accessed at `extendedFields["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.
+     *
+     * - `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.
+     *
+     * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
+     * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
+     * @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.
+     *
+     * - `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 it already existed, returns `false`.
+     */
+    newField?: boolean;
+}
+export interface GetExtendedFieldRequest {
+    /**
+     * Extended field key.
+     *
+     * When accessing contact data,
+     * extended field values are available at `info.extendedFields.items[key]`.
+     * For example, if the key is "custom.patronus",
+     * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
+     *
+     * 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;
+}
+/**
+ * Retrieves a custom field with a given name, or creates one if it doesn't exist.
+ *
+ * Successful calls to this endpoint always return a field,
+ * which can be passed to subsequent requests.
+ *
+ * To find an existing custom field without potentially creating a new one, use
+ * [Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or
+ * [List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField displayName
+ * @returns Extended field that was found or created.
+ */
+export declare function findOrCreateExtendedField(displayName: string, options?: FindOrCreateExtendedFieldOptions): Promise<FindOrCreateExtendedFieldResponse>;
+export interface FindOrCreateExtendedFieldOptions {
+    /**
+     * Type of data the field holds.
+     * Ignored if an existing field is an exact match
+     * for the specified display name.
+     *
+     * - `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;
+}
+/**
+ * Retrieves an extended field.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param key - Extended field key.
+ *
+ * When accessing contact data,
+ * extended field values are available at `info.extendedFields.items[key]`.
+ * For example, if the key is "custom.patronus",
+ * the value can be accessed at `info.extendedFields.items["custom.patronus"]`.
+ *
+ * Once set, `key` cannot be modified, even if `displayName` changes.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField key
+ * @returns The specified field.
+ */
+export declare function getExtendedField(key: string): Promise<ExtendedField>;
+/**
+ * Updates an extended field's specified properties.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param key - Extended field key.
+ *
+ * When accessing contact data,
+ * extended field data is available at `extendedFields[key]`.
+ * For example, if the key is "custom.notes",
+ * the value can be accessed at `extendedFields["custom.notes"]`.
+ *
+ * `key` is generated when the extended field is created
+ * and cannot be modified, even if `displayName` changes.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField key
+ * @requiredField options.field.displayName
+ * @returns Updated extended field.
+ */
+export declare function renameExtendedField(key: string, options?: RenameExtendedFieldOptions): Promise<ExtendedField>;
+export interface RenameExtendedFieldOptions {
+    field: {
+        /**
+         * Extended field namespace.
+         *
+         * Extended fields created by site contributors 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.
+         *
+         * - `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.
+         *
+         * - `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
+         * - `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.
+         * @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.
+ *
+ * When an extended field is deleted,
+ * any contact data stored in the field is permanently deleted as well.
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @param key - Extended field key.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField key
+ */
+export declare function deleteExtendedField(key: string): Promise<void>;
+/**
+ * Retrieves a list of extended fields.
+ *
+ * For a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ *
+ * This function is not a universal function and runs only on the backend.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryExtendedFields(): FieldsQueryBuilder;
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    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
+     */
+    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 {};