Zum Hauptinhalt springen

API changes for v2 API, July 11 to July 18

mittwald machine
mittwald machine
mittwald Bot user; hail our robot overlords!

This week, the mittwald API introduces several enhancements, including the addition of the 'productManagement' enum value across multiple response properties, new endpoints for detecting phishing emails and listing incoming invoices, and updates to request and response properties to improve functionality and flexibility.

Summary​

  • The new 'productManagement' enum value has been added to multiple response properties for the status '200' in the following operations:

    • /items/createdBy/department and /items/lastMessage/createdBy/department in the GET /v2/conversations operation.
    • /items/lastMessageBy/department and /items/mainUser/department in the GET /v2/conversations operation.
    • createdBy/department, lastMessage/createdBy/department, lastMessageBy/department, and mainUser/department in the GET /v2/conversations/{conversationId} operation.
    • /items/allOf[#/components/schemas/de.mittwald.v1.conversation.User]/department in the GET /v2/conversations/{conversationId}/members operation.
    • /items/oneOf[#/components/schemas/de.mittwald.v1.conversation.Message]/createdBy/department and /items/oneOf[#/components/schemas/de.mittwald.v1.conversation.StatusUpdate]/meta/user/department in the GET /v2/conversations/{conversationId}/messages operation.

  • The optional property 'reason' has been added to the response with the '200' status in the POST /v2/actions/validate-container-registry-uri operation.

  • New endpoints have been added:

    • POST /v2/actions/detect-phishing-email to check if an email is from Mittwald.
    • GET /v2/contributors/{contributorId}/invoices/incoming to list incoming invoices of a contributor.
    • GET /v2/contributors/{contributorId}/invoices/incoming/{contributorReceiptId}/file-access-token to request an access token for the incoming invoice file.

  • The 'subschema #7' has been added to the 'oneOf' list for the following properties:

    • /items/relatedTo in the GET /v2/conversations operation.
    • relatedTo in the GET /v2/conversations/{conversationId} operation.
    • relatedTo in the POST /v2/conversations operation.
    • relatedTo in the PUT /v2/conversations/{conversationId} operation.

  • A new optional request parameter 'search' has been added to the GET /v2/customers/{customerId}/invoices operation.

  • A non-success response with the status '403' has been added to the GET /v2/domains/{domainId} operation.

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

Detailed changes​

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

  • added the new 'productManagement' enum value to the '/items/createdBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the '/items/lastMessage/createdBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the '/items/lastMessageBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the '/items/mainUser/department' response property for the response status '200'

  • added 'subschema #7' to the '/items/relatedTo' response property 'oneOf' list for the response status '200'

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

Changes in "Get a support conversation"​

  • added the new 'productManagement' enum value to the 'createdBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the 'lastMessage/createdBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the 'lastMessageBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the 'mainUser/department' response property for the response status '200'

  • added 'subschema #7' to the 'relatedTo' response property 'oneOf' list for the response status '200'

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

Changes in "Get members of a support conversation"​

  • added the new 'productManagement' enum value to the '/items/allOf[#/components/schemas/de.mittwald.v1.conversation.User]/department' response property for the response status '200'

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

Changes in "Get all message of the conversation"​

  • added the new 'productManagement' enum value to the '/items/oneOf[#/components/schemas/de.mittwald.v1.conversation.Message]/createdBy/department' response property for the response status '200'

  • added the new 'productManagement' enum value to the '/items/oneOf[#/components/schemas/de.mittwald.v1.conversation.StatusUpdate]/meta/user/department' response property for the response status '200'

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

Changes in "Check if an email is from mittwald"​

  • endpoint added

For details, refer to the POST/v2/actions/detect-phishing-email/ endpoint.

Changes in "Validate a Registries' URI"​

  • added the optional property 'reason' to the response with the '200' status

For details, refer to the POST/v2/actions/validate-container-registry-uri/ endpoint.

Changes in "List incoming Invoices of a contributor"​

  • endpoint added

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

Changes in "Request an Access Token for the Incoming Invoice file"​

  • endpoint added

For details, refer to the GET/v2/contributors/{contributorId}/invoices/incoming/{contributorReceiptId}/file-access-token/ endpoint.

Changes in "Create a conversation"​

  • added 'subschema #7' to the 'relatedTo' request property 'oneOf' list

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

Changes in "Update the basic properties of the conversation"​

  • added 'subschema #7' to the 'relatedTo' request property 'oneOf' list

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

Changes in "List Invoices of a Customer"​

  • added the new optional 'query' request parameter 'search'

For details, refer to the GET/v2/customers/{customerId}/invoices/ endpoint.

Changes in "Get a Domain"​

  • added the non-success response with the status '403'

For details, refer to the GET/v2/domains/{domainId}/ endpoint.

Client package releases​

mittwald JavaScript SDK Release 4.186.0​

The mittwald JavaScript SDK has been updated to version 4.186.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.186.0.

mittwald JavaScript SDK Release 4.185.0​

The mittwald JavaScript SDK has been updated to version 4.185.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 here.

mittwald JavaScript SDK Release 4.184.0​

The mittwald JavaScript SDK has been updated to version 4.184.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 here.

mittwald JavaScript SDK Release 4.183.0​

The mittwald JavaScript SDK version 4.183.0 has been released. This update includes the following feature:

  • Updated the generated client to enhance functionality and performance (commit c11f485).

For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.182.0​

The mittwald JavaScript SDK has been updated to version 4.182.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, visit the release page.