toggleTemplateDeliveryWithHttpInfo method

Future<Response> toggleTemplateDeliveryWithHttpInfo(
  1. String templateType,
  2. String slug, {
  3. ToggleTemplateDeliveryRequest? toggleTemplateDeliveryRequest,
})

Toggle the delivery by Clerk for a template of a given type and slug

Toggles the delivery by Clerk for a template of a given type and slug. If disabled, Clerk will not deliver the resulting email or SMS. The app developer will need to listen to the email.created or sms.created webhooks in order to handle delivery themselves.

Note: This method returns the HTTP Response.

Parameters:

  • String templateType (required): The type of template to toggle delivery for

  • String slug (required): The slug of the template for which to toggle delivery

  • ToggleTemplateDeliveryRequest toggleTemplateDeliveryRequest:

Implementation

Future<http.Response> toggleTemplateDeliveryWithHttpInfo(
  String templateType,
  String slug, {
  ToggleTemplateDeliveryRequest? toggleTemplateDeliveryRequest,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/templates/{template_type}/{slug}/toggle_delivery'
      .replaceAll('{template_type}', templateType)
      .replaceAll('{slug}', slug);

  // ignore: prefer_final_locals
  Object? postBody = toggleTemplateDeliveryRequest;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}