@aws-sdk/client-endusermessaging 3.1145.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.
Files changed (178) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +370 -0
  3. package/dist-cjs/index.js +1645 -0
  4. package/dist-es/EndUserMessaging.js +79 -0
  5. package/dist-es/EndUserMessagingClient.js +47 -0
  6. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  7. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  8. package/dist-es/commandBuilder.js +6 -0
  9. package/dist-es/commands/CreateBrandProfileAttributesCommand.js +4 -0
  10. package/dist-es/commands/CreateBrandProfileCommand.js +4 -0
  11. package/dist-es/commands/CreateBrandProfileFromRegistrationCommand.js +4 -0
  12. package/dist-es/commands/CreateNotifyCodeConfigurationCommand.js +4 -0
  13. package/dist-es/commands/CreateRegistrationsFromBrandProfileCommand.js +4 -0
  14. package/dist-es/commands/DeleteBrandProfileAttributeCommand.js +4 -0
  15. package/dist-es/commands/DeleteBrandProfileCommand.js +4 -0
  16. package/dist-es/commands/DeleteNotifyCodeConfigurationCommand.js +4 -0
  17. package/dist-es/commands/GetBrandProfileAttributeCommand.js +4 -0
  18. package/dist-es/commands/GetBrandProfileCommand.js +4 -0
  19. package/dist-es/commands/GetJobCommand.js +4 -0
  20. package/dist-es/commands/GetNotifyCodeConfigurationCommand.js +4 -0
  21. package/dist-es/commands/ListBrandProfileAttributesCommand.js +4 -0
  22. package/dist-es/commands/ListBrandProfilesCommand.js +4 -0
  23. package/dist-es/commands/ListJobsCommand.js +4 -0
  24. package/dist-es/commands/ListNotifyCodeConfigurationsCommand.js +4 -0
  25. package/dist-es/commands/ListRegistrationsFromBrandProfileCommand.js +4 -0
  26. package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
  27. package/dist-es/commands/SendNotifyCodeVerificationCommand.js +4 -0
  28. package/dist-es/commands/TagResourceCommand.js +4 -0
  29. package/dist-es/commands/UntagResourceCommand.js +4 -0
  30. package/dist-es/commands/UpdateBrandProfileAttributeCommand.js +4 -0
  31. package/dist-es/commands/UpdateBrandProfileCommand.js +4 -0
  32. package/dist-es/commands/UpdateBrandProfileFromRegistrationCommand.js +4 -0
  33. package/dist-es/commands/UpdateNotifyCodeConfigurationCommand.js +4 -0
  34. package/dist-es/commands/UpdateRegistrationsFromBrandProfileCommand.js +4 -0
  35. package/dist-es/commands/ValidateNotifyCodeVerificationCommand.js +4 -0
  36. package/dist-es/commands/index.js +27 -0
  37. package/dist-es/endpoint/EndpointParameters.js +13 -0
  38. package/dist-es/endpoint/bdd.js +46 -0
  39. package/dist-es/endpoint/endpointResolver.js +14 -0
  40. package/dist-es/extensionConfiguration.js +1 -0
  41. package/dist-es/index.js +11 -0
  42. package/dist-es/models/EndUserMessagingServiceException.js +8 -0
  43. package/dist-es/models/enums.js +43 -0
  44. package/dist-es/models/errors.js +99 -0
  45. package/dist-es/models/models_0.js +1 -0
  46. package/dist-es/pagination/Interfaces.js +1 -0
  47. package/dist-es/pagination/ListBrandProfileAttributesPaginator.js +4 -0
  48. package/dist-es/pagination/ListBrandProfilesPaginator.js +4 -0
  49. package/dist-es/pagination/ListJobsPaginator.js +4 -0
  50. package/dist-es/pagination/ListNotifyCodeConfigurationsPaginator.js +4 -0
  51. package/dist-es/pagination/ListRegistrationsFromBrandProfilePaginator.js +4 -0
  52. package/dist-es/pagination/index.js +6 -0
  53. package/dist-es/runtimeConfig.browser.js +29 -0
  54. package/dist-es/runtimeConfig.js +43 -0
  55. package/dist-es/runtimeConfig.native.js +9 -0
  56. package/dist-es/runtimeConfig.shared.js +40 -0
  57. package/dist-es/runtimeExtensions.js +9 -0
  58. package/dist-es/schemas/schemas_0.js +818 -0
  59. package/dist-es/waiters/index.js +2 -0
  60. package/dist-es/waiters/waitForBrandProfileActive.js +58 -0
  61. package/dist-es/waiters/waitForJobSuccess.js +40 -0
  62. package/dist-types/EndUserMessaging.d.ts +256 -0
  63. package/dist-types/EndUserMessagingClient.d.ts +213 -0
  64. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  65. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  66. package/dist-types/commandBuilder.d.ts +18 -0
  67. package/dist-types/commands/CreateBrandProfileAttributesCommand.d.ts +139 -0
  68. package/dist-types/commands/CreateBrandProfileCommand.d.ts +129 -0
  69. package/dist-types/commands/CreateBrandProfileFromRegistrationCommand.d.ts +130 -0
  70. package/dist-types/commands/CreateNotifyCodeConfigurationCommand.d.ts +206 -0
  71. package/dist-types/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +125 -0
  72. package/dist-types/commands/DeleteBrandProfileAttributeCommand.d.ts +110 -0
  73. package/dist-types/commands/DeleteBrandProfileCommand.d.ts +108 -0
  74. package/dist-types/commands/DeleteNotifyCodeConfigurationCommand.d.ts +102 -0
  75. package/dist-types/commands/GetBrandProfileAttributeCommand.d.ts +119 -0
  76. package/dist-types/commands/GetBrandProfileCommand.d.ts +115 -0
  77. package/dist-types/commands/GetJobCommand.d.ts +129 -0
  78. package/dist-types/commands/GetNotifyCodeConfigurationCommand.d.ts +156 -0
  79. package/dist-types/commands/ListBrandProfileAttributesCommand.d.ts +124 -0
  80. package/dist-types/commands/ListBrandProfilesCommand.d.ts +122 -0
  81. package/dist-types/commands/ListJobsCommand.d.ts +133 -0
  82. package/dist-types/commands/ListNotifyCodeConfigurationsCommand.d.ts +159 -0
  83. package/dist-types/commands/ListRegistrationsFromBrandProfileCommand.d.ts +121 -0
  84. package/dist-types/commands/ListTagsForResourceCommand.d.ts +113 -0
  85. package/dist-types/commands/SendNotifyCodeVerificationCommand.d.ts +151 -0
  86. package/dist-types/commands/TagResourceCommand.d.ts +114 -0
  87. package/dist-types/commands/UntagResourceCommand.d.ts +105 -0
  88. package/dist-types/commands/UpdateBrandProfileAttributeCommand.d.ts +127 -0
  89. package/dist-types/commands/UpdateBrandProfileCommand.d.ts +122 -0
  90. package/dist-types/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +123 -0
  91. package/dist-types/commands/UpdateNotifyCodeConfigurationCommand.d.ts +193 -0
  92. package/dist-types/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +127 -0
  93. package/dist-types/commands/ValidateNotifyCodeVerificationCommand.d.ts +104 -0
  94. package/dist-types/commands/index.d.ts +27 -0
  95. package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
  96. package/dist-types/endpoint/bdd.d.ts +2 -0
  97. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  98. package/dist-types/extensionConfiguration.d.ts +9 -0
  99. package/dist-types/index.d.ts +19 -0
  100. package/dist-types/models/EndUserMessagingServiceException.d.ts +14 -0
  101. package/dist-types/models/enums.d.ts +145 -0
  102. package/dist-types/models/errors.d.ts +119 -0
  103. package/dist-types/models/models_0.d.ts +1667 -0
  104. package/dist-types/pagination/Interfaces.d.ts +8 -0
  105. package/dist-types/pagination/ListBrandProfileAttributesPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListBrandProfilesPaginator.d.ts +7 -0
  107. package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
  108. package/dist-types/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +7 -0
  109. package/dist-types/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +7 -0
  110. package/dist-types/pagination/index.d.ts +6 -0
  111. package/dist-types/runtimeConfig.browser.d.ts +57 -0
  112. package/dist-types/runtimeConfig.d.ts +57 -0
  113. package/dist-types/runtimeConfig.native.d.ts +56 -0
  114. package/dist-types/runtimeConfig.shared.d.ts +28 -0
  115. package/dist-types/runtimeExtensions.d.ts +17 -0
  116. package/dist-types/schemas/schemas_0.d.ts +120 -0
  117. package/dist-types/ts3.4/EndUserMessaging.d.ts +515 -0
  118. package/dist-types/ts3.4/EndUserMessagingClient.d.ts +256 -0
  119. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
  120. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
  121. package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
  122. package/dist-types/ts3.4/commands/CreateBrandProfileAttributesCommand.d.ts +42 -0
  123. package/dist-types/ts3.4/commands/CreateBrandProfileCommand.d.ts +39 -0
  124. package/dist-types/ts3.4/commands/CreateBrandProfileFromRegistrationCommand.d.ts +42 -0
  125. package/dist-types/ts3.4/commands/CreateNotifyCodeConfigurationCommand.d.ts +42 -0
  126. package/dist-types/ts3.4/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +42 -0
  127. package/dist-types/ts3.4/commands/DeleteBrandProfileAttributeCommand.d.ts +42 -0
  128. package/dist-types/ts3.4/commands/DeleteBrandProfileCommand.d.ts +39 -0
  129. package/dist-types/ts3.4/commands/DeleteNotifyCodeConfigurationCommand.d.ts +42 -0
  130. package/dist-types/ts3.4/commands/GetBrandProfileAttributeCommand.d.ts +39 -0
  131. package/dist-types/ts3.4/commands/GetBrandProfileCommand.d.ts +38 -0
  132. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +38 -0
  133. package/dist-types/ts3.4/commands/GetNotifyCodeConfigurationCommand.d.ts +42 -0
  134. package/dist-types/ts3.4/commands/ListBrandProfileAttributesCommand.d.ts +42 -0
  135. package/dist-types/ts3.4/commands/ListBrandProfilesCommand.d.ts +38 -0
  136. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +38 -0
  137. package/dist-types/ts3.4/commands/ListNotifyCodeConfigurationsCommand.d.ts +42 -0
  138. package/dist-types/ts3.4/commands/ListRegistrationsFromBrandProfileCommand.d.ts +42 -0
  139. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  140. package/dist-types/ts3.4/commands/SendNotifyCodeVerificationCommand.d.ts +42 -0
  141. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
  142. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
  143. package/dist-types/ts3.4/commands/UpdateBrandProfileAttributeCommand.d.ts +42 -0
  144. package/dist-types/ts3.4/commands/UpdateBrandProfileCommand.d.ts +39 -0
  145. package/dist-types/ts3.4/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +42 -0
  146. package/dist-types/ts3.4/commands/UpdateNotifyCodeConfigurationCommand.d.ts +42 -0
  147. package/dist-types/ts3.4/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +42 -0
  148. package/dist-types/ts3.4/commands/ValidateNotifyCodeVerificationCommand.d.ts +42 -0
  149. package/dist-types/ts3.4/commands/index.d.ts +27 -0
  150. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  151. package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
  152. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  153. package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
  154. package/dist-types/ts3.4/index.d.ts +14 -0
  155. package/dist-types/ts3.4/models/EndUserMessagingServiceException.d.ts +9 -0
  156. package/dist-types/ts3.4/models/enums.d.ts +54 -0
  157. package/dist-types/ts3.4/models/errors.d.ts +47 -0
  158. package/dist-types/ts3.4/models/models_0.d.ts +413 -0
  159. package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
  160. package/dist-types/ts3.4/pagination/ListBrandProfileAttributesPaginator.d.ts +11 -0
  161. package/dist-types/ts3.4/pagination/ListBrandProfilesPaginator.d.ts +11 -0
  162. package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +8 -0
  163. package/dist-types/ts3.4/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +11 -0
  164. package/dist-types/ts3.4/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +11 -0
  165. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  166. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
  167. package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
  168. package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
  169. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
  170. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  171. package/dist-types/ts3.4/schemas/schemas_0.d.ts +115 -0
  172. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  173. package/dist-types/ts3.4/waiters/waitForBrandProfileActive.d.ts +15 -0
  174. package/dist-types/ts3.4/waiters/waitForJobSuccess.d.ts +12 -0
  175. package/dist-types/waiters/index.d.ts +2 -0
  176. package/dist-types/waiters/waitForBrandProfileActive.d.ts +15 -0
  177. package/dist-types/waiters/waitForJobSuccess.d.ts +15 -0
  178. package/package.json +69 -0
@@ -0,0 +1,413 @@
1
+ import {
2
+ BrandProfileAttributeType,
3
+ CodeType,
4
+ JobResourceType,
5
+ JobStatus,
6
+ NotifyChannel,
7
+ OnAttributeConflict,
8
+ Status,
9
+ VerificationStatus,
10
+ VoiceMessageBodyTextType,
11
+ } from "./enums";
12
+ export interface BrandProfileAttributeInput {
13
+ attributeName: string | undefined;
14
+ attributeType: BrandProfileAttributeType | undefined;
15
+ attributeValue?: string | undefined;
16
+ attachmentBody?: Uint8Array | undefined;
17
+ description?: string | undefined;
18
+ category?: string | undefined;
19
+ }
20
+ export interface BrandProfileAttributeOutput {
21
+ attributeName: string | undefined;
22
+ attributeType: BrandProfileAttributeType | undefined;
23
+ mediaDownloadUrl?: string | undefined;
24
+ }
25
+ export interface BrandProfileAttributeSummary {
26
+ attributeName: string | undefined;
27
+ attributeType: BrandProfileAttributeType | undefined;
28
+ description?: string | undefined;
29
+ category?: string | undefined;
30
+ createdAt: Date | undefined;
31
+ updatedAt: Date | undefined;
32
+ }
33
+ export interface BrandProfileInfo {
34
+ brandProfileId: string | undefined;
35
+ brandProfileArn: string | undefined;
36
+ brandProfileName: string | undefined;
37
+ status: Status | undefined;
38
+ deletionProtectionEnabled: boolean | undefined;
39
+ createdAt: Date | undefined;
40
+ updatedAt: Date | undefined;
41
+ }
42
+ export interface NotifyParameters {
43
+ notifyTemplateId?: string | undefined;
44
+ voiceId?: string | undefined;
45
+ }
46
+ export interface TextParameters {
47
+ inlineTemplateBody?: string | undefined;
48
+ destinationCountryParameters?: Record<string, string> | undefined;
49
+ }
50
+ export interface VoiceParameters {
51
+ inlineTemplateBody?: string | undefined;
52
+ languageCode?: string | undefined;
53
+ voiceId?: string | undefined;
54
+ voiceMessageBodyTextType?: VoiceMessageBodyTextType | undefined;
55
+ }
56
+ export interface WhatsAppParameters {
57
+ whatsAppTemplateName?: string | undefined;
58
+ languageCode?: string | undefined;
59
+ }
60
+ export interface ChannelParameters {
61
+ text?: TextParameters | undefined;
62
+ voice?: VoiceParameters | undefined;
63
+ notify?: NotifyParameters | undefined;
64
+ whatsApp?: WhatsAppParameters | undefined;
65
+ }
66
+ export interface CodeConfigurationParameters {
67
+ codeType?: CodeType | undefined;
68
+ codeLength?: number | undefined;
69
+ validityPeriodMinutes?: number | undefined;
70
+ maxAttempts?: number | undefined;
71
+ }
72
+ export interface Tag {
73
+ key: string | undefined;
74
+ value: string | undefined;
75
+ }
76
+ export interface CreateBrandProfileInput {
77
+ brandProfileName: string | undefined;
78
+ clientToken?: string | undefined;
79
+ deletionProtectionEnabled?: boolean | undefined;
80
+ tags?: Tag[] | undefined;
81
+ }
82
+ export interface CreateBrandProfileOutput {
83
+ brandProfileId: string | undefined;
84
+ brandProfileArn: string | undefined;
85
+ brandProfileName: string | undefined;
86
+ status: Status | undefined;
87
+ deletionProtectionEnabled: boolean | undefined;
88
+ createdAt: Date | undefined;
89
+ updatedAt: Date | undefined;
90
+ attributesCreated: number | undefined;
91
+ }
92
+ export interface ValidationExceptionField {
93
+ path: string | undefined;
94
+ message: string | undefined;
95
+ }
96
+ export interface CreateBrandProfileAttributesInput {
97
+ brandProfileId: string | undefined;
98
+ attributes: BrandProfileAttributeInput[] | undefined;
99
+ clientToken?: string | undefined;
100
+ }
101
+ export interface CreateBrandProfileAttributesOutput {
102
+ attributes: BrandProfileAttributeOutput[] | undefined;
103
+ }
104
+ export interface CreateBrandProfileFromRegistrationInput {
105
+ registrationId: string | undefined;
106
+ brandProfileName: string | undefined;
107
+ smartMatch?: boolean | undefined;
108
+ tags?: Tag[] | undefined;
109
+ clientToken?: string | undefined;
110
+ }
111
+ export interface JobResult {
112
+ jobId: string | undefined;
113
+ resourceIdentifier: string | undefined;
114
+ }
115
+ export interface CreateBrandProfileFromRegistrationOutput {
116
+ results: JobResult[] | undefined;
117
+ }
118
+ export interface CreateNotifyCodeConfigurationInput {
119
+ notifyCodeConfigurationName: string | undefined;
120
+ codeConfigurationParameters?: CodeConfigurationParameters | undefined;
121
+ channelParameters?: ChannelParameters | undefined;
122
+ deletionProtectionEnabled?: boolean | undefined;
123
+ clientToken?: string | undefined;
124
+ tags?: Tag[] | undefined;
125
+ }
126
+ export interface NotifyCodeConfiguration {
127
+ notifyCodeConfigurationId: string | undefined;
128
+ notifyCodeConfigurationArn: string | undefined;
129
+ notifyCodeConfigurationName: string | undefined;
130
+ codeConfigurationParameters?: CodeConfigurationParameters | undefined;
131
+ channelParameters?: ChannelParameters | undefined;
132
+ deletionProtectionEnabled: boolean | undefined;
133
+ createdAt: Date | undefined;
134
+ updatedAt: Date | undefined;
135
+ }
136
+ export interface CreateNotifyCodeConfigurationOutput {
137
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
138
+ }
139
+ export interface CreateRegistrationsFromBrandProfileInput {
140
+ brandProfileId: string | undefined;
141
+ registrationTypes: string[] | undefined;
142
+ smartMatch?: boolean | undefined;
143
+ clientToken?: string | undefined;
144
+ }
145
+ export interface CreateRegistrationsFromBrandProfileOutput {
146
+ results: JobResult[] | undefined;
147
+ }
148
+ export interface DeleteBrandProfileInput {
149
+ brandProfileId: string | undefined;
150
+ }
151
+ export interface DeleteBrandProfileOutput {
152
+ brandProfileId: string | undefined;
153
+ brandProfileArn: string | undefined;
154
+ }
155
+ export interface DeleteBrandProfileAttributeInput {
156
+ brandProfileId: string | undefined;
157
+ attributeName: string | undefined;
158
+ }
159
+ export interface DeleteBrandProfileAttributeOutput {
160
+ brandProfileId: string | undefined;
161
+ attributeName: string | undefined;
162
+ }
163
+ export interface DeleteNotifyCodeConfigurationInput {
164
+ notifyCodeConfigurationId: string | undefined;
165
+ }
166
+ export interface DeleteNotifyCodeConfigurationOutput {}
167
+ export interface GetBrandProfileInput {
168
+ brandProfileId: string | undefined;
169
+ }
170
+ export interface GetBrandProfileOutput {
171
+ brandProfileId: string | undefined;
172
+ brandProfileArn: string | undefined;
173
+ brandProfileName: string | undefined;
174
+ status: Status | undefined;
175
+ deletionProtectionEnabled: boolean | undefined;
176
+ createdAt: Date | undefined;
177
+ updatedAt: Date | undefined;
178
+ }
179
+ export interface GetBrandProfileAttributeInput {
180
+ brandProfileId: string | undefined;
181
+ attributeName: string | undefined;
182
+ }
183
+ export interface GetBrandProfileAttributeOutput {
184
+ attributeName: string | undefined;
185
+ attributeType: BrandProfileAttributeType | undefined;
186
+ attributeValue?: string | undefined;
187
+ description?: string | undefined;
188
+ category?: string | undefined;
189
+ mediaContentType?: string | undefined;
190
+ mediaSizeBytes?: number | undefined;
191
+ mediaDownloadUrl?: string | undefined;
192
+ createdAt: Date | undefined;
193
+ updatedAt: Date | undefined;
194
+ }
195
+ export interface GetJobInput {
196
+ jobId: string | undefined;
197
+ }
198
+ export interface JobResource {
199
+ resourceType: JobResourceType | undefined;
200
+ resourceId: string | undefined;
201
+ resourceArn: string | undefined;
202
+ }
203
+ export interface Job {
204
+ jobId: string | undefined;
205
+ status: JobStatus | undefined;
206
+ operationType: string | undefined;
207
+ createdAt: Date | undefined;
208
+ updatedAt: Date | undefined;
209
+ brandProfileId?: string | undefined;
210
+ errorCode?: string | undefined;
211
+ errorMessage?: string | undefined;
212
+ resources?: JobResource[] | undefined;
213
+ }
214
+ export interface GetNotifyCodeConfigurationInput {
215
+ notifyCodeConfigurationId: string | undefined;
216
+ }
217
+ export interface GetNotifyCodeConfigurationOutput {
218
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
219
+ }
220
+ export interface ListBrandProfileAttributesInput {
221
+ brandProfileId: string | undefined;
222
+ nextToken?: string | undefined;
223
+ maxResults?: number | undefined;
224
+ }
225
+ export interface ListBrandProfileAttributesOutput {
226
+ brandProfileAttributes: BrandProfileAttributeSummary[] | undefined;
227
+ nextToken?: string | undefined;
228
+ }
229
+ export interface ListBrandProfilesInput {
230
+ nextToken?: string | undefined;
231
+ maxResults?: number | undefined;
232
+ }
233
+ export interface ListBrandProfilesOutput {
234
+ brandProfiles: BrandProfileInfo[] | undefined;
235
+ nextToken?: string | undefined;
236
+ }
237
+ export interface ListJobsInput {
238
+ maxResults?: number | undefined;
239
+ nextToken?: string | undefined;
240
+ status?: JobStatus | undefined;
241
+ brandProfileId?: string | undefined;
242
+ operationType?: string | undefined;
243
+ }
244
+ export interface JobSummary {
245
+ jobId: string | undefined;
246
+ status: JobStatus | undefined;
247
+ operationType: string | undefined;
248
+ createdAt: Date | undefined;
249
+ updatedAt: Date | undefined;
250
+ brandProfileId?: string | undefined;
251
+ errorCode?: string | undefined;
252
+ errorMessage?: string | undefined;
253
+ resources?: JobResource[] | undefined;
254
+ }
255
+ export interface ListJobsOutput {
256
+ jobs: JobSummary[] | undefined;
257
+ nextToken?: string | undefined;
258
+ }
259
+ export interface ListNotifyCodeConfigurationsInput {
260
+ maxResults?: number | undefined;
261
+ nextToken?: string | undefined;
262
+ }
263
+ export interface ListNotifyCodeConfigurationsOutput {
264
+ notifyCodeConfigurations: NotifyCodeConfiguration[] | undefined;
265
+ nextToken?: string | undefined;
266
+ }
267
+ export interface ListRegistrationsFromBrandProfileInput {
268
+ brandProfileId: string | undefined;
269
+ maxResults?: number | undefined;
270
+ nextToken?: string | undefined;
271
+ }
272
+ export interface RegistrationAssociationSummary {
273
+ registrationId: string | undefined;
274
+ registrationType: string | undefined;
275
+ createdAt: Date | undefined;
276
+ smartMatchUsed: boolean | undefined;
277
+ }
278
+ export interface ListRegistrationsFromBrandProfileOutput {
279
+ registrationAssociations: RegistrationAssociationSummary[] | undefined;
280
+ nextToken?: string | undefined;
281
+ }
282
+ export interface ListTagsForResourceInput {
283
+ resourceArn: string | undefined;
284
+ }
285
+ export interface ListTagsForResourceOutput {
286
+ tags?: Tag[] | undefined;
287
+ }
288
+ export interface SendNotifyCodeVerificationInput {
289
+ channel: NotifyChannel | undefined;
290
+ destinationIdentity: string | undefined;
291
+ originationIdentity: string | undefined;
292
+ notifyCodeConfiguration?: string | undefined;
293
+ overrideChannelParameters?: ChannelParameters | undefined;
294
+ overrideCodeConfigurationParameters?: CodeConfigurationParameters | undefined;
295
+ configurationSetName?: string | undefined;
296
+ context?: Record<string, string> | undefined;
297
+ referenceId?: string | undefined;
298
+ }
299
+ export interface SendNotifyCodeVerificationOutput {
300
+ verificationId: string | undefined;
301
+ messageId: string | undefined;
302
+ }
303
+ export interface TagResourceInput {
304
+ resourceArn: string | undefined;
305
+ tags: Tag[] | undefined;
306
+ }
307
+ export interface TagResourceOutput {}
308
+ export interface UntagResourceInput {
309
+ resourceArn: string | undefined;
310
+ tagKeys: string[] | undefined;
311
+ }
312
+ export interface UntagResourceOutput {}
313
+ export interface UpdateBrandProfileInput {
314
+ brandProfileId: string | undefined;
315
+ brandProfileName?: string | undefined;
316
+ deletionProtectionEnabled?: boolean | undefined;
317
+ }
318
+ export interface UpdateBrandProfileOutput {
319
+ brandProfileId: string | undefined;
320
+ brandProfileArn: string | undefined;
321
+ brandProfileName: string | undefined;
322
+ status: Status | undefined;
323
+ deletionProtectionEnabled: boolean | undefined;
324
+ createdAt: Date | undefined;
325
+ updatedAt: Date | undefined;
326
+ }
327
+ export interface UpdateBrandProfileAttributeInput {
328
+ brandProfileId: string | undefined;
329
+ attributeName: string | undefined;
330
+ attributeValue?: string | undefined;
331
+ attachmentBody?: Uint8Array | undefined;
332
+ description?: string | undefined;
333
+ category?: string | undefined;
334
+ }
335
+ export interface UpdateBrandProfileAttributeOutput {
336
+ attributeName: string | undefined;
337
+ attributeType: BrandProfileAttributeType | undefined;
338
+ attributeValue?: string | undefined;
339
+ description?: string | undefined;
340
+ category?: string | undefined;
341
+ mediaContentType?: string | undefined;
342
+ mediaSizeBytes?: number | undefined;
343
+ createdAt: Date | undefined;
344
+ updatedAt: Date | undefined;
345
+ }
346
+ export interface UpdateBrandProfileFromRegistrationInput {
347
+ brandProfileId: string | undefined;
348
+ registrationId: string | undefined;
349
+ smartMatch?: boolean | undefined;
350
+ onAttributeConflict?: OnAttributeConflict | undefined;
351
+ clientToken?: string | undefined;
352
+ }
353
+ export interface UpdateBrandProfileFromRegistrationOutput {
354
+ results: JobResult[] | undefined;
355
+ }
356
+ export interface UpdateNotifyParameters {
357
+ notifyTemplateId?: string | undefined;
358
+ voiceId?: string | undefined;
359
+ }
360
+ export interface UpdateTextParameters {
361
+ inlineTemplateBody?: string | undefined;
362
+ destinationCountryParameters?: Record<string, string> | undefined;
363
+ }
364
+ export interface UpdateVoiceParameters {
365
+ inlineTemplateBody?: string | undefined;
366
+ languageCode?: string | undefined;
367
+ voiceId?: string | undefined;
368
+ voiceMessageBodyTextType?: VoiceMessageBodyTextType | undefined;
369
+ }
370
+ export interface UpdateWhatsAppParameters {
371
+ whatsAppTemplateName?: string | undefined;
372
+ languageCode?: string | undefined;
373
+ }
374
+ export interface UpdateChannelParameters {
375
+ text?: UpdateTextParameters | undefined;
376
+ voice?: UpdateVoiceParameters | undefined;
377
+ notify?: UpdateNotifyParameters | undefined;
378
+ whatsApp?: UpdateWhatsAppParameters | undefined;
379
+ }
380
+ export interface UpdateCodeConfigurationParameters {
381
+ codeType?: CodeType | undefined;
382
+ codeLength?: number | undefined;
383
+ validityPeriodMinutes?: number | undefined;
384
+ maxAttempts?: number | undefined;
385
+ }
386
+ export interface UpdateNotifyCodeConfigurationInput {
387
+ notifyCodeConfigurationId: string | undefined;
388
+ notifyCodeConfigurationName?: string | undefined;
389
+ codeConfigurationParameters?: UpdateCodeConfigurationParameters | undefined;
390
+ channelParameters?: UpdateChannelParameters | undefined;
391
+ deletionProtectionEnabled?: boolean | undefined;
392
+ }
393
+ export interface UpdateNotifyCodeConfigurationOutput {
394
+ notifyCodeConfiguration: NotifyCodeConfiguration | undefined;
395
+ }
396
+ export interface UpdateRegistrationsFromBrandProfileInput {
397
+ brandProfileId: string | undefined;
398
+ registrationIds: string[] | undefined;
399
+ smartMatch?: boolean | undefined;
400
+ onAttributeConflict?: OnAttributeConflict | undefined;
401
+ clientToken?: string | undefined;
402
+ }
403
+ export interface UpdateRegistrationsFromBrandProfileOutput {
404
+ results: JobResult[] | undefined;
405
+ }
406
+ export interface ValidateNotifyCodeVerificationInput {
407
+ destinationIdentity: string | undefined;
408
+ referenceId?: string | undefined;
409
+ code: string | undefined;
410
+ }
411
+ export interface ValidateNotifyCodeVerificationOutput {
412
+ status: VerificationStatus | undefined;
413
+ }
@@ -0,0 +1,5 @@
1
+ import { PaginationConfiguration } from "@smithy/types";
2
+ import { EndUserMessagingClient } from "../EndUserMessagingClient";
3
+ export interface EndUserMessagingPaginationConfiguration extends PaginationConfiguration {
4
+ client: EndUserMessagingClient;
5
+ }
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListBrandProfileAttributesCommandInput,
4
+ ListBrandProfileAttributesCommandOutput,
5
+ } from "../commands/ListBrandProfileAttributesCommand";
6
+ import { EndUserMessagingPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListBrandProfileAttributes: (
8
+ config: EndUserMessagingPaginationConfiguration,
9
+ input: ListBrandProfileAttributesCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListBrandProfileAttributesCommandOutput>;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListBrandProfilesCommandInput,
4
+ ListBrandProfilesCommandOutput,
5
+ } from "../commands/ListBrandProfilesCommand";
6
+ import { EndUserMessagingPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListBrandProfiles: (
8
+ config: EndUserMessagingPaginationConfiguration,
9
+ input: ListBrandProfilesCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListBrandProfilesCommandOutput>;
@@ -0,0 +1,8 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { ListJobsCommandInput, ListJobsCommandOutput } from "../commands/ListJobsCommand";
3
+ import { EndUserMessagingPaginationConfiguration } from "./Interfaces";
4
+ export declare const paginateListJobs: (
5
+ config: EndUserMessagingPaginationConfiguration,
6
+ input: ListJobsCommandInput,
7
+ ...rest: any[]
8
+ ) => Paginator<ListJobsCommandOutput>;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListNotifyCodeConfigurationsCommandInput,
4
+ ListNotifyCodeConfigurationsCommandOutput,
5
+ } from "../commands/ListNotifyCodeConfigurationsCommand";
6
+ import { EndUserMessagingPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListNotifyCodeConfigurations: (
8
+ config: EndUserMessagingPaginationConfiguration,
9
+ input: ListNotifyCodeConfigurationsCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListNotifyCodeConfigurationsCommandOutput>;
@@ -0,0 +1,11 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import {
3
+ ListRegistrationsFromBrandProfileCommandInput,
4
+ ListRegistrationsFromBrandProfileCommandOutput,
5
+ } from "../commands/ListRegistrationsFromBrandProfileCommand";
6
+ import { EndUserMessagingPaginationConfiguration } from "./Interfaces";
7
+ export declare const paginateListRegistrationsFromBrandProfile: (
8
+ config: EndUserMessagingPaginationConfiguration,
9
+ input: ListRegistrationsFromBrandProfileCommandInput,
10
+ ...rest: any[]
11
+ ) => Paginator<ListRegistrationsFromBrandProfileCommandOutput>;
@@ -0,0 +1,6 @@
1
+ export * from "./Interfaces";
2
+ export * from "./ListBrandProfileAttributesPaginator";
3
+ export * from "./ListBrandProfilesPaginator";
4
+ export * from "./ListJobsPaginator";
5
+ export * from "./ListNotifyCodeConfigurationsPaginator";
6
+ export * from "./ListRegistrationsFromBrandProfilePaginator";
@@ -0,0 +1,93 @@
1
+ import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
2
+ import { EndUserMessagingClientConfig } from "./EndUserMessagingClient";
3
+ export declare const getRuntimeConfig: (config: EndUserMessagingClientConfig) => {
4
+ cacheMiddleware?: boolean;
5
+ endpoint?:
6
+ | ((
7
+ | string
8
+ | import("@smithy/types").Endpoint
9
+ | import("@smithy/types").EndpointV2
10
+ | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
11
+ | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
12
+ ) &
13
+ (
14
+ | string
15
+ | import("@smithy/types").Endpoint
16
+ | import("@smithy/types").EndpointV2
17
+ | import("@smithy/types").Provider<string>
18
+ | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
19
+ | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
20
+ ))
21
+ | undefined;
22
+ tls?: boolean;
23
+ ignoreConfiguredEndpointUrls?: boolean;
24
+ serviceConfiguredEndpoint?: never;
25
+ customUserAgent?: string | import("@smithy/types").UserAgent;
26
+ userAgentAppId?: string | undefined | import("@smithy/types").Provider<string | undefined>;
27
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2;
28
+ credentials?:
29
+ | import("@smithy/types").AwsCredentialIdentity
30
+ | import("@smithy/types").AwsCredentialIdentityProvider;
31
+ signer?:
32
+ | import("@smithy/types").RequestSigner
33
+ | ((
34
+ authScheme?: import("@smithy/types").AuthScheme,
35
+ ) => Promise<import("@smithy/types").RequestSigner>);
36
+ signingEscapePath?: boolean;
37
+ systemClockOffset?: number;
38
+ signingRegion?: string;
39
+ signerConstructor?: new (
40
+ options: import("@smithy/signature-v4").SignatureV4Init &
41
+ import("@smithy/signature-v4").SignatureV4CryptoInit,
42
+ ) => import("@smithy/types").RequestSigner;
43
+ disableClockSkewCorrection?: boolean | import("@smithy/types").Provider<boolean>;
44
+ authSchemePreference?: string[] | import("@smithy/types").Provider<string[]>;
45
+ apiVersion: string;
46
+ base64Decoder: import("@smithy/types").Decoder;
47
+ base64Encoder: (_input: Uint8Array | string) => string;
48
+ disableHostPrefix: boolean;
49
+ endpointProvider: (
50
+ params: import("./endpoint/EndpointParameters").EndpointParameters,
51
+ context?: {
52
+ logger?: import("@smithy/types").Logger;
53
+ },
54
+ ) => import("@smithy/types").EndpointV2;
55
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
56
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").EndUserMessagingHttpAuthSchemeProvider;
57
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
58
+ logger: import("@smithy/types").Logger;
59
+ protocol:
60
+ | import("@smithy/types").$ClientProtocol<any, any>
61
+ | import("@smithy/types").$ClientProtocolCtor<any, any>
62
+ | typeof import("@aws-sdk/core/protocols").AwsRestJsonProtocol;
63
+ protocolSettings: {
64
+ [setting: string]: unknown;
65
+ defaultNamespace?: string;
66
+ };
67
+ serviceId: string;
68
+ sha256: import("@smithy/types").HashConstructor;
69
+ urlParser: import("@smithy/types").UrlParser;
70
+ utf8Decoder: import("@smithy/types").Decoder;
71
+ utf8Encoder: (input: Uint8Array | string) => string;
72
+ profile?: string;
73
+ runtime: string;
74
+ defaultsMode: import("@smithy/types").Provider<
75
+ import("@smithy/core/client").ResolvedDefaultsMode
76
+ >;
77
+ bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
78
+ credentialDefaultProvider:
79
+ | ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider)
80
+ | ((_: unknown) => () => Promise<import("@smithy/types").AwsCredentialIdentity>);
81
+ defaultUserAgentProvider: (
82
+ config?: import("@aws-sdk/core/client").PreviouslyResolved,
83
+ ) => Promise<import("@smithy/types").UserAgent>;
84
+ maxAttempts: number | import("@smithy/types").Provider<number>;
85
+ region: string | import("@smithy/types").Provider<any>;
86
+ requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
87
+ retryMode: string | import("@smithy/types").Provider<string>;
88
+ streamCollector: (
89
+ stream: import("stream").Readable | import("stream/web").ReadableStream | ReadableStream | Blob,
90
+ ) => Promise<Uint8Array>;
91
+ useDualstackEndpoint: boolean | (() => Promise<boolean>);
92
+ useFipsEndpoint: boolean | (() => Promise<boolean>);
93
+ };
@@ -0,0 +1,95 @@
1
+ import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
2
+ import { EndUserMessagingClientConfig } from "./EndUserMessagingClient";
3
+ export declare const getRuntimeConfig: (config: EndUserMessagingClientConfig) => {
4
+ cacheMiddleware?: boolean;
5
+ endpoint?:
6
+ | ((
7
+ | string
8
+ | import("@smithy/types").Endpoint
9
+ | import("@smithy/types").EndpointV2
10
+ | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
11
+ | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
12
+ ) &
13
+ (
14
+ | string
15
+ | import("@smithy/types").Endpoint
16
+ | import("@smithy/types").EndpointV2
17
+ | import("@smithy/types").Provider<string>
18
+ | import("@smithy/types").Provider<import("@smithy/types").Endpoint>
19
+ | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>
20
+ ))
21
+ | undefined;
22
+ tls?: boolean;
23
+ ignoreConfiguredEndpointUrls?: boolean;
24
+ serviceConfiguredEndpoint?: never;
25
+ customUserAgent?: string | import("@smithy/types").UserAgent;
26
+ retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2;
27
+ credentials?:
28
+ | import("@smithy/types").AwsCredentialIdentity
29
+ | import("@smithy/types").AwsCredentialIdentityProvider;
30
+ signer?:
31
+ | import("@smithy/types").RequestSigner
32
+ | ((
33
+ authScheme?: import("@smithy/types").AuthScheme,
34
+ ) => Promise<import("@smithy/types").RequestSigner>);
35
+ signingEscapePath?: boolean;
36
+ systemClockOffset?: number;
37
+ signingRegion?: string;
38
+ signerConstructor?: new (
39
+ options: import("@smithy/signature-v4").SignatureV4Init &
40
+ import("@smithy/signature-v4").SignatureV4CryptoInit,
41
+ ) => import("@smithy/types").RequestSigner;
42
+ disableClockSkewCorrection?: boolean | import("@smithy/types").Provider<boolean>;
43
+ apiVersion: string;
44
+ base64Decoder: import("@smithy/types").Decoder;
45
+ base64Encoder: (_input: Uint8Array | string) => string;
46
+ disableHostPrefix: boolean;
47
+ endpointProvider: (
48
+ params: import("./endpoint/EndpointParameters").EndpointParameters,
49
+ context?: {
50
+ logger?: import("@smithy/types").Logger;
51
+ },
52
+ ) => import("@smithy/types").EndpointV2;
53
+ extensions: import("./runtimeExtensions").RuntimeExtension[];
54
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").EndUserMessagingHttpAuthSchemeProvider;
55
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
56
+ logger: import("@smithy/types").Logger;
57
+ protocol:
58
+ | import("@smithy/types").$ClientProtocol<any, any>
59
+ | import("@smithy/types").$ClientProtocolCtor<any, any>
60
+ | typeof import("@aws-sdk/core/protocols").AwsRestJsonProtocol;
61
+ protocolSettings: {
62
+ [setting: string]: unknown;
63
+ defaultNamespace?: string;
64
+ };
65
+ serviceId: string;
66
+ sha256: import("@smithy/types").HashConstructor;
67
+ urlParser: import("@smithy/types").UrlParser;
68
+ utf8Decoder: import("@smithy/types").Decoder;
69
+ utf8Encoder: (input: Uint8Array | string) => string;
70
+ runtime: string;
71
+ defaultsMode: import("@smithy/types").Provider<
72
+ import("@smithy/core/client").ResolvedDefaultsMode
73
+ >;
74
+ authSchemePreference: string[] | import("@smithy/types").Provider<string[]>;
75
+ bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
76
+ credentialDefaultProvider:
77
+ | ((
78
+ init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit,
79
+ ) => import("@aws-sdk/credential-provider-node").MemoizedRuntimeConfigAwsCredentialIdentityProvider)
80
+ | ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider);
81
+ defaultUserAgentProvider: (
82
+ config?: import("@aws-sdk/core/client").PreviouslyResolved,
83
+ ) => Promise<import("@smithy/types").UserAgent>;
84
+ maxAttempts: number | import("@smithy/types").Provider<number>;
85
+ region: string | import("@smithy/types").Provider<string>;
86
+ requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
87
+ retryMode: string | import("@smithy/types").Provider<string>;
88
+ streamCollector: (
89
+ stream: import("stream").Readable | import("stream/web").ReadableStream | ReadableStream | Blob,
90
+ ) => Promise<Uint8Array>;
91
+ useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
92
+ useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
93
+ userAgentAppId: string | import("@smithy/types").Provider<string | undefined>;
94
+ profile?: string;
95
+ };