IWINVProvider
Defined in: packages/provider/src/iwinv/provider.ts:20
Interface for providers that support AlimTalk template management.
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IWINVProvider(
config):IWINVProvider
Defined in: packages/provider/src/iwinv/provider.send.ts:85
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”IWINVProvider
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”
readonlyid:"iwinv"="iwinv"
Defined in: packages/provider/src/iwinv/provider.send.ts:67
Unique identifier for this provider instance. Used for routing and logging.
Example
Section titled “Example”"solapi"Inherited from
Section titled “Inherited from”
readonlyname:"IWINV Messaging Provider"="IWINV Messaging Provider"
Defined in: packages/provider/src/iwinv/provider.send.ts:68
Human-readable name for display purposes.
Example
Section titled “Example”"SOLAPI"Inherited from
Section titled “Inherited from”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/iwinv/provider.send.ts:69
Message types this provider supports. Messages of unsupported types will be rejected.
Inherited from
Section titled “Inherited from”IWINVSendProvider.supportedTypes
Methods
Section titled “Methods”createTemplate()
Section titled “createTemplate()”createTemplate(
input,_ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:24
Create a new template.
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:49
Delete a template by code.
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.send.ts:207
Query the remaining balance/points for the provider account.
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”Promise<Result<BalanceResult, KMsgError>>
Inherited from
Section titled “Inherited from”getDeliveryStatus()
Section titled “getDeliveryStatus()”getDeliveryStatus(
query):Promise<Result<DeliveryStatusResult|null,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.send.ts:178
Query delivery status for a previously sent message. Optional capability - not all providers support this.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<DeliveryStatusResult | null, KMsgError>>
Inherited from
Section titled “Inherited from”IWINVSendProvider.getDeliveryStatus
getOnboardingSpec()
Section titled “getOnboardingSpec()”getOnboardingSpec():
ProviderOnboardingSpec
Defined in: packages/provider/src/iwinv/provider.send.ts:73
Get the onboarding specification for this provider. Used by tooling to guide provider configuration.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”IWINVSendProvider.getOnboardingSpec
getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:60
Get a template by code.
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.send.ts:110
Check if the provider is operational. Used for health monitoring and circuit breaker decisions.
Returns
Section titled “Returns”Promise<ProviderHealthStatus>
Inherited from
Section titled “Inherited from”listTemplates()
Section titled “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:72
List templates with optional filtering and pagination.
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.send.ts:145
Send a message through this provider.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.
Inherited from
Section titled “Inherited from”updateTemplate()
Section titled “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/iwinv/provider.ts:35
Update an existing template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>