@wildix/xbees-conversations-client 1.1.15 → 1.1.17
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 +14 -0
- package/dist-cjs/commands/GetOrCreateSmsChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateTelephonyChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateWhatsAppChannelCommand.js +21 -0
- package/dist-cjs/commands/GetSmsChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetTelephonyChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetWhatsAppChannelIdCommand.js +21 -0
- package/dist-cjs/commands/SendTemplateMessageCommand.js +21 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +265 -3
- package/dist-es/Conversations.js +14 -0
- package/dist-es/commands/GetOrCreateSmsChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateTelephonyChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateWhatsAppChannelCommand.js +17 -0
- package/dist-es/commands/GetSmsChannelIdCommand.js +17 -0
- package/dist-es/commands/GetTelephonyChannelIdCommand.js +17 -0
- package/dist-es/commands/GetWhatsAppChannelIdCommand.js +17 -0
- package/dist-es/commands/SendTemplateMessageCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +248 -0
- package/dist-types/Conversations.d.ts +49 -0
- package/dist-types/ConversationsClient.d.ts +9 -2
- package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetSmsChannelIdCommand.d.ts +81 -0
- package/dist-types/commands/GetTelephonyChannelIdCommand.d.ts +81 -0
- package/dist-types/commands/GetWhatsAppChannelIdCommand.d.ts +81 -0
- package/dist-types/commands/SendTemplateMessageCommand.d.ts +365 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +243 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/package.json +1 -1
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetOrCreateSmsChannelInput, GetOrCreateSmsChannelOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOrCreateSmsChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOrCreateSmsChannelCommandInput extends GetOrCreateSmsChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOrCreateSmsChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOrCreateSmsChannelCommandOutput extends GetOrCreateSmsChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOrCreateSmsChannelCommand_base: {
|
|
25
|
+
new (input: GetOrCreateSmsChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateSmsChannelCommandInput, GetOrCreateSmsChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOrCreateSmsChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateSmsChannelCommandInput, GetOrCreateSmsChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets or creates a SMS channel
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetOrCreateSmsChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetOrCreateSmsChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetOrCreateSmsChannelInput
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* serviceUri: "STRING_VALUE", // required
|
|
40
|
+
* recipientId: "STRING_VALUE",
|
|
41
|
+
* recipientNumber: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetOrCreateSmsChannelCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetOrCreateSmsChannelOutput
|
|
46
|
+
* // channel: { // Channel
|
|
47
|
+
* // subject: "STRING_VALUE",
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // picture: "STRING_VALUE",
|
|
50
|
+
* // pictureColor: "STRING_VALUE",
|
|
51
|
+
* // access: "private" || "public",
|
|
52
|
+
* // company: "STRING_VALUE",
|
|
53
|
+
* // context: { // ChannelContext
|
|
54
|
+
* // source: "kite",
|
|
55
|
+
* // target: "STRING_VALUE",
|
|
56
|
+
* // events: [ // ChannelContextEventList
|
|
57
|
+
* // { // ChannelContextEvent
|
|
58
|
+
* // id: "STRING_VALUE",
|
|
59
|
+
* // owner: "STRING_VALUE",
|
|
60
|
+
* // start: "STRING_VALUE",
|
|
61
|
+
* // end: "STRING_VALUE",
|
|
62
|
+
* // summary: "STRING_VALUE",
|
|
63
|
+
* // attendees: [ // ChannelContextEventAttendeeList
|
|
64
|
+
* // { // ChannelContextEventAttendee
|
|
65
|
+
* // email: "STRING_VALUE", // required
|
|
66
|
+
* // name: "STRING_VALUE",
|
|
67
|
+
* // status: "accepted" || "tentative" || "declined" || "none", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // ptt: { // ChannelContextPushToTalk
|
|
73
|
+
* // broadcastId: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // kite: true || false,
|
|
77
|
+
* // kiteTarget: "STRING_VALUE",
|
|
78
|
+
* // kiteVariant: "STRING_VALUE",
|
|
79
|
+
* // kiteAssign: "STRING_VALUE",
|
|
80
|
+
* // kiteServiceName: "STRING_VALUE",
|
|
81
|
+
* // kiteDefaultSubject: "STRING_VALUE",
|
|
82
|
+
* // service: "STRING_VALUE",
|
|
83
|
+
* // serviceTitle: "STRING_VALUE",
|
|
84
|
+
* // serviceRecipient: "STRING_VALUE",
|
|
85
|
+
* // assignee: { // User
|
|
86
|
+
* // id: "STRING_VALUE", // required
|
|
87
|
+
* // name: "STRING_VALUE",
|
|
88
|
+
* // email: "STRING_VALUE",
|
|
89
|
+
* // phone: "STRING_VALUE",
|
|
90
|
+
* // picture: "STRING_VALUE",
|
|
91
|
+
* // locale: "STRING_VALUE",
|
|
92
|
+
* // timeZone: "STRING_VALUE",
|
|
93
|
+
* // company: "STRING_VALUE",
|
|
94
|
+
* // bot: true || false,
|
|
95
|
+
* // pbxDomain: "STRING_VALUE",
|
|
96
|
+
* // pbxPort: "STRING_VALUE",
|
|
97
|
+
* // pbxExtension: "STRING_VALUE",
|
|
98
|
+
* // pbxSerial: "STRING_VALUE",
|
|
99
|
+
* // pbxUserId: "STRING_VALUE",
|
|
100
|
+
* // createdAt: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // telephony: true || false,
|
|
104
|
+
* // sms: true || false,
|
|
105
|
+
* // mms: true || false,
|
|
106
|
+
* // whatsapp: true || false,
|
|
107
|
+
* // whatsappStatus: "24h_channel_closed",
|
|
108
|
+
* // broadcast: true || false,
|
|
109
|
+
* // external: true || false,
|
|
110
|
+
* // channelId: "STRING_VALUE", // required
|
|
111
|
+
* // channelType: "direct" || "group", // required
|
|
112
|
+
* // memberCount: Number("int"), // required
|
|
113
|
+
* // createdAt: "STRING_VALUE", // required
|
|
114
|
+
* // createdBy: "STRING_VALUE", // required
|
|
115
|
+
* // updatedAt: "STRING_VALUE",
|
|
116
|
+
* // },
|
|
117
|
+
* // };
|
|
118
|
+
*
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
121
|
+
* @param GetOrCreateSmsChannelCommandInput - {@link GetOrCreateSmsChannelCommandInput}
|
|
122
|
+
* @returns {@link GetOrCreateSmsChannelCommandOutput}
|
|
123
|
+
* @see {@link GetOrCreateSmsChannelCommandInput} for command's `input` shape.
|
|
124
|
+
* @see {@link GetOrCreateSmsChannelCommandOutput} for command's `response` shape.
|
|
125
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ValidationException} (client fault)
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ConversationsServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class GetOrCreateSmsChannelCommand extends GetOrCreateSmsChannelCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: GetOrCreateSmsChannelInput;
|
|
144
|
+
output: GetOrCreateSmsChannelOutput;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: GetOrCreateSmsChannelCommandInput;
|
|
148
|
+
output: GetOrCreateSmsChannelCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetOrCreateTelephonyChannelInput, GetOrCreateTelephonyChannelOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOrCreateTelephonyChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOrCreateTelephonyChannelCommandInput extends GetOrCreateTelephonyChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOrCreateTelephonyChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOrCreateTelephonyChannelCommandOutput extends GetOrCreateTelephonyChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOrCreateTelephonyChannelCommand_base: {
|
|
25
|
+
new (input: GetOrCreateTelephonyChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateTelephonyChannelCommandInput, GetOrCreateTelephonyChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOrCreateTelephonyChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateTelephonyChannelCommandInput, GetOrCreateTelephonyChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets or creates a telephony channel
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetOrCreateTelephonyChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetOrCreateTelephonyChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetOrCreateTelephonyChannelInput
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* serviceUri: "STRING_VALUE", // required
|
|
40
|
+
* recipientId: "STRING_VALUE",
|
|
41
|
+
* recipientNumber: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetOrCreateTelephonyChannelCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetOrCreateTelephonyChannelOutput
|
|
46
|
+
* // channel: { // Channel
|
|
47
|
+
* // subject: "STRING_VALUE",
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // picture: "STRING_VALUE",
|
|
50
|
+
* // pictureColor: "STRING_VALUE",
|
|
51
|
+
* // access: "private" || "public",
|
|
52
|
+
* // company: "STRING_VALUE",
|
|
53
|
+
* // context: { // ChannelContext
|
|
54
|
+
* // source: "kite",
|
|
55
|
+
* // target: "STRING_VALUE",
|
|
56
|
+
* // events: [ // ChannelContextEventList
|
|
57
|
+
* // { // ChannelContextEvent
|
|
58
|
+
* // id: "STRING_VALUE",
|
|
59
|
+
* // owner: "STRING_VALUE",
|
|
60
|
+
* // start: "STRING_VALUE",
|
|
61
|
+
* // end: "STRING_VALUE",
|
|
62
|
+
* // summary: "STRING_VALUE",
|
|
63
|
+
* // attendees: [ // ChannelContextEventAttendeeList
|
|
64
|
+
* // { // ChannelContextEventAttendee
|
|
65
|
+
* // email: "STRING_VALUE", // required
|
|
66
|
+
* // name: "STRING_VALUE",
|
|
67
|
+
* // status: "accepted" || "tentative" || "declined" || "none", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // ptt: { // ChannelContextPushToTalk
|
|
73
|
+
* // broadcastId: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // kite: true || false,
|
|
77
|
+
* // kiteTarget: "STRING_VALUE",
|
|
78
|
+
* // kiteVariant: "STRING_VALUE",
|
|
79
|
+
* // kiteAssign: "STRING_VALUE",
|
|
80
|
+
* // kiteServiceName: "STRING_VALUE",
|
|
81
|
+
* // kiteDefaultSubject: "STRING_VALUE",
|
|
82
|
+
* // service: "STRING_VALUE",
|
|
83
|
+
* // serviceTitle: "STRING_VALUE",
|
|
84
|
+
* // serviceRecipient: "STRING_VALUE",
|
|
85
|
+
* // assignee: { // User
|
|
86
|
+
* // id: "STRING_VALUE", // required
|
|
87
|
+
* // name: "STRING_VALUE",
|
|
88
|
+
* // email: "STRING_VALUE",
|
|
89
|
+
* // phone: "STRING_VALUE",
|
|
90
|
+
* // picture: "STRING_VALUE",
|
|
91
|
+
* // locale: "STRING_VALUE",
|
|
92
|
+
* // timeZone: "STRING_VALUE",
|
|
93
|
+
* // company: "STRING_VALUE",
|
|
94
|
+
* // bot: true || false,
|
|
95
|
+
* // pbxDomain: "STRING_VALUE",
|
|
96
|
+
* // pbxPort: "STRING_VALUE",
|
|
97
|
+
* // pbxExtension: "STRING_VALUE",
|
|
98
|
+
* // pbxSerial: "STRING_VALUE",
|
|
99
|
+
* // pbxUserId: "STRING_VALUE",
|
|
100
|
+
* // createdAt: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // telephony: true || false,
|
|
104
|
+
* // sms: true || false,
|
|
105
|
+
* // mms: true || false,
|
|
106
|
+
* // whatsapp: true || false,
|
|
107
|
+
* // whatsappStatus: "24h_channel_closed",
|
|
108
|
+
* // broadcast: true || false,
|
|
109
|
+
* // external: true || false,
|
|
110
|
+
* // channelId: "STRING_VALUE", // required
|
|
111
|
+
* // channelType: "direct" || "group", // required
|
|
112
|
+
* // memberCount: Number("int"), // required
|
|
113
|
+
* // createdAt: "STRING_VALUE", // required
|
|
114
|
+
* // createdBy: "STRING_VALUE", // required
|
|
115
|
+
* // updatedAt: "STRING_VALUE",
|
|
116
|
+
* // },
|
|
117
|
+
* // };
|
|
118
|
+
*
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
121
|
+
* @param GetOrCreateTelephonyChannelCommandInput - {@link GetOrCreateTelephonyChannelCommandInput}
|
|
122
|
+
* @returns {@link GetOrCreateTelephonyChannelCommandOutput}
|
|
123
|
+
* @see {@link GetOrCreateTelephonyChannelCommandInput} for command's `input` shape.
|
|
124
|
+
* @see {@link GetOrCreateTelephonyChannelCommandOutput} for command's `response` shape.
|
|
125
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ValidationException} (client fault)
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ConversationsServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class GetOrCreateTelephonyChannelCommand extends GetOrCreateTelephonyChannelCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: GetOrCreateTelephonyChannelInput;
|
|
144
|
+
output: GetOrCreateTelephonyChannelOutput;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: GetOrCreateTelephonyChannelCommandInput;
|
|
148
|
+
output: GetOrCreateTelephonyChannelCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetOrCreateWhatsAppChannelInput, GetOrCreateWhatsAppChannelOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOrCreateWhatsAppChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOrCreateWhatsAppChannelCommandInput extends GetOrCreateWhatsAppChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOrCreateWhatsAppChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOrCreateWhatsAppChannelCommandOutput extends GetOrCreateWhatsAppChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOrCreateWhatsAppChannelCommand_base: {
|
|
25
|
+
new (input: GetOrCreateWhatsAppChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateWhatsAppChannelCommandInput, GetOrCreateWhatsAppChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOrCreateWhatsAppChannelCommandInput): import("@smithy/smithy-client").CommandImpl<GetOrCreateWhatsAppChannelCommandInput, GetOrCreateWhatsAppChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets or creates a WhatsApp channel
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetOrCreateWhatsAppChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetOrCreateWhatsAppChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetOrCreateWhatsAppChannelInput
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* serviceUri: "STRING_VALUE", // required
|
|
40
|
+
* recipientId: "STRING_VALUE",
|
|
41
|
+
* recipientNumber: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetOrCreateWhatsAppChannelCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetOrCreateWhatsAppChannelOutput
|
|
46
|
+
* // channel: { // Channel
|
|
47
|
+
* // subject: "STRING_VALUE",
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // picture: "STRING_VALUE",
|
|
50
|
+
* // pictureColor: "STRING_VALUE",
|
|
51
|
+
* // access: "private" || "public",
|
|
52
|
+
* // company: "STRING_VALUE",
|
|
53
|
+
* // context: { // ChannelContext
|
|
54
|
+
* // source: "kite",
|
|
55
|
+
* // target: "STRING_VALUE",
|
|
56
|
+
* // events: [ // ChannelContextEventList
|
|
57
|
+
* // { // ChannelContextEvent
|
|
58
|
+
* // id: "STRING_VALUE",
|
|
59
|
+
* // owner: "STRING_VALUE",
|
|
60
|
+
* // start: "STRING_VALUE",
|
|
61
|
+
* // end: "STRING_VALUE",
|
|
62
|
+
* // summary: "STRING_VALUE",
|
|
63
|
+
* // attendees: [ // ChannelContextEventAttendeeList
|
|
64
|
+
* // { // ChannelContextEventAttendee
|
|
65
|
+
* // email: "STRING_VALUE", // required
|
|
66
|
+
* // name: "STRING_VALUE",
|
|
67
|
+
* // status: "accepted" || "tentative" || "declined" || "none", // required
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // ptt: { // ChannelContextPushToTalk
|
|
73
|
+
* // broadcastId: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // kite: true || false,
|
|
77
|
+
* // kiteTarget: "STRING_VALUE",
|
|
78
|
+
* // kiteVariant: "STRING_VALUE",
|
|
79
|
+
* // kiteAssign: "STRING_VALUE",
|
|
80
|
+
* // kiteServiceName: "STRING_VALUE",
|
|
81
|
+
* // kiteDefaultSubject: "STRING_VALUE",
|
|
82
|
+
* // service: "STRING_VALUE",
|
|
83
|
+
* // serviceTitle: "STRING_VALUE",
|
|
84
|
+
* // serviceRecipient: "STRING_VALUE",
|
|
85
|
+
* // assignee: { // User
|
|
86
|
+
* // id: "STRING_VALUE", // required
|
|
87
|
+
* // name: "STRING_VALUE",
|
|
88
|
+
* // email: "STRING_VALUE",
|
|
89
|
+
* // phone: "STRING_VALUE",
|
|
90
|
+
* // picture: "STRING_VALUE",
|
|
91
|
+
* // locale: "STRING_VALUE",
|
|
92
|
+
* // timeZone: "STRING_VALUE",
|
|
93
|
+
* // company: "STRING_VALUE",
|
|
94
|
+
* // bot: true || false,
|
|
95
|
+
* // pbxDomain: "STRING_VALUE",
|
|
96
|
+
* // pbxPort: "STRING_VALUE",
|
|
97
|
+
* // pbxExtension: "STRING_VALUE",
|
|
98
|
+
* // pbxSerial: "STRING_VALUE",
|
|
99
|
+
* // pbxUserId: "STRING_VALUE",
|
|
100
|
+
* // createdAt: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // telephony: true || false,
|
|
104
|
+
* // sms: true || false,
|
|
105
|
+
* // mms: true || false,
|
|
106
|
+
* // whatsapp: true || false,
|
|
107
|
+
* // whatsappStatus: "24h_channel_closed",
|
|
108
|
+
* // broadcast: true || false,
|
|
109
|
+
* // external: true || false,
|
|
110
|
+
* // channelId: "STRING_VALUE", // required
|
|
111
|
+
* // channelType: "direct" || "group", // required
|
|
112
|
+
* // memberCount: Number("int"), // required
|
|
113
|
+
* // createdAt: "STRING_VALUE", // required
|
|
114
|
+
* // createdBy: "STRING_VALUE", // required
|
|
115
|
+
* // updatedAt: "STRING_VALUE",
|
|
116
|
+
* // },
|
|
117
|
+
* // };
|
|
118
|
+
*
|
|
119
|
+
* ```
|
|
120
|
+
*
|
|
121
|
+
* @param GetOrCreateWhatsAppChannelCommandInput - {@link GetOrCreateWhatsAppChannelCommandInput}
|
|
122
|
+
* @returns {@link GetOrCreateWhatsAppChannelCommandOutput}
|
|
123
|
+
* @see {@link GetOrCreateWhatsAppChannelCommandInput} for command's `input` shape.
|
|
124
|
+
* @see {@link GetOrCreateWhatsAppChannelCommandOutput} for command's `response` shape.
|
|
125
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ValidationException} (client fault)
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link ConversationsServiceException}
|
|
134
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
export declare class GetOrCreateWhatsAppChannelCommand extends GetOrCreateWhatsAppChannelCommand_base {
|
|
140
|
+
/** @internal type navigation helper, not in runtime. */
|
|
141
|
+
protected static __types: {
|
|
142
|
+
api: {
|
|
143
|
+
input: GetOrCreateWhatsAppChannelInput;
|
|
144
|
+
output: GetOrCreateWhatsAppChannelOutput;
|
|
145
|
+
};
|
|
146
|
+
sdk: {
|
|
147
|
+
input: GetOrCreateWhatsAppChannelCommandInput;
|
|
148
|
+
output: GetOrCreateWhatsAppChannelCommandOutput;
|
|
149
|
+
};
|
|
150
|
+
};
|
|
151
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetSmsChannelIdInput, GetSmsChannelIdOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetSmsChannelIdCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetSmsChannelIdCommandInput extends GetSmsChannelIdInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetSmsChannelIdCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetSmsChannelIdCommandOutput extends GetSmsChannelIdOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetSmsChannelIdCommand_base: {
|
|
25
|
+
new (input: GetSmsChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetSmsChannelIdCommandInput, GetSmsChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetSmsChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetSmsChannelIdCommandInput, GetSmsChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets the channel ID of an existing or non-existing SMS channel
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetSmsChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetSmsChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetSmsChannelIdInput
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* serviceUri: "STRING_VALUE", // required
|
|
40
|
+
* recipientId: "STRING_VALUE",
|
|
41
|
+
* recipientNumber: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetSmsChannelIdCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetSmsChannelIdOutput
|
|
46
|
+
* // channelId: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetSmsChannelIdCommandInput - {@link GetSmsChannelIdCommandInput}
|
|
52
|
+
* @returns {@link GetSmsChannelIdCommandOutput}
|
|
53
|
+
* @see {@link GetSmsChannelIdCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetSmsChannelIdCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConversationsServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class GetSmsChannelIdCommand extends GetSmsChannelIdCommand_base {
|
|
70
|
+
/** @internal type navigation helper, not in runtime. */
|
|
71
|
+
protected static __types: {
|
|
72
|
+
api: {
|
|
73
|
+
input: GetSmsChannelIdInput;
|
|
74
|
+
output: GetSmsChannelIdOutput;
|
|
75
|
+
};
|
|
76
|
+
sdk: {
|
|
77
|
+
input: GetSmsChannelIdCommandInput;
|
|
78
|
+
output: GetSmsChannelIdCommandOutput;
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { GetTelephonyChannelIdInput, GetTelephonyChannelIdOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetTelephonyChannelIdCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetTelephonyChannelIdCommandInput extends GetTelephonyChannelIdInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetTelephonyChannelIdCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetTelephonyChannelIdCommandOutput extends GetTelephonyChannelIdOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetTelephonyChannelIdCommand_base: {
|
|
25
|
+
new (input: GetTelephonyChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetTelephonyChannelIdCommandInput, GetTelephonyChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetTelephonyChannelIdCommandInput): import("@smithy/smithy-client").CommandImpl<GetTelephonyChannelIdCommandInput, GetTelephonyChannelIdCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets the channel ID of an existing or non-existing telephony channel
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, GetTelephonyChannelIdCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, GetTelephonyChannelIdCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // GetTelephonyChannelIdInput
|
|
38
|
+
* userId: "STRING_VALUE",
|
|
39
|
+
* serviceUri: "STRING_VALUE", // required
|
|
40
|
+
* recipientId: "STRING_VALUE",
|
|
41
|
+
* recipientNumber: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetTelephonyChannelIdCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetTelephonyChannelIdOutput
|
|
46
|
+
* // channelId: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetTelephonyChannelIdCommandInput - {@link GetTelephonyChannelIdCommandInput}
|
|
52
|
+
* @returns {@link GetTelephonyChannelIdCommandOutput}
|
|
53
|
+
* @see {@link GetTelephonyChannelIdCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetTelephonyChannelIdCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ConversationsServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class GetTelephonyChannelIdCommand extends GetTelephonyChannelIdCommand_base {
|
|
70
|
+
/** @internal type navigation helper, not in runtime. */
|
|
71
|
+
protected static __types: {
|
|
72
|
+
api: {
|
|
73
|
+
input: GetTelephonyChannelIdInput;
|
|
74
|
+
output: GetTelephonyChannelIdOutput;
|
|
75
|
+
};
|
|
76
|
+
sdk: {
|
|
77
|
+
input: GetTelephonyChannelIdCommandInput;
|
|
78
|
+
output: GetTelephonyChannelIdCommandOutput;
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
}
|