// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" const docTemplate = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/contact": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get a contact record to have a recipient to send a text to (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Get contact", "parameters": [ { "type": "string", "description": "Contact Id", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "User Id", "name": "user_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.GetContactResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.GetContactResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.GetContactResponse" } } } } }, "/contact/new": { "post": { "security": [ { "BearerAuth": [] } ], "description": "Add a contact record to have a recipient to send a text to (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "contacts" ], "summary": "Add contact", "parameters": [ { "description": "Data to add contact", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.RequestAddContact" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.AddContactResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.AddContactResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.AddContactResponse" } } } } }, "/message": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get a message record to have a recipient to send a text to (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messages" ], "summary": "Get message", "parameters": [ { "type": "string", "description": "Message Id", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "User Id", "name": "user_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.GetMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.GetMessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.GetMessageResponse" } } } } }, "/message/new": { "post": { "security": [ { "BearerAuth": [] } ], "description": "Add a message record to send a text to (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "messages" ], "summary": "Add message", "parameters": [ { "description": "Data to add message", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.RequestAddMessage" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.AddMessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.AddMessageResponse" } } } } }, "/schedule/message": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Get a scheduled message (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled messages" ], "summary": "Get scheduled message", "parameters": [ { "type": "string", "description": "Contact Id", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "User Id", "name": "user_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Adds a scheduled message (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled messages" ], "summary": "Add scheduled message", "parameters": [ { "description": "Data to add scheduled message", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.RequestAddScheduledMessage" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageResponse" } } } } }, "/schedule/message/event": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Gets a scheduled message event (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled message events" ], "summary": "Get scheduled message event", "parameters": [ { "type": "string", "description": "Contact Id", "name": "id", "in": "path", "required": true }, { "type": "string", "description": "Scheduled Message Id", "name": "scheduled_message_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.GetScheduledMessageEventResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "description": "Add a scheduled message event (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled message events" ], "summary": "Add scheduled message event", "parameters": [ { "description": "Data to add scheduled message event", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.RequestAddScheduledMessageEvent" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.AddScheduledMessageEventResponse" } } } } }, "/schedule/message/event/{id}": { "delete": { "security": [ { "BearerAuth": [] } ], "description": "Deletes a scheduled message event (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled message events" ], "summary": "Delete scheduled message event", "parameters": [ { "type": "string", "format": "uuid", "description": "scheduled message event Id", "name": "id", "in": "path", "required": true } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.DeleteScheduledMessageEventResponse" } } } } }, "/schedule/message/fetch": { "get": { "security": [ { "BearerAuth": [] } ], "description": "Fetches a scheduled message that is available to be processed (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "scheduled messages" ], "summary": "Fetch scheduled message", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.FetchNextMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.FetchNextMessageResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.FetchNextMessageResponse" } } } } }, "/schedule/message/status/update": { "patch": { "security": [ { "BearerAuth": [] } ], "description": "Update the status of a scheduled message (requires JWT)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "status" ], "summary": "Update status", "parameters": [ { "description": "Used to update scheduled message status", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.RequestScheduledMessageStatus" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/handler.ScheduledMessageStatusResponse" } } } } } }, "definitions": { "contact.Contact": { "type": "object", "properties": { "id": { "type": "string" }, "phone_number": { "type": "string" }, "user_id": { "type": "string" } } }, "handler.AddContactResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.Contact" } }, "message": { "type": "string" } } }, "handler.AddMessageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/message.Message" } }, "message": { "type": "string" } } }, "handler.AddScheduledMessageEventResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessageEvent" } }, "message": { "type": "string" } } }, "handler.AddScheduledMessageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessage" } }, "message": { "type": "string" } } }, "handler.DeleteScheduledMessageEventResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessageEvent" } }, "message": { "type": "string" } } }, "handler.FetchNextMessageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessage" } }, "message": { "type": "string" } } }, "handler.GetContactResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.Contact" } }, "message": { "type": "string" } } }, "handler.GetMessageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/message.Message" } }, "message": { "type": "string" } } }, "handler.GetScheduledMessageEventResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessageEvent" } }, "message": { "type": "string" } } }, "handler.GetScheduledMessageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/scheduling.ScheduledMessage" } }, "message": { "type": "string" } } }, "handler.RequestAddContact": { "type": "object", "properties": { "phone_number": { "type": "string" }, "user_id": { "type": "string" } } }, "handler.RequestAddMessage": { "type": "object", "properties": { "content": { "type": "string" }, "user_id": { "type": "string" } } }, "handler.RequestAddScheduledMessage": { "type": "object", "properties": { "scheduled": { "type": "string" }, "status": { "type": "string" }, "user_id": { "type": "string" } } }, "handler.RequestAddScheduledMessageEvent": { "type": "object", "properties": { "message_id": { "type": "string" }, "recipient_id": { "type": "string" }, "scheduled_message_id": { "type": "string" } } }, "handler.RequestScheduledMessageStatus": { "type": "object", "properties": { "scheduled_message_id": { "type": "string" }, "status": { "type": "string" } } }, "handler.ScheduledMessageChange": { "type": "object", "properties": { "old_status": { "type": "string" }, "scheduled_message": { "$ref": "#/definitions/scheduling.ScheduledMessage" } } }, "handler.ScheduledMessageStatusResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/handler.ScheduledMessageChange" } }, "message": { "type": "string" } } }, "message.Message": { "type": "object", "properties": { "content": { "type": "string" }, "id": { "type": "string" }, "user_id": { "type": "string" } } }, "scheduling.ScheduledMessage": { "type": "object", "properties": { "created": { "type": "string" }, "id": { "type": "string" }, "scheduled": { "type": "string" }, "status": { "type": "string" }, "user_id": { "type": "string" } } }, "scheduling.ScheduledMessageEvent": { "type": "object", "properties": { "created": { "type": "string" }, "id": { "type": "string" }, "message_id": { "type": "string" }, "recipient_id": { "type": "string" }, "scheduled_message_id": { "type": "string" } } } }, "securityDefinitions": { "BearerAuth": { "description": "JWT Bearer Token", "type": "apiKey", "name": "Authorization", "in": "header" } } }` // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", Host: "localhost:8080", BasePath: "/api/v1", Schemes: []string{}, Title: "textsender-api", Description: "Core API to send text messages", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) }