twilio
Version:
A Twilio helper library
251 lines (250 loc) • 10.5 kB
TypeScript
import { inspect, InspectOptions } from "util";
import Page, { TwilioResponsePayload } from "../../../../base/Page";
import Response from "../../../../http/response";
import V1 from "../../V1";
/**
* Options to pass to update a InstalledAddOnExtensionInstance
*/
export interface InstalledAddOnExtensionContextUpdateOptions {
/** Whether the Extension should be invoked. */
enabled: boolean;
}
/**
* Options to pass to each
*/
export interface InstalledAddOnExtensionListInstanceEachOptions {
/** 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: InstalledAddOnExtensionInstance, 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 InstalledAddOnExtensionListInstanceOptions {
/** 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 InstalledAddOnExtensionListInstancePageOptions {
/** 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 InstalledAddOnExtensionContext {
/**
* Fetch a InstalledAddOnExtensionInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed InstalledAddOnExtensionInstance
*/
fetch(callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
/**
* Update a InstalledAddOnExtensionInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed InstalledAddOnExtensionInstance
*/
update(params: InstalledAddOnExtensionContextUpdateOptions, callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export interface InstalledAddOnExtensionContextSolution {
installedAddOnSid: string;
sid: string;
}
export declare class InstalledAddOnExtensionContextImpl implements InstalledAddOnExtensionContext {
protected _version: V1;
protected _solution: InstalledAddOnExtensionContextSolution;
protected _uri: string;
constructor(_version: V1, installedAddOnSid: string, sid: string);
fetch(callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
update(params: InstalledAddOnExtensionContextUpdateOptions, callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON(): InstalledAddOnExtensionContextSolution;
[inspect.custom](_depth: any, options: InspectOptions): string;
}
interface InstalledAddOnExtensionPayload extends TwilioResponsePayload {
extensions: InstalledAddOnExtensionResource[];
}
interface InstalledAddOnExtensionResource {
sid: string;
installed_add_on_sid: string;
friendly_name: string;
product_name: string;
unique_name: string;
enabled: boolean;
url: string;
}
export declare class InstalledAddOnExtensionInstance {
protected _version: V1;
protected _solution: InstalledAddOnExtensionContextSolution;
protected _context?: InstalledAddOnExtensionContext;
constructor(_version: V1, payload: InstalledAddOnExtensionResource, installedAddOnSid: string, sid?: string);
/**
* The unique string that we created to identify the InstalledAddOn Extension resource.
*/
sid: string;
/**
* The SID of the InstalledAddOn resource to which this extension applies.
*/
installedAddOnSid: string;
/**
* The string that you assigned to describe the resource.
*/
friendlyName: string;
/**
* The name of the Product this Extension is used within.
*/
productName: string;
/**
* An application-defined string that uniquely identifies the resource.
*/
uniqueName: string;
/**
* Whether the Extension will be invoked.
*/
enabled: boolean;
/**
* The absolute URL of the resource.
*/
url: string;
private get _proxy();
/**
* Fetch a InstalledAddOnExtensionInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed InstalledAddOnExtensionInstance
*/
fetch(callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
/**
* Update a InstalledAddOnExtensionInstance
*
* @param params - Parameter for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed InstalledAddOnExtensionInstance
*/
update(params: InstalledAddOnExtensionContextUpdateOptions, callback?: (error: Error | null, item?: InstalledAddOnExtensionInstance) => any): Promise<InstalledAddOnExtensionInstance>;
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON(): {
sid: string;
installedAddOnSid: string;
friendlyName: string;
productName: string;
uniqueName: string;
enabled: boolean;
url: string;
};
[inspect.custom](_depth: any, options: InspectOptions): string;
}
export interface InstalledAddOnExtensionSolution {
installedAddOnSid: string;
}
export interface InstalledAddOnExtensionListInstance {
_version: V1;
_solution: InstalledAddOnExtensionSolution;
_uri: string;
(sid: string): InstalledAddOnExtensionContext;
get(sid: string): InstalledAddOnExtensionContext;
/**
* Streams InstalledAddOnExtensionInstance 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 { InstalledAddOnExtensionListInstanceEachOptions } [params] - Options for request
* @param { function } [callback] - Function to process each record
*/
each(callback?: (item: InstalledAddOnExtensionInstance, done: (err?: Error) => void) => void): void;
each(params: InstalledAddOnExtensionListInstanceEachOptions, callback?: (item: InstalledAddOnExtensionInstance, done: (err?: Error) => void) => void): void;
/**
* Retrieve a single target page of InstalledAddOnExtensionInstance 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: InstalledAddOnExtensionPage) => any): Promise<InstalledAddOnExtensionPage>;
/**
* Lists InstalledAddOnExtensionInstance 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 { InstalledAddOnExtensionListInstanceOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
list(callback?: (error: Error | null, items: InstalledAddOnExtensionInstance[]) => any): Promise<InstalledAddOnExtensionInstance[]>;
list(params: InstalledAddOnExtensionListInstanceOptions, callback?: (error: Error | null, items: InstalledAddOnExtensionInstance[]) => any): Promise<InstalledAddOnExtensionInstance[]>;
/**
* Retrieve a single page of InstalledAddOnExtensionInstance 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 { InstalledAddOnExtensionListInstancePageOptions } [params] - Options for request
* @param { function } [callback] - Callback to handle list of records
*/
page(callback?: (error: Error | null, items: InstalledAddOnExtensionPage) => any): Promise<InstalledAddOnExtensionPage>;
page(params: InstalledAddOnExtensionListInstancePageOptions, callback?: (error: Error | null, items: InstalledAddOnExtensionPage) => any): Promise<InstalledAddOnExtensionPage>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export declare function InstalledAddOnExtensionListInstance(version: V1, installedAddOnSid: string): InstalledAddOnExtensionListInstance;
export declare class InstalledAddOnExtensionPage extends Page<V1, InstalledAddOnExtensionPayload, InstalledAddOnExtensionResource, InstalledAddOnExtensionInstance> {
/**
* Initialize the InstalledAddOnExtensionPage
*
* @param version - Version of the resource
* @param response - Response from the API
* @param solution - Path solution
*/
constructor(version: V1, response: Response<string>, solution: InstalledAddOnExtensionSolution);
/**
* Build an instance of InstalledAddOnExtensionInstance
*
* @param payload - Payload response from the API
*/
getInstance(payload: InstalledAddOnExtensionResource): InstalledAddOnExtensionInstance;
[inspect.custom](depth: any, options: InspectOptions): string;
}
export {};