@wildix/xbees-conversations-client 1.5.0 → 4.0.1

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

@@ -0,0 +1,285 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const TargetNotEligibleReason: {
+    readonly NO_LICENSE: "no_license";
+};
+/**
+ * @public
+ */
+export type TargetNotEligibleReason = (typeof TargetNotEligibleReason)[keyof typeof TargetNotEligibleReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelAccess: {
+    readonly PRIVATE: "private";
+    readonly PUBLIC: "public";
+};
+/**
+ * @public
+ */
+export type ChannelAccess = (typeof ChannelAccess)[keyof typeof ChannelAccess];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelType: {
+    readonly DIRECT: "direct";
+    readonly GROUP: "group";
+};
+/**
+ * @public
+ */
+export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextEventAttendeeStatus: {
+    readonly ACCEPTED: "accepted";
+    readonly DECLINED: "declined";
+    readonly NONE: "none";
+    readonly TENTATIVE: "tentative";
+};
+/**
+ * @public
+ */
+export type ChannelContextEventAttendeeStatus = (typeof ChannelContextEventAttendeeStatus)[keyof typeof ChannelContextEventAttendeeStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextSource: {
+    readonly KITE: "kite";
+};
+/**
+ * @public
+ */
+export type ChannelContextSource = (typeof ChannelContextSource)[keyof typeof ChannelContextSource];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelWhatsAppStatus: {
+    readonly CHANNEL_CLOSED: "24h_channel_closed";
+};
+/**
+ * @public
+ */
+export type ChannelWhatsAppStatus = (typeof ChannelWhatsAppStatus)[keyof typeof ChannelWhatsAppStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ButtonVariant: {
+    readonly CONTAINED: "contained";
+    readonly OUTLINED: "outlined";
+};
+/**
+ * @public
+ */
+export type ButtonVariant = (typeof ButtonVariant)[keyof typeof ButtonVariant];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageSmsStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageSmsStatus = (typeof MessageSmsStatus)[keyof typeof MessageSmsStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageType: {
+    readonly DELETED: "deleted";
+    readonly REGULAR: "regular";
+    readonly SYSTEM: "system";
+};
+/**
+ * @public
+ */
+export type MessageType = (typeof MessageType)[keyof typeof MessageType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageWhatsAppStatus: {
+    readonly DELIVERED: "delivered";
+    readonly ERROR: "error";
+    readonly SENT: "sent";
+    readonly TRYING: "trying";
+};
+/**
+ * @public
+ */
+export type MessageWhatsAppStatus = (typeof MessageWhatsAppStatus)[keyof typeof MessageWhatsAppStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ConversationFileCategory: {
+    readonly GENERAL: "channels";
+    readonly RECORDING: "recordings";
+    readonly WIZY_RECORDING: "wizyconfRecordings";
+};
+/**
+ * @public
+ */
+export type ConversationFileCategory = (typeof ConversationFileCategory)[keyof typeof ConversationFileCategory];
+/**
+ * @public
+ * @enum
+ */
+export declare const ActionTriggerStatus: {
+    readonly COMPLETED: "completed";
+    readonly PENDING: "pending";
+};
+/**
+ * @public
+ */
+export type ActionTriggerStatus = (typeof ActionTriggerStatus)[keyof typeof ActionTriggerStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelMemberRole: {
+    readonly MEMBER: "member";
+    readonly SUPERVISOR: "supervisor";
+};
+/**
+ * @public
+ */
+export type ChannelMemberRole = (typeof ChannelMemberRole)[keyof typeof ChannelMemberRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const AssignChannelVariant: {
+    /**
+     * If service was previously assigned it uses SKIP variant, otherwise SELECTED. Default option.
+     */
+    readonly ADAPTIVE: "ADAPTIVE";
+    /**
+     * Ensures that all agents in the service are presented in the conversation and existing members.
+     */
+    readonly EVERYBODY: "EVERYBODY";
+    /**
+     * Ensures that only selected agent and user that made assignment are presented in the conversation.
+     */
+    readonly SELECTED: "SELECTED";
+    /**
+     * Does not invite anyone (except the assignee if not present yet) or remove any agents from the conversation.
+     */
+    readonly SKIP: "SKIP";
+};
+/**
+ * @public
+ */
+export type AssignChannelVariant = (typeof AssignChannelVariant)[keyof typeof AssignChannelVariant];
+/**
+ * @public
+ * @enum
+ */
+export declare const GroupChannelCreationEventType: {
+    readonly CONVERSATION_CREATED: "conversation_created";
+    readonly CONVERSATION_CREATED_WITH_NAME: "conversation_created_with_name";
+};
+/**
+ * @public
+ */
+export type GroupChannelCreationEventType = (typeof GroupChannelCreationEventType)[keyof typeof GroupChannelCreationEventType];
+/**
+ * @public
+ * @enum
+ */
+export declare const ReactionType: {
+    readonly CLAP: "clap";
+    readonly CONFUSED: "confused";
+    readonly EYES: "eyes";
+    readonly HEART: "heart";
+    readonly SLIGHTLY_SMILING_FACE: "slightly_smiling_face";
+    readonly SMILEY: "smiley";
+    readonly THUMBSDOWN: "thumbsdown";
+    readonly THUMBSUP: "thumbsup";
+    readonly WHITE_CHECK_MARK: "white_check_mark";
+};
+/**
+ * @public
+ */
+export type ReactionType = (typeof ReactionType)[keyof typeof ReactionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const WebhookEventType: {
+    readonly ACTION_TRIGGERED: "chat:action:triggered";
+    readonly CHANNEL_CREATED: "chat:channel:created";
+    readonly CHANNEL_UPDATED: "chat:channel:updated";
+    readonly MEMBER_ADDED: "chat:member:added";
+    readonly MEMBER_REMOVED: "chat:member:removed";
+    readonly MESSAGE_DELETED: "chat:message:deleted";
+    readonly MESSAGE_NEW: "chat:message:new";
+    readonly MESSAGE_UPDATED: "chat:message:updated";
+    readonly REACTION_DELETED: "chat:reaction:deleted";
+    readonly REACTION_NEW: "chat:reaction:new";
+};
+/**
+ * @public
+ */
+export type WebhookEventType = (typeof WebhookEventType)[keyof typeof WebhookEventType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GroupChannelUnsetOptions: {
+    readonly ACCESS: "access";
+    readonly ASSIGNEE: "assignee";
+    readonly BROADCAST: "broadcast";
+    readonly CONTEXT: "context";
+    readonly CONTEXT_EVENTS: "contextEvents";
+    readonly CONTEXT_PTT: "contextPtt";
+    readonly DESCRIPTION: "description";
+    readonly KITE_ASSIGN: "kiteAssign";
+    readonly MMS: "mms";
+    readonly PICTURE: "picture";
+    readonly PICTURE_COLOR: "pictureColor";
+    readonly SERVICE: "service";
+    readonly SERVICE_TITLE: "serviceTitle";
+    readonly SMS: "sms";
+    readonly SUBJECT: "subject";
+    readonly WHATSAPP: "whatsapp";
+    readonly WHATSAPP_STATUS: "whatsappStatus";
+};
+/**
+ * @public
+ */
+export type GroupChannelUnsetOptions = (typeof GroupChannelUnsetOptions)[keyof typeof GroupChannelUnsetOptions];
+/**
+ * @public
+ * @enum
+ */
+export declare const MessageUnsetFields: {
+    readonly ATTACHMENTS: "attachments";
+    readonly ELEMENTS: "elements";
+    readonly FORWARD: "forward";
+    readonly MENTIONS: "mentions";
+    readonly QUOTE: "quote";
+    readonly SMS: "sms";
+    readonly SMS_STATUS: "smsStatus";
+    readonly TEXT: "text";
+    readonly WHATSAPP: "whatsapp";
+    readonly WHATSAPP_STATUS: "whatsappStatus";
+};
+/**
+ * @public
+ */
+export type MessageUnsetFields = (typeof MessageUnsetFields)[keyof typeof MessageUnsetFields];

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

@@ -0,0 +1,244 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
+import { ConversationsSyntheticServiceException as __BaseException } from "./ConversationsSyntheticServiceException";
+import type { TargetNotEligibleReason } from "./enums";
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class RateLimitExceededException extends __BaseException {
+    readonly name: "RateLimitExceededException";
+    readonly $fault: "client";
+    /**
+     * Displays the applicable rate limits for the current request.
+     * @public
+     */
+    rateLimit?: string | undefined;
+    /**
+     * Indicates how many requests a user can still make within the current time window.
+     * @public
+     */
+    rateLimitRemaining?: number | undefined;
+    /**
+     * Shows the time in seconds until the rate limit resets.
+     * @public
+     */
+    rateLimitReset?: number | undefined;
+    /**
+     * Displays how many seconds the user agent should wait before making a follow-up request.
+     * @public
+     */
+    retryAfter?: number | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<RateLimitExceededException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TargetNotEligibleException extends __BaseException {
+    readonly name: "TargetNotEligibleException";
+    readonly $fault: "client";
+    reason?: TargetNotEligibleReason | undefined;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TargetNotEligibleException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TargetNotFoundException extends __BaseException {
+    readonly name: "TargetNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TargetNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class FileNotFoundException extends __BaseException {
+    readonly name: "FileNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ChannelNotFoundException extends __BaseException {
+    readonly name: "ChannelNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MemberAlreadyExistException extends __BaseException {
+    readonly name: "MemberAlreadyExistException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MemberAlreadyExistException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MemberDeactivatedException extends __BaseException {
+    readonly name: "MemberDeactivatedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MemberDeactivatedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ChannelAlreadyExistException extends __BaseException {
+    readonly name: "ChannelAlreadyExistException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TagsLimitReachedException extends __BaseException {
+    readonly name: "TagsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TagsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MemberNotFoundException extends __BaseException {
+    readonly name: "MemberNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MessageNotFoundException extends __BaseException {
+    readonly name: "MessageNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TriggerNotFoundException extends __BaseException {
+    readonly name: "TriggerNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TriggerNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TagNotFoundException extends __BaseException {
+    readonly name: "TagNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TagNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MarkUnreadChannelsLimitReachedException extends __BaseException {
+    readonly name: "MarkUnreadChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MarkUnreadChannelsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class PinnedChannelsLimitReachedException extends __BaseException {
+    readonly name: "PinnedChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class ConversationsServiceException extends __BaseException {
+    readonly name: "ConversationsServiceException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConversationsServiceException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class TaggedChannelsLimitReachedException extends __BaseException {
+    readonly name: "TaggedChannelsLimitReachedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TaggedChannelsLimitReachedException, __BaseException>);
+}
+/**
+ * @public
+ */
+export declare class MessageActionNotFoundException extends __BaseException {
+    readonly name: "MessageActionNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageActionNotFoundException, __BaseException>);
+}