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

swagger/paths/contact/conversations.yml

@@ -2,8 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactConversations
-  summary: Conversations
+  summary: Contact Conversations
+  description: Get conversations associated to that contact
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number

swagger/paths/contact/crud.yml

@@ -3,7 +3,9 @@ get:
     - Contact
   operationId: contactDetails
   summary: Show Contact
+  description: Get a contact belonging to the account using ID
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number
@@ -24,7 +26,9 @@ put:
     - Contact
   operationId: contactUpdate
   summary: Update Contact
+  description: Update a contact belonging to the account using ID
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: id
       in: path
       type: number

swagger/paths/contact/list_create.yml

@@ -2,9 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactList
-  description: Listing all the contacts with pagination (Page size = 15)
+  description: Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number
   summary: List Contacts
   parameters:
+    - $ref: '#/parameters/account_id'
     - $ref: '#/parameters/contact_sort_param'
     - $ref: '#/parameters/page'
   responses:
@@ -21,9 +22,10 @@ post:
   tags:
     - Contact
   operationId: contactCreate
-  description: Create New Contact
+  description: Create a new Contact
   summary: Create Contact
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: data
       in: body
       required: true

swagger/paths/contact/search.yml

@@ -2,9 +2,10 @@ get:
   tags:
     - Contact
   operationId: contactSearch
-  description: Search the contacts using a search key, currently supports email search (Page size = 15)
+  description: Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
   summary: Search Contacts
   parameters:
+    - $ref: '#/parameters/account_id'
     - name: q
       in: query
       type: string

swagger/paths/contact_inboxes/create.yml

@@ -5,6 +5,12 @@ post:
   description: Create a contact inbox record for an inbox
   summary: Create contact inbox
   parameters:
+    - $ref: '#/parameters/account_id'
+    - name: id
+      in: path
+      type: number
+      description: ID of the contact
+      required: true
     - name: data
       in: body
       required: true

swagger/paths/contactable_inboxes/get.yml

@@ -4,6 +4,13 @@ get:
   operationId: contactableInboxesGet
   description: Get List of contactable Inboxes
   summary: Get Contactable Inboxes
+  parameters:
+    - $ref: '#/parameters/account_id'
+    - name: id
+      in: path
+      type: number
+      description: ID of the contact
+      required: true
   responses:
     200:
       description: Success

swagger/paths/inboxes/create.yml

@@ -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

swagger/paths/inboxes/get_agent_bot.yml

@@ -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

swagger/paths/inboxes/index.yml

@@ -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

swagger/paths/inboxes/set_agent_bot.yml

@@ -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

swagger/paths/inboxes/show.yml

@@ -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

swagger/paths/inboxes/update.yml

@@ -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

swagger/paths/index.yml

@@ -198,6 +198,8 @@ public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversat
 # Inboxes
 /api/v1/accounts/{account_id}/inboxes:
   $ref: ./inboxes/index.yml
+/api/v1/accounts/{account_id}/inboxes/{id}/:
+  $ref: ./inboxes/show.yml
 /api/v1/accounts/{account_id}/inboxes/:
   $ref: ./inboxes/create.yml
 /api/v1/accounts/{account_id}/inboxes/{id}: