getInheritedShares method

Future<DynamiteResponse<ShareapiGetInheritedSharesResponseApplicationJson, void>> getInheritedShares({ required String path, bool? oCSAPIRequest, })

Get all shares relative to a file, including parent folders shares rights.

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:

• path Path all shares will be relative to.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Shares returned
• 500
• 404: The given path is invalid

See:

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

Implementation

Future<_i1.DynamiteResponse<ShareapiGetInheritedSharesResponseApplicationJson, void>> getInheritedShares({
  required String path,
  bool? oCSAPIRequest,
}) async {
  final _request = $getInheritedShares_Request(
    path: path,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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