chore: Add API documentation for teams (#2221)

Add API documentation for teams
This commit is contained in:
Pranav Raj S
2021-05-05 20:39:00 +05:30
committed by GitHub
parent 6469acc750
commit fd0c26cdae
18 changed files with 378 additions and 11 deletions

View File

@@ -23,6 +23,8 @@ contact_inboxes:
$ref: ./resource/contact_inboxes.yml
account:
$ref: ./resource/account.yml
team:
$ref: ./resource/team.yml
# RESPONSE
@@ -78,3 +80,8 @@ contact_update:
## conversation
conversation_message_create:
$ref: ./request/conversation/create_message.yml
# Team request Payload
team_create_update_payload:
$ref: ./request/team/create_update_payload.yml

View File

@@ -0,0 +1,11 @@
type: object
properties:
name:
type: string
description: The name of the team
description:
type: string
description: The description of the team
allow_auto_assign:
type: boolean
description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

View File

@@ -0,0 +1,20 @@
type: object
properties:
id:
type: number
description: The id of the team
name:
type: string
description: The name of the team
description:
type: string
description: The description about the team
allow_auto_assign:
type: boolean
description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
account_id:
type: number
description: The id of the account with the team is a part of
is_member:
type: boolean
description: This field shows whether the current user is a part of the team