Package com.mypurecloud.sdk.v2.api

Class GroupsApi

java.lang.Object
com.mypurecloud.sdk.v2.api.GroupsApi
public class GroupsApi extends Object

  • Constructor Details

    • GroupsApi

      public GroupsApi()

    • GroupsApi

      public GroupsApi(ApiClient apiClient)

  • Method Details

    • deleteGroup

      public void deleteGroup(String groupId) throws IOException, ApiException
      Delete group
      Parameters:
      groupId - Group ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroupWithHttpInfo

      public ApiResponse<Void> deleteGroupWithHttpInfo(String groupId) throws IOException
      Delete group
      Parameters:
      groupId - Group ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteGroup

      public void deleteGroup(DeleteGroupRequest request) throws IOException, ApiException
      Delete group
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroup

      public ApiResponse<Void> deleteGroup(ApiRequest<Void> request) throws IOException
      Delete group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteGroupDynamicsettings

      public void deleteGroupDynamicsettings(String groupId) throws IOException, ApiException
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroupDynamicsettingsWithHttpInfo

      public ApiResponse<Void> deleteGroupDynamicsettingsWithHttpInfo(String groupId) throws IOException
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteGroupDynamicsettings

      public void deleteGroupDynamicsettings(DeleteGroupDynamicsettingsRequest request) throws IOException, ApiException
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroupDynamicsettings

      public ApiResponse<Void> deleteGroupDynamicsettings(ApiRequest<Void> request) throws IOException
      Remove dynamic group definition deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteGroupMembers

      public Empty deleteGroupMembers(String groupId, String ids) throws IOException, ApiException
      Remove members
      Parameters:
      groupId - Group ID (required)
      ids - Comma separated list of userIds to remove. A maximum of 50 members are allowed per request. (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroupMembersWithHttpInfo

      public ApiResponse<Empty> deleteGroupMembersWithHttpInfo(String groupId, String ids) throws IOException
      Remove members
      Parameters:
      groupId - Group ID (required)
      ids - Comma separated list of userIds to remove. A maximum of 50 members are allowed per request. (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteGroupMembers

      public Empty deleteGroupMembers(DeleteGroupMembersRequest request) throws IOException, ApiException
      Remove members
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteGroupMembers

      public ApiResponse<Empty> deleteGroupMembers(ApiRequest<Void> request) throws IOException
      Remove members
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getFieldconfig

      public FieldConfig getFieldconfig(String type) throws IOException, ApiException
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      type - Field type (required)
      Returns:
      FieldConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getFieldconfigWithHttpInfo

      public ApiResponse<FieldConfig> getFieldconfigWithHttpInfo(String type) throws IOException
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      type - Field type (required)
      Returns:
      FieldConfig
      Throws:
      IOException - if the request fails to be processed

    • getFieldconfig

      public FieldConfig getFieldconfig(GetFieldconfigRequest request) throws IOException, ApiException
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      request - The request object
      Returns:
      FieldConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getFieldconfig

      public ApiResponse<FieldConfig> getFieldconfig(ApiRequest<Void> request) throws IOException
      Deprecated.
      Fetch field config for an entity type
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroup

      public Group getGroup(String groupId) throws IOException, ApiException
      Get group
      Parameters:
      groupId - Group ID (required)
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupWithHttpInfo

      public ApiResponse<Group> getGroupWithHttpInfo(String groupId) throws IOException
      Get group
      Parameters:
      groupId - Group ID (required)
      Returns:
      Group
      Throws:
      IOException - if the request fails to be processed

    • getGroup

      public Group getGroup(GetGroupRequest request) throws IOException, ApiException
      Get group
      Parameters:
      request - The request object
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroup

      public ApiResponse<Group> getGroup(ApiRequest<Void> request) throws IOException
      Get group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroupDynamicsettings

      public DynamicGroupDefinition getGroupDynamicsettings(String groupId) throws IOException, ApiException
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      Returns:
      DynamicGroupDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupDynamicsettingsWithHttpInfo

      public ApiResponse<DynamicGroupDefinition> getGroupDynamicsettingsWithHttpInfo(String groupId) throws IOException
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      Returns:
      DynamicGroupDefinition
      Throws:
      IOException - if the request fails to be processed

    • getGroupDynamicsettings

      public DynamicGroupDefinition getGroupDynamicsettings(GetGroupDynamicsettingsRequest request) throws IOException, ApiException
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      DynamicGroupDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupDynamicsettings

      public ApiResponse<DynamicGroupDefinition> getGroupDynamicsettings(ApiRequest<Void> request) throws IOException
      Get dynamic group definition getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroupIndividuals

      public UserEntityListing getGroupIndividuals(String groupId) throws IOException, ApiException
      Get all individuals associated with the group
      Parameters:
      groupId - Group ID (required)
      Returns:
      UserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupIndividualsWithHttpInfo

      public ApiResponse<UserEntityListing> getGroupIndividualsWithHttpInfo(String groupId) throws IOException
      Get all individuals associated with the group
      Parameters:
      groupId - Group ID (required)
      Returns:
      UserEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getGroupIndividuals

      public UserEntityListing getGroupIndividuals(GetGroupIndividualsRequest request) throws IOException, ApiException
      Get all individuals associated with the group
      Parameters:
      request - The request object
      Returns:
      UserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupIndividuals

      public ApiResponse<UserEntityListing> getGroupIndividuals(ApiRequest<Void> request) throws IOException
      Get all individuals associated with the group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroupMembers

      public UserEntityListing getGroupMembers(String groupId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException, ApiException
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      groupId - Group ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      expand - Which fields, if any, to expand (optional)
      Returns:
      UserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupMembersWithHttpInfo

      public ApiResponse<UserEntityListing> getGroupMembersWithHttpInfo(String groupId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      groupId - Group ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      expand - Which fields, if any, to expand (optional)
      Returns:
      UserEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getGroupMembers

      public UserEntityListing getGroupMembers(GetGroupMembersRequest request) throws IOException, ApiException
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      request - The request object
      Returns:
      UserEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupMembers

      public ApiResponse<UserEntityListing> getGroupMembers(ApiRequest<Void> request) throws IOException
      Get group members, includes individuals, owners, and dynamically included people
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroupProfile

      public GroupProfile getGroupProfile(String groupId, String fields) throws IOException, ApiException
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups instead
      Parameters:
      groupId - groupId (required)
      fields - Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList (optional)
      Returns:
      GroupProfile
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupProfileWithHttpInfo

      public ApiResponse<GroupProfile> getGroupProfileWithHttpInfo(String groupId, String fields) throws IOException
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups instead
      Parameters:
      groupId - groupId (required)
      fields - Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList (optional)
      Returns:
      GroupProfile
      Throws:
      IOException - if the request fails to be processed

    • getGroupProfile

      public GroupProfile getGroupProfile(GetGroupProfileRequest request) throws IOException, ApiException
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups instead
      Parameters:
      request - The request object
      Returns:
      GroupProfile
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupProfile

      public ApiResponse<GroupProfile> getGroupProfile(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get group profile This api is deprecated. Use /api/v2/groups instead
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroups

      public GroupEntityListing getGroups(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder) throws IOException, ApiException
      Get a group list
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - id (optional)
      jabberId - A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) (optional)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      GroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupsWithHttpInfo

      public ApiResponse<GroupEntityListing> getGroupsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder) throws IOException
      Get a group list
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - id (optional)
      jabberId - A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) (optional)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      GroupEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getGroups

      public GroupEntityListing getGroups(GetGroupsRequest request) throws IOException, ApiException
      Get a group list
      Parameters:
      request - The request object
      Returns:
      GroupEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroups

      public ApiResponse<GroupEntityListing> getGroups(ApiRequest<Void> request) throws IOException
      Get a group list
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getGroupsSearch

      public GroupsSearchResponse getGroupsSearch(String q64, List<String> expand) throws IOException, ApiException
      Search groups using the q64 value returned from a previous search
      Parameters:
      q64 - q64 (required)
      expand - expand (optional)
      Returns:
      GroupsSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupsSearchWithHttpInfo

      public ApiResponse<GroupsSearchResponse> getGroupsSearchWithHttpInfo(String q64, List<String> expand) throws IOException
      Search groups using the q64 value returned from a previous search
      Parameters:
      q64 - q64 (required)
      expand - expand (optional)
      Returns:
      GroupsSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • getGroupsSearch

      public GroupsSearchResponse getGroupsSearch(GetGroupsSearchRequest request) throws IOException, ApiException
      Search groups using the q64 value returned from a previous search
      Parameters:
      request - The request object
      Returns:
      GroupsSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getGroupsSearch

      public ApiResponse<GroupsSearchResponse> getGroupsSearch(ApiRequest<Void> request) throws IOException
      Search groups using the q64 value returned from a previous search
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getProfilesGroups

      public GroupProfileEntityListing getProfilesGroups(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder) throws IOException, ApiException
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups instead.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - id (optional)
      jabberId - A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) (optional)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      GroupProfileEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProfilesGroupsWithHttpInfo

      public ApiResponse<GroupProfileEntityListing> getProfilesGroupsWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder) throws IOException
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups instead.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      id - id (optional)
      jabberId - A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) (optional)
      sortOrder - Ascending or descending sort order (optional, default to ASC)
      Returns:
      GroupProfileEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getProfilesGroups

      public GroupProfileEntityListing getProfilesGroups(GetProfilesGroupsRequest request) throws IOException, ApiException
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups instead.
      Parameters:
      request - The request object
      Returns:
      GroupProfileEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getProfilesGroups

      public ApiResponse<GroupProfileEntityListing> getProfilesGroups(ApiRequest<Void> request) throws IOException
      Deprecated.
      Get group profile listing This api is deprecated. Use /api/v2/groups instead.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postGroupMembers

      public Empty postGroupMembers(String groupId, GroupMembersUpdate body) throws IOException, ApiException
      Add members
      Parameters:
      groupId - Group ID (required)
      body - Add members (required)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupMembersWithHttpInfo

      public ApiResponse<Empty> postGroupMembersWithHttpInfo(String groupId, GroupMembersUpdate body) throws IOException
      Add members
      Parameters:
      groupId - Group ID (required)
      body - Add members (required)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • postGroupMembers

      public Empty postGroupMembers(PostGroupMembersRequest request) throws IOException, ApiException
      Add members
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupMembers

      public ApiResponse<Empty> postGroupMembers(ApiRequest<GroupMembersUpdate> request) throws IOException
      Add members
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postGroups

      public Group postGroups(GroupCreate body) throws IOException, ApiException
      Create a group
      Parameters:
      body - Group (required)
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupsWithHttpInfo

      public ApiResponse<Group> postGroupsWithHttpInfo(GroupCreate body) throws IOException
      Create a group
      Parameters:
      body - Group (required)
      Returns:
      Group
      Throws:
      IOException - if the request fails to be processed

    • postGroups

      public Group postGroups(PostGroupsRequest request) throws IOException, ApiException
      Create a group
      Parameters:
      request - The request object
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroups

      public ApiResponse<Group> postGroups(ApiRequest<GroupCreate> request) throws IOException
      Create a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postGroupsDynamicsettingsPreview

      public DynamicGroupQueryPreview postGroupsDynamicsettingsPreview(DynamicGroupQuery body) throws IOException, ApiException
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - Group query to preview (required)
      Returns:
      DynamicGroupQueryPreview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupsDynamicsettingsPreviewWithHttpInfo

      public ApiResponse<DynamicGroupQueryPreview> postGroupsDynamicsettingsPreviewWithHttpInfo(DynamicGroupQuery body) throws IOException
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      body - Group query to preview (required)
      Returns:
      DynamicGroupQueryPreview
      Throws:
      IOException - if the request fails to be processed

    • postGroupsDynamicsettingsPreview

      public DynamicGroupQueryPreview postGroupsDynamicsettingsPreview(PostGroupsDynamicsettingsPreviewRequest request) throws IOException, ApiException
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      DynamicGroupQueryPreview
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupsDynamicsettingsPreview

      public ApiResponse<DynamicGroupQueryPreview> postGroupsDynamicsettingsPreview(ApiRequest<DynamicGroupQuery> request) throws IOException
      Deprecated.
      Preview the number of users selected for a dynamic group definition query postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postGroupsSearch

      public GroupsSearchResponse postGroupsSearch(GroupSearchRequest body) throws IOException, ApiException
      Search groups
      Parameters:
      body - Search request options (required)
      Returns:
      GroupsSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupsSearchWithHttpInfo

      public ApiResponse<GroupsSearchResponse> postGroupsSearchWithHttpInfo(GroupSearchRequest body) throws IOException
      Search groups
      Parameters:
      body - Search request options (required)
      Returns:
      GroupsSearchResponse
      Throws:
      IOException - if the request fails to be processed

    • postGroupsSearch

      public GroupsSearchResponse postGroupsSearch(PostGroupsSearchRequest request) throws IOException, ApiException
      Search groups
      Parameters:
      request - The request object
      Returns:
      GroupsSearchResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postGroupsSearch

      public ApiResponse<GroupsSearchResponse> postGroupsSearch(ApiRequest<GroupSearchRequest> request) throws IOException
      Search groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putGroup

      public Group putGroup(String groupId, GroupUpdate body) throws IOException, ApiException
      Update group
      Parameters:
      groupId - Group ID (required)
      body - Group (optional)
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putGroupWithHttpInfo

      public ApiResponse<Group> putGroupWithHttpInfo(String groupId, GroupUpdate body) throws IOException
      Update group
      Parameters:
      groupId - Group ID (required)
      body - Group (optional)
      Returns:
      Group
      Throws:
      IOException - if the request fails to be processed

    • putGroup

      public Group putGroup(PutGroupRequest request) throws IOException, ApiException
      Update group
      Parameters:
      request - The request object
      Returns:
      Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putGroup

      public ApiResponse<Group> putGroup(ApiRequest<GroupUpdate> request) throws IOException
      Update group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putGroupDynamicsettings

      public void putGroupDynamicsettings(String groupId, DynamicGroupQuery body) throws IOException, ApiException
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      body - Create/Update dynamic groups (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putGroupDynamicsettingsWithHttpInfo

      public ApiResponse<Void> putGroupDynamicsettingsWithHttpInfo(String groupId, DynamicGroupQuery body) throws IOException
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      groupId - Group ID (required)
      body - Create/Update dynamic groups (required)
      Throws:
      IOException - if the request fails to be processed

    • putGroupDynamicsettings

      public void putGroupDynamicsettings(PutGroupDynamicsettingsRequest request) throws IOException, ApiException
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putGroupDynamicsettings

      public ApiResponse<Void> putGroupDynamicsettings(ApiRequest<DynamicGroupQuery> request) throws IOException
      Create / Update dynamic group definition putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed