nylas/lib/esm/resources/agentLists.js

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

import { makePathParams } from '../utils.js';
import { Resource } from './resource.js';
/**
 * Nylas Agent Account Lists API
 *
 * Lists manage values that rules can reference using the in_list operator.
 */
export class AgentLists extends Resource {
    /**
     * Return all lists.
     * @return The list of Agent Account lists.
     */
    list({ queryParams, overrides, } = {}) {
        return super._list({
            queryParams,
            path: makePathParams('/v3/lists', {}),
            overrides,
        });
    }
    /**
     * Return a list.
     * @return The Agent Account list.
     */
    find({ listId, overrides, }) {
        return super._find({
            path: makePathParams('/v3/lists/{listId}', { listId }),
            overrides,
        });
    }
    /**
     * Create a list.
     * @return The created Agent Account list.
     */
    create({ requestBody, overrides, }) {
        return super._create({
            path: makePathParams('/v3/lists', {}),
            requestBody,
            overrides,
        });
    }
    /**
     * Update a list.
     * @return The updated Agent Account list.
     */
    update({ listId, requestBody, overrides, }) {
        return super._update({
            path: makePathParams('/v3/lists/{listId}', { listId }),
            requestBody,
            overrides,
        });
    }
    /**
     * Delete a list.
     * @return The deletion response.
     */
    destroy({ listId, overrides, }) {
        return super._destroy({
            path: makePathParams('/v3/lists/{listId}', { listId }),
            overrides,
        });
    }
    /**
     * Return items in a list.
     * @return The list items.
     */
    listItems({ listId, queryParams, overrides, }) {
        return super._list({
            queryParams,
            path: makePathParams('/v3/lists/{listId}/items', { listId }),
            overrides,
        });
    }
    /**
     * Add items to a list.
     * @return The updated Agent Account list.
     */
    addItems({ listId, requestBody, overrides, }) {
        return super._create({
            path: makePathParams('/v3/lists/{listId}/items', { listId }),
            requestBody,
            overrides,
        });
    }
    /**
     * Remove items from a list.
     * @return The updated Agent Account list.
     */
    removeItems({ listId, requestBody, overrides, }) {
        return super._destroy({
            path: makePathParams('/v3/lists/{listId}/items', { listId }),
            requestBody,
            overrides,
        });
    }
}