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

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

import { Overrides } from '../config.js';
import { CreatePolicyRequest, ListPoliciesQueryParams, Policy, UpdatePolicyRequest } from '../models/policies.js';
import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
import { AsyncListResponse, Resource } from './resource.js';
/**
 * @property queryParams The query parameters to include in the request.
 */
interface ListPoliciesParams {
    queryParams?: ListPoliciesQueryParams;
}
/**
 * @property policyId The ID of the policy to retrieve.
 */
interface FindPolicyParams {
    policyId: string;
}
/**
 * @property requestBody The values to create the policy with.
 */
interface CreatePolicyParams {
    requestBody: CreatePolicyRequest;
}
/**
 * @property policyId The ID of the policy to update.
 * @property requestBody The values to update the policy with.
 */
interface UpdatePolicyParams {
    policyId: string;
    requestBody: UpdatePolicyRequest;
}
/**
 * @property policyId The ID of the policy to delete.
 */
interface DestroyPolicyParams {
    policyId: string;
}
/**
 * Nylas Agent Account Policies API
 *
 * Policies define limits, spam settings, options, and linked rules for Agent Accounts.
 */
export declare class Policies extends Resource {
    /**
     * Return all policies.
     * @return The list of policies.
     */
    list({ queryParams, overrides, }?: ListPoliciesParams & Overrides): AsyncListResponse<NylasListResponse<Policy>>;
    /**
     * Return a policy.
     * @return The policy.
     */
    find({ policyId, overrides, }: FindPolicyParams & Overrides): Promise<NylasResponse<Policy>>;
    /**
     * Create a policy.
     * @return The created policy.
     */
    create({ requestBody, overrides, }: CreatePolicyParams & Overrides): Promise<NylasResponse<Policy>>;
    /**
     * Update a policy.
     * @return The updated policy.
     */
    update({ policyId, requestBody, overrides, }: UpdatePolicyParams & Overrides): Promise<NylasResponse<Policy>>;
    /**
     * Delete a policy.
     * @return The deletion response.
     */
    destroy({ policyId, overrides, }: DestroyPolicyParams & Overrides): Promise<NylasBaseResponse>;
}
export {};