@wildix/xbees-conversations-client 1.0.30 → 1.0.31

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

@@ -52,6 +52,103 @@ export declare const ChannelType: {
  * @public
  */
 export type ChannelType = typeof ChannelType[keyof typeof ChannelType];
+/**
+ * @public
+ */
+export interface UserToInvite {
+    email?: string;
+    phone?: string;
+    name?: string;
+    colleague?: boolean;
+}
+/**
+ * @public
+ */
+export interface AddChannelMemberInput {
+    channelId: string;
+    memberId?: string;
+    memberToInvite?: UserToInvite;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelMemberRole: {
+    readonly MEMBER: "member";
+    readonly SUPERVISOR: "supervisor";
+};
+/**
+ * @public
+ */
+export type ChannelMemberRole = typeof ChannelMemberRole[keyof typeof ChannelMemberRole];
+/**
+ * @public
+ */
+export interface ChannelMember {
+    id: string;
+    createdAt: string;
+    role: ChannelMemberRole | string;
+}
+/**
+ * @public
+ */
+export interface AddChannelMemberOutput {
+    /**
+     * @public
+     * Member added to the channel
+     */
+    member: ChannelMember;
+    /**
+     * @public
+     * Users added to the channel
+     */
+    user: User;
+}
+/**
+ * @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 interface AddChannelMembersInput {
+    channelId: string;
+    members?: (string)[];
+    membersToInvite?: (UserToInvite)[];
+}
+/**
+ * @public
+ */
+export interface AddChannelMembersOutput {
+    /**
+     * @public
+     * The list of members added to the channel
+     */
+    members: (ChannelMember)[];
+    /**
+     * @public
+     * The list of users added to the channel
+     */
+    users: (User)[];
+}
 /**
  * @public
  * @enum
@@ -160,7 +257,18 @@ export interface Channel {
 /**
  * @public
  */
-export interface ChannelCreateFields {
+export declare class ChannelAlreadyExistException extends __BaseException {
+    readonly name: "ChannelAlreadyExistException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ChannelAlreadyExistException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface CreateGroupChannelInput {
     subject?: string;
     description?: string;
     /**
@@ -174,138 +282,172 @@ export interface ChannelCreateFields {
      */
     pictureColor?: string;
     access?: ChannelAccess | string;
-    company?: string;
-    context?: ChannelContext;
-    kite?: boolean;
-    kiteTarget?: string;
-    kiteVariant?: string;
-    kiteAssign?: string;
-    kiteServiceName?: string;
-    kiteDefaultSubject?: string;
-    service?: string;
-    serviceTitle?: string;
-    serviceRecipient?: string;
-    assignee?: User;
-    telephony?: boolean;
-    sms?: boolean;
-    mms?: boolean;
     broadcast?: boolean;
-    external?: boolean;
+    userId?: string;
     channelId?: string;
-    channelType: ChannelType | string;
     members?: (string)[];
+    membersToInvite?: (UserToInvite)[];
 }
 /**
  * @public
- * @enum
  */
-export declare const ChannelMemberRole: {
-    readonly MEMBER: "member";
-    readonly SUPERVISOR: "supervisor";
-};
+export interface CreateGroupChannelOutput {
+    channel: Channel;
+}
 /**
  * @public
  */
-export type ChannelMemberRole = typeof ChannelMemberRole[keyof typeof ChannelMemberRole];
+export interface DeleteChannelInput {
+    channelId: string;
+}
 /**
  * @public
  */
-export interface ChannelMember {
-    id: string;
-    createdAt: string;
-    role: ChannelMemberRole | string;
+export interface DeleteChannelOutput {
 }
 /**
  * @public
  */
-export declare class ChannelNotFoundException extends __BaseException {
-    readonly name: "ChannelNotFoundException";
+export interface DeleteChannelMemberInput {
+    channelId: string;
+    memberId: string;
+    /**
+     * @public
+     * True to not send a system message that member was removed from the conversartion. Default - false.
+     */
+    silent?: boolean;
+}
+/**
+ * @public
+ */
+export interface DeleteChannelMemberOutput {
+}
+/**
+ * @public
+ */
+export declare class MemberNotFoundException extends __BaseException {
+    readonly name: "MemberNotFoundException";
     readonly $fault: "client";
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<ChannelNotFoundException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface DeleteMessageInput {
+    channelId: string;
+    messageId: string;
+}
+/**
+ * @public
+ */
+export interface DeleteMessageOutput {
+}
+/**
+ * @public
+ */
+export declare class MessageNotFoundException extends __BaseException {
+    readonly name: "MessageNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
 }
 /**
  * @public
  * @enum
  */
-export declare const ChannelUnsetFields: {
-    readonly ACCESS: "access";
-    readonly ASSIGNEE: "assignee";
-    readonly BROADCAST: "broadcast";
-    readonly COMPANY: "company";
-    readonly CONTEXT: "context";
-    readonly DESCRIPTION: "description";
-    readonly EXTERNAL: "external";
-    readonly KITE: "kite";
-    readonly KITE_ASSIGN: "kiteAssign";
-    readonly KITE_DEFAULT_SUBJECT: "kiteDefaultSubject";
-    readonly KITE_SERVICE_NAME: "kiteServiceName";
-    readonly KITE_TARGET: "kiteTarget";
-    readonly KITE_VARIANT: "kiteVariant";
-    readonly MMS: "mms";
-    readonly PICTURE: "picture";
-    readonly PICTURE_COLOR: "pictureColor";
-    readonly SERVICE: "service";
-    readonly SERVICE_RECIPIENT: "serviceRecipient";
-    readonly SERVICE_TITLE: "serviceTitle";
-    readonly SMS: "sms";
-    readonly SUBJECT: "subject";
-    readonly TELEPHONY: "telephony";
+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 ChannelUnsetFields = typeof ChannelUnsetFields[keyof typeof ChannelUnsetFields];
+export type ReactionType = typeof ReactionType[keyof typeof ReactionType];
 /**
  * @public
  */
-export interface ChannelUpdateFields {
-    subject?: string;
-    description?: string;
+export interface DeleteMessageReactionInput {
+    channelId: string;
     /**
      * @public
-     * Picture URL
+     * ID of the message to react to.
      */
-    picture?: string;
+    messageId: string;
     /**
      * @public
-     * Picture dominant color represented by a hex value.
+     * Type of the reaction.
      */
-    pictureColor?: string;
-    access?: ChannelAccess | string;
-    company?: string;
-    context?: ChannelContext;
-    kite?: boolean;
-    kiteTarget?: string;
-    kiteVariant?: string;
-    kiteAssign?: string;
-    kiteServiceName?: string;
-    kiteDefaultSubject?: string;
-    service?: string;
-    serviceTitle?: string;
-    serviceRecipient?: string;
-    assignee?: User;
-    telephony?: boolean;
-    sms?: boolean;
-    mms?: boolean;
-    broadcast?: boolean;
-    external?: boolean;
+    reactionType: ReactionType | string;
+    /**
+     * @public
+     * User ID for server side calls
+     */
+    userId?: string;
 }
 /**
  * @public
  */
-export interface CreateChannelInput {
-    channel: ChannelCreateFields;
-    userId?: string;
+export interface DeleteMessageReactionOutput {
 }
 /**
  * @public
  */
-export interface CreateChannelOutput {
+export interface GetChannelInput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface GetChannelOutput {
     channel: Channel;
 }
+/**
+ * @public
+ */
+export interface GetChannelMemberInput {
+    channelId: string;
+    memberId: string;
+}
+/**
+ * @public
+ */
+export interface GetChannelMemberOutput {
+    member: ChannelMember;
+    user: User;
+}
+/**
+ * @public
+ */
+export interface GetDirectChannelIdInput {
+    userId?: string;
+    participantId: string;
+    participantToInvite: UserToInvite;
+}
+/**
+ * @public
+ */
+export interface GetDirectChannelIdOutput {
+    channelId: string;
+}
+/**
+ * @public
+ */
+export interface GetMessageInput {
+    channelId: string;
+    messageId: string;
+}
 /**
  * @public
  */
@@ -379,92 +521,93 @@ export type MessageType = typeof MessageType[keyof typeof MessageType];
 /**
  * @public
  */
-export interface DeleteChannelInput {
+export interface GetMessageReactionsInput {
     channelId: string;
+    messageId: string;
+    limit?: number;
+    offset?: number;
 }
 /**
  * @public
  */
-export interface DeleteChannelOutput {
-}
-/**
- * @public
- */
-export interface DeleteMessageInput {
-    channelId: string;
-    messageId: string;
+export interface GetMessageReactionsOutput {
+    reactions: (Reaction)[];
 }
 /**
  * @public
  */
-export interface DeleteMessageOutput {
+export interface GetOrCreateDirectChannelInput {
+    userId?: string;
+    memberId?: string;
+    memberToInvite?: UserToInvite;
 }
 /**
  * @public
  */
-export declare class MessageNotFoundException extends __BaseException {
-    readonly name: "MessageNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<MessageNotFoundException, __BaseException>);
+export interface GetOrCreateDirectChannelOutput {
+    channel: Channel;
 }
 /**
  * @public
  */
-export interface GetChannelInput {
-    channelId: string;
+export interface InviteInput {
+    invitees: (UserToInvite)[];
 }
 /**
  * @public
  */
-export interface GetChannelOutput {
-    channel: Channel;
+export interface InviteOutput {
+    users: (User)[];
 }
 /**
  * @public
  */
-export interface GetChannelMemberInput {
+export interface JoinChannelInput {
     channelId: string;
-    memberId: string;
+    userId?: string;
+    silent?: boolean;
 }
 /**
  * @public
  */
-export interface GetChannelMemberOutput {
-    member: ChannelMember;
+export interface JoinChannelOutput {
+    channel: Channel;
 }
 /**
  * @public
  */
-export declare class MemberNotFoundException extends __BaseException {
-    readonly name: "MemberNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<MemberNotFoundException, __BaseException>);
+export interface LeaveChannelInput {
+    channelId: string;
+    userId?: string;
+    silent?: boolean;
 }
 /**
  * @public
  */
-export interface GetMessageInput {
-    channelId: string;
-    messageId: string;
+export interface LeaveChannelOutput {
 }
 /**
  * @public
  */
-export interface JoinChannelInput {
+export interface ListChannelMembersInput {
     channelId: string;
-    userId?: string;
+    limit?: number;
+    offset?: number;
 }
 /**
  * @public
  */
-export interface JoinChannelOutput {
-    channel: Channel;
+export interface ListChannelMembersOutput {
+    /**
+     * @public
+     * The list of members matching the query
+     */
+    members: (ChannelMember)[];
+    /**
+     * @public
+     * The list of users matching the query
+     */
+    users: (User)[];
 }
 /**
  * @public
@@ -486,14 +629,61 @@ export interface ListChannelsOutput {
 export interface ListMessagesInput {
     channelId: string;
 }
+/**
+ * @public
+ */
+export interface MarkReadInput {
+    channelId: string;
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface MarkReadOutput {
+}
+/**
+ * @public
+ */
+export interface PartialUpdateChannelSetOptions {
+    subject?: string;
+    description?: string;
+    /**
+     * @public
+     * Picture URL
+     */
+    picture?: string;
+    /**
+     * @public
+     * Picture dominant color represented by a hex value.
+     */
+    pictureColor?: string;
+    access?: ChannelAccess | string;
+    broadcast?: boolean;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const GroupChannelUnsetOptions: {
+    readonly ACCESS: "access";
+    readonly BROADCAST: "broadcast";
+    readonly DESCRIPTION: "description";
+    readonly PICTURE: "picture";
+    readonly PICTURE_COLOR: "pictureColor";
+    readonly SUBJECT: "subject";
+};
+/**
+ * @public
+ */
+export type GroupChannelUnsetOptions = typeof GroupChannelUnsetOptions[keyof typeof GroupChannelUnsetOptions];
 /**
  * @public
  */
 export interface PartialUpdateChannelInput {
     channelId: string;
     userId?: string;
-    set?: ChannelUpdateFields;
-    unset?: (ChannelUnsetFields | string)[];
+    set?: PartialUpdateChannelSetOptions;
+    unset?: (GroupChannelUnsetOptions | string)[];
 }
 /**
  * @public
@@ -507,11 +697,9 @@ export interface PartialUpdateChannelOutput {
  */
 export declare const MessageUnsetFields: {
     readonly ATTACHMENTS: "attachments";
-    readonly EVENT: "event";
     readonly FORWARD: "forward";
     readonly QUOTE: "quote";
-    readonly SMS: "sms";
-    readonly SMS_STATUS: "smsStatus";
+    readonly TEXT: "text";
 };
 /**
  * @public
@@ -543,13 +731,105 @@ export interface ScheduleExternalFlagAdjustmentJobInput {
  */
 export interface ScheduleExternalFlagAdjustmentJobOutput {
 }
+/**
+ * @public
+ */
+export interface SendGiphyInput {
+    channelId: string;
+    /**
+     * @public
+     * User ID for server side calls
+     */
+    userId?: string;
+    /**
+     * @public
+     * Message ID if empty ID will be auto-generated.
+     */
+    messageId?: string;
+    giphy: MessageGiphy;
+}
+/**
+ * @public
+ */
+export interface SendMessageReactionInput {
+    channelId: string;
+    messageId: string;
+    /**
+     * @public
+     * Type of the reaction. User could have only 1 reaction of each type per message.
+     */
+    reactionType: ReactionType | string;
+    /**
+     * @public
+     * User ID for server side calls
+     */
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface SendMessageReactionOutput {
+}
+/**
+ * @public
+ */
+export interface SendSystemMessageInput {
+    channelId: string;
+    /**
+     * @public
+     * User ID for server side calls
+     */
+    userId?: string;
+    /**
+     * @public
+     * Message ID if empty ID will be auto-generated.
+     */
+    messageId?: string;
+}
+/**
+ * @public
+ */
+export interface SendTypingStartInput {
+    channelId: string;
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface SendTypingStartOutput {
+}
+/**
+ * @public
+ */
+export interface SendTypingStopInput {
+    channelId: string;
+    userId?: string;
+}
+/**
+ * @public
+ */
+export interface SendTypingStopOutput {
+}
 /**
  * @public
  */
 export interface UpdateChannelInput {
+    subject?: string;
+    description?: string;
+    /**
+     * @public
+     * Picture URL
+     */
+    picture?: string;
+    /**
+     * @public
+     * Picture dominant color represented by a hex value.
+     */
+    pictureColor?: string;
+    access?: ChannelAccess | string;
+    broadcast?: boolean;
     channelId: string;
     userId?: string;
-    channel: ChannelUpdateFields;
 }
 /**
  * @public
@@ -561,14 +841,14 @@ export interface UpdateChannelOutput {
  * @public
  */
 export interface Message {
-    type: MessageType | string;
     text?: string;
-    silent?: boolean;
-    event?: string;
     attachments?: (MessageAttachment)[];
-    giphy?: MessageGiphy;
     quote?: Message;
     forward?: MessageForward;
+    type: MessageType | string;
+    giphy?: MessageGiphy;
+    silent?: boolean;
+    event?: string;
     sms?: boolean;
     smsStatus?: MessageSmsStatus | string;
     messageId: string;
@@ -584,95 +864,93 @@ export interface Message {
 /**
  * @public
  */
-export interface CreateMessageOutput {
+export interface GetMessageOutput {
     message?: Message;
 }
 /**
  * @public
  */
-export interface GetMessageOutput {
+export interface PartialUpdateMessageOutput {
     message?: Message;
 }
 /**
  * @public
- * An interface of available options for new message command
  */
-export interface MessageCreateFields {
-    type: MessageType | string;
+export interface PartialUpdateMessageSetInput {
     text?: string;
-    silent?: boolean;
-    event?: string;
     attachments?: (MessageAttachment)[];
-    giphy?: MessageGiphy;
     quote?: Message;
     forward?: MessageForward;
-    sms?: boolean;
-    smsStatus?: MessageSmsStatus | string;
-    messageId?: string;
-    mentions?: (string)[];
 }
 /**
  * @public
  */
-export interface MessageUpdateFields {
-    type: MessageType | string;
+export interface SendGiphyOutput {
+    message?: Message;
+}
+/**
+ * @public
+ */
+export interface SendMessageInput {
     text?: string;
-    silent?: boolean;
-    event?: string;
     attachments?: (MessageAttachment)[];
-    giphy?: MessageGiphy;
     quote?: Message;
     forward?: MessageForward;
-    sms?: boolean;
-    smsStatus?: MessageSmsStatus | string;
+    channelId: string;
+    /**
+     * @public
+     * User ID for server side calls
+     */
+    userId?: string;
+    /**
+     * @public
+     * Message ID if empty ID will be auto-generated.
+     */
+    messageId?: string;
     mentions?: (string)[];
 }
 /**
  * @public
  */
-export interface PartialUpdateMessageOutput {
+export interface SendMessageOutput {
     message?: Message;
 }
 /**
  * @public
  */
-export interface UpdateMessageOutput {
+export interface SendSystemMessageOutput {
     message?: Message;
 }
 /**
  * @public
  */
-export interface CreateMessageInput {
+export interface UpdateMessageInput {
+    text?: string;
+    attachments?: (MessageAttachment)[];
+    quote?: Message;
+    forward?: MessageForward;
     channelId: string;
-    userId?: string;
-    /**
-     * @public
-     * An interface of available options for new message command
-     */
-    message: MessageCreateFields;
+    messageId: string;
+    mentions?: (string)[];
 }
 /**
  * @public
  */
-export interface ListMessagesOutput {
-    messages?: (Message)[];
+export interface UpdateMessageOutput {
+    message?: Message;
 }
 /**
  * @public
  */
-export interface PartialUpdateMessageInput {
-    channelId: string;
-    messageId: string;
-    userId?: string;
-    set?: MessageUpdateFields;
-    unset?: (MessageUnsetFields | string)[];
+export interface ListMessagesOutput {
+    messages?: (Message)[];
 }
 /**
  * @public
  */
-export interface UpdateMessageInput {
+export interface PartialUpdateMessageInput {
     channelId: string;
     messageId: string;
-    userId?: string;
-    message: MessageUpdateFields;
+    set?: PartialUpdateMessageSetInput;
+    unset?: (MessageUnsetFields | string)[];
 }