@signalwire/compatibility-api/lib/rest/api/v2010/account/sip/domain.d.ts

SignalWire Compatibility API

/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

import Page = require('../../../../../base/Page');
import Response = require('../../../../../http/response');
import V2010 = require('../../../V2010');
import { AuthTypesList } from './domain/authTypes';
import { AuthTypesListInstance } from './domain/authTypes';
import { CredentialListMappingList } from './domain/credentialListMapping';
import { CredentialListMappingListInstance } from './domain/credentialListMapping';
import { IpAccessControlListMappingList } from './domain/ipAccessControlListMapping';
import { IpAccessControlListMappingListInstance } from './domain/ipAccessControlListMapping';
import { SerializableClass } from '../../../../../interfaces';

/**
 * Initialize the DomainList
 *
 * @param version - Version of the resource
 * @param accountSid - A 34 character string that uniquely identifies this resource.
 */
declare function DomainList(version: V2010, accountSid: string): DomainListInstance;

/**
 * Options to pass to update
 *
 * @property byocTrunkSid - The SID of the BYOC Trunk resource.
 * @property domainName - The unique address on Twilio to route SIP traffic
 * @property emergencyCallerSid - Whether an emergency caller sid is configured for the domain.
 * @property emergencyCallingEnabled - Whether emergency calling is enabled for the domain.
 * @property friendlyName - A string to describe the resource
 * @property secure - Whether secure SIP is enabled for the domain
 * @property sipRegistration - Whether SIP registration is allowed
 * @property voiceFallbackMethod - The HTTP method used with voice_fallback_url
 * @property voiceFallbackUrl - The URL we should call when an error occurs in executing TwiML
 * @property voiceMethod - The HTTP method we should use with voice_url
 * @property voiceStatusCallbackMethod - The HTTP method we should use to call voice_status_callback_url
 * @property voiceStatusCallbackUrl - The URL that we should call to pass status updates
 * @property voiceUrl - The URL we should call when receiving a call
 */
interface DomainInstanceUpdateOptions {
  byocTrunkSid?: string;
  domainName?: string;
  emergencyCallerSid?: string;
  emergencyCallingEnabled?: boolean;
  friendlyName?: string;
  secure?: boolean;
  sipRegistration?: boolean;
  voiceFallbackMethod?: string;
  voiceFallbackUrl?: string;
  voiceMethod?: string;
  voiceStatusCallbackMethod?: string;
  voiceStatusCallbackUrl?: string;
  voiceUrl?: string;
}

interface DomainListInstance {
  /**
   * @param sid - sid of instance
   */
  (sid: string): DomainContext;
  /**
   * create a DomainInstance
   *
   * @param opts - Options for request
   * @param callback - Callback to handle processed record
   */
  create(opts: DomainListInstanceCreateOptions, callback?: (error: Error | null, item: DomainInstance) => any): Promise<DomainInstance>;
  /**
   * Streams DomainInstance 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: DomainInstance, done: (err?: Error) => void) => void): void;
  /**
   * Streams DomainInstance 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?: DomainListInstanceEachOptions, callback?: (item: DomainInstance, done: (err?: Error) => void) => void): void;
  /**
   * Constructs a domain
   *
   * @param sid - The unique string that identifies the resource
   */
  get(sid: string): DomainContext;
  /**
   * Retrieve a single target page of DomainInstance 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: DomainPage) => any): Promise<DomainPage>;
  /**
   * Retrieve a single target page of DomainInstance 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: DomainPage) => any): Promise<DomainPage>;
  /**
   * Lists DomainInstance 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: DomainInstance[]) => any): Promise<DomainInstance[]>;
  /**
   * Lists DomainInstance 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?: DomainListInstanceOptions, callback?: (error: Error | null, items: DomainInstance[]) => any): Promise<DomainInstance[]>;
  /**
   * Retrieve a single page of DomainInstance 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: DomainPage) => any): Promise<DomainPage>;
  /**
   * Retrieve a single page of DomainInstance 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?: DomainListInstancePageOptions, callback?: (error: Error | null, items: DomainPage) => any): Promise<DomainPage>;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
}

/**
 * Options to pass to create
 *
 * @property byocTrunkSid - The SID of the BYOC Trunk resource.
 * @property domainName - The unique address on Twilio to route SIP traffic
 * @property emergencyCallerSid - Whether an emergency caller sid is configured for the domain.
 * @property emergencyCallingEnabled - Whether emergency calling is enabled for the domain.
 * @property friendlyName - A string to describe the resource
 * @property secure - Whether secure SIP is enabled for the domain
 * @property sipRegistration - Whether SIP registration is allowed
 * @property voiceFallbackMethod - The HTTP method to use with voice_fallback_url
 * @property voiceFallbackUrl - The URL we should call when an error occurs in executing TwiML
 * @property voiceMethod - The HTTP method to use with voice_url
 * @property voiceStatusCallbackMethod - The HTTP method we should use to call `voice_status_callback_url`
 * @property voiceStatusCallbackUrl - The URL that we should call to pass status updates
 * @property voiceUrl - The URL we should call when receiving a call
 */
interface DomainListInstanceCreateOptions {
  byocTrunkSid?: string;
  domainName: string;
  emergencyCallerSid?: string;
  emergencyCallingEnabled?: boolean;
  friendlyName?: string;
  secure?: boolean;
  sipRegistration?: boolean;
  voiceFallbackMethod?: string;
  voiceFallbackUrl?: string;
  voiceMethod?: string;
  voiceStatusCallbackMethod?: string;
  voiceStatusCallbackUrl?: string;
  voiceUrl?: 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 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)
 */
interface DomainListInstanceEachOptions {
  callback?: (item: DomainInstance, done: (err?: Error) => void) => void;
  done?: Function;
  limit?: number;
  pageSize?: number;
}

/**
 * Options to pass to list
 *
 * @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)
 */
interface DomainListInstanceOptions {
  limit?: number;
  pageSize?: number;
}

/**
 * Options to pass to page
 *
 * @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
 */
interface DomainListInstancePageOptions {
  pageNumber?: number;
  pageSize?: number;
  pageToken?: string;
}

interface DomainPayload extends DomainResource, Page.TwilioResponsePayload {
}

interface DomainResource {
  account_sid: string;
  api_version: string;
  auth_type: string;
  byoc_trunk_sid: string;
  date_created: Date;
  date_updated: Date;
  domain_name: string;
  emergency_caller_sid: string;
  emergency_calling_enabled: boolean;
  friendly_name: string;
  secure: boolean;
  sid: string;
  sip_registration: boolean;
  subresource_uris: string;
  uri: string;
  voice_fallback_method: string;
  voice_fallback_url: string;
  voice_method: string;
  voice_status_callback_method: string;
  voice_status_callback_url: string;
  voice_url: string;
}

interface DomainSolution {
  accountSid?: string;
}


declare class DomainContext {
  /**
   * Initialize the DomainContext
   *
   * @param version - Version of the resource
   * @param accountSid - The SID of the Account that created the resource to fetch
   * @param sid - The unique string that identifies the resource
   */
  constructor(version: V2010, accountSid: string, sid: string);

  auth: AuthTypesListInstance;
  credentialListMappings: CredentialListMappingListInstance;
  /**
   * fetch a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  fetch(callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
  ipAccessControlListMappings: IpAccessControlListMappingListInstance;
  /**
   * remove a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  remove(callback?: (error: Error | null, items: DomainInstance) => any): Promise<boolean>;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
  /**
   * update a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  update(callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
  /**
   * update a DomainInstance
   *
   * @param opts - Options for request
   * @param callback - Callback to handle processed record
   */
  update(opts?: DomainInstanceUpdateOptions, callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
}


declare class DomainInstance extends SerializableClass {
  /**
   * Initialize the DomainContext
   *
   * @param version - Version of the resource
   * @param payload - The instance payload
   * @param accountSid - A 34 character string that uniquely identifies this resource.
   * @param sid - The unique string that identifies the resource
   */
  constructor(version: V2010, payload: DomainPayload, accountSid: string, sid: string);

  private _proxy: DomainContext;
  accountSid: string;
  apiVersion: string;
  /**
   * Access the auth
   */
  auth(): AuthTypesListInstance;
  authType: string;
  byocTrunkSid: string;
  /**
   * Access the credentialListMappings
   */
  credentialListMappings(): CredentialListMappingListInstance;
  dateCreated: Date;
  dateUpdated: Date;
  domainName: string;
  emergencyCallerSid: string;
  emergencyCallingEnabled: boolean;
  /**
   * fetch a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  fetch(callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
  friendlyName: string;
  /**
   * Access the ipAccessControlListMappings
   */
  ipAccessControlListMappings(): IpAccessControlListMappingListInstance;
  /**
   * remove a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  remove(callback?: (error: Error | null, items: DomainInstance) => any): Promise<boolean>;
  secure: boolean;
  sid: string;
  sipRegistration: boolean;
  subresourceUris: string;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
  /**
   * update a DomainInstance
   *
   * @param callback - Callback to handle processed record
   */
  update(callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
  /**
   * update a DomainInstance
   *
   * @param opts - Options for request
   * @param callback - Callback to handle processed record
   */
  update(opts?: DomainInstanceUpdateOptions, callback?: (error: Error | null, items: DomainInstance) => any): Promise<DomainInstance>;
  uri: string;
  voiceFallbackMethod: string;
  voiceFallbackUrl: string;
  voiceMethod: string;
  voiceStatusCallbackMethod: string;
  voiceStatusCallbackUrl: string;
  voiceUrl: string;
}


declare class DomainPage extends Page<V2010, DomainPayload, DomainResource, DomainInstance> {
  /**
   * Initialize the DomainPage
   *
   * @param version - Version of the resource
   * @param response - Response from the API
   * @param solution - Path solution
   */
  constructor(version: V2010, response: Response<string>, solution: DomainSolution);

  /**
   * Build an instance of DomainInstance
   *
   * @param payload - Payload response from the API
   */
  getInstance(payload: DomainPayload): DomainInstance;
  /**
   * Provide a user-friendly representation
   */
  toJSON(): any;
}

export { DomainContext, DomainInstance, DomainInstanceUpdateOptions, DomainList, DomainListInstance, DomainListInstanceCreateOptions, DomainListInstanceEachOptions, DomainListInstanceOptions, DomainListInstancePageOptions, DomainPage, DomainPayload, DomainResource, DomainSolution }