@wildix/xbees-users-client 1.3.1 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1077,6 +1077,7 @@ const de_InviteCommand = async (output, context) => {
1077
1077
  });
1078
1078
  const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
1079
1079
  const doc = (0, smithy_client_1.take)(data, {
1080
+ 'skippedInvitees': smithy_client_1._json,
1080
1081
  'users': smithy_client_1._json,
1081
1082
  });
1082
1083
  Object.assign(contents, doc);
@@ -1007,6 +1007,7 @@ export const de_InviteCommand = async (output, context) => {
1007
1007
  });
1008
1008
  const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
1009
1009
  const doc = take(data, {
1010
+ 'skippedInvitees': _json,
1010
1011
  'users': _json,
1011
1012
  });
1012
1013
  Object.assign(contents, doc);
@@ -28,6 +28,8 @@ declare const InviteCommand_base: {
28
28
  };
29
29
  /**
30
30
  * 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.
31
+ * 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`.
32
+ *
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -69,6 +71,13 @@ declare const InviteCommand_base: {
69
71
  * // updatedAt: "STRING_VALUE",
70
72
  * // },
71
73
  * // ],
74
+ * // skippedInvitees: [ // SkippedMembersList // required
75
+ * // { // SkippedMember
76
+ * // id: "STRING_VALUE",
77
+ * // email: "STRING_VALUE",
78
+ * // phone: "STRING_VALUE",
79
+ * // },
80
+ * // ],
72
81
  * // };
73
82
  *
74
83
  * ```
@@ -227,6 +227,26 @@ export interface UserToInvite {
227
227
  */
228
228
  colleague?: boolean | undefined;
229
229
  }
230
+ /**
231
+ * @public
232
+ */
233
+ export interface SkippedMember {
234
+ /**
235
+ * The unique identifier of the skipped user if it is known.
236
+ * @public
237
+ */
238
+ id?: string | undefined;
239
+ /**
240
+ * The email address of the skipped user if it is known.
241
+ * @public
242
+ */
243
+ email?: string | undefined;
244
+ /**
245
+ * The phone number of the skipped user if it is known.
246
+ * @public
247
+ */
248
+ phone?: string | undefined;
249
+ }
230
250
  /**
231
251
  * @public
232
252
  */
@@ -1857,6 +1877,11 @@ export interface InviteOutput {
1857
1877
  * @public
1858
1878
  */
1859
1879
  users: (User)[];
1880
+ /**
1881
+ * 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.
1882
+ * @public
1883
+ */
1884
+ skippedInvitees: (SkippedMember)[];
1860
1885
  }
1861
1886
  /**
1862
1887
  * @public
@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
11
11
  maxAttempts: number | import("@smithy/types").Provider<number>;
12
- requestHandler: import("@smithy/core/protocols").HttpHandler<any> | RequestHandler;
12
+ requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
13
13
  retryMode: string | import("@smithy/types").Provider<string>;
14
14
  sha256: import("@smithy/types").HashConstructor;
15
15
  streamCollector: import("@smithy/types").StreamCollector;
@@ -9,7 +9,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
11
11
  maxAttempts: number | import("@smithy/types").Provider<number>;
12
- requestHandler: RequestHandler | import("@smithy/core/protocols").HttpHandler<any>;
12
+ requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
13
13
  retryMode: string | import("@smithy/types").Provider<string>;
14
14
  sha256: import("@smithy/types").HashConstructor;
15
15
  streamCollector: import("@smithy/types").StreamCollector;
@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: UsersClientConfig) => {
7
7
  sha256: import("@smithy/types").HashConstructor;
8
8
  env?: "stage" | "stable" | "prod" | undefined;
9
9
  token: import("@wildix/smithy-utils").TokenProvider;
10
- requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/core/protocols").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
10
+ requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/protocol-http").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
11
11
  cacheMiddleware?: boolean | undefined;
12
12
  protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
13
13
  protocolSettings?: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/xbees-users-client",
3
3
  "description": "@wildix/xbees-users-client client",
4
- "version": "1.3.1",
4
+ "version": "1.3.2",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",