Restructure omni services and add Chatwoot research snapshot

research/chatwoot/swagger/paths/application/inboxes/create.yml

@@ -0,0 +1,35 @@
+post:
+  tags:
+    - Inboxes
+  operationId: inboxCreation
+  summary: Create an inbox
+  description: You can create more than one website inbox in each account
+  security:
+    - userApiKey: []
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/inbox_create_payload'
+  responses:
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/inbox'
+    '404':
+      description: Inbox not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/get_agent_bot.yml

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Inboxes
+  operationId: getInboxAgentBot
+  summary: Show Inbox Agent Bot
+  description: See if an agent bot is associated to the Inbox
+  security:
+    - userApiKey: []
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+    - name: id
+      in: path
+      schema:
+        type: number
+      description: ID of the inbox
+      required: true
+  responses:
+    '204':
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/agent_bot'
+    '404':
+      description: Inbox not found, Agent bot not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/inbox_members/create.yml

@@ -0,0 +1,58 @@
+tags:
+  - Inboxes
+operationId: add-new-agent-to-inbox
+summary: Add a New Agent
+description: Add a new Agent to Inbox
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - inbox_id
+          - user_ids
+        properties:
+          inbox_id:
+            type: integer
+            description: The ID of the inbox
+            example: 1
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the inbox
+            example: [1]
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            payload:
+              type: array
+              description: 'Array of all active agents'
+              items:
+                $ref: '#/components/schemas/agent'
+  '404':
+    description: Inbox not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
+    description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/inbox_members/delete.yml

@@ -0,0 +1,46 @@
+tags:
+  - Inboxes
+operationId: delete-agent-in-inbox
+summary: Remove an Agent from Inbox
+description: Remove an Agent from Inbox
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - inbox_id
+          - user_ids
+        properties:
+          inbox_id:
+            type: string
+            description: The ID of the inbox
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be deleted from the inbox
+responses:
+  '200':
+    description: Success
+  '404':
+    description: Inbox not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
+    description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/inbox_members/show.yml

@@ -0,0 +1,34 @@
+tags:
+  - Inboxes
+operationId: get-inbox-members
+summary: List Agents in Inbox
+description: Get Details of Agents in an Inbox
+security:
+  - userApiKey: []
+parameters:
+  - $ref: '#/components/parameters/inbox_id'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            payload:
+              type: array
+              description: 'Array of all active agents'
+              items:
+                $ref: '#/components/schemas/agent'
+  '404':
+    description: Inbox not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/inbox_members/update.yml

@@ -0,0 +1,58 @@
+tags:
+  - Inboxes
+operationId: update-agents-in-inbox
+summary: Update Agents in Inbox
+description: All agents except the one passed in params will be removed
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        type: object
+        required:
+          - inbox_id
+          - user_ids
+        properties:
+          inbox_id:
+            type: string
+            description: The ID of the inbox
+            example: 1
+          user_ids:
+            type: array
+            items:
+              type: integer
+            description: IDs of users to be added to the inbox
+            example: [1]
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            payload:
+              type: array
+              description: 'Array of all active agents'
+              items:
+                $ref: '#/components/schemas/agent'
+  '404':
+    description: Inbox not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '422':
+    description: User must exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/index.yml

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Inboxes
+  operationId: listAllInboxes
+  summary: List all inboxes
+  description: List all inboxes available in the current account
+  security:
+    - userApiKey: []
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+  responses:
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              payload:
+                type: array
+                description: 'Array of inboxes'
+                items:
+                  $ref: '#/components/schemas/inbox'
+    '404':
+      description: Inbox not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/set_agent_bot.yml

@@ -0,0 +1,44 @@
+post:
+  tags:
+    - Inboxes
+  operationId: updateAgentBot
+  summary: Add or remove agent bot
+  security:
+    - userApiKey: []
+  description: To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+    - name: id
+      in: path
+      schema:
+        type: number
+      description: ID of the inbox
+      required: true
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          required:
+            - agent_bot
+          properties:
+            agent_bot:
+              type: number
+              description: 'Agent bot ID'
+              example: 1
+  responses:
+    '204':
+      description: Success
+    '404':
+      description: Inbox not found, Agent bot not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/show.yml

@@ -0,0 +1,35 @@
+get:
+  tags:
+    - Inboxes
+  operationId: GetInbox
+  summary: Get an inbox
+  security:
+    - userApiKey: []
+  description: Get an inbox available in the current account
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+    - name: id
+      in: path
+      schema:
+        type: number
+      description: ID of the inbox
+      required: true
+  responses:
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/inbox'
+    '404':
+      description: Inbox not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/application/inboxes/update.yml

@@ -0,0 +1,43 @@
+patch:
+  tags:
+    - Inboxes
+  operationId: updateInbox
+  summary: Update Inbox
+  security:
+    - userApiKey: []
+  description: Update an existing inbox
+  parameters:
+    - $ref: '#/components/parameters/account_id'
+    - name: id
+      in: path
+      schema:
+        type: number
+      description: ID of the inbox
+      required: true
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/inbox_update_payload'
+  responses:
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            type: object
+            description: 'Updated inbox object'
+            $ref: '#/components/schemas/inbox'
+    '404':
+      description: Inbox not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'
+    '403':
+      description: Access denied
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bad_request_error'