index method

Future<DynamiteResponse<DeletedShareapiIndexResponseApplicationJson, void>> index({
  1. bool? oCSAPIRequest,
})

Get a list of all deleted shares.

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:

  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Deleted shares returned

See:

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

Implementation

Future<_i1.DynamiteResponse<DeletedShareapiIndexResponseApplicationJson, void>> index({bool? oCSAPIRequest}) async {
  final rawResponse = indexRaw(
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}