@aws-sdk/client-socialmessaging 3.669.0
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/LICENSE +201 -0
- package/README.md +334 -0
- package/dist-cjs/SocialMessaging.js +37 -0
- package/dist-cjs/SocialMessagingClient.js +50 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/AssociateWhatsAppBusinessAccountCommand.js +27 -0
- package/dist-cjs/commands/DeleteWhatsAppMessageMediaCommand.js +26 -0
- package/dist-cjs/commands/DisassociateWhatsAppBusinessAccountCommand.js +26 -0
- package/dist-cjs/commands/GetLinkedWhatsAppBusinessAccountCommand.js +26 -0
- package/dist-cjs/commands/GetLinkedWhatsAppBusinessAccountPhoneNumberCommand.js +26 -0
- package/dist-cjs/commands/GetWhatsAppMessageMediaCommand.js +27 -0
- package/dist-cjs/commands/ListLinkedWhatsAppBusinessAccountsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/PostWhatsAppMessageMediaCommand.js +27 -0
- package/dist-cjs/commands/PutWhatsAppBusinessAccountEventDestinationsCommand.js +26 -0
- package/dist-cjs/commands/SendWhatsAppMessageCommand.js +27 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/index.js +16 -0
- package/dist-cjs/endpoint/EndpointParameters.js +18 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/SocialMessagingServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +173 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListLinkedWhatsAppBusinessAccountsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_restJson1.js +573 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/SocialMessaging.js +33 -0
- package/dist-es/SocialMessagingClient.js +46 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/AssociateWhatsAppBusinessAccountCommand.js +23 -0
- package/dist-es/commands/DeleteWhatsAppMessageMediaCommand.js +22 -0
- package/dist-es/commands/DisassociateWhatsAppBusinessAccountCommand.js +22 -0
- package/dist-es/commands/GetLinkedWhatsAppBusinessAccountCommand.js +22 -0
- package/dist-es/commands/GetLinkedWhatsAppBusinessAccountPhoneNumberCommand.js +22 -0
- package/dist-es/commands/GetWhatsAppMessageMediaCommand.js +23 -0
- package/dist-es/commands/ListLinkedWhatsAppBusinessAccountsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/PostWhatsAppMessageMediaCommand.js +23 -0
- package/dist-es/commands/PutWhatsAppBusinessAccountEventDestinationsCommand.js +22 -0
- package/dist-es/commands/SendWhatsAppMessageCommand.js +23 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/endpoint/EndpointParameters.js +14 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/SocialMessagingServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +152 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListLinkedWhatsAppBusinessAccountsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +544 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/SocialMessaging.d.ts +128 -0
- package/dist-types/SocialMessagingClient.d.ts +207 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/AssociateWhatsAppBusinessAccountCommand.d.ts +139 -0
- package/dist-types/commands/DeleteWhatsAppMessageMediaCommand.d.ts +97 -0
- package/dist-types/commands/DisassociateWhatsAppBusinessAccountCommand.d.ts +87 -0
- package/dist-types/commands/GetLinkedWhatsAppBusinessAccountCommand.d.ts +116 -0
- package/dist-types/commands/GetLinkedWhatsAppBusinessAccountPhoneNumberCommand.d.ts +103 -0
- package/dist-types/commands/GetWhatsAppMessageMediaCommand.d.ts +113 -0
- package/dist-types/commands/ListLinkedWhatsAppBusinessAccountsCommand.d.ts +106 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +93 -0
- package/dist-types/commands/PostWhatsAppMessageMediaCommand.d.ts +110 -0
- package/dist-types/commands/PutWhatsAppBusinessAccountEventDestinationsCommand.d.ts +90 -0
- package/dist-types/commands/SendWhatsAppMessageCommand.d.ts +99 -0
- package/dist-types/commands/TagResourceCommand.d.ts +94 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +39 -0
- package/dist-types/models/SocialMessagingServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +969 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListLinkedWhatsAppBusinessAccountsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +119 -0
- package/dist-types/runtimeConfig.browser.d.ts +48 -0
- package/dist-types/runtimeConfig.d.ts +48 -0
- package/dist-types/runtimeConfig.native.d.ts +47 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/SocialMessaging.d.ts +254 -0
- package/dist-types/ts3.4/SocialMessagingClient.d.ts +197 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/AssociateWhatsAppBusinessAccountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteWhatsAppMessageMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateWhatsAppBusinessAccountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetLinkedWhatsAppBusinessAccountCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetLinkedWhatsAppBusinessAccountPhoneNumberCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetWhatsAppMessageMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListLinkedWhatsAppBusinessAccountsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PostWhatsAppMessageMediaCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutWhatsAppBusinessAccountEventDestinationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SendWhatsAppMessageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/SocialMessagingServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +272 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListLinkedWhatsAppBusinessAccountsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +161 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +101 -0
|
@@ -0,0 +1,969 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { SocialMessagingServiceException as __BaseException } from "./SocialMessagingServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare class AccessDeniedByMetaException extends __BaseException {
|
|
8
|
+
readonly name: "AccessDeniedByMetaException";
|
|
9
|
+
readonly $fault: "client";
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedByMetaException, __BaseException>);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
20
|
+
readonly name: "AccessDeniedException";
|
|
21
|
+
readonly $fault: "client";
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* <p>The tag for a resource.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface Tag {
|
|
32
|
+
/**
|
|
33
|
+
* <p>The tag key.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
key: string | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>The tag value.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
value?: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* <p>The registration details for a linked phone number.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
export interface WabaPhoneNumberSetupFinalization {
|
|
48
|
+
/**
|
|
49
|
+
* <p>The unique identifier of the originating phone number associated with the media. Phone
|
|
50
|
+
* number identifiers are formatted as
|
|
51
|
+
* <code>phone-number-id-01234567890123456789012345678901</code>. Use
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
53
|
+
* id.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
id: string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The PIN to use for two-step verification. To reset your PIN follow the directions in
|
|
59
|
+
* <a href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/two-step-verification/#updating-pin">Updating PIN</a> in the <i>WhatsApp Business Platform Cloud API
|
|
60
|
+
* Reference</i>.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
twoFactorPin: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>The two letter ISO region for the location of where Meta will store data.</p>
|
|
66
|
+
* <p class="title">
|
|
67
|
+
* <b>Asia–Pacific (APAC)</b>
|
|
68
|
+
* </p>
|
|
69
|
+
* <ul>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>Australia <b>AU</b>
|
|
72
|
+
* </p>
|
|
73
|
+
* </li>
|
|
74
|
+
* <li>
|
|
75
|
+
* <p>Indonesia <b>ID</b>
|
|
76
|
+
* </p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p>India <b>IN</b>
|
|
80
|
+
* </p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>Japan <b>JP</b>
|
|
84
|
+
* </p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>Singapore <b>SG</b>
|
|
88
|
+
* </p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>South Korea <b>KR</b>
|
|
92
|
+
* </p>
|
|
93
|
+
* </li>
|
|
94
|
+
* </ul>
|
|
95
|
+
* <p class="title">
|
|
96
|
+
* <b>Europe</b>
|
|
97
|
+
* </p>
|
|
98
|
+
* <ul>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p>Germany <b>DE</b>
|
|
101
|
+
* </p>
|
|
102
|
+
* </li>
|
|
103
|
+
* <li>
|
|
104
|
+
* <p>Switzerland <b>CH</b>
|
|
105
|
+
* </p>
|
|
106
|
+
* </li>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>United Kingdom <b>GB</b>
|
|
109
|
+
* </p>
|
|
110
|
+
* </li>
|
|
111
|
+
* </ul>
|
|
112
|
+
* <p class="title">
|
|
113
|
+
* <b>Latin America (LATAM)</b>
|
|
114
|
+
* </p>
|
|
115
|
+
* <ul>
|
|
116
|
+
* <li>
|
|
117
|
+
* <p>Brazil <b>BR</b>
|
|
118
|
+
* </p>
|
|
119
|
+
* </li>
|
|
120
|
+
* </ul>
|
|
121
|
+
* <p class="title">
|
|
122
|
+
* <b>Middle East and Africa (MEA)</b>
|
|
123
|
+
* </p>
|
|
124
|
+
* <ul>
|
|
125
|
+
* <li>
|
|
126
|
+
* <p>Bahrain <b>BH</b>
|
|
127
|
+
* </p>
|
|
128
|
+
* </li>
|
|
129
|
+
* <li>
|
|
130
|
+
* <p>South Africa <b>ZA</b>
|
|
131
|
+
* </p>
|
|
132
|
+
* </li>
|
|
133
|
+
* <li>
|
|
134
|
+
* <p>United Arab Emirates <b>AE</b>
|
|
135
|
+
* </p>
|
|
136
|
+
* </li>
|
|
137
|
+
* </ul>
|
|
138
|
+
* <p class="title">
|
|
139
|
+
* <b>North America (NORAM)</b>
|
|
140
|
+
* </p>
|
|
141
|
+
* <ul>
|
|
142
|
+
* <li>
|
|
143
|
+
* <p>Canada <b>CA</b>
|
|
144
|
+
* </p>
|
|
145
|
+
* </li>
|
|
146
|
+
* </ul>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
dataLocalizationRegion?: string;
|
|
150
|
+
/**
|
|
151
|
+
* <p>An array of key and value pair tags.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
tags?: Tag[];
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* <p>Contains information on the event destination.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
export interface WhatsAppBusinessAccountEventDestination {
|
|
161
|
+
/**
|
|
162
|
+
* <p>The ARN of the event destination.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
eventDestinationArn: string | undefined;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* <p>The registration details for a linked WhatsApp Business Account.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
export interface WabaSetupFinalization {
|
|
172
|
+
/**
|
|
173
|
+
* <p>The ID of the linked WhatsApp Business Account, formatted as <code>waba-01234567890123456789012345678901</code>.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
id?: string;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The event destinations for the linked WhatsApp Business Account.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
eventDestinations?: WhatsAppBusinessAccountEventDestination[];
|
|
182
|
+
/**
|
|
183
|
+
* <p>An array of key and value pair tags.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
tags?: Tag[];
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* <p>The details of linking a WhatsApp Business Account to your Amazon Web Services account.</p>
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
export interface WhatsAppSetupFinalization {
|
|
193
|
+
/**
|
|
194
|
+
* <p>An Amazon Web Services access token generated by <code>WhatsAppSignupCallback</code> and used by <code>WhatsAppSetupFinalization</code>.</p>
|
|
195
|
+
* @public
|
|
196
|
+
*/
|
|
197
|
+
associateInProgressToken: string | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* <p>An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.</p>
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
phoneNumbers: WabaPhoneNumberSetupFinalization[] | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* <p>Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the <code>waba</code> field is present.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
phoneNumberParent?: string;
|
|
208
|
+
/**
|
|
209
|
+
* <p>Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the <code>phoneNumberParent</code> field is present.</p>
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
waba?: WabaSetupFinalization;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* <p>Contains the <code>accessToken</code> provided by Meta during signup.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
export interface WhatsAppSignupCallback {
|
|
219
|
+
/**
|
|
220
|
+
* <p>The access token for your WhatsApp Business Account. The <code>accessToken</code> value is provided by Meta.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
accessToken: string | undefined;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export interface AssociateWhatsAppBusinessAccountInput {
|
|
229
|
+
/**
|
|
230
|
+
* <p>Contains the callback access token.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
signupCallback?: WhatsAppSignupCallback;
|
|
234
|
+
/**
|
|
235
|
+
* <p>A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.</p>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
setupFinalization?: WhatsAppSetupFinalization;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
* @enum
|
|
243
|
+
*/
|
|
244
|
+
export declare const RegistrationStatus: {
|
|
245
|
+
readonly COMPLETE: "COMPLETE";
|
|
246
|
+
readonly INCOMPLETE: "INCOMPLETE";
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof RegistrationStatus];
|
|
252
|
+
/**
|
|
253
|
+
* <p>The details of your WhatsApp phone number.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
export interface WhatsAppPhoneNumberDetail {
|
|
257
|
+
/**
|
|
258
|
+
* <p>The ARN of the WhatsApp phone number.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
arn: string | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* <p>The phone number for sending WhatsApp.</p>
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
phoneNumber: string | undefined;
|
|
267
|
+
/**
|
|
268
|
+
* <p>The phone number ID. Phone number identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>. </p>
|
|
269
|
+
* @public
|
|
270
|
+
*/
|
|
271
|
+
phoneNumberId: string | undefined;
|
|
272
|
+
/**
|
|
273
|
+
* <p>The phone number ID from Meta.</p>
|
|
274
|
+
* @public
|
|
275
|
+
*/
|
|
276
|
+
metaPhoneNumberId: string | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* <p>The display name for this phone number.</p>
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
displayPhoneNumberName: string | undefined;
|
|
282
|
+
/**
|
|
283
|
+
* <p>The phone number that appears in the recipients display.</p>
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
286
|
+
displayPhoneNumber: string | undefined;
|
|
287
|
+
/**
|
|
288
|
+
* <p>The quality rating of the phone number.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
qualityRating: string | undefined;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* <p>Contains your WhatsApp registration status and details of any unregistered WhatsApp
|
|
295
|
+
* phone number.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
export interface LinkedWhatsAppBusinessAccountIdMetaData {
|
|
299
|
+
/**
|
|
300
|
+
* <p>The name of your account.</p>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
accountName?: string;
|
|
304
|
+
/**
|
|
305
|
+
* <p>The registration status of the linked WhatsApp Business Account.</p>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
registrationStatus?: RegistrationStatus;
|
|
309
|
+
/**
|
|
310
|
+
* <p>The details for unregistered WhatsApp phone numbers.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
unregisteredWhatsAppPhoneNumbers?: WhatsAppPhoneNumberDetail[];
|
|
314
|
+
}
|
|
315
|
+
/**
|
|
316
|
+
* <p>Contains the results of WhatsAppSignupCallback.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
export interface WhatsAppSignupCallbackResult {
|
|
320
|
+
/**
|
|
321
|
+
* <p>An Amazon Web Services access token generated by <code>WhatsAppSignupCallback</code> and used by <code>WhatsAppSetupFinalization</code>.</p>
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
associateInProgressToken?: string;
|
|
325
|
+
/**
|
|
326
|
+
* <p>A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
linkedAccountsWithIncompleteSetup?: Record<string, LinkedWhatsAppBusinessAccountIdMetaData>;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
export interface AssociateWhatsAppBusinessAccountOutput {
|
|
335
|
+
/**
|
|
336
|
+
* <p>Contains your WhatsApp registration status.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
signupCallbackResult?: WhatsAppSignupCallbackResult;
|
|
340
|
+
/**
|
|
341
|
+
* <p>The status code for the response.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
statusCode?: number;
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
export declare class DependencyException extends __BaseException {
|
|
351
|
+
readonly name: "DependencyException";
|
|
352
|
+
readonly $fault: "server";
|
|
353
|
+
$retryable: {};
|
|
354
|
+
/**
|
|
355
|
+
* @internal
|
|
356
|
+
*/
|
|
357
|
+
constructor(opts: __ExceptionOptionType<DependencyException, __BaseException>);
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
export declare class InvalidParametersException extends __BaseException {
|
|
364
|
+
readonly name: "InvalidParametersException";
|
|
365
|
+
readonly $fault: "client";
|
|
366
|
+
/**
|
|
367
|
+
* @internal
|
|
368
|
+
*/
|
|
369
|
+
constructor(opts: __ExceptionOptionType<InvalidParametersException, __BaseException>);
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* <p>The request was denied due to request throttling.</p>
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
export declare class ThrottledRequestException extends __BaseException {
|
|
376
|
+
readonly name: "ThrottledRequestException";
|
|
377
|
+
readonly $fault: "client";
|
|
378
|
+
$retryable: {};
|
|
379
|
+
/**
|
|
380
|
+
* @internal
|
|
381
|
+
*/
|
|
382
|
+
constructor(opts: __ExceptionOptionType<ThrottledRequestException, __BaseException>);
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
388
|
+
export declare class ValidationException extends __BaseException {
|
|
389
|
+
readonly name: "ValidationException";
|
|
390
|
+
readonly $fault: "client";
|
|
391
|
+
/**
|
|
392
|
+
* @internal
|
|
393
|
+
*/
|
|
394
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
export interface DeleteWhatsAppMessageMediaInput {
|
|
400
|
+
/**
|
|
401
|
+
* <p>The unique identifier of the media file to delete. Use the <code>mediaId</code> returned from <a href="https://console.aws.amazon.com/social-messaging/latest/APIReference/API_PostWhatsAppMessageMedia.html">PostWhatsAppMessageMedia</a>.</p>
|
|
402
|
+
* @public
|
|
403
|
+
*/
|
|
404
|
+
mediaId: string | undefined;
|
|
405
|
+
/**
|
|
406
|
+
* <p>The unique identifier of the originating phone number associated with the media. Phone
|
|
407
|
+
* number identifiers are formatted as
|
|
408
|
+
* <code>phone-number-id-01234567890123456789012345678901</code>. Use
|
|
409
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
410
|
+
* id.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
originationPhoneNumberId: string | undefined;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
export interface DeleteWhatsAppMessageMediaOutput {
|
|
419
|
+
/**
|
|
420
|
+
* <p>Success indicator for deleting the media file.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
success?: boolean;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
427
|
+
* failure.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
export declare class InternalServiceException extends __BaseException {
|
|
431
|
+
readonly name: "InternalServiceException";
|
|
432
|
+
readonly $fault: "server";
|
|
433
|
+
$retryable: {};
|
|
434
|
+
/**
|
|
435
|
+
* @internal
|
|
436
|
+
*/
|
|
437
|
+
constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* <p>The resource was not found.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
444
|
+
readonly name: "ResourceNotFoundException";
|
|
445
|
+
readonly $fault: "client";
|
|
446
|
+
/**
|
|
447
|
+
* @internal
|
|
448
|
+
*/
|
|
449
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* @public
|
|
453
|
+
*/
|
|
454
|
+
export interface DisassociateWhatsAppBusinessAccountInput {
|
|
455
|
+
/**
|
|
456
|
+
* <p>The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as
|
|
457
|
+
* <code>waba-01234567890123456789012345678901</code>. Use
|
|
458
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
id: string | undefined;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
export interface DisassociateWhatsAppBusinessAccountOutput {
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
export interface GetLinkedWhatsAppBusinessAccountInput {
|
|
472
|
+
/**
|
|
473
|
+
* <p>The unique identifier, from Amazon Web Services, of the linked WhatsApp Business
|
|
474
|
+
* Account. WABA identifiers are formatted as
|
|
475
|
+
* <code>waba-01234567890123456789012345678901</code>. Use
|
|
476
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
id: string | undefined;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* <p>The details of a linked phone number.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface WhatsAppPhoneNumberSummary {
|
|
486
|
+
/**
|
|
487
|
+
* <p>The full Amazon Resource Name (ARN) for the phone number.</p>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
arn: string | undefined;
|
|
491
|
+
/**
|
|
492
|
+
* <p>The phone number associated with the Linked WhatsApp Business Account.</p>
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
phoneNumber: string | undefined;
|
|
496
|
+
/**
|
|
497
|
+
* <p>The phone number ID. Phone number identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>. </p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
phoneNumberId: string | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* <p>The phone number ID from Meta.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
metaPhoneNumberId: string | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* <p>The display name for this phone number.</p>
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
displayPhoneNumberName: string | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* <p>The phone number that appears in the recipients display.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
displayPhoneNumber: string | undefined;
|
|
516
|
+
/**
|
|
517
|
+
* <p>The quality rating of the phone number. This is from Meta.</p>
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
qualityRating: string | undefined;
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* <p>The details of your linked WhatsApp Business Account.</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
export interface LinkedWhatsAppBusinessAccount {
|
|
527
|
+
/**
|
|
528
|
+
* <p>The ARN of the linked WhatsApp Business Account.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
arn: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>The ID of the linked WhatsApp Business Account, formatted as <code>waba-01234567890123456789012345678901</code>.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
id: string | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>The WhatsApp Business Account ID from meta.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
wabaId: string | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>The registration status of the linked WhatsApp Business Account.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
registrationStatus: RegistrationStatus | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>The date the WhatsApp Business Account was linked.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
linkDate: Date | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>The name of the linked WhatsApp Business Account.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
wabaName: string | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The event destinations for the linked WhatsApp Business Account.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
eventDestinations: WhatsAppBusinessAccountEventDestination[] | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The phone numbers associated with the Linked WhatsApp Business Account.</p>
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
phoneNumbers: WhatsAppPhoneNumberSummary[] | undefined;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
export interface GetLinkedWhatsAppBusinessAccountOutput {
|
|
572
|
+
/**
|
|
573
|
+
* <p>The details of the linked WhatsApp Business Account.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
account?: LinkedWhatsAppBusinessAccount;
|
|
577
|
+
}
|
|
578
|
+
/**
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
export interface GetLinkedWhatsAppBusinessAccountPhoneNumberInput {
|
|
582
|
+
/**
|
|
583
|
+
* <p>The unique identifier of the phone number. Phone number
|
|
584
|
+
* identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>.
|
|
585
|
+
* Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
586
|
+
* id.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
id: string | undefined;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* @public
|
|
593
|
+
*/
|
|
594
|
+
export interface GetLinkedWhatsAppBusinessAccountPhoneNumberOutput {
|
|
595
|
+
/**
|
|
596
|
+
* <p>The details of your WhatsApp phone number.</p>
|
|
597
|
+
* @public
|
|
598
|
+
*/
|
|
599
|
+
phoneNumber?: WhatsAppPhoneNumberDetail;
|
|
600
|
+
/**
|
|
601
|
+
* <p>The WABA identifier linked to the phone number, formatted as
|
|
602
|
+
* <code>waba-01234567890123456789012345678901</code>.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
linkedWhatsAppBusinessAccountId?: string;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* <p>Contains information for the S3 bucket that contains media files.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
export interface S3File {
|
|
612
|
+
/**
|
|
613
|
+
* <p>The bucket name.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
bucketName: string | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* <p>The object key of the media file.</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
key: string | undefined;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* <p>You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html">Working with presigned URLs</a> in the <i>Amazon S3
|
|
625
|
+
* User Guide</i>.</p>
|
|
626
|
+
* @public
|
|
627
|
+
*/
|
|
628
|
+
export interface S3PresignedUrl {
|
|
629
|
+
/**
|
|
630
|
+
* <p>The presign url to the object.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
url: string | undefined;
|
|
634
|
+
/**
|
|
635
|
+
* <p>A map of headers and their values. You must specify the <code>Content-Type</code> header when using <code>PostWhatsAppMessageMedia</code>. For a list of common headers, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request Headers</a> in the <i>Amazon S3
|
|
636
|
+
* API Reference</i>
|
|
637
|
+
* </p>
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
headers: Record<string, string> | undefined;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* @public
|
|
644
|
+
*/
|
|
645
|
+
export interface GetWhatsAppMessageMediaInput {
|
|
646
|
+
/**
|
|
647
|
+
* <p>The unique identifier for the media file.</p>
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
mediaId: string | undefined;
|
|
651
|
+
/**
|
|
652
|
+
* <p>The unique identifier of the originating phone number for the WhatsApp message media.
|
|
653
|
+
* The phone number identifiers are formatted as
|
|
654
|
+
* <code>phone-number-id-01234567890123456789012345678901</code>. Use
|
|
655
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
656
|
+
* id.</p>
|
|
657
|
+
* @public
|
|
658
|
+
*/
|
|
659
|
+
originationPhoneNumberId: string | undefined;
|
|
660
|
+
/**
|
|
661
|
+
* <p>Set to <code>True</code> to get only the metadata for the file.</p>
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
metadataOnly?: boolean;
|
|
665
|
+
/**
|
|
666
|
+
* <p>The presign url of the media file.</p>
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
destinationS3PresignedUrl?: S3PresignedUrl;
|
|
670
|
+
/**
|
|
671
|
+
* <p>The <code>bucketName</code> and <code>key</code> of the S3 media file.</p>
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
destinationS3File?: S3File;
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
export interface GetWhatsAppMessageMediaOutput {
|
|
680
|
+
/**
|
|
681
|
+
* <p>The MIME type of the media.</p>
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
mimeType?: string;
|
|
685
|
+
/**
|
|
686
|
+
* <p>The file size of the media, in KB.</p>
|
|
687
|
+
* @public
|
|
688
|
+
*/
|
|
689
|
+
fileSize?: number;
|
|
690
|
+
}
|
|
691
|
+
/**
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
export interface ListLinkedWhatsAppBusinessAccountsInput {
|
|
695
|
+
/**
|
|
696
|
+
* <p>The next token for pagination.</p>
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
nextToken?: string;
|
|
700
|
+
/**
|
|
701
|
+
* <p>The maximum number of results to return.</p>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
maxResults?: number;
|
|
705
|
+
}
|
|
706
|
+
/**
|
|
707
|
+
* <p>The details of a linked WhatsApp Business Account.</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
export interface LinkedWhatsAppBusinessAccountSummary {
|
|
711
|
+
/**
|
|
712
|
+
* <p>The ARN of the linked WhatsApp Business Account.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
arn: string | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p>The ID of the linked WhatsApp Business Account, formatted as <code>waba-01234567890123456789012345678901</code>.</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
id: string | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p>The WhatsApp Business Account ID provided by Meta.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
wabaId: string | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The registration status of the linked WhatsApp Business Account.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
registrationStatus: RegistrationStatus | undefined;
|
|
731
|
+
/**
|
|
732
|
+
* <p>The date the WhatsApp Business Account was linked.</p>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
linkDate: Date | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* <p>The name of the linked WhatsApp Business Account.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
wabaName: string | undefined;
|
|
741
|
+
/**
|
|
742
|
+
* <p>The event destinations for the linked WhatsApp Business Account.</p>
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
eventDestinations: WhatsAppBusinessAccountEventDestination[] | undefined;
|
|
746
|
+
}
|
|
747
|
+
/**
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
export interface ListLinkedWhatsAppBusinessAccountsOutput {
|
|
751
|
+
/**
|
|
752
|
+
* <p>A list of WhatsApp Business Accounts linked to your Amazon Web Services account.</p>
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
755
|
+
linkedAccounts?: LinkedWhatsAppBusinessAccountSummary[];
|
|
756
|
+
/**
|
|
757
|
+
* <p>The next token for pagination.</p>
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
nextToken?: string;
|
|
761
|
+
}
|
|
762
|
+
/**
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
export interface PutWhatsAppBusinessAccountEventDestinationsInput {
|
|
766
|
+
/**
|
|
767
|
+
* <p>The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as
|
|
768
|
+
* <code>waba-01234567890123456789012345678901</code>. Use
|
|
769
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_ListLinkedWhatsAppBusinessAccounts.html">ListLinkedWhatsAppBusinessAccounts</a> to list all WABAs and their details.</p>
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
id: string | undefined;
|
|
773
|
+
/**
|
|
774
|
+
* <p>An array of <code>WhatsAppBusinessAccountEventDestination</code> event destinations.</p>
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
eventDestinations: WhatsAppBusinessAccountEventDestination[] | undefined;
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
export interface PutWhatsAppBusinessAccountEventDestinationsOutput {
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
export interface PostWhatsAppMessageMediaInput {
|
|
788
|
+
/**
|
|
789
|
+
* <p>The ID of the phone number to associate with the WhatsApp media file. The phone number
|
|
790
|
+
* identifiers are formatted as <code>phone-number-id-01234567890123456789012345678901</code>.
|
|
791
|
+
* Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
792
|
+
* id.</p>
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
originationPhoneNumberId: string | undefined;
|
|
796
|
+
/**
|
|
797
|
+
* <p>The source presign url of the media file.</p>
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
sourceS3PresignedUrl?: S3PresignedUrl;
|
|
801
|
+
/**
|
|
802
|
+
* <p>The source S3 url for the media file.</p>
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
sourceS3File?: S3File;
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export interface PostWhatsAppMessageMediaOutput {
|
|
811
|
+
/**
|
|
812
|
+
* <p>The unique identifier of the posted WhatsApp message.</p>
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
mediaId?: string;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
export interface SendWhatsAppMessageInput {
|
|
821
|
+
/**
|
|
822
|
+
* <p>The ID of the phone number used to send the WhatsApp message. If you are sending a media
|
|
823
|
+
* file only the <code>originationPhoneNumberId</code> used to upload the file can be used.
|
|
824
|
+
* Phone number identifiers are formatted as
|
|
825
|
+
* <code>phone-number-id-01234567890123456789012345678901</code>. Use
|
|
826
|
+
* <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_GetLinkedWhatsAppBusinessAccountPhoneNumber.html">GetLinkedWhatsAppBusinessAccount</a> to find a phone number's
|
|
827
|
+
* id.</p>
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
originationPhoneNumberId: string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp
|
|
833
|
+
* Message object, see <a href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages">Messages</a> in the <i>WhatsApp Business Platform Cloud API
|
|
834
|
+
* Reference</i>.</p>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
message: Uint8Array | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The API version for the request formatted as <code>v\{VersionNumber\}</code>. For a list of supported API versions and Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/end-user-messaging.html">
|
|
840
|
+
* <i>Amazon Web Services End User Messaging Social API</i> Service Endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
metaApiVersion: string | undefined;
|
|
844
|
+
}
|
|
845
|
+
/**
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
export interface SendWhatsAppMessageOutput {
|
|
849
|
+
/**
|
|
850
|
+
* <p>The unique identifier of the message.</p>
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
messageId?: string;
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
export interface ListTagsForResourceInput {
|
|
859
|
+
/**
|
|
860
|
+
* <p>The Amazon Resource Name (ARN) of the resource to retrieve the tags from.</p>
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
resourceArn: string | undefined;
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
export interface ListTagsForResourceOutput {
|
|
869
|
+
/**
|
|
870
|
+
* <p>The status code of the response.</p>
|
|
871
|
+
* @public
|
|
872
|
+
*/
|
|
873
|
+
statusCode?: number;
|
|
874
|
+
/**
|
|
875
|
+
* <p>The tags for the resource.</p>
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
tags?: Tag[];
|
|
879
|
+
}
|
|
880
|
+
/**
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
export interface TagResourceInput {
|
|
884
|
+
/**
|
|
885
|
+
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
resourceArn: string | undefined;
|
|
889
|
+
/**
|
|
890
|
+
* <p>The tags to add to the resource.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
tags: Tag[] | undefined;
|
|
894
|
+
}
|
|
895
|
+
/**
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
export interface TagResourceOutput {
|
|
899
|
+
/**
|
|
900
|
+
* <p>The status code of the tag resource operation.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
statusCode?: number;
|
|
904
|
+
}
|
|
905
|
+
/**
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
export interface UntagResourceInput {
|
|
909
|
+
/**
|
|
910
|
+
* <p>The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
resourceArn: string | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The keys of the tags to remove from the resource.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
tagKeys: string[] | undefined;
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
export interface UntagResourceOutput {
|
|
924
|
+
/**
|
|
925
|
+
* <p>The status code of the untag resource operation.</p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
statusCode?: number;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* @internal
|
|
932
|
+
*/
|
|
933
|
+
export declare const WabaPhoneNumberSetupFinalizationFilterSensitiveLog: (obj: WabaPhoneNumberSetupFinalization) => any;
|
|
934
|
+
/**
|
|
935
|
+
* @internal
|
|
936
|
+
*/
|
|
937
|
+
export declare const WhatsAppSetupFinalizationFilterSensitiveLog: (obj: WhatsAppSetupFinalization) => any;
|
|
938
|
+
/**
|
|
939
|
+
* @internal
|
|
940
|
+
*/
|
|
941
|
+
export declare const AssociateWhatsAppBusinessAccountInputFilterSensitiveLog: (obj: AssociateWhatsAppBusinessAccountInput) => any;
|
|
942
|
+
/**
|
|
943
|
+
* @internal
|
|
944
|
+
*/
|
|
945
|
+
export declare const WhatsAppSignupCallbackResultFilterSensitiveLog: (obj: WhatsAppSignupCallbackResult) => any;
|
|
946
|
+
/**
|
|
947
|
+
* @internal
|
|
948
|
+
*/
|
|
949
|
+
export declare const AssociateWhatsAppBusinessAccountOutputFilterSensitiveLog: (obj: AssociateWhatsAppBusinessAccountOutput) => any;
|
|
950
|
+
/**
|
|
951
|
+
* @internal
|
|
952
|
+
*/
|
|
953
|
+
export declare const S3FileFilterSensitiveLog: (obj: S3File) => any;
|
|
954
|
+
/**
|
|
955
|
+
* @internal
|
|
956
|
+
*/
|
|
957
|
+
export declare const S3PresignedUrlFilterSensitiveLog: (obj: S3PresignedUrl) => any;
|
|
958
|
+
/**
|
|
959
|
+
* @internal
|
|
960
|
+
*/
|
|
961
|
+
export declare const GetWhatsAppMessageMediaInputFilterSensitiveLog: (obj: GetWhatsAppMessageMediaInput) => any;
|
|
962
|
+
/**
|
|
963
|
+
* @internal
|
|
964
|
+
*/
|
|
965
|
+
export declare const PostWhatsAppMessageMediaInputFilterSensitiveLog: (obj: PostWhatsAppMessageMediaInput) => any;
|
|
966
|
+
/**
|
|
967
|
+
* @internal
|
|
968
|
+
*/
|
|
969
|
+
export declare const SendWhatsAppMessageInputFilterSensitiveLog: (obj: SendWhatsAppMessageInput) => any;
|