Chore: API Improvements (#2956)

- API to fetch info of a single inbox
- Document passing custom_attributes in the API
- Ability to filter contacts with contact identifier in search API
This commit is contained in:
Sojan Jose
2021-09-04 17:56:46 +05:30
committed by GitHub
parent b866c54ad5
commit 2ebd38c3b7
29 changed files with 248 additions and 29 deletions

View File

@@ -5,6 +5,7 @@ post:
summary: Create an inbox
description: You can create more than one website inbox in each account
parameters:
- $ref: '#/parameters/account_id'
- name: data
in: body
required: true

View File

@@ -5,6 +5,7 @@ get:
summary: Show Inbox Agent Bot
description: See if an agent bot is associated to the Inbox
parameters:
- $ref: '#/parameters/account_id'
- name: id
in: path
type: number

View File

@@ -4,6 +4,8 @@ get:
operationId: listAllInboxes
summary: List all inboxes
description: List all inboxes available in the current account
parameters:
- $ref: '#/parameters/account_id'
responses:
200:
description: Success

View File

@@ -5,6 +5,7 @@ post:
summary: Add or remove agent bot
description: To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
parameters:
- $ref: '#/parameters/account_id'
- name: id
in: path
type: number

View File

@@ -0,0 +1,22 @@
get:
tags:
- Inbox
operationId: GetInboxe
summary: Get an inbox
description: Get an inbox available in the current account
parameters:
- $ref: '#/parameters/account_id'
- name: id
in: path
type: number
description: ID of the inbox
required: true
responses:
200:
description: Success
schema:
$ref: '#/definitions/inbox'
404:
description: Inbox not found
403:
description: Access denied

View File

@@ -5,6 +5,7 @@ patch:
summary: Update Inbox
description: Add avatar and disable auto assignment for an inbox
parameters:
- $ref: '#/parameters/account_id'
- name: id
in: path
type: number