@wildix/xbees-conversations-client 1.3.0 → 1.4.1

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageActionNotFoundException = exports.TaggedChannelsLimitReachedException = exports.SystemMessage = exports.ConversationsServiceException = exports.PinnedChannelsLimitReachedException = exports.MessageUnsetFields = exports.GroupChannelUnsetOptions = exports.MarkUnreadChannelsLimitReachedException = exports.TagNotFoundException = exports.TriggerNotFoundException = exports.WebhookEventType = exports.ReactionType = exports.MessageNotFoundException = exports.MemberNotFoundException = exports.TargetNotFoundException = exports.TargetNotEligibleException = exports.TargetNotEligibleReason = exports.TagsLimitReachedException = exports.GroupChannelCreationEventType = exports.ChannelAlreadyExistException = exports.AssignChannelVariant = exports.AssignChannelServiceRequest = exports.AssignChannelAssigneeRequest = exports.MemberAlreadyExistException = exports.ChannelNotFoundException = exports.ChannelMemberRole = exports.ActionTriggerStatus = exports.FileNotFoundException = exports.ConversationFileCategory = exports.MessageWhatsAppStatus = exports.MessageType = exports.MessageSmsStatus = exports.Element = exports.ActionElement = exports.ButtonVariant = exports.ButtonHandler = exports.ChannelWhatsAppStatus = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.ValidationException = exports.RateLimitExceededException = exports.ForbiddenException = void 0;
+exports.MessageActionNotFoundException = exports.TaggedChannelsLimitReachedException = exports.SystemMessage = exports.ConversationsServiceException = exports.PinnedChannelsLimitReachedException = exports.MessageUnsetFields = exports.GroupChannelUnsetOptions = exports.MarkUnreadChannelsLimitReachedException = exports.TagNotFoundException = exports.TriggerNotFoundException = exports.WebhookEventType = exports.ReactionType = exports.MessageNotFoundException = exports.MemberNotFoundException = exports.TagsLimitReachedException = exports.GroupChannelCreationEventType = exports.ChannelAlreadyExistException = exports.AssignChannelVariant = exports.AssignChannelServiceRequest = exports.AssignChannelAssigneeRequest = exports.MemberAlreadyExistException = exports.ChannelNotFoundException = exports.ChannelMemberRole = exports.ActionTriggerStatus = exports.FileNotFoundException = exports.ConversationFileCategory = exports.MessageWhatsAppStatus = exports.MessageType = exports.MessageSmsStatus = exports.Element = exports.ActionElement = exports.ButtonVariant = exports.ButtonHandler = exports.ChannelWhatsAppStatus = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.TargetNotFoundException = exports.TargetNotEligibleException = exports.TargetNotEligibleReason = exports.ValidationException = exports.RateLimitExceededException = exports.ForbiddenException = void 0;
 const ConversationsServiceException_1 = require("./ConversationsServiceException");
 class ForbiddenException extends ConversationsServiceException_1.ConversationsServiceException {
     name = "ForbiddenException";
@@ -49,6 +49,37 @@ class ValidationException extends ConversationsServiceException_1.ConversationsS
     }
 }
 exports.ValidationException = ValidationException;
+exports.TargetNotEligibleReason = {
+    NO_LICENSE: "no_license",
+};
+class TargetNotEligibleException extends ConversationsServiceException_1.ConversationsServiceException {
+    name = "TargetNotEligibleException";
+    $fault = "client";
+    reason;
+    constructor(opts) {
+        super({
+            name: "TargetNotEligibleException",
+            $fault: "client",
+            ...opts
+        });
+        Object.setPrototypeOf(this, TargetNotEligibleException.prototype);
+        this.reason = opts.reason;
+    }
+}
+exports.TargetNotEligibleException = TargetNotEligibleException;
+class TargetNotFoundException extends ConversationsServiceException_1.ConversationsServiceException {
+    name = "TargetNotFoundException";
+    $fault = "client";
+    constructor(opts) {
+        super({
+            name: "TargetNotFoundException",
+            $fault: "client",
+            ...opts
+        });
+        Object.setPrototypeOf(this, TargetNotFoundException.prototype);
+    }
+}
+exports.TargetNotFoundException = TargetNotFoundException;
 exports.ChannelAccess = {
     PRIVATE: "private",
     PUBLIC: "public",
@@ -226,37 +257,6 @@ class TagsLimitReachedException extends ConversationsServiceException_1.Conversa
     }
 }
 exports.TagsLimitReachedException = TagsLimitReachedException;
-exports.TargetNotEligibleReason = {
-    NO_LICENSE: "no_license",
-};
-class TargetNotEligibleException extends ConversationsServiceException_1.ConversationsServiceException {
-    name = "TargetNotEligibleException";
-    $fault = "client";
-    reason;
-    constructor(opts) {
-        super({
-            name: "TargetNotEligibleException",
-            $fault: "client",
-            ...opts
-        });
-        Object.setPrototypeOf(this, TargetNotEligibleException.prototype);
-        this.reason = opts.reason;
-    }
-}
-exports.TargetNotEligibleException = TargetNotEligibleException;
-class TargetNotFoundException extends ConversationsServiceException_1.ConversationsServiceException {
-    name = "TargetNotFoundException";
-    $fault = "client";
-    constructor(opts) {
-        super({
-            name: "TargetNotFoundException",
-            $fault: "client",
-            ...opts
-        });
-        Object.setPrototypeOf(this, TargetNotFoundException.prototype);
-    }
-}
-exports.TargetNotFoundException = TargetNotFoundException;
 class MemberNotFoundException extends ConversationsServiceException_1.ConversationsServiceException {
     name = "MemberNotFoundException";
     $fault = "client";

package/dist-cjs/protocols/Aws_restJson1.js

@@ -1302,6 +1302,7 @@ const de_AddChannelMemberCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'member': smithy_client_1._json,
+        'skippedMember': smithy_client_1._json,
         'user': smithy_client_1._json,
     });
     Object.assign(contents, doc);
@@ -1318,6 +1319,7 @@ const de_AddChannelMembersCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'members': smithy_client_1._json,
+        'skippedMembers': smithy_client_1._json,
         'users': smithy_client_1._json,
     });
     Object.assign(contents, doc);
@@ -1728,6 +1730,7 @@ const de_InviteCommand = async (output, context) => {
     });
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
+        'skippedInvitees': smithy_client_1._json,
         'users': smithy_client_1._json,
     });
     Object.assign(contents, doc);

package/dist-es/models/models_0.js

@@ -43,6 +43,35 @@ export class ValidationException extends __BaseException {
         Object.setPrototypeOf(this, ValidationException.prototype);
     }
 }
+export const TargetNotEligibleReason = {
+    NO_LICENSE: "no_license",
+};
+export class TargetNotEligibleException extends __BaseException {
+    name = "TargetNotEligibleException";
+    $fault = "client";
+    reason;
+    constructor(opts) {
+        super({
+            name: "TargetNotEligibleException",
+            $fault: "client",
+            ...opts
+        });
+        Object.setPrototypeOf(this, TargetNotEligibleException.prototype);
+        this.reason = opts.reason;
+    }
+}
+export class TargetNotFoundException extends __BaseException {
+    name = "TargetNotFoundException";
+    $fault = "client";
+    constructor(opts) {
+        super({
+            name: "TargetNotFoundException",
+            $fault: "client",
+            ...opts
+        });
+        Object.setPrototypeOf(this, TargetNotFoundException.prototype);
+    }
+}
 export const ChannelAccess = {
     PRIVATE: "private",
     PUBLIC: "public",
@@ -215,35 +244,6 @@ export class TagsLimitReachedException extends __BaseException {
         Object.setPrototypeOf(this, TagsLimitReachedException.prototype);
     }
 }
-export const TargetNotEligibleReason = {
-    NO_LICENSE: "no_license",
-};
-export class TargetNotEligibleException extends __BaseException {
-    name = "TargetNotEligibleException";
-    $fault = "client";
-    reason;
-    constructor(opts) {
-        super({
-            name: "TargetNotEligibleException",
-            $fault: "client",
-            ...opts
-        });
-        Object.setPrototypeOf(this, TargetNotEligibleException.prototype);
-        this.reason = opts.reason;
-    }
-}
-export class TargetNotFoundException extends __BaseException {
-    name = "TargetNotFoundException";
-    $fault = "client";
-    constructor(opts) {
-        super({
-            name: "TargetNotFoundException",
-            $fault: "client",
-            ...opts
-        });
-        Object.setPrototypeOf(this, TargetNotFoundException.prototype);
-    }
-}
 export class MemberNotFoundException extends __BaseException {
     name = "MemberNotFoundException";
     $fault = "client";

package/dist-es/protocols/Aws_restJson1.js

@@ -1232,6 +1232,7 @@ export const de_AddChannelMemberCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'member': _json,
+        'skippedMember': _json,
         'user': _json,
     });
     Object.assign(contents, doc);
@@ -1247,6 +1248,7 @@ export const de_AddChannelMembersCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'members': _json,
+        'skippedMembers': _json,
         'users': _json,
     });
     Object.assign(contents, doc);
@@ -1629,6 +1631,7 @@ export const de_InviteCommand = async (output, context) => {
     });
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
+        'skippedInvitees': _json,
         'users': _json,
     });
     Object.assign(contents, doc);

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

@@ -27,7 +27,11 @@ declare const AddChannelMemberCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Adds a single member to an existing channel. This operation will either add an existing user or invite a new user to the channel. This operation is idempotent, meaning that if the member already exists, the operation will still return a successful response.
+ * Adds a single member to an existing channel.
+ * This operation will either add an existing user or invite a new user to the channel.
+ * This operation is idempotent, meaning that if the member already exists, the operation will still return a successful response.
+ * If the specified member cannot be added because the account is deactivated in GetStream, the response returns `skippedMember` instead of `member` and `user`.
+ *
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -74,6 +78,11 @@ declare const AddChannelMemberCommand_base: {
  * //     createdAt: "STRING_VALUE",
  * //     updatedAt: "STRING_VALUE",
  * //   },
+ * //   skippedMember: { // SkippedMember
+ * //     id: "STRING_VALUE",
+ * //     email: "STRING_VALUE",
+ * //     phone: "STRING_VALUE",
+ * //   },
  * // };
  *
  * ```

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

@@ -27,7 +27,10 @@ declare const AddChannelMembersCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * Adds members to an existing channel. This operation is idempotent, meaning that if a member already exists in the channel, the operation will still return a successful response.
+ * Adds members to an existing channel.
+ * This operation is idempotent, meaning that if a member already exists in the channel, the operation will still return a successful response.
+ * If some members cannot be added because their accounts are deactivated in GetStream, the operation still succeeds for the rest and returns skipped members in the response.
+ *
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -83,6 +86,13 @@ declare const AddChannelMembersCommand_base: {
  * //       updatedAt: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   skippedMembers: [ // SkippedMembersList // required
+ * //     { // SkippedMember
+ * //       id: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -28,6 +28,10 @@ declare const InviteCommand_base: {
 };
 /**
  * Invite a list of users to x-bees. This operation creates an account for specified emails or phone numbers. Use this method to create users who can be added to conversations later.
+ * If an invitee resolves to an account that is currently deactivated in GetStream, the operation does not fail; instead, that invitee is reported in `skippedInvitees` and is not included in `users`.
+ *
+ *
+ * @deprecated Use InviteCommand from xbees-users-client instead.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -69,6 +73,13 @@ declare const InviteCommand_base: {
  * //       updatedAt: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   skippedInvitees: [ // SkippedMembersList // required
+ * //     { // SkippedMember
+ * //       id: "STRING_VALUE",
+ * //       email: "STRING_VALUE",
+ * //       phone: "STRING_VALUE",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -67,6 +67,40 @@ export interface TemplateWithParameters {
     name: string;
     parameters?: (TemplateParameter)[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const TargetNotEligibleReason: {
+    readonly NO_LICENSE: "no_license";
+};
+/**
+ * @public
+ */
+export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeof TargetNotEligibleReason];
+/**
+ * @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
  * @enum
@@ -639,6 +673,26 @@ export interface ChannelMember {
     createdAt: string;
     role: ChannelMemberRole;
 }
+/**
+ * @public
+ */
+export interface SkippedMember {
+    /**
+     * The unique identifier of the skipped user if it is known.
+     * @public
+     */
+    id?: string | undefined;
+    /**
+     * The email address of the skipped user if it is known.
+     * @public
+     */
+    email?: string | undefined;
+    /**
+     * The phone number of the skipped user if it is known.
+     * @public
+     */
+    phone?: string | undefined;
+}
 /**
  * @public
  */
@@ -647,12 +701,17 @@ export interface AddChannelMemberOutput {
      * Details of the member added to the channel.
      * @public
      */
-    member: ChannelMember;
+    member?: ChannelMember | undefined;
     /**
      * Details of the user added to the channel.
      * @public
      */
-    user: User;
+    user?: User | undefined;
+    /**
+     * Details of the skipped user if the member was not added, for example because the account is deactivated in GetStream.
+     * @public
+     */
+    skippedMember?: SkippedMember | undefined;
 }
 /**
  * @public
@@ -730,6 +789,11 @@ export interface AddChannelMembersOutput {
      * @public
      */
     users: (User)[];
+    /**
+     * The list of users skipped during the operation, for example because they are deactivated in GetStream.
+     * @public
+     */
+    skippedMembers: (SkippedMember)[];
 }
 /**
  * @public
@@ -1176,40 +1240,6 @@ export interface CreateKiteChannelInput {
 export interface CreateKiteChannelOutput {
     channel: Channel;
 }
-/**
- * @public
- * @enum
- */
-export declare const TargetNotEligibleReason: {
-    readonly NO_LICENSE: "no_license";
-};
-/**
- * @public
- */
-export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeof TargetNotEligibleReason];
-/**
- * @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
  */
@@ -2115,6 +2145,11 @@ export interface InviteOutput {
      * @public
      */
     users: (User)[];
+    /**
+     * A list of invitees that were skipped during the operation, for example because the resolved account is deactivated in GetStream. Each entry carries the email or phone supplied in the request, and the user id when it was already known.
+     * @public
+     */
+    skippedInvitees: (SkippedMember)[];
 }
 /**
  * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/xbees-conversations-client",
     "description": "@wildix/xbees-conversations-client client",
-    "version": "1.3.0",
+    "version": "1.4.1",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",