@wildix/xbees-conversations-client 1.1.26 → 1.1.27

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.
@@ -568,12 +568,16 @@ const se_InviteCommand = async (input, context) => {
568
568
  'content-type': 'application/json',
569
569
  };
570
570
  b.bp("/v2/conversations/invite");
571
+ const query = (0, smithy_client_1.map)({
572
+ [_co]: [, input[_cI]],
573
+ });
571
574
  let body;
572
575
  body = JSON.stringify((0, smithy_client_1.take)(input, {
573
576
  'invitees': _ => (0, smithy_client_1._json)(_),
574
577
  }));
575
578
  b.m("POST")
576
579
  .h(headers)
580
+ .q(query)
577
581
  .b(body);
578
582
  return b.build();
579
583
  };
@@ -534,12 +534,16 @@ export const se_InviteCommand = async (input, context) => {
534
534
  'content-type': 'application/json',
535
535
  };
536
536
  b.bp("/v2/conversations/invite");
537
+ const query = map({
538
+ [_co]: [, input[_cI]],
539
+ });
537
540
  let body;
538
541
  body = JSON.stringify(take(input, {
539
542
  'invitees': _ => _json(_),
540
543
  }));
541
544
  b.m("POST")
542
545
  .h(headers)
546
+ .q(query)
543
547
  .b(body);
544
548
  return b.build();
545
549
  };
@@ -35,6 +35,7 @@ declare const InviteCommand_base: {
35
35
  * // const { ConversationsClient, InviteCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
36
36
  * const client = new ConversationsClient(config);
37
37
  * const input = { // InviteInput
38
+ * companyId: "STRING_VALUE",
38
39
  * invitees: [ // UsersToInviteList // required
39
40
  * { // UserToInvite
40
41
  * email: "STRING_VALUE",
@@ -257,9 +257,28 @@ export type ActionTriggerStatus = typeof ActionTriggerStatus[keyof typeof Action
257
257
  * @public
258
258
  */
259
259
  export interface UserToInvite {
260
+ /**
261
+ * The email address of the invited user. If no user exists with the specified email and colleague flag is provided, the system will retrieve the colleague's details from the PBX.
262
+ * @public
263
+ */
260
264
  email?: string | undefined;
265
+ /**
266
+ * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided.
267
+ * @public
268
+ */
261
269
  phone?: string | undefined;
270
+ /**
271
+ * An optional name for the invited user. If the user logs in later and a different name is provided via SSO or the PBX, the system will update the user's name accordingly.
272
+ * @public
273
+ */
262
274
  name?: string | undefined;
275
+ /**
276
+ * A flag to indicate that specified email are registered colleague on the PBX.
277
+ * When provided, the system will search for the colleague on the PBX and automatically establish a connection to the organization if one does not already exist.
278
+ * If the specified colleague does not exist on the WMS, a ValidationException will be thrown and no users will be invited.
279
+ *
280
+ * @public
281
+ */
263
282
  colleague?: boolean | undefined;
264
283
  }
265
284
  /**
@@ -2037,6 +2056,11 @@ export interface HideChannelOutput {
2037
2056
  * @public
2038
2057
  */
2039
2058
  export interface InviteInput {
2059
+ /**
2060
+ * The unique identifier of the tenant when a service token is used.
2061
+ * @public
2062
+ */
2063
+ companyId?: string | undefined;
2040
2064
  /**
2041
2065
  * A list of users to invite. The list must contain between 1 and 20 users.
2042
2066
  * @public
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/xbees-conversations-client",
3
3
  "description": "@wildix/xbees-conversations-client client",
4
- "version": "1.1.26",
4
+ "version": "1.1.27",
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",