Restructure omni services and add Chatwoot research snapshot

research/chatwoot/swagger/definitions/resource/account.yml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  id:
+    type: number
+    description: Account ID
+  name:
+    type: string
+    description: Name of the account
+  role:
+    type: string
+    enum: ['administrator', 'agent']
+    description: The user role in the account

research/chatwoot/swagger/definitions/resource/account_detail.yml

@@ -0,0 +1,84 @@
+type: object
+properties:
+  id:
+    type: number
+    description: Account ID
+  name:
+    type: string
+    description: Name of the account
+  locale:
+    type: string
+    description: The locale of the account
+  domain:
+    type: string
+    description: The domain of the account
+  support_email:
+    type: string
+    description: The support email of the account
+  status:
+    type: string
+    description: The status of the account
+  created_at:
+    type: string
+    format: date-time
+    description: The creation date of the account
+  cache_keys:
+    type: object
+    description: Cache keys for the account
+  features:
+    type: array
+    items:
+      type: string
+    description: Enabled features for the account
+  settings:
+    type: object
+    description: Account settings
+    properties:
+      auto_resolve_after:
+        type: number
+        description: Auto resolve conversations after specified minutes
+      auto_resolve_message:
+        type: string
+        description: Message to send when auto resolving
+      auto_resolve_ignore_waiting:
+        type: boolean
+        description: Whether to ignore waiting conversations for auto resolve
+  custom_attributes:
+    type: object
+    description: Custom attributes of the account
+    properties:
+      plan_name:
+        type: string
+        description: Subscription plan name
+      subscribed_quantity:
+        type: number
+        description: Subscribed quantity
+      subscription_status:
+        type: string
+        description: Subscription status
+      subscription_ends_on:
+        type: string
+        format: date
+        description: Subscription end date
+      industry:
+        type: string
+        description: Industry type
+      company_size:
+        type: string
+        description: Company size
+      timezone:
+        type: string
+        description: Account timezone
+      logo:
+        type: string
+        description: Account logo URL
+      onboarding_step:
+        type: string
+        description: Current onboarding step
+      marked_for_deletion_at:
+        type: string
+        format: date-time
+        description: When account was marked for deletion
+      marked_for_deletion_reason:
+        type: string
+        description: Reason for account deletion

research/chatwoot/swagger/definitions/resource/account_show_response.yml

@@ -0,0 +1,13 @@
+allOf:
+  - $ref: '#/components/schemas/account_detail'
+  - type: object
+    properties:
+      latest_chatwoot_version:
+        type: string
+        description: Latest version of Chatwoot available
+        example: "3.0.0"
+      subscribed_features:
+        type: array
+        items:
+          type: string
+        description: List of subscribed enterprise features (if enterprise edition is enabled)

research/chatwoot/swagger/definitions/resource/account_user.yml

@@ -0,0 +1,14 @@
+type: array
+description: 'Array of account users'
+items:
+  type: object
+  properties:
+    account_id:
+      type: integer
+      description: The ID of the account
+    user_id:
+      type: integer
+      description: The ID of the user
+    role:
+      type: string
+      description: whether user is an administrator or agent

research/chatwoot/swagger/definitions/resource/agent.yml

@@ -0,0 +1,35 @@
+type: object
+properties:
+  id:
+    type: integer
+  account_id:
+    type: integer
+  availability_status:
+    type: string
+    enum: ['available', 'busy', 'offline']
+    description: The availability status of the agent computed by Chatwoot.
+  auto_offline:
+    type: boolean
+    description: Whether the availability status of agent is configured to go offline automatically when away.
+  confirmed:
+    type: boolean
+    description: Whether the agent has confirmed their email address.
+  email:
+    type: string
+    description: The email of the agent
+  available_name:
+    type: string
+    description: The available name of the agent
+  name:
+    type: string
+    description: The name of the agent
+  role:
+    type: string
+    enum: ['agent', 'administrator']
+    description: The role of the agent
+  thumbnail:
+    type: string
+    description: The thumbnail of the agent
+  custom_role_id:
+    type: integer
+    description: The custom role id of the agent

research/chatwoot/swagger/definitions/resource/agent_bot.yml

@@ -0,0 +1,32 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the agent bot
+  name:
+    type: string
+    description: The name of the agent bot
+  description:
+    type: string
+    description: The description about the agent bot
+  thumbnail:
+    type: string
+    description: The thumbnail of the agent bot
+  outgoing_url:
+    type: string
+    description: The webhook URL for the bot
+  bot_type:
+    type: string
+    description: The type of the bot
+  bot_config:
+    type: object
+    description: The configuration of the bot
+  account_id:
+    type: number
+    description: Account ID if it's an account specific bot
+  access_token:
+    type: string
+    description: The access token for the bot
+  system_bot:
+    type: boolean
+    description: Whether the bot is a system bot

research/chatwoot/swagger/definitions/resource/article.yml

@@ -0,0 +1,33 @@
+type: object
+properties:
+  id:
+    type: integer
+  content:
+    type: string
+    description: The text content.
+  meta:
+    type: object
+  position:
+    type: integer
+  status:
+    type: integer
+    enum: ['draft', 'published', 'archived']
+  title:
+    type: string
+  slug:
+    type: string
+  views:
+    type: integer
+  portal_id:
+    type: integer
+  account_id:
+    type: integer
+  author_id:
+    type: integer
+  category_id:
+    type: integer
+  folder_id:
+    type: integer
+  associated_article_id:
+    type: integer
+    description: To associate similar articles to each other, e.g to provide the link for the reference.

research/chatwoot/swagger/definitions/resource/audit_log.yml

@@ -0,0 +1,53 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Unique identifier for the audit log entry
+  auditable_id:
+    type: integer
+    description: The ID of the audited object
+  auditable_type:
+    type: string
+    description: The type of the audited object (e.g., Conversation, Contact, User)
+  auditable:
+    type: object
+    description: The audited object data
+  associated_id:
+    type: integer
+    description: The ID of the associated object (typically the account ID)
+  associated_type:
+    type: string
+    description: The type of the associated object
+  user_id:
+    type: integer
+    description: The ID of the user who performed the action
+  user_type:
+    type: string
+    description: The type of user who performed the action
+  username:
+    type: string
+    description: The email/username of the user who performed the action
+  action:
+    type: string
+    enum: ['create', 'update', 'destroy']
+    description: The action performed on the object
+  audited_changes:
+    type: object
+    description: JSON object containing the changes made to the audited object
+  version:
+    type: integer
+    description: Version number of the audit log entry
+  comment:
+    type: string
+    nullable: true
+    description: Optional comment associated with the audit log entry
+  request_uuid:
+    type: string
+    description: UUID to identify the request that generated this audit log
+  created_at:
+    type: integer
+    description: Unix timestamp when the audit log entry was created
+  remote_address:
+    type: string
+    nullable: true
+    description: IP address from which the action was performed

research/chatwoot/swagger/definitions/resource/automation_rule.yml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  payload:
+    description: Response payload that contains automation rule(s)
+    oneOf:
+      - type: array
+        description: Array of automation rules (for listing endpoint)
+        items:
+          $ref: '#/components/schemas/automation_rule_item'
+      - type: object
+        description: Single automation rule (for show/create/update endpoints)
+        allOf:
+          - $ref: '#/components/schemas/automation_rule_item'

research/chatwoot/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 

research/chatwoot/swagger/definitions/resource/canned_response.yml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: ID of the canned response
+  account_id:
+    type: integer
+    description: Account Id
+  short_code:
+    type: string
+    description: Short Code for quick access of the canned response
+  content:
+    type: string
+    description: Message content for canned response
+  created_at:
+    type: string
+    description: The date and time when the canned response was created
+  updated_at:
+    type: string
+    description: The date and time when the canned response was updated

research/chatwoot/swagger/definitions/resource/category.yml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  id:
+    type: integer
+  description:
+    type: string
+    description: The text content.
+  locale:
+    type: string
+  name:
+    type: string
+  slug:
+    type: string
+  position:
+    type: integer
+  portal_id:
+    type: integer
+  account_id:
+    type: integer
+  associated_category_id:
+    type: integer
+    description: To associate similar categories to each other, e.g same category of product documentation in different languages
+  parent_category_id:
+    type: integer
+    description: To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

research/chatwoot/swagger/definitions/resource/contact.yml

@@ -0,0 +1,49 @@
+type: object
+properties:
+  payload:
+    type: array
+    items:
+      type: object
+      properties:
+        additional_attributes:
+          type: object
+          description: The object containing additional attributes related to the contact
+        availability_status:
+          type: string
+          description: The availability status of the contact
+        email:
+          type: string
+          description: The email address of the contact
+        id:
+          type: integer
+          description: The ID of the contact
+        name:
+          type: string
+          description: The name of the contact
+        phone_number:
+          type: string
+          description: The phone number of the contact
+        blocked:
+          type: boolean
+          description: Whether the contact is blocked
+        identifier:
+          type: string
+          description: The identifier of the contact
+        thumbnail:
+          type: string
+          description: The thumbnail of the contact
+        custom_attributes:
+          type: object
+          description: The custom attributes of the contact
+          example:
+            { attribute_key: attribute_value, signed_up_at: dd/mm/yyyy }
+        last_activity_at:
+          type: integer
+          description: The last activity at of the contact
+        created_at:
+          type: integer
+          description: The created at of the contact
+        contact_inboxes:
+          type: array
+          items:
+            $ref: '#/components/schemas/contact_inboxes'

research/chatwoot/swagger/definitions/resource/contact_conversation_message.yml

@@ -0,0 +1,109 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: ID of the message
+  content:
+    type: string
+    description: Content of the message
+  account_id:
+    type: integer
+    description: ID of the account
+  inbox_id:
+    type: integer
+    description: ID of the inbox
+  conversation_id:
+    type: integer
+    description: ID of the conversation
+  message_type:
+    type: integer
+    description: Type of the message
+  created_at:
+    type: integer
+    description: Timestamp when message was created
+  updated_at:
+    type: string
+    description: Formatted datetime when message was updated
+  private:
+    type: boolean
+    description: Whether the message is private
+  status:
+    type: string
+    description: Status of the message
+  source_id:
+    type: string
+    description: Source ID of the message
+    nullable: true
+  content_type:
+    type: string
+    description: Type of the content
+  content_attributes:
+    type: object
+    description: Attributes of the content
+  sender_type:
+    type: string
+    description: Type of the sender
+    nullable: true
+  sender_id:
+    type: integer
+    description: ID of the sender
+    nullable: true
+  external_source_ids:
+    type: object
+    description: External source IDs
+  additional_attributes:
+    type: object
+    description: Additional attributes of the message
+  processed_message_content:
+    type: string
+    description: Processed message content
+    nullable: true
+  sentiment:
+    type: object
+    description: Sentiment analysis of the message
+  conversation:
+    type: object
+    description: Conversation details
+    properties:
+      assignee_id:
+        type: integer
+        description: ID of the assignee
+        nullable: true
+      unread_count:
+        type: integer
+        description: Count of unread messages
+      last_activity_at:
+        type: integer
+        description: Timestamp of last activity
+      contact_inbox:
+        type: object
+        description: Contact inbox details
+        properties:
+          source_id:
+            type: string
+            description: Source ID of the contact inbox
+  sender:
+    type: object
+    description: Details of the sender
+    properties:
+      id:
+        type: integer
+        description: ID of the sender
+      name:
+        type: string
+        description: Name of the sender
+      available_name:
+        type: string
+        description: Available name of the sender
+      avatar_url:
+        type: string
+        description: URL of the sender's avatar
+      type:
+        type: string
+        description: Type of the sender
+      availability_status:
+        type: string
+        description: Availability status of the sender
+      thumbnail:
+        type: string
+        description: Thumbnail URL of the sender 

research/chatwoot/swagger/definitions/resource/contact_conversations_response.yml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  payload:
+    type: array
+    items:
+      allOf:
+        - $ref: '#/components/schemas/conversation'
+        - type: object
+          properties:
+            meta:
+              $ref: './extension/contact/conversation.yml#/properties/meta'
+              description: Meta information about the conversation
+    description: List of conversations for the contact 

research/chatwoot/swagger/definitions/resource/contact_detail.yml

@@ -0,0 +1,48 @@
+type: object
+properties:
+  additional_attributes:
+    type: object
+    description: The object containing additional attributes related to the contact
+    properties:
+      city:
+        type: string
+        description: City of the contact
+      country:
+        type: string
+        description: Country of the contact
+      country_code:
+        type: string
+        description: Country code of the contact
+      created_at_ip:
+        type: string
+        description: IP address when the contact was created
+  custom_attributes:
+    type: object
+    description: The custom attributes of the contact
+  email:
+    type: string
+    description: The email address of the contact
+  id:
+    type: integer
+    description: The ID of the contact
+  identifier:
+    type: string
+    description: The identifier of the contact
+    nullable: true
+  name:
+    type: string
+    description: The name of the contact
+  phone_number:
+    type: string
+    description: The phone number of the contact
+    nullable: true
+  thumbnail:
+    type: string
+    description: The thumbnail of the contact
+  blocked:
+    type: boolean
+    description: Whether the contact is blocked
+  type:
+    type: string
+    description: The type of entity
+    enum: ["contact"] 

research/chatwoot/swagger/definitions/resource/contact_inbox.yml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  source_id:
+    type: string
+    description: Source identifier for the contact inbox
+  inbox:
+    type: object
+    properties:
+      id:
+        type: integer
+        description: ID of the inbox
+      avatar_url:
+        type: string
+        description: URL for the inbox avatar
+      channel_id:
+        type: integer
+        description: ID of the channel
+      name:
+        type: string
+        description: Name of the inbox
+      channel_type:
+        type: string
+        description: Type of channel
+      provider:
+        type: string
+        description: Provider of the inbox
+        nullable: true 

research/chatwoot/swagger/definitions/resource/contact_inboxes.yml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  source_id:
+    type: string
+    description: Contact Inbox Source Id
+  inbox:
+    $ref: '#/components/schemas/inbox_contact'

research/chatwoot/swagger/definitions/resource/contact_list_item.yml

@@ -0,0 +1,61 @@
+type: object
+properties:
+  additional_attributes:
+    type: object
+    description: The object containing additional attributes related to the contact
+    properties:
+      city:
+        type: string
+        description: City of the contact
+      country:
+        type: string
+        description: Country of the contact
+      country_code:
+        type: string
+        description: Country code of the contact
+      created_at_ip:
+        type: string
+        description: IP address when the contact was created
+  availability_status:
+    type: string
+    description: Availability status of the contact
+    enum: ["online", "offline"]
+  email:
+    type: string
+    description: The email address of the contact
+    nullable: true
+  id:
+    type: integer
+    description: The ID of the contact
+  name:
+    type: string
+    description: The name of the contact
+  phone_number:
+    type: string
+    description: The phone number of the contact
+    nullable: true
+  blocked:
+    type: boolean
+    description: Whether the contact is blocked
+  identifier:
+    type: string
+    description: The identifier of the contact
+    nullable: true
+  thumbnail:
+    type: string
+    description: The thumbnail of the contact
+  custom_attributes:
+    type: object
+    description: The custom attributes of the contact
+  last_activity_at:
+    type: integer
+    description: Timestamp of last activity
+    nullable: true
+  created_at:
+    type: integer
+    description: Timestamp when contact was created
+  contact_inboxes:
+    type: array
+    description: List of inboxes associated with this contact
+    items:
+      $ref: '#/components/schemas/contact_inbox' 

research/chatwoot/swagger/definitions/resource/contact_meta.yml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  count:
+    type: integer
+    description: Total number of contacts
+  current_page:
+    type: string
+    description: Current page number 

research/chatwoot/swagger/definitions/resource/contact_show_response.yml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  payload:
+    $ref: '#/components/schemas/contact_list_item'
+    description: Contact details 

research/chatwoot/swagger/definitions/resource/contactable_inboxes.yml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  source_id:
+    type: string
+    description: Contact Inbox Source Id
+  inbox:
+    type: object
+    $ref: '#/components/schemas/inbox'

research/chatwoot/swagger/definitions/resource/contactable_inboxes_response.yml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  payload:
+    type: array
+    items:
+      $ref: '#/components/schemas/contact_inbox'
+    description: List of contactable inboxes for the contact 

research/chatwoot/swagger/definitions/resource/contacts_list_response.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  meta:
+    $ref: '#/components/schemas/contact_meta'
+    description: Metadata about the contact list response
+  payload:
+    type: array
+    items:
+      $ref: '#/components/schemas/contact_list_item'
+    description: List of contacts 

research/chatwoot/swagger/definitions/resource/conversation.yml

@@ -0,0 +1,91 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the conversation
+  messages:
+    type: array
+    items:
+      $ref: '#/components/schemas/message'
+  account_id:
+    type: number
+    description: Account Id
+  uuid:
+    type: string
+    description: UUID of the conversation
+  additional_attributes:
+    type: object
+    description: The object containing additional attributes related to the conversation
+  agent_last_seen_at:
+    type: number
+    description: The last activity at of the agent
+  assignee_last_seen_at:
+    type: number
+    description: The last activity at of the assignee
+  can_reply:
+    type: boolean
+    description: Whether the conversation can be replied to
+  contact_last_seen_at:
+    type: number
+    description: The last activity at of the contact
+  custom_attributes:
+    type: object
+    description: The object to save custom attributes for conversation, accepts custom attributes key and value
+  inbox_id:
+    type: number
+    description: ID of the inbox
+  labels:
+    type: array
+    items:
+      type: string
+    description: The labels of the conversation
+  muted:
+    type: boolean
+    description: Whether the conversation is muted
+  snoozed_until:
+    type: number
+    description: The time at which the conversation will be unmuted
+  status:
+    type: string
+    enum: ['open', 'resolved', 'pending']
+    description: The status of the conversation
+  created_at:
+    type: number
+    description: The time at which conversation was created
+  updated_at:
+    type: number
+    description: The time at which conversation was updated
+  timestamp:
+    type: string
+    description: The time at which conversation was created
+  first_reply_created_at:
+    type: number
+    description: The time at which the first reply was created
+  unread_count:
+    type: number
+    description: The number of unread messages
+  last_non_activity_message:
+    type: object
+    $ref: '#/components/schemas/message'
+    description: The last non activity message
+  last_activity_at:
+    type: number
+    description: The last activity at of the conversation
+  priority:
+    type: string
+    description: The priority of the conversation
+  waiting_since:
+    type: number
+    description: The time at which the conversation was waiting
+  sla_policy_id:
+    type: number
+    description: The ID of the SLA policy
+  applied_sla:
+    type: object
+    description: The applied SLA
+  sla_events:
+    type: array
+    items:
+      type: object
+      description: SLA event objects
+

research/chatwoot/swagger/definitions/resource/conversation_messages.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  meta:
+    $ref: '#/components/schemas/conversation_meta'
+    description: Meta information about the conversation
+  payload:
+    type: array
+    items:
+      $ref: '#/components/schemas/message_detailed'
+    description: List of messages in the conversation 

research/chatwoot/swagger/definitions/resource/conversation_meta.yml

@@ -0,0 +1,55 @@
+type: object
+properties:
+  labels:
+    type: array
+    items:
+      type: string
+    description: Labels associated with the conversation
+  additional_attributes:
+    type: object
+    properties:
+      browser:
+        type: object
+        properties:
+          device_name:
+            type: string
+            description: Name of the device
+          browser_name:
+            type: string
+            description: Name of the browser
+          platform_name:
+            type: string
+            description: Name of the platform
+          browser_version:
+            type: string
+            description: Version of the browser
+          platform_version:
+            type: string
+            description: Version of the platform
+      referer:
+        type: string
+        description: Referrer URL
+      initiated_at:
+        type: object
+        properties:
+          timestamp:
+            type: string
+            description: Timestamp when the conversation was initiated
+      browser_language:
+        type: string
+        description: Browser language setting
+      conversation_language:
+        type: string
+        description: Conversation language
+    description: Additional attributes of the conversation
+  contact:
+    $ref: '#/components/schemas/contact_detail'
+    description: Contact details
+  agent_last_seen_at:
+    type: string
+    description: Timestamp when the agent last saw the conversation
+    nullable: true
+  assignee_last_seen_at:
+    type: string
+    description: Timestamp when the assignee last saw the conversation
+    nullable: true 

research/chatwoot/swagger/definitions/resource/custom_attribute.yml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Identifier
+  attribute_display_name:
+    type: string
+    description: Attribute display name
+  attribute_display_type:
+    type: string
+    description: Attribute display type (text, number, currency, percent, link, date, list, checkbox)
+  attribute_description:
+    type: string
+    description: Attribute description
+  attribute_key:
+    type: string
+    description: Attribute unique key value
+  regex_pattern:
+    type: string
+    description: Regex pattern
+  regex_cue:
+    type: string
+    description: Regex cue
+  attribute_values:
+    type: string
+    description: Attribute values
+  attribute_model:
+    type: string
+    description: Attribute type(conversation_attribute/contact_attribute)
+  default_value:
+    type: string
+    description: Attribute default value
+  created_at:
+    type: string
+    description: The date and time when the custom attribute was created
+  updated_at:
+    type: string
+    description: The date and time when the custom attribute was updated

research/chatwoot/swagger/definitions/resource/custom_filter.yml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the custom filter
+  name:
+    type: string
+    description: The name of the custom filter
+  type:
+    type: string
+    enum: ["conversation", "contact", "report"]
+    description: The description about the custom filter
+  query:
+    type: object
+    description: A query that needs to be saved as a custom filter
+  created_at:
+    type: string
+    format: date-time
+    description: The time at which the custom filter was created
+  updated_at:
+    type: string
+    format: date-time
+    description: The time at which the custom filter was updated

research/chatwoot/swagger/definitions/resource/extension/contact/conversation.yml

@@ -0,0 +1,53 @@
+type: object
+properties:
+  meta:
+    type: object
+    properties:
+      sender:
+        type: object
+        properties:
+          additional_attributes:
+            type: object
+            description: The additional attributes of the sender
+          availability_status:
+            type: string
+            description: The availability status of the sender
+          email:
+            type: string
+            description: The email of the sender
+          id:
+            type: number
+            description: ID fo the sender
+          name:
+            type: string
+            description: The name of the sender
+          phone_number:
+            type: string
+            description: The phone number of the sender
+          blocked:
+            type: boolean
+            description: Whether the sender is blocked
+          identifier:
+            type: string
+            description: The identifier of the sender
+          thumbnail:
+            type: string
+            description: Avatar URL of the contact
+          custom_attributes:
+            type: object
+            description: The custom attributes of the sender
+          last_activity_at:
+            type: number
+            description: The last activity at of the sender
+          created_at:
+            type: number
+            description: The created at of the sender
+
+      channel:
+        type: string
+        description: Channel Type
+      assignee:
+        $ref: '#/components/schemas/user'
+      hmac_verified:
+        type: boolean
+        description: Whether the hmac is verified

research/chatwoot/swagger/definitions/resource/extension/contact/labels.yml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  payload:
+    type: array
+    description: Array of labels
+    items:
+      type: string

research/chatwoot/swagger/definitions/resource/extension/contact/show.yml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  id:
+    type: number
+    description: Id of the user
+  availability_status:
+    type: string
+    enum: ['online', 'offline']
+    description: Availability status of the user

research/chatwoot/swagger/definitions/resource/extension/conversation/labels.yml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  payload:
+    type: array
+    description: Array of labels
+    items:
+      type: string

research/chatwoot/swagger/definitions/resource/extension/conversation/list.yml

@@ -0,0 +1,24 @@
+type: object
+properties:
+  data:
+    type: object
+    properties:
+      meta:
+        type: object
+        properties:
+          mine_count:
+            type: number
+          unassigned_count:
+            type: number
+          assigned_count:
+            type: number
+          all_count:
+            type: number
+      payload:
+        type: array
+        description: 'array of conversations'
+        items:
+          allOf:
+            - $ref: '#/components/schemas/generic_id'
+            - $ref: '#/components/schemas/conversation'
+            - $ref: '../contact/conversation.yml'

research/chatwoot/swagger/definitions/resource/extension/conversation/show.yml

@@ -0,0 +1,4 @@
+type: object
+allOf:
+  - $ref: '#/components/schemas/conversation'
+  - $ref: '../contact/conversation.yml'

research/chatwoot/swagger/definitions/resource/extension/conversation/status_toggle.yml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  meta:
+    type: object
+  payload:
+    type: object
+    properties:
+      success:
+        type: boolean
+      current_status:
+        type: string
+        enum: ['open', 'resolved']
+      conversation_id:
+        type: number

research/chatwoot/swagger/definitions/resource/extension/conversation/with_display_id.yml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  display_id:
+    type: number

research/chatwoot/swagger/definitions/resource/extension/generic.yml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  id:
+    type: number

research/chatwoot/swagger/definitions/resource/extension/message/with_source_sender.yml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  source_id:
+    type: number

research/chatwoot/swagger/definitions/resource/inbox.yml

@@ -0,0 +1,125 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the inbox
+  name:
+    type: string
+    description: The name of the inbox
+  website_url:
+    type: string
+    description: Website URL
+  channel_type:
+    type: string
+    description: The type of the inbox
+  avatar_url:
+    type: string
+    description: The avatar image of the inbox
+  widget_color:
+    type: string
+    description: Widget Color used for customization of the widget
+  website_token:
+    type: string
+    description: Website Token
+  enable_auto_assignment:
+    type: boolean
+    description: The flag which shows whether Auto Assignment is enabled or not
+  web_widget_script:
+    type: string
+    description: Script used to load the website widget
+  welcome_title:
+    type: string
+    description: Welcome title to be displayed on the widget
+  welcome_tagline:
+    type: string
+    description: Welcome tagline to be displayed on the widget
+  greeting_enabled:
+    type: boolean
+    description: The flag which shows whether greeting is enabled
+  greeting_message:
+    type: string
+    description: A greeting message when the user starts the conversation
+  channel_id:
+    type: number
+    description: ID of the channel this inbox belongs to
+  working_hours_enabled:
+    type: boolean
+    description: The flag which shows whether working hours feature is enabled
+  enable_email_collect:
+    type: boolean
+    description: The flag to enable collecting email from contacts
+  csat_survey_enabled:
+    type: boolean
+    description: The flag to enable CSAT survey
+  auto_assignment_config:
+    type: object
+    description: Configuration settings for auto assignment
+  out_of_office_message:
+    type: string
+    description: Message to show when agents are out of office
+  working_hours:
+    type: array
+    description: Configuration for working hours of the inbox
+    items:
+      type: object
+      properties:
+        day_of_week:
+          type: number
+          description: Day of the week (0-6, where 0 is Sunday)
+        closed_all_day:
+          type: boolean
+          description: Whether the inbox is closed for the entire day
+        open_hour:
+          type: number
+          description: Hour when inbox opens (0-23)
+        open_minutes:
+          type: number
+          description: Minutes of the hour when inbox opens (0-59)
+        close_hour:
+          type: number
+          description: Hour when inbox closes (0-23)
+        close_minutes:
+          type: number
+          description: Minutes of the hour when inbox closes (0-59)
+        open_all_day:
+          type: boolean
+          description: Whether the inbox is open for the entire day
+  timezone:
+    type: string
+    description: Timezone configuration for the inbox
+  callback_webhook_url:
+    type: string
+    description: Webhook URL for callbacks
+  allow_messages_after_resolved:
+    type: boolean
+    description: Whether to allow messages after a conversation is resolved
+  lock_to_single_conversation:
+    type: boolean
+    description: Whether to lock a contact to a single conversation
+  sender_name_type:
+    type: string
+    description: Type of sender name to display (e.g., friendly)
+  business_name:
+    type: string
+    description: Business name associated with the inbox
+  hmac_mandatory:
+    type: boolean
+    description: Whether HMAC verification is mandatory
+  selected_feature_flags:
+    type: object
+    description: Selected feature flags for the inbox
+  reply_time:
+    type: string
+    description: Expected reply time
+  messaging_service_sid:
+    type: string
+    description: Messaging service SID for SMS providers
+  phone_number:
+    type: string
+    description: Phone number associated with the inbox
+  medium:
+    type: string
+    description: Medium of communication (e.g., sms, email)
+  provider:
+    type: string
+    description: Provider of the channel

research/chatwoot/swagger/definitions/resource/inbox_contact.yml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the inbox
+  avatar_url:
+    type: string
+    description: The avatar image of the inbox
+  channel_id:
+    type: number
+    description: The ID of the channel
+  name:
+    type: string
+    description: The name of the inbox
+  channel_type:
+    type: string
+    description: The type of the inbox
+  provider:
+    type: string
+    description: The provider of the inbox

research/chatwoot/swagger/definitions/resource/integrations/app.yml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the integration
+  name:
+    type: string
+    description: The name of the integration
+  description:
+    type: string
+    description: The description about the team
+  hook_type:
+    type: string
+    description: Whether the integration is an account or inbox integration
+  enabled:
+    type: boolean
+    description: Whether the integration is enabled for the account
+  allow_multiple_hooks:
+    type: boolean
+    description: Whether multiple hooks can be created for the integration
+  hooks:
+    type: array
+    items:
+      type: object
+    description: If there are any hooks created for this integration

research/chatwoot/swagger/definitions/resource/integrations/hook.yml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the integration hook
+  app_id:
+    type: string
+    description: The ID of the integration app
+  inbox_id:
+    type: string
+    description: Inbox ID if its an Inbox integration
+  account_id:
+    type: string
+    description: Account ID of the integration
+  status:
+    type: boolean
+    description: Whether the integration hook is enabled for the account
+  hook_type:
+    type: boolean
+    description: Whether its an account or inbox integration hook
+  settings:
+    type: object
+    description: The associated settings for the integration

research/chatwoot/swagger/definitions/resource/message.yml

@@ -0,0 +1,72 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the message
+  content:
+    type: string
+    description: The text content of the message
+  account_id:
+    type: number
+    description: The ID of the account
+  inbox_id:
+    type: number
+    description: The ID of the inbox
+  conversation_id:
+    type: number
+    description: The ID of the conversation
+  message_type:
+    type: integer
+    enum: [0, 1, 2]
+    description: The type of the message
+  created_at:
+    type: integer
+    description: The time at which message was created
+  updated_at:
+    type: integer
+    description: The time at which message was updated
+  private:
+    type: boolean
+    description: The flags which shows whether the message is private or not
+  status:
+    type: string
+    enum: ["sent", "delivered", "read", "failed"]
+    description: The status of the message
+  source_id:
+    type: string
+    description: The source ID of the message
+  content_type:
+    type: string
+    enum: ["text", "input_select", "cards", "form"]
+    description: The type of the template message
+  content_attributes:
+    type: object
+    description: The content attributes for each content_type
+  sender_type:
+    type: string
+    enum: ["contact", "agent", "agent_bot"]
+    description: The type of the sender
+  sender_id:
+    type: number
+    description: The ID of the sender
+  external_source_ids:
+    type: object
+    description: The external source IDs of the message
+  additional_attributes:
+    type: object
+    description: The additional attributes of the message
+  processed_message_content:
+    type: string
+    description: The processed message content
+  sentiment:
+    type: object
+    description: The sentiment of the message
+  conversation:
+    type: object
+    description: The conversation object
+  attachment:
+    type: object
+    description: The file object attached to the image
+  sender:
+    type: object
+    description: User/Agent/AgentBot object

research/chatwoot/swagger/definitions/resource/message_detailed.yml

@@ -0,0 +1,47 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the message
+  content:
+    type: string
+    description: The text content of the message
+  inbox_id:
+    type: number
+    description: The ID of the inbox
+  conversation_id:
+    type: number
+    description: The ID of the conversation
+  message_type:
+    type: integer
+    enum: [0, 1, 2, 3]
+    description: "The type of the message (0: incoming, 1: outgoing, 2: activity, 3: template)"
+  content_type:
+    type: string
+    enum: ["text", "input_select", "cards", "form", "input_csat"]
+    description: The type of the message content
+  status:
+    type: string
+    enum: ["sent", "delivered", "read", "failed"]
+    description: The status of the message
+  content_attributes:
+    type: object
+    description: The content attributes for each content_type
+    properties:
+      in_reply_to:
+        type: string
+        description: ID of the message this is replying to
+        nullable: true
+  created_at:
+    type: integer
+    description: The timestamp when message was created
+  private:
+    type: boolean
+    description: The flag which shows whether the message is private or not
+  source_id:
+    type: string
+    description: The source ID of the message
+    nullable: true
+  sender:
+    $ref: '#/components/schemas/contact_detail'
+    description: The sender of the message (only for incoming messages) 

research/chatwoot/swagger/definitions/resource/platform_account.yml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  id:
+    type: number
+    description: Account ID
+  name:
+    type: string
+    description: Name of the account
+

research/chatwoot/swagger/definitions/resource/portal.yml

@@ -0,0 +1,6 @@
+type: object
+properties:
+  payload:
+    type: array
+    items:
+      $ref: '#/components/schemas/portal_item'

research/chatwoot/swagger/definitions/resource/portal_config.yml

@@ -0,0 +1,18 @@
+type: object
+description: Configuration settings for the portal
+properties:
+  allowed_locales:
+    type: array
+    description: List of allowed locales for the portal
+    items:
+      type: object
+      properties:
+        code:
+          type: string
+          description: The language code
+        articles_count:
+          type: integer
+          description: Number of articles in this locale
+        categories_count:
+          type: integer
+          description: Number of categories in this locale 

research/chatwoot/swagger/definitions/resource/portal_item.yml

@@ -0,0 +1,40 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: The ID of the portal
+  archived:
+    type: boolean
+    description: Whether the portal is archived
+  color:
+    type: string
+    description: The color code for the portal
+  config:
+    $ref: '#/components/schemas/portal_config'
+  custom_domain:
+    type: string
+    description: Custom domain for the portal
+  header_text:
+    type: string
+    description: The header text for the portal
+  homepage_link:
+    type: string
+    description: Homepage link for the portal
+  name:
+    type: string
+    description: Name of the portal
+  slug:
+    type: string
+    description: URL slug for the portal
+  page_title:
+    type: string
+    description: Page title for the portal
+  account_id:
+    type: integer
+    description: ID of the account the portal belongs to
+  inbox:
+    $ref: '#/components/schemas/inbox'
+  logo:
+    $ref: '#/components/schemas/portal_logo'
+  meta:
+    $ref: '#/components/schemas/portal_meta' 

research/chatwoot/swagger/definitions/resource/portal_logo.yml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: ID of the logo file
+  portal_id:
+    type: integer
+    description: ID of the portal this logo belongs to
+  file_type:
+    type: string
+    description: MIME type of the file
+  account_id:
+    type: integer
+    description: ID of the account
+  file_url:
+    type: string
+    description: URL to access the logo file
+  blob_id:
+    type: integer
+    description: ID of the blob
+  filename:
+    type: string
+    description: Name of the file 

research/chatwoot/swagger/definitions/resource/portal_meta.yml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  all_articles_count:
+    type: integer
+    description: Total number of articles
+  archived_articles_count:
+    type: integer
+    nullable: true
+    description: Number of archived articles
+  published_count:
+    type: integer
+    nullable: true
+    description: Number of published articles
+  draft_articles_count:
+    type: integer
+    nullable: true
+    description: Number of draft articles
+  categories_count:
+    type: integer
+    description: Number of categories
+  default_locale:
+    type: string
+    description: Default locale for the portal 

research/chatwoot/swagger/definitions/resource/portal_single.yml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  payload:
+    description: A single portal object (for show/update endpoints)
+    $ref: '#/components/schemas/portal_item' 

research/chatwoot/swagger/definitions/resource/public/contact.yml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Id of the contact
+  source_id:
+    type: string
+    description: The session identifier of the contact
+  name:
+    type: string
+    description: Name of the contact
+  email:
+    type: string
+    description: Email of the contact
+  pubsub_token:
+    type: string
+    description: The token to be used to connect to chatwoot websocket

research/chatwoot/swagger/definitions/resource/public/conversation.yml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Id of the conversation
+  inbox_id:
+    type: string
+    description: The inbox id of the conversation
+  messages:
+    type: array
+    items:
+      $ref: '#/components/schemas/message'
+    description: Messages in the conversation
+  contact:
+    type: object
+    description: The contact information associated to the conversation

research/chatwoot/swagger/definitions/resource/public/inbox.yml

@@ -0,0 +1,50 @@
+type: object
+properties:
+  identifier:
+    type: string
+    description: Inbox identifier
+  name:
+    type: string
+    description: Name of the inbox
+  timezone:
+    type: string
+    description: The timezone defined on the inbox
+  working_hours:
+    type: array
+    description: The working hours defined on the inbox
+    items:
+      type: object
+      properties:
+        day_of_week:
+          type: integer
+          description: Day of the week as a number. Sunday -> 0, Saturday -> 6
+        open_all_day:
+          type: boolean
+          description: Whether or not the business is open the whole day
+        closed_all_day:
+          type: boolean
+          description: Whether or not the business is closed the whole day
+        open_hour:
+          type: integer
+          description: Opening hour. Can be null if closed all day
+        open_minutes:
+          type: integer
+          description: Opening minute. Can be null if closed all day
+        close_hour:
+          type: integer
+          description: Closing hour. Can be null if closed all day
+        close_minutes:
+          type: integer
+          description: Closing minute. Can be null if closed all day
+  working_hours_enabled:
+    type: boolean
+    description: Whether of not the working hours are enabled on the inbox
+  csat_survey_enabled:
+    type: boolean
+    description: Whether of not the Customer Satisfaction survey is enabled on the inbox
+  greeting_enabled:
+    type: boolean
+    description: Whether of not the Greeting Message is enabled on the inbox
+  identity_validation_enabled:
+    type: boolean
+    description: Whether of not the User Identity Validation is enforced on the inbox

research/chatwoot/swagger/definitions/resource/public/message.yml

@@ -0,0 +1,38 @@
+type: object
+properties:
+  id:
+    type: string
+    description: Id of the message
+  content:
+    type: string
+    description: Text content of the message
+  message_type:
+    type: string
+    description: Denotes the message type
+  content_type:
+    type: string
+    description: Content type of the message
+  content_attributes:
+    type: string
+    description: Additional content attributes of the message
+  created_at:
+    type: string
+    description: Created at time stamp of the message
+  conversation_id:
+    type: string
+    description: Conversation Id of the message
+  attachments:
+    type: array
+    items:
+      type: object
+    description: Attachments if any
+  sender:
+    type: object
+    description: Details of the sender
+
+
+
+
+
+
+

research/chatwoot/swagger/definitions/resource/reporting_event.yml

@@ -0,0 +1,47 @@
+type: object
+properties:
+  id:
+    type: number
+    description: ID of the reporting event
+  name:
+    type: string
+    description: Name of the event (e.g., first_response, resolution, reply_time)
+  value:
+    type: number
+    format: double
+    description: Value of the metric in seconds
+  value_in_business_hours:
+    type: number
+    format: double
+    description: Value of the metric in seconds, calculated only for business hours
+  event_start_time:
+    type: string
+    format: date-time
+    description: The timestamp when the event started
+  event_end_time:
+    type: string
+    format: date-time
+    description: The timestamp when the event ended
+  account_id:
+    type: number
+    description: ID of the account
+  conversation_id:
+    type: number
+    nullable: true
+    description: ID of the conversation
+  inbox_id:
+    type: number
+    nullable: true
+    description: ID of the inbox
+  user_id:
+    type: number
+    nullable: true
+    description: ID of the user/agent
+  created_at:
+    type: string
+    format: date-time
+    description: The timestamp when the reporting event was created
+  updated_at:
+    type: string
+    format: date-time
+    description: The timestamp when the reporting event was last updated

research/chatwoot/swagger/definitions/resource/reporting_event_meta.yml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  count:
+    type: integer
+    description: Total number of reporting events
+  current_page:
+    type: integer
+    description: Current page number
+  total_pages:
+    type: integer
+    description: Total number of pages

research/chatwoot/swagger/definitions/resource/reporting_events_list_response.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  meta:
+    $ref: '#/components/schemas/reporting_event_meta'
+    description: Metadata about the reporting events list response
+  payload:
+    type: array
+    items:
+      $ref: '#/components/schemas/reporting_event'
+    description: List of reporting events

research/chatwoot/swagger/definitions/resource/reports/agent_summary.yml

@@ -0,0 +1,39 @@
+type: array
+description: Agent summary report containing conversation statistics grouped by agent.
+items:
+  type: object
+  properties:
+    id:
+      type: number
+      description: The agent (user) ID
+    conversations_count:
+      type: number
+      description: Number of conversations assigned to the agent during the date range
+    resolved_conversations_count:
+      type: number
+      description: Number of conversations resolved by the agent during the date range
+    avg_resolution_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) to resolve conversations. Null if no data available.
+    avg_first_response_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) for the first response. Null if no data available.
+    avg_reply_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) between replies. Null if no data available.
+example:
+  - id: 1
+    conversations_count: 150
+    resolved_conversations_count: 120
+    avg_resolution_time: 3600
+    avg_first_response_time: 300
+    avg_reply_time: 600
+  - id: 2
+    conversations_count: 75
+    resolved_conversations_count: 60
+    avg_resolution_time: 1800
+    avg_first_response_time: 180
+    avg_reply_time: 420

research/chatwoot/swagger/definitions/resource/reports/channel_summary.yml

@@ -0,0 +1,34 @@
+type: object
+description: Channel summary report containing conversation counts grouped by channel type and status. Available in version 4.10.0+.
+additionalProperties:
+  type: object
+  description: Conversation statistics for a specific channel type (e.g., Channel::WebWidget, Channel::Api)
+  properties:
+    open:
+      type: number
+      description: Number of open conversations
+    resolved:
+      type: number
+      description: Number of resolved conversations
+    pending:
+      type: number
+      description: Number of pending conversations
+    snoozed:
+      type: number
+      description: Number of snoozed conversations
+    total:
+      type: number
+      description: Total number of conversations
+example:
+  Channel::WebWidget:
+    open: 10
+    resolved: 20
+    pending: 5
+    snoozed: 2
+    total: 37
+  Channel::Api:
+    open: 5
+    resolved: 15
+    pending: 3
+    snoozed: 1
+    total: 24

research/chatwoot/swagger/definitions/resource/reports/conversation/agent.yml

@@ -0,0 +1,19 @@
+type: object
+properties:
+  id:
+    type: number
+  name:
+    type: string
+  email:
+    type: string
+  thumbnail:
+    type: string
+  availability:
+    type: string
+  metric:
+    type: object
+    properties:
+      open:
+        type: number
+      unattended:
+        type: number

research/chatwoot/swagger/definitions/resource/reports/first_response_time_distribution.yml

@@ -0,0 +1,34 @@
+type: object
+description: First response time distribution report grouped by channel type. Shows the count of conversations with first response times in different time buckets.
+additionalProperties:
+  type: object
+  description: First response time distribution for a specific channel type (e.g., Channel::WebWidget, Channel::Api)
+  properties:
+    0-1h:
+      type: number
+      description: Number of conversations with first response time less than 1 hour
+    1-4h:
+      type: number
+      description: Number of conversations with first response time between 1-4 hours
+    4-8h:
+      type: number
+      description: Number of conversations with first response time between 4-8 hours
+    8-24h:
+      type: number
+      description: Number of conversations with first response time between 8-24 hours
+    24h+:
+      type: number
+      description: Number of conversations with first response time greater than 24 hours
+example:
+  Channel::WebWidget:
+    0-1h: 150
+    1-4h: 80
+    4-8h: 45
+    8-24h: 30
+    24h+: 15
+  Channel::Api:
+    0-1h: 75
+    1-4h: 40
+    4-8h: 20
+    8-24h: 10
+    24h+: 5

research/chatwoot/swagger/definitions/resource/reports/inbox_label_matrix.yml

@@ -0,0 +1,50 @@
+type: object
+description: Inbox-label matrix report showing the count of conversations for each inbox-label combination.
+properties:
+  inboxes:
+    type: array
+    description: List of inboxes included in the report
+    items:
+      type: object
+      properties:
+        id:
+          type: number
+          description: The inbox ID
+        name:
+          type: string
+          description: The inbox name
+  labels:
+    type: array
+    description: List of labels included in the report
+    items:
+      type: object
+      properties:
+        id:
+          type: number
+          description: The label ID
+        title:
+          type: string
+          description: The label title
+  matrix:
+    type: array
+    description: 2D array where matrix[i][j] represents the count of conversations in inboxes[i] with labels[j]
+    items:
+      type: array
+      items:
+        type: number
+example:
+  inboxes:
+    - id: 1
+      name: Website Chat
+    - id: 2
+      name: Email Support
+  labels:
+    - id: 1
+      title: bug
+    - id: 2
+      title: feature-request
+    - id: 3
+      title: urgent
+  matrix:
+    - [10, 5, 3]
+    - [8, 12, 2]

research/chatwoot/swagger/definitions/resource/reports/inbox_summary.yml

@@ -0,0 +1,39 @@
+type: array
+description: Inbox summary report containing conversation statistics grouped by inbox.
+items:
+  type: object
+  properties:
+    id:
+      type: number
+      description: The inbox ID
+    conversations_count:
+      type: number
+      description: Number of conversations created in the inbox during the date range
+    resolved_conversations_count:
+      type: number
+      description: Number of conversations resolved in the inbox during the date range
+    avg_resolution_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) to resolve conversations. Null if no data available.
+    avg_first_response_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) for the first response. Null if no data available.
+    avg_reply_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) between replies. Null if no data available.
+example:
+  - id: 1
+    conversations_count: 150
+    resolved_conversations_count: 120
+    avg_resolution_time: 3600
+    avg_first_response_time: 300
+    avg_reply_time: 600
+  - id: 2
+    conversations_count: 75
+    resolved_conversations_count: 60
+    avg_resolution_time: 1800
+    avg_first_response_time: 180
+    avg_reply_time: 420

research/chatwoot/swagger/definitions/resource/reports/outgoing_messages_count.yml

@@ -0,0 +1,21 @@
+type: array
+description: Outgoing messages count report grouped by entity (agent, team, inbox, or label).
+items:
+  type: object
+  properties:
+    id:
+      type: number
+      description: The ID of the grouped entity (agent, team, inbox, or label).
+    name:
+      type: string
+      description: The name of the grouped entity.
+    outgoing_messages_count:
+      type: number
+      description: The total number of outgoing messages for this entity in the given time range.
+example:
+  - id: 1
+    name: Agent One
+    outgoing_messages_count: 42
+  - id: 2
+    name: Agent Two
+    outgoing_messages_count: 18

research/chatwoot/swagger/definitions/resource/reports/summary.yml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  avg_first_response_time:
+    type: string
+  avg_resolution_time:
+    type: string
+  conversations_count:
+    type: number
+  incoming_messages_count:
+    type: number
+  outgoing_messages_count:
+    type: number
+  resolutions_count:
+    type: number
+  previous:
+    type: object
+    properties:
+      avg_first_response_time:
+        type: string
+      avg_resolution_time:
+        type: string
+      conversations_count:
+        type: number
+      incoming_messages_count:
+        type: number
+      outgoing_messages_count:
+        type: number
+      resolutions_count:
+        type: number

research/chatwoot/swagger/definitions/resource/reports/team_summary.yml

@@ -0,0 +1,39 @@
+type: array
+description: Team summary report containing conversation statistics grouped by team.
+items:
+  type: object
+  properties:
+    id:
+      type: number
+      description: The team ID
+    conversations_count:
+      type: number
+      description: Number of conversations assigned to the team during the date range
+    resolved_conversations_count:
+      type: number
+      description: Number of conversations resolved by the team during the date range
+    avg_resolution_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) to resolve conversations. Null if no data available.
+    avg_first_response_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) for the first response. Null if no data available.
+    avg_reply_time:
+      type: number
+      nullable: true
+      description: Average time (in seconds) between replies. Null if no data available.
+example:
+  - id: 1
+    conversations_count: 250
+    resolved_conversations_count: 200
+    avg_resolution_time: 2800
+    avg_first_response_time: 240
+    avg_reply_time: 500
+  - id: 2
+    conversations_count: 180
+    resolved_conversations_count: 150
+    avg_resolution_time: 2400
+    avg_first_response_time: 200
+    avg_reply_time: 450

research/chatwoot/swagger/definitions/resource/team.yml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the team
+  name:
+    type: string
+    description: The name of the team
+  description:
+    type: string
+    description: The description about the team
+  allow_auto_assign:
+    type: boolean
+    description: If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team
+  account_id:
+    type: number
+    description: The ID of the account with the team is a part of
+  is_member:
+    type: boolean
+    description: This field shows whether the current user is a part of the team

research/chatwoot/swagger/definitions/resource/user.yml

@@ -0,0 +1,78 @@
+type: object
+properties:
+  id:
+    type: number
+  access_token:
+    type: string
+  account_id:
+    type: number
+  available_name:
+    type: string
+  avatar_url:
+    type: string
+  confirmed:
+    type: boolean
+  display_name:
+    type: string
+    nullable: true
+  message_signature:
+    type: string
+    nullable: true
+  email:
+    type: string
+  hmac_identifier:
+    type: string
+  inviter_id:
+    type: number
+  name:
+    type: string
+  provider:
+    type: string
+  pubsub_token:
+    type: string
+  role:
+    type: string
+    enum: ['agent', 'administrator']
+  ui_settings:
+    type: object
+  uid:
+    type: string
+  type:
+    type: string
+    nullable: true
+  custom_attributes:
+    type: object
+    description: Available for users who are created through platform APIs and has custom attributes associated.
+  accounts:
+    type: array
+    items:
+      type: object
+      properties:
+        id:
+          type: number
+        name:
+          type: string
+        status:
+          type: string
+        active_at:
+          type: string
+          format: date-time
+        role:
+          type: string
+          enum: ['administrator', 'agent']
+        permissions:
+          type: array
+          items:
+            type: string
+        availability:
+          type: string
+        availability_status:
+          type: string
+        auto_offline:
+          type: boolean
+        custom_role_id:
+          type: number
+          nullable: true
+        custom_role:
+          type: object
+          nullable: true

research/chatwoot/swagger/definitions/resource/webhook.yml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the webhook
+  url:
+    type: string
+    description: The url to which the events will be send
+  name:
+    type: string
+    description: The name of the webhook
+  subscriptions:
+    type: array
+    items:
+      type: string
+      enum: [
+        "conversation_created",
+        "conversation_status_changed",
+        "conversation_updated",
+        "contact_created",
+        "contact_updated",
+        "message_created",
+        "message_updated",
+        "webwidget_triggered"
+      ]
+    description: The list of subscribed events
+  account_id:
+    type: number
+    description: The id of the account which the webhook object belongs to