deleteDomain method

Future<DeletedObject?> deleteDomain(
  1. String domainId
)

Delete a satellite domain

Deletes a satellite domain for the instance. It is currently not possible to delete the instance's primary domain.

Parameters:

  • String domainId (required): The ID of the domain that will be deleted. Must be a satellite domain.

Implementation

Future<DeletedObject?> deleteDomain(
  String domainId,
) async {
  final response = await deleteDomainWithHttpInfo(
    domainId,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(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),
      'DeletedObject',
    ) as DeletedObject;
  }
  return null;
}