@oficialapi/sdk 9.0.3 → 9.0.5

package/dist/index.d.mts

@@ -36,7 +36,7 @@ interface ApiResponse<T = any> {
 }
 interface Channel {
     id: number;
-    token: string;
+    channelToken: string;
     nome: string;
     channel: 'whatsapp' | 'facebook' | 'instagram' | 'webchat' | 'email' | 'telegram';
     status: boolean;
@@ -48,12 +48,12 @@ interface Channel {
     updatedAt: string;
 }
 interface SendWhatsAppTextParams {
-    token: string;
+    channelToken: string;
     sender: string;
     messageText: string;
 }
 interface SendWhatsAppMediaParams {
-    token: string;
+    channelToken: string;
     sender: string;
     fileUrl: string;
     type: 'image' | 'video' | 'audio' | 'document';
@@ -61,7 +61,7 @@ interface SendWhatsAppMediaParams {
     fileName?: string;
 }
 interface SendWhatsAppTemplateParams {
-    token: string;
+    channelToken: string;
     sender: string;
     templateName: string;
     languageCode: string;
@@ -93,7 +93,7 @@ interface SendWhatsAppTemplateParams {
     }>;
 }
 interface SendWhatsAppButtonsParams {
-    token: string;
+    channelToken: string;
     sender: string;
     text: string;
     buttons: Array<{
@@ -106,7 +106,7 @@ interface SendWhatsAppButtonsParams {
     };
 }
 interface SendWhatsAppListParams {
-    token: string;
+    channelToken: string;
     sender: string;
     headerText: string;
     bodyText: string;
@@ -122,20 +122,20 @@ interface SendWhatsAppListParams {
     }>;
 }
 interface ReplyWhatsAppParams {
-    token: string;
+    channelToken: string;
     sender: string;
     messageText: string;
     replyMessageId?: string;
     preview_url?: boolean;
 }
 interface ReactWhatsAppParams {
-    token: string;
+    channelToken: string;
     sender: string;
     emoji: string;
     message_id?: string;
 }
 interface CreateTemplateParams {
-    token: string;
+    channelToken: string;
     name: string;
     language: string;
     category: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
@@ -156,13 +156,13 @@ interface CreateTemplateParams {
     }>;
 }
 interface UploadMediaParams {
-    token: string;
+    channelToken: string;
     file: File | Blob | Buffer;
     mediaType: 'image' | 'video' | 'document';
     filename?: string;
 }
 interface SendOrderDetailsParams {
-    token: string;
+    channelToken: string;
     sender: string;
     headerText?: string;
     bodyText: string;
@@ -240,7 +240,7 @@ interface SendOrderDetailsParams {
     }>;
 }
 interface SendOrderStatusParams {
-    token: string;
+    channelToken: string;
     sender: string;
     bodyText: string;
     footerText?: string;
@@ -251,31 +251,31 @@ interface SendOrderStatusParams {
     payment_timestamp?: number;
 }
 interface SendWhatsAppAudioParams {
-    token: string;
+    channelToken: string;
     sender: string;
     mediaId: string;
     voice?: boolean;
 }
 interface SendWhatsAppStickerParams {
-    token: string;
+    channelToken: string;
     sender: string;
     mediaId: string;
 }
 interface SendWhatsAppVideoParams {
-    token: string;
+    channelToken: string;
     sender: string;
     mediaId: string;
     caption?: string;
 }
 interface SendWhatsAppDocumentParams {
-    token: string;
+    channelToken: string;
     sender: string;
     mediaId: string;
     filename?: string;
     caption?: string;
 }
 interface SendWhatsAppContactParams {
-    token: string;
+    channelToken: string;
     sender: string;
     contacts: Array<{
         name: {
@@ -317,7 +317,7 @@ interface SendWhatsAppContactParams {
     }>;
 }
 interface SendWhatsAppLocationParams {
-    token: string;
+    channelToken: string;
     sender: string;
     latitude: number;
     longitude: number;
@@ -325,14 +325,14 @@ interface SendWhatsAppLocationParams {
     address?: string;
 }
 interface SendWhatsAppLocationRequestParams {
-    token: string;
+    channelToken: string;
     sender: string;
     bodyText: string;
     headerText?: string;
     footerText?: string;
 }
 interface SendWhatsAppCtaUrlParams {
-    token: string;
+    channelToken: string;
     sender: string;
     bodyText: string;
     buttonText: string;
@@ -345,7 +345,7 @@ interface SendWhatsAppCtaUrlParams {
     footerText?: string;
 }
 interface SendWhatsAppMediaCarouselParams {
-    token: string;
+    channelToken: string;
     sender: string;
     bodyText: string;
     cards: Array<{
@@ -358,11 +358,11 @@ interface SendWhatsAppMediaCarouselParams {
     }>;
 }
 interface DownloadWhatsAppMediaParams {
-    token: string;
+    channelToken: string;
     url: string;
 }
 interface SendTelegramTextParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     text: string;
     parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
@@ -370,7 +370,7 @@ interface SendTelegramTextParams {
     disableNotification?: boolean;
 }
 interface SendTelegramMediaParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     fileUrl: string;
     type: 'photo' | 'video' | 'audio' | 'document' | 'voice';
@@ -379,7 +379,7 @@ interface SendTelegramMediaParams {
     replyToMessageId?: number;
 }
 interface SendTelegramButtonsParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     text: string;
     buttons: Array<Array<{
@@ -393,14 +393,14 @@ interface SendTelegramButtonsParams {
     parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
 }
 interface SendTelegramLocationParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     latitude: number;
     longitude: number;
     livePeriod?: number;
 }
 interface SendTelegramContactParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     phoneNumber: string;
     firstName: string;
@@ -408,7 +408,7 @@ interface SendTelegramContactParams {
     vcard?: string;
 }
 interface SendTelegramPollParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     question: string;
     options: string[];
@@ -417,7 +417,7 @@ interface SendTelegramPollParams {
     correctOptionId?: number;
 }
 interface SendTelegramVenueParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     latitude: number;
     longitude: number;
@@ -426,31 +426,31 @@ interface SendTelegramVenueParams {
     foursquareId?: string;
 }
 interface SendTelegramDiceParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     emoji?: '🎲' | '🎯' | '🏀' | '⚽' | '🎳' | '🎰';
 }
 interface SendTelegramStickerParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     stickerUrl: string;
 }
 interface SendTelegramVoiceParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     voiceUrl: string;
     caption?: string;
     duration?: number;
 }
 interface SendTelegramVideoNoteParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     videoNoteUrl: string;
     duration?: number;
     length?: number;
 }
 interface SendTelegramMediaGroupParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     media: Array<{
         type: 'photo' | 'video';
@@ -459,7 +459,7 @@ interface SendTelegramMediaGroupParams {
     }>;
 }
 interface SendTelegramReplyKeyboardParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     text: string;
     keyboard: Array<Array<{
@@ -469,19 +469,19 @@ interface SendTelegramReplyKeyboardParams {
     oneTimeKeyboard?: boolean;
 }
 interface EditTelegramMessageParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     messageId: number;
     text: string;
     parseMode?: 'HTML' | 'Markdown' | 'MarkdownV2';
 }
 interface DeleteTelegramMessageParams {
-    token: string;
+    channelToken: string;
     chatId: string | number;
     messageId: number;
 }
 interface DownloadTelegramMediaParams {
-    token: string;
+    channelToken: string;
     fileId: string;
 }
 interface SendWebChatTextParams {
@@ -582,44 +582,44 @@ interface SendWebChatButtonsParams {
     typingTime?: number;
 }
 interface ListPostsParams {
-    token: string;
+    channelToken: string;
     pageId: string;
     limit?: number;
 }
 interface ListCommentsParams {
-    token: string;
+    channelToken: string;
     postId: string;
     limit?: number;
 }
 interface CreatePostParams {
-    token: string;
+    channelToken: string;
     pageId: string;
     message: string;
     link?: string;
 }
 interface ReplyCommentParams {
-    token: string;
+    channelToken: string;
     commentId: string;
     message: string;
 }
 interface DeleteCommentParams {
-    token: string;
+    channelToken: string;
     commentId: string;
 }
 interface SendFacebookTextParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     message: string;
 }
 interface SendFacebookMediaParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     fileUrl: string;
     type: 'image' | 'video' | 'audio' | 'file';
     caption?: string;
 }
 interface SendFacebookButtonsParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     message: string;
     buttons: Array<{
@@ -630,58 +630,59 @@ interface SendFacebookButtonsParams {
     }>;
 }
 interface SendFacebookStickerParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     stickerId: number;
 }
 interface ReplyFacebookMessageParams {
-    token: string;
+    channelToken: string;
     messageId: string;
     message: string;
 }
 interface ReplyFacebookMediaParams {
-    token: string;
+    channelToken: string;
     messageId: string;
     fileUrl: string;
     type: 'image' | 'video' | 'audio' | 'file';
     caption?: string;
 }
 interface SharePostParams {
-    token: string;
+    channelToken: string;
     mediaId: string;
     recipientId: string;
 }
 interface GetFacebookUserProfileParams {
-    token: string;
+    channelToken: string;
     userId: string;
 }
 interface GetFacebookPageProfileParams {
-    token: string;
+    channelToken: string;
     pageId: string;
 }
 interface DownloadFacebookMediaParams {
-    token: string;
+    channelToken: string;
     url: string;
 }
 interface SendInstagramPrivateReplyParams {
-    token: string;
+    channelToken: string;
     commentId: string;
     message: string;
 }
 interface SendInstagramTextParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
-    message: string;
+    text: string;
+    tags?: string[];
 }
 interface SendInstagramMediaParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     fileUrl: string;
     type: 'image' | 'video' | 'audio' | 'file';
     caption?: string;
 }
 interface SendInstagramImagesParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     images: Array<{
         url: string;
@@ -689,22 +690,22 @@ interface SendInstagramImagesParams {
     }>;
 }
 interface SendInstagramStickerParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     stickerType: 'like' | 'heart';
 }
 interface ReactInstagramMessageParams {
-    token: string;
+    channelToken: string;
     messageId: string;
     reactionType: 'like' | 'love' | 'wow' | 'haha' | 'sorry' | 'anger';
 }
 interface RemoveInstagramReactionParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     messageId: string;
 }
 interface SendInstagramQuickRepliesParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     message: string;
     quickReplies: Array<{
@@ -714,7 +715,7 @@ interface SendInstagramQuickRepliesParams {
     }>;
 }
 interface SendInstagramGenericTemplateParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     elements: Array<{
         title: string;
@@ -729,7 +730,7 @@ interface SendInstagramGenericTemplateParams {
     }>;
 }
 interface SendInstagramButtonTemplateParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     text: string;
     buttons: Array<{
@@ -740,30 +741,30 @@ interface SendInstagramButtonTemplateParams {
     }>;
 }
 interface SendInstagramSenderActionParams {
-    token: string;
+    channelToken: string;
     recipientId: string;
     action: 'typing_on' | 'typing_off' | 'mark_seen';
 }
 interface GetInstagramUserProfileParams {
-    token: string;
+    channelToken: string;
     userId: string;
 }
 interface ListInstagramPostsParams {
-    token: string;
+    channelToken: string;
     userId?: string;
     limit?: number;
 }
 interface GetInstagramBusinessProfileParams {
-    token: string;
+    channelToken: string;
 }
 interface DownloadInstagramMediaParams {
-    token: string;
+    channelToken: string;
     url: string;
 }
 type InstagramPublishMediaType = 'IMAGE' | 'VIDEO' | 'REELS' | 'STORIES' | 'CAROUSEL';
 type GraduationStrategy = 'MANUAL' | 'SS_PERFORMANCE';
 interface CreateInstagramMediaContainerParams {
-    token: string;
+    channelToken: string;
     image_url?: string;
     video_url?: string;
     media_type: InstagramPublishMediaType;
@@ -784,18 +785,18 @@ interface CreateInstagramMediaContainerParams {
     }>;
 }
 interface PublishInstagramMediaParams {
-    token: string;
+    channelToken: string;
     creation_id: string;
 }
 interface GetInstagramContainerStatusParams {
-    token: string;
+    channelToken: string;
     container_id: string;
 }
 interface GetInstagramPublishingLimitParams {
-    token: string;
+    channelToken: string;
 }
 interface UploadInstagramVideoParams {
-    token: string;
+    channelToken: string;
     container_id: string;
     file_url?: string;
     offset?: number;
@@ -953,14 +954,14 @@ declare class WhatsAppModule {
      * @param token Token do canal
      * @param accessToken Token de acesso do usuário
      */
-    listTemplates(token: string, accessToken: string): Promise<ApiResponse<any>>;
+    listTemplates(channelToken: string, accessToken: string): Promise<ApiResponse<any>>;
     /**
      * Obtém detalhes de um template
-     * @param token Token do canal
+     * @param channelToken Token do canal
      * @param templateId ID do template
      * @param accessToken Token de acesso do usuário
      */
-    getTemplate(token: string, templateId: string, accessToken: string): Promise<ApiResponse<any>>;
+    getTemplate(channelToken: string, templateId: string, accessToken: string): Promise<ApiResponse<any>>;
     /**
      * Faz upload de mídia para templates
      * @param params Parâmetros do upload
@@ -1452,7 +1453,7 @@ declare class InstagramModule {
  *
  * // Enviar mensagem WhatsApp
  * const result = await sdk.whatsapp.sendText({
- *   token: 'sk_live_...',
+ *   channelToken: 'sk_live_...',
  *   sender: '5511999999999',
  *   messageText: 'Olá!'
  * });