v2.1.192

Features

Set Stack Update Schedule

• New API endpoint to set an update schedule for a stack, allowing users to define a cron-based schedule for updates. This includes detailed request and response handling for different HTTP status codes.

Improvements and Updates

• Updated descriptions in existing API request and response schemas for better clarity, including information about command, entrypoint, environment variables, image handling, and more.
• Added context-rich descriptions for properties related to resource specifications such as CPU and memory limits.

Documentation Enhancements

• Enhanced schema documentation across various models to provide clarity on expected formats and examples, helping developers integrate more effectively with the API.

API Changes

New Methods

• setStackUpdateSchedule: Added to the ContainerClient interface, allowing the setting of a scheduled update for containers.

Updated Method Descriptions

• The method documentation for pulling images and recreating services has been updated for clarity.

New Response Classes

• Created various response classes for error handling in the setStackUpdateSchedule method, including:
  • SetStackUpdateScheduleBadRequestResponse
  • SetStackUpdateScheduleForbiddenResponse
  • SetStackUpdateScheduleNotFoundResponse
  • SetStackUpdateScheduleInternalServerErrorResponse
  • SetStackUpdateScheduleTooManyRequestsResponse

Schema Updates

• Resource Specification Updates: Detailed descriptions for CPU and memory usage in the ResourceSpec schema.
• New fields added in the StackResponse schema to accommodate scheduling updates, enhancing the overall responsiveness of service management.

Consistency Improvements

• Improved naming and structuring in the request schemas for better semantic understanding when configuring containers and services, making it easier for clients to manage them programmatically.

v2.1.191

Added

License API

• Introduced a new LicenseClient and its implementation, providing functionality for managing licenses including:

  • Fetching a Single License: getLicense(GetLicenseRequest $request)
  • Listing Licenses for a Project: listLicensesForProject(ListLicensesForProjectRequest $request)
  • Rotating License Keys: rotateLicenseKey(RotateLicenseKeyRequest $request)
  • Validating License Keys for a Project: validateLicenseKeyForProject(ValidateLicenseKeyForProjectRequest $request)

• New response classes for GetLicense operation:

  • GetLicenseOKResponse
  • GetLicenseBadRequestResponse
  • GetLicenseForbiddenResponse
  • GetLicenseTooManyRequestsResponse
  • GetLicenseInternalServerErrorResponse
  • GetLicenseDefaultResponse

• New response classes for ListLicensesForProject operation:

  • ListLicensesForProjectOKResponse
  • ListLicensesForProjectBadRequestResponse
  • ListLicensesForProjectForbiddenResponse
  • ListLicensesForProjectInternalServerErrorResponse
  • ListLicensesForProjectDefaultResponse
  • ListLicensesForProjectTooManyRequestsResponse

• New response classes for RotateLicenseKey operation:

  • RotateLicenseKeyOKResponse
  • RotateLicenseKeyBadRequestResponse
  • RotateLicenseKeyForbiddenResponse
  • RotateLicenseKeyNotFoundResponse
  • RotateLicenseKeyInternalServerErrorResponse
  • RotateLicenseKeyDefaultResponse
  • RotateLicenseKeyPreconditionFailedResponse
  • RotateLicenseKeyTooManyRequestsResponse

• New request classes for ListLicensesForProject and ValidateLicenseKeyForProject operations.

Data Models

• Added data models for managing licenses including License, Key, ExternalKey, KeyResponse, Meta, Reference, and their respective enums and request/response classes.

Enhancements

• New schema definitions for various operations in the License API, providing structure for input validation and response handling.

• New functionality for validating and processing license keys related to projects.

License Order Support

• Integrations for creating and managing aspects of TYPO3 ELTS license orders including key management and version handling were established.

This update introduces significant capability to manage licenses accurately, ensuring robust API interactions for license validations, actions, listing, and details management.

v2.1.190

Breaking Changes

• Removed the deprecated method deprecatedCronjobAbortExecution and its associated classes and functionality within the CronjobClient interface. This feature is no longer supported.

Features

• Added a new boolean property avoidEmailConfirmation to the UpdateDomainContactRequest and UpdateDomainContactRequestBody classes. This property allows users to indicate whether to avoid the email confirmation during updates, which might result in the application of a 60-day transfer lock on the domain.

Improvements

• Improved the UpdateDomainContactRequestBody class by providing methods to set and unset the avoidEmailConfirmation parameter, alongside validation during input processing.

Bug Fixes

• No bug fixes were explicitly mentioned in this release; the focus was primarily on removing deprecated features and introducing new functionality.

v2.1.189

Added Features

Get Detail of Contract by License

• Introduced a new method getDetailOfContractByLicense to the ContractClient interface and its implementation, allowing retrieval of contracts based on License ID.
• The new method enhances querying capabilities for contracts, improving the overall API usability for clients managing contracts.

New Request and Response Classes

• Added GetDetailOfContractByLicenseRequest to construct requests for fetching contract details using a License ID.
• Introduced new response classes to handle the result of the getDetailOfContractByLicense method:
  • GetDetailOfContractByLicenseOKResponse: for successful responses.
  • GetDetailOfContractByLicenseBadRequestResponse: for handling bad requests.
  • GetDetailOfContractByLicenseNotFoundResponse: for scenarios where no contract is found for the given License ID.
  • GetDetailOfContractByLicenseDefaultResponse: for handling any other issues.
  • GetDetailOfContractByLicenseTooManyRequestsResponse: to manage rate limiting scenarios.
  • GetDetailOfContractByLicenseTooManyRequestsResponseBody: to encapsulate the response body for too many requests.

Internal Validation

• Each new response and request class includes a schema for input validation to ensure data integrity when interacting with the API.

v2.1.188

Features Added

• Verification Address Confidence Enum: Introduced a new enum VerifyAddressConfidence to categorize the confidence levels of address verification. This enhancement allows users to understand the certainty of an address's existence more clearly.

Changes

• Refactor Verification Response Handling:

  • The class VerificationVerifyAddressOKResponse now utilizes the VerifyAddressResponse schema instead of the previously defined VerificationVerifyAddressOKResponseBody. This change improves the clarity and structure of the response handling.
  • Updated constructor and method signatures in VerificationVerifyAddressOKResponse to utilize the new VerifyAddressResponse class.

• New VerifyAddressResponse Class:

  • Renamed VerificationVerifyAddressOKResponseBody to VerifyAddressResponse.
  • Enhanced docstrings and adjusted method signatures to reflect the renaming and structural changes.

• Removed Cloning of Body: Simplified handling of the body in the __clone method by removing unnecessary cloning, which enhances performance and memory management.

v2.1.187

Added

• Introduced ExecuteActionBadRequestResponse class to handle bad request responses for execute action operations, providing a structured way to manage validation errors.
• Added ExecuteActionPreconditionFailedResponse class to manage responses when precondition failures occur, enhancing error handling capabilities.

Changed

• Updated the AppClientImpl to incorporate the new response classes for 400 (Bad Request) and 412 (Precondition Failed) status codes.
• Removed the projectId parameter from the CreateMySqlDatabase schema to streamline the database creation process and ensure it aligns with the latest API specifications.

Documentation

• Corrected documentation in the MiscClient interface and implementation to capitalize "German" in describing the company register for clarity.

v2.1.186

New Features

DnsCreateDnsZoneConflictResponse

An implementation for handling conflict responses when creating DNS zones has been introduced. This feature allows the API client to manage scenarios when a request to create a DNS zone conflicts with existing resources.

Changes

• Introduced DnsCreateDnsZoneConflictResponse class to handle conflict responses for DNS zone creation, providing validation and serialization capabilities.
• Updated DomainClientImpl to throw a DnsCreateDnsZoneConflictResponse for HTTP status code 409 sessions, enabling the client to correctly interpret conflict responses.

v2.1.185

Enhancements

DatabaseClient Interface

• The Create a MySQLDatabase with a MySQLUser method now includes detailed descriptions about the operation, noting that it is asynchronous and providing guidance on how to check the database status after creation.

DatabaseClient Implementation

• Similar to the interface, the Create a MySQLDatabase with a MySQLUser method in the DatabaseClientImpl class has been updated to clarify the operation's asynchronous nature.

Added Response Class

• Introduced ContributorGetLoginLinkForbiddenResponse to handle 403 Forbidden responses specific to the login link process.

Schema Updates

CharacterSettings

• Added descriptions and examples for characterSet and collation properties indicating their valid values and sources.

CreateMySqlDatabase

• Enhanced the schema to include descriptions for description and version properties providing contextual information for users.

CreateMySqlUser

• Enhanced the schema with detailed descriptions, including examples for accessIpMask, accessLevel, and externalAccess.

CreateMySqlUserWithDatabase

• Updated the schema to include detailed descriptions for both accessLevel and externalAccess, clarifying user permissions and external connectivity scenarios.

MySqlDatabase

• Enhanced the schema to provide more context in the form of descriptions for properties like description, externalHostname, hostname, name, and version.

v2.1.184

Added

• lastError Property:
  • A new property lastError has been added to the AppInstallation class, which holds the last error that occurred during an update and resets on success. This provides better tracking of issues during updates.

Enhanced

• Getter and Setter for lastError:
  • Methods getLastError(), withLastError(string $lastError), and withoutLastError() have been introduced to manage the lastError property effectively.

Updated

• Input Processing:

  • The input processing for the AppInstallation class has been updated to include the lastError property, ensuring that it can be set and retrieved as part of the installation state.

• Output Serialization:

  • The output serialization method has been modified to include the lastError in the serialized output, allowing external clients to see if there was an error during the last update.

v2.1.183

Summary of Changes

This release includes the implementation of new response handling for the verification of addresses and the modification of existing response structures related to user deletion. Notably, the new VerificationVerifyAddressBadRequestResponse class is introduced, which enhances error handling when verifying addresses.

Added

• VerificationVerifyAddressBadRequestResponse class added to improve address verification error handling.
  • Implements response handling for invalid requests to the address verification service.

Changed

• The UnexpectedResponseException handling in MiscClientImpl now recognizes HTTP status code 400 for bad requests, returning a VerificationVerifyAddressBadRequestResponse.
• Updates made to the DeleteUserConflictResponse to use a more generalized error response structure based on the Error schema instead of the previously defined DeleteUserConflictResponseBody.
• Removal of the now obsolete DeleteUserConflictResponseBody and its associated properties, along with the DeleteUserConflictResponseBodyName enumeration.
• Documentation corrections made in the UserClient and UserClientImpl interfaces to fix typos in the authentication method descriptions.