Class NotificationTenantTemplatesController

Namespace

KadicErp.WebApi.Controllers.Notifications

Assembly

KadicErp.WebApi.dll

[ApiController]
[Authorize]
[Route("api/notifications/tenant-templates")]
[Produces("application/json", new string[] { })]
[RequireModule("NOTIFICATIONS")]
public class NotificationTenantTemplatesController : ControllerBase

Inheritance

object

ControllerBase

NotificationTenantTemplatesController

Constructors

NotificationTenantTemplatesController(IMediator, IStringLocalizer<GeneralMessages>)

public NotificationTenantTemplatesController(IMediator mediator, IStringLocalizer<GeneralMessages> localizer)

Parameters

mediator IMediator

localizer IStringLocalizer<GeneralMessages>

Methods

ActivateTemplate(Guid, CancellationToken)

[HttpPost("{id:guid}/activate")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_ACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> ActivateTemplate(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

CreateTemplate(CreateNotificationTemplateCommand, CancellationToken)

[HttpPost]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_CREATE")]
[ProducesResponseType(typeof(object), 201)]
[ProducesResponseType(400)]
public Task<ActionResult> CreateTemplate(CreateNotificationTemplateCommand command, CancellationToken cancellationToken)

Parameters

command CreateNotificationTemplateCommand

cancellationToken CancellationToken

Returns

Task<ActionResult>

DeactivateTemplate(Guid, CancellationToken)

[HttpPost("{id:guid}/deactivate")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_DEACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> DeactivateTemplate(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

DeleteTemplate(Guid, CancellationToken)

[HttpDelete("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_DELETE")]
[ProducesResponseType(204)]
public Task<ActionResult> DeleteTemplate(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

GetTemplateById(Guid, CancellationToken)

[HttpGet("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_VIEW")]
[ProducesResponseType(200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<ActionResult> GetTemplateById(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

GetTemplates(PaginatorRequestDto, bool?, string?, CancellationToken)

[HttpGet]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<NotificationTemplateListItemDto>), 200)]
public Task<ActionResult> GetTemplates(PaginatorRequestDto paginatorRequest, bool? isActive, string? channelType, CancellationToken cancellationToken)

Parameters

paginatorRequest PaginatorRequestDto

isActive bool?

channelType string

cancellationToken CancellationToken

Returns

Task<ActionResult>

SendTestEmail(Guid, SendTestTemplateEmailRequest, CancellationToken)

Envía el template como correo de PRUEBA al destinatario indicado, con las variables sustituidas por marcadores [x]. Subject/BodyHtml opcionales permiten probar el borrador del editor sin guardarlo antes.

[HttpPost("{id:guid}/send-test")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_VIEW")]
[ProducesResponseType(typeof(SendEmailResult), 200)]
[ProducesResponseType(typeof(SendEmailResult), 400)]
public Task<ActionResult<SendEmailResult>> SendTestEmail(Guid id, SendTestTemplateEmailRequest request, CancellationToken cancellationToken)

Parameters

id Guid

request SendTestTemplateEmailRequest

cancellationToken CancellationToken

Returns

Task<ActionResult<SendEmailResult>>

UpdateTemplate(Guid, UpdateNotificationTemplateRequest, CancellationToken)

[HttpPut("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_TEMPLATES_UPDATE")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
public Task<ActionResult> UpdateTemplate(Guid id, UpdateNotificationTemplateRequest request, CancellationToken cancellationToken)

Parameters

id Guid

request UpdateNotificationTemplateRequest

cancellationToken CancellationToken

Returns

Task<ActionResult>