@smsmode/rcs 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,577 @@
+interface SmsmodeClientOptions {
+    apiKey: string;
+    /** @internal */
+    baseUrl?: string;
+    /** Timeout in milliseconds. @default 10000 */
+    timeout?: number;
+}
+type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'DELETE';
+interface RequestOptions {
+    method?: HttpMethod;
+    body?: unknown;
+    params?: Record<string, string | number | boolean | undefined>;
+}
+interface PaginatedResponse<T> {
+    startDate?: string;
+    endDate?: string;
+    page: number;
+    pageSize: number;
+    count: number;
+    totalCount: number;
+    links: {
+        first?: string;
+        last?: string;
+        previous?: string;
+        next?: string;
+    };
+    items: T[];
+}
+/** Route the request through a specific Channel and/or Campaign */
+interface MessagePathOptions {
+    channelId?: string;
+    campaignId?: string;
+}
+interface CampaignPathOptions {
+    channelId?: string;
+}
+/** Direction of a message. MT = Mobile Terminated (sent), MO = Mobile Originator (received). */
+type RcsDirection = 'MT' | 'MO';
+/** Message status — final or temporary. See doc "Message Status Values". */
+type RcsStatusValue = 'SCHEDULED' | 'ENROUTE' | 'DELIVERED' | 'READ' | 'UNDELIVERABLE' | 'UNDELIVERED';
+/** Detailed status information. See doc "Status Detail Values". */
+type RcsStatusDetail = 'IN_PROGRESS' | 'DELIVERED_TO_NETWORK' | 'INSUFFICIENT_CREDIT' | 'DAILY_LIMIT_EXCEEDED' | 'ORGANISATION_MONTHLY_LIMIT_EXCEEDED' | 'ROUTE_NOT_AVAILABLE' | 'SPAM' | 'INVALID_PHONE_NUMBER' | 'BLACKLISTED' | 'PHONE_NOT_SUITABLE' | 'NETWORK_NOT_SUITABLE' | 'MEDIA_INVALID' | 'EXPIRED' | 'CANCELLED' | 'INTERNAL_ERROR';
+/** Body content kind. See doc "Body type values". */
+type RcsBodyType = 'BASIC' | 'TEXT' | 'CARD' | 'CAROUSEL' | 'FILE';
+/** Suggested action kind. See doc "Body Suggestions type values". */
+type RcsSuggestionType = 'REPLY' | 'OPEN_URL' | 'DIAL_PHONE' | 'SHOW_LOCATION' | 'REQUEST_LOCATION' | 'CREATE_CALENDAR_EVENT';
+/** Webview display size for OPEN_URL suggestions. */
+type RcsWebviewSize = 'NONE' | 'HALF' | 'TALL' | 'FULL';
+/** Card media height — only applicable when orientation is VERTICAL. */
+type RcsMediaHeight = 'SHORT' | 'MEDIUM' | 'TALL';
+/** Card orientation. */
+type RcsCardOrientation = 'VERTICAL' | 'HORIZONTAL';
+/** Card alignment. */
+type RcsCardAlignment = 'LEFT' | 'RIGHT';
+/** Carousel card width. */
+type RcsCardWidth = 'SMALL' | 'MEDIUM';
+interface RcsPrice {
+    amount: number;
+    currency: string;
+}
+interface RcsValidity {
+    /** Duration value (integer). Min 30 SECONDS, max 48 HOURS (default). */
+    amount: number;
+    /** Unit of time. Defaults to MINUTES when omitted. */
+    timeUnit: 'SECONDS' | 'MINUTES' | 'HOURS';
+}
+interface RcsStatus {
+    value: RcsStatusValue;
+    detail?: RcsStatusDetail;
+    /** ISO 8601 date-time. */
+    deliveryDate?: string;
+    /** Network lookup data. Structure not yet documented. */
+    lookup?: Record<string, unknown>;
+}
+interface RcsRecipient {
+    to: string;
+    /** Per-recipient dynamic variables for campaigns. Keys are used as `$key` in body.text. */
+    parameters?: Record<string, string>;
+    /** Per-recipient reference tag for campaigns. 3-140 chars. */
+    refClient?: string;
+}
+/** Channel details embedded in a Message. */
+interface RcsChannel {
+    channelId: string;
+    name?: string;
+    type: 'RCS';
+    flow?: 'TRANSACTIONAL' | 'MARKETING' | 'OTP';
+}
+/** Base fields shared by all suggestion types. */
+interface RcsSuggestionBase {
+    type: RcsSuggestionType;
+    /** Text displayed in the suggestion. Max 25 chars. */
+    text: string;
+    /** Base64-encoded payload returned to the agent on tap. Max 2048 chars. */
+    postbackData: string;
+}
+/** Suggested quick reply — no extra fields. */
+interface RcsReplySuggestion extends RcsSuggestionBase {
+    type: 'REPLY';
+}
+/** Suggested URL opening. */
+interface RcsOpenUrlSuggestion extends RcsSuggestionBase {
+    type: 'OPEN_URL';
+    /** URL to open. Max 255 chars. */
+    url: string;
+    /** Webview display size. @default "NONE" */
+    webviewSize?: RcsWebviewSize;
+}
+/** Suggested phone call. */
+interface RcsDialPhoneSuggestion extends RcsSuggestionBase {
+    type: 'DIAL_PHONE';
+    /** Phone number in E.164 format. */
+    phoneNumber: string;
+}
+/** Suggested location display. */
+interface RcsShowLocationSuggestion extends RcsSuggestionBase {
+    type: 'SHOW_LOCATION';
+    /** Latitude. -90 to 90. */
+    latitude: number;
+    /** Longitude. -180 to 180. */
+    longitude: number;
+    /** Location label. Max 100 chars. */
+    label?: string;
+}
+/** Suggested location request — no extra fields. */
+interface RcsRequestLocationSuggestion extends RcsSuggestionBase {
+    type: 'REQUEST_LOCATION';
+}
+/** Suggested calendar event creation. */
+interface RcsCreateCalendarEventSuggestion extends RcsSuggestionBase {
+    type: 'CREATE_CALENDAR_EVENT';
+    /** ISO 8601 date-time — event start. */
+    startTime: string;
+    /** ISO 8601 date-time — event end. */
+    endTime: string;
+    /** Event title. Max 100 chars. */
+    title: string;
+    /** Event description. Max 500 chars. */
+    description?: string;
+}
+/** Discriminated union of all RCS suggestion types. */
+type RcsSuggestion = RcsReplySuggestion | RcsOpenUrlSuggestion | RcsDialPhoneSuggestion | RcsShowLocationSuggestion | RcsRequestLocationSuggestion | RcsCreateCalendarEventSuggestion;
+/** Media content inside a Card or Carousel item. */
+interface RcsCardMedia {
+    /** URL of the media to display. Max 255 chars. */
+    fileUrl: string;
+    /** Thumbnail URL — only when fileUrl is a video. */
+    thumbnailUrl?: string;
+    /** Media height. @default "MEDIUM". Only applicable when orientation is VERTICAL. */
+    height?: RcsMediaHeight;
+}
+/** Card content — shared between CARD `content` and CAROUSEL `contents[]` items. */
+interface RcsCardContent {
+    /** Card title. Max 200 chars. */
+    title?: string;
+    /** Card description. Max 2000 chars. */
+    description?: string;
+    /** Card media (image or video). */
+    media?: RcsCardMedia;
+    /** Suggestions inside the card. Max 4 items. */
+    suggestions?: RcsSuggestion[];
+}
+/** BASIC body — plain text, no suggestions. Max 160 chars. */
+interface RcsBasicBody {
+    type: 'BASIC';
+    /** Plain text message. Max 160 chars. */
+    text: string;
+}
+/** TEXT body — rich text with optional suggestions. Max 3072 chars. */
+interface RcsTextBody {
+    type: 'TEXT';
+    /** Text message content. Max 3072 chars. */
+    text: string;
+    /** Suggestions list. Max 11 items. */
+    suggestions?: RcsSuggestion[];
+}
+/** FILE body — media file with optional suggestions. */
+interface RcsFileBody {
+    type: 'FILE';
+    /** URL of the media. Max 255 chars. Supported: images, videos, audio, PDF. */
+    fileUrl: string;
+    /** Thumbnail URL — only when fileUrl is a video. */
+    thumbnailUrl?: string;
+    /** Suggestions list. Max 11 items. */
+    suggestions?: RcsSuggestion[];
+}
+/** CARD body — rich card with content, orientation, alignment and suggestions. */
+interface RcsCardBody {
+    type: 'CARD';
+    /** Card content. Must contain at least `media` or `title`. */
+    content: RcsCardContent;
+    /** Card orientation. @default "VERTICAL" */
+    orientation?: RcsCardOrientation;
+    /** Card alignment. @default "LEFT" */
+    alignment?: RcsCardAlignment;
+    /** Suggestions below the card. Max 11 items. */
+    suggestions?: RcsSuggestion[];
+}
+/** CAROUSEL body — 2 to 11 cards with optional suggestions. */
+interface RcsCarouselBody {
+    type: 'CAROUSEL';
+    /** Carousel cards. Min 2, max 11 items. */
+    contents: RcsCardContent[];
+    /** Card width. @default "MEDIUM" */
+    cardWidth?: RcsCardWidth;
+    /** Suggestions below the carousel. Max 11 items. */
+    suggestions?: RcsSuggestion[];
+}
+/** Discriminated union of all RCS body types. */
+type RcsBody = RcsBasicBody | RcsTextBody | RcsFileBody | RcsCardBody | RcsCarouselBody;
+/** RCS Message resource as returned by the API. */
+interface RcsMessage {
+    messageId: string;
+    /** Present only for MO (Mobile Originator) messages. */
+    originMessageId?: string;
+    /** ISO 8601 date-time when the message was accepted by smsmode. */
+    acceptedAt: string;
+    /** ISO 8601 date-time when the message has been or will be sent. */
+    sentDate: string;
+    channel: RcsChannel;
+    type: 'RCS';
+    direction: RcsDirection;
+    recipient: RcsRecipient;
+    /** RCS agent used for sending. 1-40 chars. Default "Default RCS Agent". */
+    from: string;
+    body: RcsBody;
+    price: RcsPrice;
+    status: RcsStatus;
+    validity: RcsValidity;
+    /** Client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. */
+    callbackUrlMo?: string;
+    /** Link to message details operation. */
+    href: string;
+}
+/**
+ * Corps de requête pour l'envoi d'un message RCS unitaire.
+ * Pour un envoi en batch, utiliser un tableau `RcsSendPayload[]` (max 1000).
+ */
+interface RcsSendPayload {
+    recipient: RcsRecipient;
+    body: RcsBody;
+    /** RCS agent used for sending. 1-40 chars. @default "Default RCS Agent" */
+    from?: string;
+    /**
+     * ISO 8601 date-time. Future date <= 1 year.
+     * Si sentDate < 5 min dans le futur, envoi immédiat. @default now
+     */
+    sentDate?: string;
+    /** Message validity period. Min 30 SECONDS, max 48 HOURS (default). */
+    validity?: RcsValidity;
+    /** Client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. */
+    callbackUrlMo?: string;
+}
+/** Batch send payload — up to 1000 messages per request. */
+type RcsBatchSendPayload = RcsSendPayload[];
+/** Sort order for paginated lists. */
+type RcsSortOrder = 'ASC' | 'DESC';
+/** Filter fields for GET /messages. Serialized as `searchBy[<key>]`. */
+interface RcsMessageSearchBy {
+    /** Filter: MT (sent) or MO (incoming). @default MT */
+    direction?: RcsDirection;
+    /** Filter by client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** Filter by recipient phone number (E.164). */
+    to?: string;
+    /** Filter by origin message UUID. Must be combined with `direction=MO`. */
+    originMessageId?: string;
+}
+/** Sort fields for GET /messages. Serialized as `sortBy[<key>]`. */
+interface RcsMessageSortBy {
+    sentDate?: RcsSortOrder;
+    refClient?: RcsSortOrder;
+}
+/** Query parameters for GET /messages. */
+interface RcsListParams {
+    /** ISO 8601. @default 10 days earlier than now */
+    startDate?: string;
+    /** ISO 8601. @default now */
+    endDate?: string;
+    /** Page number, min 1. @default 1 */
+    page?: number;
+    /** Page size, 1-100. @default 10 */
+    pageSize?: number;
+    searchBy?: RcsMessageSearchBy;
+    sortBy?: RcsMessageSortBy;
+}
+/**
+ * Corps de requête pour la modification d'un message RCS programmé.
+ * Tous les champs sont optionnels. Une valeur vide (`""`) permet de retirer
+ * un paramètre optionnel (ex: `refClient: ""`).
+ * Impossible d'éditer dans les 5 minutes précédant l'envoi ("preloaded" state).
+ */
+interface RcsUpdatePayload {
+    recipient?: RcsRecipient;
+    /** ISO 8601. Future date entre 5 minutes et 1 an. */
+    sentDate?: string;
+    /** Client reference tag. 3-140 chars. `""` pour retirer. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. `""` pour retirer. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. `""` pour retirer. */
+    callbackUrlMo?: string;
+}
+/** Campaign state. See doc "Campaign Status Values". */
+type RcsCampaignStatus = 'SCHEDULED' | 'ONGOING' | 'ENDED' | 'CANCELED';
+/** Aggregated delivery status entry inside a Campaign response. */
+interface RcsCampaignStatusEntry {
+    /** ISO 8601 date-time when the delivery report was received. */
+    deliveryDate?: string;
+    value: RcsStatusValue;
+    detail?: RcsStatusDetail;
+    /** Number of messages for this status. */
+    quantity: number;
+}
+/** RCS Campaign resource as returned by the API. */
+interface RcsCampaign {
+    campaignId: string;
+    /** Max 100 chars. */
+    name?: string;
+    /** ISO 8601 date-time when the campaign was accepted by smsmode. */
+    acceptedAt: string;
+    /** ISO 8601 date-time when the campaign has been or will be sent. */
+    sentDate: string;
+    /** ISO 8601 date-time when the campaign will finish. */
+    endDate: string;
+    channel: RcsChannel;
+    type: 'RCS';
+    /** Recipient list. Max 1000. */
+    recipients: RcsRecipient[];
+    /** RCS agent used for sending. 1-40 chars. Default "Default RCS Agent". */
+    from: string;
+    body: RcsBody;
+    /** Total of Messages sent. */
+    quantity: number;
+    price: RcsPrice;
+    status: RcsCampaignStatus;
+    statuses: RcsCampaignStatusEntry[];
+    /** Client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. */
+    callbackUrlMo?: string;
+    /** Link to campaign details operation. */
+    href: string;
+}
+/**
+ * Corps de requête pour l'envoi/programmation d'une campagne RCS.
+ * Limité à 1000 destinataires. Pour plus, utiliser POST /campaigns/{id}/messages.
+ */
+interface RcsCampaignSendPayload {
+    /** Campaign name. Max 100 chars. */
+    name: string;
+    /** Recipient list. Max 1000. */
+    recipients: RcsRecipient[];
+    body: RcsBody;
+    /** RCS agent used for sending. 1-40 chars. @default "Default RCS Agent" */
+    from?: string;
+    /**
+     * ISO 8601 date-time. Future, <= 1 year, au moins +30 minutes vs now.
+     * @default now
+     */
+    sentDate?: string;
+    /** Client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. */
+    callbackUrlMo?: string;
+}
+/** Filter fields for GET /campaigns. Serialized as `searchBy[<key>]`. */
+interface RcsCampaignSearchBy {
+    /** Filter by campaign status. @default ONGOING */
+    status?: RcsCampaignStatus;
+    /** Filter by client reference tag. 3-140 chars. */
+    refClient?: string;
+}
+/** Sort fields for GET /campaigns. Serialized as `sortBy[<key>]`. */
+interface RcsCampaignSortBy {
+    sentDate?: RcsSortOrder;
+    refClient?: RcsSortOrder;
+}
+/** Query parameters for GET /campaigns. */
+interface RcsCampaignListParams {
+    /** ISO 8601. @default 10 days earlier than today */
+    startDate?: string;
+    /** ISO 8601. @default today */
+    endDate?: string;
+    /** Page number, min 1. @default 1 */
+    page?: number;
+    /** Page size, 1-100. @default 10 */
+    pageSize?: number;
+    searchBy?: RcsCampaignSearchBy;
+    sortBy?: RcsCampaignSortBy;
+}
+/**
+ * Corps de requête pour la modification d'une campagne RCS programmée.
+ * Les champs sont appliqués à tous les messages unitaires de la campagne.
+ * Une valeur vide (`""`) permet de retirer un paramètre optionnel (ex: `refClient: ""`),
+ * sauf pour `name` (non vidable) et pour `callbackUrlStatus` / `callbackUrlMo` lorsqu'ils
+ * ont une valeur par défaut configurée au niveau du Channel.
+ */
+interface RcsCampaignUpdatePayload {
+    /** Campaign name. Max 100 chars. Non vidable. */
+    name?: string;
+    /**
+     * ISO 8601 date-time. Future, <= 1 year, au moins +30 minutes vs now.
+     */
+    sentDate?: string;
+    /** Client reference tag. 3-140 chars. `""` pour retirer. */
+    refClient?: string;
+    /** DLR callback URL. Max 255 chars. */
+    callbackUrlStatus?: string;
+    /** MO callback URL. Max 255 chars. */
+    callbackUrlMo?: string;
+}
+/**
+ * Delivery Report (DLR) webhook payload — reçu sur l'URL configurée via
+ * `callbackUrlStatus` (dynamique dans la requête ou défini au niveau du Channel).
+ * Schéma identique à {@link RcsMessage} (source : section "Receive Status reports
+ * Webhook" de la doc officielle smsmode RCS).
+ */
+type RcsDeliveryReportPayload = RcsMessage;
+/**
+ * Incoming Message (MO) webhook payload — reçu sur l'URL configurée via
+ * `callbackUrlMo` (dynamique dans la requête ou défini au niveau du Channel).
+ * Schéma issu de la section "Receive RCS MO message Webhook" de la doc officielle.
+ *
+ * Sous-ensemble du modèle Message : pas de `acceptedAt`, `price`, `status`,
+ * `validity`, `callbackUrl*`. Le `body` est systématiquement de type TEXT.
+ */
+interface RcsIncomingMessagePayload {
+    messageId: string;
+    /** UUID du message d'origine (MT) auquel ce MO répond — toujours présent pour un MO. */
+    originMessageId: string;
+    /** ISO 8601 date-time when the message was received. */
+    sentDate: string;
+    channel: RcsChannel;
+    type: 'RCS';
+    direction: 'MO';
+    recipient: RcsRecipient;
+    /** RCS agent. 1-40 chars. Default "Default RCS Agent". */
+    from: string;
+    body: RcsTextBody;
+    /** Client reference tag. 3-140 chars. */
+    refClient?: string;
+    /** Link to message details operation. */
+    href: string;
+}
+/** Union discriminable par `direction` (MT = DLR, MO = incoming message). */
+type RcsWebhookPayload = RcsDeliveryReportPayload | RcsIncomingMessagePayload;
+
+declare class BaseClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeout;
+    constructor(options: SmsmodeClientOptions);
+    private encodeParams;
+    private buildUrl;
+    private handleErrorResponse;
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+    get<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    post<T>(path: string, body?: unknown, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    patch<T>(path: string, body?: unknown, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    delete<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+}
+
+/**
+ * Campaigns resource — grouped RCS sends (max 1000 recipients per campaign)
+ * and campaign statistics. Accessed via `client.campaigns` on {@link SmsmodeRcsClient}.
+ */
+declare class CampaignsResource {
+    private readonly client;
+    constructor(client: BaseClient);
+    private buildBasePath;
+    private buildCampaignPath;
+    private flattenListParams;
+    /** Send or schedule a campaign (max 1000 recipients) */
+    send(payload: RcsCampaignSendPayload, options?: CampaignPathOptions): Promise<RcsCampaign>;
+    /** List campaigns with optional filters and pagination */
+    list(params?: RcsCampaignListParams, options?: CampaignPathOptions): Promise<PaginatedResponse<RcsCampaign>>;
+    /** Get a campaign by ID */
+    get(campaignId: string, options?: CampaignPathOptions): Promise<RcsCampaign>;
+    /** Update a scheduled campaign before it is sent */
+    update(campaignId: string, payload: RcsCampaignUpdatePayload, options?: CampaignPathOptions): Promise<RcsCampaign>;
+    /** Cancel a scheduled campaign before it is sent */
+    cancel(campaignId: string, options?: CampaignPathOptions): Promise<void>;
+}
+
+/**
+ * Main entry point of the `@smsmode/rcs`.
+ *
+ * Exposes RCS message methods directly on the instance, and namespaces the
+ * Campaign resource under `.campaigns`.
+ *
+ * @example
+ * ```ts
+ * const client = new SmsmodeRcsClient({ apiKey: 'your-api-key' });
+ * await client.send({ recipient: { to: '33612345678' }, body: { type: 'TEXT' } });
+ * await client.campaigns.list();
+ * ```
+ */
+declare class SmsmodeRcsClient {
+    private readonly messages;
+    readonly campaigns: CampaignsResource;
+    constructor(options: SmsmodeClientOptions);
+    /** Send a single RCS message or a batch (max 1000) */
+    send(payload: RcsSendPayload, options?: MessagePathOptions): Promise<RcsMessage>;
+    send(payload: RcsBatchSendPayload, options?: MessagePathOptions): Promise<RcsMessage[]>;
+    /** List messages with optional filters and pagination */
+    list(params?: RcsListParams, options?: MessagePathOptions): Promise<PaginatedResponse<RcsMessage>>;
+    /** Get a message by ID */
+    get(messageId: string, options?: MessagePathOptions): Promise<RcsMessage>;
+    /** Update a scheduled message before it is sent */
+    update(messageId: string, payload: RcsUpdatePayload, options?: MessagePathOptions): Promise<RcsMessage>;
+    /** Cancel a scheduled message before it is sent */
+    cancel(messageId: string, options?: MessagePathOptions): Promise<void>;
+}
+
+/** Base class for all SDK errors — enables a unified `instanceof RcsError` check. */
+declare class RcsError extends Error {
+    constructor(message: string);
+}
+/** Thrown when the response contains a structured smsmode error body. All fields are guaranteed. */
+declare class SmsModeApiError extends RcsError {
+    readonly httpStatus: number;
+    readonly title: string;
+    readonly detail: string;
+    readonly errorCode: string;
+    readonly docsUrl: string;
+    readonly details: unknown;
+    constructor(httpStatus: number, body: Record<string, unknown>);
+    toString(): string;
+}
+/** Thrown when no structured smsmode body is present (5xx, proxy errors, empty bodies). */
+declare class SmsModeHttpError extends RcsError {
+    readonly httpStatus: number;
+    readonly statusText: string;
+    constructor(httpStatus: number, statusText: string);
+    toString(): string;
+}
+/** Thrown on HTTP 401 — invalid or missing API key. */
+declare class AuthError extends SmsModeApiError {
+    constructor(httpStatus: number, body: Record<string, unknown>);
+}
+/** Thrown on HTTP 429 — rate limit exceeded. Check retryAfter for delay in seconds. */
+declare class RateLimitError extends SmsModeApiError {
+    readonly retryAfter?: number | undefined;
+    constructor(httpStatus: number, body: Record<string, unknown>, retryAfter?: number | undefined);
+}
+/** Thrown when a webhook payload fails local structural validation (not an HTTP error). */
+declare class ValidationError extends RcsError {
+    constructor(message: string);
+}
+
+/**
+ * Parse a raw webhook body (object or JSON string) into a typed RCS webhook payload.
+ * Performs a minimal structural check — downstream code should rely on the
+ * discriminated union (`direction`) via `isDeliveryReport` / `isIncomingMessage`.
+ *
+ * @throws {ValidationError} if the body is not a valid RCS webhook payload.
+ */
+declare function parseWebhookPayload(body: unknown): RcsWebhookPayload;
+/** Type guard — true when the payload is a Delivery Report (MT). */
+declare function isDeliveryReport(payload: RcsWebhookPayload): payload is RcsDeliveryReportPayload;
+/** Type guard — true when the payload is an Incoming Message (MO). */
+declare function isIncomingMessage(payload: RcsWebhookPayload): payload is RcsIncomingMessagePayload;
+
+export { AuthError, type CampaignPathOptions, type MessagePathOptions, type PaginatedResponse, RateLimitError, type RcsBasicBody, type RcsBatchSendPayload, type RcsBody, type RcsBodyType, type RcsCampaign, type RcsCampaignListParams, type RcsCampaignSendPayload, type RcsCampaignStatus, type RcsCampaignUpdatePayload, type RcsCardAlignment, type RcsCardBody, type RcsCardContent, type RcsCardMedia, type RcsCardOrientation, type RcsCardWidth, type RcsCarouselBody, type RcsChannel, type RcsCreateCalendarEventSuggestion, type RcsDeliveryReportPayload, type RcsDialPhoneSuggestion, type RcsDirection, RcsError, type RcsFileBody, type RcsIncomingMessagePayload, type RcsListParams, type RcsMediaHeight, type RcsMessage, type RcsOpenUrlSuggestion, type RcsPrice, type RcsRecipient, type RcsReplySuggestion, type RcsRequestLocationSuggestion, type RcsSendPayload, type RcsShowLocationSuggestion, type RcsSortOrder, type RcsStatus, type RcsStatusDetail, type RcsStatusValue, type RcsSuggestion, type RcsSuggestionBase, type RcsSuggestionType, type RcsTextBody, type RcsUpdatePayload, type RcsValidity, type RcsWebhookPayload, type RcsWebviewSize, SmsModeApiError, SmsModeHttpError, type SmsmodeClientOptions, SmsmodeRcsClient, ValidationError, isDeliveryReport, isIncomingMessage, parseWebhookPayload };