Restructure omni services and add Chatwoot research snapshot
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: create-a-contact
|
||||
summary: Create a contact
|
||||
description: Create a contact
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_contact_create_update_payload'
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_contact'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: get-details-of-a-contact
|
||||
summary: Get a contact
|
||||
description: Get the details of a contact
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_contact'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: The given contact does not exist
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Contacts API
|
||||
operationId: update-a-contact
|
||||
summary: Update a contact
|
||||
description: Update a contact's attributes
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_contact_create_update_payload'
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_contact'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: create-a-conversation
|
||||
summary: Create a conversation
|
||||
description: Create a conversation
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_conversation_create_payload'
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_conversation'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,22 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: list-all-contact-conversations
|
||||
summary: List all conversations
|
||||
description: List all conversations for the contact
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of conversations'
|
||||
items:
|
||||
$ref: '#/components/schemas/public_conversation'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: get-single-conversation
|
||||
summary: Get a single conversation
|
||||
description: Retrieves the details of a specific conversation
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_conversation'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: Conversation not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: resolve-conversation
|
||||
summary: Resolve a conversation
|
||||
description: Marks a conversation as resolved
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Conversation resolved successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_conversation'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: Conversation not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,40 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: toggle-typing-status
|
||||
summary: Toggle typing status
|
||||
description: Toggles the typing status in a conversation
|
||||
security: []
|
||||
parameters:
|
||||
- name: typing_status
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Typing status, either 'on' or 'off'
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
typing_status:
|
||||
type: string
|
||||
enum: ['on', 'off']
|
||||
description: The typing status to set
|
||||
example: 'on'
|
||||
responses:
|
||||
'200':
|
||||
description: Typing status toggled successfully
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: Conversation not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,21 @@
|
||||
tags:
|
||||
- Conversations API
|
||||
operationId: update-last-seen
|
||||
summary: Update last seen
|
||||
description: Updates the last seen time of the contact in a conversation
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Last seen updated successfully
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: Conversation not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: create-a-message
|
||||
summary: Create a message
|
||||
description: Create a message
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_message_create_payload'
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_message'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,22 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: list-all-converation-messages
|
||||
summary: List all messages
|
||||
description: List all messages in the conversation
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of messages'
|
||||
items:
|
||||
$ref: '#/components/schemas/public_message'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Messages API
|
||||
operationId: update-a-message
|
||||
summary: Update a message
|
||||
description: Update a message
|
||||
security: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_message_update_payload'
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_message'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
25
research/chatwoot/swagger/paths/public/inboxes/show.yml
Normal file
25
research/chatwoot/swagger/paths/public/inboxes/show.yml
Normal file
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Inbox API
|
||||
operationId: get-details-of-a-inbox
|
||||
summary: Inbox details
|
||||
description: Get the details of an inbox
|
||||
security: []
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/public_inbox'
|
||||
'401':
|
||||
description: Unauthorized
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'404':
|
||||
description: The given inbox does not exist
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
Reference in New Issue
Block a user