@wildix/wda-stream-client 1.0.1

package/dist-types/commands/GetOngoingConversationsCommand.d.ts

@@ -0,0 +1,275 @@
+import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
+import { GetOngoingConversationsInput, GetOngoingConversationsOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetOngoingConversationsCommand}.
+ */
+export interface GetOngoingConversationsCommandInput extends GetOngoingConversationsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetOngoingConversationsCommand}.
+ */
+export interface GetOngoingConversationsCommandOutput extends GetOngoingConversationsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * <p>Retrieves ongoing conversations.</p>
+ * <p>Once the conversation ends the item would be dissapeared from the list.</p>
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WdaStreamClient, GetOngoingConversationsCommand } from "@wildix/wda-stream-client"; // ES Modules import
+ * // const { WdaStreamClient, GetOngoingConversationsCommand } = require("@wildix/wda-stream-client"); // CommonJS import
+ * const client = new WdaStreamClient(config);
+ * const input = { // GetOngoingConversationsInput
+ *   company: "STRING_VALUE",
+ * };
+ * const command = new GetOngoingConversationsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetOngoingConversationsOutput
+ * //   calls: [ // GetOngoingConversationsCallsList // required
+ * //     { // CallAnalyticsLiveProgressEvent
+ * //       id: "STRING_VALUE", // required
+ * //       pbx: "STRING_VALUE", // required
+ * //       time: Number("long"), // required
+ * //       company: "STRING_VALUE", // required
+ * //       licenses: [ // LicensesList // required
+ * //         "x-bees",
+ * //       ],
+ * //       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "call_transcription_complete" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_transcription_complete", // required
+ * //       start: "STRING_VALUE", // required
+ * //       flows: [ // CallAnalyticsLiveProgressEventFlowList // required
+ * //         { // CallAnalyticsLiveProgressEventFlow
+ * //           status: "CONNECTING" || "TALKING" || "HOLD", // required
+ * //           statusChangeDate: "STRING_VALUE", // required
+ * //           startTime: Number("long"), // required
+ * //           connectTime: Number("long"),
+ * //           talkTime: Number("long"),
+ * //           waitTime: Number("long"),
+ * //           caller: { // CallParticipant
+ * //             type: "REMOTE" || "LOCAL", // required
+ * //             phone: "STRING_VALUE",
+ * //             name: "STRING_VALUE",
+ * //             company: "STRING_VALUE",
+ * //             email: "STRING_VALUE",
+ * //             userId: "STRING_VALUE",
+ * //             userExtension: "STRING_VALUE",
+ * //             userDepartment: "STRING_VALUE",
+ * //             groupId: "STRING_VALUE",
+ * //             groupName: "STRING_VALUE",
+ * //             userAgent: "STRING_VALUE",
+ * //             userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "UNKNOWN",
+ * //             role: "CLIENT" || "AGENT", // required
+ * //             license: "STRING_VALUE",
+ * //           },
+ * //           callee: {
+ * //             type: "REMOTE" || "LOCAL", // required
+ * //             phone: "STRING_VALUE",
+ * //             name: "STRING_VALUE",
+ * //             company: "STRING_VALUE",
+ * //             email: "STRING_VALUE",
+ * //             userId: "STRING_VALUE",
+ * //             userExtension: "STRING_VALUE",
+ * //             userDepartment: "STRING_VALUE",
+ * //             groupId: "STRING_VALUE",
+ * //             groupName: "STRING_VALUE",
+ * //             userAgent: "STRING_VALUE",
+ * //             userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "UNKNOWN",
+ * //             role: "CLIENT" || "AGENT", // required
+ * //             license: "STRING_VALUE",
+ * //           },
+ * //           service: "STRING_VALUE",
+ * //           serviceNumber: "STRING_VALUE",
+ * //           destination: "STRING_VALUE",
+ * //           direction: "INTERNAL" || "INBOUND" || "OUTBOUND" || "UNDEFINED",
+ * //           trunkName: "STRING_VALUE",
+ * //           trunkDirection: "STRING_VALUE",
+ * //           queueName: "STRING_VALUE",
+ * //           queueId: "STRING_VALUE",
+ * //           tags: [ // CallFlowTags
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           flags: [ // CallFlowFlags
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           callerMos: "STRING_VALUE",
+ * //           calleeMos: "STRING_VALUE",
+ * //           xhoppersConfId: "STRING_VALUE",
+ * //           recordings: [ // CallFlowRecordings
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           mergeWith: "STRING_VALUE",
+ * //           splitReason: "STRING_VALUE",
+ * //           splitTransferType: "STRING_VALUE",
+ * //           remotePhone: "STRING_VALUE",
+ * //           remotePhoneCountryCode: Number("int"),
+ * //           remotePhoneCountryCodeStr: "STRING_VALUE",
+ * //           remotePhoneLocation: "STRING_VALUE",
+ * //           callStatus: "COMPLETED" || "MISSED",
+ * //           transcriptionStatus: "AVAILABLE" || "UNAVAILABLE", // required
+ * //           attachment: "STRING_VALUE",
+ * //           attachmentType: "VOICEMAIL" || "FAX",
+ * //           attachmentDestinations: [ // CallFlowAttachmentDestinationList
+ * //             { // CallFlowAttachmentDestination
+ * //               phone: "STRING_VALUE",
+ * //               name: "STRING_VALUE",
+ * //               email: "STRING_VALUE",
+ * //               userId: "STRING_VALUE",
+ * //               userExtension: "STRING_VALUE",
+ * //               userDepartment: "STRING_VALUE",
+ * //               groupId: "STRING_VALUE",
+ * //               groupName: "STRING_VALUE",
+ * //             },
+ * //           ],
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * //   conferences: [ // GetOngoingConversationsConferencesList // required
+ * //     { // ConferenceAnalyticsLiveProgressEvent
+ * //       id: "STRING_VALUE", // required
+ * //       time: Number("long"), // required
+ * //       company: "STRING_VALUE", // required
+ * //       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "call_transcription_complete" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_transcription_complete", // required
+ * //       start: "STRING_VALUE", // required
+ * //       subject: "STRING_VALUE", // required
+ * //       participants: [ // ConferenceParticipantsList // required
+ * //         { // ConferenceParticipant
+ * //           type: "EXTERNAL" || "EXTERNAL_DIAL_IN" || "PBX" || "PBX_SIP" || "XBS", // required
+ * //           role: "CLIENT" || "AGENT",
+ * //           jid: "STRING_VALUE",
+ * //           name: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           phone: "STRING_VALUE",
+ * //           department: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //           pbxSerial: "STRING_VALUE",
+ * //           pbxExtension: "STRING_VALUE",
+ * //           xbsId: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       transcriptionStatus: "AVAILABLE" || "UNAVAILABLE", // required
+ * //     },
+ * //   ],
+ * //   chats: [ // GetOngoingConversationsChatsList // required
+ * //     { // ChatAnalyticsLiveProgressEvent
+ * //       id: "STRING_VALUE", // required
+ * //       time: Number("long"), // required
+ * //       company: "STRING_VALUE", // required
+ * //       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "call_transcription_complete" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_transcription_complete", // required
+ * //       start: "STRING_VALUE", // required
+ * //       channelId: "STRING_VALUE", // required
+ * //       channelType: "direct" || "group", // required
+ * //       subject: "STRING_VALUE", // required
+ * //       service: "STRING_VALUE",
+ * //       serviceTitle: "STRING_VALUE",
+ * //       participants: [ // ChatParticipantList // required
+ * //         { // ChatParticipant
+ * //           id: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           phone: "STRING_VALUE",
+ * //           picture: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //           pbxDomain: "STRING_VALUE",
+ * //           pbxPort: "STRING_VALUE",
+ * //           pbxExtension: "STRING_VALUE",
+ * //           pbxSerial: "STRING_VALUE",
+ * //           pbxUserId: "STRING_VALUE",
+ * //           createdAt: "STRING_VALUE",
+ * //           updatedAt: "STRING_VALUE",
+ * //           type: "REMOTE" || "LOCAL", // required
+ * //           role: "CLIENT" || "AGENT", // required
+ * //         },
+ * //       ],
+ * //       agents: [ // ChatUserList // required
+ * //         { // User
+ * //           id: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           phone: "STRING_VALUE",
+ * //           picture: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //           pbxDomain: "STRING_VALUE",
+ * //           pbxPort: "STRING_VALUE",
+ * //           pbxExtension: "STRING_VALUE",
+ * //           pbxSerial: "STRING_VALUE",
+ * //           pbxUserId: "STRING_VALUE",
+ * //           createdAt: "STRING_VALUE",
+ * //           updatedAt: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       agentsCount: Number("int"), // required
+ * //       customers: [ // required
+ * //         {
+ * //           id: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           phone: "STRING_VALUE",
+ * //           picture: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //           pbxDomain: "STRING_VALUE",
+ * //           pbxPort: "STRING_VALUE",
+ * //           pbxExtension: "STRING_VALUE",
+ * //           pbxSerial: "STRING_VALUE",
+ * //           pbxUserId: "STRING_VALUE",
+ * //           createdAt: "STRING_VALUE",
+ * //           updatedAt: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //       customersCount: Number("int"), // required
+ * //       tags: [ // ChatTags
+ * //         "sms" || "telephony",
+ * //       ],
+ * //       direction: "INTERNAL" || "INBOUND" || "OUTBOUND", // required
+ * //       status: "WAITFIRSTREPLY" || "WAITREPLYFROMGUEST" || "WAITREPLYFROMAGENT" || "COMPLETED" || "MISSED", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetOngoingConversationsCommandInput - {@link GetOngoingConversationsCommandInput}
+ * @returns {@link GetOngoingConversationsCommandOutput}
+ * @see {@link GetOngoingConversationsCommandInput} for command's `input` shape.
+ * @see {@link GetOngoingConversationsCommandOutput} for command's `response` shape.
+ * @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WdaStreamServiceException}
+ * <p>Base exception class for all service exceptions from WdaStream service.</p>
+ *
+ */
+export declare class GetOngoingConversationsCommand extends $Command<GetOngoingConversationsCommandInput, GetOngoingConversationsCommandOutput, WdaStreamClientResolvedConfig> {
+    readonly input: GetOngoingConversationsCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: GetOngoingConversationsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WdaStreamClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetOngoingConversationsCommandInput, GetOngoingConversationsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ConsumeEventCommand";
+export * from "./DescribeEventCommand";
+export * from "./GetOngoingConversationsCommand";

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,7 @@
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface WdaStreamExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./WdaStreamClient";
+export * from "./WdaStream";
+export * from "./commands";
+export * from "./models";
+export { WdaStreamServiceException } from "./models/WdaStreamServiceException";

package/dist-types/models/WdaStreamServiceException.d.ts

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from WdaStream service.
+ */
+export declare class WdaStreamServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";