Chore: Update swagger API documentation (#745)
* Chore: Update swagger documentation
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
post:
|
||||
tags:
|
||||
- Widget
|
||||
operationId: widgetInboxCreation
|
||||
summary: Create a website inbox
|
||||
- Inbox
|
||||
operationId: inboxCreation
|
||||
summary: Create an inbox
|
||||
description: You can create more than one website inbox in each account
|
||||
parameters:
|
||||
- name: data
|
||||
@@ -11,15 +11,30 @@ post:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
website:
|
||||
name:
|
||||
type: string
|
||||
description: The name of the inbox
|
||||
avatar:
|
||||
type: file
|
||||
description: File for avatar image
|
||||
channel:
|
||||
type: object
|
||||
properties:
|
||||
website_name:
|
||||
type:
|
||||
type: string
|
||||
description: The name of the inbox
|
||||
enum: ['web_widget']
|
||||
website_url:
|
||||
type: string
|
||||
description: URL at which the widget will be loaded
|
||||
welcome_title:
|
||||
type: string
|
||||
description: Welcome title to be displayed on the widget
|
||||
welcome_tagline:
|
||||
type: string
|
||||
description: Welcome tagline to be displayed on the widget
|
||||
agent_away_message:
|
||||
type: string
|
||||
description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
|
||||
widget_color:
|
||||
type: string
|
||||
description: A Hex-color string used to customize the widget
|
||||
|
||||
@@ -16,6 +16,9 @@ patch:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description: The name of the inbox
|
||||
enable_auto_assignment:
|
||||
type: boolean
|
||||
required: true
|
||||
@@ -24,6 +27,24 @@ patch:
|
||||
type: file
|
||||
required: false
|
||||
description: 'Image file for avatar'
|
||||
channel:
|
||||
type: object
|
||||
properties:
|
||||
website_url:
|
||||
type: string
|
||||
description: URL at which the widget will be loaded
|
||||
welcome_title:
|
||||
type: string
|
||||
description: Welcome title to be displayed on the widget
|
||||
welcome_tagline:
|
||||
type: string
|
||||
description: Welcome tagline to be displayed on the widget
|
||||
agent_away_message:
|
||||
type: string
|
||||
description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
|
||||
widget_color:
|
||||
type: string
|
||||
description: A Hex-color string used to customize the widget
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
# Widget
|
||||
/accounts/{account_id}/widget/inboxes:
|
||||
$ref: ./widget/inboxes/create.yml
|
||||
/accounts/{account_id}/widget/inboxes/${id}:
|
||||
$ref: ./widget/inboxes/update.yml
|
||||
|
||||
|
||||
# Inboxes
|
||||
/accounts/{account_id}/inboxes:
|
||||
$ref: ./inboxes/index.yml
|
||||
/accounts/{account_id}/inboxes:
|
||||
$ref: ./inboxes/create.yml
|
||||
/accounts/{account_id}/inboxes/{id}:
|
||||
$ref: ./inboxes/update.yml
|
||||
/accounts/{account_id}/inboxes/{id}/set_agent_bot:
|
||||
|
||||
Reference in New Issue
Block a user