Chore: Swagger Docs V1 (#546)

swagger/definitions/error/bad_request.yml

@@ -0,0 +1,9 @@
+title: data
+type: object
+properties:
+  description:
+    type: string
+  errors:
+    type: array
+    items:
+      $ref: '#/definitions/request_error'

swagger/definitions/error/request.yml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  field:
+    type: string
+  message:
+    type: string
+  code:
+    type: string

swagger/definitions/index.yml

@@ -0,0 +1,39 @@
+# ERROR
+bad_request_error:
+  $ref: ./error/bad_request.yml
+request_error:
+  $ref: ./error/request.yml
+
+# RESOURCE
+contact:
+  $ref: ./resource/contact.yml
+conversation:
+  $ref: ./resource/conversation.yml
+
+# RESPONSE
+extended_contact:
+  allOf:
+    - $ref: '#/definitions/contact'
+    - $ref: ./resource/extension/contact/show.yml
+contact_base:
+  allOf:
+    - $ref: '#/definitions/contact'
+    - $ref: ./resource/extension/generic.yml
+contact_list:
+  type: array
+  items:
+    allOf:
+      - $ref: '#/definitions/contact'
+      - $ref: ./resource/extension/generic.yml
+contact_conversations:
+  type: array
+  items:
+    allOf:
+      - $ref: '#/definitions/conversation'
+      - $ref: ./resource/extension/contact/conversation.yml
+
+# REQUEST
+contact_create:
+  $ref: ./request/contact/create.yml
+contact_update:
+  $ref: ./request/contact/update.yml

swagger/definitions/request/contact/create.yml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  account_id:
+    type: number
+  inbox_id:
+    type: number

swagger/definitions/request/contact/update.yml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  name:
+    type: string
+  email:
+    type: string
+  phone_number:
+    type: string

swagger/definitions/resource/contact.yml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  email:
+    type: string
+  name:
+    type: string
+  phone_number:
+    type: string
+  thumbnail:
+    type: string
+  additional_attributes:
+    type: object

swagger/definitions/resource/conversation.yml

@@ -0,0 +1,21 @@
+type: object
+properties:
+  display_id:
+    type: number
+  messages:
+    type: array
+    items:
+      type: object
+  inbox_id:
+    type: number
+  status:
+    type: string
+    enum: ['open', 'resolved']
+  timestamp:
+    type: string
+  user_last_seen_at:
+    type: string
+  agent_last_seen_at:
+    type: agent_last_seen_at
+  unread_count:
+    type: number

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

@@ -0,0 +1,18 @@
+type: object
+properties:
+  meta:
+    type: object
+    properties:
+      sender:
+        type: object
+        properties:
+          id:
+            type: number
+          name:
+            type: string
+          thumbnail:
+            type: string
+          channel:
+            type: string
+      assignee:
+        type: object

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

@@ -0,0 +1,5 @@
+type: object
+properties:
+  allOf:
+    - $ref: '#/definitions/contact'
+    - $ref: ./resource/extension/contact.yaml

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

@@ -0,0 +1,7 @@
+type: object
+properties:
+  id:
+    type: number
+  availability_status:
+    type: string
+    enum: ['online', 'offline']

swagger/definitions/resource/extension/generic.yml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  id:
+    type: number