import { inspect, InspectOptions } from "util"; import Page, { TwilioResponsePayload } from "../../../../../../base/Page"; import Response from "../../../../../../http/response"; import V2010 from "../../../../V2010"; /** * Options to pass to create a CredentialListMappingInstance */ export interface CredentialListMappingListInstanceCreateOptions { /** A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain. */ credentialListSid: string; } /** * Options to pass to each */ export interface CredentialListMappingListInstanceEachOptions { /** 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: CredentialListMappingInstance, 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 CredentialListMappingListInstanceOptions { /** 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 CredentialListMappingListInstancePageOptions { /** 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 CredentialListMappingContext { /** * Remove a CredentialListMappingInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a CredentialListMappingInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListMappingInstance */ fetch(callback?: (error: Error | null, item?: CredentialListMappingInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export interface CredentialListMappingContextSolution { accountSid: string; domainSid: string; sid: string; } export declare class CredentialListMappingContextImpl implements CredentialListMappingContext { protected _version: V2010; protected _solution: CredentialListMappingContextSolution; protected _uri: string; constructor(_version: V2010, accountSid: string, domainSid: string, sid: string); remove(callback?: (error: Error | null, item?: boolean) => any): Promise; fetch(callback?: (error: Error | null, item?: CredentialListMappingInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): CredentialListMappingContextSolution; [inspect.custom](_depth: any, options: InspectOptions): string; } interface CredentialListMappingPayload extends TwilioResponsePayload { credential_list_mappings: CredentialListMappingResource[]; } interface CredentialListMappingResource { account_sid: string; date_created: Date; date_updated: Date; domain_sid: string; friendly_name: string; sid: string; uri: string; } export declare class CredentialListMappingInstance { protected _version: V2010; protected _solution: CredentialListMappingContextSolution; protected _context?: CredentialListMappingContext; constructor(_version: V2010, payload: CredentialListMappingResource, accountSid: string, domainSid: string, sid?: string); /** * The unique id of the Account that is responsible for this resource. */ accountSid: 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 unique string that is created to identify the SipDomain resource. */ domainSid: string; /** * A human readable descriptive text for this resource, up to 64 characters long. */ friendlyName: string; /** * A 34 character string that uniquely identifies this resource. */ sid: string; /** * The URI for this resource, relative to `https://api.twilio.com` */ uri: string; private get _proxy(); /** * Remove a CredentialListMappingInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a CredentialListMappingInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListMappingInstance */ fetch(callback?: (error: Error | null, item?: CredentialListMappingInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): { accountSid: string; dateCreated: Date; dateUpdated: Date; domainSid: string; friendlyName: string; sid: string; uri: string; }; [inspect.custom](_depth: any, options: InspectOptions): string; } export interface CredentialListMappingSolution { accountSid: string; domainSid: string; } export interface CredentialListMappingListInstance { _version: V2010; _solution: CredentialListMappingSolution; _uri: string; (sid: string): CredentialListMappingContext; get(sid: string): CredentialListMappingContext; /** * Create a CredentialListMappingInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed CredentialListMappingInstance */ create(params: CredentialListMappingListInstanceCreateOptions, callback?: (error: Error | null, item?: CredentialListMappingInstance) => any): Promise; /** * Streams CredentialListMappingInstance 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 { CredentialListMappingListInstanceEachOptions } [params] - Options for request * @param { function } [callback] - Function to process each record */ each(callback?: (item: CredentialListMappingInstance, done: (err?: Error) => void) => void): void; each(params: CredentialListMappingListInstanceEachOptions, callback?: (item: CredentialListMappingInstance, done: (err?: Error) => void) => void): void; /** * Retrieve a single target page of CredentialListMappingInstance 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: CredentialListMappingPage) => any): Promise; /** * Lists CredentialListMappingInstance 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 { CredentialListMappingListInstanceOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ list(callback?: (error: Error | null, items: CredentialListMappingInstance[]) => any): Promise; list(params: CredentialListMappingListInstanceOptions, callback?: (error: Error | null, items: CredentialListMappingInstance[]) => any): Promise; /** * Retrieve a single page of CredentialListMappingInstance 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 { CredentialListMappingListInstancePageOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ page(callback?: (error: Error | null, items: CredentialListMappingPage) => any): Promise; page(params: CredentialListMappingListInstancePageOptions, callback?: (error: Error | null, items: CredentialListMappingPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export declare function CredentialListMappingListInstance(version: V2010, accountSid: string, domainSid: string): CredentialListMappingListInstance; export declare class CredentialListMappingPage extends Page { /** * Initialize the CredentialListMappingPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V2010, response: Response, solution: CredentialListMappingSolution); /** * Build an instance of CredentialListMappingInstance * * @param payload - Payload response from the API */ getInstance(payload: CredentialListMappingResource): CredentialListMappingInstance; [inspect.custom](depth: any, options: InspectOptions): string; } export {};