import { inspect, InspectOptions } from "util"; import Page, { TwilioResponsePayload } from "../../../../../base/Page"; import Response from "../../../../../http/response"; import V2 from "../../../V2"; export type MemberWebhookEnabledType = "true" | "false"; /** * Options to pass to remove a MemberInstance */ export interface MemberContextRemoveOptions { /** The X-Twilio-Webhook-Enabled HTTP request header */ xTwilioWebhookEnabled?: MemberWebhookEnabledType; } /** * Options to pass to update a MemberInstance */ export interface MemberContextUpdateOptions { /** The X-Twilio-Webhook-Enabled HTTP request header */ xTwilioWebhookEnabled?: MemberWebhookEnabledType; /** */ roleSid?: string; /** */ lastConsumedMessageIndex?: number; /** */ lastConsumptionTimestamp?: Date; /** */ dateCreated?: Date; /** */ dateUpdated?: Date; /** */ attributes?: string; } /** * Options to pass to create a MemberInstance */ export interface MemberListInstanceCreateOptions { /** */ identity: string; /** The X-Twilio-Webhook-Enabled HTTP request header */ xTwilioWebhookEnabled?: MemberWebhookEnabledType; /** */ roleSid?: string; /** */ lastConsumedMessageIndex?: number; /** */ lastConsumptionTimestamp?: Date; /** */ dateCreated?: Date; /** */ dateUpdated?: Date; /** */ attributes?: string; } /** * Options to pass to each */ export interface MemberListInstanceEachOptions { /** */ identity?: Array; /** 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: MemberInstance, 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 MemberListInstanceOptions { /** */ identity?: Array; /** 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 MemberListInstancePageOptions { /** */ identity?: Array; /** 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 MemberContext { /** * Remove a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Remove a MemberInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ remove(params: MemberContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ fetch(callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Update a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ update(callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Update a MemberInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ update(params: MemberContextUpdateOptions, callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export interface MemberContextSolution { serviceSid: string; channelSid: string; sid: string; } export declare class MemberContextImpl implements MemberContext { protected _version: V2; protected _solution: MemberContextSolution; protected _uri: string; constructor(_version: V2, serviceSid: string, channelSid: string, sid: string); remove(params?: MemberContextRemoveOptions | ((error: Error | null, item?: boolean) => any), callback?: (error: Error | null, item?: boolean) => any): Promise; fetch(callback?: (error: Error | null, item?: MemberInstance) => any): Promise; update(params?: MemberContextUpdateOptions | ((error: Error | null, item?: MemberInstance) => any), callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): MemberContextSolution; [inspect.custom](_depth: any, options: InspectOptions): string; } interface MemberPayload extends TwilioResponsePayload { members: MemberResource[]; } interface MemberResource { sid: string; account_sid: string; channel_sid: string; service_sid: string; identity: string; date_created: Date; date_updated: Date; role_sid: string; last_consumed_message_index: number; last_consumption_timestamp: Date; url: string; attributes: string; } export declare class MemberInstance { protected _version: V2; protected _solution: MemberContextSolution; protected _context?: MemberContext; constructor(_version: V2, payload: MemberResource, serviceSid: string, channelSid: string, sid?: string); sid: string; accountSid: string; channelSid: string; serviceSid: string; identity: string; dateCreated: Date; dateUpdated: Date; roleSid: string; lastConsumedMessageIndex: number; lastConsumptionTimestamp: Date; url: string; attributes: string; private get _proxy(); /** * Remove a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed boolean */ remove(callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Remove a MemberInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ remove(params: MemberContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise; /** * Fetch a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ fetch(callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Update a MemberInstance * * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ update(callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Update a MemberInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ update(params: MemberContextUpdateOptions, callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Provide a user-friendly representation * * @returns Object */ toJSON(): { sid: string; accountSid: string; channelSid: string; serviceSid: string; identity: string; dateCreated: Date; dateUpdated: Date; roleSid: string; lastConsumedMessageIndex: number; lastConsumptionTimestamp: Date; url: string; attributes: string; }; [inspect.custom](_depth: any, options: InspectOptions): string; } export interface MemberSolution { serviceSid: string; channelSid: string; } export interface MemberListInstance { _version: V2; _solution: MemberSolution; _uri: string; (sid: string): MemberContext; get(sid: string): MemberContext; /** * Create a MemberInstance * * @param params - Parameter for request * @param callback - Callback to handle processed record * * @returns Resolves to processed MemberInstance */ create(params: MemberListInstanceCreateOptions, callback?: (error: Error | null, item?: MemberInstance) => any): Promise; /** * Streams MemberInstance 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 { MemberListInstanceEachOptions } [params] - Options for request * @param { function } [callback] - Function to process each record */ each(callback?: (item: MemberInstance, done: (err?: Error) => void) => void): void; each(params: MemberListInstanceEachOptions, callback?: (item: MemberInstance, done: (err?: Error) => void) => void): void; /** * Retrieve a single target page of MemberInstance 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: MemberPage) => any): Promise; /** * Lists MemberInstance 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 { MemberListInstanceOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ list(callback?: (error: Error | null, items: MemberInstance[]) => any): Promise; list(params: MemberListInstanceOptions, callback?: (error: Error | null, items: MemberInstance[]) => any): Promise; /** * Retrieve a single page of MemberInstance 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 { MemberListInstancePageOptions } [params] - Options for request * @param { function } [callback] - Callback to handle list of records */ page(callback?: (error: Error | null, items: MemberPage) => any): Promise; page(params: MemberListInstancePageOptions, callback?: (error: Error | null, items: MemberPage) => any): Promise; /** * Provide a user-friendly representation */ toJSON(): any; [inspect.custom](_depth: any, options: InspectOptions): any; } export declare function MemberListInstance(version: V2, serviceSid: string, channelSid: string): MemberListInstance; export declare class MemberPage extends Page { /** * Initialize the MemberPage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V2, response: Response, solution: MemberSolution); /** * Build an instance of MemberInstance * * @param payload - Payload response from the API */ getInstance(payload: MemberResource): MemberInstance; [inspect.custom](depth: any, options: InspectOptions): string; } export {};