@sendgrid/client/src/client.d.ts

Twilio SendGrid NodeJS API client

import {ResponseError} from "@sendgrid/helpers/classes";
import {ClientRequest} from "@sendgrid/client/src/request";
import {ClientResponse} from "@sendgrid/client/src/response";

declare class Client {
  constructor();

  /**
   * Set the SendGrid API key.
   */
  setApiKey(apiKey: string): void;

  /**
   * Set the Twilio Email credentials.
   */
  setTwilioEmailAuth(username: string, password: string): void;

  /**
   * Set client requests to impersonate a subuser
   */
  setImpersonateSubuser(subuser: string): void;

  /**
   * Set default header
   */
  setDefaultHeader(key: string | { [s: string]: string }, value ?: string): this;

  /**
   * Set default request
   */
  setDefaultRequest<K extends keyof ClientRequest>(key: K | ClientRequest, value ?: ClientRequest[K]): this;

  /**
   * Sets the data residency as per region provided
   */
  setDataResidency(region: string): this;

  /**
   * Create headers for request
   */
  createHeaders(data: { [key: string]: string }): { [key: string]: string };

  /**
   * Create request
   */
  createRequest(data: ClientRequest): ClientRequest;

  /**
   * Do a request
   */
  request(data: ClientRequest, cb?: (err: ResponseError, response: [ClientResponse, any]) => void): Promise<[ClientResponse, any]>;
}

declare const client: Client;
// @ts-ignore
export = client

export {Client};