Releases: mittwald/api-client-php
v2.1.167
Features Added
- Added the
invoiceTypefield to theContributorListIncomingInvoicesOKResponseandContributorListIncomingInvoicesOKResponseBodyItemclasses. - Introduced an enumeration called
ContributorListIncomingInvoicesOKResponseBodyItemInvoiceTypeto define the possible types of invoices:REGULAR,CORRECTION,REISSUE, andCANCELLATION.
Enhancements
- Updated the
getInvoiceTypemethod in theContributorListIncomingInvoicesOKResponseBodyItemclass to return the invoice type if set. - Added methods
withInvoiceTypeandwithoutInvoiceTypeto manage theinvoiceTypeproperty more effectively. - Extended the constructor logic to accommodate the
invoiceTypewhen creating instances ofContributorListIncomingInvoicesOKResponseBodyItem. - Improved the serialization process in the
toJsonmethod to include theinvoiceTypein the output if it is set.
v2.1.166
Features
- Added support for a new field
deletionDeadlineacross various classes in the Marketplace and ProjectFileSystem clients, which allows tracking the scheduled deletion date for variants and items. This addition enhances the data model to manage the lifecycle of extension pricing and project files more effectively.
Changed
Marketplace Extensions
-
ExtensionUpdateExtensionPricingOKResponse.php
- Added
deletionDeadlineproperty to represent the date when the variant will be deleted.
- Added
-
ExtensionUpdateExtensionPricingOKResponseBody.php
- Included
deletionDeadlinein the response body for extension pricing updates.
- Included
-
ExtensionUpdateExtensionPricingOKResponseBodyPriceChangeConsequence.php
- Extended to accommodate
deletionDeadline.
- Extended to accommodate
-
ExtensionUpdateExtensionPricingOKResponseBodyPriceChangeConsequenceVariantConsequencesItem.php
- Introduced
deletionDeadlineto represent the variant's deletion timeframe.
- Introduced
-
Variant.php
- Added
deletionDeadlineandisDeletionScheduledproperties for managing extension variants' deletion status.
- Added
ProjectFileSystem
-
ProjectFileSystemClientImpl.php
- Included handling for unauthorized responses via
ProjectFileSystemGetJwtUnauthorizedResponse.
- Included handling for unauthorized responses via
-
ProjectFileSystemGetJwtUnauthorizedResponse.php
- New response class to manage unauthorized access in the JWT authentication process for the project file system client.
Marketplace Pricing Plans
- MonthlyPricePlanStrategyItem.php
- Incorporated
deletionDeadlineandisDeletionScheduled, enhancing the pricing plan functionality with scheduled deletion details.
- Incorporated
v2.1.165
Added Features
- Introduced a new method
getDetailOfContractByAiHostingin theContractClientand its implementation in theContractClientImpl. This method is designed to retrieve the AI Hosting Contract for a specific customer using their customer ID.
New API Requests and Responses
-
New Request Class:
GetDetailOfContractByAiHostingRequest: This class encapsulates the request parameters for retrieving the AI Hosting Contract, specifically requiring acustomerId.
-
New Response Classes:
GetDetailOfContractByAiHostingOKResponse: Represents a successful response containing the contract details.GetDetailOfContractByAiHostingBadRequestResponse: Handles the 400 Bad Request error responses.GetDetailOfContractByAiHostingNotFoundResponse: Represents a 404 Not Found error.GetDetailOfContractByAiHostingTooManyRequestsResponse: For handling the 429 Too Many Requests error.GetDetailOfContractByAiHostingDefaultResponse: Captures any other type of response error.
-
Response Body Classes:
GetDetailOfContractByAiHostingTooManyRequestsResponseBody: This class models the body content of a too many requests response, including fields formessageandtype.
Changes in Interfaces and Implementations
- Updated the
ContractClientinterface to include the new method for retrieving AI Hosting Contracts. - Extended the
ContractClientImplto implement the behavior of the new method, processing the request and managing HTTP responses accordingly. - Added validation schemas to request and response handling processes to ensure data integrity and error management.
This release enhances the capabilities of the API client by providing a dedicated method for accessing AI Hosting Contract details for customers, facilitating improved service interaction and error handling.
v2.1.164
New Features
- Added support for
deleteIngressesparameter in the scheduled deletion request. This allows users to choose whether to also delete the corresponding Ingress and subdomain Ingresses.
Enhancements
- Introduced
deleteIngressesproperty in theCreateScheduledDeletionRequestBodyclass to facilitate the deletion of Ingress objects during the scheduled deletion process. - Updated the JSON serialization of the
CreateScheduledDeletionRequestBodyclass to include thedeleteIngressesproperty if it is set. - Added
withDeleteIngresses()method for setting thedeleteIngressesproperty with validation. - Added
withoutDeleteIngresses()method for unsetting thedeleteIngressesproperty. - Enhanced input validation in the
fromJson()method to accommodate the newdeleteIngressesparameter.
v2.1.163
Changes
Updated Request Limit Handling
-
The
limitattribute for request classesListAppinstallationsRequest,ListAppinstallationsForUserRequest, andListSystemsoftwaresRequesthas been made optional. The attribute type has been changed fromintwith a default value of1000to a nullableintwithout a default value. -
A new method
withoutLimit()has been added to each of these request classes to allow users to create a request without a limit, enhancing flexibility in request configurations.
Adjustments in Serialization
- Updates have been made to the serialization logic. The limit will only be included in the output if it is set, preventing unnecessary inclusion of a default value in the serialized output.
These changes collectively improve the adaptability of the API, offering better management of request parameters and accommodating different use cases without enforcing a rigid structure around the limit parameter.
v2.1.162
Features
-
List App Installations Request Update: The
ListAppinstallationsRequesthas been enhanced with the introduction of a default limit value of 1000. This change ensures that if no limit is provided, it will automatically use this default, improving the usability of the API. Additionally, the limit attribute has been changed to a non-nullable type. -
List App Installations for User Request Update: Similar to the
ListAppinstallationsRequest, theListAppinstallationsForUserRequestnow also includes a default limit of 1000. This further standardizes the API behavior across requests. -
List System Software Request Update: The
ListSystemsoftwaresRequestincludes a default limit of 1000, enhancing its functionality and consistency with other requests. -
Backup Client Enhancements: New methods are now available in the
BackupClientinterface and its implementation:getProjectBackupDirectories: This method allows obtaining the directory structure for a specified project backup.requestProjectBackupRestorePath: This new method enables the restoration of a project backup's path.
-
Improved Error Handling: Multiple new response classes have been added for handling different error scenarios, such as bad requests, not found, forbidden access, and too many requests across various services including Mail and Marketplace.
-
Changes in Mail API: The implementation of the
MailClientnow integrates new requests and responses related to listing mail addresses, providing better access to user-specific mail functionalities.
Updates
API Changes
-
Updated Request Models:
ListMailAddressesForUserRequestnow allows for comprehensive query parameters including pagination (limit,skip,page) and filters (search,forwardAddress,catchAll, etc.).
-
Error Response Classes: Numerous classes have been added to handle various responses for mail address requests including:
ListMailAddressesForUserBadRequestResponseListMailAddressesForUserForbiddenResponseListMailAddressesForUserNotFoundResponseListMailAddressesForUserServiceUnavailableResponseListMailAddressesForUserTooManyRequestsResponse
-
Introduced New Error Types: The
GetProjectBackupDirectoriesandRequestProjectBackupRestorePathnow have defined structures for handling various errors, making the API clearer in its response management.
Code Refactoring
- Renamed and restructured several classes for better clarity and accuracy. For example:
settingin theDeprecatedMailUpdateProjectMailSettingRequesthas been renamed tomailSetting.- The enum for mail settings has been updated for clear designation.
This release serves to enhance usability, provide clearer error management, and maintain consistency in defaults across the API, thereby improving the developer experience.
v2.1.161
New Features
- Introduced
ExtensionDeleteExtensionPreconditionFailedResponseclass to handle specific HTTP responses for the delete extension operation when preconditions fail.
Changes
- Updated the documentation in
MarketplaceClient.phpandMarketplaceClientImpl.phpto clarify the extension deletion process. - Added a new case in
MarketplaceClientImplto correctly respond with theExtensionDeleteExtensionPreconditionFailedResponsewhen a 412 status code is received.
v2.1.160
Removed
- The
AuthenticateBadRequestResponseclass has been removed, which previously handled responses for bad authentication requests. This includes its corresponding methods and validation schema.
Changes
UserClientImpl Updates
- The
AuthenticateBadRequestResponsereference was removed from theUserClientImpl. The handling for status code400now uses anUntypedResponse.
CronjobExecutionAnalysis Updates
- The
CronjobExecutionAnalysisclass has been simplified by removing properties and related methods forissuesandrecommendation. The class now only handles amessage, reducing its complexity. - Input handling in the
buildFromInputmethod and JSON output intoJsonhave been updated to reflect the removed properties.
v2.1.159
Features
Cronjob Execution Analysis
- Added the ability to retrieve the analysis of cronjob executions, especially for cases where executions have failed. This feature includes a detailed message about the possible causes and recommendations for resolution.
API Changes
New Methods
- getExecutionAnalysis
- New method to get a CronjobExecution analysis for failed executions.
- Accepts a
GetExecutionAnalysisRequestobject and returns aGetExecutionAnalysisOKResponse.
New Responses
- Introduced various response classes for
getExecutionAnalysismethod including:GetExecutionAnalysisBadRequestResponseGetExecutionAnalysisDefaultResponseGetExecutionAnalysisForbiddenResponseGetExecutionAnalysisInternalServerErrorResponseGetExecutionAnalysisNotFoundResponseGetExecutionAnalysisTooManyRequestsResponseGetExecutionAnalysisOKResponse
New Request Class
- GetExecutionAnalysisRequest
- A new request class for fetching the execution analysis. It requires an
executionIdand acronjobId.
- A new request class for fetching the execution analysis. It requires an
New Schema Classes
- CronjobExecutionAnalysis
- A schema class detailing the structure of the cronjob execution analysis response.
Updated Existing Schemas
- Adjusted fields in existing schema classes under the
Leadfyndrnamespace to use camelCase naming conventions instead of snake_case for:address_prefixrenamed toaddressPrefixcountry_coderenamed tocountryCodehouse_numberrenamed tohouseNumber
v2.1.158
Added Features
- Introduced new classes for container management, including
Deploy,ResourceSpec, andResources, enhancing the API's capability to manage container deployment specifications and resource allocation.
Updated Requests
- ListLeadsRequest and ListUnlockedLeadsRequest
- Modified the
technologiesfield to support an array structure that can now include a string type or the value 'none'. - Updated the type hint for
technologiesfromstring[]|nulltomixed[]|null.
- Modified the
New Classes
-
Deploy
- Defines the deployment schema for containers and includes methods for managing the resources used.
- Supports input validation and serialization to JSON.
-
ResourceSpec
- Represents the resource specifications for containers, including CPU and memory constraints.
- Provides validation and serialization features.
-
Resources
- Wraps around
ResourceSpec, providing a schema to define limits on resources for container deployments. - Includes methods for validation and handling input data.
- Wraps around
Updated Service Management
-
ServiceDeclareRequest and ServiceRequest
- Added
deployfield to both classes to reference the newDeployschema. - Updated methods and input handling to support deployment specifications.
- Added
-
ServiceResponse
- Expanded to include a reference to the
Deployclass to handle deployment information in the response.
- Expanded to include a reference to the
These changes collectively enhance the API's flexibility and usability in managing container deployments and the associated resources.