From a1bddd53f1249d2a05d98e2ff273fa56b1f3e93b Mon Sep 17 00:00:00 2001 From: Tanmay Deep Sharma Date: Thu, 15 May 2025 15:10:04 +0700 Subject: [PATCH] update automation rules payload for developer docs --- swagger/definitions/index.yml | 2 + .../definitions/resource/automation_rule.yml | 74 +------ .../resource/automation_rule_item.yml | 69 +++++++ swagger/swagger.json | 180 +++++++++--------- 4 files changed, 162 insertions(+), 163 deletions(-) create mode 100644 swagger/definitions/resource/automation_rule_item.yml diff --git a/swagger/definitions/index.yml b/swagger/definitions/index.yml index 4e26c2c7e..872183ca7 100644 --- a/swagger/definitions/index.yml +++ b/swagger/definitions/index.yml @@ -16,6 +16,8 @@ custom_attribute: $ref: ./resource/custom_attribute.yml automation_rule: $ref: ./resource/automation_rule.yml +automation_rule_item: + $ref: ./resource/automation_rule_item.yml portal: $ref: ./resource/portal.yml category: diff --git a/swagger/definitions/resource/automation_rule.yml b/swagger/definitions/resource/automation_rule.yml index 6165b12a2..37fb0f61e 100644 --- a/swagger/definitions/resource/automation_rule.yml +++ b/swagger/definitions/resource/automation_rule.yml @@ -8,76 +8,4 @@ properties: items: $ref: '#/components/schemas/automation_rule_item' - $ref: '#/components/schemas/automation_rule_item' - description: Single automation rule (for show/create/update endpoints) - -# Schema for an individual automation rule (used by all automation rule endpoints) -automation_rule_item: - type: object - properties: - id: - type: integer - description: The ID of the automation rule - account_id: - type: integer - description: Account Id - name: - type: string - description: The name of the rule - example: Add label on message create event - description: - type: string - description: Description to give more context about the rule - example: Add label support and sales on message create event if incoming message content contains text help - event_name: - type: string - description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created) - enum: - - conversation_created - - conversation_updated - - message_created - example: message_created - conditions: - type: array - description: Array of conditions on which conversation/message filter would work - items: - type: object - properties: - values: - type: array - items: - type: string - attribute_key: - type: string - query_operator: - type: string - filter_operator: - type: string - example: - attribute_key: content - filter_operator: contains - values: - - help - query_operator: and - actions: - type: array - description: Array of actions which we perform when condition matches - items: - type: object - properties: - action_name: - type: string - action_params: - type: array - items: - type: string - example: - action_name: add_label - action_params: - - support - - sales - created_on: - type: integer - description: The timestamp when the rule was created - active: - type: boolean - description: Enable/disable automation rule + description: Single automation rule (for show/create/update endpoints) \ No newline at end of file diff --git a/swagger/definitions/resource/automation_rule_item.yml b/swagger/definitions/resource/automation_rule_item.yml new file mode 100644 index 000000000..b3b644b2e --- /dev/null +++ b/swagger/definitions/resource/automation_rule_item.yml @@ -0,0 +1,69 @@ +type: object +properties: + id: + type: integer + description: The ID of the automation rule + account_id: + type: integer + description: Account Id + name: + type: string + description: The name of the rule + example: Add label on message create event + description: + type: string + description: Description to give more context about the rule + example: Add label support and sales on message create event if incoming message content contains text help + event_name: + type: string + description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created) + enum: + - conversation_created + - conversation_updated + - message_created + example: message_created + conditions: + type: array + description: Array of conditions on which conversation/message filter would work + items: + type: object + properties: + values: + type: array + items: + type: string + attribute_key: + type: string + query_operator: + type: string + filter_operator: + type: string + example: + attribute_key: content + filter_operator: contains + values: + - help + query_operator: and + actions: + type: array + description: Array of actions which we perform when condition matches + items: + type: object + properties: + action_name: + type: string + action_params: + type: array + items: + type: string + example: + action_name: add_label + action_params: + - support + - sales + created_on: + type: integer + description: The timestamp when the rule was created + active: + type: boolean + description: Enable/disable automation rule \ No newline at end of file diff --git a/swagger/swagger.json b/swagger/swagger.json index 3c485388e..34788b999 100644 --- a/swagger/swagger.json +++ b/swagger/swagger.json @@ -7609,103 +7609,103 @@ } ] } - }, - "automation_rule_item": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the automation rule" - }, - "account_id": { - "type": "integer", - "description": "Account Id" - }, - "name": { - "type": "string", - "description": "The name of the rule", - "example": "Add label on message create event" - }, - "description": { - "type": "string", - "description": "Description to give more context about the rule", - "example": "Add label support and sales on message create event if incoming message content contains text help" - }, - "event_name": { - "type": "string", - "description": "Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)", - "enum": [ - "conversation_created", - "conversation_updated", - "message_created" - ], - "example": "message_created" - }, - "conditions": { - "type": "array", - "description": "Array of conditions on which conversation/message filter would work", - "items": { - "type": "object", - "properties": { - "values": { - "type": "array", - "items": { - "type": "string" - } - }, - "attribute_key": { - "type": "string" - }, - "query_operator": { - "type": "string" - }, - "filter_operator": { + } + }, + "automation_rule_item": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the automation rule" + }, + "account_id": { + "type": "integer", + "description": "Account Id" + }, + "name": { + "type": "string", + "description": "The name of the rule", + "example": "Add label on message create event" + }, + "description": { + "type": "string", + "description": "Description to give more context about the rule", + "example": "Add label support and sales on message create event if incoming message content contains text help" + }, + "event_name": { + "type": "string", + "description": "Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)", + "enum": [ + "conversation_created", + "conversation_updated", + "message_created" + ], + "example": "message_created" + }, + "conditions": { + "type": "array", + "description": "Array of conditions on which conversation/message filter would work", + "items": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { "type": "string" } }, - "example": { - "attribute_key": "content", - "filter_operator": "contains", - "values": [ - "help" - ], - "query_operator": "and" - } - } - }, - "actions": { - "type": "array", - "description": "Array of actions which we perform when condition matches", - "items": { - "type": "object", - "properties": { - "action_name": { - "type": "string" - }, - "action_params": { - "type": "array", - "items": { - "type": "string" - } - } + "attribute_key": { + "type": "string" }, - "example": { - "action_name": "add_label", - "action_params": [ - "support", - "sales" - ] + "query_operator": { + "type": "string" + }, + "filter_operator": { + "type": "string" } + }, + "example": { + "attribute_key": "content", + "filter_operator": "contains", + "values": [ + "help" + ], + "query_operator": "and" } - }, - "created_on": { - "type": "integer", - "description": "The timestamp when the rule was created" - }, - "active": { - "type": "boolean", - "description": "Enable/disable automation rule" } + }, + "actions": { + "type": "array", + "description": "Array of actions which we perform when condition matches", + "items": { + "type": "object", + "properties": { + "action_name": { + "type": "string" + }, + "action_params": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "example": { + "action_name": "add_label", + "action_params": [ + "support", + "sales" + ] + } + } + }, + "created_on": { + "type": "integer", + "description": "The timestamp when the rule was created" + }, + "active": { + "type": "boolean", + "description": "Enable/disable automation rule" } } },