twilio 4.6.0 → 4.7.0

package/lib/rest/api/v2010/account/sip/domain.d.ts

@@ -0,0 +1,459 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../../base/Page";
+import Response from "../../../../../http/response";
+import V2010 from "../../../V2010";
+import { AuthTypesListInstance } from "./domain/authTypes";
+import { CredentialListMappingListInstance } from "./domain/credentialListMapping";
+import { IpAccessControlListMappingListInstance } from "./domain/ipAccessControlListMapping";
+/**
+ * Options to pass to update a DomainInstance
+ */
+export interface DomainContextUpdateOptions {
+    /** A descriptive string that you created to describe the resource. It can be up to 64 characters long. */
+    friendlyName?: string;
+    /** The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. */
+    voiceFallbackMethod?: string;
+    /** The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`. */
+    voiceFallbackUrl?: string;
+    /** The HTTP method we should use to call `voice_url` */
+    voiceMethod?: string;
+    /** The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`. */
+    voiceStatusCallbackMethod?: string;
+    /** The URL that we should call to pass status parameters (such as call ended) to your application. */
+    voiceStatusCallbackUrl?: string;
+    /** The URL we should call when the domain receives a call. */
+    voiceUrl?: string;
+    /** Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not. */
+    sipRegistration?: boolean;
+    /** The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`. */
+    domainName?: string;
+    /** Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. */
+    emergencyCallingEnabled?: boolean;
+    /** Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain. */
+    secure?: boolean;
+    /** The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. */
+    byocTrunkSid?: string;
+    /** Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. */
+    emergencyCallerSid?: string;
+}
+/**
+ * Options to pass to create a DomainInstance
+ */
+export interface DomainListInstanceCreateOptions {
+    /** The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \\\"-\\\" and must end with `sip.twilio.com`. */
+    domainName: string;
+    /** A descriptive string that you created to describe the resource. It can be up to 64 characters long. */
+    friendlyName?: string;
+    /** The URL we should when the domain receives a call. */
+    voiceUrl?: string;
+    /** The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. */
+    voiceMethod?: string;
+    /** The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`. */
+    voiceFallbackUrl?: string;
+    /** The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. */
+    voiceFallbackMethod?: string;
+    /** The URL that we should call to pass status parameters (such as call ended) to your application. */
+    voiceStatusCallbackUrl?: string;
+    /** The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`. */
+    voiceStatusCallbackMethod?: string;
+    /** Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not. */
+    sipRegistration?: boolean;
+    /** Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. */
+    emergencyCallingEnabled?: boolean;
+    /** Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain. */
+    secure?: boolean;
+    /** The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. */
+    byocTrunkSid?: string;
+    /** Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. */
+    emergencyCallerSid?: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface DomainListInstanceEachOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: DomainInstance, done: (err?: Error) => void) => void;
+    /** Function to be called upon completion of streaming */
+    done?: Function;
+    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to list
+ */
+export interface DomainListInstanceOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to page
+ */
+export interface DomainListInstancePageOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface DomainContext {
+    auth: AuthTypesListInstance;
+    credentialListMappings: CredentialListMappingListInstance;
+    ipAccessControlListMappings: IpAccessControlListMappingListInstance;
+    /**
+     * Remove a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    fetch(callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Update a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    update(callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Update a DomainInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    update(params: DomainContextUpdateOptions, callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface DomainContextSolution {
+    accountSid: string;
+    sid: string;
+}
+export declare class DomainContextImpl implements DomainContext {
+    protected _version: V2010;
+    protected _solution: DomainContextSolution;
+    protected _uri: string;
+    protected _auth?: AuthTypesListInstance;
+    protected _credentialListMappings?: CredentialListMappingListInstance;
+    protected _ipAccessControlListMappings?: IpAccessControlListMappingListInstance;
+    constructor(_version: V2010, accountSid: string, sid: string);
+    get auth(): AuthTypesListInstance;
+    get credentialListMappings(): CredentialListMappingListInstance;
+    get ipAccessControlListMappings(): IpAccessControlListMappingListInstance;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    update(params?: DomainContextUpdateOptions | ((error: Error | null, item?: DomainInstance) => any), callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): DomainContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export type DomainVoiceFallbackMethod = "HEAD" | "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+export type DomainVoiceMethod = "HEAD" | "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+export type DomainVoiceStatusCallbackMethod = "HEAD" | "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+interface DomainPayload extends TwilioResponsePayload {
+    domains: DomainResource[];
+}
+interface DomainResource {
+    account_sid: string;
+    api_version: string;
+    auth_type: string;
+    date_created: Date;
+    date_updated: Date;
+    domain_name: string;
+    friendly_name: string;
+    sid: string;
+    uri: string;
+    voice_fallback_method: DomainVoiceFallbackMethod;
+    voice_fallback_url: string;
+    voice_method: DomainVoiceMethod;
+    voice_status_callback_method: DomainVoiceStatusCallbackMethod;
+    voice_status_callback_url: string;
+    voice_url: string;
+    subresource_uris: Record<string, string>;
+    sip_registration: boolean;
+    emergency_calling_enabled: boolean;
+    secure: boolean;
+    byoc_trunk_sid: string;
+    emergency_caller_sid: string;
+}
+export declare class DomainInstance {
+    protected _version: V2010;
+    protected _solution: DomainContextSolution;
+    protected _context?: DomainContext;
+    constructor(_version: V2010, payload: DomainResource, accountSid: string, sid?: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource.
+     */
+    accountSid: string;
+    /**
+     * The API version used to process the call.
+     */
+    apiVersion: string;
+    /**
+     * The types of authentication you have mapped to your domain. Can be: `IP_ACL` and `CREDENTIAL_LIST`. If you have both defined for your domain, both will be returned in a comma delimited string. If `auth_type` is not defined, the domain will not be able to receive any traffic.
+     */
+    authType: string;
+    /**
+     * The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`.
+     */
+    domainName: string;
+    /**
+     * The string that you assigned to describe the resource.
+     */
+    friendlyName: string;
+    /**
+     * The unique string that that we created to identify the SipDomain resource.
+     */
+    sid: string;
+    /**
+     * The URI of the resource, relative to `https://api.twilio.com`.
+     */
+    uri: string;
+    /**
+     * The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
+     */
+    voiceFallbackMethod: DomainVoiceFallbackMethod;
+    /**
+     * The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.
+     */
+    voiceFallbackUrl: string;
+    /**
+     * The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
+     */
+    voiceMethod: DomainVoiceMethod;
+    /**
+     * The HTTP method we use to call `voice_status_callback_url`. Either `GET` or `POST`.
+     */
+    voiceStatusCallbackMethod: DomainVoiceStatusCallbackMethod;
+    /**
+     * The URL that we call to pass status parameters (such as call ended) to your application.
+     */
+    voiceStatusCallbackUrl: string;
+    /**
+     * The URL we call using the `voice_method` when the domain receives a call.
+     */
+    voiceUrl: string;
+    /**
+     * A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.
+     */
+    subresourceUris: Record<string, string>;
+    /**
+     * Whether to allow SIP Endpoints to register with the domain to receive calls.
+     */
+    sipRegistration: boolean;
+    /**
+     * Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
+     */
+    emergencyCallingEnabled: boolean;
+    /**
+     * Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
+     */
+    secure: boolean;
+    /**
+     * The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
+     */
+    byocTrunkSid: string;
+    /**
+     * Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
+     */
+    emergencyCallerSid: string;
+    private get _proxy();
+    /**
+     * Remove a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    fetch(callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Update a DomainInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    update(callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Update a DomainInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    update(params: DomainContextUpdateOptions, callback?: (error: Error | null, item?: DomainInstance) => any): Promise<DomainInstance>;
+    /**
+     * Access the auth.
+     */
+    auth(): AuthTypesListInstance;
+    /**
+     * Access the credentialListMappings.
+     */
+    credentialListMappings(): CredentialListMappingListInstance;
+    /**
+     * Access the ipAccessControlListMappings.
+     */
+    ipAccessControlListMappings(): IpAccessControlListMappingListInstance;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        apiVersion: string;
+        authType: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        domainName: string;
+        friendlyName: string;
+        sid: string;
+        uri: string;
+        voiceFallbackMethod: DomainVoiceFallbackMethod;
+        voiceFallbackUrl: string;
+        voiceMethod: DomainVoiceMethod;
+        voiceStatusCallbackMethod: DomainVoiceStatusCallbackMethod;
+        voiceStatusCallbackUrl: string;
+        voiceUrl: string;
+        subresourceUris: Record<string, string>;
+        sipRegistration: boolean;
+        emergencyCallingEnabled: boolean;
+        secure: boolean;
+        byocTrunkSid: string;
+        emergencyCallerSid: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface DomainSolution {
+    accountSid: string;
+}
+export interface DomainListInstance {
+    _version: V2010;
+    _solution: DomainSolution;
+    _uri: string;
+    (sid: string): DomainContext;
+    get(sid: string): DomainContext;
+    /**
+     * Create a DomainInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed DomainInstance
+     */
+    create(params: 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 { DomainListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: DomainInstance, done: (err?: Error) => void) => void): void;
+    each(params: DomainListInstanceEachOptions, callback?: (item: DomainInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of DomainInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * @param { string } [targetUrl] - API-generated URL for the requested results page
+     * @param { function } [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 { DomainListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: DomainInstance[]) => any): Promise<DomainInstance[]>;
+    list(params: 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 { DomainListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: DomainPage) => any): Promise<DomainPage>;
+    page(params: DomainListInstancePageOptions, callback?: (error: Error | null, items: DomainPage) => any): Promise<DomainPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function DomainListInstance(version: V2010, accountSid: string): DomainListInstance;
+export 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: DomainResource): DomainInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};