@aws-sdk/client-chime-sdk-messaging 3.295.0 → 3.297.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 (96) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/ChimeSDKMessaging.js +45 -0
  3. package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +46 -0
  4. package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +46 -0
  5. package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_0.js +32 -3
  9. package/dist-cjs/protocols/Aws_restJson1.js +243 -2
  10. package/dist-es/ChimeSDKMessaging.js +45 -0
  11. package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +42 -0
  12. package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +42 -0
  13. package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +42 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +3 -3
  16. package/dist-es/models/models_0.js +23 -0
  17. package/dist-es/protocols/Aws_restJson1.js +235 -0
  18. package/dist-types/ChimeSDKMessaging.d.ts +76 -40
  19. package/dist-types/ChimeSDKMessagingClient.d.ts +29 -6
  20. package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -1
  21. package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
  22. package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
  23. package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -1
  24. package/dist-types/commands/CreateChannelCommand.d.ts +16 -2
  25. package/dist-types/commands/CreateChannelFlowCommand.d.ts +17 -3
  26. package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -4
  27. package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -2
  28. package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -1
  29. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -1
  30. package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -1
  32. package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -1
  33. package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -1
  34. package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +76 -0
  35. package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -2
  36. package/dist-types/commands/DescribeChannelCommand.d.ts +16 -2
  37. package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -1
  40. package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -1
  41. package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
  42. package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
  43. package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
  44. package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -1
  45. package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -3
  46. package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
  47. package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +82 -0
  48. package/dist-types/commands/ListChannelBansCommand.d.ts +16 -1
  49. package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -2
  51. package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -1
  52. package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
  53. package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
  55. package/dist-types/commands/ListChannelsCommand.d.ts +16 -2
  56. package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -1
  57. package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  59. package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
  60. package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +86 -0
  61. package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -1
  62. package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
  63. package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -2
  64. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -1
  69. package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -1
  70. package/dist-types/commands/index.d.ts +3 -0
  71. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  72. package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
  73. package/dist-types/models/models_0.d.ts +430 -0
  74. package/dist-types/pagination/Interfaces.d.ts +3 -0
  75. package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
  85. package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
  86. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  87. package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +69 -0
  88. package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +18 -0
  89. package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +37 -0
  90. package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +41 -0
  91. package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +41 -0
  92. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  93. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  94. package/dist-types/ts3.4/models/models_0.d.ts +42 -0
  95. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  96. package/package.json +29 -29
@@ -21,6 +21,7 @@ import { DeleteChannelFlowCommandInput, DeleteChannelFlowCommandOutput } from ".
21
21
  import { DeleteChannelMembershipCommandInput, DeleteChannelMembershipCommandOutput } from "./commands/DeleteChannelMembershipCommand";
22
22
  import { DeleteChannelMessageCommandInput, DeleteChannelMessageCommandOutput } from "./commands/DeleteChannelMessageCommand";
23
23
  import { DeleteChannelModeratorCommandInput, DeleteChannelModeratorCommandOutput } from "./commands/DeleteChannelModeratorCommand";
24
+ import { DeleteMessagingStreamingConfigurationsCommandInput, DeleteMessagingStreamingConfigurationsCommandOutput } from "./commands/DeleteMessagingStreamingConfigurationsCommand";
24
25
  import { DescribeChannelBanCommandInput, DescribeChannelBanCommandOutput } from "./commands/DescribeChannelBanCommand";
25
26
  import { DescribeChannelCommandInput, DescribeChannelCommandOutput } from "./commands/DescribeChannelCommand";
26
27
  import { DescribeChannelFlowCommandInput, DescribeChannelFlowCommandOutput } from "./commands/DescribeChannelFlowCommand";
@@ -33,6 +34,7 @@ import { GetChannelMembershipPreferencesCommandInput, GetChannelMembershipPrefer
33
34
  import { GetChannelMessageCommandInput, GetChannelMessageCommandOutput } from "./commands/GetChannelMessageCommand";
34
35
  import { GetChannelMessageStatusCommandInput, GetChannelMessageStatusCommandOutput } from "./commands/GetChannelMessageStatusCommand";
35
36
  import { GetMessagingSessionEndpointCommandInput, GetMessagingSessionEndpointCommandOutput } from "./commands/GetMessagingSessionEndpointCommand";
37
+ import { GetMessagingStreamingConfigurationsCommandInput, GetMessagingStreamingConfigurationsCommandOutput } from "./commands/GetMessagingStreamingConfigurationsCommand";
36
38
  import { ListChannelBansCommandInput, ListChannelBansCommandOutput } from "./commands/ListChannelBansCommand";
37
39
  import { ListChannelFlowsCommandInput, ListChannelFlowsCommandOutput } from "./commands/ListChannelFlowsCommand";
38
40
  import { ListChannelMembershipsCommandInput, ListChannelMembershipsCommandOutput } from "./commands/ListChannelMembershipsCommand";
@@ -45,6 +47,7 @@ import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModerat
45
47
  import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
46
48
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
47
49
  import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
50
+ import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
48
51
  import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
49
52
  import { SearchChannelsCommandInput, SearchChannelsCommandOutput } from "./commands/SearchChannelsCommand";
50
53
  import { SendChannelMessageCommandInput, SendChannelMessageCommandOutput } from "./commands/SendChannelMessageCommand";
@@ -55,15 +58,24 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
55
58
  import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
56
59
  import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
57
60
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
58
- export type ServiceInputTypes = AssociateChannelFlowCommandInput | BatchCreateChannelMembershipCommandInput | ChannelFlowCallbackCommandInput | CreateChannelBanCommandInput | CreateChannelCommandInput | CreateChannelFlowCommandInput | CreateChannelMembershipCommandInput | CreateChannelModeratorCommandInput | DeleteChannelBanCommandInput | DeleteChannelCommandInput | DeleteChannelFlowCommandInput | DeleteChannelMembershipCommandInput | DeleteChannelMessageCommandInput | DeleteChannelModeratorCommandInput | DescribeChannelBanCommandInput | DescribeChannelCommandInput | DescribeChannelFlowCommandInput | DescribeChannelMembershipCommandInput | DescribeChannelMembershipForAppInstanceUserCommandInput | DescribeChannelModeratedByAppInstanceUserCommandInput | DescribeChannelModeratorCommandInput | DisassociateChannelFlowCommandInput | GetChannelMembershipPreferencesCommandInput | GetChannelMessageCommandInput | GetChannelMessageStatusCommandInput | GetMessagingSessionEndpointCommandInput | ListChannelBansCommandInput | ListChannelFlowsCommandInput | ListChannelMembershipsCommandInput | ListChannelMembershipsForAppInstanceUserCommandInput | ListChannelMessagesCommandInput | ListChannelModeratorsCommandInput | ListChannelsAssociatedWithChannelFlowCommandInput | ListChannelsCommandInput | ListChannelsModeratedByAppInstanceUserCommandInput | ListSubChannelsCommandInput | ListTagsForResourceCommandInput | PutChannelMembershipPreferencesCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
59
- export type ServiceOutputTypes = AssociateChannelFlowCommandOutput | BatchCreateChannelMembershipCommandOutput | ChannelFlowCallbackCommandOutput | CreateChannelBanCommandOutput | CreateChannelCommandOutput | CreateChannelFlowCommandOutput | CreateChannelMembershipCommandOutput | CreateChannelModeratorCommandOutput | DeleteChannelBanCommandOutput | DeleteChannelCommandOutput | DeleteChannelFlowCommandOutput | DeleteChannelMembershipCommandOutput | DeleteChannelMessageCommandOutput | DeleteChannelModeratorCommandOutput | DescribeChannelBanCommandOutput | DescribeChannelCommandOutput | DescribeChannelFlowCommandOutput | DescribeChannelMembershipCommandOutput | DescribeChannelMembershipForAppInstanceUserCommandOutput | DescribeChannelModeratedByAppInstanceUserCommandOutput | DescribeChannelModeratorCommandOutput | DisassociateChannelFlowCommandOutput | GetChannelMembershipPreferencesCommandOutput | GetChannelMessageCommandOutput | GetChannelMessageStatusCommandOutput | GetMessagingSessionEndpointCommandOutput | ListChannelBansCommandOutput | ListChannelFlowsCommandOutput | ListChannelMembershipsCommandOutput | ListChannelMembershipsForAppInstanceUserCommandOutput | ListChannelMessagesCommandOutput | ListChannelModeratorsCommandOutput | ListChannelsAssociatedWithChannelFlowCommandOutput | ListChannelsCommandOutput | ListChannelsModeratedByAppInstanceUserCommandOutput | ListSubChannelsCommandOutput | ListTagsForResourceCommandOutput | PutChannelMembershipPreferencesCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
61
+ /**
62
+ * @public
63
+ */
64
+ export type ServiceInputTypes = AssociateChannelFlowCommandInput | BatchCreateChannelMembershipCommandInput | ChannelFlowCallbackCommandInput | CreateChannelBanCommandInput | CreateChannelCommandInput | CreateChannelFlowCommandInput | CreateChannelMembershipCommandInput | CreateChannelModeratorCommandInput | DeleteChannelBanCommandInput | DeleteChannelCommandInput | DeleteChannelFlowCommandInput | DeleteChannelMembershipCommandInput | DeleteChannelMessageCommandInput | DeleteChannelModeratorCommandInput | DeleteMessagingStreamingConfigurationsCommandInput | DescribeChannelBanCommandInput | DescribeChannelCommandInput | DescribeChannelFlowCommandInput | DescribeChannelMembershipCommandInput | DescribeChannelMembershipForAppInstanceUserCommandInput | DescribeChannelModeratedByAppInstanceUserCommandInput | DescribeChannelModeratorCommandInput | DisassociateChannelFlowCommandInput | GetChannelMembershipPreferencesCommandInput | GetChannelMessageCommandInput | GetChannelMessageStatusCommandInput | GetMessagingSessionEndpointCommandInput | GetMessagingStreamingConfigurationsCommandInput | ListChannelBansCommandInput | ListChannelFlowsCommandInput | ListChannelMembershipsCommandInput | ListChannelMembershipsForAppInstanceUserCommandInput | ListChannelMessagesCommandInput | ListChannelModeratorsCommandInput | ListChannelsAssociatedWithChannelFlowCommandInput | ListChannelsCommandInput | ListChannelsModeratedByAppInstanceUserCommandInput | ListSubChannelsCommandInput | ListTagsForResourceCommandInput | PutChannelMembershipPreferencesCommandInput | PutMessagingStreamingConfigurationsCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
65
+ /**
66
+ * @public
67
+ */
68
+ export type ServiceOutputTypes = AssociateChannelFlowCommandOutput | BatchCreateChannelMembershipCommandOutput | ChannelFlowCallbackCommandOutput | CreateChannelBanCommandOutput | CreateChannelCommandOutput | CreateChannelFlowCommandOutput | CreateChannelMembershipCommandOutput | CreateChannelModeratorCommandOutput | DeleteChannelBanCommandOutput | DeleteChannelCommandOutput | DeleteChannelFlowCommandOutput | DeleteChannelMembershipCommandOutput | DeleteChannelMessageCommandOutput | DeleteChannelModeratorCommandOutput | DeleteMessagingStreamingConfigurationsCommandOutput | DescribeChannelBanCommandOutput | DescribeChannelCommandOutput | DescribeChannelFlowCommandOutput | DescribeChannelMembershipCommandOutput | DescribeChannelMembershipForAppInstanceUserCommandOutput | DescribeChannelModeratedByAppInstanceUserCommandOutput | DescribeChannelModeratorCommandOutput | DisassociateChannelFlowCommandOutput | GetChannelMembershipPreferencesCommandOutput | GetChannelMessageCommandOutput | GetChannelMessageStatusCommandOutput | GetMessagingSessionEndpointCommandOutput | GetMessagingStreamingConfigurationsCommandOutput | ListChannelBansCommandOutput | ListChannelFlowsCommandOutput | ListChannelMembershipsCommandOutput | ListChannelMembershipsForAppInstanceUserCommandOutput | ListChannelMessagesCommandOutput | ListChannelModeratorsCommandOutput | ListChannelsAssociatedWithChannelFlowCommandOutput | ListChannelsCommandOutput | ListChannelsModeratedByAppInstanceUserCommandOutput | ListSubChannelsCommandOutput | ListTagsForResourceCommandOutput | PutChannelMembershipPreferencesCommandOutput | PutMessagingStreamingConfigurationsCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
69
+ /**
70
+ * @public
71
+ */
60
72
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
61
73
  /**
62
74
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
63
75
  */
64
76
  requestHandler?: __HttpHandler;
65
77
  /**
66
- * A constructor for a class implementing the {@link __Checksum} interface
78
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
67
79
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
68
80
  * @internal
69
81
  */
@@ -153,23 +165,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
153
165
  */
154
166
  logger?: __Logger;
155
167
  /**
156
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
168
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
157
169
  */
158
170
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
159
171
  }
172
+ /**
173
+ * @public
174
+ */
160
175
  type ChimeSDKMessagingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
161
176
  /**
162
- * The configuration interface of ChimeSDKMessagingClient class constructor that set the region, credentials and other options.
177
+ * @public
178
+ *
179
+ * The configuration interface of ChimeSDKMessagingClient class constructor that set the region, credentials and other options.
163
180
  */
164
181
  export interface ChimeSDKMessagingClientConfig extends ChimeSDKMessagingClientConfigType {
165
182
  }
183
+ /**
184
+ * @public
185
+ */
166
186
  type ChimeSDKMessagingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
167
187
  /**
168
- * The resolved configuration interface of ChimeSDKMessagingClient class. This is resolved and normalized from the {@link ChimeSDKMessagingClientConfig | constructor configuration interface}.
188
+ * @public
189
+ *
190
+ * The resolved configuration interface of ChimeSDKMessagingClient class. This is resolved and normalized from the {@link ChimeSDKMessagingClientConfig | constructor configuration interface}.
169
191
  */
170
192
  export interface ChimeSDKMessagingClientResolvedConfig extends ChimeSDKMessagingClientResolvedConfigType {
171
193
  }
172
194
  /**
195
+ * @public
173
196
  * <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
174
197
  * and receive messages in custom messaging applications. These APIs depend on the frameworks
175
198
  * provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { AssociateChannelFlowRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AssociateChannelFlowCommand}.
8
10
  */
9
11
  export interface AssociateChannelFlowCommandInput extends AssociateChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AssociateChannelFlowCommand}.
13
17
  */
14
18
  export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
18
23
  * <code>DisassociateChannelFlow</code> API.</p>
19
- *
20
24
  * <note>
21
25
  * <p>Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code>
22
26
  * of the user that makes the API call as the value in the header.</p>
@@ -31,6 +35,8 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param AssociateChannelFlowCommandInput - {@link AssociateChannelFlowCommandInput}
39
+ * @returns {@link AssociateChannelFlowCommandOutput}
34
40
  * @see {@link AssociateChannelFlowCommandInput} for command's `input` shape.
35
41
  * @see {@link AssociateChannelFlowCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -65,11 +71,20 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
65
71
  export declare class AssociateChannelFlowCommand extends $Command<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
66
72
  readonly input: AssociateChannelFlowCommandInput;
67
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
68
77
  constructor(input: AssociateChannelFlowCommandInput);
69
78
  /**
70
79
  * @internal
71
80
  */
72
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
73
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
74
89
  private deserialize;
75
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { BatchCreateChannelMembershipRequest, BatchCreateChannelMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchCreateChannelMembershipCommand}.
8
10
  */
9
11
  export interface BatchCreateChannelMembershipCommandInput extends BatchCreateChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchCreateChannelMembershipCommand}.
13
17
  */
14
18
  export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateChannelMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a specified number of users to a channel. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param BatchCreateChannelMembershipCommandInput - {@link BatchCreateChannelMembershipCommandInput}
34
+ * @returns {@link BatchCreateChannelMembershipCommandOutput}
28
35
  * @see {@link BatchCreateChannelMembershipCommandInput} for command's `input` shape.
29
36
  * @see {@link BatchCreateChannelMembershipCommandOutput} for command's `response` shape.
30
37
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +65,20 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
58
65
  export declare class BatchCreateChannelMembershipCommand extends $Command<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
66
  readonly input: BatchCreateChannelMembershipCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: BatchCreateChannelMembershipCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { ChannelFlowCallbackRequest, ChannelFlowCallbackResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ChannelFlowCallbackCommand}.
8
10
  */
9
11
  export interface ChannelFlowCallbackCommandInput extends ChannelFlowCallbackRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ChannelFlowCallbackCommand}.
13
17
  */
14
18
  export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.</p>
18
23
  * <p>You can return one of the following processing responses:</p>
19
24
  * <ul>
@@ -37,6 +42,8 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param ChannelFlowCallbackCommandInput - {@link ChannelFlowCallbackCommandInput}
46
+ * @returns {@link ChannelFlowCallbackCommandOutput}
40
47
  * @see {@link ChannelFlowCallbackCommandInput} for command's `input` shape.
41
48
  * @see {@link ChannelFlowCallbackCommandOutput} for command's `response` shape.
42
49
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -68,11 +75,20 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
68
75
  export declare class ChannelFlowCallbackCommand extends $Command<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
69
76
  readonly input: ChannelFlowCallbackCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: ChannelFlowCallbackCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,23 +4,27 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelBanRequest, CreateChannelBanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelBanCommand}.
8
10
  */
9
11
  export interface CreateChannelBanCommandInput extends CreateChannelBanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelBanCommand}.
13
17
  */
14
18
  export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Permanently bans a member from a channel. Moderators can't add banned members to a
18
23
  * channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
19
24
  * <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
20
25
  * channels.</p>
21
26
  * <p>If you ban a user who is already part of a channel, that user is automatically kicked
22
27
  * from the channel.</p>
23
- *
24
28
  * <note>
25
29
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
26
30
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -36,6 +40,8 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
36
40
  * const response = await client.send(command);
37
41
  * ```
38
42
  *
43
+ * @param CreateChannelBanCommandInput - {@link CreateChannelBanCommandInput}
44
+ * @returns {@link CreateChannelBanCommandOutput}
39
45
  * @see {@link CreateChannelBanCommandInput} for command's `input` shape.
40
46
  * @see {@link CreateChannelBanCommandOutput} for command's `response` shape.
41
47
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -70,11 +76,20 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
70
76
  export declare class CreateChannelBanCommand extends $Command<CreateChannelBanCommandInput, CreateChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
71
77
  readonly input: CreateChannelBanCommandInput;
72
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
73
82
  constructor(input: CreateChannelBanCommandInput);
74
83
  /**
75
84
  * @internal
76
85
  */
77
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelBanCommandInput, CreateChannelBanCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
78
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
79
94
  private deserialize;
80
95
  }
@@ -4,22 +4,25 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelRequest, CreateChannelResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelCommand}.
8
10
  */
9
11
  export interface CreateChannelCommandInput extends CreateChannelRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelCommand}.
13
17
  */
14
18
  export interface CreateChannelCommandOutput extends CreateChannelResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a channel to which you can add users and send messages.</p>
18
- *
19
23
  * <p>
20
24
  * <b>Restriction</b>: You can't change a channel's
21
25
  * privacy.</p>
22
- *
23
26
  * <note>
24
27
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
25
28
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -35,6 +38,8 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
35
38
  * const response = await client.send(command);
36
39
  * ```
37
40
  *
41
+ * @param CreateChannelCommandInput - {@link CreateChannelCommandInput}
42
+ * @returns {@link CreateChannelCommandOutput}
38
43
  * @see {@link CreateChannelCommandInput} for command's `input` shape.
39
44
  * @see {@link CreateChannelCommandOutput} for command's `response` shape.
40
45
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -69,11 +74,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
69
74
  export declare class CreateChannelCommand extends $Command<CreateChannelCommandInput, CreateChannelCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
70
75
  readonly input: CreateChannelCommandInput;
71
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
72
80
  constructor(input: CreateChannelCommandInput);
73
81
  /**
74
82
  * @internal
75
83
  */
76
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelCommandInput, CreateChannelCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
77
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
78
92
  private deserialize;
79
93
  }
@@ -4,22 +4,26 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelFlowRequest, CreateChannelFlowResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelFlowCommand}.
8
10
  */
9
11
  export interface CreateChannelFlowCommandInput extends CreateChannelFlowRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelFlowCommand}.
13
17
  */
14
18
  export interface CreateChannelFlowCommandOutput extends CreateChannelFlowResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
18
23
  * that perform actions on chat messages, such as stripping out profanity. You can associate
19
24
  * channel flows with channels, and the processors in the channel flow then take action on all
20
25
  * messages sent to that channel. This is a developer API.</p>
21
- *
22
- * <p>Channel flows process the following items:</p>
26
+ * <p>Channel flows process the following items:</p>
23
27
  * <ol>
24
28
  * <li>
25
29
  * <p>New and updated messages</p>
@@ -31,7 +35,6 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
31
35
  * <p>The Standard message type</p>
32
36
  * </li>
33
37
  * </ol>
34
- *
35
38
  * <note>
36
39
  * <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to
37
40
  * <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
@@ -46,6 +49,8 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
46
49
  * const response = await client.send(command);
47
50
  * ```
48
51
  *
52
+ * @param CreateChannelFlowCommandInput - {@link CreateChannelFlowCommandInput}
53
+ * @returns {@link CreateChannelFlowCommandOutput}
49
54
  * @see {@link CreateChannelFlowCommandInput} for command's `input` shape.
50
55
  * @see {@link CreateChannelFlowCommandOutput} for command's `response` shape.
51
56
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -80,11 +85,20 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
80
85
  export declare class CreateChannelFlowCommand extends $Command<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
81
86
  readonly input: CreateChannelFlowCommandInput;
82
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
83
91
  constructor(input: CreateChannelFlowCommandInput);
84
92
  /**
85
93
  * @internal
86
94
  */
87
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelFlowCommandInput, CreateChannelFlowCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
88
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
89
103
  private deserialize;
90
104
  }
@@ -4,19 +4,23 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelMembershipRequest, CreateChannelMembershipResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelMembershipCommand}.
8
10
  */
9
11
  export interface CreateChannelMembershipCommandInput extends CreateChannelMembershipRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelMembershipCommand}.
13
17
  */
14
18
  export interface CreateChannelMembershipCommandOutput extends CreateChannelMembershipResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
18
23
  * request header. A channel member can:</p>
19
- *
20
24
  * <ul>
21
25
  * <li>
22
26
  * <p>List messages</p>
@@ -34,9 +38,7 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
34
38
  * <p>Leave the channel</p>
35
39
  * </li>
36
40
  * </ul>
37
- *
38
41
  * <p>Privacy settings impact this action as follows:</p>
39
- *
40
42
  * <ul>
41
43
  * <li>
42
44
  * <p>Public Channels: You do not need to be a member to list messages, but you must be
@@ -46,7 +48,6 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
46
48
  * <p>Private Channels: You must be a member to list or send messages.</p>
47
49
  * </li>
48
50
  * </ul>
49
- *
50
51
  * <note>
51
52
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
52
53
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -62,6 +63,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
62
63
  * const response = await client.send(command);
63
64
  * ```
64
65
  *
66
+ * @param CreateChannelMembershipCommandInput - {@link CreateChannelMembershipCommandInput}
67
+ * @returns {@link CreateChannelMembershipCommandOutput}
65
68
  * @see {@link CreateChannelMembershipCommandInput} for command's `input` shape.
66
69
  * @see {@link CreateChannelMembershipCommandOutput} for command's `response` shape.
67
70
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -99,11 +102,20 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
99
102
  export declare class CreateChannelMembershipCommand extends $Command<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
100
103
  readonly input: CreateChannelMembershipCommandInput;
101
104
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
105
+ /**
106
+ * @public
107
+ */
102
108
  constructor(input: CreateChannelMembershipCommandInput);
103
109
  /**
104
110
  * @internal
105
111
  */
106
112
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelMembershipCommandInput, CreateChannelMembershipCommandOutput>;
113
+ /**
114
+ * @internal
115
+ */
107
116
  private serialize;
117
+ /**
118
+ * @internal
119
+ */
108
120
  private deserialize;
109
121
  }
@@ -4,18 +4,22 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { CreateChannelModeratorRequest, CreateChannelModeratorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateChannelModeratorCommand}.
8
10
  */
9
11
  export interface CreateChannelModeratorCommandInput extends CreateChannelModeratorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateChannelModeratorCommand}.
13
17
  */
14
18
  export interface CreateChannelModeratorCommandOutput extends CreateChannelModeratorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
18
- *
19
23
  * <ul>
20
24
  * <li>
21
25
  * <p>Add and remove other members of the channel.</p>
@@ -33,7 +37,6 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
33
37
  * <p>List messages in the channel.</p>
34
38
  * </li>
35
39
  * </ul>
36
- *
37
40
  * <note>
38
41
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
39
42
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -49,6 +52,8 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
49
52
  * const response = await client.send(command);
50
53
  * ```
51
54
  *
55
+ * @param CreateChannelModeratorCommandInput - {@link CreateChannelModeratorCommandInput}
56
+ * @returns {@link CreateChannelModeratorCommandOutput}
52
57
  * @see {@link CreateChannelModeratorCommandInput} for command's `input` shape.
53
58
  * @see {@link CreateChannelModeratorCommandOutput} for command's `response` shape.
54
59
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -83,11 +88,20 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
83
88
  export declare class CreateChannelModeratorCommand extends $Command<CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
84
89
  readonly input: CreateChannelModeratorCommandInput;
85
90
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
91
+ /**
92
+ * @public
93
+ */
86
94
  constructor(input: CreateChannelModeratorCommandInput);
87
95
  /**
88
96
  * @internal
89
97
  */
90
98
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateChannelModeratorCommandInput, CreateChannelModeratorCommandOutput>;
99
+ /**
100
+ * @internal
101
+ */
91
102
  private serialize;
103
+ /**
104
+ * @internal
105
+ */
92
106
  private deserialize;
93
107
  }
@@ -4,18 +4,22 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
5
5
  import { DeleteChannelBanRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteChannelBanCommand}.
8
10
  */
9
11
  export interface DeleteChannelBanCommandInput extends DeleteChannelBanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteChannelBanCommand}.
13
17
  */
14
18
  export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes a user from a channel's ban list.</p>
18
- *
19
23
  * <note>
20
24
  * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
21
25
  * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
@@ -31,6 +35,8 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
31
35
  * const response = await client.send(command);
32
36
  * ```
33
37
  *
38
+ * @param DeleteChannelBanCommandInput - {@link DeleteChannelBanCommandInput}
39
+ * @returns {@link DeleteChannelBanCommandOutput}
34
40
  * @see {@link DeleteChannelBanCommandInput} for command's `input` shape.
35
41
  * @see {@link DeleteChannelBanCommandOutput} for command's `response` shape.
36
42
  * @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
@@ -58,11 +64,20 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
58
64
  export declare class DeleteChannelBanCommand extends $Command<DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
59
65
  readonly input: DeleteChannelBanCommandInput;
60
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
61
70
  constructor(input: DeleteChannelBanCommandInput);
62
71
  /**
63
72
  * @internal
64
73
  */
65
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteChannelBanCommandInput, DeleteChannelBanCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
66
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
67
82
  private deserialize;
68
83
  }