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

@@ -895,6 +895,97 @@
}
}
}
},
"/accounts/{account_id}/contacts/search": {
"get": {
"tags": [
"Contact"
],
"operationId": "contactSearch",
"description": "Search the contacts using a search key, currently supports email search",
"summary": "Search Contacts",
"parameters": [
{
"name": "q",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "object",
"properties": {
"payload": {
"$ref": "#/definitions/contact_list"
}
}
}
},
"401": {
"description": "Authentication error",
"schema": {
"$ref": "#/definitions/bad_request_error"
}
}
}
}
},
"/accounts/{account_id}/contacts/{id}/contact_inboxes": {
"post": {
"tags": [
"Contact"
],
"operationId": "contactInboxCreation",
"description": "Create a contact inbox record for an inbox",
"summary": "Create contact inbox",
"parameters": [
{
"name": "inbox_id",
"in": "params",
"type": "number"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/contact_inboxes"
}
},
"401": {
"description": "Authentication error",
"schema": {
"$ref": "#/definitions/bad_request_error"
}
},
"422": {
"description": "Incorrect payload"
}
}
}
},
"/profile": {
"get": {
"tags": [
"Profile"
],
"operationId": "fetchProfile",
"summary": "Fetch user profile",
"description": "Get the user profile details",
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/user"
}
},
"401": {
"description": "Unauthorized"
}
}
}
}
},
"definitions": {
@@ -957,6 +1048,12 @@
"additional_attributes": {
"type": "object",
"description": "The object containing additional attributes related to the contact"
},
"contact_inboxes": {
"type": "array",
"items": {
"$ref": "#/definitions/contact_inboxes"
}
}
}
},
@@ -1072,6 +1169,12 @@
"name": {
"type": "string"
},
"available_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"email": {
"type": "string"
},
@@ -1088,8 +1191,11 @@
"confirmed": {
"type": "boolean"
},
"display_name": {
"type": "string"
"accounts": {
"type": "array",
"items": {
"$ref": "#/definitions/account"
}
}
}
},
@@ -1140,9 +1246,13 @@
"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"
}
}
},
@@ -1167,6 +1277,39 @@
}
}
},
"contact_inboxes": {
"type": "object",
"properties": {
"source_id": {
"type": "string",
"description": "Contact Inbox Source Id"
},
"inbox": {
"$ref": "#/definitions/inbox"
}
}
},
"account": {
"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"
}
}
},
"extended_contact": {
"allOf": [
{