nylas/lib/types/resources/threads.d.ts

A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.

import { ListThreadsQueryParams, Thread, UpdateThreadRequest } from '../models/threads.js';
import { AsyncListResponse, Resource } from './resource.js';
import { Overrides } from '../config.js';
import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
/**
 * The parameters for the {@link Threads.list} method
 * @property identifier The identifier of the grant to act upon
 * @property queryParams The query parameters to include in the request
 */
export interface ListThreadsParams {
    identifier: string;
    queryParams?: ListThreadsQueryParams;
}
/**
 * The parameters for the {@link Threads.find} method
 * @property identifier The identifier of the grant to act upon
 * @property threadId The id of the thread to retrieve.
 * @property queryParams The query parameters to include in the request
 */
export interface FindThreadParams {
    identifier: string;
    threadId: string;
}
/**
 * The parameters for the {@link Threads.update} method
 * @property identifier The identifier of the grant to act upon
 * @property threadId The id of the thread to update
 * @property requestBody The values to update the thread with
 */
export interface UpdateThreadParams {
    identifier: string;
    threadId: string;
    requestBody: UpdateThreadRequest;
}
/**
 * The parameters for the {@link Threads.destroy} method
 * @property identifier The identifier of the grant to act upon
 * @property threadId The id of the thread to delete
 */
export interface DestroyThreadParams {
    identifier: string;
    threadId: string;
}
/**
 * Nylas Threads API
 *
 * The Nylas Threads API allows you to list, find, update, and delete threads on user accounts.
 */
export declare class Threads extends Resource {
    /**
     * Return all Threads
     * @return A list of threads
     */
    list({ identifier, queryParams, overrides, }: ListThreadsParams & Overrides): AsyncListResponse<NylasListResponse<Thread>>;
    /**
     * Return a Thread
     * @return The thread
     */
    find({ identifier, threadId, overrides, }: FindThreadParams & Overrides): Promise<NylasResponse<Thread>>;
    /**
     * Update a Thread
     * @return The updated thread
     */
    update({ identifier, threadId, requestBody, overrides, }: UpdateThreadParams & Overrides): Promise<NylasResponse<Thread>>;
    /**
     * Delete a Thread
     * @return The deleted thread
     */
    destroy({ identifier, threadId, overrides, }: DestroyThreadParams & Overrides): Promise<NylasBaseResponse>;
}