Documentation ¶
Overview ¶
Package routes Mail-Templater
Mail-Templater service is service for sending emails.
Version: 0.0.1 Consumes: - application/json Produces: - application/json
swagger:meta
Index ¶
- func MessageGetHandler(ctx *gin.Context)
- func MessageListGetHandler(ctx *gin.Context)
- func SendHandler(ctx *gin.Context)
- func SimpleSendHandler(ctx *gin.Context)
- func TemplateCreateHandler(ctx *gin.Context)
- func TemplateDeleteHandler(ctx *gin.Context)
- func TemplateGetHandler(ctx *gin.Context)
- func TemplateListGetHandler(ctx *gin.Context)
- func TemplateUpdateHandler(ctx *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MessageGetHandler ¶
swagger:operation GET /messages/{message_id} Messages MessageGetHandler Get single message. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#get-message-copy
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
- name: message_id in: path type: string required: true
responses:
'200': description: message get response schema: $ref: '#/definitions/MessageGetResponse' default: $ref: '#/responses/error'
func MessageListGetHandler ¶
swagger:operation GET /messages Messages MessageListGetHandler // Get messages list. // https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#get-messages // // --- // x-method-visibility: private // parameters: // - $ref: '#/parameters/UserRoleHeader' // - name: page // in: query // type: string // required: false // - name: per_page // in: query // type: string // required: false // responses: // '200': // description: message list get response // schema: // $ref: '#/definitions/MessageListResponse' // default: // $ref: '#/responses/error'
func SendHandler ¶
swagger:operation POST /templates/{template} Send SendHandler Send message to any email. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#send-message-extended
--- x-method-visibility: public parameters:
- name: template in: path type: string required: true
parameters:
- name: template in: path type: string required: true
- name: body in: body schema: $ref: '#/definitions/SendRequest'
responses:
'202': description: message send response schema: $ref: '#/definitions/SendResponse' default: $ref: '#/responses/error'
func SimpleSendHandler ¶
swagger:operation POST /send Send SimpleSendHandler Send message from internal service. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#send-message-for-resource-manager
--- x-method-visibility: public parameters:
- name: body in: body schema: $ref: '#/definitions/SimpleSendRequest'
responses:
'202': description: message simple send response schema: $ref: '#/definitions/SimpleSendResponse' default: $ref: '#/responses/error'
func TemplateCreateHandler ¶
swagger:operation POST /templates Templates TemplateCreateHandler Create new template. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#create-template
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
- name: body in: body schema: $ref: '#/definitions/Template'
responses:
'201': description: created template schema: $ref: '#/definitions/Template' default: $ref: '#/responses/error'
func TemplateDeleteHandler ¶
swagger:operation DELETE /templates/{name} Templates TemplateDeleteHandler Delete template. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#update-template-of-specific-version
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
- name: name in: path type: string required: true
- name: version in: query type: string required: false
responses:
'202': description: template deleted default: $ref: '#/responses/error'
func TemplateGetHandler ¶
swagger:operation GET /templates/{name} Templates TemplateGetHandler Get single template. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#get-all-versions-of-template https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#get-template-of-specific-version
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
- name: version in: query type: string required: false
- name: name in: path type: string required: true
responses:
'200': description: templates list get response schema: $ref: '#/definitions/TemplatesListResponse' default: $ref: '#/responses/error'
func TemplateListGetHandler ¶
swagger:operation GET /templates Templates TemplateListGetHandler Get templates list. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#get-all-templates
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
responses:
'200': description: templates list get response schema: $ref: '#/definitions/TemplatesListResponse' default: $ref: '#/responses/error'
func TemplateUpdateHandler ¶
swagger:operation PUT /templates/{name} Templates TemplateUpdateHandler Update template. https://ch.pages.containerum.net/api-docs/modules/ch-mail-template/index.html#update-template-of-specific-version
--- x-method-visibility: private parameters:
- $ref: '#/parameters/UserRoleHeader'
- name: name in: path type: string required: true
- name: body in: body schema: $ref: '#/definitions/Template'
responses:
'202': description: updated template schema: $ref: '#/definitions/Template' default: $ref: '#/responses/error'
Types ¶
This section is empty.