f9d1146cb0
* feat: Adds model for scheduling messages * feat: Implement scheduled message handling and processing jobs * feat: Add ScheduledMessagesController and associated specs for managing scheduled messages * refactor: Simplify scheduled message job specs and improve metadata handling * feat: Add ScheduledMessagePolicy for managing access to scheduled messages * feat: Add routes for managing scheduled messages * feat: Add scheduled message event handling and broadcasting * feat: Add JSON views for scheduled messages creation, destruction, updating, and indexing * feat: Update scheduled message status and dispatch update event after message creation * feat: Ensure scheduled message updates trigger dispatch event * feat: Add mutation types for managing scheduled messages * feat: Add additionalAttributes prop to Message component and provider * feat: Implement scheduled message handling in ActionCable and Vuex store * feat: Add unit tests for scheduled messages actions and mutations * feat: implement scheduled messages functionality - Added support for scheduling messages in the conversation dashboard. - Introduced new components: ScheduledMessageModal and ScheduledMessages for managing scheduled messages. - Enhanced ReplyBottomPanel to include scheduling options. - Updated Base.vue to handle scheduled message styling. - Integrated Vuex store module for managing scheduled messages state. - Added necessary translations for scheduled messages in English and Portuguese. * feat: add pagination to scheduled messages index and update tests accordingly * chore: update scheduled messages specs for future time validation and response status * chore: enhance scheduled messages API with pagination and add skeleton loader component * feat: add create_scheduled_message action to automation rule attributes * feat: implement create_scheduled_message action and enhance attachment handling * feat: add scheduled message functionality with UI components and localization * test: enhance scheduledMessages mutations tests with meta handling and structure * chore: update label to display file name upon successful upload in AutomationFileInput component * feat: add initialAttachment prop to ScheduledMessageModal and update ReplyBox to pass attachment * chore: prepend_mod_with to ScheduledMessagesController for better module handling * fix: attachment visibility in ScheduledMessageItem component * chore: enhance ScheduledMessage model with validations and reduce controller load * refactor: simplify ScheduledMessagesAPI methods by removing unnecessary instance variable * chore: update event emission for scheduled message creation in ReplyBox and ScheduledMessageModal * refactor: update status configuration to use label keys * chore: update date formatting in ScheduledMessageItem component * refactor: collapse logic to checkOverflow and update related functionality * chore: add author indication for current user in scheduled messages * chore: enhance scheduled message metadata with author information and localization * fix: send message shortcut * chore: handle errors in scheduled message submission * chore: update scheduled message modal to use combined date and time input * chore: refactor scheduled messages handling to remove pagination and update related tests * fix: ensure scheduled messages update status and dispatch on failure * fix: update scheduled message due date logic and simplify sending checks * refactor: rename build_message method for send_message * fix: update scheduled message creation time and improve test reliability * chore: ignore unnecessary check * chore: add scheduled message metadata handling in message builder, add scheduled message factorie and update specs * refactor: use scheduled message factorie creation in specs * chore: streamline error handling in scheduled message job and remove dispatch logic * fix: change scheduled_messages association to destroy dependent records * refactor: remove unused attributes from scheduled message payload builder * chore: update scheduled message retrieval to use conversation association * chore: correct cron format for scheduled messages job * chore: remove migration for author_type in scheduled_messages * feat: enhance scheduled messages management with delete confirmation and error handling * chore: set cron poll interval to 10 seconds for improved scheduling precision * feat: include additional_attributes in message JSON response * feat: enhance scheduled message validation and localization support * chore: update scheduled message display * Merge branch 'main' into Cayo-Oliveira/CU-86aenh268/Mensagens-agendadas * feat: add scheduled message indicators and validation for message length * fix: remove unnecessary condition from line-clamp class binding * feat: update scheduled messages localization and enhance content validation * feat: update scheduled messages order, enhance scheduledAt computation, and add message association * fix: reorder condition for Facebook channel message length computation * fix: change detection for attachments in scheduled messages * fix: remove unnecessary colon from close-on-backdrop-click prop in ScheduledMessageModal * chore: add error handling for scheduled message deletion and update localization for delete failure * fix: enforce minimum delay of 1 minute for scheduled messages and update validation * fix: remove unused private property and improve locale formatting for scheduled messages * fix: adjust positioning of DropdownBody in ReplyBottomPanel and clean up schema foreign keys * docs: add scheduled messages management APIs and payload definitions --------- Co-authored-by: gabrieljablonski <contact@gabrieljablonski.com>
133 lines
3.9 KiB
YAML
133 lines
3.9 KiB
YAML
openapi: '3.0.4'
|
|
info:
|
|
title: Chatwoot
|
|
description: This is the API documentation for Chatwoot server.
|
|
version: 1.1.0
|
|
termsOfService: https://www.chatwoot.com/terms-of-service/
|
|
contact:
|
|
email: hello@chatwoot.com
|
|
license:
|
|
name: MIT License
|
|
url: https://opensource.org/licenses/MIT
|
|
servers:
|
|
- url: https://app.chatwoot.com/
|
|
paths:
|
|
$ref: ./paths/index.yml
|
|
components:
|
|
schemas:
|
|
$ref: ./definitions/index.yml
|
|
parameters:
|
|
$ref: ./parameters/index.yml
|
|
securitySchemes:
|
|
userApiKey:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
|
|
agentBotApiKey:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
|
|
platformAppApiKey:
|
|
type: apiKey
|
|
in: header
|
|
name: api_access_token
|
|
description: This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
|
|
tags:
|
|
- name: Accounts
|
|
description: Account management APIs
|
|
- name: Account Users
|
|
description: Account user management APIs
|
|
- name: AgentBots
|
|
description: Bot integrations
|
|
- name: Users
|
|
description: User management APIs
|
|
- name: Account AgentBots
|
|
description: Account-specific Agent Bots
|
|
- name: Agents
|
|
description: Agent management APIs
|
|
- name: Canned Responses
|
|
description: Pre-defined responses for common queries
|
|
- name: Contacts
|
|
description: Contact management APIs
|
|
- name: Contact Labels
|
|
description: Manage contact labels
|
|
- name: Conversation Assignments
|
|
description: Manage conversation assignments
|
|
- name: Conversation Labels
|
|
description: Manage conversation labels
|
|
- name: Conversations
|
|
description: Conversation management APIs
|
|
- name: Custom Attributes
|
|
description: Custom fields for contacts and conversations
|
|
- name: Custom Filters
|
|
description: Saved filters for conversations
|
|
- name: Inboxes
|
|
description: Communication channels setup
|
|
- name: Integrations
|
|
description: Third-party integrations
|
|
- name: Messages
|
|
description: Message management APIs
|
|
- name: Scheduled Messages
|
|
description: Scheduled message management APIs
|
|
- name: Profile
|
|
description: User profile APIs
|
|
- name: Reports
|
|
description: Analytics and reporting APIs
|
|
- name: Teams
|
|
description: Team management APIs
|
|
- name: Webhooks
|
|
description: Event notification webhooks
|
|
- name: Automation Rule
|
|
description: Workflow automation rules
|
|
- name: Help Center
|
|
description: Knowledge base management
|
|
- name: Contacts API
|
|
description: Public contact APIs
|
|
- name: Conversations API
|
|
description: Public conversation APIs
|
|
- name: Messages API
|
|
description: Public message APIs
|
|
- name: CSAT Survey Page
|
|
description: Customer satisfaction survey
|
|
x-tagGroups:
|
|
- name: Platform
|
|
tags:
|
|
- Accounts
|
|
- Account Users
|
|
- AgentBots
|
|
- Users
|
|
- name: Application
|
|
tags:
|
|
- Account AgentBots
|
|
- Account
|
|
- Agents
|
|
- Audit Logs
|
|
- Canned Responses
|
|
- Contacts
|
|
- Contact Labels
|
|
- Conversation Assignments
|
|
- Conversation Labels
|
|
- Conversations
|
|
- Custom Attributes
|
|
- Custom Filters
|
|
- Inboxes
|
|
- Integrations
|
|
- Messages
|
|
- Scheduled Messages
|
|
- Profile
|
|
- Reports
|
|
- Teams
|
|
- Webhooks
|
|
- Automation Rule
|
|
- Help Center
|
|
- name: Client
|
|
tags:
|
|
- Contacts API
|
|
- Conversations API
|
|
- Messages API
|
|
- name: Others
|
|
tags:
|
|
- CSAT Survey Page
|