@seven.io/client/dist/resources/hooks/types.d.ts

Official API client for seven

import { HOOK_EVENT_TYPES, HOOK_REQUEST_METHODS } from './constants';
export type HookEventType = (typeof HOOK_EVENT_TYPES)[number];
export type HookRequestMethod = (typeof HOOK_REQUEST_METHODS)[number];
export type HooksSubscribeParams = {
    eventFilter?: string;
    eventType: HookEventType;
    headers?: string;
    requestMethod?: HookRequestMethod;
    targetUrl: string;
};
export type HooksReadResponse = {
    hooks?: Hook[];
    success: boolean;
};
export type Hook = {
    enabled: boolean;
    created: Date;
    event_filter: null | string;
    event_type: HookEventType;
    headers: string;
    id: string;
    request_method: HookRequestMethod;
    target_url: string;
};
export type HooksSubscribeResponse = {
    error_message?: string;
    id?: number;
    success: boolean;
};
export type HooksUnsubscribeResponse = {
    success: boolean;
};
export type HookRcsStatusPayload = {
    agent_id: string;
    sender: string;
    status: 'IS_TYPING' | 'READ' | 'DELIVERED';
    foreign_id: string | null;
    msg_id: string;
    timestamp: string;
};
export type HookRcsTextPayload = {
    agent_id: string;
    content_type: 'text';
    foreign_id?: string;
    id: number;
    message_type: 'RCS';
    sender: string;
    text: string;
    time: number;
};
export type HookRcsSuggestionResponsePayload = {
    agent_id: string;
    content_type: 'suggestion_response';
    id: number;
    message_type: 'RCS';
    sender: string;
    suggestion_response: {
        postbackData: string;
        text: string;
        type: 'REPLY';
    };
    time: number;
};
export type HookRcsUserFilePayload = {
    agent_id: string;
    content_type: 'user_file';
    id: number;
    message_type: 'RCS';
    sender: string;
    time: number;
    user_file: {
        payload: {
            fileName: string;
            fileSizeBytes: number;
            fileUri: string;
            mimeType: string;
        };
    };
};
export type HookRcsUserFileImagePayload = {
    agent_id: string;
    content_type: 'user_file';
    id: number;
    message_type: 'RCS';
    sender: string;
    time: number;
    user_file: {
        payload: {
            fileName: string;
            fileSizeBytes: number;
            fileUri: string;
            mimeType: string;
        };
        thumbnail: {
            fileSizeBytes: number;
            fileUri: string;
            mimeType: string;
        };
    };
};
export type HookRcsLocationPayload = {
    agent_id: string;
    content_type: 'location';
    id: number;
    location: {
        latitude: number;
        longitude: number;
    };
    message_type: 'RCS';
    sender: string;
    time: number;
};
export type HookRcsPayload = HookRcsStatusPayload | HookRcsTextPayload | HookRcsSuggestionResponsePayload | HookRcsUserFilePayload | HookRcsUserFileImagePayload | HookRcsLocationPayload;
export declare function isHookRcsTextMessage(hook: HookRcsPayload): hook is HookRcsTextPayload;
export declare function isHookRcsFileMessage(hook: HookRcsPayload): hook is HookRcsUserFilePayload;
export declare function isHookRcsImageMessage(hook: HookRcsPayload): hook is HookRcsUserFileImagePayload;
export declare function isHookRcsStatusUpdate(hook: HookRcsPayload): hook is HookRcsStatusPayload;
export declare function isHookRcsLocation(hook: HookRcsPayload): hook is HookRcsLocationPayload;
export type InboundSmsPayload = {
    data: {
        id: string;
        message_type: 'SMS';
        sender: string;
        system: string;
        text: string;
        time: string;
    };
    webhook_event: 'sms_mo';
    webhook_timestamp: '2020-12-02 11:55:44';
};
export type SmsStatusChangePayload = {
    data: {
        msg_id: string;
        status: string;
        timestamp: string;
    };
    webhook_event: 'dlr';
    webhook_timestamp: string;
};
export type PerformanceTrackingPayload = {
    data: {
        final_url: string;
        sms_id: string;
        sms_label: null | string;
        total_clicks: number;
        total_views: number;
        tracking_url: string;
        type: 'click' | string;
    };
    'webhook_event': 'tracking';
    'webhook_timestamp': string;
};
export type VoiceStatusChangePayload = {
    data: {
        callerId: string;
        duration: string;
        id: string;
        pricePerMinute: number;
        recipient: string;
        status: 'completed' | string;
        timestamp: number;
    };
    webhook_event: 'voice_status';
    webhook_timestamp: string;
};
export type InboundCallPayload = {
    data: {
        caller: string;
        id: number;
        system: string;
        time: number;
    };
    webhook_event: "voice_call";
    webhook_timestamp: string;
};
export type DtmfPayload = {
    data: {
        callerId: string;
        dtmf_digit: number;
        duration: number;
        id: number;
        pricePerMinute: number;
        recipient: string;
        status: 'completed' | string;
        system: string;
        timestamp: number;
        total_price: number;
    };
    webhook_event: "voice_dtmf";
    webhook_timestamp: string;
};