v2.1.197

Breaking Changes

• The VerificationVerifyAddressBadRequestResponse class has been removed from the codebase.

Enhancements

• The documentation for the country field in VerificationVerifyAddressRequest and VerificationVerifyAddressRequestBody has been updated. It now specifies that the input can be the full English or German name in addition to the ISO 3166-2 country codes.

v2.1.196

New Features

Backup Client

• Replace Project Backup Expiration Time
  • A new method has been added to update a backup's expiration time. This feature allows users to specify when a backup should expire, providing more control over backup management.

Container Client

• List Self Stacks
  • Introduced functionality to list stacks belonging to the executing user, allowing better management and organization of user-specific stacks.

Enhancements

Backup Client

• Improved the error handling for the new "Replace Project Backup Expiration Time" method by introducing responses for bad requests, forbidden access, not found errors, and rate limiting.

Container Client

• Enhanced error responses for the "List Self Stacks" method to handle various client errors including bad requests, forbidden access, and internal server errors.

Key Class in AI Hosting

• Deprecated the models field from the Key class and updated documentation to redirect users to the appropriate route for model information.

Bug Fixes

• Addressed various minor issues and improved validation schemas across different requests and responses, ensuring better compliance with specifications and smoother interactions with the API.

v2.1.195

Features

• Introduced a new schema for the verify address response that enhances the response structure and refines the handling of request bodies.

Changed

• VerificationVerifyAddressOKResponse:

  • Updated the response body to use VerificationVerifyAddressOKResponseBody instead of the previous VerifyAddressResponse.
  • The body property now explicitly defines its structure, requiring the exists field of type boolean.
  • The cloning mechanism for the body property has been updated to clone the body object properly, ensuring deep copies are maintained.

• VerificationVerifyAddressOKResponseBody:

  • Renamed from VerifyAddressResponse.
  • Adjusted methods to create instances and retrieve data according to the new response format and naming conventions.

• VerificationVerifyAddressRequest:

  • Updated the description for the country field to clarify that it should use the ISO 3166-2 Alpha 2 country code format.

• VerificationVerifyAddressRequestBody:

  • Consistently updated the country field description to reflect the ISO 3166-2 Alpha 2 country code requirement.

Removed

• The VerifyAddressConfidence enum has been entirely removed from the codebase, simplifying the verification process without this classification.

v2.1.194

Added

• Introduced a refreshToken field in the ChangePasswordOKResponse and ChangePasswordOKResponseBody classes.
  • Purpose: This token allows users to refresh their access token even after it has expired.

Updated

• The required fields for the responses have been updated to include the new refreshToken.
• The constructor for ChangePasswordOKResponseBody now accepts a refreshToken as an argument.
• Added a getRefreshToken method to retrieve the refreshToken.
• Included a withRefreshToken method to facilitate fluent interface usage while updating the refreshToken.
• Updated the hydration method to correctly process the new refreshToken from input data.
• The output serialization method now includes the refreshToken in the response output.

v2.1.193

Added Features

• Order List Orders Request Enhancements: Introduced new types property in the OrderListOrdersRequest class, allowing clients to filter orders by specific types. This feature enhances the flexibility of order retrieval based on varying classifications of orders.

Changes

OrderListOrdersRequest.php

• Added OrderType to the class, enabling classification of orders by types.
• Introduced the types property as an array in the request schema, allowing multiple order types to be specified.
• Added methods to get, set, and unset the types property within the OrderListOrdersRequest class.

DeprecatedMailProjectsettingUpdateBlacklistRequest.php

• Updated the email validation format to a regex pattern instead of using idn-email.

DeprecatedMailProjectsettingUpdateBlacklistRequestBody.php

• Similar update from idn-email format to regex pattern for blacklist items.

DeprecatedMailProjectsettingUpdateWhitelistRequest.php

• Updated email validation to use regex pattern instead of idn-email for whitelist items.

DeprecatedMailProjectsettingUpdateWhitelistRequestBody.php

• Updated the validation format to regex pattern for whitelist items.

DeprecatedMailUpdateProjectMailSettingRequest.php

• Changed validation format from idn-email to regex pattern for blacklist and whitelist items.

ListProjectMailSettingsOKResponse.php

• Adjusted email validation to regex patterns for blacklist and whitelist properties.

ListProjectMailSettingsOKResponseBody.php

• Updated email validation from idn-email to a regex pattern for blacklist and whitelist properties.

UpdateProjectMailSettingRequest.php

• Email validation updated to regex patterns for both blacklist and whitelist item formats.

UpdateProjectMailSettingRequestBodyAlternative1.php

• Revised email validation from idn-email format to regex pattern for blacklist items.

UpdateProjectMailSettingRequestBodyAlternative2.php

• Updated email validation to utilize a regex pattern instead of idn-email for whitelist items.

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.