nylas/lib/esm/resources/rules.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 Rules API
 *
 * Rules define inbound and outbound filtering logic for Agent Accounts.
 */
export class Rules extends Resource {
    /**
     * Return all rules.
     * @return The list of rules.
     */
    list({ queryParams, overrides, } = {}) {
        return super._list({
            queryParams,
            path: makePathParams('/v3/rules', {}),
            overrides,
        });
    }
    /**
     * Return a rule.
     * @return The rule.
     */
    find({ ruleId, overrides, }) {
        return super._find({
            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
            overrides,
        });
    }
    /**
     * Create a rule.
     * @return The created rule.
     */
    create({ requestBody, overrides, }) {
        return super._create({
            path: makePathParams('/v3/rules', {}),
            requestBody,
            overrides,
        });
    }
    /**
     * Update a rule.
     * @return The updated rule.
     */
    update({ ruleId, requestBody, overrides, }) {
        return super._update({
            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
            requestBody,
            overrides,
        });
    }
    /**
     * Delete a rule.
     * @return The deletion response.
     */
    destroy({ ruleId, overrides, }) {
        return super._destroy({
            path: makePathParams('/v3/rules/{ruleId}', { ruleId }),
            overrides,
        });
    }
    /**
     * Return rule evaluation records for a grant.
     * @return The list of rule evaluation records.
     */
    listEvaluations({ identifier, queryParams, overrides, }) {
        return super._list({
            queryParams,
            path: makePathParams('/v3/grants/{identifier}/rule-evaluations', {
                identifier,
            }),
            overrides,
        });
    }
}