@zapyapi/sdk 1.0.0-beta.1 → 1.0.0-beta.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.
@@ -246,6 +246,48 @@ export interface NotFoundErrorDto {
246
246
  */
247
247
  path: string;
248
248
  }
249
+ export interface CheckNumbersRequestDto {
250
+ /**
251
+ * List of phone numbers to check (with country code, e.g., 5511999999999)
252
+ * @maxItems 100
253
+ * @minItems 1
254
+ * @example ["5511999999999","5521888888888"]
255
+ */
256
+ numbers: string[];
257
+ }
258
+ export interface CheckNumberResultDto {
259
+ /**
260
+ * The phone number that was checked
261
+ * @example "5511999999999"
262
+ */
263
+ number: string;
264
+ /**
265
+ * Whether the number is registered on WhatsApp
266
+ * @example true
267
+ */
268
+ exists: boolean;
269
+ /**
270
+ * The WhatsApp JID if the number exists
271
+ * @example "5511999999999@s.whatsapp.net"
272
+ */
273
+ jid?: string;
274
+ }
275
+ export interface CheckNumbersResponseDto {
276
+ /** Results for each number checked */
277
+ results: CheckNumberResultDto[];
278
+ }
279
+ export interface SendPresenceDto {
280
+ /**
281
+ * Recipient phone number or WhatsApp JID
282
+ * @example "5511999999999"
283
+ */
284
+ to: string;
285
+ /**
286
+ * Presence type to send
287
+ * @example "composing"
288
+ */
289
+ presence: "available" | "unavailable" | "composing" | "recording" | "paused";
290
+ }
249
291
  export interface WebhookConfigResponseDto {
250
292
  /**
251
293
  * Webhook configuration ID
@@ -517,6 +559,102 @@ export interface ReadMessageResponseDto {
517
559
  */
518
560
  messageId: string;
519
561
  }
562
+ export interface SendLocationDto {
563
+ /**
564
+ * WhatsApp number or group ID to send the location to
565
+ * @example "5511999999999@c.us"
566
+ */
567
+ to: string;
568
+ /**
569
+ * Latitude coordinate
570
+ * @min -90
571
+ * @max 90
572
+ * @example -23.5505199
573
+ */
574
+ latitude: number;
575
+ /**
576
+ * Longitude coordinate
577
+ * @min -180
578
+ * @max 180
579
+ * @example -46.6333094
580
+ */
581
+ longitude: number;
582
+ /**
583
+ * Location name/title
584
+ * @example "Paulista Avenue"
585
+ */
586
+ name?: string;
587
+ /**
588
+ * Full address of the location
589
+ * @example "Av. Paulista, 1578 - Bela Vista, São Paulo - SP"
590
+ */
591
+ address?: string;
592
+ /**
593
+ * Whatsapp Message ID of the message to quote/reply to
594
+ * @example "73C5222F61C8DB541672CE65D79C7E4B"
595
+ */
596
+ quoteMessageId?: string | null;
597
+ }
598
+ export interface ContactInfoDto {
599
+ /**
600
+ * Full name of the contact
601
+ * @example "John Doe"
602
+ */
603
+ fullName: string;
604
+ /**
605
+ * Phone number of the contact (with country code)
606
+ * @example "5511999999999"
607
+ */
608
+ phoneNumber: string;
609
+ /**
610
+ * Organization/company name
611
+ * @example "Acme Corp"
612
+ */
613
+ organization?: string;
614
+ }
615
+ export interface SendContactDto {
616
+ /**
617
+ * WhatsApp number or group ID to send the contact to
618
+ * @example "5511999999999@c.us"
619
+ */
620
+ to: string;
621
+ /** Contact information to send */
622
+ contact: ContactInfoDto;
623
+ /**
624
+ * Whatsapp Message ID of the message to quote/reply to
625
+ * @example "73C5222F61C8DB541672CE65D79C7E4B"
626
+ */
627
+ quoteMessageId?: string | null;
628
+ }
629
+ export interface SendStickerDto {
630
+ /**
631
+ * WhatsApp number or group ID to send the sticker to
632
+ * @example "5511999999999@c.us"
633
+ */
634
+ to: string;
635
+ /**
636
+ * Base64 encoded sticker (WebP format) or URL to the sticker image
637
+ * @example "https://example.com/sticker.webp"
638
+ */
639
+ sticker: string;
640
+ /**
641
+ * Whatsapp Message ID of the message to quote/reply to
642
+ * @example "73C5222F61C8DB541672CE65D79C7E4B"
643
+ */
644
+ quoteMessageId?: string;
645
+ }
646
+ export interface SendReactionDto {
647
+ /**
648
+ * WhatsApp Message ID to react to
649
+ * @example "3EB01CEDFD9A2E927BED83"
650
+ */
651
+ messageId: string;
652
+ /**
653
+ * Reaction emoji (empty string to remove reaction)
654
+ * @example "👍"
655
+ */
656
+ reaction: string;
657
+ }
520
658
  export interface DeleteMessageDto {
521
659
  /**
522
660
  * Whatsapp Message ID of the message to delete
@@ -586,6 +724,68 @@ export interface ManagerInstancesControllerDeleteInstanceParams {
586
724
  */
587
725
  instanceId: string;
588
726
  }
727
+ export interface ManagerInstancesControllerCheckNumbersParams {
728
+ /**
729
+ * Identificador da instância do WhatsApp
730
+ * @example "minha-instancia-whatsapp"
731
+ */
732
+ instanceId: string;
733
+ }
734
+ export interface ManagerInstancesControllerSendPresenceParams {
735
+ /**
736
+ * Identificador da instância do WhatsApp
737
+ * @example "minha-instancia-whatsapp"
738
+ */
739
+ instanceId: string;
740
+ }
741
+ export interface ManagerInstancesControllerGetProfilePictureParams {
742
+ /**
743
+ * Identificador da instância do WhatsApp
744
+ * @example "minha-instancia-whatsapp"
745
+ */
746
+ instanceId: string;
747
+ /**
748
+ * Número de telefone do contato
749
+ * @example "5511999999999"
750
+ */
751
+ phone: string;
752
+ }
753
+ export interface ManagerInstancesControllerBlockContactParams {
754
+ /**
755
+ * Identificador da instância do WhatsApp
756
+ * @example "minha-instancia-whatsapp"
757
+ */
758
+ instanceId: string;
759
+ /**
760
+ * Número de telefone do contato
761
+ * @example "5511999999999"
762
+ */
763
+ phone: string;
764
+ }
765
+ export interface ManagerInstancesControllerUnblockContactParams {
766
+ /**
767
+ * Identificador da instância do WhatsApp
768
+ * @example "minha-instancia-whatsapp"
769
+ */
770
+ instanceId: string;
771
+ /**
772
+ * Número de telefone do contato
773
+ * @example "5511999999999"
774
+ */
775
+ phone: string;
776
+ }
777
+ export interface ManagerInstancesControllerGetGroupMetadataParams {
778
+ /**
779
+ * Identificador da instância do WhatsApp
780
+ * @example "minha-instancia-whatsapp"
781
+ */
782
+ instanceId: string;
783
+ /**
784
+ * ID do grupo (JID ou número)
785
+ * @example "120363123456789012@g.us"
786
+ */
787
+ groupId: string;
788
+ }
589
789
  export interface SendMessageControllerSendTextMessageParams {
590
790
  /**
591
791
  * Identificador da instância do WhatsApp
@@ -649,6 +849,34 @@ export interface SendMessageControllerReadMessageParams {
649
849
  */
650
850
  instanceId: string;
651
851
  }
852
+ export interface SendMessageControllerSendLocationMessageParams {
853
+ /**
854
+ * Identificador da instância do WhatsApp
855
+ * @example "minha-instancia-whatsapp"
856
+ */
857
+ instanceId: string;
858
+ }
859
+ export interface SendMessageControllerSendContactMessageParams {
860
+ /**
861
+ * Identificador da instância do WhatsApp
862
+ * @example "minha-instancia-whatsapp"
863
+ */
864
+ instanceId: string;
865
+ }
866
+ export interface SendMessageControllerSendStickerMessageParams {
867
+ /**
868
+ * Identificador da instância do WhatsApp
869
+ * @example "minha-instancia-whatsapp"
870
+ */
871
+ instanceId: string;
872
+ }
873
+ export interface SendMessageControllerSendReactionParams {
874
+ /**
875
+ * Identificador da instância do WhatsApp
876
+ * @example "minha-instancia-whatsapp"
877
+ */
878
+ instanceId: string;
879
+ }
652
880
  export interface SendMessageControllerDeleteMessageParams {
653
881
  /**
654
882
  * Identificador da instância do WhatsApp
@@ -824,6 +1052,176 @@ export declare namespace Instances {
824
1052
  type RequestHeaders = {};
825
1053
  type ResponseBody = void;
826
1054
  }
1055
+ /**
1056
+ * @description Verifica se uma lista de números de telefone está registrada no WhatsApp
1057
+ * @tags Instâncias
1058
+ * @name ManagerInstancesControllerCheckNumbers
1059
+ * @summary Verificar Números no WhatsApp
1060
+ * @request POST:/api/instances/{instanceId}/check-numbers
1061
+ * @secure
1062
+ * @response `200` `CheckNumbersResponseDto` Números verificados com sucesso
1063
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1064
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1065
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1066
+ */
1067
+ namespace ManagerInstancesControllerCheckNumbers {
1068
+ type RequestParams = {
1069
+ /**
1070
+ * Identificador da instância do WhatsApp
1071
+ * @example "minha-instancia-whatsapp"
1072
+ */
1073
+ instanceId: string;
1074
+ };
1075
+ type RequestQuery = {};
1076
+ type RequestBody = CheckNumbersRequestDto;
1077
+ type RequestHeaders = {};
1078
+ type ResponseBody = CheckNumbersResponseDto;
1079
+ }
1080
+ /**
1081
+ * @description Envia um indicador de presença (digitando, gravando, online, etc.) para um contato
1082
+ * @tags Instâncias
1083
+ * @name ManagerInstancesControllerSendPresence
1084
+ * @summary Enviar Indicador de Presença
1085
+ * @request POST:/api/instances/{instanceId}/presence
1086
+ * @secure
1087
+ * @response `204` `void` Presença enviada com sucesso
1088
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1089
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1090
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1091
+ */
1092
+ namespace ManagerInstancesControllerSendPresence {
1093
+ type RequestParams = {
1094
+ /**
1095
+ * Identificador da instância do WhatsApp
1096
+ * @example "minha-instancia-whatsapp"
1097
+ */
1098
+ instanceId: string;
1099
+ };
1100
+ type RequestQuery = {};
1101
+ type RequestBody = SendPresenceDto;
1102
+ type RequestHeaders = {};
1103
+ type ResponseBody = void;
1104
+ }
1105
+ /**
1106
+ * @description Obtém a URL da foto de perfil de um contato
1107
+ * @tags Instâncias
1108
+ * @name ManagerInstancesControllerGetProfilePicture
1109
+ * @summary Obter Foto de Perfil
1110
+ * @request GET:/api/instances/{instanceId}/contacts/{phone}/profile-picture
1111
+ * @secure
1112
+ * @response `200` `void` Foto de perfil obtida com sucesso
1113
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1114
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1115
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1116
+ */
1117
+ namespace ManagerInstancesControllerGetProfilePicture {
1118
+ type RequestParams = {
1119
+ /**
1120
+ * Identificador da instância do WhatsApp
1121
+ * @example "minha-instancia-whatsapp"
1122
+ */
1123
+ instanceId: string;
1124
+ /**
1125
+ * Número de telefone do contato
1126
+ * @example "5511999999999"
1127
+ */
1128
+ phone: string;
1129
+ };
1130
+ type RequestQuery = {};
1131
+ type RequestBody = never;
1132
+ type RequestHeaders = {};
1133
+ type ResponseBody = void;
1134
+ }
1135
+ /**
1136
+ * @description Bloqueia um contato no WhatsApp
1137
+ * @tags Instâncias
1138
+ * @name ManagerInstancesControllerBlockContact
1139
+ * @summary Bloquear Contato
1140
+ * @request POST:/api/instances/{instanceId}/contacts/{phone}/block
1141
+ * @secure
1142
+ * @response `204` `void` Contato bloqueado com sucesso
1143
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1144
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1145
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1146
+ */
1147
+ namespace ManagerInstancesControllerBlockContact {
1148
+ type RequestParams = {
1149
+ /**
1150
+ * Identificador da instância do WhatsApp
1151
+ * @example "minha-instancia-whatsapp"
1152
+ */
1153
+ instanceId: string;
1154
+ /**
1155
+ * Número de telefone do contato
1156
+ * @example "5511999999999"
1157
+ */
1158
+ phone: string;
1159
+ };
1160
+ type RequestQuery = {};
1161
+ type RequestBody = never;
1162
+ type RequestHeaders = {};
1163
+ type ResponseBody = void;
1164
+ }
1165
+ /**
1166
+ * @description Desbloqueia um contato no WhatsApp
1167
+ * @tags Instâncias
1168
+ * @name ManagerInstancesControllerUnblockContact
1169
+ * @summary Desbloquear Contato
1170
+ * @request DELETE:/api/instances/{instanceId}/contacts/{phone}/block
1171
+ * @secure
1172
+ * @response `204` `void` Contato desbloqueado com sucesso
1173
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1174
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1175
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1176
+ */
1177
+ namespace ManagerInstancesControllerUnblockContact {
1178
+ type RequestParams = {
1179
+ /**
1180
+ * Identificador da instância do WhatsApp
1181
+ * @example "minha-instancia-whatsapp"
1182
+ */
1183
+ instanceId: string;
1184
+ /**
1185
+ * Número de telefone do contato
1186
+ * @example "5511999999999"
1187
+ */
1188
+ phone: string;
1189
+ };
1190
+ type RequestQuery = {};
1191
+ type RequestBody = never;
1192
+ type RequestHeaders = {};
1193
+ type ResponseBody = void;
1194
+ }
1195
+ /**
1196
+ * @description Obtém informações detalhadas sobre um grupo do WhatsApp
1197
+ * @tags Instâncias
1198
+ * @name ManagerInstancesControllerGetGroupMetadata
1199
+ * @summary Obter Metadados do Grupo
1200
+ * @request GET:/api/instances/{instanceId}/groups/{groupId}
1201
+ * @secure
1202
+ * @response `200` `void` Metadados do grupo obtidos com sucesso
1203
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1204
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1205
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1206
+ */
1207
+ namespace ManagerInstancesControllerGetGroupMetadata {
1208
+ type RequestParams = {
1209
+ /**
1210
+ * Identificador da instância do WhatsApp
1211
+ * @example "minha-instancia-whatsapp"
1212
+ */
1213
+ instanceId: string;
1214
+ /**
1215
+ * ID do grupo (JID ou número)
1216
+ * @example "120363123456789012@g.us"
1217
+ */
1218
+ groupId: string;
1219
+ };
1220
+ type RequestQuery = {};
1221
+ type RequestBody = never;
1222
+ type RequestHeaders = {};
1223
+ type ResponseBody = void;
1224
+ }
827
1225
  }
828
1226
  export declare namespace Webhooks {
829
1227
  /**
@@ -1130,6 +1528,102 @@ export declare namespace Message {
1130
1528
  type RequestHeaders = {};
1131
1529
  type ResponseBody = ReadMessageResponseDto;
1132
1530
  }
1531
+ /**
1532
+ * @description Envia uma localização geográfica para um contato ou grupo do WhatsApp
1533
+ * @tags Mensagens
1534
+ * @name SendMessageControllerSendLocationMessage
1535
+ * @summary Enviar Localização
1536
+ * @request POST:/api/message/{instanceId}/location
1537
+ * @secure
1538
+ * @response `201` `CommonSendMessageResponseDto` Localização enviada com sucesso
1539
+ * @response `400` `void` Dados da requisição inválidos
1540
+ * @response `404` `void` Instância do WhatsApp não encontrada
1541
+ */
1542
+ namespace SendMessageControllerSendLocationMessage {
1543
+ type RequestParams = {
1544
+ /**
1545
+ * Identificador da instância do WhatsApp
1546
+ * @example "minha-instancia-whatsapp"
1547
+ */
1548
+ instanceId: string;
1549
+ };
1550
+ type RequestQuery = {};
1551
+ type RequestBody = SendLocationDto;
1552
+ type RequestHeaders = {};
1553
+ type ResponseBody = CommonSendMessageResponseDto;
1554
+ }
1555
+ /**
1556
+ * @description Envia um cartão de contato para um contato ou grupo do WhatsApp
1557
+ * @tags Mensagens
1558
+ * @name SendMessageControllerSendContactMessage
1559
+ * @summary Enviar Contato
1560
+ * @request POST:/api/message/{instanceId}/contact
1561
+ * @secure
1562
+ * @response `201` `CommonSendMessageResponseDto` Contato enviado com sucesso
1563
+ * @response `400` `void` Dados da requisição inválidos
1564
+ * @response `404` `void` Instância do WhatsApp não encontrada
1565
+ */
1566
+ namespace SendMessageControllerSendContactMessage {
1567
+ type RequestParams = {
1568
+ /**
1569
+ * Identificador da instância do WhatsApp
1570
+ * @example "minha-instancia-whatsapp"
1571
+ */
1572
+ instanceId: string;
1573
+ };
1574
+ type RequestQuery = {};
1575
+ type RequestBody = SendContactDto;
1576
+ type RequestHeaders = {};
1577
+ type ResponseBody = CommonSendMessageResponseDto;
1578
+ }
1579
+ /**
1580
+ * @description Envia um sticker para um contato ou grupo do WhatsApp
1581
+ * @tags Mensagens
1582
+ * @name SendMessageControllerSendStickerMessage
1583
+ * @summary Enviar Sticker
1584
+ * @request POST:/api/message/{instanceId}/sticker
1585
+ * @secure
1586
+ * @response `201` `CommonSendMessageResponseDto` Sticker enviado com sucesso
1587
+ * @response `400` `void` Dados da requisição inválidos ou formato de sticker inválido
1588
+ * @response `404` `void` Instância do WhatsApp não encontrada
1589
+ */
1590
+ namespace SendMessageControllerSendStickerMessage {
1591
+ type RequestParams = {
1592
+ /**
1593
+ * Identificador da instância do WhatsApp
1594
+ * @example "minha-instancia-whatsapp"
1595
+ */
1596
+ instanceId: string;
1597
+ };
1598
+ type RequestQuery = {};
1599
+ type RequestBody = SendStickerDto;
1600
+ type RequestHeaders = {};
1601
+ type ResponseBody = CommonSendMessageResponseDto;
1602
+ }
1603
+ /**
1604
+ * @description Adiciona uma reação (emoji) a uma mensagem existente
1605
+ * @tags Mensagens
1606
+ * @name SendMessageControllerSendReaction
1607
+ * @summary Enviar Reação
1608
+ * @request POST:/api/message/{instanceId}/reaction
1609
+ * @secure
1610
+ * @response `204` `void` Reação enviada com sucesso
1611
+ * @response `400` `void` Dados da requisição inválidos
1612
+ * @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
1613
+ */
1614
+ namespace SendMessageControllerSendReaction {
1615
+ type RequestParams = {
1616
+ /**
1617
+ * Identificador da instância do WhatsApp
1618
+ * @example "minha-instancia-whatsapp"
1619
+ */
1620
+ instanceId: string;
1621
+ };
1622
+ type RequestQuery = {};
1623
+ type RequestBody = SendReactionDto;
1624
+ type RequestHeaders = {};
1625
+ type ResponseBody = void;
1626
+ }
1133
1627
  /**
1134
1628
  * @description Exclui uma mensagem para todos no chat
1135
1629
  * @tags Mensagens
@@ -1329,6 +1823,90 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1329
1823
  * @response `404` `NotFoundErrorDto` Recurso não encontrado
1330
1824
  */
1331
1825
  managerInstancesControllerDeleteInstance: ({ instanceId, ...query }: ManagerInstancesControllerDeleteInstanceParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1826
+ /**
1827
+ * @description Verifica se uma lista de números de telefone está registrada no WhatsApp
1828
+ *
1829
+ * @tags Instâncias
1830
+ * @name ManagerInstancesControllerCheckNumbers
1831
+ * @summary Verificar Números no WhatsApp
1832
+ * @request POST:/api/instances/{instanceId}/check-numbers
1833
+ * @secure
1834
+ * @response `200` `CheckNumbersResponseDto` Números verificados com sucesso
1835
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1836
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1837
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1838
+ */
1839
+ managerInstancesControllerCheckNumbers: ({ instanceId, ...query }: ManagerInstancesControllerCheckNumbersParams, data: CheckNumbersRequestDto, params?: RequestParams) => Promise<AxiosResponse<CheckNumbersResponseDto, any, {}>>;
1840
+ /**
1841
+ * @description Envia um indicador de presença (digitando, gravando, online, etc.) para um contato
1842
+ *
1843
+ * @tags Instâncias
1844
+ * @name ManagerInstancesControllerSendPresence
1845
+ * @summary Enviar Indicador de Presença
1846
+ * @request POST:/api/instances/{instanceId}/presence
1847
+ * @secure
1848
+ * @response `204` `void` Presença enviada com sucesso
1849
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1850
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1851
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1852
+ */
1853
+ managerInstancesControllerSendPresence: ({ instanceId, ...query }: ManagerInstancesControllerSendPresenceParams, data: SendPresenceDto, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1854
+ /**
1855
+ * @description Obtém a URL da foto de perfil de um contato
1856
+ *
1857
+ * @tags Instâncias
1858
+ * @name ManagerInstancesControllerGetProfilePicture
1859
+ * @summary Obter Foto de Perfil
1860
+ * @request GET:/api/instances/{instanceId}/contacts/{phone}/profile-picture
1861
+ * @secure
1862
+ * @response `200` `void` Foto de perfil obtida com sucesso
1863
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1864
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1865
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1866
+ */
1867
+ managerInstancesControllerGetProfilePicture: ({ instanceId, phone, ...query }: ManagerInstancesControllerGetProfilePictureParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1868
+ /**
1869
+ * @description Bloqueia um contato no WhatsApp
1870
+ *
1871
+ * @tags Instâncias
1872
+ * @name ManagerInstancesControllerBlockContact
1873
+ * @summary Bloquear Contato
1874
+ * @request POST:/api/instances/{instanceId}/contacts/{phone}/block
1875
+ * @secure
1876
+ * @response `204` `void` Contato bloqueado com sucesso
1877
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1878
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1879
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1880
+ */
1881
+ managerInstancesControllerBlockContact: ({ instanceId, phone, ...query }: ManagerInstancesControllerBlockContactParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1882
+ /**
1883
+ * @description Desbloqueia um contato no WhatsApp
1884
+ *
1885
+ * @tags Instâncias
1886
+ * @name ManagerInstancesControllerUnblockContact
1887
+ * @summary Desbloquear Contato
1888
+ * @request DELETE:/api/instances/{instanceId}/contacts/{phone}/block
1889
+ * @secure
1890
+ * @response `204` `void` Contato desbloqueado com sucesso
1891
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1892
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1893
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1894
+ */
1895
+ managerInstancesControllerUnblockContact: ({ instanceId, phone, ...query }: ManagerInstancesControllerUnblockContactParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1896
+ /**
1897
+ * @description Obtém informações detalhadas sobre um grupo do WhatsApp
1898
+ *
1899
+ * @tags Instâncias
1900
+ * @name ManagerInstancesControllerGetGroupMetadata
1901
+ * @summary Obter Metadados do Grupo
1902
+ * @request GET:/api/instances/{instanceId}/groups/{groupId}
1903
+ * @secure
1904
+ * @response `200` `void` Metadados do grupo obtidos com sucesso
1905
+ * @response `400` `BadRequestErrorDto` Dados da requisição inválidos
1906
+ * @response `403` `ForbiddenErrorDto` Acesso negado - Sem acesso ao recurso
1907
+ * @response `404` `NotFoundErrorDto` Recurso não encontrado
1908
+ */
1909
+ managerInstancesControllerGetGroupMetadata: ({ instanceId, groupId, ...query }: ManagerInstancesControllerGetGroupMetadataParams, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1332
1910
  };
1333
1911
  webhooks: {
1334
1912
  /**
@@ -1511,6 +2089,58 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1511
2089
  * @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
1512
2090
  */
1513
2091
  sendMessageControllerReadMessage: ({ instanceId, ...query }: SendMessageControllerReadMessageParams, data: ReadMessageDto, params?: RequestParams) => Promise<AxiosResponse<ReadMessageResponseDto, any, {}>>;
2092
+ /**
2093
+ * @description Envia uma localização geográfica para um contato ou grupo do WhatsApp
2094
+ *
2095
+ * @tags Mensagens
2096
+ * @name SendMessageControllerSendLocationMessage
2097
+ * @summary Enviar Localização
2098
+ * @request POST:/api/message/{instanceId}/location
2099
+ * @secure
2100
+ * @response `201` `CommonSendMessageResponseDto` Localização enviada com sucesso
2101
+ * @response `400` `void` Dados da requisição inválidos
2102
+ * @response `404` `void` Instância do WhatsApp não encontrada
2103
+ */
2104
+ sendMessageControllerSendLocationMessage: ({ instanceId, ...query }: SendMessageControllerSendLocationMessageParams, data: SendLocationDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
2105
+ /**
2106
+ * @description Envia um cartão de contato para um contato ou grupo do WhatsApp
2107
+ *
2108
+ * @tags Mensagens
2109
+ * @name SendMessageControllerSendContactMessage
2110
+ * @summary Enviar Contato
2111
+ * @request POST:/api/message/{instanceId}/contact
2112
+ * @secure
2113
+ * @response `201` `CommonSendMessageResponseDto` Contato enviado com sucesso
2114
+ * @response `400` `void` Dados da requisição inválidos
2115
+ * @response `404` `void` Instância do WhatsApp não encontrada
2116
+ */
2117
+ sendMessageControllerSendContactMessage: ({ instanceId, ...query }: SendMessageControllerSendContactMessageParams, data: SendContactDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
2118
+ /**
2119
+ * @description Envia um sticker para um contato ou grupo do WhatsApp
2120
+ *
2121
+ * @tags Mensagens
2122
+ * @name SendMessageControllerSendStickerMessage
2123
+ * @summary Enviar Sticker
2124
+ * @request POST:/api/message/{instanceId}/sticker
2125
+ * @secure
2126
+ * @response `201` `CommonSendMessageResponseDto` Sticker enviado com sucesso
2127
+ * @response `400` `void` Dados da requisição inválidos ou formato de sticker inválido
2128
+ * @response `404` `void` Instância do WhatsApp não encontrada
2129
+ */
2130
+ sendMessageControllerSendStickerMessage: ({ instanceId, ...query }: SendMessageControllerSendStickerMessageParams, data: SendStickerDto, params?: RequestParams) => Promise<AxiosResponse<CommonSendMessageResponseDto, any, {}>>;
2131
+ /**
2132
+ * @description Adiciona uma reação (emoji) a uma mensagem existente
2133
+ *
2134
+ * @tags Mensagens
2135
+ * @name SendMessageControllerSendReaction
2136
+ * @summary Enviar Reação
2137
+ * @request POST:/api/message/{instanceId}/reaction
2138
+ * @secure
2139
+ * @response `204` `void` Reação enviada com sucesso
2140
+ * @response `400` `void` Dados da requisição inválidos
2141
+ * @response `404` `void` Instância do WhatsApp ou mensagem não encontrada
2142
+ */
2143
+ sendMessageControllerSendReaction: ({ instanceId, ...query }: SendMessageControllerSendReactionParams, data: SendReactionDto, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
1514
2144
  /**
1515
2145
  * @description Exclui uma mensagem para todos no chat
1516
2146
  *