@wildix/xbees-conversations-client 1.0.18
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/dist-cjs/Conversations.js +27 -0
- package/dist-cjs/ConversationsClient.js +33 -0
- package/dist-cjs/commands/CreateChannelCommand.js +41 -0
- package/dist-cjs/commands/CreateMessageCommand.js +41 -0
- package/dist-cjs/commands/DeleteChannelCommand.js +41 -0
- package/dist-cjs/commands/GetChannelCommand.js +41 -0
- package/dist-cjs/commands/GetChannelMemberCommand.js +41 -0
- package/dist-cjs/commands/GetMessageCommand.js +41 -0
- package/dist-cjs/commands/PartialUpdateChannelCommand.js +41 -0
- package/dist-cjs/commands/UpdateChannelCommand.js +41 -0
- package/dist-cjs/commands/index.js +11 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/ConversationsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +96 -0
- package/dist-cjs/protocols/Aws_restJson1.js +597 -0
- package/dist-cjs/runtimeConfig.browser.js +28 -0
- package/dist-cjs/runtimeConfig.js +32 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +19 -0
- package/dist-cjs/runtimeExtensions.js +19 -0
- package/dist-es/Conversations.js +23 -0
- package/dist-es/ConversationsClient.js +29 -0
- package/dist-es/commands/CreateChannelCommand.js +37 -0
- package/dist-es/commands/CreateMessageCommand.js +37 -0
- package/dist-es/commands/DeleteChannelCommand.js +37 -0
- package/dist-es/commands/GetChannelCommand.js +37 -0
- package/dist-es/commands/GetChannelMemberCommand.js +37 -0
- package/dist-es/commands/GetMessageCommand.js +37 -0
- package/dist-es/commands/PartialUpdateChannelCommand.js +37 -0
- package/dist-es/commands/UpdateChannelCommand.js +37 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/ConversationsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +90 -0
- package/dist-es/protocols/Aws_restJson1.js +578 -0
- package/dist-es/runtimeConfig.browser.js +24 -0
- package/dist-es/runtimeConfig.js +28 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +15 -0
- package/dist-es/runtimeExtensions.js +15 -0
- package/dist-types/Conversations.d.ts +65 -0
- package/dist-types/ConversationsClient.d.ts +144 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +194 -0
- package/dist-types/commands/CreateMessageCommand.d.ts +360 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +71 -0
- package/dist-types/commands/GetChannelCommand.d.ts +136 -0
- package/dist-types/commands/GetChannelMemberCommand.d.ts +80 -0
- package/dist-types/commands/GetMessageCommand.d.ts +209 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +193 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +190 -0
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +7 -0
- package/dist-types/index.d.ts +5 -0
- package/dist-types/models/ConversationsServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +508 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +74 -0
- package/dist-types/runtimeConfig.browser.d.ts +29 -0
- package/dist-types/runtimeConfig.d.ts +29 -0
- package/dist-types/runtimeConfig.native.d.ts +28 -0
- package/dist-types/runtimeConfig.shared.d.ts +15 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +77 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetMessageInput, GetMessageOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link GetMessageCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface GetMessageCommandInput extends GetMessageInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link GetMessageCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface GetMessageCommandOutput extends GetMessageOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { ConversationsClient, GetMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
30
|
+
* // const { ConversationsClient, GetMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
31
|
+
* const client = new ConversationsClient(config);
|
|
32
|
+
* const input = { // GetMessageInput
|
|
33
|
+
* channelId: "STRING_VALUE", // required
|
|
34
|
+
* };
|
|
35
|
+
* const command = new GetMessageCommand(input);
|
|
36
|
+
* const response = await client.send(command);
|
|
37
|
+
* // { // GetMessageOutput
|
|
38
|
+
* // message: { // Message
|
|
39
|
+
* // type: "regular", // required
|
|
40
|
+
* // text: "STRING_VALUE",
|
|
41
|
+
* // silent: true || false,
|
|
42
|
+
* // event: "STRING_VALUE",
|
|
43
|
+
* // attachments: [ // MessageAttachmentList
|
|
44
|
+
* // { // MessageAttachment
|
|
45
|
+
* // id: "STRING_VALUE", // required
|
|
46
|
+
* // fsId: "STRING_VALUE", // required
|
|
47
|
+
* // mime: "STRING_VALUE",
|
|
48
|
+
* // name: "STRING_VALUE",
|
|
49
|
+
* // size: Number("int"), // required
|
|
50
|
+
* // width: Number("int"),
|
|
51
|
+
* // height: Number("int"),
|
|
52
|
+
* // thumbnail: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // giphy: { // MessageGiphy
|
|
56
|
+
* // id: "STRING_VALUE",
|
|
57
|
+
* // size: "STRING_VALUE",
|
|
58
|
+
* // url: "STRING_VALUE",
|
|
59
|
+
* // height: "STRING_VALUE",
|
|
60
|
+
* // width: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // quote: {
|
|
63
|
+
* // type: "regular", // required
|
|
64
|
+
* // text: "STRING_VALUE",
|
|
65
|
+
* // silent: true || false,
|
|
66
|
+
* // event: "STRING_VALUE",
|
|
67
|
+
* // attachments: [
|
|
68
|
+
* // {
|
|
69
|
+
* // id: "STRING_VALUE", // required
|
|
70
|
+
* // fsId: "STRING_VALUE", // required
|
|
71
|
+
* // mime: "STRING_VALUE",
|
|
72
|
+
* // name: "STRING_VALUE",
|
|
73
|
+
* // size: Number("int"), // required
|
|
74
|
+
* // width: Number("int"),
|
|
75
|
+
* // height: Number("int"),
|
|
76
|
+
* // thumbnail: "STRING_VALUE",
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // giphy: {
|
|
80
|
+
* // id: "STRING_VALUE",
|
|
81
|
+
* // size: "STRING_VALUE",
|
|
82
|
+
* // url: "STRING_VALUE",
|
|
83
|
+
* // height: "STRING_VALUE",
|
|
84
|
+
* // width: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // quote: "<Message>",
|
|
87
|
+
* // forward: { // MessageForward
|
|
88
|
+
* // forwardCompany: "STRING_VALUE",
|
|
89
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
90
|
+
* // forwardEmail: "STRING_VALUE",
|
|
91
|
+
* // forwardName: "STRING_VALUE",
|
|
92
|
+
* // },
|
|
93
|
+
* // sms: true || false,
|
|
94
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
95
|
+
* // messageId: "STRING_VALUE", // required
|
|
96
|
+
* // channelId: "STRING_VALUE", // required
|
|
97
|
+
* // user: { // User
|
|
98
|
+
* // id: "STRING_VALUE", // required
|
|
99
|
+
* // name: "STRING_VALUE",
|
|
100
|
+
* // email: "STRING_VALUE",
|
|
101
|
+
* // phone: "STRING_VALUE",
|
|
102
|
+
* // picture: "STRING_VALUE",
|
|
103
|
+
* // company: "STRING_VALUE",
|
|
104
|
+
* // pbxDomain: "STRING_VALUE",
|
|
105
|
+
* // pbxPort: "STRING_VALUE",
|
|
106
|
+
* // pbxExtension: "STRING_VALUE",
|
|
107
|
+
* // pbxSerial: "STRING_VALUE",
|
|
108
|
+
* // pbxUserId: "STRING_VALUE",
|
|
109
|
+
* // createdAt: "STRING_VALUE",
|
|
110
|
+
* // updatedAt: "STRING_VALUE",
|
|
111
|
+
* // },
|
|
112
|
+
* // edit: true || false,
|
|
113
|
+
* // mentions: [ // UserList
|
|
114
|
+
* // {
|
|
115
|
+
* // id: "STRING_VALUE", // required
|
|
116
|
+
* // name: "STRING_VALUE",
|
|
117
|
+
* // email: "STRING_VALUE",
|
|
118
|
+
* // phone: "STRING_VALUE",
|
|
119
|
+
* // picture: "STRING_VALUE",
|
|
120
|
+
* // company: "STRING_VALUE",
|
|
121
|
+
* // pbxDomain: "STRING_VALUE",
|
|
122
|
+
* // pbxPort: "STRING_VALUE",
|
|
123
|
+
* // pbxExtension: "STRING_VALUE",
|
|
124
|
+
* // pbxSerial: "STRING_VALUE",
|
|
125
|
+
* // pbxUserId: "STRING_VALUE",
|
|
126
|
+
* // createdAt: "STRING_VALUE",
|
|
127
|
+
* // updatedAt: "STRING_VALUE",
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // latestReactions: [ // ReactionList
|
|
131
|
+
* // { // Reaction
|
|
132
|
+
* // type: "STRING_VALUE",
|
|
133
|
+
* // userId: "STRING_VALUE",
|
|
134
|
+
* // messageId: "STRING_VALUE",
|
|
135
|
+
* // user: "<User>",
|
|
136
|
+
* // },
|
|
137
|
+
* // ],
|
|
138
|
+
* // reactionCounts: { // ReactionCounts
|
|
139
|
+
* // "<keys>": Number("int"),
|
|
140
|
+
* // },
|
|
141
|
+
* // createdAt: "STRING_VALUE", // required
|
|
142
|
+
* // updatedAt: "STRING_VALUE",
|
|
143
|
+
* // },
|
|
144
|
+
* // forward: {
|
|
145
|
+
* // forwardCompany: "STRING_VALUE",
|
|
146
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
147
|
+
* // forwardEmail: "STRING_VALUE",
|
|
148
|
+
* // forwardName: "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // sms: true || false,
|
|
151
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
152
|
+
* // messageId: "STRING_VALUE", // required
|
|
153
|
+
* // channelId: "STRING_VALUE", // required
|
|
154
|
+
* // user: "<User>", // required
|
|
155
|
+
* // edit: true || false,
|
|
156
|
+
* // mentions: [
|
|
157
|
+
* // "<User>",
|
|
158
|
+
* // ],
|
|
159
|
+
* // latestReactions: [
|
|
160
|
+
* // {
|
|
161
|
+
* // type: "STRING_VALUE",
|
|
162
|
+
* // userId: "STRING_VALUE",
|
|
163
|
+
* // messageId: "STRING_VALUE",
|
|
164
|
+
* // user: "<User>",
|
|
165
|
+
* // },
|
|
166
|
+
* // ],
|
|
167
|
+
* // reactionCounts: {
|
|
168
|
+
* // "<keys>": Number("int"),
|
|
169
|
+
* // },
|
|
170
|
+
* // createdAt: "STRING_VALUE", // required
|
|
171
|
+
* // updatedAt: "STRING_VALUE",
|
|
172
|
+
* // },
|
|
173
|
+
* // };
|
|
174
|
+
*
|
|
175
|
+
* ```
|
|
176
|
+
*
|
|
177
|
+
* @param GetMessageCommandInput - {@link GetMessageCommandInput}
|
|
178
|
+
* @returns {@link GetMessageCommandOutput}
|
|
179
|
+
* @see {@link GetMessageCommandInput} for command's `input` shape.
|
|
180
|
+
* @see {@link GetMessageCommandOutput} for command's `response` shape.
|
|
181
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
182
|
+
*
|
|
183
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
184
|
+
*
|
|
185
|
+
* @throws {@link ValidationException} (client fault)
|
|
186
|
+
*
|
|
187
|
+
* @throws {@link ConversationsServiceException}
|
|
188
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
189
|
+
*
|
|
190
|
+
*/
|
|
191
|
+
export declare class GetMessageCommand extends $Command<GetMessageCommandInput, GetMessageCommandOutput, ConversationsClientResolvedConfig> {
|
|
192
|
+
readonly input: GetMessageCommandInput;
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
constructor(input: GetMessageCommandInput);
|
|
197
|
+
/**
|
|
198
|
+
* @internal
|
|
199
|
+
*/
|
|
200
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetMessageCommandInput, GetMessageCommandOutput>;
|
|
201
|
+
/**
|
|
202
|
+
* @internal
|
|
203
|
+
*/
|
|
204
|
+
private serialize;
|
|
205
|
+
/**
|
|
206
|
+
* @internal
|
|
207
|
+
*/
|
|
208
|
+
private deserialize;
|
|
209
|
+
}
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { PartialUpdateChannelInput, PartialUpdateChannelOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link PartialUpdateChannelCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface PartialUpdateChannelCommandInput extends PartialUpdateChannelInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link PartialUpdateChannelCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface PartialUpdateChannelCommandOutput extends PartialUpdateChannelOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { ConversationsClient, PartialUpdateChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
30
|
+
* // const { ConversationsClient, PartialUpdateChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
31
|
+
* const client = new ConversationsClient(config);
|
|
32
|
+
* const input = { // PartialUpdateChannelInput
|
|
33
|
+
* channelId: "STRING_VALUE", // required
|
|
34
|
+
* set: { // ChannelUpdateFields
|
|
35
|
+
* subject: "STRING_VALUE",
|
|
36
|
+
* description: "STRING_VALUE",
|
|
37
|
+
* picture: "STRING_VALUE",
|
|
38
|
+
* pictureColor: "STRING_VALUE",
|
|
39
|
+
* access: "private" || "public",
|
|
40
|
+
* company: "STRING_VALUE",
|
|
41
|
+
* context: { // ChannelContext
|
|
42
|
+
* source: "kite",
|
|
43
|
+
* target: "STRING_VALUE",
|
|
44
|
+
* events: [ // ChannelContextEventList
|
|
45
|
+
* { // ChannelContextEvent
|
|
46
|
+
* id: "STRING_VALUE",
|
|
47
|
+
* owner: "STRING_VALUE",
|
|
48
|
+
* start: "STRING_VALUE",
|
|
49
|
+
* end: "STRING_VALUE",
|
|
50
|
+
* summary: "STRING_VALUE",
|
|
51
|
+
* attendees: [ // ChannelContextEventAttendeeList
|
|
52
|
+
* { // ChannelContextEventAttendee
|
|
53
|
+
* email: "STRING_VALUE", // required
|
|
54
|
+
* name: "STRING_VALUE",
|
|
55
|
+
* status: "accepted" || "tentative" || "declined" || "none", // required
|
|
56
|
+
* },
|
|
57
|
+
* ],
|
|
58
|
+
* },
|
|
59
|
+
* ],
|
|
60
|
+
* },
|
|
61
|
+
* kite: true || false,
|
|
62
|
+
* kiteTarget: "STRING_VALUE",
|
|
63
|
+
* kiteVariant: "STRING_VALUE",
|
|
64
|
+
* kiteAssign: "STRING_VALUE",
|
|
65
|
+
* kiteServiceName: "STRING_VALUE",
|
|
66
|
+
* kiteDefaultSubject: "STRING_VALUE",
|
|
67
|
+
* service: "STRING_VALUE",
|
|
68
|
+
* serviceTitle: "STRING_VALUE",
|
|
69
|
+
* serviceRecipient: "STRING_VALUE",
|
|
70
|
+
* assignee: { // User
|
|
71
|
+
* id: "STRING_VALUE", // required
|
|
72
|
+
* name: "STRING_VALUE",
|
|
73
|
+
* email: "STRING_VALUE",
|
|
74
|
+
* phone: "STRING_VALUE",
|
|
75
|
+
* picture: "STRING_VALUE",
|
|
76
|
+
* company: "STRING_VALUE",
|
|
77
|
+
* pbxDomain: "STRING_VALUE",
|
|
78
|
+
* pbxPort: "STRING_VALUE",
|
|
79
|
+
* pbxExtension: "STRING_VALUE",
|
|
80
|
+
* pbxSerial: "STRING_VALUE",
|
|
81
|
+
* pbxUserId: "STRING_VALUE",
|
|
82
|
+
* createdAt: "STRING_VALUE",
|
|
83
|
+
* updatedAt: "STRING_VALUE",
|
|
84
|
+
* },
|
|
85
|
+
* telephony: true || false,
|
|
86
|
+
* sms: true || false,
|
|
87
|
+
* broadcast: true || false,
|
|
88
|
+
* external: true || false,
|
|
89
|
+
* },
|
|
90
|
+
* unset: [ // ChannelUnsetFieldsList
|
|
91
|
+
* "subject" || "description" || "picture" || "pictureColor" || "access" || "company" || "context" || "kite" || "kiteTarget" || "kiteVariant" || "kiteAssign" || "kiteServiceName" || "kiteDefaultSubject" || "service" || "serviceTitle" || "serviceRecipient" || "assignee" || "telephony" || "sms" || "broadcast" || "external",
|
|
92
|
+
* ],
|
|
93
|
+
* };
|
|
94
|
+
* const command = new PartialUpdateChannelCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* // { // PartialUpdateChannelOutput
|
|
97
|
+
* // channel: { // Channel
|
|
98
|
+
* // subject: "STRING_VALUE",
|
|
99
|
+
* // description: "STRING_VALUE",
|
|
100
|
+
* // picture: "STRING_VALUE",
|
|
101
|
+
* // pictureColor: "STRING_VALUE",
|
|
102
|
+
* // access: "private" || "public",
|
|
103
|
+
* // company: "STRING_VALUE",
|
|
104
|
+
* // context: { // ChannelContext
|
|
105
|
+
* // source: "kite",
|
|
106
|
+
* // target: "STRING_VALUE",
|
|
107
|
+
* // events: [ // ChannelContextEventList
|
|
108
|
+
* // { // ChannelContextEvent
|
|
109
|
+
* // id: "STRING_VALUE",
|
|
110
|
+
* // owner: "STRING_VALUE",
|
|
111
|
+
* // start: "STRING_VALUE",
|
|
112
|
+
* // end: "STRING_VALUE",
|
|
113
|
+
* // summary: "STRING_VALUE",
|
|
114
|
+
* // attendees: [ // ChannelContextEventAttendeeList
|
|
115
|
+
* // { // ChannelContextEventAttendee
|
|
116
|
+
* // email: "STRING_VALUE", // required
|
|
117
|
+
* // name: "STRING_VALUE",
|
|
118
|
+
* // status: "accepted" || "tentative" || "declined" || "none", // required
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // kite: true || false,
|
|
125
|
+
* // kiteTarget: "STRING_VALUE",
|
|
126
|
+
* // kiteVariant: "STRING_VALUE",
|
|
127
|
+
* // kiteAssign: "STRING_VALUE",
|
|
128
|
+
* // kiteServiceName: "STRING_VALUE",
|
|
129
|
+
* // kiteDefaultSubject: "STRING_VALUE",
|
|
130
|
+
* // service: "STRING_VALUE",
|
|
131
|
+
* // serviceTitle: "STRING_VALUE",
|
|
132
|
+
* // serviceRecipient: "STRING_VALUE",
|
|
133
|
+
* // assignee: { // User
|
|
134
|
+
* // id: "STRING_VALUE", // required
|
|
135
|
+
* // name: "STRING_VALUE",
|
|
136
|
+
* // email: "STRING_VALUE",
|
|
137
|
+
* // phone: "STRING_VALUE",
|
|
138
|
+
* // picture: "STRING_VALUE",
|
|
139
|
+
* // company: "STRING_VALUE",
|
|
140
|
+
* // pbxDomain: "STRING_VALUE",
|
|
141
|
+
* // pbxPort: "STRING_VALUE",
|
|
142
|
+
* // pbxExtension: "STRING_VALUE",
|
|
143
|
+
* // pbxSerial: "STRING_VALUE",
|
|
144
|
+
* // pbxUserId: "STRING_VALUE",
|
|
145
|
+
* // createdAt: "STRING_VALUE",
|
|
146
|
+
* // updatedAt: "STRING_VALUE",
|
|
147
|
+
* // },
|
|
148
|
+
* // telephony: true || false,
|
|
149
|
+
* // sms: true || false,
|
|
150
|
+
* // broadcast: true || false,
|
|
151
|
+
* // external: true || false,
|
|
152
|
+
* // channelId: "STRING_VALUE", // required
|
|
153
|
+
* // channelType: "direct" || "group", // required
|
|
154
|
+
* // memberCount: Number("int"), // required
|
|
155
|
+
* // createdAt: "STRING_VALUE", // required
|
|
156
|
+
* // createdBy: "STRING_VALUE", // required
|
|
157
|
+
* // updatedAt: "STRING_VALUE",
|
|
158
|
+
* // },
|
|
159
|
+
* // };
|
|
160
|
+
*
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
163
|
+
* @param PartialUpdateChannelCommandInput - {@link PartialUpdateChannelCommandInput}
|
|
164
|
+
* @returns {@link PartialUpdateChannelCommandOutput}
|
|
165
|
+
* @see {@link PartialUpdateChannelCommandInput} for command's `input` shape.
|
|
166
|
+
* @see {@link PartialUpdateChannelCommandOutput} for command's `response` shape.
|
|
167
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link ValidationException} (client fault)
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link ConversationsServiceException}
|
|
172
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
173
|
+
*
|
|
174
|
+
*/
|
|
175
|
+
export declare class PartialUpdateChannelCommand extends $Command<PartialUpdateChannelCommandInput, PartialUpdateChannelCommandOutput, ConversationsClientResolvedConfig> {
|
|
176
|
+
readonly input: PartialUpdateChannelCommandInput;
|
|
177
|
+
/**
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
constructor(input: PartialUpdateChannelCommandInput);
|
|
181
|
+
/**
|
|
182
|
+
* @internal
|
|
183
|
+
*/
|
|
184
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PartialUpdateChannelCommandInput, PartialUpdateChannelCommandOutput>;
|
|
185
|
+
/**
|
|
186
|
+
* @internal
|
|
187
|
+
*/
|
|
188
|
+
private serialize;
|
|
189
|
+
/**
|
|
190
|
+
* @internal
|
|
191
|
+
*/
|
|
192
|
+
private deserialize;
|
|
193
|
+
}
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { UpdateChannelInput, UpdateChannelOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link UpdateChannelCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface UpdateChannelCommandInput extends UpdateChannelInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link UpdateChannelCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface UpdateChannelCommandOutput extends UpdateChannelOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { ConversationsClient, UpdateChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
30
|
+
* // const { ConversationsClient, UpdateChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
31
|
+
* const client = new ConversationsClient(config);
|
|
32
|
+
* const input = { // UpdateChannelInput
|
|
33
|
+
* channelId: "STRING_VALUE", // required
|
|
34
|
+
* channel: { // ChannelUpdateFields
|
|
35
|
+
* subject: "STRING_VALUE",
|
|
36
|
+
* description: "STRING_VALUE",
|
|
37
|
+
* picture: "STRING_VALUE",
|
|
38
|
+
* pictureColor: "STRING_VALUE",
|
|
39
|
+
* access: "private" || "public",
|
|
40
|
+
* company: "STRING_VALUE",
|
|
41
|
+
* context: { // ChannelContext
|
|
42
|
+
* source: "kite",
|
|
43
|
+
* target: "STRING_VALUE",
|
|
44
|
+
* events: [ // ChannelContextEventList
|
|
45
|
+
* { // ChannelContextEvent
|
|
46
|
+
* id: "STRING_VALUE",
|
|
47
|
+
* owner: "STRING_VALUE",
|
|
48
|
+
* start: "STRING_VALUE",
|
|
49
|
+
* end: "STRING_VALUE",
|
|
50
|
+
* summary: "STRING_VALUE",
|
|
51
|
+
* attendees: [ // ChannelContextEventAttendeeList
|
|
52
|
+
* { // ChannelContextEventAttendee
|
|
53
|
+
* email: "STRING_VALUE", // required
|
|
54
|
+
* name: "STRING_VALUE",
|
|
55
|
+
* status: "accepted" || "tentative" || "declined" || "none", // required
|
|
56
|
+
* },
|
|
57
|
+
* ],
|
|
58
|
+
* },
|
|
59
|
+
* ],
|
|
60
|
+
* },
|
|
61
|
+
* kite: true || false,
|
|
62
|
+
* kiteTarget: "STRING_VALUE",
|
|
63
|
+
* kiteVariant: "STRING_VALUE",
|
|
64
|
+
* kiteAssign: "STRING_VALUE",
|
|
65
|
+
* kiteServiceName: "STRING_VALUE",
|
|
66
|
+
* kiteDefaultSubject: "STRING_VALUE",
|
|
67
|
+
* service: "STRING_VALUE",
|
|
68
|
+
* serviceTitle: "STRING_VALUE",
|
|
69
|
+
* serviceRecipient: "STRING_VALUE",
|
|
70
|
+
* assignee: { // User
|
|
71
|
+
* id: "STRING_VALUE", // required
|
|
72
|
+
* name: "STRING_VALUE",
|
|
73
|
+
* email: "STRING_VALUE",
|
|
74
|
+
* phone: "STRING_VALUE",
|
|
75
|
+
* picture: "STRING_VALUE",
|
|
76
|
+
* company: "STRING_VALUE",
|
|
77
|
+
* pbxDomain: "STRING_VALUE",
|
|
78
|
+
* pbxPort: "STRING_VALUE",
|
|
79
|
+
* pbxExtension: "STRING_VALUE",
|
|
80
|
+
* pbxSerial: "STRING_VALUE",
|
|
81
|
+
* pbxUserId: "STRING_VALUE",
|
|
82
|
+
* createdAt: "STRING_VALUE",
|
|
83
|
+
* updatedAt: "STRING_VALUE",
|
|
84
|
+
* },
|
|
85
|
+
* telephony: true || false,
|
|
86
|
+
* sms: true || false,
|
|
87
|
+
* broadcast: true || false,
|
|
88
|
+
* external: true || false,
|
|
89
|
+
* },
|
|
90
|
+
* };
|
|
91
|
+
* const command = new UpdateChannelCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* // { // UpdateChannelOutput
|
|
94
|
+
* // channel: { // Channel
|
|
95
|
+
* // subject: "STRING_VALUE",
|
|
96
|
+
* // description: "STRING_VALUE",
|
|
97
|
+
* // picture: "STRING_VALUE",
|
|
98
|
+
* // pictureColor: "STRING_VALUE",
|
|
99
|
+
* // access: "private" || "public",
|
|
100
|
+
* // company: "STRING_VALUE",
|
|
101
|
+
* // context: { // ChannelContext
|
|
102
|
+
* // source: "kite",
|
|
103
|
+
* // target: "STRING_VALUE",
|
|
104
|
+
* // events: [ // ChannelContextEventList
|
|
105
|
+
* // { // ChannelContextEvent
|
|
106
|
+
* // id: "STRING_VALUE",
|
|
107
|
+
* // owner: "STRING_VALUE",
|
|
108
|
+
* // start: "STRING_VALUE",
|
|
109
|
+
* // end: "STRING_VALUE",
|
|
110
|
+
* // summary: "STRING_VALUE",
|
|
111
|
+
* // attendees: [ // ChannelContextEventAttendeeList
|
|
112
|
+
* // { // ChannelContextEventAttendee
|
|
113
|
+
* // email: "STRING_VALUE", // required
|
|
114
|
+
* // name: "STRING_VALUE",
|
|
115
|
+
* // status: "accepted" || "tentative" || "declined" || "none", // required
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // ],
|
|
120
|
+
* // },
|
|
121
|
+
* // kite: true || false,
|
|
122
|
+
* // kiteTarget: "STRING_VALUE",
|
|
123
|
+
* // kiteVariant: "STRING_VALUE",
|
|
124
|
+
* // kiteAssign: "STRING_VALUE",
|
|
125
|
+
* // kiteServiceName: "STRING_VALUE",
|
|
126
|
+
* // kiteDefaultSubject: "STRING_VALUE",
|
|
127
|
+
* // service: "STRING_VALUE",
|
|
128
|
+
* // serviceTitle: "STRING_VALUE",
|
|
129
|
+
* // serviceRecipient: "STRING_VALUE",
|
|
130
|
+
* // assignee: { // User
|
|
131
|
+
* // id: "STRING_VALUE", // required
|
|
132
|
+
* // name: "STRING_VALUE",
|
|
133
|
+
* // email: "STRING_VALUE",
|
|
134
|
+
* // phone: "STRING_VALUE",
|
|
135
|
+
* // picture: "STRING_VALUE",
|
|
136
|
+
* // company: "STRING_VALUE",
|
|
137
|
+
* // pbxDomain: "STRING_VALUE",
|
|
138
|
+
* // pbxPort: "STRING_VALUE",
|
|
139
|
+
* // pbxExtension: "STRING_VALUE",
|
|
140
|
+
* // pbxSerial: "STRING_VALUE",
|
|
141
|
+
* // pbxUserId: "STRING_VALUE",
|
|
142
|
+
* // createdAt: "STRING_VALUE",
|
|
143
|
+
* // updatedAt: "STRING_VALUE",
|
|
144
|
+
* // },
|
|
145
|
+
* // telephony: true || false,
|
|
146
|
+
* // sms: true || false,
|
|
147
|
+
* // broadcast: true || false,
|
|
148
|
+
* // external: true || false,
|
|
149
|
+
* // channelId: "STRING_VALUE", // required
|
|
150
|
+
* // channelType: "direct" || "group", // required
|
|
151
|
+
* // memberCount: Number("int"), // required
|
|
152
|
+
* // createdAt: "STRING_VALUE", // required
|
|
153
|
+
* // createdBy: "STRING_VALUE", // required
|
|
154
|
+
* // updatedAt: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // };
|
|
157
|
+
*
|
|
158
|
+
* ```
|
|
159
|
+
*
|
|
160
|
+
* @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput}
|
|
161
|
+
* @returns {@link UpdateChannelCommandOutput}
|
|
162
|
+
* @see {@link UpdateChannelCommandInput} for command's `input` shape.
|
|
163
|
+
* @see {@link UpdateChannelCommandOutput} for command's `response` shape.
|
|
164
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link ValidationException} (client fault)
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link ConversationsServiceException}
|
|
169
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
170
|
+
*
|
|
171
|
+
*/
|
|
172
|
+
export declare class UpdateChannelCommand extends $Command<UpdateChannelCommandInput, UpdateChannelCommandOutput, ConversationsClientResolvedConfig> {
|
|
173
|
+
readonly input: UpdateChannelCommandInput;
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
constructor(input: UpdateChannelCommandInput);
|
|
178
|
+
/**
|
|
179
|
+
* @internal
|
|
180
|
+
*/
|
|
181
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateChannelCommandInput, UpdateChannelCommandOutput>;
|
|
182
|
+
/**
|
|
183
|
+
* @internal
|
|
184
|
+
*/
|
|
185
|
+
private serialize;
|
|
186
|
+
/**
|
|
187
|
+
* @internal
|
|
188
|
+
*/
|
|
189
|
+
private deserialize;
|
|
190
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export * from "./CreateChannelCommand";
|
|
2
|
+
export * from "./CreateMessageCommand";
|
|
3
|
+
export * from "./DeleteChannelCommand";
|
|
4
|
+
export * from "./GetChannelCommand";
|
|
5
|
+
export * from "./GetChannelMemberCommand";
|
|
6
|
+
export * from "./GetMessageCommand";
|
|
7
|
+
export * from "./PartialUpdateChannelCommand";
|
|
8
|
+
export * from "./UpdateChannelCommand";
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
|
|
2
|
+
import { DefaultExtensionConfiguration } from "@smithy/types";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface ConversationsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
|
|
2
|
+
export { __ServiceException, __ServiceExceptionOptions };
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*
|
|
6
|
+
* Base exception class for all service exceptions from Conversations service.
|
|
7
|
+
*/
|
|
8
|
+
export declare class ConversationsServiceException extends __ServiceException {
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(options: __ServiceExceptionOptions);
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./models_0";
|