LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Chore: Custom filter api docs updated (#3668)

Browse Source
This commit is contained in:
Tejaswini Chile
2022-01-04 13:10:29 +05:30
committed by GitHub
parent 3e8ae3865f
commit e304ad27cb
4 changed files with 211 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

142
swagger/swagger.json
View File

@@ -1571,6 +1571,114 @@
}
}
},
"/api/v1/accounts/{account_id}/contacts/filter": {
"parameters": [
{
"$ref": "#/parameters/account_id"
}
],
"post": {
"tags": [
"Contact"
],
"operationId": "contactFilter",
"description": "Filter contacts with custom filter options and pagination",
"summary": "Contact Filter",
"security": [
{
"userApiKey": [
]
},
{
"agentBotApiKey": [
]
}
],
"parameters": [
{
"name": "page",
"in": "query",
"type": "integer"
},
{
"name": "payload",
"in": "body",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute_key": {
"type": "string",
"description": "filter attribute name"
},
"filter_operator": {
"type": "string",
"description": "filter operator name",
"enum": [
"equal_to",
"not_equal_to",
"contains",
"does_not_contain"
]
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "array of the attribute values to filter"
},
"query_operator": {
"type": "string",
"description": "query operator name",
"enum": [
"AND",
"OR"
]
}
}
},
"example": [
{
"attribute_key": "name",
"filter_operator": "equal_to",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "country_code",
"filter_operator": "equal_to",
"values": [
"us"
],
"query_operator": "nil"
}
]
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/contact_list"
}
},
"400": {
"description": "Bad Request Error",
"schema": {
"$ref": "#/definitions/bad_request_error"
}
}
}
}
},
"/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes": {
"post": {
"tags": [
@@ -1879,7 +1987,13 @@
},
"filter_operator": {
"type": "string",
"description": "filter operator name"
"description": "filter operator name",
"enum": [
"equal_to",
"not_equal_to",
"contains",
"does_not_contain"
]
},
"values": {
"type": "array",
@@ -1890,10 +2004,32 @@
},
"query_operator": {
"type": "string",
"description": "query operator name"
"description": "query operator name",
"enum": [
"AND",
"OR"
]
}
}
}
},
"example": [
{
"attribute_key": "browser_language",
"filter_operator": "not_eq",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "status",
"filter_operator": "eq",
"values": [
"pending"
],
"query_operator": "nil"
}
]
}
}
],