import { inspect, InspectOptions } from "util"; import Page, { TwilioResponsePayload } from "../../../../../../base/Page"; import Response from "../../../../../../http/response"; import V2010 from "../../../../V2010"; /** * Options to pass to update a IpAddressInstance */ export interface IpAddressContextUpdateOptions { /** An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. */ ipAddress?: string; /** A human readable descriptive text for this resource, up to 255 characters long. */ friendlyName?: string; /** An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. */ cidrPrefixLength?: number; } /** * Options to pass to create a IpAddressInstance */ export interface IpAddressListInstanceCreateOptions { /** A human readable descriptive text for this resource, up to 255 characters long. */ friendlyName: string; /** An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. */ ipAddress: string; /** An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. */ cidrPrefixLength?: number; } /** * Options to pass to each */ export interface IpAddressListInstanceEachOptions { /** 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: IpAddressInstance, 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 IpAddressListInstanceOptions { /** 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 IpAddressListInstancePageOptions { /** 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 IpAddressContext { /** * Remove a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ fetch(callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Update a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ update(callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Update a IpAddressInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ update(params: IpAddressContextUpdateOptions, callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export interface IpAddressContextSolution { accountSid: string; ipAccessControlListSid: string; sid: string; } export declare class IpAddressContextImpl implements IpAddressContext { protected _version: V2010; protected _solution: IpAddressContextSolution; protected _uri: string; constructor(_version: V2010, accountSid: string, ipAccessControlListSid: string, sid: string); remove(callback?: (error: Error | null, item?: boolean) => any): Promise; fetch(callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; update(params?: IpAddressContextUpdateOptions | ((error: Error | null, item?: IpAddressInstance) => any), callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): IpAddressContextSolution; [inspect.custom](_depth: any, options: InspectOptions): string; } interface IpAddressPayload extends TwilioResponsePayload { ip_addresses: IpAddressResource[]; } interface IpAddressResource { sid: string; account_sid: string; friendly_name: string; ip_address: string; cidr_prefix_length: number; ip_access_control_list_sid: string; date_created: Date; date_updated: Date; uri: string; } export declare class IpAddressInstance { protected _version: V2010; protected _solution: IpAddressContextSolution; protected _context?: IpAddressContext; constructor(_version: V2010, payload: IpAddressResource, accountSid: string, ipAccessControlListSid: string, sid?: string); /** * A 34 character string that uniquely identifies this resource. */ sid: string; /** * The unique id of the Account that is responsible for this resource. */ accountSid: string; /** * A human readable descriptive text for this resource, up to 255 characters long. */ friendlyName: string; /** * An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. */ ipAddress: string; /** * An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. */ cidrPrefixLength: number; /** * The unique id of the IpAccessControlList resource that includes this resource. */ ipAccessControlListSid: string; /** * The date that this resource was created, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. */ dateCreated: Date; /** * The date that this resource was last updated, given as GMT in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. */ dateUpdated: Date; /** * The URI for this resource, relative to `https://api.twilio.com` */ uri: string; private get _proxy(); /** * Remove a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ fetch(callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Update a IpAddressInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ update(callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Update a IpAddressInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ update(params: IpAddressContextUpdateOptions, callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): { sid: string; accountSid: string; friendlyName: string; ipAddress: string; cidrPrefixLength: number; ipAccessControlListSid: string; dateCreated: Date; dateUpdated: Date; uri: string; }; [inspect.custom](_depth: any, options: InspectOptions): string; } export interface IpAddressSolution { accountSid: string; ipAccessControlListSid: string; } export interface IpAddressListInstance { _version: V2010; _solution: IpAddressSolution; _uri: string; (sid: string): IpAddressContext; get(sid: string): IpAddressContext; /** * Create a IpAddressInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed IpAddressInstance */ create(params: IpAddressListInstanceCreateOptions, callback?: (error: Error | null, item?: IpAddressInstance) => any): Promise; /** * Streams IpAddressInstance 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 { IpAddressListInstanceEachOptions } [params] - Options for request * @param { function } [callback] - Function to process each record */ each(callback?: (item: IpAddressInstance, done: (err?: Error) => void) => void): void; each(params: IpAddressListInstanceEachOptions, callback?: (item: IpAddressInstance, done: (err?: Error) => void) => void): void; /** * Retrieve a single target page of IpAddressInstance 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: IpAddressPage) => any): Promise; /** * Lists IpAddressInstance 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 { IpAddressListInstanceOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ list(callback?: (error: Error | null, items: IpAddressInstance[]) => any): Promise; list(params: IpAddressListInstanceOptions, callback?: (error: Error | null, items: IpAddressInstance[]) => any): Promise; /** * Retrieve a single page of IpAddressInstance 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 { IpAddressListInstancePageOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ page(callback?: (error: Error | null, items: IpAddressPage) => any): Promise; page(params: IpAddressListInstancePageOptions, callback?: (error: Error | null, items: IpAddressPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export declare function IpAddressListInstance(version: V2010, accountSid: string, ipAccessControlListSid: string): IpAddressListInstance; export declare class IpAddressPage extends Page { /** * Initialize the IpAddressPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V2010, response: Response, solution: IpAddressSolution); /** * Build an instance of IpAddressInstance * * @param payload - Payload response from the API */ getInstance(payload: IpAddressResource): IpAddressInstance; [inspect.custom](depth: any, options: InspectOptions): string; } export {};