@oficialapi/sdk 9.0.2 → 9.0.4
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/README.md +483 -206
- package/dist/index.d.mts +201 -104
- package/dist/index.d.ts +201 -104
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ interface ApiResponse<T = any> {
|
|
|
36
36
|
}
|
|
37
37
|
interface Channel {
|
|
38
38
|
id: number;
|
|
39
|
-
|
|
39
|
+
channelToken: string;
|
|
40
40
|
nome: string;
|
|
41
41
|
channel: 'whatsapp' | 'facebook' | 'instagram' | 'webchat' | 'email' | 'telegram';
|
|
42
42
|
status: boolean;
|
|
@@ -48,12 +48,12 @@ interface Channel {
|
|
|
48
48
|
updatedAt: string;
|
|
49
49
|
}
|
|
50
50
|
interface SendWhatsAppTextParams {
|
|
51
|
-
|
|
51
|
+
channelToken: string;
|
|
52
52
|
sender: string;
|
|
53
53
|
messageText: string;
|
|
54
54
|
}
|
|
55
55
|
interface SendWhatsAppMediaParams {
|
|
56
|
-
|
|
56
|
+
channelToken: string;
|
|
57
57
|
sender: string;
|
|
58
58
|
fileUrl: string;
|
|
59
59
|
type: 'image' | 'video' | 'audio' | 'document';
|
|
@@ -61,7 +61,7 @@ interface SendWhatsAppMediaParams {
|
|
|
61
61
|
fileName?: string;
|
|
62
62
|
}
|
|
63
63
|
interface SendWhatsAppTemplateParams {
|
|
64
|
-
|
|
64
|
+
channelToken: string;
|
|
65
65
|
sender: string;
|
|
66
66
|
templateName: string;
|
|
67
67
|
languageCode: string;
|
|
@@ -93,7 +93,7 @@ interface SendWhatsAppTemplateParams {
|
|
|
93
93
|
}>;
|
|
94
94
|
}
|
|
95
95
|
interface SendWhatsAppButtonsParams {
|
|
96
|
-
|
|
96
|
+
channelToken: string;
|
|
97
97
|
sender: string;
|
|
98
98
|
text: string;
|
|
99
99
|
buttons: Array<{
|
|
@@ -106,7 +106,7 @@ interface SendWhatsAppButtonsParams {
|
|
|
106
106
|
};
|
|
107
107
|
}
|
|
108
108
|
interface SendWhatsAppListParams {
|
|
109
|
-
|
|
109
|
+
channelToken: string;
|
|
110
110
|
sender: string;
|
|
111
111
|
headerText: string;
|
|
112
112
|
bodyText: string;
|
|
@@ -122,20 +122,20 @@ interface SendWhatsAppListParams {
|
|
|
122
122
|
}>;
|
|
123
123
|
}
|
|
124
124
|
interface ReplyWhatsAppParams {
|
|
125
|
-
|
|
125
|
+
channelToken: string;
|
|
126
126
|
sender: string;
|
|
127
127
|
messageText: string;
|
|
128
128
|
replyMessageId?: string;
|
|
129
129
|
preview_url?: boolean;
|
|
130
130
|
}
|
|
131
131
|
interface ReactWhatsAppParams {
|
|
132
|
-
|
|
132
|
+
channelToken: string;
|
|
133
133
|
sender: string;
|
|
134
134
|
emoji: string;
|
|
135
135
|
message_id?: string;
|
|
136
136
|
}
|
|
137
137
|
interface CreateTemplateParams {
|
|
138
|
-
|
|
138
|
+
channelToken: string;
|
|
139
139
|
name: string;
|
|
140
140
|
language: string;
|
|
141
141
|
category: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
|
|
@@ -156,13 +156,13 @@ interface CreateTemplateParams {
|
|
|
156
156
|
}>;
|
|
157
157
|
}
|
|
158
158
|
interface UploadMediaParams {
|
|
159
|
-
|
|
159
|
+
channelToken: string;
|
|
160
160
|
file: File | Blob | Buffer;
|
|
161
161
|
mediaType: 'image' | 'video' | 'document';
|
|
162
162
|
filename?: string;
|
|
163
163
|
}
|
|
164
164
|
interface SendOrderDetailsParams {
|
|
165
|
-
|
|
165
|
+
channelToken: string;
|
|
166
166
|
sender: string;
|
|
167
167
|
headerText?: string;
|
|
168
168
|
bodyText: string;
|
|
@@ -240,7 +240,7 @@ interface SendOrderDetailsParams {
|
|
|
240
240
|
}>;
|
|
241
241
|
}
|
|
242
242
|
interface SendOrderStatusParams {
|
|
243
|
-
|
|
243
|
+
channelToken: string;
|
|
244
244
|
sender: string;
|
|
245
245
|
bodyText: string;
|
|
246
246
|
footerText?: string;
|
|
@@ -251,31 +251,31 @@ interface SendOrderStatusParams {
|
|
|
251
251
|
payment_timestamp?: number;
|
|
252
252
|
}
|
|
253
253
|
interface SendWhatsAppAudioParams {
|
|
254
|
-
|
|
254
|
+
channelToken: string;
|
|
255
255
|
sender: string;
|
|
256
256
|
mediaId: string;
|
|
257
257
|
voice?: boolean;
|
|
258
258
|
}
|
|
259
259
|
interface SendWhatsAppStickerParams {
|
|
260
|
-
|
|
260
|
+
channelToken: string;
|
|
261
261
|
sender: string;
|
|
262
262
|
mediaId: string;
|
|
263
263
|
}
|
|
264
264
|
interface SendWhatsAppVideoParams {
|
|
265
|
-
|
|
265
|
+
channelToken: string;
|
|
266
266
|
sender: string;
|
|
267
267
|
mediaId: string;
|
|
268
268
|
caption?: string;
|
|
269
269
|
}
|
|
270
270
|
interface SendWhatsAppDocumentParams {
|
|
271
|
-
|
|
271
|
+
channelToken: string;
|
|
272
272
|
sender: string;
|
|
273
273
|
mediaId: string;
|
|
274
274
|
filename?: string;
|
|
275
275
|
caption?: string;
|
|
276
276
|
}
|
|
277
277
|
interface SendWhatsAppContactParams {
|
|
278
|
-
|
|
278
|
+
channelToken: string;
|
|
279
279
|
sender: string;
|
|
280
280
|
contacts: Array<{
|
|
281
281
|
name: {
|
|
@@ -317,7 +317,7 @@ interface SendWhatsAppContactParams {
|
|
|
317
317
|
}>;
|
|
318
318
|
}
|
|
319
319
|
interface SendWhatsAppLocationParams {
|
|
320
|
-
|
|
320
|
+
channelToken: string;
|
|
321
321
|
sender: string;
|
|
322
322
|
latitude: number;
|
|
323
323
|
longitude: number;
|
|
@@ -325,14 +325,14 @@ interface SendWhatsAppLocationParams {
|
|
|
325
325
|
address?: string;
|
|
326
326
|
}
|
|
327
327
|
interface SendWhatsAppLocationRequestParams {
|
|
328
|
-
|
|
328
|
+
channelToken: string;
|
|
329
329
|
sender: string;
|
|
330
330
|
bodyText: string;
|
|
331
331
|
headerText?: string;
|
|
332
332
|
footerText?: string;
|
|
333
333
|
}
|
|
334
334
|
interface SendWhatsAppCtaUrlParams {
|
|
335
|
-
|
|
335
|
+
channelToken: string;
|
|
336
336
|
sender: string;
|
|
337
337
|
bodyText: string;
|
|
338
338
|
buttonText: string;
|
|
@@ -345,7 +345,7 @@ interface SendWhatsAppCtaUrlParams {
|
|
|
345
345
|
footerText?: string;
|
|
346
346
|
}
|
|
347
347
|
interface SendWhatsAppMediaCarouselParams {
|
|
348
|
-
|
|
348
|
+
channelToken: string;
|
|
349
349
|
sender: string;
|
|
350
350
|
bodyText: string;
|
|
351
351
|
cards: Array<{
|
|
@@ -358,11 +358,11 @@ interface SendWhatsAppMediaCarouselParams {
|
|
|
358
358
|
}>;
|
|
359
359
|
}
|
|
360
360
|
interface DownloadWhatsAppMediaParams {
|
|
361
|
-
|
|
361
|
+
channelToken: string;
|
|
362
362
|
url: string;
|
|
363
363
|
}
|
|
364
364
|
interface SendTelegramTextParams {
|
|
365
|
-
|
|
365
|
+
channelToken: string;
|
|
366
366
|
chatId: string | number;
|
|
367
367
|
text: string;
|
|
368
368
|
parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
|
|
@@ -370,7 +370,7 @@ interface SendTelegramTextParams {
|
|
|
370
370
|
disableNotification?: boolean;
|
|
371
371
|
}
|
|
372
372
|
interface SendTelegramMediaParams {
|
|
373
|
-
|
|
373
|
+
channelToken: string;
|
|
374
374
|
chatId: string | number;
|
|
375
375
|
fileUrl: string;
|
|
376
376
|
type: 'photo' | 'video' | 'audio' | 'document' | 'voice';
|
|
@@ -379,7 +379,7 @@ interface SendTelegramMediaParams {
|
|
|
379
379
|
replyToMessageId?: number;
|
|
380
380
|
}
|
|
381
381
|
interface SendTelegramButtonsParams {
|
|
382
|
-
|
|
382
|
+
channelToken: string;
|
|
383
383
|
chatId: string | number;
|
|
384
384
|
text: string;
|
|
385
385
|
buttons: Array<Array<{
|
|
@@ -393,14 +393,14 @@ interface SendTelegramButtonsParams {
|
|
|
393
393
|
parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
|
|
394
394
|
}
|
|
395
395
|
interface SendTelegramLocationParams {
|
|
396
|
-
|
|
396
|
+
channelToken: string;
|
|
397
397
|
chatId: string | number;
|
|
398
398
|
latitude: number;
|
|
399
399
|
longitude: number;
|
|
400
400
|
livePeriod?: number;
|
|
401
401
|
}
|
|
402
402
|
interface SendTelegramContactParams {
|
|
403
|
-
|
|
403
|
+
channelToken: string;
|
|
404
404
|
chatId: string | number;
|
|
405
405
|
phoneNumber: string;
|
|
406
406
|
firstName: string;
|
|
@@ -408,7 +408,7 @@ interface SendTelegramContactParams {
|
|
|
408
408
|
vcard?: string;
|
|
409
409
|
}
|
|
410
410
|
interface SendTelegramPollParams {
|
|
411
|
-
|
|
411
|
+
channelToken: string;
|
|
412
412
|
chatId: string | number;
|
|
413
413
|
question: string;
|
|
414
414
|
options: string[];
|
|
@@ -417,7 +417,7 @@ interface SendTelegramPollParams {
|
|
|
417
417
|
correctOptionId?: number;
|
|
418
418
|
}
|
|
419
419
|
interface SendTelegramVenueParams {
|
|
420
|
-
|
|
420
|
+
channelToken: string;
|
|
421
421
|
chatId: string | number;
|
|
422
422
|
latitude: number;
|
|
423
423
|
longitude: number;
|
|
@@ -426,31 +426,31 @@ interface SendTelegramVenueParams {
|
|
|
426
426
|
foursquareId?: string;
|
|
427
427
|
}
|
|
428
428
|
interface SendTelegramDiceParams {
|
|
429
|
-
|
|
429
|
+
channelToken: string;
|
|
430
430
|
chatId: string | number;
|
|
431
431
|
emoji?: '🎲' | '🎯' | '🏀' | '⚽' | '🎳' | '🎰';
|
|
432
432
|
}
|
|
433
433
|
interface SendTelegramStickerParams {
|
|
434
|
-
|
|
434
|
+
channelToken: string;
|
|
435
435
|
chatId: string | number;
|
|
436
436
|
stickerUrl: string;
|
|
437
437
|
}
|
|
438
438
|
interface SendTelegramVoiceParams {
|
|
439
|
-
|
|
439
|
+
channelToken: string;
|
|
440
440
|
chatId: string | number;
|
|
441
441
|
voiceUrl: string;
|
|
442
442
|
caption?: string;
|
|
443
443
|
duration?: number;
|
|
444
444
|
}
|
|
445
445
|
interface SendTelegramVideoNoteParams {
|
|
446
|
-
|
|
446
|
+
channelToken: string;
|
|
447
447
|
chatId: string | number;
|
|
448
448
|
videoNoteUrl: string;
|
|
449
449
|
duration?: number;
|
|
450
450
|
length?: number;
|
|
451
451
|
}
|
|
452
452
|
interface SendTelegramMediaGroupParams {
|
|
453
|
-
|
|
453
|
+
channelToken: string;
|
|
454
454
|
chatId: string | number;
|
|
455
455
|
media: Array<{
|
|
456
456
|
type: 'photo' | 'video';
|
|
@@ -459,7 +459,7 @@ interface SendTelegramMediaGroupParams {
|
|
|
459
459
|
}>;
|
|
460
460
|
}
|
|
461
461
|
interface SendTelegramReplyKeyboardParams {
|
|
462
|
-
|
|
462
|
+
channelToken: string;
|
|
463
463
|
chatId: string | number;
|
|
464
464
|
text: string;
|
|
465
465
|
keyboard: Array<Array<{
|
|
@@ -469,131 +469,157 @@ interface SendTelegramReplyKeyboardParams {
|
|
|
469
469
|
oneTimeKeyboard?: boolean;
|
|
470
470
|
}
|
|
471
471
|
interface EditTelegramMessageParams {
|
|
472
|
-
|
|
472
|
+
channelToken: string;
|
|
473
473
|
chatId: string | number;
|
|
474
474
|
messageId: number;
|
|
475
475
|
text: string;
|
|
476
476
|
parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
|
|
477
477
|
}
|
|
478
478
|
interface DeleteTelegramMessageParams {
|
|
479
|
-
|
|
479
|
+
channelToken: string;
|
|
480
480
|
chatId: string | number;
|
|
481
481
|
messageId: number;
|
|
482
482
|
}
|
|
483
483
|
interface DownloadTelegramMediaParams {
|
|
484
|
-
|
|
484
|
+
channelToken: string;
|
|
485
485
|
fileId: string;
|
|
486
486
|
}
|
|
487
487
|
interface SendWebChatTextParams {
|
|
488
|
-
|
|
489
|
-
|
|
488
|
+
channelToken: string;
|
|
489
|
+
chatId: string;
|
|
490
490
|
messageText: string;
|
|
491
|
+
typing?: boolean;
|
|
492
|
+
typingTime?: number;
|
|
491
493
|
}
|
|
492
494
|
interface SendWebChatMediaParams {
|
|
493
|
-
|
|
494
|
-
|
|
495
|
+
channelToken: string;
|
|
496
|
+
chatId: string;
|
|
495
497
|
fileUrl: string;
|
|
496
498
|
type: 'image' | 'video' | 'audio' | 'file';
|
|
497
499
|
caption?: string;
|
|
500
|
+
typing?: boolean;
|
|
501
|
+
typingTime?: number;
|
|
498
502
|
}
|
|
499
503
|
interface SendWebChatCarouselParams {
|
|
500
|
-
|
|
501
|
-
|
|
504
|
+
channelToken: string;
|
|
505
|
+
chatId: string;
|
|
502
506
|
cards: Array<{
|
|
503
507
|
title: string;
|
|
504
|
-
|
|
508
|
+
subtitle?: string;
|
|
505
509
|
imageUrl?: string;
|
|
506
510
|
buttons?: Array<{
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
511
|
+
id?: string;
|
|
512
|
+
text: string;
|
|
513
|
+
type: 'text' | 'url' | 'phone' | 'postback';
|
|
514
|
+
value?: string;
|
|
515
|
+
url?: string;
|
|
510
516
|
}>;
|
|
511
517
|
}>;
|
|
518
|
+
typing?: boolean;
|
|
519
|
+
typingTime?: number;
|
|
512
520
|
}
|
|
513
521
|
interface SendWebChatFormParams {
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
522
|
+
channelToken: string;
|
|
523
|
+
chatId: string;
|
|
524
|
+
id?: string;
|
|
525
|
+
title?: string;
|
|
517
526
|
fields: Array<{
|
|
518
|
-
|
|
519
|
-
name
|
|
527
|
+
id?: string;
|
|
528
|
+
name?: string;
|
|
529
|
+
type: 'text' | 'email' | 'number' | 'tel' | 'date' | 'select';
|
|
520
530
|
label: string;
|
|
521
|
-
required?: boolean;
|
|
522
531
|
placeholder?: string;
|
|
532
|
+
required?: boolean;
|
|
533
|
+
options?: Array<{
|
|
534
|
+
value: string;
|
|
535
|
+
label: string;
|
|
536
|
+
}>;
|
|
523
537
|
}>;
|
|
524
538
|
submitButtonText?: string;
|
|
539
|
+
typing?: boolean;
|
|
540
|
+
typingTime?: number;
|
|
525
541
|
}
|
|
526
542
|
interface SendWebChatQuickRepliesParams {
|
|
527
|
-
|
|
528
|
-
|
|
543
|
+
channelToken: string;
|
|
544
|
+
chatId: string;
|
|
529
545
|
messageText: string;
|
|
530
546
|
quickReplies: Array<{
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
547
|
+
id?: string;
|
|
548
|
+
text: string;
|
|
549
|
+
value?: string;
|
|
534
550
|
}>;
|
|
551
|
+
typing?: boolean;
|
|
552
|
+
typingTime?: number;
|
|
535
553
|
}
|
|
536
554
|
interface SendWebChatCardParams {
|
|
537
|
-
|
|
538
|
-
|
|
555
|
+
channelToken: string;
|
|
556
|
+
chatId: string;
|
|
539
557
|
title: string;
|
|
540
558
|
description?: string;
|
|
541
559
|
imageUrl?: string;
|
|
542
560
|
buttons?: Array<{
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
561
|
+
id?: string;
|
|
562
|
+
text: string;
|
|
563
|
+
type: 'text' | 'url' | 'phone' | 'postback';
|
|
564
|
+
value?: string;
|
|
565
|
+
url?: string;
|
|
546
566
|
}>;
|
|
567
|
+
typing?: boolean;
|
|
568
|
+
typingTime?: number;
|
|
547
569
|
}
|
|
548
570
|
interface SendWebChatButtonsParams {
|
|
549
|
-
|
|
550
|
-
|
|
571
|
+
channelToken: string;
|
|
572
|
+
chatId: string;
|
|
551
573
|
messageText: string;
|
|
552
574
|
buttons: Array<{
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
575
|
+
id?: string;
|
|
576
|
+
text: string;
|
|
577
|
+
type: 'text' | 'url' | 'phone' | 'postback';
|
|
578
|
+
value?: string;
|
|
579
|
+
url?: string;
|
|
556
580
|
}>;
|
|
581
|
+
typing?: boolean;
|
|
582
|
+
typingTime?: number;
|
|
557
583
|
}
|
|
558
584
|
interface ListPostsParams {
|
|
559
|
-
|
|
585
|
+
channelToken: string;
|
|
560
586
|
pageId: string;
|
|
561
587
|
limit?: number;
|
|
562
588
|
}
|
|
563
589
|
interface ListCommentsParams {
|
|
564
|
-
|
|
590
|
+
channelToken: string;
|
|
565
591
|
postId: string;
|
|
566
592
|
limit?: number;
|
|
567
593
|
}
|
|
568
594
|
interface CreatePostParams {
|
|
569
|
-
|
|
595
|
+
channelToken: string;
|
|
570
596
|
pageId: string;
|
|
571
597
|
message: string;
|
|
572
598
|
link?: string;
|
|
573
599
|
}
|
|
574
600
|
interface ReplyCommentParams {
|
|
575
|
-
|
|
601
|
+
channelToken: string;
|
|
576
602
|
commentId: string;
|
|
577
603
|
message: string;
|
|
578
604
|
}
|
|
579
605
|
interface DeleteCommentParams {
|
|
580
|
-
|
|
606
|
+
channelToken: string;
|
|
581
607
|
commentId: string;
|
|
582
608
|
}
|
|
583
609
|
interface SendFacebookTextParams {
|
|
584
|
-
|
|
610
|
+
channelToken: string;
|
|
585
611
|
recipientId: string;
|
|
586
612
|
message: string;
|
|
587
613
|
}
|
|
588
614
|
interface SendFacebookMediaParams {
|
|
589
|
-
|
|
615
|
+
channelToken: string;
|
|
590
616
|
recipientId: string;
|
|
591
617
|
fileUrl: string;
|
|
592
618
|
type: 'image' | 'video' | 'audio' | 'file';
|
|
593
619
|
caption?: string;
|
|
594
620
|
}
|
|
595
621
|
interface SendFacebookButtonsParams {
|
|
596
|
-
|
|
622
|
+
channelToken: string;
|
|
597
623
|
recipientId: string;
|
|
598
624
|
message: string;
|
|
599
625
|
buttons: Array<{
|
|
@@ -604,58 +630,58 @@ interface SendFacebookButtonsParams {
|
|
|
604
630
|
}>;
|
|
605
631
|
}
|
|
606
632
|
interface SendFacebookStickerParams {
|
|
607
|
-
|
|
633
|
+
channelToken: string;
|
|
608
634
|
recipientId: string;
|
|
609
635
|
stickerId: number;
|
|
610
636
|
}
|
|
611
637
|
interface ReplyFacebookMessageParams {
|
|
612
|
-
|
|
638
|
+
channelToken: string;
|
|
613
639
|
messageId: string;
|
|
614
640
|
message: string;
|
|
615
641
|
}
|
|
616
642
|
interface ReplyFacebookMediaParams {
|
|
617
|
-
|
|
643
|
+
channelToken: string;
|
|
618
644
|
messageId: string;
|
|
619
645
|
fileUrl: string;
|
|
620
646
|
type: 'image' | 'video' | 'audio' | 'file';
|
|
621
647
|
caption?: string;
|
|
622
648
|
}
|
|
623
649
|
interface SharePostParams {
|
|
624
|
-
|
|
650
|
+
channelToken: string;
|
|
625
651
|
mediaId: string;
|
|
626
652
|
recipientId: string;
|
|
627
653
|
}
|
|
628
654
|
interface GetFacebookUserProfileParams {
|
|
629
|
-
|
|
655
|
+
channelToken: string;
|
|
630
656
|
userId: string;
|
|
631
657
|
}
|
|
632
658
|
interface GetFacebookPageProfileParams {
|
|
633
|
-
|
|
659
|
+
channelToken: string;
|
|
634
660
|
pageId: string;
|
|
635
661
|
}
|
|
636
662
|
interface DownloadFacebookMediaParams {
|
|
637
|
-
|
|
663
|
+
channelToken: string;
|
|
638
664
|
url: string;
|
|
639
665
|
}
|
|
640
666
|
interface SendInstagramPrivateReplyParams {
|
|
641
|
-
|
|
667
|
+
channelToken: string;
|
|
642
668
|
commentId: string;
|
|
643
669
|
message: string;
|
|
644
670
|
}
|
|
645
671
|
interface SendInstagramTextParams {
|
|
646
|
-
|
|
672
|
+
channelToken: string;
|
|
647
673
|
recipientId: string;
|
|
648
674
|
message: string;
|
|
649
675
|
}
|
|
650
676
|
interface SendInstagramMediaParams {
|
|
651
|
-
|
|
677
|
+
channelToken: string;
|
|
652
678
|
recipientId: string;
|
|
653
679
|
fileUrl: string;
|
|
654
680
|
type: 'image' | 'video' | 'audio' | 'file';
|
|
655
681
|
caption?: string;
|
|
656
682
|
}
|
|
657
683
|
interface SendInstagramImagesParams {
|
|
658
|
-
|
|
684
|
+
channelToken: string;
|
|
659
685
|
recipientId: string;
|
|
660
686
|
images: Array<{
|
|
661
687
|
url: string;
|
|
@@ -663,22 +689,22 @@ interface SendInstagramImagesParams {
|
|
|
663
689
|
}>;
|
|
664
690
|
}
|
|
665
691
|
interface SendInstagramStickerParams {
|
|
666
|
-
|
|
692
|
+
channelToken: string;
|
|
667
693
|
recipientId: string;
|
|
668
694
|
stickerType: 'like' | 'heart';
|
|
669
695
|
}
|
|
670
696
|
interface ReactInstagramMessageParams {
|
|
671
|
-
|
|
697
|
+
channelToken: string;
|
|
672
698
|
messageId: string;
|
|
673
699
|
reactionType: 'like' | 'love' | 'wow' | 'haha' | 'sorry' | 'anger';
|
|
674
700
|
}
|
|
675
701
|
interface RemoveInstagramReactionParams {
|
|
676
|
-
|
|
702
|
+
channelToken: string;
|
|
677
703
|
recipientId: string;
|
|
678
704
|
messageId: string;
|
|
679
705
|
}
|
|
680
706
|
interface SendInstagramQuickRepliesParams {
|
|
681
|
-
|
|
707
|
+
channelToken: string;
|
|
682
708
|
recipientId: string;
|
|
683
709
|
message: string;
|
|
684
710
|
quickReplies: Array<{
|
|
@@ -688,7 +714,7 @@ interface SendInstagramQuickRepliesParams {
|
|
|
688
714
|
}>;
|
|
689
715
|
}
|
|
690
716
|
interface SendInstagramGenericTemplateParams {
|
|
691
|
-
|
|
717
|
+
channelToken: string;
|
|
692
718
|
recipientId: string;
|
|
693
719
|
elements: Array<{
|
|
694
720
|
title: string;
|
|
@@ -703,7 +729,7 @@ interface SendInstagramGenericTemplateParams {
|
|
|
703
729
|
}>;
|
|
704
730
|
}
|
|
705
731
|
interface SendInstagramButtonTemplateParams {
|
|
706
|
-
|
|
732
|
+
channelToken: string;
|
|
707
733
|
recipientId: string;
|
|
708
734
|
text: string;
|
|
709
735
|
buttons: Array<{
|
|
@@ -714,26 +740,67 @@ interface SendInstagramButtonTemplateParams {
|
|
|
714
740
|
}>;
|
|
715
741
|
}
|
|
716
742
|
interface SendInstagramSenderActionParams {
|
|
717
|
-
|
|
743
|
+
channelToken: string;
|
|
718
744
|
recipientId: string;
|
|
719
745
|
action: 'typing_on' | 'typing_off' | 'mark_seen';
|
|
720
746
|
}
|
|
721
747
|
interface GetInstagramUserProfileParams {
|
|
722
|
-
|
|
748
|
+
channelToken: string;
|
|
723
749
|
userId: string;
|
|
724
750
|
}
|
|
725
751
|
interface ListInstagramPostsParams {
|
|
726
|
-
|
|
752
|
+
channelToken: string;
|
|
727
753
|
userId?: string;
|
|
728
754
|
limit?: number;
|
|
729
755
|
}
|
|
730
756
|
interface GetInstagramBusinessProfileParams {
|
|
731
|
-
|
|
757
|
+
channelToken: string;
|
|
732
758
|
}
|
|
733
759
|
interface DownloadInstagramMediaParams {
|
|
734
|
-
|
|
760
|
+
channelToken: string;
|
|
735
761
|
url: string;
|
|
736
762
|
}
|
|
763
|
+
type InstagramPublishMediaType = 'IMAGE' | 'VIDEO' | 'REELS' | 'STORIES' | 'CAROUSEL';
|
|
764
|
+
type GraduationStrategy = 'MANUAL' | 'SS_PERFORMANCE';
|
|
765
|
+
interface CreateInstagramMediaContainerParams {
|
|
766
|
+
channelToken: string;
|
|
767
|
+
image_url?: string;
|
|
768
|
+
video_url?: string;
|
|
769
|
+
media_type: InstagramPublishMediaType;
|
|
770
|
+
caption?: string;
|
|
771
|
+
is_carousel_item?: boolean;
|
|
772
|
+
children?: string[];
|
|
773
|
+
upload_type?: string;
|
|
774
|
+
trial_params?: {
|
|
775
|
+
graduation_strategy: GraduationStrategy;
|
|
776
|
+
};
|
|
777
|
+
alt_text?: string;
|
|
778
|
+
location_id?: string;
|
|
779
|
+
product_tags?: string;
|
|
780
|
+
user_tags?: Array<{
|
|
781
|
+
username: string;
|
|
782
|
+
x?: number;
|
|
783
|
+
y?: number;
|
|
784
|
+
}>;
|
|
785
|
+
}
|
|
786
|
+
interface PublishInstagramMediaParams {
|
|
787
|
+
channelToken: string;
|
|
788
|
+
creation_id: string;
|
|
789
|
+
}
|
|
790
|
+
interface GetInstagramContainerStatusParams {
|
|
791
|
+
channelToken: string;
|
|
792
|
+
container_id: string;
|
|
793
|
+
}
|
|
794
|
+
interface GetInstagramPublishingLimitParams {
|
|
795
|
+
channelToken: string;
|
|
796
|
+
}
|
|
797
|
+
interface UploadInstagramVideoParams {
|
|
798
|
+
channelToken: string;
|
|
799
|
+
container_id: string;
|
|
800
|
+
file_url?: string;
|
|
801
|
+
offset?: number;
|
|
802
|
+
file_size?: number;
|
|
803
|
+
}
|
|
737
804
|
interface CreateWebhookParams {
|
|
738
805
|
url: string;
|
|
739
806
|
expiresInDays?: number;
|
|
@@ -886,14 +953,14 @@ declare class WhatsAppModule {
|
|
|
886
953
|
* @param token Token do canal
|
|
887
954
|
* @param accessToken Token de acesso do usuário
|
|
888
955
|
*/
|
|
889
|
-
listTemplates(
|
|
956
|
+
listTemplates(channelToken: string, accessToken: string): Promise<ApiResponse<any>>;
|
|
890
957
|
/**
|
|
891
958
|
* Obtém detalhes de um template
|
|
892
|
-
* @param
|
|
959
|
+
* @param channelToken Token do canal
|
|
893
960
|
* @param templateId ID do template
|
|
894
961
|
* @param accessToken Token de acesso do usuário
|
|
895
962
|
*/
|
|
896
|
-
getTemplate(
|
|
963
|
+
getTemplate(channelToken: string, templateId: string, accessToken: string): Promise<ApiResponse<any>>;
|
|
897
964
|
/**
|
|
898
965
|
* Faz upload de mídia para templates
|
|
899
966
|
* @param params Parâmetros do upload
|
|
@@ -1339,6 +1406,36 @@ declare class InstagramModule {
|
|
|
1339
1406
|
* @param accessToken Token de acesso do usuário
|
|
1340
1407
|
*/
|
|
1341
1408
|
downloadMedia(params: DownloadInstagramMediaParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1409
|
+
/**
|
|
1410
|
+
* Cria um contêiner de mídia para publicação no Instagram
|
|
1411
|
+
* @param params Parâmetros do contêiner
|
|
1412
|
+
* @param accessToken Token de acesso do usuário
|
|
1413
|
+
*/
|
|
1414
|
+
createMediaContainer(params: CreateInstagramMediaContainerParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1415
|
+
/**
|
|
1416
|
+
* Publica uma mídia no Instagram usando o ID do contêiner
|
|
1417
|
+
* @param params Parâmetros da publicação
|
|
1418
|
+
* @param accessToken Token de acesso do usuário
|
|
1419
|
+
*/
|
|
1420
|
+
publishMedia(params: PublishInstagramMediaParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1421
|
+
/**
|
|
1422
|
+
* Verifica o status de um contêiner de mídia
|
|
1423
|
+
* @param params Parâmetros da verificação
|
|
1424
|
+
* @param accessToken Token de acesso do usuário
|
|
1425
|
+
*/
|
|
1426
|
+
getContainerStatus(params: GetInstagramContainerStatusParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Verifica o limite de publicação atual
|
|
1429
|
+
* @param params Parâmetros da verificação
|
|
1430
|
+
* @param accessToken Token de acesso do usuário
|
|
1431
|
+
*/
|
|
1432
|
+
getPublishingLimit(params: GetInstagramPublishingLimitParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1433
|
+
/**
|
|
1434
|
+
* Faz upload de vídeo para sessão retomável
|
|
1435
|
+
* @param params Parâmetros do upload
|
|
1436
|
+
* @param accessToken Token de acesso do usuário
|
|
1437
|
+
*/
|
|
1438
|
+
uploadVideo(params: UploadInstagramVideoParams, accessToken: string): Promise<ApiResponse<any>>;
|
|
1342
1439
|
}
|
|
1343
1440
|
|
|
1344
1441
|
/**
|
|
@@ -1355,7 +1452,7 @@ declare class InstagramModule {
|
|
|
1355
1452
|
*
|
|
1356
1453
|
* // Enviar mensagem WhatsApp
|
|
1357
1454
|
* const result = await sdk.whatsapp.sendText({
|
|
1358
|
-
*
|
|
1455
|
+
* channelToken: 'sk_live_...',
|
|
1359
1456
|
* sender: '5511999999999',
|
|
1360
1457
|
* messageText: 'Olá!'
|
|
1361
1458
|
* });
|
|
@@ -1374,4 +1471,4 @@ declare class OficialAPISDK {
|
|
|
1374
1471
|
constructor(config: SDKConfig);
|
|
1375
1472
|
}
|
|
1376
1473
|
|
|
1377
|
-
export { type ApiResponse, type Channel, type CreatePostParams, type CreateTemplateParams, type CreateWebhookParams, type DeleteCommentParams, type DeleteTelegramMessageParams, type DownloadFacebookMediaParams, type DownloadInstagramMediaParams, type DownloadTelegramMediaParams, type DownloadWhatsAppMediaParams, type EditTelegramMessageParams, type GetFacebookPageProfileParams, type GetFacebookUserProfileParams, type GetInstagramBusinessProfileParams, type GetInstagramUserProfileParams, type ListCommentsParams, type ListInstagramPostsParams, type ListPostsParams, OficialAPISDK, type ReactInstagramMessageParams, type ReactWhatsAppParams, type RemoveInstagramReactionParams, type ReplyCommentParams, type ReplyFacebookMediaParams, type ReplyFacebookMessageParams, type ReplyWhatsAppParams, type SDKConfig, type SendFacebookButtonsParams, type SendFacebookMediaParams, type SendFacebookStickerParams, type SendFacebookTextParams, type SendInstagramButtonTemplateParams, type SendInstagramGenericTemplateParams, type SendInstagramImagesParams, type SendInstagramMediaParams, type SendInstagramPrivateReplyParams, type SendInstagramQuickRepliesParams, type SendInstagramSenderActionParams, type SendInstagramStickerParams, type SendInstagramTextParams, type SendOrderDetailsParams, type SendOrderStatusParams, type SendTelegramButtonsParams, type SendTelegramContactParams, type SendTelegramDiceParams, type SendTelegramLocationParams, type SendTelegramMediaGroupParams, type SendTelegramMediaParams, type SendTelegramPollParams, type SendTelegramReplyKeyboardParams, type SendTelegramStickerParams, type SendTelegramTextParams, type SendTelegramVenueParams, type SendTelegramVideoNoteParams, type SendTelegramVoiceParams, type SendWebChatButtonsParams, type SendWebChatCardParams, type SendWebChatCarouselParams, type SendWebChatFormParams, type SendWebChatMediaParams, type SendWebChatQuickRepliesParams, type SendWebChatTextParams, type SendWhatsAppAudioParams, type SendWhatsAppButtonsParams, type SendWhatsAppContactParams, type SendWhatsAppCtaUrlParams, type SendWhatsAppDocumentParams, type SendWhatsAppListParams, type SendWhatsAppLocationParams, type SendWhatsAppLocationRequestParams, type SendWhatsAppMediaCarouselParams, type SendWhatsAppMediaParams, type SendWhatsAppStickerParams, type SendWhatsAppTemplateParams, type SendWhatsAppTextParams, type SendWhatsAppVideoParams, type SharePostParams, type TokenResponse, type UploadMediaParams, type Webhook, OficialAPISDK as default };
|
|
1474
|
+
export { type ApiResponse, type Channel, type CreateInstagramMediaContainerParams, type CreatePostParams, type CreateTemplateParams, type CreateWebhookParams, type DeleteCommentParams, type DeleteTelegramMessageParams, type DownloadFacebookMediaParams, type DownloadInstagramMediaParams, type DownloadTelegramMediaParams, type DownloadWhatsAppMediaParams, type EditTelegramMessageParams, type GetFacebookPageProfileParams, type GetFacebookUserProfileParams, type GetInstagramBusinessProfileParams, type GetInstagramContainerStatusParams, type GetInstagramPublishingLimitParams, type GetInstagramUserProfileParams, type GraduationStrategy, type InstagramPublishMediaType, type ListCommentsParams, type ListInstagramPostsParams, type ListPostsParams, OficialAPISDK, type PublishInstagramMediaParams, type ReactInstagramMessageParams, type ReactWhatsAppParams, type RemoveInstagramReactionParams, type ReplyCommentParams, type ReplyFacebookMediaParams, type ReplyFacebookMessageParams, type ReplyWhatsAppParams, type SDKConfig, type SendFacebookButtonsParams, type SendFacebookMediaParams, type SendFacebookStickerParams, type SendFacebookTextParams, type SendInstagramButtonTemplateParams, type SendInstagramGenericTemplateParams, type SendInstagramImagesParams, type SendInstagramMediaParams, type SendInstagramPrivateReplyParams, type SendInstagramQuickRepliesParams, type SendInstagramSenderActionParams, type SendInstagramStickerParams, type SendInstagramTextParams, type SendOrderDetailsParams, type SendOrderStatusParams, type SendTelegramButtonsParams, type SendTelegramContactParams, type SendTelegramDiceParams, type SendTelegramLocationParams, type SendTelegramMediaGroupParams, type SendTelegramMediaParams, type SendTelegramPollParams, type SendTelegramReplyKeyboardParams, type SendTelegramStickerParams, type SendTelegramTextParams, type SendTelegramVenueParams, type SendTelegramVideoNoteParams, type SendTelegramVoiceParams, type SendWebChatButtonsParams, type SendWebChatCardParams, type SendWebChatCarouselParams, type SendWebChatFormParams, type SendWebChatMediaParams, type SendWebChatQuickRepliesParams, type SendWebChatTextParams, type SendWhatsAppAudioParams, type SendWhatsAppButtonsParams, type SendWhatsAppContactParams, type SendWhatsAppCtaUrlParams, type SendWhatsAppDocumentParams, type SendWhatsAppListParams, type SendWhatsAppLocationParams, type SendWhatsAppLocationRequestParams, type SendWhatsAppMediaCarouselParams, type SendWhatsAppMediaParams, type SendWhatsAppStickerParams, type SendWhatsAppTemplateParams, type SendWhatsAppTextParams, type SendWhatsAppVideoParams, type SharePostParams, type TokenResponse, type UploadInstagramVideoParams, type UploadMediaParams, type Webhook, OficialAPISDK as default };
|