meta-cloud-api 0.2.12 → 0.2.14
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 +5 -2
- package/dist/api/index.d.mts +495 -27
- package/dist/api/index.mjs +1 -1
- package/dist/api/index.mjs.map +1 -1
- package/dist/chunk-KZQQJAPX.mjs +2 -0
- package/dist/chunk-KZQQJAPX.mjs.map +1 -0
- package/dist/chunk-N7A7DQDX.mjs +2 -0
- package/dist/chunk-N7A7DQDX.mjs.map +1 -0
- package/dist/chunk-QE4PKOSW.mjs +2 -0
- package/dist/chunk-QE4PKOSW.mjs.map +1 -0
- package/dist/chunk-R4CFE2XP.mjs +2 -0
- package/dist/chunk-R4CFE2XP.mjs.map +1 -0
- package/dist/chunk-XVYL7ZTG.mjs +2 -0
- package/dist/chunk-XVYL7ZTG.mjs.map +1 -0
- package/dist/index.d.mts +142 -43
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/dist/types/index.d.mts +512 -19
- package/dist/types/index.mjs +1 -1
- package/dist/types/index.mjs.map +1 -1
- package/dist/utils/index.d.mts +70 -21
- package/dist/utils/index.mjs +1 -1
- package/dist/utils/index.mjs.map +1 -1
- package/dist/waba-RRlZTQUG.d.mts +2229 -0
- package/dist/{types/whatsapp.d.ts → whatsapp-BNHXjrds.d.mts} +2 -17
- package/package.json +52 -18
- package/dist/api/base.d.mts +0 -15
- package/dist/api/base.d.ts +0 -15
- package/dist/api/base.js +0 -2
- package/dist/api/base.js.map +0 -1
- package/dist/api/base.mjs +0 -2
- package/dist/api/base.mjs.map +0 -1
- package/dist/api/businessProfile.d.mts +0 -145
- package/dist/api/businessProfile.d.ts +0 -145
- package/dist/api/businessProfile.js +0 -2
- package/dist/api/businessProfile.js.map +0 -1
- package/dist/api/businessProfile.mjs +0 -2
- package/dist/api/businessProfile.mjs.map +0 -1
- package/dist/api/encryption.d.mts +0 -15
- package/dist/api/encryption.d.ts +0 -15
- package/dist/api/encryption.js +0 -2
- package/dist/api/encryption.js.map +0 -1
- package/dist/api/encryption.mjs +0 -2
- package/dist/api/encryption.mjs.map +0 -1
- package/dist/api/flow.d.mts +0 -126
- package/dist/api/flow.d.ts +0 -126
- package/dist/api/flow.js +0 -2
- package/dist/api/flow.js.map +0 -1
- package/dist/api/flow.mjs +0 -2
- package/dist/api/flow.mjs.map +0 -1
- package/dist/api/index.d.ts +0 -28
- package/dist/api/index.js +0 -2
- package/dist/api/index.js.map +0 -1
- package/dist/api/media.d.mts +0 -17
- package/dist/api/media.d.ts +0 -17
- package/dist/api/media.js +0 -2
- package/dist/api/media.js.map +0 -1
- package/dist/api/media.mjs +0 -2
- package/dist/api/media.mjs.map +0 -1
- package/dist/api/messages.d.mts +0 -193
- package/dist/api/messages.d.ts +0 -193
- package/dist/api/messages.js +0 -2
- package/dist/api/messages.js.map +0 -1
- package/dist/api/messages.mjs +0 -2
- package/dist/api/messages.mjs.map +0 -1
- package/dist/api/phoneNumber.d.mts +0 -17
- package/dist/api/phoneNumber.d.ts +0 -17
- package/dist/api/phoneNumber.js +0 -2
- package/dist/api/phoneNumber.js.map +0 -1
- package/dist/api/phoneNumber.mjs +0 -2
- package/dist/api/phoneNumber.mjs.map +0 -1
- package/dist/api/qrCode.d.mts +0 -18
- package/dist/api/qrCode.d.ts +0 -18
- package/dist/api/qrCode.js +0 -2
- package/dist/api/qrCode.js.map +0 -1
- package/dist/api/qrCode.mjs +0 -2
- package/dist/api/qrCode.mjs.map +0 -1
- package/dist/api/registration.d.mts +0 -14
- package/dist/api/registration.d.ts +0 -14
- package/dist/api/registration.js +0 -2
- package/dist/api/registration.js.map +0 -1
- package/dist/api/registration.mjs +0 -2
- package/dist/api/registration.mjs.map +0 -1
- package/dist/api/template.d.mts +0 -18
- package/dist/api/template.d.ts +0 -18
- package/dist/api/template.js +0 -2
- package/dist/api/template.js.map +0 -1
- package/dist/api/template.mjs +0 -2
- package/dist/api/template.mjs.map +0 -1
- package/dist/api/twoStepVerification.d.mts +0 -13
- package/dist/api/twoStepVerification.d.ts +0 -13
- package/dist/api/twoStepVerification.js +0 -2
- package/dist/api/twoStepVerification.js.map +0 -1
- package/dist/api/twoStepVerification.mjs +0 -2
- package/dist/api/twoStepVerification.mjs.map +0 -1
- package/dist/api/waba.d.mts +0 -16
- package/dist/api/waba.d.ts +0 -16
- package/dist/api/waba.js +0 -2
- package/dist/api/waba.js.map +0 -1
- package/dist/api/waba.mjs +0 -2
- package/dist/api/waba.mjs.map +0 -1
- package/dist/enums-CI7vzKhn.d.mts +0 -687
- package/dist/enums-CI7vzKhn.d.ts +0 -687
- package/dist/httpsClient.d.mts +0 -22
- package/dist/httpsClient.d.ts +0 -22
- package/dist/httpsClient.js +0 -2
- package/dist/httpsClient.js.map +0 -1
- package/dist/httpsClient.mjs +0 -2
- package/dist/httpsClient.mjs.map +0 -1
- package/dist/index.d.ts +0 -46
- package/dist/index.js +0 -3
- package/dist/index.js.map +0 -1
- package/dist/request.d.mts +0 -25
- package/dist/request.d.ts +0 -25
- package/dist/request.js +0 -2
- package/dist/request.js.map +0 -1
- package/dist/request.mjs +0 -2
- package/dist/request.mjs.map +0 -1
- package/dist/types/base.d.mts +0 -8
- package/dist/types/base.d.ts +0 -8
- package/dist/types/base.js +0 -2
- package/dist/types/base.js.map +0 -1
- package/dist/types/base.mjs +0 -1
- package/dist/types/base.mjs.map +0 -1
- package/dist/types/businessProfile.d.mts +0 -153
- package/dist/types/businessProfile.d.ts +0 -153
- package/dist/types/businessProfile.js +0 -2
- package/dist/types/businessProfile.js.map +0 -1
- package/dist/types/businessProfile.mjs +0 -1
- package/dist/types/businessProfile.mjs.map +0 -1
- package/dist/types/config.d.mts +0 -62
- package/dist/types/config.d.ts +0 -62
- package/dist/types/config.js +0 -2
- package/dist/types/config.js.map +0 -1
- package/dist/types/config.mjs +0 -1
- package/dist/types/config.mjs.map +0 -1
- package/dist/types/encryption.d.mts +0 -13
- package/dist/types/encryption.d.ts +0 -13
- package/dist/types/encryption.js +0 -2
- package/dist/types/encryption.js.map +0 -1
- package/dist/types/encryption.mjs +0 -1
- package/dist/types/encryption.mjs.map +0 -1
- package/dist/types/enums.d.mts +0 -1
- package/dist/types/enums.d.ts +0 -1
- package/dist/types/enums.js +0 -2
- package/dist/types/enums.js.map +0 -1
- package/dist/types/enums.mjs +0 -2
- package/dist/types/enums.mjs.map +0 -1
- package/dist/types/flow.d.mts +0 -404
- package/dist/types/flow.d.ts +0 -404
- package/dist/types/flow.js +0 -2
- package/dist/types/flow.js.map +0 -1
- package/dist/types/flow.mjs +0 -2
- package/dist/types/flow.mjs.map +0 -1
- package/dist/types/httpsClient.d.mts +0 -19
- package/dist/types/httpsClient.d.ts +0 -19
- package/dist/types/httpsClient.js +0 -2
- package/dist/types/httpsClient.js.map +0 -1
- package/dist/types/httpsClient.mjs +0 -1
- package/dist/types/httpsClient.mjs.map +0 -1
- package/dist/types/index.d.ts +0 -20
- package/dist/types/index.js +0 -2
- package/dist/types/index.js.map +0 -1
- package/dist/types/logger.d.mts +0 -9
- package/dist/types/logger.d.ts +0 -9
- package/dist/types/logger.js +0 -2
- package/dist/types/logger.js.map +0 -1
- package/dist/types/logger.mjs +0 -1
- package/dist/types/logger.mjs.map +0 -1
- package/dist/types/media.d.mts +0 -31
- package/dist/types/media.d.ts +0 -31
- package/dist/types/media.js +0 -2
- package/dist/types/media.js.map +0 -1
- package/dist/types/media.mjs +0 -1
- package/dist/types/media.mjs.map +0 -1
- package/dist/types/messages.d.mts +0 -558
- package/dist/types/messages.d.ts +0 -558
- package/dist/types/messages.js +0 -2
- package/dist/types/messages.js.map +0 -1
- package/dist/types/messages.mjs +0 -1
- package/dist/types/messages.mjs.map +0 -1
- package/dist/types/phoneNumber.d.mts +0 -82
- package/dist/types/phoneNumber.d.ts +0 -82
- package/dist/types/phoneNumber.js +0 -2
- package/dist/types/phoneNumber.js.map +0 -1
- package/dist/types/phoneNumber.mjs +0 -1
- package/dist/types/phoneNumber.mjs.map +0 -1
- package/dist/types/qrCode.d.mts +0 -27
- package/dist/types/qrCode.d.ts +0 -27
- package/dist/types/qrCode.js +0 -2
- package/dist/types/qrCode.js.map +0 -1
- package/dist/types/qrCode.mjs +0 -1
- package/dist/types/qrCode.mjs.map +0 -1
- package/dist/types/registration.d.mts +0 -14
- package/dist/types/registration.d.ts +0 -14
- package/dist/types/registration.js +0 -2
- package/dist/types/registration.js.map +0 -1
- package/dist/types/registration.mjs +0 -1
- package/dist/types/registration.mjs.map +0 -1
- package/dist/types/request.d.mts +0 -50
- package/dist/types/request.d.ts +0 -50
- package/dist/types/request.js +0 -2
- package/dist/types/request.js.map +0 -1
- package/dist/types/request.mjs +0 -1
- package/dist/types/request.mjs.map +0 -1
- package/dist/types/template.d.mts +0 -106
- package/dist/types/template.d.ts +0 -106
- package/dist/types/template.js +0 -2
- package/dist/types/template.js.map +0 -1
- package/dist/types/template.mjs +0 -1
- package/dist/types/template.mjs.map +0 -1
- package/dist/types/twoStepVerification.d.mts +0 -11
- package/dist/types/twoStepVerification.d.ts +0 -11
- package/dist/types/twoStepVerification.js +0 -2
- package/dist/types/twoStepVerification.js.map +0 -1
- package/dist/types/twoStepVerification.mjs +0 -1
- package/dist/types/twoStepVerification.mjs.map +0 -1
- package/dist/types/waba.d.mts +0 -78
- package/dist/types/waba.d.ts +0 -78
- package/dist/types/waba.js +0 -2
- package/dist/types/waba.js.map +0 -1
- package/dist/types/waba.mjs +0 -2
- package/dist/types/waba.mjs.map +0 -1
- package/dist/types/webhook.d.mts +0 -486
- package/dist/types/webhook.d.ts +0 -486
- package/dist/types/webhook.js +0 -2
- package/dist/types/webhook.js.map +0 -1
- package/dist/types/webhook.mjs +0 -2
- package/dist/types/webhook.mjs.map +0 -1
- package/dist/types/whatsapp.d.mts +0 -61
- package/dist/types/whatsapp.js +0 -2
- package/dist/types/whatsapp.js.map +0 -1
- package/dist/types/whatsapp.mjs +0 -1
- package/dist/types/whatsapp.mjs.map +0 -1
- package/dist/utils/buildFieldsQueryString.d.mts +0 -3
- package/dist/utils/buildFieldsQueryString.d.ts +0 -3
- package/dist/utils/buildFieldsQueryString.js +0 -2
- package/dist/utils/buildFieldsQueryString.js.map +0 -1
- package/dist/utils/buildFieldsQueryString.mjs +0 -2
- package/dist/utils/buildFieldsQueryString.mjs.map +0 -1
- package/dist/utils/filters.d.mts +0 -144
- package/dist/utils/filters.d.ts +0 -144
- package/dist/utils/filters.js +0 -2
- package/dist/utils/filters.js.map +0 -1
- package/dist/utils/filters.mjs +0 -2
- package/dist/utils/filters.mjs.map +0 -1
- package/dist/utils/flowTypeGuards.d.mts +0 -46
- package/dist/utils/flowTypeGuards.d.ts +0 -46
- package/dist/utils/flowTypeGuards.js +0 -2
- package/dist/utils/flowTypeGuards.js.map +0 -1
- package/dist/utils/flowTypeGuards.mjs +0 -2
- package/dist/utils/flowTypeGuards.mjs.map +0 -1
- package/dist/utils/generateXHub256Sig.d.mts +0 -3
- package/dist/utils/generateXHub256Sig.d.ts +0 -3
- package/dist/utils/generateXHub256Sig.js +0 -2
- package/dist/utils/generateXHub256Sig.js.map +0 -1
- package/dist/utils/generateXHub256Sig.mjs +0 -2
- package/dist/utils/generateXHub256Sig.mjs.map +0 -1
- package/dist/utils/importConfig.d.mts +0 -21
- package/dist/utils/importConfig.d.ts +0 -21
- package/dist/utils/importConfig.js +0 -2
- package/dist/utils/importConfig.js.map +0 -1
- package/dist/utils/importConfig.mjs +0 -2
- package/dist/utils/importConfig.mjs.map +0 -1
- package/dist/utils/index.d.ts +0 -22
- package/dist/utils/index.js +0 -2
- package/dist/utils/index.js.map +0 -1
- package/dist/utils/isMetaError.d.mts +0 -21
- package/dist/utils/isMetaError.d.ts +0 -21
- package/dist/utils/isMetaError.js +0 -2
- package/dist/utils/isMetaError.js.map +0 -1
- package/dist/utils/isMetaError.mjs +0 -2
- package/dist/utils/isMetaError.mjs.map +0 -1
- package/dist/utils/logger.d.mts +0 -13
- package/dist/utils/logger.d.ts +0 -13
- package/dist/utils/logger.js +0 -2
- package/dist/utils/logger.js.map +0 -1
- package/dist/utils/logger.mjs +0 -2
- package/dist/utils/logger.mjs.map +0 -1
- package/dist/utils/objectToQueryString.d.mts +0 -3
- package/dist/utils/objectToQueryString.d.ts +0 -3
- package/dist/utils/objectToQueryString.js +0 -2
- package/dist/utils/objectToQueryString.js.map +0 -1
- package/dist/utils/objectToQueryString.mjs +0 -2
- package/dist/utils/objectToQueryString.mjs.map +0 -1
- package/dist/webhook.d.mts +0 -123
- package/dist/webhook.d.ts +0 -123
- package/dist/webhook.js +0 -3
- package/dist/webhook.js.map +0 -1
- package/dist/webhook.mjs +0 -3
- package/dist/webhook.mjs.map +0 -1
- package/dist/whatsapp.d.mts +0 -58
- package/dist/whatsapp.d.ts +0 -58
- package/dist/whatsapp.js +0 -2
- package/dist/whatsapp.js.map +0 -1
- package/dist/whatsapp.mjs +0 -2
- package/dist/whatsapp.mjs.map +0 -1
package/dist/types/messages.d.ts
DELETED
|
@@ -1,558 +0,0 @@
|
|
|
1
|
-
import { BaseClass } from './base.js';
|
|
2
|
-
import { I as InteractiveTypesEnum, b as ComponentTypesEnum, L as LanguagesEnum, P as ParametersTypesEnum, i as CurrencyCodesEnum, B as ButtonTypesEnum, a as ButtonPositionEnum, M as MessageTypesEnum } from '../enums-CI7vzKhn.js';
|
|
3
|
-
import { GeneralRequestBody } from './request.js';
|
|
4
|
-
import './config.js';
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
8
|
-
* All rights reserved.
|
|
9
|
-
*
|
|
10
|
-
* This source code is licensed under the license found in the
|
|
11
|
-
* LICENSE file in the root directory of this source tree.
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
type GeneralMessageBody = GeneralRequestBody & {
|
|
15
|
-
/**
|
|
16
|
-
* The Meta messaging product name.
|
|
17
|
-
* @default 'whatsapp'
|
|
18
|
-
*/
|
|
19
|
-
messaging_product: 'whatsapp';
|
|
20
|
-
};
|
|
21
|
-
type StatusObject = {
|
|
22
|
-
status: 'read';
|
|
23
|
-
message_id: string;
|
|
24
|
-
typing_indicator?: TypingIndicatorObject;
|
|
25
|
-
};
|
|
26
|
-
type TypingIndicatorObject = {
|
|
27
|
-
type: 'text';
|
|
28
|
-
};
|
|
29
|
-
type StatusRequestBody = GeneralMessageBody & StatusObject;
|
|
30
|
-
type ConTextObject = {
|
|
31
|
-
message_id: string;
|
|
32
|
-
};
|
|
33
|
-
type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {
|
|
34
|
-
recipient_type?: string;
|
|
35
|
-
to: string;
|
|
36
|
-
context?: ConTextObject;
|
|
37
|
-
type?: T;
|
|
38
|
-
};
|
|
39
|
-
type MetaAudioMediaObject = {
|
|
40
|
-
id: string;
|
|
41
|
-
link?: never;
|
|
42
|
-
};
|
|
43
|
-
type HostedAudioMediaObject = {
|
|
44
|
-
id?: never;
|
|
45
|
-
link: string;
|
|
46
|
-
};
|
|
47
|
-
type AudioMediaObject = MetaAudioMediaObject | HostedAudioMediaObject;
|
|
48
|
-
type AudioMessageRequestBody = MessageRequestBody<MessageTypesEnum.Audio> & {
|
|
49
|
-
[MessageTypesEnum.Audio]: [AudioMediaObject];
|
|
50
|
-
};
|
|
51
|
-
type AddressesObject = {
|
|
52
|
-
street?: string;
|
|
53
|
-
city?: string;
|
|
54
|
-
state?: string;
|
|
55
|
-
zip?: string;
|
|
56
|
-
country?: string;
|
|
57
|
-
country_code?: string;
|
|
58
|
-
type?: 'HOME' | 'WORK' | string;
|
|
59
|
-
};
|
|
60
|
-
type EmailObject = {
|
|
61
|
-
email?: string;
|
|
62
|
-
type?: 'HOME' | 'WORK' | string;
|
|
63
|
-
};
|
|
64
|
-
type NameObject = {
|
|
65
|
-
formatted_name: string;
|
|
66
|
-
first_name?: string;
|
|
67
|
-
last_name?: string;
|
|
68
|
-
middle_name?: string;
|
|
69
|
-
suffix?: string;
|
|
70
|
-
prefix?: string;
|
|
71
|
-
};
|
|
72
|
-
type OrgObject = {
|
|
73
|
-
company?: string;
|
|
74
|
-
department?: string;
|
|
75
|
-
title?: string;
|
|
76
|
-
};
|
|
77
|
-
type PhoneObject = {
|
|
78
|
-
phone?: 'PHONE_NUMBER';
|
|
79
|
-
type?: 'CELL' | 'MAIN' | 'IPHONE' | 'HOME' | 'WORK' | string;
|
|
80
|
-
wa_id?: string;
|
|
81
|
-
};
|
|
82
|
-
type URLObject = {
|
|
83
|
-
url?: string;
|
|
84
|
-
type?: 'HOME' | 'WORK' | string;
|
|
85
|
-
};
|
|
86
|
-
type ContactObject = {
|
|
87
|
-
addresses?: AddressesObject[];
|
|
88
|
-
birthday?: `${number}${number}${number}${number}-${number}${number}-${number}${number}`;
|
|
89
|
-
emails?: EmailObject[];
|
|
90
|
-
name: NameObject;
|
|
91
|
-
org?: OrgObject;
|
|
92
|
-
phones?: PhoneObject[];
|
|
93
|
-
urls?: URLObject[];
|
|
94
|
-
};
|
|
95
|
-
type ContactsMessageRequestBody = MessageRequestBody<MessageTypesEnum.Contacts> & {
|
|
96
|
-
[MessageTypesEnum.Contacts]: [ContactObject];
|
|
97
|
-
};
|
|
98
|
-
type MetaDocumentMediaObject = {
|
|
99
|
-
id: string;
|
|
100
|
-
link?: never;
|
|
101
|
-
caption?: string;
|
|
102
|
-
filename?: string;
|
|
103
|
-
};
|
|
104
|
-
type HostedDocumentMediaObject = {
|
|
105
|
-
id?: never;
|
|
106
|
-
link: string;
|
|
107
|
-
caption?: string;
|
|
108
|
-
filename?: string;
|
|
109
|
-
};
|
|
110
|
-
type DocumentMediaObject = MetaDocumentMediaObject | HostedDocumentMediaObject;
|
|
111
|
-
type DocumentMessageRequestBody = MessageRequestBody<MessageTypesEnum.Document> & {
|
|
112
|
-
[MessageTypesEnum.Document]: [DocumentMediaObject];
|
|
113
|
-
};
|
|
114
|
-
type MetaImageMediaObject = {
|
|
115
|
-
id: string;
|
|
116
|
-
link?: never;
|
|
117
|
-
caption?: string;
|
|
118
|
-
};
|
|
119
|
-
type HostedImageMediaObject = {
|
|
120
|
-
id?: never;
|
|
121
|
-
link: string;
|
|
122
|
-
caption?: string;
|
|
123
|
-
};
|
|
124
|
-
type ImageMediaObject = MetaImageMediaObject | HostedImageMediaObject;
|
|
125
|
-
type ImageMessageRequestBody = MessageRequestBody<MessageTypesEnum.Image> & {
|
|
126
|
-
[MessageTypesEnum.Image]: [ImageMediaObject];
|
|
127
|
-
};
|
|
128
|
-
type ProductObject = {
|
|
129
|
-
product_retailer_id: string;
|
|
130
|
-
};
|
|
131
|
-
type SimpleTextObject = {
|
|
132
|
-
text: string;
|
|
133
|
-
};
|
|
134
|
-
type RowObject = {
|
|
135
|
-
id: string;
|
|
136
|
-
title: string;
|
|
137
|
-
description?: string;
|
|
138
|
-
};
|
|
139
|
-
type MultiProductSectionObject = {
|
|
140
|
-
product_items: ProductObject[];
|
|
141
|
-
rows?: never;
|
|
142
|
-
title?: string;
|
|
143
|
-
};
|
|
144
|
-
type ListSectionObject = {
|
|
145
|
-
product_items?: never;
|
|
146
|
-
rows: RowObject[];
|
|
147
|
-
title?: string;
|
|
148
|
-
};
|
|
149
|
-
type SectionObject = MultiProductSectionObject | ListSectionObject;
|
|
150
|
-
type ButtonObject = {
|
|
151
|
-
title: string;
|
|
152
|
-
id: string;
|
|
153
|
-
};
|
|
154
|
-
type ReplyButtonObject = {
|
|
155
|
-
type: 'reply';
|
|
156
|
-
reply: ButtonObject;
|
|
157
|
-
};
|
|
158
|
-
type ActionObject = {
|
|
159
|
-
button?: string;
|
|
160
|
-
buttons?: ReplyButtonObject[];
|
|
161
|
-
catalog_id?: string;
|
|
162
|
-
product_retailer_id?: string;
|
|
163
|
-
sections?: SectionObject;
|
|
164
|
-
};
|
|
165
|
-
type HeaderObject = {
|
|
166
|
-
type: 'document' | 'image' | 'text' | 'video';
|
|
167
|
-
document?: DocumentMediaObject;
|
|
168
|
-
image?: ImageMediaObject;
|
|
169
|
-
text?: string;
|
|
170
|
-
video?: VideoMediaObject;
|
|
171
|
-
};
|
|
172
|
-
type ButtonInteractiveObject = {
|
|
173
|
-
type: InteractiveTypesEnum.Button;
|
|
174
|
-
body: SimpleTextObject;
|
|
175
|
-
footer?: SimpleTextObject;
|
|
176
|
-
header?: HeaderObject;
|
|
177
|
-
action: ActionObject;
|
|
178
|
-
};
|
|
179
|
-
type ListInteractiveObject = {
|
|
180
|
-
type: InteractiveTypesEnum.List;
|
|
181
|
-
body: SimpleTextObject;
|
|
182
|
-
footer?: SimpleTextObject;
|
|
183
|
-
header?: HeaderObject;
|
|
184
|
-
action: ActionObject;
|
|
185
|
-
};
|
|
186
|
-
type ProductInteractiveObject = {
|
|
187
|
-
type: InteractiveTypesEnum.Product;
|
|
188
|
-
body?: SimpleTextObject;
|
|
189
|
-
footer?: SimpleTextObject;
|
|
190
|
-
header?: HeaderObject;
|
|
191
|
-
action: ActionObject;
|
|
192
|
-
};
|
|
193
|
-
type ProductListInteractiveObject = {
|
|
194
|
-
type: InteractiveTypesEnum.ProductList;
|
|
195
|
-
body: SimpleTextObject;
|
|
196
|
-
footer?: SimpleTextObject;
|
|
197
|
-
header: HeaderObject;
|
|
198
|
-
action: ActionObject;
|
|
199
|
-
};
|
|
200
|
-
type CtaUrlParameters = {
|
|
201
|
-
display_text: string;
|
|
202
|
-
url: string;
|
|
203
|
-
};
|
|
204
|
-
type CtaUrlActionObject = {
|
|
205
|
-
name: 'cta_url';
|
|
206
|
-
parameters: CtaUrlParameters;
|
|
207
|
-
};
|
|
208
|
-
type CtaUrlInteractiveObject = {
|
|
209
|
-
type: InteractiveTypesEnum.CtaUrl;
|
|
210
|
-
body?: SimpleTextObject;
|
|
211
|
-
footer?: SimpleTextObject;
|
|
212
|
-
header?: HeaderObject;
|
|
213
|
-
action: CtaUrlActionObject;
|
|
214
|
-
};
|
|
215
|
-
type LocationRequestActionObject = {
|
|
216
|
-
name: 'send_location';
|
|
217
|
-
};
|
|
218
|
-
type LocationRequestInteractiveObject = {
|
|
219
|
-
type: InteractiveTypesEnum.LocationRequest;
|
|
220
|
-
body: SimpleTextObject;
|
|
221
|
-
footer?: SimpleTextObject;
|
|
222
|
-
header?: HeaderObject;
|
|
223
|
-
action: LocationRequestActionObject;
|
|
224
|
-
};
|
|
225
|
-
type AddressValues = {
|
|
226
|
-
name?: string;
|
|
227
|
-
phone_number?: string;
|
|
228
|
-
in_pin_code?: string;
|
|
229
|
-
house_number?: string;
|
|
230
|
-
floor_number?: string;
|
|
231
|
-
tower_number?: string;
|
|
232
|
-
building_name?: string;
|
|
233
|
-
address?: string;
|
|
234
|
-
landmark_area?: string;
|
|
235
|
-
city?: string;
|
|
236
|
-
state?: string;
|
|
237
|
-
};
|
|
238
|
-
type SavedAddress = {
|
|
239
|
-
id: string;
|
|
240
|
-
value: AddressValues;
|
|
241
|
-
};
|
|
242
|
-
type ValidationErrors = {
|
|
243
|
-
[key in keyof AddressValues]?: string;
|
|
244
|
-
};
|
|
245
|
-
type AddressMessageParameters = {
|
|
246
|
-
country: string;
|
|
247
|
-
values?: AddressValues;
|
|
248
|
-
saved_addresses?: SavedAddress[];
|
|
249
|
-
validation_errors?: ValidationErrors;
|
|
250
|
-
};
|
|
251
|
-
type AddressMessageActionObject = {
|
|
252
|
-
name: 'address_message';
|
|
253
|
-
parameters: AddressMessageParameters;
|
|
254
|
-
};
|
|
255
|
-
type AddressMessageInteractiveObject = {
|
|
256
|
-
type: InteractiveTypesEnum.AddressMessage;
|
|
257
|
-
body: SimpleTextObject;
|
|
258
|
-
footer?: SimpleTextObject;
|
|
259
|
-
header?: HeaderObject;
|
|
260
|
-
action: AddressMessageActionObject;
|
|
261
|
-
};
|
|
262
|
-
type FlowParameters = {
|
|
263
|
-
flow_message_version: string;
|
|
264
|
-
flow_id?: string;
|
|
265
|
-
flow_name?: string;
|
|
266
|
-
flow_cta: string;
|
|
267
|
-
mode?: 'draft' | 'published';
|
|
268
|
-
flow_token: string;
|
|
269
|
-
flow_action: 'navigate' | 'data_exchange';
|
|
270
|
-
flow_action_payload?: {
|
|
271
|
-
screen?: string;
|
|
272
|
-
data?: Record<string, string>;
|
|
273
|
-
};
|
|
274
|
-
};
|
|
275
|
-
type FlowActionObject = {
|
|
276
|
-
name: 'flow';
|
|
277
|
-
parameters: FlowParameters;
|
|
278
|
-
};
|
|
279
|
-
type FlowInteractiveObject = {
|
|
280
|
-
type: InteractiveTypesEnum.Flow;
|
|
281
|
-
body: SimpleTextObject;
|
|
282
|
-
footer?: SimpleTextObject;
|
|
283
|
-
header?: HeaderObject;
|
|
284
|
-
action: FlowActionObject;
|
|
285
|
-
};
|
|
286
|
-
type InteractiveObject = ButtonInteractiveObject | ListInteractiveObject | ProductInteractiveObject | ProductListInteractiveObject | CtaUrlInteractiveObject | LocationRequestInteractiveObject | AddressMessageInteractiveObject | FlowInteractiveObject;
|
|
287
|
-
type InteractiveMessageRequestBody = MessageRequestBody<MessageTypesEnum.Interactive> & {
|
|
288
|
-
[MessageTypesEnum.Interactive]: InteractiveObject;
|
|
289
|
-
};
|
|
290
|
-
type MetaStickerMediaObject = {
|
|
291
|
-
id: string;
|
|
292
|
-
link?: never;
|
|
293
|
-
};
|
|
294
|
-
type HostedStickerMediaObject = {
|
|
295
|
-
id?: never;
|
|
296
|
-
link: string;
|
|
297
|
-
};
|
|
298
|
-
type StickerMediaObject = MetaStickerMediaObject | HostedStickerMediaObject;
|
|
299
|
-
type StickerMessageRequestBody = MessageRequestBody<MessageTypesEnum.Sticker> & {
|
|
300
|
-
[MessageTypesEnum.Sticker]: [StickerMediaObject];
|
|
301
|
-
};
|
|
302
|
-
type ReActionObject = {
|
|
303
|
-
message_id: string;
|
|
304
|
-
emoji: string;
|
|
305
|
-
};
|
|
306
|
-
type ReactionMessageRequestBody = MessageRequestBody<MessageTypesEnum.Reaction> & ReActionObject;
|
|
307
|
-
type TextObject = {
|
|
308
|
-
body: string;
|
|
309
|
-
preview_url?: boolean;
|
|
310
|
-
};
|
|
311
|
-
type TextMessageRequestBody = MessageRequestBody<MessageTypesEnum.Text> & {
|
|
312
|
-
[MessageTypesEnum.Text]: [TextObject];
|
|
313
|
-
};
|
|
314
|
-
type MetaHostedVideoMediaObject = {
|
|
315
|
-
id: string;
|
|
316
|
-
link?: never;
|
|
317
|
-
caption?: string;
|
|
318
|
-
};
|
|
319
|
-
type SelfHostedVideoMediaObject = {
|
|
320
|
-
id?: never;
|
|
321
|
-
link: string;
|
|
322
|
-
caption?: string;
|
|
323
|
-
};
|
|
324
|
-
type VideoMediaObject = MetaHostedVideoMediaObject | SelfHostedVideoMediaObject;
|
|
325
|
-
type VideoMessageRequestBody = MessageRequestBody<MessageTypesEnum.Video> & {
|
|
326
|
-
[MessageTypesEnum.Video]: [VideoMediaObject];
|
|
327
|
-
};
|
|
328
|
-
type LanguageObject = {
|
|
329
|
-
policy: 'deterministic';
|
|
330
|
-
code: LanguagesEnum;
|
|
331
|
-
};
|
|
332
|
-
type ParametersObject<T extends ParametersTypesEnum> = {
|
|
333
|
-
type: T;
|
|
334
|
-
};
|
|
335
|
-
type TextParametersObject = ParametersObject<ParametersTypesEnum.Text> & SimpleTextObject;
|
|
336
|
-
type CurrencyObject = {
|
|
337
|
-
fallback_value: string;
|
|
338
|
-
code: CurrencyCodesEnum;
|
|
339
|
-
amount_1000: number;
|
|
340
|
-
};
|
|
341
|
-
type CurrencyParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {
|
|
342
|
-
currency: CurrencyObject;
|
|
343
|
-
};
|
|
344
|
-
type DateTimeObject = {
|
|
345
|
-
fallback_value: string;
|
|
346
|
-
};
|
|
347
|
-
type DateTimeParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {
|
|
348
|
-
date_time: DateTimeObject;
|
|
349
|
-
};
|
|
350
|
-
type DocumentParametersObject = ParametersObject<ParametersTypesEnum.Document> & DocumentMediaObject;
|
|
351
|
-
type ImageParametersObject = ParametersObject<ParametersTypesEnum.Image> & ImageMediaObject;
|
|
352
|
-
type VideoParametersObject = ParametersObject<ParametersTypesEnum.Video> & VideoMediaObject;
|
|
353
|
-
type QuickReplyButtonParametersObject = {
|
|
354
|
-
type: ParametersTypesEnum.Payload;
|
|
355
|
-
payload: string;
|
|
356
|
-
};
|
|
357
|
-
type URLButtonParametersObject = SimpleTextObject & {
|
|
358
|
-
type: ParametersTypesEnum.Text;
|
|
359
|
-
};
|
|
360
|
-
type ButtonParameterObject = QuickReplyButtonParametersObject | URLButtonParametersObject;
|
|
361
|
-
type ComponentObject<T extends ComponentTypesEnum> = {
|
|
362
|
-
type: T;
|
|
363
|
-
parameters: (CurrencyParametersObject | DateTimeParametersObject | DocumentParametersObject | ImageParametersObject | TextParametersObject | VideoParametersObject)[];
|
|
364
|
-
};
|
|
365
|
-
type ButtonComponentObject = ComponentObject<ComponentTypesEnum.Button> & {
|
|
366
|
-
parameters: ButtonParameterObject;
|
|
367
|
-
sub_type: ButtonTypesEnum;
|
|
368
|
-
index: ButtonPositionEnum;
|
|
369
|
-
};
|
|
370
|
-
type MessageTemplateObject<T extends ComponentTypesEnum> = {
|
|
371
|
-
name: string;
|
|
372
|
-
language: LanguageObject;
|
|
373
|
-
components?: (ComponentObject<T> | ButtonComponentObject)[];
|
|
374
|
-
};
|
|
375
|
-
type MessageTemplateRequestBody<T extends ComponentTypesEnum> = MessageRequestBody<MessageTypesEnum.Template> & MessageTemplateObject<T>;
|
|
376
|
-
type LocationObject = {
|
|
377
|
-
longitude: number;
|
|
378
|
-
latitude: number;
|
|
379
|
-
name?: string;
|
|
380
|
-
address?: string;
|
|
381
|
-
};
|
|
382
|
-
type LocationMessageRequestBody = MessageRequestBody<MessageTypesEnum.Location> & {
|
|
383
|
-
[MessageTypesEnum.Location]: [LocationObject];
|
|
384
|
-
};
|
|
385
|
-
type MessagesResponse = GeneralMessageBody & {
|
|
386
|
-
contacts: [
|
|
387
|
-
{
|
|
388
|
-
input: string;
|
|
389
|
-
wa_id: string;
|
|
390
|
-
}
|
|
391
|
-
];
|
|
392
|
-
messages: [
|
|
393
|
-
{
|
|
394
|
-
id: string;
|
|
395
|
-
}
|
|
396
|
-
];
|
|
397
|
-
};
|
|
398
|
-
interface MessageRequestParams<T> {
|
|
399
|
-
body: T;
|
|
400
|
-
to: string;
|
|
401
|
-
replyMessageId?: string;
|
|
402
|
-
}
|
|
403
|
-
interface TextMessageParams extends MessageRequestParams<TextObject | string> {
|
|
404
|
-
previewUrl?: boolean;
|
|
405
|
-
}
|
|
406
|
-
interface ReactionParams {
|
|
407
|
-
messageId: string;
|
|
408
|
-
emoji: string;
|
|
409
|
-
to: string;
|
|
410
|
-
}
|
|
411
|
-
interface StatusParams {
|
|
412
|
-
status: string;
|
|
413
|
-
messageId: string;
|
|
414
|
-
typingIndicator?: {
|
|
415
|
-
type: string;
|
|
416
|
-
};
|
|
417
|
-
}
|
|
418
|
-
declare class MessagesClass extends BaseClass {
|
|
419
|
-
/**
|
|
420
|
-
* Sends an audio message via WhatsApp
|
|
421
|
-
* @param params The audio message parameter object
|
|
422
|
-
* @returns Promise with the message response
|
|
423
|
-
*/
|
|
424
|
-
audio(params: MessageRequestParams<AudioMediaObject>): Promise<MessagesResponse>;
|
|
425
|
-
/**
|
|
426
|
-
* Sends a contact card via WhatsApp
|
|
427
|
-
* @param params The contact message parameter object
|
|
428
|
-
* @returns Promise with the message response
|
|
429
|
-
*/
|
|
430
|
-
contacts(params: MessageRequestParams<[ContactObject]>): Promise<MessagesResponse>;
|
|
431
|
-
/**
|
|
432
|
-
* Sends a document via WhatsApp
|
|
433
|
-
* @param params The document message parameter object
|
|
434
|
-
* @returns Promise with the message response
|
|
435
|
-
*/
|
|
436
|
-
document(params: MessageRequestParams<DocumentMediaObject>): Promise<MessagesResponse>;
|
|
437
|
-
/**
|
|
438
|
-
* Sends an image via WhatsApp
|
|
439
|
-
* @param params The image message parameter object
|
|
440
|
-
* @returns Promise with the message response
|
|
441
|
-
*/
|
|
442
|
-
image(params: MessageRequestParams<ImageMediaObject>): Promise<MessagesResponse>;
|
|
443
|
-
/**
|
|
444
|
-
* Sends an interactive message via WhatsApp
|
|
445
|
-
* @param params The interactive message parameter object
|
|
446
|
-
* @returns Promise with the message response
|
|
447
|
-
*/
|
|
448
|
-
interactive(params: MessageRequestParams<InteractiveObject>): Promise<MessagesResponse>;
|
|
449
|
-
/**
|
|
450
|
-
* Sends a location via WhatsApp
|
|
451
|
-
* @param params The location message parameter object
|
|
452
|
-
* @returns Promise with the message response
|
|
453
|
-
*/
|
|
454
|
-
location(params: MessageRequestParams<LocationObject>): Promise<MessagesResponse>;
|
|
455
|
-
/**
|
|
456
|
-
* Updates message status (used for read receipts and typing indicators)
|
|
457
|
-
* @param params The status update parameter object
|
|
458
|
-
* @returns Promise with the response
|
|
459
|
-
*/
|
|
460
|
-
status(params: StatusParams): Promise<MessagesResponse>;
|
|
461
|
-
/**
|
|
462
|
-
* Sends a sticker via WhatsApp
|
|
463
|
-
* @param params The sticker message parameter object
|
|
464
|
-
* @returns Promise with the message response
|
|
465
|
-
*/
|
|
466
|
-
sticker(params: MessageRequestParams<StickerMediaObject>): Promise<MessagesResponse>;
|
|
467
|
-
/**
|
|
468
|
-
* Sends a template message via WhatsApp
|
|
469
|
-
* @param params The template message parameter object
|
|
470
|
-
* @returns Promise with the message response
|
|
471
|
-
*/
|
|
472
|
-
template(params: MessageRequestParams<MessageTemplateObject<ComponentTypesEnum>>): Promise<MessagesResponse>;
|
|
473
|
-
/**
|
|
474
|
-
* Sends a text message via WhatsApp
|
|
475
|
-
* @param params The text message parameter object
|
|
476
|
-
* @returns Promise with the message response
|
|
477
|
-
*/
|
|
478
|
-
text(params: TextMessageParams): Promise<MessagesResponse>;
|
|
479
|
-
/**
|
|
480
|
-
* Sends a video via WhatsApp
|
|
481
|
-
* @param params The video message parameter object
|
|
482
|
-
* @returns Promise with the message response
|
|
483
|
-
*/
|
|
484
|
-
video(params: MessageRequestParams<VideoMediaObject>): Promise<MessagesResponse>;
|
|
485
|
-
/**
|
|
486
|
-
* Marks a message as read in WhatsApp
|
|
487
|
-
* @param params The parameter object to mark message as read
|
|
488
|
-
* @returns Promise with the response
|
|
489
|
-
*/
|
|
490
|
-
markAsRead(params: {
|
|
491
|
-
messageId: string;
|
|
492
|
-
}): Promise<MessagesResponse>;
|
|
493
|
-
/**
|
|
494
|
-
* Marks a message as read and shows a typing indicator in WhatsApp
|
|
495
|
-
* @param params The typing indicator parameter object
|
|
496
|
-
* @returns Promise with the response
|
|
497
|
-
*/
|
|
498
|
-
showTypingIndicator(params: {
|
|
499
|
-
messageId: string;
|
|
500
|
-
}): Promise<MessagesResponse>;
|
|
501
|
-
/**
|
|
502
|
-
* Sends an interactive list message
|
|
503
|
-
* @param params The list message parameter object
|
|
504
|
-
* @returns Promise with the response
|
|
505
|
-
*/
|
|
506
|
-
interactiveList(params: MessageRequestParams<InteractiveObject & {
|
|
507
|
-
type: InteractiveTypesEnum.List;
|
|
508
|
-
}>): Promise<MessagesResponse>;
|
|
509
|
-
/**
|
|
510
|
-
* Sends an interactive CTA URL message
|
|
511
|
-
* @param params The CTA URL message parameter object
|
|
512
|
-
* @returns Promise with the response
|
|
513
|
-
*/
|
|
514
|
-
interactiveCtaUrl(params: MessageRequestParams<InteractiveObject & {
|
|
515
|
-
type: InteractiveTypesEnum.CtaUrl;
|
|
516
|
-
}>): Promise<MessagesResponse>;
|
|
517
|
-
/**
|
|
518
|
-
* Sends a location request message
|
|
519
|
-
* @param params The location request message parameter object
|
|
520
|
-
* @returns Promise with the response
|
|
521
|
-
*/
|
|
522
|
-
interactiveLocationRequest(params: MessageRequestParams<InteractiveObject & {
|
|
523
|
-
type: InteractiveTypesEnum.LocationRequest;
|
|
524
|
-
}>): Promise<MessagesResponse>;
|
|
525
|
-
/**
|
|
526
|
-
* Sends an address message to request shipping address from the user
|
|
527
|
-
* Note: This feature is only available for businesses based in India and their India customers
|
|
528
|
-
* @param params The address message parameter object
|
|
529
|
-
* @returns Promise with the response
|
|
530
|
-
*/
|
|
531
|
-
interactiveAddressMessage(params: MessageRequestParams<InteractiveObject & {
|
|
532
|
-
type: InteractiveTypesEnum.AddressMessage;
|
|
533
|
-
}>): Promise<MessagesResponse>;
|
|
534
|
-
/**
|
|
535
|
-
* Sends an interactive reply buttons message
|
|
536
|
-
* @param params The reply buttons message parameter object
|
|
537
|
-
* @returns Promise with the response
|
|
538
|
-
*/
|
|
539
|
-
interactiveReplyButtons(params: MessageRequestParams<InteractiveObject & {
|
|
540
|
-
type: InteractiveTypesEnum.Button;
|
|
541
|
-
}>): Promise<MessagesResponse>;
|
|
542
|
-
/**
|
|
543
|
-
* Sends a reaction to a message (emoji response)
|
|
544
|
-
* @param params The reaction message parameter object
|
|
545
|
-
* @returns Promise with the response
|
|
546
|
-
*/
|
|
547
|
-
reaction(params: ReactionParams): Promise<MessagesResponse>;
|
|
548
|
-
/**
|
|
549
|
-
* Sends an interactive Flow message
|
|
550
|
-
* @param params The Flow message parameter object
|
|
551
|
-
* @returns Promise with the response
|
|
552
|
-
*/
|
|
553
|
-
interactiveFlow(params: MessageRequestParams<InteractiveObject & {
|
|
554
|
-
type: InteractiveTypesEnum.Flow;
|
|
555
|
-
}>): Promise<MessagesResponse>;
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
export { type AudioMediaObject, type AudioMessageRequestBody, type ContactObject, type ContactsMessageRequestBody, type DocumentMediaObject, type DocumentMessageRequestBody, type GeneralMessageBody, type ImageMediaObject, type ImageMessageRequestBody, type InteractiveMessageRequestBody, type InteractiveObject, type LocationMessageRequestBody, type LocationObject, type MessageRequestBody, type MessageRequestParams, type MessageTemplateObject, type MessageTemplateRequestBody, MessagesClass, type MessagesResponse, type ReactionMessageRequestBody, type ReactionParams, type StatusObject, type StatusParams, type StatusRequestBody, type StickerMediaObject, type StickerMessageRequestBody, type TextMessageParams, type TextMessageRequestBody, type TextObject, type TypingIndicatorObject, type VideoMediaObject, type VideoMessageRequestBody };
|
package/dist/types/messages.js
DELETED
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
"use strict";var r=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var o=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var p=(t,e,n,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of o(e))!c.call(t,s)&&s!==n&&r(t,s,{get:()=>e[s],enumerable:!(a=i(e,s))||a.enumerable});return t};var m=t=>p(r({},"__esModule",{value:!0}),t);var d={};module.exports=m(d);
|
|
2
|
-
//# sourceMappingURL=messages.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/types/messages.ts"],"sourcesContent":["/**\n * Copyright (c) Meta Platforms, Inc. and affiliates.\n * All rights reserved.\n *\n * This source code is licensed under the license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport { BaseClass } from './base';\nimport {\n ButtonPositionEnum,\n ButtonTypesEnum,\n ComponentTypesEnum,\n CurrencyCodesEnum,\n InteractiveTypesEnum,\n LanguagesEnum,\n MessageTypesEnum,\n ParametersTypesEnum,\n} from './enums';\nimport { GeneralRequestBody, RequesterResponseInterface } from './request';\n\nexport type GeneralMessageBody = GeneralRequestBody & {\n /**\n * The Meta messaging product name.\n * @default 'whatsapp'\n */\n messaging_product: 'whatsapp';\n};\n\nexport type StatusObject = {\n status: 'read';\n message_id: string;\n typing_indicator?: TypingIndicatorObject;\n};\n\nexport type TypingIndicatorObject = {\n type: 'text';\n};\n\nexport type StatusRequestBody = GeneralMessageBody & StatusObject;\n\ntype ConTextObject = {\n message_id: string;\n};\n\nexport type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {\n recipient_type?: string;\n to: string;\n context?: ConTextObject;\n type?: T;\n};\n\ntype MetaAudioMediaObject = {\n id: string;\n link?: never;\n};\n\ntype HostedAudioMediaObject = {\n id?: never;\n link: string;\n};\n\nexport type AudioMediaObject = MetaAudioMediaObject | HostedAudioMediaObject;\n\nexport type AudioMessageRequestBody = MessageRequestBody<MessageTypesEnum.Audio> & {\n [MessageTypesEnum.Audio]: [AudioMediaObject];\n};\n\ntype AddressesObject = {\n street?: string;\n city?: string;\n state?: string;\n zip?: string;\n country?: string;\n country_code?: string;\n type?: 'HOME' | 'WORK' | string;\n};\n\ntype EmailObject = {\n email?: string;\n type?: 'HOME' | 'WORK' | string;\n};\n\ntype NameObject = {\n formatted_name: string;\n first_name?: string;\n last_name?: string;\n middle_name?: string;\n suffix?: string;\n prefix?: string;\n};\n\ntype OrgObject = {\n company?: string;\n department?: string;\n title?: string;\n};\n\ntype PhoneObject = {\n phone?: 'PHONE_NUMBER';\n type?: 'CELL' | 'MAIN' | 'IPHONE' | 'HOME' | 'WORK' | string;\n wa_id?: string;\n};\n\ntype URLObject = {\n url?: string;\n type?: 'HOME' | 'WORK' | string;\n};\n\nexport type ContactObject = {\n addresses?: AddressesObject[];\n birthday?: `${number}${number}${number}${number}-${number}${number}-${number}${number}`;\n emails?: EmailObject[];\n name: NameObject;\n org?: OrgObject;\n phones?: PhoneObject[];\n urls?: URLObject[];\n};\n\nexport type ContactsMessageRequestBody = MessageRequestBody<MessageTypesEnum.Contacts> & {\n [MessageTypesEnum.Contacts]: [ContactObject];\n};\n\ntype MetaDocumentMediaObject = {\n id: string;\n link?: never;\n caption?: string;\n filename?: string;\n};\n\ntype HostedDocumentMediaObject = {\n id?: never;\n link: string;\n caption?: string;\n filename?: string;\n};\n\nexport type DocumentMediaObject = MetaDocumentMediaObject | HostedDocumentMediaObject;\n\nexport type DocumentMessageRequestBody = MessageRequestBody<MessageTypesEnum.Document> & {\n [MessageTypesEnum.Document]: [DocumentMediaObject];\n};\n\ntype MetaImageMediaObject = {\n id: string;\n link?: never;\n caption?: string;\n};\n\ntype HostedImageMediaObject = {\n id?: never;\n link: string;\n caption?: string;\n};\n\nexport type ImageMediaObject = MetaImageMediaObject | HostedImageMediaObject;\n\nexport type ImageMessageRequestBody = MessageRequestBody<MessageTypesEnum.Image> & {\n [MessageTypesEnum.Image]: [ImageMediaObject];\n};\n\ntype ProductObject = {\n product_retailer_id: string;\n};\n\ntype SimpleTextObject = {\n text: string;\n};\n\ntype RowObject = {\n id: string;\n title: string;\n description?: string;\n};\n\ntype MultiProductSectionObject = {\n product_items: ProductObject[];\n rows?: never;\n title?: string;\n};\n\ntype ListSectionObject = {\n product_items?: never;\n rows: RowObject[];\n title?: string;\n};\n\ntype SectionObject = MultiProductSectionObject | ListSectionObject;\n\ntype ButtonObject = {\n title: string;\n id: string;\n};\n\ntype ReplyButtonObject = {\n type: 'reply';\n reply: ButtonObject;\n};\n\ntype ActionObject = {\n button?: string;\n buttons?: ReplyButtonObject[];\n catalog_id?: string;\n product_retailer_id?: string;\n sections?: SectionObject;\n};\n\ntype HeaderObject = {\n type: 'document' | 'image' | 'text' | 'video';\n document?: DocumentMediaObject;\n image?: ImageMediaObject;\n text?: string;\n video?: VideoMediaObject;\n};\n\ntype ButtonInteractiveObject = {\n type: InteractiveTypesEnum.Button;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: ActionObject;\n};\n\ntype ListInteractiveObject = {\n type: InteractiveTypesEnum.List;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: ActionObject;\n};\n\ntype ProductInteractiveObject = {\n type: InteractiveTypesEnum.Product;\n body?: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: ActionObject;\n};\n\ntype ProductListInteractiveObject = {\n type: InteractiveTypesEnum.ProductList;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header: HeaderObject;\n action: ActionObject;\n};\n\ntype CtaUrlParameters = {\n display_text: string;\n url: string;\n};\n\ntype CtaUrlActionObject = {\n name: 'cta_url';\n parameters: CtaUrlParameters;\n};\n\ntype CtaUrlInteractiveObject = {\n type: InteractiveTypesEnum.CtaUrl;\n body?: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: CtaUrlActionObject;\n};\n\ntype LocationRequestActionObject = {\n name: 'send_location';\n};\n\ntype LocationRequestInteractiveObject = {\n type: InteractiveTypesEnum.LocationRequest;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: LocationRequestActionObject;\n};\n\n// Address message types\ntype AddressValues = {\n name?: string;\n phone_number?: string;\n in_pin_code?: string;\n house_number?: string;\n floor_number?: string;\n tower_number?: string;\n building_name?: string;\n address?: string;\n landmark_area?: string;\n city?: string;\n state?: string;\n};\n\ntype SavedAddress = {\n id: string;\n value: AddressValues;\n};\n\ntype ValidationErrors = {\n [key in keyof AddressValues]?: string;\n};\n\ntype AddressMessageParameters = {\n country: string; // ISO country code, e.g., \"IN\" for India\n values?: AddressValues;\n saved_addresses?: SavedAddress[];\n validation_errors?: ValidationErrors;\n};\n\ntype AddressMessageActionObject = {\n name: 'address_message';\n parameters: AddressMessageParameters;\n};\n\ntype AddressMessageInteractiveObject = {\n type: InteractiveTypesEnum.AddressMessage;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: AddressMessageActionObject;\n};\n\ntype FlowParameters = {\n flow_message_version: string;\n flow_id?: string;\n flow_name?: string;\n flow_cta: string;\n mode?: 'draft' | 'published';\n flow_token: string;\n flow_action: 'navigate' | 'data_exchange';\n flow_action_payload?: {\n screen?: string;\n data?: Record<string, string>;\n };\n};\n\ntype FlowActionObject = {\n name: 'flow';\n parameters: FlowParameters;\n};\n\ntype FlowInteractiveObject = {\n type: InteractiveTypesEnum.Flow;\n body: SimpleTextObject;\n footer?: SimpleTextObject;\n header?: HeaderObject;\n action: FlowActionObject;\n};\n\n// Update InteractiveObject type\nexport type InteractiveObject =\n | ButtonInteractiveObject\n | ListInteractiveObject\n | ProductInteractiveObject\n | ProductListInteractiveObject\n | CtaUrlInteractiveObject\n | LocationRequestInteractiveObject\n | AddressMessageInteractiveObject\n | FlowInteractiveObject;\n\nexport type InteractiveMessageRequestBody = MessageRequestBody<MessageTypesEnum.Interactive> & {\n [MessageTypesEnum.Interactive]: InteractiveObject;\n};\n\ntype MetaStickerMediaObject = {\n id: string;\n link?: never;\n};\n\ntype HostedStickerMediaObject = {\n id?: never;\n link: string;\n};\n\nexport type StickerMediaObject = MetaStickerMediaObject | HostedStickerMediaObject;\n\nexport type StickerMessageRequestBody = MessageRequestBody<MessageTypesEnum.Sticker> & {\n [MessageTypesEnum.Sticker]: [StickerMediaObject];\n};\n\ntype ReActionObject = {\n message_id: string;\n emoji: string;\n};\n\nexport type ReactionMessageRequestBody = MessageRequestBody<MessageTypesEnum.Reaction> & ReActionObject;\n\nexport type TextObject = {\n body: string;\n preview_url?: boolean;\n};\n\nexport type TextMessageRequestBody = MessageRequestBody<MessageTypesEnum.Text> & {\n [MessageTypesEnum.Text]: [TextObject];\n};\n\ntype MetaHostedVideoMediaObject = {\n id: string;\n link?: never;\n caption?: string;\n};\n\ntype SelfHostedVideoMediaObject = {\n id?: never;\n link: string;\n caption?: string;\n};\n\nexport type VideoMediaObject = MetaHostedVideoMediaObject | SelfHostedVideoMediaObject;\n\nexport type VideoMessageRequestBody = MessageRequestBody<MessageTypesEnum.Video> & {\n [MessageTypesEnum.Video]: [VideoMediaObject];\n};\n\ntype LanguageObject = {\n policy: 'deterministic';\n code: LanguagesEnum;\n};\n\ntype ParametersObject<T extends ParametersTypesEnum> = {\n type: T;\n};\n\ntype TextParametersObject = ParametersObject<ParametersTypesEnum.Text> & SimpleTextObject;\n\ntype CurrencyObject = {\n fallback_value: string;\n code: CurrencyCodesEnum;\n amount_1000: number;\n};\n\ntype CurrencyParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {\n currency: CurrencyObject;\n};\n\ntype DateTimeObject = {\n fallback_value: string;\n};\n\ntype DateTimeParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {\n date_time: DateTimeObject;\n};\n\ntype DocumentParametersObject = ParametersObject<ParametersTypesEnum.Document> & DocumentMediaObject;\n\ntype ImageParametersObject = ParametersObject<ParametersTypesEnum.Image> & ImageMediaObject;\n\ntype VideoParametersObject = ParametersObject<ParametersTypesEnum.Video> & VideoMediaObject;\n\ntype QuickReplyButtonParametersObject = {\n type: ParametersTypesEnum.Payload;\n payload: string;\n};\n\ntype URLButtonParametersObject = SimpleTextObject & {\n type: ParametersTypesEnum.Text;\n};\n\ntype ButtonParameterObject = QuickReplyButtonParametersObject | URLButtonParametersObject;\n\ntype ComponentObject<T extends ComponentTypesEnum> = {\n type: T;\n parameters: (\n | CurrencyParametersObject\n | DateTimeParametersObject\n | DocumentParametersObject\n | ImageParametersObject\n | TextParametersObject\n | VideoParametersObject\n )[];\n};\n\ntype ButtonComponentObject = ComponentObject<ComponentTypesEnum.Button> & {\n parameters: ButtonParameterObject;\n sub_type: ButtonTypesEnum;\n index: ButtonPositionEnum;\n};\n\nexport type MessageTemplateObject<T extends ComponentTypesEnum> = {\n name: string;\n language: LanguageObject;\n components?: (ComponentObject<T> | ButtonComponentObject)[];\n};\n\nexport type MessageTemplateRequestBody<T extends ComponentTypesEnum> = MessageRequestBody<MessageTypesEnum.Template> &\n MessageTemplateObject<T>;\n\nexport type LocationObject = {\n longitude: number;\n latitude: number;\n name?: string;\n address?: string;\n};\n\nexport type LocationMessageRequestBody = MessageRequestBody<MessageTypesEnum.Location> & {\n [MessageTypesEnum.Location]: [LocationObject];\n};\n\nexport type MessagesResponse = GeneralMessageBody & {\n contacts: [\n {\n input: string;\n wa_id: string;\n },\n ];\n messages: [\n {\n id: string;\n },\n ];\n};\n\n// Request parameter interface definitions\nexport interface MessageRequestParams<T> {\n body: T;\n to: string;\n replyMessageId?: string;\n}\n\nexport interface TextMessageParams extends MessageRequestParams<TextObject | string> {\n previewUrl?: boolean;\n}\n\nexport interface ReactionParams {\n messageId: string;\n emoji: string;\n to: string;\n}\n\nexport interface StatusParams {\n status: string;\n messageId: string;\n typingIndicator?: {\n type: string;\n };\n}\n\nexport declare class MessagesClass extends BaseClass {\n /**\n * Sends an audio message via WhatsApp\n * @param params The audio message parameter object\n * @returns Promise with the message response\n */\n audio(params: MessageRequestParams<AudioMediaObject>): Promise<MessagesResponse>;\n\n /**\n * Sends a contact card via WhatsApp\n * @param params The contact message parameter object\n * @returns Promise with the message response\n */\n contacts(params: MessageRequestParams<[ContactObject]>): Promise<MessagesResponse>;\n\n /**\n * Sends a document via WhatsApp\n * @param params The document message parameter object\n * @returns Promise with the message response\n */\n document(params: MessageRequestParams<DocumentMediaObject>): Promise<MessagesResponse>;\n\n /**\n * Sends an image via WhatsApp\n * @param params The image message parameter object\n * @returns Promise with the message response\n */\n image(params: MessageRequestParams<ImageMediaObject>): Promise<MessagesResponse>;\n\n /**\n * Sends an interactive message via WhatsApp\n * @param params The interactive message parameter object\n * @returns Promise with the message response\n */\n interactive(params: MessageRequestParams<InteractiveObject>): Promise<MessagesResponse>;\n\n /**\n * Sends a location via WhatsApp\n * @param params The location message parameter object\n * @returns Promise with the message response\n */\n location(params: MessageRequestParams<LocationObject>): Promise<MessagesResponse>;\n\n /**\n * Updates message status (used for read receipts and typing indicators)\n * @param params The status update parameter object\n * @returns Promise with the response\n */\n status(params: StatusParams): Promise<MessagesResponse>;\n\n /**\n * Sends a sticker via WhatsApp\n * @param params The sticker message parameter object\n * @returns Promise with the message response\n */\n sticker(params: MessageRequestParams<StickerMediaObject>): Promise<MessagesResponse>;\n\n /**\n * Sends a template message via WhatsApp\n * @param params The template message parameter object\n * @returns Promise with the message response\n */\n template(params: MessageRequestParams<MessageTemplateObject<ComponentTypesEnum>>): Promise<MessagesResponse>;\n\n /**\n * Sends a text message via WhatsApp\n * @param params The text message parameter object\n * @returns Promise with the message response\n */\n text(params: TextMessageParams): Promise<MessagesResponse>;\n\n /**\n * Sends a video via WhatsApp\n * @param params The video message parameter object\n * @returns Promise with the message response\n */\n video(params: MessageRequestParams<VideoMediaObject>): Promise<MessagesResponse>;\n\n // New methods\n /**\n * Marks a message as read in WhatsApp\n * @param params The parameter object to mark message as read\n * @returns Promise with the response\n */\n markAsRead(params: { messageId: string }): Promise<MessagesResponse>;\n\n /**\n * Marks a message as read and shows a typing indicator in WhatsApp\n * @param params The typing indicator parameter object\n * @returns Promise with the response\n */\n showTypingIndicator(params: { messageId: string }): Promise<MessagesResponse>;\n\n /**\n * Sends an interactive list message\n * @param params The list message parameter object\n * @returns Promise with the response\n */\n interactiveList(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.List }>,\n ): Promise<MessagesResponse>;\n\n /**\n * Sends an interactive CTA URL message\n * @param params The CTA URL message parameter object\n * @returns Promise with the response\n */\n interactiveCtaUrl(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.CtaUrl }>,\n ): Promise<MessagesResponse>;\n\n /**\n * Sends a location request message\n * @param params The location request message parameter object\n * @returns Promise with the response\n */\n interactiveLocationRequest(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.LocationRequest }>,\n ): Promise<MessagesResponse>;\n\n /**\n * Sends an address message to request shipping address from the user\n * Note: This feature is only available for businesses based in India and their India customers\n * @param params The address message parameter object\n * @returns Promise with the response\n */\n interactiveAddressMessage(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.AddressMessage }>,\n ): Promise<MessagesResponse>;\n\n /**\n * Sends an interactive reply buttons message\n * @param params The reply buttons message parameter object\n * @returns Promise with the response\n */\n interactiveReplyButtons(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.Button }>,\n ): Promise<MessagesResponse>;\n\n /**\n * Sends a reaction to a message (emoji response)\n * @param params The reaction message parameter object\n * @returns Promise with the response\n */\n reaction(params: ReactionParams): Promise<MessagesResponse>;\n\n /**\n * Sends an interactive Flow message\n * @param params The Flow message parameter object\n * @returns Promise with the response\n */\n interactiveFlow(\n params: MessageRequestParams<InteractiveObject & { type: InteractiveTypesEnum.Flow }>,\n ): Promise<MessagesResponse>;\n}\n"],"mappings":"+WAAA,IAAAA,EAAA,kBAAAC,EAAAD","names":["messages_exports","__toCommonJS"]}
|
package/dist/types/messages.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
//# sourceMappingURL=messages.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
import { Paging, ResponseSuccess } from './request.mjs';
|
|
2
|
-
import '../enums-CI7vzKhn.mjs';
|
|
3
|
-
|
|
4
|
-
type QualityRating = 'GREEN' | 'YELLOW' | 'RED' | 'NA';
|
|
5
|
-
type AccountMode = 'LIVE' | 'SANDBOX';
|
|
6
|
-
type CodeVerificationStatus = 'NOT_VERIFIED' | 'VERIFIED' | 'EXPIRED' | 'PENDING' | 'DELETED' | 'MIGRATED' | 'BANNED' | 'RESTRICTED' | 'RATE_LIMITED' | 'FLAGGED' | 'CONNECTED' | 'DISCONNECTED' | 'UNKNOWN' | 'UNVERIFIED';
|
|
7
|
-
type MessagingLimitTier = 'TIER_50' | 'TIER_250' | 'TIER_1K' | 'TIER_10K' | 'TIER_100K' | 'TIER_UNLIMITED';
|
|
8
|
-
type PlatformType = 'CLOUD_API' | 'ON_PREMISE' | 'NOT_APPLICABLE';
|
|
9
|
-
type ThroughputLevel = 'STANDARD' | 'HIGH' | 'NOT_APPLICABLE';
|
|
10
|
-
type HealthStatusEntity = {
|
|
11
|
-
entity_type: string;
|
|
12
|
-
id: string;
|
|
13
|
-
can_send_message: string;
|
|
14
|
-
additional_info?: string[];
|
|
15
|
-
errors?: Array<{
|
|
16
|
-
error_code: number;
|
|
17
|
-
error_description: string;
|
|
18
|
-
possible_solution: string;
|
|
19
|
-
}>;
|
|
20
|
-
};
|
|
21
|
-
type HealthStatus = {
|
|
22
|
-
can_send_message: string;
|
|
23
|
-
entities: HealthStatusEntity[];
|
|
24
|
-
};
|
|
25
|
-
type QualityScore = {
|
|
26
|
-
score: QualityRating;
|
|
27
|
-
};
|
|
28
|
-
type Throughput = {
|
|
29
|
-
level: ThroughputLevel;
|
|
30
|
-
};
|
|
31
|
-
type PhoneNumberResponse = {
|
|
32
|
-
display_phone_number: string;
|
|
33
|
-
id: string;
|
|
34
|
-
quality_rating: QualityRating;
|
|
35
|
-
verified_name: string;
|
|
36
|
-
account_mode?: AccountMode;
|
|
37
|
-
certificate?: string;
|
|
38
|
-
code_verification_status?: CodeVerificationStatus;
|
|
39
|
-
conversational_automation?: Record<string, unknown>;
|
|
40
|
-
eligibility_for_api_business_global_search?: string;
|
|
41
|
-
health_status?: HealthStatus;
|
|
42
|
-
is_official_business_account?: boolean;
|
|
43
|
-
is_on_biz_app?: boolean;
|
|
44
|
-
is_pin_enabled?: boolean;
|
|
45
|
-
is_preverified_number?: boolean;
|
|
46
|
-
last_onboarded_time?: string;
|
|
47
|
-
messaging_limit_tier?: MessagingLimitTier;
|
|
48
|
-
name_status?: string;
|
|
49
|
-
new_certificate?: string;
|
|
50
|
-
new_name_status?: string;
|
|
51
|
-
platform_type?: PlatformType;
|
|
52
|
-
quality_score?: QualityScore;
|
|
53
|
-
search_visibility?: string;
|
|
54
|
-
status?: CodeVerificationStatus;
|
|
55
|
-
throughput?: Throughput;
|
|
56
|
-
};
|
|
57
|
-
type Cursors = {
|
|
58
|
-
before: string;
|
|
59
|
-
after: string;
|
|
60
|
-
};
|
|
61
|
-
type PhoneNumbersResponse = {
|
|
62
|
-
data: PhoneNumberResponse[];
|
|
63
|
-
paging: Paging;
|
|
64
|
-
};
|
|
65
|
-
type RequestVerificationCodeRequest = {
|
|
66
|
-
code_method: 'SMS' | 'VOICE';
|
|
67
|
-
language: string;
|
|
68
|
-
};
|
|
69
|
-
type VerifyCodeRequest = {
|
|
70
|
-
code: string;
|
|
71
|
-
};
|
|
72
|
-
type TwoStepVerificationParams = {
|
|
73
|
-
pin: string;
|
|
74
|
-
};
|
|
75
|
-
declare class PhoneNumberClass {
|
|
76
|
-
getPhoneNumberById(fields?: string): Promise<PhoneNumberResponse>;
|
|
77
|
-
getPhoneNumbers(): Promise<PhoneNumbersResponse>;
|
|
78
|
-
requestVerificationCode(params: RequestVerificationCodeRequest): Promise<ResponseSuccess>;
|
|
79
|
-
verifyCode(params: VerifyCodeRequest): Promise<ResponseSuccess>;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
export { type AccountMode, type CodeVerificationStatus, type Cursors, type HealthStatus, type HealthStatusEntity, type MessagingLimitTier, PhoneNumberClass, type PhoneNumberResponse, type PhoneNumbersResponse, type PlatformType, type QualityRating, type QualityScore, type RequestVerificationCodeRequest, type Throughput, type ThroughputLevel, type TwoStepVerificationParams, type VerifyCodeRequest };
|