import { inspect, InspectOptions } from "util"; import Page, { TwilioResponsePayload } from "../../../../base/Page"; import Response from "../../../../http/response"; import V1 from "../../V1"; /** * Options to pass to create a CredentialListInstance */ export interface CredentialListListInstanceCreateOptions { /** The SID of the [Credential List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource) that you want to associate with the trunk. Once associated, we will authenticate access to the trunk against this list. */ credentialListSid: string; } /** * Options to pass to each */ export interface CredentialListListInstanceEachOptions { /** 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: CredentialListInstance, 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 CredentialListListInstanceOptions { /** 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 CredentialListListInstancePageOptions { /** 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 CredentialListContext { /** * Remove a CredentialListInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a CredentialListInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListInstance */ fetch(callback?: (error: Error | null, item?: CredentialListInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export interface CredentialListContextSolution { trunkSid: string; sid: string; } export declare class CredentialListContextImpl implements CredentialListContext { protected _version: V1; protected _solution: CredentialListContextSolution; protected _uri: string; constructor(_version: V1, trunkSid: string, sid: string); remove(callback?: (error: Error | null, item?: boolean) => any): Promise; fetch(callback?: (error: Error | null, item?: CredentialListInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): CredentialListContextSolution; [inspect.custom](_depth: any, options: InspectOptions): string; } interface CredentialListPayload extends TwilioResponsePayload { credential_lists: CredentialListResource[]; } interface CredentialListResource { account_sid: string; sid: string; trunk_sid: string; friendly_name: string; date_created: Date; date_updated: Date; url: string; } export declare class CredentialListInstance { protected _version: V1; protected _solution: CredentialListContextSolution; protected _context?: CredentialListContext; constructor(_version: V1, payload: CredentialListResource, trunkSid: string, sid?: string); /** * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialList resource. */ accountSid: string; /** * The unique string that we created to identify the CredentialList resource. */ sid: string; /** * The SID of the Trunk the credential list in associated with. */ trunkSid: string; /** * The string that you assigned to describe the resource. */ friendlyName: string; /** * The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. */ dateCreated: Date; /** * The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. */ dateUpdated: Date; /** * The absolute URL of the resource. */ url: string; private get _proxy(); /** * Remove a CredentialListInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a CredentialListInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListInstance */ fetch(callback?: (error: Error | null, item?: CredentialListInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): { accountSid: string; sid: string; trunkSid: string; friendlyName: string; dateCreated: Date; dateUpdated: Date; url: string; }; [inspect.custom](_depth: any, options: InspectOptions): string; } export interface CredentialListSolution { trunkSid: string; } export interface CredentialListListInstance { _version: V1; _solution: CredentialListSolution; _uri: string; (sid: string): CredentialListContext; get(sid: string): CredentialListContext; /** * Create a CredentialListInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListInstance */ create(params: CredentialListListInstanceCreateOptions, callback?: (error: Error | null, item?: CredentialListInstance) => any): Promise; /** * Streams CredentialListInstance 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 { CredentialListListInstanceEachOptions } [params] - Options for request * @param { function } [callback] - Function to process each record */ each(callback?: (item: CredentialListInstance, done: (err?: Error) => void) => void): void; each(params: CredentialListListInstanceEachOptions, callback?: (item: CredentialListInstance, done: (err?: Error) => void) => void): void; /** * Retrieve a single target page of CredentialListInstance 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: CredentialListPage) => any): Promise; /** * Lists CredentialListInstance 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 { CredentialListListInstanceOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ list(callback?: (error: Error | null, items: CredentialListInstance[]) => any): Promise; list(params: CredentialListListInstanceOptions, callback?: (error: Error | null, items: CredentialListInstance[]) => any): Promise; /** * Retrieve a single page of CredentialListInstance 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 { CredentialListListInstancePageOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ page(callback?: (error: Error | null, items: CredentialListPage) => any): Promise; page(params: CredentialListListInstancePageOptions, callback?: (error: Error | null, items: CredentialListPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export declare function CredentialListListInstance(version: V1, trunkSid: string): CredentialListListInstance; export declare class CredentialListPage extends Page { /** * Initialize the CredentialListPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V1, response: Response, solution: CredentialListSolution); /** * Build an instance of CredentialListInstance * * @param payload - Payload response from the API */ getInstance(payload: CredentialListResource): CredentialListInstance; [inspect.custom](depth: any, options: InspectOptions): string; } export {};