twilio 3.77.1 → 3.78.0

package/lib/rest/fax/v1/fax.d.ts

@@ -1,367 +0,0 @@
-/**
- * This code was generated by
- * \ / _    _  _|   _  _
- *  | (_)\/(_)(_|\/| |(/_  v1.0.0
- *       /       /
- */
-
-import Page = require('../../../base/Page');
-import Response = require('../../../http/response');
-import V1 = require('../V1');
-import { FaxMediaList } from './fax/faxMedia';
-import { FaxMediaListInstance } from './fax/faxMedia';
-import { SerializableClass } from '../../../interfaces';
-
-type FaxDirection = 'inbound'|'outbound';
-
-type FaxQuality = 'standard'|'fine'|'superfine';
-
-type FaxStatus = 'queued'|'processing'|'sending'|'delivered'|'receiving'|'received'|'no-answer'|'busy'|'failed'|'canceled';
-
-type FaxUpdateStatus = 'canceled';
-
-/**
- * Initialize the FaxList
- *
- * PLEASE NOTE that this class contains beta products that are subject to change.
- * Use them with caution.
- *
- * @param version - Version of the resource
- */
-declare function FaxList(version: V1): FaxListInstance;
-
-interface FaxListInstance {
-  /**
-   * @param sid - sid of instance
-   */
-  (sid: string): FaxContext;
-  /**
-   * Streams FaxInstance records from the API.
-   *
-   * This operation lazily loads records as efficiently as possible until the limit
-   * is reached.
-   *
-   * The results are passed into the callback function, so this operation is memory
-   * efficient.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param callback - Function to process each record
-   */
-  each(callback?: (item: FaxInstance, done: (err?: Error) => void) => void): void;
-  /**
-   * Streams FaxInstance records from the API.
-   *
-   * This operation lazily loads records as efficiently as possible until the limit
-   * is reached.
-   *
-   * The results are passed into the callback function, so this operation is memory
-   * efficient.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param opts - Options for request
-   * @param callback - Function to process each record
-   */
-  each(opts?: FaxListInstanceEachOptions, callback?: (item: FaxInstance, done: (err?: Error) => void) => void): void;
-  /**
-   * Constructs a fax
-   *
-   * @param sid - The unique string that identifies the resource
-   */
-  get(sid: string): FaxContext;
-  /**
-   * Retrieve a single target page of FaxInstance records from the API.
-   *
-   * The request is executed immediately.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param callback - Callback to handle list of records
-   */
-  getPage(callback?: (error: Error | null, items: FaxPage) => any): Promise<FaxPage>;
-  /**
-   * Retrieve a single target page of FaxInstance records from the API.
-   *
-   * The request is executed immediately.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param targetUrl - API-generated URL for the requested results page
-   * @param callback - Callback to handle list of records
-   */
-  getPage(targetUrl?: string, callback?: (error: Error | null, items: FaxPage) => any): Promise<FaxPage>;
-  /**
-   * Lists FaxInstance records from the API as a list.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param callback - Callback to handle list of records
-   */
-  list(callback?: (error: Error | null, items: FaxInstance[]) => any): Promise<FaxInstance[]>;
-  /**
-   * Lists FaxInstance records from the API as a list.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param opts - Options for request
-   * @param callback - Callback to handle list of records
-   */
-  list(opts?: FaxListInstanceOptions, callback?: (error: Error | null, items: FaxInstance[]) => any): Promise<FaxInstance[]>;
-  /**
-   * Retrieve a single page of FaxInstance records from the API.
-   *
-   * The request is executed immediately.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param callback - Callback to handle list of records
-   */
-  page(callback?: (error: Error | null, items: FaxPage) => any): Promise<FaxPage>;
-  /**
-   * Retrieve a single page of FaxInstance records from the API.
-   *
-   * The request is executed immediately.
-   *
-   * If a function is passed as the first argument, it will be used as the callback
-   * function.
-   *
-   * @param opts - Options for request
-   * @param callback - Callback to handle list of records
-   */
-  page(opts?: FaxListInstancePageOptions, callback?: (error: Error | null, items: FaxPage) => any): Promise<FaxPage>;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-/**
- * Options to pass to each
- *
- * @property callback -
- *                         Function to process each record. If this and a positional
- *                         callback are passed, this one will be used
- * @property dateCreatedAfter - Retrieve only faxes created after this date
- * @property dateCreatedOnOrBefore - Retrieve only faxes created on or before this date
- * @property done - Function to be called upon completion of streaming
- * @property from - Retrieve only those faxes sent from this phone number
- * @property limit -
- *                         Upper limit for the number of records to return.
- *                         each() guarantees never to return more than limit.
- *                         Default is no limit
- * @property pageSize -
- *                         Number of records to fetch per request,
- *                         when not set will use the default value of 50 records.
- *                         If no pageSize is defined but a limit is defined,
- *                         each() will attempt to read the limit with the most efficient
- *                         page size, i.e. min(limit, 1000)
- * @property to - Retrieve only those faxes sent to this phone number
- */
-interface FaxListInstanceEachOptions {
-  callback?: (item: FaxInstance, done: (err?: Error) => void) => void;
-  dateCreatedAfter?: Date;
-  dateCreatedOnOrBefore?: Date;
-  done?: Function;
-  from?: string;
-  limit?: number;
-  pageSize?: number;
-  to?: string;
-}
-
-/**
- * Options to pass to list
- *
- * @property dateCreatedAfter - Retrieve only faxes created after this date
- * @property dateCreatedOnOrBefore - Retrieve only faxes created on or before this date
- * @property from - Retrieve only those faxes sent from this phone number
- * @property limit -
- *                         Upper limit for the number of records to return.
- *                         list() guarantees never to return more than limit.
- *                         Default is no limit
- * @property pageSize -
- *                         Number of records to fetch per request,
- *                         when not set will use the default value of 50 records.
- *                         If no page_size is defined but a limit is defined,
- *                         list() will attempt to read the limit with the most
- *                         efficient page size, i.e. min(limit, 1000)
- * @property to - Retrieve only those faxes sent to this phone number
- */
-interface FaxListInstanceOptions {
-  dateCreatedAfter?: Date;
-  dateCreatedOnOrBefore?: Date;
-  from?: string;
-  limit?: number;
-  pageSize?: number;
-  to?: string;
-}
-
-/**
- * Options to pass to page
- *
- * @property dateCreatedAfter - Retrieve only faxes created after this date
- * @property dateCreatedOnOrBefore - Retrieve only faxes created on or before this date
- * @property from - Retrieve only those faxes sent from this phone number
- * @property pageNumber - Page Number, this value is simply for client state
- * @property pageSize - Number of records to return, defaults to 50
- * @property pageToken - PageToken provided by the API
- * @property to - Retrieve only those faxes sent to this phone number
- */
-interface FaxListInstancePageOptions {
-  dateCreatedAfter?: Date;
-  dateCreatedOnOrBefore?: Date;
-  from?: string;
-  pageNumber?: number;
-  pageSize?: number;
-  pageToken?: string;
-  to?: string;
-}
-
-interface FaxPayload extends FaxResource, Page.TwilioResponsePayload {
-}
-
-interface FaxResource {
-  account_sid: string;
-  api_version: string;
-  date_created: Date;
-  date_updated: Date;
-  direction: FaxDirection;
-  duration: number;
-  from: string;
-  links: string;
-  media_sid: string;
-  media_url: string;
-  num_pages: number;
-  price: number;
-  price_unit: string;
-  quality: FaxQuality;
-  sid: string;
-  status: FaxStatus;
-  to: string;
-  url: string;
-}
-
-interface FaxSolution {
-}
-
-
-declare class FaxContext {
-  /**
-   * Initialize the FaxContext
-   *
-   * PLEASE NOTE that this class contains beta products that are subject to change.
-   * Use them with caution.
-   *
-   * @param version - Version of the resource
-   * @param sid - The unique string that identifies the resource
-   */
-  constructor(version: V1, sid: string);
-
-  /**
-   * fetch a FaxInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  fetch(callback?: (error: Error | null, items: FaxInstance) => any): Promise<FaxInstance>;
-  media: FaxMediaListInstance;
-  /**
-   * remove a FaxInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  remove(callback?: (error: Error | null, items: FaxInstance) => any): Promise<boolean>;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-
-declare class FaxInstance extends SerializableClass {
-  /**
-   * Initialize the FaxContext
-   *
-   * PLEASE NOTE that this class contains beta products that are subject to change.
-   * Use them with caution.
-   *
-   * @param version - Version of the resource
-   * @param payload - The instance payload
-   * @param sid - The unique string that identifies the resource
-   */
-  constructor(version: V1, payload: FaxPayload, sid: string);
-
-  private _proxy: FaxContext;
-  accountSid: string;
-  apiVersion: string;
-  dateCreated: Date;
-  dateUpdated: Date;
-  direction: FaxDirection;
-  duration: number;
-  /**
-   * fetch a FaxInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  fetch(callback?: (error: Error | null, items: FaxInstance) => any): Promise<FaxInstance>;
-  from: string;
-  links: string;
-  /**
-   * Access the media
-   */
-  media(): FaxMediaListInstance;
-  mediaSid: string;
-  mediaUrl: string;
-  numPages: number;
-  price: number;
-  priceUnit: string;
-  quality: FaxQuality;
-  /**
-   * remove a FaxInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  remove(callback?: (error: Error | null, items: FaxInstance) => any): Promise<boolean>;
-  sid: string;
-  status: FaxStatus;
-  to: string;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-  url: string;
-}
-
-
-declare class FaxPage extends Page<V1, FaxPayload, FaxResource, FaxInstance> {
-  /**
-   * Initialize the FaxPage
-   *
-   * PLEASE NOTE that this class contains beta products that are subject to change.
-   * Use them with caution.
-   *
-   * @param version - Version of the resource
-   * @param response - Response from the API
-   * @param solution - Path solution
-   */
-  constructor(version: V1, response: Response<string>, solution: FaxSolution);
-
-  /**
-   * Build an instance of FaxInstance
-   *
-   * @param payload - Payload response from the API
-   */
-  getInstance(payload: FaxPayload): FaxInstance;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-export { FaxContext, FaxDirection, FaxInstance, FaxList, FaxListInstance, FaxListInstanceEachOptions, FaxListInstanceOptions, FaxListInstancePageOptions, FaxPage, FaxPayload, FaxQuality, FaxResource, FaxSolution, FaxStatus, FaxUpdateStatus }