Package com.mypurecloud.sdk.v2.api
Class UsersApi
java.lang.Object
com.mypurecloud.sdk.v2.api.UsersApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDelete/cancel an async request for user aggregatesdeleteAnalyticsUsersAggregatesJob(ApiRequest<Void> request) Delete/cancel an async request for user aggregatesvoidDelete/cancel an async request for user aggregatesDelete/cancel an async request for user aggregatesvoidDelete/cancel an async requestdeleteAnalyticsUsersDetailsJob(ApiRequest<Void> request) Delete/cancel an async requestvoidDelete/cancel an async requestDelete/cancel an async requestvoidDelete a grant of a role in a divisionDelete a grant of a role in a divisionvoiddeleteAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId) Delete a grant of a role in a divisiondeleteAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId) Delete a grant of a role in a divisionvoidDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voiddeleteRoutingDirectroutingbackupSettingsMe(DeleteRoutingDirectroutingbackupSettingsMeRequest request) Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voiddeleteRoutingUserDirectroutingbackupSettings(DeleteRoutingUserDirectroutingbackupSettingsRequest request) Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voidDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.voidDelete the user's max utilization settings and revert to the organization-wide default.deleteRoutingUserUtilization(ApiRequest<Void> request) Delete the user's max utilization settings and revert to the organization-wide default.voiddeleteRoutingUserUtilization(String userId) Delete the user's max utilization settings and revert to the organization-wide default.Delete the user's max utilization settings and revert to the organization-wide default.deleteUser(DeleteUserRequest request) Delete userdeleteUser(ApiRequest<Void> request) Delete userdeleteUser(String userId) Delete uservoidDelete a custom attributes record.deleteUserCustomattribute(ApiRequest<Void> request) Delete a custom attributes record.voiddeleteUserCustomattribute(String userId, String schemaId) Delete a custom attributes record.deleteUserCustomattributeWithHttpInfo(String userId, String schemaId) Delete a custom attributes record.voiddeleteUserExternalidAuthorityNameExternalKey(DeleteUserExternalidAuthorityNameExternalKeyRequest request) Delete the external identifier for user.Delete the external identifier for user.voiddeleteUserExternalidAuthorityNameExternalKey(String userId, String authorityName, String externalKey) Delete the external identifier for user.deleteUserExternalidAuthorityNameExternalKeyWithHttpInfo(String userId, String authorityName, String externalKey) Delete the external identifier for user.voidRemove a routing language from a userdeleteUserRoutinglanguage(ApiRequest<Void> request) Remove a routing language from a uservoiddeleteUserRoutinglanguage(String userId, String languageId) Remove a routing language from a userdeleteUserRoutinglanguageWithHttpInfo(String userId, String languageId) Remove a routing language from a uservoidRemove a routing skill from a userdeleteUserRoutingskill(ApiRequest<Void> request) Remove a routing skill from a uservoiddeleteUserRoutingskill(String userId, String skillId) Remove a routing skill from a userdeleteUserRoutingskillWithHttpInfo(String userId, String skillId) Remove a routing skill from a uservoidDelete a schemadeleteUsersCustomattributesSchema(ApiRequest<Void> request) Delete a schemavoiddeleteUsersCustomattributesSchema(String schemaId) Delete a schemaDelete a schemavoidClear self associated stationvoidClear self associated stationClear self associated stationClear self associated stationvoidClear associated stationdeleteUserStationAssociatedstation(ApiRequest<Void> request) Clear associated stationvoidClear associated stationClear associated stationvoidClear default stationdeleteUserStationDefaultstation(ApiRequest<Void> request) Clear default stationvoidClear default stationClear default stationvoidDelete a verifierdeleteUserVerifier(ApiRequest<Void> request) Delete a verifiervoiddeleteUserVerifier(String userId, String verifierId) Delete a verifierdeleteUserVerifierWithHttpInfo(String userId, String verifierId) Delete a verifierdeleteUserWithHttpInfo(String userId) Delete userGet status for async query for user aggregatesgetAnalyticsUsersAggregatesJob(ApiRequest<Void> request) Get status for async query for user aggregatesGet status for async query for user aggregatesFetch a page of results for an async aggregates queryFetch a page of results for an async aggregates querygetAnalyticsUsersAggregatesJobResults(String jobId, String cursor) Fetch a page of results for an async aggregates querygetAnalyticsUsersAggregatesJobResultsWithHttpInfo(String jobId, String cursor) Fetch a page of results for an async aggregates queryGet status for async query for user aggregatesGet status for async query for user detailsgetAnalyticsUsersDetailsJob(ApiRequest<Void> request) Get status for async query for user detailsGet status for async query for user detailsFetch a page of results for an async querygetAnalyticsUsersDetailsJobResults(ApiRequest<Void> request) Fetch a page of results for an async querygetAnalyticsUsersDetailsJobResults(String jobId, String cursor, Integer pageSize) Fetch a page of results for an async querygetAnalyticsUsersDetailsJobResultsWithHttpInfo(String jobId, String cursor, Integer pageSize) Fetch a page of results for an async queryLookup the datalake availability date and timeLookup the datalake availability date and timeLookup the datalake availability date and timeLookup the datalake availability date and timeGet status for async query for user detailsDeprecated.Deprecated.getAuthorizationDivisionspermittedMe(String permission, String name) Deprecated.getAuthorizationDivisionspermittedMeWithHttpInfo(String permission, String name) Deprecated.Returns which divisions the current user has the given permission in.Returns which divisions the current user has the given permission in.getAuthorizationDivisionspermittedPagedMe(String permission, Integer pageNumber, Integer pageSize) Returns which divisions the current user has the given permission in.getAuthorizationDivisionspermittedPagedMeWithHttpInfo(String permission, Integer pageNumber, Integer pageSize) Returns which divisions the current user has the given permission in.getAuthorizationDivisionspermittedPagedSubjectId(GetAuthorizationDivisionspermittedPagedSubjectIdRequest request) Deprecated.Deprecated.getAuthorizationDivisionspermittedPagedSubjectId(String subjectId, String permission, Integer pageNumber, Integer pageSize) Deprecated.getAuthorizationDivisionspermittedPagedSubjectIdWithHttpInfo(String subjectId, String permission, Integer pageNumber, Integer pageSize) Deprecated.Returns a listing of roles and permissions for a user.getAuthorizationSubject(ApiRequest<Void> request) Returns a listing of roles and permissions for a user.getAuthorizationSubject(String subjectId, Boolean includeDuplicates) Returns a listing of roles and permissions for a user.Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectsMe(ApiRequest<Void> request) Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectsMe(Boolean includeDuplicates) Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectsMeWithHttpInfo(Boolean includeDuplicates) Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectWithHttpInfo(String subjectId, Boolean includeDuplicates) Returns a listing of roles and permissions for a user.getFieldconfig(GetFieldconfigRequest request) Deprecated.getFieldconfig(ApiRequest<Void> request) Deprecated.getFieldconfig(String type) Deprecated.Deprecated.getProfilesUsers(GetProfilesUsersRequest request) Deprecated.getProfilesUsers(ApiRequest<Void> request) Deprecated.getProfilesUsers(Integer pageSize, Integer pageNumber, List<String> id, List<String> jid, String sortOrder, List<String> expand, String integrationPresenceSource) Deprecated.getProfilesUsersWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jid, String sortOrder, List<String> expand, String integrationPresenceSource) Deprecated.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's Direct Routing Backup settings.Get the user's max utilization settings.getRoutingUserUtilization(ApiRequest<Void> request) Get the user's max utilization settings.getRoutingUserUtilization(String userId) Get the user's max utilization settings.Get the user's max utilization settings.getUser(GetUserRequest request) Get user.getUser(ApiRequest<Void> request) Get user.getUser(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get user.getUserAdjacents(GetUserAdjacentsRequest request) Get adjacentsgetUserAdjacents(ApiRequest<Void> request) Get adjacentsgetUserAdjacents(String userId, List<String> expand) Get adjacentsgetUserAdjacentsWithHttpInfo(String userId, List<String> expand) Get adjacentsGet a user's CallForwardinggetUserCallforwarding(ApiRequest<Void> request) Get a user's CallForwardinggetUserCallforwarding(String userId) Get a user's CallForwardingGet a user's CallForwardingGet custom attributes by schema idgetUserCustomattribute(ApiRequest<Void> request) Get custom attributes by schema idgetUserCustomattribute(String userId, String schemaId) Get custom attributes by schema idGet multiple custom attributes records by schema idsgetUserCustomattributesBulk(ApiRequest<Void> request) Get multiple custom attributes records by schema idsgetUserCustomattributesBulk(String userId, List<String> schemaIds) Get multiple custom attributes records by schema idsgetUserCustomattributesBulkWithHttpInfo(String userId, List<String> schemaIds) Get multiple custom attributes records by schema idsgetUserCustomattributeWithHttpInfo(String userId, String schemaId) Get custom attributes by schema idGet direct reportsgetUserDirectreports(ApiRequest<Void> request) Get direct reportsgetUserDirectreports(String userId, List<String> expand) Get direct reportsgetUserDirectreportsWithHttpInfo(String userId, List<String> expand) Get direct reportsGet the external identifiers for a user.getUserExternalid(ApiRequest<Void> request) Get the external identifiers for a user.getUserExternalid(String userId) Get the external identifiers for a user.Get the external identifier of user for an authority.getUserExternalidAuthorityName(ApiRequest<Void> request) Get the external identifier of user for an authority.getUserExternalidAuthorityName(String userId, String authorityName) Get the external identifier of user for an authority.getUserExternalidAuthorityNameWithHttpInfo(String userId, String authorityName) Get the external identifier of user for an authority.getUserExternalidWithHttpInfo(String userId) Get the external identifiers for a user.getUserFavorites(GetUserFavoritesRequest request) Deprecated.getUserFavorites(ApiRequest<Void> request) Deprecated.getUserFavorites(String userId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) Deprecated.getUserFavoritesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) Deprecated.Get a user's GeolocationgetUserGeolocation(ApiRequest<Void> request) Get a user's GeolocationgetUserGeolocation(String userId, String clientId) Get a user's GeolocationgetUserGeolocationWithHttpInfo(String userId, String clientId) Get a user's GeolocationGet a OutOfOfficegetUserOutofoffice(ApiRequest<Void> request) Get a OutOfOfficegetUserOutofoffice(String userId) Get a OutOfOfficegetUserOutofofficeWithHttpInfo(String userId) Get a OutOfOfficegetUserProfile(GetUserProfileRequest request) Deprecated.getUserProfile(ApiRequest<Void> request) Deprecated.getUserProfile(String userId, List<String> expand, String integrationPresenceSource) Deprecated.List profile skills for a usergetUserProfileskills(ApiRequest<Void> request) List profile skills for a usergetUserProfileskills(String userId) List profile skills for a userList profile skills for a usergetUserProfileWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource) Deprecated.getUserQueues(GetUserQueuesRequest request) Get queues for usergetUserQueues(ApiRequest<Void> request) Get queues for usergetUserQueues(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) Get queues for usergetUserQueuesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) Get queues for usergetUserRoles(GetUserRolesRequest request) Returns a listing of roles and permissions for a user.getUserRoles(ApiRequest<Void> request) Returns a listing of roles and permissions for a user.getUserRoles(String subjectId) Returns a listing of roles and permissions for a user.getUserRolesWithHttpInfo(String subjectId) Returns a listing of roles and permissions for a user.List routing languages assigned to a usergetUserRoutinglanguages(ApiRequest<Void> request) List routing languages assigned to a usergetUserRoutinglanguages(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing languages assigned to a usergetUserRoutinglanguagesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing languages assigned to a userList routing skills assigned to a usergetUserRoutingskills(ApiRequest<Void> request) List routing skills assigned to a usergetUserRoutingskills(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing skills assigned to a usergetUserRoutingskillsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) List routing skills assigned to a userFetch the routing status of a usergetUserRoutingstatus(ApiRequest<Void> request) Fetch the routing status of a usergetUserRoutingstatus(String userId) Fetch the routing status of a userFetch the routing status of a usergetUsers(GetUsersRequest request) Get the list of available users.getUsers(ApiRequest<Void> request) Get the list of available users.getUsers(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get the list of available users.getUsersChatsMe(GetUsersChatsMeRequest request) Get chats for a usergetUsersChatsMe(ApiRequest<Void> request) Get chats for a usergetUsersChatsMe(Boolean excludeClosed, Boolean includePresence, Boolean includeRoomOwners, String after) Get chats for a usergetUsersChatsMeWithHttpInfo(Boolean excludeClosed, Boolean includePresence, Boolean includeRoomOwners, String after) Get chats for a userGet a schemagetUsersCustomattributesSchema(ApiRequest<Void> request) Get a schemagetUsersCustomattributesSchema(String schemaId) Get a schemaGet a list of schemas.Get a list of schemas.getUsersCustomattributesSchemas(ApiRequest<Void> request) Get a list of schemas.Get the core types from which all schemas are built.Get the core types from which all schemas are built.getUsersCustomattributesSchemasCoretype(String coreTypeName) Get the core types from which all schemas are built.Get the list of core types enabled for a specific namespace.Get the list of core types enabled for a specific namespace.Get the list of core types enabled for a specific namespace.Get the list of core types enabled for a specific namespace.getUsersCustomattributesSchemasCoretypeWithHttpInfo(String coreTypeName) Get the core types from which all schemas are built.Get quantitative limits on schemasGet quantitative limits on schemasGet quantitative limits on schemasGet quantitative limits on schemasGet a list of schemas.Get a specific version of a schemaGet a specific version of a schemagetUsersCustomattributesSchemaVersion(String schemaId, String versionId) Get a specific version of a schemaGet all versions of a user schemaGet all versions of a user schemagetUsersCustomattributesSchemaVersions(String schemaId) Get all versions of a user schemaGet all versions of a user schemagetUsersCustomattributesSchemaVersionWithHttpInfo(String schemaId, String versionId) Get a specific version of a schemaGet a schemaGet list of Development Activities Either moduleId or userId is required.getUsersDevelopmentActivities(ApiRequest<Void> request) Get list of Development Activities Either moduleId or userId is required.getUsersDevelopmentActivities(List<String> userId, String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) Get list of Development Activities Either moduleId or userId is required.Get list of Development Activities for current user Results are filtered based on the applicable permissions.getUsersDevelopmentActivitiesMe(ApiRequest<Void> request) Get list of Development Activities for current user Results are filtered based on the applicable permissions.getUsersDevelopmentActivitiesMe(String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) Get list of Development Activities for current user Results are filtered based on the applicable permissions.getUsersDevelopmentActivitiesMeWithHttpInfo(String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) Get list of Development Activities for current user Results are filtered based on the applicable permissions.getUsersDevelopmentActivitiesWithHttpInfo(List<String> userId, String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) Get list of Development Activities Either moduleId or userId is required.Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.getUsersDevelopmentActivity(ApiRequest<Void> request) Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.getUsersDevelopmentActivity(String activityId, String type) Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.getUsersDevelopmentActivityWithHttpInfo(String activityId, String type) Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.getUsersExternalidAuthorityNameExternalKey(GetUsersExternalidAuthorityNameExternalKeyRequest request) Get the user associated with external identifier.Get the user associated with external identifier.getUsersExternalidAuthorityNameExternalKey(String authorityName, String externalKey, List<String> expand) Get the user associated with external identifier.getUsersExternalidAuthorityNameExternalKeyWithHttpInfo(String authorityName, String externalKey, List<String> expand) Get the user associated with external identifier.Get skill groups for a usergetUserSkillgroups(ApiRequest<Void> request) Get skill groups for a usergetUserSkillgroups(String userId, Integer pageSize, String after, String before) Get skill groups for a usergetUserSkillgroupsWithHttpInfo(String userId, Integer pageSize, String after, String before) Get skill groups for a usergetUsersMe(GetUsersMeRequest request) Get current user details.getUsersMe(ApiRequest<Void> request) Get current user details.getUsersMe(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds) Get current user details.getUsersMeWithHttpInfo(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds) Get current user details.getUsersQuery(GetUsersQueryRequest request) Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is requiredgetUsersQuery(ApiRequest<Void> request) Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is requiredgetUsersQuery(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is requiredgetUsersQueryWithHttpInfo(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is requiredgetUsersSearch(GetUsersSearchRequest request) Search users using the q64 value returned from a previous searchgetUsersSearch(ApiRequest<Void> request) Search users using the q64 value returned from a previous searchgetUsersSearch(String q64, List<String> expand, String integrationPresenceSource) Search users using the q64 value returned from a previous searchgetUsersSearchWithHttpInfo(String q64, List<String> expand, String integrationPresenceSource) Search users using the q64 value returned from a previous searchGet station information for selfGet station information for selfgetUsersStationsMe(ApiRequest<Void> request) Get station information for selfGet station information for selfgetUserState(GetUserStateRequest request) Get user state information.getUserState(ApiRequest<Void> request) Get user state information.getUserState(String userId) Get user state information.getUserStateWithHttpInfo(String userId) Get user state information.getUserStation(GetUserStationRequest request) Get station information for usergetUserStation(ApiRequest<Void> request) Get station information for usergetUserStation(String userId) Get station information for usergetUserStationWithHttpInfo(String userId) Get station information for usergetUserSuperiors(GetUserSuperiorsRequest request) Get superiorsgetUserSuperiors(ApiRequest<Void> request) Get superiorsgetUserSuperiors(String userId, List<String> expand) Get superiorsgetUserSuperiorsWithHttpInfo(String userId, List<String> expand) Get superiorsgetUsersWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get the list of available users.getUserTrustors(GetUserTrustorsRequest request) List the organizations that have authorized/trusted the user.getUserTrustors(ApiRequest<Void> request) List the organizations that have authorized/trusted the user.getUserTrustors(String userId, Integer pageSize, Integer pageNumber) List the organizations that have authorized/trusted the user.getUserTrustorsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber) List the organizations that have authorized/trusted the user.getUserVerifiers(GetUserVerifiersRequest request) Get a list of verifiersgetUserVerifiers(ApiRequest<Void> request) Get a list of verifiersgetUserVerifiers(String userId) Get a list of verifiersgetUserVerifiersWithHttpInfo(String userId) Get a list of verifiersgetUserWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) Get user.patchUser(PatchUserRequest request) Update userpatchUser(ApiRequest<UpdateUser> request) Update userpatchUser(String userId, UpdateUser body) Update userPatch a user's CallForwardingpatchUserCallforwarding(ApiRequest<CallForwarding> request) Patch a user's CallForwardingpatchUserCallforwarding(String userId, CallForwarding body) Patch a user's CallForwardingpatchUserCallforwardingWithHttpInfo(String userId, CallForwarding body) Patch a user's CallForwardingUpdate a single custom attributes record by amending the data with only the provided fields.Update a single custom attributes record by amending the data with only the provided fields.patchUserCustomattributes(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) Update a single custom attributes record by amending the data with only the provided fields.Update multiple custom attributes records by amending the data with only the provided fields.Update multiple custom attributes records by amending the data with only the provided fields.patchUserCustomattributesBulk(String userId, List<UserCustomAttributesUpdateRequest> userCustomAttributesList) Update multiple custom attributes records by amending the data with only the provided fields.patchUserCustomattributesBulkWithHttpInfo(String userId, List<UserCustomAttributesUpdateRequest> userCustomAttributesList) Update multiple custom attributes records by amending the data with only the provided fields.patchUserCustomattributesWithHttpInfo(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) Update a single custom attributes record by amending the data with only the provided fields.Patch a user's Geolocation The geolocation object can be patched one of three ways.patchUserGeolocation(ApiRequest<Geolocation> request) Patch a user's Geolocation The geolocation object can be patched one of three ways.patchUserGeolocation(String userId, String clientId, Geolocation body) Patch a user's Geolocation The geolocation object can be patched one of three ways.patchUserGeolocationWithHttpInfo(String userId, String clientId, Geolocation body) Patch a user's Geolocation The geolocation object can be patched one of three ways.patchUserQueue(PatchUserQueueRequest request) Join or unjoin a queue for a userpatchUserQueue(ApiRequest<UserQueue> request) Join or unjoin a queue for a userpatchUserQueue(String queueId, String userId, UserQueue body) Join or unjoin a queue for a userpatchUserQueues(PatchUserQueuesRequest request) Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.patchUserQueues(ApiRequest<List<UserQueue>> request) Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership.patchUserQueueWithHttpInfo(String queueId, String userId, UserQueue body) Join or unjoin a queue for a userUpdate an assigned routing language's proficiencyUpdate an assigned routing language's proficiencypatchUserRoutinglanguage(String userId, String languageId, UserRoutingLanguage body) Update an assigned routing language's proficiencyAssign multiple routing languages to a user.Assign multiple routing languages to a user.patchUserRoutinglanguagesBulk(String userId, List<UserRoutingLanguagePost> body) Assign multiple routing languages to a user.Assign multiple routing languages to a user.patchUserRoutinglanguageWithHttpInfo(String userId, String languageId, UserRoutingLanguage body) Update an assigned routing language's proficiencyAssign multiple routing skills to a userAssign multiple routing skills to a userpatchUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a userpatchUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a userpatchUsersBulk(PatchUsersBulkRequest request) Update bulk acd autoanswer on users.patchUsersBulk(ApiRequest<List<PatchUser>> request) Update bulk acd autoanswer on users.patchUsersBulk(List<PatchUser> body) Update bulk acd autoanswer on users.Update bulk acd autoanswer on users.patchUserWithHttpInfo(String userId, UpdateUser body) Update userQuery for user activity observationsQuery for user activity observationspostAnalyticsUsersActivityQuery(UserActivityQuery body, Integer pageSize, Integer pageNumber) Query for user activity observationspostAnalyticsUsersActivityQueryWithHttpInfo(UserActivityQuery body, Integer pageSize, Integer pageNumber) Query for user activity observationsQuery for user aggregates asynchronouslyQuery for user aggregates asynchronouslyQuery for user aggregates asynchronouslyQuery for user aggregates asynchronouslyQuery for user aggregatesQuery for user aggregatesQuery for user aggregatesQuery for user aggregatesQuery for user details asynchronouslyQuery for user details asynchronouslyQuery for user details asynchronouslyQuery for user details asynchronouslyQuery for user detailsQuery for user detailsQuery for user detailsQuery for user detailsQuery for user observationsQuery for user observationsQuery for user observationsQuery for user observationsvoidBulk-grant roles and divisions to a subject.Bulk-grant roles and divisions to a subject.voidpostAuthorizationSubjectBulkadd(String subjectId, RoleDivisionGrants body, String subjectType) Bulk-grant roles and divisions to a subject.postAuthorizationSubjectBulkaddWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) Bulk-grant roles and divisions to a subject.voidBulk-remove grants from a subject.Bulk-remove grants from a subject.voidpostAuthorizationSubjectBulkremove(String subjectId, RoleDivisionGrants body) Bulk-remove grants from a subject.postAuthorizationSubjectBulkremoveWithHttpInfo(String subjectId, RoleDivisionGrants body) Bulk-remove grants from a subject.voidReplace subject's roles and divisions with the exact list supplied in the request.Replace subject's roles and divisions with the exact list supplied in the request.voidpostAuthorizationSubjectBulkreplace(String subjectId, RoleDivisionGrants body, String subjectType) Replace subject's roles and divisions with the exact list supplied in the request.postAuthorizationSubjectBulkreplaceWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) Replace subject's roles and divisions with the exact list supplied in the request.voidMake a grant of a role in a divisionMake a grant of a role in a divisionvoidpostAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId, String subjectType) Make a grant of a role in a divisionpostAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId, String subjectType) Make a grant of a role in a divisionCreate mapping between external identifier and user.Create mapping between external identifier and user.postUserExternalid(String userId, UserExternalIdentifier body) Create mapping between external identifier and user.postUserExternalidWithHttpInfo(String userId, UserExternalIdentifier body) Create mapping between external identifier and user.voidpostUserInvite(PostUserInviteRequest request) Send an activation email to the userpostUserInvite(ApiRequest<Void> request) Send an activation email to the uservoidpostUserInvite(String userId, Boolean force) Send an activation email to the userpostUserInviteWithHttpInfo(String userId, Boolean force) Send an activation email to the uservoidpostUserPassword(PostUserPasswordRequest request) Change a users passwordpostUserPassword(ApiRequest<ChangePasswordRequest> request) Change a users passwordvoidpostUserPassword(String userId, ChangePasswordRequest body) Change a users passwordpostUserPasswordWithHttpInfo(String userId, ChangePasswordRequest body) Change a users passwordAssign a routing language to a userAssign a routing language to a userpostUserRoutinglanguages(String userId, UserRoutingLanguagePost body) Assign a routing language to a userAssign a routing language to a userAssign a routing skill to a userAssign a routing skill to a userpostUserRoutingskills(String userId, UserRoutingSkillPost body) Assign a routing skill to a userpostUserRoutingskillsWithHttpInfo(String userId, UserRoutingSkillPost body) Assign a routing skill to a userpostUsers(PostUsersRequest request) Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.postUsers(ApiRequest<CreateUser> request) Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.postUsers(CreateUser body) Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.Create a schemaCreate a schemaCreate a schemaCreate a schemapostUsersDevelopmentActivitiesAggregatesQuery(PostUsersDevelopmentActivitiesAggregatesQueryRequest request) Retrieve aggregated development activity data Results are filtered based on the applicable permissions.postUsersDevelopmentActivitiesAggregatesQuery(ApiRequest<DevelopmentActivityAggregateParam> request) Retrieve aggregated development activity data Results are filtered based on the applicable permissions.Retrieve aggregated development activity data Results are filtered based on the applicable permissions.Retrieve aggregated development activity data Results are filtered based on the applicable permissions.voidChange your passwordChange your passwordvoidChange your passwordChange your passwordpostUsersSearch(PostUsersSearchRequest request) Search userspostUsersSearch(ApiRequest<UserSearchRequest> request) Search usersSearch usersSearch users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without noticeSearch users assigned to teamsSearch users assigned to teamsSearch users assigned to teamsSearch users assigned to teamsSearch usersCreate user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.Update the user's Direct Routing Backup settings.putRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId, AgentDirectRoutingBackupSettings body) Update the user's Direct Routing Backup settings.Update the user's max utilization settings.Update the user's max utilization settings.putRoutingUserUtilization(String userId, UtilizationRequest body) Update the user's max utilization settings.putRoutingUserUtilizationWithHttpInfo(String userId, UtilizationRequest body) Update the user's max utilization settings.Update a user's CallForwardingputUserCallforwarding(ApiRequest<CallForwarding> request) Update a user's CallForwardingputUserCallforwarding(String userId, CallForwarding body) Update a user's CallForwardingputUserCallforwardingWithHttpInfo(String userId, CallForwarding body) Update a user's CallForwardingCreate or update a single custom attributes record.Create or update a single custom attributes record.putUserCustomattributes(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) Create or update a single custom attributes record.putUserCustomattributesWithHttpInfo(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) Create or update a single custom attributes record.Update an OutOfOfficeputUserOutofoffice(ApiRequest<OutOfOffice> request) Update an OutOfOfficeputUserOutofoffice(String userId, OutOfOffice body) Update an OutOfOfficeputUserOutofofficeWithHttpInfo(String userId, OutOfOffice body) Update an OutOfOfficeUpdate profile skills for a userputUserProfileskills(ApiRequest<List<String>> request) Update profile skills for a userputUserProfileskills(String userId, List<String> body) Update profile skills for a userputUserProfileskillsWithHttpInfo(String userId, List<String> body) Update profile skills for a userputUserRoles(PutUserRolesRequest request) Sets the user's rolesputUserRoles(ApiRequest<List<String>> request) Sets the user's rolesputUserRoles(String subjectId, List<String> body) Sets the user's rolesputUserRolesWithHttpInfo(String subjectId, List<String> body) Sets the user's rolesUpdate an assigned routing skill's proficiencyputUserRoutingskill(ApiRequest<UserRoutingSkill> request) Update an assigned routing skill's proficiencyputUserRoutingskill(String userId, String skillId, UserRoutingSkill body) Update an assigned routing skill's proficiencyAssign multiple routing skills to a user, replacing any current assignmentsAssign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) Assign multiple routing skills to a user, replacing any current assignmentsputUserRoutingskillWithHttpInfo(String userId, String skillId, UserRoutingSkill body) Update an assigned routing skill's proficiencyUpdate the routing status of a userputUserRoutingstatus(ApiRequest<RoutingStatus> request) Update the routing status of a userputUserRoutingstatus(String userId, RoutingStatus body) Update the routing status of a userputUserRoutingstatusWithHttpInfo(String userId, RoutingStatus body) Update the routing status of a userUpdate a schemaUpdate a schemaputUsersCustomattributesSchema(String schemaId, DataSchema body) Update a schemaputUsersCustomattributesSchemaWithHttpInfo(String schemaId, DataSchema body) Update a schemavoidputUsersStationsMeAssociatedstationStationId(PutUsersStationsMeAssociatedstationStationIdRequest request) Set self associated stationSet self associated stationvoidSet self associated stationSet self associated stationputUserState(PutUserStateRequest request) Update user state information.putUserState(ApiRequest<UserState> request) Update user state information.putUserState(String userId, UserState body) Update user state information.putUserStateWithHttpInfo(String userId, UserState body) Update user state information.voidSet associated stationSet associated stationvoidputUserStationAssociatedstationStationId(String userId, String stationId) Set associated stationputUserStationAssociatedstationStationIdWithHttpInfo(String userId, String stationId) Set associated stationvoidSet default stationSet default stationvoidputUserStationDefaultstationStationId(String userId, String stationId) Set default stationputUserStationDefaultstationStationIdWithHttpInfo(String userId, String stationId) Set default stationputUserVerifier(PutUserVerifierRequest request) Update a verifierputUserVerifier(ApiRequest<UpdateVerifierRequest> request) Update a verifierputUserVerifier(String userId, String verifierId, UpdateVerifierRequest body) Update a verifierputUserVerifierWithHttpInfo(String userId, String verifierId, UpdateVerifierRequest body) Update a verifier
-
Constructor Details
-
UsersApi
public UsersApi() -
UsersApi
-
-
Method Details
-
deleteAnalyticsUsersAggregatesJob
Delete/cancel an async request for user aggregates- Parameters:
jobId- jobId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAnalyticsUsersAggregatesJobWithHttpInfo
public ApiResponse<Void> deleteAnalyticsUsersAggregatesJobWithHttpInfo(String jobId) throws IOException Delete/cancel an async request for user aggregates- Parameters:
jobId- jobId (required)- Throws:
IOException- if the request fails to be processed
-
deleteAnalyticsUsersAggregatesJob
public void deleteAnalyticsUsersAggregatesJob(DeleteAnalyticsUsersAggregatesJobRequest request) throws IOException, ApiException Delete/cancel an async request for user aggregates- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAnalyticsUsersAggregatesJob
public ApiResponse<Void> deleteAnalyticsUsersAggregatesJob(ApiRequest<Void> request) throws IOException Delete/cancel an async request for user aggregates- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteAnalyticsUsersDetailsJob
Delete/cancel an async request- Parameters:
jobId- jobId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAnalyticsUsersDetailsJobWithHttpInfo
public ApiResponse<Void> deleteAnalyticsUsersDetailsJobWithHttpInfo(String jobId) throws IOException Delete/cancel an async request- Parameters:
jobId- jobId (required)- Throws:
IOException- if the request fails to be processed
-
deleteAnalyticsUsersDetailsJob
public void deleteAnalyticsUsersDetailsJob(DeleteAnalyticsUsersDetailsJobRequest request) throws IOException, ApiException Delete/cancel an async request- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAnalyticsUsersDetailsJob
public ApiResponse<Void> deleteAnalyticsUsersDetailsJob(ApiRequest<Void> request) throws IOException Delete/cancel an async request- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteAuthorizationSubjectDivisionRole
public void deleteAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId) throws IOException, ApiException Delete a grant of a role in a division- Parameters:
subjectId- Subject ID (user or group) (required)divisionId- the id of the division of the grant (required)roleId- the id of the role of the grant (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAuthorizationSubjectDivisionRoleWithHttpInfo
public ApiResponse<Void> deleteAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId) throws IOException Delete a grant of a role in a division- Parameters:
subjectId- Subject ID (user or group) (required)divisionId- the id of the division of the grant (required)roleId- the id of the role of the grant (required)- Throws:
IOException- if the request fails to be processed
-
deleteAuthorizationSubjectDivisionRole
public void deleteAuthorizationSubjectDivisionRole(DeleteAuthorizationSubjectDivisionRoleRequest request) throws IOException, ApiException Delete a grant of a role in a division- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteAuthorizationSubjectDivisionRole
public ApiResponse<Void> deleteAuthorizationSubjectDivisionRole(ApiRequest<Void> request) throws IOException Delete a grant of a role in a division- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOExceptionDelete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Throws:
IOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
public void deleteRoutingDirectroutingbackupSettingsMe(DeleteRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingDirectroutingbackupSettingsMe
public ApiResponse<Void> deleteRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public void deleteRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public void deleteRoutingUserDirectroutingbackupSettings(DeleteRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserDirectroutingbackupSettings
public ApiResponse<Void> deleteRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserUtilization
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserUtilizationWithHttpInfo
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteRoutingUserUtilization
public void deleteRoutingUserUtilization(DeleteRoutingUserUtilizationRequest request) throws IOException, ApiException Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteRoutingUserUtilization
Delete the user's max utilization settings and revert to the organization-wide default.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUser
Delete user- Parameters:
userId- User ID (required)- Returns:
- Empty
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserWithHttpInfo
Delete user- Parameters:
userId- User ID (required)- Returns:
- Empty
- Throws:
IOException- if the request fails to be processed
-
deleteUser
Delete user- Parameters:
request- The request object- Returns:
- Empty
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUser
Delete user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserCustomattribute
public void deleteUserCustomattribute(String userId, String schemaId) throws IOException, ApiException Delete a custom attributes record.- Parameters:
userId- user ID (required)schemaId- schemaId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserCustomattributeWithHttpInfo
public ApiResponse<Void> deleteUserCustomattributeWithHttpInfo(String userId, String schemaId) throws IOException Delete a custom attributes record.- Parameters:
userId- user ID (required)schemaId- schemaId (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserCustomattribute
public void deleteUserCustomattribute(DeleteUserCustomattributeRequest request) throws IOException, ApiException Delete a custom attributes record.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserCustomattribute
Delete a custom attributes record.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserExternalidAuthorityNameExternalKey
public void deleteUserExternalidAuthorityNameExternalKey(String userId, String authorityName, String externalKey) throws IOException, ApiException Delete the external identifier for user.- Parameters:
userId- User ID (required)authorityName- Authority Name (required)externalKey- External Key (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserExternalidAuthorityNameExternalKeyWithHttpInfo
public ApiResponse<Void> deleteUserExternalidAuthorityNameExternalKeyWithHttpInfo(String userId, String authorityName, String externalKey) throws IOException Delete the external identifier for user.- Parameters:
userId- User ID (required)authorityName- Authority Name (required)externalKey- External Key (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserExternalidAuthorityNameExternalKey
public void deleteUserExternalidAuthorityNameExternalKey(DeleteUserExternalidAuthorityNameExternalKeyRequest request) throws IOException, ApiException Delete the external identifier for user.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserExternalidAuthorityNameExternalKey
public ApiResponse<Void> deleteUserExternalidAuthorityNameExternalKey(ApiRequest<Void> request) throws IOException Delete the external identifier for user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutinglanguage
public void deleteUserRoutinglanguage(String userId, String languageId) throws IOException, ApiException Remove a routing language from a user- Parameters:
userId- User ID (required)languageId- languageId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutinglanguageWithHttpInfo
public ApiResponse<Void> deleteUserRoutinglanguageWithHttpInfo(String userId, String languageId) throws IOException Remove a routing language from a user- Parameters:
userId- User ID (required)languageId- languageId (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutinglanguage
public void deleteUserRoutinglanguage(DeleteUserRoutinglanguageRequest request) throws IOException, ApiException Remove a routing language from a user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutinglanguage
Remove a routing language from a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutingskill
Remove a routing skill from a user- Parameters:
userId- User ID (required)skillId- skillId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutingskillWithHttpInfo
public ApiResponse<Void> deleteUserRoutingskillWithHttpInfo(String userId, String skillId) throws IOException Remove a routing skill from a user- Parameters:
userId- User ID (required)skillId- skillId (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserRoutingskill
public void deleteUserRoutingskill(DeleteUserRoutingskillRequest request) throws IOException, ApiException Remove a routing skill from a user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserRoutingskill
Remove a routing skill from a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserStationAssociatedstation
Clear associated station- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserStationAssociatedstationWithHttpInfo
public ApiResponse<Void> deleteUserStationAssociatedstationWithHttpInfo(String userId) throws IOException Clear associated station- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserStationAssociatedstation
public void deleteUserStationAssociatedstation(DeleteUserStationAssociatedstationRequest request) throws IOException, ApiException Clear associated station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserStationAssociatedstation
public ApiResponse<Void> deleteUserStationAssociatedstation(ApiRequest<Void> request) throws IOException Clear associated station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserStationDefaultstation
Clear default station- Parameters:
userId- User ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserStationDefaultstationWithHttpInfo
public ApiResponse<Void> deleteUserStationDefaultstationWithHttpInfo(String userId) throws IOException Clear default station- Parameters:
userId- User ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserStationDefaultstation
public void deleteUserStationDefaultstation(DeleteUserStationDefaultstationRequest request) throws IOException, ApiException Clear default station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserStationDefaultstation
public ApiResponse<Void> deleteUserStationDefaultstation(ApiRequest<Void> request) throws IOException Clear default station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUserVerifier
Delete a verifier- Parameters:
userId- User ID (required)verifierId- Verifier ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserVerifierWithHttpInfo
public ApiResponse<Void> deleteUserVerifierWithHttpInfo(String userId, String verifierId) throws IOException Delete a verifier- Parameters:
userId- User ID (required)verifierId- Verifier ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteUserVerifier
Delete a verifier- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUserVerifier
Delete a verifier- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUsersCustomattributesSchema
Delete a schema- Parameters:
schemaId- Schema ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersCustomattributesSchemaWithHttpInfo
public ApiResponse<Void> deleteUsersCustomattributesSchemaWithHttpInfo(String schemaId) throws IOException Delete a schema- Parameters:
schemaId- Schema ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteUsersCustomattributesSchema
public void deleteUsersCustomattributesSchema(DeleteUsersCustomattributesSchemaRequest request) throws IOException, ApiException Delete a schema- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersCustomattributesSchema
public ApiResponse<Void> deleteUsersCustomattributesSchema(ApiRequest<Void> request) throws IOException Delete a schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteUsersStationsMeAssociatedstation
Clear self associated station- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersStationsMeAssociatedstationWithHttpInfo
Clear self associated station- Throws:
IOException- if the request fails to be processed
-
deleteUsersStationsMeAssociatedstation
public void deleteUsersStationsMeAssociatedstation(DeleteUsersStationsMeAssociatedstationRequest request) throws IOException, ApiException Clear self associated station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteUsersStationsMeAssociatedstation
public ApiResponse<Void> deleteUsersStationsMeAssociatedstation(ApiRequest<Void> request) throws IOException Clear self associated station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJob
public AsyncQueryStatus getAnalyticsUsersAggregatesJob(String jobId) throws IOException, ApiException Get status for async query for user aggregates- Parameters:
jobId- jobId (required)- Returns:
- AsyncQueryStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJobWithHttpInfo
public ApiResponse<AsyncQueryStatus> getAnalyticsUsersAggregatesJobWithHttpInfo(String jobId) throws IOException Get status for async query for user aggregates- Parameters:
jobId- jobId (required)- Returns:
- AsyncQueryStatus
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJob
public AsyncQueryStatus getAnalyticsUsersAggregatesJob(GetAnalyticsUsersAggregatesJobRequest request) throws IOException, ApiException Get status for async query for user aggregates- Parameters:
request- The request object- Returns:
- AsyncQueryStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJob
public ApiResponse<AsyncQueryStatus> getAnalyticsUsersAggregatesJob(ApiRequest<Void> request) throws IOException Get status for async query for user aggregates- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJobResults
public UserAsyncAggregateQueryResponse getAnalyticsUsersAggregatesJobResults(String jobId, String cursor) throws IOException, ApiException Fetch a page of results for an async aggregates query- Parameters:
jobId- jobId (required)cursor- Cursor token to retrieve next page (optional)- Returns:
- UserAsyncAggregateQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJobResultsWithHttpInfo
public ApiResponse<UserAsyncAggregateQueryResponse> getAnalyticsUsersAggregatesJobResultsWithHttpInfo(String jobId, String cursor) throws IOException Fetch a page of results for an async aggregates query- Parameters:
jobId- jobId (required)cursor- Cursor token to retrieve next page (optional)- Returns:
- UserAsyncAggregateQueryResponse
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJobResults
public UserAsyncAggregateQueryResponse getAnalyticsUsersAggregatesJobResults(GetAnalyticsUsersAggregatesJobResultsRequest request) throws IOException, ApiException Fetch a page of results for an async aggregates query- Parameters:
request- The request object- Returns:
- UserAsyncAggregateQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersAggregatesJobResults
public ApiResponse<UserAsyncAggregateQueryResponse> getAnalyticsUsersAggregatesJobResults(ApiRequest<Void> request) throws IOException Fetch a page of results for an async aggregates query- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJob
Get status for async query for user details- Parameters:
jobId- jobId (required)- Returns:
- AsyncQueryStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobWithHttpInfo
public ApiResponse<AsyncQueryStatus> getAnalyticsUsersDetailsJobWithHttpInfo(String jobId) throws IOException Get status for async query for user details- Parameters:
jobId- jobId (required)- Returns:
- AsyncQueryStatus
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJob
public AsyncQueryStatus getAnalyticsUsersDetailsJob(GetAnalyticsUsersDetailsJobRequest request) throws IOException, ApiException Get status for async query for user details- Parameters:
request- The request object- Returns:
- AsyncQueryStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJob
public ApiResponse<AsyncQueryStatus> getAnalyticsUsersDetailsJob(ApiRequest<Void> request) throws IOException Get status for async query for user details- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobResults
public AnalyticsUserDetailsAsyncQueryResponse getAnalyticsUsersDetailsJobResults(String jobId, String cursor, Integer pageSize) throws IOException, ApiException Fetch a page of results for an async query- Parameters:
jobId- jobId (required)cursor- Indicates where to resume query results (not required for first page) (optional)pageSize- The desired maximum number of results (optional)- Returns:
- AnalyticsUserDetailsAsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobResultsWithHttpInfo
public ApiResponse<AnalyticsUserDetailsAsyncQueryResponse> getAnalyticsUsersDetailsJobResultsWithHttpInfo(String jobId, String cursor, Integer pageSize) throws IOException Fetch a page of results for an async query- Parameters:
jobId- jobId (required)cursor- Indicates where to resume query results (not required for first page) (optional)pageSize- The desired maximum number of results (optional)- Returns:
- AnalyticsUserDetailsAsyncQueryResponse
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobResults
public AnalyticsUserDetailsAsyncQueryResponse getAnalyticsUsersDetailsJobResults(GetAnalyticsUsersDetailsJobResultsRequest request) throws IOException, ApiException Fetch a page of results for an async query- Parameters:
request- The request object- Returns:
- AnalyticsUserDetailsAsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobResults
public ApiResponse<AnalyticsUserDetailsAsyncQueryResponse> getAnalyticsUsersDetailsJobResults(ApiRequest<Void> request) throws IOException Fetch a page of results for an async query- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobsAvailability
public DataAvailabilityResponse getAnalyticsUsersDetailsJobsAvailability() throws IOException, ApiExceptionLookup the datalake availability date and time- Returns:
- DataAvailabilityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobsAvailabilityWithHttpInfo
public ApiResponse<DataAvailabilityResponse> getAnalyticsUsersDetailsJobsAvailabilityWithHttpInfo() throws IOExceptionLookup the datalake availability date and time- Returns:
- DataAvailabilityResponse
- Throws:
IOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobsAvailability
public DataAvailabilityResponse getAnalyticsUsersDetailsJobsAvailability(GetAnalyticsUsersDetailsJobsAvailabilityRequest request) throws IOException, ApiException Lookup the datalake availability date and time- Parameters:
request- The request object- Returns:
- DataAvailabilityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAnalyticsUsersDetailsJobsAvailability
public ApiResponse<DataAvailabilityResponse> getAnalyticsUsersDetailsJobsAvailability(ApiRequest<Void> request) throws IOException Lookup the datalake availability date and time- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedMe
public List<AuthzDivision> getAuthorizationDivisionspermittedMe(String permission, String name) throws IOException, ApiException Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
permission- The permission string, including the object to access, e.g. routing:queue:view (required)name- Search term to filter by division name (optional)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedMeWithHttpInfo
public ApiResponse<List<AuthzDivision>> getAuthorizationDivisionspermittedMeWithHttpInfo(String permission, String name) throws IOException Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
permission- The permission string, including the object to access, e.g. routing:queue:view (required)name- Search term to filter by division name (optional)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedMe
public List<AuthzDivision> getAuthorizationDivisionspermittedMe(GetAuthorizationDivisionspermittedMeRequest request) throws IOException, ApiException Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedMe
public ApiResponse<List<AuthzDivision>> getAuthorizationDivisionspermittedMe(ApiRequest<Void> request) throws IOException Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedMe
public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedMe(String permission, Integer pageNumber, Integer pageSize) throws IOException, ApiException Returns which divisions the current user has the given permission in.- Parameters:
permission- The permission string, including the object to access, e.g. routing:queue:view (required)pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)- Returns:
- DivsPermittedEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedMeWithHttpInfo
public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedMeWithHttpInfo(String permission, Integer pageNumber, Integer pageSize) throws IOException Returns which divisions the current user has the given permission in.- Parameters:
permission- The permission string, including the object to access, e.g. routing:queue:view (required)pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)- Returns:
- DivsPermittedEntityListing
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedMe
public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedMe(GetAuthorizationDivisionspermittedPagedMeRequest request) throws IOException, ApiException Returns which divisions the current user has the given permission in.- Parameters:
request- The request object- Returns:
- DivsPermittedEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedMe
public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedMe(ApiRequest<Void> request) throws IOException Returns which divisions the current user has the given permission in.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedSubjectId
public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedSubjectId(String subjectId, String permission, Integer pageNumber, Integer pageSize) throws IOException, ApiException Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
subjectId- Subject ID (user or group) (required)permission- The permission string, including the object to access, e.g. routing:queue:view (required)pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)- Returns:
- DivsPermittedEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedSubjectIdWithHttpInfo
public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedSubjectIdWithHttpInfo(String subjectId, String permission, Integer pageNumber, Integer pageSize) throws IOException Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
subjectId- Subject ID (user or group) (required)permission- The permission string, including the object to access, e.g. routing:queue:view (required)pageNumber- Page number (optional, default to 1)pageSize- Page size (optional, default to 25)- Returns:
- DivsPermittedEntityListing
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedSubjectId
public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedSubjectId(GetAuthorizationDivisionspermittedPagedSubjectIdRequest request) throws IOException, ApiException Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- The request object- Returns:
- DivsPermittedEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationDivisionspermittedPagedSubjectId
public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedSubjectId(ApiRequest<Void> request) throws IOException Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationSubject
public AuthzSubject getAuthorizationSubject(String subjectId, Boolean includeDuplicates) throws IOException, ApiException Returns a listing of roles and permissions for a user.- Parameters:
subjectId- Subject ID (user or group) (required)includeDuplicates- Include multiple entries with the same role and division but different subjects (optional, default to false)- Returns:
- AuthzSubject
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationSubjectWithHttpInfo
public ApiResponse<AuthzSubject> getAuthorizationSubjectWithHttpInfo(String subjectId, Boolean includeDuplicates) throws IOException Returns a listing of roles and permissions for a user.- Parameters:
subjectId- Subject ID (user or group) (required)includeDuplicates- Include multiple entries with the same role and division but different subjects (optional, default to false)- Returns:
- AuthzSubject
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationSubject
public AuthzSubject getAuthorizationSubject(GetAuthorizationSubjectRequest request) throws IOException, ApiException Returns a listing of roles and permissions for a user.- Parameters:
request- The request object- Returns:
- AuthzSubject
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationSubject
public ApiResponse<AuthzSubject> getAuthorizationSubject(ApiRequest<Void> request) throws IOException Returns a listing of roles and permissions for a user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationSubjectsMe
public AuthzSubject getAuthorizationSubjectsMe(Boolean includeDuplicates) throws IOException, ApiException Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
includeDuplicates- Include multiple entries with the same role and division but different subjects (optional, default to false)- Returns:
- AuthzSubject
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationSubjectsMeWithHttpInfo
public ApiResponse<AuthzSubject> getAuthorizationSubjectsMeWithHttpInfo(Boolean includeDuplicates) throws IOException Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
includeDuplicates- Include multiple entries with the same role and division but different subjects (optional, default to false)- Returns:
- AuthzSubject
- Throws:
IOException- if the request fails to be processed
-
getAuthorizationSubjectsMe
public AuthzSubject getAuthorizationSubjectsMe(GetAuthorizationSubjectsMeRequest request) throws IOException, ApiException Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
request- The request object- Returns:
- AuthzSubject
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getAuthorizationSubjectsMe
public ApiResponse<AuthzSubject> getAuthorizationSubjectsMe(ApiRequest<Void> request) throws IOException Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getFieldconfig
Deprecated.Fetch field config for an entity type- Parameters:
type- Field type (required)- Returns:
- FieldConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getFieldconfigWithHttpInfo
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
Deprecated.Fetch field config for an entity type- Parameters:
request- The request object- Returns:
- FieldConfig
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getFieldconfig
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
-
getProfilesUsers
public UserProfileEntityListing getProfilesUsers(Integer pageSize, Integer pageNumber, List<String> id, List<String> jid, String sortOrder, List<String> expand, String integrationPresenceSource) throws IOException, ApiException Deprecated.Get a user profile listing This api is deprecated. User /api/v2/users- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)id- id (optional)jid- jid (optional)sortOrder- Ascending or descending sort order (optional, default to ASC)expand- Which fields, if any, to expand (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". (optional)- Returns:
- UserProfileEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getProfilesUsersWithHttpInfo
public ApiResponse<UserProfileEntityListing> getProfilesUsersWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jid, String sortOrder, List<String> expand, String integrationPresenceSource) throws IOException Deprecated.Get a user profile listing This api is deprecated. User /api/v2/users- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)id- id (optional)jid- jid (optional)sortOrder- Ascending or descending sort order (optional, default to ASC)expand- Which fields, if any, to expand (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". (optional)- Returns:
- UserProfileEntityListing
- Throws:
IOException- if the request fails to be processed
-
getProfilesUsers
public UserProfileEntityListing getProfilesUsers(GetProfilesUsersRequest request) throws IOException, ApiException Deprecated.Get a user profile listing This api is deprecated. User /api/v2/users- Parameters:
request- The request object- Returns:
- UserProfileEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getProfilesUsers
public ApiResponse<UserProfileEntityListing> getProfilesUsers(ApiRequest<Void> request) throws IOException Deprecated.Get a user profile listing This api is deprecated. User /api/v2/users- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe() throws IOException, ApiExceptionGet the user's Direct Routing Backup settings.- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMeWithHttpInfo() throws IOExceptionGet the user's Direct Routing Backup settings.- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings getRoutingDirectroutingbackupSettingsMe(GetRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingDirectroutingbackupSettingsMe
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingDirectroutingbackupSettingsMe(ApiRequest<Void> request) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(String userId) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings getRoutingUserDirectroutingbackupSettings(GetRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserDirectroutingbackupSettings
public ApiResponse<AgentDirectRoutingBackupSettings> getRoutingUserDirectroutingbackupSettings(ApiRequest<Void> request) throws IOException Get the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserUtilization
public AgentMaxUtilizationResponse getRoutingUserUtilization(String userId) throws IOException, ApiException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
userId- User ID (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserUtilizationWithHttpInfo
public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilizationWithHttpInfo(String userId) throws IOException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
userId- User ID (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
getRoutingUserUtilization
public AgentMaxUtilizationResponse getRoutingUserUtilization(GetRoutingUserUtilizationRequest request) throws IOException, ApiException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
request- The request object- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getRoutingUserUtilization
public ApiResponse<AgentMaxUtilizationResponse> getRoutingUserUtilization(ApiRequest<Void> request) throws IOException Get the user's max utilization settings. If not configured, the organization-wide default is returned.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUser
public User getUser(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException, ApiException Get user.- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for a user instead of their default. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100 (optional)state- Search for a user with this state (optional, default to active)- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserWithHttpInfo
public ApiResponse<User> getUserWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException Get user.- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for a user instead of their default. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100 (optional)state- Search for a user with this state (optional, default to active)- Returns:
- User
- Throws:
IOException- if the request fails to be processed
-
getUser
Get user.- Parameters:
request- The request object- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUser
Get user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserAdjacents
public Adjacents getUserAdjacents(String userId, List<String> expand) throws IOException, ApiException Get adjacents- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- Adjacents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserAdjacentsWithHttpInfo
public ApiResponse<Adjacents> getUserAdjacentsWithHttpInfo(String userId, List<String> expand) throws IOException Get adjacents- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- Adjacents
- Throws:
IOException- if the request fails to be processed
-
getUserAdjacents
Get adjacents- Parameters:
request- The request object- Returns:
- Adjacents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserAdjacents
Get adjacents- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserCallforwarding
Get a user's CallForwarding- Parameters:
userId- User ID (required)- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCallforwardingWithHttpInfo
public ApiResponse<CallForwarding> getUserCallforwardingWithHttpInfo(String userId) throws IOException Get a user's CallForwarding- Parameters:
userId- User ID (required)- Returns:
- CallForwarding
- Throws:
IOException- if the request fails to be processed
-
getUserCallforwarding
public CallForwarding getUserCallforwarding(GetUserCallforwardingRequest request) throws IOException, ApiException Get a user's CallForwarding- Parameters:
request- The request object- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCallforwarding
public ApiResponse<CallForwarding> getUserCallforwarding(ApiRequest<Void> request) throws IOException Get a user's CallForwarding- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserCustomattribute
public UserCustomAttributes getUserCustomattribute(String userId, String schemaId) throws IOException, ApiException Get custom attributes by schema id- Parameters:
userId- user ID (required)schemaId- schemaId (required)- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCustomattributeWithHttpInfo
public ApiResponse<UserCustomAttributes> getUserCustomattributeWithHttpInfo(String userId, String schemaId) throws IOException Get custom attributes by schema id- Parameters:
userId- user ID (required)schemaId- schemaId (required)- Returns:
- UserCustomAttributes
- Throws:
IOException- if the request fails to be processed
-
getUserCustomattribute
public UserCustomAttributes getUserCustomattribute(GetUserCustomattributeRequest request) throws IOException, ApiException Get custom attributes by schema id- Parameters:
request- The request object- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCustomattribute
public ApiResponse<UserCustomAttributes> getUserCustomattribute(ApiRequest<Void> request) throws IOException Get custom attributes by schema id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserCustomattributesBulk
public List<Object> getUserCustomattributesBulk(String userId, List<String> schemaIds) throws IOException, ApiException Get multiple custom attributes records by schema ids- Parameters:
userId- user ID (required)schemaIds- (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCustomattributesBulkWithHttpInfo
public ApiResponse<List<Object>> getUserCustomattributesBulkWithHttpInfo(String userId, List<String> schemaIds) throws IOException Get multiple custom attributes records by schema ids- Parameters:
userId- user ID (required)schemaIds- (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getUserCustomattributesBulk
public List<Object> getUserCustomattributesBulk(GetUserCustomattributesBulkRequest request) throws IOException, ApiException Get multiple custom attributes records by schema ids- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserCustomattributesBulk
public ApiResponse<List<Object>> getUserCustomattributesBulk(ApiRequest<Void> request) throws IOException Get multiple custom attributes records by schema ids- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserDirectreports
public List<User> getUserDirectreports(String userId, List<String> expand) throws IOException, ApiException Get direct reports- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserDirectreportsWithHttpInfo
public ApiResponse<List<User>> getUserDirectreportsWithHttpInfo(String userId, List<String> expand) throws IOException Get direct reports- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getUserDirectreports
public List<User> getUserDirectreports(GetUserDirectreportsRequest request) throws IOException, ApiException Get direct reports- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserDirectreports
Get direct reports- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserExternalid
public List<UserExternalIdentifier> getUserExternalid(String userId) throws IOException, ApiException Get the external identifiers for a user.- Parameters:
userId- User ID (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserExternalidWithHttpInfo
public ApiResponse<List<UserExternalIdentifier>> getUserExternalidWithHttpInfo(String userId) throws IOException Get the external identifiers for a user.- Parameters:
userId- User ID (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getUserExternalid
public List<UserExternalIdentifier> getUserExternalid(GetUserExternalidRequest request) throws IOException, ApiException Get the external identifiers for a user.- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserExternalid
public ApiResponse<List<UserExternalIdentifier>> getUserExternalid(ApiRequest<Void> request) throws IOException Get the external identifiers for a user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserExternalidAuthorityName
public UserExternalIdentifier getUserExternalidAuthorityName(String userId, String authorityName) throws IOException, ApiException Get the external identifier of user for an authority. Authority name and external key are case sensitive.- Parameters:
userId- User ID (required)authorityName- Authority Name (required)- Returns:
- UserExternalIdentifier
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserExternalidAuthorityNameWithHttpInfo
public ApiResponse<UserExternalIdentifier> getUserExternalidAuthorityNameWithHttpInfo(String userId, String authorityName) throws IOException Get the external identifier of user for an authority. Authority name and external key are case sensitive.- Parameters:
userId- User ID (required)authorityName- Authority Name (required)- Returns:
- UserExternalIdentifier
- Throws:
IOException- if the request fails to be processed
-
getUserExternalidAuthorityName
public UserExternalIdentifier getUserExternalidAuthorityName(GetUserExternalidAuthorityNameRequest request) throws IOException, ApiException Get the external identifier of user for an authority. Authority name and external key are case sensitive.- Parameters:
request- The request object- Returns:
- UserExternalIdentifier
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserExternalidAuthorityName
public ApiResponse<UserExternalIdentifier> getUserExternalidAuthorityName(ApiRequest<Void> request) throws IOException Get the external identifier of user for an authority. Authority name and external key are case sensitive.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserFavorites
public UserEntityListing getUserFavorites(String userId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException, ApiException Deprecated.Deprecated; will be revived with new contract- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Sort order (optional, default to ASC)expand- Which fields, if any, to expand (optional)- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserFavoritesWithHttpInfo
public ApiResponse<UserEntityListing> getUserFavoritesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder, List<String> expand) throws IOException Deprecated.Deprecated; will be revived with new contract- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- 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
-
getUserFavorites
public UserEntityListing getUserFavorites(GetUserFavoritesRequest request) throws IOException, ApiException Deprecated.Deprecated; will be revived with new contract- Parameters:
request- The request object- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserFavorites
Deprecated.Deprecated; will be revived with new contract- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserGeolocation
public Geolocation getUserGeolocation(String userId, String clientId) throws IOException, ApiException Get a user's Geolocation- Parameters:
userId- user Id (required)clientId- client Id (required)- Returns:
- Geolocation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserGeolocationWithHttpInfo
public ApiResponse<Geolocation> getUserGeolocationWithHttpInfo(String userId, String clientId) throws IOException Get a user's Geolocation- Parameters:
userId- user Id (required)clientId- client Id (required)- Returns:
- Geolocation
- Throws:
IOException- if the request fails to be processed
-
getUserGeolocation
public Geolocation getUserGeolocation(GetUserGeolocationRequest request) throws IOException, ApiException Get a user's Geolocation- Parameters:
request- The request object- Returns:
- Geolocation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserGeolocation
Get a user's Geolocation- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserOutofoffice
Get a OutOfOffice- Parameters:
userId- User ID (required)- Returns:
- OutOfOffice
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserOutofofficeWithHttpInfo
Get a OutOfOffice- Parameters:
userId- User ID (required)- Returns:
- OutOfOffice
- Throws:
IOException- if the request fails to be processed
-
getUserOutofoffice
public OutOfOffice getUserOutofoffice(GetUserOutofofficeRequest request) throws IOException, ApiException Get a OutOfOffice- Parameters:
request- The request object- Returns:
- OutOfOffice
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserOutofoffice
Get a OutOfOffice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserProfile
public UserProfile getUserProfile(String userId, List<String> expand, String integrationPresenceSource) throws IOException, ApiException Deprecated.Get user profile This api has been deprecated. Use api/v2/users instead- Parameters:
userId- userId (required)expand- Which fields, if any, to expand (optional)integrationPresenceSource- Gets an integration presence for a user instead of their default. (optional)- Returns:
- UserProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserProfileWithHttpInfo
public ApiResponse<UserProfile> getUserProfileWithHttpInfo(String userId, List<String> expand, String integrationPresenceSource) throws IOException Deprecated.Get user profile This api has been deprecated. Use api/v2/users instead- Parameters:
userId- userId (required)expand- Which fields, if any, to expand (optional)integrationPresenceSource- Gets an integration presence for a user instead of their default. (optional)- Returns:
- UserProfile
- Throws:
IOException- if the request fails to be processed
-
getUserProfile
Deprecated.Get user profile This api has been deprecated. Use api/v2/users instead- Parameters:
request- The request object- Returns:
- UserProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserProfile
Deprecated.Get user profile This api has been deprecated. Use api/v2/users instead- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserProfileskills
List profile skills for a user- Parameters:
userId- User ID (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserProfileskillsWithHttpInfo
List profile skills for a user- Parameters:
userId- User ID (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getUserProfileskills
public List<String> getUserProfileskills(GetUserProfileskillsRequest request) throws IOException, ApiException List profile skills for a user- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserProfileskills
List profile skills for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserQueues
public UserQueueEntityListing getUserQueues(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException, ApiException Get queues for user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)joined- Is joined to the queue (optional, default to true)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserQueuesWithHttpInfo
public ApiResponse<UserQueueEntityListing> getUserQueuesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, Boolean joined, List<String> divisionId) throws IOException Get queues for user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)joined- Is joined to the queue (optional, default to true)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserQueues
public UserQueueEntityListing getUserQueues(GetUserQueuesRequest request) throws IOException, ApiException Get queues for user- Parameters:
request- The request object- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserQueues
public ApiResponse<UserQueueEntityListing> getUserQueues(ApiRequest<Void> request) throws IOException Get queues for user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoles
Returns a listing of roles and permissions for a user.- Parameters:
subjectId- User ID (required)- Returns:
- UserAuthorization
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRolesWithHttpInfo
Returns a listing of roles and permissions for a user.- Parameters:
subjectId- User ID (required)- Returns:
- UserAuthorization
- Throws:
IOException- if the request fails to be processed
-
getUserRoles
Returns a listing of roles and permissions for a user.- Parameters:
request- The request object- Returns:
- UserAuthorization
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoles
Returns a listing of roles and permissions for a user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoutinglanguages
public UserLanguageEntityListing getUserRoutinglanguages(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException List routing languages assigned to a user- Parameters:
userId- User 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)- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutinglanguagesWithHttpInfo
public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguagesWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException List routing languages assigned to a user- Parameters:
userId- User 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)- Returns:
- UserLanguageEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserRoutinglanguages
public UserLanguageEntityListing getUserRoutinglanguages(GetUserRoutinglanguagesRequest request) throws IOException, ApiException List routing languages assigned to a user- Parameters:
request- The request object- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutinglanguages
public ApiResponse<UserLanguageEntityListing> getUserRoutinglanguages(ApiRequest<Void> request) throws IOException List routing languages assigned to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingskills
public UserSkillEntityListing getUserRoutingskills(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException, ApiException List routing skills assigned to a user- Parameters:
userId- User 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)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingskillsWithHttpInfo
public ApiResponse<UserSkillEntityListing> getUserRoutingskillsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber, String sortOrder) throws IOException List routing skills assigned to a user- Parameters:
userId- User 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)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingskills
public UserSkillEntityListing getUserRoutingskills(GetUserRoutingskillsRequest request) throws IOException, ApiException List routing skills assigned to a user- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingskills
public ApiResponse<UserSkillEntityListing> getUserRoutingskills(ApiRequest<Void> request) throws IOException List routing skills assigned to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingstatus
Fetch the routing status of a user- Parameters:
userId- User ID (required)- Returns:
- RoutingStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingstatusWithHttpInfo
public ApiResponse<RoutingStatus> getUserRoutingstatusWithHttpInfo(String userId) throws IOException Fetch the routing status of a user- Parameters:
userId- User ID (required)- Returns:
- RoutingStatus
- Throws:
IOException- if the request fails to be processed
-
getUserRoutingstatus
public RoutingStatus getUserRoutingstatus(GetUserRoutingstatusRequest request) throws IOException, ApiException Fetch the routing status of a user- Parameters:
request- The request object- Returns:
- RoutingStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserRoutingstatus
Fetch the routing status of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserSkillgroups
public UserSkillGroupEntityListing getUserSkillgroups(String userId, Integer pageSize, String after, String before) throws IOException, ApiException Get skill groups for a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next page (optional)before- The cursor that points to the previous page (optional)- Returns:
- UserSkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSkillgroupsWithHttpInfo
public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroupsWithHttpInfo(String userId, Integer pageSize, String after, String before) throws IOException Get skill groups for a user- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)after- The cursor that points to the next page (optional)before- The cursor that points to the previous page (optional)- Returns:
- UserSkillGroupEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserSkillgroups
public UserSkillGroupEntityListing getUserSkillgroups(GetUserSkillgroupsRequest request) throws IOException, ApiException Get skill groups for a user- Parameters:
request- The request object- Returns:
- UserSkillGroupEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSkillgroups
public ApiResponse<UserSkillGroupEntityListing> getUserSkillgroups(ApiRequest<Void> request) throws IOException Get skill groups for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserState
Get user state information.- Parameters:
userId- User ID (required)- Returns:
- UserState
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserStateWithHttpInfo
Get user state information.- Parameters:
userId- User ID (required)- Returns:
- UserState
- Throws:
IOException- if the request fails to be processed
-
getUserState
Get user state information.- Parameters:
request- The request object- Returns:
- UserState
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserState
Get user state information.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserStation
Get station information for user- Parameters:
userId- User ID (required)- Returns:
- UserStations
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserStationWithHttpInfo
Get station information for user- Parameters:
userId- User ID (required)- Returns:
- UserStations
- Throws:
IOException- if the request fails to be processed
-
getUserStation
Get station information for user- Parameters:
request- The request object- Returns:
- UserStations
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserStation
Get station information for user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserSuperiors
public List<User> getUserSuperiors(String userId, List<String> expand) throws IOException, ApiException Get superiors- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSuperiorsWithHttpInfo
public ApiResponse<List<User>> getUserSuperiorsWithHttpInfo(String userId, List<String> expand) throws IOException Get superiors- Parameters:
userId- User ID (required)expand- Which fields, if any, to expand (optional)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
getUserSuperiors
public List<User> getUserSuperiors(GetUserSuperiorsRequest request) throws IOException, ApiException Get superiors- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserSuperiors
Get superiors- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserTrustors
public TrustorEntityListing getUserTrustors(String userId, Integer pageSize, Integer pageNumber) throws IOException, ApiException List the organizations that have authorized/trusted the user.- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- TrustorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserTrustorsWithHttpInfo
public ApiResponse<TrustorEntityListing> getUserTrustorsWithHttpInfo(String userId, Integer pageSize, Integer pageNumber) throws IOException List the organizations that have authorized/trusted the user.- Parameters:
userId- User ID (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- TrustorEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserTrustors
public TrustorEntityListing getUserTrustors(GetUserTrustorsRequest request) throws IOException, ApiException List the organizations that have authorized/trusted the user.- Parameters:
request- The request object- Returns:
- TrustorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserTrustors
public ApiResponse<TrustorEntityListing> getUserTrustors(ApiRequest<Void> request) throws IOException List the organizations that have authorized/trusted the user.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUserVerifiers
Get a list of verifiers- Parameters:
userId- User ID (required)- Returns:
- VerifierEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserVerifiersWithHttpInfo
public ApiResponse<VerifierEntityListing> getUserVerifiersWithHttpInfo(String userId) throws IOException Get a list of verifiers- Parameters:
userId- User ID (required)- Returns:
- VerifierEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUserVerifiers
public VerifierEntityListing getUserVerifiers(GetUserVerifiersRequest request) throws IOException, ApiException Get a list of verifiers- Parameters:
request- The request object- Returns:
- VerifierEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUserVerifiers
public ApiResponse<VerifierEntityListing> getUserVerifiers(ApiRequest<Void> request) throws IOException Get a list of verifiers- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsers
public UserEntityListing getUsers(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException, ApiException Get the list of available users.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)id- A list of user IDs to fetch by bulk (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)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5 (optional)state- Only list users of this state (optional, default to active)- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersWithHttpInfo
public ApiResponse<UserEntityListing> getUsersWithHttpInfo(Integer pageSize, Integer pageNumber, List<String> id, List<String> jabberId, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException Get the list of available users.- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)id- A list of user IDs to fetch by bulk (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)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5 (optional)state- Only list users of this state (optional, default to active)- Returns:
- UserEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUsers
Get the list of available users.- Parameters:
request- The request object- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsers
Get the list of available users.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersChatsMe
public ChatItemCursorListing getUsersChatsMe(Boolean excludeClosed, Boolean includePresence, Boolean includeRoomOwners, String after) throws IOException, ApiException Get chats for a user- Parameters:
excludeClosed- Whether or not to exclude closed chats (optional)includePresence- Whether or not to include user presence (optional)includeRoomOwners- Whether or not to include room owners (optional)after- The key to start after (optional)- Returns:
- ChatItemCursorListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersChatsMeWithHttpInfo
public ApiResponse<ChatItemCursorListing> getUsersChatsMeWithHttpInfo(Boolean excludeClosed, Boolean includePresence, Boolean includeRoomOwners, String after) throws IOException Get chats for a user- Parameters:
excludeClosed- Whether or not to exclude closed chats (optional)includePresence- Whether or not to include user presence (optional)includeRoomOwners- Whether or not to include room owners (optional)after- The key to start after (optional)- Returns:
- ChatItemCursorListing
- Throws:
IOException- if the request fails to be processed
-
getUsersChatsMe
public ChatItemCursorListing getUsersChatsMe(GetUsersChatsMeRequest request) throws IOException, ApiException Get chats for a user- Parameters:
request- The request object- Returns:
- ChatItemCursorListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersChatsMe
public ApiResponse<ChatItemCursorListing> getUsersChatsMe(ApiRequest<Void> request) throws IOException Get chats for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchema
Get a schema- Parameters:
schemaId- Schema ID (required)- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemaWithHttpInfo
public ApiResponse<DataSchema> getUsersCustomattributesSchemaWithHttpInfo(String schemaId) throws IOException Get a schema- Parameters:
schemaId- Schema ID (required)- Returns:
- DataSchema
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchema
public DataSchema getUsersCustomattributesSchema(GetUsersCustomattributesSchemaRequest request) throws IOException, ApiException Get a schema- Parameters:
request- The request object- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchema
public ApiResponse<DataSchema> getUsersCustomattributesSchema(ApiRequest<Void> request) throws IOException Get a schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersion
public DataSchema getUsersCustomattributesSchemaVersion(String schemaId, String versionId) throws IOException, ApiException Get a specific version of a schema- Parameters:
schemaId- Schema ID (required)versionId- Schema version (required)- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersionWithHttpInfo
public ApiResponse<DataSchema> getUsersCustomattributesSchemaVersionWithHttpInfo(String schemaId, String versionId) throws IOException Get a specific version of a schema- Parameters:
schemaId- Schema ID (required)versionId- Schema version (required)- Returns:
- DataSchema
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersion
public DataSchema getUsersCustomattributesSchemaVersion(GetUsersCustomattributesSchemaVersionRequest request) throws IOException, ApiException Get a specific version of a schema- Parameters:
request- The request object- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersion
public ApiResponse<DataSchema> getUsersCustomattributesSchemaVersion(ApiRequest<Void> request) throws IOException Get a specific version of a schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersions
public DataSchemaListing getUsersCustomattributesSchemaVersions(String schemaId) throws IOException, ApiException Get all versions of a user schema- Parameters:
schemaId- Schema ID (required)- Returns:
- DataSchemaListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersionsWithHttpInfo
public ApiResponse<DataSchemaListing> getUsersCustomattributesSchemaVersionsWithHttpInfo(String schemaId) throws IOException Get all versions of a user schema- Parameters:
schemaId- Schema ID (required)- Returns:
- DataSchemaListing
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersions
public DataSchemaListing getUsersCustomattributesSchemaVersions(GetUsersCustomattributesSchemaVersionsRequest request) throws IOException, ApiException Get all versions of a user schema- Parameters:
request- The request object- Returns:
- DataSchemaListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemaVersions
public ApiResponse<DataSchemaListing> getUsersCustomattributesSchemaVersions(ApiRequest<Void> request) throws IOException Get all versions of a user schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemas
Get a list of schemas.- Returns:
- DataSchemaListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasWithHttpInfo
public ApiResponse<DataSchemaListing> getUsersCustomattributesSchemasWithHttpInfo() throws IOExceptionGet a list of schemas.- Returns:
- DataSchemaListing
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemas
public DataSchemaListing getUsersCustomattributesSchemas(GetUsersCustomattributesSchemasRequest request) throws IOException, ApiException Get a list of schemas.- Parameters:
request- The request object- Returns:
- DataSchemaListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemas
public ApiResponse<DataSchemaListing> getUsersCustomattributesSchemas(ApiRequest<Void> request) throws IOException Get a list of schemas.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretype
public Coretype getUsersCustomattributesSchemasCoretype(String coreTypeName) throws IOException, ApiException Get the core types from which all schemas are built.- Parameters:
coreTypeName- Name of the core type (required)- Returns:
- Coretype
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretypeWithHttpInfo
public ApiResponse<Coretype> getUsersCustomattributesSchemasCoretypeWithHttpInfo(String coreTypeName) throws IOException Get the core types from which all schemas are built.- Parameters:
coreTypeName- Name of the core type (required)- Returns:
- Coretype
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretype
public Coretype getUsersCustomattributesSchemasCoretype(GetUsersCustomattributesSchemasCoretypeRequest request) throws IOException, ApiException Get the core types from which all schemas are built.- Parameters:
request- The request object- Returns:
- Coretype
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretype
public ApiResponse<Coretype> getUsersCustomattributesSchemasCoretype(ApiRequest<Void> request) throws IOException Get the core types from which all schemas are built.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretypes
Get the list of core types enabled for a specific namespace.- Returns:
- CoretypeListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretypesWithHttpInfo
public ApiResponse<CoretypeListing> getUsersCustomattributesSchemasCoretypesWithHttpInfo() throws IOExceptionGet the list of core types enabled for a specific namespace.- Returns:
- CoretypeListing
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretypes
public CoretypeListing getUsersCustomattributesSchemasCoretypes(GetUsersCustomattributesSchemasCoretypesRequest request) throws IOException, ApiException Get the list of core types enabled for a specific namespace.- Parameters:
request- The request object- Returns:
- CoretypeListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasCoretypes
public ApiResponse<CoretypeListing> getUsersCustomattributesSchemasCoretypes(ApiRequest<Void> request) throws IOException Get the list of core types enabled for a specific namespace.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasLimits
public SchemaQuantityLimits getUsersCustomattributesSchemasLimits() throws IOException, ApiExceptionGet quantitative limits on schemas- Returns:
- SchemaQuantityLimits
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasLimitsWithHttpInfo
public ApiResponse<SchemaQuantityLimits> getUsersCustomattributesSchemasLimitsWithHttpInfo() throws IOExceptionGet quantitative limits on schemas- Returns:
- SchemaQuantityLimits
- Throws:
IOException- if the request fails to be processed
-
getUsersCustomattributesSchemasLimits
public SchemaQuantityLimits getUsersCustomattributesSchemasLimits(GetUsersCustomattributesSchemasLimitsRequest request) throws IOException, ApiException Get quantitative limits on schemas- Parameters:
request- The request object- Returns:
- SchemaQuantityLimits
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersCustomattributesSchemasLimits
public ApiResponse<SchemaQuantityLimits> getUsersCustomattributesSchemasLimits(ApiRequest<Void> request) throws IOException Get quantitative limits on schemas- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivities
public DevelopmentActivityListing getUsersDevelopmentActivities(List<String> userId, String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) throws IOException, ApiException Get list of Development Activities Either moduleId or userId is required. Results are filtered based on the applicable permissions.- Parameters:
userId- Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId. (optional)moduleId- Specifies the ID of the learning module. (optional)interval- Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)completionInterval- Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)overdue- Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional, default to Any)pass- Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned (optional, default to Any)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional, default to Desc)types- Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional)statuses- Specifies the activity statuses to filter by (optional)relationship- Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional)- Returns:
- DevelopmentActivityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivitiesWithHttpInfo
public ApiResponse<DevelopmentActivityListing> getUsersDevelopmentActivitiesWithHttpInfo(List<String> userId, String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) throws IOException Get list of Development Activities Either moduleId or userId is required. Results are filtered based on the applicable permissions.- Parameters:
userId- Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId. (optional)moduleId- Specifies the ID of the learning module. (optional)interval- Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)completionInterval- Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)overdue- Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional, default to Any)pass- Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned (optional, default to Any)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional, default to Desc)types- Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional)statuses- Specifies the activity statuses to filter by (optional)relationship- Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional)- Returns:
- DevelopmentActivityListing
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivities
public DevelopmentActivityListing getUsersDevelopmentActivities(GetUsersDevelopmentActivitiesRequest request) throws IOException, ApiException Get list of Development Activities Either moduleId or userId is required. Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- DevelopmentActivityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivities
public ApiResponse<DevelopmentActivityListing> getUsersDevelopmentActivities(ApiRequest<Void> request) throws IOException Get list of Development Activities Either moduleId or userId is required. Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivitiesMe
public DevelopmentActivityListing getUsersDevelopmentActivitiesMe(String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) throws IOException, ApiException Get list of Development Activities for current user Results are filtered based on the applicable permissions.- Parameters:
moduleId- Specifies the ID of the learning module. (optional)interval- Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)completionInterval- Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)overdue- Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional, default to Any)pass- Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned (optional, default to Any)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional, default to Desc)types- Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional)statuses- Specifies the activity statuses to filter by (optional)relationship- Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional)- Returns:
- DevelopmentActivityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivitiesMeWithHttpInfo
public ApiResponse<DevelopmentActivityListing> getUsersDevelopmentActivitiesMeWithHttpInfo(String moduleId, String interval, String completionInterval, String overdue, String pass, Integer pageSize, Integer pageNumber, String sortOrder, List<String> types, List<String> statuses, List<String> relationship) throws IOException Get list of Development Activities for current user Results are filtered based on the applicable permissions.- Parameters:
moduleId- Specifies the ID of the learning module. (optional)interval- Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)completionInterval- Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)overdue- Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional, default to Any)pass- Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") activities are returned. If pass is \"Any\" or if the pass parameter is not supplied, all activities are returned (optional, default to Any)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortOrder- Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional, default to Desc)types- Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional)statuses- Specifies the activity statuses to filter by (optional)relationship- Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional)- Returns:
- DevelopmentActivityListing
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivitiesMe
public DevelopmentActivityListing getUsersDevelopmentActivitiesMe(GetUsersDevelopmentActivitiesMeRequest request) throws IOException, ApiException Get list of Development Activities for current user Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- DevelopmentActivityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivitiesMe
public ApiResponse<DevelopmentActivityListing> getUsersDevelopmentActivitiesMe(ApiRequest<Void> request) throws IOException Get list of Development Activities for current user Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivity
public DevelopmentActivity getUsersDevelopmentActivity(String activityId, String type) throws IOException, ApiException Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.- Parameters:
activityId- Specifies the activity ID, maps to either assignment or appointment ID (required)type- Specifies the activity type. Informational, AssessedContent and Assessment are deprecated (required)- Returns:
- DevelopmentActivity
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivityWithHttpInfo
public ApiResponse<DevelopmentActivity> getUsersDevelopmentActivityWithHttpInfo(String activityId, String type) throws IOException Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.- Parameters:
activityId- Specifies the activity ID, maps to either assignment or appointment ID (required)type- Specifies the activity type. Informational, AssessedContent and Assessment are deprecated (required)- Returns:
- DevelopmentActivity
- Throws:
IOException- if the request fails to be processed
-
getUsersDevelopmentActivity
public DevelopmentActivity getUsersDevelopmentActivity(GetUsersDevelopmentActivityRequest request) throws IOException, ApiException Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.- Parameters:
request- The request object- Returns:
- DevelopmentActivity
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersDevelopmentActivity
public ApiResponse<DevelopmentActivity> getUsersDevelopmentActivity(ApiRequest<Void> request) throws IOException Get a Development Activity Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersExternalidAuthorityNameExternalKey
public User getUsersExternalidAuthorityNameExternalKey(String authorityName, String externalKey, List<String> expand) throws IOException, ApiException Get the user associated with external identifier. Authority name and external key are case sensitive.- Parameters:
authorityName- Authority Name (required)externalKey- External Key (required)expand- Which fields, if any, to expand (optional)- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersExternalidAuthorityNameExternalKeyWithHttpInfo
public ApiResponse<User> getUsersExternalidAuthorityNameExternalKeyWithHttpInfo(String authorityName, String externalKey, List<String> expand) throws IOException Get the user associated with external identifier. Authority name and external key are case sensitive.- Parameters:
authorityName- Authority Name (required)externalKey- External Key (required)expand- Which fields, if any, to expand (optional)- Returns:
- User
- Throws:
IOException- if the request fails to be processed
-
getUsersExternalidAuthorityNameExternalKey
public User getUsersExternalidAuthorityNameExternalKey(GetUsersExternalidAuthorityNameExternalKeyRequest request) throws IOException, ApiException Get the user associated with external identifier. Authority name and external key are case sensitive.- Parameters:
request- The request object- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersExternalidAuthorityNameExternalKey
public ApiResponse<User> getUsersExternalidAuthorityNameExternalKey(ApiRequest<Void> request) throws IOException Get the user associated with external identifier. Authority name and external key are case sensitive.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersMe
public UserMe getUsersMe(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds) throws IOException, ApiException Get current user details. This request is not valid when using the Client Credentials OAuth grant.- Parameters:
expand- Which fields, if any, to expand. (optional)integrationPresenceSource- Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\". (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100 (optional)- Returns:
- UserMe
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersMeWithHttpInfo
public ApiResponse<UserMe> getUsersMeWithHttpInfo(List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds) throws IOException Get current user details. This request is not valid when using the Client Credentials OAuth grant.- Parameters:
expand- Which fields, if any, to expand. (optional)integrationPresenceSource- Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\". (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100 (optional)- Returns:
- UserMe
- Throws:
IOException- if the request fails to be processed
-
getUsersMe
Get current user details. This request is not valid when using the Client Credentials OAuth grant.- Parameters:
request- The request object- Returns:
- UserMe
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersMe
Get current user details. This request is not valid when using the Client Credentials OAuth grant.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersQuery
public UserCursorEntityListing getUsersQuery(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException, ApiException Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required- Parameters:
cursor- Cursor token to retrieve next page (optional)pageSize- Page size (optional, default to 25)sortOrder- Ascending or descending sort order (optional, default to ASC)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5 (optional)state- Only list users of this state (optional, default to active)- Returns:
- UserCursorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersQueryWithHttpInfo
public ApiResponse<UserCursorEntityListing> getUsersQueryWithHttpInfo(String cursor, Integer pageSize, String sortOrder, List<String> expand, String integrationPresenceSource, List<String> userCustomAttributeSchemaIds, String state) throws IOException Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required- Parameters:
cursor- Cursor token to retrieve next page (optional)pageSize- Page size (optional, default to 25)sortOrder- Ascending or descending sort order (optional, default to ASC)expand- Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional)integrationPresenceSource- Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100. (optional)userCustomAttributeSchemaIds- Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5 (optional)state- Only list users of this state (optional, default to active)- Returns:
- UserCursorEntityListing
- Throws:
IOException- if the request fails to be processed
-
getUsersQuery
public UserCursorEntityListing getUsersQuery(GetUsersQueryRequest request) throws IOException, ApiException Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required- Parameters:
request- The request object- Returns:
- UserCursorEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersQuery
public ApiResponse<UserCursorEntityListing> getUsersQuery(ApiRequest<Void> request) throws IOException Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getUsersSearch
public UsersSearchResponse getUsersSearch(String q64, List<String> expand, String integrationPresenceSource) throws IOException, ApiException Search users using the q64 value returned from a previous search- Parameters:
q64- q64 (required)expand- expand (optional)integrationPresenceSource- integrationPresenceSource (optional)- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersSearchWithHttpInfo
public ApiResponse<UsersSearchResponse> getUsersSearchWithHttpInfo(String q64, List<String> expand, String integrationPresenceSource) throws IOException Search users using the q64 value returned from a previous search- Parameters:
q64- q64 (required)expand- expand (optional)integrationPresenceSource- integrationPresenceSource (optional)- Returns:
- UsersSearchResponse
- Throws:
IOException- if the request fails to be processed
-
getUsersSearch
public UsersSearchResponse getUsersSearch(GetUsersSearchRequest request) throws IOException, ApiException Search users using the q64 value returned from a previous search- Parameters:
request- The request object- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersSearch
Search users 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
-
getUsersStationsMe
Get station information for self- Returns:
- UserStations
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersStationsMeWithHttpInfo
Get station information for self- Returns:
- UserStations
- Throws:
IOException- if the request fails to be processed
-
getUsersStationsMe
public UserStations getUsersStationsMe(GetUsersStationsMeRequest request) throws IOException, ApiException Get station information for self- Parameters:
request- The request object- Returns:
- UserStations
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getUsersStationsMe
Get station information for self- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUser
Update user- Parameters:
userId- User ID (required)body- User (required)- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserWithHttpInfo
Update user- Parameters:
userId- User ID (required)body- User (required)- Returns:
- User
- Throws:
IOException- if the request fails to be processed
-
patchUser
Update user- Parameters:
request- The request object- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUser
Update user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserCallforwarding
public CallForwarding patchUserCallforwarding(String userId, CallForwarding body) throws IOException, ApiException Patch a user's CallForwarding- Parameters:
userId- User ID (required)body- Call forwarding (required)- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCallforwardingWithHttpInfo
public ApiResponse<CallForwarding> patchUserCallforwardingWithHttpInfo(String userId, CallForwarding body) throws IOException Patch a user's CallForwarding- Parameters:
userId- User ID (required)body- Call forwarding (required)- Returns:
- CallForwarding
- Throws:
IOException- if the request fails to be processed
-
patchUserCallforwarding
public CallForwarding patchUserCallforwarding(PatchUserCallforwardingRequest request) throws IOException, ApiException Patch a user's CallForwarding- Parameters:
request- The request object- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCallforwarding
public ApiResponse<CallForwarding> patchUserCallforwarding(ApiRequest<CallForwarding> request) throws IOException Patch a user's CallForwarding- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserCustomattributes
public UserCustomAttributes patchUserCustomattributes(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) throws IOException, ApiException Update a single custom attributes record by amending the data with only the provided fields.- Parameters:
userId- user ID (required)userCustomAttributes- (required)- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCustomattributesWithHttpInfo
public ApiResponse<UserCustomAttributes> patchUserCustomattributesWithHttpInfo(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) throws IOException Update a single custom attributes record by amending the data with only the provided fields.- Parameters:
userId- user ID (required)userCustomAttributes- (required)- Returns:
- UserCustomAttributes
- Throws:
IOException- if the request fails to be processed
-
patchUserCustomattributes
public UserCustomAttributes patchUserCustomattributes(PatchUserCustomattributesRequest request) throws IOException, ApiException Update a single custom attributes record by amending the data with only the provided fields.- Parameters:
request- The request object- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCustomattributes
public ApiResponse<UserCustomAttributes> patchUserCustomattributes(ApiRequest<UserCustomAttributesUpdateRequest> request) throws IOException Update a single custom attributes record by amending the data with only the provided fields.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserCustomattributesBulk
public UserCustomAttributes patchUserCustomattributesBulk(String userId, List<UserCustomAttributesUpdateRequest> userCustomAttributesList) throws IOException, ApiException Update multiple custom attributes records by amending the data with only the provided fields.- Parameters:
userId- user ID (required)userCustomAttributesList- (required)- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCustomattributesBulkWithHttpInfo
public ApiResponse<UserCustomAttributes> patchUserCustomattributesBulkWithHttpInfo(String userId, List<UserCustomAttributesUpdateRequest> userCustomAttributesList) throws IOException Update multiple custom attributes records by amending the data with only the provided fields.- Parameters:
userId- user ID (required)userCustomAttributesList- (required)- Returns:
- UserCustomAttributes
- Throws:
IOException- if the request fails to be processed
-
patchUserCustomattributesBulk
public UserCustomAttributes patchUserCustomattributesBulk(PatchUserCustomattributesBulkRequest request) throws IOException, ApiException Update multiple custom attributes records by amending the data with only the provided fields.- Parameters:
request- The request object- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserCustomattributesBulk
public ApiResponse<UserCustomAttributes> patchUserCustomattributesBulk(ApiRequest<List<UserCustomAttributesUpdateRequest>> request) throws IOException Update multiple custom attributes records by amending the data with only the provided fields.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserGeolocation
public Geolocation patchUserGeolocation(String userId, String clientId, Geolocation body) throws IOException, ApiException Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.- Parameters:
userId- user Id (required)clientId- client Id (required)body- Geolocation (required)- Returns:
- Geolocation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserGeolocationWithHttpInfo
public ApiResponse<Geolocation> patchUserGeolocationWithHttpInfo(String userId, String clientId, Geolocation body) throws IOException Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.- Parameters:
userId- user Id (required)clientId- client Id (required)body- Geolocation (required)- Returns:
- Geolocation
- Throws:
IOException- if the request fails to be processed
-
patchUserGeolocation
public Geolocation patchUserGeolocation(PatchUserGeolocationRequest request) throws IOException, ApiException Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.- Parameters:
request- The request object- Returns:
- Geolocation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserGeolocation
public ApiResponse<Geolocation> patchUserGeolocation(ApiRequest<Geolocation> request) throws IOException Patch a user's Geolocation The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserQueue
public UserQueue patchUserQueue(String queueId, String userId, UserQueue body) throws IOException, ApiException Join or unjoin a queue for a user- Parameters:
queueId- Queue ID (required)userId- User ID (required)body- Queue Member (required)- Returns:
- UserQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueueWithHttpInfo
public ApiResponse<UserQueue> patchUserQueueWithHttpInfo(String queueId, String userId, UserQueue body) throws IOException Join or unjoin a queue for a user- Parameters:
queueId- Queue ID (required)userId- User ID (required)body- Queue Member (required)- Returns:
- UserQueue
- Throws:
IOException- if the request fails to be processed
-
patchUserQueue
Join or unjoin a queue for a user- Parameters:
request- The request object- Returns:
- UserQueue
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueue
Join or unjoin a queue for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserQueues
public UserQueueEntityListing patchUserQueues(String userId, List<UserQueue> body, List<String> divisionId) throws IOException, ApiException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
userId- User ID (required)body- User Queues (required)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueuesWithHttpInfo
public ApiResponse<UserQueueEntityListing> patchUserQueuesWithHttpInfo(String userId, List<UserQueue> body, List<String> divisionId) throws IOException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
userId- User ID (required)body- User Queues (required)divisionId- Division ID(s) (optional)- Returns:
- UserQueueEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserQueues
public UserQueueEntityListing patchUserQueues(PatchUserQueuesRequest request) throws IOException, ApiException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- UserQueueEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserQueues
public ApiResponse<UserQueueEntityListing> patchUserQueues(ApiRequest<List<UserQueue>> request) throws IOException Join or unjoin a set of queues for a user Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. Query the GET endpoint after a delay to retrieve the current membership status.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguage
public UserRoutingLanguage patchUserRoutinglanguage(String userId, String languageId, UserRoutingLanguage body) throws IOException, ApiException Update an assigned routing language's proficiency- Parameters:
userId- User ID (required)languageId- languageId (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguageWithHttpInfo
public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguageWithHttpInfo(String userId, String languageId, UserRoutingLanguage body) throws IOException Update an assigned routing language's proficiency- Parameters:
userId- User ID (required)languageId- languageId (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguage
public UserRoutingLanguage patchUserRoutinglanguage(PatchUserRoutinglanguageRequest request) throws IOException, ApiException Update an assigned routing language's proficiency- Parameters:
request- The request object- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguage
public ApiResponse<UserRoutingLanguage> patchUserRoutinglanguage(ApiRequest<UserRoutingLanguage> request) throws IOException Update an assigned routing language's proficiency- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public UserLanguageEntityListing patchUserRoutinglanguagesBulk(String userId, List<UserRoutingLanguagePost> body) throws IOException, ApiException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulkWithHttpInfo
public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulkWithHttpInfo(String userId, List<UserRoutingLanguagePost> body) throws IOException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserLanguageEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public UserLanguageEntityListing patchUserRoutinglanguagesBulk(PatchUserRoutinglanguagesBulkRequest request) throws IOException, ApiException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
request- The request object- Returns:
- UserLanguageEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutinglanguagesBulk
public ApiResponse<UserLanguageEntityListing> patchUserRoutinglanguagesBulk(ApiRequest<List<UserRoutingLanguagePost>> request) throws IOException Assign multiple routing languages to a user. Max 50 routing languages in request body- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public UserSkillEntityListing patchUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException Assign multiple routing skills to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutingskillsBulkWithHttpInfo
public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException Assign multiple routing skills to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public UserSkillEntityListing patchUserRoutingskillsBulk(PatchUserRoutingskillsBulkRequest request) throws IOException, ApiException Assign multiple routing skills to a user- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUserRoutingskillsBulk
public ApiResponse<UserSkillEntityListing> patchUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException Assign multiple routing skills to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchUsersBulk
Update bulk acd autoanswer on users. Max 50 users can be updated at a time.- Parameters:
body- Users (required)- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUsersBulkWithHttpInfo
public ApiResponse<UserEntityListing> patchUsersBulkWithHttpInfo(List<PatchUser> body) throws IOException Update bulk acd autoanswer on users. Max 50 users can be updated at a time.- Parameters:
body- Users (required)- Returns:
- UserEntityListing
- Throws:
IOException- if the request fails to be processed
-
patchUsersBulk
public UserEntityListing patchUsersBulk(PatchUsersBulkRequest request) throws IOException, ApiException Update bulk acd autoanswer on users. Max 50 users can be updated at a time.- Parameters:
request- The request object- Returns:
- UserEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchUsersBulk
public ApiResponse<UserEntityListing> patchUsersBulk(ApiRequest<List<PatchUser>> request) throws IOException Update bulk acd autoanswer on users. Max 50 users can be updated at a time.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersActivityQuery
public UserActivityResponse postAnalyticsUsersActivityQuery(UserActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException, ApiException Query for user activity observations- Parameters:
body- query (required)pageSize- The desired page size (optional)pageNumber- The desired page number (optional)- Returns:
- UserActivityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersActivityQueryWithHttpInfo
public ApiResponse<UserActivityResponse> postAnalyticsUsersActivityQueryWithHttpInfo(UserActivityQuery body, Integer pageSize, Integer pageNumber) throws IOException Query for user activity observations- Parameters:
body- query (required)pageSize- The desired page size (optional)pageNumber- The desired page number (optional)- Returns:
- UserActivityResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersActivityQuery
public UserActivityResponse postAnalyticsUsersActivityQuery(PostAnalyticsUsersActivityQueryRequest request) throws IOException, ApiException Query for user activity observations- Parameters:
request- The request object- Returns:
- UserActivityResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersActivityQuery
public ApiResponse<UserActivityResponse> postAnalyticsUsersActivityQuery(ApiRequest<UserActivityQuery> request) throws IOException Query for user activity observations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesJobs
public AsyncQueryResponse postAnalyticsUsersAggregatesJobs(UserAsyncAggregationQuery body) throws IOException, ApiException Query for user aggregates asynchronously- Parameters:
body- query (required)- Returns:
- AsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesJobsWithHttpInfo
public ApiResponse<AsyncQueryResponse> postAnalyticsUsersAggregatesJobsWithHttpInfo(UserAsyncAggregationQuery body) throws IOException Query for user aggregates asynchronously- Parameters:
body- query (required)- Returns:
- AsyncQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesJobs
public AsyncQueryResponse postAnalyticsUsersAggregatesJobs(PostAnalyticsUsersAggregatesJobsRequest request) throws IOException, ApiException Query for user aggregates asynchronously- Parameters:
request- The request object- Returns:
- AsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesJobs
public ApiResponse<AsyncQueryResponse> postAnalyticsUsersAggregatesJobs(ApiRequest<UserAsyncAggregationQuery> request) throws IOException Query for user aggregates asynchronously- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesQuery
public UserAggregateQueryResponse postAnalyticsUsersAggregatesQuery(UserAggregationQuery body) throws IOException, ApiException Query for user aggregates- Parameters:
body- query (required)- Returns:
- UserAggregateQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesQueryWithHttpInfo
public ApiResponse<UserAggregateQueryResponse> postAnalyticsUsersAggregatesQueryWithHttpInfo(UserAggregationQuery body) throws IOException Query for user aggregates- Parameters:
body- query (required)- Returns:
- UserAggregateQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesQuery
public UserAggregateQueryResponse postAnalyticsUsersAggregatesQuery(PostAnalyticsUsersAggregatesQueryRequest request) throws IOException, ApiException Query for user aggregates- Parameters:
request- The request object- Returns:
- UserAggregateQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersAggregatesQuery
public ApiResponse<UserAggregateQueryResponse> postAnalyticsUsersAggregatesQuery(ApiRequest<UserAggregationQuery> request) throws IOException Query for user aggregates- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersDetailsJobs
public AsyncQueryResponse postAnalyticsUsersDetailsJobs(AsyncUserDetailsQuery body) throws IOException, ApiException Query for user details asynchronously- Parameters:
body- query (required)- Returns:
- AsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersDetailsJobsWithHttpInfo
public ApiResponse<AsyncQueryResponse> postAnalyticsUsersDetailsJobsWithHttpInfo(AsyncUserDetailsQuery body) throws IOException Query for user details asynchronously- Parameters:
body- query (required)- Returns:
- AsyncQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersDetailsJobs
public AsyncQueryResponse postAnalyticsUsersDetailsJobs(PostAnalyticsUsersDetailsJobsRequest request) throws IOException, ApiException Query for user details asynchronously- Parameters:
request- The request object- Returns:
- AsyncQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersDetailsJobs
public ApiResponse<AsyncQueryResponse> postAnalyticsUsersDetailsJobs(ApiRequest<AsyncUserDetailsQuery> request) throws IOException Query for user details asynchronously- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersDetailsQuery
public AnalyticsUserDetailsQueryResponse postAnalyticsUsersDetailsQuery(UserDetailsQuery body) throws IOException, ApiException Query for user details- Parameters:
body- query (required)- Returns:
- AnalyticsUserDetailsQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersDetailsQueryWithHttpInfo
public ApiResponse<AnalyticsUserDetailsQueryResponse> postAnalyticsUsersDetailsQueryWithHttpInfo(UserDetailsQuery body) throws IOException Query for user details- Parameters:
body- query (required)- Returns:
- AnalyticsUserDetailsQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersDetailsQuery
public AnalyticsUserDetailsQueryResponse postAnalyticsUsersDetailsQuery(PostAnalyticsUsersDetailsQueryRequest request) throws IOException, ApiException Query for user details- Parameters:
request- The request object- Returns:
- AnalyticsUserDetailsQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersDetailsQuery
public ApiResponse<AnalyticsUserDetailsQueryResponse> postAnalyticsUsersDetailsQuery(ApiRequest<UserDetailsQuery> request) throws IOException Query for user details- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersObservationsQuery
public UserObservationQueryResponse postAnalyticsUsersObservationsQuery(UserObservationQuery body) throws IOException, ApiException Query for user observations- Parameters:
body- query (required)- Returns:
- UserObservationQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersObservationsQueryWithHttpInfo
public ApiResponse<UserObservationQueryResponse> postAnalyticsUsersObservationsQueryWithHttpInfo(UserObservationQuery body) throws IOException Query for user observations- Parameters:
body- query (required)- Returns:
- UserObservationQueryResponse
- Throws:
IOException- if the request fails to be processed
-
postAnalyticsUsersObservationsQuery
public UserObservationQueryResponse postAnalyticsUsersObservationsQuery(PostAnalyticsUsersObservationsQueryRequest request) throws IOException, ApiException Query for user observations- Parameters:
request- The request object- Returns:
- UserObservationQueryResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAnalyticsUsersObservationsQuery
public ApiResponse<UserObservationQueryResponse> postAnalyticsUsersObservationsQuery(ApiRequest<UserObservationQuery> request) throws IOException Query for user observations- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkadd
public void postAuthorizationSubjectBulkadd(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException, ApiException Bulk-grant roles and divisions to a subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)subjectType- what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkaddWithHttpInfo
public ApiResponse<Void> postAuthorizationSubjectBulkaddWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException Bulk-grant roles and divisions to a subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)subjectType- what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkadd
public void postAuthorizationSubjectBulkadd(PostAuthorizationSubjectBulkaddRequest request) throws IOException, ApiException Bulk-grant roles and divisions to a subject.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkadd
public ApiResponse<Void> postAuthorizationSubjectBulkadd(ApiRequest<RoleDivisionGrants> request) throws IOException Bulk-grant roles and divisions to a subject.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkremove
public void postAuthorizationSubjectBulkremove(String subjectId, RoleDivisionGrants body) throws IOException, ApiException Bulk-remove grants from a subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkremoveWithHttpInfo
public ApiResponse<Void> postAuthorizationSubjectBulkremoveWithHttpInfo(String subjectId, RoleDivisionGrants body) throws IOException Bulk-remove grants from a subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkremove
public void postAuthorizationSubjectBulkremove(PostAuthorizationSubjectBulkremoveRequest request) throws IOException, ApiException Bulk-remove grants from a subject.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkremove
public ApiResponse<Void> postAuthorizationSubjectBulkremove(ApiRequest<RoleDivisionGrants> request) throws IOException Bulk-remove grants from a subject.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkreplace
public void postAuthorizationSubjectBulkreplace(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException, ApiException Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)subjectType- what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkreplaceWithHttpInfo
public ApiResponse<Void> postAuthorizationSubjectBulkreplaceWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
subjectId- Subject ID (user or group) (required)body- Pairs of role and division IDs (required)subjectType- what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectBulkreplace
public void postAuthorizationSubjectBulkreplace(PostAuthorizationSubjectBulkreplaceRequest request) throws IOException, ApiException Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectBulkreplace
public ApiResponse<Void> postAuthorizationSubjectBulkreplace(ApiRequest<RoleDivisionGrants> request) throws IOException Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectDivisionRole
public void postAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId, String subjectType) throws IOException, ApiException Make a grant of a role in a division- Parameters:
subjectId- Subject ID (user or group) (required)divisionId- the id of the division to which to make the grant (required)roleId- the id of the role to grant (required)subjectType- what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional, default to PC_USER)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectDivisionRoleWithHttpInfo
public ApiResponse<Void> postAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId, String subjectType) throws IOException Make a grant of a role in a division- Parameters:
subjectId- Subject ID (user or group) (required)divisionId- the id of the division to which to make the grant (required)roleId- the id of the role to grant (required)subjectType- what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional, default to PC_USER)- Throws:
IOException- if the request fails to be processed
-
postAuthorizationSubjectDivisionRole
public void postAuthorizationSubjectDivisionRole(PostAuthorizationSubjectDivisionRoleRequest request) throws IOException, ApiException Make a grant of a role in a division- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postAuthorizationSubjectDivisionRole
public ApiResponse<Void> postAuthorizationSubjectDivisionRole(ApiRequest<Void> request) throws IOException Make a grant of a role in a division- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserExternalid
public List<UserExternalIdentifier> postUserExternalid(String userId, UserExternalIdentifier body) throws IOException, ApiException Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive.- Parameters:
userId- User ID (required)body- (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserExternalidWithHttpInfo
public ApiResponse<List<UserExternalIdentifier>> postUserExternalidWithHttpInfo(String userId, UserExternalIdentifier body) throws IOException Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive.- Parameters:
userId- User ID (required)body- (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
postUserExternalid
public List<UserExternalIdentifier> postUserExternalid(PostUserExternalidRequest request) throws IOException, ApiException Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive.- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserExternalid
public ApiResponse<List<UserExternalIdentifier>> postUserExternalid(ApiRequest<UserExternalIdentifier> request) throws IOException Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserInvite
Send an activation email to the user- Parameters:
userId- User ID (required)force- Resend the invitation even if one is already outstanding (optional, default to false)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserInviteWithHttpInfo
public ApiResponse<Void> postUserInviteWithHttpInfo(String userId, Boolean force) throws IOException Send an activation email to the user- Parameters:
userId- User ID (required)force- Resend the invitation even if one is already outstanding (optional, default to false)- Throws:
IOException- if the request fails to be processed
-
postUserInvite
Send an activation email to the user- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserInvite
Send an activation email to the user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserPassword
public void postUserPassword(String userId, ChangePasswordRequest body) throws IOException, ApiException Change a users password- Parameters:
userId- User ID (required)body- Password (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserPasswordWithHttpInfo
public ApiResponse<Void> postUserPasswordWithHttpInfo(String userId, ChangePasswordRequest body) throws IOException Change a users password- Parameters:
userId- User ID (required)body- Password (required)- Throws:
IOException- if the request fails to be processed
-
postUserPassword
Change a users password- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserPassword
public ApiResponse<Void> postUserPassword(ApiRequest<ChangePasswordRequest> request) throws IOException Change a users password- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserRoutinglanguages
public UserRoutingLanguage postUserRoutinglanguages(String userId, UserRoutingLanguagePost body) throws IOException, ApiException Assign a routing language to a user- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutinglanguagesWithHttpInfo
public ApiResponse<UserRoutingLanguage> postUserRoutinglanguagesWithHttpInfo(String userId, UserRoutingLanguagePost body) throws IOException Assign a routing language to a user- Parameters:
userId- User ID (required)body- Language (required)- Returns:
- UserRoutingLanguage
- Throws:
IOException- if the request fails to be processed
-
postUserRoutinglanguages
public UserRoutingLanguage postUserRoutinglanguages(PostUserRoutinglanguagesRequest request) throws IOException, ApiException Assign a routing language to a user- Parameters:
request- The request object- Returns:
- UserRoutingLanguage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutinglanguages
public ApiResponse<UserRoutingLanguage> postUserRoutinglanguages(ApiRequest<UserRoutingLanguagePost> request) throws IOException Assign a routing language to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUserRoutingskills
public UserRoutingSkill postUserRoutingskills(String userId, UserRoutingSkillPost body) throws IOException, ApiException Assign a routing skill to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutingskillsWithHttpInfo
public ApiResponse<UserRoutingSkill> postUserRoutingskillsWithHttpInfo(String userId, UserRoutingSkillPost body) throws IOException Assign a routing skill to a user- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
IOException- if the request fails to be processed
-
postUserRoutingskills
public UserRoutingSkill postUserRoutingskills(PostUserRoutingskillsRequest request) throws IOException, ApiException Assign a routing skill to a user- Parameters:
request- The request object- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUserRoutingskills
public ApiResponse<UserRoutingSkill> postUserRoutingskills(ApiRequest<UserRoutingSkillPost> request) throws IOException Assign a routing skill to a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsers
Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.- Parameters:
body- User (required)- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersWithHttpInfo
Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.- Parameters:
body- User (required)- Returns:
- User
- Throws:
IOException- if the request fails to be processed
-
postUsers
Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.- Parameters:
request- The request object- Returns:
- User
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsers
Create user If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsersCustomattributesSchemas
public DataSchema postUsersCustomattributesSchemas(DataSchema body) throws IOException, ApiException Create a schema- Parameters:
body- Schema (required)- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersCustomattributesSchemasWithHttpInfo
public ApiResponse<DataSchema> postUsersCustomattributesSchemasWithHttpInfo(DataSchema body) throws IOException Create a schema- Parameters:
body- Schema (required)- Returns:
- DataSchema
- Throws:
IOException- if the request fails to be processed
-
postUsersCustomattributesSchemas
public DataSchema postUsersCustomattributesSchemas(PostUsersCustomattributesSchemasRequest request) throws IOException, ApiException Create a schema- Parameters:
request- The request object- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersCustomattributesSchemas
public ApiResponse<DataSchema> postUsersCustomattributesSchemas(ApiRequest<DataSchema> request) throws IOException Create a schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsersDevelopmentActivitiesAggregatesQuery
public DevelopmentActivityAggregateResponse postUsersDevelopmentActivitiesAggregatesQuery(DevelopmentActivityAggregateParam body) throws IOException, ApiException Retrieve aggregated development activity data Results are filtered based on the applicable permissions.- Parameters:
body- Aggregate Request (required)- Returns:
- DevelopmentActivityAggregateResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersDevelopmentActivitiesAggregatesQueryWithHttpInfo
public ApiResponse<DevelopmentActivityAggregateResponse> postUsersDevelopmentActivitiesAggregatesQueryWithHttpInfo(DevelopmentActivityAggregateParam body) throws IOException Retrieve aggregated development activity data Results are filtered based on the applicable permissions.- Parameters:
body- Aggregate Request (required)- Returns:
- DevelopmentActivityAggregateResponse
- Throws:
IOException- if the request fails to be processed
-
postUsersDevelopmentActivitiesAggregatesQuery
public DevelopmentActivityAggregateResponse postUsersDevelopmentActivitiesAggregatesQuery(PostUsersDevelopmentActivitiesAggregatesQueryRequest request) throws IOException, ApiException Retrieve aggregated development activity data Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- DevelopmentActivityAggregateResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersDevelopmentActivitiesAggregatesQuery
public ApiResponse<DevelopmentActivityAggregateResponse> postUsersDevelopmentActivitiesAggregatesQuery(ApiRequest<DevelopmentActivityAggregateParam> request) throws IOException Retrieve aggregated development activity data Results are filtered based on the applicable permissions.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsersMePassword
Change your password- Parameters:
body- Password (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersMePasswordWithHttpInfo
public ApiResponse<Void> postUsersMePasswordWithHttpInfo(ChangeMyPasswordRequest body) throws IOException Change your password- Parameters:
body- Password (required)- Throws:
IOException- if the request fails to be processed
-
postUsersMePassword
public void postUsersMePassword(PostUsersMePasswordRequest request) throws IOException, ApiException Change your password- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersMePassword
public ApiResponse<Void> postUsersMePassword(ApiRequest<ChangeMyPasswordRequest> request) throws IOException Change your password- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsersSearch
Search users- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchWithHttpInfo
public ApiResponse<UsersSearchResponse> postUsersSearchWithHttpInfo(UserSearchRequest body) throws IOException Search users- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
IOException- if the request fails to be processed
-
postUsersSearch
public UsersSearchResponse postUsersSearch(PostUsersSearchRequest request) throws IOException, ApiException Search users- Parameters:
request- The request object- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearch
public ApiResponse<UsersSearchResponse> postUsersSearch(ApiRequest<UserSearchRequest> request) throws IOException Search users- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postUsersSearchConversationTarget
public UsersSearchResponse postUsersSearchConversationTarget(UserSearchRequest body) throws IOException, ApiException Search users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchConversationTargetWithHttpInfo
public ApiResponse<UsersSearchResponse> postUsersSearchConversationTargetWithHttpInfo(UserSearchRequest body) throws IOException Search users as conversation targets postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
IOException- if the request fails to be processed
-
postUsersSearchConversationTarget
public UsersSearchResponse postUsersSearchConversationTarget(PostUsersSearchConversationTargetRequest request) throws IOException, ApiException Search users as conversation targets postUsersSearchConversationTarget 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:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchConversationTarget
public ApiResponse<UsersSearchResponse> postUsersSearchConversationTarget(ApiRequest<UserSearchRequest> request) throws IOException Search users as conversation targets postUsersSearchConversationTarget 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
-
postUsersSearchQueuemembersManage
public UsersSearchResponse postUsersSearchQueuemembersManage(UserSearchRequest body) throws IOException, ApiException Search manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchQueuemembersManageWithHttpInfo
public ApiResponse<UsersSearchResponse> postUsersSearchQueuemembersManageWithHttpInfo(UserSearchRequest body) throws IOException Search manage queue member postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
IOException- if the request fails to be processed
-
postUsersSearchQueuemembersManage
public UsersSearchResponse postUsersSearchQueuemembersManage(PostUsersSearchQueuemembersManageRequest request) throws IOException, ApiException Search manage queue member postUsersSearchQueuemembersManage 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:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchQueuemembersManage
public ApiResponse<UsersSearchResponse> postUsersSearchQueuemembersManage(ApiRequest<UserSearchRequest> request) throws IOException Search manage queue member postUsersSearchQueuemembersManage 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
-
postUsersSearchTeamsAssign
public UsersSearchResponse postUsersSearchTeamsAssign(UserSearchRequest body) throws IOException, ApiException Search users assigned to teams- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchTeamsAssignWithHttpInfo
public ApiResponse<UsersSearchResponse> postUsersSearchTeamsAssignWithHttpInfo(UserSearchRequest body) throws IOException Search users assigned to teams- Parameters:
body- Search request options (required)- Returns:
- UsersSearchResponse
- Throws:
IOException- if the request fails to be processed
-
postUsersSearchTeamsAssign
public UsersSearchResponse postUsersSearchTeamsAssign(PostUsersSearchTeamsAssignRequest request) throws IOException, ApiException Search users assigned to teams- Parameters:
request- The request object- Returns:
- UsersSearchResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postUsersSearchTeamsAssign
public ApiResponse<UsersSearchResponse> postUsersSearchTeamsAssign(ApiRequest<UserSearchRequest> request) throws IOException Search users assigned to teams- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(AgentDirectRoutingBackupSettings body) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMeWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMeWithHttpInfo(AgentDirectRoutingBackupSettings body) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public AgentDirectRoutingBackupSettings putRoutingDirectroutingbackupSettingsMe(PutRoutingDirectroutingbackupSettingsMeRequest request) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingDirectroutingbackupSettingsMe
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingDirectroutingbackupSettingsMe(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(String userId, AgentDirectRoutingBackupSettings body) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettingsWithHttpInfo
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettingsWithHttpInfo(String userId, AgentDirectRoutingBackupSettings body) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
userId- User ID (required)body- directRoutingBackup (required)- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public AgentDirectRoutingBackupSettings putRoutingUserDirectroutingbackupSettings(PutRoutingUserDirectroutingbackupSettingsRequest request) throws IOException, ApiException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- AgentDirectRoutingBackupSettings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserDirectroutingbackupSettings
public ApiResponse<AgentDirectRoutingBackupSettings> putRoutingUserDirectroutingbackupSettings(ApiRequest<AgentDirectRoutingBackupSettings> request) throws IOException Update the user's Direct Routing Backup settings.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserUtilization
public AgentMaxUtilizationResponse putRoutingUserUtilization(String userId, UtilizationRequest body) throws IOException, ApiException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
userId- User ID (required)body- utilization (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserUtilizationWithHttpInfo
public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilizationWithHttpInfo(String userId, UtilizationRequest body) throws IOException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
userId- User ID (required)body- utilization (required)- Returns:
- AgentMaxUtilizationResponse
- Throws:
IOException- if the request fails to be processed
-
putRoutingUserUtilization
public AgentMaxUtilizationResponse putRoutingUserUtilization(PutRoutingUserUtilizationRequest request) throws IOException, ApiException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
request- The request object- Returns:
- AgentMaxUtilizationResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putRoutingUserUtilization
public ApiResponse<AgentMaxUtilizationResponse> putRoutingUserUtilization(ApiRequest<UtilizationRequest> request) throws IOException Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserCallforwarding
public CallForwarding putUserCallforwarding(String userId, CallForwarding body) throws IOException, ApiException Update a user's CallForwarding- Parameters:
userId- User ID (required)body- Call forwarding (required)- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserCallforwardingWithHttpInfo
public ApiResponse<CallForwarding> putUserCallforwardingWithHttpInfo(String userId, CallForwarding body) throws IOException Update a user's CallForwarding- Parameters:
userId- User ID (required)body- Call forwarding (required)- Returns:
- CallForwarding
- Throws:
IOException- if the request fails to be processed
-
putUserCallforwarding
public CallForwarding putUserCallforwarding(PutUserCallforwardingRequest request) throws IOException, ApiException Update a user's CallForwarding- Parameters:
request- The request object- Returns:
- CallForwarding
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserCallforwarding
public ApiResponse<CallForwarding> putUserCallforwarding(ApiRequest<CallForwarding> request) throws IOException Update a user's CallForwarding- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserCustomattributes
public UserCustomAttributes putUserCustomattributes(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) throws IOException, ApiException Create or update a single custom attributes record. Updating replaces all data with the provided fields.- Parameters:
userId- user ID (required)userCustomAttributes- (required)- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserCustomattributesWithHttpInfo
public ApiResponse<UserCustomAttributes> putUserCustomattributesWithHttpInfo(String userId, UserCustomAttributesUpdateRequest userCustomAttributes) throws IOException Create or update a single custom attributes record. Updating replaces all data with the provided fields.- Parameters:
userId- user ID (required)userCustomAttributes- (required)- Returns:
- UserCustomAttributes
- Throws:
IOException- if the request fails to be processed
-
putUserCustomattributes
public UserCustomAttributes putUserCustomattributes(PutUserCustomattributesRequest request) throws IOException, ApiException Create or update a single custom attributes record. Updating replaces all data with the provided fields.- Parameters:
request- The request object- Returns:
- UserCustomAttributes
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserCustomattributes
public ApiResponse<UserCustomAttributes> putUserCustomattributes(ApiRequest<UserCustomAttributesUpdateRequest> request) throws IOException Create or update a single custom attributes record. Updating replaces all data with the provided fields.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserOutofoffice
public OutOfOffice putUserOutofoffice(String userId, OutOfOffice body) throws IOException, ApiException Update an OutOfOffice- Parameters:
userId- User ID (required)body- The updated OutOffOffice (required)- Returns:
- OutOfOffice
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserOutofofficeWithHttpInfo
public ApiResponse<OutOfOffice> putUserOutofofficeWithHttpInfo(String userId, OutOfOffice body) throws IOException Update an OutOfOffice- Parameters:
userId- User ID (required)body- The updated OutOffOffice (required)- Returns:
- OutOfOffice
- Throws:
IOException- if the request fails to be processed
-
putUserOutofoffice
public OutOfOffice putUserOutofoffice(PutUserOutofofficeRequest request) throws IOException, ApiException Update an OutOfOffice- Parameters:
request- The request object- Returns:
- OutOfOffice
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserOutofoffice
public ApiResponse<OutOfOffice> putUserOutofoffice(ApiRequest<OutOfOffice> request) throws IOException Update an OutOfOffice- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserProfileskills
public List<String> putUserProfileskills(String userId, List<String> body) throws IOException, ApiException Update profile skills for a user- Parameters:
userId- User ID (required)body- Skills (required)- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserProfileskillsWithHttpInfo
public ApiResponse<List<String>> putUserProfileskillsWithHttpInfo(String userId, List<String> body) throws IOException Update profile skills for a user- Parameters:
userId- User ID (required)body- Skills (required)- Returns:
- List
- Throws:
IOException- if the request fails to be processed
-
putUserProfileskills
public List<String> putUserProfileskills(PutUserProfileskillsRequest request) throws IOException, ApiException Update profile skills for a user- Parameters:
request- The request object- Returns:
- List
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserProfileskills
public ApiResponse<List<String>> putUserProfileskills(ApiRequest<List<String>> request) throws IOException Update profile skills for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoles
public UserAuthorization putUserRoles(String subjectId, List<String> body) throws IOException, ApiException Sets the user's roles- Parameters:
subjectId- User ID (required)body- List of roles (required)- Returns:
- UserAuthorization
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRolesWithHttpInfo
public ApiResponse<UserAuthorization> putUserRolesWithHttpInfo(String subjectId, List<String> body) throws IOException Sets the user's roles- Parameters:
subjectId- User ID (required)body- List of roles (required)- Returns:
- UserAuthorization
- Throws:
IOException- if the request fails to be processed
-
putUserRoles
Sets the user's roles- Parameters:
request- The request object- Returns:
- UserAuthorization
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoles
public ApiResponse<UserAuthorization> putUserRoles(ApiRequest<List<String>> request) throws IOException Sets the user's roles- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskill
public UserRoutingSkill putUserRoutingskill(String userId, String skillId, UserRoutingSkill body) throws IOException, ApiException Update an assigned routing skill's proficiency- Parameters:
userId- User ID (required)skillId- skillId (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillWithHttpInfo
public ApiResponse<UserRoutingSkill> putUserRoutingskillWithHttpInfo(String userId, String skillId, UserRoutingSkill body) throws IOException Update an assigned routing skill's proficiency- Parameters:
userId- User ID (required)skillId- skillId (required)body- Skill (required)- Returns:
- UserRoutingSkill
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskill
public UserRoutingSkill putUserRoutingskill(PutUserRoutingskillRequest request) throws IOException, ApiException Update an assigned routing skill's proficiency- Parameters:
request- The request object- Returns:
- UserRoutingSkill
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskill
public ApiResponse<UserRoutingSkill> putUserRoutingskill(ApiRequest<UserRoutingSkill> request) throws IOException Update an assigned routing skill's proficiency- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public UserSkillEntityListing putUserRoutingskillsBulk(String userId, List<UserRoutingSkillPost> body) throws IOException, ApiException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillsBulkWithHttpInfo
public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulkWithHttpInfo(String userId, List<UserRoutingSkillPost> body) throws IOException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
userId- User ID (required)body- Skill (required)- Returns:
- UserSkillEntityListing
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public UserSkillEntityListing putUserRoutingskillsBulk(PutUserRoutingskillsBulkRequest request) throws IOException, ApiException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
request- The request object- Returns:
- UserSkillEntityListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingskillsBulk
public ApiResponse<UserSkillEntityListing> putUserRoutingskillsBulk(ApiRequest<List<UserRoutingSkillPost>> request) throws IOException Assign multiple routing skills to a user, replacing any current assignments- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingstatus
public RoutingStatus putUserRoutingstatus(String userId, RoutingStatus body) throws IOException, ApiException Update the routing status of a user- Parameters:
userId- User ID (required)body- Routing Status (required)- Returns:
- RoutingStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingstatusWithHttpInfo
public ApiResponse<RoutingStatus> putUserRoutingstatusWithHttpInfo(String userId, RoutingStatus body) throws IOException Update the routing status of a user- Parameters:
userId- User ID (required)body- Routing Status (required)- Returns:
- RoutingStatus
- Throws:
IOException- if the request fails to be processed
-
putUserRoutingstatus
public RoutingStatus putUserRoutingstatus(PutUserRoutingstatusRequest request) throws IOException, ApiException Update the routing status of a user- Parameters:
request- The request object- Returns:
- RoutingStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserRoutingstatus
public ApiResponse<RoutingStatus> putUserRoutingstatus(ApiRequest<RoutingStatus> request) throws IOException Update the routing status of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserState
Update user state information.- Parameters:
userId- User ID (required)body- User (required)- Returns:
- UserState
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserStateWithHttpInfo
public ApiResponse<UserState> putUserStateWithHttpInfo(String userId, UserState body) throws IOException Update user state information.- Parameters:
userId- User ID (required)body- User (required)- Returns:
- UserState
- Throws:
IOException- if the request fails to be processed
-
putUserState
Update user state information.- Parameters:
request- The request object- Returns:
- UserState
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserState
Update user state information.- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserStationAssociatedstationStationId
public void putUserStationAssociatedstationStationId(String userId, String stationId) throws IOException, ApiException Set associated station- Parameters:
userId- User ID (required)stationId- stationId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserStationAssociatedstationStationIdWithHttpInfo
public ApiResponse<Void> putUserStationAssociatedstationStationIdWithHttpInfo(String userId, String stationId) throws IOException Set associated station- Parameters:
userId- User ID (required)stationId- stationId (required)- Throws:
IOException- if the request fails to be processed
-
putUserStationAssociatedstationStationId
public void putUserStationAssociatedstationStationId(PutUserStationAssociatedstationStationIdRequest request) throws IOException, ApiException Set associated station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserStationAssociatedstationStationId
public ApiResponse<Void> putUserStationAssociatedstationStationId(ApiRequest<Void> request) throws IOException Set associated station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserStationDefaultstationStationId
public void putUserStationDefaultstationStationId(String userId, String stationId) throws IOException, ApiException Set default station- Parameters:
userId- User ID (required)stationId- stationId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserStationDefaultstationStationIdWithHttpInfo
public ApiResponse<Void> putUserStationDefaultstationStationIdWithHttpInfo(String userId, String stationId) throws IOException Set default station- Parameters:
userId- User ID (required)stationId- stationId (required)- Throws:
IOException- if the request fails to be processed
-
putUserStationDefaultstationStationId
public void putUserStationDefaultstationStationId(PutUserStationDefaultstationStationIdRequest request) throws IOException, ApiException Set default station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserStationDefaultstationStationId
public ApiResponse<Void> putUserStationDefaultstationStationId(ApiRequest<Void> request) throws IOException Set default station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUserVerifier
public Verifier putUserVerifier(String userId, String verifierId, UpdateVerifierRequest body) throws IOException, ApiException Update a verifier- Parameters:
userId- User ID (required)verifierId- Verifier ID (required)body- Verifier Update (required)- Returns:
- Verifier
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserVerifierWithHttpInfo
public ApiResponse<Verifier> putUserVerifierWithHttpInfo(String userId, String verifierId, UpdateVerifierRequest body) throws IOException Update a verifier- Parameters:
userId- User ID (required)verifierId- Verifier ID (required)body- Verifier Update (required)- Returns:
- Verifier
- Throws:
IOException- if the request fails to be processed
-
putUserVerifier
Update a verifier- Parameters:
request- The request object- Returns:
- Verifier
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUserVerifier
public ApiResponse<Verifier> putUserVerifier(ApiRequest<UpdateVerifierRequest> request) throws IOException Update a verifier- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUsersCustomattributesSchema
public DataSchema putUsersCustomattributesSchema(String schemaId, DataSchema body) throws IOException, ApiException Update a schema- Parameters:
schemaId- Schema ID (required)body- Data Schema (required)- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersCustomattributesSchemaWithHttpInfo
public ApiResponse<DataSchema> putUsersCustomattributesSchemaWithHttpInfo(String schemaId, DataSchema body) throws IOException Update a schema- Parameters:
schemaId- Schema ID (required)body- Data Schema (required)- Returns:
- DataSchema
- Throws:
IOException- if the request fails to be processed
-
putUsersCustomattributesSchema
public DataSchema putUsersCustomattributesSchema(PutUsersCustomattributesSchemaRequest request) throws IOException, ApiException Update a schema- Parameters:
request- The request object- Returns:
- DataSchema
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersCustomattributesSchema
public ApiResponse<DataSchema> putUsersCustomattributesSchema(ApiRequest<DataSchema> request) throws IOException Update a schema- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putUsersStationsMeAssociatedstationStationId
public void putUsersStationsMeAssociatedstationStationId(String stationId) throws IOException, ApiException Set self associated station- Parameters:
stationId- stationId (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersStationsMeAssociatedstationStationIdWithHttpInfo
public ApiResponse<Void> putUsersStationsMeAssociatedstationStationIdWithHttpInfo(String stationId) throws IOException Set self associated station- Parameters:
stationId- stationId (required)- Throws:
IOException- if the request fails to be processed
-
putUsersStationsMeAssociatedstationStationId
public void putUsersStationsMeAssociatedstationStationId(PutUsersStationsMeAssociatedstationStationIdRequest request) throws IOException, ApiException Set self associated station- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putUsersStationsMeAssociatedstationStationId
public ApiResponse<Void> putUsersStationsMeAssociatedstationStationId(ApiRequest<Void> request) throws IOException Set self associated station- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-