Chore: Update Swagger API docs (#608)

swagger/definitions/resource/contact.yml

@@ -2,11 +2,16 @@ type: object
 properties:
   email:
     type: string
+    description: Email address of the contact
   name:
     type: string
+    description: The name of the contact
   phone_number:
     type: string
+    description: Phone number of the contact
   thumbnail:
     type: string
+    description: Avatar URL of the contact
   additional_attributes:
     type: object
+    description: The object containing additional attributes related to the contact

swagger/definitions/resource/conversation.yml

@@ -1,19 +1,27 @@
 type: object
 properties:
+  id:
+    type: number
+    description: ID of the conversation
   messages:
     type: array
-    items:
-      type: object
   inbox_id:
     type: number
+    description: ID of the inbox
   status:
     type: string
-    enum: ['open', 'resolved']
+    enum: ['open', 'resolved', 'bot']
+    description: The status of the conversation
   timestamp:
     type: string
+    description: The time at which conversation was created
   user_last_seen_at:
     type: string
   agent_last_seen_at:
     type: agent_last_seen_at
   unread_count:
     type: number
+    description: The number of unread messages
+  additional_attributes:
+    type: object
+    description: The object containing additional attributes related to the conversation

swagger/definitions/resource/extension/contact/conversation.yml

@@ -8,11 +8,15 @@ properties:
         properties:
           id:
             type: number
+            description: ID fo the sender
           name:
             type: string
+            description: The name of the sender
           thumbnail:
             type: string
+            description: Avatar URL of the contact
           channel:
             type: string
+            description: Channel Type
       assignee:
         $ref: '#/definitions/user'

swagger/definitions/resource/extension/contact/show.yml

@@ -2,6 +2,8 @@ type: object
 properties:
   id:
     type: number
+    description: Id of the user
   availability_status:
     type: string
-    enum: ['online', 'offline']
+    enum: ['online', 'offline']
+    description: Availability status of the user

swagger/definitions/resource/extension/conversation/labels.yml

@@ -2,6 +2,6 @@ type: object
 properties:
   payload:
     type: array
-    description: 'array of labels'
+    description: Array of labels
     items:
       type: string

swagger/definitions/resource/extension/conversation/show.yml

@@ -1,19 +1,5 @@
 type: object
-properties:
-  meta:
-    type: object
-    properties:
-      labels:
-        type: array
-        items:
-          type: string
-      additional_attributes:
-        type: object
-      contact_id:
-        type: number
-  payload:
-    type: array
-    description: 'array of messages'
-    items:
-      allOf:
-        - $ref: '#/definitions/extended_message'
+allOf:
+  - $ref: '#/definitions/generic_id'
+  - $ref: '#/definitions/conversation'
+  - $ref: '../contact/conversation.yml'

swagger/definitions/resource/inbox.yml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the inbox
+  channel_type:
+    type: string
+    description: The type of the inbox
+  avatar_url:
+    type: string
+    description: The avatar image of the inbox
+  widget_color:
+    type: string
+    description: Widget Color used for customization of the widget
+  website_token:
+    type: string
+    description: Website Token
+  enable_auto_assignment:
+    type: boolean
+    description: The flag which shows whether Auto Assignment is enabled or not

swagger/definitions/resource/message.yml

@@ -2,15 +2,23 @@ type: object
 properties:
   content:
     type: string
-  inbox_id:
-    type: number
-  conversation_id:
-    type: number
+    description: The text content of the message
   message_type:
     type: string
+    enum: ["incoming", "outgoing", "activity", "template"]
+    description: The type of the message
   created_at:
     type: integer
+    description: The time at which message was created
   private:
     type: boolean
+    description: The flags which shows whether the message is private or not
   attachment:
     type: object
+    description: The file object attached to the image
+  sender:
+    type: object
+    description: User/Agent/AgentBot object
+  conversation_id:
+    type: number
+    description: ID of the conversation