@wireapp/api-client 20.5.3 → 20.5.6

package/src/conversation/Conversation.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * Wire
+ * Copyright (C) 2018 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONVERSATION_ACCESS = exports.ACCESS_ROLE_V2 = exports.CONVERSATION_ACCESS_ROLE = exports.CONVERSATION_TYPE = void 0;
+var CONVERSATION_TYPE;
+(function (CONVERSATION_TYPE) {
+    CONVERSATION_TYPE[CONVERSATION_TYPE["REGULAR"] = 0] = "REGULAR";
+    CONVERSATION_TYPE[CONVERSATION_TYPE["SELF"] = 1] = "SELF";
+    CONVERSATION_TYPE[CONVERSATION_TYPE["ONE_TO_ONE"] = 2] = "ONE_TO_ONE";
+    CONVERSATION_TYPE[CONVERSATION_TYPE["CONNECT"] = 3] = "CONNECT";
+})(CONVERSATION_TYPE = exports.CONVERSATION_TYPE || (exports.CONVERSATION_TYPE = {}));
+var CONVERSATION_ACCESS_ROLE;
+(function (CONVERSATION_ACCESS_ROLE) {
+    CONVERSATION_ACCESS_ROLE["ACTIVATED"] = "activated";
+    CONVERSATION_ACCESS_ROLE["NON_ACTIVATED"] = "non_activated";
+    CONVERSATION_ACCESS_ROLE["PRIVATE"] = "private";
+    CONVERSATION_ACCESS_ROLE["TEAM"] = "team";
+})(CONVERSATION_ACCESS_ROLE = exports.CONVERSATION_ACCESS_ROLE || (exports.CONVERSATION_ACCESS_ROLE = {}));
+var ACCESS_ROLE_V2;
+(function (ACCESS_ROLE_V2) {
+    ACCESS_ROLE_V2["TEAM_MEMBER"] = "team_member";
+    ACCESS_ROLE_V2["SERVICE"] = "service";
+    ACCESS_ROLE_V2["NON_TEAM_MEMBER"] = "non_team_member";
+    ACCESS_ROLE_V2["GUEST"] = "guest";
+})(ACCESS_ROLE_V2 = exports.ACCESS_ROLE_V2 || (exports.ACCESS_ROLE_V2 = {}));
+var CONVERSATION_ACCESS;
+(function (CONVERSATION_ACCESS) {
+    CONVERSATION_ACCESS["CODE"] = "code";
+    CONVERSATION_ACCESS["INVITE"] = "invite";
+    CONVERSATION_ACCESS["LINK"] = "link";
+    CONVERSATION_ACCESS["PRIVATE"] = "private";
+})(CONVERSATION_ACCESS = exports.CONVERSATION_ACCESS || (exports.CONVERSATION_ACCESS = {}));
+//# sourceMappingURL=Conversation.js.map

package/src/conversation/Conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Conversation.js","sourceRoot":"","sources":["Conversation.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;AAMH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,+DAAW,CAAA;IACX,yDAAQ,CAAA;IACR,qEAAc,CAAA;IACd,+DAAW,CAAA;AACb,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAED,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,mDAAuB,CAAA;IACvB,2DAA+B,CAAA;IAC/B,+CAAmB,CAAA;IACnB,yCAAa,CAAA;AACf,CAAC,EALW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAKnC;AAED,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,6CAA2B,CAAA;IAC3B,qCAAmB,CAAA;IACnB,qDAAmC,CAAA;IACnC,iCAAe,CAAA;AACjB,CAAC,EALW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAKzB;AAED,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,wCAAiB,CAAA;IACjB,oCAAa,CAAA;IACb,0CAAmB,CAAA;AACrB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B"}

package/src/conversation/ConversationAPI/ConversationAPI.d.ts

@@ -0,0 +1,344 @@
+import { proteus as ProtobufOTR } from '@wireapp/protocol-messaging/web/otr';
+import { ClientMismatch, Conversation, ConversationCode, ConversationIds, ConversationRolesList, Conversations, Invite, Member, MessageSendingStatus, NewConversation, NewOTRMessage, RemoteConversations } from '..';
+import { ConversationAccessUpdateEvent, ConversationCodeDeleteEvent, ConversationCodeUpdateEvent, ConversationEvent, ConversationMemberJoinEvent, ConversationMemberLeaveEvent, ConversationMessageTimerUpdateEvent, ConversationReceiptModeUpdateEvent, ConversationRenameEvent } from '../../event';
+import { HttpClient } from '../../http';
+import { ConversationAccessUpdateData, ConversationAccessV2UpdateData, ConversationJoinData, ConversationMemberUpdateData, ConversationMessageTimerUpdateData, ConversationNameUpdateData, ConversationOtherMemberUpdateData, ConversationReceiptModeUpdateData, ConversationTypingData } from '../data';
+import { QualifiedId } from '../../user';
+import { BackendFeatures } from '../../APIClient';
+import { MlsEvent } from '../data/MlsEventData';
+export declare type PostMlsMessageResponse = {
+    events: MlsEvent[];
+    time: string;
+};
+declare type ConversationGuestLinkStatus = {
+    status: 'enabled' | 'disabled';
+};
+export declare class ConversationAPI {
+    protected readonly client: HttpClient;
+    protected readonly backendFeatures: BackendFeatures;
+    static readonly MAX_CHUNK_SIZE = 500;
+    static readonly URL: {
+        ACCESS: string;
+        BOTS: string;
+        CLIENTS: string;
+        CODE: string;
+        CODE_CHECK: string;
+        CONVERSATIONS: string;
+        MLS: string;
+        IDS: string;
+        JOIN: string;
+        LIST: string;
+        LIST_IDS: string;
+        MEMBERS: string;
+        MESSAGE_TIMER: string;
+        MESSAGES: string;
+        NAME: string;
+        OTR: string;
+        PROTEUS: string;
+        RECEIPT_MODE: string;
+        ROLES: string;
+        SELF: string;
+        TYPING: string;
+        V2: string;
+    };
+    constructor(client: HttpClient, backendFeatures: BackendFeatures);
+    /**
+     * Delete a conversation code.
+     * @param conversationId ID of conversation to delete the code for
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/deleteConversationCode
+     */
+    deleteConversationCode(conversationId: string): Promise<ConversationCodeDeleteEvent>;
+    /**
+     * @deprecated Use `deleteService()` instead.
+     */
+    deleteBot(conversationId: string, serviceId: string): Promise<void>;
+    /**
+     * Remove service from conversation.
+     * @param conversationId The conversation ID to remove the service from
+     * @param serviceId The ID of the service to be removed from the conversation
+     */
+    deleteService(conversationId: string, serviceId: string): Promise<void>;
+    /**
+     * Remove member from conversation.
+     * @param conversationId The conversation ID to remove the user from
+     * @param userId The user to remove
+     * @see https://staging-nginz-https.zinfra.io/api/swagger-ui/#/default/delete_conversations__cnv_domain___cnv__members__usr_domain___usr_
+     */
+    deleteMember(conversationId: QualifiedId, userId: QualifiedId): Promise<ConversationMemberLeaveEvent>;
+    /**
+     * Get all conversations.
+     * @deprecated - use getConversationList instead
+     */
+    getAllConversations(): Promise<Conversation[]>;
+    /**
+     * Get a conversation code.
+     * @param conversationId ID of conversation to get the code for
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/getConversationCode
+     */
+    getConversationCode(conversationId: string): Promise<ConversationCode>;
+    /**
+     * @param conversationId
+     * @deprecated use feature.getAllFeatures instead
+     */
+    getConversationGuestLinkFeature(conversationId: string): Promise<ConversationGuestLinkStatus>;
+    getConversation(conversationId: string | QualifiedId): Promise<Conversation>;
+    /**
+     * Get a conversation by ID.
+     * @param conversationId The conversation ID
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/conversation
+     */
+    private getConversation_v1;
+    private getConversation_v2;
+    /**
+     * Get all qualified conversation IDs.
+     * @param limit Max. number of qualified IDs to return
+     */
+    getQualifiedConversationIds(limit?: number): Promise<QualifiedId[]>;
+    /**
+     * Get all conversation IDs.
+     * @param limit Max. number of IDs to return
+     * @param conversationId Conversation ID to start from (exclusive)
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/conversationIds
+     * @deprecated Use `getListConversations()` instead.
+     */
+    getConversationIds(limit: number, conversationId?: string): Promise<ConversationIds>;
+    /**
+     * Get conversations as chunks.
+     * Note: At most 500 conversations are returned per request.
+     * @param startConversationId Conversation ID to start from (exclusive). Mutually exclusive with `conversationIds`.
+     * @param limit Max. number of conversations to return
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/conversations
+     */
+    getConversations(startConversationId?: string, limit?: number): Promise<Conversations>;
+    /**
+     * Get conversation metadata for a list of conversation qualified ids
+     * @see https://staging-nginz-https.zinfra.io/api/swagger-ui/#/default/post_conversations_list_v2
+     */
+    getConversationsByQualifiedIds(conversations: QualifiedId[]): Promise<RemoteConversations>;
+    /**
+     * Get all local & remote conversations from a federated backend.
+     */
+    getConversationList(): Promise<RemoteConversations>;
+    /**
+     * Get conversations.
+     * Note: At most 500 conversations are returned per request.
+     * @param conversationId Conversation ID to start from (exclusive). Mutually exclusive with `conversationIds`.
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/conversations
+     */
+    getConversationsByIds(filteredConversationIds: string[]): Promise<Conversation[]>;
+    /**
+     * Get conversations.
+     * Note: At most 500 conversations are returned per request.
+     * @param startConversationId Conversation ID to start from (exclusive). Mutually exclusive with `conversationIds`.
+     * @param filteredConversationIds Mutually exclusive with `startConversationId`. At most 32 IDs per request.
+     * @param limit Max. number of conversations to return
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/conversations
+     */
+    private _getConversations;
+    /**
+     * Get existing roles available for the given conversation.
+     * @param conversationId The Conversation ID to get roles for
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/getConversationsRoles
+     */
+    getRoles(conversationId: string): Promise<ConversationRolesList>;
+    /**
+     * Get self membership properties.
+     * @param conversationId The Conversation ID to get properties for
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/getSelf
+     */
+    getMembershipProperties(conversationId: string): Promise<Member>;
+    /**
+     * Create a 1:1-conversation.
+     * @param conversationData The new conversation
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/createOne2OneConversation
+     */
+    post1to1(conversationData: NewConversation): Promise<void>;
+    /**
+     * Add users to an existing conversation.
+     * @param conversationId The conversation ID
+     * @param invitationData The new conversation
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/addMembers
+     */
+    postAddMembers(conversationId: string, invitationData: Invite): Promise<ConversationEvent>;
+    /**
+     * @deprecated Use `postService()` instead.
+     */
+    postBot(conversationId: string, providerId: string, serviceId: string): Promise<ConversationMemberJoinEvent>;
+    /**
+     * Add a service to an existing conversation.
+     * @param conversationId ID of the conversation to add services to
+     * @param providerId ID of the service provider
+     * @param serviceId ID of the service provider
+     */
+    postService(conversationId: string, providerId: string, serviceId: string): Promise<ConversationMemberJoinEvent>;
+    /**
+     * Create a new conversation
+     * @param conversationData The new conversation
+     * @see https://staging-nginz-https.zinfra.io/api/swagger-ui/#/default/post_conversations
+     */
+    postConversation(conversationData: NewConversation): Promise<Conversation>;
+    /**
+     * Create or recreate a conversation code.
+     * @param conversationId ID of conversation to request the code for
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/createConversationCode
+     */
+    postConversationCodeRequest(conversationId: string): Promise<ConversationCodeUpdateEvent>;
+    /**
+     * Validate a conversation code.
+     * @param conversationCode The conversation code
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/checkConversationCode
+     */
+    postConversationCodeCheck(conversationCode: ConversationCode): Promise<void>;
+    /**
+     * Join a conversation by conversation code.
+     * @param conversationCode The conversation code
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/joinConversationByCode
+     */
+    postJoinByCode(conversationCode: ConversationCode): Promise<ConversationMemberJoinEvent>;
+    /**
+     * Get information about a conversation by conversation code.
+     * @param conversationCode The conversation code
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/joinConversationByCode
+     */
+    getJoinByCode(conversationCode: Omit<ConversationCode, 'uri'>): Promise<ConversationJoinData>;
+    /**
+     * Join a conversation.
+     * @param conversationId The conversation ID
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/joinConversation
+     */
+    postJoin(conversationId: string): Promise<ConversationEvent>;
+    /**
+     * Post an encrypted message to a conversation.
+     * @param sendingClientId The sender's client ID
+     * @param conversationId The conversation ID
+     * @param messageData The message content
+     * @param ignoreMissing Whether to report missing clients or not:
+     * `false`: Report about all missing clients
+     * `true`: Ignore all missing clients and force sending.
+     * Array: User IDs specifying which user IDs are allowed to have
+     * missing clients
+     * `undefined`: Default to setting of `report_missing` in `NewOTRMessage`
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/postOtrMessage
+     */
+    postOTRMessage(sendingClientId: string, conversationId: string, messageData?: NewOTRMessage<string>, ignoreMissing?: boolean | string[]): Promise<ClientMismatch>;
+    /**
+     * This endpoint ensures that the list of clients is correct and only sends the message if the list is correct.
+     * To override this, the endpoint accepts `client_mismatch_strategy` in the body. It can have these values:
+     *
+     * - `report_all`: When set, the message is not sent if any clients are missing. The missing clients are reported
+     * in the response.
+     * - `ignore_all`: When set, no checks about missing clients are carried out.
+     * - `report_only`: Takes a list of qualified UserIDs. If any clients of the listed users are missing, the message is
+     * not sent. The missing clients are reported in the response.
+     * - `ignore_only`: Takes a list of qualified UserIDs. If any clients of the non-listed users are missing, the message
+     * is not sent. The missing clients are reported in the response.
+     *
+     * The sending of messages in a federated conversation could theorectically fail partially. To make this case
+     * unlikely, the backend first gets a list of clients from all the involved backends and then tries to send a message.
+     * So, if any backend is down, the message is not propagated to anyone. But the actual message fan out to multiple
+     * backends could still fail partially. This type of failure is reported as a 201, the clients for which the message
+     * sending failed are part of the response body.
+     *
+     * This endpoint can lead to OtrMessageAdd event being sent to the recipients.
+     *
+     * @see https://nginz-https.anta.wire.link/api/swagger-ui/#/default/post_conversations__cnv_domain___cnv__proteus_messages
+     */
+    postOTRMessageV2(conversationId: string, domain: string, messageData: ProtobufOTR.QualifiedNewOtrMessage): Promise<MessageSendingStatus>;
+    /**
+     * Post an encrypted message to a conversation.
+     * @param sendingClientId The sender's client ID
+     * @param conversationId The conversation ID
+     * @param messageData The message content
+     * @param ignoreMissing Whether to report missing clients or not:
+     * `false`: Report about all missing clients
+     * `true`: Ignore all missing clients and force sending.
+     * Array: User IDs specifying which user IDs are allowed to have
+     * missing clients
+     * `undefined`: Default to setting of `report_missing` in `NewOTRMessage`
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/postOtrMessage
+     */
+    postOTRProtobufMessage(sendingClientId: string, conversationId: string, messageData: ProtobufOTR.NewOtrMessage, ignoreMissing?: boolean | string[]): Promise<ClientMismatch>;
+    /**
+     * Post an encrypted message to a conversation.
+     * @param messageData Mls message payload in TLS format. Please refer to the MLS specification for details.
+     * @see https://messaginglayersecurity.rocks/mls-protocol/draft-ietf-mls-protocol.html#name-message-framing
+     * @see https://staging-nginz-https.zinfra.io/api/swagger-ui/#/default/post_mls_messages
+     */
+    postMlsMessage(messageData: Uint8Array): Promise<PostMlsMessageResponse>;
+    /**
+     * Post the welcome encrypted message to a conversation.
+     * @param messageData Mls welocome message payload in TLS format. Please refer to the MLS specification for details.
+     * @see https://messaginglayersecurity.rocks/mls-protocol/draft-ietf-mls-protocol.html#name-message-framing
+     * @see https://staging-nginz-https.zinfra.io/api/swagger-ui/#/default/post_mls_welcome
+     */
+    postMlsWelcomeMessage(messageData: Uint8Array): Promise<void>;
+    postForClients(clientId: string, conversationId: string): Promise<ClientMismatch>;
+    /**
+     * Create a self-conversation.
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/createSelfConversation
+     */
+    postSelf(): Promise<Conversation>;
+    /**
+     * Send typing notifications.
+     * @param conversationId The Conversation ID to send notifications in
+     * @param typingData The typing status
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/isTyping
+     */
+    postTyping(conversationId: string, typingData: ConversationTypingData): Promise<void>;
+    /**
+     * Update access modes for a conversation.
+     * @param conversationId The conversation ID to update the access mode of
+     * @param accessData The new access data
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateConversationAccess
+     */
+    putAccess(conversationId: string, accessData: ConversationAccessUpdateData | ConversationAccessV2UpdateData): Promise<ConversationAccessUpdateEvent>;
+    /**
+     * Update conversation properties.
+     * @param conversationId The conversation ID to update properties of
+     * @param conversationNameData The new conversation name
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateConversation
+     */
+    putConversation(conversationId: string, conversationNameData: ConversationNameUpdateData): Promise<ConversationRenameEvent>;
+    /**
+     * Update the message timer for a conversation.
+     * @param conversationId The conversation ID
+     * @param conversationData The new message timer
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateConversationMessageTimer
+     */
+    putConversationMessageTimer(conversationId: string, messageTimerData: ConversationMessageTimerUpdateData): Promise<ConversationMessageTimerUpdateEvent>;
+    /**
+     * Update the receipt mode for a conversation.
+     * @param conversationId The conversation ID
+     * @param receiptModeData The new receipt mode
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateConversationReceiptMode
+     */
+    putConversationReceiptMode(conversationId: string, receiptModeData: ConversationReceiptModeUpdateData): Promise<ConversationReceiptModeUpdateEvent>;
+    /**
+     * Add users to an existing conversation.
+     * @param conversationId The conversation ID to add the users to
+     * @param users List of users to add to a conversation
+     */
+    private postMembersV0;
+    /**
+     * Add qualified members to an existing Proteus conversation.
+     * @param conversationId The conversation ID to add the users to
+     * @param users List of users to add to a conversation
+     */
+    postMembers(conversationId: QualifiedId, users: QualifiedId[]): Promise<ConversationMemberJoinEvent>;
+    /**
+     * Update membership of the specified user in a certain conversation
+     * @param userId The user ID
+     * @param conversationId The conversation ID to change the user's membership in
+     * @param memberUpdateData The new member data
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateOtherMember
+     */
+    putOtherMember(userId: string, conversationId: string, memberUpdateData: ConversationOtherMemberUpdateData): Promise<void>;
+    /**
+     * Update self membership properties.
+     * @param conversationId The Conversation ID
+     * @param memberData The new conversation
+     * @see https://staging-nginz-https.zinfra.io/swagger-ui/#!/conversations/updateSelf
+     */
+    putMembershipProperties(conversationId: string, memberData: Partial<ConversationMemberUpdateData>): Promise<void>;
+}
+export {};