package
0.0.0-20220628121841-115b5aaa068d
Repository: https://github.com/harry-027/go-notify.git
Documentation: pkg.go.dev

# Functions

AddClients godoc @Summary Registers the client details @Description Adds the clients for a logged in user @Tags Add Client @Accept json @Produce json @Param Body body []models.SwaggerClient true "Add the client details" @Param Authorization header string true "Authentication header" @Success 201 {object} config.ApiResponse{} @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/clients [post].
AddTemplate godoc @Summary Add the mail template @Description Add the mail template @Tags Add template @Accept json @Produce json @Param Body body models.SwaggerTemplate true "Add the template details" @Param Authorization header string true "Authentication header" @Success 201 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 412 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/addTemplate [post].
AddUserVariable godoc @Summary Add the user variable @Description Add the user variable @Tags Add user variable @Accept json @Produce json @Param Body body models.VariableTemplateInput true "Add the template details" @Param Authorization header string true "Authentication header" @Success 201 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 424 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/clientDetails [post].
CheckAuditLog godoc @Summary CheckAuditLog @Description CheckAuditLog @Tags CheckAuditLog @Accept json @Produce json @Success 200 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Router /api/checkAuditLog [get].
DeleteAccount godoc @Summary Delete the User Account @Description Deletes the user account permanently.
DeleteClient godoc @Summary Delete the client @Description Delete the client @Tags Delete Client @Accept json @Produce json @Param mailId path string true "mail id" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/deleteClient [delete].
DeleteScheduleMail godoc @Summary Deletes the scheduled job @Description Deletes the scheduled job for sending mail @Tags Delete Scheduled Job @Accept json @Produce json @Param Authorization header string true "Authentication header" @Param Body body models.DeleteJob true "Delete job Input" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 401 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/deleteScheduleMail [post].
DeleteTemplate godoc @Summary Delete the template @Description Delete the template @Tags Delete Template @Accept json @Produce json @Param id path string true "Template name" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/deleteTemplate [delete].
DeleteUserVariable godoc @Summary Delete the user variable @Description Delete the user variable @Tags Delete user variable @Accept json @Produce json @Param Authorization header string true "Authentication header" @Param Body body models.DeleteTemplateInput true "delete user variable" @Success 200 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 403 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/clientDetails [delete].
ForgotPassword godoc @Summary ForgotPassword @Description ForgotPassword @Tags ForgotPassword @Accept json @Produce json @Param Body body models.ForgotPassword true "forgot password" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Router /auth/forgotPassword [post].
GetClients godoc @Summary Fetch the clients @Description Fetch the clients @Tags Fetch Client @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {object} []models.SwaggerClient{} @Failure 204 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/clients [get].
GetClientVariable godoc @Summary Fetch the client variable (variable that can be replaced in a given email template) @Description Fetch the client variable @Tags Fetch Client variable @Accept json @Produce json @Param clientID path string true "client ID" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 403 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/clientDetails [get].
GetNewPassword godoc @Summary GetNewPassword @Description GetNewPassword @Tags GetNewPassword @Accept json @Produce json @Param id path string true "uuid" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 412 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Router /auth/getNewPassword [post].
GetSubsDetail godoc @Summary Current subscription details @Description Get the current subscription details @Tags Subscription details @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/subscriptionDetails [get].
GetTemplates godoc @Summary Fetch the templates @Description Fetch all the registered mail templates @Tags Template details @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/getTemplates [get].
GetUsers godoc @Summary Fetch the users @Description Fetch the users registered in system @Tags Get User @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 403 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/users [get].
Login godoc @Summary Authenticate the user @Description Authenticates a user and provides jwt token @Tags login @Accept json @Produce json @Param Body body models.LoginInput true "User login" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Router /auth/login [post].
Logout godoc @Summary Logout @Description Logout @Tags Logout @Accept json @Produce json @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /privacy/logout [post].
No description provided by the author
ScheduleMail godoc @Summary schedule the mail for clients @Description schedule the mail for clients @Tags Schedule Mail @Accept json @Produce json @Param Body body []models.SendMailInput true "Send Mail Input" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 417 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/scheduleMail [post].
SendMail godoc @Summary Send mail to client @Description Sends the mail to the registered client @Tags Send Mail @Accept json @Produce json @Param Body body []models.SendMailInput true "Send Mail Input" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 417 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/sendMail [post].
Signup godoc @Summary The user account registration @Description Registers the user account @Tags signup @Accept json @Produce json @Param Body body models.SignupInput true "User SignupDetails" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Router /auth/signup [post].
Subscribe godoc @Summary User subscription @Description user can subscribe to a specific plan @Tags Subscribe @Accept json @Produce json @Param Body body models.SubscriptionInput true "subscription details" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 424 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/subscribe [post].
UpdateClient godoc @Summary Update the client details @Description Update the client details @Tags Update Client @Accept json @Produce json @Param Body body models.SwaggerClient true "client details" @Param mailId path string true "mail id" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/updateClient [put].
UpdatePassword godoc @Summary The user password update @Description Helps the user to update the password @Tags UpdatePassword @Accept json @Produce json @Param Body body models.UpdatePassword true "Update Password" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 412 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /privacy/updatePassword [post].
UpdateTemplate godoc @Summary Update the template @Description Update the template details @Tags Update Template @Accept json @Produce json @Param id path string true "template name" @Param Authorization header string true "Authentication header" @Success 200 {object} config.ApiResponse{} @Failure 400 {object} config.ApiResponse{} @Failure 204 {object} config.ApiResponse{} @Failure 500 {object} config.ApiResponse{} @Security ApiKeyAuth @Router /api/updateTemplate [put].

# Variables

No description provided by the author
No description provided by the author

# Structs

No description provided by the author