Papier
Get started
InterfaceSDK v0.2.1

SmsTemplateMethods

SMS surface methods for a specific template.

import type { SmsTemplateMethods } from '@usepapier/client/base';

Declaration #

surfaces.tsTypeScript
export interface SmsTemplateMethods<TPayload = any> {
    send: (args: {
        to: string;
        data: TPayload;
    }) => Promise<{
        success: true;
        adapter: string;
        id?: string;
    }>;
    build: (args: {
        to: string;
        data: TPayload;
    }) => Promise<BuiltSmsPayload<TPayload>>;
}

Source: packages/client/src/core/surfaces.ts:92

Members 2

send

send: (args: {
    to: string;
    data: TPayload;
}) => Promise<{
    success: true;
    adapter: string;
    id?: string;
}>;

Parameters

args
{ to: string; data: TPayload }

packages/client/src/core/surfaces.ts:93

build

Build and validate a payload for later sending (outbox pattern). The returned payload can be stored and sent later using papier.send().

build: (args: {
    to: string;
    data: TPayload;
}) => Promise<BuiltSmsPayload<TPayload>>;

Parameters

args
{ to: string; data: TPayload }

packages/client/src/core/surfaces.ts:103

Generated from TypeScript source.d65ea8f71fbf