index method

Future<DynamiteResponse<WebhooksIndexResponseApplicationJson, void>> index({ String? uri, bool? oCSAPIRequest, })

List registered webhooks.

This endpoint requires admin access.

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:

• uri The callback URI to filter by.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Webhook registrations 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<WebhooksIndexResponseApplicationJson, void>> index({
  String? uri,
  bool? oCSAPIRequest,
}) async {
  final _request = $index_Request(
    uri: uri,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $index_Serializer();
  return _i1.ResponseConverter<WebhooksIndexResponseApplicationJson, void>(_serializer).convert(_response);
}