chore: Update API docs (#1153)

This commit is contained in:
Pranav Raj S
2020-08-18 12:14:37 +05:30
committed by GitHub
parent dfe4b70d91
commit 662bb882f7
11 changed files with 259 additions and 6 deletions

View File

@@ -19,6 +19,11 @@ inbox:
$ref: ./resource/inbox.yml
agent_bot:
$ref: ./resource/agent_bot.yml
contact_inboxes:
$ref: ./resource/contact_inboxes.yml
account:
$ref: ./resource/account.yml
# RESPONSE
## contact

View File

@@ -0,0 +1,12 @@
type: object
properties:
id:
type: number
description: Account ID
name:
type: string
description: Name of the account
role:
type: string
enum: ['administrator', 'agent']
description: The user role in the account

View File

@@ -15,3 +15,7 @@ properties:
additional_attributes:
type: object
description: The object containing additional attributes related to the contact
contact_inboxes:
type: array
items:
$ref: '#/definitions/contact_inboxes'

View File

@@ -0,0 +1,8 @@
type: object
properties:
source_id:
type: string
description: Contact Inbox Source Id
inbox:
type: object
$ref: '#/definitions/inbox'

View File

@@ -33,6 +33,9 @@ properties:
welcome_tagline:
type: string
description: Welcome tagline to be displayed on the widget
agent_away_message:
greeting_enabled:
type: boolean
description: The flag which shows whether greeting is enabled
greeting_message:
type: string
description: A message which will be sent if there is not agent available. This is not available if agentbot is connected
description: A greeting message when the user starts the conversation

View File

@@ -6,6 +6,10 @@ properties:
type: string
name:
type: string
available_name:
type: string
display_name:
type: string
email:
type: string
account_id:
@@ -17,3 +21,7 @@ properties:
type: boolean
display_name:
type: string
accounts:
type: array
items:
$ref: '#/definitions/account'