feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)
This commit is contained in:
Daniel Jimenez
@@ -7,7 +7,7 @@
|
||||
$ref: ./platform/accounts/create.yml
|
||||
/platform/api/v1/accounts/{account_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: './platform/accounts/show.yml'
|
||||
patch:
|
||||
@@ -15,12 +15,11 @@
|
||||
delete:
|
||||
$ref: ./platform/accounts/delete.yml
|
||||
|
||||
|
||||
# Account Users
|
||||
|
||||
/platform/api/v1/accounts/{account_id}/account_users:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: './platform/account_users/index.yml'
|
||||
post:
|
||||
@@ -37,7 +36,7 @@
|
||||
$ref: ./platform/agent_bots/create.yml
|
||||
/platform/api/v1/agent_bots/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/agent_bot_id'
|
||||
- $ref: '#/components/parameters/agent_bot_id'
|
||||
get:
|
||||
$ref: './platform/agent_bots/show.yml'
|
||||
patch:
|
||||
@@ -52,7 +51,7 @@
|
||||
$ref: ./platform/users/create.yml
|
||||
/platform/api/v1/users/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/platform_user_id'
|
||||
- $ref: '#/components/parameters/platform_user_id'
|
||||
get:
|
||||
$ref: './platform/users/show.yml'
|
||||
patch:
|
||||
@@ -61,7 +60,7 @@
|
||||
$ref: ./platform/users/delete.yml
|
||||
/platform/api/v1/users/{id}/login:
|
||||
parameters:
|
||||
- $ref: '#/parameters/platform_user_id'
|
||||
- $ref: '#/components/parameters/platform_user_id'
|
||||
get:
|
||||
$ref: './platform/users/login.yml'
|
||||
/platform/api/v1/users/{id}/token:
|
||||
@@ -70,7 +69,6 @@
|
||||
post:
|
||||
$ref: './platform/users/token.yml'
|
||||
|
||||
|
||||
# ---------------- end of platform path -----------#
|
||||
|
||||
# ------------ Public API routes ------------#
|
||||
@@ -79,7 +77,7 @@
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
get:
|
||||
$ref: './public/inboxes/show.yml'
|
||||
|
||||
@@ -87,13 +85,13 @@
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
post:
|
||||
$ref: ./public/inboxes/contacts/create.yml
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
get:
|
||||
$ref: './public/inboxes/contacts/show.yml'
|
||||
patch:
|
||||
@@ -101,8 +99,8 @@
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
post:
|
||||
$ref: ./public/inboxes/conversations/create.yml
|
||||
get:
|
||||
@@ -110,61 +108,54 @@
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
get:
|
||||
$ref: ./public/inboxes/conversations/show.yml
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./public/inboxes/conversations/toggle_status.yml
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./public/inboxes/conversations/toggle_typing.yml
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./public/inboxes/conversations/update_last_seen.yml
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./public/inboxes/messages/create.yml
|
||||
get:
|
||||
$ref: ./public/inboxes/messages/index.yml
|
||||
|
||||
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/public_inbox_identifier'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/parameters/message_id'
|
||||
- $ref: '#/components/parameters/public_inbox_identifier'
|
||||
- $ref: '#/components/parameters/public_contact_identifier'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/message_id'
|
||||
patch:
|
||||
$ref: ./public/inboxes/messages/update.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{contact_identifier}/labels:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/public_contact_identifier'
|
||||
get:
|
||||
$ref: ./application/contacts/labels/index.yml
|
||||
post:
|
||||
$ref: ./application/contacts/labels/create.yml
|
||||
|
||||
# ---------------- end of public api routes-----------#
|
||||
|
||||
@@ -172,7 +163,7 @@
|
||||
|
||||
/survey/responses/{conversation_uuid}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/conversation_uuid'
|
||||
- $ref: '#/components/parameters/conversation_uuid'
|
||||
get:
|
||||
$ref: ./survey/show.yml
|
||||
|
||||
@@ -180,19 +171,18 @@
|
||||
|
||||
# ------------ Application API routes ------------#
|
||||
|
||||
|
||||
# AgentBots
|
||||
/api/v1/accounts/{account_id}/agent_bots:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/agent_bots/index.yml
|
||||
post:
|
||||
$ref: ./application/agent_bots/create.yml
|
||||
/api/v1/accounts/{account_id}/agent_bots/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/agent_bot_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/agent_bot_id'
|
||||
get:
|
||||
$ref: './application/agent_bots/show.yml'
|
||||
patch:
|
||||
@@ -203,14 +193,14 @@
|
||||
# Agents
|
||||
/api/v1/accounts/{account_id}/agents:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/agents/index.yml
|
||||
post:
|
||||
$ref: ./application/agents/create.yml
|
||||
/api/v1/accounts/{account_id}/agents/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
patch:
|
||||
$ref: ./application/agents/update.yml
|
||||
delete:
|
||||
@@ -219,14 +209,14 @@
|
||||
# Canned Responses
|
||||
/api/v1/accounts/{account_id}/canned_responses:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/canned_responses/index.yml
|
||||
post:
|
||||
$ref: ./application/canned_responses/create.yml
|
||||
/api/v1/accounts/{account_id}/canned_responses/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
patch:
|
||||
$ref: ./application/canned_responses/update.yml
|
||||
delete:
|
||||
@@ -235,17 +225,18 @@
|
||||
# Custom Attributes
|
||||
/api/v1/accounts/{account_id}/custom_attribute_definitions:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/custom_attributes/index.yml
|
||||
post:
|
||||
$ref: ./application/custom_attributes/create.yml
|
||||
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
schema:
|
||||
type: number
|
||||
description: ID of the custom attribute
|
||||
required: true
|
||||
get:
|
||||
@@ -262,13 +253,12 @@
|
||||
$ref: ./application/contacts/crud.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{id}/conversations:
|
||||
$ref: ./application/contacts/conversations.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{id}/labels:
|
||||
$ref: ./application/contacts/labels.yml
|
||||
/api/v1/accounts/{account_id}/contacts/search:
|
||||
$ref: ./application/contacts/search.yml
|
||||
/api/v1/accounts/{account_id}/contacts/filter:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
post:
|
||||
$ref: ./application/contacts/filter.yml
|
||||
$ref: ./application/contacts/filter.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes:
|
||||
$ref: ./application/contact_inboxes/create.yml
|
||||
/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes:
|
||||
@@ -278,17 +268,18 @@
|
||||
# Automation Rule
|
||||
/api/v1/accounts/{account_id}/automation_rules:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/automation_rule/index.yml
|
||||
post:
|
||||
$ref: ./application/automation_rule/create.yml
|
||||
/api/v1/accounts/{account_id}/automation_rules/{id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- name: id
|
||||
in: path
|
||||
type: number
|
||||
schema:
|
||||
type: number
|
||||
description: ID of the Automation Rule
|
||||
required: true
|
||||
get:
|
||||
@@ -298,36 +289,37 @@
|
||||
delete:
|
||||
$ref: ./application/automation_rule/delete.yml
|
||||
|
||||
|
||||
# Help Center
|
||||
/api/v1/accounts/{account_id}/portals:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
post:
|
||||
$ref: ./application/portal/create.yml
|
||||
get:
|
||||
$ref: ./application/portal/index.yml
|
||||
/api/v1/accounts/{account_id}/portals/{id}:
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/portal_id'
|
||||
patch:
|
||||
$ref: ./application/portal/update.yml
|
||||
|
||||
|
||||
# Help Center category
|
||||
/api/v1/accounts/{account_id}/portals/{portal_id}/categories:
|
||||
/api/v1/accounts/{account_id}/portals/{id}/categories:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/portal_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/portal_id'
|
||||
post:
|
||||
$ref: ./application/category/create.yml
|
||||
|
||||
# Help Center article
|
||||
/api/v1/accounts/{account_id}/portals/{portal_id}/articles:
|
||||
/api/v1/accounts/{account_id}/portals/{id}/articles:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/portal_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/portal_id'
|
||||
post:
|
||||
$ref: ./application/article/create.yml
|
||||
|
||||
|
||||
# Conversations
|
||||
/api/v1/accounts/{account_id}/conversations/meta:
|
||||
$ref: ./application/conversation/meta.yml
|
||||
@@ -335,34 +327,34 @@
|
||||
$ref: ./application/conversation/index.yml
|
||||
/api/v1/accounts/{account_id}/conversations/filter:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
post:
|
||||
$ref: ./application/conversation/filter.yml
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
get:
|
||||
$ref: ./application/conversation/show.yml
|
||||
patch:
|
||||
$ref: ./application/conversation/update.yml
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./application/conversation/toggle_status.yml
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priority:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./application/conversation/toggle_priority.yml
|
||||
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./application/conversation/custom_attributes.yml
|
||||
|
||||
@@ -370,8 +362,8 @@
|
||||
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
post:
|
||||
$ref: ./application/conversation/assignments.yml
|
||||
|
||||
@@ -379,14 +371,13 @@
|
||||
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
get:
|
||||
$ref: ./application/conversation/labels/index.yml
|
||||
post:
|
||||
$ref: ./application/conversation/labels/create.yml
|
||||
|
||||
|
||||
# Inboxes
|
||||
/api/v1/accounts/{account_id}/inboxes:
|
||||
$ref: ./application/inboxes/index.yml
|
||||
@@ -404,14 +395,14 @@
|
||||
# Inbox Members
|
||||
/api/v1/accounts/{account_id}/inbox_members/{inbox_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/inbox_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/inbox_id'
|
||||
get:
|
||||
$ref: ./application/inboxes/inbox_members/show.yml
|
||||
|
||||
/api/v1/accounts/{account_id}/inbox_members:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
post:
|
||||
$ref: ./application/inboxes/inbox_members/create.yml
|
||||
patch:
|
||||
@@ -419,31 +410,27 @@
|
||||
delete:
|
||||
$ref: ./application/inboxes/inbox_members/delete.yml
|
||||
|
||||
|
||||
|
||||
# Messages
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
get:
|
||||
$ref: ./application/conversation/messages/index.yml
|
||||
post:
|
||||
$ref: ./application/conversation/messages/create.yml
|
||||
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/conversation_id'
|
||||
- $ref: '#/parameters/message_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/conversation_id'
|
||||
- $ref: '#/components/parameters/message_id'
|
||||
delete:
|
||||
$ref: ./application/conversation/messages/delete.yml
|
||||
|
||||
|
||||
|
||||
# Integrations
|
||||
/api/v1/accounts/{account_id}/integrations/apps:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: './application/integrations/apps/show.yml'
|
||||
/api/v1/accounts/{account_id}/integrations/hooks:
|
||||
@@ -455,25 +442,22 @@
|
||||
delete:
|
||||
$ref: ./application/integrations/hooks/delete.yml
|
||||
|
||||
|
||||
|
||||
# Profile
|
||||
/api/v1/profile:
|
||||
$ref: ./profile/index.yml
|
||||
|
||||
|
||||
# Teams
|
||||
/api/v1/accounts/{account_id}/teams:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/teams/index.yml
|
||||
post:
|
||||
$ref: ./application/teams/create.yml
|
||||
/api/v1/accounts/{account_id}/teams/{team_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/team_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/team_id'
|
||||
get:
|
||||
$ref: './application/teams/show.yml'
|
||||
patch:
|
||||
@@ -482,8 +466,8 @@
|
||||
$ref: ./application/teams/delete.yml
|
||||
/api/v1/accounts/{account_id}/teams/{team_id}/team_members:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/team_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/team_id'
|
||||
get:
|
||||
$ref: ./application/team_members/index.yml
|
||||
post:
|
||||
@@ -498,11 +482,12 @@
|
||||
# Custom Filters
|
||||
/api/v1/accounts/{account_id}/custom_filters:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- in: query
|
||||
name: filter_type
|
||||
type: string
|
||||
enum: ['conversation', 'contact', 'report']
|
||||
schema:
|
||||
type: string
|
||||
enum: ['conversation', 'contact', 'report']
|
||||
required: false
|
||||
description: The type of custom filter
|
||||
get:
|
||||
@@ -511,8 +496,8 @@
|
||||
$ref: ./application/custom_filters/create.yml
|
||||
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/custom_filter_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/custom_filter_id'
|
||||
get:
|
||||
$ref: './application/custom_filters/show.yml'
|
||||
patch:
|
||||
@@ -523,15 +508,15 @@
|
||||
# webhooks
|
||||
/api/v1/accounts/{account_id}/webhooks:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
get:
|
||||
$ref: ./application/webhooks/index.yml
|
||||
post:
|
||||
$ref: ./application/webhooks/create.yml
|
||||
/api/v1/accounts/{account_id}/webhooks/{webhook_id}:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/webhook_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/webhook_id'
|
||||
patch:
|
||||
$ref: ./application/webhooks/update.yml
|
||||
delete:
|
||||
@@ -542,20 +527,23 @@
|
||||
# List
|
||||
/api/v2/accounts/{account_id}/reports:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/report_metric'
|
||||
- $ref: '#/parameters/report_type'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/report_metric'
|
||||
- $ref: '#/components/parameters/report_type'
|
||||
- in: query
|
||||
name: id
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The Id of specific object in case of agent/inbox/label
|
||||
- in: query
|
||||
name: since
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The timestamp from where report should start.
|
||||
- in: query
|
||||
name: until
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The timestamp from where report should stop.
|
||||
get:
|
||||
$ref: './application/reports/index.yml'
|
||||
@@ -563,19 +551,22 @@
|
||||
# Summary
|
||||
/api/v2/accounts/{account_id}/reports/summary:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/parameters/report_type'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- $ref: '#/components/parameters/report_type'
|
||||
- in: query
|
||||
name: id
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The Id of specific object in case of agent/inbox/label
|
||||
- in: query
|
||||
name: since
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The timestamp from where report should start.
|
||||
- in: query
|
||||
name: until
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The timestamp from where report should stop.
|
||||
get:
|
||||
$ref: './application/reports/summary.yml'
|
||||
@@ -583,12 +574,13 @@
|
||||
# Conversation metrics for account
|
||||
/api/v2/accounts/{account_id}/reports/conversations:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- in: query
|
||||
name: type
|
||||
type: string
|
||||
enum:
|
||||
- account
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- account
|
||||
required: true
|
||||
description: Type of report
|
||||
get:
|
||||
@@ -597,17 +589,19 @@
|
||||
# Conversation metrics for agent
|
||||
/api/v2/accounts/{account_id}/reports/conversations/:
|
||||
parameters:
|
||||
- $ref: '#/parameters/account_id'
|
||||
- $ref: '#/components/parameters/account_id'
|
||||
- in: query
|
||||
name: type
|
||||
type: string
|
||||
enum:
|
||||
- agent
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- agent
|
||||
required: true
|
||||
description: Type of report
|
||||
- in: query
|
||||
name: user_id
|
||||
type: string
|
||||
schema:
|
||||
type: string
|
||||
description: The numeric ID of the user
|
||||
get:
|
||||
$ref: './application/reports/conversation/agent.yml'
|
||||
|
||||
Reference in New Issue
Block a user