Restructure omni services and add Chatwoot research snapshot

research/chatwoot/swagger/paths/platform/account_users/create.yml

@@ -0,0 +1,37 @@
+tags:
+  - Account Users
+operationId: create-an-account-user
+summary: Create an Account User
+description: Create an Account User
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/account_user_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            account_id:
+              type: integer
+              description: The ID of the account
+            user_id:
+              type: integer
+              description: The ID of the user
+            role:
+              type: string
+              description: whether user is an administrator or agent
+
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/account_users/delete.yml

@@ -0,0 +1,22 @@
+tags:
+  - Account Users
+operationId: delete-an-account-user
+summary: Delete an Account User
+description: Delete an Account User
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The account does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/account_users/index.yml

@@ -0,0 +1,20 @@
+tags:
+  - Account Users
+operationId: list-all-account-users
+summary: List all Account Users
+description: List all account users
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/account_user'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/accounts/create.yml

@@ -0,0 +1,26 @@
+tags:
+  - Accounts
+operationId: create-an-account
+summary: Create an Account
+description: Create an Account
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/account_create_update_payload'
+responses:
+  200:
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/platform_account'
+  401:
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/accounts/delete.yml

@@ -0,0 +1,22 @@
+tags:
+  - Accounts
+operationId: delete-an-account
+summary: Delete an Account
+description: Delete an Account
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The account does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/accounts/show.yml

@@ -0,0 +1,26 @@
+tags:
+  - Accounts
+operationId: get-details-of-an-account
+summary: Get an account details
+description: Get the details of an account
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/platform_account'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The given account does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/accounts/update.yml

@@ -0,0 +1,26 @@
+tags:
+  - Accounts
+operationId: update-an-account
+summary: Update an account
+description: Update an account's attributes
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/account_create_update_payload'
+responses:
+  200:
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/platform_account'
+  401:
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/agent_bots/create.yml

@@ -0,0 +1,26 @@
+tags:
+  - AgentBots
+operationId: create-an-agent-bot
+summary: Create an Agent Bot
+description: Create an agent bot
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/platform_agent_bot_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/agent_bots/delete.yml

@@ -0,0 +1,22 @@
+tags:
+  - AgentBots
+operationId: delete-an-agent-bot
+summary: Delete an AgentBot
+description: Delete an AgentBot
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The agent bot does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/agent_bots/index.yml

@@ -0,0 +1,23 @@
+tags:
+  - AgentBots
+operationId: list-all-agent-bots
+summary: List all AgentBots
+description: List all agent bots available
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: array
+          description: 'Array of agent bots'
+          items:
+            $ref: '#/components/schemas/agent_bot'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/agent_bots/show.yml

@@ -0,0 +1,26 @@
+tags:
+  - AgentBots
+operationId: get-details-of-a-single-agent-bot
+summary: Get an agent bot details
+description: Get the details of an agent bot
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The given agent bot ID does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/agent_bots/update.yml

@@ -0,0 +1,26 @@
+tags:
+  - AgentBots
+operationId: update-an-agent-bot
+summary: Update an agent bot
+description: Update an agent bot's attributes
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/platform_agent_bot_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/agent_bot'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/users/create.yml

@@ -0,0 +1,26 @@
+tags:
+  - Users
+operationId: create-a-user
+summary: Create a User
+description: Create a User
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/user_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/user'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/users/delete.yml

@@ -0,0 +1,22 @@
+tags:
+  - Users
+operationId: delete-a-user
+summary: Delete a User
+description: Delete a User
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The user does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/users/login.yml

@@ -0,0 +1,30 @@
+tags:
+  - Users
+operationId: get-sso-url-of-a-user
+summary: Get User SSO Link
+description: Get the sso link of a user
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            url:
+              type: string
+              description: SSO url to autenticate the user
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The given user does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/users/show.yml

@@ -0,0 +1,26 @@
+tags:
+  - Users
+operationId: get-details-of-a-user
+summary: Get an user details
+description: Get the details of an user
+security:
+  - platformAppApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/user'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The given user does not exist
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'

research/chatwoot/swagger/paths/platform/users/token.yml

@@ -0,0 +1,42 @@
+tags:
+  - Users
+operationId: post-user-token
+summary: Get User Access Token
+description: Get the access token of a user
+security:
+  - platformAppApiKey: []
+responses:
+  200:
+    description: Success
+    schema:
+      type: object
+      properties:
+        access_token:
+          type: string
+          description: Access token of the user
+        expiry:
+          type: [integer, "null"]
+          description: Expiry timestamp
+        user:
+          type: object
+          properties:
+            id:
+              type: integer
+              description: User ID
+            name:
+              type: string
+              description: User's full name
+            display_name:
+              type: string
+              description: User's display name
+            email:
+              type: string
+              description: User's email address
+            pubsub_token:
+              type: string
+              description: User's pubsub token
+  401:
+    description: Unauthorized
+  404:
+    description: The given user does not exist
+    

research/chatwoot/swagger/paths/platform/users/update.yml

@@ -0,0 +1,26 @@
+tags:
+  - Users
+operationId: update-a-user
+summary: Update a user
+description: Update a user's attributes
+security:
+  - platformAppApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/user_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/user'
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'