@wildix/xbees-conversations-client 1.2.3 → 1.2.5

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

@@ -71,26 +71,14 @@ export interface TemplateWithParameters {
  * @public
  * @enum
  */
-export declare const ConversationFileCategory: {
-    readonly GENERAL: "channels";
-    readonly RECORDING: "recordings";
-    readonly WIZY_RECORDING: "wizyconfRecordings";
+export declare const ChannelAccess: {
+    readonly PRIVATE: "private";
+    readonly PUBLIC: "public";
 };
 /**
  * @public
  */
-export type ConversationFileCategory = typeof ConversationFileCategory[keyof typeof ConversationFileCategory];
-/**
- * @public
- */
-export declare class FileNotFoundException extends __BaseException {
-    readonly name: "FileNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
-}
+export type ChannelAccess = typeof ChannelAccess[keyof typeof ChannelAccess];
 /**
  * @public
  */
@@ -109,6 +97,7 @@ export interface User {
     pbxExtension?: string | undefined;
     pbxSerial?: string | undefined;
     pbxUserId?: string | undefined;
+    pbxGroupId?: string | undefined;
     createdAt?: string | undefined;
     updatedAt?: string | undefined;
 }
@@ -124,6 +113,143 @@ export declare const ChannelType: {
  * @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
+ */
+export interface ChannelContextEventAttendee {
+    email: string;
+    name?: string | undefined;
+    status: ChannelContextEventAttendeeStatus;
+}
+/**
+ * @public
+ */
+export interface ChannelContextEvent {
+    id?: string | undefined;
+    owner?: string | undefined;
+    start?: string | undefined;
+    end?: string | undefined;
+    summary?: string | undefined;
+    attendees?: (ChannelContextEventAttendee)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface ChannelContextPushToTalk {
+    /**
+     * A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
+     * @public
+     */
+    broadcastId?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelContextSource: {
+    readonly KITE: "kite";
+};
+/**
+ * @public
+ */
+export type ChannelContextSource = typeof ChannelContextSource[keyof typeof ChannelContextSource];
+/**
+ * @public
+ */
+export interface ChannelContext {
+    source?: ChannelContextSource | undefined;
+    target?: string | undefined;
+    events?: (ChannelContextEvent)[] | undefined;
+    ptt?: ChannelContextPushToTalk | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelWhatsAppStatus: {
+    readonly CHANNEL_CLOSED: "24h_channel_closed";
+};
+/**
+ * @public
+ */
+export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof ChannelWhatsAppStatus];
+/**
+ * @public
+ */
+export interface Channel {
+    subject?: string | undefined;
+    description?: string | undefined;
+    /**
+     * Picture URL
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * Picture dominant color represented by a hex value.
+     * @public
+     */
+    pictureColor?: string | undefined;
+    access?: ChannelAccess | undefined;
+    company?: string | undefined;
+    context?: ChannelContext | undefined;
+    kite?: boolean | undefined;
+    kiteTarget?: string | undefined;
+    kiteVariant?: string | undefined;
+    kiteAssign?: string | undefined;
+    kiteServiceName?: string | undefined;
+    kiteDefaultSubject?: string | undefined;
+    service?: string | undefined;
+    serviceTitle?: string | undefined;
+    serviceRecipient?: string | undefined;
+    assignee?: User | undefined;
+    telephony?: boolean | undefined;
+    sms?: boolean | undefined;
+    mms?: boolean | undefined;
+    whatsapp?: boolean | undefined;
+    whatsappStatus?: ChannelWhatsAppStatus | undefined;
+    broadcast?: boolean | undefined;
+    external?: boolean | undefined;
+    autoRecord?: boolean | undefined;
+    transcriptionLanguage?: string | undefined;
+    wizyGuestViewOnly?: boolean | undefined;
+    channelId: string;
+    channelType: ChannelType;
+    memberCount: number;
+    createdAt: string;
+    createdBy: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface MessageAttachment {
+    id: string;
+    /**
+     * This *is* documentation about the field. Describe here what fsId and how to get it.
+     * @public
+     */
+    fsId: string;
+    mime?: string | undefined;
+    name: string;
+    size: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    thumbnail?: string | undefined;
+}
 /**
  * @public
  */
@@ -235,6 +361,182 @@ export declare namespace ActionElement {
     }
     const visit: <T>(value: ActionElement, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
+export interface MessageTemplateConfig {
+    whatsapp?: TemplateWithParameters | undefined;
+}
+/**
+ * @public
+ */
+export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Element {
+    interface TemplateMember {
+        template: MessageTemplateConfig;
+        actions?: never;
+        $unknown?: never;
+    }
+    interface ActionsMember {
+        template?: never;
+        actions: (ActionElement)[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        template?: never;
+        actions?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        template: (value: MessageTemplateConfig) => T;
+        actions: (value: (ActionElement)[]) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Element, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface MessageForward {
+    forwardCompany?: string | undefined;
+    forwardDate: string;
+    forwardEmail?: string | undefined;
+    forwardName?: string | undefined;
+    messageId: string;
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface MessageGiphy {
+    id: string;
+    size: string;
+    url: string;
+    height: string;
+    width: string;
+}
+/**
+ * @public
+ */
+export interface Reaction {
+    type?: string | undefined;
+    userId?: string | undefined;
+    messageId?: string | undefined;
+    user?: User | undefined;
+}
+/**
+ * @public
+ */
+export interface MessageQuote {
+    messageId: string;
+    channelId: string;
+    user: User;
+    text?: string | undefined;
+    attachments?: (MessageAttachment)[] | undefined;
+    forward?: MessageForward | undefined;
+    mentions?: (User)[] | undefined;
+    giphy?: MessageGiphy | undefined;
+    createdAt: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @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
+ */
+export interface Message {
+    text?: string | undefined;
+    elements?: (Element)[] | undefined;
+    attachments?: (MessageAttachment)[] | undefined;
+    quote?: MessageQuote | undefined;
+    forward?: MessageForward | undefined;
+    whatsapp?: boolean | undefined;
+    whatsappStatus?: MessageWhatsAppStatus | undefined;
+    sms?: boolean | undefined;
+    smsStatus?: MessageSmsStatus | undefined;
+    type: MessageType;
+    giphy?: MessageGiphy | undefined;
+    silent?: boolean | undefined;
+    event?: string | undefined;
+    messageId: string;
+    channelId: string;
+    user: User;
+    edit?: boolean | undefined;
+    mentions?: (User)[] | undefined;
+    latestReactions?: (Reaction)[] | undefined;
+    reactionCounts?: Record<string, number> | undefined;
+    createdAt: string;
+    updatedAt?: string | undefined;
+}
+/**
+ * @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
+ */
+export declare class FileNotFoundException extends __BaseException {
+    readonly name: "FileNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<FileNotFoundException, __BaseException>);
+}
 /**
  * @public
  */
@@ -548,184 +850,52 @@ export interface AssignChannelInput {
      * A user that should be assigned to the channel. If service was specified than this field can be optional.
      * @public
      */
-    assignee?: AssignChannelAssigneeRequest | undefined;
-    /**
-     * Indicates when agents from specified service should be added or removed from the conversation. Default is `ADAPTIVE`. This is applicable only if the service is included in the request.
-     * @public
-     */
-    variant?: AssignChannelVariant | undefined;
-}
-/**
- * @public
- */
-export interface ServicePbx {
-    domain: string;
-    port: number;
-}
-/**
- * @public
- */
-export interface ServiceSettings {
-    phoneNumber?: string | undefined;
-    messagingNumber?: string | undefined;
-}
-/**
- * @public
- */
-export interface Service {
-    id: number;
-    uri: string;
-    title: string;
-    settings: ServiceSettings;
-    extensions: (string)[];
-    pbx: ServicePbx;
-}
-/**
- * @public
- */
-export interface AssignChannelOutput {
-    /**
-     * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
-     * @public
-     */
-    assignee?: User | undefined;
-    /**
-     * A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
-     * @public
-     */
-    service?: Service | undefined;
-}
-/**
- * @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 ChannelContextEventAttendeeStatus: {
-    readonly ACCEPTED: "accepted";
-    readonly DECLINED: "declined";
-    readonly NONE: "none";
-    readonly TENTATIVE: "tentative";
-};
-/**
- * @public
- */
-export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttendeeStatus[keyof typeof ChannelContextEventAttendeeStatus];
-/**
- * @public
- */
-export interface ChannelContextEventAttendee {
-    email: string;
-    name?: string | undefined;
-    status: ChannelContextEventAttendeeStatus;
-}
-/**
- * @public
- */
-export interface ChannelContextEvent {
-    id?: string | undefined;
-    owner?: string | undefined;
-    start?: string | undefined;
-    end?: string | undefined;
-    summary?: string | undefined;
-    attendees?: (ChannelContextEventAttendee)[] | undefined;
-}
-/**
- * @public
- */
-export interface ChannelContextPushToTalk {
+    assignee?: AssignChannelAssigneeRequest | undefined;
     /**
-     * A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
+     * Indicates when agents from specified service should be added or removed from the conversation. Default is `ADAPTIVE`. This is applicable only if the service is included in the request.
      * @public
      */
-    broadcastId?: string | undefined;
+    variant?: AssignChannelVariant | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const ChannelContextSource: {
-    readonly KITE: "kite";
-};
-/**
- * @public
- */
-export type ChannelContextSource = typeof ChannelContextSource[keyof typeof ChannelContextSource];
 /**
  * @public
  */
-export interface ChannelContext {
-    source?: ChannelContextSource | undefined;
-    target?: string | undefined;
-    events?: (ChannelContextEvent)[] | undefined;
-    ptt?: ChannelContextPushToTalk | undefined;
+export interface ServicePbx {
+    domain: string;
+    port: number;
 }
 /**
  * @public
- * @enum
  */
-export declare const ChannelWhatsAppStatus: {
-    readonly CHANNEL_CLOSED: "24h_channel_closed";
-};
+export interface ServiceSettings {
+    phoneNumber?: string | undefined;
+    messagingNumber?: string | undefined;
+}
 /**
  * @public
  */
-export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof ChannelWhatsAppStatus];
+export interface Service {
+    id: number;
+    uri: string;
+    title: string;
+    settings: ServiceSettings;
+    extensions: (string)[];
+    pbx: ServicePbx;
+}
 /**
  * @public
  */
-export interface Channel {
-    subject?: string | undefined;
-    description?: string | undefined;
+export interface AssignChannelOutput {
     /**
-     * Picture URL
+     * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
      * @public
      */
-    picture?: string | undefined;
+    assignee?: User | undefined;
     /**
-     * Picture dominant color represented by a hex value.
+     * A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
      * @public
      */
-    pictureColor?: string | undefined;
-    access?: ChannelAccess | undefined;
-    company?: string | undefined;
-    context?: ChannelContext | undefined;
-    kite?: boolean | undefined;
-    kiteTarget?: string | undefined;
-    kiteVariant?: string | undefined;
-    kiteAssign?: string | undefined;
-    kiteServiceName?: string | undefined;
-    kiteDefaultSubject?: string | undefined;
-    service?: string | undefined;
-    serviceTitle?: string | undefined;
-    serviceRecipient?: string | undefined;
-    assignee?: User | undefined;
-    telephony?: boolean | undefined;
-    sms?: boolean | undefined;
-    mms?: boolean | undefined;
-    whatsapp?: boolean | undefined;
-    whatsappStatus?: ChannelWhatsAppStatus | undefined;
-    broadcast?: boolean | undefined;
-    external?: boolean | undefined;
-    autoRecord?: boolean | undefined;
-    transcriptionLanguage?: string | undefined;
-    wizyGuestViewOnly?: boolean | undefined;
-    channelId: string;
-    channelType: ChannelType;
-    memberCount: number;
-    createdAt: string;
-    createdBy: string;
-    updatedAt?: string | undefined;
+    service?: Service | undefined;
 }
 /**
  * @public
@@ -896,126 +1066,6 @@ export declare class TagsLimitReachedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TagsLimitReachedException, __BaseException>);
 }
-/**
- * @public
- */
-export interface MessageAttachment {
-    id: string;
-    /**
-     * This *is* documentation about the field. Describe here what fsId and how to get it.
-     * @public
-     */
-    fsId: string;
-    mime?: string | undefined;
-    name: string;
-    size: number;
-    width?: number | undefined;
-    height?: number | undefined;
-    thumbnail?: string | undefined;
-}
-/**
- * @public
- */
-export interface MessageTemplateConfig {
-    whatsapp?: TemplateWithParameters | undefined;
-}
-/**
- * @public
- */
-export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
-/**
- * @public
- */
-export declare namespace Element {
-    interface TemplateMember {
-        template: MessageTemplateConfig;
-        actions?: never;
-        $unknown?: never;
-    }
-    interface ActionsMember {
-        template?: never;
-        actions: (ActionElement)[];
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        template?: never;
-        actions?: never;
-        $unknown: [string, any];
-    }
-    interface Visitor<T> {
-        template: (value: MessageTemplateConfig) => T;
-        actions: (value: (ActionElement)[]) => T;
-        _: (name: string, value: any) => T;
-    }
-    const visit: <T>(value: Element, visitor: Visitor<T>) => T;
-}
-/**
- * @public
- */
-export interface MessageForward {
-    forwardCompany?: string | undefined;
-    forwardDate: string;
-    forwardEmail?: string | undefined;
-    forwardName?: string | undefined;
-    messageId: string;
-    channelId: string;
-}
-/**
- * @public
- */
-export interface MessageGiphy {
-    id: string;
-    size: string;
-    url: string;
-    height: string;
-    width: string;
-}
-/**
- * @public
- */
-export interface MessageQuote {
-    messageId: string;
-    channelId: string;
-    user: User;
-    text?: string | undefined;
-    attachments?: (MessageAttachment)[] | undefined;
-    forward?: MessageForward | undefined;
-    mentions?: (User)[] | undefined;
-    giphy?: MessageGiphy | undefined;
-    createdAt: string;
-    updatedAt?: string | undefined;
-}
-/**
- * @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 MessageWhatsAppStatus: {
-    readonly DELIVERED: "delivered";
-    readonly ERROR: "error";
-    readonly SENT: "sent";
-    readonly TRYING: "trying";
-};
-/**
- * @public
- */
-export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof MessageWhatsAppStatus];
 /**
  * @public
  */
@@ -1306,54 +1356,6 @@ export interface DeleteMessageReactionOutput {
  */
 export interface DescribeEventInput {
 }
-/**
- * @public
- */
-export interface Reaction {
-    type?: string | undefined;
-    userId?: string | undefined;
-    messageId?: string | undefined;
-    user?: User | undefined;
-}
-/**
- * @public
- * @enum
- */
-export declare const MessageType: {
-    readonly REGULAR: "regular";
-    readonly SYSTEM: "system";
-};
-/**
- * @public
- */
-export type MessageType = typeof MessageType[keyof typeof MessageType];
-/**
- * @public
- */
-export interface Message {
-    text?: string | undefined;
-    elements?: (Element)[] | undefined;
-    attachments?: (MessageAttachment)[] | undefined;
-    quote?: MessageQuote | undefined;
-    forward?: MessageForward | undefined;
-    whatsapp?: boolean | undefined;
-    whatsappStatus?: MessageWhatsAppStatus | undefined;
-    sms?: boolean | undefined;
-    smsStatus?: MessageSmsStatus | undefined;
-    type: MessageType;
-    giphy?: MessageGiphy | undefined;
-    silent?: boolean | undefined;
-    event?: string | undefined;
-    messageId: string;
-    channelId: string;
-    user: User;
-    edit?: boolean | undefined;
-    mentions?: (User)[] | undefined;
-    latestReactions?: (Reaction)[] | undefined;
-    reactionCounts?: Record<string, number> | undefined;
-    createdAt: string;
-    updatedAt?: string | undefined;
-}
 /**
  * @public
  */
@@ -1826,6 +1828,11 @@ export interface GetOrCreateSmsChannelInput {
      * @public
      */
     recipientNumber?: string | undefined;
+    /**
+     * Indicates if the channel is outgoing. It's prevents applying routing settings for the channel. This parameter will be reset to false after 48 hours. Default is false.
+     * @public
+     */
+    outgoing?: boolean | undefined;
 }
 /**
  * @public
@@ -1888,6 +1895,11 @@ export interface GetOrCreateWhatsAppChannelInput {
      * @public
      */
     recipientNumber?: string | undefined;
+    /**
+     * Indicates if the channel is outgoing. It's prevents applying routing settings for the channel. This parameter will be reset to false after 48 hours. Default is false.
+     * @public
+     */
+    outgoing?: boolean | undefined;
 }
 /**
  * @public