chore: Add documentation for automation rule, fix conversation/inbox_members (#4852)

This commit is contained in:
Tejaswini Chile
2022-06-14 10:35:56 +05:30
committed by GitHub
parent 713fdb44ee
commit 37cb46238a
17 changed files with 695 additions and 69 deletions

View File

@@ -0,0 +1,20 @@
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: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/automation_rule_create_update_payload'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/automation_rule'
'403':
description: Access denied

View File

@@ -0,0 +1,20 @@
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
type: integer
required: true
description: The ID of the automation rule to be deleted
responses:
'200':
description: Success
'403':
description: Access denied
'404':
description: automation rule not found

View File

@@ -0,0 +1,20 @@
tags:
- Automation Rule
operationId: get-account-automation-rule
summary: List all automation rules in an account
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/page'
description: Get details of automation rules in an Account
security:
- userApiKey: []
responses:
'200':
description: Success
schema:
type: array
description: Array of all automation rules
items:
$ref: '#/definitions/automation_rule'
'403':
description: Access denied

View File

@@ -0,0 +1,20 @@
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
parameters:
- in: path
name: id
type: integer
required: true
description: The ID of the automation rule to be updated.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/automation_rule'
'401':
description: Unauthorized
'404':
description: The given rule ID does not exist in the account

View File

@@ -0,0 +1,27 @@
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
type: integer
required: true
description: The ID of the automation rule to be updated.
- name: data
in: body
required: true
schema:
$ref: '#/definitions/automation_rule_create_update_payload'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/automation_rule'
'403':
description: Access denied
'404':
description: Rule not found