twilio 3.75.1 → 3.76.0

package/lib/rest/supersim/v1/command.d.ts

@@ -1,342 +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 { SerializableClass } from '../../../interfaces';
-
-type CommandDirection = 'to_sim'|'from_sim';
-
-type CommandStatus = 'queued'|'sent'|'delivered'|'received'|'failed';
-
-/**
- * Initialize the CommandList
- *
- * 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 CommandList(version: V1): CommandListInstance;
-
-interface CommandListInstance {
-  /**
-   * @param sid - sid of instance
-   */
-  (sid: string): CommandContext;
-  /**
-   * create a CommandInstance
-   *
-   * @param opts - Options for request
-   * @param callback - Callback to handle processed record
-   */
-  create(opts: CommandListInstanceCreateOptions, callback?: (error: Error | null, item: CommandInstance) => any): Promise<CommandInstance>;
-  /**
-   * Streams CommandInstance 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: CommandInstance, done: (err?: Error) => void) => void): void;
-  /**
-   * Streams CommandInstance 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?: CommandListInstanceEachOptions, callback?: (item: CommandInstance, done: (err?: Error) => void) => void): void;
-  /**
-   * Constructs a command
-   *
-   * @param sid - The SID that identifies the resource to fetch
-   */
-  get(sid: string): CommandContext;
-  /**
-   * Retrieve a single target page of CommandInstance 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: CommandPage) => any): Promise<CommandPage>;
-  /**
-   * Retrieve a single target page of CommandInstance 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: CommandPage) => any): Promise<CommandPage>;
-  /**
-   * Lists CommandInstance 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: CommandInstance[]) => any): Promise<CommandInstance[]>;
-  /**
-   * Lists CommandInstance 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?: CommandListInstanceOptions, callback?: (error: Error | null, items: CommandInstance[]) => any): Promise<CommandInstance[]>;
-  /**
-   * Retrieve a single page of CommandInstance 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: CommandPage) => any): Promise<CommandPage>;
-  /**
-   * Retrieve a single page of CommandInstance 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?: CommandListInstancePageOptions, callback?: (error: Error | null, items: CommandPage) => any): Promise<CommandPage>;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-/**
- * Options to pass to create
- *
- * @property callbackMethod - The HTTP method we should use to call callback_url
- * @property callbackUrl - The URL we should call after we have sent the command
- * @property command - The message body of the command
- * @property sim - The sid or unique_name of the SIM to send the Command to
- */
-interface CommandListInstanceCreateOptions {
-  callbackMethod?: string;
-  callbackUrl?: string;
-  command: string;
-  sim: string;
-}
-
-/**
- * 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 direction - The direction of the Command
- * @property done - Function to be called upon completion of streaming
- * @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 sim - The SID or unique name of the Sim that Command was sent to or from.
- * @property status - The status of the Command
- */
-interface CommandListInstanceEachOptions {
-  callback?: (item: CommandInstance, done: (err?: Error) => void) => void;
-  direction?: CommandDirection;
-  done?: Function;
-  limit?: number;
-  pageSize?: number;
-  sim?: string;
-  status?: CommandStatus;
-}
-
-/**
- * Options to pass to list
- *
- * @property direction - The direction of the Command
- * @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 sim - The SID or unique name of the Sim that Command was sent to or from.
- * @property status - The status of the Command
- */
-interface CommandListInstanceOptions {
-  direction?: CommandDirection;
-  limit?: number;
-  pageSize?: number;
-  sim?: string;
-  status?: CommandStatus;
-}
-
-/**
- * Options to pass to page
- *
- * @property direction - The direction of the Command
- * @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 sim - The SID or unique name of the Sim that Command was sent to or from.
- * @property status - The status of the Command
- */
-interface CommandListInstancePageOptions {
-  direction?: CommandDirection;
-  pageNumber?: number;
-  pageSize?: number;
-  pageToken?: string;
-  sim?: string;
-  status?: CommandStatus;
-}
-
-interface CommandPayload extends CommandResource, Page.TwilioResponsePayload {
-}
-
-interface CommandResource {
-  account_sid: string;
-  command: string;
-  date_created: Date;
-  date_updated: Date;
-  direction: CommandDirection;
-  sid: string;
-  sim_sid: string;
-  status: CommandStatus;
-  url: string;
-}
-
-interface CommandSolution {
-}
-
-
-declare class CommandContext {
-  /**
-   * Initialize the CommandContext
-   *
-   * 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 SID that identifies the resource to fetch
-   */
-  constructor(version: V1, sid: string);
-
-  /**
-   * fetch a CommandInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  fetch(callback?: (error: Error | null, items: CommandInstance) => any): Promise<CommandInstance>;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-
-declare class CommandInstance extends SerializableClass {
-  /**
-   * Initialize the CommandContext
-   *
-   * 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 SID that identifies the resource to fetch
-   */
-  constructor(version: V1, payload: CommandPayload, sid: string);
-
-  private _proxy: CommandContext;
-  accountSid: string;
-  command: string;
-  dateCreated: Date;
-  dateUpdated: Date;
-  direction: CommandDirection;
-  /**
-   * fetch a CommandInstance
-   *
-   * @param callback - Callback to handle processed record
-   */
-  fetch(callback?: (error: Error | null, items: CommandInstance) => any): Promise<CommandInstance>;
-  sid: string;
-  simSid: string;
-  status: CommandStatus;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-  url: string;
-}
-
-
-declare class CommandPage extends Page<V1, CommandPayload, CommandResource, CommandInstance> {
-  /**
-   * Initialize the CommandPage
-   *
-   * 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: CommandSolution);
-
-  /**
-   * Build an instance of CommandInstance
-   *
-   * @param payload - Payload response from the API
-   */
-  getInstance(payload: CommandPayload): CommandInstance;
-  /**
-   * Provide a user-friendly representation
-   */
-  toJSON(): any;
-}
-
-export { CommandContext, CommandDirection, CommandInstance, CommandList, CommandListInstance, CommandListInstanceCreateOptions, CommandListInstanceEachOptions, CommandListInstanceOptions, CommandListInstancePageOptions, CommandPage, CommandPayload, CommandResource, CommandSolution, CommandStatus }