@sentdm/sentdm 0.39.0 → 0.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/client.d.mts +2 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -0
- package/client.d.ts.map +1 -1
- package/client.js +2 -0
- package/client.js.map +1 -1
- package/client.mjs +2 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/conversations.d.mts +126 -3
- package/resources/conversations.d.mts.map +1 -1
- package/resources/conversations.d.ts +126 -3
- package/resources/conversations.d.ts.map +1 -1
- package/resources/me.d.mts +21 -0
- package/resources/me.d.mts.map +1 -1
- package/resources/me.d.ts +21 -0
- package/resources/me.d.ts.map +1 -1
- package/resources/me.js +5 -0
- package/resources/me.js.map +1 -1
- package/resources/me.mjs +5 -0
- package/resources/me.mjs.map +1 -1
- package/resources/messages.d.mts +239 -14
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +239 -14
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +21 -3
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +21 -3
- package/resources/messages.mjs.map +1 -1
- package/resources/templates.d.mts +130 -1
- package/resources/templates.d.mts.map +1 -1
- package/resources/templates.d.ts +130 -1
- package/resources/templates.d.ts.map +1 -1
- package/resources/templates.js.map +1 -1
- package/resources/templates.mjs.map +1 -1
- package/resources/webhooks.d.mts +616 -30
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +616 -30
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +3 -1
- package/resources/webhooks.mjs.map +1 -1
- package/src/client.ts +2 -0
- package/src/resources/conversations.ts +140 -3
- package/src/resources/me.ts +22 -0
- package/src/resources/messages.ts +259 -14
- package/src/resources/templates.ts +143 -1
- package/src/resources/webhooks.ts +678 -31
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/messages.d.mts
CHANGED
|
@@ -8,11 +8,15 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
8
8
|
* One endpoint sends on any channel: pass `channel: "sent"` and we pick between SMS, WhatsApp and RCS per recipient using your routing rules, or name a channel to pin it. A send is accepted asynchronously — `POST /v3/messages` returns an id, and delivery is reported through `GET /v3/messages/{id}`, its activities, or a webhook.
|
|
9
9
|
*
|
|
10
10
|
* **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
|
|
11
|
+
*
|
|
12
|
+
* **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
|
|
11
13
|
*/
|
|
12
14
|
export declare class Messages extends APIResource {
|
|
13
15
|
/**
|
|
14
16
|
* Retrieves the activity log for a specific message. Activities track the message
|
|
15
|
-
* lifecycle including acceptance, processing, sending, delivery, and any errors.
|
|
17
|
+
* lifecycle including acceptance, processing, sending, delivery, and any errors. A
|
|
18
|
+
* SCHEDULED entry carries scheduled_at, the release instant in UTC as it stood at
|
|
19
|
+
* that moment. Other entries have no scheduled_at key.
|
|
16
20
|
*
|
|
17
21
|
* @example
|
|
18
22
|
* ```ts
|
|
@@ -24,7 +28,11 @@ export declare class Messages extends APIResource {
|
|
|
24
28
|
retrieveActivities(id: string, params?: MessageRetrieveActivitiesParams | null | undefined, options?: RequestOptions): APIPromise<MessageRetrieveActivitiesResponse>;
|
|
25
29
|
/**
|
|
26
30
|
* Retrieves the current status and details of a message by ID. Includes delivery
|
|
27
|
-
* status, timestamps, and error information if applicable.
|
|
31
|
+
* status, timestamps, and error information if applicable. A message that is or
|
|
32
|
+
* was held for a later time (a send you scheduled with scheduled_at, or a
|
|
33
|
+
* quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
|
|
34
|
+
* plus scheduled_at, the release instant in UTC. A message sent immediately has no
|
|
35
|
+
* scheduled_at key.
|
|
28
36
|
*
|
|
29
37
|
* @example
|
|
30
38
|
* ```ts
|
|
@@ -44,7 +52,17 @@ export declare class Messages extends APIResource {
|
|
|
44
52
|
* insufficient balance, a template not approved for sending, or free-form content
|
|
45
53
|
* with no open conversation with the contact. The send is accepted with 202 and
|
|
46
54
|
* the affected messages are reported as BLOCKED on GET /messages/{id} and the
|
|
47
|
-
* message.blocked webhook.
|
|
55
|
+
* message.blocked webhook. To send later, set scheduled_at (ISO-8601 with an
|
|
56
|
+
* explicit UTC offset; a value without one is rejected) between 1 minute and 30
|
|
57
|
+
* days ahead: the response is a ScheduledSendMessageResponse (the same fields plus
|
|
58
|
+
* scheduled_at; status is still QUEUED), each message then moves to SCHEDULED, is
|
|
59
|
+
* held and released at that time (within a few minutes), and a message.scheduled
|
|
60
|
+
* webhook fires once it is held. Balance and template approval are evaluated at
|
|
61
|
+
* release, not at acceptance. Quiet hours are not checked when the request is
|
|
62
|
+
* accepted: if the time falls inside a legally protected quiet-hours window for a
|
|
63
|
+
* recipient, that message is moved to the next allowed time at release and a
|
|
64
|
+
* second message.scheduled webhook reports the new scheduled_at. An account may
|
|
65
|
+
* hold at most 1,000,000 scheduled messages at once (429 LIMIT_001).
|
|
48
66
|
*
|
|
49
67
|
* @example
|
|
50
68
|
* ```ts
|
|
@@ -94,7 +112,11 @@ export declare namespace MessageRetrieveActivitiesResponse {
|
|
|
94
112
|
}
|
|
95
113
|
namespace Data {
|
|
96
114
|
/**
|
|
97
|
-
* A single message activity event for v3 API
|
|
115
|
+
* A single message activity event for v3 API.
|
|
116
|
+
*
|
|
117
|
+
* The activity list mixes statuses, so unlike a message it is one shape rather
|
|
118
|
+
* than two: a SCHEDULED entry carries scheduled_at, and every other entry has no
|
|
119
|
+
* such key.
|
|
98
120
|
*/
|
|
99
121
|
interface Activity {
|
|
100
122
|
/**
|
|
@@ -118,8 +140,28 @@ export declare namespace MessageRetrieveActivitiesResponse {
|
|
|
118
140
|
*/
|
|
119
141
|
price?: string | null;
|
|
120
142
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
143
|
+
* A human-readable sentence for reason_code, for example "The recipient is not
|
|
144
|
+
* registered on this channel" Omitted whenever reason_code is.
|
|
145
|
+
*/
|
|
146
|
+
reason?: string | null;
|
|
147
|
+
/**
|
|
148
|
+
* Why the message reached this status, as a stable platform code such as
|
|
149
|
+
* DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
|
|
150
|
+
* activities; omitted on every status that needs no explanation. Switch on this
|
|
151
|
+
* rather than on reason: the code is stable, the wording may be improved. Same
|
|
152
|
+
* wire name and vocabulary as on the message and the webhook.
|
|
153
|
+
*/
|
|
154
|
+
reason_code?: string | null;
|
|
155
|
+
/**
|
|
156
|
+
* SCHEDULED activities only: when the held message will be released for delivery,
|
|
157
|
+
* in UTC. Same wire name as on the send response, the message and the webhook.
|
|
158
|
+
* Omitted on every other activity. A message that quiet hours moved at release has
|
|
159
|
+
* two SCHEDULED entries, each carrying the instant as it stood at that moment.
|
|
160
|
+
*/
|
|
161
|
+
scheduled_at?: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
|
|
164
|
+
* DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
|
|
123
165
|
*/
|
|
124
166
|
status?: string;
|
|
125
167
|
/**
|
|
@@ -134,7 +176,12 @@ export declare namespace MessageRetrieveActivitiesResponse {
|
|
|
134
176
|
*/
|
|
135
177
|
export interface MessageRetrieveStatusResponse {
|
|
136
178
|
/**
|
|
137
|
-
* Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
179
|
+
* Message response for v3 API — same shape as v2 with snake_case JSON conventions.
|
|
180
|
+
*
|
|
181
|
+
* The shape of a message that was sent immediately: it never has a scheduled_at
|
|
182
|
+
* key. A message that is or was held for a later instant is a
|
|
183
|
+
* ScheduledMessageResponse, and the endpoint decides which of the two to answer
|
|
184
|
+
* with. From always returns this type.
|
|
138
185
|
*/
|
|
139
186
|
data?: MessageRetrieveStatusResponse.Data | null;
|
|
140
187
|
/**
|
|
@@ -152,7 +199,12 @@ export interface MessageRetrieveStatusResponse {
|
|
|
152
199
|
}
|
|
153
200
|
export declare namespace MessageRetrieveStatusResponse {
|
|
154
201
|
/**
|
|
155
|
-
* Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
202
|
+
* Message response for v3 API — same shape as v2 with snake_case JSON conventions.
|
|
203
|
+
*
|
|
204
|
+
* The shape of a message that was sent immediately: it never has a scheduled_at
|
|
205
|
+
* key. A message that is or was held for a later instant is a
|
|
206
|
+
* ScheduledMessageResponse, and the endpoint decides which of the two to answer
|
|
207
|
+
* with. From always returns this type.
|
|
156
208
|
*/
|
|
157
209
|
interface Data {
|
|
158
210
|
id?: string;
|
|
@@ -165,12 +217,33 @@ export declare namespace MessageRetrieveStatusResponse {
|
|
|
165
217
|
events?: Array<Data.Event> | null;
|
|
166
218
|
/**
|
|
167
219
|
* Structured message body format for database storage. Preserves channel-specific
|
|
168
|
-
* components (header, body, footer, buttons).
|
|
220
|
+
* components (header, header media, body, footer, buttons, MMS subject and media).
|
|
221
|
+
*
|
|
222
|
+
* Persisted as the messageBody jsonb column on Messages. Every write path goes
|
|
223
|
+
* through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
|
|
224
|
+
* shape is stable regardless of channel or status. Anything that rebuilds this
|
|
225
|
+
* object field by field — the four IMessageBodyStrategy implementations and
|
|
226
|
+
* MessageUtils.BuildSegmentBody — has to carry every member, or that member is
|
|
227
|
+
* silently dropped on whichever path forgot it.
|
|
169
228
|
*/
|
|
170
229
|
message_body?: Data.MessageBody | null;
|
|
171
230
|
phone?: string;
|
|
172
231
|
phone_international?: string;
|
|
173
232
|
price?: number | null;
|
|
233
|
+
/**
|
|
234
|
+
* A human-readable sentence for reason_code, for example "Insufficient balance".
|
|
235
|
+
* Omitted whenever reason_code is.
|
|
236
|
+
*/
|
|
237
|
+
reason?: string | null;
|
|
238
|
+
/**
|
|
239
|
+
* Why the message is at its current status, as a stable platform code such as
|
|
240
|
+
* DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
|
|
241
|
+
* FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
|
|
242
|
+
* Switch on this rather than on reason: the code is stable, the wording may be
|
|
243
|
+
* improved. It is the platform's classification of the outcome, never a carrier or
|
|
244
|
+
* vendor code.
|
|
245
|
+
*/
|
|
246
|
+
reason_code?: string | null;
|
|
174
247
|
region_code?: string;
|
|
175
248
|
status?: string;
|
|
176
249
|
template_category?: string | null;
|
|
@@ -185,16 +258,52 @@ export declare namespace MessageRetrieveStatusResponse {
|
|
|
185
258
|
status: string;
|
|
186
259
|
timestamp: string;
|
|
187
260
|
description?: string | null;
|
|
261
|
+
/**
|
|
262
|
+
* A human-readable sentence for reason_code. Omitted whenever reason_code is.
|
|
263
|
+
*/
|
|
264
|
+
reason?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* Why the message reached this status, as a stable platform code such as
|
|
267
|
+
* DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
|
|
268
|
+
* status that needs no explanation. Same wire name and vocabulary as on the
|
|
269
|
+
* activities list and the webhook.
|
|
270
|
+
*/
|
|
271
|
+
reason_code?: string | null;
|
|
188
272
|
}
|
|
189
273
|
/**
|
|
190
274
|
* Structured message body format for database storage. Preserves channel-specific
|
|
191
|
-
* components (header, body, footer, buttons).
|
|
275
|
+
* components (header, header media, body, footer, buttons, MMS subject and media).
|
|
276
|
+
*
|
|
277
|
+
* Persisted as the messageBody jsonb column on Messages. Every write path goes
|
|
278
|
+
* through MessageUtils.MessageBodyJsonOptions, which writes nulls, so the envelope
|
|
279
|
+
* shape is stable regardless of channel or status. Anything that rebuilds this
|
|
280
|
+
* object field by field — the four IMessageBodyStrategy implementations and
|
|
281
|
+
* MessageUtils.BuildSegmentBody — has to carry every member, or that member is
|
|
282
|
+
* silently dropped on whichever path forgot it.
|
|
192
283
|
*/
|
|
193
284
|
interface MessageBody {
|
|
194
285
|
buttons?: Array<MessageBody.Button> | null;
|
|
195
286
|
content?: string;
|
|
196
287
|
footer?: string | null;
|
|
197
288
|
header?: string | null;
|
|
289
|
+
/**
|
|
290
|
+
* The media asset that rode a message's header, recorded as sent.
|
|
291
|
+
*/
|
|
292
|
+
headerMedia?: MessageBody.HeaderMedia | null;
|
|
293
|
+
/**
|
|
294
|
+
* MMS attachments, as the publicly fetchable URLs handed to the carrier. Null on
|
|
295
|
+
* every other channel.
|
|
296
|
+
*
|
|
297
|
+
* Persisted rather than derived because a resend and a curfew release rebuild the
|
|
298
|
+
* send from the stored row — MessageReplayCommandBuilder reads templateId and
|
|
299
|
+
* templateVariables and nothing else — so media that lives only on the original
|
|
300
|
+
* request would silently turn a replayed MMS into a text message.
|
|
301
|
+
*/
|
|
302
|
+
media?: Array<MessageBody.Media> | null;
|
|
303
|
+
/**
|
|
304
|
+
* MMS subject line. Null on every other channel.
|
|
305
|
+
*/
|
|
306
|
+
subject?: string | null;
|
|
198
307
|
}
|
|
199
308
|
namespace MessageBody {
|
|
200
309
|
interface Button {
|
|
@@ -203,6 +312,67 @@ export declare namespace MessageRetrieveStatusResponse {
|
|
|
203
312
|
type?: string;
|
|
204
313
|
value?: string;
|
|
205
314
|
}
|
|
315
|
+
/**
|
|
316
|
+
* The media asset that rode a message's header, recorded as sent.
|
|
317
|
+
*/
|
|
318
|
+
interface HeaderMedia {
|
|
319
|
+
/**
|
|
320
|
+
* "image", "video" or "document" — taken from the header's media variable.
|
|
321
|
+
*/
|
|
322
|
+
type?: string;
|
|
323
|
+
/**
|
|
324
|
+
* The https URL the caller supplied for this send. Never the template's stored
|
|
325
|
+
* props.sample, which is Meta's expiring header_handle rather than what was
|
|
326
|
+
* delivered.
|
|
327
|
+
*/
|
|
328
|
+
url?: string;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* One attachment on a message, in either direction — and in both, a URL somebody
|
|
332
|
+
* else hosts.
|
|
333
|
+
*
|
|
334
|
+
* Outbound: the customer supplied a public URL and we handed it to the carrier.
|
|
335
|
+
* Inbound: the carrier hosts the file and we record where. sent.dm never holds the
|
|
336
|
+
* bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
|
|
337
|
+
* what is stored is what is served.
|
|
338
|
+
*
|
|
339
|
+
* An inbound link expires on the carrier's own schedule and is unauthenticated.
|
|
340
|
+
* That is the customer's to manage, and it is documented where they will see it
|
|
341
|
+
* rather than only here — a recipient who needs an attachment to outlive that
|
|
342
|
+
* window copies it on receipt.
|
|
343
|
+
*
|
|
344
|
+
* Storing a presigned URL is the specific mistake this shape still avoids:
|
|
345
|
+
* M260826130000 and M260826140000 exist because RCS assets were stored as signed
|
|
346
|
+
* URLs and went stale. Nothing here is signed.
|
|
347
|
+
*/
|
|
348
|
+
interface Media {
|
|
349
|
+
/**
|
|
350
|
+
* One of MmsMediaTypes when the content type is known. Advisory — a reader should
|
|
351
|
+
* trust the fetched object's own Content-Type.
|
|
352
|
+
*/
|
|
353
|
+
mediaType?: string | null;
|
|
354
|
+
/**
|
|
355
|
+
* Content type as the provider declared it. Null when it declared none.
|
|
356
|
+
*/
|
|
357
|
+
mimeType?: string | null;
|
|
358
|
+
/**
|
|
359
|
+
* Size as the provider declared it. Never measured here — nothing downloads the
|
|
360
|
+
* file.
|
|
361
|
+
*/
|
|
362
|
+
sizeBytes?: number | null;
|
|
363
|
+
/**
|
|
364
|
+
* Inbound only: the SHA-256 the provider declared alongside the attachment, when
|
|
365
|
+
* it declared one. Relayed to the customer so they can verify what they fetch
|
|
366
|
+
* matches what the carrier said it sent. It is the only integrity signal available
|
|
367
|
+
* on an attachment nobody here has read.
|
|
368
|
+
*/
|
|
369
|
+
sourceHashSha256?: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* Where the file lives. Outbound: the URL the customer gave us and the carrier
|
|
372
|
+
* fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
|
|
373
|
+
*/
|
|
374
|
+
url?: string | null;
|
|
375
|
+
}
|
|
206
376
|
}
|
|
207
377
|
}
|
|
208
378
|
}
|
|
@@ -220,7 +390,9 @@ export interface MessageSendResponse {
|
|
|
220
390
|
* its result; this is what a caller sees, and the mapping between them is a
|
|
221
391
|
* decision the endpoint makes.
|
|
222
392
|
*
|
|
223
|
-
* The
|
|
393
|
+
* The shape of an immediate send: it never has a scheduled_at key. A send that
|
|
394
|
+
* carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
|
|
395
|
+
* which of the two to answer with. From always returns this type.
|
|
224
396
|
*/
|
|
225
397
|
data?: MessageSendResponse.Data | null;
|
|
226
398
|
/**
|
|
@@ -247,12 +419,16 @@ export declare namespace MessageSendResponse {
|
|
|
247
419
|
* its result; this is what a caller sees, and the mapping between them is a
|
|
248
420
|
* decision the endpoint makes.
|
|
249
421
|
*
|
|
250
|
-
* The
|
|
422
|
+
* The shape of an immediate send: it never has a scheduled_at key. A send that
|
|
423
|
+
* carried scheduled_at is a ScheduledSendMessageResponse, and the endpoint decides
|
|
424
|
+
* which of the two to answer with. From always returns this type.
|
|
251
425
|
*/
|
|
252
426
|
interface Data {
|
|
253
427
|
recipients?: Array<Data.Recipient>;
|
|
254
428
|
/**
|
|
255
|
-
*
|
|
429
|
+
* QUEUED: the batch is accepted. A request that carried scheduled_at is QUEUED
|
|
430
|
+
* here too; each message moves to SCHEDULED once it is held, as GET
|
|
431
|
+
* /v3/messages/{id} and the message.scheduled webhook report.
|
|
256
432
|
*/
|
|
257
433
|
status?: string;
|
|
258
434
|
template_id?: string;
|
|
@@ -304,11 +480,47 @@ export interface MessageSendParams {
|
|
|
304
480
|
* ["sent"] (auto-detect) if omitted.
|
|
305
481
|
*/
|
|
306
482
|
channel?: Array<string> | null;
|
|
483
|
+
/**
|
|
484
|
+
* Body param: Attachments for this send, as publicly fetchable https URLs. Used by
|
|
485
|
+
* the MMS channel and ignored by every other one.
|
|
486
|
+
*
|
|
487
|
+
* Supplying these replaces the media on the template's mms body rather than adding
|
|
488
|
+
* to it, so a template can hold a default creative while a caller still sends
|
|
489
|
+
* something recipient-specific.
|
|
490
|
+
*
|
|
491
|
+
* Their presence is also what makes a message eligible for MMS on an auto-detect
|
|
492
|
+
* send: a message with nothing attached is delivered as SMS, because an MMS with
|
|
493
|
+
* no media is a more expensive text message.
|
|
494
|
+
*
|
|
495
|
+
* The recipient's carrier fetches each URL after the send is accepted, so it must
|
|
496
|
+
* stay publicly reachable — a link that expires, or one behind auth, arrives as a
|
|
497
|
+
* failed message.
|
|
498
|
+
*/
|
|
499
|
+
media_urls?: Array<string> | null;
|
|
307
500
|
/**
|
|
308
501
|
* Body param: Sandbox flag - when true, the operation is simulated without side
|
|
309
502
|
* effects Useful for testing integrations without actual execution
|
|
310
503
|
*/
|
|
311
504
|
sandbox?: boolean;
|
|
505
|
+
/**
|
|
506
|
+
* Body param: Optional future send time as an ISO-8601 timestamp with an explicit
|
|
507
|
+
* UTC offset, e.g. 2026-10-01T09:00:00+02:00 or 2026-10-01T07:00:00Z. A value
|
|
508
|
+
* without an offset is rejected (400) rather than read in the server's zone. The
|
|
509
|
+
* offset only fixes the instant: it is stored and echoed in UTC as scheduled_at.
|
|
510
|
+
* Omit to send now. Must be at least one minute ahead and at most 30 days ahead.
|
|
511
|
+
* Accepted messages report SCHEDULED and are released for delivery at this time.
|
|
512
|
+
* Quiet hours, balance and template approval are evaluated at release, not at
|
|
513
|
+
* acceptance: a message whose time falls inside a recipient's protected
|
|
514
|
+
* quiet-hours window is moved to the next allowed time and a second
|
|
515
|
+
* message.scheduled webhook reports the new scheduled_at.
|
|
516
|
+
*/
|
|
517
|
+
scheduled_at?: string | null;
|
|
518
|
+
/**
|
|
519
|
+
* Body param: Subject line for this send, overriding the template's. MMS only;
|
|
520
|
+
* ignored on every other channel. Most handsets render it above the body, some
|
|
521
|
+
* ignore it entirely.
|
|
522
|
+
*/
|
|
523
|
+
subject?: string | null;
|
|
312
524
|
/**
|
|
313
525
|
* Body param: SDK-style template reference: resolve by ID or by name, with
|
|
314
526
|
* optional parameters.
|
|
@@ -352,7 +564,20 @@ export declare namespace MessageSendParams {
|
|
|
352
564
|
*/
|
|
353
565
|
name?: string | null;
|
|
354
566
|
/**
|
|
355
|
-
* Template variable parameters for personalization
|
|
567
|
+
* Template variable parameters for personalization, keyed by variable name.
|
|
568
|
+
*
|
|
569
|
+
* Every variable the template declares is required; GET /v3/templates/{id} lists
|
|
570
|
+
* them. Supplying a key the template does not declare is ignored.
|
|
571
|
+
*
|
|
572
|
+
* Media headers. A template whose header is an image (designed in WhatsApp Manager
|
|
573
|
+
* and imported into Sent) declares a reserved header_image key. Its value is a
|
|
574
|
+
* publicly reachable https URL that Meta fetches at send time — Sent does not host
|
|
575
|
+
* the asset, and the sample approved with the template is not reused. The key is
|
|
576
|
+
* derived from the header's media type, so header_video and header_document follow
|
|
577
|
+
* the same shape when those formats ship.
|
|
578
|
+
*
|
|
579
|
+
* "parameters": { "header_image": "https://cdn.example.com/banner.jpg", "name":
|
|
580
|
+
* "John Doe" }
|
|
356
581
|
*/
|
|
357
582
|
parameters?: {
|
|
358
583
|
[key: string]: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D
|
|
1
|
+
{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;;;;;;;GAQG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAWhD;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAW5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAc3F;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,CAAC,EAAE,iCAAiC,CAAC,IAAI,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAElC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACzC;IAED,UAAiB,IAAI,CAAC;QACpB;;;;;;WAMG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErC;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;;;eAIG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;;;;;eAMG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;;;;eAKG;YACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE7B;;;eAGG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,6BAA6B,CAAC,IAAI,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;;;;;;OAOG;IACH,UAAiB,IAAI;QACnB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAElC;;;;;;;;;;WAUG;QACH,YAAY,CAAC,EAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAEvC,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAE7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,KAAK;YACpB,MAAM,EAAE,MAAM,CAAC;YAEf,SAAS,EAAE,MAAM,CAAC;YAElB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;;;;eAKG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;QAED;;;;;;;;;;WAUG;QACH,UAAiB,WAAW;YAC1B,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAE3C,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEvB;;eAEG;YACH,WAAW,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;YAE7C;;;;;;;;eAQG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;YAExC;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACzB;QAED,UAAiB,WAAW,CAAC;YAC3B,UAAiB,MAAM;gBACrB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErB,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED;;eAEG;YACH,UAAiB,WAAW;gBAC1B;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;gBAEd;;;;mBAIG;gBACH,GAAG,CAAC,EAAE,MAAM,CAAC;aACd;YAED;;;;;;;;;;;;;;;;;eAiBG;YACH,UAAiB,KAAK;gBACpB;;;mBAGG;gBACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB;;;mBAGG;gBACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;;;;mBAKG;gBACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEjC;;;mBAGG;gBACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACrB;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,UAAiB,IAAI;QACnB,UAAU,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnC;;;;WAIG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,SAAS;YACxB;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;;;;;;;;;;;;;WAeG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;KAC/C;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|