@signalwire/compatibility-api

/** * This code was generated by * \ / _ _ _| _ _ * | (_)\/(_)(_|\/| |(/_ v1.0.0 * / / */ import Page = require('../../../base/Page'); import Response = require('../../../http/response'); import V1 = require('../V1'); import { ChannelList } from './service/channel'; import { ChannelListInstance } from './service/channel'; import { RoleList } from './service/role'; import { RoleListInstance } from './service/role'; import { SerializableClass } from '../../../interfaces'; import { UserList } from './service/user'; import { UserListInstance } from './service/user'; /** * Initialize the ServiceList * * @param version - Version of the resource */ declare function ServiceList(version: V1): ServiceListInstance; /** * Options to pass to update * * @property consumptionReportInterval - The consumption_report_interval * @property defaultChannelCreatorRoleSid - The default_channel_creator_role_sid * @property defaultChannelRoleSid - The default_channel_role_sid * @property defaultServiceRoleSid - The default_service_role_sid * @property friendlyName - The friendly_name * @property limits.channelMembers - The limits.channel_members * @property limits.userChannels - The limits.user_channels * @property notifications.addedToChannel.enabled - The notifications.added_to_channel.enabled * @property notifications.addedToChannel.template - The notifications.added_to_channel.template * @property notifications.invitedToChannel.enabled - The notifications.invited_to_channel.enabled * @property notifications.invitedToChannel.template - The notifications.invited_to_channel.template * @property notifications.newMessage.enabled - The notifications.new_message.enabled * @property notifications.newMessage.template - The notifications.new_message.template * @property notifications.removedFromChannel.enabled - The notifications.removed_from_channel.enabled * @property notifications.removedFromChannel.template - The notifications.removed_from_channel.template * @property postWebhookUrl - The post_webhook_url * @property preWebhookUrl - The pre_webhook_url * @property reachabilityEnabled - The reachability_enabled * @property readStatusEnabled - The read_status_enabled * @property typingIndicatorTimeout - The typing_indicator_timeout * @property webhookFilters - The webhook_filters * @property webhookMethod - The webhook_method * @property webhooks.onChannelAdd.method - The webhooks.on_channel_add.method * @property webhooks.onChannelAdd.url - The webhooks.on_channel_add.url * @property webhooks.onChannelAdded.method - The webhooks.on_channel_added.method * @property webhooks.onChannelAdded.url - The webhooks.on_channel_added.url * @property webhooks.onChannelDestroy.method - The webhooks.on_channel_destroy.method * @property webhooks.onChannelDestroy.url - The webhooks.on_channel_destroy.url * @property webhooks.onChannelDestroyed.method - The webhooks.on_channel_destroyed.method * @property webhooks.onChannelDestroyed.url - The webhooks.on_channel_destroyed.url * @property webhooks.onChannelUpdate.method - The webhooks.on_channel_update.method * @property webhooks.onChannelUpdate.url - The webhooks.on_channel_update.url * @property webhooks.onChannelUpdated.method - The webhooks.on_channel_updated.method * @property webhooks.onChannelUpdated.url - The webhooks.on_channel_updated.url * @property webhooks.onMemberAdd.method - The webhooks.on_member_add.method * @property webhooks.onMemberAdd.url - The webhooks.on_member_add.url * @property webhooks.onMemberAdded.method - The webhooks.on_member_added.method * @property webhooks.onMemberAdded.url - The webhooks.on_member_added.url * @property webhooks.onMemberRemove.method - The webhooks.on_member_remove.method * @property webhooks.onMemberRemove.url - The webhooks.on_member_remove.url * @property webhooks.onMemberRemoved.method - The webhooks.on_member_removed.method * @property webhooks.onMemberRemoved.url - The webhooks.on_member_removed.url * @property webhooks.onMessageRemove.method - The webhooks.on_message_remove.method * @property webhooks.onMessageRemove.url - The webhooks.on_message_remove.url * @property webhooks.onMessageRemoved.method - The webhooks.on_message_removed.method * @property webhooks.onMessageRemoved.url - The webhooks.on_message_removed.url * @property webhooks.onMessageSend.method - The webhooks.on_message_send.method * @property webhooks.onMessageSend.url - The webhooks.on_message_send.url * @property webhooks.onMessageSent.method - The webhooks.on_message_sent.method * @property webhooks.onMessageSent.url - The webhooks.on_message_sent.url * @property webhooks.onMessageUpdate.method - The webhooks.on_message_update.method * @property webhooks.onMessageUpdate.url - The webhooks.on_message_update.url * @property webhooks.onMessageUpdated.method - The webhooks.on_message_updated.method * @property webhooks.onMessageUpdated.url - The webhooks.on_message_updated.url */ interface ServiceInstanceUpdateOptions { consumptionReportInterval?: number; defaultChannelCreatorRoleSid?: string; defaultChannelRoleSid?: string; defaultServiceRoleSid?: string; friendlyName?: string; limits?: { channelMembers?: number; userChannels?: number; }; notifications?: { newMessage?: { enabled?: boolean; template?: string; }; addedToChannel?: { enabled?: boolean; template?: string; }; removedFromChannel?: { enabled?: boolean; template?: string; }; invitedToChannel?: { enabled?: boolean; template?: string; }; }; postWebhookUrl?: string; preWebhookUrl?: string; reachabilityEnabled?: boolean; readStatusEnabled?: boolean; typingIndicatorTimeout?: number; webhookFilters?: string | string[]; webhookMethod?: string; webhooks?: { onMessageSend?: { url?: string; method?: string; }; onMessageUpdate?: { url?: string; method?: string; }; onMessageRemove?: { url?: string; method?: string; }; onChannelAdd?: { url?: string; method?: string; }; onChannelDestroy?: { url?: string; method?: string; }; onChannelUpdate?: { url?: string; method?: string; }; onMemberAdd?: { url?: string; method?: string; }; onMemberRemove?: { url?: string; method?: string; }; onMessageSent?: { url?: string; method?: string; }; onMessageUpdated?: { url?: string; method?: string; }; onMessageRemoved?: { url?: string; method?: string; }; onChannelAdded?: { url?: string; method?: string; }; onChannelDestroyed?: { url?: string; method?: string; }; onChannelUpdated?: { url?: string; method?: string; }; onMemberAdded?: { url?: string; method?: string; }; onMemberRemoved?: { url?: string; method?: string; }; }; } interface ServiceListInstance { /** * @param sid - sid of instance */ (sid: string): ServiceContext; /** * create a ServiceInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ create(opts: ServiceListInstanceCreateOptions, callback?: (error: Error | null, item: ServiceInstance) => any): Promise<ServiceInstance>; /** * Streams ServiceInstance 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 callback - Function to process each record */ each(callback?: (item: ServiceInstance, done: (err?: Error) => void) => void): void; /** * Streams ServiceInstance 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 opts - Options for request * @param callback - Function to process each record */ each(opts?: ServiceListInstanceEachOptions, callback?: (item: ServiceInstance, done: (err?: Error) => void) => void): void; /** * Constructs a service * * @param sid - The sid */ get(sid: string): ServiceContext; /** * Retrieve a single target page of ServiceInstance 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 callback - Callback to handle list of records */ getPage(callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>; /** * Retrieve a single target page of ServiceInstance 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 targetUrl - API-generated URL for the requested results page * @param callback - Callback to handle list of records */ getPage(targetUrl?: string, callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>; /** * Lists ServiceInstance 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 callback - Callback to handle list of records */ list(callback?: (error: Error | null, items: ServiceInstance[]) => any): Promise<ServiceInstance[]>; /** * Lists ServiceInstance 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 opts - Options for request * @param callback - Callback to handle list of records */ list(opts?: ServiceListInstanceOptions, callback?: (error: Error | null, items: ServiceInstance[]) => any): Promise<ServiceInstance[]>; /** * Retrieve a single page of ServiceInstance 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 callback - Callback to handle list of records */ page(callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>; /** * Retrieve a single page of ServiceInstance 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 opts - Options for request * @param callback - Callback to handle list of records */ page(opts?: ServiceListInstancePageOptions, callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>; /** * Provide a user-friendly representation */ toJSON(): any; } /** * Options to pass to create * * @property friendlyName - The friendly_name */ interface ServiceListInstanceCreateOptions { friendlyName: string; } /** * Options to pass to each * * @property callback - * Function to process each record. If this and a positional * callback are passed, this one will be used * @property done - Function to be called upon completion of streaming * @property limit - * Upper limit for the number of records to return. * each() guarantees never to return more than limit. * Default is no limit * @property pageSize - * Number of records to fetch per request, * when not set will use the default value of 50 records. * If no pageSize is defined but a limit is defined, * each() will attempt to read the limit with the most efficient * page size, i.e. min(limit, 1000) */ interface ServiceListInstanceEachOptions { callback?: (item: ServiceInstance, done: (err?: Error) => void) => void; done?: Function; limit?: number; pageSize?: number; } /** * Options to pass to list * * @property limit - * Upper limit for the number of records to return. * list() guarantees never to return more than limit. * Default is no limit * @property pageSize - * Number of records to fetch per request, * when not set will use the default value of 50 records. * If no page_size is defined but a limit is defined, * list() will attempt to read the limit with the most * efficient page size, i.e. min(limit, 1000) */ interface ServiceListInstanceOptions { limit?: number; pageSize?: number; } /** * Options to pass to page * * @property pageNumber - Page Number, this value is simply for client state * @property pageSize - Number of records to return, defaults to 50 * @property pageToken - PageToken provided by the API */ interface ServiceListInstancePageOptions { pageNumber?: number; pageSize?: number; pageToken?: string; } interface ServicePayload extends ServiceResource, Page.TwilioResponsePayload { } interface ServiceResource { account_sid: string; consumption_report_interval: number; date_created: Date; date_updated: Date; default_channel_creator_role_sid: string; default_channel_role_sid: string; default_service_role_sid: string; friendly_name: string; limits: object; links: string; notifications: object; post_webhook_url: string; pre_webhook_url: string; reachability_enabled: boolean; read_status_enabled: boolean; sid: string; typing_indicator_timeout: number; url: string; webhook_filters: string[]; webhook_method: string; webhooks: object; } interface ServiceSolution { } declare class ServiceContext { /** * Initialize the ServiceContext * * @param version - Version of the resource * @param sid - The sid */ constructor(version: V1, sid: string); channels: ChannelListInstance; /** * fetch a ServiceInstance * * @param callback - Callback to handle processed record */ fetch(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; /** * remove a ServiceInstance * * @param callback - Callback to handle processed record */ remove(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<boolean>; roles: RoleListInstance; /** * Provide a user-friendly representation */ toJSON(): any; /** * update a ServiceInstance * * @param callback - Callback to handle processed record */ update(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; /** * update a ServiceInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ update(opts?: ServiceInstanceUpdateOptions, callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; users: UserListInstance; } declare class ServiceInstance extends SerializableClass { /** * Initialize the ServiceContext * * @param version - Version of the resource * @param payload - The instance payload * @param sid - The sid */ constructor(version: V1, payload: ServicePayload, sid: string); private _proxy: ServiceContext; accountSid: string; /** * Access the channels */ channels(): ChannelListInstance; consumptionReportInterval: number; dateCreated: Date; dateUpdated: Date; defaultChannelCreatorRoleSid: string; defaultChannelRoleSid: string; defaultServiceRoleSid: string; /** * fetch a ServiceInstance * * @param callback - Callback to handle processed record */ fetch(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; friendlyName: string; limits: any; links: string; notifications: any; postWebhookUrl: string; preWebhookUrl: string; reachabilityEnabled: boolean; readStatusEnabled: boolean; /** * remove a ServiceInstance * * @param callback - Callback to handle processed record */ remove(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<boolean>; /** * Access the roles */ roles(): RoleListInstance; sid: string; /** * Provide a user-friendly representation */ toJSON(): any; typingIndicatorTimeout: number; /** * update a ServiceInstance * * @param callback - Callback to handle processed record */ update(callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; /** * update a ServiceInstance * * @param opts - Options for request * @param callback - Callback to handle processed record */ update(opts?: ServiceInstanceUpdateOptions, callback?: (error: Error | null, items: ServiceInstance) => any): Promise<ServiceInstance>; url: string; /** * Access the users */ users(): UserListInstance; webhookFilters: string[]; webhookMethod: string; webhooks: any; } declare class ServicePage extends Page<V1, ServicePayload, ServiceResource, ServiceInstance> { /** * Initialize the ServicePage * * @param version - Version of the resource * @param response - Response from the API * @param solution - Path solution */ constructor(version: V1, response: Response<string>, solution: ServiceSolution); /** * Build an instance of ServiceInstance * * @param payload - Payload response from the API */ getInstance(payload: ServicePayload): ServiceInstance; /** * Provide a user-friendly representation */ toJSON(): any; } export { ServiceContext, ServiceInstance, ServiceInstanceUpdateOptions, ServiceList, ServiceListInstance, ServiceListInstanceCreateOptions, ServiceListInstanceEachOptions, ServiceListInstanceOptions, ServiceListInstancePageOptions, ServicePage, ServicePayload, ServiceResource, ServiceSolution }