@wats/graph 0.3.1 → 0.3.3

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.
Files changed (86) hide show
  1. package/dist/client.d.ts +2 -2
  2. package/dist/client.js +3 -3
  3. package/dist/createFetchTransport.d.ts +1 -1
  4. package/dist/createFetchTransport.js +1 -1
  5. package/dist/createMockTransport.d.ts +1 -1
  6. package/dist/endpoint.d.ts +1 -1
  7. package/dist/endpoint.js +1 -1
  8. package/dist/endpoints/businessManagement.d.ts +153 -9
  9. package/dist/endpoints/businessManagement.js +279 -7
  10. package/dist/endpoints/calling.d.ts +7 -7
  11. package/dist/endpoints/calling.js +2 -2
  12. package/dist/endpoints/flows/callables.d.ts +10 -10
  13. package/dist/endpoints/flows/callables.js +2 -2
  14. package/dist/endpoints/flows/dataExchange.d.ts +1 -1
  15. package/dist/endpoints/flows/dataExchange.js +2 -2
  16. package/dist/endpoints/flows/flowJson.d.ts +1 -1
  17. package/dist/endpoints/flows/flowJson.js +1 -1
  18. package/dist/endpoints/flows/index.d.ts +6 -6
  19. package/dist/endpoints/flows/index.js +4 -4
  20. package/dist/endpoints/flows/shared.d.ts +1 -1
  21. package/dist/endpoints/flows/shared.js +1 -1
  22. package/dist/endpoints/flows/types.d.ts +1 -1
  23. package/dist/endpoints/flows.d.ts +2 -2
  24. package/dist/endpoints/flows.js +1 -1
  25. package/dist/endpoints/media.d.ts +1 -1
  26. package/dist/endpoints/media.js +1 -1
  27. package/dist/endpoints/messages/builders-basic.d.ts +11 -0
  28. package/dist/endpoints/messages/builders-basic.js +272 -0
  29. package/dist/endpoints/messages/builders-interactive.d.ts +11 -0
  30. package/dist/endpoints/messages/builders-interactive.js +156 -0
  31. package/dist/endpoints/messages/builders-template.d.ts +3 -0
  32. package/dist/endpoints/messages/builders-template.js +121 -0
  33. package/dist/endpoints/messages/callables.d.ts +31 -0
  34. package/dist/endpoints/messages/callables.js +57 -0
  35. package/dist/endpoints/messages/index.d.ts +6 -0
  36. package/dist/endpoints/messages/index.js +56 -0
  37. package/dist/endpoints/messages/types.d.ts +363 -0
  38. package/dist/endpoints/messages/types.js +0 -0
  39. package/dist/endpoints/messages/validation.d.ts +43 -0
  40. package/dist/endpoints/messages/validation.js +277 -0
  41. package/dist/endpoints/messages.d.ts +1 -375
  42. package/dist/endpoints/messages.js +1 -675
  43. package/dist/endpoints/templates/builders.d.ts +1 -1
  44. package/dist/endpoints/templates/builders.js +24 -1
  45. package/dist/endpoints/templates/callables.d.ts +7 -6
  46. package/dist/endpoints/templates/callables.js +7 -5
  47. package/dist/endpoints/templates/groups.d.ts +126 -0
  48. package/dist/endpoints/templates/groups.js +156 -0
  49. package/dist/endpoints/templates/index.d.ts +7 -5
  50. package/dist/endpoints/templates/index.js +11 -3
  51. package/dist/endpoints/templates/shared.d.ts +2 -2
  52. package/dist/endpoints/templates/shared.js +1 -1
  53. package/dist/endpoints/templates/types.d.ts +15 -2
  54. package/dist/endpoints/templates/validation.d.ts +1 -1
  55. package/dist/endpoints/templates/validation.js +2 -2
  56. package/dist/endpoints/templates.d.ts +2 -2
  57. package/dist/endpoints/templates.js +7 -1
  58. package/dist/endpoints/waba/index.d.ts +4 -4
  59. package/dist/endpoints/waba/index.js +1 -1
  60. package/dist/endpoints/waba/phoneNumbers.d.ts +6 -4
  61. package/dist/endpoints/waba/phoneNumbers.js +3 -3
  62. package/dist/endpoints/wabaEndpoints.d.ts +6 -6
  63. package/dist/endpoints/wabaEndpoints.js +9 -3
  64. package/dist/errorRegistry.d.ts +1 -1
  65. package/dist/errorSubclasses.d.ts +30 -2
  66. package/dist/errorSubclasses.js +65 -2
  67. package/dist/errors.js +1 -1
  68. package/dist/index.d.ts +20 -20
  69. package/dist/index.js +15 -15
  70. package/dist/internal/validation/arrays.js +2 -2
  71. package/dist/internal/validation/errors.d.ts +1 -1
  72. package/dist/internal/validation/errors.js +1 -1
  73. package/dist/internal/validation/headers.js +3 -3
  74. package/dist/internal/validation/index.d.ts +8 -8
  75. package/dist/internal/validation/index.js +8 -8
  76. package/dist/internal/validation/json.js +4 -4
  77. package/dist/internal/validation/options.js +2 -2
  78. package/dist/internal/validation/paths.js +2 -2
  79. package/dist/internal/validation/records.js +2 -2
  80. package/dist/internal/validation/strings.js +1 -1
  81. package/dist/pagination.d.ts +2 -2
  82. package/dist/subclients/phoneNumberClient.d.ts +21 -5
  83. package/dist/subclients/phoneNumberClient.js +78 -7
  84. package/dist/subclients/wabaClient.d.ts +19 -5
  85. package/dist/subclients/wabaClient.js +39 -6
  86. package/package.json +10 -1
@@ -1,375 +1 @@
1
- import type { GraphRequestOptions } from "../client";
2
- interface GraphRequestExecutor {
3
- request<TResponse>(options: GraphRequestOptions): Promise<TResponse>;
4
- }
5
- export interface GraphMessagesSendMessageInput {
6
- phoneNumberId: string;
7
- to: string;
8
- text: string;
9
- previewUrl?: boolean;
10
- }
11
- export interface GraphMessagesSendTextInput {
12
- readonly to: string;
13
- readonly text: string;
14
- readonly previewUrl?: boolean;
15
- readonly replyToMessageId?: string;
16
- }
17
- export interface GraphMessagesSendMediaInput {
18
- readonly to: string;
19
- readonly mediaId?: string;
20
- readonly link?: string;
21
- readonly replyToMessageId?: string;
22
- }
23
- export interface GraphMessagesSendCaptionedMediaInput extends GraphMessagesSendMediaInput {
24
- readonly caption?: string;
25
- }
26
- export interface GraphMessagesSendDocumentInput extends GraphMessagesSendCaptionedMediaInput {
27
- readonly filename?: string;
28
- }
29
- export type GraphMessagesSendImageInput = GraphMessagesSendCaptionedMediaInput;
30
- export type GraphMessagesSendVideoInput = GraphMessagesSendCaptionedMediaInput;
31
- export type GraphMessagesSendAudioInput = GraphMessagesSendMediaInput;
32
- export type GraphMessagesSendStickerInput = GraphMessagesSendMediaInput;
33
- export interface GraphMessagesSendLocationInput {
34
- readonly to: string;
35
- readonly latitude: number;
36
- readonly longitude: number;
37
- readonly name?: string;
38
- readonly address?: string;
39
- readonly replyToMessageId?: string;
40
- }
41
- export interface GraphMessagesContactNameInput {
42
- readonly formattedName?: string;
43
- readonly firstName?: string;
44
- readonly lastName?: string;
45
- readonly middleName?: string;
46
- readonly suffix?: string;
47
- readonly prefix?: string;
48
- }
49
- export interface GraphMessagesContactPhoneInput {
50
- readonly phone?: string;
51
- readonly type?: string;
52
- readonly waId?: string;
53
- }
54
- export interface GraphMessagesContactEmailInput {
55
- readonly email: string;
56
- readonly type?: string;
57
- }
58
- export interface GraphMessagesContactUrlInput {
59
- readonly url: string;
60
- readonly type?: string;
61
- }
62
- export interface GraphMessagesContactAddressInput {
63
- readonly street?: string;
64
- readonly city?: string;
65
- readonly state?: string;
66
- readonly zip?: string;
67
- readonly country?: string;
68
- readonly countryCode?: string;
69
- readonly type?: string;
70
- }
71
- export interface GraphMessagesContactOrgInput {
72
- readonly company?: string;
73
- readonly department?: string;
74
- readonly title?: string;
75
- }
76
- export interface GraphMessagesContactInput {
77
- readonly name: GraphMessagesContactNameInput;
78
- readonly phones?: readonly GraphMessagesContactPhoneInput[];
79
- readonly emails?: readonly GraphMessagesContactEmailInput[];
80
- readonly urls?: readonly GraphMessagesContactUrlInput[];
81
- readonly addresses?: readonly GraphMessagesContactAddressInput[];
82
- readonly org?: GraphMessagesContactOrgInput;
83
- readonly birthday?: string;
84
- }
85
- export interface GraphMessagesSendContactsInput {
86
- readonly to: string;
87
- readonly contacts: readonly GraphMessagesContactInput[];
88
- readonly replyToMessageId?: string;
89
- }
90
- export interface GraphMessagesSendReactionInput {
91
- readonly to: string;
92
- readonly messageId: string;
93
- readonly emoji: string;
94
- }
95
- export interface GraphMessagesRemoveReactionInput {
96
- readonly to: string;
97
- readonly messageId: string;
98
- }
99
- export interface GraphMessagesSendButtonsInput {
100
- readonly to: string;
101
- readonly bodyText: string;
102
- readonly buttons: readonly {
103
- readonly id: string;
104
- readonly title: string;
105
- }[];
106
- readonly headerText?: string;
107
- readonly footerText?: string;
108
- readonly replyToMessageId?: string;
109
- }
110
- export interface GraphMessagesSendListInput {
111
- readonly to: string;
112
- readonly bodyText: string;
113
- readonly buttonText: string;
114
- readonly sections: readonly {
115
- readonly title?: string;
116
- readonly rows: readonly {
117
- readonly id: string;
118
- readonly title: string;
119
- readonly description?: string;
120
- }[];
121
- }[];
122
- readonly headerText?: string;
123
- readonly footerText?: string;
124
- readonly replyToMessageId?: string;
125
- }
126
- export interface GraphMessagesSendCtaUrlInput {
127
- readonly to: string;
128
- readonly bodyText: string;
129
- readonly displayText: string;
130
- readonly url: string;
131
- readonly footerText?: string;
132
- readonly replyToMessageId?: string;
133
- }
134
- export interface GraphMessagesSendProductInput {
135
- readonly to: string;
136
- readonly catalogId: string;
137
- readonly productRetailerId: string;
138
- readonly bodyText?: string;
139
- readonly footerText?: string;
140
- readonly replyToMessageId?: string;
141
- }
142
- export interface GraphMessagesSendProductsInput {
143
- readonly to: string;
144
- readonly catalogId: string;
145
- readonly headerText: string;
146
- readonly bodyText: string;
147
- readonly sections: readonly {
148
- readonly title: string;
149
- readonly productItems: readonly {
150
- readonly productRetailerId: string;
151
- }[];
152
- }[];
153
- readonly footerText?: string;
154
- readonly replyToMessageId?: string;
155
- }
156
- export interface GraphMessagesSendCatalogInput {
157
- readonly to: string;
158
- readonly bodyText: string;
159
- readonly footerText?: string;
160
- readonly thumbnailProductRetailerId?: string;
161
- readonly replyToMessageId?: string;
162
- }
163
- export interface GraphMessagesRequestLocationInput {
164
- readonly to: string;
165
- readonly bodyText: string;
166
- readonly replyToMessageId?: string;
167
- }
168
- export interface GraphMessagesMarkMessageAsReadInput {
169
- readonly messageId: string;
170
- }
171
- export type GraphMessagesTypingIndicatorInput = GraphMessagesMarkMessageAsReadInput;
172
- export interface GraphMessagesTemplateComponentInput {
173
- readonly type: string;
174
- readonly parameters?: readonly Record<string, unknown>[];
175
- readonly subType?: string;
176
- readonly index?: string;
177
- }
178
- export interface GraphMessagesSendTemplateInput {
179
- readonly to: string;
180
- readonly name: string;
181
- readonly languageCode: string;
182
- readonly components?: readonly GraphMessagesTemplateComponentInput[];
183
- readonly replyToMessageId?: string;
184
- }
185
- export interface GraphMessagesSendResponse {
186
- messaging_product?: string;
187
- contacts?: Array<{
188
- input?: string;
189
- wa_id?: string;
190
- }>;
191
- messages?: Array<{
192
- id: string;
193
- }>;
194
- }
195
- export interface GraphMessagesTextPayload {
196
- messaging_product: "whatsapp";
197
- to: string;
198
- type: "text";
199
- text: {
200
- body: string;
201
- preview_url?: boolean;
202
- };
203
- context?: {
204
- message_id: string;
205
- };
206
- }
207
- export type GraphMessagesMediaType = "image" | "video" | "audio" | "document" | "sticker";
208
- interface GraphMessagesMediaReferencePayload {
209
- id?: string;
210
- link?: string;
211
- caption?: string;
212
- filename?: string;
213
- }
214
- export type GraphMessagesImagePayload = {
215
- messaging_product: "whatsapp";
216
- to: string;
217
- type: "image";
218
- image: GraphMessagesMediaReferencePayload;
219
- context?: {
220
- message_id: string;
221
- };
222
- };
223
- export type GraphMessagesVideoPayload = {
224
- messaging_product: "whatsapp";
225
- to: string;
226
- type: "video";
227
- video: GraphMessagesMediaReferencePayload;
228
- context?: {
229
- message_id: string;
230
- };
231
- };
232
- export type GraphMessagesAudioPayload = {
233
- messaging_product: "whatsapp";
234
- to: string;
235
- type: "audio";
236
- audio: GraphMessagesMediaReferencePayload;
237
- context?: {
238
- message_id: string;
239
- };
240
- };
241
- export type GraphMessagesDocumentPayload = {
242
- messaging_product: "whatsapp";
243
- to: string;
244
- type: "document";
245
- document: GraphMessagesMediaReferencePayload;
246
- context?: {
247
- message_id: string;
248
- };
249
- };
250
- export type GraphMessagesStickerPayload = {
251
- messaging_product: "whatsapp";
252
- to: string;
253
- type: "sticker";
254
- sticker: GraphMessagesMediaReferencePayload;
255
- context?: {
256
- message_id: string;
257
- };
258
- };
259
- export type GraphMessagesMediaPayload = GraphMessagesImagePayload | GraphMessagesVideoPayload | GraphMessagesAudioPayload | GraphMessagesDocumentPayload | GraphMessagesStickerPayload;
260
- export type GraphMessagesLocationPayload = {
261
- messaging_product: "whatsapp";
262
- to: string;
263
- type: "location";
264
- location: {
265
- latitude: number;
266
- longitude: number;
267
- name?: string;
268
- address?: string;
269
- };
270
- context?: {
271
- message_id: string;
272
- };
273
- };
274
- export type GraphMessagesContactsPayload = {
275
- messaging_product: "whatsapp";
276
- to: string;
277
- type: "contacts";
278
- contacts: readonly Record<string, unknown>[];
279
- context?: {
280
- message_id: string;
281
- };
282
- };
283
- export type GraphMessagesReactionPayload = {
284
- messaging_product: "whatsapp";
285
- to: string;
286
- type: "reaction";
287
- reaction: {
288
- message_id: string;
289
- emoji: string;
290
- };
291
- };
292
- export type GraphMessagesInteractivePayload = {
293
- messaging_product: "whatsapp";
294
- to: string;
295
- type: "interactive";
296
- interactive: Record<string, unknown>;
297
- context?: {
298
- message_id: string;
299
- };
300
- };
301
- export type GraphMessagesTemplatePayload = {
302
- messaging_product: "whatsapp";
303
- to: string;
304
- type: "template";
305
- template: Record<string, unknown>;
306
- context?: {
307
- message_id: string;
308
- };
309
- };
310
- export type GraphMessagesStatusPayload = {
311
- messaging_product: "whatsapp";
312
- status: "read";
313
- message_id: string;
314
- typing_indicator?: {
315
- type: "text";
316
- };
317
- };
318
- export type GraphMessagesRemainingPayload = GraphMessagesLocationPayload | GraphMessagesContactsPayload | GraphMessagesReactionPayload | GraphMessagesInteractivePayload | GraphMessagesTemplatePayload | GraphMessagesStatusPayload;
319
- export type GraphMessagesSendBody = GraphMessagesTextPayload | GraphMessagesMediaPayload | GraphMessagesRemainingPayload;
320
- export declare const GRAPH_MESSAGES_TEXT_BODY_MAX_LENGTH = 4096;
321
- export declare const GRAPH_MESSAGES_RECIPIENT_MAX_DIGITS = 15;
322
- export declare const GRAPH_MESSAGES_REPLY_TO_MESSAGE_ID_MAX_LENGTH = 256;
323
- export declare const GRAPH_MESSAGES_MEDIA_ID_MAX_LENGTH = 2048;
324
- export declare const GRAPH_MESSAGES_MEDIA_LINK_MAX_LENGTH = 2048;
325
- export declare const GRAPH_MESSAGES_MEDIA_CAPTION_MAX_LENGTH = 1024;
326
- export declare const GRAPH_MESSAGES_DOCUMENT_FILENAME_MAX_LENGTH = 256;
327
- export declare const GRAPH_MESSAGES_GENERAL_TEXT_MAX_LENGTH = 1024;
328
- export declare const GRAPH_MESSAGES_SHORT_LABEL_MAX_LENGTH = 60;
329
- export declare const GRAPH_MESSAGES_BUTTON_TITLE_MAX_LENGTH = 20;
330
- export declare const GRAPH_MESSAGES_BUTTON_ID_MAX_LENGTH = 256;
331
- export declare const GRAPH_MESSAGES_SECTION_TITLE_MAX_LENGTH = 24;
332
- export declare const GRAPH_MESSAGES_ROW_TITLE_MAX_LENGTH = 24;
333
- export declare const GRAPH_MESSAGES_ROW_DESCRIPTION_MAX_LENGTH = 72;
334
- export declare const GRAPH_MESSAGES_MAX_REPLY_BUTTONS = 3;
335
- export declare const GRAPH_MESSAGES_MAX_LIST_SECTIONS = 10;
336
- export declare const GRAPH_MESSAGES_MAX_LIST_ROWS = 10;
337
- export declare const GRAPH_MESSAGES_MAX_CONTACTS = 257;
338
- export declare const GRAPH_MESSAGES_MAX_PRODUCT_ITEMS = 30;
339
- export declare function buildSendTextPayload(input: GraphMessagesSendTextInput): GraphMessagesTextPayload;
340
- export declare function buildSendImagePayload(input: GraphMessagesSendImageInput): GraphMessagesImagePayload;
341
- export declare function buildSendVideoPayload(input: GraphMessagesSendVideoInput): GraphMessagesVideoPayload;
342
- export declare function buildSendAudioPayload(input: GraphMessagesSendAudioInput): GraphMessagesAudioPayload;
343
- export declare function buildSendDocumentPayload(input: GraphMessagesSendDocumentInput): GraphMessagesDocumentPayload;
344
- export declare function buildSendStickerPayload(input: GraphMessagesSendStickerInput): GraphMessagesStickerPayload;
345
- export declare function buildSendLocationPayload(input: GraphMessagesSendLocationInput): GraphMessagesLocationPayload;
346
- export declare function buildSendContactsPayload(input: GraphMessagesSendContactsInput): GraphMessagesContactsPayload;
347
- export declare function buildSendReactionPayload(input: GraphMessagesSendReactionInput): GraphMessagesReactionPayload;
348
- export declare function buildRemoveReactionPayload(input: GraphMessagesRemoveReactionInput): GraphMessagesReactionPayload;
349
- export declare function buildSendButtonsPayload(input: GraphMessagesSendButtonsInput): GraphMessagesInteractivePayload;
350
- export declare function buildSendListPayload(input: GraphMessagesSendListInput): GraphMessagesInteractivePayload;
351
- export declare function buildSendCtaUrlPayload(input: GraphMessagesSendCtaUrlInput): GraphMessagesInteractivePayload;
352
- export declare function buildSendProductPayload(input: GraphMessagesSendProductInput): GraphMessagesInteractivePayload;
353
- export declare function buildSendProductsPayload(input: GraphMessagesSendProductsInput): GraphMessagesInteractivePayload;
354
- export declare function buildSendCatalogPayload(input: GraphMessagesSendCatalogInput): GraphMessagesInteractivePayload;
355
- export declare function buildRequestLocationPayload(input: GraphMessagesRequestLocationInput): GraphMessagesInteractivePayload;
356
- export declare function buildMarkMessageAsReadPayload(input: GraphMessagesMarkMessageAsReadInput): GraphMessagesStatusPayload;
357
- export declare function buildTypingIndicatorPayload(input: GraphMessagesTypingIndicatorInput): GraphMessagesStatusPayload;
358
- export declare function buildSendTemplatePayload(input: GraphMessagesSendTemplateInput): GraphMessagesTemplatePayload;
359
- export declare function buildSendMessagePayload(input: GraphMessagesSendMessageInput): GraphMessagesTextPayload;
360
- /**
361
- * `sendMessage` — Graph `POST /{phoneNumberId}/messages`.
362
- *
363
- * Built via `defineEndpoint`, so path-template parsing, param validation,
364
- * control-char rejection, body passthrough, and F-5 error registry
365
- * routing are handled uniformly.
366
- */
367
- export declare const sendMessage: import("..").EndpointCallable<{
368
- phoneNumberId: string;
369
- }, GraphMessagesSendBody, GraphMessagesSendResponse>;
370
- export declare class GraphMessagesEndpoint {
371
- private readonly requestExecutor;
372
- constructor(requestExecutor: GraphRequestExecutor);
373
- sendMessage(input: GraphMessagesSendMessageInput): Promise<GraphMessagesSendResponse>;
374
- }
375
- export {};
1
+ export * from "./messages/index.js";