Breaking (!) API changes for v2 API, January 9, 2025

On January 9, 2025, the mittwald API introduced several changes, including the removal of the project_email_admin enum value from various properties, the addition of the project_emailadmin enum value, the removal of a schema, and the introduction of a new endpoint for listing extensions of a contributor.

Breaking changes

This document contains changes that can under certain circumstances be considered breaking. Please review the changes carefully.

While we generally strive to avoid breaking changes in accordance with our API stability guarantees, we occasionally might perform changes that would be considered breaking in the strictest sense of the term, but we do not consider as breaking in a practical sense. We will always provide ample notice and documentation for such changes.

Summary

• The enum value project_email_admin has been removed from the request property notificationRoles/items/ in the POST operation for creating a conversation. This is a breaking change.
• A new enum value project_emailadmin has been added to the response property notificationRoles/items/ for the GET operation to list all conversations and for the GET operation to get a specific conversation.
• The enum value project_email_admin has been removed from the response property notificationRoles/items/ for the GET operations to list all conversations and to get a specific conversation.
• A new enum value project_emailadmin has been added to the request property notificationRoles/items/ in the POST operation for creating a conversation.
• The schema de.mittwald.v1.conversation.DepartmentWithStatus has been removed from the API schema.
• A new endpoint has been added to list extensions of a contributor with the GET operation at the path /v2/contributors/{contributorId}/extensions.
• The response property oneOf list for the response status 200 has been updated to include #/components/schemas/de.mittwald.v1.conversation.ServiceRequest in the GET operation to list messages by conversation.

Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.

Detailed changes

Changes in "Create a conversation"

• ⚠️ Breaking: removed the enum value project_email_admin of the request property notificationRoles/items/

• added the new project_emailadmin enum value to the request property notificationRoles/items/

For details, refer to the POST/v2/conversations/ endpoint.

Changes in "Get all conversation the authenticated user has created or has access to"

• added the new project_emailadmin enum value to the /items/notificationRoles/items/ response property for the response status 200

• removed the project_email_admin enum value from the /items/notificationRoles/items/ response property for the response status 200

For details, refer to the GET/v2/conversations/ endpoint.

Changes in "Get a support conversation"

• added the new project_emailadmin enum value to the notificationRoles/items/ response property for the response status 200

• removed the project_email_admin enum value from the notificationRoles/items/ response property for the response status 200

For details, refer to the GET/v2/conversations/{conversationId}/ endpoint.

Changes in "List Extensions of own contributor"

• endpoint added

For details, refer to the GET/v2/contributors/{contributorId}/extensions/ endpoint.

Changes in "Get all message of the conversation"

• added #/components/schemas/de.mittwald.v1.conversation.ServiceRequest to the /items/ response property oneOf list for the response status 200

For details, refer to the GET/v2/conversations/{conversationId}/messages/ endpoint.

Client package releases

mittwald PHP SDK Release v2.1.90

The mittwald PHP SDK has been updated to version v2.1.90. This release introduces several new features and improvements:

Added Features

• New API Request and Response Handling for Listing Own Extensions:

  • Implemented a client for fetching a contributor's extensions, including:
    • ExtensionListOwnExtensionsRequest: A request object for listing extensions with pagination and limit parameters.
    • ExtensionListOwnExtensionsOKResponse: A successful response containing an array of OwnExtension objects.
    • ExtensionListOwnExtensionsDefaultResponse: A response object for handling general errors.
    • ExtensionListOwnExtensionsTooManyRequestsResponse: A response for rate-limiting errors.
    • ExtensionListOwnExtensionsTooManyRequestsResponseBody: The body structure for the too-many-requests response.

• Schema Definitions:

  • Added OwnExtension schema detailing the properties and structure of an extension.
  • Defined OwnExtensionState enumeration to manage extension states.

Client Changes

• Updated the MarketplaceClient interface and its implementation to include a method for listing the contributor's extensions:
  • Added extensionListOwnExtensions method in MarketplaceClient.
  • Implemented in MarketplaceClientImpl, with error handling for various response scenarios.

These enhancements improve the API client's functionality, enabling users to efficiently manage and retrieve details about their specific extensions.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.90.0

The mittwald JavaScript SDK has been updated to version 4.90.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.90.0.