index method

Future<DynamiteResponse<DeletedShareapiIndexResponseApplicationJson, void>> index({ 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:

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

Implementation

Future<_i1.DynamiteResponse<DeletedShareapiIndexResponseApplicationJson, void>> index({bool? oCSAPIRequest}) async {
  final _request = $index_Request(
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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