v2.1.131

Breaking Changes

• The ExtensionGetContributorOKResponse class has been removed entirely. Consequently, the return type in the extensionGetContributor methods within both the MarketplaceClient and MarketplaceClientImpl classes has been changed from ExtensionGetContributorOKResponse to UntypedResponse.

New Features

• Introduced a new class OwnContributor, representing contributors in the marketplace. This class includes:
  • Properties for contact person, contract owner, customer details, description, id, name, state, support information, and logo reference.
  • Methods for creating instances from input and converting them back to JSON.
  • Validation logic for various fields based on defined schemas.

Removed Files

• ExtensionGetContributorOKResponse.php has been removed, which potentially simplifies response handling related to contributor details.

v2.1.130

Added

New Feature: Pricing Strategy for Extensions

• Introduced a MonthlyPricingStrategy schema to facilitate the definition of monthly pricing for extensions, including net price in Euro cents.
• The Extension and OwnExtension classes were updated to accommodate optional pricing attributes.

New Feature: Profile and Profile Request Management

• Added a Profile class for managing user profiles with attributes such as approvedOn, customerId, and domain.
• Introduced ProfileRequest, which includes user-requested profiles, status tracking, and metadata like createdOn and requestedBy.
• The ProfileRequestStatus enumeration was created to define possible states of a profile request.

New Response Handling

• A new response class ExtensionDeleteExtensionInstancePreconditionFailedResponse was created to manage precondition failures when deleting extension instances.

Changed

• The ListProjectBackupsRequest class now has a default limit of 1000 for the number of backups returned.
• Various methods in ListProjectBackupsRequest and marketplace client classes were updated to improve data handling, reflecting the new pricing strategies and error management responses.

v2.1.129

Features

• Container API: Introduced a new ContainerClient for managing containers, stacks, and volumes. This client allows users to create, update, list, and delete container registries, stacks, and volumes. The new functionalities include:
  • Create Registry: Ability to create a new container registry.
  • Declare Stack: Ability to declare a stack with services and volumes.
  • Delete Registry: Ability to delete a container registry.
  • Delete Volume: Ability to delete a volume associated with a container stack.
  • Retrieve Configuration: Ability to get configuration details for a specified container image.

Added

New Client Interfaces

• ContainerClient
• ContainerClientImpl

New Responses and Requests

• Create Registry:

  • CreateRegistryRequest
  • CreateRegistryCreatedResponse
  • Responses for various error conditions (4xx, 500 errors).

• Declare Stack:

  • DeclareStackRequest
  • DeclareStackOKResponse
  • Responses for various error conditions.

• Delete Registry:

  • DeleteRegistryRequest
  • Responses for various error conditions.

• Delete Volume:

  • DeleteVolumeRequest
  • Responses for various error conditions.

New Error Handling Responses

• Introduced various response classes for handling errors, including bad requests, conflicts, forbidden accesses, not found, internal server errors, and too many requests.

New Request and Response Objects for API Operations

• Detailed request and response implementations including validation for input data.

These enhancements provide a more comprehensive interface for users to interact with the container management capabilities of the API.

v2.1.128

Changes

API Response Update

• Updated the return annotation for dnsDeleteDnsZone method to reflect the accurate HTTP status response:
  • From OK to No Content as the method now returns a 204 No Content status instead of a 200 OK status.

New Feature: Customer Order Placement Status

• Added a new property isAllowedToPlaceOrders to the Customer schema.
  • This boolean flag indicates whether a customer is permitted to place orders.

Attributes

• isAllowedToPlaceOrders:
  • Type: boolean
  • Getter: getIsAllowedToPlaceOrders()
  • Setter: withIsAllowedToPlaceOrders(bool $isAllowedToPlaceOrders)
  • Method to unset: withoutIsAllowedToPlaceOrders()

These changes improve API response clarity and enhance the customer model to manage order placement permissions.

v2.1.127

Features Added

• Enhanced request handling for listing app installations with support for filtering by multiple app IDs and searching using a search term.

Changes

ListAppinstallationsRequest

• Added appIds parameter to allow filtering installations by specific application IDs.
• Introduced searchTerm parameter for searching installations based on a keyword.
• Updates to the data validation and handling methods to accommodate new parameters.

ListAppinstallationsForUserRequest

• Introduced appIds parameter to filter user-specific installations.
• Added searchTerm for enhanced searching capabilities in user context.

MarketplaceClient Interface Changes

• Updated method documentation for extensionAuthenticateInstance to specify authentication using a session token and an extension secret.

v2.1.126

Removed

Deleted Classes

• AbortAgencyVerificationBadRequestResponse
• AbortAgencyVerificationDefaultResponse
• AbortAgencyVerificationForbiddenResponse
• AbortAgencyVerificationNotFoundResponse
• AbortAgencyVerificationOKResponse
• AbortAgencyVerificationOKResponseBody
• AbortAgencyVerificationRequest
• AbortAgencyVerificationTooManyRequestsResponse
• AbortAgencyVerificationTooManyRequestsResponseBody
• CreateAgencyVerificationBadRequestResponse
• CreateAgencyVerificationCreatedResponse
• CreateAgencyVerificationCreatedResponseBody
• CreateAgencyVerificationDefaultResponse
• CreateAgencyVerificationForbiddenResponse
• CreateAgencyVerificationNotFoundResponse
• CreateAgencyVerificationRequest
• CreateAgencyVerificationTooManyRequestsResponse
• CreateAgencyVerificationTooManyRequestsResponseBody
• GetOpenAgencyVerificationBadRequestResponse
• GetOpenAgencyVerificationDefaultResponse
• GetOpenAgencyVerificationForbiddenResponse
• GetOpenAgencyVerificationNotFoundResponse
• GetOpenAgencyVerificationOKResponse
• GetOpenAgencyVerificationRequest
• GetOpenAgencyVerificationTooManyRequestsResponse
• GetOpenAgencyVerificationTooManyRequestsResponseBody
• VerificationRequest

Changes in Interfaces

• Removed methods from CustomerClient
  • abortAgencyVerification
  • createAgencyVerification
  • getOpenAgencyVerification

Changes in Implementations

• Removed implementations related to agency verification process from CustomerClientImpl.

These deletions and modifications indicate a significant refactoring or change in approach concerning the customer agency verification feature set within the API client.

v2.1.125

Added Features

Abort Agency Verification

• A new endpoint to abort an open agency verification process has been implemented.
• The API now includes several response types for this action, including:
  • AbortAgencyVerificationBadRequestResponse: For 400 Bad Request errors.
  • AbortAgencyVerificationDefaultResponse: A generic response for errors that do not fit other categories.
  • AbortAgencyVerificationForbiddenResponse: For 403 Forbidden errors.
  • AbortAgencyVerificationNotFoundResponse: For 404 Not Found errors.
  • AbortAgencyVerificationOKResponse: For a successful response, indicating the verification has been aborted.

Create Agency Verification

• Several new classes have been introduced for creating agency verification requests:
  • CreateAgencyVerificationRequest: Represents the request to create an agency verification.
  • CreateAgencyVerificationCreatedResponse: The response when an agency verification is successfully created.
  • CreateAgencyVerificationBadRequestResponse, CreateAgencyVerificationDefaultResponse, CreateAgencyVerificationForbiddenResponse, CreateAgencyVerificationNotFoundResponse, and CreateAgencyVerificationTooManyRequestsResponse: Various error responses for handling different HTTP status codes.

Get Open Agency Verification

• Implemented an endpoint to get the status of an agency verification request:
  • GetOpenAgencyVerificationRequest: Represents the request to fetch an agency verification's status.
  • GetOpenAgencyVerificationOKResponse: The successful response containing verification data.
  • Response classes for errors such as GetOpenAgencyVerificationBadRequestResponse, GetOpenAgencyVerificationDefaultResponse, GetOpenAgencyVerificationForbiddenResponse, and GetOpenAgencyVerificationNotFoundResponse.

Changes in Classes

• Refactored the TargetDirectory class into the new AbortAgencyVerificationOKResponseBody and ExtensionChangeContextOKResponseBody classes to better encapsulate specific responses related to agency verification and context changes.
• New ExtensionChangeContext functionality, including:
  • ExtensionChangeContextRequest: For changing the context of an extension.
  • Error response classes including ExtensionChangeContextDefaultResponse and ExtensionChangeContextNotFoundResponse.

This release provides enhanced functionality for agency verification and context manipulation within the Mittwald API, ensuring robust error handling and user interaction.

v2.1.124

New Features

Ingress Request Handling Enhancements

• Added support for handling the 412 Precondition Failed response in the DomainClientImpl class. This allows the API client to manage scenarios where preconditions for requests are not met.

Changes

• Introduced the IngressRequestIngressAcmeCertificateIssuancePreconditionFailedResponse class, which encapsulates the structure of the 412 response for improved error handling and clearer response management. It includes methods for validation and JSON serialization.

v2.1.123

Added Features

Pagination Parameters for API Token and Session Retrieval

• The ListApiTokensRequest, ListSessionsRequest, and ListSshKeysRequest classes have been updated to support pagination through the introduction of limit, skip, and page query parameters.
  • Limit: Set the maximum number of items to return.
  • Skip: Specify the number of items to skip before starting to collect the result set.
  • Page: Indicate the specific page of results to return.

This enhancement will allow for more controlled and efficient retrieval of resources, improving performance in scenarios with large datasets.

File Upload Rules Enhancements

• The FileUploadRules class has been enhanced with a new property, maxNameLength, which defines the maximum allowed name length for uploaded files.
• This includes a corresponding method withMaxNameLength to set this property and perform validation.

These changes enhance the overall file upload configuration, allowing for better control over file naming constraints.

Changes Summary

ListApiTokensRequest, ListSessionsRequest, ListSshKeysRequest

• Added properties: limit, skip, page.
• Introduced validation methods for these properties.
• Updated input parsing and JSON serialization to include pagination parameters.

FileUploadRules

• Introduced a new property maxNameLength.
• Updated constructor to include the new property.
• Added getter and a method to set maxNameLength with validation.

v2.1.122

New Features

Extension Authentication with Session Token

• ExtensionAuthenticateWithSessionToken API: A new feature allows external applications to authenticate using a session token, enhancing security and interaction with the system.
• Tokens: Upon successful authentication, a public token with expiry is provided, which can be used for further domain actions.

Extension Management

• Delete Extension API: Introduced a new capability to delete an extension asynchronously. This action will also remove all associated ExtensionInstances, allowing for comprehensive management of extensions in the system.

Added Classes

• ExtensionAuthenticateWithSessionToken

  • ExtensionAuthenticateWithSessionTokenBadRequestResponse: Handles bad request responses during authentication.
  • ExtensionAuthenticateWithSessionTokenCreatedResponse: Provides the response format when authentication is successful.
  • ExtensionAuthenticateWithSessionTokenDefaultResponse: Manages default responses when errors occur.
  • ExtensionAuthenticateWithSessionTokenNotFoundResponse: Handles not found responses.
  • ExtensionAuthenticateWithSessionTokenRequest: Manages requests to authenticate with a session token.

• ExtensionDeleteExtension

  • ExtensionDeleteExtensionRequest: Handles requests for deleting an extension.
  • ExtensionDeleteExtensionDefaultResponse: Manages default responses for delete operations.
  • ExtensionDeleteExtensionNotFoundResponse: Captures not found error conditions.
  • ExtensionDeleteExtensionTooManyRequestsResponse: For handling rate limits during deletion.

• ExtensionGenerateSessionToken

  • ExtensionGenerateSessionTokenOKResponse: Handles successful session token generation responses.
  • ExtensionGenerateSessionTokenBadRequestResponse: For handling validation errors during token generation.
  • ExtensionGenerateSessionTokenNotFoundResponse: Handles not found errors.
  • ExtensionGenerateSessionTokenDefaultResponse: Manages default responses.
  • ExtensionGenerateSessionTokenTooManyRequestsResponse: For rate limit errors in token generation.

Changes in Existing Classes

• MarketplaceClient Interface and Implementation: Updated to include methods for both the new extension session authentication and the deletion of extensions, allowing a streamlined interaction within the marketplace client.

Changes in API Response Handling

• Updated APIs to accommodate the new request types and responses, allowing for more effective error handling and response parsing.

Modified DTOs

• PublicKey schema now supports different formats for keys, allowing for more flexibility in how public keys are delivered and utilized within the application.

This release provides significant enhancements to the marketplace API, improving user authentication processes and extension management capabilities while ensuring robust error handling.