Bevatel

Partial diff: added / removed operations, renames, and spec-info fields. Nested schema changes are not tracked yet.

1d9d76ffeat: add example for GeneralContactTagIdsRequest schema in apis.json
  • Description changedlistDeveloperTeams"Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. Provide the service UUID via either the service_id query parameter or the x-service-id header (exactly one of the two is required). Empty results return 200 with data: [] and meta.total: 0." → "Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. The service_id query parameter is required. Empty results return 200 with data: [] and meta.total: 0."
3a966d5fix: playground bug with some apis and sidebar order issues
  • Description changedlistDeveloperTeams"Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. The service_id query parameter is required. Empty results return 200 with data: [] and meta.total: 0." → "Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. Provide the service UUID via either the service_id query parameter or the x-service-id header (exactly one of the two is required). Empty results return 200 with data: [] and meta.total: 0."
2886434fix: update List Teams endpoint documentation to require service_id and remove x-service-id alternative
  • Description changedlistDeveloperTeams"Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. Provide the service UUID via either the service_id query parameter or the x-service-id header (exactly one of the two is required). Empty results return 200 with data: [] and meta.total: 0." → "Returns teams in the workspace that have at least one agent for the given service, ordered by created_at descending. The service_id query parameter is required. Empty results return 200 with data: [] and meta.total: 0."
9835f41feat:resolve conflict
  • AddedaddDeveloperContactTags
  • AddedremoveDeveloperContactTags
  • AddedlistDeveloperCustomAttributes
  • AddedcreateDeveloperCustomAttribute
  • AddedupdateDeveloperCustomAttribute
  • AddeddeleteDeveloperCustomAttribute
  • AddedlistDeveloperTags
6693df5feat:Enhance API documentation: Updated the description for the General tag to... Merge branch 'user_endpoints' into 'stage' See merge request bevatel-system/developer-docs!86
  • Description changedsendWhatsAppTemplateMessage"Sends an outbound WhatsApp template message to a contact. Documented as application/json because the developer docs renderer does not support file upload yet. Optional media should be referenced via whatsAppContent.header_params (for example a canned file id), not as a multipart file." → "Sends an outbound WhatsApp template message to a contact. For media headers, provide exactly one source: fileUrl (public direct media URL), multipart file (not shown in this JSON playground), or whatsAppContent.headerparams.cannedFileId. When using media, set headerparams.attachmentType to image, video, or document. fileUrl must be a direct file link, not an HTML gallery page."
  • AddedlistCannedFiles
  • AddedsendSessionMessage
  • AddedlistWhatsAppTemplates
  • AddedlistDeveloperTeams
  • AddedlistDeveloperUsers
  • AddedgetDeveloperUser
68615c2feat: enhance conversation API documentation with detailed error response and parameter validation
  • Description changedgetPreviousConversation"Returns all non-deleted conversations for a contact in the current workspace, including open and closed." → "Returns all non-deleted conversations for a contact in the current workspace, including open and closed. "
a976c05feat:update conversation API description and parameter details to remove redundant mongo id warnings
  • Description changedgetPreviousConversation"Returns all non-deleted conversations for a contact in the current workspace, including open and closed. The query parameter id is the contact's contactServiceId, not a conversation id." → "Returns all non-deleted conversations for a contact in the current workspace, including open and closed."
cf47011feat: update conversation retrieval endpoint summary and description for clarity
  • Summary changedgetPreviousConversation"Get Previous Conversation" → "List Conversations by Contact"
  • Description changedgetPreviousConversation"Retrieves previous conversation details for a specific contact." → "Returns all non-deleted conversations for a contact in the current workspace, including open and closed. The query parameter id is the contact's contactServiceId, not a conversation id."
5d939e8feat: standardize API error responses, update WhatsApp template request schema, and refine documentation models
  • Description changedsendWhatsAppTemplateMessage"Sends an outbound WhatsApp template message to a contact." → "Sends an outbound WhatsApp template message to a contact. Documented as application/json because the developer docs renderer does not support file upload yet. Optional media should be referenced via whatsAppContent.header_params (for example a canned file id), not as a multipart file."
076c56efeat: add API documentation for Business Chat conversations, messaging, and channels endpoints
  • Summary changedlistDeveloperContacts"List contacts (paginated)" → "List Contacts"
  • Description changedlistDeveloperContacts"Returns non-blocked contacts, ordered by created_at descending. Blocked contacts are excluded from this list but can still be retrieved by identifier. Empty results return 200 with data: [] and meta.total: 0." → "Returns both blocked and non-blocked contacts, ordered by created_at descending. Empty results return 200 with data: [] and meta.total: 0."
  • Description changedcreateDeveloperContact"Creates a contact. fullname and phonenumber are required. Optional fields include email, source, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, source defaults to api, type defaults to external, and isblocked defaults to false." → "Creates a contact. fullname and phonenumber are required. Optional fields include email, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, type defaults to external and isblocked defaults to false."
  • Summary changedgetDeveloperContact"Get a contact by identifier" → "Get a contact"
  • AddedlistBusinessChatChannels
  • AddedassignTeamToConversation
  • AddedassignUserToConversation
  • AddedunassignTeamFromConversation
  • AddedunassignUserFromConversation
  • AddedcloseConversation
  • AddedgetPreviousConversation
  • AddedopenConversation
  • AddedlistMessagesByConversation
  • AddedsendWhatsAppTemplateMessage
df2d7a5fix: boolean and empty objects (includes arrays) in request body
  • Summary changedlistDeveloperContacts"List Contacts" → "List contacts (paginated)"
  • Description changedlistDeveloperContacts"Returns both blocked and non-blocked contacts, ordered by created_at descending. Empty results return 200 with data: [] and meta.total: 0." → "Returns non-blocked contacts, ordered by created_at descending. Blocked contacts are excluded from this list but can still be retrieved by identifier. Empty results return 200 with data: [] and meta.total: 0."
  • Description changedcreateDeveloperContact"Creates a contact. fullname and phonenumber are required. Optional fields include email, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, type defaults to external and isblocked defaults to false." → "Creates a contact. fullname and phonenumber are required. Optional fields include email, source, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, source defaults to api, type defaults to external, and isblocked defaults to false."
  • Summary changedgetDeveloperContact"Get a contact" → "Get a contact by identifier"
85e9dc5docs(api): align response contracts and contact behavior
  • Summary changedlistDeveloperContacts"List contacts (paginated)" → "List Contacts"
  • Description changedlistDeveloperContacts"Returns non-blocked contacts, ordered by created_at descending. Blocked contacts are excluded from this list but can still be retrieved by identifier. Empty results return 200 with data: [] and meta.total: 0." → "Returns both blocked and non-blocked contacts, ordered by created_at descending. Empty results return 200 with data: [] and meta.total: 0."
  • Description changedcreateDeveloperContact"Creates a contact. fullname and phonenumber are required. Optional fields include email, source, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, source defaults to api, type defaults to external, and isblocked defaults to false." → "Creates a contact. fullname and phonenumber are required. Optional fields include email, type, companyname, countryname, cityname, bio, additionalattributes, and isblocked. When omitted, type defaults to external and isblocked defaults to false."
  • Summary changedgetDeveloperContact"Get a contact by identifier" → "Get a contact"