kustomer-client
    Preparing search index...

    Type Alias CustomerArchiveSearchData

    type CustomerArchiveSearchData = {
        body?: {
            and?:
                | { [key: string]: unknown }
                | {
                    "^kobject_.*_any_text$"?: { [key: string]: unknown };
                    "^kobject_.*_company_id$"?: { [key: string]: unknown };
                    "^kobject_.*_created_at$"?: { [key: string]: unknown };
                    "^kobject_.*_customer_id$"?: { [key: string]: unknown };
                    "^kobject_.*_id$"?: { [key: string]: unknown };
                    "^kobject_.*_updated_at$"?: { [key: string]: unknown };
                    company_created_at?: { [key: string]: unknown };
                    company_updated_at?: { [key: string]: unknown };
                    conversation_any_text?: { [key: string]: unknown };
                    conversation_created_at?: { [key: string]: unknown };
                    conversation_customer_id?: { [key: string]: unknown };
                    conversation_deleted?: { [key: string]: unknown };
                    conversation_id?: { [key: string]: unknown };
                    conversation_updated_at?: { [key: string]: unknown };
                    customer_any_text_new?: { [key: string]: unknown };
                    customer_companyId?: { [key: string]: unknown };
                    customer_created_at?: { [key: string]: unknown };
                    customer_deleted?: { [key: string]: unknown };
                    customer_id?: { [key: string]: unknown };
                    customer_updated_at?: { [key: string]: unknown };
                    kobject_any_text?: { [key: string]: unknown };
                    kobject_company_id?: { [key: string]: unknown };
                    kobject_created_at?: { [key: string]: unknown };
                    kobject_customer_id?: { [key: string]: unknown };
                    kobject_id?: { [key: string]: unknown };
                    kobject_updated_at?: { [key: string]: unknown };
                    message_any_text?: { [key: string]: unknown };
                    message_conversation_id?: { [key: string]: unknown };
                    message_created_at?: { [key: string]: unknown };
                    message_id?: { [key: string]: unknown };
                    message_updated_at?: { [key: string]: unknown };
                }[];
            includeDeleted?: boolean;
            not?: | { [key: string]: unknown }
            | {
                "^kobject_.*_any_text$"?: { [key: string]: unknown };
                "^kobject_.*_company_id$"?: { [key: string]: unknown };
                "^kobject_.*_created_at$"?: { [key: string]: unknown };
                "^kobject_.*_customer_id$"?: { [key: string]: unknown };
                "^kobject_.*_id$"?: { [key: string]: unknown };
                "^kobject_.*_updated_at$"?: { [key: string]: unknown };
                company_created_at?: { [key: string]: unknown };
                company_updated_at?: { [key: string]: unknown };
                conversation_any_text?: { [key: string]: unknown };
                conversation_created_at?: { [key: string]: unknown };
                conversation_customer_id?: { [key: string]: unknown };
                conversation_deleted?: { [key: string]: unknown };
                conversation_id?: { [key: string]: unknown };
                conversation_updated_at?: { [key: string]: unknown };
                customer_any_text_new?: { [key: string]: unknown };
                customer_companyId?: { [key: string]: unknown };
                customer_created_at?: { [key: string]: unknown };
                customer_deleted?: { [key: string]: unknown };
                customer_id?: { [key: string]: unknown };
                customer_updated_at?: { [key: string]: unknown };
                kobject_any_text?: { [key: string]: unknown };
                kobject_company_id?: { [key: string]: unknown };
                kobject_created_at?: { [key: string]: unknown };
                kobject_customer_id?: { [key: string]: unknown };
                kobject_id?: { [key: string]: unknown };
                kobject_updated_at?: { [key: string]: unknown };
                message_any_text?: { [key: string]: unknown };
                message_conversation_id?: { [key: string]: unknown };
                message_created_at?: { [key: string]: unknown };
                message_id?: { [key: string]: unknown };
                message_updated_at?: { [key: string]: unknown };
            }[];
            or?: | { [key: string]: unknown }
            | {
                "^kobject_.*_any_text$"?: { [key: string]: unknown };
                "^kobject_.*_company_id$"?: { [key: string]: unknown };
                "^kobject_.*_created_at$"?: { [key: string]: unknown };
                "^kobject_.*_customer_id$"?: { [key: string]: unknown };
                "^kobject_.*_id$"?: { [key: string]: unknown };
                "^kobject_.*_updated_at$"?: { [key: string]: unknown };
                company_created_at?: { [key: string]: unknown };
                company_updated_at?: { [key: string]: unknown };
                conversation_any_text?: { [key: string]: unknown };
                conversation_created_at?: { [key: string]: unknown };
                conversation_customer_id?: { [key: string]: unknown };
                conversation_deleted?: { [key: string]: unknown };
                conversation_id?: { [key: string]: unknown };
                conversation_updated_at?: { [key: string]: unknown };
                customer_any_text_new?: { [key: string]: unknown };
                customer_companyId?: { [key: string]: unknown };
                customer_created_at?: { [key: string]: unknown };
                customer_deleted?: { [key: string]: unknown };
                customer_id?: { [key: string]: unknown };
                customer_updated_at?: { [key: string]: unknown };
                kobject_any_text?: { [key: string]: unknown };
                kobject_company_id?: { [key: string]: unknown };
                kobject_created_at?: { [key: string]: unknown };
                kobject_customer_id?: { [key: string]: unknown };
                kobject_id?: { [key: string]: unknown };
                kobject_updated_at?: { [key: string]: unknown };
                message_any_text?: { [key: string]: unknown };
                message_conversation_id?: { [key: string]: unknown };
                message_created_at?: { [key: string]: unknown };
                message_id?: { [key: string]: unknown };
                message_updated_at?: { [key: string]: unknown };
            }[];
            queryContext?: string;
            sort?: { [key: string]: unknown }
            | { [key: string]: unknown }[];
            timeZone?: string;
        };
        path?: never;
        query?: never;
        url: "/customers/archive/search";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: {
        and?:
            | { [key: string]: unknown }
            | {
                "^kobject_.*_any_text$"?: { [key: string]: unknown };
                "^kobject_.*_company_id$"?: { [key: string]: unknown };
                "^kobject_.*_created_at$"?: { [key: string]: unknown };
                "^kobject_.*_customer_id$"?: { [key: string]: unknown };
                "^kobject_.*_id$"?: { [key: string]: unknown };
                "^kobject_.*_updated_at$"?: { [key: string]: unknown };
                company_created_at?: { [key: string]: unknown };
                company_updated_at?: { [key: string]: unknown };
                conversation_any_text?: { [key: string]: unknown };
                conversation_created_at?: { [key: string]: unknown };
                conversation_customer_id?: { [key: string]: unknown };
                conversation_deleted?: { [key: string]: unknown };
                conversation_id?: { [key: string]: unknown };
                conversation_updated_at?: { [key: string]: unknown };
                customer_any_text_new?: { [key: string]: unknown };
                customer_companyId?: { [key: string]: unknown };
                customer_created_at?: { [key: string]: unknown };
                customer_deleted?: { [key: string]: unknown };
                customer_id?: { [key: string]: unknown };
                customer_updated_at?: { [key: string]: unknown };
                kobject_any_text?: { [key: string]: unknown };
                kobject_company_id?: { [key: string]: unknown };
                kobject_created_at?: { [key: string]: unknown };
                kobject_customer_id?: { [key: string]: unknown };
                kobject_id?: { [key: string]: unknown };
                kobject_updated_at?: { [key: string]: unknown };
                message_any_text?: { [key: string]: unknown };
                message_conversation_id?: { [key: string]: unknown };
                message_created_at?: { [key: string]: unknown };
                message_id?: { [key: string]: unknown };
                message_updated_at?: { [key: string]: unknown };
            }[];
        includeDeleted?: boolean;
        not?: | { [key: string]: unknown }
        | {
            "^kobject_.*_any_text$"?: { [key: string]: unknown };
            "^kobject_.*_company_id$"?: { [key: string]: unknown };
            "^kobject_.*_created_at$"?: { [key: string]: unknown };
            "^kobject_.*_customer_id$"?: { [key: string]: unknown };
            "^kobject_.*_id$"?: { [key: string]: unknown };
            "^kobject_.*_updated_at$"?: { [key: string]: unknown };
            company_created_at?: { [key: string]: unknown };
            company_updated_at?: { [key: string]: unknown };
            conversation_any_text?: { [key: string]: unknown };
            conversation_created_at?: { [key: string]: unknown };
            conversation_customer_id?: { [key: string]: unknown };
            conversation_deleted?: { [key: string]: unknown };
            conversation_id?: { [key: string]: unknown };
            conversation_updated_at?: { [key: string]: unknown };
            customer_any_text_new?: { [key: string]: unknown };
            customer_companyId?: { [key: string]: unknown };
            customer_created_at?: { [key: string]: unknown };
            customer_deleted?: { [key: string]: unknown };
            customer_id?: { [key: string]: unknown };
            customer_updated_at?: { [key: string]: unknown };
            kobject_any_text?: { [key: string]: unknown };
            kobject_company_id?: { [key: string]: unknown };
            kobject_created_at?: { [key: string]: unknown };
            kobject_customer_id?: { [key: string]: unknown };
            kobject_id?: { [key: string]: unknown };
            kobject_updated_at?: { [key: string]: unknown };
            message_any_text?: { [key: string]: unknown };
            message_conversation_id?: { [key: string]: unknown };
            message_created_at?: { [key: string]: unknown };
            message_id?: { [key: string]: unknown };
            message_updated_at?: { [key: string]: unknown };
        }[];
        or?: | { [key: string]: unknown }
        | {
            "^kobject_.*_any_text$"?: { [key: string]: unknown };
            "^kobject_.*_company_id$"?: { [key: string]: unknown };
            "^kobject_.*_created_at$"?: { [key: string]: unknown };
            "^kobject_.*_customer_id$"?: { [key: string]: unknown };
            "^kobject_.*_id$"?: { [key: string]: unknown };
            "^kobject_.*_updated_at$"?: { [key: string]: unknown };
            company_created_at?: { [key: string]: unknown };
            company_updated_at?: { [key: string]: unknown };
            conversation_any_text?: { [key: string]: unknown };
            conversation_created_at?: { [key: string]: unknown };
            conversation_customer_id?: { [key: string]: unknown };
            conversation_deleted?: { [key: string]: unknown };
            conversation_id?: { [key: string]: unknown };
            conversation_updated_at?: { [key: string]: unknown };
            customer_any_text_new?: { [key: string]: unknown };
            customer_companyId?: { [key: string]: unknown };
            customer_created_at?: { [key: string]: unknown };
            customer_deleted?: { [key: string]: unknown };
            customer_id?: { [key: string]: unknown };
            customer_updated_at?: { [key: string]: unknown };
            kobject_any_text?: { [key: string]: unknown };
            kobject_company_id?: { [key: string]: unknown };
            kobject_created_at?: { [key: string]: unknown };
            kobject_customer_id?: { [key: string]: unknown };
            kobject_id?: { [key: string]: unknown };
            kobject_updated_at?: { [key: string]: unknown };
            message_any_text?: { [key: string]: unknown };
            message_conversation_id?: { [key: string]: unknown };
            message_created_at?: { [key: string]: unknown };
            message_id?: { [key: string]: unknown };
            message_updated_at?: { [key: string]: unknown };
        }[];
        queryContext?: string;
        sort?: { [key: string]: unknown }
        | { [key: string]: unknown }[];
        timeZone?: string;
    }

    Creates a query to retrieve the last updatedAt attribute to use in a subsequent request.

    {
    "and": [
    { "customer_updated_at": { "gte": "2016-01-01" } }
    ],
    "sort" : [{"customer_updated_at": "asc"}],
    "queryContext": "customer",
    "or":[]
    }

    Uses the returned updatedAt value from the previous request to page through all customer data and keep data up to date.

    {
    "and": [
    { "customer_updated_at": { "gte": "2016-07-27T22:30:48.939Z" } }
    ],
    "sort" : [{"customer_updated_at": "asc"}],
    "queryContext": "customer",
    "or":[]
    }
    path?: never
    query?: never
    url: "/customers/archive/search"

    Settings

    Member Visibility

    On This Page

    Properties