@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.
- package/LICENSE +201 -0
- package/README.md +370 -0
- package/dist-cjs/index.js +1645 -0
- package/dist-es/EndUserMessaging.js +79 -0
- package/dist-es/EndUserMessagingClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commandBuilder.js +6 -0
- package/dist-es/commands/CreateBrandProfileAttributesCommand.js +4 -0
- package/dist-es/commands/CreateBrandProfileCommand.js +4 -0
- package/dist-es/commands/CreateBrandProfileFromRegistrationCommand.js +4 -0
- package/dist-es/commands/CreateNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/CreateRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/DeleteBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/DeleteBrandProfileCommand.js +4 -0
- package/dist-es/commands/DeleteNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/GetBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/GetBrandProfileCommand.js +4 -0
- package/dist-es/commands/GetJobCommand.js +4 -0
- package/dist-es/commands/GetNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/ListBrandProfileAttributesCommand.js +4 -0
- package/dist-es/commands/ListBrandProfilesCommand.js +4 -0
- package/dist-es/commands/ListJobsCommand.js +4 -0
- package/dist-es/commands/ListNotifyCodeConfigurationsCommand.js +4 -0
- package/dist-es/commands/ListRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +4 -0
- package/dist-es/commands/SendNotifyCodeVerificationCommand.js +4 -0
- package/dist-es/commands/TagResourceCommand.js +4 -0
- package/dist-es/commands/UntagResourceCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileAttributeCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileCommand.js +4 -0
- package/dist-es/commands/UpdateBrandProfileFromRegistrationCommand.js +4 -0
- package/dist-es/commands/UpdateNotifyCodeConfigurationCommand.js +4 -0
- package/dist-es/commands/UpdateRegistrationsFromBrandProfileCommand.js +4 -0
- package/dist-es/commands/ValidateNotifyCodeVerificationCommand.js +4 -0
- package/dist-es/commands/index.js +27 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/bdd.js +46 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +11 -0
- package/dist-es/models/EndUserMessagingServiceException.js +8 -0
- package/dist-es/models/enums.js +43 -0
- package/dist-es/models/errors.js +99 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListBrandProfileAttributesPaginator.js +4 -0
- package/dist-es/pagination/ListBrandProfilesPaginator.js +4 -0
- package/dist-es/pagination/ListJobsPaginator.js +4 -0
- package/dist-es/pagination/ListNotifyCodeConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/ListRegistrationsFromBrandProfilePaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/runtimeConfig.browser.js +29 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +9 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +818 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForBrandProfileActive.js +58 -0
- package/dist-es/waiters/waitForJobSuccess.js +40 -0
- package/dist-types/EndUserMessaging.d.ts +256 -0
- package/dist-types/EndUserMessagingClient.d.ts +213 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commandBuilder.d.ts +18 -0
- package/dist-types/commands/CreateBrandProfileAttributesCommand.d.ts +139 -0
- package/dist-types/commands/CreateBrandProfileCommand.d.ts +129 -0
- package/dist-types/commands/CreateBrandProfileFromRegistrationCommand.d.ts +130 -0
- package/dist-types/commands/CreateNotifyCodeConfigurationCommand.d.ts +206 -0
- package/dist-types/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +125 -0
- package/dist-types/commands/DeleteBrandProfileAttributeCommand.d.ts +110 -0
- package/dist-types/commands/DeleteBrandProfileCommand.d.ts +108 -0
- package/dist-types/commands/DeleteNotifyCodeConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetBrandProfileAttributeCommand.d.ts +119 -0
- package/dist-types/commands/GetBrandProfileCommand.d.ts +115 -0
- package/dist-types/commands/GetJobCommand.d.ts +129 -0
- package/dist-types/commands/GetNotifyCodeConfigurationCommand.d.ts +156 -0
- package/dist-types/commands/ListBrandProfileAttributesCommand.d.ts +124 -0
- package/dist-types/commands/ListBrandProfilesCommand.d.ts +122 -0
- package/dist-types/commands/ListJobsCommand.d.ts +133 -0
- package/dist-types/commands/ListNotifyCodeConfigurationsCommand.d.ts +159 -0
- package/dist-types/commands/ListRegistrationsFromBrandProfileCommand.d.ts +121 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +113 -0
- package/dist-types/commands/SendNotifyCodeVerificationCommand.d.ts +151 -0
- package/dist-types/commands/TagResourceCommand.d.ts +114 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +105 -0
- package/dist-types/commands/UpdateBrandProfileAttributeCommand.d.ts +127 -0
- package/dist-types/commands/UpdateBrandProfileCommand.d.ts +122 -0
- package/dist-types/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +123 -0
- package/dist-types/commands/UpdateNotifyCodeConfigurationCommand.d.ts +193 -0
- package/dist-types/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +127 -0
- package/dist-types/commands/ValidateNotifyCodeVerificationCommand.d.ts +104 -0
- package/dist-types/commands/index.d.ts +27 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +50 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +19 -0
- package/dist-types/models/EndUserMessagingServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +145 -0
- package/dist-types/models/errors.d.ts +119 -0
- package/dist-types/models/models_0.d.ts +1667 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListBrandProfileAttributesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBrandProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/runtimeConfig.browser.d.ts +57 -0
- package/dist-types/runtimeConfig.d.ts +57 -0
- package/dist-types/runtimeConfig.native.d.ts +56 -0
- package/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +120 -0
- package/dist-types/ts3.4/EndUserMessaging.d.ts +515 -0
- package/dist-types/ts3.4/EndUserMessagingClient.d.ts +256 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileAttributesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateBrandProfileFromRegistrationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteBrandProfileAttributeCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetBrandProfileAttributeCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetBrandProfileCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListBrandProfileAttributesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListBrandProfilesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListNotifyCodeConfigurationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/SendNotifyCodeVerificationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileAttributeCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateBrandProfileFromRegistrationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateNotifyCodeConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateRegistrationsFromBrandProfileCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ValidateNotifyCodeVerificationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +27 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
- package/dist-types/ts3.4/index.d.ts +14 -0
- package/dist-types/ts3.4/models/EndUserMessagingServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +54 -0
- package/dist-types/ts3.4/models/errors.d.ts +47 -0
- package/dist-types/ts3.4/models/models_0.d.ts +413 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListBrandProfileAttributesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBrandProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListNotifyCodeConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRegistrationsFromBrandProfilePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +115 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForBrandProfileActive.d.ts +15 -0
- package/dist-types/ts3.4/waiters/waitForJobSuccess.d.ts +12 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForBrandProfileActive.d.ts +15 -0
- package/dist-types/waiters/waitForJobSuccess.d.ts +15 -0
- package/package.json +69 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateBrandProfileFromRegistrationInput, UpdateBrandProfileFromRegistrationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateBrandProfileFromRegistrationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateBrandProfileFromRegistrationCommandInput extends UpdateBrandProfileFromRegistrationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateBrandProfileFromRegistrationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateBrandProfileFromRegistrationCommandOutput extends UpdateBrandProfileFromRegistrationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateBrandProfileFromRegistrationCommand_base: {
|
|
22
|
+
new (input: UpdateBrandProfileFromRegistrationCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileFromRegistrationCommandInput, UpdateBrandProfileFromRegistrationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateBrandProfileFromRegistrationCommandInput): import("@smithy/core/client").CommandImpl<UpdateBrandProfileFromRegistrationCommandInput, UpdateBrandProfileFromRegistrationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Imports or refreshes the attributes of an existing brand profile from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UpdateBrandProfileFromRegistrationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UpdateBrandProfileFromRegistrationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // UpdateBrandProfileFromRegistrationInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* registrationId: "STRING_VALUE", // required
|
|
39
|
+
* smartMatch: true || false,
|
|
40
|
+
* onAttributeConflict: "REPLACE" || "PRESERVE",
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UpdateBrandProfileFromRegistrationCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // UpdateBrandProfileFromRegistrationOutput
|
|
46
|
+
* // results: [ // JobResults // required
|
|
47
|
+
* // { // JobResult
|
|
48
|
+
* // jobId: "STRING_VALUE", // required
|
|
49
|
+
* // resourceIdentifier: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param UpdateBrandProfileFromRegistrationCommandInput - {@link UpdateBrandProfileFromRegistrationCommandInput}
|
|
57
|
+
* @returns {@link UpdateBrandProfileFromRegistrationCommandOutput}
|
|
58
|
+
* @see {@link UpdateBrandProfileFromRegistrationCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link UpdateBrandProfileFromRegistrationCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ConflictException} (client fault)
|
|
66
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ValidationException} (client fault)
|
|
78
|
+
* A standard error for input validation failures.
|
|
79
|
+
* This should be thrown by services when a member of the input structure
|
|
80
|
+
* falls outside of the modeled or documented constraints.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @example Update a brand profile from a registration
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
91
|
+
* onAttributeConflict: "REPLACE",
|
|
92
|
+
* registrationId: "reg-abc12345678901234",
|
|
93
|
+
* smartMatch: true
|
|
94
|
+
* };
|
|
95
|
+
* const command = new UpdateBrandProfileFromRegistrationCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response is
|
|
98
|
+
* {
|
|
99
|
+
* results: [
|
|
100
|
+
* {
|
|
101
|
+
* jobId: "job-abc12345678901234",
|
|
102
|
+
* resourceIdentifier: "reg-abc12345678901234"
|
|
103
|
+
* }
|
|
104
|
+
* ]
|
|
105
|
+
* }
|
|
106
|
+
* *\/
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class UpdateBrandProfileFromRegistrationCommand extends UpdateBrandProfileFromRegistrationCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: UpdateBrandProfileFromRegistrationInput;
|
|
116
|
+
output: UpdateBrandProfileFromRegistrationOutput;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: UpdateBrandProfileFromRegistrationCommandInput;
|
|
120
|
+
output: UpdateBrandProfileFromRegistrationCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateNotifyCodeConfigurationInput, UpdateNotifyCodeConfigurationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateNotifyCodeConfigurationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateNotifyCodeConfigurationCommandInput extends UpdateNotifyCodeConfigurationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateNotifyCodeConfigurationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateNotifyCodeConfigurationCommandOutput extends UpdateNotifyCodeConfigurationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateNotifyCodeConfigurationCommand_base: {
|
|
22
|
+
new (input: UpdateNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateNotifyCodeConfigurationCommandInput, UpdateNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateNotifyCodeConfigurationCommandInput): import("@smithy/core/client").CommandImpl<UpdateNotifyCodeConfigurationCommandInput, UpdateNotifyCodeConfigurationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Updates the mutable fields of a notify code configuration. Only the fields that you supply are changed. For the template and language fields, supplying an empty value clears the currently stored value.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UpdateNotifyCodeConfigurationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UpdateNotifyCodeConfigurationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // UpdateNotifyCodeConfigurationInput
|
|
37
|
+
* notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
38
|
+
* notifyCodeConfigurationName: "STRING_VALUE",
|
|
39
|
+
* codeConfigurationParameters: { // UpdateCodeConfigurationParameters
|
|
40
|
+
* codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
41
|
+
* codeLength: Number("int"),
|
|
42
|
+
* validityPeriodMinutes: Number("int"),
|
|
43
|
+
* maxAttempts: Number("int"),
|
|
44
|
+
* },
|
|
45
|
+
* channelParameters: { // UpdateChannelParameters
|
|
46
|
+
* text: { // UpdateTextParameters
|
|
47
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
48
|
+
* destinationCountryParameters: { // UpdateDestinationCountryParameters
|
|
49
|
+
* "<keys>": "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* },
|
|
52
|
+
* voice: { // UpdateVoiceParameters
|
|
53
|
+
* inlineTemplateBody: "STRING_VALUE",
|
|
54
|
+
* languageCode: "STRING_VALUE",
|
|
55
|
+
* voiceId: "STRING_VALUE",
|
|
56
|
+
* voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
57
|
+
* },
|
|
58
|
+
* notify: { // UpdateNotifyParameters
|
|
59
|
+
* notifyTemplateId: "STRING_VALUE",
|
|
60
|
+
* voiceId: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* whatsApp: { // UpdateWhatsAppParameters
|
|
63
|
+
* whatsAppTemplateName: "STRING_VALUE",
|
|
64
|
+
* languageCode: "STRING_VALUE",
|
|
65
|
+
* },
|
|
66
|
+
* },
|
|
67
|
+
* deletionProtectionEnabled: true || false,
|
|
68
|
+
* };
|
|
69
|
+
* const command = new UpdateNotifyCodeConfigurationCommand(input);
|
|
70
|
+
* const response = await client.send(command);
|
|
71
|
+
* // { // UpdateNotifyCodeConfigurationOutput
|
|
72
|
+
* // notifyCodeConfiguration: { // NotifyCodeConfiguration
|
|
73
|
+
* // notifyCodeConfigurationId: "STRING_VALUE", // required
|
|
74
|
+
* // notifyCodeConfigurationArn: "STRING_VALUE", // required
|
|
75
|
+
* // notifyCodeConfigurationName: "STRING_VALUE", // required
|
|
76
|
+
* // codeConfigurationParameters: { // CodeConfigurationParameters
|
|
77
|
+
* // codeType: "NUMERIC" || "ALPHA" || "ALPHANUMERIC",
|
|
78
|
+
* // codeLength: Number("int"),
|
|
79
|
+
* // validityPeriodMinutes: Number("int"),
|
|
80
|
+
* // maxAttempts: Number("int"),
|
|
81
|
+
* // },
|
|
82
|
+
* // channelParameters: { // ChannelParameters
|
|
83
|
+
* // text: { // TextParameters
|
|
84
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
85
|
+
* // destinationCountryParameters: { // DestinationCountryParameters
|
|
86
|
+
* // "<keys>": "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // voice: { // VoiceParameters
|
|
90
|
+
* // inlineTemplateBody: "STRING_VALUE",
|
|
91
|
+
* // languageCode: "STRING_VALUE",
|
|
92
|
+
* // voiceId: "STRING_VALUE",
|
|
93
|
+
* // voiceMessageBodyTextType: "TEXT" || "SSML",
|
|
94
|
+
* // },
|
|
95
|
+
* // notify: { // NotifyParameters
|
|
96
|
+
* // notifyTemplateId: "STRING_VALUE",
|
|
97
|
+
* // voiceId: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // whatsApp: { // WhatsAppParameters
|
|
100
|
+
* // whatsAppTemplateName: "STRING_VALUE",
|
|
101
|
+
* // languageCode: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // },
|
|
104
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
105
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
106
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
107
|
+
* // },
|
|
108
|
+
* // };
|
|
109
|
+
*
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
112
|
+
* @param UpdateNotifyCodeConfigurationCommandInput - {@link UpdateNotifyCodeConfigurationCommandInput}
|
|
113
|
+
* @returns {@link UpdateNotifyCodeConfigurationCommandOutput}
|
|
114
|
+
* @see {@link UpdateNotifyCodeConfigurationCommandInput} for command's `input` shape.
|
|
115
|
+
* @see {@link UpdateNotifyCodeConfigurationCommandOutput} for command's `response` shape.
|
|
116
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
119
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link ConflictException} (client fault)
|
|
122
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link InternalServerException} (server fault)
|
|
125
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
128
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
131
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ValidationException} (client fault)
|
|
134
|
+
* A standard error for input validation failures.
|
|
135
|
+
* This should be thrown by services when a member of the input structure
|
|
136
|
+
* falls outside of the modeled or documented constraints.
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
139
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
140
|
+
*
|
|
141
|
+
*
|
|
142
|
+
* @example Update a notify code configuration
|
|
143
|
+
* ```javascript
|
|
144
|
+
* //
|
|
145
|
+
* const input = {
|
|
146
|
+
* codeConfigurationParameters: {
|
|
147
|
+
* codeLength: 8,
|
|
148
|
+
* validityPeriodMinutes: 15
|
|
149
|
+
* },
|
|
150
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234"
|
|
151
|
+
* };
|
|
152
|
+
* const command = new UpdateNotifyCodeConfigurationCommand(input);
|
|
153
|
+
* const response = await client.send(command);
|
|
154
|
+
* /* response is
|
|
155
|
+
* {
|
|
156
|
+
* notifyCodeConfiguration: {
|
|
157
|
+
* channelParameters: {
|
|
158
|
+
* text: {
|
|
159
|
+
* inlineTemplateBody: "Your verification code is {{code}}."
|
|
160
|
+
* }
|
|
161
|
+
* },
|
|
162
|
+
* codeConfigurationParameters: {
|
|
163
|
+
* codeLength: 8,
|
|
164
|
+
* codeType: "NUMERIC",
|
|
165
|
+
* maxAttempts: 3,
|
|
166
|
+
* validityPeriodMinutes: 15
|
|
167
|
+
* },
|
|
168
|
+
* createdAt: 1727130000,
|
|
169
|
+
* deletionProtectionEnabled: false,
|
|
170
|
+
* notifyCodeConfigurationArn: "arn:aws:end-user-messaging:us-east-1:123456789012:notify-code-configuration/ncc-abc12345678901234",
|
|
171
|
+
* notifyCodeConfigurationId: "ncc-abc12345678901234",
|
|
172
|
+
* notifyCodeConfigurationName: "SignupOtp",
|
|
173
|
+
* updatedAt: 1727216400
|
|
174
|
+
* }
|
|
175
|
+
* }
|
|
176
|
+
* *\/
|
|
177
|
+
* ```
|
|
178
|
+
*
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export declare class UpdateNotifyCodeConfigurationCommand extends UpdateNotifyCodeConfigurationCommand_base {
|
|
182
|
+
/** @internal type navigation helper, not in runtime. */
|
|
183
|
+
protected static __types: {
|
|
184
|
+
api: {
|
|
185
|
+
input: UpdateNotifyCodeConfigurationInput;
|
|
186
|
+
output: UpdateNotifyCodeConfigurationOutput;
|
|
187
|
+
};
|
|
188
|
+
sdk: {
|
|
189
|
+
input: UpdateNotifyCodeConfigurationCommandInput;
|
|
190
|
+
output: UpdateNotifyCodeConfigurationCommandOutput;
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { UpdateRegistrationsFromBrandProfileInput, UpdateRegistrationsFromBrandProfileOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link UpdateRegistrationsFromBrandProfileCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface UpdateRegistrationsFromBrandProfileCommandInput extends UpdateRegistrationsFromBrandProfileInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link UpdateRegistrationsFromBrandProfileCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateRegistrationsFromBrandProfileCommandOutput extends UpdateRegistrationsFromBrandProfileOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const UpdateRegistrationsFromBrandProfileCommand_base: {
|
|
22
|
+
new (input: UpdateRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<UpdateRegistrationsFromBrandProfileCommandInput, UpdateRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: UpdateRegistrationsFromBrandProfileCommandInput): import("@smithy/core/client").CommandImpl<UpdateRegistrationsFromBrandProfileCommandInput, UpdateRegistrationsFromBrandProfileCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Repushes the attributes of a brand profile into existing DRAFT registrations. This operation runs asynchronously. Use the GetJob operation to track its progress.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, UpdateRegistrationsFromBrandProfileCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, UpdateRegistrationsFromBrandProfileCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // UpdateRegistrationsFromBrandProfileInput
|
|
37
|
+
* brandProfileId: "STRING_VALUE", // required
|
|
38
|
+
* registrationIds: [ // RegistrationIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* smartMatch: true || false,
|
|
42
|
+
* onAttributeConflict: "REPLACE" || "PRESERVE",
|
|
43
|
+
* clientToken: "STRING_VALUE",
|
|
44
|
+
* };
|
|
45
|
+
* const command = new UpdateRegistrationsFromBrandProfileCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // UpdateRegistrationsFromBrandProfileOutput
|
|
48
|
+
* // results: [ // JobResults // required
|
|
49
|
+
* // { // JobResult
|
|
50
|
+
* // jobId: "STRING_VALUE", // required
|
|
51
|
+
* // resourceIdentifier: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param UpdateRegistrationsFromBrandProfileCommandInput - {@link UpdateRegistrationsFromBrandProfileCommandInput}
|
|
59
|
+
* @returns {@link UpdateRegistrationsFromBrandProfileCommandOutput}
|
|
60
|
+
* @see {@link UpdateRegistrationsFromBrandProfileCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link UpdateRegistrationsFromBrandProfileCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConflictException} (client fault)
|
|
68
|
+
* <p>The request conflicts with the current state of the resource.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* A standard error for input validation failures.
|
|
81
|
+
* This should be thrown by services when a member of the input structure
|
|
82
|
+
* falls outside of the modeled or documented constraints.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
86
|
+
*
|
|
87
|
+
*
|
|
88
|
+
* @example Update registrations from a brand profile
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* brandProfileId: "bp-abc12345678901234",
|
|
93
|
+
* onAttributeConflict: "PRESERVE",
|
|
94
|
+
* registrationIds: [
|
|
95
|
+
* "reg-abc12345678901234"
|
|
96
|
+
* ],
|
|
97
|
+
* smartMatch: true
|
|
98
|
+
* };
|
|
99
|
+
* const command = new UpdateRegistrationsFromBrandProfileCommand(input);
|
|
100
|
+
* const response = await client.send(command);
|
|
101
|
+
* /* response is
|
|
102
|
+
* {
|
|
103
|
+
* results: [
|
|
104
|
+
* {
|
|
105
|
+
* jobId: "job-abc12345678901234",
|
|
106
|
+
* resourceIdentifier: "reg-abc12345678901234"
|
|
107
|
+
* }
|
|
108
|
+
* ]
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
export declare class UpdateRegistrationsFromBrandProfileCommand extends UpdateRegistrationsFromBrandProfileCommand_base {
|
|
116
|
+
/** @internal type navigation helper, not in runtime. */
|
|
117
|
+
protected static __types: {
|
|
118
|
+
api: {
|
|
119
|
+
input: UpdateRegistrationsFromBrandProfileInput;
|
|
120
|
+
output: UpdateRegistrationsFromBrandProfileOutput;
|
|
121
|
+
};
|
|
122
|
+
sdk: {
|
|
123
|
+
input: UpdateRegistrationsFromBrandProfileCommandInput;
|
|
124
|
+
output: UpdateRegistrationsFromBrandProfileCommandOutput;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ValidateNotifyCodeVerificationInput, ValidateNotifyCodeVerificationOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ValidateNotifyCodeVerificationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ValidateNotifyCodeVerificationCommandInput extends ValidateNotifyCodeVerificationInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ValidateNotifyCodeVerificationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ValidateNotifyCodeVerificationCommandOutput extends ValidateNotifyCodeVerificationOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ValidateNotifyCodeVerificationCommand_base: {
|
|
22
|
+
new (input: ValidateNotifyCodeVerificationCommandInput): import("@smithy/core/client").CommandImpl<ValidateNotifyCodeVerificationCommandInput, ValidateNotifyCodeVerificationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: ValidateNotifyCodeVerificationCommandInput): import("@smithy/core/client").CommandImpl<ValidateNotifyCodeVerificationCommandInput, ValidateNotifyCodeVerificationCommandOutput, import("..").EndUserMessagingClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EndUserMessagingClient, ValidateNotifyCodeVerificationCommand } from "@aws-sdk/client-endusermessaging"; // ES Modules import
|
|
32
|
+
* // const { EndUserMessagingClient, ValidateNotifyCodeVerificationCommand } = require("@aws-sdk/client-endusermessaging"); // CommonJS import
|
|
33
|
+
* // import type { EndUserMessagingClientConfig } from "@aws-sdk/client-endusermessaging";
|
|
34
|
+
* const config = {}; // type is EndUserMessagingClientConfig
|
|
35
|
+
* const client = new EndUserMessagingClient(config);
|
|
36
|
+
* const input = { // ValidateNotifyCodeVerificationInput
|
|
37
|
+
* destinationIdentity: "STRING_VALUE", // required
|
|
38
|
+
* referenceId: "STRING_VALUE",
|
|
39
|
+
* code: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ValidateNotifyCodeVerificationCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ValidateNotifyCodeVerificationOutput
|
|
44
|
+
* // status: "VALID" || "INVALID", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param ValidateNotifyCodeVerificationCommandInput - {@link ValidateNotifyCodeVerificationCommandInput}
|
|
50
|
+
* @returns {@link ValidateNotifyCodeVerificationCommandOutput}
|
|
51
|
+
* @see {@link ValidateNotifyCodeVerificationCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link ValidateNotifyCodeVerificationCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link EndUserMessagingClientResolvedConfig | config} for EndUserMessagingClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerException} (server fault)
|
|
59
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
62
|
+
* <p>The request was denied because it exceeded the allowed request rate.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
* A standard error for input validation failures.
|
|
66
|
+
* This should be thrown by services when a member of the input structure
|
|
67
|
+
* falls outside of the modeled or documented constraints.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link EndUserMessagingServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from EndUserMessaging service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @example Validate a submitted one-time passcode
|
|
74
|
+
* ```javascript
|
|
75
|
+
* //
|
|
76
|
+
* const input = {
|
|
77
|
+
* code: "123456",
|
|
78
|
+
* destinationIdentity: "+14255550100",
|
|
79
|
+
* referenceId: "signup-flow-42"
|
|
80
|
+
* };
|
|
81
|
+
* const command = new ValidateNotifyCodeVerificationCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* /* response is
|
|
84
|
+
* {
|
|
85
|
+
* status: "VALID"
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class ValidateNotifyCodeVerificationCommand extends ValidateNotifyCodeVerificationCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: ValidateNotifyCodeVerificationInput;
|
|
97
|
+
output: ValidateNotifyCodeVerificationOutput;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: ValidateNotifyCodeVerificationCommandInput;
|
|
101
|
+
output: ValidateNotifyCodeVerificationCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export * from "./CreateBrandProfileAttributesCommand";
|
|
2
|
+
export * from "./CreateBrandProfileCommand";
|
|
3
|
+
export * from "./CreateBrandProfileFromRegistrationCommand";
|
|
4
|
+
export * from "./CreateNotifyCodeConfigurationCommand";
|
|
5
|
+
export * from "./CreateRegistrationsFromBrandProfileCommand";
|
|
6
|
+
export * from "./DeleteBrandProfileAttributeCommand";
|
|
7
|
+
export * from "./DeleteBrandProfileCommand";
|
|
8
|
+
export * from "./DeleteNotifyCodeConfigurationCommand";
|
|
9
|
+
export * from "./GetBrandProfileAttributeCommand";
|
|
10
|
+
export * from "./GetBrandProfileCommand";
|
|
11
|
+
export * from "./GetJobCommand";
|
|
12
|
+
export * from "./GetNotifyCodeConfigurationCommand";
|
|
13
|
+
export * from "./ListBrandProfileAttributesCommand";
|
|
14
|
+
export * from "./ListBrandProfilesCommand";
|
|
15
|
+
export * from "./ListJobsCommand";
|
|
16
|
+
export * from "./ListNotifyCodeConfigurationsCommand";
|
|
17
|
+
export * from "./ListRegistrationsFromBrandProfileCommand";
|
|
18
|
+
export * from "./ListTagsForResourceCommand";
|
|
19
|
+
export * from "./SendNotifyCodeVerificationCommand";
|
|
20
|
+
export * from "./TagResourceCommand";
|
|
21
|
+
export * from "./UntagResourceCommand";
|
|
22
|
+
export * from "./UpdateBrandProfileAttributeCommand";
|
|
23
|
+
export * from "./UpdateBrandProfileCommand";
|
|
24
|
+
export * from "./UpdateBrandProfileFromRegistrationCommand";
|
|
25
|
+
export * from "./UpdateNotifyCodeConfigurationCommand";
|
|
26
|
+
export * from "./UpdateRegistrationsFromBrandProfileCommand";
|
|
27
|
+
export * from "./ValidateNotifyCodeVerificationCommand";
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ClientInputEndpointParameters {
|
|
6
|
+
region?: string | undefined | Provider<string | undefined>;
|
|
7
|
+
useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
|
|
8
|
+
useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
|
|
9
|
+
endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
|
|
15
|
+
defaultSigningName: string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* @internal
|
|
19
|
+
*/
|
|
20
|
+
export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
|
|
21
|
+
/**
|
|
22
|
+
* @internal
|
|
23
|
+
*/
|
|
24
|
+
export declare const commonParams: {
|
|
25
|
+
readonly UseFIPS: {
|
|
26
|
+
readonly type: "builtInParams";
|
|
27
|
+
readonly name: "useFipsEndpoint";
|
|
28
|
+
};
|
|
29
|
+
readonly Endpoint: {
|
|
30
|
+
readonly type: "builtInParams";
|
|
31
|
+
readonly name: "endpoint";
|
|
32
|
+
};
|
|
33
|
+
readonly Region: {
|
|
34
|
+
readonly type: "builtInParams";
|
|
35
|
+
readonly name: "region";
|
|
36
|
+
};
|
|
37
|
+
readonly UseDualStack: {
|
|
38
|
+
readonly type: "builtInParams";
|
|
39
|
+
readonly name: "useDualstackEndpoint";
|
|
40
|
+
};
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
* @internal
|
|
44
|
+
*/
|
|
45
|
+
export interface EndpointParameters extends __EndpointParameters {
|
|
46
|
+
Region?: string | undefined;
|
|
47
|
+
UseDualStack?: boolean | undefined;
|
|
48
|
+
UseFIPS?: boolean | undefined;
|
|
49
|
+
Endpoint?: string | undefined;
|
|
50
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { EndpointV2, Logger } from "@smithy/types";
|
|
2
|
+
import type { EndpointParameters } from "./EndpointParameters";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
|
|
7
|
+
logger?: Logger;
|
|
8
|
+
}) => EndpointV2;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
|
|
2
|
+
import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
|
|
3
|
+
import type { DefaultExtensionConfiguration } from "@smithy/types";
|
|
4
|
+
import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
|
|
5
|
+
/**
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export interface EndUserMessagingExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
|
|
9
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* <p>AWS End User Messaging provides a set of APIs to manage brand profiles, synchronize brand profile data with SMS and Rich Communication Services (RCS) registrations, and send and validate one-time passcodes across the SMS, voice, and WhatsApp channels.</p>
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
export * from "./EndUserMessagingClient";
|
|
7
|
+
export * from "./EndUserMessaging";
|
|
8
|
+
export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
9
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
10
|
+
export type { EndUserMessagingExtensionConfiguration } from "./extensionConfiguration";
|
|
11
|
+
export * from "./commands";
|
|
12
|
+
export { Command as $Command } from "@smithy/core/client";
|
|
13
|
+
export * from "./pagination";
|
|
14
|
+
export * from "./waiters";
|
|
15
|
+
export * from "./schemas/schemas_0";
|
|
16
|
+
export * from "./models/enums";
|
|
17
|
+
export * from "./models/errors";
|
|
18
|
+
export * from "./models/models_0";
|
|
19
|
+
export { EndUserMessagingServiceException } from "./models/EndUserMessagingServiceException";
|