IWINVProvider
Defined in: packages/provider/src/iwinv/provider.ts:54
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IWINVProvider(
config):IWINVProvider
Defined in: packages/provider/src/iwinv/provider.ts:71
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”IWINVProvider
Properties
Section titled “Properties”
readonlyid:"iwinv"="iwinv"
Defined in: packages/provider/src/iwinv/provider.ts:57
Implementation of
Section titled “Implementation of”
readonlyname:"IWINV Messaging Provider"="IWINV Messaging Provider"
Defined in: packages/provider/src/iwinv/provider.ts:58
Implementation of
Section titled “Implementation of”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/iwinv/provider.ts:59
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”createTemplate()
Section titled “createTemplate()”createTemplate(
input,_ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:391
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.createTemplate
deleteTemplate()
Section titled “deleteTemplate()”deleteTemplate(
code,_ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:416
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.deleteTemplate
getBalance()
Section titled “getBalance()”getBalance(
query?):Promise<Result<BalanceResult,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:189
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<Result<BalanceResult, KMsgError>>
Implementation of
Section titled “Implementation of”getDeliveryStatus()
Section titled “getDeliveryStatus()”getDeliveryStatus(
query):Promise<Result<DeliveryStatusResult|null,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:160
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<DeliveryStatusResult | null, KMsgError>>
Implementation of
Section titled “Implementation of”getOnboardingSpec()
Section titled “getOnboardingSpec()”getOnboardingSpec():
ProviderOnboardingSpec
Defined in: packages/provider/src/iwinv/provider.ts:63
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:427
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”healthCheck()
Section titled “healthCheck()”healthCheck():
Promise<ProviderHealthStatus>
Defined in: packages/provider/src/iwinv/provider.ts:92
Returns
Section titled “Returns”Promise<ProviderHealthStatus>
Implementation of
Section titled “Implementation of”listTemplates()
Section titled “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:439
Parameters
Section titled “Parameters”params?
Section titled “params?”limit?
Section titled “limit?”number
number
status?
Section titled “status?”string
Returns
Section titled “Returns”Promise<Result<Template[], KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.listTemplates
send()
Section titled “send()”send(
options):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:127
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Implementation of
Section titled “Implementation of”updateTemplate()
Section titled “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:402
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>