chore: Add API documentation for teams (#2221)
Add API documentation for teams
This commit is contained in:
@@ -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
|
||||
|
||||
11
swagger/definitions/request/team/create_update_payload.yml
Normal file
11
swagger/definitions/request/team/create_update_payload.yml
Normal 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
|
||||
20
swagger/definitions/resource/team.yml
Normal file
20
swagger/definitions/resource/team.yml
Normal 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
|
||||
Reference in New Issue
Block a user