@aws-sdk/client-socialmessaging 3.1059.0 → 3.1061.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 (67) hide show
  1. package/README.md +77 -7
  2. package/dist-cjs/index.js +160 -0
  3. package/dist-cjs/schemas/schemas_0.js +262 -14
  4. package/dist-es/SocialMessaging.js +24 -0
  5. package/dist-es/commands/CreateWhatsAppFlowCommand.js +16 -0
  6. package/dist-es/commands/DeleteWhatsAppFlowCommand.js +16 -0
  7. package/dist-es/commands/DeprecateWhatsAppFlowCommand.js +16 -0
  8. package/dist-es/commands/GetWhatsAppFlowCommand.js +16 -0
  9. package/dist-es/commands/GetWhatsAppFlowPreviewCommand.js +16 -0
  10. package/dist-es/commands/ListWhatsAppFlowAssetsCommand.js +16 -0
  11. package/dist-es/commands/ListWhatsAppFlowsCommand.js +16 -0
  12. package/dist-es/commands/PublishWhatsAppFlowCommand.js +16 -0
  13. package/dist-es/commands/UpdateWhatsAppFlowAssetsCommand.js +16 -0
  14. package/dist-es/commands/UpdateWhatsAppFlowCommand.js +16 -0
  15. package/dist-es/commands/index.js +10 -0
  16. package/dist-es/models/enums.js +11 -0
  17. package/dist-es/pagination/ListWhatsAppFlowAssetsPaginator.js +4 -0
  18. package/dist-es/pagination/ListWhatsAppFlowsPaginator.js +4 -0
  19. package/dist-es/pagination/index.js +2 -0
  20. package/dist-es/schemas/schemas_0.js +259 -12
  21. package/dist-types/SocialMessaging.d.ts +84 -0
  22. package/dist-types/SocialMessagingClient.d.ts +12 -2
  23. package/dist-types/commands/CreateWhatsAppFlowCommand.d.ts +113 -0
  24. package/dist-types/commands/CreateWhatsAppMessageTemplateCommand.d.ts +3 -0
  25. package/dist-types/commands/CreateWhatsAppMessageTemplateFromLibraryCommand.d.ts +3 -0
  26. package/dist-types/commands/CreateWhatsAppMessageTemplateMediaCommand.d.ts +3 -0
  27. package/dist-types/commands/DeleteWhatsAppFlowCommand.d.ts +100 -0
  28. package/dist-types/commands/DeleteWhatsAppMessageTemplateCommand.d.ts +3 -0
  29. package/dist-types/commands/DeprecateWhatsAppFlowCommand.d.ts +100 -0
  30. package/dist-types/commands/GetWhatsAppFlowCommand.d.ts +139 -0
  31. package/dist-types/commands/GetWhatsAppFlowPreviewCommand.d.ts +107 -0
  32. package/dist-types/commands/GetWhatsAppMessageTemplateCommand.d.ts +3 -0
  33. package/dist-types/commands/ListWhatsAppFlowAssetsCommand.d.ts +111 -0
  34. package/dist-types/commands/ListWhatsAppFlowsCommand.d.ts +116 -0
  35. package/dist-types/commands/ListWhatsAppMessageTemplatesCommand.d.ts +3 -0
  36. package/dist-types/commands/ListWhatsAppTemplateLibraryCommand.d.ts +3 -0
  37. package/dist-types/commands/PublishWhatsAppFlowCommand.d.ts +100 -0
  38. package/dist-types/commands/UpdateWhatsAppFlowAssetsCommand.d.ts +105 -0
  39. package/dist-types/commands/UpdateWhatsAppFlowCommand.d.ts +104 -0
  40. package/dist-types/commands/UpdateWhatsAppMessageTemplateCommand.d.ts +3 -0
  41. package/dist-types/commands/index.d.ts +10 -0
  42. package/dist-types/models/enums.d.ts +19 -0
  43. package/dist-types/models/models_0.d.ts +518 -1
  44. package/dist-types/pagination/ListWhatsAppFlowAssetsPaginator.d.ts +7 -0
  45. package/dist-types/pagination/ListWhatsAppFlowsPaginator.d.ts +7 -0
  46. package/dist-types/pagination/index.d.ts +2 -0
  47. package/dist-types/schemas/schemas_0.d.ts +37 -0
  48. package/dist-types/ts3.4/SocialMessaging.d.ts +184 -0
  49. package/dist-types/ts3.4/SocialMessagingClient.d.ts +60 -0
  50. package/dist-types/ts3.4/commands/CreateWhatsAppFlowCommand.d.ts +53 -0
  51. package/dist-types/ts3.4/commands/DeleteWhatsAppFlowCommand.d.ts +53 -0
  52. package/dist-types/ts3.4/commands/DeprecateWhatsAppFlowCommand.d.ts +53 -0
  53. package/dist-types/ts3.4/commands/GetWhatsAppFlowCommand.d.ts +52 -0
  54. package/dist-types/ts3.4/commands/GetWhatsAppFlowPreviewCommand.d.ts +53 -0
  55. package/dist-types/ts3.4/commands/ListWhatsAppFlowAssetsCommand.d.ts +53 -0
  56. package/dist-types/ts3.4/commands/ListWhatsAppFlowsCommand.d.ts +52 -0
  57. package/dist-types/ts3.4/commands/PublishWhatsAppFlowCommand.d.ts +53 -0
  58. package/dist-types/ts3.4/commands/UpdateWhatsAppFlowAssetsCommand.d.ts +53 -0
  59. package/dist-types/ts3.4/commands/UpdateWhatsAppFlowCommand.d.ts +53 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  61. package/dist-types/ts3.4/models/enums.d.ts +13 -0
  62. package/dist-types/ts3.4/models/models_0.d.ts +126 -1
  63. package/dist-types/ts3.4/pagination/ListWhatsAppFlowAssetsPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/ListWhatsAppFlowsPaginator.d.ts +11 -0
  65. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  66. package/dist-types/ts3.4/schemas/schemas_0.d.ts +37 -0
  67. package/package.json +3 -3
@@ -0,0 +1,105 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { UpdateWhatsAppFlowAssetsInput, UpdateWhatsAppFlowAssetsOutput } 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 UpdateWhatsAppFlowAssetsCommand}.
14
+ */
15
+ export interface UpdateWhatsAppFlowAssetsCommandInput extends UpdateWhatsAppFlowAssetsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateWhatsAppFlowAssetsCommand}.
21
+ */
22
+ export interface UpdateWhatsAppFlowAssetsCommandOutput extends UpdateWhatsAppFlowAssetsOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateWhatsAppFlowAssetsCommand_base: {
25
+ new (input: UpdateWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowAssetsCommandInput, UpdateWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: UpdateWhatsAppFlowAssetsCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowAssetsCommandInput, UpdateWhatsAppFlowAssetsCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Updates the Flow JSON definition (assets) of a WhatsApp Flow. Updating a published Flow's assets reverts it to DRAFT status, requiring re-publishing.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { SocialMessagingClient, UpdateWhatsAppFlowAssetsCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
37
+ * // const { SocialMessagingClient, UpdateWhatsAppFlowAssetsCommand } = 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 = { // UpdateWhatsAppFlowAssetsInput
42
+ * id: "STRING_VALUE", // required
43
+ * flowId: "STRING_VALUE", // required
44
+ * flowJson: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
45
+ * };
46
+ * const command = new UpdateWhatsAppFlowAssetsCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // UpdateWhatsAppFlowAssetsOutput
49
+ * // validationErrors: [ // ValidationErrorList
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param UpdateWhatsAppFlowAssetsCommandInput - {@link UpdateWhatsAppFlowAssetsCommandInput}
57
+ * @returns {@link UpdateWhatsAppFlowAssetsCommandOutput}
58
+ * @see {@link UpdateWhatsAppFlowAssetsCommandInput} for command's `input` shape.
59
+ * @see {@link UpdateWhatsAppFlowAssetsCommandOutput} for command's `response` shape.
60
+ * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
61
+ *
62
+ * @throws {@link AccessDeniedByMetaException} (client fault)
63
+ * <p>You do not have sufficient access to perform this action.</p>
64
+ *
65
+ * @throws {@link DependencyException} (server fault)
66
+ * <p>Thrown when performing an action because a dependency would be broken.</p>
67
+ *
68
+ * @throws {@link InternalServiceException} (server fault)
69
+ * <p>The request processing has failed because of an unknown error, exception, or
70
+ * failure.</p>
71
+ *
72
+ * @throws {@link InvalidParametersException} (client fault)
73
+ * <p>One or more parameters provided to the action are not valid.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The resource was not found.</p>
77
+ *
78
+ * @throws {@link ThrottledRequestException} (client fault)
79
+ * <p>The request was denied due to request throttling.</p>
80
+ *
81
+ * @throws {@link AccessDeniedException} (client fault)
82
+ * <p>You do not have sufficient access to perform this action.</p>
83
+ *
84
+ * @throws {@link ValidationException} (client fault)
85
+ * <p>The request contains an invalid parameter value. </p>
86
+ *
87
+ * @throws {@link SocialMessagingServiceException}
88
+ * <p>Base exception class for all service exceptions from SocialMessaging service.</p>
89
+ *
90
+ *
91
+ * @public
92
+ */
93
+ export declare class UpdateWhatsAppFlowAssetsCommand extends UpdateWhatsAppFlowAssetsCommand_base {
94
+ /** @internal type navigation helper, not in runtime. */
95
+ protected static __types: {
96
+ api: {
97
+ input: UpdateWhatsAppFlowAssetsInput;
98
+ output: UpdateWhatsAppFlowAssetsOutput;
99
+ };
100
+ sdk: {
101
+ input: UpdateWhatsAppFlowAssetsCommandInput;
102
+ output: UpdateWhatsAppFlowAssetsCommandOutput;
103
+ };
104
+ };
105
+ }
@@ -0,0 +1,104 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { UpdateWhatsAppFlowInput, UpdateWhatsAppFlowOutput } 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 UpdateWhatsAppFlowCommand}.
14
+ */
15
+ export interface UpdateWhatsAppFlowCommandInput extends UpdateWhatsAppFlowInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateWhatsAppFlowCommand}.
21
+ */
22
+ export interface UpdateWhatsAppFlowCommandOutput extends UpdateWhatsAppFlowOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateWhatsAppFlowCommand_base: {
25
+ new (input: UpdateWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowCommandInput, UpdateWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: UpdateWhatsAppFlowCommandInput): import("@smithy/core/client").CommandImpl<UpdateWhatsAppFlowCommandInput, UpdateWhatsAppFlowCommandOutput, SocialMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): {
28
+ [x: string]: unknown;
29
+ };
30
+ };
31
+ /**
32
+ * <p>Updates the metadata of a WhatsApp Flow, such as its name or categories. This does not update the Flow JSON definition. Use <a href="https://docs.aws.amazon.com/social-messaging/latest/APIReference/API_UpdateWhatsAppFlowAssets.html">UpdateWhatsAppFlowAssets</a> to update the Flow JSON.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { SocialMessagingClient, UpdateWhatsAppFlowCommand } from "@aws-sdk/client-socialmessaging"; // ES Modules import
37
+ * // const { SocialMessagingClient, UpdateWhatsAppFlowCommand } = 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 = { // UpdateWhatsAppFlowInput
42
+ * id: "STRING_VALUE", // required
43
+ * flowId: "STRING_VALUE", // required
44
+ * flowName: "STRING_VALUE",
45
+ * categories: [ // MetaFlowCategoryList
46
+ * "SIGN_UP" || "SIGN_IN" || "APPOINTMENT_BOOKING" || "LEAD_GENERATION" || "SHOPPING" || "CONTACT_US" || "CUSTOMER_SUPPORT" || "SURVEY" || "OTHER",
47
+ * ],
48
+ * };
49
+ * const command = new UpdateWhatsAppFlowCommand(input);
50
+ * const response = await client.send(command);
51
+ * // {};
52
+ *
53
+ * ```
54
+ *
55
+ * @param UpdateWhatsAppFlowCommandInput - {@link UpdateWhatsAppFlowCommandInput}
56
+ * @returns {@link UpdateWhatsAppFlowCommandOutput}
57
+ * @see {@link UpdateWhatsAppFlowCommandInput} for command's `input` shape.
58
+ * @see {@link UpdateWhatsAppFlowCommandOutput} for command's `response` shape.
59
+ * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
60
+ *
61
+ * @throws {@link AccessDeniedByMetaException} (client fault)
62
+ * <p>You do not have sufficient access to perform this action.</p>
63
+ *
64
+ * @throws {@link DependencyException} (server fault)
65
+ * <p>Thrown when performing an action because a dependency would be broken.</p>
66
+ *
67
+ * @throws {@link InternalServiceException} (server fault)
68
+ * <p>The request processing has failed because of an unknown error, exception, or
69
+ * failure.</p>
70
+ *
71
+ * @throws {@link InvalidParametersException} (client fault)
72
+ * <p>One or more parameters provided to the action are not valid.</p>
73
+ *
74
+ * @throws {@link ResourceNotFoundException} (client fault)
75
+ * <p>The resource was not found.</p>
76
+ *
77
+ * @throws {@link ThrottledRequestException} (client fault)
78
+ * <p>The request was denied due to request throttling.</p>
79
+ *
80
+ * @throws {@link AccessDeniedException} (client fault)
81
+ * <p>You do not have sufficient access to perform this action.</p>
82
+ *
83
+ * @throws {@link ValidationException} (client fault)
84
+ * <p>The request contains an invalid parameter value. </p>
85
+ *
86
+ * @throws {@link SocialMessagingServiceException}
87
+ * <p>Base exception class for all service exceptions from SocialMessaging service.</p>
88
+ *
89
+ *
90
+ * @public
91
+ */
92
+ export declare class UpdateWhatsAppFlowCommand extends UpdateWhatsAppFlowCommand_base {
93
+ /** @internal type navigation helper, not in runtime. */
94
+ protected static __types: {
95
+ api: {
96
+ input: UpdateWhatsAppFlowInput;
97
+ output: {};
98
+ };
99
+ sdk: {
100
+ input: UpdateWhatsAppFlowCommandInput;
101
+ output: UpdateWhatsAppFlowCommandOutput;
102
+ };
103
+ };
104
+ }
@@ -60,6 +60,9 @@ declare const UpdateWhatsAppMessageTemplateCommand_base: {
60
60
  * @see {@link UpdateWhatsAppMessageTemplateCommandOutput} for command's `response` shape.
61
61
  * @see {@link SocialMessagingClientResolvedConfig | config} for SocialMessagingClient's `config` shape.
62
62
  *
63
+ * @throws {@link AccessDeniedByMetaException} (client fault)
64
+ * <p>You do not have sufficient access to perform this action.</p>
65
+ *
63
66
  * @throws {@link DependencyException} (server fault)
64
67
  * <p>Thrown when performing an action because a dependency would be broken.</p>
65
68
  *
@@ -1,21 +1,31 @@
1
1
  export * from "./AssociateWhatsAppBusinessAccountCommand";
2
+ export * from "./CreateWhatsAppFlowCommand";
2
3
  export * from "./CreateWhatsAppMessageTemplateCommand";
3
4
  export * from "./CreateWhatsAppMessageTemplateFromLibraryCommand";
4
5
  export * from "./CreateWhatsAppMessageTemplateMediaCommand";
6
+ export * from "./DeleteWhatsAppFlowCommand";
5
7
  export * from "./DeleteWhatsAppMessageMediaCommand";
6
8
  export * from "./DeleteWhatsAppMessageTemplateCommand";
9
+ export * from "./DeprecateWhatsAppFlowCommand";
7
10
  export * from "./DisassociateWhatsAppBusinessAccountCommand";
8
11
  export * from "./GetLinkedWhatsAppBusinessAccountCommand";
9
12
  export * from "./GetLinkedWhatsAppBusinessAccountPhoneNumberCommand";
13
+ export * from "./GetWhatsAppFlowCommand";
14
+ export * from "./GetWhatsAppFlowPreviewCommand";
10
15
  export * from "./GetWhatsAppMessageMediaCommand";
11
16
  export * from "./GetWhatsAppMessageTemplateCommand";
12
17
  export * from "./ListLinkedWhatsAppBusinessAccountsCommand";
13
18
  export * from "./ListTagsForResourceCommand";
19
+ export * from "./ListWhatsAppFlowAssetsCommand";
20
+ export * from "./ListWhatsAppFlowsCommand";
14
21
  export * from "./ListWhatsAppMessageTemplatesCommand";
15
22
  export * from "./ListWhatsAppTemplateLibraryCommand";
16
23
  export * from "./PostWhatsAppMessageMediaCommand";
24
+ export * from "./PublishWhatsAppFlowCommand";
17
25
  export * from "./PutWhatsAppBusinessAccountEventDestinationsCommand";
18
26
  export * from "./SendWhatsAppMessageCommand";
19
27
  export * from "./TagResourceCommand";
20
28
  export * from "./UntagResourceCommand";
29
+ export * from "./UpdateWhatsAppFlowAssetsCommand";
30
+ export * from "./UpdateWhatsAppFlowCommand";
21
31
  export * from "./UpdateWhatsAppMessageTemplateCommand";
@@ -10,3 +10,22 @@ export declare const RegistrationStatus: {
10
10
  * @public
11
11
  */
12
12
  export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof RegistrationStatus];
13
+ /**
14
+ * @public
15
+ * @enum
16
+ */
17
+ export declare const MetaFlowCategory: {
18
+ readonly APPOINTMENT_BOOKING: "APPOINTMENT_BOOKING";
19
+ readonly CONTACT_US: "CONTACT_US";
20
+ readonly CUSTOMER_SUPPORT: "CUSTOMER_SUPPORT";
21
+ readonly LEAD_GENERATION: "LEAD_GENERATION";
22
+ readonly OTHER: "OTHER";
23
+ readonly SHOPPING: "SHOPPING";
24
+ readonly SIGN_IN: "SIGN_IN";
25
+ readonly SIGN_UP: "SIGN_UP";
26
+ readonly SURVEY: "SURVEY";
27
+ };
28
+ /**
29
+ * @public
30
+ */
31
+ export type MetaFlowCategory = (typeof MetaFlowCategory)[keyof typeof MetaFlowCategory];