patchUser method

Future<MmUser?> patchUser(
  1. String userId,
  2. MmPatchUserRequest mmPatchUserRequest
)

Patch a user

Partially update a user by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must be logged in as the user being updated or have the edit_other_users permission.

Parameters:

  • String userId (required): User GUID

  • MmPatchUserRequest mmPatchUserRequest (required): User object that is to be updated

Implementation

Future<MmUser?> patchUser(
  String userId,
  MmPatchUserRequest mmPatchUserRequest,
) async {
  final response = await patchUserWithHttpInfo(
    userId,
    mmPatchUserRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmUser',
    ) as MmUser;
  }
  return null;
}