deleteUser method

Future<DynamiteResponse<UsersDeleteUserResponseApplicationJson, void>> deleteUser({
  1. required String userId,
  2. bool? oCSAPIRequest,
})

Delete a user.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User deleted successfully

See:

  • deleteUserRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<UsersDeleteUserResponseApplicationJson, void>> deleteUser({
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = deleteUserRaw(
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}