deleteShare method

Future<DynamiteResponse<ShareapiDeleteShareResponseApplicationJson, void>> deleteShare({ required String id, bool? oCSAPIRequest, })

Delete a share.

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:

• id ID of the share.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Share deleted successfully
• 404: Share not found
• 403: Missing permissions to delete the share

See:

• $deleteShare_Request for the request send by this method.
• $deleteShare_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<ShareapiDeleteShareResponseApplicationJson, void>> deleteShare({
  required String id,
  bool? oCSAPIRequest,
}) async {
  final _request = $deleteShare_Request(
    id: id,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $deleteShare_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<ShareapiDeleteShareResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}