ChannelCRUD
Defined in: packages/channel/src/toolkit/management/crud.ts:67
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChannelCRUD(
options?):ChannelCRUD
Defined in: packages/channel/src/toolkit/management/crud.ts:83
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<ChannelCRUDOptions> = {}
Returns
Section titled “Returns”ChannelCRUD
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cleanup()
Section titled “cleanup()”cleanup():
object
Defined in: packages/channel/src/toolkit/management/crud.ts:646
Returns
Section titled “Returns”object
deletedChannels
Section titled “deletedChannels”deletedChannels:
number
expiredAuditLogs
Section titled “expiredAuditLogs”expiredAuditLogs:
number
createChannel()
Section titled “createChannel()”createChannel(
request,userId?):Promise<Channel>
Defined in: packages/channel/src/toolkit/management/crud.ts:93
Parameters
Section titled “Parameters”request
Section titled “request”userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<Channel>
createSenderNumber()
Section titled “createSenderNumber()”createSenderNumber(
channelId,request,userId?):Promise<SenderNumber>
Defined in: packages/channel/src/toolkit/management/crud.ts:309
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
request
Section titled “request”userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<SenderNumber>
deleteChannel()
Section titled “deleteChannel()”deleteChannel(
channelId,userId?):Promise<boolean>
Defined in: packages/channel/src/toolkit/management/crud.ts:198
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<boolean>
deleteSenderNumber()
Section titled “deleteSenderNumber()”deleteSenderNumber(
senderNumberId,userId?):Promise<boolean>
Defined in: packages/channel/src/toolkit/management/crud.ts:439
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<boolean>
destroy()
Section titled “destroy()”destroy():
void
Defined in: packages/channel/src/toolkit/management/crud.ts:678
Returns
Section titled “Returns”void
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:71
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”EventEmitter.eventNames
getAuditLogs()
Section titled “getAuditLogs()”getAuditLogs(
entityType?,entityId?,limit?):AuditLogEntry[]
Defined in: packages/channel/src/toolkit/management/crud.ts:573
Parameters
Section titled “Parameters”entityType?
Section titled “entityType?”"senderNumber" | "channel"
entityId?
Section titled “entityId?”string
limit?
Section titled “limit?”number = 100
Returns
Section titled “Returns”getChannel()
Section titled “getChannel()”getChannel(
channelId,userId?):Promise<Channel|null>
Defined in: packages/channel/src/toolkit/management/crud.ts:139
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<Channel | null>
getSenderNumber()
Section titled “getSenderNumber()”getSenderNumber(
senderNumberId,userId?):Promise<SenderNumber|null>
Defined in: packages/channel/src/toolkit/management/crud.ts:364
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<SenderNumber | null>
getStatistics()
Section titled “getStatistics()”getStatistics():
object
Defined in: packages/channel/src/toolkit/management/crud.ts:592
Returns
Section titled “Returns”object
channels
Section titled “channels”channels:
object
channels.byProvider
Section titled “channels.byProvider”byProvider:
Record<string,number>
channels.byStatus
Section titled “channels.byStatus”byStatus:
Record<string,number>
channels.byType
Section titled “channels.byType”byType:
Record<string,number>
channels.total
Section titled “channels.total”total:
number
senderNumbers
Section titled “senderNumbers”senderNumbers:
object
senderNumbers.byCategory
Section titled “senderNumbers.byCategory”byCategory:
Record<string,number>
senderNumbers.byStatus
Section titled “senderNumbers.byStatus”byStatus:
Record<string,number>
senderNumbers.total
Section titled “senderNumbers.total”total:
number
listChannels()
Section titled “listChannels()”listChannels(
filters?,pagination?):Promise<PaginatedResult<Channel>>
Defined in: packages/channel/src/toolkit/management/crud.ts:227
Parameters
Section titled “Parameters”filters?
Section titled “filters?”ChannelFilters = {}
pagination?
Section titled “pagination?”PaginationOptions = ...
Returns
Section titled “Returns”Promise<PaginatedResult<Channel>>
listenerCount()
Section titled “listenerCount()”listenerCount(
eventName):number
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:67
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
listSenderNumbers()
Section titled “listSenderNumbers()”listSenderNumbers(
filters?,pagination?):Promise<PaginatedResult<SenderNumber>>
Defined in: packages/channel/src/toolkit/management/crud.ts:482
Parameters
Section titled “Parameters”filters?
Section titled “filters?”SenderNumberFilters = {}
pagination?
Section titled “pagination?”PaginationOptions = ...
Returns
Section titled “Returns”Promise<PaginatedResult<SenderNumber>>
off(
eventName,listener):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/channel/src/toolkit/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
updateChannel()
Section titled “updateChannel()”updateChannel(
channelId,updates,userId?):Promise<Channel>
Defined in: packages/channel/src/toolkit/management/crud.ts:152
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
updates
Section titled “updates”Partial<Omit<Channel, "id" | "createdAt" | "updatedAt">>
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<Channel>
updateSenderNumber()
Section titled “updateSenderNumber()”updateSenderNumber(
senderNumberId,updates,userId?):Promise<SenderNumber>
Defined in: packages/channel/src/toolkit/management/crud.ts:377
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
updates
Section titled “updates”Partial<Omit<SenderNumber, "id" | "phoneNumber" | "createdAt" | "updatedAt">>
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<SenderNumber>