Last active
April 14, 2017 13:49
-
-
Save siwonred/c38afdf64951e945fc37f7b91f77ac81 to your computer and use it in GitHub Desktop.
ch-swagger.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger":"2.0", | |
| "info":{ | |
| "description":"Private API for channel applications.", | |
| "version":"1.0", | |
| "title":"Channel General Api" | |
| }, | |
| "basePath":"/", | |
| "tags":[ | |
| { | |
| "name":"App Channels" | |
| }, | |
| { | |
| "name":"App DeviceTokens" | |
| }, | |
| { | |
| "name":"App Guests" | |
| }, | |
| { | |
| "name":"App Managers" | |
| }, | |
| { | |
| "name":"App Messages" | |
| }, | |
| { | |
| "name":"App Plugins" | |
| }, | |
| { | |
| "name":"App Scripts" | |
| }, | |
| { | |
| "name":"App ShortLinks" | |
| }, | |
| { | |
| "name":"App UserChats" | |
| }, | |
| { | |
| "name":"Desk Bots" | |
| }, | |
| { | |
| "name":"Desk ChannelManagers" | |
| }, | |
| { | |
| "name":"Desk Channels" | |
| }, | |
| { | |
| "name":"Desk Commands" | |
| }, | |
| { | |
| "name":"Desk Credentials" | |
| }, | |
| { | |
| "name":"Desk DeviceTokens" | |
| }, | |
| { | |
| "name":"Desk DirectChats" | |
| }, | |
| { | |
| "name":"Desk Groups" | |
| }, | |
| { | |
| "name":"Desk Invite" | |
| }, | |
| { | |
| "name":"Desk Managers" | |
| }, | |
| { | |
| "name":"Desk Plugins" | |
| }, | |
| { | |
| "name":"Desk PushServices" | |
| }, | |
| { | |
| "name":"Desk Scripts" | |
| }, | |
| { | |
| "name":"Desk Sessions" | |
| }, | |
| { | |
| "name":"Desk Subscribers" | |
| }, | |
| { | |
| "name":"Desk Tutorials" | |
| }, | |
| { | |
| "name":"Desk UserChats" | |
| }, | |
| { | |
| "name":"Desk VirtualNumbers" | |
| }, | |
| { | |
| "name":"Desk WebHooks" | |
| }, | |
| { | |
| "name":"Desk Integrations" | |
| }, | |
| { | |
| "name":"Utilities" | |
| }, | |
| { | |
| "name":"2nd-party" | |
| } | |
| ], | |
| "schemes":[ | |
| "http" | |
| ], | |
| "paths":{ | |
| "/app/channels":{ | |
| "get":{ | |
| "tags":[ | |
| "App Channels" | |
| ], | |
| "summary":"Show a channel.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/channels/avatar":{ | |
| "get":{ | |
| "tags":[ | |
| "App Channels" | |
| ], | |
| "summary":"Show avatar image.", | |
| "description":"", | |
| "operationId":"showAvatar", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/app/channels/{channelId}/avatar":{ | |
| "get":{ | |
| "tags":[ | |
| "App Channels" | |
| ], | |
| "summary":"Show avatar image.", | |
| "description":"", | |
| "operationId":"showAvatarWithChannelId", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/app/device_tokens":{ | |
| "get":{ | |
| "tags":[ | |
| "App DeviceTokens" | |
| ], | |
| "summary":"List device tokens", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceTokensView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "App DeviceTokens" | |
| ], | |
| "summary":"Register a device token.", | |
| "description":"", | |
| "operationId":"register", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceToken" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceTokenView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/device_tokens/{platform}/{key}":{ | |
| "delete":{ | |
| "tags":[ | |
| "App DeviceTokens" | |
| ], | |
| "summary":"Delete a device token", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"platform", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/app/guests/me":{ | |
| "get":{ | |
| "tags":[ | |
| "App Guests" | |
| ], | |
| "summary":"Show current guest.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GuestView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/guests":{ | |
| "put":{ | |
| "tags":[ | |
| "App Guests" | |
| ], | |
| "summary":"Update a guest.", | |
| "description":"", | |
| "operationId":"Update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Profile" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GuestView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/managers/{managerId}":{ | |
| "get":{ | |
| "tags":[ | |
| "App Managers" | |
| ], | |
| "summary":"Show a channel manager", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"managerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/messages/{messageId}":{ | |
| "get":{ | |
| "tags":[ | |
| "App Messages" | |
| ], | |
| "summary":"Show a message.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"messageId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/plugins/{key}":{ | |
| "get":{ | |
| "tags":[ | |
| "App Plugins" | |
| ], | |
| "summary":"Show a plugin with channel.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/plugins/{key}/check_in":{ | |
| "post":{ | |
| "tags":[ | |
| "App Plugins" | |
| ], | |
| "summary":"Check in with a plugin.", | |
| "description":"Before call this API, you have to check in basis cookie.", | |
| "operationId":"checkIn", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| }, | |
| { | |
| "name":"url", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"visitId", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"referer", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"title", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"screen", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Profile" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CheckInView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/scripts":{ | |
| "get":{ | |
| "tags":[ | |
| "App Scripts" | |
| ], | |
| "summary":"List scripts", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ScriptsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/short_links/{token}":{ | |
| "get":{ | |
| "tags":[ | |
| "App ShortLinks" | |
| ], | |
| "summary":"Show a short link", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"token", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ShortLinkView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"List of user chats.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "default":"updatedAt" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Create a user chat.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats/{userChatId}/close":{ | |
| "put":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Close a user chat", | |
| "description":"", | |
| "operationId":"close", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats/{userChatId}/messages":{ | |
| "get":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"List of messages.", | |
| "description":"", | |
| "operationId":"indexMessages", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessagesView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Create a message.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats/{userChatId}/messages/read_all":{ | |
| "put":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Mark all messages as read.", | |
| "description":"", | |
| "operationId":"read_all", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats/{userChatId}/messages/file":{ | |
| "post":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Upload a file.", | |
| "description":"", | |
| "operationId":"uploadFile", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"name", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| }, | |
| { | |
| "name":"requestId", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/app/user_chats/{userChatId}":{ | |
| "get":{ | |
| "tags":[ | |
| "App UserChats" | |
| ], | |
| "summary":"Show a user chat.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/bots/{id}":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Bots" | |
| ], | |
| "summary":"Delete a bot", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channel_managers/{channelManagerId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk ChannelManagers" | |
| ], | |
| "summary":"Show a channel manager", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelManagerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManagerView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk ChannelManagers" | |
| ], | |
| "summary":"Update a channel manager", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelManagerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManager" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManagerView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk ChannelManagers" | |
| ], | |
| "summary":"Delete a channel manager", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelManagerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of channels.", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a channel.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Channel" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/groups":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of groups", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a group", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Group" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/search":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Search Query", | |
| "description":"", | |
| "operationId":"query", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"query", | |
| "in":"query", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":true, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":0, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ElasticsearchPagination" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/messages/{messageId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Get a message.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"messageId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/messages/{messageId}/sms_logs":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List smsLogs", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"messageId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SMSLogsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/page_views/{pageViewId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Get a pageView", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"pageViewId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PageViewView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{id}/avatar":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show avatar image.", | |
| "description":"", | |
| "operationId":"showAvatar", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Upload avatar.", | |
| "description":"", | |
| "operationId":"uploadAvatar", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a channel by id.", | |
| "description":"", | |
| "operationId":"showById", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Update a channel.", | |
| "description":"", | |
| "operationId":"updateById", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Channel" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{domain}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a channel by domain.", | |
| "description":"", | |
| "operationId":"showByDomain", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"domain", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"[a-z][\\da-z-]*" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/bots":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List bots", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/BotsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a bot", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Bot" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/BotView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/credentials":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List credentials", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CredentialsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a credential", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Credential" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CredentialView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/invites":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Invite a manager.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Invite" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/InviteView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/team_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"list all team chats", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/TeamChatsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/direct_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of direct chats", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DirectChatsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a direct chat", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/DirectChat" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DirectChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/integrations":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of integrations", | |
| "description":"", | |
| "operationId":"retrieveChannelIntegrations", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/IntegrationsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/integrations/slack/connect":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Connect to Slack", | |
| "description":"", | |
| "operationId":"connect", | |
| "produces":[ | |
| "text/html; charset=utf-8", | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"callbackUri", | |
| "in":"query", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"ott", | |
| "in":"query", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/integrations/slack/authorize":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Callback for initial slack authorization.", | |
| "description":"", | |
| "operationId":"authorize", | |
| "produces":[ | |
| "text/html; charset=utf-8", | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"code", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/meta_schema":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List meta schema", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MetaSchemaView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/plugins":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List plugins", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a plugin.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Plugin" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/scripts":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List scripts", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ScriptsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Upsert a script.", | |
| "description":"", | |
| "operationId":"upsert", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Script" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ScriptView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/webhooks":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List webhooks", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/WebhooksView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a webhook", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Webhook" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/WebhookView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/push_services":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of push services", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PushServicesView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Upsert a push service", | |
| "description":"", | |
| "operationId":"upsert", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/PushService" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PushServiceView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/virtual_number":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a virtual number", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VirtualNumberView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a virtual number", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"virtualNumber", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VirtualNumberView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Delete a virtual number", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/leave":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Leave a channel.", | |
| "description":"", | |
| "operationId":"leave", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/managers":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of managers.", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManagersView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/managers/{managerId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a manager.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"managerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/guests":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List customers", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"createdAt" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":true, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":0, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ElasticsearchPagination" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/guests/count":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Get number of all customers", | |
| "description":"", | |
| "operationId":"count", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CountView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/onlines":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List onlines", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/OnlinesView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/onlines/users/{userId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Check a user is online or not", | |
| "description":"", | |
| "operationId":"user", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/OnlineView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/onlines/veils/{veilId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Check a veil is online or not", | |
| "description":"", | |
| "operationId":"veil", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/OnlineView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/commands":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List commands", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CommandsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create a command", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Command" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CommandView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/user_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List of user chats.", | |
| "description":"", | |
| "operationId":"anyone", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "description":"UserChat's state", | |
| "required":false, | |
| "type":"string", | |
| "enum":[ | |
| "new", | |
| "open", | |
| "resolved", | |
| "closed" | |
| ] | |
| }, | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/user_chats/assigned/me":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List user chats .", | |
| "description":"", | |
| "operationId":"assignedToMe", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "description":"UserChat's state", | |
| "required":false, | |
| "type":"string", | |
| "enum":[ | |
| "new", | |
| "open", | |
| "resolved", | |
| "closed" | |
| ] | |
| }, | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/user_chats/unassigned":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List unassigned user chats.", | |
| "description":"", | |
| "operationId":"unassignedUserChats", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "description":"UserChat's state", | |
| "required":false, | |
| "type":"string", | |
| "enum":[ | |
| "new", | |
| "open", | |
| "resolved", | |
| "closed" | |
| ] | |
| }, | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/user_chats/unread":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List unread user chats.", | |
| "description":"", | |
| "operationId":"unreadUserChats", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"state", | |
| "in":"query", | |
| "description":"UserChat's state", | |
| "required":false, | |
| "type":"string", | |
| "enum":[ | |
| "new", | |
| "open", | |
| "resolved", | |
| "closed" | |
| ] | |
| }, | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/users/{userId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a user", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Delete a user", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/users/{userId}/page_views":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List pageviews", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PageViewsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/users/{userId}/user_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List userChats of a channel's guest", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create userChat of a channel's guest", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/veils/{veilId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Show a veil", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VeilView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Update a veil", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Profile" | |
| } | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VeilView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Delete a veil", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/veils/{veilId}/page_views":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List pageviews", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "default":25, | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PageViewsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/channels/{channelId}/veils/{veilId}/user_chats":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"List userChats of a channel's guest", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"sortField", | |
| "in":"query", | |
| "description":"Sort criteria", | |
| "required":true, | |
| "type":"string", | |
| "default":"updatedAt", | |
| "enum":[ | |
| "createdAt", | |
| "openedAt", | |
| "updatedAt" | |
| ] | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatsView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Channels" | |
| ], | |
| "summary":"Create userChat of a channel's guest", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"veilId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"channelId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/commands/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Commands" | |
| ], | |
| "summary":"Show a command by id.", | |
| "description":"", | |
| "operationId":"get", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Command" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CommandView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Commands" | |
| ], | |
| "summary":"Update a command.", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Command" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CommandView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Commands" | |
| ], | |
| "summary":"Delete a command.", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/credentials/{id}":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Credentials" | |
| ], | |
| "summary":"Update a credential.", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Credential" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CredentialView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Credentials" | |
| ], | |
| "summary":"Delete a credential", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/device_tokens":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk DeviceTokens" | |
| ], | |
| "summary":"List device tokens", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceTokensView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk DeviceTokens" | |
| ], | |
| "summary":"Register a device token", | |
| "description":"", | |
| "operationId":"register", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceToken" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DeviceTokenView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/device_tokens/{platform}/{key}":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk DeviceTokens" | |
| ], | |
| "summary":"Delete a device token", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"platform", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}/messages":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"List of messages.", | |
| "description":"", | |
| "operationId":"indexMessages", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessagesView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"Create a message.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}/messages/read_all":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"Mark all messages as read.", | |
| "description":"", | |
| "operationId":"read_all", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}/messages/file":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"Upload a file.", | |
| "description":"", | |
| "operationId":"uploadFile", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"name", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| }, | |
| { | |
| "name":"requestId", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"scope", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"Show a direct chat", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/DirectChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}/leave":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"Leave a direct chat", | |
| "description":"", | |
| "operationId":"leave", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/direct_chats/{directChatId}/sessions":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk DirectChats" | |
| ], | |
| "summary":"List sessions.", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"directChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SessionsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Show a group", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Update a group", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Group" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/join":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Join a group", | |
| "description":"", | |
| "operationId":"join", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/messages":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"List of messages.", | |
| "description":"", | |
| "operationId":"indexMessages", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessagesView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Create a message.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/messages/read_all":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Mark all messages as read.", | |
| "description":"", | |
| "operationId":"read_all", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/messages/file":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Upload a file.", | |
| "description":"", | |
| "operationId":"uploadFile", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"name", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| }, | |
| { | |
| "name":"requestId", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"scope", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/leave":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Leave a group", | |
| "description":"", | |
| "operationId":"leave", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/sessions":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"List sessions.", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SessionsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/groups/{groupId}/invite":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Groups" | |
| ], | |
| "summary":"Invite to group", | |
| "description":"", | |
| "operationId":"invite", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"groupId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"managerIds", | |
| "in":"query", | |
| "required":false, | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| }, | |
| "collectionFormat":"multi" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GroupView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/invites/{key}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Invite" | |
| ], | |
| "summary":"Show an invite", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/InviteView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Invite" | |
| ], | |
| "summary":"Accept an invite", | |
| "description":"", | |
| "operationId":"accept", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/ChannelManager" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/InviteView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/me":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Show current manager.", | |
| "description":"", | |
| "operationId":"me", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Update current manager.", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/me/change_password":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Update current manager's password.", | |
| "description":"", | |
| "operationId":"update", | |
| "consumes":[ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"password", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"newPassword", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"newPasswordConfirmation", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Create a manager with name, email and password.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/{managerId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Show a manager.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"managerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/{managerId}/avatar":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Show avatar image.", | |
| "description":"", | |
| "operationId":"showAvatar", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"managerId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/me/avatar":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Upload avatar.", | |
| "description":"", | |
| "operationId":"uploadAvatar", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/sign_in":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Sign-in a manager.", | |
| "description":"", | |
| "operationId":"signIn", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/password_resets/{key}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Get reset password entity", | |
| "description":"", | |
| "operationId":"resetPassword", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PasswordResetView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Reset password", | |
| "description":"", | |
| "operationId":"resetPassword", | |
| "consumes":[ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"key", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "format":"uuid" | |
| }, | |
| { | |
| "name":"password", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"passwordConfirmation", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/password_resets":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Request to reset password.", | |
| "description":"", | |
| "operationId":"requestToResetPassword", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/PasswordReset" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PasswordResetView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/sign_out":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Sign-out a manager.", | |
| "description":"", | |
| "operationId":"signOut", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/sign_in_form":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Sign-in a manager.", | |
| "description":"", | |
| "operationId":"signInForm", | |
| "consumes":[ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"email", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"password", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ManagerView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/managers/me/ott":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Managers" | |
| ], | |
| "summary":"Generate OTT(One Time Token)", | |
| "description":"", | |
| "operationId":"ottGenerate", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/OTTView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/plugins/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Show a plugin by id.", | |
| "description":"", | |
| "operationId":"showById", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Update a plugin.", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Plugin" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Delete a plugin.", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/plugins/dummy":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Create a dummy plugin.", | |
| "description":"", | |
| "operationId":"createDummy", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Plugin" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/plugins/{id}/desk_image":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Upload an desk image.", | |
| "description":"", | |
| "operationId":"uploadDeskImage", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Delete an desk image.", | |
| "description":"", | |
| "operationId":"deleteDeskImage", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/plugins/{id}/mobile_image":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Upload an mobile image.", | |
| "description":"", | |
| "operationId":"uploadMobileImage", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk Plugins" | |
| ], | |
| "summary":"Delete an mobile image.", | |
| "description":"", | |
| "operationId":"deleteMobileImage", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string", | |
| "pattern":"\\d+" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/push_service/apns":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk PushServices" | |
| ], | |
| "summary":"Decode the credential from p12 file", | |
| "description":"", | |
| "operationId":"apns", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"p12file", | |
| "in":"formData", | |
| "required":true, | |
| "type":"file" | |
| }, | |
| { | |
| "name":"password", | |
| "in":"formData", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/ApnsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/push_services/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk PushServices" | |
| ], | |
| "summary":"Show a push service by id.", | |
| "description":"", | |
| "operationId":"get", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PushServiceView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk PushServices" | |
| ], | |
| "summary":"Delete a push service", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/scripts/{id}":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Scripts" | |
| ], | |
| "summary":"Delete a script", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/sessions/{id}":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk Sessions" | |
| ], | |
| "summary":"Update a session", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SessionView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/subscribers":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk Subscribers" | |
| ], | |
| "summary":"Create a subscriber.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Subscriber" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SubscriberView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/tutorials":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk Tutorials" | |
| ], | |
| "summary":"Get tutorial status of manager", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/TutorialView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk Tutorials" | |
| ], | |
| "summary":"Upsert tutorial status of manager", | |
| "description":"", | |
| "operationId":"upsert", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Tutorial" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/TutorialView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/join":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Join a user chat", | |
| "description":"", | |
| "operationId":"join", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/resolve":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Resolve a user chat", | |
| "description":"", | |
| "operationId":"close", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/open":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Open a user chat", | |
| "description":"", | |
| "operationId":"open", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/messages":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"List of messages.", | |
| "description":"", | |
| "operationId":"indexMessages", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"since", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"limit", | |
| "in":"query", | |
| "required":false, | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| { | |
| "name":"sortOrder", | |
| "in":"query", | |
| "required":true, | |
| "type":"string", | |
| "default":"DESC", | |
| "enum":[ | |
| "ASC", | |
| "DESC", | |
| "BOTH" | |
| ] | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessagesView" | |
| } | |
| } | |
| } | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Create a message.", | |
| "description":"", | |
| "operationId":"create", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/messages/read_all":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Mark all messages as read.", | |
| "description":"", | |
| "operationId":"read_all", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/messages/file":{ | |
| "post":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Upload a file.", | |
| "description":"", | |
| "operationId":"uploadFile", | |
| "consumes":[ | |
| "multipart/form-data" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"name", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"file", | |
| "in":"formData", | |
| "required":false, | |
| "type":"file" | |
| }, | |
| { | |
| "name":"requestId", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"scope", | |
| "in":"formData", | |
| "required":false, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/MessageView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Get a user chat.", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/leave":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Leave a user chat", | |
| "description":"", | |
| "operationId":"leave", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/sessions":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"List sessions.", | |
| "description":"", | |
| "operationId":"index", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/SessionsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/user_chats/{userChatId}/invite":{ | |
| "put":{ | |
| "tags":[ | |
| "Desk UserChats" | |
| ], | |
| "summary":"Invite to user chat", | |
| "description":"", | |
| "operationId":"invite", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"userChatId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"managerIds", | |
| "in":"query", | |
| "required":false, | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| }, | |
| "collectionFormat":"multi" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UserChatView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/virtual_numbers/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk VirtualNumbers" | |
| ], | |
| "summary":"Show a virtual number by id.", | |
| "description":"", | |
| "operationId":"get", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VirtualNumberView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/virtual_numbers/available":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk VirtualNumbers" | |
| ], | |
| "summary":"List all available virtual numbers", | |
| "description":"", | |
| "operationId":"allAvailable", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VirtualNumbersView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/webhooks/{id}":{ | |
| "get":{ | |
| "tags":[ | |
| "Desk WebHooks" | |
| ], | |
| "summary":"Show a webhook by id.", | |
| "description":"", | |
| "operationId":"get", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/WebhookView" | |
| } | |
| } | |
| } | |
| }, | |
| "put":{ | |
| "tags":[ | |
| "Desk WebHooks" | |
| ], | |
| "summary":"Update a webhook.", | |
| "description":"", | |
| "operationId":"update", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "in":"body", | |
| "name":"body", | |
| "required":false, | |
| "schema":{ | |
| "$ref":"#/definitions/Webhook" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/WebhookView" | |
| } | |
| } | |
| } | |
| }, | |
| "delete":{ | |
| "tags":[ | |
| "Desk WebHooks" | |
| ], | |
| "summary":"Delete a webhook.", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"id", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/desk/integrations/{integrationId}":{ | |
| "delete":{ | |
| "tags":[ | |
| "Desk Integrations" | |
| ], | |
| "summary":"Delete an integration", | |
| "description":"", | |
| "operationId":"delete", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"integrationId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/countries":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Show supported countries", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/CountriesView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/geoip":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Determine the IP address location", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/GeoIPView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ott/{ott}/test":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Test OTT(One Time Token)", | |
| "description":"", | |
| "operationId":"ottTest", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"ott", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/packages/{packageId}/versions/latest":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Show a latest version", | |
| "description":"", | |
| "operationId":"latest", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"packageId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| }, | |
| { | |
| "name":"from", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PackageVersionView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/ping":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"ping pong", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "text/plain" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "default":{ | |
| "description":"successful operation" | |
| } | |
| } | |
| } | |
| }, | |
| "/2nd-party/plugins":{ | |
| "get":{ | |
| "tags":[ | |
| "2nd-party" | |
| ], | |
| "summary":"Retrieve all plugins by manager's email.", | |
| "description":"", | |
| "operationId":"indexByEmail", | |
| "consumes":[ | |
| "application/x-www-form-urlencoded" | |
| ], | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"email", | |
| "in":"query", | |
| "required":false, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/PluginsView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/time_zones":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Show supported timezones", | |
| "description":"", | |
| "operationId":"show", | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/TimeZonesView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/unique_id/{uniqueId}":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Parse UniqueId", | |
| "description":"", | |
| "operationId":"parse", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| { | |
| "name":"uniqueId", | |
| "in":"path", | |
| "required":true, | |
| "type":"string" | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UniqueIdView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/unique_id/new":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Get a new UniqueId", | |
| "description":"", | |
| "operationId":"newUid", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/UniqueIdView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/version":{ | |
| "get":{ | |
| "tags":[ | |
| "Utilities" | |
| ], | |
| "summary":"Show a latest server version", | |
| "description":"", | |
| "operationId":"show", | |
| "produces":[ | |
| "application/json" | |
| ], | |
| "parameters":[ | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"successful operation", | |
| "schema":{ | |
| "$ref":"#/definitions/VersionView" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "definitions":{ | |
| "Channel":{ | |
| "type":"object", | |
| "required":[ | |
| "domain", | |
| "name" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string", | |
| "pattern":"[0-9a-z-]+" | |
| }, | |
| "description":{ | |
| "type":"string" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "domain":{ | |
| "type":"string", | |
| "pattern":"[0-9a-z-]+" | |
| }, | |
| "color":{ | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "textColor":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "userInfoUrl":{ | |
| "type":"string" | |
| }, | |
| "timeZone":{ | |
| "$ref":"#/definitions/ZoneId" | |
| }, | |
| "workingTime":{ | |
| "$ref":"#/definitions/TimeRangeWeekly" | |
| }, | |
| "lunchTime":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "outOfWorkPlugin":{ | |
| "type":"boolean" | |
| }, | |
| "utmSource":{ | |
| "type":"string" | |
| }, | |
| "homepageUrl":{ | |
| "type":"string" | |
| }, | |
| "phoneNumber":{ | |
| "type":"string" | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "working":{ | |
| "type":"boolean" | |
| }, | |
| "initial":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "ChannelView":{ | |
| "type":"object", | |
| "properties":{ | |
| "channel":{ | |
| "$ref":"#/definitions/Channel" | |
| } | |
| } | |
| }, | |
| "Color":{ | |
| "type":"object", | |
| "properties":{ | |
| "red":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "green":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "blue":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "alpha":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "rgb":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "colorSpace":{ | |
| "$ref":"#/definitions/ColorSpace" | |
| }, | |
| "transparency":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "ColorSpace":{ | |
| "type":"object", | |
| "properties":{ | |
| "type":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "numComponents":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "cs_sRGB":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "Duration":{ | |
| "type":"object", | |
| "properties":{ | |
| "seconds":{ | |
| "type":"integer", | |
| "format":"int64" | |
| }, | |
| "nano":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "zero":{ | |
| "type":"boolean" | |
| }, | |
| "negative":{ | |
| "type":"boolean" | |
| }, | |
| "units":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/TemporalUnit" | |
| } | |
| } | |
| } | |
| }, | |
| "LocalTime":{ | |
| "type":"object", | |
| "properties":{ | |
| "hour":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "minute":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "second":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "nano":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "Locale":{ | |
| "type":"object", | |
| "properties":{ | |
| "language":{ | |
| "type":"string" | |
| }, | |
| "script":{ | |
| "type":"string" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "variant":{ | |
| "type":"string" | |
| }, | |
| "extensionKeys":{ | |
| "type":"array", | |
| "uniqueItems":true, | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "unicodeLocaleAttributes":{ | |
| "type":"array", | |
| "uniqueItems":true, | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "unicodeLocaleKeys":{ | |
| "type":"array", | |
| "uniqueItems":true, | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "iso3Language":{ | |
| "type":"string" | |
| }, | |
| "iso3Country":{ | |
| "type":"string" | |
| }, | |
| "displayLanguage":{ | |
| "type":"string" | |
| }, | |
| "displayScript":{ | |
| "type":"string" | |
| }, | |
| "displayCountry":{ | |
| "type":"string" | |
| }, | |
| "displayVariant":{ | |
| "type":"string" | |
| }, | |
| "displayName":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "MobileNumber":{ | |
| "type":"object", | |
| "properties":{ | |
| "value":{ | |
| "type":"string" | |
| }, | |
| "region":{ | |
| "type":"string" | |
| }, | |
| "internationalNumber":{ | |
| "type":"string" | |
| }, | |
| "korean":{ | |
| "type":"boolean" | |
| }, | |
| "valid":{ | |
| "type":"boolean" | |
| }, | |
| "locale":{ | |
| "$ref":"#/definitions/Locale" | |
| }, | |
| "nationalNumber":{ | |
| "type":"string" | |
| }, | |
| "nationalNumberDigits":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "TemporalUnit":{ | |
| "type":"object", | |
| "properties":{ | |
| "timeBased":{ | |
| "type":"boolean" | |
| }, | |
| "duration":{ | |
| "$ref":"#/definitions/Duration" | |
| }, | |
| "dateBased":{ | |
| "type":"boolean" | |
| }, | |
| "durationEstimated":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "TimeRange":{ | |
| "type":"object", | |
| "properties":{ | |
| "from":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "to":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "TimeRangeWeekly":{ | |
| "type":"object", | |
| "properties":{ | |
| "mon":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "tue":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "wed":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "thu":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "fri":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "sat":{ | |
| "$ref":"#/definitions/TimeRange" | |
| }, | |
| "sun":{ | |
| "$ref":"#/definitions/TimeRange" | |
| } | |
| } | |
| }, | |
| "User":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "mobileNumber":{ | |
| "$ref":"#/definitions/MobileNumber" | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "meta":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "type":"object" | |
| } | |
| }, | |
| "ghost":{ | |
| "type":"boolean" | |
| }, | |
| "locale":{ | |
| "type":"string", | |
| "pattern":"[a-z]{2}" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "city":{ | |
| "type":"string" | |
| }, | |
| "latitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "longitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "lastPageViewId":{ | |
| "type":"string" | |
| }, | |
| "pageViewsCount":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "visitsCount":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "alert":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "unread":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "initial":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "Veil":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "mobileNumber":{ | |
| "$ref":"#/definitions/MobileNumber" | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "meta":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "type":"object" | |
| } | |
| }, | |
| "ghost":{ | |
| "type":"boolean" | |
| }, | |
| "locale":{ | |
| "type":"string", | |
| "pattern":"[a-z]{2}" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "city":{ | |
| "type":"string" | |
| }, | |
| "latitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "longitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "lastPageViewId":{ | |
| "type":"string" | |
| }, | |
| "pageViewsCount":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "visitsCount":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "alert":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "unread":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "initial":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "ZoneId":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "rules":{ | |
| "$ref":"#/definitions/ZoneRules" | |
| } | |
| } | |
| }, | |
| "ZoneOffset":{ | |
| "type":"object", | |
| "properties":{ | |
| "totalSeconds":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "rules":{ | |
| "$ref":"#/definitions/ZoneRules" | |
| } | |
| } | |
| }, | |
| "ZoneOffsetTransition":{ | |
| "type":"object", | |
| "properties":{ | |
| "offsetBefore":{ | |
| "$ref":"#/definitions/ZoneOffset" | |
| }, | |
| "offsetAfter":{ | |
| "$ref":"#/definitions/ZoneOffset" | |
| }, | |
| "duration":{ | |
| "$ref":"#/definitions/Duration" | |
| }, | |
| "gap":{ | |
| "type":"boolean" | |
| }, | |
| "overlap":{ | |
| "type":"boolean" | |
| }, | |
| "dateTimeAfter":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "instant":{ | |
| "type":"integer", | |
| "format":"int64" | |
| }, | |
| "dateTimeBefore":{ | |
| "type":"string", | |
| "format":"date-time" | |
| } | |
| } | |
| }, | |
| "ZoneOffsetTransitionRule":{ | |
| "type":"object", | |
| "properties":{ | |
| "month":{ | |
| "type":"string", | |
| "enum":[ | |
| "JANUARY", | |
| "FEBRUARY", | |
| "MARCH", | |
| "APRIL", | |
| "MAY", | |
| "JUNE", | |
| "JULY", | |
| "AUGUST", | |
| "SEPTEMBER", | |
| "OCTOBER", | |
| "NOVEMBER", | |
| "DECEMBER" | |
| ] | |
| }, | |
| "timeDefinition":{ | |
| "type":"string", | |
| "enum":[ | |
| "UTC", | |
| "WALL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "standardOffset":{ | |
| "$ref":"#/definitions/ZoneOffset" | |
| }, | |
| "offsetBefore":{ | |
| "$ref":"#/definitions/ZoneOffset" | |
| }, | |
| "offsetAfter":{ | |
| "$ref":"#/definitions/ZoneOffset" | |
| }, | |
| "dayOfWeek":{ | |
| "type":"string", | |
| "enum":[ | |
| "MONDAY", | |
| "TUESDAY", | |
| "WEDNESDAY", | |
| "THURSDAY", | |
| "FRIDAY", | |
| "SATURDAY", | |
| "SUNDAY" | |
| ] | |
| }, | |
| "dayOfMonthIndicator":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "localTime":{ | |
| "$ref":"#/definitions/LocalTime" | |
| }, | |
| "midnightEndOfDay":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "ZoneRules":{ | |
| "type":"object", | |
| "properties":{ | |
| "fixedOffset":{ | |
| "type":"boolean" | |
| }, | |
| "transitions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/ZoneOffsetTransition" | |
| } | |
| }, | |
| "transitionRules":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/ZoneOffsetTransitionRule" | |
| } | |
| } | |
| } | |
| }, | |
| "DeviceToken":{ | |
| "type":"object", | |
| "required":[ | |
| "key", | |
| "platform", | |
| "token" | |
| ], | |
| "properties":{ | |
| "platform":{ | |
| "type":"string", | |
| "pattern":"(android|ios)" | |
| }, | |
| "key":{ | |
| "type":"string" | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "token":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "expireAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "personKey":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "DeviceTokensView":{ | |
| "type":"object", | |
| "properties":{ | |
| "previous":{ | |
| "type":"string" | |
| }, | |
| "next":{ | |
| "type":"string" | |
| }, | |
| "deviceTokens":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/DeviceToken" | |
| } | |
| } | |
| } | |
| }, | |
| "DeviceTokenView":{ | |
| "type":"object", | |
| "properties":{ | |
| "deviceToken":{ | |
| "$ref":"#/definitions/DeviceToken" | |
| } | |
| } | |
| }, | |
| "GuestView":{ | |
| "type":"object", | |
| "properties":{ | |
| "user":{ | |
| "$ref":"#/definitions/User" | |
| }, | |
| "veil":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| }, | |
| "Profile":{ | |
| "type":"object", | |
| "properties":{ | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "mobileNumber":{ | |
| "type":"string" | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "meta":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "type":"object" | |
| } | |
| } | |
| } | |
| }, | |
| "ChannelManager":{ | |
| "type":"object", | |
| "required":[ | |
| "username" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "managerId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "role":{ | |
| "type":"string", | |
| "pattern":"admin|member|owner" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "username":{ | |
| "type":"string", | |
| "pattern":"[a-z0-9]+" | |
| }, | |
| "teamChatsAlert":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "teamChatsUnread":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "userChatsAlert":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "userChatsUnread":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "defaultWatch":{ | |
| "type":"string", | |
| "pattern":"(all|info|none)" | |
| }, | |
| "watchPublicUserChats":{ | |
| "type":"boolean" | |
| }, | |
| "alert":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "unread":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "ChannelManagerView":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelManager":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/ChannelManager" | |
| }, | |
| "manager":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| }, | |
| "Manager":{ | |
| "type":"object", | |
| "required":[ | |
| "email", | |
| "name" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "email":{ | |
| "type":"string" | |
| }, | |
| "mobileNumber":{ | |
| "type":"string" | |
| }, | |
| "authToken":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "admin":{ | |
| "type":"boolean", | |
| "readOnly":true | |
| }, | |
| "locale":{ | |
| "type":"string", | |
| "pattern":"[a-z]{2}" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "address":{ | |
| "type":"string" | |
| }, | |
| "latitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "longitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "username":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "online":{ | |
| "type":"boolean", | |
| "readOnly":true | |
| }, | |
| "alert":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "unread":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "initial":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "File":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "filename":{ | |
| "type":"string" | |
| }, | |
| "size":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "type":{ | |
| "type":"string" | |
| }, | |
| "extension":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "url":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "previewThumb":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Thumb" | |
| }, | |
| "image":{ | |
| "type":"boolean", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "Log":{ | |
| "type":"object", | |
| "properties":{ | |
| "action":{ | |
| "type":"string" | |
| }, | |
| "object":{ | |
| "type":"string" | |
| }, | |
| "objectId":{ | |
| "type":"string" | |
| }, | |
| "objectType":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "Message":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "chatType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "chatId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "scope":{ | |
| "type":"string" | |
| }, | |
| "message":{ | |
| "type":"string" | |
| }, | |
| "requestId":{ | |
| "type":"string" | |
| }, | |
| "file":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/File" | |
| }, | |
| "log":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Log" | |
| }, | |
| "webPage":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/WebPage" | |
| }, | |
| "notifiedBy":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "chatKey":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "MessageView":{ | |
| "type":"object", | |
| "properties":{ | |
| "message":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| } | |
| }, | |
| "Thumb":{ | |
| "type":"object", | |
| "properties":{ | |
| "url":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "width":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "height":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "WebPage":{ | |
| "type":"object", | |
| "required":[ | |
| "url" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "url":{ | |
| "type":"string" | |
| }, | |
| "title":{ | |
| "type":"string" | |
| }, | |
| "description":{ | |
| "type":"string" | |
| }, | |
| "imageUrl":{ | |
| "type":"string" | |
| }, | |
| "contentLength":{ | |
| "type":"integer", | |
| "format":"int64" | |
| }, | |
| "contentType":{ | |
| "type":"string" | |
| }, | |
| "previewThumb":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Thumb" | |
| } | |
| } | |
| }, | |
| "I18nText":{ | |
| "type":"object", | |
| "properties":{ | |
| "en":{ | |
| "type":"string" | |
| }, | |
| "ja":{ | |
| "type":"string" | |
| }, | |
| "ko":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "Plugin":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "key":{ | |
| "type":"string", | |
| "format":"uuid", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "color":{ | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "text":{ | |
| "type":"string" | |
| }, | |
| "i18n":{ | |
| "$ref":"#/definitions/I18nText" | |
| }, | |
| "deskMarginX":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "deskMarginY":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "mobileMarginX":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "mobileMarginY":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "mobileHideButton":{ | |
| "type":"boolean" | |
| }, | |
| "deskImage":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Thumb" | |
| }, | |
| "mobileImage":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Thumb" | |
| }, | |
| "borderColor":{ | |
| "type":"string" | |
| }, | |
| "textColor":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "PluginView":{ | |
| "type":"object", | |
| "properties":{ | |
| "plugin":{ | |
| "$ref":"#/definitions/Plugin" | |
| } | |
| } | |
| }, | |
| "CheckInView":{ | |
| "type":"object", | |
| "properties":{ | |
| "channel":{ | |
| "$ref":"#/definitions/Channel" | |
| }, | |
| "plugin":{ | |
| "$ref":"#/definitions/Plugin" | |
| }, | |
| "user":{ | |
| "$ref":"#/definitions/User" | |
| }, | |
| "veil":{ | |
| "$ref":"#/definitions/Veil" | |
| }, | |
| "pageView":{ | |
| "$ref":"#/definitions/PageView" | |
| }, | |
| "veilId":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "PageView":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "userId":{ | |
| "type":"string" | |
| }, | |
| "veilId":{ | |
| "type":"string" | |
| }, | |
| "pluginId":{ | |
| "type":"string" | |
| }, | |
| "visitId":{ | |
| "type":"string" | |
| }, | |
| "url":{ | |
| "type":"string" | |
| }, | |
| "title":{ | |
| "type":"string" | |
| }, | |
| "screen":{ | |
| "type":"string" | |
| }, | |
| "browser":{ | |
| "type":"string" | |
| }, | |
| "device":{ | |
| "type":"string" | |
| }, | |
| "os":{ | |
| "type":"string" | |
| }, | |
| "ip":{ | |
| "type":"string" | |
| }, | |
| "enter":{ | |
| "type":"boolean" | |
| }, | |
| "referer":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| } | |
| } | |
| }, | |
| "Script":{ | |
| "type":"object", | |
| "required":[ | |
| "key", | |
| "message" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "key":{ | |
| "type":"string" | |
| }, | |
| "message":{ | |
| "type":"string" | |
| }, | |
| "i18n":{ | |
| "$ref":"#/definitions/I18nText" | |
| } | |
| } | |
| }, | |
| "ScriptsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "scripts":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Script" | |
| } | |
| } | |
| } | |
| }, | |
| "ShortLink":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "token":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "entityType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "entityId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "ShortLinkView":{ | |
| "type":"object", | |
| "properties":{ | |
| "shortLink":{ | |
| "$ref":"#/definitions/ShortLink" | |
| }, | |
| "userChat":{ | |
| "$ref":"#/definitions/UserChat" | |
| } | |
| } | |
| }, | |
| "UserChat":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "personType":{ | |
| "type":"string" | |
| }, | |
| "personId":{ | |
| "type":"string" | |
| }, | |
| "bindFromId":{ | |
| "type":"string" | |
| }, | |
| "state":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "lastMessageId":{ | |
| "type":"string" | |
| }, | |
| "openedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "notifiedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "alert":{ | |
| "type":"boolean" | |
| }, | |
| "unread":{ | |
| "type":"boolean" | |
| }, | |
| "talkedManagerIds":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "assigned":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "Session":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "chatType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "chatId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "alert":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "unread":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "watch":{ | |
| "type":"string", | |
| "pattern":"(all|info|none)" | |
| }, | |
| "lastReadAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "UserChatView":{ | |
| "type":"object", | |
| "properties":{ | |
| "userChat":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/UserChat" | |
| }, | |
| "session":{ | |
| "$ref":"#/definitions/Session" | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| }, | |
| "message":{ | |
| "$ref":"#/definitions/Message" | |
| }, | |
| "user":{ | |
| "$ref":"#/definitions/User" | |
| }, | |
| "veil":{ | |
| "$ref":"#/definitions/Veil" | |
| }, | |
| "online":{ | |
| "$ref":"#/definitions/Online" | |
| } | |
| } | |
| }, | |
| "Bot":{ | |
| "type":"object", | |
| "required":[ | |
| "name" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "avatarUrl":{ | |
| "type":"string" | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| }, | |
| "initial":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "MessagesView":{ | |
| "type":"object", | |
| "properties":{ | |
| "previous":{ | |
| "type":"string" | |
| }, | |
| "next":{ | |
| "type":"string" | |
| }, | |
| "messages":{ | |
| "type":"array", | |
| "readOnly":true, | |
| "items":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| "files":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/File" | |
| } | |
| }, | |
| "webPages":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/WebPage" | |
| } | |
| }, | |
| "bots":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Bot" | |
| } | |
| }, | |
| "users":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/User" | |
| } | |
| }, | |
| "veils":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| } | |
| }, | |
| "UserChatsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "userChats":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/UserChat" | |
| } | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| }, | |
| "messages":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Message" | |
| } | |
| }, | |
| "users":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/User" | |
| } | |
| }, | |
| "veils":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| } | |
| }, | |
| "ChannelsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channels":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Channel" | |
| } | |
| }, | |
| "channelManagers":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/ChannelManager" | |
| } | |
| } | |
| } | |
| }, | |
| "Group":{ | |
| "type":"object", | |
| "required":[ | |
| "name", | |
| "scope" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string", | |
| "pattern":"[0-9a-z-]+" | |
| }, | |
| "scope":{ | |
| "type":"string", | |
| "pattern":"(all|public|private)" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "lastMessageId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| } | |
| } | |
| }, | |
| "GroupsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "groups":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Group" | |
| } | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| } | |
| }, | |
| "GroupView":{ | |
| "type":"object", | |
| "properties":{ | |
| "group":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Group" | |
| }, | |
| "session":{ | |
| "$ref":"#/definitions/Session" | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| } | |
| }, | |
| "ChannelEntity":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ElasticsearchPagination":{ | |
| "type":"object", | |
| "properties":{ | |
| "hits":{ | |
| "type":"array", | |
| "readOnly":true, | |
| "items":{ | |
| "$ref":"#/definitions/SearchHit" | |
| } | |
| }, | |
| "next":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "userChats":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/UserChat" | |
| } | |
| }, | |
| "users":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/User" | |
| } | |
| }, | |
| "veils":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchHit":{ | |
| "type":"object", | |
| "properties":{ | |
| "index":{ | |
| "type":"string" | |
| }, | |
| "type":{ | |
| "type":"string" | |
| }, | |
| "score":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "source":{ | |
| "$ref":"#/definitions/ChannelEntity" | |
| }, | |
| "highlight":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SMSLog":{ | |
| "type":"object", | |
| "required":[ | |
| "channelId", | |
| "id" | |
| ], | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "entityType":{ | |
| "type":"string" | |
| }, | |
| "entityId":{ | |
| "type":"string" | |
| }, | |
| "mobileNumber":{ | |
| "$ref":"#/definitions/MobileNumber" | |
| }, | |
| "vendor":{ | |
| "type":"string" | |
| }, | |
| "text":{ | |
| "type":"string" | |
| }, | |
| "sid":{ | |
| "type":"string" | |
| }, | |
| "state":{ | |
| "type":"string" | |
| }, | |
| "errorMessage":{ | |
| "type":"string" | |
| }, | |
| "sentAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "failed":{ | |
| "type":"boolean" | |
| }, | |
| "entityKey":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "SMSLogsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "previous":{ | |
| "type":"string" | |
| }, | |
| "next":{ | |
| "type":"string" | |
| }, | |
| "smsLogs":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/SMSLog" | |
| } | |
| } | |
| } | |
| }, | |
| "PageViewView":{ | |
| "type":"object", | |
| "properties":{ | |
| "pageView":{ | |
| "$ref":"#/definitions/PageView" | |
| } | |
| } | |
| }, | |
| "BotsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "bots":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Bot" | |
| } | |
| } | |
| } | |
| }, | |
| "BotView":{ | |
| "type":"object", | |
| "properties":{ | |
| "bot":{ | |
| "$ref":"#/definitions/Bot" | |
| } | |
| } | |
| }, | |
| "Credential":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "accessKey":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "accessSecret":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "CredentialsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "credentials":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Credential" | |
| } | |
| } | |
| } | |
| }, | |
| "CredentialView":{ | |
| "type":"object", | |
| "properties":{ | |
| "credential":{ | |
| "$ref":"#/definitions/Credential" | |
| } | |
| } | |
| }, | |
| "Invite":{ | |
| "type":"object", | |
| "required":[ | |
| "email" | |
| ], | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "hostId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "email":{ | |
| "type":"string" | |
| }, | |
| "role":{ | |
| "type":"string", | |
| "pattern":"admin|member|owner" | |
| }, | |
| "state":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "guestId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "InviteView":{ | |
| "type":"object", | |
| "properties":{ | |
| "invite":{ | |
| "$ref":"#/definitions/Invite" | |
| }, | |
| "channel":{ | |
| "$ref":"#/definitions/Channel" | |
| }, | |
| "channelManager":{ | |
| "$ref":"#/definitions/ChannelManager" | |
| }, | |
| "host":{ | |
| "$ref":"#/definitions/Manager" | |
| }, | |
| "guest":{ | |
| "$ref":"#/definitions/Manager" | |
| }, | |
| "suggestedUsername":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "DirectChat":{ | |
| "type":"object", | |
| "required":[ | |
| "managerIds" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "managerIds":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| }, | |
| "maxItems":2147483647, | |
| "minItems":1 | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "lastMessageId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "color":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/Color" | |
| } | |
| } | |
| }, | |
| "TeamChatsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "groups":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Group" | |
| } | |
| }, | |
| "directChats":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/DirectChat" | |
| } | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| } | |
| }, | |
| "DirectChatsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "directChats":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/DirectChat" | |
| } | |
| }, | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| } | |
| }, | |
| "DirectChatView":{ | |
| "type":"object", | |
| "properties":{ | |
| "directChat":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/DirectChat" | |
| }, | |
| "session":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| }, | |
| "Integration":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "url":{ | |
| "type":"string" | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "IntegrationsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "integrations":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Integration" | |
| } | |
| } | |
| } | |
| }, | |
| "MetaSchema":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "attribute":{ | |
| "type":"string" | |
| }, | |
| "type":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "MetaSchemaView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "metaSchema":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/MetaSchema" | |
| } | |
| } | |
| } | |
| }, | |
| "PluginsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "plugins":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Plugin" | |
| } | |
| } | |
| } | |
| }, | |
| "ScriptView":{ | |
| "type":"object", | |
| "properties":{ | |
| "script":{ | |
| "$ref":"#/definitions/Script" | |
| } | |
| } | |
| }, | |
| "Webhook":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "url":{ | |
| "type":"string" | |
| }, | |
| "token":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "watchUserChats":{ | |
| "type":"boolean" | |
| }, | |
| "watchMessages":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "WebhooksView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "webhooks":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Webhook" | |
| } | |
| } | |
| } | |
| }, | |
| "WebhookView":{ | |
| "type":"object", | |
| "properties":{ | |
| "webhook":{ | |
| "$ref":"#/definitions/Webhook" | |
| } | |
| } | |
| }, | |
| "PushService":{ | |
| "type":"object", | |
| "required":[ | |
| "service" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "service":{ | |
| "type":"string", | |
| "pattern":"(ios|ios-dev|fcm)" | |
| }, | |
| "certificate":{ | |
| "type":"string" | |
| }, | |
| "privateKey":{ | |
| "type":"string" | |
| }, | |
| "apiKey":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "PushServicesView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "pushServices":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/PushService" | |
| } | |
| } | |
| } | |
| }, | |
| "PushServiceView":{ | |
| "type":"object", | |
| "properties":{ | |
| "pushService":{ | |
| "readOnly":true, | |
| "$ref":"#/definitions/PushService" | |
| } | |
| } | |
| }, | |
| "VirtualNumber":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "virtualNumber":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "VirtualNumberView":{ | |
| "type":"object", | |
| "properties":{ | |
| "virtualNumber":{ | |
| "$ref":"#/definitions/VirtualNumber" | |
| } | |
| } | |
| }, | |
| "ChannelManagersView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelManagers":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/ChannelManager" | |
| } | |
| }, | |
| "managers":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| } | |
| }, | |
| "CountView":{ | |
| "type":"object", | |
| "properties":{ | |
| "count":{ | |
| "type":"integer", | |
| "format":"int64" | |
| } | |
| } | |
| }, | |
| "Online":{ | |
| "type":"object", | |
| "properties":{ | |
| "channelId":{ | |
| "type":"string" | |
| }, | |
| "personType":{ | |
| "type":"string" | |
| }, | |
| "personId":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| } | |
| } | |
| }, | |
| "OnlinesView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string" | |
| }, | |
| "onlines":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Online" | |
| } | |
| }, | |
| "users":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/User" | |
| } | |
| }, | |
| "veils":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| }, | |
| "pageViews":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/PageView" | |
| } | |
| } | |
| } | |
| }, | |
| "OnlineView":{ | |
| "type":"object", | |
| "properties":{ | |
| "online":{ | |
| "$ref":"#/definitions/Online" | |
| }, | |
| "user":{ | |
| "$ref":"#/definitions/User" | |
| }, | |
| "veil":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| }, | |
| "Command":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "channelId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "command":{ | |
| "type":"string", | |
| "pattern":"[0-9a-z-]+" | |
| }, | |
| "message":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "CommandsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "next":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "commands":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Command" | |
| } | |
| } | |
| } | |
| }, | |
| "CommandView":{ | |
| "type":"object", | |
| "properties":{ | |
| "command":{ | |
| "$ref":"#/definitions/Command" | |
| } | |
| } | |
| }, | |
| "PageViewsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "previous":{ | |
| "type":"string" | |
| }, | |
| "next":{ | |
| "type":"string" | |
| }, | |
| "pageViews":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/PageView" | |
| } | |
| } | |
| } | |
| }, | |
| "UserView":{ | |
| "type":"object", | |
| "properties":{ | |
| "user":{ | |
| "$ref":"#/definitions/User" | |
| } | |
| } | |
| }, | |
| "VeilView":{ | |
| "type":"object", | |
| "properties":{ | |
| "veil":{ | |
| "$ref":"#/definitions/Veil" | |
| } | |
| } | |
| }, | |
| "SessionsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "sessions":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| } | |
| }, | |
| "ManagerView":{ | |
| "type":"object", | |
| "properties":{ | |
| "manager":{ | |
| "$ref":"#/definitions/Manager" | |
| } | |
| } | |
| }, | |
| "PasswordReset":{ | |
| "type":"object", | |
| "properties":{ | |
| "email":{ | |
| "type":"string" | |
| }, | |
| "personType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "state":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "resetAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "expiresAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "PasswordResetView":{ | |
| "type":"object", | |
| "properties":{ | |
| "passwordReset":{ | |
| "$ref":"#/definitions/PasswordReset" | |
| } | |
| } | |
| }, | |
| "OTT":{ | |
| "type":"object", | |
| "properties":{ | |
| "type":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "exp":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "OTTView":{ | |
| "type":"object", | |
| "properties":{ | |
| "ott":{ | |
| "$ref":"#/definitions/OTT" | |
| } | |
| } | |
| }, | |
| "Apns":{ | |
| "type":"object", | |
| "properties":{ | |
| "certificate":{ | |
| "type":"string" | |
| }, | |
| "privateKey":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "ApnsView":{ | |
| "type":"object", | |
| "properties":{ | |
| "apns":{ | |
| "$ref":"#/definitions/Apns" | |
| } | |
| } | |
| }, | |
| "SessionView":{ | |
| "type":"object", | |
| "properties":{ | |
| "session":{ | |
| "$ref":"#/definitions/Session" | |
| } | |
| } | |
| }, | |
| "Subscriber":{ | |
| "type":"object", | |
| "required":[ | |
| "email" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "email":{ | |
| "type":"string" | |
| }, | |
| "locale":{ | |
| "type":"string", | |
| "pattern":"[a-z]{2}" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "registeredAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "utmSource":{ | |
| "type":"string" | |
| }, | |
| "ip":{ | |
| "type":"string" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "city":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "SubscriberView":{ | |
| "type":"object", | |
| "properties":{ | |
| "subscriber":{ | |
| "$ref":"#/definitions/Subscriber" | |
| } | |
| } | |
| }, | |
| "Tutorial":{ | |
| "type":"object", | |
| "required":[ | |
| "step" | |
| ], | |
| "properties":{ | |
| "id":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personType":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "personId":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "step":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| }, | |
| "updatedAt":{ | |
| "type":"string", | |
| "format":"date-time", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "TutorialView":{ | |
| "type":"object", | |
| "properties":{ | |
| "tutorial":{ | |
| "$ref":"#/definitions/Tutorial" | |
| } | |
| } | |
| }, | |
| "VirtualNumbersView":{ | |
| "type":"object", | |
| "properties":{ | |
| "virtualNumbers":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| } | |
| } | |
| } | |
| }, | |
| "CountriesView":{ | |
| "type":"object", | |
| "properties":{ | |
| "countries":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/Country" | |
| } | |
| } | |
| } | |
| }, | |
| "Country":{ | |
| "type":"object", | |
| "properties":{ | |
| "name":{ | |
| "type":"string" | |
| }, | |
| "code":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| "GeoIP":{ | |
| "type":"object", | |
| "properties":{ | |
| "ip":{ | |
| "type":"string" | |
| }, | |
| "country":{ | |
| "type":"string" | |
| }, | |
| "city":{ | |
| "type":"string" | |
| }, | |
| "timezone":{ | |
| "type":"string" | |
| }, | |
| "longitude":{ | |
| "type":"number", | |
| "format":"double" | |
| }, | |
| "latitude":{ | |
| "type":"number", | |
| "format":"double" | |
| } | |
| } | |
| }, | |
| "GeoIPView":{ | |
| "type":"object", | |
| "properties":{ | |
| "geoIP":{ | |
| "$ref":"#/definitions/GeoIP" | |
| } | |
| } | |
| }, | |
| "PackageVersion":{ | |
| "type":"object", | |
| "properties":{ | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "packageId":{ | |
| "type":"string" | |
| }, | |
| "version":{ | |
| "type":"string" | |
| }, | |
| "minCompatibleVersion":{ | |
| "type":"string" | |
| }, | |
| "createdAt":{ | |
| "type":"string", | |
| "format":"date-time" | |
| }, | |
| "key":{ | |
| "type":"string" | |
| }, | |
| "filename":{ | |
| "type":"string" | |
| }, | |
| "size":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "url":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "PackageVersionView":{ | |
| "type":"object", | |
| "properties":{ | |
| "packageVersion":{ | |
| "$ref":"#/definitions/PackageVersion" | |
| }, | |
| "needToUpgrade":{ | |
| "type":"boolean" | |
| } | |
| } | |
| }, | |
| "TimeZone":{ | |
| "type":"object", | |
| "properties":{ | |
| "displayName":{ | |
| "type":"string" | |
| }, | |
| "id":{ | |
| "type":"string" | |
| }, | |
| "rawOffset":{ | |
| "type":"integer", | |
| "format":"int32" | |
| }, | |
| "dstsavings":{ | |
| "type":"integer", | |
| "format":"int32" | |
| } | |
| } | |
| }, | |
| "TimeZonesView":{ | |
| "type":"object", | |
| "properties":{ | |
| "timeZones":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/definitions/TimeZone" | |
| } | |
| } | |
| } | |
| }, | |
| "UniqueIdView":{ | |
| "type":"object", | |
| "properties":{ | |
| "rand":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "micro":{ | |
| "type":"integer", | |
| "format":"int64", | |
| "readOnly":true | |
| }, | |
| "hex":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "dateTime":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| } | |
| }, | |
| "VersionView":{ | |
| "type":"object", | |
| "properties":{ | |
| "version":{ | |
| "type":"string" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment