Skip to content

Releases: mittwald/api-client-php

v2.1.168

08 Jan 19:10

Choose a tag to compare

Features

Added Support for Time Zones

  • The API now includes an endpoint to list valid time zones, enhancing functionality for scheduling tasks.
  • Added parameters for time zone and concurrency policy in cron job creation and update methods.

Concurrency Policy Enhancements

  • Introduced a ConcurrencyPolicy enum to define how concurrent executions of cron jobs are handled.
  • Updated cron job schemas to include concurrency policy and time zone settings.

Deprecated Features

Aborted Execution Method Deprecated

  • The abort execution method for cron jobs has been deprecated and replaced with a new method that acknowledges the feature's unavailability but maintains compatibility with previous calls.

Changes in API Client

CronjobClient Modifications

  • Removed the abortExecution method and introduced deprecatedCronjobAbortExecution, which documents that the feature is currently unavailable.
  • Updated the CronjobClientImpl and associated methods to adapt to the deprecation.

MiscellaneousClient Modifications

  • Added a method for listing time zones, miscellaneousListTimeZones, that utilizes the new endpoint.
  • Adjusted response handling for this new method to accommodate error responses.

Structural Changes

New Request and Response Classes

  • Added classes to manage requests and responses related to time zones, including:
    • MiscellaneousListTimeZonesRequest
    • MiscellaneousListTimeZonesDefaultResponse
    • MiscellaneousListTimeZonesTooManyRequestsResponse

Schema Updates

  • Modified existing schemas for cron jobs to incorporate new properties for concurrency policies and time zones.
  • Provided additional fields in cron job execution schemas.

Removal of Redundant Code

  • Cleaned up unused code and references to the now-removed abort execution functionality throughout various files, streamlining the project.

This release strengthens the ability to manage cron jobs effectively by adding support for essential features like time zones and task execution policies while deprecated features are organized to minimize disruption.

v2.1.167

19 Dec 19:09

Choose a tag to compare

Features Added

  • Added the invoiceType field to the ContributorListIncomingInvoicesOKResponse and ContributorListIncomingInvoicesOKResponseBodyItem classes.
  • Introduced an enumeration called ContributorListIncomingInvoicesOKResponseBodyItemInvoiceType to define the possible types of invoices: REGULAR, CORRECTION, REISSUE, and CANCELLATION.

Enhancements

  • Updated the getInvoiceType method in the ContributorListIncomingInvoicesOKResponseBodyItem class to return the invoice type if set.
  • Added methods withInvoiceType and withoutInvoiceType to manage the invoiceType property more effectively.
  • Extended the constructor logic to accommodate the invoiceType when creating instances of ContributorListIncomingInvoicesOKResponseBodyItem.
  • Improved the serialization process in the toJson method to include the invoiceType in the output if it is set.

v2.1.166

18 Dec 19:10

Choose a tag to compare

Features

  • Added support for a new field deletionDeadline across 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 deletionDeadline property to represent the date when the variant will be deleted.
  • ExtensionUpdateExtensionPricingOKResponseBody.php

    • Included deletionDeadline in the response body for extension pricing updates.
  • ExtensionUpdateExtensionPricingOKResponseBodyPriceChangeConsequence.php

    • Extended to accommodate deletionDeadline.
  • ExtensionUpdateExtensionPricingOKResponseBodyPriceChangeConsequenceVariantConsequencesItem.php

    • Introduced deletionDeadline to represent the variant's deletion timeframe.
  • Variant.php

    • Added deletionDeadline and isDeletionScheduled properties for managing extension variants' deletion status.

ProjectFileSystem

  • ProjectFileSystemClientImpl.php

    • Included handling for unauthorized responses via ProjectFileSystemGetJwtUnauthorizedResponse.
  • 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 deletionDeadline and isDeletionScheduled, enhancing the pricing plan functionality with scheduled deletion details.

v2.1.165

17 Dec 19:10

Choose a tag to compare

Added Features

  • Introduced a new method getDetailOfContractByAiHosting in the ContractClient and its implementation in the ContractClientImpl. 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 a customerId.
  • 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 for message and type.

Changes in Interfaces and Implementations

  • Updated the ContractClient interface to include the new method for retrieving AI Hosting Contracts.
  • Extended the ContractClientImpl to 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

15 Dec 19:10

Choose a tag to compare

New Features

  • Added support for deleteIngresses parameter in the scheduled deletion request. This allows users to choose whether to also delete the corresponding Ingress and subdomain Ingresses.

Enhancements

  • Introduced deleteIngresses property in the CreateScheduledDeletionRequestBody class to facilitate the deletion of Ingress objects during the scheduled deletion process.
  • Updated the JSON serialization of the CreateScheduledDeletionRequestBody class to include the deleteIngresses property if it is set.
  • Added withDeleteIngresses() method for setting the deleteIngresses property with validation.
  • Added withoutDeleteIngresses() method for unsetting the deleteIngresses property.
  • Enhanced input validation in the fromJson() method to accommodate the new deleteIngresses parameter.

v2.1.163

10 Dec 19:09

Choose a tag to compare

Changes

Updated Request Limit Handling

  • The limit attribute for request classes ListAppinstallationsRequest, ListAppinstallationsForUserRequest, and ListSystemsoftwaresRequest has been made optional. The attribute type has been changed from int with a default value of 1000 to a nullable int without 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

05 Dec 14:42

Choose a tag to compare

Features

  • List App Installations Request Update: The ListAppinstallationsRequest has 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, the ListAppinstallationsForUserRequest now also includes a default limit of 1000. This further standardizes the API behavior across requests.

  • List System Software Request Update: The ListSystemsoftwaresRequest includes a default limit of 1000, enhancing its functionality and consistency with other requests.

  • Backup Client Enhancements: New methods are now available in the BackupClient interface 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 MailClient now integrates new requests and responses related to listing mail addresses, providing better access to user-specific mail functionalities.

Updates

API Changes

  • Updated Request Models:

    • ListMailAddressesForUserRequest now 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:

    • ListMailAddressesForUserBadRequestResponse
    • ListMailAddressesForUserForbiddenResponse
    • ListMailAddressesForUserNotFoundResponse
    • ListMailAddressesForUserServiceUnavailableResponse
    • ListMailAddressesForUserTooManyRequestsResponse
  • Introduced New Error Types: The GetProjectBackupDirectories and RequestProjectBackupRestorePath now 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:
    • setting in the DeprecatedMailUpdateProjectMailSettingRequest has been renamed to mailSetting.
    • 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

31 Oct 19:07

Choose a tag to compare

New Features

  • Introduced ExtensionDeleteExtensionPreconditionFailedResponse class to handle specific HTTP responses for the delete extension operation when preconditions fail.

Changes

  • Updated the documentation in MarketplaceClient.php and MarketplaceClientImpl.php to clarify the extension deletion process.
  • Added a new case in MarketplaceClientImpl to correctly respond with the ExtensionDeleteExtensionPreconditionFailedResponse when a 412 status code is received.

v2.1.160

30 Oct 19:07

Choose a tag to compare

Removed

  • The AuthenticateBadRequestResponse class has been removed, which previously handled responses for bad authentication requests. This includes its corresponding methods and validation schema.

Changes

UserClientImpl Updates

  • The AuthenticateBadRequestResponse reference was removed from the UserClientImpl. The handling for status code 400 now uses an UntypedResponse.

CronjobExecutionAnalysis Updates

  • The CronjobExecutionAnalysis class has been simplified by removing properties and related methods for issues and recommendation. The class now only handles a message, reducing its complexity.
  • Input handling in the buildFromInput method and JSON output in toJson have been updated to reflect the removed properties.

v2.1.159

29 Oct 19:07

Choose a tag to compare

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 GetExecutionAnalysisRequest object and returns a GetExecutionAnalysisOKResponse.

New Responses

  • Introduced various response classes for getExecutionAnalysis method including:
    • GetExecutionAnalysisBadRequestResponse
    • GetExecutionAnalysisDefaultResponse
    • GetExecutionAnalysisForbiddenResponse
    • GetExecutionAnalysisInternalServerErrorResponse
    • GetExecutionAnalysisNotFoundResponse
    • GetExecutionAnalysisTooManyRequestsResponse
    • GetExecutionAnalysisOKResponse

New Request Class

  • GetExecutionAnalysisRequest
    • A new request class for fetching the execution analysis. It requires an executionId and a cronjobId.

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 Leadfyndr namespace to use camelCase naming conventions instead of snake_case for:
    • address_prefix renamed to addressPrefix
    • country_code renamed to countryCode
    • house_number renamed to houseNumber