toggleTemplateDelivery method

Future<Template?> toggleTemplateDelivery(
  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.

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<Template?> toggleTemplateDelivery(
  String templateType,
  String slug, {
  ToggleTemplateDeliveryRequest? toggleTemplateDeliveryRequest,
}) async {
  final response = await toggleTemplateDeliveryWithHttpInfo(
    templateType,
    slug,
    toggleTemplateDeliveryRequest: toggleTemplateDeliveryRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'Template',
    ) as Template;
  }
  return null;
}