Restructure omni services and add Chatwoot research snapshot

2026-02-21 11:11:27 +07:00
parent edea7a0034
commit b73babbbf6
7732 changed files with 978203 additions and 32 deletions
--- a/research/chatwoot/swagger/paths/application/automation_rule/create.yml
+++ b/research/chatwoot/swagger/paths/application/automation_rule/create.yml
@@ -0,0 +1,26 @@
+tags:
+  - Automation Rule
+operationId: add-new-automation-rule-to-account
+summary: Add a new automation rule
+description: Add a new automation rule to account
+security:
+  - userApiKey: []
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/automation_rule_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
--- a/research/chatwoot/swagger/paths/application/automation_rule/delete.yml
+++ b/research/chatwoot/swagger/paths/application/automation_rule/delete.yml
@@ -0,0 +1,29 @@
+tags:
+  - Automation Rule
+operationId: delete-automation-rule-from-account
+summary: Remove a automation rule from account
+description: Remove a automation rule from account
+security:
+  - userApiKey: []
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: The ID of the automation rule to be deleted
+responses:
+  '200':
+    description: Success
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: automation rule not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
--- a/research/chatwoot/swagger/paths/application/automation_rule/index.yml
+++ b/research/chatwoot/swagger/paths/application/automation_rule/index.yml
@@ -0,0 +1,23 @@
+tags:
+  - Automation Rule
+operationId: get-account-automation-rule
+summary: List all automation rules in an account
+parameters:
+  - $ref: '#/components/parameters/account_id'
+  - $ref: '#/components/parameters/page'
+description: Get details of automation rules in an Account
+security:
+  - userApiKey: []
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
--- a/research/chatwoot/swagger/paths/application/automation_rule/show.yml
+++ b/research/chatwoot/swagger/paths/application/automation_rule/show.yml
@@ -0,0 +1,53 @@
+tags:
+  - Automation Rule
+operationId: get-details-of-a-single-automation-rule
+summary: Get a automation rule details
+description: Get the details of a automation rule in the account
+security:
+  - userApiKey: []
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: The ID of the automation rule to be updated.
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
+        example:
+          payload:
+            id: 90
+            account_id: 1
+            name: "add-label-bug-if-message-contains-bug"
+            description: "add-label-bug-if-message-contains-bug"
+            event_name: "message_created"
+            conditions:
+              - values: ["incoming"]
+                attribute_key: "message_type"
+                query_operator: "and"
+                filter_operator: "equal_to"
+              - values: ["bug"]
+                attribute_key: "content"
+                filter_operator: "contains"
+            actions:
+              - action_name: "add_label"
+                action_params: ["bugs", "support-query"]
+            created_on: 1650555440
+            active: true
+  '401':
+    description: Unauthorized
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: The given rule ID does not exist in the account
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
--- a/research/chatwoot/swagger/paths/application/automation_rule/update.yml
+++ b/research/chatwoot/swagger/paths/application/automation_rule/update.yml
@@ -0,0 +1,39 @@
+tags:
+  - Automation Rule
+operationId: update-automation-rule-in-account
+summary: Update automation rule in Account
+description: Update a automation rule in account
+security:
+  - userApiKey: []
+parameters:
+  - in: path
+    name: id
+    schema:
+      type: integer
+    required: true
+    description: The ID of the automation rule to be updated.
+requestBody:
+  required: true
+  content:
+    application/json:
+      schema:
+        $ref: '#/components/schemas/automation_rule_create_update_payload'
+responses:
+  '200':
+    description: Success
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/automation_rule'
+  '403':
+    description: Access denied
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'
+  '404':
+    description: Rule not found
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/bad_request_error'