deleteShare method

Future<DynamiteResponse<ShareapiDeleteShareResponseApplicationJson, void>> deleteShare({
  1. required String id,
  2. 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:

Implementation

Future<DynamiteResponse<ShareapiDeleteShareResponseApplicationJson, void>> deleteShare({
  required String id,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = deleteShareRaw(
    id: id,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}