epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/group.js

@@ -1,655 +0,0 @@
-import { ROLE } from '../utils/constants.js';
-import '../utils/helpers.js';
-import { parseFilterInput } from '../utils/filter-parser.js';
-import EpicenterError from '../utils/error.js';
-import '../utils/config.js';
-import identification from '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-
-// Aliases for backward compatibility
-
-/**
- * Provides information on a particular Epicenter group.
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/{GROUP_KEY}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/{GROUP_KEY}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/quantized/{GROUP_KEY}`
- *
- * @example
- * import { authAdapter, groupAdapter } from 'epicenter-libs';
- * const session = authAdapter.getLocalSession();
- * // include members of the group in the response
- * const group = await groupAdapter.get({ groupKey: session.groupKey, augment: 'MEMBERS' });
- * // include metrics relating to the group in the response
- * const group = await groupAdapter.get({ groupKey: session.groupKey, augment: 'QUANTIZED' });
- *
- * @param [optionals]           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.augment]   Specifies which additional information you'd like returned with the group
- * @param [optionals.groupKey]  Group key; if omitted will attempt to use the group associated with the current session
- * @returns promise that resolves to a group
- */
-async function get(optionals = {}) {
-  const {
-    groupKey,
-    augment,
-    ...routingOptions
-  } = optionals;
-  let uriComponent = '';
-  if (augment === 'MEMBERS') uriComponent = '/member';
-  if (augment === 'QUANTIZED') uriComponent = '/quantized';
-  const session = identification.session;
-  return await new Router().get(`/group${uriComponent}/${groupKey !== null && groupKey !== void 0 ? groupKey : session === null || session === void 0 ? void 0 : session.groupKey}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes the group; available only to Epicenter admins
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * await groupAdapter.destroy('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param groupKey      Key associated with group
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to undefined if successful
- */
-async function destroy(groupKey, optionals = {}) {
-  return await new Router().delete(`/group/${groupKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Provides information for all groups in the project
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const groups = await groupAdapter.gather();
- *
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.includeExpired]    Indicates whether to include expired groups in the query
- * @returns promise that resolves to a list of groups
- */
-async function gather(optionals = {}) {
-  const {
-    includeExpired,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    includeExpired
-  }).get('/group', routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates fields for a particular group; available only to Epicenter admins
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * await groupAdapter.update('0000017dd3bf540e5ada5b1e058f08f20461', { event: 'Orientation Day' });
- *
- * @param groupKey                          Key associated with group
- * @param update                            Attributes you wish to update
- * @param [update.runLimit]                 Defines the upper limit of runs allowed in the group
- * @param [update.organization]             Name of the organization owning the group
- * @param [update.allowSelfRegistration]    Whether users can register to join the group without being invited
- * @param [update.flightRecorder]           Diagnostic tool for logging HTTP requests for the server
- * @param [update.flightRecorder.start]     Start time (epoch time)
- * @param [update.flightRecorder.stop]      End time (epoch time)
- * @param [update.flightRecorder.enabled]   Enabled flag for the flight recorder
- * @param [update.event]                    Name of the event the group is playing for
- * @param [update.allowMembershipChanges]   Locks the group so members cannot be added and member permissions cannot be changed
- * @param [update.pricing]                  Group pricing information
- * @param [update.pricing.amount]           Amount (in cents) for user signup
- * @param [update.startDate]                Start date for group event
- * @param [update.expirationDate]           Date the group expires
- * @param [update.capacity]                 Defines the upper limit on the number of users allowed in the group
- * @param [update.allowChannel]             Opt into push notifications for this resource; applicable to projects with phylogeny >= SILENT
- * @param [optionals]                       Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated group
- */
-async function update(groupKey, update, optionals = {}) {
-  const {
-    runLimit,
-    organization,
-    allowSelfRegistration,
-    flightRecorder,
-    event,
-    allowMembershipChanges,
-    pricing,
-    startDate,
-    expirationDate,
-    capacity,
-    allowChannel
-  } = update;
-  return await new Router().patch(`/group/${groupKey}`, {
-    body: {
-      runLimit,
-      organization,
-      allowSelfRegistration,
-      flightRecorder,
-      event,
-      allowMembershipChanges,
-      pricing,
-      startDate,
-      expirationDate,
-      capacity,
-      allowChannel
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Creates a new group; available only to Epicenter admins
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const group = await groupAdapter.create({
- *      runLimit: 10,
- *      name: 'my-group-name',
- * });
- *
- * @param group                             Group object
- * @param group.name                        Group name (required)
- * @param [group.runLimit]                  Defines the upper limit on the number of runs allowed in the group
- * @param [group.organization]              Name of the organization owning the group
- * @param [group.allowSelfRegistration]     Whether users can register to join the group without being invited
- * @param [group.flightRecorder]            Diagnostic tool for logging HTTP requests for the server
- * @param [group.flightRecorder.start]      Start time (epoch time)
- * @param [group.flightRecorder.stop]       End time (epoch time)
- * @param [group.flightRecorder.enabled]    Enabled flag for the flight recorder
- * @param [group.event]                     Name of the event the group is playing for
- * @param [group.allowMembershipChanges]    Locks the group so members cannot be added and member permissions cannot be changed
- * @param [group.pricing]                   Group pricing information
- * @param [group.pricing.amount]            Amount (in cents) for user signup
- * @param [group.startDate]                 Start date for group event
- * @param [group.expirationDate]            Date the group expires
- * @param [group.capacity]                  Defines the upper limit on the number of users allowed in the group
- * @param [group.allowChannel]              Opt into push notifications for this resource; applicable to projects with phylogeny >= SILENT
- * @param [optionals]                       Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the newly created group
- */
-async function create(group, optionals = {}) {
-  const {
-    name,
-    runLimit,
-    organization,
-    allowSelfRegistration,
-    flightRecorder,
-    event,
-    allowMembershipChanges,
-    pricing,
-    startDate,
-    expirationDate,
-    capacity,
-    allowChannel
-  } = group;
-  if (!name) throw new EpicenterError('Cannot create a group with no name');
-  return await new Router().post('/group', {
-    body: {
-      name,
-      runLimit,
-      organization,
-      allowSelfRegistration,
-      flightRecorder,
-      event,
-      allowMembershipChanges,
-      pricing,
-      startDate,
-      expirationDate,
-      capacity,
-      allowChannel
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Queries for groups
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/search` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/quantized/search`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const filter = [
- *      'name|=group1|group2',                              // look for groups whose name is 'group1' or 'group2'
- *      'groupKey=0000017dd3bf540e5ada5b1e058f08f20461',    // look for groups with the specific group key
- *      'approximateMemberCount>30',                        // look for groups larger than 30
- *      'startDate<2022-01-03T20:30:53.054Z',               // look for groups with start date before Jan 3rd 2022
- *      'expirationDate<2022-01-03T20:30:53.054Z',          // look for groups with expiration date before Jan 3rd 2022
- *      // 'account.shortName=acme',                        // specifies account, intended for admin use
- *      // 'project.shortName=simulations',                 // specifies project, intended for admin use
- * ];
- * const page = await groupAdapter.query({
- *      filter,
- *      sort: ['+group.name'],  // sort all findings by group name ascending (lexicographically)
- *      first: 3,               // page should start with the 4th item found (will default to 0)
- *      max: 10,                // page should only include the first 10 items
- * });
- *
- * @param searchOptions             Search options for the query
- * @param [searchOptions.filter]    Filters for searching
- * @param [searchOptions.sort]      Sorting criteria
- * @param [searchOptions.first]     The starting index of the page returned
- * @param [searchOptions.max]       The number of entries per page
- * @param [optionals]               Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a page of groups
- */
-async function query(searchOptions, optionals = {}) {
-  const {
-    filter,
-    sort = [],
-    first,
-    max,
-    quantized
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter),
-    sort: sort.join(';') || undefined,
-    first,
-    max
-  };
-  return await new Router().withSearchParams(searchParams).get(`/group${quantized ? '/quantized' : ''}/search`, {
-    paginated: true,
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-/** DEPRECATED -- use groupAdapter.query instead */
-async function search(optionals = {}) {
-  console.warn('DEPRECATION WARNING: groupAdapter.search is deprecated and will be removed with the next release. Use groupAdapter.query instead.');
-  const {
-    filter = [],
-    sort = [],
-    first,
-    max,
-    quantized,
-    ...routingOptions
-  } = optionals;
-  const searchOptions = {
-    filter,
-    sort,
-    first,
-    max,
-    quantized
-  };
-  return await query(searchOptions, routingOptions);
-}
-
-/**
- * Retrieves a group with given group name
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/with/{NAME}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const group = await groupAdapter.withGroupName('my-group-name');
- *
- * @param name          Name associated with the group
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a group
- */
-async function withGroupName(name, optionals = {}) {
-  return await new Router().get(`/group/with/${name}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves the list of groups a particular user is in; intended for admin use
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/for/{USER_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const groups = await groupAdapter.forUser(
- *      '000001796733eef0842f4d6d960997018a3b', // get groups where this user is a member of
- *      { role: ['FACILITATOR'] }               // where this user is a facilitator in the group
- * );
- *
- * @param userKey                       User key associated with the user
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.includeExpired]    Indicates whether to include expired groups in the query
- * @param [optionals.includeAllMembers] Indicates whether to include the other members in the group (by default, only the requested user appears)
- * @param [optionals.role]              Role or list of possible roles the user holds in the group
- * @returns promise that resolves to a list of groups
- */
-async function forUser(userKey, optionals = {}) {
-  const {
-    includeExpired,
-    includeAllMembers,
-    role,
-    ...routingOptions
-  } = optionals;
-  const isMultiple = Array.isArray(role) && role.length > 0;
-  const roleList = isMultiple ? role : [role];
-  const searchParams = {
-    includeExpired,
-    includeAllMembers,
-    role: role ? roleList : undefined
-  };
-  return await new Router().withSearchParams(searchParams).get(`/group/member/for/${userKey}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves the list of groups particular to the current session
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const groups = await groupAdapter.getSessionGroups();
- *
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.includeExpired]    Indicates whether to include expired groups in the query
- * @param [optionals.includeAllMembers] Indicates whether to include the other members in the group (by default, only the requested user appears)
- * @param [optionals.role]              Role or list of possible roles the user holds in the group
- * @returns promise that resolves to a list of groups
- */
-async function getSessionGroups(optionals = {}) {
-  const {
-    includeExpired,
-    role,
-    ...routingOptions
-  } = optionals;
-  const isMultiple = Array.isArray(role) && role.length > 0;
-  const roleList = isMultiple ? role : [role];
-  const searchParams = {
-    includeExpired,
-    role: role ? roleList : undefined
-  };
-  return await new Router().withSearchParams(searchParams).get('/group/member', routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Permits a list of users to self-register for membership in a group; will only work if the group has allowSelfRegistration set to true
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/self/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * await groupAdapter.whitelistUsers('0000017dd3bf540e5ada5b1e058f08f20461', {
- *    allow: true,
- *    emails: ['user1@test.com', 'user2@test.com'],
- * });
- *
- * @param groupKey                  Key associated with group
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.allow]         Whether to allow or disallow self-registration for the specified users; defaults to true if unset
- * @param [optionals.emails]        List of emails to allow or disallow; a value of "*" is interpreted as all users; defaults to all users if unset
- * @returns promise that resolves to undefined (indicating success)
- */
-async function whitelistUsers(groupKey, optionals = {}) {
-  const {
-    allow = true,
-    emails = ['*'],
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/group/self/${groupKey}`, {
-    body: {
-      allow,
-      emails
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves a list of users allowed to self-register for membership in a group with a given groupKey
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/self/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const users = await groupAdapter.getWhitelistedUsers('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param groupKey      Key associated with the group
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a list of users
- */
-async function getWhitelistedUsers(groupKey, optionals = {}) {
-  return await new Router().get(`/group/self/${groupKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Sends an email to the specified email address with a link to complete self-registration for a group
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/registration/self/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * await groupAdapter.sendRegistrationEmail('0000017dd3bf540e5ada5b1e058f08f20461', 'user1@test.com', {
- *     redirectURL: '/login',
- *     linkURL: '/register',
- *     subject: 'Complete your registration!',
- * });
- *
- * @param groupKey                  Key associated with group
- * @param email                     Email address to send the link to
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.linkURL]       Relative path to link sent in email to complete registration (<forio scheme>://<forio host>/app/<account>/<project><linkURL>)
- * @param [optionals.redirectURL]   Relative path to redirect to after completing registration (<forio scheme>://<forio host>/app/<account>/<project><redirectURL>)
- * @param [optionals.subject]       The subject of the email that will be sent
- * @returns promise that resolves to undefined (indicating success)
- */
-async function sendRegistrationEmail(groupKey, email, optionals = {}) {
-  const {
-    redirectURL,
-    linkURL,
-    subject,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/registration/self/${groupKey}`, {
-    body: {
-      email,
-      linkUrl: linkURL,
-      redirectUrl: redirectURL,
-      subject
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Finalizes a user's self-registration process for a group; requires the project to have deployment.autoCreatePlayer set to true
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/registration/self/{TOKEN}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const result = await groupAdapter.selfRegister('myregistrationtoken', 'pass', {
- *    displayName: 'My Display Name',
- *    givenName: 'Leonard',
- *    familyName: 'Nimoy',
- *    handle: 'the_real_spock',
- * });
- *
- * @param token                     Registration token
- * @param password                  Password the user would use to log in
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.displayName]   Display name chosen by user
- * @param [optionals.givenName]     User's given name
- * @param [optionals.familyName]    User's family name
- * @param [optionals.handle]        Handle the user would use to log in; defaults to email address if not specified
- * @returns promise resolving to an object containing the redirect URL and the session
- */
-async function selfRegister(token, password, optionals = {}) {
-  const {
-    displayName,
-    givenName,
-    familyName,
-    handle,
-    ...routingOptions
-  } = optionals;
-  return await new Router().patch(`/registration/self/${token}`, {
-    body: {
-      password,
-      displayName,
-      givenName,
-      familyName,
-      handle
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Adds user(s) to the group
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * await groupAdapter.addUser('000001796733eef0842f4d6d960997018a3b');
- * await groupAdapter.addUser([{
- *      userKey: '000001796733eef0842f4d6d960997018a3b',
- *      role: 'REVIEWER',
- *      available: false,
- * }]);
- *
- * @param usersInput                List of user keys or user input objects (properties defined below)
- * @param usersInput[].userKey      User key
- * @param [usersInput[].role]       User's role; defaults to PARTICIPANT if unset; See [ROLE](#ROLE) for all types
- * @param [usersInput[].available]  Indicates whether or not the user is 'active' (for semantic labeling); defaults to true if unset
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupKey]      Group key to indicate the group; will default to the group key associated with the current session
- * @returns promise that resolves to the group the user was added to
- */
-async function addUser(usersInput, optionals = {}) {
-  const {
-    groupKey,
-    ...routingOptions
-  } = optionals;
-  const users = Array.isArray(usersInput) ? usersInput : [usersInput];
-  const session = identification.session;
-  return await new Router().post(`/group/member/${groupKey !== null && groupKey !== void 0 ? groupKey : session === null || session === void 0 ? void 0 : session.groupKey}`, {
-    body: users.map(u => {
-      const userKey = typeof u === 'string' ? u : u.userKey;
-      const role = typeof u === 'string' ? ROLE.PARTICIPANT : u.role;
-      const available = typeof u === 'string' ? true : u.available;
-      return {
-        role,
-        userKey,
-        objectType: 'group',
-        available: available !== null && available !== void 0 ? available : true
-      };
-    }),
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates a user's group membership information
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/{GROUP_KEY}/{USER_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const group = await groupAdapter.updateUser('000001796733eef0842f4d6d960997018a3b', { role: 'LEADER' });
- *
- * @param userKey               User key
- * @param update                Object containing the updates to a user's group membership information
- * @param [update.role]         User's role; See [ROLE](#ROLE) for all types
- * @param [update.available]    Indicates whether or not the user is 'active' (for semantic labeling)
- * @param [optionals]           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupKey]  Group key; defaults to the group key associated with the current session
- * @returns promise that resolves to the membership information that was updated
- */
-async function updateUser(userKey, update, optionals = {}) {
-  const {
-    role,
-    available
-  } = update;
-  const {
-    groupKey,
-    ...routingOptions
-  } = optionals;
-  const session = identification.session;
-  return await new Router().patch(`/group/member/${groupKey !== null && groupKey !== void 0 ? groupKey : session === null || session === void 0 ? void 0 : session.groupKey}/${userKey}`, {
-    body: {
-      objectType: 'group',
-      role,
-      available
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Removes user(s) from the group
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/{GROUP_KEY}/{USER_KEY}` or DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/member/{GROUP_KEY}` (for multiple users)
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const userKeys = members.map(({ userKey }) => userKey);
- * await groupAdapter.removeUser(userKeys);
- *
- * @param userKey               Key associated with the user or an array of user keys to remove from group
- * @param [optionals]           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupKey]  Group key for the group you want to remove from; defaults to the group in the current session
- * @returns promise that resolves to undefined when successful
- */
-async function removeUser(userKey, optionals = {}) {
-  const {
-    groupKey,
-    ...routingOptions
-  } = optionals;
-  const hasMultiple = Array.isArray(userKey) && userKey.length > 1;
-  const uriComponent = hasMultiple ? '' : `/${userKey.length === 1 ? userKey[0] : userKey}`;
-  const searchParams = hasMultiple ? {
-    userKey
-  } : undefined;
-  const session = identification.session;
-  return await new Router().withSearchParams(searchParams).delete(`/group/member/${groupKey !== null && groupKey !== void 0 ? groupKey : session === null || session === void 0 ? void 0 : session.groupKey}${uriComponent}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates the status of a group
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/group/status/{GROUP_KEY}`
- *
- * @example
- * import { groupAdapter } from 'epicenter-libs';
- * const group = await groupAdapter.statusUpdate('active', 'Group is currently active');
- *
- * @param code                      Status code
- * @param message                   Status message
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupKey]      Group key; defaults to the group key associated with the current session
- * @returns promise that resolves to the updated group
- */
-async function statusUpdate(code, message, optionals = {}) {
-  const {
-    groupKey,
-    ...routingOptions
-  } = optionals;
-  const session = identification.session;
-  return await new Router().patch(`/group/status/${groupKey !== null && groupKey !== void 0 ? groupKey : session === null || session === void 0 ? void 0 : session.groupKey}`, {
-    body: {
-      code,
-      message
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-export { addUser, create, destroy, forUser, gather, get, getSessionGroups, getWhitelistedUsers, query, removeUser, search, selfRegister, sendRegistrationEmail, statusUpdate, update, updateUser, whitelistUsers, withGroupName };