Skip to content
k-msg

IWINVSendProvider

Defined in: packages/provider/src/iwinv/provider.send.ts:60

Core provider interface for sending messages.

All providers must implement this interface. Optional capabilities (balance, templates, delivery status) are exposed via separate interfaces.

Example

Section titled “Example”
class MyProvider implements Provider {
  readonly id = "my-provider";
  readonly name = "My Provider";
  readonly supportedTypes = ["SMS", "LMS"] as const;


  async healthCheck() { return { healthy: true, issues: [] }; }
  async send(params) { ... }
}

Extended by

Section titled “Extended by”

Implements

Section titled “Implements”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new IWINVSendProvider(config): IWINVSendProvider

Defined in: packages/provider/src/iwinv/provider.send.ts:77

Parameters

Section titled “Parameters”
config
Section titled “config”

IWINVConfig

Returns

Section titled “Returns”

IWINVSendProvider

Properties

Section titled “Properties”

id

Section titled “id”

readonly id: "iwinv" = "iwinv"

Defined in: packages/provider/src/iwinv/provider.send.ts:61

Unique identifier for this provider instance. Used for routing and logging.

Example

Section titled “Example”
"solapi"

Implementation of

Section titled “Implementation of”

Provider.id

name

Section titled “name”

readonly name: "IWINV Messaging Provider" = "IWINV Messaging Provider"

Defined in: packages/provider/src/iwinv/provider.send.ts:62

Human-readable name for display purposes.

Example

Section titled “Example”
"SOLAPI"

Implementation of

Section titled “Implementation of”

Provider.name

supportedTypes

Section titled “supportedTypes”

readonly supportedTypes: readonly MessageType[]

Defined in: packages/provider/src/iwinv/provider.send.ts:63

Message types this provider supports. Messages of unsupported types will be rejected.

Implementation of

Section titled “Implementation of”

Provider.supportedTypes

transportCapabilities

Section titled “transportCapabilities”

readonly transportCapabilities: object

Defined in: packages/provider/src/iwinv/provider.send.ts:64

Per-operation transport features supported by this provider. Missing declarations must be treated as unsupported.

abortSignal

Section titled “abortSignal”

readonly abortSignal: "supported" = "supported"

injectableFetch

Section titled “injectableFetch”

readonly injectableFetch: "supported" = "supported"

Implementation of

Section titled “Implementation of”

Provider.transportCapabilities

Methods

Section titled “Methods”

getBalance()

Section titled “getBalance()”

getBalance(query?): Promise<Result<BalanceResult, KMsgError>>

Defined in: packages/provider/src/iwinv/provider.send.ts:218

Query the remaining balance/points for the provider account.

Parameters

Section titled “Parameters”
query?
Section titled “query?”

BalanceQuery

Returns

Section titled “Returns”

Promise<Result<BalanceResult, KMsgError>>

Implementation of

Section titled “Implementation of”

BalanceProvider.getBalance

getDeliveryStatus()

Section titled “getDeliveryStatus()”

getDeliveryStatus(query, context?): Promise<Result<DeliveryStatusResult | null, KMsgError>>

Defined in: packages/provider/src/iwinv/provider.send.ts:179

Query delivery status for a previously sent message. Optional capability - not all providers support this.

Parameters

Section titled “Parameters”
query
Section titled “query”

DeliveryStatusQuery

context?
Section titled “context?”

ProviderRequestContext

Returns

Section titled “Returns”

Promise<Result<DeliveryStatusResult | null, KMsgError>>

Implementation of

Section titled “Implementation of”

Provider.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”

ProviderOnboardingSpec

Implementation of

Section titled “Implementation of”

Provider.getOnboardingSpec

healthCheck()

Section titled “healthCheck()”

healthCheck(): Promise<ProviderHealthStatus>

Defined in: packages/provider/src/iwinv/provider.send.ts:98

Check if the provider is operational. Used for health monitoring and circuit breaker decisions.

Returns

Section titled “Returns”

Promise<ProviderHealthStatus>

Implementation of

Section titled “Implementation of”

Provider.healthCheck

send()

Section titled “send()”

send(options, context?): Promise<Result<SendResult, KMsgError>>

Defined in: packages/provider/src/iwinv/provider.send.ts:133

Send a message through this provider.

Parameters

Section titled “Parameters”
options
Section titled “options”

SendOptions

context?
Section titled “context?”

ProviderRequestContext

Returns

Section titled “Returns”

Promise<Result<SendResult, KMsgError>>

Result with SendResult on success, KMsgError on failure.

Implementation of

Section titled “Implementation of”

Provider.send