@aws-sdk/client-socialmessaging 3.1060.0 → 3.1062.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/README.md +77 -7
- package/dist-cjs/index.js +160 -0
- package/dist-cjs/schemas/schemas_0.js +262 -14
- package/dist-es/SocialMessaging.js +24 -0
- package/dist-es/commands/CreateWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/DeleteWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/DeprecateWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/GetWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/GetWhatsAppFlowPreviewCommand.js +16 -0
- package/dist-es/commands/ListWhatsAppFlowAssetsCommand.js +16 -0
- package/dist-es/commands/ListWhatsAppFlowsCommand.js +16 -0
- package/dist-es/commands/PublishWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/UpdateWhatsAppFlowAssetsCommand.js +16 -0
- package/dist-es/commands/UpdateWhatsAppFlowCommand.js +16 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/enums.js +11 -0
- package/dist-es/pagination/ListWhatsAppFlowAssetsPaginator.js +4 -0
- package/dist-es/pagination/ListWhatsAppFlowsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +259 -12
- package/dist-types/SocialMessaging.d.ts +84 -0
- package/dist-types/SocialMessagingClient.d.ts +12 -2
- package/dist-types/commands/CreateWhatsAppFlowCommand.d.ts +113 -0
- package/dist-types/commands/CreateWhatsAppMessageTemplateCommand.d.ts +3 -0
- package/dist-types/commands/CreateWhatsAppMessageTemplateFromLibraryCommand.d.ts +3 -0
- package/dist-types/commands/CreateWhatsAppMessageTemplateMediaCommand.d.ts +3 -0
- package/dist-types/commands/DeleteWhatsAppFlowCommand.d.ts +100 -0
- package/dist-types/commands/DeleteWhatsAppMessageTemplateCommand.d.ts +3 -0
- package/dist-types/commands/DeprecateWhatsAppFlowCommand.d.ts +100 -0
- package/dist-types/commands/GetWhatsAppFlowCommand.d.ts +139 -0
- package/dist-types/commands/GetWhatsAppFlowPreviewCommand.d.ts +107 -0
- package/dist-types/commands/GetWhatsAppMessageTemplateCommand.d.ts +3 -0
- package/dist-types/commands/ListWhatsAppFlowAssetsCommand.d.ts +111 -0
- package/dist-types/commands/ListWhatsAppFlowsCommand.d.ts +116 -0
- package/dist-types/commands/ListWhatsAppMessageTemplatesCommand.d.ts +3 -0
- package/dist-types/commands/ListWhatsAppTemplateLibraryCommand.d.ts +3 -0
- package/dist-types/commands/PublishWhatsAppFlowCommand.d.ts +100 -0
- package/dist-types/commands/UpdateWhatsAppFlowAssetsCommand.d.ts +105 -0
- package/dist-types/commands/UpdateWhatsAppFlowCommand.d.ts +104 -0
- package/dist-types/commands/UpdateWhatsAppMessageTemplateCommand.d.ts +3 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/enums.d.ts +19 -0
- package/dist-types/models/models_0.d.ts +518 -1
- package/dist-types/pagination/ListWhatsAppFlowAssetsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListWhatsAppFlowsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +37 -0
- package/dist-types/ts3.4/SocialMessaging.d.ts +184 -0
- package/dist-types/ts3.4/SocialMessagingClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/CreateWhatsAppFlowCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteWhatsAppFlowCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeprecateWhatsAppFlowCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetWhatsAppFlowCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/GetWhatsAppFlowPreviewCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListWhatsAppFlowAssetsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/ListWhatsAppFlowsCommand.d.ts +52 -0
- package/dist-types/ts3.4/commands/PublishWhatsAppFlowCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateWhatsAppFlowAssetsCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/UpdateWhatsAppFlowCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/enums.d.ts +13 -0
- package/dist-types/ts3.4/models/models_0.d.ts +126 -1
- package/dist-types/ts3.4/pagination/ListWhatsAppFlowAssetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListWhatsAppFlowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +37 -0
- package/package.json +2 -2
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetWhatsAppFlowInput, GetWhatsAppFlowOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetWhatsAppFlowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetWhatsAppFlowCommandInput extends GetWhatsAppFlowInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetWhatsAppFlowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetWhatsAppFlowCommandOutput extends GetWhatsAppFlowOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetWhatsAppFlowCommand_base: {
|
|
25
|
+
new (input: GetWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppFlowCommandInput, GetWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppFlowCommandInput, GetWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { SocialMessagingClient, GetWhatsAppFlowCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
|
|
37
|
+
* // const { SocialMessagingClient, GetWhatsAppFlowCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
|
|
38
|
+
* // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
|
|
39
|
+
* const config = {}; // type is SocialMessagingClientConfig
|
|
40
|
+
* const client = new SocialMessagingClient(config);
|
|
41
|
+
* const input = { // GetWhatsAppFlowInput
|
|
42
|
+
* id: "STRING_VALUE", // required
|
|
43
|
+
* flowId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new GetWhatsAppFlowCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // GetWhatsAppFlowOutput
|
|
48
|
+
* // flowId: "STRING_VALUE", // required
|
|
49
|
+
* // flowName: "STRING_VALUE", // required
|
|
50
|
+
* // flowStatus: "STRING_VALUE", // required
|
|
51
|
+
* // categories: [ // MetaFlowCategoryList
|
|
52
|
+
* // "SIGN_UP" || "SIGN_IN" || "APPOINTMENT_BOOKING" || "LEAD_GENERATION" || "SHOPPING" || "CONTACT_US" || "CUSTOMER_SUPPORT" || "SURVEY" || "OTHER",
|
|
53
|
+
* // ],
|
|
54
|
+
* // validationErrors: [ // ValidationErrorList
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // jsonVersion: "STRING_VALUE",
|
|
58
|
+
* // dataApiVersion: "STRING_VALUE",
|
|
59
|
+
* // endpointUri: "STRING_VALUE",
|
|
60
|
+
* // preview: { // MetaFlowPreviewInfo
|
|
61
|
+
* // previewUrl: "STRING_VALUE", // required
|
|
62
|
+
* // expiresAt: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // whatsAppBusinessAccount: { // MetaFlowWhatsAppBusinessAccountInfo
|
|
65
|
+
* // id: "STRING_VALUE", // required
|
|
66
|
+
* // name: "STRING_VALUE", // required
|
|
67
|
+
* // currency: "STRING_VALUE",
|
|
68
|
+
* // timezoneId: "STRING_VALUE",
|
|
69
|
+
* // messageTemplateNamespace: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // application: { // MetaFlowApplicationInfo
|
|
72
|
+
* // link: "STRING_VALUE",
|
|
73
|
+
* // name: "STRING_VALUE", // required
|
|
74
|
+
* // id: "STRING_VALUE", // required
|
|
75
|
+
* // },
|
|
76
|
+
* // healthStatus: { // MetaFlowHealthStatus
|
|
77
|
+
* // canSendMessage: "STRING_VALUE", // required
|
|
78
|
+
* // entities: [ // MetaFlowHealthEntityList
|
|
79
|
+
* // { // MetaFlowHealthEntity
|
|
80
|
+
* // entityType: "STRING_VALUE", // required
|
|
81
|
+
* // id: "STRING_VALUE", // required
|
|
82
|
+
* // canSendMessage: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @param GetWhatsAppFlowCommandInput - {@link GetWhatsAppFlowCommandInput}
|
|
91
|
+
* @returns {@link GetWhatsAppFlowCommandOutput}
|
|
92
|
+
* @see {@link GetWhatsAppFlowCommandInput} for command's `input` shape.
|
|
93
|
+
* @see {@link GetWhatsAppFlowCommandOutput} for command's `response` shape.
|
|
94
|
+
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
97
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link DependencyException} (server fault)
|
|
100
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
103
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
104
|
+
* failure.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InvalidParametersException} (client fault)
|
|
107
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
110
|
+
* <p>The resource was not found.</p>
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ThrottledRequestException} (client fault)
|
|
113
|
+
* <p>The request was denied due to request throttling.</p>
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
116
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link ValidationException} (client fault)
|
|
119
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
120
|
+
*
|
|
121
|
+
* @throws {@link SocialMessagingServiceException}
|
|
122
|
+
* <p>Base exception class for all service exceptions from SocialMessaging service.</p>
|
|
123
|
+
*
|
|
124
|
+
*
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export declare class GetWhatsAppFlowCommand extends GetWhatsAppFlowCommand_base {
|
|
128
|
+
/** @internal type navigation helper, not in runtime. */
|
|
129
|
+
protected static __types: {
|
|
130
|
+
api: {
|
|
131
|
+
input: GetWhatsAppFlowInput;
|
|
132
|
+
output: GetWhatsAppFlowOutput;
|
|
133
|
+
};
|
|
134
|
+
sdk: {
|
|
135
|
+
input: GetWhatsAppFlowCommandInput;
|
|
136
|
+
output: GetWhatsAppFlowCommandOutput;
|
|
137
|
+
};
|
|
138
|
+
};
|
|
139
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetWhatsAppFlowPreviewInput, GetWhatsAppFlowPreviewOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetWhatsAppFlowPreviewCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetWhatsAppFlowPreviewCommandInput extends GetWhatsAppFlowPreviewInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetWhatsAppFlowPreviewCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetWhatsAppFlowPreviewCommandOutput extends GetWhatsAppFlowPreviewOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetWhatsAppFlowPreviewCommand_base: {
|
|
25
|
+
new (input: GetWhatsAppFlowPreviewCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppFlowPreviewCommandInput, GetWhatsAppFlowPreviewCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetWhatsAppFlowPreviewCommandInput): import("@smithy/core/client").CommandImpl<GetWhatsAppFlowPreviewCommandInput, GetWhatsAppFlowPreviewCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Generates a web preview URL for testing a WhatsApp Flow before publishing. Preview URLs expire in 30 days and can be shared with stakeholders for review.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { SocialMessagingClient, GetWhatsAppFlowPreviewCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
|
|
37
|
+
* // const { SocialMessagingClient, GetWhatsAppFlowPreviewCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
|
|
38
|
+
* // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
|
|
39
|
+
* const config = {}; // type is SocialMessagingClientConfig
|
|
40
|
+
* const client = new SocialMessagingClient(config);
|
|
41
|
+
* const input = { // GetWhatsAppFlowPreviewInput
|
|
42
|
+
* id: "STRING_VALUE", // required
|
|
43
|
+
* flowId: "STRING_VALUE", // required
|
|
44
|
+
* invalidate: true || false,
|
|
45
|
+
* };
|
|
46
|
+
* const command = new GetWhatsAppFlowPreviewCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // GetWhatsAppFlowPreviewOutput
|
|
49
|
+
* // flowId: "STRING_VALUE", // required
|
|
50
|
+
* // preview: { // MetaFlowPreviewInfo
|
|
51
|
+
* // previewUrl: "STRING_VALUE", // required
|
|
52
|
+
* // expiresAt: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetWhatsAppFlowPreviewCommandInput - {@link GetWhatsAppFlowPreviewCommandInput}
|
|
59
|
+
* @returns {@link GetWhatsAppFlowPreviewCommandOutput}
|
|
60
|
+
* @see {@link GetWhatsAppFlowPreviewCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetWhatsAppFlowPreviewCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
65
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link DependencyException} (server fault)
|
|
68
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
71
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
72
|
+
* failure.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidParametersException} (client fault)
|
|
75
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
|
+
* <p>The resource was not found.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ThrottledRequestException} (client fault)
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
84
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link SocialMessagingServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from SocialMessaging service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class GetWhatsAppFlowPreviewCommand extends GetWhatsAppFlowPreviewCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: GetWhatsAppFlowPreviewInput;
|
|
100
|
+
output: GetWhatsAppFlowPreviewOutput;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: GetWhatsAppFlowPreviewCommandInput;
|
|
104
|
+
output: GetWhatsAppFlowPreviewCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -58,6 +58,9 @@ declare const GetWhatsAppMessageTemplateCommand_base: {
|
|
|
58
58
|
* @see {@link GetWhatsAppMessageTemplateCommandOutput} for command's `response` shape.
|
|
59
59
|
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
60
60
|
*
|
|
61
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
62
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
|
+
*
|
|
61
64
|
* @throws {@link DependencyException} (server fault)
|
|
62
65
|
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
63
66
|
*
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListWhatsAppFlowAssetsInput, ListWhatsAppFlowAssetsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListWhatsAppFlowAssetsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListWhatsAppFlowAssetsCommandInput extends ListWhatsAppFlowAssetsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListWhatsAppFlowAssetsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListWhatsAppFlowAssetsCommandOutput extends ListWhatsAppFlowAssetsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListWhatsAppFlowAssetsCommand_base: {
|
|
25
|
+
new (input: ListWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<ListWhatsAppFlowAssetsCommandInput, ListWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<ListWhatsAppFlowAssetsCommandInput, ListWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Lists the assets (Flow JSON definition) of a WhatsApp Flow with presigned download URLs. Download URLs are generated by Meta and expire after a short period.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { SocialMessagingClient, ListWhatsAppFlowAssetsCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
|
|
37
|
+
* // const { SocialMessagingClient, ListWhatsAppFlowAssetsCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
|
|
38
|
+
* // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
|
|
39
|
+
* const config = {}; // type is SocialMessagingClientConfig
|
|
40
|
+
* const client = new SocialMessagingClient(config);
|
|
41
|
+
* const input = { // ListWhatsAppFlowAssetsInput
|
|
42
|
+
* id: "STRING_VALUE", // required
|
|
43
|
+
* flowId: "STRING_VALUE", // required
|
|
44
|
+
* nextToken: "STRING_VALUE",
|
|
45
|
+
* maxResults: Number("int"),
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListWhatsAppFlowAssetsCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ListWhatsAppFlowAssetsOutput
|
|
50
|
+
* // flowAssets: [ // MetaFlowAssetList // required
|
|
51
|
+
* // { // MetaFlowAsset
|
|
52
|
+
* // name: "STRING_VALUE", // required
|
|
53
|
+
* // assetType: "STRING_VALUE", // required
|
|
54
|
+
* // downloadUrl: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // nextToken: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param ListWhatsAppFlowAssetsCommandInput - {@link ListWhatsAppFlowAssetsCommandInput}
|
|
63
|
+
* @returns {@link ListWhatsAppFlowAssetsCommandOutput}
|
|
64
|
+
* @see {@link ListWhatsAppFlowAssetsCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link ListWhatsAppFlowAssetsCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
69
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link DependencyException} (server fault)
|
|
72
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
75
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
76
|
+
* failure.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InvalidParametersException} (client fault)
|
|
79
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>The resource was not found.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ThrottledRequestException} (client fault)
|
|
85
|
+
* <p>The request was denied due to request throttling.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
88
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ValidationException} (client fault)
|
|
91
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link SocialMessagingServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from SocialMessaging service.</p>
|
|
95
|
+
*
|
|
96
|
+
*
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
export declare class ListWhatsAppFlowAssetsCommand extends ListWhatsAppFlowAssetsCommand_base {
|
|
100
|
+
/** @internal type navigation helper, not in runtime. */
|
|
101
|
+
protected static __types: {
|
|
102
|
+
api: {
|
|
103
|
+
input: ListWhatsAppFlowAssetsInput;
|
|
104
|
+
output: ListWhatsAppFlowAssetsOutput;
|
|
105
|
+
};
|
|
106
|
+
sdk: {
|
|
107
|
+
input: ListWhatsAppFlowAssetsCommandInput;
|
|
108
|
+
output: ListWhatsAppFlowAssetsCommandOutput;
|
|
109
|
+
};
|
|
110
|
+
};
|
|
111
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListWhatsAppFlowsInput, ListWhatsAppFlowsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListWhatsAppFlowsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListWhatsAppFlowsCommandInput extends ListWhatsAppFlowsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListWhatsAppFlowsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListWhatsAppFlowsCommandOutput extends ListWhatsAppFlowsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListWhatsAppFlowsCommand_base: {
|
|
25
|
+
new (input: ListWhatsAppFlowsCommandInput): import("@smithy/core/client").CommandImpl<ListWhatsAppFlowsCommandInput, ListWhatsAppFlowsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListWhatsAppFlowsCommandInput): import("@smithy/core/client").CommandImpl<ListWhatsAppFlowsCommandInput, ListWhatsAppFlowsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Lists all WhatsApp Flows for a WhatsApp Business Account. Returns summary information including Flow ID, name, status, and categories.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { SocialMessagingClient, ListWhatsAppFlowsCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
|
|
37
|
+
* // const { SocialMessagingClient, ListWhatsAppFlowsCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
|
|
38
|
+
* // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
|
|
39
|
+
* const config = {}; // type is SocialMessagingClientConfig
|
|
40
|
+
* const client = new SocialMessagingClient(config);
|
|
41
|
+
* const input = { // ListWhatsAppFlowsInput
|
|
42
|
+
* id: "STRING_VALUE", // required
|
|
43
|
+
* nextToken: "STRING_VALUE",
|
|
44
|
+
* maxResults: Number("int"),
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListWhatsAppFlowsCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListWhatsAppFlowsOutput
|
|
49
|
+
* // flows: [ // MetaFlowSummaryList // required
|
|
50
|
+
* // { // MetaFlowSummary
|
|
51
|
+
* // flowId: "STRING_VALUE", // required
|
|
52
|
+
* // flowName: "STRING_VALUE", // required
|
|
53
|
+
* // flowStatus: "STRING_VALUE", // required
|
|
54
|
+
* // flowCategories: [ // MetaFlowCategoryList // required
|
|
55
|
+
* // "SIGN_UP" || "SIGN_IN" || "APPOINTMENT_BOOKING" || "LEAD_GENERATION" || "SHOPPING" || "CONTACT_US" || "CUSTOMER_SUPPORT" || "SURVEY" || "OTHER",
|
|
56
|
+
* // ],
|
|
57
|
+
* // validationErrors: [ // ValidationErrorList // required
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // nextToken: "STRING_VALUE",
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param ListWhatsAppFlowsCommandInput - {@link ListWhatsAppFlowsCommandInput}
|
|
68
|
+
* @returns {@link ListWhatsAppFlowsCommandOutput}
|
|
69
|
+
* @see {@link ListWhatsAppFlowsCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link ListWhatsAppFlowsCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
74
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link DependencyException} (server fault)
|
|
77
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
80
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
81
|
+
* failure.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InvalidParametersException} (client fault)
|
|
84
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
87
|
+
* <p>The resource was not found.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ThrottledRequestException} (client fault)
|
|
90
|
+
* <p>The request was denied due to request throttling.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
93
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ValidationException} (client fault)
|
|
96
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link SocialMessagingServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from SocialMessaging service.</p>
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export declare class ListWhatsAppFlowsCommand extends ListWhatsAppFlowsCommand_base {
|
|
105
|
+
/** @internal type navigation helper, not in runtime. */
|
|
106
|
+
protected static __types: {
|
|
107
|
+
api: {
|
|
108
|
+
input: ListWhatsAppFlowsInput;
|
|
109
|
+
output: ListWhatsAppFlowsOutput;
|
|
110
|
+
};
|
|
111
|
+
sdk: {
|
|
112
|
+
input: ListWhatsAppFlowsCommandInput;
|
|
113
|
+
output: ListWhatsAppFlowsCommandOutput;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
}
|
|
@@ -67,6 +67,9 @@ declare const ListWhatsAppMessageTemplatesCommand_base: {
|
|
|
67
67
|
* @see {@link ListWhatsAppMessageTemplatesCommandOutput} for command's `response` shape.
|
|
68
68
|
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
69
69
|
*
|
|
70
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
71
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
72
|
+
*
|
|
70
73
|
* @throws {@link DependencyException} (server fault)
|
|
71
74
|
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
72
75
|
*
|
|
@@ -93,6 +93,9 @@ declare const ListWhatsAppTemplateLibraryCommand_base: {
|
|
|
93
93
|
* @see {@link ListWhatsAppTemplateLibraryCommandOutput} for command's `response` shape.
|
|
94
94
|
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
95
95
|
*
|
|
96
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
97
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
98
|
+
*
|
|
96
99
|
* @throws {@link DependencyException} (server fault)
|
|
97
100
|
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
98
101
|
*
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { PublishWhatsAppFlowInput, PublishWhatsAppFlowOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, SocialMessagingClientResolvedConfig } from "../SocialMessagingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PublishWhatsAppFlowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PublishWhatsAppFlowCommandInput extends PublishWhatsAppFlowInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PublishWhatsAppFlowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PublishWhatsAppFlowCommandOutput extends PublishWhatsAppFlowOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PublishWhatsAppFlowCommand_base: {
|
|
25
|
+
new (input: PublishWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<PublishWhatsAppFlowCommandInput, PublishWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PublishWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<PublishWhatsAppFlowCommandInput, PublishWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Publishes a WhatsApp Flow, making it available for use in template messages. The Flow must be in DRAFT status with valid Flow JSON that passes Meta's validation. This is an irreversible operation.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { SocialMessagingClient, PublishWhatsAppFlowCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
|
|
37
|
+
* // const { SocialMessagingClient, PublishWhatsAppFlowCommand } = require("@aws-sdk/client-socialmessaging"); // CommonJS import
|
|
38
|
+
* // import type { SocialMessagingClientConfig } from "@aws-sdk/client-socialmessaging";
|
|
39
|
+
* const config = {}; // type is SocialMessagingClientConfig
|
|
40
|
+
* const client = new SocialMessagingClient(config);
|
|
41
|
+
* const input = { // PublishWhatsAppFlowInput
|
|
42
|
+
* id: "STRING_VALUE", // required
|
|
43
|
+
* flowId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new PublishWhatsAppFlowCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param PublishWhatsAppFlowCommandInput - {@link PublishWhatsAppFlowCommandInput}
|
|
52
|
+
* @returns {@link PublishWhatsAppFlowCommandOutput}
|
|
53
|
+
* @see {@link PublishWhatsAppFlowCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link PublishWhatsAppFlowCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedByMetaException} (client fault)
|
|
58
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link DependencyException} (server fault)
|
|
61
|
+
* <p>Thrown when performing an action because a dependency would be broken.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
64
|
+
* <p>The request processing has failed because of an unknown error, exception, or
|
|
65
|
+
* failure.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidParametersException} (client fault)
|
|
68
|
+
* <p>One or more parameters provided to the action are not valid.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>The resource was not found.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottledRequestException} (client fault)
|
|
74
|
+
* <p>The request was denied due to request throttling.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
77
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ValidationException} (client fault)
|
|
80
|
+
* <p>The request contains an invalid parameter value. </p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link SocialMessagingServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from SocialMessaging service.</p>
|
|
84
|
+
*
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export declare class PublishWhatsAppFlowCommand extends PublishWhatsAppFlowCommand_base {
|
|
89
|
+
/** @internal type navigation helper, not in runtime. */
|
|
90
|
+
protected static __types: {
|
|
91
|
+
api: {
|
|
92
|
+
input: PublishWhatsAppFlowInput;
|
|
93
|
+
output: {};
|
|
94
|
+
};
|
|
95
|
+
sdk: {
|
|
96
|
+
input: PublishWhatsAppFlowCommandInput;
|
|
97
|
+
output: PublishWhatsAppFlowCommandOutput;
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
}
|