From bb14ef396deb2b1bccc1e8d80da4bd47e3a04427 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 1 Sep 2025 13:50:19 +0000 Subject: [PATCH 01/40] chore: sync repo --- .editorconfig | 15 - .gitattributes | 10 - .github/workflows/ci.yml | 52 + .github/workflows/coverage.yml | 29 - .github/workflows/create-releases.yml | 30 + .github/workflows/release-doctor.yml | 21 + .github/workflows/test.yml | 31 - .github/workflows/wiki.yml | 24 - .gitignore | 51 +- .php-cs-fixer.dist.php | 17 + .phpactor.json | 6 + .release-please-manifest.json | 3 + .stats.yml | 4 + DEVELOPMENT.md | 25 - LICENSE | 221 +- README.md | 1277 +-------- SECURITY.md | 27 + bin/check-release-environment | 29 + composer.json | 89 +- composer.lock | 2395 ----------------- phpstan.dist.neon | 14 + phpunit.xml.dist | 31 +- release-please-config.json | 66 + sample/README.md | 15 - sample/file_management/index.php | 319 --- sample/metadata/index.php | 62 - sample/sample.php | 31 - sample/sample_image.jpeg | Bin 62767 -> 0 bytes sample/upload_api/index.php | 87 - sample/upload_api/sample_image.jpeg | Bin 62767 -> 0 bytes .../chained_transformations.php | 54 - ...age_enhancement_and_color_manipulation.php | 105 - sample/url_generation/index.php | 11 - ...size_crop_other_common_transformations.php | 521 ---- sample/url_generation/signed_url.php | 27 - sample/utility/index.php | 26 - scripts/bootstrap | 8 + scripts/clean | 8 + scripts/format | 8 + scripts/lint | 8 + scripts/mock | 41 + scripts/test | 55 + src/Accounts/Origins/OriginCreateParams.php | 87 + src/Accounts/Origins/OriginRequest.php | 48 + .../Origins/OriginRequest/AkeneoPim.php | 231 ++ .../Origins/OriginRequest/AzureBlob.php | 178 ++ .../OriginRequest/CloudinaryBackup.php | 202 ++ src/Accounts/Origins/OriginRequest/Gcs.php | 178 ++ src/Accounts/Origins/OriginRequest/S3.php | 198 ++ .../Origins/OriginRequest/S3Compatible.php | 245 ++ .../Origins/OriginRequest/WebFolder.php | 159 ++ .../Origins/OriginRequest/WebProxy.php | 118 + src/Accounts/Origins/OriginResponse.php | 48 + .../Origins/OriginResponse/AkeneoPim.php | 162 ++ .../Origins/OriginResponse/AzureBlob.php | 193 ++ .../OriginResponse/CloudinaryBackup.php | 185 ++ src/Accounts/Origins/OriginResponse/Gcs.php | 193 ++ src/Accounts/Origins/OriginResponse/S3.php | 185 ++ .../Origins/OriginResponse/S3Compatible.php | 233 ++ .../Origins/OriginResponse/WebFolder.php | 190 ++ .../Origins/OriginResponse/WebProxy.php | 138 + src/Accounts/Origins/OriginUpdateParams.php | 87 + .../URLEndpoints/URLEndpointCreateParams.php | 149 + .../URLEndpointCreateParams/URLRewriter.php | 38 + .../URLRewriter/Akamai.php | 36 + .../URLRewriter/Cloudinary.php | 60 + .../URLRewriter/Imgix.php | 36 + .../URLEndpoints/URLEndpointRequest.php | 144 + .../URLEndpointRequest/URLRewriter.php | 38 + .../URLEndpointRequest/URLRewriter/Akamai.php | 36 + .../URLRewriter/Cloudinary.php | 60 + .../URLEndpointRequest/URLRewriter/Imgix.php | 36 + .../URLEndpoints/URLEndpointResponse.php | 170 ++ .../URLEndpointResponse/URLRewriter.php | 38 + .../URLRewriter/Akamai.php | 36 + .../URLRewriter/Cloudinary.php | 74 + .../URLEndpointResponse/URLRewriter/Imgix.php | 36 + .../URLEndpoints/URLEndpointUpdateParams.php | 149 + .../URLEndpointUpdateParams/URLRewriter.php | 38 + .../URLRewriter/Akamai.php | 36 + .../URLRewriter/Cloudinary.php | 60 + .../URLRewriter/Imgix.php | 36 + src/Accounts/Usage/UsageGetParams.php | 96 + src/Accounts/Usage/UsageGetResponse.php | 140 + src/Assets/AssetListParams.php | 242 ++ src/Assets/AssetListParams/FileType.php | 26 + src/Assets/AssetListParams/Sort.php | 44 + src/Assets/AssetListParams/Type.php | 29 + src/Assets/AssetListResponseItem.php | 33 + src/BaseOverlay.php | 64 + src/Beta/V2/Files/FileUploadParams.php | 571 ++++ .../V2/Files/FileUploadParams/Extension.php | 35 + .../Extension/AIAutoDescription.php | 39 + .../Extension/AutoTaggingExtension.php | 119 + .../Extension/AutoTaggingExtension/Name.php | 20 + .../FileUploadParams/Extension/RemoveBg.php | 55 + .../Extension/RemoveBg/Options.php | 117 + .../Files/FileUploadParams/ResponseField.php | 27 + .../Files/FileUploadParams/Transformation.php | 99 + .../FileUploadParams/Transformation/Post.php | 37 + .../Transformation/Post/Abs.php | 101 + .../Transformation/Post/Abs/Protocol.php | 20 + .../Transformation/Post/GifToVideo.php | 62 + .../Transformation/Post/Thumbnail.php | 62 + .../Transformation/Post/Transformation.php | 76 + src/Beta/V2/Files/FileUploadResponse.php | 556 ++++ .../V2/Files/FileUploadResponse/AITag.php | 95 + .../FileUploadResponse/ExtensionStatus.php | 126 + .../ExtensionStatus/AIAutoDescription.php | 19 + .../ExtensionStatus/AwsAutoTagging.php | 19 + .../ExtensionStatus/GoogleAutoTagging.php | 19 + .../ExtensionStatus/RemoveBg.php | 19 + .../Files/FileUploadResponse/VersionInfo.php | 74 + .../Invalidation/InvalidationCreateParams.php | 74 + .../Invalidation/InvalidationGetResponse.php | 61 + .../InvalidationGetResponse/Status.php | 20 + .../Invalidation/InvalidationNewResponse.php | 54 + src/Client.php | 123 + src/Core.php | 9 + src/Core/Attributes/Api.php | 42 + src/Core/BaseClient.php | 222 ++ src/Core/Concerns/SdkEnum.php | 33 + src/Core/Concerns/SdkModel.php | 269 ++ src/Core/Concerns/SdkPage.php | 118 + src/Core/Concerns/SdkParams.php | 37 + src/Core/Concerns/SdkUnion.php | 40 + src/Core/Contracts/BaseModel.php | 18 + src/Core/Contracts/BasePage.php | 52 + src/Core/Contracts/BaseStream.php | 36 + src/Core/Conversion.php | 165 ++ src/Core/Conversion/CoerceState.php | 19 + src/Core/Conversion/Concerns/ArrayOf.php | 66 + src/Core/Conversion/Contracts/Converter.php | 24 + .../Conversion/Contracts/ConverterSource.php | 13 + src/Core/Conversion/DumpState.php | 15 + src/Core/Conversion/EnumOf.php | 46 + src/Core/Conversion/ListOf.php | 21 + src/Core/Conversion/MapOf.php | 16 + src/Core/Conversion/ModelOf.php | 128 + src/Core/Conversion/PropertyInfo.php | 76 + src/Core/Conversion/UnionOf.php | 96 + .../Exceptions/APIConnectionException.php | 9 + src/Core/Exceptions/APIException.php | 23 + src/Core/Exceptions/APIStatusException.php | 55 + src/Core/Exceptions/APITimeoutException.php | 19 + .../Exceptions/AuthenticationException.php | 9 + src/Core/Exceptions/BadRequestException.php | 9 + src/Core/Exceptions/ConflictException.php | 9 + src/Core/Exceptions/ImageKitException.php | 14 + .../Exceptions/InternalServerException.php | 9 + src/Core/Exceptions/NotFoundException.php | 9 + .../Exceptions/PermissionDeniedException.php | 9 + src/Core/Exceptions/RateLimitException.php | 9 + .../UnprocessableEntityException.php | 9 + src/Core/Implementation/Omit.php | 13 + .../Accounts/OriginsContract.php | 72 + .../Accounts/URLEndpointsContract.php | 77 + .../Accounts/UsageContract.php | 23 + .../ServiceContracts/AccountsContract.php | 7 + src/Core/ServiceContracts/AssetsContract.php | 61 + .../Beta/V2/FilesContract.php | 98 + src/Core/ServiceContracts/Beta/V2Contract.php | 7 + src/Core/ServiceContracts/BetaContract.php | 7 + .../Cache/InvalidationContract.php | 30 + src/Core/ServiceContracts/CacheContract.php | 7 + .../CustomMetadataFieldsContract.php | 63 + .../ServiceContracts/Files/BulkContract.php | 60 + .../Files/MetadataContract.php | 29 + .../Files/VersionsContract.php | 55 + src/Core/ServiceContracts/FilesContract.php | 206 ++ .../ServiceContracts/Folders/JobContract.php | 19 + src/Core/ServiceContracts/FoldersContract.php | 91 + .../ServiceContracts/WebhooksContract.php | 7 + src/Core/Services/Accounts/OriginsService.php | 149 + .../Services/Accounts/URLEndpointsService.php | 163 ++ src/Core/Services/Accounts/UsageService.php | 47 + src/Core/Services/AccountsService.php | 39 + src/Core/Services/AssetsService.php | 95 + src/Core/Services/Beta/V2/FilesService.php | 160 ++ src/Core/Services/Beta/V2Service.php | 25 + src/Core/Services/BetaService.php | 25 + .../Services/Cache/InvalidationService.php | 64 + src/Core/Services/CacheService.php | 25 + .../Services/CustomMetadataFieldsService.php | 132 + src/Core/Services/Files/BulkService.php | 139 + src/Core/Services/Files/MetadataService.php | 65 + src/Core/Services/Files/VersionsService.php | 129 + src/Core/Services/FilesService.php | 401 +++ src/Core/Services/Folders/JobService.php | 36 + src/Core/Services/FoldersService.php | 203 ++ src/Core/Services/WebhooksService.php | 16 + src/Core/Util.php | 445 +++ .../CustomMetadataField.php | 135 + .../CustomMetadataField/Schema.php | 234 ++ .../Schema/DefaultValue.php | 28 + .../Schema/DefaultValue/Mixed.php | 23 + .../CustomMetadataField/Schema/MaxValue.php | 26 + .../CustomMetadataField/Schema/MinValue.php | 26 + .../Schema/SelectOption.php | 23 + .../CustomMetadataField/Schema/Type.php | 30 + .../CustomMetadataFieldCreateParams.php | 113 + .../Schema.php | 232 ++ .../Schema/DefaultValue.php | 28 + .../Schema/DefaultValue/Mixed.php | 23 + .../Schema/MaxValue.php | 26 + .../Schema/MinValue.php | 26 + .../Schema/SelectOption.php | 23 + .../Schema/Type.php | 30 + .../CustomMetadataFieldDeleteResponse.php | 32 + .../CustomMetadataFieldListParams.php | 60 + .../CustomMetadataFieldUpdateParams.php | 83 + .../Schema.php | 193 ++ .../Schema/DefaultValue.php | 28 + .../Schema/DefaultValue/Mixed.php | 23 + .../Schema/MaxValue.php | 26 + .../Schema/MinValue.php | 26 + .../Schema/SelectOption.php | 23 + src/Files/Bulk/BulkAddTagsParams.php | 105 + src/Files/Bulk/BulkAddTagsResponse.php | 63 + src/Files/Bulk/BulkDeleteParams.php | 84 + src/Files/Bulk/BulkDeleteResponse.php | 63 + src/Files/Bulk/BulkRemoveAITagsParams.php | 105 + src/Files/Bulk/BulkRemoveAITagsResponse.php | 63 + src/Files/Bulk/BulkRemoveTagsParams.php | 105 + src/Files/Bulk/BulkRemoveTagsResponse.php | 63 + src/Files/File.php | 503 ++++ src/Files/File/AITag.php | 95 + src/Files/File/Type.php | 20 + src/Files/File/VersionInfo.php | 74 + src/Files/FileCopyParams.php | 118 + src/Files/FileCopyResponse.php | 32 + src/Files/FileMoveParams.php | 98 + src/Files/FileMoveResponse.php | 32 + src/Files/FileRenameParams.php | 144 + src/Files/FileRenameResponse.php | 54 + src/Files/FileUpdateParams.php | 60 + src/Files/FileUpdateParams/Update.php | 25 + .../Update/ChangePublicationStatus.php | 55 + .../ChangePublicationStatus/Publish.php | 93 + .../Update/UpdateFileDetails.php | 211 ++ .../Update/UpdateFileDetails/Extension.php | 35 + .../Extension/AIAutoDescription.php | 39 + .../Extension/AutoTaggingExtension.php | 119 + .../Extension/AutoTaggingExtension/Name.php | 20 + .../UpdateFileDetails/Extension/RemoveBg.php | 55 + .../Extension/RemoveBg/Options.php | 117 + .../Update/UpdateFileDetails/RemoveAITags.php | 31 + src/Files/FileUpdateResponse.php | 53 + .../FileUpdateResponse/ExtensionStatus.php | 118 + .../ExtensionStatus/AIAutoDescription.php | 19 + .../ExtensionStatus/AwsAutoTagging.php | 19 + .../ExtensionStatus/GoogleAutoTagging.php | 19 + .../ExtensionStatus/RemoveBg.php | 19 + src/Files/FileUploadParams.php | 655 +++++ src/Files/FileUploadParams/Extension.php | 35 + .../Extension/AIAutoDescription.php | 39 + .../Extension/AutoTaggingExtension.php | 119 + .../Extension/AutoTaggingExtension/Name.php | 20 + .../FileUploadParams/Extension/RemoveBg.php | 55 + .../Extension/RemoveBg/Options.php | 117 + src/Files/FileUploadParams/ResponseField.php | 27 + src/Files/FileUploadParams/Transformation.php | 99 + .../FileUploadParams/Transformation/Post.php | 37 + .../Transformation/Post/Abs.php | 101 + .../Transformation/Post/Abs/Protocol.php | 20 + .../Transformation/Post/GifToVideo.php | 62 + .../Transformation/Post/Thumbnail.php | 62 + .../Transformation/Post/Transformation.php | 76 + src/Files/FileUploadResponse.php | 555 ++++ src/Files/FileUploadResponse/AITag.php | 95 + .../FileUploadResponse/ExtensionStatus.php | 126 + .../ExtensionStatus/AIAutoDescription.php | 19 + .../ExtensionStatus/AwsAutoTagging.php | 19 + .../ExtensionStatus/GoogleAutoTagging.php | 19 + .../ExtensionStatus/RemoveBg.php | 19 + src/Files/FileUploadResponse/VersionInfo.php | 74 + src/Files/Folder.php | 164 ++ src/Files/Folder/Type.php | 18 + src/Files/Metadata.php | 314 +++ src/Files/Metadata/Exif.php | 163 ++ src/Files/Metadata/Exif/Exif.php | 406 +++ src/Files/Metadata/Exif/Gps.php | 56 + src/Files/Metadata/Exif/Image.php | 193 ++ src/Files/Metadata/Exif/Interoperability.php | 66 + src/Files/Metadata/Exif/Thumbnail.php | 123 + .../Metadata/MetadataGetFromURLParams.php | 74 + src/Files/Versions/VersionDeleteParams.php | 70 + src/Files/Versions/VersionDeleteResponse.php | 32 + src/Files/Versions/VersionGetParams.php | 68 + src/Files/Versions/VersionRestoreParams.php | 68 + src/Folders/FolderCopyParams.php | 116 + src/Folders/FolderCopyResponse.php | 70 + src/Folders/FolderCreateParams.php | 104 + src/Folders/FolderDeleteParams.php | 74 + src/Folders/FolderDeleteResponse.php | 32 + src/Folders/FolderMoveParams.php | 96 + src/Folders/FolderMoveResponse.php | 70 + src/Folders/FolderNewResponse.php | 32 + src/Folders/FolderRenameParams.php | 132 + src/Folders/FolderRenameResponse.php | 70 + src/Folders/Job/JobGetResponse.php | 130 + src/Folders/Job/JobGetResponse/Status.php | 20 + src/Folders/Job/JobGetResponse/Type.php | 22 + src/ImageKit/Configuration/Configuration.php | 30 - src/ImageKit/Constants/Endpoints.php | 263 -- src/ImageKit/Constants/ErrorMessages.php | 153 -- .../Constants/SupportedTransforms.php | 51 - src/ImageKit/ImageKit.php | 1205 --------- src/ImageKit/Manage/Cache.php | 89 - src/ImageKit/Manage/CustomMetadataFields.php | 242 -- src/ImageKit/Manage/File.php | 592 ---- src/ImageKit/Manage/Folder.php | 157 -- src/ImageKit/Phash/Phash.php | 52 - src/ImageKit/Resource/GuzzleHttpWrapper.php | 313 --- src/ImageKit/Resource/HttpRequest.php | 41 - src/ImageKit/Signature/Signature.php | 53 - src/ImageKit/Upload/Upload.php | 87 - src/ImageKit/Url/Url.php | 420 --- src/ImageKit/Utils/Authorization.php | 26 - src/ImageKit/Utils/Response.php | 71 - src/ImageKit/Utils/Transformation.php | 72 - src/ImageOverlay.php | 136 + src/ImageOverlay/Encoding.php | 25 + src/Overlay.php | 39 + src/OverlayPosition.php | 116 + src/OverlayPosition/Focus.php | 35 + src/OverlayPosition/X.php | 29 + src/OverlayPosition/Y.php | 29 + src/OverlayTiming.php | 117 + src/OverlayTiming/Duration.php | 29 + src/OverlayTiming/End.php | 30 + src/OverlayTiming/Start.php | 29 + src/RequestOptions.php | 219 ++ src/SolidColorOverlay.php | 106 + src/SolidColorOverlayTransformation.php | 165 ++ .../Gradient.php | 27 + .../Height.php | 27 + .../Radius.php | 27 + src/SolidColorOverlayTransformation/Width.php | 27 + src/SrcOptions.php | 243 ++ src/StreamingResolution.php | 30 + src/SubtitleOverlay.php | 134 + src/SubtitleOverlay/Encoding.php | 25 + src/SubtitleOverlayTransformation.php | 218 ++ .../Typography.php | 24 + src/TextOverlay.php | 134 + src/TextOverlay/Encoding.php | 25 + src/TextOverlayTransformation.php | 332 +++ src/TextOverlayTransformation/Flip.php | 24 + src/TextOverlayTransformation/FontSize.php | 26 + .../InnerAlignment.php | 22 + src/TextOverlayTransformation/LineHeight.php | 27 + src/TextOverlayTransformation/Padding.php | 28 + src/TextOverlayTransformation/Radius.php | 27 + src/TextOverlayTransformation/Rotation.php | 27 + src/TextOverlayTransformation/Width.php | 27 + src/Transformation.php | 1334 +++++++++ src/Transformation/AIDropShadow.php | 30 + src/Transformation/AIRemoveBackground.php | 20 + .../AIRemoveBackgroundExternal.php | 21 + src/Transformation/AIRetouch.php | 19 + src/Transformation/AIUpscale.php | 19 + src/Transformation/AIVariation.php | 20 + src/Transformation/AspectRatio.php | 28 + src/Transformation/AudioCodec.php | 22 + src/Transformation/ContrastStretch.php | 19 + src/Transformation/Crop.php | 26 + src/Transformation/CropMode.php | 22 + src/Transformation/Duration.php | 28 + src/Transformation/EndOffset.php | 28 + src/Transformation/Flip.php | 26 + src/Transformation/Format.php | 41 + src/Transformation/Gradient.php | 27 + src/Transformation/Grayscale.php | 18 + src/Transformation/Height.php | 28 + src/Transformation/Page.php | 29 + src/Transformation/Radius.php | 27 + src/Transformation/Rotation.php | 29 + src/Transformation/Shadow.php | 29 + src/Transformation/Sharpen.php | 28 + src/Transformation/StartOffset.php | 28 + src/Transformation/Trim.php | 28 + src/Transformation/UnsharpMask.php | 28 + src/Transformation/VideoCodec.php | 24 + src/Transformation/Width.php | 28 + src/Transformation/X.php | 26 + src/Transformation/XCenter.php | 26 + src/Transformation/Y.php | 26 + src/Transformation/YCenter.php | 26 + src/TransformationPosition.php | 22 + src/VideoOverlay.php | 136 + src/VideoOverlay/Encoding.php | 25 + src/Webhooks/UnsafeUnwrapWebhookEvent.php | 34 + src/Webhooks/UnwrapWebhookEvent.php | 34 + .../UploadPostTransformErrorEvent.php | 133 + .../UploadPostTransformErrorEvent/Data.php | 151 ++ .../Data/Transformation.php | 63 + .../Data/Transformation/Error.php | 68 + .../UploadPostTransformErrorEvent/Request.php | 85 + .../Request/Transformation.php | 123 + .../Request/Transformation/Protocol.php | 20 + .../Request/Transformation/Type.php | 24 + .../UploadPostTransformSuccessEvent.php | 133 + .../UploadPostTransformSuccessEvent/Data.php | 104 + .../Request.php | 85 + .../Request/Transformation.php | 123 + .../Request/Transformation/Protocol.php | 20 + .../Request/Transformation/Type.php | 24 + src/Webhooks/UploadPreTransformErrorEvent.php | 133 + .../UploadPreTransformErrorEvent/Data.php | 104 + .../Data/Transformation.php | 63 + .../Data/Transformation/Error.php | 68 + .../UploadPreTransformErrorEvent/Request.php | 88 + .../UploadPreTransformSuccessEvent.php | 139 + .../UploadPreTransformSuccessEvent/Data.php | 556 ++++ .../Data/AITag.php | 95 + .../Data/ExtensionStatus.php | 126 + .../ExtensionStatus/AIAutoDescription.php | 19 + .../Data/ExtensionStatus/AwsAutoTagging.php | 19 + .../ExtensionStatus/GoogleAutoTagging.php | 19 + .../Data/ExtensionStatus/RemoveBg.php | 19 + .../Data/VersionInfo.php | 74 + .../Request.php | 88 + .../VideoTransformationAcceptedEvent.php | 139 + .../VideoTransformationAcceptedEvent/Data.php | 90 + .../Data/Asset.php | 70 + .../Data/Transformation.php | 105 + .../Data/Transformation/Options.php | 209 ++ .../Transformation/Options/AudioCodec.php | 20 + .../Data/Transformation/Options/Format.php | 26 + .../Transformation/Options/StreamProtocol.php | 20 + .../Transformation/Options/VideoCodec.php | 22 + .../Data/Transformation/Type.php | 25 + .../Request.php | 112 + .../VideoTransformationErrorEvent.php | 139 + .../VideoTransformationErrorEvent/Data.php | 84 + .../Data/Asset.php | 70 + .../Data/Transformation.php | 125 + .../Data/Transformation/Error.php | 83 + .../Data/Transformation/Error/Reason.php | 25 + .../Data/Transformation/Options.php | 209 ++ .../Transformation/Options/AudioCodec.php | 20 + .../Data/Transformation/Options/Format.php | 26 + .../Transformation/Options/StreamProtocol.php | 20 + .../Transformation/Options/VideoCodec.php | 22 + .../Data/Transformation/Type.php | 25 + .../VideoTransformationErrorEvent/Request.php | 112 + .../VideoTransformationReadyEvent.php | 161 ++ .../VideoTransformationReadyEvent/Data.php | 84 + .../Data/Asset.php | 70 + .../Data/Transformation.php | 125 + .../Data/Transformation/Options.php | 209 ++ .../Transformation/Options/AudioCodec.php | 20 + .../Data/Transformation/Options/Format.php | 26 + .../Transformation/Options/StreamProtocol.php | 20 + .../Transformation/Options/VideoCodec.php | 22 + .../Data/Transformation/Output.php | 94 + .../Transformation/Output/VideoMetadata.php | 134 + .../Data/Transformation/Type.php | 25 + .../VideoTransformationReadyEvent/Request.php | 112 + .../VideoTransformationReadyEvent/Timings.php | 78 + tests/Core/TestModel.php | 180 ++ tests/ImageKit/ImageKitTest.php | 337 --- tests/ImageKit/Manage/CacheTest.php | 192 -- tests/ImageKit/Manage/CustomMetadataTest.php | 627 ----- tests/ImageKit/Manage/FileTest.php | 2035 -------------- tests/ImageKit/Manage/FolderTest.php | 565 ---- tests/ImageKit/Phash/PhashTest.php | 55 - .../Resource/GuzzleHttpWrapperTest.php | 41 - tests/ImageKit/Upload/UploadTest.php | 856 ------ tests/ImageKit/Url/UrlTest.php | 1283 --------- tests/Services/Accounts/OriginsTest.php | 153 ++ tests/Services/Accounts/URLEndpointsTest.php | 126 + tests/Services/Accounts/UsageTest.php | 62 + tests/Services/AssetsTest.php | 44 + tests/Services/Beta/V2/FilesTest.php | 62 + tests/Services/Cache/InvalidationTest.php | 72 + tests/Services/CustomMetadataFieldsTest.php | 108 + tests/Services/Files/BulkTest.php | 150 ++ tests/Services/Files/MetadataTest.php | 68 + tests/Services/Files/VersionsTest.php | 116 + tests/Services/FilesTest.php | 182 ++ tests/Services/Folders/JobTest.php | 44 + tests/Services/FoldersTest.php | 176 ++ tests/Services/WebhooksTest.php | 30 + tests/UnsupportedMockTests.php | 8 + 486 files changed, 35764 insertions(+), 14977 deletions(-) delete mode 100644 .editorconfig create mode 100644 .github/workflows/ci.yml delete mode 100644 .github/workflows/coverage.yml create mode 100644 .github/workflows/create-releases.yml create mode 100644 .github/workflows/release-doctor.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/wiki.yml create mode 100644 .php-cs-fixer.dist.php create mode 100644 .phpactor.json create mode 100644 .release-please-manifest.json create mode 100644 .stats.yml delete mode 100644 DEVELOPMENT.md create mode 100644 SECURITY.md create mode 100644 bin/check-release-environment delete mode 100644 composer.lock create mode 100644 phpstan.dist.neon create mode 100644 release-please-config.json delete mode 100644 sample/README.md delete mode 100644 sample/file_management/index.php delete mode 100644 sample/metadata/index.php delete mode 100644 sample/sample.php delete mode 100644 sample/sample_image.jpeg delete mode 100644 sample/upload_api/index.php delete mode 100644 sample/upload_api/sample_image.jpeg delete mode 100644 sample/url_generation/chained_transformations.php delete mode 100644 sample/url_generation/image_enhancement_and_color_manipulation.php delete mode 100644 sample/url_generation/index.php delete mode 100644 sample/url_generation/resize_crop_other_common_transformations.php delete mode 100644 sample/url_generation/signed_url.php delete mode 100644 sample/utility/index.php create mode 100755 scripts/bootstrap create mode 100755 scripts/clean create mode 100755 scripts/format create mode 100755 scripts/lint create mode 100755 scripts/mock create mode 100755 scripts/test create mode 100644 src/Accounts/Origins/OriginCreateParams.php create mode 100644 src/Accounts/Origins/OriginRequest.php create mode 100644 src/Accounts/Origins/OriginRequest/AkeneoPim.php create mode 100644 src/Accounts/Origins/OriginRequest/AzureBlob.php create mode 100644 src/Accounts/Origins/OriginRequest/CloudinaryBackup.php create mode 100644 src/Accounts/Origins/OriginRequest/Gcs.php create mode 100644 src/Accounts/Origins/OriginRequest/S3.php create mode 100644 src/Accounts/Origins/OriginRequest/S3Compatible.php create mode 100644 src/Accounts/Origins/OriginRequest/WebFolder.php create mode 100644 src/Accounts/Origins/OriginRequest/WebProxy.php create mode 100644 src/Accounts/Origins/OriginResponse.php create mode 100644 src/Accounts/Origins/OriginResponse/AkeneoPim.php create mode 100644 src/Accounts/Origins/OriginResponse/AzureBlob.php create mode 100644 src/Accounts/Origins/OriginResponse/CloudinaryBackup.php create mode 100644 src/Accounts/Origins/OriginResponse/Gcs.php create mode 100644 src/Accounts/Origins/OriginResponse/S3.php create mode 100644 src/Accounts/Origins/OriginResponse/S3Compatible.php create mode 100644 src/Accounts/Origins/OriginResponse/WebFolder.php create mode 100644 src/Accounts/Origins/OriginResponse/WebProxy.php create mode 100644 src/Accounts/Origins/OriginUpdateParams.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointCreateParams.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Akamai.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Imgix.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointRequest.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Akamai.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Imgix.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointResponse.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Akamai.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Cloudinary.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Imgix.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointUpdateParams.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Akamai.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php create mode 100644 src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Imgix.php create mode 100644 src/Accounts/Usage/UsageGetParams.php create mode 100644 src/Accounts/Usage/UsageGetResponse.php create mode 100644 src/Assets/AssetListParams.php create mode 100644 src/Assets/AssetListParams/FileType.php create mode 100644 src/Assets/AssetListParams/Sort.php create mode 100644 src/Assets/AssetListParams/Type.php create mode 100644 src/Assets/AssetListResponseItem.php create mode 100644 src/BaseOverlay.php create mode 100644 src/Beta/V2/Files/FileUploadParams.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php create mode 100644 src/Beta/V2/Files/FileUploadParams/ResponseField.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post/GifToVideo.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php create mode 100644 src/Beta/V2/Files/FileUploadParams/Transformation/Post/Transformation.php create mode 100644 src/Beta/V2/Files/FileUploadResponse.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/AITag.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php create mode 100644 src/Beta/V2/Files/FileUploadResponse/VersionInfo.php create mode 100644 src/Cache/Invalidation/InvalidationCreateParams.php create mode 100644 src/Cache/Invalidation/InvalidationGetResponse.php create mode 100644 src/Cache/Invalidation/InvalidationGetResponse/Status.php create mode 100644 src/Cache/Invalidation/InvalidationNewResponse.php create mode 100644 src/Client.php create mode 100644 src/Core.php create mode 100644 src/Core/Attributes/Api.php create mode 100644 src/Core/BaseClient.php create mode 100644 src/Core/Concerns/SdkEnum.php create mode 100644 src/Core/Concerns/SdkModel.php create mode 100644 src/Core/Concerns/SdkPage.php create mode 100644 src/Core/Concerns/SdkParams.php create mode 100644 src/Core/Concerns/SdkUnion.php create mode 100644 src/Core/Contracts/BaseModel.php create mode 100644 src/Core/Contracts/BasePage.php create mode 100644 src/Core/Contracts/BaseStream.php create mode 100644 src/Core/Conversion.php create mode 100644 src/Core/Conversion/CoerceState.php create mode 100644 src/Core/Conversion/Concerns/ArrayOf.php create mode 100644 src/Core/Conversion/Contracts/Converter.php create mode 100644 src/Core/Conversion/Contracts/ConverterSource.php create mode 100644 src/Core/Conversion/DumpState.php create mode 100644 src/Core/Conversion/EnumOf.php create mode 100644 src/Core/Conversion/ListOf.php create mode 100644 src/Core/Conversion/MapOf.php create mode 100644 src/Core/Conversion/ModelOf.php create mode 100644 src/Core/Conversion/PropertyInfo.php create mode 100644 src/Core/Conversion/UnionOf.php create mode 100644 src/Core/Exceptions/APIConnectionException.php create mode 100644 src/Core/Exceptions/APIException.php create mode 100644 src/Core/Exceptions/APIStatusException.php create mode 100644 src/Core/Exceptions/APITimeoutException.php create mode 100644 src/Core/Exceptions/AuthenticationException.php create mode 100644 src/Core/Exceptions/BadRequestException.php create mode 100644 src/Core/Exceptions/ConflictException.php create mode 100644 src/Core/Exceptions/ImageKitException.php create mode 100644 src/Core/Exceptions/InternalServerException.php create mode 100644 src/Core/Exceptions/NotFoundException.php create mode 100644 src/Core/Exceptions/PermissionDeniedException.php create mode 100644 src/Core/Exceptions/RateLimitException.php create mode 100644 src/Core/Exceptions/UnprocessableEntityException.php create mode 100644 src/Core/Implementation/Omit.php create mode 100644 src/Core/ServiceContracts/Accounts/OriginsContract.php create mode 100644 src/Core/ServiceContracts/Accounts/URLEndpointsContract.php create mode 100644 src/Core/ServiceContracts/Accounts/UsageContract.php create mode 100644 src/Core/ServiceContracts/AccountsContract.php create mode 100644 src/Core/ServiceContracts/AssetsContract.php create mode 100644 src/Core/ServiceContracts/Beta/V2/FilesContract.php create mode 100644 src/Core/ServiceContracts/Beta/V2Contract.php create mode 100644 src/Core/ServiceContracts/BetaContract.php create mode 100644 src/Core/ServiceContracts/Cache/InvalidationContract.php create mode 100644 src/Core/ServiceContracts/CacheContract.php create mode 100644 src/Core/ServiceContracts/CustomMetadataFieldsContract.php create mode 100644 src/Core/ServiceContracts/Files/BulkContract.php create mode 100644 src/Core/ServiceContracts/Files/MetadataContract.php create mode 100644 src/Core/ServiceContracts/Files/VersionsContract.php create mode 100644 src/Core/ServiceContracts/FilesContract.php create mode 100644 src/Core/ServiceContracts/Folders/JobContract.php create mode 100644 src/Core/ServiceContracts/FoldersContract.php create mode 100644 src/Core/ServiceContracts/WebhooksContract.php create mode 100644 src/Core/Services/Accounts/OriginsService.php create mode 100644 src/Core/Services/Accounts/URLEndpointsService.php create mode 100644 src/Core/Services/Accounts/UsageService.php create mode 100644 src/Core/Services/AccountsService.php create mode 100644 src/Core/Services/AssetsService.php create mode 100644 src/Core/Services/Beta/V2/FilesService.php create mode 100644 src/Core/Services/Beta/V2Service.php create mode 100644 src/Core/Services/BetaService.php create mode 100644 src/Core/Services/Cache/InvalidationService.php create mode 100644 src/Core/Services/CacheService.php create mode 100644 src/Core/Services/CustomMetadataFieldsService.php create mode 100644 src/Core/Services/Files/BulkService.php create mode 100644 src/Core/Services/Files/MetadataService.php create mode 100644 src/Core/Services/Files/VersionsService.php create mode 100644 src/Core/Services/FilesService.php create mode 100644 src/Core/Services/Folders/JobService.php create mode 100644 src/Core/Services/FoldersService.php create mode 100644 src/Core/Services/WebhooksService.php create mode 100644 src/Core/Util.php create mode 100644 src/CustomMetadataFields/CustomMetadataField.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue/Mixed.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/MaxValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/MinValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/SelectOption.php create mode 100644 src/CustomMetadataFields/CustomMetadataField/Schema/Type.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue/Mixed.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MaxValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MinValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/SelectOption.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldListParams.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue/Mixed.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MaxValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MinValue.php create mode 100644 src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/SelectOption.php create mode 100644 src/Files/Bulk/BulkAddTagsParams.php create mode 100644 src/Files/Bulk/BulkAddTagsResponse.php create mode 100644 src/Files/Bulk/BulkDeleteParams.php create mode 100644 src/Files/Bulk/BulkDeleteResponse.php create mode 100644 src/Files/Bulk/BulkRemoveAITagsParams.php create mode 100644 src/Files/Bulk/BulkRemoveAITagsResponse.php create mode 100644 src/Files/Bulk/BulkRemoveTagsParams.php create mode 100644 src/Files/Bulk/BulkRemoveTagsResponse.php create mode 100644 src/Files/File.php create mode 100644 src/Files/File/AITag.php create mode 100644 src/Files/File/Type.php create mode 100644 src/Files/File/VersionInfo.php create mode 100644 src/Files/FileCopyParams.php create mode 100644 src/Files/FileCopyResponse.php create mode 100644 src/Files/FileMoveParams.php create mode 100644 src/Files/FileMoveResponse.php create mode 100644 src/Files/FileRenameParams.php create mode 100644 src/Files/FileRenameResponse.php create mode 100644 src/Files/FileUpdateParams.php create mode 100644 src/Files/FileUpdateParams/Update.php create mode 100644 src/Files/FileUpdateParams/Update/ChangePublicationStatus.php create mode 100644 src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php create mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php create mode 100644 src/Files/FileUpdateResponse.php create mode 100644 src/Files/FileUpdateResponse/ExtensionStatus.php create mode 100644 src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php create mode 100644 src/Files/FileUpdateResponse/ExtensionStatus/AwsAutoTagging.php create mode 100644 src/Files/FileUpdateResponse/ExtensionStatus/GoogleAutoTagging.php create mode 100644 src/Files/FileUpdateResponse/ExtensionStatus/RemoveBg.php create mode 100644 src/Files/FileUploadParams.php create mode 100644 src/Files/FileUploadParams/Extension.php create mode 100644 src/Files/FileUploadParams/Extension/AIAutoDescription.php create mode 100644 src/Files/FileUploadParams/Extension/AutoTaggingExtension.php create mode 100644 src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php create mode 100644 src/Files/FileUploadParams/Extension/RemoveBg.php create mode 100644 src/Files/FileUploadParams/Extension/RemoveBg/Options.php create mode 100644 src/Files/FileUploadParams/ResponseField.php create mode 100644 src/Files/FileUploadParams/Transformation.php create mode 100644 src/Files/FileUploadParams/Transformation/Post.php create mode 100644 src/Files/FileUploadParams/Transformation/Post/Abs.php create mode 100644 src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php create mode 100644 src/Files/FileUploadParams/Transformation/Post/GifToVideo.php create mode 100644 src/Files/FileUploadParams/Transformation/Post/Thumbnail.php create mode 100644 src/Files/FileUploadParams/Transformation/Post/Transformation.php create mode 100644 src/Files/FileUploadResponse.php create mode 100644 src/Files/FileUploadResponse/AITag.php create mode 100644 src/Files/FileUploadResponse/ExtensionStatus.php create mode 100644 src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php create mode 100644 src/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php create mode 100644 src/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php create mode 100644 src/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php create mode 100644 src/Files/FileUploadResponse/VersionInfo.php create mode 100644 src/Files/Folder.php create mode 100644 src/Files/Folder/Type.php create mode 100644 src/Files/Metadata.php create mode 100644 src/Files/Metadata/Exif.php create mode 100644 src/Files/Metadata/Exif/Exif.php create mode 100644 src/Files/Metadata/Exif/Gps.php create mode 100644 src/Files/Metadata/Exif/Image.php create mode 100644 src/Files/Metadata/Exif/Interoperability.php create mode 100644 src/Files/Metadata/Exif/Thumbnail.php create mode 100644 src/Files/Metadata/MetadataGetFromURLParams.php create mode 100644 src/Files/Versions/VersionDeleteParams.php create mode 100644 src/Files/Versions/VersionDeleteResponse.php create mode 100644 src/Files/Versions/VersionGetParams.php create mode 100644 src/Files/Versions/VersionRestoreParams.php create mode 100644 src/Folders/FolderCopyParams.php create mode 100644 src/Folders/FolderCopyResponse.php create mode 100644 src/Folders/FolderCreateParams.php create mode 100644 src/Folders/FolderDeleteParams.php create mode 100644 src/Folders/FolderDeleteResponse.php create mode 100644 src/Folders/FolderMoveParams.php create mode 100644 src/Folders/FolderMoveResponse.php create mode 100644 src/Folders/FolderNewResponse.php create mode 100644 src/Folders/FolderRenameParams.php create mode 100644 src/Folders/FolderRenameResponse.php create mode 100644 src/Folders/Job/JobGetResponse.php create mode 100644 src/Folders/Job/JobGetResponse/Status.php create mode 100644 src/Folders/Job/JobGetResponse/Type.php delete mode 100644 src/ImageKit/Configuration/Configuration.php delete mode 100644 src/ImageKit/Constants/Endpoints.php delete mode 100644 src/ImageKit/Constants/ErrorMessages.php delete mode 100644 src/ImageKit/Constants/SupportedTransforms.php delete mode 100644 src/ImageKit/ImageKit.php delete mode 100644 src/ImageKit/Manage/Cache.php delete mode 100644 src/ImageKit/Manage/CustomMetadataFields.php delete mode 100644 src/ImageKit/Manage/File.php delete mode 100644 src/ImageKit/Manage/Folder.php delete mode 100644 src/ImageKit/Phash/Phash.php delete mode 100644 src/ImageKit/Resource/GuzzleHttpWrapper.php delete mode 100644 src/ImageKit/Resource/HttpRequest.php delete mode 100644 src/ImageKit/Signature/Signature.php delete mode 100644 src/ImageKit/Upload/Upload.php delete mode 100644 src/ImageKit/Url/Url.php delete mode 100644 src/ImageKit/Utils/Authorization.php delete mode 100644 src/ImageKit/Utils/Response.php delete mode 100644 src/ImageKit/Utils/Transformation.php create mode 100644 src/ImageOverlay.php create mode 100644 src/ImageOverlay/Encoding.php create mode 100644 src/Overlay.php create mode 100644 src/OverlayPosition.php create mode 100644 src/OverlayPosition/Focus.php create mode 100644 src/OverlayPosition/X.php create mode 100644 src/OverlayPosition/Y.php create mode 100644 src/OverlayTiming.php create mode 100644 src/OverlayTiming/Duration.php create mode 100644 src/OverlayTiming/End.php create mode 100644 src/OverlayTiming/Start.php create mode 100644 src/RequestOptions.php create mode 100644 src/SolidColorOverlay.php create mode 100644 src/SolidColorOverlayTransformation.php create mode 100644 src/SolidColorOverlayTransformation/Gradient.php create mode 100644 src/SolidColorOverlayTransformation/Height.php create mode 100644 src/SolidColorOverlayTransformation/Radius.php create mode 100644 src/SolidColorOverlayTransformation/Width.php create mode 100644 src/SrcOptions.php create mode 100644 src/StreamingResolution.php create mode 100644 src/SubtitleOverlay.php create mode 100644 src/SubtitleOverlay/Encoding.php create mode 100644 src/SubtitleOverlayTransformation.php create mode 100644 src/SubtitleOverlayTransformation/Typography.php create mode 100644 src/TextOverlay.php create mode 100644 src/TextOverlay/Encoding.php create mode 100644 src/TextOverlayTransformation.php create mode 100644 src/TextOverlayTransformation/Flip.php create mode 100644 src/TextOverlayTransformation/FontSize.php create mode 100644 src/TextOverlayTransformation/InnerAlignment.php create mode 100644 src/TextOverlayTransformation/LineHeight.php create mode 100644 src/TextOverlayTransformation/Padding.php create mode 100644 src/TextOverlayTransformation/Radius.php create mode 100644 src/TextOverlayTransformation/Rotation.php create mode 100644 src/TextOverlayTransformation/Width.php create mode 100644 src/Transformation.php create mode 100644 src/Transformation/AIDropShadow.php create mode 100644 src/Transformation/AIRemoveBackground.php create mode 100644 src/Transformation/AIRemoveBackgroundExternal.php create mode 100644 src/Transformation/AIRetouch.php create mode 100644 src/Transformation/AIUpscale.php create mode 100644 src/Transformation/AIVariation.php create mode 100644 src/Transformation/AspectRatio.php create mode 100644 src/Transformation/AudioCodec.php create mode 100644 src/Transformation/ContrastStretch.php create mode 100644 src/Transformation/Crop.php create mode 100644 src/Transformation/CropMode.php create mode 100644 src/Transformation/Duration.php create mode 100644 src/Transformation/EndOffset.php create mode 100644 src/Transformation/Flip.php create mode 100644 src/Transformation/Format.php create mode 100644 src/Transformation/Gradient.php create mode 100644 src/Transformation/Grayscale.php create mode 100644 src/Transformation/Height.php create mode 100644 src/Transformation/Page.php create mode 100644 src/Transformation/Radius.php create mode 100644 src/Transformation/Rotation.php create mode 100644 src/Transformation/Shadow.php create mode 100644 src/Transformation/Sharpen.php create mode 100644 src/Transformation/StartOffset.php create mode 100644 src/Transformation/Trim.php create mode 100644 src/Transformation/UnsharpMask.php create mode 100644 src/Transformation/VideoCodec.php create mode 100644 src/Transformation/Width.php create mode 100644 src/Transformation/X.php create mode 100644 src/Transformation/XCenter.php create mode 100644 src/Transformation/Y.php create mode 100644 src/Transformation/YCenter.php create mode 100644 src/TransformationPosition.php create mode 100644 src/VideoOverlay.php create mode 100644 src/VideoOverlay/Encoding.php create mode 100644 src/Webhooks/UnsafeUnwrapWebhookEvent.php create mode 100644 src/Webhooks/UnwrapWebhookEvent.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Data.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation/Error.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Request.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php create mode 100644 src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Type.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent/Data.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent/Request.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php create mode 100644 src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Type.php create mode 100644 src/Webhooks/UploadPreTransformErrorEvent.php create mode 100644 src/Webhooks/UploadPreTransformErrorEvent/Data.php create mode 100644 src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation.php create mode 100644 src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation/Error.php create mode 100644 src/Webhooks/UploadPreTransformErrorEvent/Request.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AwsAutoTagging.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/GoogleAutoTagging.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/RemoveBg.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Data/VersionInfo.php create mode 100644 src/Webhooks/UploadPreTransformSuccessEvent/Request.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Asset.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/Format.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/StreamProtocol.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/VideoCodec.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Type.php create mode 100644 src/Webhooks/VideoTransformationAcceptedEvent/Request.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Asset.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/Format.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/StreamProtocol.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/VideoCodec.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Type.php create mode 100644 src/Webhooks/VideoTransformationErrorEvent/Request.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Asset.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/Format.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/StreamProtocol.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/VideoCodec.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output/VideoMetadata.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Request.php create mode 100644 src/Webhooks/VideoTransformationReadyEvent/Timings.php create mode 100644 tests/Core/TestModel.php delete mode 100644 tests/ImageKit/ImageKitTest.php delete mode 100644 tests/ImageKit/Manage/CacheTest.php delete mode 100644 tests/ImageKit/Manage/CustomMetadataTest.php delete mode 100644 tests/ImageKit/Manage/FileTest.php delete mode 100644 tests/ImageKit/Manage/FolderTest.php delete mode 100644 tests/ImageKit/Phash/PhashTest.php delete mode 100644 tests/ImageKit/Resource/GuzzleHttpWrapperTest.php delete mode 100644 tests/ImageKit/Upload/UploadTest.php delete mode 100644 tests/ImageKit/Url/UrlTest.php create mode 100644 tests/Services/Accounts/OriginsTest.php create mode 100644 tests/Services/Accounts/URLEndpointsTest.php create mode 100644 tests/Services/Accounts/UsageTest.php create mode 100644 tests/Services/AssetsTest.php create mode 100644 tests/Services/Beta/V2/FilesTest.php create mode 100644 tests/Services/Cache/InvalidationTest.php create mode 100644 tests/Services/CustomMetadataFieldsTest.php create mode 100644 tests/Services/Files/BulkTest.php create mode 100644 tests/Services/Files/MetadataTest.php create mode 100644 tests/Services/Files/VersionsTest.php create mode 100644 tests/Services/FilesTest.php create mode 100644 tests/Services/Folders/JobTest.php create mode 100644 tests/Services/FoldersTest.php create mode 100644 tests/Services/WebhooksTest.php create mode 100644 tests/UnsupportedMockTests.php diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index e27be283..00000000 --- a/.editorconfig +++ /dev/null @@ -1,15 +0,0 @@ -# This file is for unifying the coding style for different editors and IDEs -# editorconfig.org - -root = true - -[*] -charset = utf-8 -end_of_line = lf -insert_final_newline = true -trim_trailing_whitespace = true -indent_style = space -indent_size = 4 - -[*.md] -trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes index 4c4dbe73..e69de29b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,10 +0,0 @@ -# Path-based git attributes -# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html - -# Ignore all test and documentation with "export-ignore". -/.gitattributes export-ignore -/.gitignore export-ignore -/.travis.yml export-ignore -/phpunit.xml.dist export-ignore -/scrutinizer.yml export-ignore -/tests export-ignore diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 00000000..aed6777f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,52 @@ +name: CI +on: + push: + branches-ignore: + - 'generated' + - 'codegen/**' + - 'integrated/**' + - 'stl-preview-head/**' + - 'stl-preview-base/**' + pull_request: + branches-ignore: + - 'stl-preview-head/**' + - 'stl-preview-base/**' + +jobs: + lint: + timeout-minutes: 10 + name: lint + runs-on: ${{ github.repository == 'stainless-sdks/imagekit-php' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + + steps: + - uses: actions/checkout@v4 + + - name: Set up PHP + uses: 'shivammathur/setup-php@v2' + with: + php-version: '8.3' + + - name: Run Bootstrap + run: ./scripts/bootstrap + + - name: Run lints + run: ./scripts/lint + test: + timeout-minutes: 10 + name: test + runs-on: ${{ github.repository == 'stainless-sdks/imagekit-php' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + steps: + - uses: actions/checkout@v4 + + - name: Set up PHP + uses: 'shivammathur/setup-php@v2' + with: + php-version: '8.3' + + - name: Run bootstrap + run: ./scripts/bootstrap + + - name: Run tests + run: ./scripts/test diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml deleted file mode 100644 index 8cba38a5..00000000 --- a/.github/workflows/coverage.yml +++ /dev/null @@ -1,29 +0,0 @@ -name: PHP Coverage CI - -on: [ push, pull_request ] - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v1 - - name: Setup PHP - uses: shivammathur/setup-php@v2 - with: - php-version: '8.0' - - - name: Validate composer.json and composer.lock - run: composer validate - - - name: Install dependencies - run: composer install --prefer-dist --no-progress --no-suggest - - # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" - # Docs: https://getcomposer.org/doc/articles/scripts.md - - - name: Run test suite - run: ./vendor/bin/phpunit --coverage-clover coverage.xml - - - name: Upload to codecov - run: bash <(curl -s https://codecov.io/bash) diff --git a/.github/workflows/create-releases.yml b/.github/workflows/create-releases.yml new file mode 100644 index 00000000..8e723adf --- /dev/null +++ b/.github/workflows/create-releases.yml @@ -0,0 +1,30 @@ +name: Create releases +on: + schedule: + - cron: '0 5 * * *' # every day at 5am UTC + push: + branches: + - main + +jobs: + release: + name: release + if: github.ref == 'refs/heads/main' && github.repository == 'stainless-sdks/imagekit-php' + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - uses: stainless-api/trigger-release-please@v1 + id: release + with: + repo: ${{ github.event.repository.full_name }} + stainless-api-key: ${{ secrets.STAINLESS_API_KEY }} + + - name: Publish to Packagist + if: ${{ steps.release.outputs.releases_created }} + run: |- + curl --fail-with-body -X POST -H 'Content-Type: application/json' "https://packagist.org/api/update-package?username=${PACKAGIST_USERNAME}&apiToken=${PACKAGIST_SAFE_KEY}" -d '{"repository":"https://www.github.com/stainless-sdks/imagekit-php"}' + env: + PACKAGIST_USERNAME: ${{ secrets.IMAGE_KIT_PACKAGIST_USERNAME || secrets.PACKAGIST_USERNAME }} + PACKAGIST_SAFE_KEY: ${{ secrets.IMAGE_KIT_PACKAGIST_SAFE_KEY || secrets.PACKAGIST_SAFE_KEY }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml new file mode 100644 index 00000000..c789d348 --- /dev/null +++ b/.github/workflows/release-doctor.yml @@ -0,0 +1,21 @@ +name: Release Doctor +on: + pull_request: + branches: + - main + workflow_dispatch: + +jobs: + release_doctor: + name: release doctor + runs-on: ubuntu-latest + if: github.repository == 'stainless-sdks/imagekit-php' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + + steps: + - uses: actions/checkout@v4 + + - name: Check release environment + run: | + bash ./bin/check-release-environment + env: + STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml deleted file mode 100644 index eded823b..00000000 --- a/.github/workflows/test.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: PHP Test CI - -on: [ push, pull_request ] - -jobs: - build: - runs-on: ${{ matrix.operating-system }} - strategy: - matrix: - operating-system: [ 'ubuntu-latest', 'windows-latest', 'macos-latest' ] - php-versions: [ '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0' ] - phpunit-versions: [ 'latest' ] - steps: - - uses: actions/checkout@v1 - - - name: Setup PHP - uses: shivammathur/setup-php@v2 - with: - php-version: '${{ matrix.php-versions }}' - - - name: Validate composer.json and composer.lock - run: composer validate - - - name: Install dependencies - run: composer install --prefer-dist --no-progress --no-suggest - - # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit" - # Docs: https://getcomposer.org/doc/articles/scripts.md - - - name: Run test suite - run: ./vendor/bin/phpunit diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml deleted file mode 100644 index 85568a30..00000000 --- a/.github/workflows/wiki.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Automatic update project documentation - -on: - push: - branches: - - master - tags: - - '*' - -jobs: - update_wiki: - runs-on: ubuntu-latest - steps: - - name: Checkouting project code... - uses: actions/checkout@v2 - - name: Updating wiki... - uses: impresscms-dev/phpdocs-wiki-update-action@v1.0.0 - with: - wiki_github_update_token: ${{ secrets.WIKI_GITHUB_UPDATE_TOKEN }} - wiki_github_update_user: ${{ secrets.WIKI_GITHUB_UPDATE_USER }} - engine: clean/phpdoc-md - class_root_namespace: ImageKit - include: | - ImageKit\** diff --git a/.gitignore b/.gitignore index 5f842560..6739884e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,42 +1,11 @@ -# IntelliJ - PhpStorm and PyCharm -.idea -*.iml -*.ipr -*.iws - -# Netbeans -nbproject -.nbproject -.nbproject/* -nbproject/* -nbproject/private/ -build/ -nbbuild/ -dist/ -nbdist/ -nbactions.xml -nb-configuration.xml - -# Mac OSX -.DS_Store -# Thumbnails -._* -# Files that might appear on external disk -.Spotlight-V100 -.Trashes - -# SublimeText project files -/*.sublime-project -*.sublime-workspace - -build -docs -vendor -composer.phar +composer.lock +docs/ +.idea/ +.php-cs-fixer.cache +.php-cs-fixer.php +.phpunit.cache phpunit.xml -.vscode -.phpunit* -sample/vendor -sample/composer.lock - -*.phar +playground/ +*.swo +*.swp +vendor/ diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 00000000..a2b062b9 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,17 @@ +setParallelConfig(ParallelConfigFactory::detect()) + ->setFinder(Finder::create()->in([__DIR__.'/src', __DIR__.'/tests'])) + ->setRules([ + '@PhpCsFixer' => true, + 'phpdoc_align' => false, + 'new_with_parentheses' => ['named_class' => false], + 'ordered_types' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'], + 'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'], + ]) +; diff --git a/.phpactor.json b/.phpactor.json new file mode 100644 index 00000000..97fdd060 --- /dev/null +++ b/.phpactor.json @@ -0,0 +1,6 @@ +{ + "indexer.exclude_patterns": ["vendor"], + "language_server_completion.trim_leading_dollar": true, + "language_server_php_cs_fixer.enabled": false, + "language_server_phpstan.enabled": true +} diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 00000000..1332969b --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.0.1" +} \ No newline at end of file diff --git a/.stats.yml b/.stats.yml new file mode 100644 index 00000000..ad85869b --- /dev/null +++ b/.stats.yml @@ -0,0 +1,4 @@ +configured_endpoints: 42 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml +openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886 +config_hash: cf9d50fe62973f4e91ef65c147aabcc1 diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md deleted file mode 100644 index 2f857ed7..00000000 --- a/DEVELOPMENT.md +++ /dev/null @@ -1,25 +0,0 @@ -## Installing dependencies - -Install the project dependencies by running the following command in terminal - -``` -composer install -``` - -## Running the tests - -``` -vendor/bin/phpunit -``` - -## Sample Code Instruction - -To run sample code go to the sample directory and run - -``` -php sample.php -``` - -## Support - -For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io) \ No newline at end of file diff --git a/LICENSE b/LICENSE index 8b976bea..e7a4d160 100644 --- a/LICENSE +++ b/LICENSE @@ -1,20 +1,201 @@ -MIT License - -Copyright (c) 2020 Imagekit - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 Image Kit + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 69c9d458..4a52aaa4 100644 --- a/README.md +++ b/README.md @@ -1,1238 +1,187 @@ -# PHP SDK for ImageKit +# Image Kit PHP API library -[![Packagist](https://img.shields.io/packagist/v/imagekit/imagekit.svg)](https://packagist.org/packages/imagekit/imagekit) [![Packagist](https://img.shields.io/packagist/dt/imagekit/imagekit.svg)](https://packagist.org/packages/imagekit/imagekit) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![codecov](https://codecov.io/gh/imagekit-developer/imagekit-php/branch/master/graph/badge.svg)](https://codecov.io/gh/imagekit-developer/imagekit-php) [![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo) -[![PHP Test CI](https://github.com/imagekit-developer/imagekit-php/actions/workflows/test.yml/badge.svg)](https://github.com/imagekit-developer/imagekit-php/actions/workflows/test.yml) [![PHP Coverage CI](https://github.com/imagekit-developer/imagekit-php/actions/workflows/coverage.yml/badge.svg)](https://github.com/imagekit-developer/imagekit-php/actions/workflows/coverage.yml) [![Wiki Documentation](https://img.shields.io/badge/wiki-documentation-forestgreen)](https://github.com/imagekit-developer/imagekit-php/wiki) +> [!NOTE] +> The Image Kit PHP API Library is currently in **beta** and we're excited for you to experiment with it! +> +> This library has not yet been exhaustively tested in production environments and may be missing some features you'd expect in a stable release. As we continue development, there may be breaking changes that require updates to your code. +> +> **We'd love your feedback!** Please share any suggestions, bug reports, feature requests, or general thoughts by [filing an issue](https://www.github.com/stainless-sdks/imagekit-php/issues/new). -PHP SDK for [ImageKit](https://imagekit.io/) implements the new APIs and interface for different file operations. +The Image Kit PHP library provides convenient access to the Image Kit REST API from any PHP 8.1.0+ application. -ImageKit is complete media storage, optimization, and transformation solution that comes with an [image and video CDN](https://imagekit.io/). It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes. +It is generated with [Stainless](https://www.stainless.com/). -- [Key Features](#key-features) -- [Requirements](#requirements) -- [Version Support](#version-support) -- [Breaking changes](#breaking-changes) -- [Installation](#installation) -- [Usage](#usage) -- [Getting Started](#getting-started) -- [Quick Examples](#quick-examples) - * [Create an ImageKit Instance](#create-an-imagekit-instance) - * [URL Generation](#url-generation) - * [File Upload](#file-upload) -- [Demo Application](#demo-application) -- [URL Generation](#url-generation-1) -- [Signed URL & Image Transformations](#applying-chained-transformations-common-image-manipulations--signed-url) -- [Server-side File Upload](#server-side-file-upload) -- [File Management](#file-management) -- [Custom Metadata Fields API](#custom-metadata-fields-api) -- [Utility Function](#utility-functions) -- [Opening Issues](#opening-issues) -- [Support](#support) -- [Resources](#resources) -- [License](#license) +## Documentation -## Key Features -- [URL Generation](#url-generation) -- [Transformations](#1-chained-transformations-as-a-query-parameter) -- [Secure URLS](#6-signed-url) -- [File Upload](#server-side-file-upload) -- [File Management](#file-management) - -## Requirements -* PHP 5.6+ -* [JSON PHP Extension](https://www.php.net/manual/en/book.json.php) -* [cURL PHP Extension](https://www.php.net/manual/en/book.curl.php) - -## Version Support -| SDK Version | PHP 5.4 | PHP 5.5 | PHP 5.6 | PHP 7.x | PHP 8.x | -|-------------|---------|---------|---------|---------|---------| -| 4.x | ❌ | ❌ | ✔️ | ✔️ |✔️ | -| 3.x | ❌ | ❌ | ✔️ | ✔️ |✔️ | -| 2.x | ❌ | ❌ | ✔️ | ✔️ |✔️ | -| 1.x | ❌ | ✔️ | ✔️ | ✔️ |✔️ | - -## Breaking changes - -### Upgrading from 3.x to 4.x version - -1. Overlay syntax update - -* In version 4.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly. -* You can migrate to the new layers syntax using the `raw` transformation parameter. +The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs). ## Installation -You can install the bindings via [Composer](http://getcomposer.org/). Run the following command: - -```bash -composer require imagekit/imagekit -``` -To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading): -```php -require_once('vendor/autoload.php'); -``` - -## Usage - -You can use this PHP SDK for three different methods - URL generation, file upload, and file management. The usage of the SDK has been explained below. - -* `URL Generation` -* `File Upload` -* `File Management` - -## Getting Started -1. **Sign up for ImageKit** – Before you begin, you need to sign up for an [ImageKit account](https://imagekit.io/registration/) -2. Get your [API Keys](https://docs.imagekit.io/api-reference/api-introduction/api-keys) from [developer options](https://imagekit.io/dashboard/developer) inside the dashboard. -3. **Minimum requirements** – To use PHP SDK, your system must meet the minimum requirements, including having **PHP >= 5.6**. We highly recommend having it compiled with the cURL extension and cURL 7.16.2+ compiled with a TLS backend (e.g., NSS or OpenSSL). -4. **Install the SDK** – Using Composer is the recommended way to install the ImageKit SDK for PHP. The SDK is available via [Packagist](http://packagist.org/) under the [`imagekit/imagekit`](https://packagist.org/packages/imagekit/imagekit) package. If Composer is installed globally on your system, you can run the following in the base directory of your project to add the SDK as a dependency: - ``` - composer require imagekit/imagekit - ``` - Please see the [Installation](#installation) section for more detailed information about installing. -5. **Using the SDK** – The best way to become familiar with how to use the SDK is to follow the examples provided in the [quick start guide](https://docs.imagekit.io/getting-started/quickstart-guides/php). - -## Quick Examples - -#### Create an ImageKit Instance -```php -// Require the Composer autoloader. -require 'vendor/autoload.php'; -use ImageKit\ImageKit; - -$imageKit = new ImageKit( - "your_public_key", - "your_private_key", - "your_url_endpoint" -); -``` - -#### URL Generation -```php -// For URL Generation, works for both images and videos -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - ] -); -echo $imageURL; -``` - -#### File Upload -```php -// For File Upload -$uploadFile = $imageKit->uploadFile([ - 'file' => 'file-url', # required, "binary","base64" or "file url" - 'fileName' => 'new-file' # required - 'checks' => '"file.size" < "1mb"' // optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library. -]); -``` - -#### Response Structure -Following is the response for [server-side file upload API](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload#response-code-and-structure-json) +To use this package, install via Composer by adding the following to your application's `composer.json`: ```json { - "error": null, - "result": { - "fileId": "6286329dfef1b033aee60211", - "name": "your_file_name_S-PgGysnR.jpg", - "size": 94466, - "versionInfo": { - "id": "6286329dfef1b033aee60211", - "name": "Version 1" - }, - "filePath": "/your_file_name_S-PgGysnR.jpg", - "url": "https://ik.imagekit.io/demo/your_file_name_S-PgGysnR.jpg", - "fileType": "image", - "height": 640, - "width": 960, - "thumbnailUrl": "https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/your_file_name_S-PgGysnR.jpg", - "tags": [], - "AITags": null, - "customMetadata": { }, - "extensionStatus": {} - }, - "responseMetadata":{ - "headers":{ - "access-control-allow-origin": "*", - "x-ik-requestid": "e98f2464-2a86-4934-a5ab-9a226df012c9", - "content-type": "application/json; charset=utf-8", - "content-length": "434", - "etag": 'W/"1b2-reNzjRCFNt45rEyD7yFY/dk+Ghg"', - "date": "Thu, 16 Jun 2022 14:22:01 GMT", - "x-request-id": "e98f2464-2a86-4934-a5ab-9a226df012c9" - }, - "raw":{ - "fileId": "6286329dfef1b033aee60211", - "name": "your_file_name_S-PgGysnR.jpg", - "size": 94466, - "versionInfo": { - "id": "6286329dfef1b033aee60211", - "name": "Version 1" - }, - "filePath": "/your_file_name_S-PgGysnR.jpg", - "url": "https://ik.imagekit.io/demo/your_file_name_S-PgGysnR.jpg", - "fileType": "image", - "height": 640, - "width": 960, - "thumbnailUrl": "https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/your_file_name_S-PgGysnR.jpg", - "tags": [], - "AITags": null, - "customMetadata": { }, - "extensionStatus": {} - }, - "statusCode":200 + "repositories": [ + { + "type": "vcs", + "url": "git@github.com:stainless-sdks/imagekit-php.git" } + ], + "require": { + "imagekit/imagekit": "dev-main" + } } ``` -## Demo application - -* Step-by-step PHP quick start guide - https://docs.imagekit.io/getting-started/quickstart-guides/php -* You can also run the demo application in this repository's [sample](/sample) folder. - ```sh - cd sample - php sample.php - ``` - -## URL generation - -### Using relative file path and URL endpoint - -This method allows you to create an URL to access a file using the relative file path and the ImageKit URL endpoint (`urlEndpoint`). The file can be an image, video, or any other static file supported by ImageKit. - -#### Example - -```php -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400' - ] - ] - ] -); -``` - -#### Response - -``` -https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg -``` - -### Using full image URL -This method allows you to add transformation parameters to an absolute URL. For example, if you have configured a custom CNAME and have absolute asset URLs in your database or CMS, you will often need this. - -#### Example -```php -$imageURL = $imageKit->url([ - 'src' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400' - ] - ] -]); -``` - -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/endpoint/tr:h-300,w-400/default-image.jpg -``` - -The `$imageKit->url()` method accepts the following parameters. - -| Option | Description | -| :-------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| urlEndpoint | Optional. The base URL to be appended before the path of the image. If not specified, the URL Endpoint specified at the time of SDK initialization is used. For example, https://ik.imagekit.io/your_imagekit_id/endpoint/ | -| path | Conditional. This is the path at which the image exists. For example, `/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. | -| src | Conditional. This is the complete URL of an image already mapped to ImageKit. For example, `https://ik.imagekit.io/your_imagekit_id/endpoint/path/to/image.jpg`. Either the `path` or `src` parameter needs to be specified for URL generation. | -| transformation | Optional. An array of objects specifying the transformation to be applied in the URL. The transformation name and the value should be specified as a key-value pair in the object. Different steps of a [chained transformation](https://docs.imagekit.io/features/image-transformations/chained-transformations) can be specified as different objects of the array. The complete [List of supported transformations](#list-of-supported-transformations) in the SDK and some examples of using them are given later. If you use a transformation name that is not specified in the SDK, it gets applied as it is in the URL. | -| transformationPosition | Optional. The default value is `path` which places the transformation string as a path parameter in the URL. It can also be specified as `query`, which adds the transformation string as the query parameter `tr` in the URL. The transformation string is always added as a query parameter if you use the `src` parameter to create the URL. | -| queryParameters | Optional. These are the other query parameters that you want to add to the final URL. These can be any query parameters and are not necessarily related to ImageKit. Especially useful if you want to add some versioning parameters to your URLs. | -| signed | Optional. Boolean. The default value is `false`. If set to `true`, the SDK generates a signed image URL adding the image signature to the image URL. | -| expireSeconds | Optional. Integer. It is used along with the `signed` parameter. It specifies the time in seconds from now when the signed URL will expire. If specified, the URL contains the expiry timestamp in the URL, and the image signature is modified accordingly. - -### Applying chained transformations, common image manipulations & signed URL - -This section covers the basics: - -* [Chained Transformations as a query parameter](#1-chained-transformations-as-a-query-parameter) -* [Image enhancement & color manipulation](#2-image-enhancement-and-color-manipulation) -* [Resizing images and videos](#3-resizing-images-and-videos) -* [Quality manipulation](#4-quality-manipulation) -* [Adding overlays](#5-adding-overlays) -* [Signed URL](#6-signed-url) - -The PHP SDK gives a name to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [Full list of supported transformations](#list-of-supported-transformations). - -👉 If the property does not match any of the available options, it is added as it is. For example: -```php -[ - 'effectGray' => 'e-grayscale' -] -// and -[ - 'e-grayscale' => '' -] -// works the same -``` -👉 Note that you can also use the `h` and `w` parameters instead of `height` and `width`. - -For more examples, check the [Demo Application](https://github.com/imagekit-developer/imagekit-php/tree/master/sample). - - -### 1. Chained transformations as a query parameter - -#### Example -```php -$imageURL = $imageKit->url([ - 'path' => '/default-image.jpg', - 'urlEndpoint' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400' - ], - [ - 'rotation' => 90 - ], - ], - 'transformationPosition' => 'query' -]); -``` -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg?tr=h-300,w-400:rt-90 -``` - -### 2. Image enhancement and color manipulation - -Some transformations like [contrast stretch](https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#contrast-stretch-e-contrast) , [sharpen](https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#sharpen-e-sharpen) and [unsharp mask](https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#unsharp-mask-e-usm) can be added to the URL with or without any other value. To use such transforms without specifying a value, specify the value as "-" in the transformation object. Otherwise, specify the value that you want to be added to this transformation. - -#### Example -```php -$imageURL = $imageKit->url([ - 'src' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - 'transformation' => - [ - [ - 'format' => 'jpg', - 'progressive' => true, - 'effectSharpen' => '-', - 'effectContrast' => '1' - ] - ] -]); -``` -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/endpoint/tr:f-jpg,pr-true,e-sharpen,e-contrast-1/default-image.jpg -``` - -### 3. Resizing images and videos -Let's resize the image to `width` 400 and `height` 300. -Check detailed instructions on [resize, crop, and other Common transformations](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations) - -#### Example -```php -$imageURL = $imageKit->url(array( - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - ] - ] -)); -``` -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/tr:w-400,h-300/default-image.jpg -``` - -### 4. Quality manipulation -You can use the [quality parameter](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#quality-q) to change quality like this. - -#### Example -```php -$imageURL = $imageKit->url(array( - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'quality' => '40', - ] - ] -)); -``` - -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/tr:q-40/default-image.jpg -``` - -### 5. Adding overlays - -ImageKit.io enables you to apply overlays to [images](https://docs.imagekit.io/features/image-transformations/overlay-using-layers) and [videos](https://docs.imagekit.io/features/video-transformation/overlay) using the raw parameter with the concept of [layers](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#layers). The raw parameter facilitates incorporating transformations directly in the URL. A layer is a distinct type of transformation that allows you to define an asset to serve as an overlay, along with its positioning and additional transformations. - -#### Text as overlays - -You can add any text string over a base video or image using a text layer (l-text). +## Usage -For example: +This library uses named parameters to specify optional arguments. +Parameters with a default value must be set by name. ```php -$imageURL = $imageKit->url(array( - 'path' => '/default-image.jpg', - 'urlEndpoint' => 'https://ik.imagekit.io/your_imagekit_id' - - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'raw': "l-text,i-Imagekit,fs-50,l-end" - ] - ] -)); -``` -#### Sample Result URL -``` -https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-text,i-Imagekit,fs-50,l-end/default-image.jpg -``` +files->upload(file: 'file', fileName: "file-name.jpg"); -```php -$imageURL = $imageKit->url(array( - 'path' => '/default-image.jpg', - 'urlEndpoint' => 'https://ik.imagekit.io/your_imagekit_id' - - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'raw': "l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end" - ] - ] -)); -``` -#### Sample Result URL +var_dump($response->videoCodec); ``` -https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end/default-image.jpg -``` - -#### Solid color blocks as overlays - -You can add solid color blocks over a base video or image using an image layer (l-image). -For example: +### Value Objects -```php -$imageURL = $imageKit->url(array( - 'path' => '/img/sample-video.mp4', - 'urlEndpoint' => 'https://ik.imagekit.io/your_imagekit_id' - - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'raw': "l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end" - ] - ] -)); -``` -#### Sample Result URL -``` -https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end/img/sample-video.mp4 -``` +It is recommended to use the static `with` constructor `Dog::with(name: "Joey")` +and named parameters to initialize value objects. -### 6. Arithmetic expressions in transformations +However, builders are also provided `(new Dog)->withName("Joey")`. -ImageKit allows use of [arithmetic expressions](https://docs.imagekit.io/features/arithmetic-expressions-in-transformations) in certain dimension and position-related parameters, making media transformations more flexible and dynamic. +### Handling errors -For example: +When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `ImageKit\Core\Exceptions\APIException` will be thrown: ```php -$imageURL = $imageKit->url(array( - 'path' => '/default-image.jpg', - 'urlEndpoint' => 'https://ik.imagekit.io/your_imagekit_id' - 'transformation' => [ - [ - "height": "ih_div_2", - "width": "iw_div_4", - "border": "cw_mul_0.05_yellow" - ] - ] -)); -``` - -#### Sample Result URL -``` -https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=w-iw_div_4,h-ih_div_2,b-cw_mul_0.05_yellow -`` - -### 7. Signed URL - -For example, the signed URL expires in 300 seconds with the default URL endpoint and other query parameters. -For a detailed explanation of the signed URL, refer to this [documentation](https://docs.imagekit.io/features/security/signed-urls). - -#### Example -```php -$imageURL = $imageKit->url([ - "path" => "/default-image.jpg", - "queryParameters" => - [ - "v" => "123" - ], - "transformation" => [ - [ - "height" => "300", - "width" => "400" - ] - ], - "signed" => true, - "expireSeconds" => 300, -]); -``` -#### Response -``` -https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&ik-t=1654183277&ik-s=f98618f264a9ccb3c017e7b7441e86d1bc9a7ebb -``` - -You can manage [security settings](https://docs.imagekit.io/features/security#restricting-unsigned-urls) from the dashboard to prevent unsigned URLs usage. In that case, if the URL doesn't have a signature `ik-s` parameter or the signature is invalid, ImageKit will return a forbidden error instead of an actual image. - -### List of supported transformations - -The complete list of transformations supported and their usage in ImageKit can be found in the docs for [images](https://docs.imagekit.io/features/image-transformations) and [videos](https://docs.imagekit.io/features/video-transformation). The SDK gives a name to each transformation parameter, making the code simpler, making the code simpler, and readable. - -If a transformation is supported in ImageKit, but a name for it cannot be found in the table below, then use the transformation code from ImageKit docs as the name when using the `url` function. - -If you want to generate transformations in your application and add them to the URL as it is, use the `raw` parameter. - -| Supported Transformation Name | Translates to parameter | -|-------------------------------|-------------------------| -| height | h | -| width | w | -| aspectRatio | ar | -| quality | q | -| crop | c | -| cropMode | cm | -| x | x | -| y | y | -| focus | fo | -| format | f | -| radius | r | -| background | bg | -| border | b | -| rotation | rt | -| blur | bl | -| named | n | -| progressive | pr | -| lossless | lo | -| trim | t | -| metadata | md | -| colorProfile | cp | -| defaultImage | di | -| dpr | dpr | -| effectSharpen | e-sharpen | -| effectUSM | e-usm | -| effectContrast | e-contrast | -| effectGray | e-grayscale | -| effectShadow | e-shadow | -| effectGradient | e-gradient | -| original | orig | -| raw | `replaced by the parameter value` | - +uploadFile()` method to upload files to the [ImageKit Media Library](https://imagekit.io/dashboard/media-library). - -- [Server-side file upload API](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload). -- [Supported file types and extensions](https://docs.imagekit.io/api-reference/upload-file-api#allowed-file-types-for-uploading). - -#### Basic Usage -```php -$uploadFile = $imageKit->uploadFile([ - 'file' => 'your_file', // required, "binary","base64" or "file url" - 'fileName' => 'your_file_name.jpg', // required - 'checks' => '"file.size" < "1mb"', // optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library. -]); -``` -#### Response -```json -{ - "error": null, - "result": { - "fileId": "6286329dfef1b033aee60211", - "name": "your_file_name_S-PgGysnR.jpg", - "size": 94466, - "versionInfo": { - "id": "6286329dfef1b033aee60211", - "name": "Version 1" - }, - "filePath": "/your_file_name_S-PgGysnR.jpg", - "url": "https://ik.imagekit.io/demo/your_file_name_S-PgGysnR.jpg", - "fileType": "image", - "height": 640, - "width": 960, - "thumbnailUrl": "https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/your_file_name_S-PgGysnR.jpg", - "tags": [], - "AITags": null, - "customMetadata": { }, - "extensionStatus": {} - }, - "responseMetadata":{ - "headers":{ - "access-control-allow-origin": "*", - "x-ik-requestid": "e98f2464-2a86-4934-a5ab-9a226df012c9", - "content-type": "application/json; charset=utf-8", - "content-length": "434", - "etag": 'W/"1b2-reNzjRCFNt45rEyD7yFY/dk+Ghg"', - "date": "Thu, 16 Jun 2022 14:22:01 GMT", - "x-request-id": "e98f2464-2a86-4934-a5ab-9a226df012c9" - }, - "raw":{ - "fileId": "6286329dfef1b033aee60211", - "name": "your_file_name_S-PgGysnR.jpg", - "size": 94466, - "versionInfo": { - "id": "6286329dfef1b033aee60211", - "name": "Version 1" - }, - "filePath": "/your_file_name_S-PgGysnR.jpg", - "url": "https://ik.imagekit.io/demo/your_file_name_S-PgGysnR.jpg", - "fileType": "image", - "height": 640, - "width": 960, - "thumbnailUrl": "https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/your_file_name_S-PgGysnR.jpg", - "tags": [], - "AITags": null, - "customMetadata": { }, - "extensionStatus": {} - }, - "statusCode":200 - } +try { + $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); +} catch (APIConnectionException $e) { + echo "The server could not be reached", PHP_EOL; + var_dump($e->getPrevious()); +} catch (RateLimitError $_) { + echo "A 429 status code was received; we should back off a bit.", PHP_EOL; +} catch (APIStatusError $e) { + echo "Another non-200-range status code was received", PHP_EOL; + echo $e->getMessage(); } ``` -#### Optional Parameters -Please refer to [server-side file upload API request structure](https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload#request-structure-multipart-form-data) for a detailed explanation of mandatory and optional parameters. -```php -// Attempt File Uplaod -$uploadFile = $imageKit->uploadFile([ - 'file' => 'your_file', // required, "binary","base64" or "file url" - 'fileName' => 'your_file_name.jpg', // required - // Optional Parameters - "useUniqueFileName" => true, // true|false - "tags" => implode(",",["abd", "def"]), // max: 500 chars - "folder" => "/sample-folder", - "isPrivateFile" => false, // true|false - "customCoordinates" => implode(",", ["10", "10", "100", "100"]), // max: 500 chars - "responseFields" => implode(",", ["tags", "customMetadata"]), - "extensions" => [ - [ - "name" => "remove-bg", - "options" => [ // refer https://docs.imagekit.io/extensions/overview - "add_shadow" => true - ] - ] - ], - "webhookUrl" => "https://example.com/webhook", - "overwriteFile" => true, // in case of false useUniqueFileName should be true - "overwriteAITags" => true, // set to false in order to preserve overwriteAITags - "overwriteTags" => true, - "overwriteCustomMetadata" => true, - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], - 'checks' => '"file.size" < "1mb"', // optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library. - 'isPublished' => true, - // "customMetadata" => [ - // "SKU" => "VS882HJ2JD", - // "price" => 599.99, - // ] -]); -``` +Error codes are as follows: -## File Management +| Cause | Error Type | +| ---------------- | ------------------------------ | +| HTTP 400 | `BadRequestException` | +| HTTP 401 | `AuthenticationException` | +| HTTP 403 | `PermissionDeniedException` | +| HTTP 404 | `NotFoundException` | +| HTTP 409 | `ConflictException` | +| HTTP 422 | `UnprocessableEntityException` | +| HTTP 429 | `RateLimitException` | +| HTTP >= 500 | `InternalServerException` | +| Other HTTP error | `APIStatusException` | +| Timeout | `APITimeoutException` | +| Network error | `APIConnectionException` | -The SDK provides a simple interface for all the following [Media APIs](https://docs.imagekit.io/api-reference/media-api) to manage your files. +### Retries -### 1. List and Search Files +Certain errors will be automatically retried 2 times by default, with a short exponential backoff. -This API can list all the uploaded files and folders in your [ImageKit.io](https://docs.imagekit.io/api-reference/media-api) media library. +Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default. -Refer to the [list and search file API](https://docs.imagekit.io/api-reference/media-api/list-and-search-files) for a better understanding of the **request & response structure**. +You can use the `maxRetries` option to configure or disable this: -#### Example ```php -$listFiles = $imageKit->listFiles(); -``` -#### Applying Filters -Filter out the files with an object specifying the parameters. +listFiles([ - "type" => "file", // file, file-version or folder - "sort" => "ASC_CREATED", - "path" => "/", // folder path - "fileType" => "all", // all, image, non-image - "limit" => 10, // min:1, max:1000 - "skip" => 0, // min:0 -]); -``` - -#### Advance Search -In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and providing this generated string as the value of the `searchQuery`. - -```php -$listFiles = $imageKit->listFiles([ - "searchQuery" => '(size < "1mb" AND width > 500) OR (tags IN ["summer-sale","banner"])', -]); -``` -Detailed documentation can be found here for [advance search queries](https://docs.imagekit.io/api-reference/media-api/list-and-search-files#advanced-search-queries). +use ImageKit\Client; +use ImageKit\RequestOptions; -### 2. Get File Details +// Configure the default for all requests: +$client = new Client(maxRetries: 0); -This API will get all the details and attributes of the current version of the asset. - -Refer to the [get file details API](https://docs.imagekit.io/api-reference/media-api/get-file-details) for a better understanding of the **request & response structure**. - -#### Example -```php -$getFileDetails = $imageKit->getFileDetails('file_id'); -``` +// Or, configure per-request: -### 3. Get File Version Details - -This API can get you all the details and attributes for the provided version of the file. - -Refer to the [get file version details API](https://docs.imagekit.io/api-reference/media-api/get-file-version-details) for a better understanding of the **request & response structure**. - -#### Example -```php -$getFileVersionDetails = $imageKit->getFileVersionDetails('file_id','version_id'); -``` - -### 4. Get File Versions - -This API will get you all the versions of an asset. - -Refer to the [get file versions API](https://docs.imagekit.io/api-reference/media-api/get-file-versions) for a better understanding of the **request & response structure**. - -#### Example -```php -$getFileVersions = $imageKit->getFileVersions('file_id'); -``` - -### 5. Update File Details - -Update file details such as `tags`, `customCoordinates` attributes, remove existing `AITags`, and apply [extensions](https://docs.imagekit.io/extensions/overview) using update file details API. This operation can only be performed only on the current version of an asset. - -Refer to the [update file details API](https://docs.imagekit.io/api-reference/media-api/update-file-details) for better understanding about the **request & response structure**. - -#### Example -```php -// Update parameters -$updateData = [ - "removeAITags" => "all", // "all" or ["tag1","tag2"] - "webhookUrl" => "https://example.com/webhook", - "extensions" => [ - [ - "name" => "remove-bg", - "options" => [ // refer https://docs.imagekit.io/extensions/overview - "add_shadow" => true - ] - ], - [ - "name" => "google-auto-tagging", - ] - ], - "tags" => ["tag1", "tag2"], - "customCoordinates" => "10,10,100,100", - // "customMetadata" => [ - // "SKU" => "VS882HJ2JD", - // "price" => 599.99, - // ] -]; - -// Attempt Update -$updateFileDetails = $imageKit->updateFileDetails( - 'file_id', - $updateData -); -``` - -**Update publish status** - -If `publish` is included in the update options, no other parameters are allowed. If any are present, an error will be returned: `Your request cannot contain any other parameters when publish is present`. - -#### Example -```php -// Update parameters -$updateData = [ - "publish" => [ - "isPublished" => true, - "includeFileVersions" => true - ] -]; - -// Attempt Update -$updateFileDetails = $imageKit->updateFileDetails( - 'file_id', - $updateData +$result = $client->files->upload( + file: 'file', + fileName: "file-name.jpg", + requestOptions: RequestOptions::with(maxRetries: 5), ); ``` -### 6. Add Tags (Bulk) API +## Advanced concepts -Add tags to multiple files in a single request. The method accepts an array of `fileIds` of the files and an array of `tags` that have to be added to those files. - -Refer to the [add tags (Bulk) API](https://docs.imagekit.io/api-reference/media-api/add-tags-bulk) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileIds = ['file_id1','file_id2']; -$tags = ['image_tag_1', 'image_tag_2']; - -$bulkAddTags = $imageKit->bulkAddTags($fileIds, $tags); -``` +### Making custom or undocumented requests -### 7. Remove Tags (Bulk) API +#### Undocumented properties -Remove tags from multiple files in a single request. The method accepts an array of `fileIds` of the files and an array of `tags` that have to be removed from those files. +You can send undocumented parameters to any endpoint, and read undocumented response properties, like so: -Refer to the [remove tags (Bulk) API](https://docs.imagekit.io/api-reference/media-api/remove-tags-bulk) for a better understanding of the **request & response structure**. +Note: the `extra*` parameters of the same name overrides the documented parameters. -#### Example ```php -$fileIds = ['file_id1','file_id2']; -$tags = ['image_tag_1', 'image_tag_2']; - -$bulkRemoveTags = $imageKit->bulkRemoveTags($fileIds, $tags); -``` - -### 8. Remove AI Tags (Bulk) API - -Remove AI tags from multiple files in a single request. The method accepts an array of `fileIds` of the files and an array of `AITags` that have to be removed from those files. - -Refer to the [remove AI Tags (Bulk) API](https://docs.imagekit.io/api-reference/media-api/remove-aitags-bulk) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileIds = ['file_id1','file_id2']; -$AITags = ['image_AITag_1', 'image_AITag_2']; - -$bulkRemoveTags = $imageKit->bulkRemoveTags($fileIds, $AITags); -``` + If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. However, you can purge the cache using [Purge Cache API](#21-purge-cache-api). - -Refer to the [delete file API](https://docs.imagekit.io/api-reference/media-api/delete-file) for better understanding about the **request & response structure**. - -#### Basic Usage -```php -$fileId = 'file_id'; -$deleteFile = $imageKit->deleteFile($fileId); -``` - -### 10. Delete File Version API - -Using the delete file version API, you can programmatically delete the uploaded file version in the media library. - -> You can delete only the non-current version of a file. - -Refer to the [delete file version API](https://docs.imagekit.io/api-reference/media-api/delete-file-version) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileId = 'file_id'; -$versionId = 'version_id'; -$deleteFileVersion = $imageKit->deleteFileVersion($fileId, $versionId); -``` - -### 11. Delete Files (Bulk) API - -Deletes multiple files and their versions from the media library. - -Refer to the [delete files (Bulk) API](https://docs.imagekit.io/api-reference/media-api/delete-files-bulk) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileIds = ["5e1c13d0c55ec3437c451406", ...]; -$deleteFiles = $imageKit->bulkDeleteFiles($fileIds); -``` - - -### 12. Copy File API - -This will copy a file from one folder to another. - -> If any file at the destination has the same name as the source file, then the source file and its versions (if `includeFileVersions` is set to true) will be appended to the destination file version history. - -Refer to the [copy file API](https://docs.imagekit.io/api-reference/media-api/copy-file) for a better understanding of the **request & response structure**. - -#### Basic Usage -```php -$sourceFilePath = '/sample-folder1/sample-file.jpg'; -$destinationPath = '/sample-folder2/'; -$includeFileVersions = false; - -$copyFile = $imageKit->copy([ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => $includeFileVersions -]); -``` - -### 13. Move File API - -This will move a file and all its versions from one folder to another. - -> If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file. - -Refer to the [move file API](https://docs.imagekit.io/api-reference/media-api/move-file) for a better understanding of the **request & response structure**. - -#### Example -```php -$sourceFilePath = '/sample-file.jpg'; -$destinationPath = '/sample-folder/'; - -$moveFile = $imageKit->move([ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath -]); -``` - -### 14. Rename File API - -Using Rename File API, you can programmatically rename an already existing file in the media library. This operation would rename all versions of the file. - -> The old URLs will stop working. However, the file/file version URLs cached on CDN will continue to work unless a purge is requested. - -Refer to the [rename file API](https://docs.imagekit.io/api-reference/media-api/rename-file) for a better understanding of the **request & response structure**. - -#### Example -```php -// Purge Cache would default to false - -$filePath = '/sample-folder/sample-file.jpg'; -$newFileName = 'sample-file2.jpg'; -$renameFile = $imageKit->rename([ - 'filePath' => $filePath, - 'newFileName' => $newFileName, -]); -``` -When `purgeCache` is set to `true`, response will return `purgeRequestId`. This `purgeRequestId` can be used to get the purge request status. -```php -$filePath = '/sample-folder/sample-file.jpg'; -$newFileName = 'sample-file2.jpg'; -$renameFile = $imageKit->rename([ - 'filePath' => $filePath, - 'newFileName' => $newFileName, -],true); -``` - -### 15. Restore File Version API - -This will restore the provided file version to a different version of the file. The newly restored version of the file will be returned in the response. - -Refer to the [restore file version API](https://docs.imagekit.io/api-reference/media-api/restore-file-version) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileId = 'fileId'; -$versionId = 'versionId'; -$restoreFileVersion = $imageKit->restoreFileVersion([ - 'fileId' => $fileId, - 'versionId' => $versionId, -]); -``` - -### 16. Create Folder API - -This will create a new folder. You can specify the folder name and location of the parent folder where this new folder should be created. - -Refer to the [create folder API](https://docs.imagekit.io/api-reference/media-api/create-folder) for a better understanding of the **request & response structure**. - -#### Example -```php -$folderName = 'new-folder'; -$parentFolderPath = '/'; -$createFolder = $imageKit->createFolder([ - 'folderName' => $folderName, - 'parentFolderPath' => $parentFolderPath, -]); -``` - -### 17. Delete Folder API - -This will delete the specified folder and all nested files, their versions & folders. This action cannot be undone. - -Refer to the [delete folder API](https://docs.imagekit.io/api-reference/media-api/delete-folder) for a better understanding of the **request & response structure**. - -#### Example -```php -$folderPath = '/new-folder'; -$deleteFolder = $imageKit->deleteFolder($folderPath); -``` - -### 18. Copy Folder API - -This will copy one folder into another. - -Refer to the [copy folder API](https://docs.imagekit.io/api-reference/media-api/copy-folder) for a better understanding of the **request & response structure**. - -#### Example -```php -$sourceFolderPath = '/source-folder/'; -$destinationPath = '/destination-folder/'; -$includeFileVersions = false; -$copyFolder = $imageKit->copyFolder([ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => $includeFileVersions -]); -``` - -### 19. Move Folder API - -This will move one folder into another. The selected folder, its nested folders, files, and their versions are moved in this operation. - -> If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history. - -Refer to the [move folder API](https://docs.imagekit.io/api-reference/media-api/move-folder) for a better understanding of the **request & response structure**. - -#### Example -```php -$sourceFolderPath = '/sample-folder/'; -$destinationPath = '/destination-folder/'; -$moveFolder = $imageKit->moveFolder([ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath -]); -``` - -### 20. Bulk Job Status API - -This endpoint allows you to get the status of a bulk operation e.g. [Copy Folder API](#18-copy-folder-api) or [Move Folder API](#19-move-folder-api). - -Refer to the [bulk job status API](https://docs.imagekit.io/api-reference/media-api/copy-move-folder-status) for a better understanding of the **request & response structure**. - -#### Example -```php -$jobId = 'jobId'; -$bulkJobStatus = $imageKit->getBulkJobStatus($jobId); -``` - -### 21. Purge Cache API - -This will purge CDN and ImageKit.io's internal cache. In response, `requestId` is returned, which can be used to fetch the status of the submitted purge request with [Purge Cache Status API](#22-purge-cache-status-api). - -Refer to the [Purge Cache API](https://docs.imagekit.io/api-reference/media-api/purge-cache) for a better understanding of the **request & response structure**. - -#### Example -```php -$image_url = 'https://ik.imagekit.io/demo/sample-folder/sample-file.jpg'; -$purgeCache = $imageKit->purgeCache($image_url); -``` - -You can purge the cache for multiple files. Check [purge cache multiple files](https://docs.imagekit.io/api-reference/media-api/purge-cache#purge-cache-for-multiple-files). - -### 22. Purge Cache Status API - -Get the purge cache request status using the `requestId` returned when a purge cache request gets submitted with [Purge Cache API](#21-purge-cache-api) - -Refer to the [Purge Cache Status API](https://docs.imagekit.io/api-reference/media-api/purge-cache-status) for a better understanding of the **request & response structure**. - -#### Example -```php -$cacheRequestId = '598821f949c0a938d57563bd'; -$purgeCacheStatus = $imageKit->purgeCacheStatus($cacheRequestId); -``` - -### 23. Get File Metadata API (From File ID) - -Get the image EXIF, pHash, and other metadata for uploaded files in the ImageKit.io media library using this API. - -Refer to the [get image metadata for uploaded media files API](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files) for a better understanding of the **request & response structure**. - -#### Example -```php -$fileId = '598821f949c0a938d57563bd'; -$getFileMetadata = $imageKit->getFileMetaData($fileId); -``` - -### 24. Get File Metadata API (From Remote URL) - -Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL using this API. - -Refer to the [get image metadata from remote URL API](https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-from-remote-url) for a better understanding of the **request & response structure**. - -#### Example -```php -$image_url = 'https://ik.imagekit.io/demo/sample-folder/sample-file.jpg'; -$getFileMetadataFromRemoteURL = $imageKit->getFileMetadataFromRemoteURL($image_url); -``` -## Custom Metadata Fields API - -Imagekit.io allows you to define a `schema` for your metadata keys, and the value filled against that key will have to adhere to those rules. You can [create](#1-create-fields), [read](#2-get-fields) and [update](#3-update-fields) custom metadata rules and update your file with custom metadata value in [file update API](#5-update-file-details) or [file upload API](#server-side-file-upload). - -For a detailed explanation, refer to the [custom metadata fields documentation](https://docs.imagekit.io/api-reference/custom-metadata-fields-api). - - -### 1. Create Fields - -Create a custom metadata field with this API. - -Refer to the [create custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field) for a better understanding of the **request & response structure**. - -#### Example -```php -$body = [ - "name" => "price", // required - "label" => "Unit Price", // required - "schema" => [ // required - "type" => 'Number', // required - "minValue" => 1000, - "maxValue" => 5000, - ], -]; - -$createCustomMetadataField = $imageKit->createCustomMetadataField($body); -``` - -Check for the [allowed values in the schema](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field#allowed-values-in-the-schema-object). - -### 2. Get Fields - -Get a list of all the custom metadata fields. - -Refer to the [get custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field) for a better understanding of the **request & response structure**. - -#### Example -```php -$includeDeleted = false; -$getCustomMetadataField = $imageKit->getCustomMetadataField($includeDeleted); -``` - -### 3. Update Fields - -Update an existing custom metadata field's `label` or `schema`. - -Refer to the [update custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/update-custom-metadata-field) for a better understanding of the **request & response structure**. - -#### Example -```php -$customMetadataFieldId = '598821f949c0a938d57563dd'; -$body = [ - "label" => "Net Price", - "schema" => [ - "type"=>'Number' - ], -]; +$response = $client->files->upload( + file: 'file', + fileName: "file-name.jpg", + requestOptions: RequestOptions::with( + extraQueryParams: ["my_query_parameter" => "value"], + extraBodyParams: ["my_body_parameter" => "value"], + extraHeaders: ["my-header" => "value"], + ), +); -$updateCustomMetadataField = $imageKit->updateCustomMetadataField($customMetadataFieldId, $body); +var_dump($response["my_undocumented_property"]); ``` -Check for the [allowed values in the schema](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field#allowed-values-in-the-schema-object). +#### Undocumented request params +If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above. -### 4. Delete Fields +#### Undocumented endpoints -Delete a custom metadata field. +To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so: -Refer to the [delete custom metadata fields API](https://docs.imagekit.io/api-reference/custom-metadata-fields-api/delete-custom-metadata-field) for a better understanding of the **request & response structure**. - -#### Example ```php -$customMetadataFieldId = '598821f949c0a938d57563dd'; +deleteCustomMetadataField($customMetadataFieldId); +$response = $client->request( + method: "post", + path: '/undocumented/endpoint', + query: ['dog' => 'woof'], + headers: ['useful-header' => 'interesting-value'], + body: ['hello' => 'world'] +); ``` +## Versioning -## Utility functions - -We have included the following commonly used utility functions in this SDK. - -### Authentication parameter generation +This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time. -If you want to implement client-side file upload, you will need a `token`, `expiry` timestamp, and a valid `signature` for that upload. The SDK provides a simple method you can use in your code to generate these authentication parameters. +This package considers improvements to the (non-runtime) PHPDoc type definitions to be non-breaking changes. -_Note: The Private API Key should never be exposed in any client-side code. You must always generate these authentication parameters on the server-side_ - -```php -$imageKit->getAuthenticationParameters($token = "", $expire = 0); -``` - -Returns - -```json -{ - "token": "5d1c4a22-54f2-40bb-9e8c-99daaeeb7307", - "expire": 1654207193, - "signature": "a03a88b814570a3d92919c16a1b8bd4491f053c3" -} -``` - -Both the `token` and `expire` parameters are optional. If not specified, the SDK internally generates a random token and a valid expiry timestamp. The value of the `token` and `expire` used to create the signature is always returned in the response, whether they are provided in input or not. - -### Distance calculation between two pHash values - -Perceptual hashing allows you to construct a hash value that uniquely identifies an input image based on the contents of an image. [ImageKit.io metadata API](https://docs.imagekit.io/api-reference/metadata-api) returns the pHash value of an image in the response. You can use this value to find a duplicate (or similar) image by calculating the distance between the pHash value of the two images. - -This SDK exposes `pHashDistance` function to calculate the distance between two pHash values. It accepts two pHash hexadecimal strings and returns a numeric value indicative of the level of difference between the two images. - -```php - $imageKit->pHashDistance($firstHash ,$secondHash); -``` - -#### Distance calculation examples - -```php -$imageKit->pHashDistance('f06830ca9f1e3e90', 'f06830ca9f1e3e90'); -// output: 0 (same image) - -$imageKit->pHashDistance('2d5ad3936d2e015b', '2d6ed293db36a4fb'); -// output: 17 (similar images) - -$imageKit->pHashDistance('a4a65595ac94518b', '7838873e791f8400'); -// output: 37 (dissimilar images) -``` - -## Opening Issues -If you encounter a bug with `imagekit-php` we would like to hear about it. Search the existing issues and try to make sure your problem doesn't already exist before opening a new issue. It's helpful if you include the version of `imagekit-php`, PHP version, and OS you're using. Please include a stack trace and a simple workflow to reproduce the case when appropriate, too. - - -## Support - -For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io) - -## Resources +## Requirements -- [Main website](https://imagekit.io) - Main Website. -- [Documentation](https://docs.imagekit.io) - For both getting started and in-depth SDK usage information. -- [PHP quick start guide](https://docs.imagekit.io/getting-started/quickstart-guides/php) +PHP 8.1.0 or higher. -## License +## Contributing -Released under the MIT license. \ No newline at end of file +See [the contributing documentation](https://github.com/stainless-sdks/imagekit-php/tree/main/CONTRIBUTING.md). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..8e64327a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,27 @@ +# Security Policy + +## Reporting Security Issues + +This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken. + +To report a security issue, please contact the Stainless team at security@stainless.com. + +## Responsible Disclosure + +We appreciate the efforts of security researchers and individuals who help us maintain the security of +SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible +disclosure practices by allowing us a reasonable amount of time to investigate and address the issue +before making any information public. + +## Reporting Non-SDK Related Security Issues + +If you encounter security issues that are not directly related to SDKs but pertain to the services +or products provided by Image Kit, please follow the respective company's security reporting guidelines. + +### Image Kit Terms and Policies + +Please contact developer@imagekit.io for any questions or concerns regarding the security of our services. + +--- + +Thank you for helping us keep the SDKs and systems they interact with secure. diff --git a/bin/check-release-environment b/bin/check-release-environment new file mode 100644 index 00000000..0d9c55da --- /dev/null +++ b/bin/check-release-environment @@ -0,0 +1,29 @@ +#!/usr/bin/env bash + +errors=() + +if [ -z "${STAINLESS_API_KEY}" ]; then + errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.") +fi + +if [ -z "${PACKAGIST_USERNAME}" ]; then + errors+=("The PACKAGIST_USERNAME secret has not been set. Please set it in either this repository's secrets or your organization secrets") +fi + +if [ -z "${PACKAGIST_SAFE_KEY}" ]; then + errors+=("The PACKAGIST_SAFE_KEY secret has not been set. Please set it in either this repository's secrets or your organization secrets") +fi + +lenErrors=${#errors[@]} + +if [[ lenErrors -gt 0 ]]; then + echo -e "Found the following errors in the release environment:\n" + + for error in "${errors[@]}"; do + echo -e "- $error\n" + done + + exit 1 +fi + +echo "The environment is ready to push releases!" diff --git a/composer.json b/composer.json index 32efa114..7f793c41 100644 --- a/composer.json +++ b/composer.json @@ -1,46 +1,51 @@ { - "authors": [ - { - "name": "Imagekit", - "homepage": "https://github.com/imagekit-developer/imagekit-php/graphs/contributors" - } - ], - "autoload": { - "psr-4": { - "ImageKit\\": "src/ImageKit/" - } + "$schema": "https://getcomposer.org/schema.json", + "autoload": { + "files": ["src/Core.php", "src/Client.php"], + "psr-4": { + "ImageKit\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Tests\\": "tests/" + } + }, + "config": { + "allow-plugins": { + "pestphp/pest-plugin": true, + "php-http/discovery": false, + "phpstan/extension-installer": true }, - "autoload-dev": { - "psr-4": { - "ImageKit\\Tests\\": "tests/" - } + "platform": { + "php": "8.3" }, - "description": "PHP library for Imagekit", - "homepage": "https://github.com/imagekit-developer/imagekit-php", - "keywords": [ - "library", - "imagekit", - "image management" - ], - "license": "MIT", - "name": "imagekit/imagekit", - "require": { - "php": ">=5.6.0", - "ext-curl": "*", - "guzzlehttp/guzzle": "~6.0 || ~7.0", - "ext-json": "*", - "beberlei/assert": "^2.9.9" - }, - "config": { - "platform": { - "php": "5.6" - } - }, - "require-dev": { - "phpunit/phpunit": "^5.7.27" - }, - "support": { - "email": "support@imagekit.io" - }, - "type": "library" + "preferred-install": "dist", + "sort-packages": true + }, + "description": "Image Kit PHP SDK", + "name": "imagekit/imagekit", + "require": { + "php": "^8.1", + "php-http/discovery": "^1", + "psr/http-client": "^1", + "psr/http-client-implementation": "^1", + "psr/http-factory-implementation": "^1", + "psr/http-message": "^1|^2" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3", + "nyholm/psr7": "^1", + "pestphp/pest": "^3", + "phpstan/extension-installer": "^1", + "phpstan/phpstan": "^2", + "phpstan/phpstan-phpunit": "^2", + "phpunit/phpunit": "^11", + "symfony/http-client": "^7" + }, + "scripts": { + "build:docs": "curl --etag-save ./vendor/ag.etags --etag-compare ./vendor/ag.etags --create-dirs --remote-name --output-dir ./vendor/bin --no-progress-meter -- https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar && php ./vendor/bin/apigen.phar --output docs -- src", + "lint": "./scripts/lint", + "test": "./scripts/test" + } } diff --git a/composer.lock b/composer.lock deleted file mode 100644 index 7594938f..00000000 --- a/composer.lock +++ /dev/null @@ -1,2395 +0,0 @@ -{ - "_readme": [ - "This file locks the dependencies of your project to a known state", - "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", - "This file is @generated automatically" - ], - "content-hash": "39a1be44588c84272c5860de8d14993c", - "packages": [ - { - "name": "beberlei/assert", - "version": "v2.9.9", - "source": { - "type": "git", - "url": "https://github.com/beberlei/assert.git", - "reference": "124317de301b7c91d5fce34c98bba2c6925bec95" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/beberlei/assert/zipball/124317de301b7c91d5fce34c98bba2c6925bec95", - "reference": "124317de301b7c91d5fce34c98bba2c6925bec95", - "shasum": "" - }, - "require": { - "ext-mbstring": "*", - "php": ">=5.3" - }, - "require-dev": { - "friendsofphp/php-cs-fixer": "^2.1.1", - "phpunit/phpunit": "^4.8.35|^5.7" - }, - "type": "library", - "autoload": { - "files": [ - "lib/Assert/functions.php" - ], - "psr-4": { - "Assert\\": "lib/Assert" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-2-Clause" - ], - "authors": [ - { - "name": "Benjamin Eberlei", - "email": "kontakt@beberlei.de", - "role": "Lead Developer" - }, - { - "name": "Richard Quadling", - "email": "rquadling@gmail.com", - "role": "Collaborator" - } - ], - "description": "Thin assertion library for input validation in business models.", - "keywords": [ - "assert", - "assertion", - "validation" - ], - "support": { - "issues": "https://github.com/beberlei/assert/issues", - "source": "https://github.com/beberlei/assert/tree/v2.9.9" - }, - "time": "2019-05-28T15:27:37+00:00" - }, - { - "name": "guzzlehttp/guzzle", - "version": "6.5.8", - "source": { - "type": "git", - "url": "https://github.com/guzzle/guzzle.git", - "reference": "a52f0440530b54fa079ce76e8c5d196a42cad981" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/guzzle/guzzle/zipball/a52f0440530b54fa079ce76e8c5d196a42cad981", - "reference": "a52f0440530b54fa079ce76e8c5d196a42cad981", - "shasum": "" - }, - "require": { - "ext-json": "*", - "guzzlehttp/promises": "^1.0", - "guzzlehttp/psr7": "^1.9", - "php": ">=5.5", - "symfony/polyfill-intl-idn": "^1.17" - }, - "require-dev": { - "ext-curl": "*", - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.4 || ^7.0", - "psr/log": "^1.1" - }, - "suggest": { - "psr/log": "Required for using the Log middleware" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "6.5-dev" - } - }, - "autoload": { - "files": [ - "src/functions_include.php" - ], - "psr-4": { - "GuzzleHttp\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Graham Campbell", - "email": "hello@gjcampbell.co.uk", - "homepage": "https://github.com/GrahamCampbell" - }, - { - "name": "Michael Dowling", - "email": "mtdowling@gmail.com", - "homepage": "https://github.com/mtdowling" - }, - { - "name": "Jeremy Lindblom", - "email": "jeremeamia@gmail.com", - "homepage": "https://github.com/jeremeamia" - }, - { - "name": "George Mponos", - "email": "gmponos@gmail.com", - "homepage": "https://github.com/gmponos" - }, - { - "name": "Tobias Nyholm", - "email": "tobias.nyholm@gmail.com", - "homepage": "https://github.com/Nyholm" - }, - { - "name": "Márk Sági-Kazár", - "email": "mark.sagikazar@gmail.com", - "homepage": "https://github.com/sagikazarmark" - }, - { - "name": "Tobias Schultze", - "email": "webmaster@tubo-world.de", - "homepage": "https://github.com/Tobion" - } - ], - "description": "Guzzle is a PHP HTTP client library", - "homepage": "http://guzzlephp.org/", - "keywords": [ - "client", - "curl", - "framework", - "http", - "http client", - "rest", - "web service" - ], - "support": { - "issues": "https://github.com/guzzle/guzzle/issues", - "source": "https://github.com/guzzle/guzzle/tree/6.5.8" - }, - "funding": [ - { - "url": "https://github.com/GrahamCampbell", - "type": "github" - }, - { - "url": "https://github.com/Nyholm", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle", - "type": "tidelift" - } - ], - "time": "2022-06-20T22:16:07+00:00" - }, - { - "name": "guzzlehttp/promises", - "version": "1.5.3", - "source": { - "type": "git", - "url": "https://github.com/guzzle/promises.git", - "reference": "67ab6e18aaa14d753cc148911d273f6e6cb6721e" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/guzzle/promises/zipball/67ab6e18aaa14d753cc148911d273f6e6cb6721e", - "reference": "67ab6e18aaa14d753cc148911d273f6e6cb6721e", - "shasum": "" - }, - "require": { - "php": ">=5.5" - }, - "require-dev": { - "symfony/phpunit-bridge": "^4.4 || ^5.1" - }, - "type": "library", - "autoload": { - "files": [ - "src/functions_include.php" - ], - "psr-4": { - "GuzzleHttp\\Promise\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Graham Campbell", - "email": "hello@gjcampbell.co.uk", - "homepage": "https://github.com/GrahamCampbell" - }, - { - "name": "Michael Dowling", - "email": "mtdowling@gmail.com", - "homepage": "https://github.com/mtdowling" - }, - { - "name": "Tobias Nyholm", - "email": "tobias.nyholm@gmail.com", - "homepage": "https://github.com/Nyholm" - }, - { - "name": "Tobias Schultze", - "email": "webmaster@tubo-world.de", - "homepage": "https://github.com/Tobion" - } - ], - "description": "Guzzle promises library", - "keywords": [ - "promise" - ], - "support": { - "issues": "https://github.com/guzzle/promises/issues", - "source": "https://github.com/guzzle/promises/tree/1.5.3" - }, - "funding": [ - { - "url": "https://github.com/GrahamCampbell", - "type": "github" - }, - { - "url": "https://github.com/Nyholm", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises", - "type": "tidelift" - } - ], - "time": "2023-05-21T12:31:43+00:00" - }, - { - "name": "guzzlehttp/psr7", - "version": "1.9.1", - "source": { - "type": "git", - "url": "https://github.com/guzzle/psr7.git", - "reference": "e4490cabc77465aaee90b20cfc9a770f8c04be6b" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/guzzle/psr7/zipball/e4490cabc77465aaee90b20cfc9a770f8c04be6b", - "reference": "e4490cabc77465aaee90b20cfc9a770f8c04be6b", - "shasum": "" - }, - "require": { - "php": ">=5.4.0", - "psr/http-message": "~1.0", - "ralouphie/getallheaders": "^2.0.5 || ^3.0.0" - }, - "provide": { - "psr/http-message-implementation": "1.0" - }, - "require-dev": { - "ext-zlib": "*", - "phpunit/phpunit": "~4.8.36 || ^5.7.27 || ^6.5.14 || ^7.5.20 || ^8.5.8 || ^9.3.10" - }, - "suggest": { - "laminas/laminas-httphandlerrunner": "Emit PSR-7 responses" - }, - "type": "library", - "autoload": { - "files": [ - "src/functions_include.php" - ], - "psr-4": { - "GuzzleHttp\\Psr7\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Graham Campbell", - "email": "hello@gjcampbell.co.uk", - "homepage": "https://github.com/GrahamCampbell" - }, - { - "name": "Michael Dowling", - "email": "mtdowling@gmail.com", - "homepage": "https://github.com/mtdowling" - }, - { - "name": "George Mponos", - "email": "gmponos@gmail.com", - "homepage": "https://github.com/gmponos" - }, - { - "name": "Tobias Nyholm", - "email": "tobias.nyholm@gmail.com", - "homepage": "https://github.com/Nyholm" - }, - { - "name": "Márk Sági-Kazár", - "email": "mark.sagikazar@gmail.com", - "homepage": "https://github.com/sagikazarmark" - }, - { - "name": "Tobias Schultze", - "email": "webmaster@tubo-world.de", - "homepage": "https://github.com/Tobion" - } - ], - "description": "PSR-7 message implementation that also provides common utility methods", - "keywords": [ - "http", - "message", - "psr-7", - "request", - "response", - "stream", - "uri", - "url" - ], - "support": { - "issues": "https://github.com/guzzle/psr7/issues", - "source": "https://github.com/guzzle/psr7/tree/1.9.1" - }, - "funding": [ - { - "url": "https://github.com/GrahamCampbell", - "type": "github" - }, - { - "url": "https://github.com/Nyholm", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7", - "type": "tidelift" - } - ], - "time": "2023-04-17T16:00:37+00:00" - }, - { - "name": "paragonie/random_compat", - "version": "v2.0.21", - "source": { - "type": "git", - "url": "https://github.com/paragonie/random_compat.git", - "reference": "96c132c7f2f7bc3230723b66e89f8f150b29d5ae" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/paragonie/random_compat/zipball/96c132c7f2f7bc3230723b66e89f8f150b29d5ae", - "reference": "96c132c7f2f7bc3230723b66e89f8f150b29d5ae", - "shasum": "" - }, - "require": { - "php": ">=5.2.0" - }, - "require-dev": { - "phpunit/phpunit": "*" - }, - "suggest": { - "ext-libsodium": "Provides a modern crypto API that can be used to generate random bytes." - }, - "type": "library", - "autoload": { - "files": [ - "lib/random.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Paragon Initiative Enterprises", - "email": "security@paragonie.com", - "homepage": "https://paragonie.com" - } - ], - "description": "PHP 5.x polyfill for random_bytes() and random_int() from PHP 7", - "keywords": [ - "csprng", - "polyfill", - "pseudorandom", - "random" - ], - "support": { - "email": "info@paragonie.com", - "issues": "https://github.com/paragonie/random_compat/issues", - "source": "https://github.com/paragonie/random_compat" - }, - "time": "2022-02-16T17:07:03+00:00" - }, - { - "name": "psr/http-message", - "version": "1.0.1", - "source": { - "type": "git", - "url": "https://github.com/php-fig/http-message.git", - "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/php-fig/http-message/zipball/f6561bf28d520154e4b0ec72be95418abe6d9363", - "reference": "f6561bf28d520154e4b0ec72be95418abe6d9363", - "shasum": "" - }, - "require": { - "php": ">=5.3.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "psr-4": { - "Psr\\Http\\Message\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "PHP-FIG", - "homepage": "http://www.php-fig.org/" - } - ], - "description": "Common interface for HTTP messages", - "homepage": "https://github.com/php-fig/http-message", - "keywords": [ - "http", - "http-message", - "psr", - "psr-7", - "request", - "response" - ], - "support": { - "source": "https://github.com/php-fig/http-message/tree/master" - }, - "time": "2016-08-06T14:39:51+00:00" - }, - { - "name": "ralouphie/getallheaders", - "version": "3.0.3", - "source": { - "type": "git", - "url": "https://github.com/ralouphie/getallheaders.git", - "reference": "120b605dfeb996808c31b6477290a714d356e822" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822", - "reference": "120b605dfeb996808c31b6477290a714d356e822", - "shasum": "" - }, - "require": { - "php": ">=5.6" - }, - "require-dev": { - "php-coveralls/php-coveralls": "^2.1", - "phpunit/phpunit": "^5 || ^6.5" - }, - "type": "library", - "autoload": { - "files": [ - "src/getallheaders.php" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Ralph Khattar", - "email": "ralph.khattar@gmail.com" - } - ], - "description": "A polyfill for getallheaders.", - "support": { - "issues": "https://github.com/ralouphie/getallheaders/issues", - "source": "https://github.com/ralouphie/getallheaders/tree/develop" - }, - "time": "2019-03-08T08:55:37+00:00" - }, - { - "name": "symfony/polyfill-intl-idn", - "version": "v1.19.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-intl-idn.git", - "reference": "4ad5115c0f5d5172a9fe8147675ec6de266d8826" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/4ad5115c0f5d5172a9fe8147675ec6de266d8826", - "reference": "4ad5115c0f5d5172a9fe8147675ec6de266d8826", - "shasum": "" - }, - "require": { - "php": ">=5.3.3", - "symfony/polyfill-intl-normalizer": "^1.10", - "symfony/polyfill-php70": "^1.10", - "symfony/polyfill-php72": "^1.10" - }, - "suggest": { - "ext-intl": "For best performance" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "1.19-dev" - }, - "thanks": { - "name": "symfony/polyfill", - "url": "https://github.com/symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Intl\\Idn\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Laurent Bassin", - "email": "laurent@bassin.info" - }, - { - "name": "Trevor Rowbotham", - "email": "trevor.rowbotham@pm.me" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "idn", - "intl", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-intl-idn/tree/v1.19.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-21T09:57:48+00:00" - }, - { - "name": "symfony/polyfill-intl-normalizer", - "version": "v1.19.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-intl-normalizer.git", - "reference": "8db0ae7936b42feb370840cf24de1a144fb0ef27" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/8db0ae7936b42feb370840cf24de1a144fb0ef27", - "reference": "8db0ae7936b42feb370840cf24de1a144fb0ef27", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "suggest": { - "ext-intl": "For best performance" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "1.19-dev" - }, - "thanks": { - "name": "symfony/polyfill", - "url": "https://github.com/symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Intl\\Normalizer\\": "" - }, - "classmap": [ - "Resources/stubs" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for intl's Normalizer class and related functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "intl", - "normalizer", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.19.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-23T09:01:57+00:00" - }, - { - "name": "symfony/polyfill-php70", - "version": "v1.19.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-php70.git", - "reference": "3fe414077251a81a1b15b1c709faf5c2fbae3d4e" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php70/zipball/3fe414077251a81a1b15b1c709faf5c2fbae3d4e", - "reference": "3fe414077251a81a1b15b1c709faf5c2fbae3d4e", - "shasum": "" - }, - "require": { - "paragonie/random_compat": "~1.0|~2.0|~9.99", - "php": ">=5.3.3" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "1.19-dev" - }, - "thanks": { - "name": "symfony/polyfill", - "url": "https://github.com/symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Php70\\": "" - }, - "classmap": [ - "Resources/stubs" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill backporting some PHP 7.0+ features to lower PHP versions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-php70/tree/v1.19.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-23T09:01:57+00:00" - }, - { - "name": "symfony/polyfill-php72", - "version": "v1.19.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-php72.git", - "reference": "beecef6b463b06954638f02378f52496cb84bacc" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php72/zipball/beecef6b463b06954638f02378f52496cb84bacc", - "reference": "beecef6b463b06954638f02378f52496cb84bacc", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "1.19-dev" - }, - "thanks": { - "name": "symfony/polyfill", - "url": "https://github.com/symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Php72\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-php72/tree/v1.19.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-23T09:01:57+00:00" - } - ], - "packages-dev": [ - { - "name": "doctrine/instantiator", - "version": "1.0.5", - "source": { - "type": "git", - "url": "https://github.com/doctrine/instantiator.git", - "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/doctrine/instantiator/zipball/8e884e78f9f0eb1329e445619e04456e64d8051d", - "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d", - "shasum": "" - }, - "require": { - "php": ">=5.3,<8.0-DEV" - }, - "require-dev": { - "athletic/athletic": "~0.1.8", - "ext-pdo": "*", - "ext-phar": "*", - "phpunit/phpunit": "~4.0", - "squizlabs/php_codesniffer": "~2.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "psr-4": { - "Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Marco Pivetta", - "email": "ocramius@gmail.com", - "homepage": "http://ocramius.github.com/" - } - ], - "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors", - "homepage": "https://github.com/doctrine/instantiator", - "keywords": [ - "constructor", - "instantiate" - ], - "support": { - "issues": "https://github.com/doctrine/instantiator/issues", - "source": "https://github.com/doctrine/instantiator/tree/1.0.5" - }, - "funding": [ - { - "url": "https://www.doctrine-project.org/sponsorship.html", - "type": "custom" - }, - { - "url": "https://www.patreon.com/phpdoctrine", - "type": "patreon" - }, - { - "url": "https://tidelift.com/funding/github/packagist/doctrine%2Finstantiator", - "type": "tidelift" - } - ], - "time": "2015-06-14T21:17:01+00:00" - }, - { - "name": "myclabs/deep-copy", - "version": "1.7.0", - "source": { - "type": "git", - "url": "https://github.com/myclabs/DeepCopy.git", - "reference": "3b8a3a99ba1f6a3952ac2747d989303cbd6b7a3e" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/myclabs/DeepCopy/zipball/3b8a3a99ba1f6a3952ac2747d989303cbd6b7a3e", - "reference": "3b8a3a99ba1f6a3952ac2747d989303cbd6b7a3e", - "shasum": "" - }, - "require": { - "php": "^5.6 || ^7.0" - }, - "require-dev": { - "doctrine/collections": "^1.0", - "doctrine/common": "^2.6", - "phpunit/phpunit": "^4.1" - }, - "type": "library", - "autoload": { - "files": [ - "src/DeepCopy/deep_copy.php" - ], - "psr-4": { - "DeepCopy\\": "src/DeepCopy/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "description": "Create deep copies (clones) of your objects", - "keywords": [ - "clone", - "copy", - "duplicate", - "object", - "object graph" - ], - "support": { - "issues": "https://github.com/myclabs/DeepCopy/issues", - "source": "https://github.com/myclabs/DeepCopy/tree/1.x" - }, - "time": "2017-10-19T19:58:43+00:00" - }, - { - "name": "phpdocumentor/reflection-common", - "version": "1.0.1", - "source": { - "type": "git", - "url": "https://github.com/phpDocumentor/ReflectionCommon.git", - "reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionCommon/zipball/21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6", - "reference": "21bdeb5f65d7ebf9f43b1b25d404f87deab5bfb6", - "shasum": "" - }, - "require": { - "php": ">=5.5" - }, - "require-dev": { - "phpunit/phpunit": "^4.6" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "psr-4": { - "phpDocumentor\\Reflection\\": [ - "src" - ] - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Jaap van Otterdijk", - "email": "opensource@ijaap.nl" - } - ], - "description": "Common reflection classes used by phpdocumentor to reflect the code structure", - "homepage": "http://www.phpdoc.org", - "keywords": [ - "FQSEN", - "phpDocumentor", - "phpdoc", - "reflection", - "static analysis" - ], - "support": { - "issues": "https://github.com/phpDocumentor/ReflectionCommon/issues", - "source": "https://github.com/phpDocumentor/ReflectionCommon/tree/master" - }, - "time": "2017-09-11T18:02:19+00:00" - }, - { - "name": "phpdocumentor/reflection-docblock", - "version": "3.3.2", - "source": { - "type": "git", - "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/bf329f6c1aadea3299f08ee804682b7c45b326a2", - "reference": "bf329f6c1aadea3299f08ee804682b7c45b326a2", - "shasum": "" - }, - "require": { - "php": "^5.6 || ^7.0", - "phpdocumentor/reflection-common": "^1.0.0", - "phpdocumentor/type-resolver": "^0.4.0", - "webmozart/assert": "^1.0" - }, - "require-dev": { - "mockery/mockery": "^0.9.4", - "phpunit/phpunit": "^4.4" - }, - "type": "library", - "autoload": { - "psr-4": { - "phpDocumentor\\Reflection\\": [ - "src/" - ] - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Mike van Riel", - "email": "me@mikevanriel.com" - } - ], - "description": "With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.", - "support": { - "issues": "https://github.com/phpDocumentor/ReflectionDocBlock/issues", - "source": "https://github.com/phpDocumentor/ReflectionDocBlock/tree/release/3.x" - }, - "time": "2017-11-10T14:09:06+00:00" - }, - { - "name": "phpdocumentor/type-resolver", - "version": "0.4.0", - "source": { - "type": "git", - "url": "https://github.com/phpDocumentor/TypeResolver.git", - "reference": "9c977708995954784726e25d0cd1dddf4e65b0f7" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/TypeResolver/zipball/9c977708995954784726e25d0cd1dddf4e65b0f7", - "reference": "9c977708995954784726e25d0cd1dddf4e65b0f7", - "shasum": "" - }, - "require": { - "php": "^5.5 || ^7.0", - "phpdocumentor/reflection-common": "^1.0" - }, - "require-dev": { - "mockery/mockery": "^0.9.4", - "phpunit/phpunit": "^5.2||^4.8.24" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "psr-4": { - "phpDocumentor\\Reflection\\": [ - "src/" - ] - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Mike van Riel", - "email": "me@mikevanriel.com" - } - ], - "support": { - "issues": "https://github.com/phpDocumentor/TypeResolver/issues", - "source": "https://github.com/phpDocumentor/TypeResolver/tree/master" - }, - "time": "2017-07-14T14:27:02+00:00" - }, - { - "name": "phpspec/prophecy", - "version": "v1.10.3", - "source": { - "type": "git", - "url": "https://github.com/phpspec/prophecy.git", - "reference": "451c3cd1418cf640de218914901e51b064abb093" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/451c3cd1418cf640de218914901e51b064abb093", - "reference": "451c3cd1418cf640de218914901e51b064abb093", - "shasum": "" - }, - "require": { - "doctrine/instantiator": "^1.0.2", - "php": "^5.3|^7.0", - "phpdocumentor/reflection-docblock": "^2.0|^3.0.2|^4.0|^5.0", - "sebastian/comparator": "^1.2.3|^2.0|^3.0|^4.0", - "sebastian/recursion-context": "^1.0|^2.0|^3.0|^4.0" - }, - "require-dev": { - "phpspec/phpspec": "^2.5 || ^3.2", - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.5 || ^7.1" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.10.x-dev" - } - }, - "autoload": { - "psr-4": { - "Prophecy\\": "src/Prophecy" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Konstantin Kudryashov", - "email": "ever.zet@gmail.com", - "homepage": "http://everzet.com" - }, - { - "name": "Marcello Duarte", - "email": "marcello.duarte@gmail.com" - } - ], - "description": "Highly opinionated mocking framework for PHP 5.3+", - "homepage": "https://github.com/phpspec/prophecy", - "keywords": [ - "Double", - "Dummy", - "fake", - "mock", - "spy", - "stub" - ], - "support": { - "issues": "https://github.com/phpspec/prophecy/issues", - "source": "https://github.com/phpspec/prophecy/tree/v1.10.3" - }, - "time": "2020-03-05T15:02:03+00:00" - }, - { - "name": "phpunit/php-code-coverage", - "version": "4.0.8", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "ef7b2f56815df854e66ceaee8ebe9393ae36a40d" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/ef7b2f56815df854e66ceaee8ebe9393ae36a40d", - "reference": "ef7b2f56815df854e66ceaee8ebe9393ae36a40d", - "shasum": "" - }, - "require": { - "ext-dom": "*", - "ext-xmlwriter": "*", - "php": "^5.6 || ^7.0", - "phpunit/php-file-iterator": "^1.3", - "phpunit/php-text-template": "^1.2", - "phpunit/php-token-stream": "^1.4.2 || ^2.0", - "sebastian/code-unit-reverse-lookup": "^1.0", - "sebastian/environment": "^1.3.2 || ^2.0", - "sebastian/version": "^1.0 || ^2.0" - }, - "require-dev": { - "ext-xdebug": "^2.1.4", - "phpunit/phpunit": "^5.7" - }, - "suggest": { - "ext-xdebug": "^2.5.1" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "4.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", - "role": "lead" - } - ], - "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", - "homepage": "https://github.com/sebastianbergmann/php-code-coverage", - "keywords": [ - "coverage", - "testing", - "xunit" - ], - "support": { - "irc": "irc://irc.freenode.net/phpunit", - "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/4.0" - }, - "time": "2017-04-02T07:44:40+00:00" - }, - { - "name": "phpunit/php-file-iterator", - "version": "1.4.5", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4", - "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.4.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", - "role": "lead" - } - ], - "description": "FilterIterator implementation that filters files based on a list of suffixes.", - "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", - "keywords": [ - "filesystem", - "iterator" - ], - "support": { - "irc": "irc://irc.freenode.net/phpunit", - "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues", - "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/1.4.5" - }, - "time": "2017-11-27T13:52:08+00:00" - }, - { - "name": "phpunit/php-text-template", - "version": "1.2.1", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/php-text-template.git", - "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/31f8b717e51d9a2afca6c9f046f5d69fc27c8686", - "reference": "31f8b717e51d9a2afca6c9f046f5d69fc27c8686", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "type": "library", - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" - } - ], - "description": "Simple template engine.", - "homepage": "https://github.com/sebastianbergmann/php-text-template/", - "keywords": [ - "template" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/php-text-template/issues", - "source": "https://github.com/sebastianbergmann/php-text-template/tree/1.2.1" - }, - "time": "2015-06-21T13:50:34+00:00" - }, - { - "name": "phpunit/php-timer", - "version": "1.0.9", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", - "reference": "3dcf38ca72b158baf0bc245e9184d3fdffa9c46f", - "shasum": "" - }, - "require": { - "php": "^5.3.3 || ^7.0" - }, - "require-dev": { - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", - "role": "lead" - } - ], - "description": "Utility class for timing", - "homepage": "https://github.com/sebastianbergmann/php-timer/", - "keywords": [ - "timer" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/php-timer/issues", - "source": "https://github.com/sebastianbergmann/php-timer/tree/master" - }, - "time": "2017-02-26T11:10:40+00:00" - }, - { - "name": "phpunit/php-token-stream", - "version": "1.4.12", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/php-token-stream.git", - "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/1ce90ba27c42e4e44e6d8458241466380b51fa16", - "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16", - "shasum": "" - }, - "require": { - "ext-tokenizer": "*", - "php": ">=5.3.3" - }, - "require-dev": { - "phpunit/phpunit": "~4.2" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.4-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Wrapper around PHP's tokenizer extension.", - "homepage": "https://github.com/sebastianbergmann/php-token-stream/", - "keywords": [ - "tokenizer" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/php-token-stream/issues", - "source": "https://github.com/sebastianbergmann/php-token-stream/tree/1.4" - }, - "abandoned": true, - "time": "2017-12-04T08:55:13+00:00" - }, - { - "name": "phpunit/phpunit", - "version": "5.7.27", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "b7803aeca3ccb99ad0a506fa80b64cd6a56bbc0c" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/b7803aeca3ccb99ad0a506fa80b64cd6a56bbc0c", - "reference": "b7803aeca3ccb99ad0a506fa80b64cd6a56bbc0c", - "shasum": "" - }, - "require": { - "ext-dom": "*", - "ext-json": "*", - "ext-libxml": "*", - "ext-mbstring": "*", - "ext-xml": "*", - "myclabs/deep-copy": "~1.3", - "php": "^5.6 || ^7.0", - "phpspec/prophecy": "^1.6.2", - "phpunit/php-code-coverage": "^4.0.4", - "phpunit/php-file-iterator": "~1.4", - "phpunit/php-text-template": "~1.2", - "phpunit/php-timer": "^1.0.6", - "phpunit/phpunit-mock-objects": "^3.2", - "sebastian/comparator": "^1.2.4", - "sebastian/diff": "^1.4.3", - "sebastian/environment": "^1.3.4 || ^2.0", - "sebastian/exporter": "~2.0", - "sebastian/global-state": "^1.1", - "sebastian/object-enumerator": "~2.0", - "sebastian/resource-operations": "~1.0", - "sebastian/version": "^1.0.6|^2.0.1", - "symfony/yaml": "~2.1|~3.0|~4.0" - }, - "conflict": { - "phpdocumentor/reflection-docblock": "3.0.2" - }, - "require-dev": { - "ext-pdo": "*" - }, - "suggest": { - "ext-xdebug": "*", - "phpunit/php-invoker": "~1.1" - }, - "bin": [ - "phpunit" - ], - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "5.7.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" - } - ], - "description": "The PHP Unit Testing framework.", - "homepage": "https://phpunit.de/", - "keywords": [ - "phpunit", - "testing", - "xunit" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/phpunit/issues", - "source": "https://github.com/sebastianbergmann/phpunit/tree/5.7.27" - }, - "time": "2018-02-01T05:50:59+00:00" - }, - { - "name": "phpunit/phpunit-mock-objects", - "version": "3.4.4", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", - "reference": "a23b761686d50a560cc56233b9ecf49597cc9118" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/a23b761686d50a560cc56233b9ecf49597cc9118", - "reference": "a23b761686d50a560cc56233b9ecf49597cc9118", - "shasum": "" - }, - "require": { - "doctrine/instantiator": "^1.0.2", - "php": "^5.6 || ^7.0", - "phpunit/php-text-template": "^1.2", - "sebastian/exporter": "^1.2 || ^2.0" - }, - "conflict": { - "phpunit/phpunit": "<5.4.0" - }, - "require-dev": { - "phpunit/phpunit": "^5.4" - }, - "suggest": { - "ext-soap": "*" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "3.2.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", - "role": "lead" - } - ], - "description": "Mock Object library for PHPUnit", - "homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/", - "keywords": [ - "mock", - "xunit" - ], - "support": { - "irc": "irc://irc.freenode.net/phpunit", - "issues": "https://github.com/sebastianbergmann/phpunit-mock-objects/issues", - "source": "https://github.com/sebastianbergmann/phpunit-mock-objects/tree/3.4" - }, - "abandoned": true, - "time": "2017-06-30T09:13:00+00:00" - }, - { - "name": "sebastian/code-unit-reverse-lookup", - "version": "1.0.2", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/code-unit-reverse-lookup.git", - "reference": "1de8cd5c010cb153fcd68b8d0f64606f523f7619" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/code-unit-reverse-lookup/zipball/1de8cd5c010cb153fcd68b8d0f64606f523f7619", - "reference": "1de8cd5c010cb153fcd68b8d0f64606f523f7619", - "shasum": "" - }, - "require": { - "php": ">=5.6" - }, - "require-dev": { - "phpunit/phpunit": "^8.5" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Looks up which function or method a line of code belongs to", - "homepage": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/", - "support": { - "issues": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/issues", - "source": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/tree/1.0.2" - }, - "funding": [ - { - "url": "https://github.com/sebastianbergmann", - "type": "github" - } - ], - "time": "2020-11-30T08:15:22+00:00" - }, - { - "name": "sebastian/comparator", - "version": "1.2.4", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", - "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", - "shasum": "" - }, - "require": { - "php": ">=5.3.3", - "sebastian/diff": "~1.2", - "sebastian/exporter": "~1.2 || ~2.0" - }, - "require-dev": { - "phpunit/phpunit": "~4.4" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.2.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, - { - "name": "Volker Dusch", - "email": "github@wallbash.com" - }, - { - "name": "Bernhard Schussek", - "email": "bschussek@2bepublished.at" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Provides the functionality to compare PHP values for equality", - "homepage": "http://www.github.com/sebastianbergmann/comparator", - "keywords": [ - "comparator", - "compare", - "equality" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/comparator/issues", - "source": "https://github.com/sebastianbergmann/comparator/tree/1.2" - }, - "time": "2017-01-29T09:50:25+00:00" - }, - { - "name": "sebastian/diff", - "version": "1.4.3", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7f066a26a962dbe58ddea9f72a4e82874a3975a4", - "reference": "7f066a26a962dbe58ddea9f72a4e82874a3975a4", - "shasum": "" - }, - "require": { - "php": "^5.3.3 || ^7.0" - }, - "require-dev": { - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.4-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Kore Nordmann", - "email": "mail@kore-nordmann.de" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Diff implementation", - "homepage": "https://github.com/sebastianbergmann/diff", - "keywords": [ - "diff" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/diff/issues", - "source": "https://github.com/sebastianbergmann/diff/tree/1.4" - }, - "time": "2017-05-22T07:24:03+00:00" - }, - { - "name": "sebastian/environment", - "version": "2.0.0", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/environment.git", - "reference": "5795ffe5dc5b02460c3e34222fee8cbe245d8fac" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/5795ffe5dc5b02460c3e34222fee8cbe245d8fac", - "reference": "5795ffe5dc5b02460c3e34222fee8cbe245d8fac", - "shasum": "" - }, - "require": { - "php": "^5.6 || ^7.0" - }, - "require-dev": { - "phpunit/phpunit": "^5.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Provides functionality to handle HHVM/PHP environments", - "homepage": "http://www.github.com/sebastianbergmann/environment", - "keywords": [ - "Xdebug", - "environment", - "hhvm" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/environment/issues", - "source": "https://github.com/sebastianbergmann/environment/tree/master" - }, - "time": "2016-11-26T07:53:53+00:00" - }, - { - "name": "sebastian/exporter", - "version": "2.0.0", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "ce474bdd1a34744d7ac5d6aad3a46d48d9bac4c4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/ce474bdd1a34744d7ac5d6aad3a46d48d9bac4c4", - "reference": "ce474bdd1a34744d7ac5d6aad3a46d48d9bac4c4", - "shasum": "" - }, - "require": { - "php": ">=5.3.3", - "sebastian/recursion-context": "~2.0" - }, - "require-dev": { - "ext-mbstring": "*", - "phpunit/phpunit": "~4.4" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, - { - "name": "Volker Dusch", - "email": "github@wallbash.com" - }, - { - "name": "Bernhard Schussek", - "email": "bschussek@2bepublished.at" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - }, - { - "name": "Adam Harvey", - "email": "aharvey@php.net" - } - ], - "description": "Provides the functionality to export PHP variables for visualization", - "homepage": "http://www.github.com/sebastianbergmann/exporter", - "keywords": [ - "export", - "exporter" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/exporter/issues", - "source": "https://github.com/sebastianbergmann/exporter/tree/master" - }, - "time": "2016-11-19T08:54:04+00:00" - }, - { - "name": "sebastian/global-state", - "version": "1.1.1", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/global-state.git", - "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/bc37d50fea7d017d3d340f230811c9f1d7280af4", - "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "require-dev": { - "phpunit/phpunit": "~4.2" - }, - "suggest": { - "ext-uopz": "*" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Snapshotting of global state", - "homepage": "http://www.github.com/sebastianbergmann/global-state", - "keywords": [ - "global state" - ], - "support": { - "issues": "https://github.com/sebastianbergmann/global-state/issues", - "source": "https://github.com/sebastianbergmann/global-state/tree/1.1.1" - }, - "time": "2015-10-12T03:26:01+00:00" - }, - { - "name": "sebastian/object-enumerator", - "version": "2.0.1", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/object-enumerator.git", - "reference": "1311872ac850040a79c3c058bea3e22d0f09cbb7" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/1311872ac850040a79c3c058bea3e22d0f09cbb7", - "reference": "1311872ac850040a79c3c058bea3e22d0f09cbb7", - "shasum": "" - }, - "require": { - "php": ">=5.6", - "sebastian/recursion-context": "~2.0" - }, - "require-dev": { - "phpunit/phpunit": "~5" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Traverses array structures and object graphs to enumerate all referenced objects", - "homepage": "https://github.com/sebastianbergmann/object-enumerator/", - "support": { - "issues": "https://github.com/sebastianbergmann/object-enumerator/issues", - "source": "https://github.com/sebastianbergmann/object-enumerator/tree/master" - }, - "time": "2017-02-18T15:18:39+00:00" - }, - { - "name": "sebastian/recursion-context", - "version": "2.0.0", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/recursion-context.git", - "reference": "2c3ba150cbec723aa057506e73a8d33bdb286c9a" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/2c3ba150cbec723aa057506e73a8d33bdb286c9a", - "reference": "2c3ba150cbec723aa057506e73a8d33bdb286c9a", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "require-dev": { - "phpunit/phpunit": "~4.4" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - }, - { - "name": "Adam Harvey", - "email": "aharvey@php.net" - } - ], - "description": "Provides functionality to recursively process PHP variables", - "homepage": "http://www.github.com/sebastianbergmann/recursion-context", - "support": { - "issues": "https://github.com/sebastianbergmann/recursion-context/issues", - "source": "https://github.com/sebastianbergmann/recursion-context/tree/master" - }, - "time": "2016-11-19T07:33:16+00:00" - }, - { - "name": "sebastian/resource-operations", - "version": "1.0.0", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/resource-operations.git", - "reference": "ce990bb21759f94aeafd30209e8cfcdfa8bc3f52" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/resource-operations/zipball/ce990bb21759f94aeafd30209e8cfcdfa8bc3f52", - "reference": "ce990bb21759f94aeafd30209e8cfcdfa8bc3f52", - "shasum": "" - }, - "require": { - "php": ">=5.6.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - } - ], - "description": "Provides a list of PHP built-in functions that operate on resources", - "homepage": "https://www.github.com/sebastianbergmann/resource-operations", - "support": { - "issues": "https://github.com/sebastianbergmann/resource-operations/issues", - "source": "https://github.com/sebastianbergmann/resource-operations/tree/master" - }, - "time": "2015-07-28T20:34:47+00:00" - }, - { - "name": "sebastian/version", - "version": "2.0.1", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/version.git", - "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/99732be0ddb3361e16ad77b68ba41efc8e979019", - "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019", - "shasum": "" - }, - "require": { - "php": ">=5.6" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" - } - ], - "description": "Library that helps with managing the version number of Git-hosted PHP projects", - "homepage": "https://github.com/sebastianbergmann/version", - "support": { - "issues": "https://github.com/sebastianbergmann/version/issues", - "source": "https://github.com/sebastianbergmann/version/tree/master" - }, - "time": "2016-10-03T07:35:21+00:00" - }, - { - "name": "symfony/polyfill-ctype", - "version": "v1.19.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-ctype.git", - "reference": "aed596913b70fae57be53d86faa2e9ef85a2297b" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/aed596913b70fae57be53d86faa2e9ef85a2297b", - "reference": "aed596913b70fae57be53d86faa2e9ef85a2297b", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "suggest": { - "ext-ctype": "For best performance" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "1.19-dev" - }, - "thanks": { - "name": "symfony/polyfill", - "url": "https://github.com/symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Ctype\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Gert de Pagter", - "email": "BackEndTea@gmail.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for ctype functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "ctype", - "polyfill", - "portable" - ], - "support": { - "source": "https://github.com/symfony/polyfill-ctype/tree/v1.19.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-23T09:01:57+00:00" - }, - { - "name": "symfony/yaml", - "version": "v3.4.47", - "source": { - "type": "git", - "url": "https://github.com/symfony/yaml.git", - "reference": "88289caa3c166321883f67fe5130188ebbb47094" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/88289caa3c166321883f67fe5130188ebbb47094", - "reference": "88289caa3c166321883f67fe5130188ebbb47094", - "shasum": "" - }, - "require": { - "php": "^5.5.9|>=7.0.8", - "symfony/polyfill-ctype": "~1.8" - }, - "conflict": { - "symfony/console": "<3.4" - }, - "require-dev": { - "symfony/console": "~3.4|~4.0" - }, - "suggest": { - "symfony/console": "For validating YAML files using the lint command" - }, - "type": "library", - "autoload": { - "psr-4": { - "Symfony\\Component\\Yaml\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony Yaml Component", - "homepage": "https://symfony.com", - "support": { - "source": "https://github.com/symfony/yaml/tree/v3.4.47" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2020-10-24T10:57:07+00:00" - }, - { - "name": "webmozart/assert", - "version": "1.9.1", - "source": { - "type": "git", - "url": "https://github.com/webmozarts/assert.git", - "reference": "bafc69caeb4d49c39fd0779086c03a3738cbb389" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/webmozarts/assert/zipball/bafc69caeb4d49c39fd0779086c03a3738cbb389", - "reference": "bafc69caeb4d49c39fd0779086c03a3738cbb389", - "shasum": "" - }, - "require": { - "php": "^5.3.3 || ^7.0 || ^8.0", - "symfony/polyfill-ctype": "^1.8" - }, - "conflict": { - "phpstan/phpstan": "<0.12.20", - "vimeo/psalm": "<3.9.1" - }, - "require-dev": { - "phpunit/phpunit": "^4.8.36 || ^7.5.13" - }, - "type": "library", - "autoload": { - "psr-4": { - "Webmozart\\Assert\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Bernhard Schussek", - "email": "bschussek@gmail.com" - } - ], - "description": "Assertions to validate method input/output with nice error messages.", - "keywords": [ - "assert", - "check", - "validate" - ], - "support": { - "issues": "https://github.com/webmozarts/assert/issues", - "source": "https://github.com/webmozarts/assert/tree/1.9.1" - }, - "time": "2020-07-08T17:02:28+00:00" - } - ], - "aliases": [], - "minimum-stability": "stable", - "stability-flags": [], - "prefer-stable": false, - "prefer-lowest": false, - "platform": { - "php": ">=5.6.0", - "ext-curl": "*", - "ext-json": "*" - }, - "platform-dev": [], - "platform-overrides": { - "php": "5.6" - }, - "plugin-api-version": "2.2.0" -} diff --git a/phpstan.dist.neon b/phpstan.dist.neon new file mode 100644 index 00000000..1cdf47d8 --- /dev/null +++ b/phpstan.dist.neon @@ -0,0 +1,14 @@ +parameters: + level: max + phpVersion: + min: 80100 + max: 80499 + paths: + - src + - tests + ignoreErrors: + - identifier: parameter.defaultValue + - identifier: trait.unused + - identifier: property.onlyWritten + + reportUnmatchedIgnoredErrors: false diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 00dd3c89..41860103 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,17 +1,18 @@ - + - - - src - - - - - tests - - + cacheDirectory=".phpunit.cache" + colors="true" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" +> + + + ./src + + + + + ./tests + + diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 00000000..1891660d --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,66 @@ +{ + "packages": { + ".": {} + }, + "$schema": "https://raw.githubusercontent.com/stainless-api/release-please/main/schemas/config.json", + "include-v-in-tag": true, + "include-component-in-tag": false, + "versioning": "prerelease", + "prerelease": true, + "bump-minor-pre-major": true, + "bump-patch-for-minor-pre-major": false, + "pull-request-header": "Automated Release PR", + "pull-request-title-pattern": "release: ${version}", + "changelog-sections": [ + { + "type": "feat", + "section": "Features" + }, + { + "type": "fix", + "section": "Bug Fixes" + }, + { + "type": "perf", + "section": "Performance Improvements" + }, + { + "type": "revert", + "section": "Reverts" + }, + { + "type": "chore", + "section": "Chores" + }, + { + "type": "docs", + "section": "Documentation" + }, + { + "type": "style", + "section": "Styles" + }, + { + "type": "refactor", + "section": "Refactors" + }, + { + "type": "test", + "section": "Tests", + "hidden": true + }, + { + "type": "build", + "section": "Build System" + }, + { + "type": "ci", + "section": "Continuous Integration", + "hidden": true + } + ], + "release-type": "php", + "extra-files": [ + "README.md" + ] +} \ No newline at end of file diff --git a/sample/README.md b/sample/README.md deleted file mode 100644 index 2b83ab87..00000000 --- a/sample/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Running the sample application - -### Step 1 -Open `sample.php` and fill the account details: -```php -$public_key = 'your_public_key'; -$your_private_key = 'your_private_key'; -$url_end_point = 'https://ik.imagekit.io/demo'; -``` - -### Step 2: -Run the `sample.php` file. -```bash -php sample.php -``` \ No newline at end of file diff --git a/sample/file_management/index.php b/sample/file_management/index.php deleted file mode 100644 index 2d8e3ada..00000000 --- a/sample/file_management/index.php +++ /dev/null @@ -1,319 +0,0 @@ -listFiles(); - -echo "\n\n"; -echo "1. List All Files: \n"; -echo "\033[01;32m".print_r($listFiles,true)."\033[0m"; -echo "\n"; - -$file_id = $listFiles->result[0]->fileId; -$version_id = $listFiles->result[0]->versionInfo->id; -$filePath = $listFiles->result[0]->filePath; -$sourceFilePath = $listFiles->result[0]->filePath; - -// List Filtered Files - -$listFilteredFiles = $imageKit->listFiles([ - "type" => "file", - "sort" => "ASC_CREATED", - "path" => "/sample-folder", - "fileType" => "all", - "limit" => 10, - "skip" => 0, - "tags" => ["tag3","tag4"], -]); - -echo "\n\n"; -echo "2. List Filtered Files: \n"; -echo "\033[01;32m".print_r($listFilteredFiles,true)."\033[0m"; -echo "\n"; - -// Advance Search Filtered Files - -$advanceSearchFilteredFiles = $imageKit->listFiles([ - "searchQuery" => '(size < "50kb" AND width > 500) OR (tags IN ["summer-sale","banner"])', -]); - -echo "\n\n"; -echo "3. Advance Search Filtered Files: \n"; -echo "\033[01;32m".print_r($advanceSearchFilteredFiles,true)."\033[0m"; -echo "\n"; - -// Get File Details -$getFileDetails = $imageKit->getFileDetails($file_id); - -echo "\n\n"; -echo "4. Get File Details: \n"; -echo "\033[01;32m".print_r($getFileDetails,true)."\033[0m"; -echo "\n"; - -// Get File Version Details -$getFileVersionDetails = $imageKit->getFileVersionDetails($file_id,$version_id); - -echo "\n\n"; -echo "5. Get File Version Details: \n"; -echo "\033[01;32m".print_r($getFileVersionDetails,true)."\033[0m"; -echo "\n"; - -// Get File Versions -$getFileVersions = $imageKit->getFileVersions($file_id); - - -echo "\n\n"; -echo "6. Get File Versions: \n"; -echo "\033[01;32m".print_r($getFileVersions,true)."\033[0m"; -echo "\n"; - -// Update File Details -$updateData = [ - "removeAITags" => "all", // "all" or ["tag1","tag2"] - "webhookUrl" => "https://example.com/webhook", - "tags" => ["tag3", "tag4"], -]; - -$updateFileDetails = $imageKit->updateFileDetails( - $file_id, - $updateData -); - -echo "\n\n"; -echo "7. Update File Details: \n"; -echo "\033[01;32m".print_r($updateFileDetails,true)."\033[0m"; -echo "\n"; - -// Add Tags (Bulk) -$fileIds = [$file_id]; -$tags = ['image_tag_1', 'image_tag_2']; - -$bulkAddTags = $imageKit->bulkAddTags($fileIds, $tags); - -echo "\n\n"; -echo "8. Add Tags (Bulk): \n"; -echo "\033[01;32m".print_r($bulkAddTags,true)."\033[0m"; -echo "\n"; - -// Remove Tags (Bulk) -$fileIds = [$file_id]; -$tags = ['image_tag_1', 'image_tag_2']; - -$bulkRemoveTags = $imageKit->bulkRemoveTags($fileIds, $tags); - -echo "\n\n"; -echo "9. Remove Tags (Bulk): \n"; -echo "\033[01;32m".print_r($bulkRemoveTags,true)."\033[0m"; -echo "\n"; - -// Remove AI Tags (Bulk) -$fileIds = [$file_id]; -$AITags = ['image_AITag_1', 'image_AITag_2']; - -$bulkRemoveAITags = $imageKit->bulkRemoveAITags($fileIds, $AITags); - -echo "\n\n"; -echo "10. Remove AI Tags (Bulk): \n"; -echo "\033[01;32m".print_r($bulkRemoveAITags,true)."\033[0m"; -echo "\n"; - -// Copy File - -$destinationPath = '/sample-folder2/'; -$copyFile = $imageKit->copy([ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => false -]); - -echo "\n\n"; -echo "11. Copy File: \n"; -echo "\033[01;32m".print_r($copyFile,true)."\033[0m"; -echo "\n"; - -// Move File - -$destinationPath = '/'; -$moveFile = $imageKit->move([ - 'sourceFilePath' => '/sample-folder2/default-image.jpg', - 'destinationPath' => $destinationPath -]); - -echo "\n\n"; -echo "12. Move File: \n"; -echo "\033[01;32m".print_r($moveFile,true)."\033[0m"; -echo "\n"; - -// Rename File with purge cache false - -$newFileName = 'sample-file2.jpg'; -$renameFile = $imageKit->rename([ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - 'purgeCache' => false -]); - -echo "\n\n"; -echo "13. Rename File with Pruge Cache False: \n"; -echo "\033[01;32m".print_r($renameFile,true)."\033[0m"; -echo "\n"; - -// Rename File with Purge Cache true - -$newFileName = 'sample-file3.jpg'; -$renameFile = $imageKit->renameFile([ - 'filePath' => $filePath, - 'newFileName' => $newFileName, -], true); - -echo "\n\n"; -echo "14. Rename File with Pruge Cache True: \n"; -echo "\033[01;32m".print_r($renameFile,true)."\033[0m"; -echo "\n"; - -// Restore File Version - -$restoreFileVersion = $imageKit->restoreFileVersion([ - 'fileId' => $file_id, - 'versionId' => $version_id, -]); - -echo "\n\n"; -echo "15. Restore File Version: \n"; -echo "\033[01;32m".print_r($restoreFileVersion,true)."\033[0m"; -echo "\n"; - -// Create Folder - -$folderName = 'new-folder'; -$parentFolderPath = '/'; -$createFolder = $imageKit->createFolder([ - 'folderName' => $folderName, - 'parentFolderPath' => $parentFolderPath, -]); - -echo "\n\n"; -echo "16. Create Folder: \n"; -echo "\033[01;32m".print_r($createFolder,true)."\033[0m"; -echo "\n"; - -// Copy Folder - -$sourceFolderPath = $folderName; -$destinationPath = '/sample-folder'; -$includeFileVersions = false; -$copyFolder = $imageKit->copyFolder([ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => $includeFileVersions -]); - -echo "\n\n"; -echo "17. Copy Folder: \n"; -echo "\033[01;32m".print_r($copyFolder,true)."\033[0m"; -echo "\n"; - -// Move Folder - -$sourceFolderPath = $folderName; -$destinationPath = '/sample-folder'; -$moveFolder = $imageKit->moveFolder([ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath -]); - -$job_id = $moveFolder->result->jobId; - -echo "\n\n"; -echo "18. Move Folder: \n"; -echo "\033[01;32m".print_r($moveFolder,true)."\033[0m"; -echo "\n"; - - -// Delete Folder -$folderPath = '/sample-folder/new-folder'; -$deleteFolder = $imageKit->deleteFolder($folderPath); - -echo "\n\n"; -echo "19. Delete Folder: \n"; -echo "\033[01;32m".print_r($deleteFolder,true)."\033[0m"; -echo "\n"; - -// Bulk Job Status - -$bulkJobStatus = $imageKit->getBulkJobStatus($job_id); - -echo "\n\n"; -echo "20. Bulk Job Status: \n"; -echo "\033[01;32m".print_r($bulkJobStatus,true)."\033[0m"; -echo "\n"; - -// Purge Cache - -$image_url = $url_end_point.'/sample-folder/default-image.jpg'; -$purgeCache = $imageKit->purgeCache($image_url); -$cacheRequestId = $purgeCache->result->requestId; -echo "\n\n"; -echo "21. Purge Cache: \n"; -echo "\033[01;32m".print_r($purgeCache,true)."\033[0m"; -echo "\n"; - -// Purge Cache Status - -$getPurgeCacheStatus = $imageKit->getPurgeCacheStatus($cacheRequestId); - -echo "\n\n"; -echo "22. Purge Cache Status: \n"; -echo "\033[01;32m".print_r($getPurgeCacheStatus,true)."\033[0m"; -echo "\n"; - -// Get File Metadata (From File ID) - -$getFileMetadata = $imageKit->getFileMetaData($file_id); - -echo "\n\n"; -echo "23. Get File Metadata (From File ID): \n"; -echo "\033[01;32m".print_r($getFileMetadata,true)."\033[0m"; -echo "\n"; - -// Get File Metadata (From Remote URL) - -$getFileMetadata = $imageKit->getFileMetadataFromRemoteURL($image_url); - -echo "\n\n"; -echo "24. Get File Metadata (From Remote URL): \n"; -echo "\033[01;32m".print_r($getFileMetadata,true)."\033[0m"; -echo "\n"; - -// Delete File Version - -$deleteFileVersion = $imageKit->deleteFileVersion($file_id, $version_id); - -echo "\n\n"; -echo "25. Delete File Version: \n"; -echo "\033[01;32m".print_r($deleteFileVersion,true)."\033[0m"; -echo "\n"; - -// Delete File - -$deleteFile = $imageKit->deleteFile($file_id); - -echo "\n\n"; -echo "26. Delete File: \n"; -echo "\033[01;32m".print_r($deleteFile,true)."\033[0m"; -echo "\n"; - -// Delete Files (Bulk) - -$fileIds = [$file_id]; -$deleteFiles = $imageKit->bulkDeleteFiles($fileIds); - -echo "\n\n"; -echo "27. Delete Files (Bulk): \n"; -echo "\033[01;32m".print_r($deleteFiles,true)."\033[0m"; -echo "\n"; diff --git a/sample/metadata/index.php b/sample/metadata/index.php deleted file mode 100644 index 4c2fbed3..00000000 --- a/sample/metadata/index.php +++ /dev/null @@ -1,62 +0,0 @@ - "net_price", // required - "label" => "Net Price", // required - "schema" => [ // required - "type" => 'Number', // required - "minValue" => 1000, - "maxValue" => 5000, - ], -]; - -$createCustomMetadataField = $imageKit->createCustomMetadataField($body); - -echo "\n\n"; -echo "1. Create Fields: \n"; -echo "\033[01;32m".print_r($createCustomMetadataField,true)."\033[0m"; -echo "\n"; - -// Get Fields - -$includeDeleted = false; -$getCustomMetadataFields = $imageKit->getCustomMetadataFields($includeDeleted); -$customMetadataFieldId = $getCustomMetadataFields->result[0]->id; - -echo "\n\n"; -echo "2. Get Fields: \n"; -echo "\033[01;32m".print_r($getCustomMetadataFields,true)."\033[0m"; -echo "\n"; - -// Update Field - -$body = [ - "label" => "Net Price2", - "schema" => [ - "type"=>'Number' - ], -]; - -$updateCustomMetadataField = $imageKit->updateCustomMetadataField($customMetadataFieldId, $body); - -echo "\n\n"; -echo "3. Update Field: \n"; -echo "\033[01;32m".print_r($updateCustomMetadataField,true)."\033[0m"; -echo "\n"; - -// Delete Field - -$deleteCustomMetadataField = $imageKit->deleteCustomMetadataField($customMetadataFieldId); - -echo "\n\n"; -echo "4. Delete Field: \n"; -echo "\033[01;32m".print_r($deleteCustomMetadataField,true)."\033[0m"; -echo "\n"; - diff --git a/sample/sample.php b/sample/sample.php deleted file mode 100644 index ac3cc383..00000000 --- a/sample/sample.php +++ /dev/null @@ -1,31 +0,0 @@ -Q<0H13BF#rq{G&D36%)bE!2IdPa5*+M5 zpduo|BcY>WV4$O-qhsO_e#OMX$3{oTCBwxhA|fFn!Td`8jhy%!Au$Q@f0ID``xN#I zED9VP3NaQs7V-aYeD(s+;ULN(e?mc!10c~MpwJ;c`vHUi03_6Zs|EZYpr9cjVZH!h z;r?0iAOQav|IhT_69N(n8s>8qfCL2rfJB2r`}gKlX4!o_rLk^a$q){BTN;Cco1@lP zAch=X1|OH}m7Kz+lLpI)AM$$&CbD)nM!--OIh<4&LxhX1N*46YlXfLl1hqgEFmqab zIssv!>{!}p!xuAeoz*y}BM+go`AhmP2G)@powK!&`G}*`SM~1?$;5S64)loG0`oj% zt$Z9P+1BH_hPWXU-6aICX&jn!-T*JHQ%g7#rU<1%Xy1HnTEb+7rbyX{-vD4`uQ>zp z-5+my-E2_A^7GN!@ocOYs+Rz7SP7lZN=kvW3VEf+&o*R-<(y@|Qo&yF3*Bc3^gqM* zr&w6i?$w>DI(oL^i;xCVO45Zzm85O0=`_-$mGF`&`bp^i}7fE~94Nb3Qv-Vn_4d*F0_t@yUe#Ywd{Ad(gtPYqlgt;Z8khU61xRVzJ9h2mB zLBy--&G&Y+A@!DC&A8x2{I)VQX#Un{&q)alccx|2X_9Xcim7Z_FNPO1uQ@$tV+xWn zh(A@wgOJ$wv%Zyz&&nEP*M(_(_JXm(Ezr!-+A(s!+SQLKot7C_c@S#Vfw!f(-_<^D zfS&508^|HAhpNzb)LQtpDMcz>5n67EFtClygIo}2hQ*JtS@=yoH3uiy=!>Ju{lNYR zkf*?{9k6$r+R|D7)VQF3>z!OU|iB454ngBH` zvbQmNin=koN|njC`)P$6I+124^t#k)MeV|JN0XIulU2vZ6GFjg)@*XOFV+U>;p*q) zzgn1XLl!-&>--#EiXz*t`*c@ogOEv8F^mjZ0GpptNzHRC%Z~5ED7ttSg`i6GRhR88w}bvE2PKsEODdX zMu&A#H)V)Kf$poJ7_}tk6j;%Z5sK7-QF#SnYz1|US)OF+LZv_*fnR%SX19p4nT<>~t!l7TPSq9#a4aXA*1lm>OT~C-cdzAWcbcw&vFsMmwuwB76>`7*=GiCfLL^j&h zdMSB~f7KELz9r_86{-QnsY}Xj6Xw|y;QkOW6PF|Xkfk;99w zs1=;fS=v_T9jO12P%PN=25GyMk>i?4V~op}X~q(?HA+r^ zoNhbpzdhA9%3@6x^iXJ!SImeLO$2V{(@P5s{{1{ZGOz1+#qi?^aW-Q(Db; zt+&!D7wIt38g(i2YX_^523d*<5h2ieN|cU8zb{;5##V?h4fGbW%N-ibS-0qw5E3)4 zTlKb5Ami@LS~!R*-XE&-!Wq$J!#LTtCK~n+PQ?^?2k=)$7e)&t9@jZ0p>ip)8?kzu z*p|z3UpJ|?$@8tc4XTZCr^byy&7PItLRfaWqg`x`24u?TRH@Dld3kZ@Ih4cW!_XTu zq68H{GefBAj1~4$s#0RbDDI`&sebf9JI6NjzStAYss;UiwG1U3Y^|qhSPJ_RT0L@?;c@T!?At1BdDw9#OD)uhyp4+A zyn24qFy4USzTR%2K~>t}+uI}MyY_pdL$&22YbFo*SRy`${`6J}SoPYPo5_Ic}mitRWCynoU z6#`@2X5OU;yDlb1F=zg$v37&{t6g#)ZKDL%(g?ky#r4jqvqGt7$##!+cX9a4;3l~l zL+p*WIwv4=n29`HJ7d5tU#@dDgg>t_+f8Da7W<74?gKT*5(anccTEP96~;7|DPB_x z@hf<5jdOjP-YG43LKl>NvT#lVyj>#_v?EaPOZHUwDL%Szq;vWsc2VbG)X$l{w#d0E zeE)oL0Q)=RrF-d7Dwhp{lg);1GAlwrx9Qawj4yKRrf5h6KO1=iXwz2STWdUT*6z^maX_1SNs0)%mhw{>Cp^Vq@}l1xV>J z?XJiPc4}T3hstf-t&wv@OCw!6hD4X9HhzJzyZ8>`J3%!)BIV?SKB4S1jI_CRw?|O>kE@5M# zT%WyxA|-IIwUQ15-uwL3BMzf6^F(aB;7rKgoJ{?p^7cC5QlY=f;Q~C3Co8% zr+nS1F7NQs2K;Sp93uB}*t)Yij_&E50$5k9FE`Ha)D?~G9f!56IyXy6Vybu@CYy$u z(;m!KK6w$RMTAS9(~iE3f()9swgh39tqjH91%oq{`s0wV^2{dGX>lKZp1TjJK3?7B zY`^HFGAkvi@!v8O<1<+Q34kqCpit$p<^PTSFESi!o2IFMq%}PgN4g^e)w^e(oky-r`iN z=`A@#@7IJ#o57f8n>B%;0gAG%0-wBuA&O(!pNsNY41Nyt@@6nK43Qm^Vue4YAO`5( zEuv4?kY2Uyg!Q4m%1DPEHR{rVU~u7BbU@%zFlpZW+wA$SHzhfoLw;4lNbwd?xF(JTSTq)Z1sLV z)|E^TPCFijkGt{mYI5KCr@5vpeAS=4^ZMiB&}0XW^|Bd~S?$Y`d1O4ql`)_aGupPJ z(O`2MjDQHtb8^1B6?m@|iXVL3Gm-F0GLo918VDohhCgx-!ZqC^Nl+Z|{ON}hx-#aM zbko501N$w6JRp#Vjx()B7Q&DXIN>NmpX)C8@=C_+P9r+L8 z6{3;rJDs)^sm$gGJy?CoEN5-4dnN0Hp164q3{RlSD>rTn|1i<7?#Q^CQV=73>ZDv|D(*zb7i<8%6OU)7G+S3Hah zLEb78^S7nVR%wKhvestD2jcr#cJf z!D`sn&KUDe-uVt{a2qCY(_h9I#;O8_$29E)aQN-GQ{s!`_Fdd67Mz-#;*T9+7=cCg z>>M`>FI;Rl4KEx`4WocZL3m$*BZOJDq7v7I^aW2h_Jzv)#7jl-(xw4XvjmLFYSna| z=ZWpC0`s4%ZagxXyK15($K~|AkqY&v>kY}F8Yy+gwfJEQ@dAZz2unO;QJfs+5Ai@O zOjqN2fI)RoXAI7!(O1!s;M;Pq#u+>|G%ryL4z^p@P#XNr7D@WFHqtX{Wh?H`Qut~f z(K_kp2vLG52ovjkw#GA0LSvk!Xh|iffSi}p=`VS|Hyn^**!9Ncoz{QQb^Wxnl8w%5 z_?575BQ8ewRP#m!V+FxQpUpuqmK2rIRpbe4b(sK3d4Zbc!F8&ZI!d>w5$D9&6vq-Q zJEI0Yu_=NM5*#~LJ7eIPfRjJmAd$*ilYcX>D{MPO;mz31OM}ra0xjOto&HRli@ja_ zZ8gs><9rE0n#O($PmwO=$jue9F0y@Bq3NaeSR_R@{?{Q7)W`O;Cth^ZRd+0@lNAm+c z^cVa2!DwM4$*}bFJGAed$E3vJmG_&KK=%B5x;lDE9Lq9kmN?cqu?Z;1m!_-M9 zgW(ir4@(d1vT*?J*0$ktJi!=A>v!`S?C7sO#;~~|aL~jdH1{{u8oXGpu}@uiK7G4z z!b7I$STKfHyf?LZgLkD)np_MY>2QLc3Wmn7aOwAkD?YK8xW3%bb^Arl)|VwO3?Dlo zaHRJn<`#-Wh_QNR zjIaJ0JLl|>3Jts?pr*U%q`y0ZoD|ZX?|Gh3;r-Ivxg@D7D`koEqozX8~if(D)Zc}^;FKE zy4B|u383zrzvG?nHGt;T{gHzNh4e`bss9sj5&{Ju)OThG78Doi6tCNMdySl{IWM_| z8L#f|e(KlSEIqg)_%R#$A;cO~4=;a@Lf;bF^9mn{;|eST`|k;UXT7EKsxt5v$rX8Z ze|SQ(_Y0kVKje*syQ|*!;Lh`{sd6WJQzJweezW?|+sjOp%Lsu-zD?h2~_p=9DC~$fVC~U_) za<_*>g?aKraQ;^B07`!F&YleH2M*&>=j3D)_C0k1e{1StTcDu2qWt5yuDFd3Z46x^ zEBSBE-E0}nKGy7yD4$6sjsrx|X^xLT@A5}U{%`L;D#xZ7)paQYkVfU@Ug`}%bpGS+l@5sPu$2Ns%zrZ-RKY7kLc z3A8dNC*Ypl>F`>Ys5HQbr`RmiNMmd%o+VEhR!%%O z*E&5HT=fGQ8%l9pJ^>?a>+ZLL6_qqgmJ^eb%EE<0cs}vF>P_DqHEsL#D~qEB2x)>O zu1}(?E}lc`Vw%;j=?qw7NyGp@eSh{H_j1(Ok)NVQPkg`f({+>^{Gd3V*#_U47NL!i zvdW2QgC(Kz*JIX_-Z~2GXb>4c40N*ab<37WR-1KHx-v4`Kn7<={&%B38WXT-rD3%} zOUe4BL7s!fKZiX66Hqa3FRT4^IpG3u=@0*oC0VsrPOi_-qsdR4GHrYUTA&vXl6q@U zNd$5+cNt_XZIJw1&Aml5%-cC!X-bG2 zLN=s_;FU<_usb{_F8;}67@jIBv@0Ta{g$}OfaAfQQk4G`;lnQ_vg z-ROL%Rj(|$m7FL+z+Y9GTs{Hac8Sh}llO#pG>6|!e~>Lkb;z6qa_IS^uhk7>o;ZnK zXrM(*t1D`f?MM(P&1fh78b*@TvC=ta{a2;9U0)Pe!xE(A0nR9Tm%gJ?-qrt2C)ZIo zc;=mk6S?W+=q^9J`f<`NLF~?uBp{3fFZ}?8&r$Q_k*E4*=J}%=#TQNiCXy#=qi~|T zF*K_C*_BNy%4Lt>k5-;Z)9^I@fiLppc&9HDD+NxHd2&-Jb)T#`=_62k!0}?ASC$|u zw<&prSEh*TDaDQ+OAdQmF}%)%YuP)>JlO!pSBX(Sqo}j}1~w9hl%Q)t=C5-C+euyW zU|s=2@JbD=bF7ieTMh7(XVIOzbRE3@{=K$VmHlKvCQQ#bZWd5l7C5BRo=o#5oF6Q9I%|(Lxc1#rmWC-E4i`}a#Fi=McpdVTW%rZ zN4Zx28#h~4mZ!H$Iy$s_@#w@*-e7I}=e?1!PHq5zWELf6m{Ydc-N^hW-w(4V^buB>o|7fEvj`G zvyLAes8=vOz}7#FyqQh>G2hEnIBHpGOSIFFk_FvbpwXYcYQ?emQT)X?AmfGW%x2v&mIX%Xu|O(VadA=Q(Qi6ZGC<<*l zjNa^N4BU=%=~t382iYy1es!>W!kSE3cLt}IQ%+nA3r9j@>L)p-HbsIdC~Dc;z~}*s z$?|n<7a|$HEhj}I3UZ-Q?R&+<8bB*5?p6ThMNMVWc@O@#3gT0)wRdyzlk@j8E5UgM z0MWn`YJXRn^_9USeY{l)FXfBxl0tTtVw= zsN2cOZgdCo*Fmd$^Rzr-@x!*?ujAHjHLkmnxcO~NG>E%X%OE%5YMx{ica1y_OO0ab z>;JH0B(%$-l}OLZGd-e2t#3s?t#2OD;L}EI3b2d~?b^7g^_tuPp$2Sbn0MBu6bPd! zL`d8e>(*iBfOfCMolLZ!fSF`ZLEKlJk&zfsB6y#e@D)ypCEZFc^QM*~i` zM|`dp?HBl1jp*bu_D{f#Y5YBIG|EpmMxeoTQPoD`O{8|pGf!!6WVdgKu774~vMv%1 zywYkZJ_)jaM8tAh78SoAex(LpNOk0U7o$~(<^ znq!D1`F$W7t=+&%XEEME4ispvOY3Xim-C*?;3MRm{ze(mGr`}E(< zq%y5<6}aaKsJKRI$%I%rX5%jm(3>8&;#choBmSbpr-JqvL&B&WeD6+45}+CFPzlp5 zx0ytP8)oMQO&xd=F_Zii1aSVE>yP4*wAw!NB8G~wdOMO_?NqznoaiqPHLAvXEWPu* zsqI#CiE?+bEgtX_I@VSiv!BR~O4uqL6q}5HHFrW_tAk{gG4^eh|3jrzEL`EuXS|})2uIjldG(Uf}~vP(dsUT+8SE)wysa0 zJ9TiquS|27zdd1( z(cp_i;9bGrSEB2upPun*WS;eKGFoDiwczYAuwp{PfO%k3jA?95i4 zE=ISbpQ(uaUKD|xk_fIAxj8O{(JhTal(qk&f~JBCxv0lBzUJ9g~W;t z;drllc)be0oO!{J}r-TszT z03zBFkqo#IV|}@l1t+<6MZ@*f)zJ<_8x8*%ShF}-VY#Di$l+$(Q29`Idk(?foXqt7 zSPxk#9W~Y~8qRQ>!{4*BSE6W?At3mQr;c^%9w2whvl6SK*O))A_eIT!Jf59kNO2a3 zwU?3^`>YbQA)tW>i?klda;y{g1dgzHj7^jHneESLb2yE^y)NE9Tu$uv8e>Z(j$)psa9Tlk7 zb#z>8qdPEOH*WQPsVBkAd>3P{X{v25cF|;{G1!#nAehw9_n4zUWgLddN^fNtfH*Hy z+dka0Gnvz>CcD>^Bs$Nkw1A(HYUk=R>M56f`MGIdvyv2^uvS-LtRd4f*HY$+)KuYe zUewfGLg`?On(b>ce@Yui?e_=Nc}V#{=%WkeDq%Ua6qlCPvLVby5{O!L&*;ssFJPt_ zJZiR1SI*3P&f}hbqch+m{0WektPeVw>@5_6`bRO?-|X+*p5g|PH}*))J4bC^3URVc zwf#*;)AZ9{pOWEXf=Nnt6Daifsckz~s;2$o{AgJCwV3*ZczrzUG@sIA-jQ4-n5M4U z9N9$m@1Saud??v!qD!6s;E7pzh4y+krmNAME>`&}W1G3TTMRtNR_5M{&@@>V=2p-< z@+Urcj@Dq@&(-yf{&_)Ca?lrB&yi(7jJpIY(wp(glinAm!xMZ(9is(5KgUeMPe9ct zAi=Vp*+0eQDo6M|+?|@~(rgww<~@!YiA3!;w7CJD~qa*W0PL^I0L))stc%#5-MYn%Qd zAJB{Yk|s+n3GrRe5MIZEtU)-6ZmZ}67n{3<`blPdC2{I&afP?j{FJTMlOe^9WS)=k z^^q`QwOgHu>hSV946#OIhFfcN4+uxsdzp2R&b#8~;&)>azcWG?5ip(d_^T}I`&0Tk zQYdJ4!FWxKxw!9b$smSj!3Ew@Wrg!y;~y=WK!UFFF4r#Mv>xdC5b%sO57)afL{F-b z5$<&i^l7Y$v=)uEQy$7BzK!Es{0b_Zlidmpsf;#|bSqLYCeN7y8fcE(l^tT9lE^1Q z^XB>5s-BgFG8IyAJD;9YcX}&ci2gasWYBKYH#bySGt?|T`Flcr?b`DR$R{~U;cs&a zD5H@1z_s;iD66)%wb40l(o|Rdi54Co!<({eaG346~N5A@toaSb-w!ugkixg~f9_p)4*`8c0VcUu0lV#`5B85F>{f z#(<_$ZOs9(=H7GpgH7c5p!IEty7rVlj|GjkdX<<}l}o`q>W;F9tG*Ri{kv|Q^0w34 zax!YkWT8y^z-l5}L%MaxzwB9tR6`nB+Z*2hO`TX8ilw|1dITF_$?7rQ2wM|*$y zPPZ-^EB?~htVhz*I`SooThKU|5NSO@t!%82`!;M^l0TUy!1Psn!A7u>eX)WB*Wuh6 ze>A#ZI65ZB-(QjN#OxrhiB1m8)2wK2lu_OF7B`_e&=J*?rECd<1!0(A?NRh0zLnb2 z1ZFr%E03$^##QP%%SK2)sepAK-6D>T-5Rw^pF6IWKInJ5ZbV~2msU0qX=FQ{r#o}S z+5~!N3X~TE)Lo&`i?z!;g9F;iOK7}76)OqB(q-`miBCaJ5u6O{;c2>%@p~!>CA|Qi zt7Nh&H|^!=fXU&2PKk^>?u^)__I85nh1i6a(70i9<$DQ{7PLha{-mao;gzu1mBH%9 zNQ*s#>)Q7f+%%!pcyHWgtn+s7cq#mOZCmRpFo*{C$c+ShML(3fYL{I(*6!N6ZJhpe z6oRd`D|N4?QKh~+_e&Sp4!=Z*6Cn^kJ)ICq19A4+JNv%H+eb&P6w|i=&GGIUNs$Ft zG31f-A!C+W@)1b!8tF|8H$kwWlMT#{pRFSUNX&2j+U3lVb^6j(oMgR(xBh6~*Hv_{ zs--a~aCSjbIt9I;Q(M&yr$~{Qg;S}t(HK_03+7%aPWhLn!hoz7#566a_tbqZKR|VY zk%qySw(74Q%d%@jUHwYoy=VBo_Ff-8A-0SXk8B2s{2KSmpz5MsQiS_?uYnZ)y9{M@ zLo}k^xeR1(Zupc}L$=3iXai7PvZJdTq>};U)CAv*c06zE-f&C zP#a*E6R|bTQ=eW@jmS}V{ILcKkgE^7^_M6v)CT6v zR$n?`QkXewJ(NRL3IqC$?d3`{$d%G)LBjHWlkScZ+LoAQWb~2R5k9AOWJ2Iy#o_*S z1N=%Br;C{~YmVQc!Y6^6DR=ah6XY`_0qrmh?F&+B+I{IBI-RH)>FNC0iP(1Yr${dI|Dd+afk?LgUYJ5w7 zS1)i-KWh{+uY9;&8f(RBIShDt{Rxb|3_lJZ6O>g}fC7%Sv~E&W28)T;D<)LS5{R|7 z6cJswjHgWZ)F-)SdHmgl+V>G2DELh<5GA`)%e8*9M#@fmm#UG1XqeCs-Z<^6)*pg}#(RTbx^+_q?h1<~Dw;^+Gwm8F$fbi(cM9x-#FC zvPoOPUnFodjYe+bl`JJmrXb{WT!Jxz-}Oa@HYC`!uV^YF>}^ zAyazW%6ODasr}kkUF8R0vr_?IJ)tI$s7tEWC~=-XTUoD>sG_w&kON7W?~!W{pmQ2a z%x4Y$4P*?vZ%k5RQ^aR9;9E9Z7iZT2Od7bu2k!{UTDq1K+4rH|M_RP%_Sh20wM{oB zHl3BKG(K947jc(fGbD)$XcdN{Fgm@e`6;3;{H>36CLV)tP0377U=3&W>FqkGR!$hO z8q~e=x6@_lqQeir@>8{ecx-)Cebd!6NQ+2=x8%90ch<8*fN5MIZcI#8wv;ucpoLYb zZF-{L-)~AuAyZ1BZYJonm}?x@M5)V|G7E#fc`ef)&k8og;skQhqo_F6m&@;S=CuXhqP4u5U*j4is?8N zN#U7&0c|xj!!vqXtsHVFYja&&xY6&$d`X#TRjO%T)=4{L&UISIh2euWbc<+5`$+Dj zk|W}itR*uD)H3{?aG6&*_EpxICG)Jg)~qNmR%@OSIS^Db)7#L=K`+U?_TVKOvuzf5b8judcw53RX%^Pp4d1};;I{?c}a?!VAx;pY2{zb!<{F!`I ziHxFy(9zBMuKH8)uTMTdspmz9!km%YkUf`cWXU&4jS&NhAx)M|*0~6A`z5vOic>PH z&d71DL9Yo%281WF&x|~QI9+U$s@|M$PzSiU;;_ms4INfL9+r)6;Ui4m)Qs5upiL3` zn-Hma#^X+T18`zY8!#P-ox-7oVtl!|dBtd{Q(iv-HgcZ;>ra5!CqTbf?qfMic3$FD>GlMwt5AkfeuNy%6- zzC*DnW0JEOL&J!O{tv7EPkbN@A)8uV7%9u7IRhMsJqBfN%^5y6c)ey%e~iB3HhV1$ zBr{3HR59pwF5Y)e3P$IqhzV7h>{k=Q?-b9Twaw*$BEV8aaJ`Y+?y^Y8A;rXU>j`{t_6-n9%}8hC=ERG z&rIBShX_S^Fi712*BR0FShZHJzm02BBGtxdwX)GmYQ^HC&4>YSyknVxy*>l-D^?Vv zE0!avKuG~&4SmqDNhEQyi@yn*h3WZlE(H@+WQb|ndm2A4oj~lo$up9loT0-O1xAxc zlug|bHht<1D+~Sdl*CLz6l)A0Q`%d6vhc5ivtw=C+vzcunG;~NZpdJXoSa<}V(Q2$ zUJQjxlt1}fWUY(Y(LffAi4H@93X44sk5q17x_}1`*U*YN-SW6nh)d8@@VJm@zXL$g?B@9TO`}Zg?8odC5@F@{ZV1VAYq_5Rtu@*MgA!KP<-Hvf{4_-?vnLH9V z+R+bM%L6f4p$NoLqK?ZuSut%i&u9b4Vxp1TL&==SCpZR6<&It&=VA(&n6;%PmQRlR z4_Z57GXoODda^UeN9c(W4ClGICLE^y``>8%#Y`8EJFS&PB{+EGWCnkWEzpRO%qCYf za%p9S`6Thwcj5-;zpm1h0K-hc|Mp++#1yCc^q+%M|9=h+^{*r3|Fkm@kmzV+7_3mF z-^rmdS=f|~|JT1E|MTztbcVW{{+oVb8G7cYV=aRjudzGBzOkc^r-o4GeNTh4S%XaT zv4ND3&ZVnr*=kAZk6rx(;vX7#TLmV{I9tVR1Cp%xW9(Sg7~@A zOuU$s)7KX&X;E*&aOpa_l|3=b{CkYw$2YA)lR5%+n<~V$KnnSqBgJSdIVi>KO&(i6&XgBLqKz55?jn<%T$g}p@B>Hx zt2c3&6{5wg(*|7bUN|o&N66$b30er%UopRn2?Gt-gfJB6TfaTft?>LO376O8=3F2OY%VMmHb z-Q(7}?3aHWUZL<^Q@cPJ6BoBPL(KHd*HPN~X!hs~nmJQ+>NYYakeCi{jGi>}BS9o4 zZL9LWrLO4toR+U;B38Wei(j_1p9E%N5lw+U`3&>Id?}jGo|$P6+`D+$tPqK`i!yc| zgS1(Lo49O>nLiQv4@MFRVkrs4!H*1&GV*5|#ke-6Hpap_x={h!o7~DQT8-f54l1pc zSNL|)r!uCo%HKCPanrkG@hei&b>c2c`5%~X`ea>cxVCkwR`BTLTXPfdiWooO>9C|E zj)OpX`WgQ8+|zr#)L$YQ>iWmX<@FR8*%S@J;o`zAy-j9U+#K;YB6Nt@Xha1nkK4o& zFdP|F6vd@V>W8q|Sfg;le~cWT)#gX=Pz3Pg9tVA39B0^SQ|H_6UabI=EbjTyu67;J zaeOgWzDW@(vab1`&u|EpO+~@M>e2ra)7B zglpH$xJUNZ#-jy=xWs6XdkOf$&k}mn510{$(z*FCD3UD1DF`N~X7_fZUt~$yhsA4k zsCx-ekxR>JNzqA}#njATX$*;1@4zc9ub3G`QZ~@)Fr`(A{Z=MFU4gli2@2850?pJ3 zqGODOySUK-qr;qX!((J;q~&TA3dOHqVyU-FqFg9N*ZTfddoUmLk@Vrc$P$^QmYc*q zu|vXeiGp?wPZ-rUISWt5=gqH-g)nybXbXz1iUC}RLgN=xeQza zzP){YCIi3Y>tkpX1|x8yF(m#j@?qlhG4*SE#DJbOv`vB0$k(@INshIusci2J3fHWn<`nLD-Q+^j9tgyNHTO zd~J`I>dX$-zdpY!HRs=T-#D(t|F`Gui!kITfXQ8#l-ECQ3Rl>wtDQnpWOT*ldI+0! zV(diTZ5}OWwYur|vZRl@mN}W>k6Z|InC=#PvYQrH8HbLL}RhGZ9 z`h8SSrZgEU>p8x{wS_U{9xz4x-Z2d{z_Y}w0@Im#D6tLo&Nc_SC+r4}bRuO6+(tHQO z9~2MdJvj;Ii10BoHQ5E!>aYfE*YdGoy!~uq^1qxDxqRgtNUoEbz^shxY@=0!3pC*y z`bG^*ljDE?VY(iT_P{3-Gby$uduGLOcYe5XvG4G^5OjXiJnkpWVJS4Ax%?3L1b*>G zC~UZ0K0G3vE?g-UyoENinp0P3RQ(_tcMned%eb#hD)J|{AM;fHzX1nQ}yf{)8PCdm ztZ1}3IhVLNe`9n@vI4YC=OAPxRL|}bg&iC%mui=0Ree+WYpW6Kq&FC+ZG}Fyz`@^f zwQ+HSlX%KxD>~G=05uH7*(~Dpkj7=#sklPt^$KYJaisaM7j*gw7_aAJv3fr1=P8~0 z04fPVp3d!-q))X?vp7GaTAn9++CY{ro-YudMu+mok{@}00@Rb6v~A)cA5~l*+-~_M zv~_GBWU@~mkYhmHo8Fm&wEpY{QTW*_ei;-?0WhP1HZ)xJ@>OO2BJGsSu@mm#6hqjT zp@wk{HDP88XMlBkU+K*q3DCc~#{1*U_B2rFIEIu8y}VI+WF}DYtbgt)9=EL&-|8n~ zBOhuITlQt>c2Nmt`TEh$$Ib=iS6(%5pDS5kH~BISZ?TqE8aDu9BJFG5y>MQ_gQnLj zf{DQ7xG!WDL*P>uiRA0h!&5m@ehN0T+Fw0N4rlSxD$LW^T}?;*$~lis>A{=*ZN`CR!$^b0X|J>ol-;hm9pCd+qLu%y zroKVFfUjp1?g#SYBu*<;e4;6pEjEC2I>Oae#Zq5iGKFOKjl zKs&r$F8kV8Yu`XA^@T~M-4R~-9|=iAMX%t)y{fsQ}{Ij3EnJm#P%<2~w6Kehv zqEcOo{SK0te_+{z@z>Z2NThUM$Ty_|G*TtkUI|AHjIFDIl}|@MuRGrYqJPHV zrk+Mt5hWdbud5^>H{b6|*jP7k~pB^;}BC>%l-HrOO2WfNU2;^(KJl?vj=SS^V zm$EAz0UJ5|OZ<7-^9UDY&&#@Oj)26`@;1+9F#3B>N%5qfuHWOA)L=JT?{G)9lc)(t z78Fh{pNtTySNdT6MxH?EX9sXgI+0*qyXlrpis0>^zA@8yjip_wLE9_#&N>zn#G zIub=37?GDhfU4naGj&WAXDweE0}bG|qew~rr2olxaxB<+vo=q=$2SEdwR0U{n>1=C zmpOi`ium!fSp5)L+jk#P=Zq#617-GWq#i8H%mWHPqA9MK2c8c9XlOQRq00u)YDRZA zTf56WOf+!{AkZ#ET{c=e8_9m6|7v8rUm#;AwtG3$1Iw3-;=jbZ8OB{d!1ar0XOWMZ zfBX~Bb(ZkQ!iECAkN@B81}P0X?>-fsfbb<)S$b|83U)ONy9ce z$V;{0r`M;BO!rDNU59S!n?Q-1uhAnm(sjGJ0-(HHSz@}ekWf|Wh`3GLkY@+*{omyzcBt7kdeov1T4BCa` zRcg=$Dn-LDe$C}ro}3ueXU&_3TQ9y8n&J^^sE zwAq}d<()W9+B!JS{z6t09EAm7nA|JgH=3`QRbU5ONrq_p*-G4}7{uD>gCiObWee@7v7Mf6xU z2AAk0Tq*VVmHj^em_TR03se@6x+#@)G|>jf2Vrx;3PSG(n0&?oqf&rog2So9DBXB9 zUM6===G{LfHgkE788{FL{{ZVAzVe2tCh5qg{Y@R*dHN^Saql}z>`2kSg{i%gbRSC}qK%XK06ry7 z+o3y^P28$Izclx`rP&5y>J%wZuDYpef}>?I=2L+rs2JN)qhX>ygvycmAW#F>2n(T7 zG{OK-t!yKM=BL>?5ef-X=PguskbP7&^Ms+62yXuXhhnk=bGJ-f{n1$$crFyIwQf16 z21dxPtD*(5;q31J0NEBlQio|Q??|&Lk9pfCR;>K>-aJm^IR!TF9j8vIh0s4=R0lGF z*qp^SojqJ~j+>IFlqWZrX>xUkg|kuLvYazJbBxNJ(2?d|ffqSLP7{EY0|M@CM=zmG zJKQG)l#9f>q9X%M-e9w4%FWhFBPiy%@y;JCEsXFv?$9E}g>r$w9oA{S7O_F~V%`UT zr2hbP`G95+!UnhkvaHP(!17YneHK)I?LYNLwN{Y8VW4~NDi%ShKuv{_qey0Ur98UDl?<-={{U8;*}uK&iR*xP z5)PgUj}6COSa*!RF9ag0uFg7ZL4W5#NA1Qp&>XqI>$ z2R?WJqjhCuGyGGTs)6Mu$TTd9BE_SgF@~GzoHb`=YjK0%zBcGpK|XS19Nh_OWg0HZ8p8fpib?*tbHX@oHwub3d$`p z%dQ4WA!bGuI(j>Fa{fvgYKtSq!U%Fvf##h3V8S431($v9y64cUxeS0aABjew7N*(t za&ac|oX2xkC?GgySAtxm!$P@nQqTuArwf`M(p#to;azz``Zs1AisX4B5gdJ;vje;m ztUj)y5a};&Lpu@W`7G3cWBDQoxJEF}Mv7Q`Zca5xIgoO`5I0RC_mt{QvvQDsHms5v zNtbs-+MY^m@`KCzrnn|Ensb}=wQcMDkS@MwN~;>WDTL>=!MZQ^-)5>}qdX*n@O5|| zR(ws+r2EwO`gB1M54t~9my(p%H$t+e4V!YkY!NVl(Xyr9ZHn<|g7FwfBZPBCmGev} zOvyP~a}>zEvM=!EnSl)eYI-giy|nwGgV9(dmm2+BE?B$9frTsf)` z0`q=j3WAT;WH~)z$&O_=jK5r6Zw~`%H{yjgJQIsvJ=NP;H-P2ckAKVlt&pt3VeJnK zVN>8O{d)c=rgj@?<$+Vp;O68-k<;JpA=*1pEM(0( zd%Lgv(RZ&s*Jc`ZUC(B2R*m_ro1!&}XZ6C`rh}{?@R?6$wLC_OKNswX*-n^cb;kV{ zeL0xz`6pzk(BNX|HT;yf4N&B}K>MntKXlwHoB;?q3T*Q_!2kyhW>Kk~)QmX>c8W}> zHSq-v00E>fs%eYDhc(RVR#EYsSw@{9{ud+x0DE3`S@>T8{wyB4;tJc1)At=gSzqsq>S-ShK4JXiAcRL3C!I#z!3;Hon-Vh+`&33vakx(?gXH`zUGZGeNvohqhL=c8!wUFVbPy94Hw3&0- zBd5h*4cC;ec+?aly$v~J?y0l1RPQRsh^R)P*%(ycJE`cOu$)7Wy}{Yv$%_)UJ|?`{k+p_G5!sYBD@ghpEW<+ zA>$4Q%2URMENh(J(Md4xtfdNv@Z}LcX^wiSeyPy{fV?(LkEfTr@>aO-aezN z8a4GzO=!?yaBo7NZPu#B%Q@!*hc#D!v@D^p#2o5PcWORSwJ+|2 z8g6we2j-_zujSQWQ*yGVKAoY`oaV!Id!4gFXltdr^+kaik$-e@3QpKcjgj;}rV;Q# z<*|^*oXvNY!DbLi&_<(l z(=aNr(Yz-1uFY{v>uK&eM@>^rt5FUb^4WK+e|1)8p-!sO2;_xND^zTu1tRP^g)Dar zgy+(uO^(10W;z8bcpR922vSgm-Vt@-;4P+d zldHEtNemk(W~wtlK5nU}c`iPu9T9Foquu>eMu~t8Hxo3ZBC0XnA9JV?;orn&9_zx=qf{!&N*ArKyRY)?3-V+>Iv|32zH*&2l=dv zuJ^LBt)U+7gZd)y2tHJ1(6Y2H>}qvZM5*M7vFfaMO%hQqxoMwO8i;^-CW@TS=sCKh z-VZCbPHc(jn&YoEZBS`CuLipy`rt}|gKG^FQ$QP_!K#?DaT{>9V@1#_DcMVO#IO@F zs_~ns8kEs*5)P`|p~eU9ydc8Uho%-J1qDFDH&9R`{#y#CXij#Sos~HCSJQP_#j+Vn z-y15Kqbn{7&$1N4zAqs7o3d&5pQoa7))Q)w47*AoM+3&;F-+*Aa)SphFI5AA*jZ?^IIQhx&CILZ@XE@w zV`Xr&10boxT^3=ws~VdsZ93eQDZq3eHBvzY81-lXs8x{+N3vACGGufpjaq*qo?6`fny1#%<>;H*dpq;?bD`zx zi%62ZED|O?R&Lbr&=F^6fC7|B)m$$V8h#4&o6Tk|Bp?(jGFPN-~Z z_(w+WP;&=@B04Kv9S#{kmLMYAK~Br%CO}aT@$+62ecD!F%-x=)p2?U_b@Cgv3RFNO zp+vrCmWUnD!dEOe#5q-}&ofv^MztrL`#X6|bH-N?GY+`r`0y0ww{nA4vN$6`eBBW) z)xyJ)X(~mBMJC)mQ?qPkF^ura2Urr00RWxNxMso|%|azvYObM2M12!gwS@fI0sAI) zh@DHlVKuyfT6l_{3O${?uj+$aq(glb^}6sEB=$w}>vPGRV-9vs84h>OgCO z%lRzeTXfO*iW9Jv>aKV%qPmnqEGSoRXJ>gc)ACl=9e5=d9h4!2U|#XOj;kiipjY69 zWteK5-@Mc#V4YD;4Mp6PkBad5R@h3_Wl%T?+Yf@xtMc2T9i4_>R_;f$ljj+ex}nMy zl;8&1ldEl=5UT!l5w4o zz_gtWmuRGRb(0zvQG_A_1puAMTZR;?t0-CB&fQa|cPD;$8PmIunuluKC6;p0eIwyC zYZeMJ%rB}7!wt=3GZ`w%0=}!FZ$urqHbpkbIi|_8sv~|M?6g~>d_lYw;B#CCv9}0W zMyNlSS+rhfJJkl?H2koIZSl4Q^-`r}*rUq^f38#C5wS(&%KM>fI2C1^f^-NjLxVTw zx(yfmmwWIi6QZ|7Tkuf`7aOdl0t~fv)B55RVJhWY;){wcJdyDjMaPnEVY&p^DBVoq z$zN4$2ElqQFrwk*-FLwFGC}I3m8vRK$`Lm}a#>ZOTK#$Z2DA&UETm|fP#Y8h@}b}l zBT3mmGpry0zH6eM8AVD13uByIpf^&7#XgV`WJ{A+&%BHC6?JvtD9W+8R|-(z@iZQ* zQLBi-U8(b6sCb?whEt!q*MLkaG@-anV^u8F{GWij9=v3T9z+Q^RF-JQ-XE#aKc&oCnxP zh=QkeZB^D(SmR=vTX<09?7r|tp|V08)TjdZOsvR^E?_G!HWpWE@Y!9(P8Kk{>*+P- zqiv2Fg&Y_D!(WNM2zo2q8;Egwv@w5(16z*;s;zDgr9S zUm3uOSws~aT^B|4aC$4XZnaYZUYgNbRDvX}iqd_ot1IfV%qTx-ozxqSs#_sgqHyrp zYsGE|;2y$!rArOgk-?`8{fyzFy0;Df$rxO#DdCkGaBIbUE~nVYDq614PucWV`$)j! zs=u<=fO|Xt0G5CM!~iG|0RRF50s#a90|5a60RR910RRypF+ovb5OIN#p|Qcy@F3yw zF#p;B2mt{A0Y4$H_=0*X(jdJ`m7hqBA&lk+rpuP7CVyQCSLr|E2p}Lz^mv#F%+zBU zTg~A4m8ZkeCJBOb3o?aRO`_bm#V#?jXVSCi1!^>AkopNdH_{ooSqwgveu6C5WygSu zDpqG0R8K&Gm>!-{m0i>xfJ2E=rAn15QG{Dbc2W^mT_1)avrMn}(ioKHGUdgX9=~JI zlJPpm-jymOuSHy`Nwlb+@@^hvD$Kc;(Ps%zLky>+30|O>4-w3%Q)!z02hmsSOykhX zhoDN8=~CjN)6qC(^DL=hseR%)Yzi*mOgCQybN>K3OM+fdY>ZiR!LRr+U%3=mikLov zRAUr98O&ut>%_T_%o)bvy}=R~{{X_u1JK40^jD=y^nxU?RTM3FCqOV04@!)$LLc+9 z><${~YyK`=Sd=jCUSl@&rp5%z%wB_o93W+SX;8Ek=v=vereB~2 zXJ1HD=`gn+K=d!O5}0!zLcJS7>8K@Mg<`x+JW7V@I5RH4X`Y`xhP@Rl(!b*UE?Q!0 z?Jr<|FVwUhxkC3}^7<|%)GT?0K*ZZqh+T+8Syzlpw#@$k;u?dAuccyZH}o&jWy|#Z zi9n*ND;Oe0NHXHXTNiv0YYWNfdo;_>BtC=w5P!m~M3;okMb%-GrV##BkARCzIz?xt z^{@HAO#!=14$#%Ka_#cV{{WURr2?jKPOKP}n6O1#X_*>Gy$3k|0Fw+x(%{9+H!Ig{ zXEA1VcM6LyFL`lAFVRH{4=)j#juh;z{4lr%g`XGW(^ARgm0pGDGYF$mW5ir~k#Os^ zfrPXQCSHLb_gDe>rQ&Hru8+<@aYZkiVA#)E*DItHD`U~a>%mXV;1Sb}t@?#$_ z;$GLa$J-0<_4bSc;+~u zrS6n6H6Dru6bDeSQt+3DGUbxEA}Nf>wli82e_yF{DPnO|`XYK{ziF17T%qE_cI(o; zOd<<%a6{H0W{~0k0ACT%Tl|3hOPeJCcsTA05B&Be*mcxgOZ9UIdX^)j&(pXB&|}i# z#g_;eda&H2T^v|WMBM6#&0=4yC~wlV<TAQbawe8HjC7_Fk)ct4bn^d;gwpshoeFk=N%4VN2+Ud~0A1QZK1rCk~v`qCD zsl8FcG}oz;qZDGMf@0Nl%`A-CQO=gXWYn!~7ue6x%A+`y15TZCzeLd!)l(?v6}%pjN_$1luBzc%z|=Q4~>#uw1!Fv-D?>wbVkQw3uT z>4@bs#fT`qdTj5t5;Ex?ANYV4gdXMkStW;{s-rBtH2}ls&}fA)1Z<8J?c!awF*7ps zZ*vboqpw>?#t|~f=={EpWn=CikxC${15tTnW?Wps*;)SH>J47a&OcDb7KUEQS&&G_QQRp#3WG4S!-VdL{Rv@m;V5gq?K*;J7Uk- z#Zg_wn?qsmD!mBDl3bL>1U2Y7P}CHZL7Y<3uE&u$|lL1 z(5yxtDVRygDvRC|Q9FXdWbl=JA8 zc`!0JEtQGc2`zq6Vj?_TLJi`g)3I!HH`Cm|12N?LqS~f;cQW&+{_ey-x*~(~ zEVaVJV=(QwmBH<=f@OX7Qwstcg1*6i9)MfGP%8Yzuq)aj)Tg@j71!o5NL#HhM=ZP` zlxpHwN+eT)J^GX?=TN$e;t*05gn+K)sv$jqqxjc%T!=F zc0`W4F$=JZC758QQXxWsFds!0dR}R#BmV$iej+uwa~h5riWtTPLJEqU$u|_-O zN>_q=I#85|^CzHysZ?(mkQ&n(r*i=ON6z>38}pNpWz2gnzSBDpW++L&WOu;-01wmv zn!I~)9pWQb1O_vJ^9GJgox~P^28hVm%mgJ=Q_eo>9Mn)l=31`hv2ofVS_EEABzjO; zxNcj_&6LdXSNzXAIjLf7a}akRd#)op6)=?!y$qs2mLjS#=p_d`BbDhm`Vni}eE{xC z3G*XS;r^03z-`X@_%Q@QyUCW*K>!f0IQj_|Subz76#`b>M*}5SYbAOmkv-8*B9um`nG!Ts4993@YizBV;c%GDT;Q3g>QrM0=01{h?E+YM zlrv>-1I$E&P!%)8cuJ3}-*K&=$r?8pfubxg$Dv6ZCL?p5EvuypVXmXH8$Ocqg9X)=+xFiP?)N+gB(<-!1A;zD z=r+7DVYH1xJ5L5jytGcpm5N5MfnJVZP=Q*jg`mrRJ^ zF?9~ArxPtwRv&W)0J}p2+)2b-78mzG9GQuYXv#1wg0ajcqcb~1tNd9`I2sG)IHCRb zQQgN%((*1|&>2f|v6}NJX=cmj8do`*q}>xFc8+Dz^)7;E2JR#e5iyU733i&O3b{Fz zO2eo&)8cgzv2BoUQ8-H_FSMs5wpq9*RY5n$qG4m|FBQw?ZdV@?xSY($T?f!Yw5Cqh z;P*O@;dYc}uMq>#18l&kil};)H_S_hY{cQ2mW|7Sp~TS7m2FHSgFL+sSZRjLygVkS;$2Q6uY?CO)lk*PQoL>;EA5T!Btt*< zaoEAY_L+u44QdUruBU{!7QP4mW8zkJ3+uKLt4^j-rA*AiuC-ZoM0DOr#h_-lD=P^p ze3Kxk%$x|1C9rUO%QfO79e3_%lg#2{0Qtwoj5bAdxNLj#g&bEx1L_={;AV{?#O zKyRYeVo{A}`jk&={{XW0@SzzBbCRJWF)RwWFqk?g&;J0~S3R7rGOKIM*=k&x ztA5z@Z`x6BiEvQUHCU+x@ekZH$bf_%ASxn)@hkvE?l=P08pNyaw!MGI@$63FC z=2dInFp+~Ng3;w>2(tDVF)7Qbm2&v9taAYDcM{dWXpi4kVGCPTj+B}+H1g)9@Oz){ zski2z%)Xf%{{TPCz{ynpB}?&$6Cy*fr$6t^NnCJyz&eJl?gKB4;!vN7a^fvqQOK6| z{IIX@4-0X|_n2@#Vfg77bQEn_{e(QBf}DCC3lqM{p1jl#z?Jz;z-`Q+c%DS&D`Ex6 za8=fzjHF@JLYtDtCR`}p%f!uhRj<{`0-T;az-4a^%e55^P-pV}M6=6(eSRuZ!HyjZ z9>Mv59$=XU$^+hEvZw>Sd!0%HGu~gkW`=QlLl(s1DT;feLWz)>&p zB^THjdX5}pDaOP7g z#vSV){DQi@T)Ru*sou}LD6^}5AbFasuy-67r)&=@$HSu;_@y30H1*>NLUT}d6|{g5xWq+UCJwnJB|s2`U~zRpqciRpTaG-E?6k-JW^vk z8X>J#ClSoVT$MQl9~TTbL{xF8*E;j65A2uBJj=^fN6cKIowM-x)Ec|I(KAxT!iVZI z@kqDKR+5K#`4uk1jEw?7eG8=Dq$ z-;E6Ji{i;ibVUo5_kN}&4e_bwnfEdzn1X1m!0&j0DY7T?2&Ah)XU|XoRrIGXQzWXF zO=*JL4=9a!*oX^^!UVft3oyE}iMLh* zioaxPg|lv4O$TYmPm|2T4m{vxLf(JXhypDSzsexy_SmO@luJQ6sh(x z7+=pHFov$Tm8&|SK4n}39x-9g*1lyiHiaJYr9)OrS7QLFE7Nw-<%z1ImFJkFwi;K7 zkM~|?F^ZUZfr#u?G$Q{1gHS^JnU#1+m3DCDtNtZHV+L||{{H|GT>@L%e~Dqh1B5a4 zEI6#MD+30~KBGyAVS|_{bP+NMypDgEYdFLT{L4fG%Te(d$wob{Z9YCz_=j2FEc%Ey zC|JL|{7@?063U4H`+G6 z3&3{{7Mu2FS3qy#nm^pd>vPBK`F7Q5Ve-eT@^yps%u$!Yz5XDy z(Z%2>pC-2lb1XsQp$~C*2)L@?YpIOj+)<_uD(HVWrg0ENMD?s5SW!pt5RJT`1TalP zr_Jl$7*s|+Ww$GCQv(E`*yaww&Y_1j7|@!k(ijXI9JD00f@aX{mL}*2e_eTW_h-Uk@RP&Q(ZrMgYwGH zqz{4>h*&-XG3l2#58MqUf^zV<4pL~oUTpsWUG+6~XMtrM(CWnSd!>;x7ds0vgq?9e zoL`Mwm8ny7v}^7p7V9P-!WSR9~IG` z<1=$N$Zm03SGo#!5-6j9MXbqKi?em^{-rrC<^DQ^8i*VHP4dH;W2l^QC@-6QF$Mns zD~|sF5j?f#P}YziX{3qfVMC(atK1S$9?^swmmtWFp~NX=2v?F00NDcE>sCasZSu3qs>>R*WMnHn)3 zzL;X$S7@7BTYSVFEMWcvaNP(Snf7%BQEN#plT3JF;60I*9Pa>}8NAoC6}fZ^t6I=TJdEC>Zxj$+X{5uGyJTHC}@+hPg4&%CO<(jCGf z-}#vmf1F9Ss*rs5GKIsg=NA(F)@cUaNAyP_;5GSpn6a)6j3UQqO@kL1P-}`hhM~3i zk9U{tfw^@JX=7lByM&KXli2e!5asXBp{_R0il{yd)W58hWpoPEerY%pzc5lb$HgK;@4%s(_^3afywE;u1s@10*Y ztA!zTpi3Hq9*ev!15jkqD;(}(S<*9S(2H3@zJ)1cjw)!5Dm-m?f>yB|j~$RUI5Xlp zMF>kAVjZ+8z<6ST3$B`ih(mqwUzowIC9Y16pbh^3po@u4UjG2`Fi!H7s9-aojGDYvx>*F><!=)e!oWl~n0Sdy^zL;IGqUbjY ztdCoPcMGxkd&lnZ-*9C&T+Eww118SaBX1i`3u^ zq-RiSIar$XK^Z=<*H2Rd{kJdpVi`T_5wwGDNEpW=&$_)sE5{Hcr2&GwnzLjC&0a#w zjVl}Pk}ET1jngizq8Ip`7FxQU#f6cLV~jMZ%*o>_^8WzXr^(xMIE(HbI}Xvwi1#ic z%*`86)lMh6nWV)l`;6~5aQec-#G%wu!=0~L`I*f5IDP*B z)W^-4sG3=So0)-p4>F@|?exs9O1QQRML}nn&!-NM9<;}3D~H5X<*GyINaT zA^EomRhmDz$YmJDSaWRK{7fO98;aIg_2TgS#U>;DJDF{|F*~0u#m#Ae#<`U!%?nFv zmuzUdFy=mrD|%(9+gOd>XY7kvjGm@)S)VX0aKRp43{jbN*Z%xU@Kn~AT;KjqnLVJF zzZVY9zU3)H70lBvXmZqYKsI|@{X>wBp^n!=9wqYe!iH}4=47@V+1|ezi|DMN1{1 zQCnRT0jdUuDE|QGl*UV4G*qw(FjoA|6r92B1Vaub?u}eqSwgi>>JfbiZLXA;!pzy z`5w`7l|iNV7>mhZ=vOqw+-L2O;?kwq%R#ihJj*rSv-phO6BcthS7uU@z|_EY1Bp~q z7}@tPceP1I?={p&!Q^Z64@oY~SO>JMR1F<_-ePE=IWrGAj#)zjRsR5UV3)J~nMp)b zqEw-3svqVe@PRZ~!ka>oZJOR-G)mql`^0b|y1(POb@;r@ZUjo6V|@sP&Qesb3jx*6 z@TrPoRM5&D@p0M?$(l#RI$F5*;u%GyzcX@>(uSLh+jj5X3C5oN2y_W{^7hMJmoSS; z$Z|P@lW%)3@Bs;}N_@;Pyt8#J-5&QV0Q9pjxUNRraSetAWt9sZhBzQxhOLD*>O2yq z(c%hY(tcAh_hOf|nY>jWI+;i9jKQGS^)n_ayq}tiw-%OYg)6Ee%k-`DHDwGN9Acz$RO+yCX#nZB_bZi~`UB^^9AC z76koF?xS-}a9aNWckc@Jg=6(_a2#0K1zqJO&z{aR@wrYLg1S>d3_^~jfQ4C>8SXlp z1UXK;pxg(UZfu~!flo-%@=eMZc=H9VR)~r8nXiNGxGEu2EJTqPi$;bNw0ICY@g64n zWYA|3CdM2!wO+&=mD$9)q2f@)s*auch^JStX;r8+xu$lZtCWPR;#j`hn?tP5&NRXH z5nQGgFa_MLEs0>NkiMaA!k<%O!1_iIu(P)V`D3xMc*w;12+NEUF?G01;>me9matcI zTLQZiehP z>RGn88?ADSfo9UXuBHgF-zS1K`-1Ydc8 z#1G6}{{VQMjyF?xsaIAQ3{2KFs9)k24Fyq8^$IIii&gwh>g9RgK9(mhZeaBhxV*}j zMk1NrLn^C=w@QHRR3*!X8Zxy$p26w~Nu!@`2skO0Ru^+4T9k7ed5j3H{^5lRA&Imw z3^Yw}wYfdIg;%2G^Zx*Z9Tmt*%#9@&%bt-fYmX@B z!klI^hSfthqe@vuuzTOsDdXs9^DV|J-W&v+4m?Z{zVkYv?wr>??|3XMrci(Y&c`?J zDGmULi|3ICQ2m*P)YquLsYI}G6()V)MN19JK!;`#9uSoH80&O#JY3MRN?@?cd!;RN zsF25BMm@Ec+z&I)LLrgCd-|DyUy0Xi?l7o4)SxXe*HdG+-!lg3s+m0+>EDT{Ua#Yi z)W}TWk6pj%6OaxJ*E?-%*Z`ZXJ6)4 zPi;Qyp2}5JxAQM}I~H&meePc03+S(n^EA4Qm$}(B%q<$+q@=ZF#x}7_ZBUKW1&$pa zSg9?X`UD}4c$n?giu}qILn@~mY_B_sUCFa?Kh*PqL#Q#C85f$P@{qh5J~1?v9(kW7 z{Y+Gt0Dw?$ttA-CuRZ0?o zZCYX(Cuj2=sPf0&2I?LJIw#-HnEukKxmA&KGmv5Lj*yYq4Fvk&6S@wX^Ou_L}L0GHH#)PWn70sBP?Va~$%*vK) znWiR0y-S0{yliLl88gc&Nocx@lfB2e(dOYW+*QDM<>m=Ra7zP{am4J07xTYP1TCNa zjHj`b$SbUXY0#sGBOH3{;hsaF|nE66K|c;sYSr)p?d%e7yev zNl2_E&|ItU#JqQ3QP+_esP8XxiIvtb3R}T291z*T_j2Bcnw#T&ye29G$HczRgA<07 zr%c~+^B3kdvkVFf`--M-GObfaVtEz=mE{~meM?q0p${uJsc_BIC%eQ-O|nG2hZy$H zc(2+336`f!K_-C}d$u7QTN-1zRm8b*bzeFCRIOM_Hbxn1c zxLk&+=2s+Qw%Qy_QFWMgna@DfgkK&e*vu@`2^x6d++K@EFS zmWnD3`z{v{KIP;-a-D~X90j5Iw=ndSK{#)S+QAm4nw7c(ea8e{!H8zDY~2W^s{!>8 zlJcEg62XiU9*r;a9nrO3(ui>VdQ27pn7I?Pl2JwwCQQ(1hRaIc2;~0JFJ&94brZJ~{z^xz29bsVzfF2pRkIY<{rU^k$4yU(`CEoVRL9^l) z`yaRjEIE|puvdJ_Az3U-+kC*Sxl8U<)!=YKM}vD zPQ3B$3fb1bGR5j$p|RyWyZwjUX}Oo7FsGal$+IiWy+!!z-Z_QMvqZ*GqEz8zq4Hcx zoHF*nTIvQ5h>Wq&rZc`F{{WG0z@u`p1cfC*5Pf?}jzy_`V!fa|>Q#Z%N&0%CUGQwA8Z%>%*;U+ffVxk@d z@qs#?W+2&!raEG?MZ_Bc&X&My4{7X>UTRPm2eCHYvc&hDEuO%0Jc6cDR`*%eP6kW* z9>@BbR>?^QaQ(_9a4J_|6Atkx@m)%YHb5wtW<=D3gYH%HgsFl#LWmC#VO+3}Iko0E z0J62rSExZTF=ZUY!A-~U9ec=uqn4tvwNxYp3lv4c`IWW5b4o|FOnYZC`DOr=)KHcV zC+;qhN5GhXW0`8zu`h3X65HpS;`fy2L+Vvcg@bdjs?^h>SM@KU4L&9AR~GXIz~e6{xk28oleGDAU(af@t9nP+a(aJNeGQp=}8P@@wFI-0Ht zP2&t|YP0(>TTKMgRB8yFIh9t#br#}LZN1E5+(Uhi5YINf&qRy438(UjT>c@$1n~4a zLLWskuQ26s*AXokCQT58s4Rqy@h*d>8kjIFa?A!P1|nZ*G(Vv5uLB$B2!bMtL~RIBz?HG@ zA{i~i6cy2z^_Rz~UhCwC{{W-}9Iluq>7Tj^mZ=<_N`PO9g)O;C6sUgUM^2?!d(>2Y zk}oWiuA+GKP*A^mS_kCnY^ZIO4(!^&!BDePG;Q8a)T_olE}1_S|>0p zv55(qSCtNQPFxjc2nF~owcMTkX0nhC@CZk^J?-3oPUNXe2nzoIXhCRmD`+x@#|uJk z1(_~lA<{g(uuBZg?qY0d;he`K6CsuWokvcfhfXRMR$}=OuOjI~mS%C|@WtSXL&$>Y zC2DzN%M45(5Vm5KQu`uN3|hi0tB3~F3`)byR34Iqb(mbHED&ZfU=srTo9RX*^L3yqy-74&vTA<0&K^To@Z1*Kv zk1FPK9X3?GkCCVX8BfTDHFkM`Fq*_pj7KGrTbNWZ{5?KNbmEF~X)kC@^kJb26lP8{ z7WW)4M82kEQ=({?+d4|+uKg~FL}o-7)KT;;p&x-Fjal~*av-}*mhPb48jh%C82*5( z3m6n8#2{ta38}Uq4dB{y34}J{Cn(FTnBIAdm;jZ{k1~j5GJ|ErT(f7?diUcDL{j&R z7bD1KAAky|04^nV7z6~BM7;%9n_bkco#5{7ZpAgYTX87G-QC>+1P>O9TajYLp=fZo z0Hs9=#R8=*4#isFIlS)~-}&+rGVWyVeXn(0^IBqps#`KvYu~J}{mqvVzpXFY&#+(b z5L)#`&GuXB$qR?T*+P2`9J9FnpLsooVHJ`cddl_Vs&#fhL(4LpQpaZBY<1E8Kr*iAh0uNnFrhYl#j~2`v!sZj!lwU%!cdUEw}^M>f{7 zjG1ti5N5F%S0io~Tm_lf93>Cd2X=a4(`kE$f4@^=2p<;qkqYgGQsxh#@OvB3og$yI-T8eeqOZWv!> znWPV7hwWgnpYkQi->rG(N`&8x61h?c`mj1u6LI`~q3@ME{b$dVuwzRBe62iy>gvSe zh4-(;h@-QATN+C(r)~cwLYemQF9!>GIN54z6yNDN0BNO`jzz$)(xiGxtWd6`O#*2C zE`A^i`dD33Nz35+hs{EG-9uWM>|CAW@Z!Pwr#fauEV?Q3Dr3?fNDlLr=yf4IGypeG zn|i;W@=mJuw>QZdS3jT&UrC*4pYx$<~8=Hpa$6D_O=Bz%Z(SNZf0|&t+(lu+)*#1wfpVWgzL}

>By?{7cHlq;C(2EP5S z9EJ8J91?1&${G5(X<@uJ|A%>gZsxSgo)~dUotV?vX##bkx1DJ#iB*TgU9 z+?&5h9||HcMIhIS!5edV^CdJbRVb#g{ptA1fc0$<3J>RB#d_vzZ+Qk7%km38!btq$ zQ2c+N|FMPsUwnkfz|Jpr`Tt2miHs@e`yBplAPncN@Q+@gd8I5T?U_RceMB?x;{cKCutk8^UQ?2iPBDTh=K}k zjpOs#pUul-aCfH06`yB?oldS6{M8Qfwb>lm*jgj`JgLm+ZUYYTl&w0lG|C^gUF8WOHH&Rv0p}c zk~ZvCCeebR{fKRQST=*`DvCL7UD}V|LbO13?jr&BzE0T{!%3_93C-M0z@VL z+ddrehF!Bm&4Q_8ART$_SD0OK-z2Qc3q!GXV0OIPod^7m9O_Uj$g^c^A*ZANq-8n+ z@xHJ|7<(#vm0**>e7*<$vkk1=@o)rRKZH|m$Jvvv_aHISB4d_c%TnX&^Ffb_V6?JJ zW*#+~^a1eQjGVGCLw?^dAiJM+eWjf$_{7)omz%}~l&HGlo7dT@UFe3D(8|n}^-K~o zP4@~`@aF~oZ@+v^2cQ<4R-b)K6Q{IXkY8BD!X3}^w7%hX_AmK;@y9a8s*>l3!bqmA6^)nSFaPr!ayUzxZfSC)$ycGH2EsUc<45h2zq*-N(PT@A z8f~pchlNk$|B0cf1fhzMvS$dgX1BN`PD>Tgra$t+@Pcpfey|BN725Zx0kLv6h_R&B zNwdRn|IY2U+SGp$ci{zO*8iFo8dbLY4TOEPpjT3wvCO_Q9&g6AELx8X*L1nkMA@W^ z+k78?%+fvg1)O~>IPPewME8$?K8e2df&TWG{xNjwc4K1tyq#W7LHIF;MXFO;KsAv! z)*pBhQk{Lf{4gD4p-y-S6eU zT>kc@R*FE)PTXn^LNvOV_BSWrxkwyu?jAO{K{GOOw%(>7998f=!GDBv;{B@HvmgXE zwMkNl>z4l-(H$4X_WhP-=P;I4==N3*7&V8NLv_cRZ3knAGv{YJW9oNXKyu^7@e&m} z#6od{vgKxQT_iF6B@g$F9F(yYyKe{+cJqIW1<{{Y_oz(sf3_63VPnBCE5opoEtO~_ zaT=R(ffhu#KVb4_Np{q%nrgGA=VKdn`K-(2Q;SbQOkm_2bXOD8=zp?d0qeZXfpckW zAHbj1N2sH%mb@_8r{!C_tojQ&Z&)WwdnPg21<8$;ARO zFRe&SFoG?T@n_!dHco+;B;feJN$>&_{trv||B`^{g(SRqAqkh6+D7&+|2Gi+$Er&d zh!Ks!u*v_3T7CH2>{YbdKUoK-tgC6>)6)1n>k&4bN#?xk-7$#J<%W+_8=lBR+$O98 z$~(j=mmRfv(MJ)CCD9&Cpoy^oQ$!=tf=FpP24e+e&G8CvhC^}22p`2G!7~2=zz6s0 zSt77tnQ}YvIV!L0E>jXLm`!3g-uHuj(alXIzz@s8(-fa?)?+@ydXSX$J(==(nX>5{ zB3^1HiUWC%d=)V4saZ}D2AH(;bQ&_+3~<7m;vnQpvMe|}zG&Yhn!|TvI2_BmJt2yI z?~pV(zR58n&D%?~ulOi}s|Br?S;;1`KzBTg;0{?Zb}+wCiv>JofFOcp`z(xxB^u*RjSn z?&3pTtCK8x`~NqB3VBv zjo7TY zvHKKL$B~D_ILT;&*YE$modr>zT=P*){nY^x-n!b^Ox*^PE>YK_cANNut}JAFC0o|>^N8ZU zaG!=#8!#B{%uCL{&=^{%o+7DFH;|%oTd?4xQ;KY_9kFl z$uDqtAd~RuAsIhAC+lS()QV)a+@eOdz3m#FIqBHc*?4dBedd^jR`O|AI6QGPHEA#M zD&}{;#x7Vo&(&#o*cr@0fMBi8xhqha);k-!RJ^;P?{Yvrjydi8?MO74HL@u+9qLTS zYr@Nbkl5{XDR%#NLBP(L;xasV#Cl%zSoJG*a7En{BFVKy}wZ$ z_0E>h7>P=YZJqyW0G>t|-@V{P9YXT&@H7_+Tu%GF@@+ZUhnW5-8`~YFg8>8M&Y3$; zmgz^>dKx@$==kO5-@S4izi_Ct9lwDw$V==YHjd-VBKaT09epZ+qro%GHZKz|B$9sB zu{D+M@!PgKa{^4l9{q7dnlszZvvpS2GLu8cWy+aaY;BX}iP{(CXR)K*jop~Y4rAtx zz(5X{wTm5|)Rg*vzq&RTIqiD!%rt|bt;(KNZef_xPDPrZF;aKZXxq!<82t=- z6ei7>f&X$LfYIkYCgBanw3zL3|P41zi9Se+MxucU*vVLEL+}qq0ZqAqkwKN z)Qg$a+30eYxqoJM(EWXBtQ2DM!p`=0QIoZ5WKfT~Nb378HR+ZV;uU{yGve=Nd!4E)!ZRsFSA2aAvSl|^$OEO_+)=igh#K49 z>q0gAF`QsMGcTYDeXe3>ug|)?7j5mglBQmokq*7m$!7`+K3%lHZcUk#AXscA5|leF z{_!2m{E>r~-hOP9=MkqX#Dz2~YWQjHhBv;LH_-vN1UlGDFHID|Dv2je$i~?7L(s~U z8qe^K?sj)Nc7Vw_XX_DyuuQif$=8Z^`scW<=Hf)e=;t|TdTYH+a%TDIzLCG!_Vu6| zGfO{HhMElSIEU2+{-)q2fAh=*lIEb&aC6=Mpplk!-Iw3c#9?qOdzv~*D~tAmJ_1WY zn!~hAe82+pvk+j?sJ(3N6r;v$l6sc6|Nm*it?f$PO%&+-JOv@~*W6@B9KU6FDQ9aCNTwhTI8>ifsTMO@;j%UIA%>!hJw zMOUagq+-1M0^#qDPew^d|9weJqe#L`|NRQP)()L1lYCu)ym*9q@72Bx$FF z!I^p_6F5m-B8J45an7h=EvMqzFY-z}D!+bN@&lS#FEiNXVlgYPfP23b-p*?r+Cy#f zx3Sej>r8Z|*pYPqe6jxgz6AUS&=vlukNPkbg}hxrN_#te61DXl=cJ+;K9bm`J3SIR z$C0&HPrFW)pKoqFCWAicT9@8xRdC{CfhPM89k{}N=Q*7(H>KW zegu7oUsLE9pu{oWk^>7h0AI+*tfLl9)>i&r5aWUlx%W*3o4GxY9jOeX$6*IJ0>G;F z66*4v5PAS0{<3I| zYjtKw|74~|0=}KDAo?nbUy^R??0!||9BEJ+g4bcD9G@C{Rmue8qH_oF(hw7rK~jA` ziXT?U%d@|L>aZ=`No@GW8GhhQpnrdaqcEK6mon82jDIz$XDU|m!jB-EF#jj5n|iXYz21g;NV&(LlxavbW{}pytSEjil1p}Q(TUpNhBELpgV>^>|z=ee#FRM zdWcG| zpT>lg7E^~IDS+Jt)a?tRHA%Zw5`I>aT7eZ->BGnNo3LbvzPzw(qr&6k1#( zMyMO@H=ZgH_;=();4)TrFI^}-B;$a(U+T#?*w1!eOIstM$RJF%U>2zw*pD15u3ry} zJk+DY@d=If%@Oxsi1bTE3Ed_;0#dHJihYf~WNlCM47OF#ire<1Fy&Lm@U2q4f%D5^ zkRDhYo>DMe(kRG)rb&uNngdh@14{JFx>`jNV=nD3^Zi%y_Ky?O3G{aflJXdws=Ys` zHUu}BY%_$`$T&<|n$2Y5hfm(+kj{0WhayBbX7YV^KyEEGHn{q$IKNe#-8RU{14kmgn;Y9**MUKF2$p(XmfAU>)&LiL=L%6?7+Q073g*NO&rEcC$>=|v!KEqBz{p7%2qrpwV>H>ovw%gniMDF z@6pR$e#0iNBXePjrw>THwcQN`pq6+|Y-1zQ*tOYYB_$e5ER`%p;z>E$IxtSh9RLBD z3{Ejy5}HPF9!vCh-SDt{aqIT^p36*X1gn*;!#Qh4?8kTp8xAU9E%{$KXi6Oh(iD=u z%rehaWMc)LV`^;pBq0pH5rW(r`{^Z7?_di5W(t9DJklJrF653h-0z((?T)UtDwE9HvXvyXbv^D`eyeuG}@rxJjX8>ZV$5Tew=?0}mM{;dzQ1h*wN2W3w&CDe+!g0^v?=7>b}a=2Nd7+-*a7|^Ab)GIGsP}?*cWBt$$Jm{l_KRN%DZ;GlM0+V4BZEk4B=!2*dqv$a{yju@_ab zc2qlH^)60~HrbHyGFD?tV65>q0wmecWdBLiW|eP7fBRqf*jxAgA7aI}`B2`Ay>`$T zrfF;7yHxVSNI$T;V2{f0_|Xm@DO0;RbXTU6VDXj4S6#>;kx=p|+o{Yl|N4|y{6cuF zGc;&L{!%t2eTf=})cPTr{Fka+BwDA%sWm5&Ku#%r_ z7uDyeF#g8CL+Jb?o#aEGjriz6m14qa_)fAR>D|30ZZyV(N1{c6g)0fWVX|J&g23a1 zu_42alrtB;y=$oCh7i3id~5TidxLku=Lju}=clkqV++sY66LIJiH;~7*=XHnQS6%| z0HrQD0`&$R0a~|?2uD8Qn{?B6M7-2$3_pgr3BjOW3@=_8zo9uam?I2WaBML-qBN z-LTD*M1jb!HEO7d#SAIFwS8-;!sW@tLvDPOk5)N?9HnCMKd@$CUC8q*+^k-!g)A8#=##N z<7oRZMl0+Qs?gk)*0j&Xl)^IT^D&={`UGK(riNANjkM{(-;jYCOj+8hC`xJU^0JM5 zl6B%YP?O?RT;AMFZKSWs!9lpq6-fy(UdQW&UP-+xlyTT*zD$)I0x-LM^4nS?wD1E;6C%YK zq^EPt9HN{k5x9*kTpVzUmfZmB;*pob@Q@BlJ5`r zw}|@m#T->^@f1NS$tN+|RU{M&Q-=tZhNf4&N4(PMzP9zH_PwZZW(GV1mEM|%u_|w= zJx(~l;Hxjjg((s5#p+;i%clum->?kM_>AW6G}AOZq`#TZvsCu1&H;;zq=TiClR(&A z>5sVmtz0IW^ZSYY_hj1%Pg`HEGX-P455}9Lw~z?6d=yTOz%{EqXI2%abjmW~2j9-Q zAU_j?Jc_Mi@8qafY^Rj4760ZJlZ4-`KNSG3V7ef%&bC&Z9r!9Bw%I*lO6hmU2ZWFy zWR`s~*apTjkwyO<7P>(B_Kjz3!x?<95349|B;Q7~NKrAL zIOwe&fcg~4YY7P((f-mbtrx~@Q=-Vk+Uir)y-HlCM#5~vW93*p>EVojlOubOGA$9g z?_XaJAlFmC8N}oeTx)w>9QH|-rb7b5)Ow4LLYv@sM?Af9=XqHh``?|@F^&tPZMAcn z`VwR<_BiTr9mg63#r9Blb;w=a-Tb{5m9Ma>I0-%$S+vF(=e=5@;5Jry>Wn8~s+hVw^6d#@XUZAVu&JRa z)4loHu_e?{0xROsFS0H8%sKr>Je+^QfmeG;o2~K~3&1AW`Dyr3onDN;T@uOjv_I3NCGCzI&GUJeg)Tz=_S~X7Nl^Y#c-lu@0~PFm zd{b;YPasjz>|@Deg9pgfH0_-LvS|2dgixCLR6S+hIcZC_$+;HlCTrE`t6?QH zJ*pxxBpSsr1(7JvlY^aBYf6bsfgxtFqDHcRbX9B}4qktn+AgLMf=ByhQ6lav4*%kE zlIbH^d?G z(Uyb3y@!}UP_kiQL(wwoh<25KN6IkV{pm^A?( zK3QtpG4j%vxVFU6yGU}DNYL&u2%rq;V`?8Fz}ijKbj5QUe_gpTt5dZfQ~~GA>|+-Jt>Q0 z1d8#Z)klQE-Jmg%dcIM?g#0mh zMWNeV{67HI6pTd_%Q{SNifXmN5{;Oms`JT1ph!_dLCme1^8uo<2SmYMPakSr-+}6{ zi%1Ghl^}5}VB--{4^uUyAs0t>Sv9}XJrQ)Vl)CN8q5Qob&3=efB2+C=he7g603&7< zo4occj@<67|GX+nqHk)-!Bncy^jxik1U$Pt)bY!%q@PrSe()1Q$W>K|$hU?9gQI8o z;}&7#sVSR|z@dVE_*jF(2dhF=nqyWYi&1uAg>%!9yT;&VDgkH*Rs9f% z+_T3de4%(QY$Qx$D9p`l3e;cf_-dQ#6W8@6MACo}u5w?z9^M z>B)x8#)m)8zx8U1>J}ZlpAj4V?lp#i{(XGBf(#ACvkse%YFhQ30`LN0hv=JWoSDXj zyDDXdqBc@RIp%S5gB1PJ_2a)3c)J<7zz_Xa{!M=NB?#X6If}l8uCQi0Je|#Bvew9> zF+@_BwpuWFHKI|rKQbh>hXj!KG3fL6ZC-ufcQx9U8dpqcwS#=m6~3W7!eU+9#*s7? zXe{049d2opxhPQd`!E_mi6fu|F|UaXvkX8=YFckayfdfEpo|;b3LaUZUr|u6mJh`m zn8kk#Pebs&s-jk3DH_y*8xSzXiSmD}r3M;of4z)TDTV0!C2O0ZU6wko*lM)+e!9Q~ zr-@2C=}Ft|u9@N#`Q!2Q6-0~M$=xI!6)`W2(44b*4de9>7Y>MBLW}i6DD8b9>ea)$Rqk6dvsLH^F5<;*SUQ^{V>RHTOUSS zVM{Ry{P-8kHlQV!nJk^{Gmd-?E+#l-{w~iTo;t}5Z(GTkq|W^)K|IcDzaoQC)K;%K z&Xl-Zm7DEL6oZFupF8|AoARWDHSvweOi|3sw?(j93ChxZctOZ0mDm6vs z3Jh(&1Rg}UrPaNA_8a=ZxRHl8rJ%I+<-I*?gMnP+vtUK=_0P*}^8|@0GZra4lLWiR z-NI$Gjmf#9QD1?X*_NcZc6+sMIL^Bsq~hvjdfE|!59L?&5u;l>f6KqvVR!K|xTS-# z(s%lvmp#N>{+t$0@Ld+5$Q=d0-%xkuM+IiF=*_`1(h&{`sy_At}bk}kWL5Z)8_ zok5ri^_-Yfz>Kx^oDA70RDbD*v3raS8m<0p8-UyyqM~@ep=TQLqw*KyDk#=<4Z$KQ zY^S|JIpDbYcf8#Ncgi8zYY6(?ZMpp(%i79`SK;XM@44aIRk zo-^kibX&E2cYk!}n?z<- ziR-tuc%*VQe7(!l=CxUsvT?P z3U9g&%qB|}l)-kd#@#g#XmoYh$22f}YvNMScORGus8&6~;KE24XXE4$vVtJDiB_gw zs!#rIb2aavrYIf^UViv>fs{h`*DV#g&R=LQGF9f)XGTNY=Lf&jQ=vS zJ{# zsR+>3vv73meL7>l1Wu=cqG>dgj?zN_8s!FLVtGl)^$FXl8UW|DuJJ~`xAVCKwXgs* z@a48J>Yk!6x-BpQ=6$cso)Y*9$A5rIWfk8fH_XNx`{)iz7Ls0rB#n^mwG-176ml~y z^Cb$1OZQNQRw$a|#W5_2!9=rM{n-Ib;>SeAgTE#dW1Ha4Yg}&96OEOD*M1F!)1o~A zHlcEpvc0bk2t2PsY0wVEV8Uk=Um3I#>`YwpT^uYHbraXakA0a9fX~Q9ZVnB9Ujl*%J zry?Hq%_i!ZA%woi$LRl*tO z-p-ZOyKR2g*EY6#c|)P+S*X_fE$10RihTuQ#A?&OYNx2ifb%Tab0eBfCUbF4f6oC1 zgmQzj`+0y$Qmd`L29c2-9)hf0THoejFQjE8yvGAr<{wV+Fc)jl>~G-t`^px!)I2^) zzfz(i^?jyQxkG@6-um)c0Xyp&wr`(oBPsp`r#Jc{r`ju2D54GsyiA)W$S9#4Q}j&* zybVbd|GQ0s;=u*hlbqMj{bL`?#T(Q3L&;y(4(&H+MOff;mi%MmmJhseI|QTkCnyN4 z!giVD&rA9#=@`f)h2*j>hEt+-Q1gX{G`gbFp})BkrTdsnNidyEaKRqctXRUU-Gel| zlP<5qsqdOn2>tuiGoD7oJWGH&ml}&-8|eIW9O{Hw^)xGM&@7~~dV^?7v(uD*KTJ=v z^DmA-Iz5WY86ZllVLPkDy6AM1!14N~!R33DCC@v3_5{5-8#q5o8B^_p9fV1l?=1qO z_JQK9xA58bwao{P-Sm)xjCHh{t)|vq$K9g+{chC zF=i7luKm2^K02C*hOkk0J8b9vF&281iMv6+EX-V~-Vdf!s|GGqdwyMajpT1c-!PUK zj9ye0Z0B~ijeh_%!1lYA2!$pl9`!+K8?oRdWq|Y)_d830b=>et=gv#NsVq;a5fiw9 zRr8jpRqSH^)55FL*8c!2a3$jk$$>qrLz^RU=ut(g|(fFG7%S>o^|Jx5A$fYPtd|x+wTr`2(Mkd8iYQ0wkR0xbb?pxw` z_3=MnIP1KA^E)%71ILr?s$qzc+E+owsf>Iytgz~s`ctP}t3e1tqFK(qvG({SoAE%sz|cM9`Z}((qX+Orl@F*U>z)F<08=j z#3yFNiJi#+*Wx}!TtmgO{Kfb}8PTSH-0j>YtG^u0epZ%`B)?|U4{rVskW!o~;Z>0F zc_}6=kXCNP>4Ty4-ID`)cudKDED#R(G752!_&9ZpZ7gXDp8@?W!$g^GGCzyioLu$G zB334==kiCxoHe;ZGTLnq=k^q>?*awQ2O=ivzvIWR644R&^_LO&dU6T8^@;Z6gf}?2 zkBbX_wyVIZ%|tM<*~0sG5SI%zzA+$@b;z$m$0NBFmV|FFQR@QIyn~GFg3J|2H<8%y z*D=U`joqU7N7kn+dWmPM2u`E?p~E((ns)=UYown!6q>$zTS^_Ca&F-}eeyu<{ zvx(YE%Uj!NM2W43L@-wo(3&MT^h-@S)NQR$EL#x`G1D2L^r1iX-0~TR_(!9OMOa@K zJa7PK@0oU$tUfh<3nY3hvFGsn`O*#RpVlZrWO503>}WX z1lVg>=VH#G{y5x}O#*kY96K08a}7#J=p*XWsNAYF7t!ENDi+{b@ZeF}1KIhK|C0lFCC2NaU`ypaTn6(P|0}$f)8gg3MwGWwG_HE`r$CwEZtT;0 zN`qBHrkjBarXQo-?$W7~bzh1AA1B_$X4=x1XRhL?Sk{z`C2hvp{uw5*LxU@J6gd>p zxPN}YMD?h)+orDhnjT#7rt9C41P{u~=8=JS&r~v1|H;%Tnz)mLOA>tD>f575Hd3uT zlwh0-evDQ8_Onlt*lw)&Hos;A2@pG~cL*QS1#*GeFLjc;$MlFvk}VY|DPbrc$d#zE zf7rV|!d}vHVGOkz-+n3c^-EC%jdQX0X9$u1{uv`_@X7q++pED#dI_C#v$|NKp7gWH z0=I#ArB8wyilU(4=2o2e_*B)=HAE{`6X|=xI|?>~5uwD(gOLx7Uw-VZyPTq=Y_a^) z&P(ztkCIGC9FD3jNwZoLbSQ>_`su#P+?ooGN!Jg zc3q1iuJG8pN;TrRvF~VTZ$6pL4y+;}#AruH)GscL2>YBvb@taa_W(j97sx3FS}=E0 zO!0dUZl#@(f}-yma*F=@DImM?G5v}l&LLSxWC`=Us1IFo9U_W~MMI1- z6GZ38<@P(Dr~$2^LYT^KUmK`XP!QXy!+|j%iU(pdK_fa4(YH8>d{G|IF&UW4I`7Ld zXEeE}(W9e!yAg7h;7W3MxoHJ*BltQeMIm9=jScBcxw?dhlhdi# zvzot_e@>}TAB0?Hs@Bsa(IP#$-hEO6$(0+dZzlLhDU2QSdYOKh1JthBwk zX7iaT!1v57q5b!z4xZAXLSS55j5WM16z0T=sB@F+ilsqk56AP zYS#jN{f`wB%)GLd)eswi3-E6K>Nl4#vRWxy<*hoQr|?xfP)HXz^~y`BRaGhubt}@L zhv}ct5&9pN%tk3Xj=wMdyfd_9b{i_Tz?zFc>^p0wDk(O1M@%0wP_YEX`eb`XPl z*9g2OHt8~csUj(XT%S>SBj z=l)y|1Rx*oOVw97C)XmK!Lw1w=1$g+aMu&T5mr;_pdV`~U)A6VFNm5I49*1cYlxaU zPC_QHA>=%EHDe_#4gG%{XSpc6B=sg~4%vUy6dt%D6+gT0nd_53l%*a~?)uj(UD&|= zd5qkjFJLsd=XBrJwc1!9DxJEmN-8J$Kg0*>kHxekQIFdG?Cna~MNC?C(TAuJ9K#(@o3`~`2 zWLS~qEHL<4h?hHg0!=*;@E}Ah+>(t|)+Mk_1zTvAFhrf^7`uu0OhLh}bldx3)D0l} zyeIWe$$MM#KR{3{8P5rg_&IxZnC#yEcdxs>)W)S}uTl;%7Jfkr`e2Czshs zu@X1I7l=o0;={I{!h48**n{{po}VWQyz_N<^?lFGYwlrlY}G$<{*GKHW=$=ylIz~M z408R%nf8D3b_uRT>>r zH#{%EH)n73v2gUzFX;Q<2`?ODhVef+RNoJ@j(5yO+?v`U^i{Lx z`wl0ap4Tv{C6x1cDpX^K9n^c@4CSn!cbO_=R*y*p44Usk1{umtM@mf`P9mnHQ{_BR&e6OHLbXtmg zgoxJ+3N^K*Gy4_2lWymNWgS^`OX_C1u*Bj_BN9PwvfS4Z=*o}y^?S>kk z$K>u%q1%pBw$h>o=~@V>lxn)4=Rwhrv0;1`-!wN~uC z>+iLHt=4Kdb(Y~h&IS0o(cDW|OC-_$O2HsHoPfR^aa?6uKZj(6{LHkuS+|k-Spz)ftL7 zuUr;|qjr8YiR4LYWYHlV%(@2&Th~0OERQriItI{H9Bajomh_2v1d$X}8cT;0e3^Ov z%l4rW9L0PC;M4s>$uO-5$XB{ePHHrXw{%s^a9`7yoGrqhM>pFH0Y_5;G|+M# zW+v_u&%Uu-VCE7r+>e$~#&YKkSO4qf(s-3+_UAhH<+jeL*7oui&6339ow*+gFh0~L zuC-q}ro^5}xFHsE`Iw|D-xzE)v<%T*?t20y@SKF~`QGydFp{_gVP}E%J)!>A;&DI4{ZY_$Vp&%c=S&Xs3jnrGGN`s%NA6 zh`EaOE^akTBZAZ>VU!1L{~d|Qp-^mBqg_qxeQ*t`uLg54$C^GKo7?Ny~7b=e-CIPWXHJD#z&qd*@b&+)DlY}B+j*r=Y=d70pmR3Y<(GzKUvM?Tr#$EUR3zMLrS z+MRIrbrik_pHH^>Wbohi8>J>fRSuK`PPs=}ay|%hP}qqBLP=TxcH6JWAdI-fAe#Pd zdH*@je$#<&pM1t}tOfH3%>h=Szw zqIw6kCzxnR`*aVX2_L|)E_x{O3wW4fx6B`%R+am4OfS~8zoULf$2p}*QoKv7Ni}!_ z5Yxa+OJpPaK!L-l2%Mm&9^6&=BNHuOqThxc74-L6NOSnN`ANj9KS(JsWzLF>T^~S* zqXy%P#%xLAJQqIMr=E9DvCxXwrxvU~0%E9Dri+@S$RQ4nW2XX(gZ-0 z-*ct3Y@fMVr06GESj|+GW%$NNW~W00M5?#v66cA+kn|OwNdIS|n}v(ka2v8{VQHW< zoBO6O1kmeV=caY`AAppD9`Wp3lqHGScsg9q*y=73^Awd0iZksEQL<~#@{A~OCXgEC zjq~zwPAZK))B7MoM#dNsWj`|1#gBN;dZ10jMEL=p%%2f5=ewRlpX2C9;P+Z~zDzfh zM)E%ZUd-zj2H)of0KO$hZq`Mh+(kV(#+X`*#)^qMS9`54~RSnsTtmR=8mepm>lGSV5t$En{%O*FeDC9UCsiA(qkCRKxIpN+0q_ye{+C6Th za?TnMRqKoNuWy46M@<7c%Tce+cMBf1-sV~R)^@!48dtSn@i5x$y{CvDxwcLFCRu~c zeWWSexo^d_I2v2|;7EoWC!>7cD59X4#>lqepT)amZtqWhQT9X^grLCD;C%QlQ_2x8 zFb&yKLdKHKGJ#okDnnaf6fq%LntsE${X&D`ZlFDE{TpFMCm~4Z0ay979aDTK6H<0l z2wEJAT>@)p$9+v}{)DaX7w+^y!NXQ5WD10=G-VefR*vHBKq#noO zwvY~uWw~t&Rp6wN=+cLk z)A}zfiK233|3Dg%q#FeLGdTF!XLidkhVCb)%Y&2}RqxU#cw$U%msT~cB6q>+F(55# z#VLX=nSVko6A4X$ zzE01X#G#osDsdqnK6SwYX8Ue|F{`IAAIBI^`Huu>eFkW`?nG*)$lQdyJyVPnnI z@HGo#yx zH^p!0o+n_cp^yhJ6FkWq{Hb;7f}}WUg|&uUqL0exV|cxqg7>*pxQEJSywtrm0mpQv zpT7`{VKD)K+Z5ndgUPxWpH-75w9kL87$ap}xQWmVN5jJg1r5QN)sk}VF;xE8iOEi~ z2{sZmvs6syG)3EYjo9ekSlD~2j;}tZkBp}()KrfxKWh1hqyQ5){ALS|`7)J9l-5~|gCPCO0JDYb}_pA@5FZ9|d7w=vaMbbL#4W>gxIk6cTrkK9$g678s*dkj|#J(G&;+>{5k2!ocw1cl2@%Mqg1j>MJOp; zEaIK-xi(NLdAMZ)PygOelQeY7(YDp^3TzLk;@2vkP-!dT0StG0QmL)@yO{uiQ z)$nfPZ_Dp0G_B37bOw)j;@p9ZDy1XwabF;i<{)q6!)!-bcVApE64)im)CTH&76W3< zs$(h0lYj$^d^Dh%F1?+dJ2i{2NKcJqNDSUfv}knrF|H2|`0!vnw#swQ8Orejo(#T( zYCdrt_86_;J@}Jqt}28SH%h*jY~?VIRT3i4&;q@fB%4;TYMRyC=bS-DPrGWn*gW0y zf`GISVuks}Jlhp?fRakLl>*>O*+9@?1H=b6y{Ypde$jsMev`)5+MR`;ID*?r4#K48 zLrxpK18QE#By&O|A)#@0iB_!~H@O*}x9yNe2-;>#b2zDJlez%Im0H?|1o>zF?9wd}OW^xq>fN9GXzoh5r_7@l;Ru1H3H=Y&L5-h%A<~2jJic*afF)`}Z_9r; zIXJn<5|7{WhQP%~v&Kk-f+9I=fG0?=hZ&1NH;T|uvF`Q!<(w@RSc;C*eZ7O0kLM8$ z@HmfIG=ZB<0%HZwCnhfxIo>29iYTL{lkd(7U=@-eeV?pydaTMd6@&o*MHRSf2hb3R zfRzBkDtnkvO06n{5*;fGe%e+Kb>%58pd1pvyKUupAxB!G3_W8nPP)(g;Y}iYX@&3#hITvZJll|q|kVB;qs8I$*920~JQ9;w(bo^pi zDauo{_I70G9vgtrS5)frm!u;HOSk8DCzKF772dqT!qTtAMMLi>`M?+j6*pHNluDPg zd9{HzElMJcaHF_>@Ln>l%XX)o?|3K*4&d{>O@98cl%xetE`+t$-VIm{q9e%}^!)kC zhS9p)?AG=LzIB5}bBZkr0znE@#ktm=P(=x8XP1eM#x~$DGj)9!MId$uD&0T}6xI`1AUwxft-o5l;j}Jl4KJ1v=US7F~lpcF$SxgjFPH@sj$plf{yyf57@}o~@e^^h* zI5h^H8KoM$VLjC<`t8Qo2wn37e{(8T6HnIh0?p?Dr}>4I%`ju`R)?~3mtl`ldCLUN)7;<8LBRIvCL!9NBQ zt+H%KPce<|9&vU_(5e9|fAOZ`i3W4U63Y|Ct(igg-uTU`8YzLyOK4xE_aDqF0sA0K=k0t&80C>WyWsAO4V==51f^ygJy?Eec(R|AS-0} zfcn5Ovv5d!03W<}Gq!;&);$S(iR3YZfy#vWxVr^30m@-4XzT7qsW|b z#sC;KsyrK%^VTgXWOM^fDc-ViLINQq@gKii^Nb|~bTQ7aY~1fU9;|mH2vG)wMRJfy z1c=({^|OWJDX60;L4JWM&b@Pwbp{1gt!th+4~!y_A}uxAHLo*XamlbCMOR1N@i8hq z)`2T6j==5XpNgodKvKHrM~OFf^@Zyr)Kff#j>yj#nb;GukrQB^NqCsDkwR2bdR~8= zX-$jninPNag$Uc5@sA?H=TL}K} zow`Z&j^VV2BBEc1CChDPFOO|~+$WnVvy)G_$0uNxCo^;I;us69?GN)I#K`#^nRSz5 zZn(a^{bz-_w>ijIdBs&2GtX`hWTSNUbfeZ#rGgPaLseK9s{T@rfuwDV+%CrQk0l)_e3pyv9W|D+XWY^~8nhnt;3G800b3uji zMMucf>m5-$;fu;`NL?1X9GhtbQYmQ;)+wR@V}QsMs8O^g*3j4?o$3V+my!h!h3^Kb z1xpa>leZ1w5H8g}`;JF)oVO3WvR6RV1lM|9Oq7<16L?W}C!R7@P#QsWlob46Egcw~ zL*n)L!^uLH$RK!CTAn5ulqUx%UHl(;J_p*OtmEq@7%Fy&zR)M5CK3ok^0@RT$kF9- zi%D40_P)Qv8|RUVDsI<}`@^VGu&{F1k679*BLi)NkL`lk#Z@K&;W$UxjwZ;CVN#k& zP}r0cLAv#O2vXHyxkW^duoMn*1F7*5UNx+bG(u>wA3?p>7%W{wqKJrw_u~jPR>Flx z!`Fny7$7eMCFkbhuzhHY?8!7bCYh5tU;tmA8K{FiAnbi5GC@hMc$GMg37{$mZcTvvKXRYzpD-Z7B9Ou>{{ zq9 zO~L}JRb)6f=PVIXfC)-~9!jAx$}I39Br367>;OHyMh2Q6&jZBVom`w{a5-loWbrXw zAwr8gnHxqkSp`}VI!76U%za@urrXvWLpguUCv^p0d>?qi>j>jUYQ2Uc4d`aQv0w8q zocc$b`5bE?inmBScyK7EWnm>4DS+Nlxk>)gBT?GgU7L`YpgKwM$&;ckNRq_~$64T!n zL*>V)YqIKgoh&DZC0fNG`Z@pr=*38ZQ{mn{#Kj^gPC8_Maj$ANinD;gZBPYrUD!JY zgmT$Vo#bf~QD61(jF_M}ZE59QzCF2je?=n2UG!iDnM=F8HpyN<#{ow`JUYsRsqT*4 zet7qs=s;B45B1I7gaPHPXVk)2fwYFin>R9$h5{%u)sVQLVV0k$c7!grGnLY;0(t?>~py8qgtpKq~Q?oei1QL=f z*r1{&7Ym3K0;Et#>C#-Wj0HzQ9fEbMg~=rwUc^rh4bTKCBbW}Ghq3JL%)Tc;l4Udo`A7hpipSmO`I z1!|*05D`tV?IdbCN(g8G2>^IR1Ym;HAVf9^vLFMrF|i^ndW8TtWmH#XnD*gB01F{5 zo71}M5>N&}+*Cky?)QaSQXMY`m%`7CR3stGT1OD@)x)jq`8mUh-R}uRf_HkvC7{|I zG1flHs0Viv5Pipc4gB&LRn6tYlB$@_QBDv#BzwXn5dq>q`>F0dX3#G9uF-b~R^M#s_TG=6X^^|#T6%-*nj5a9DE z!=kkkElSiT)s<{G4|T?Zj)JLE;5%@D&{JnT?LvJR*GATC(h2KWV31PyulQo1LR$3`GRd5cLZEWvVb#$cp{<;|ZxO!$2%QL6;-}S6gRatk59Q0C%}L(asxCT%*x- z*FRWXl-r9cp58N4PY8k?uaN8B@-f3}A8Cx)z9^c4odjcgNRfG-c15{z%rPOfsiaaAj-qAEq^m&@d_jyZ3OL39 zY3-qT2oCc2B(bF|0j)0lM9FX#j@xmZA<^-BafL`#w0uwR0APcJ4HI6@a5BWy3Amh( zA2VEIIw@L{L;-K!_l;1T3aARC=4z975uT`)RpFtYR*-SRA_ZfST(m=-^kQITVA>dn zjo9|mlLCsMpn}zLBN<7B_VxuvqNad4x1$dA^V60j5 zh+q&WQmb~=6HTWG;}panh^fPOba0c#7YU;!kW-}7DZX$}BLlS>v36Zhw|60Is6lK_ zRB*f*xG~a5*M9KdC_yY_{o_UegnHj6tY}pilf7aDCWnsj*ifa${L=-|AM+#eGWjgX zgftkD6qw05H06{WLUM@1@q&886-1B-93>%a^b)8!U;i6er*F znsASf@yfz*-C&_3O`dV9A>Ddv{gVd}q7X=@RAQT&Cfq84(#2h`DXDaD1yxF24u~C3 z#v0eO3edd>CbzuWLJAEG2M|Y%;=M_scGX=R75!ld=p4yhbOG)TC}E*N4qXG4{8bDP zpwd8EQPFH32yI+}i3NZN*gE7N`r#HRpefh!f@h`O1F~oXe>vmzvwPNCxESC2S!9nU zy2BnvtLjs4Ni~o_|7u`uc2Si?lv;7ZkikI1_auJ&sjTr;%UG}#TPwnLq(R+2*m5I{{23t}c9A!)FP z%C!TnKn5z{bjZ{ium~kmi!SwriZO+Xl-iK(y5qb7umu{AQ1HKH$2Kq#WxJ4CuN&_T zm>L8Ob!01h#KY{vTjBhZH9%N5urSmU3Cj)rW{#M9VKu0%(>!LR5jfKC0954OQBEuz z3Q2~xUf($Qb}iuxU%|(@<0J4T5ks`{^5d1)uTMAYSpg9Zoe4qpQ|l(FTSJ}q@sS8AD^B`fuJAs2Y*c!bk`>LpsK4Gl?)()+(wfnrMpJTxz;#1u0WosRL>^Nw0#y zK|z4cH>@(Rp=lJ|5eAl$>~!K6R$l<=5vc)Tdz-@R3Q7PF2q1(QgKIJB_zi6k0@Jt` z;_o+J(G(ZExR=SSEP_Zcj+~tub6FQBhSHBtH999A@QKwbc5MCS6(XmGf94M>b!}0< z9Az-ddaeF2O)wNTsgHn&zc*J5mz0J5*0B0y+vCk8v0b-4WZ)oFHm~=O1`}h+LHfbw*aMK@^UgHA z44^kFLa!Ugp<1f15&Z|=9DoiW2Cf5gbJiZm13haTZnu|z81@DiSV?5GQvxJqSL1k5 zfDY_q5Z33;I!I3W9AH+dJY)qo_;~c;aB!>;$tvORY(J0I6k|y?;n^Xb(g1!R z-didU7fslHM+KlD-6PNQk^l-Dvd#UUj1%w?%I|-?F4P9JrYGQVxQ2zOb}JUl;Mbx$ z8)QoG{I#E(gy_?o6fFKfSOz1tdwBc85f~PA^56u}TJTR88BAeFRR>-<^NvU?%7IvF zLcMX7;97YKenq~621#H%ZxiJ}qMMVw7>Qx+HVF|JM(Os_hA@k(0D1)HndV@>x+ow4 z-UQKLRmg{14A312Q8pBI5$s6llN8b{wG#-e~iIo7*K!(AnMXo=O5G@@^_$E9A zaDlD|V1v=}2hd7jUPI3G1mgrd;u5&8Z_9^EVr}Phqw%b2N>D!9FZ{U`8yG~_3-7FP zXweGt=r-5i>lRQTK?7bxbz#KZml2n$VL5{KP3=0vJlJjW?Wnnr*UvyWJIqjJF~I|vZke>VyUh_4fVgnmiuE%uN+`YZL9yTUI%KJog7 z3*Q6z#ZV#1+3Ofsb-r*F5r*%R6~GLMtz2Qk9S$`A0JuX4QZ-h7IK%*r-9zY|V;cqp zJok)VwTKWw<#4;T0QZBOk_AzAgfwXH3?_wD?x*vQ8YoAE-G6%TMk(8(V2_1(>jhEI zQg_Sa7(f(3AL3%7!$>mt+rOMjYB;%ST4@d84&g5(8t2iPcN~VQ1wHM-?C1=YKm}EL z*ElsqsME5G?6170H-E+|PN*L|3{?6xedxvINWUV>n(%+a9$8g1Yfd&u1V)Z4Tz6zZ zu85YeS5VuG=_h4Tk~f!Fx&(Bt5h}nGtLVo#u0uc(djRtrtCmnYs3q;?+nN_=D)o_a zZ%A%<{bE7_LaSV1o%uLSEvXVNjRXDS7CaR@U2?xzENcLW_(w>&X3abVy@57ITI&IW z@m)?7JcKBymLTJ4g*h1#YW6xkmSjz`BnBji!B(t_AmZ&@Wyqo25v3g#xZAi?1yqf; zpMKnRNv0K82ZN3dJ1{TFA3^fjjf~$zgzWLMLzjU|f=v8(w(j#y}{+0WgFW zwP}{qsm9vZJx+DotOAis%`Wvycg_^G#;OcQeFyW9qNLJ_d~-E0Bgh3|O$pZDj3%X4 zY)uQah&?*%4@Qrwsby-r+iY!^hw2C@K)jUbPB_*!?K}ZJH8no>hQ3yv2Waw5>S6ce zNJWG<<8Hj*>%;1P@qi9dwvVio8jsglCIa5NLB^v{m;U&`U>*1?+w*YtnM{E9%lB}t zjN(AZ4SZrnKx*RT$U#OB?GM;=;gKXNAe7-lb@z%um4*`9y%^4^18{EDzBh(iE}6IO z+m=x0O5#+!@8br7kI>}}A(yZFSelmLv?mTCq6*i_c%%BsDxsL1ww_eD@yO@Y3&WuG zGgh#c=m0-U_letZH8I<%x_=mv@X~r2#ZH`64m%@6FgfRrZz16F z_i~z+8dsM#=qD&fZ_ncu%Nj#E;}{Vj)pnjf_llEpE!|f}3;^(k8x^_dy8i%NZk`t| zi0b;dXaQCRh1;*rIB2jPL=0ZI5!6dw=)2&nUm*HxwuGi|NivNPvT+ zK7oGBC(RIfhb~D)OkP}pc>`E{Q1E2Av9T2q;RY9A9&5tU^DEK{o0_lljKwHkxc)K$(pR0x@xA=yvqcHFT;Fr@d&`0@9UlrkYm z>x_{l4OUam_xO0$B`q5ZDBU&3%e*v@9U9qtH@#YSCL@}pZk5om={V~3#twjR3Zexa zK^gbq##kt!5xj2jb42+uzb9z#sHiB6(piZ>1ld5;g2CGBYrLmO4-WV=Uk4A3*RR{IYEHTf;v2sIC6+W z_XTg-pMP0ZK!ALo?g8hlEXIR>tZ7Up^?7hz5QtIkzPF1>Y!DUFp{<}~ct~tUKG;MZc&7y8SVQg(sHTL&}EtvP?93!X)oOO${czi_y9F*4e z;|-jRJxt-}iixk&toXeV3(BLi>&G}v;xDctP1p&@ZO&?ZJY_%+r}L7@VYdnGw}(r|boqRyL0Lvc8{$f{^i4gs85z0-*?3Lxn~ZKPL?^0QCQ8iIgGLu#Q3 z(C>S+)*%2jNC+l;;KY}~>Emn&^P zaUzA)x1D2!Rsqf4C}VH5bQ!+oB6$w5aZxlPotQ!r+K4&{wSD0r>CjGb%!I43Ct=&; ztSY12)H*Mhm**G~&BnvG;Qp`xq#AFc%k^KpqzzO&ZO6RSn7kj}K>eRsic%)T-_9^Q zS$!CZU0r+!`sXP$4+!^#p)opXC*?4H(m^7v;J<4GKsQf9VlfZ{WJJEIxP#`O6zKjBtZEg!9T`xKYvTzu z)?SogEeLq5_1hw>v3vd?{bDpZF*pSP0?NNQBB2n`@IB#%P|!aKdics%jjlE0E!;{P zCOWzcRGrM8ASm*bbbF_oaW&;SqD51EY(!hx!lj~Q_>Rj_9tfBAx_rL>-Ql-R4==f)MGT`EFyqc1$0 z>BUB?V5zgVamP7OYY2jN&9cZvG`hF|AdmrD!N7ELHQM8{gQApy6_T6t&loaD97PbZ zSCmdPBk_e&0=A{16M_&D<9{!vkOUI4o$M8GQIn!|?}erJOMok=1L z?tJ4lMdi={1UspZlU18WD0f>Qlg3DjtblcbMh3|^_Wp9ng$*7rHS)b>v_qwO{{Z(8 z3RtfO5{8X?z-$9UfrMev&alT}z1R|O5vZ%!D_^3%QhCU#(AuC=;|`vsAn&6cK0Zgr zN(d$c`8_!b#7d>y*L5r73U#$!L6-P8f*Bf~LF4ZX;>1bzJNYnl@#UgmAp?{b7sghU zXd`~!Z1vK-%99V49J0vG;k?VT*h*88U^6l75O&k6)6ah%H)BXkd!Bp!Ys>hJh zAQ3!wF`WTyQB!t17W2aMj-Xi8v0&GpI;Og@(kcv~0j&&Pj`geS8iY4$c)K4_*?H>> z7!?lG>gw#P^)4UFY3dfmH}knQi}FcM+XOan@>Q*Hh#C_^tJoI z$5j#iGdaYUt3Ql$YVbQUL?Mt-01wXayDkSv^mgQoBnZQ@7~grdjmfY8PNg@)k~dhz z{&27@QJtN>vD=7CN9H~ zuZ#P^OF$>8m{>^lq`GHJo5l$wG1)YU=XWDfWoGikK-7^C75FubSioS5XJRKE;>j$u z5&^BM>mZGtq92}D=MGazx0B8I|0$j)|saYaI%B z!md;hQD2|dHz=KMq0r>^KO&fg!hCjsFTwoGvK+UR1W&{J#-b=jk=_pnNCjaBy#c{? zbQGP8a=FA6pag#7fr;fqq3QkQ$OhkM`gUgs!W=X`{Na!Qj8>+^-N~dI3axeeMc?oRpF$2cm06+6}&Vy>%a#uAV%VwULm!~>nkR+sZ!en3)Ho1e}Jg8>ndH_u;q zvWPi|{{TSf?>IIfobl%p4JjgU9bem&;jlo&s?lmLxWFobp?Bf@{;|WR%J&C2q?fk32ZWQC8@JEB0d`z*OSyZ{@jaPz4J{ zA0qz%*Dn;PP1{u#uG^3~h_mtw2OU@dQ ztx5XHRMl?H84x0#IJj*Jysl`SlzrS1nuxFQjshA_?*T1%I^*|{5C)Lq;K;W`4zaBO z?WO^Mij{Y*c3w;&YAA`fDfCc2Fa?T2g|MUSkI0x%K~Xem+2CNM~#ie`Dk~W&*L@INDMjL^IUY` zI73b)Qdt49IQzm9@-N0TvA{2Q==3zW(3xQJ;-G;6eUne#LXcYR9}7rFa+tlP2&5t7 znSY-dBPeO=EFV!adIVwK_FNjcqB>R=;u$O?Dm0>FJzBu<+IhY`Wz?ur?j%R{e0*Uw zN(5JKea`&ncR*8A@gEN+5n!ig@qTjC{KJ6Dg>?Mum)@K@njtoiDl_S`yon@Rvo_%s z^}TxU80p*!J@0g?#h*LJm=4^I;ymyx+n3EIx@nZ##_n7s=qy$QM(=Cac=Mt#eSq<~ zhcbjfFPj!um|n5Ldm=}{wVs@D71(wc-WpUpOV+-yO9CkEj>@1OToP6)1(F~)#~02s z@|&Cu{=#CM`{puVel{&TWh)sBQFTB7gw9obS&( z=Hcwa(9x~;nvr#fOxuJYZf_e-sF-A^E8hFb>pU<<7g%n>ZmaxZ0(BvT`xjcspb!;Z zhrkv3#~Tq#5Z~`FfRxmV2))Jm;`q9NWFSHSa(g`E#$-|nr}+$ST7{%u-xC9xst=Ms ztd0OgkT`@$##)t*cEB z*@VcXLsNbAjYv%rsD*FeSZY;9?p1mGOmK+w1=w`B4vE@2?Y@-PquS*0(q1RQ(UE+n zu@&aJf4rH-iPCt+X-JwjgU=i?|(OY1QAx zv4XrGycty`f$tn6tFMgSD!azBU0o?v_#tzB4OP=Nm!~xlpiw{(AG{)AtE03O@|Yxt znYQOzsQ?^3V-}EkR`7e{k2p$@8Z?FyfIJ-@NBY8O zqoRDx4ZN&|FkX&LwY<>LmIlJa^to5eZU6YR?s zL2NOymrn$ADfya&F*s2UA4|C2;BE>Mb;tct~HWfwIzJJUu+c&Kb-#Fqe;XvnamBy1H1tm^H z%e*~+5k0)P>w1C<4Qm2IOgaTNUi8d>kO3fF9sS|e73yd_88$WMUb2$NIKr__d|*xt zDT5mI?-zX95<+u^0J|-_e(}iDd?T^IfGLggVDB*pi+jKI%hB=y8_@HFEb3MluyWvm z*g^U@!hGoyV9bSM0o^{WRKC{U=!zCzy(-ix|s5IzJ z%fEPS0yj^9{1wI}4J*dn7D6{0xz3^4)&(dVWdX}O*8Z`T)CwpL3h(ph48cWIO$%TKs> zj9s&h2k`6ngHVc~q#5DE#M1Ii({y$_#R8LBImUpX>67>?j^n>EU(2@-D z1%88^Tsjms4DIip3^A(eK=?30li|)VI;X??-f7quuv>+>SBHR;_PKbt4Y=Do4ln}) z(6#}a19gC=DINoIIm!b*65ny+qeCi32cheja?Qv+0C5W>ATb1v@!xV3q_PyOu61Og*R%wId!AxLNt z4MjgZVFE)9rFoqhbVU%n`267q4$vq!pPY2rHk%i`vecR`BDA-dzD(hB8p8EFR)_zpOw#hLb~rC=}uB#zO%V2^YMF4EA5amY-Vwuu~wK z*e(Jt9g>Hk#uN#rX~!YMcwz?*QD2Aa2y?Zr7!HqD4K(W;grJi88U&p#Q3{yJmD+?kxibklV=kzLGKNZon;HF)We5H zu=X5k`Nb50pmskw-$-Du(X%x;@LKjfKh7Xjxe9!lBwK@&JUV_b*{k8kX(<)i@t332 zjs4=O9}{R}6`C7+#0smbTsD(o$7~C^WW)$lba^vK^oacBP`Wt74;%R~h@JJ7O6Lq- z12-C8PdU$rhc^K(t}sXdaeyoUpE)w4VO#+Mv=?f=F(RUd%HDY3>o$;qwtpCI1ZRwk zgvou!tN^hP8kK$Yh8(lvTuT z4)DE!#>_+kIWUwWc+1caiGcwTq8FKpXhx_j@q@1=nyw65DZ4eC$xbadiW`-V9kTaK zay30T<=;06aOp$QhlGEeE4>d+6M+2Wei7U2FOWB2bBAbIfu@1Wss<>IGa6`d;30Wa zj3HJY4)Rb6X`N-A^>M|*`O5>zFf%(l%49PfuA>Y4!bp#m59!D3+1vCwak#0lrTaC3 zWxEjjnH6Z7-Q`o9zBFiChG0X(glrsV3i`&|V8n1Ez#hKw+C+jmKtpYKI>QAJ+{H`2 zyx|deE57lz+L*vzu?Tw2X5#9;i%o=u>Bn-s@t|=AcHaExhi9)9Gjkj(GCh$NF_QEx=Tk(QG zjl>js#`$qut}<=QG@HUbu`sc4+Ab~%OeBkdcTM8#oJd?O7Z}A{{ti8!vSCtUdt<$_ z1vAD3ujq03%AuploadFile([ - 'file' => $encodedImageData, - 'fileName' => 'sample-base64-upload', - 'folder' => 'sample-folder', - 'tags' => implode(['abd', 'def']), - 'useUniqueFileName' => false, - 'customCoordinates' => implode(',', ['10', '10', '100', '100']), - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], -]); - -echo "\n\n"; -echo "1. Upload Image (Base64) - Response: \n"; -echo "\033[01;32m".print_r($uploadFile, true)."\033[0m"; -echo "\n"; - -// Upload Image - Binary - -$uploadFile = $imageKit->uploadFile([ - 'file' => fopen(__DIR__ . '/sample_image.jpeg', 'r'), - 'fileName' => 'sample-binary-upload', - 'folder' => 'sample-folder', - 'tags' => implode(['abd', 'def']), - 'useUniqueFileName' => true, - 'customCoordinates' => implode(',', ['10', '10', '100', '100']), - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], -]); - -echo "\n\n"; -echo "2. Upload Image (Binary) - Response: \n"; -echo "\033[01;32m".print_r($uploadFile, true)."\033[0m"; -echo "\n"; - - -// Upload Image - URL - -$uploadFile = $imageKit->uploadFile([ - 'file' => $sample_file_url, - 'fileName' => 'sample-url-upload', - 'folder' => 'sample-folder', - 'tags' => implode(['abd', 'def']), - 'useUniqueFileName' => true, - 'customCoordinates' => implode(',', ['10', '10', '100', '100']), - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], -]); - -echo "\n\n"; -echo "3. Upload Image (URL) - Response: \n"; -echo "\033[01;32m".print_r($uploadFile, true)."\033[0m"; -echo "\n"; diff --git a/sample/upload_api/sample_image.jpeg b/sample/upload_api/sample_image.jpeg deleted file mode 100644 index 44283cdf1be12c157324e4ea3fab3c89f05224f5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 62767 zcmb5V^LJ%Wus(dEiH(Ulv29E|vF+qUC$=*a8x!Zmw#|uc+s4GkcRu&M_YZiVA9}B~ zYwcdWd)4ZyuBV>Q<0H13BF#rq{G&D36%)bE!2IdPa5*+M5 zpduo|BcY>WV4$O-qhsO_e#OMX$3{oTCBwxhA|fFn!Td`8jhy%!Au$Q@f0ID``xN#I zED9VP3NaQs7V-aYeD(s+;ULN(e?mc!10c~MpwJ;c`vHUi03_6Zs|EZYpr9cjVZH!h z;r?0iAOQav|IhT_69N(n8s>8qfCL2rfJB2r`}gKlX4!o_rLk^a$q){BTN;Cco1@lP zAch=X1|OH}m7Kz+lLpI)AM$$&CbD)nM!--OIh<4&LxhX1N*46YlXfLl1hqgEFmqab zIssv!>{!}p!xuAeoz*y}BM+go`AhmP2G)@powK!&`G}*`SM~1?$;5S64)loG0`oj% zt$Z9P+1BH_hPWXU-6aICX&jn!-T*JHQ%g7#rU<1%Xy1HnTEb+7rbyX{-vD4`uQ>zp z-5+my-E2_A^7GN!@ocOYs+Rz7SP7lZN=kvW3VEf+&o*R-<(y@|Qo&yF3*Bc3^gqM* zr&w6i?$w>DI(oL^i;xCVO45Zzm85O0=`_-$mGF`&`bp^i}7fE~94Nb3Qv-Vn_4d*F0_t@yUe#Ywd{Ad(gtPYqlgt;Z8khU61xRVzJ9h2mB zLBy--&G&Y+A@!DC&A8x2{I)VQX#Un{&q)alccx|2X_9Xcim7Z_FNPO1uQ@$tV+xWn zh(A@wgOJ$wv%Zyz&&nEP*M(_(_JXm(Ezr!-+A(s!+SQLKot7C_c@S#Vfw!f(-_<^D zfS&508^|HAhpNzb)LQtpDMcz>5n67EFtClygIo}2hQ*JtS@=yoH3uiy=!>Ju{lNYR zkf*?{9k6$r+R|D7)VQF3>z!OU|iB454ngBH` zvbQmNin=koN|njC`)P$6I+124^t#k)MeV|JN0XIulU2vZ6GFjg)@*XOFV+U>;p*q) zzgn1XLl!-&>--#EiXz*t`*c@ogOEv8F^mjZ0GpptNzHRC%Z~5ED7ttSg`i6GRhR88w}bvE2PKsEODdX zMu&A#H)V)Kf$poJ7_}tk6j;%Z5sK7-QF#SnYz1|US)OF+LZv_*fnR%SX19p4nT<>~t!l7TPSq9#a4aXA*1lm>OT~C-cdzAWcbcw&vFsMmwuwB76>`7*=GiCfLL^j&h zdMSB~f7KELz9r_86{-QnsY}Xj6Xw|y;QkOW6PF|Xkfk;99w zs1=;fS=v_T9jO12P%PN=25GyMk>i?4V~op}X~q(?HA+r^ zoNhbpzdhA9%3@6x^iXJ!SImeLO$2V{(@P5s{{1{ZGOz1+#qi?^aW-Q(Db; zt+&!D7wIt38g(i2YX_^523d*<5h2ieN|cU8zb{;5##V?h4fGbW%N-ibS-0qw5E3)4 zTlKb5Ami@LS~!R*-XE&-!Wq$J!#LTtCK~n+PQ?^?2k=)$7e)&t9@jZ0p>ip)8?kzu z*p|z3UpJ|?$@8tc4XTZCr^byy&7PItLRfaWqg`x`24u?TRH@Dld3kZ@Ih4cW!_XTu zq68H{GefBAj1~4$s#0RbDDI`&sebf9JI6NjzStAYss;UiwG1U3Y^|qhSPJ_RT0L@?;c@T!?At1BdDw9#OD)uhyp4+A zyn24qFy4USzTR%2K~>t}+uI}MyY_pdL$&22YbFo*SRy`${`6J}SoPYPo5_Ic}mitRWCynoU z6#`@2X5OU;yDlb1F=zg$v37&{t6g#)ZKDL%(g?ky#r4jqvqGt7$##!+cX9a4;3l~l zL+p*WIwv4=n29`HJ7d5tU#@dDgg>t_+f8Da7W<74?gKT*5(anccTEP96~;7|DPB_x z@hf<5jdOjP-YG43LKl>NvT#lVyj>#_v?EaPOZHUwDL%Szq;vWsc2VbG)X$l{w#d0E zeE)oL0Q)=RrF-d7Dwhp{lg);1GAlwrx9Qawj4yKRrf5h6KO1=iXwz2STWdUT*6z^maX_1SNs0)%mhw{>Cp^Vq@}l1xV>J z?XJiPc4}T3hstf-t&wv@OCw!6hD4X9HhzJzyZ8>`J3%!)BIV?SKB4S1jI_CRw?|O>kE@5M# zT%WyxA|-IIwUQ15-uwL3BMzf6^F(aB;7rKgoJ{?p^7cC5QlY=f;Q~C3Co8% zr+nS1F7NQs2K;Sp93uB}*t)Yij_&E50$5k9FE`Ha)D?~G9f!56IyXy6Vybu@CYy$u z(;m!KK6w$RMTAS9(~iE3f()9swgh39tqjH91%oq{`s0wV^2{dGX>lKZp1TjJK3?7B zY`^HFGAkvi@!v8O<1<+Q34kqCpit$p<^PTSFESi!o2IFMq%}PgN4g^e)w^e(oky-r`iN z=`A@#@7IJ#o57f8n>B%;0gAG%0-wBuA&O(!pNsNY41Nyt@@6nK43Qm^Vue4YAO`5( zEuv4?kY2Uyg!Q4m%1DPEHR{rVU~u7BbU@%zFlpZW+wA$SHzhfoLw;4lNbwd?xF(JTSTq)Z1sLV z)|E^TPCFijkGt{mYI5KCr@5vpeAS=4^ZMiB&}0XW^|Bd~S?$Y`d1O4ql`)_aGupPJ z(O`2MjDQHtb8^1B6?m@|iXVL3Gm-F0GLo918VDohhCgx-!ZqC^Nl+Z|{ON}hx-#aM zbko501N$w6JRp#Vjx()B7Q&DXIN>NmpX)C8@=C_+P9r+L8 z6{3;rJDs)^sm$gGJy?CoEN5-4dnN0Hp164q3{RlSD>rTn|1i<7?#Q^CQV=73>ZDv|D(*zb7i<8%6OU)7G+S3Hah zLEb78^S7nVR%wKhvestD2jcr#cJf z!D`sn&KUDe-uVt{a2qCY(_h9I#;O8_$29E)aQN-GQ{s!`_Fdd67Mz-#;*T9+7=cCg z>>M`>FI;Rl4KEx`4WocZL3m$*BZOJDq7v7I^aW2h_Jzv)#7jl-(xw4XvjmLFYSna| z=ZWpC0`s4%ZagxXyK15($K~|AkqY&v>kY}F8Yy+gwfJEQ@dAZz2unO;QJfs+5Ai@O zOjqN2fI)RoXAI7!(O1!s;M;Pq#u+>|G%ryL4z^p@P#XNr7D@WFHqtX{Wh?H`Qut~f z(K_kp2vLG52ovjkw#GA0LSvk!Xh|iffSi}p=`VS|Hyn^**!9Ncoz{QQb^Wxnl8w%5 z_?575BQ8ewRP#m!V+FxQpUpuqmK2rIRpbe4b(sK3d4Zbc!F8&ZI!d>w5$D9&6vq-Q zJEI0Yu_=NM5*#~LJ7eIPfRjJmAd$*ilYcX>D{MPO;mz31OM}ra0xjOto&HRli@ja_ zZ8gs><9rE0n#O($PmwO=$jue9F0y@Bq3NaeSR_R@{?{Q7)W`O;Cth^ZRd+0@lNAm+c z^cVa2!DwM4$*}bFJGAed$E3vJmG_&KK=%B5x;lDE9Lq9kmN?cqu?Z;1m!_-M9 zgW(ir4@(d1vT*?J*0$ktJi!=A>v!`S?C7sO#;~~|aL~jdH1{{u8oXGpu}@uiK7G4z z!b7I$STKfHyf?LZgLkD)np_MY>2QLc3Wmn7aOwAkD?YK8xW3%bb^Arl)|VwO3?Dlo zaHRJn<`#-Wh_QNR zjIaJ0JLl|>3Jts?pr*U%q`y0ZoD|ZX?|Gh3;r-Ivxg@D7D`koEqozX8~if(D)Zc}^;FKE zy4B|u383zrzvG?nHGt;T{gHzNh4e`bss9sj5&{Ju)OThG78Doi6tCNMdySl{IWM_| z8L#f|e(KlSEIqg)_%R#$A;cO~4=;a@Lf;bF^9mn{;|eST`|k;UXT7EKsxt5v$rX8Z ze|SQ(_Y0kVKje*syQ|*!;Lh`{sd6WJQzJweezW?|+sjOp%Lsu-zD?h2~_p=9DC~$fVC~U_) za<_*>g?aKraQ;^B07`!F&YleH2M*&>=j3D)_C0k1e{1StTcDu2qWt5yuDFd3Z46x^ zEBSBE-E0}nKGy7yD4$6sjsrx|X^xLT@A5}U{%`L;D#xZ7)paQYkVfU@Ug`}%bpGS+l@5sPu$2Ns%zrZ-RKY7kLc z3A8dNC*Ypl>F`>Ys5HQbr`RmiNMmd%o+VEhR!%%O z*E&5HT=fGQ8%l9pJ^>?a>+ZLL6_qqgmJ^eb%EE<0cs}vF>P_DqHEsL#D~qEB2x)>O zu1}(?E}lc`Vw%;j=?qw7NyGp@eSh{H_j1(Ok)NVQPkg`f({+>^{Gd3V*#_U47NL!i zvdW2QgC(Kz*JIX_-Z~2GXb>4c40N*ab<37WR-1KHx-v4`Kn7<={&%B38WXT-rD3%} zOUe4BL7s!fKZiX66Hqa3FRT4^IpG3u=@0*oC0VsrPOi_-qsdR4GHrYUTA&vXl6q@U zNd$5+cNt_XZIJw1&Aml5%-cC!X-bG2 zLN=s_;FU<_usb{_F8;}67@jIBv@0Ta{g$}OfaAfQQk4G`;lnQ_vg z-ROL%Rj(|$m7FL+z+Y9GTs{Hac8Sh}llO#pG>6|!e~>Lkb;z6qa_IS^uhk7>o;ZnK zXrM(*t1D`f?MM(P&1fh78b*@TvC=ta{a2;9U0)Pe!xE(A0nR9Tm%gJ?-qrt2C)ZIo zc;=mk6S?W+=q^9J`f<`NLF~?uBp{3fFZ}?8&r$Q_k*E4*=J}%=#TQNiCXy#=qi~|T zF*K_C*_BNy%4Lt>k5-;Z)9^I@fiLppc&9HDD+NxHd2&-Jb)T#`=_62k!0}?ASC$|u zw<&prSEh*TDaDQ+OAdQmF}%)%YuP)>JlO!pSBX(Sqo}j}1~w9hl%Q)t=C5-C+euyW zU|s=2@JbD=bF7ieTMh7(XVIOzbRE3@{=K$VmHlKvCQQ#bZWd5l7C5BRo=o#5oF6Q9I%|(Lxc1#rmWC-E4i`}a#Fi=McpdVTW%rZ zN4Zx28#h~4mZ!H$Iy$s_@#w@*-e7I}=e?1!PHq5zWELf6m{Ydc-N^hW-w(4V^buB>o|7fEvj`G zvyLAes8=vOz}7#FyqQh>G2hEnIBHpGOSIFFk_FvbpwXYcYQ?emQT)X?AmfGW%x2v&mIX%Xu|O(VadA=Q(Qi6ZGC<<*l zjNa^N4BU=%=~t382iYy1es!>W!kSE3cLt}IQ%+nA3r9j@>L)p-HbsIdC~Dc;z~}*s z$?|n<7a|$HEhj}I3UZ-Q?R&+<8bB*5?p6ThMNMVWc@O@#3gT0)wRdyzlk@j8E5UgM z0MWn`YJXRn^_9USeY{l)FXfBxl0tTtVw= zsN2cOZgdCo*Fmd$^Rzr-@x!*?ujAHjHLkmnxcO~NG>E%X%OE%5YMx{ica1y_OO0ab z>;JH0B(%$-l}OLZGd-e2t#3s?t#2OD;L}EI3b2d~?b^7g^_tuPp$2Sbn0MBu6bPd! zL`d8e>(*iBfOfCMolLZ!fSF`ZLEKlJk&zfsB6y#e@D)ypCEZFc^QM*~i` zM|`dp?HBl1jp*bu_D{f#Y5YBIG|EpmMxeoTQPoD`O{8|pGf!!6WVdgKu774~vMv%1 zywYkZJ_)jaM8tAh78SoAex(LpNOk0U7o$~(<^ znq!D1`F$W7t=+&%XEEME4ispvOY3Xim-C*?;3MRm{ze(mGr`}E(< zq%y5<6}aaKsJKRI$%I%rX5%jm(3>8&;#choBmSbpr-JqvL&B&WeD6+45}+CFPzlp5 zx0ytP8)oMQO&xd=F_Zii1aSVE>yP4*wAw!NB8G~wdOMO_?NqznoaiqPHLAvXEWPu* zsqI#CiE?+bEgtX_I@VSiv!BR~O4uqL6q}5HHFrW_tAk{gG4^eh|3jrzEL`EuXS|})2uIjldG(Uf}~vP(dsUT+8SE)wysa0 zJ9TiquS|27zdd1( z(cp_i;9bGrSEB2upPun*WS;eKGFoDiwczYAuwp{PfO%k3jA?95i4 zE=ISbpQ(uaUKD|xk_fIAxj8O{(JhTal(qk&f~JBCxv0lBzUJ9g~W;t z;drllc)be0oO!{J}r-TszT z03zBFkqo#IV|}@l1t+<6MZ@*f)zJ<_8x8*%ShF}-VY#Di$l+$(Q29`Idk(?foXqt7 zSPxk#9W~Y~8qRQ>!{4*BSE6W?At3mQr;c^%9w2whvl6SK*O))A_eIT!Jf59kNO2a3 zwU?3^`>YbQA)tW>i?klda;y{g1dgzHj7^jHneESLb2yE^y)NE9Tu$uv8e>Z(j$)psa9Tlk7 zb#z>8qdPEOH*WQPsVBkAd>3P{X{v25cF|;{G1!#nAehw9_n4zUWgLddN^fNtfH*Hy z+dka0Gnvz>CcD>^Bs$Nkw1A(HYUk=R>M56f`MGIdvyv2^uvS-LtRd4f*HY$+)KuYe zUewfGLg`?On(b>ce@Yui?e_=Nc}V#{=%WkeDq%Ua6qlCPvLVby5{O!L&*;ssFJPt_ zJZiR1SI*3P&f}hbqch+m{0WektPeVw>@5_6`bRO?-|X+*p5g|PH}*))J4bC^3URVc zwf#*;)AZ9{pOWEXf=Nnt6Daifsckz~s;2$o{AgJCwV3*ZczrzUG@sIA-jQ4-n5M4U z9N9$m@1Saud??v!qD!6s;E7pzh4y+krmNAME>`&}W1G3TTMRtNR_5M{&@@>V=2p-< z@+Urcj@Dq@&(-yf{&_)Ca?lrB&yi(7jJpIY(wp(glinAm!xMZ(9is(5KgUeMPe9ct zAi=Vp*+0eQDo6M|+?|@~(rgww<~@!YiA3!;w7CJD~qa*W0PL^I0L))stc%#5-MYn%Qd zAJB{Yk|s+n3GrRe5MIZEtU)-6ZmZ}67n{3<`blPdC2{I&afP?j{FJTMlOe^9WS)=k z^^q`QwOgHu>hSV946#OIhFfcN4+uxsdzp2R&b#8~;&)>azcWG?5ip(d_^T}I`&0Tk zQYdJ4!FWxKxw!9b$smSj!3Ew@Wrg!y;~y=WK!UFFF4r#Mv>xdC5b%sO57)afL{F-b z5$<&i^l7Y$v=)uEQy$7BzK!Es{0b_Zlidmpsf;#|bSqLYCeN7y8fcE(l^tT9lE^1Q z^XB>5s-BgFG8IyAJD;9YcX}&ci2gasWYBKYH#bySGt?|T`Flcr?b`DR$R{~U;cs&a zD5H@1z_s;iD66)%wb40l(o|Rdi54Co!<({eaG346~N5A@toaSb-w!ugkixg~f9_p)4*`8c0VcUu0lV#`5B85F>{f z#(<_$ZOs9(=H7GpgH7c5p!IEty7rVlj|GjkdX<<}l}o`q>W;F9tG*Ri{kv|Q^0w34 zax!YkWT8y^z-l5}L%MaxzwB9tR6`nB+Z*2hO`TX8ilw|1dITF_$?7rQ2wM|*$y zPPZ-^EB?~htVhz*I`SooThKU|5NSO@t!%82`!;M^l0TUy!1Psn!A7u>eX)WB*Wuh6 ze>A#ZI65ZB-(QjN#OxrhiB1m8)2wK2lu_OF7B`_e&=J*?rECd<1!0(A?NRh0zLnb2 z1ZFr%E03$^##QP%%SK2)sepAK-6D>T-5Rw^pF6IWKInJ5ZbV~2msU0qX=FQ{r#o}S z+5~!N3X~TE)Lo&`i?z!;g9F;iOK7}76)OqB(q-`miBCaJ5u6O{;c2>%@p~!>CA|Qi zt7Nh&H|^!=fXU&2PKk^>?u^)__I85nh1i6a(70i9<$DQ{7PLha{-mao;gzu1mBH%9 zNQ*s#>)Q7f+%%!pcyHWgtn+s7cq#mOZCmRpFo*{C$c+ShML(3fYL{I(*6!N6ZJhpe z6oRd`D|N4?QKh~+_e&Sp4!=Z*6Cn^kJ)ICq19A4+JNv%H+eb&P6w|i=&GGIUNs$Ft zG31f-A!C+W@)1b!8tF|8H$kwWlMT#{pRFSUNX&2j+U3lVb^6j(oMgR(xBh6~*Hv_{ zs--a~aCSjbIt9I;Q(M&yr$~{Qg;S}t(HK_03+7%aPWhLn!hoz7#566a_tbqZKR|VY zk%qySw(74Q%d%@jUHwYoy=VBo_Ff-8A-0SXk8B2s{2KSmpz5MsQiS_?uYnZ)y9{M@ zLo}k^xeR1(Zupc}L$=3iXai7PvZJdTq>};U)CAv*c06zE-f&C zP#a*E6R|bTQ=eW@jmS}V{ILcKkgE^7^_M6v)CT6v zR$n?`QkXewJ(NRL3IqC$?d3`{$d%G)LBjHWlkScZ+LoAQWb~2R5k9AOWJ2Iy#o_*S z1N=%Br;C{~YmVQc!Y6^6DR=ah6XY`_0qrmh?F&+B+I{IBI-RH)>FNC0iP(1Yr${dI|Dd+afk?LgUYJ5w7 zS1)i-KWh{+uY9;&8f(RBIShDt{Rxb|3_lJZ6O>g}fC7%Sv~E&W28)T;D<)LS5{R|7 z6cJswjHgWZ)F-)SdHmgl+V>G2DELh<5GA`)%e8*9M#@fmm#UG1XqeCs-Z<^6)*pg}#(RTbx^+_q?h1<~Dw;^+Gwm8F$fbi(cM9x-#FC zvPoOPUnFodjYe+bl`JJmrXb{WT!Jxz-}Oa@HYC`!uV^YF>}^ zAyazW%6ODasr}kkUF8R0vr_?IJ)tI$s7tEWC~=-XTUoD>sG_w&kON7W?~!W{pmQ2a z%x4Y$4P*?vZ%k5RQ^aR9;9E9Z7iZT2Od7bu2k!{UTDq1K+4rH|M_RP%_Sh20wM{oB zHl3BKG(K947jc(fGbD)$XcdN{Fgm@e`6;3;{H>36CLV)tP0377U=3&W>FqkGR!$hO z8q~e=x6@_lqQeir@>8{ecx-)Cebd!6NQ+2=x8%90ch<8*fN5MIZcI#8wv;ucpoLYb zZF-{L-)~AuAyZ1BZYJonm}?x@M5)V|G7E#fc`ef)&k8og;skQhqo_F6m&@;S=CuXhqP4u5U*j4is?8N zN#U7&0c|xj!!vqXtsHVFYja&&xY6&$d`X#TRjO%T)=4{L&UISIh2euWbc<+5`$+Dj zk|W}itR*uD)H3{?aG6&*_EpxICG)Jg)~qNmR%@OSIS^Db)7#L=K`+U?_TVKOvuzf5b8judcw53RX%^Pp4d1};;I{?c}a?!VAx;pY2{zb!<{F!`I ziHxFy(9zBMuKH8)uTMTdspmz9!km%YkUf`cWXU&4jS&NhAx)M|*0~6A`z5vOic>PH z&d71DL9Yo%281WF&x|~QI9+U$s@|M$PzSiU;;_ms4INfL9+r)6;Ui4m)Qs5upiL3` zn-Hma#^X+T18`zY8!#P-ox-7oVtl!|dBtd{Q(iv-HgcZ;>ra5!CqTbf?qfMic3$FD>GlMwt5AkfeuNy%6- zzC*DnW0JEOL&J!O{tv7EPkbN@A)8uV7%9u7IRhMsJqBfN%^5y6c)ey%e~iB3HhV1$ zBr{3HR59pwF5Y)e3P$IqhzV7h>{k=Q?-b9Twaw*$BEV8aaJ`Y+?y^Y8A;rXU>j`{t_6-n9%}8hC=ERG z&rIBShX_S^Fi712*BR0FShZHJzm02BBGtxdwX)GmYQ^HC&4>YSyknVxy*>l-D^?Vv zE0!avKuG~&4SmqDNhEQyi@yn*h3WZlE(H@+WQb|ndm2A4oj~lo$up9loT0-O1xAxc zlug|bHht<1D+~Sdl*CLz6l)A0Q`%d6vhc5ivtw=C+vzcunG;~NZpdJXoSa<}V(Q2$ zUJQjxlt1}fWUY(Y(LffAi4H@93X44sk5q17x_}1`*U*YN-SW6nh)d8@@VJm@zXL$g?B@9TO`}Zg?8odC5@F@{ZV1VAYq_5Rtu@*MgA!KP<-Hvf{4_-?vnLH9V z+R+bM%L6f4p$NoLqK?ZuSut%i&u9b4Vxp1TL&==SCpZR6<&It&=VA(&n6;%PmQRlR z4_Z57GXoODda^UeN9c(W4ClGICLE^y``>8%#Y`8EJFS&PB{+EGWCnkWEzpRO%qCYf za%p9S`6Thwcj5-;zpm1h0K-hc|Mp++#1yCc^q+%M|9=h+^{*r3|Fkm@kmzV+7_3mF z-^rmdS=f|~|JT1E|MTztbcVW{{+oVb8G7cYV=aRjudzGBzOkc^r-o4GeNTh4S%XaT zv4ND3&ZVnr*=kAZk6rx(;vX7#TLmV{I9tVR1Cp%xW9(Sg7~@A zOuU$s)7KX&X;E*&aOpa_l|3=b{CkYw$2YA)lR5%+n<~V$KnnSqBgJSdIVi>KO&(i6&XgBLqKz55?jn<%T$g}p@B>Hx zt2c3&6{5wg(*|7bUN|o&N66$b30er%UopRn2?Gt-gfJB6TfaTft?>LO376O8=3F2OY%VMmHb z-Q(7}?3aHWUZL<^Q@cPJ6BoBPL(KHd*HPN~X!hs~nmJQ+>NYYakeCi{jGi>}BS9o4 zZL9LWrLO4toR+U;B38Wei(j_1p9E%N5lw+U`3&>Id?}jGo|$P6+`D+$tPqK`i!yc| zgS1(Lo49O>nLiQv4@MFRVkrs4!H*1&GV*5|#ke-6Hpap_x={h!o7~DQT8-f54l1pc zSNL|)r!uCo%HKCPanrkG@hei&b>c2c`5%~X`ea>cxVCkwR`BTLTXPfdiWooO>9C|E zj)OpX`WgQ8+|zr#)L$YQ>iWmX<@FR8*%S@J;o`zAy-j9U+#K;YB6Nt@Xha1nkK4o& zFdP|F6vd@V>W8q|Sfg;le~cWT)#gX=Pz3Pg9tVA39B0^SQ|H_6UabI=EbjTyu67;J zaeOgWzDW@(vab1`&u|EpO+~@M>e2ra)7B zglpH$xJUNZ#-jy=xWs6XdkOf$&k}mn510{$(z*FCD3UD1DF`N~X7_fZUt~$yhsA4k zsCx-ekxR>JNzqA}#njATX$*;1@4zc9ub3G`QZ~@)Fr`(A{Z=MFU4gli2@2850?pJ3 zqGODOySUK-qr;qX!((J;q~&TA3dOHqVyU-FqFg9N*ZTfddoUmLk@Vrc$P$^QmYc*q zu|vXeiGp?wPZ-rUISWt5=gqH-g)nybXbXz1iUC}RLgN=xeQza zzP){YCIi3Y>tkpX1|x8yF(m#j@?qlhG4*SE#DJbOv`vB0$k(@INshIusci2J3fHWn<`nLD-Q+^j9tgyNHTO zd~J`I>dX$-zdpY!HRs=T-#D(t|F`Gui!kITfXQ8#l-ECQ3Rl>wtDQnpWOT*ldI+0! zV(diTZ5}OWwYur|vZRl@mN}W>k6Z|InC=#PvYQrH8HbLL}RhGZ9 z`h8SSrZgEU>p8x{wS_U{9xz4x-Z2d{z_Y}w0@Im#D6tLo&Nc_SC+r4}bRuO6+(tHQO z9~2MdJvj;Ii10BoHQ5E!>aYfE*YdGoy!~uq^1qxDxqRgtNUoEbz^shxY@=0!3pC*y z`bG^*ljDE?VY(iT_P{3-Gby$uduGLOcYe5XvG4G^5OjXiJnkpWVJS4Ax%?3L1b*>G zC~UZ0K0G3vE?g-UyoENinp0P3RQ(_tcMned%eb#hD)J|{AM;fHzX1nQ}yf{)8PCdm ztZ1}3IhVLNe`9n@vI4YC=OAPxRL|}bg&iC%mui=0Ree+WYpW6Kq&FC+ZG}Fyz`@^f zwQ+HSlX%KxD>~G=05uH7*(~Dpkj7=#sklPt^$KYJaisaM7j*gw7_aAJv3fr1=P8~0 z04fPVp3d!-q))X?vp7GaTAn9++CY{ro-YudMu+mok{@}00@Rb6v~A)cA5~l*+-~_M zv~_GBWU@~mkYhmHo8Fm&wEpY{QTW*_ei;-?0WhP1HZ)xJ@>OO2BJGsSu@mm#6hqjT zp@wk{HDP88XMlBkU+K*q3DCc~#{1*U_B2rFIEIu8y}VI+WF}DYtbgt)9=EL&-|8n~ zBOhuITlQt>c2Nmt`TEh$$Ib=iS6(%5pDS5kH~BISZ?TqE8aDu9BJFG5y>MQ_gQnLj zf{DQ7xG!WDL*P>uiRA0h!&5m@ehN0T+Fw0N4rlSxD$LW^T}?;*$~lis>A{=*ZN`CR!$^b0X|J>ol-;hm9pCd+qLu%y zroKVFfUjp1?g#SYBu*<;e4;6pEjEC2I>Oae#Zq5iGKFOKjl zKs&r$F8kV8Yu`XA^@T~M-4R~-9|=iAMX%t)y{fsQ}{Ij3EnJm#P%<2~w6Kehv zqEcOo{SK0te_+{z@z>Z2NThUM$Ty_|G*TtkUI|AHjIFDIl}|@MuRGrYqJPHV zrk+Mt5hWdbud5^>H{b6|*jP7k~pB^;}BC>%l-HrOO2WfNU2;^(KJl?vj=SS^V zm$EAz0UJ5|OZ<7-^9UDY&&#@Oj)26`@;1+9F#3B>N%5qfuHWOA)L=JT?{G)9lc)(t z78Fh{pNtTySNdT6MxH?EX9sXgI+0*qyXlrpis0>^zA@8yjip_wLE9_#&N>zn#G zIub=37?GDhfU4naGj&WAXDweE0}bG|qew~rr2olxaxB<+vo=q=$2SEdwR0U{n>1=C zmpOi`ium!fSp5)L+jk#P=Zq#617-GWq#i8H%mWHPqA9MK2c8c9XlOQRq00u)YDRZA zTf56WOf+!{AkZ#ET{c=e8_9m6|7v8rUm#;AwtG3$1Iw3-;=jbZ8OB{d!1ar0XOWMZ zfBX~Bb(ZkQ!iECAkN@B81}P0X?>-fsfbb<)S$b|83U)ONy9ce z$V;{0r`M;BO!rDNU59S!n?Q-1uhAnm(sjGJ0-(HHSz@}ekWf|Wh`3GLkY@+*{omyzcBt7kdeov1T4BCa` zRcg=$Dn-LDe$C}ro}3ueXU&_3TQ9y8n&J^^sE zwAq}d<()W9+B!JS{z6t09EAm7nA|JgH=3`QRbU5ONrq_p*-G4}7{uD>gCiObWee@7v7Mf6xU z2AAk0Tq*VVmHj^em_TR03se@6x+#@)G|>jf2Vrx;3PSG(n0&?oqf&rog2So9DBXB9 zUM6===G{LfHgkE788{FL{{ZVAzVe2tCh5qg{Y@R*dHN^Saql}z>`2kSg{i%gbRSC}qK%XK06ry7 z+o3y^P28$Izclx`rP&5y>J%wZuDYpef}>?I=2L+rs2JN)qhX>ygvycmAW#F>2n(T7 zG{OK-t!yKM=BL>?5ef-X=PguskbP7&^Ms+62yXuXhhnk=bGJ-f{n1$$crFyIwQf16 z21dxPtD*(5;q31J0NEBlQio|Q??|&Lk9pfCR;>K>-aJm^IR!TF9j8vIh0s4=R0lGF z*qp^SojqJ~j+>IFlqWZrX>xUkg|kuLvYazJbBxNJ(2?d|ffqSLP7{EY0|M@CM=zmG zJKQG)l#9f>q9X%M-e9w4%FWhFBPiy%@y;JCEsXFv?$9E}g>r$w9oA{S7O_F~V%`UT zr2hbP`G95+!UnhkvaHP(!17YneHK)I?LYNLwN{Y8VW4~NDi%ShKuv{_qey0Ur98UDl?<-={{U8;*}uK&iR*xP z5)PgUj}6COSa*!RF9ag0uFg7ZL4W5#NA1Qp&>XqI>$ z2R?WJqjhCuGyGGTs)6Mu$TTd9BE_SgF@~GzoHb`=YjK0%zBcGpK|XS19Nh_OWg0HZ8p8fpib?*tbHX@oHwub3d$`p z%dQ4WA!bGuI(j>Fa{fvgYKtSq!U%Fvf##h3V8S431($v9y64cUxeS0aABjew7N*(t za&ac|oX2xkC?GgySAtxm!$P@nQqTuArwf`M(p#to;azz``Zs1AisX4B5gdJ;vje;m ztUj)y5a};&Lpu@W`7G3cWBDQoxJEF}Mv7Q`Zca5xIgoO`5I0RC_mt{QvvQDsHms5v zNtbs-+MY^m@`KCzrnn|Ensb}=wQcMDkS@MwN~;>WDTL>=!MZQ^-)5>}qdX*n@O5|| zR(ws+r2EwO`gB1M54t~9my(p%H$t+e4V!YkY!NVl(Xyr9ZHn<|g7FwfBZPBCmGev} zOvyP~a}>zEvM=!EnSl)eYI-giy|nwGgV9(dmm2+BE?B$9frTsf)` z0`q=j3WAT;WH~)z$&O_=jK5r6Zw~`%H{yjgJQIsvJ=NP;H-P2ckAKVlt&pt3VeJnK zVN>8O{d)c=rgj@?<$+Vp;O68-k<;JpA=*1pEM(0( zd%Lgv(RZ&s*Jc`ZUC(B2R*m_ro1!&}XZ6C`rh}{?@R?6$wLC_OKNswX*-n^cb;kV{ zeL0xz`6pzk(BNX|HT;yf4N&B}K>MntKXlwHoB;?q3T*Q_!2kyhW>Kk~)QmX>c8W}> zHSq-v00E>fs%eYDhc(RVR#EYsSw@{9{ud+x0DE3`S@>T8{wyB4;tJc1)At=gSzqsq>S-ShK4JXiAcRL3C!I#z!3;Hon-Vh+`&33vakx(?gXH`zUGZGeNvohqhL=c8!wUFVbPy94Hw3&0- zBd5h*4cC;ec+?aly$v~J?y0l1RPQRsh^R)P*%(ycJE`cOu$)7Wy}{Yv$%_)UJ|?`{k+p_G5!sYBD@ghpEW<+ zA>$4Q%2URMENh(J(Md4xtfdNv@Z}LcX^wiSeyPy{fV?(LkEfTr@>aO-aezN z8a4GzO=!?yaBo7NZPu#B%Q@!*hc#D!v@D^p#2o5PcWORSwJ+|2 z8g6we2j-_zujSQWQ*yGVKAoY`oaV!Id!4gFXltdr^+kaik$-e@3QpKcjgj;}rV;Q# z<*|^*oXvNY!DbLi&_<(l z(=aNr(Yz-1uFY{v>uK&eM@>^rt5FUb^4WK+e|1)8p-!sO2;_xND^zTu1tRP^g)Dar zgy+(uO^(10W;z8bcpR922vSgm-Vt@-;4P+d zldHEtNemk(W~wtlK5nU}c`iPu9T9Foquu>eMu~t8Hxo3ZBC0XnA9JV?;orn&9_zx=qf{!&N*ArKyRY)?3-V+>Iv|32zH*&2l=dv zuJ^LBt)U+7gZd)y2tHJ1(6Y2H>}qvZM5*M7vFfaMO%hQqxoMwO8i;^-CW@TS=sCKh z-VZCbPHc(jn&YoEZBS`CuLipy`rt}|gKG^FQ$QP_!K#?DaT{>9V@1#_DcMVO#IO@F zs_~ns8kEs*5)P`|p~eU9ydc8Uho%-J1qDFDH&9R`{#y#CXij#Sos~HCSJQP_#j+Vn z-y15Kqbn{7&$1N4zAqs7o3d&5pQoa7))Q)w47*AoM+3&;F-+*Aa)SphFI5AA*jZ?^IIQhx&CILZ@XE@w zV`Xr&10boxT^3=ws~VdsZ93eQDZq3eHBvzY81-lXs8x{+N3vACGGufpjaq*qo?6`fny1#%<>;H*dpq;?bD`zx zi%62ZED|O?R&Lbr&=F^6fC7|B)m$$V8h#4&o6Tk|Bp?(jGFPN-~Z z_(w+WP;&=@B04Kv9S#{kmLMYAK~Br%CO}aT@$+62ecD!F%-x=)p2?U_b@Cgv3RFNO zp+vrCmWUnD!dEOe#5q-}&ofv^MztrL`#X6|bH-N?GY+`r`0y0ww{nA4vN$6`eBBW) z)xyJ)X(~mBMJC)mQ?qPkF^ura2Urr00RWxNxMso|%|azvYObM2M12!gwS@fI0sAI) zh@DHlVKuyfT6l_{3O${?uj+$aq(glb^}6sEB=$w}>vPGRV-9vs84h>OgCO z%lRzeTXfO*iW9Jv>aKV%qPmnqEGSoRXJ>gc)ACl=9e5=d9h4!2U|#XOj;kiipjY69 zWteK5-@Mc#V4YD;4Mp6PkBad5R@h3_Wl%T?+Yf@xtMc2T9i4_>R_;f$ljj+ex}nMy zl;8&1ldEl=5UT!l5w4o zz_gtWmuRGRb(0zvQG_A_1puAMTZR;?t0-CB&fQa|cPD;$8PmIunuluKC6;p0eIwyC zYZeMJ%rB}7!wt=3GZ`w%0=}!FZ$urqHbpkbIi|_8sv~|M?6g~>d_lYw;B#CCv9}0W zMyNlSS+rhfJJkl?H2koIZSl4Q^-`r}*rUq^f38#C5wS(&%KM>fI2C1^f^-NjLxVTw zx(yfmmwWIi6QZ|7Tkuf`7aOdl0t~fv)B55RVJhWY;){wcJdyDjMaPnEVY&p^DBVoq z$zN4$2ElqQFrwk*-FLwFGC}I3m8vRK$`Lm}a#>ZOTK#$Z2DA&UETm|fP#Y8h@}b}l zBT3mmGpry0zH6eM8AVD13uByIpf^&7#XgV`WJ{A+&%BHC6?JvtD9W+8R|-(z@iZQ* zQLBi-U8(b6sCb?whEt!q*MLkaG@-anV^u8F{GWij9=v3T9z+Q^RF-JQ-XE#aKc&oCnxP zh=QkeZB^D(SmR=vTX<09?7r|tp|V08)TjdZOsvR^E?_G!HWpWE@Y!9(P8Kk{>*+P- zqiv2Fg&Y_D!(WNM2zo2q8;Egwv@w5(16z*;s;zDgr9S zUm3uOSws~aT^B|4aC$4XZnaYZUYgNbRDvX}iqd_ot1IfV%qTx-ozxqSs#_sgqHyrp zYsGE|;2y$!rArOgk-?`8{fyzFy0;Df$rxO#DdCkGaBIbUE~nVYDq614PucWV`$)j! zs=u<=fO|Xt0G5CM!~iG|0RRF50s#a90|5a60RR910RRypF+ovb5OIN#p|Qcy@F3yw zF#p;B2mt{A0Y4$H_=0*X(jdJ`m7hqBA&lk+rpuP7CVyQCSLr|E2p}Lz^mv#F%+zBU zTg~A4m8ZkeCJBOb3o?aRO`_bm#V#?jXVSCi1!^>AkopNdH_{ooSqwgveu6C5WygSu zDpqG0R8K&Gm>!-{m0i>xfJ2E=rAn15QG{Dbc2W^mT_1)avrMn}(ioKHGUdgX9=~JI zlJPpm-jymOuSHy`Nwlb+@@^hvD$Kc;(Ps%zLky>+30|O>4-w3%Q)!z02hmsSOykhX zhoDN8=~CjN)6qC(^DL=hseR%)Yzi*mOgCQybN>K3OM+fdY>ZiR!LRr+U%3=mikLov zRAUr98O&ut>%_T_%o)bvy}=R~{{X_u1JK40^jD=y^nxU?RTM3FCqOV04@!)$LLc+9 z><${~YyK`=Sd=jCUSl@&rp5%z%wB_o93W+SX;8Ek=v=vereB~2 zXJ1HD=`gn+K=d!O5}0!zLcJS7>8K@Mg<`x+JW7V@I5RH4X`Y`xhP@Rl(!b*UE?Q!0 z?Jr<|FVwUhxkC3}^7<|%)GT?0K*ZZqh+T+8Syzlpw#@$k;u?dAuccyZH}o&jWy|#Z zi9n*ND;Oe0NHXHXTNiv0YYWNfdo;_>BtC=w5P!m~M3;okMb%-GrV##BkARCzIz?xt z^{@HAO#!=14$#%Ka_#cV{{WURr2?jKPOKP}n6O1#X_*>Gy$3k|0Fw+x(%{9+H!Ig{ zXEA1VcM6LyFL`lAFVRH{4=)j#juh;z{4lr%g`XGW(^ARgm0pGDGYF$mW5ir~k#Os^ zfrPXQCSHLb_gDe>rQ&Hru8+<@aYZkiVA#)E*DItHD`U~a>%mXV;1Sb}t@?#$_ z;$GLa$J-0<_4bSc;+~u zrS6n6H6Dru6bDeSQt+3DGUbxEA}Nf>wli82e_yF{DPnO|`XYK{ziF17T%qE_cI(o; zOd<<%a6{H0W{~0k0ACT%Tl|3hOPeJCcsTA05B&Be*mcxgOZ9UIdX^)j&(pXB&|}i# z#g_;eda&H2T^v|WMBM6#&0=4yC~wlV<TAQbawe8HjC7_Fk)ct4bn^d;gwpshoeFk=N%4VN2+Ud~0A1QZK1rCk~v`qCD zsl8FcG}oz;qZDGMf@0Nl%`A-CQO=gXWYn!~7ue6x%A+`y15TZCzeLd!)l(?v6}%pjN_$1luBzc%z|=Q4~>#uw1!Fv-D?>wbVkQw3uT z>4@bs#fT`qdTj5t5;Ex?ANYV4gdXMkStW;{s-rBtH2}ls&}fA)1Z<8J?c!awF*7ps zZ*vboqpw>?#t|~f=={EpWn=CikxC${15tTnW?Wps*;)SH>J47a&OcDb7KUEQS&&G_QQRp#3WG4S!-VdL{Rv@m;V5gq?K*;J7Uk- z#Zg_wn?qsmD!mBDl3bL>1U2Y7P}CHZL7Y<3uE&u$|lL1 z(5yxtDVRygDvRC|Q9FXdWbl=JA8 zc`!0JEtQGc2`zq6Vj?_TLJi`g)3I!HH`Cm|12N?LqS~f;cQW&+{_ey-x*~(~ zEVaVJV=(QwmBH<=f@OX7Qwstcg1*6i9)MfGP%8Yzuq)aj)Tg@j71!o5NL#HhM=ZP` zlxpHwN+eT)J^GX?=TN$e;t*05gn+K)sv$jqqxjc%T!=F zc0`W4F$=JZC758QQXxWsFds!0dR}R#BmV$iej+uwa~h5riWtTPLJEqU$u|_-O zN>_q=I#85|^CzHysZ?(mkQ&n(r*i=ON6z>38}pNpWz2gnzSBDpW++L&WOu;-01wmv zn!I~)9pWQb1O_vJ^9GJgox~P^28hVm%mgJ=Q_eo>9Mn)l=31`hv2ofVS_EEABzjO; zxNcj_&6LdXSNzXAIjLf7a}akRd#)op6)=?!y$qs2mLjS#=p_d`BbDhm`Vni}eE{xC z3G*XS;r^03z-`X@_%Q@QyUCW*K>!f0IQj_|Subz76#`b>M*}5SYbAOmkv-8*B9um`nG!Ts4993@YizBV;c%GDT;Q3g>QrM0=01{h?E+YM zlrv>-1I$E&P!%)8cuJ3}-*K&=$r?8pfubxg$Dv6ZCL?p5EvuypVXmXH8$Ocqg9X)=+xFiP?)N+gB(<-!1A;zD z=r+7DVYH1xJ5L5jytGcpm5N5MfnJVZP=Q*jg`mrRJ^ zF?9~ArxPtwRv&W)0J}p2+)2b-78mzG9GQuYXv#1wg0ajcqcb~1tNd9`I2sG)IHCRb zQQgN%((*1|&>2f|v6}NJX=cmj8do`*q}>xFc8+Dz^)7;E2JR#e5iyU733i&O3b{Fz zO2eo&)8cgzv2BoUQ8-H_FSMs5wpq9*RY5n$qG4m|FBQw?ZdV@?xSY($T?f!Yw5Cqh z;P*O@;dYc}uMq>#18l&kil};)H_S_hY{cQ2mW|7Sp~TS7m2FHSgFL+sSZRjLygVkS;$2Q6uY?CO)lk*PQoL>;EA5T!Btt*< zaoEAY_L+u44QdUruBU{!7QP4mW8zkJ3+uKLt4^j-rA*AiuC-ZoM0DOr#h_-lD=P^p ze3Kxk%$x|1C9rUO%QfO79e3_%lg#2{0Qtwoj5bAdxNLj#g&bEx1L_={;AV{?#O zKyRYeVo{A}`jk&={{XW0@SzzBbCRJWF)RwWFqk?g&;J0~S3R7rGOKIM*=k&x ztA5z@Z`x6BiEvQUHCU+x@ekZH$bf_%ASxn)@hkvE?l=P08pNyaw!MGI@$63FC z=2dInFp+~Ng3;w>2(tDVF)7Qbm2&v9taAYDcM{dWXpi4kVGCPTj+B}+H1g)9@Oz){ zski2z%)Xf%{{TPCz{ynpB}?&$6Cy*fr$6t^NnCJyz&eJl?gKB4;!vN7a^fvqQOK6| z{IIX@4-0X|_n2@#Vfg77bQEn_{e(QBf}DCC3lqM{p1jl#z?Jz;z-`Q+c%DS&D`Ex6 za8=fzjHF@JLYtDtCR`}p%f!uhRj<{`0-T;az-4a^%e55^P-pV}M6=6(eSRuZ!HyjZ z9>Mv59$=XU$^+hEvZw>Sd!0%HGu~gkW`=QlLl(s1DT;feLWz)>&p zB^THjdX5}pDaOP7g z#vSV){DQi@T)Ru*sou}LD6^}5AbFasuy-67r)&=@$HSu;_@y30H1*>NLUT}d6|{g5xWq+UCJwnJB|s2`U~zRpqciRpTaG-E?6k-JW^vk z8X>J#ClSoVT$MQl9~TTbL{xF8*E;j65A2uBJj=^fN6cKIowM-x)Ec|I(KAxT!iVZI z@kqDKR+5K#`4uk1jEw?7eG8=Dq$ z-;E6Ji{i;ibVUo5_kN}&4e_bwnfEdzn1X1m!0&j0DY7T?2&Ah)XU|XoRrIGXQzWXF zO=*JL4=9a!*oX^^!UVft3oyE}iMLh* zioaxPg|lv4O$TYmPm|2T4m{vxLf(JXhypDSzsexy_SmO@luJQ6sh(x z7+=pHFov$Tm8&|SK4n}39x-9g*1lyiHiaJYr9)OrS7QLFE7Nw-<%z1ImFJkFwi;K7 zkM~|?F^ZUZfr#u?G$Q{1gHS^JnU#1+m3DCDtNtZHV+L||{{H|GT>@L%e~Dqh1B5a4 zEI6#MD+30~KBGyAVS|_{bP+NMypDgEYdFLT{L4fG%Te(d$wob{Z9YCz_=j2FEc%Ey zC|JL|{7@?063U4H`+G6 z3&3{{7Mu2FS3qy#nm^pd>vPBK`F7Q5Ve-eT@^yps%u$!Yz5XDy z(Z%2>pC-2lb1XsQp$~C*2)L@?YpIOj+)<_uD(HVWrg0ENMD?s5SW!pt5RJT`1TalP zr_Jl$7*s|+Ww$GCQv(E`*yaww&Y_1j7|@!k(ijXI9JD00f@aX{mL}*2e_eTW_h-Uk@RP&Q(ZrMgYwGH zqz{4>h*&-XG3l2#58MqUf^zV<4pL~oUTpsWUG+6~XMtrM(CWnSd!>;x7ds0vgq?9e zoL`Mwm8ny7v}^7p7V9P-!WSR9~IG` z<1=$N$Zm03SGo#!5-6j9MXbqKi?em^{-rrC<^DQ^8i*VHP4dH;W2l^QC@-6QF$Mns zD~|sF5j?f#P}YziX{3qfVMC(atK1S$9?^swmmtWFp~NX=2v?F00NDcE>sCasZSu3qs>>R*WMnHn)3 zzL;X$S7@7BTYSVFEMWcvaNP(Snf7%BQEN#plT3JF;60I*9Pa>}8NAoC6}fZ^t6I=TJdEC>Zxj$+X{5uGyJTHC}@+hPg4&%CO<(jCGf z-}#vmf1F9Ss*rs5GKIsg=NA(F)@cUaNAyP_;5GSpn6a)6j3UQqO@kL1P-}`hhM~3i zk9U{tfw^@JX=7lByM&KXli2e!5asXBp{_R0il{yd)W58hWpoPEerY%pzc5lb$HgK;@4%s(_^3afywE;u1s@10*Y ztA!zTpi3Hq9*ev!15jkqD;(}(S<*9S(2H3@zJ)1cjw)!5Dm-m?f>yB|j~$RUI5Xlp zMF>kAVjZ+8z<6ST3$B`ih(mqwUzowIC9Y16pbh^3po@u4UjG2`Fi!H7s9-aojGDYvx>*F><!=)e!oWl~n0Sdy^zL;IGqUbjY ztdCoPcMGxkd&lnZ-*9C&T+Eww118SaBX1i`3u^ zq-RiSIar$XK^Z=<*H2Rd{kJdpVi`T_5wwGDNEpW=&$_)sE5{Hcr2&GwnzLjC&0a#w zjVl}Pk}ET1jngizq8Ip`7FxQU#f6cLV~jMZ%*o>_^8WzXr^(xMIE(HbI}Xvwi1#ic z%*`86)lMh6nWV)l`;6~5aQec-#G%wu!=0~L`I*f5IDP*B z)W^-4sG3=So0)-p4>F@|?exs9O1QQRML}nn&!-NM9<;}3D~H5X<*GyINaT zA^EomRhmDz$YmJDSaWRK{7fO98;aIg_2TgS#U>;DJDF{|F*~0u#m#Ae#<`U!%?nFv zmuzUdFy=mrD|%(9+gOd>XY7kvjGm@)S)VX0aKRp43{jbN*Z%xU@Kn~AT;KjqnLVJF zzZVY9zU3)H70lBvXmZqYKsI|@{X>wBp^n!=9wqYe!iH}4=47@V+1|ezi|DMN1{1 zQCnRT0jdUuDE|QGl*UV4G*qw(FjoA|6r92B1Vaub?u}eqSwgi>>JfbiZLXA;!pzy z`5w`7l|iNV7>mhZ=vOqw+-L2O;?kwq%R#ihJj*rSv-phO6BcthS7uU@z|_EY1Bp~q z7}@tPceP1I?={p&!Q^Z64@oY~SO>JMR1F<_-ePE=IWrGAj#)zjRsR5UV3)J~nMp)b zqEw-3svqVe@PRZ~!ka>oZJOR-G)mql`^0b|y1(POb@;r@ZUjo6V|@sP&Qesb3jx*6 z@TrPoRM5&D@p0M?$(l#RI$F5*;u%GyzcX@>(uSLh+jj5X3C5oN2y_W{^7hMJmoSS; z$Z|P@lW%)3@Bs;}N_@;Pyt8#J-5&QV0Q9pjxUNRraSetAWt9sZhBzQxhOLD*>O2yq z(c%hY(tcAh_hOf|nY>jWI+;i9jKQGS^)n_ayq}tiw-%OYg)6Ee%k-`DHDwGN9Acz$RO+yCX#nZB_bZi~`UB^^9AC z76koF?xS-}a9aNWckc@Jg=6(_a2#0K1zqJO&z{aR@wrYLg1S>d3_^~jfQ4C>8SXlp z1UXK;pxg(UZfu~!flo-%@=eMZc=H9VR)~r8nXiNGxGEu2EJTqPi$;bNw0ICY@g64n zWYA|3CdM2!wO+&=mD$9)q2f@)s*auch^JStX;r8+xu$lZtCWPR;#j`hn?tP5&NRXH z5nQGgFa_MLEs0>NkiMaA!k<%O!1_iIu(P)V`D3xMc*w;12+NEUF?G01;>me9matcI zTLQZiehP z>RGn88?ADSfo9UXuBHgF-zS1K`-1Ydc8 z#1G6}{{VQMjyF?xsaIAQ3{2KFs9)k24Fyq8^$IIii&gwh>g9RgK9(mhZeaBhxV*}j zMk1NrLn^C=w@QHRR3*!X8Zxy$p26w~Nu!@`2skO0Ru^+4T9k7ed5j3H{^5lRA&Imw z3^Yw}wYfdIg;%2G^Zx*Z9Tmt*%#9@&%bt-fYmX@B z!klI^hSfthqe@vuuzTOsDdXs9^DV|J-W&v+4m?Z{zVkYv?wr>??|3XMrci(Y&c`?J zDGmULi|3ICQ2m*P)YquLsYI}G6()V)MN19JK!;`#9uSoH80&O#JY3MRN?@?cd!;RN zsF25BMm@Ec+z&I)LLrgCd-|DyUy0Xi?l7o4)SxXe*HdG+-!lg3s+m0+>EDT{Ua#Yi z)W}TWk6pj%6OaxJ*E?-%*Z`ZXJ6)4 zPi;Qyp2}5JxAQM}I~H&meePc03+S(n^EA4Qm$}(B%q<$+q@=ZF#x}7_ZBUKW1&$pa zSg9?X`UD}4c$n?giu}qILn@~mY_B_sUCFa?Kh*PqL#Q#C85f$P@{qh5J~1?v9(kW7 z{Y+Gt0Dw?$ttA-CuRZ0?o zZCYX(Cuj2=sPf0&2I?LJIw#-HnEukKxmA&KGmv5Lj*yYq4Fvk&6S@wX^Ou_L}L0GHH#)PWn70sBP?Va~$%*vK) znWiR0y-S0{yliLl88gc&Nocx@lfB2e(dOYW+*QDM<>m=Ra7zP{am4J07xTYP1TCNa zjHj`b$SbUXY0#sGBOH3{;hsaF|nE66K|c;sYSr)p?d%e7yev zNl2_E&|ItU#JqQ3QP+_esP8XxiIvtb3R}T291z*T_j2Bcnw#T&ye29G$HczRgA<07 zr%c~+^B3kdvkVFf`--M-GObfaVtEz=mE{~meM?q0p${uJsc_BIC%eQ-O|nG2hZy$H zc(2+336`f!K_-C}d$u7QTN-1zRm8b*bzeFCRIOM_Hbxn1c zxLk&+=2s+Qw%Qy_QFWMgna@DfgkK&e*vu@`2^x6d++K@EFS zmWnD3`z{v{KIP;-a-D~X90j5Iw=ndSK{#)S+QAm4nw7c(ea8e{!H8zDY~2W^s{!>8 zlJcEg62XiU9*r;a9nrO3(ui>VdQ27pn7I?Pl2JwwCQQ(1hRaIc2;~0JFJ&94brZJ~{z^xz29bsVzfF2pRkIY<{rU^k$4yU(`CEoVRL9^l) z`yaRjEIE|puvdJ_Az3U-+kC*Sxl8U<)!=YKM}vD zPQ3B$3fb1bGR5j$p|RyWyZwjUX}Oo7FsGal$+IiWy+!!z-Z_QMvqZ*GqEz8zq4Hcx zoHF*nTIvQ5h>Wq&rZc`F{{WG0z@u`p1cfC*5Pf?}jzy_`V!fa|>Q#Z%N&0%CUGQwA8Z%>%*;U+ffVxk@d z@qs#?W+2&!raEG?MZ_Bc&X&My4{7X>UTRPm2eCHYvc&hDEuO%0Jc6cDR`*%eP6kW* z9>@BbR>?^QaQ(_9a4J_|6Atkx@m)%YHb5wtW<=D3gYH%HgsFl#LWmC#VO+3}Iko0E z0J62rSExZTF=ZUY!A-~U9ec=uqn4tvwNxYp3lv4c`IWW5b4o|FOnYZC`DOr=)KHcV zC+;qhN5GhXW0`8zu`h3X65HpS;`fy2L+Vvcg@bdjs?^h>SM@KU4L&9AR~GXIz~e6{xk28oleGDAU(af@t9nP+a(aJNeGQp=}8P@@wFI-0Ht zP2&t|YP0(>TTKMgRB8yFIh9t#br#}LZN1E5+(Uhi5YINf&qRy438(UjT>c@$1n~4a zLLWskuQ26s*AXokCQT58s4Rqy@h*d>8kjIFa?A!P1|nZ*G(Vv5uLB$B2!bMtL~RIBz?HG@ zA{i~i6cy2z^_Rz~UhCwC{{W-}9Iluq>7Tj^mZ=<_N`PO9g)O;C6sUgUM^2?!d(>2Y zk}oWiuA+GKP*A^mS_kCnY^ZIO4(!^&!BDePG;Q8a)T_olE}1_S|>0p zv55(qSCtNQPFxjc2nF~owcMTkX0nhC@CZk^J?-3oPUNXe2nzoIXhCRmD`+x@#|uJk z1(_~lA<{g(uuBZg?qY0d;he`K6CsuWokvcfhfXRMR$}=OuOjI~mS%C|@WtSXL&$>Y zC2DzN%M45(5Vm5KQu`uN3|hi0tB3~F3`)byR34Iqb(mbHED&ZfU=srTo9RX*^L3yqy-74&vTA<0&K^To@Z1*Kv zk1FPK9X3?GkCCVX8BfTDHFkM`Fq*_pj7KGrTbNWZ{5?KNbmEF~X)kC@^kJb26lP8{ z7WW)4M82kEQ=({?+d4|+uKg~FL}o-7)KT;;p&x-Fjal~*av-}*mhPb48jh%C82*5( z3m6n8#2{ta38}Uq4dB{y34}J{Cn(FTnBIAdm;jZ{k1~j5GJ|ErT(f7?diUcDL{j&R z7bD1KAAky|04^nV7z6~BM7;%9n_bkco#5{7ZpAgYTX87G-QC>+1P>O9TajYLp=fZo z0Hs9=#R8=*4#isFIlS)~-}&+rGVWyVeXn(0^IBqps#`KvYu~J}{mqvVzpXFY&#+(b z5L)#`&GuXB$qR?T*+P2`9J9FnpLsooVHJ`cddl_Vs&#fhL(4LpQpaZBY<1E8Kr*iAh0uNnFrhYl#j~2`v!sZj!lwU%!cdUEw}^M>f{7 zjG1ti5N5F%S0io~Tm_lf93>Cd2X=a4(`kE$f4@^=2p<;qkqYgGQsxh#@OvB3og$yI-T8eeqOZWv!> znWPV7hwWgnpYkQi->rG(N`&8x61h?c`mj1u6LI`~q3@ME{b$dVuwzRBe62iy>gvSe zh4-(;h@-QATN+C(r)~cwLYemQF9!>GIN54z6yNDN0BNO`jzz$)(xiGxtWd6`O#*2C zE`A^i`dD33Nz35+hs{EG-9uWM>|CAW@Z!Pwr#fauEV?Q3Dr3?fNDlLr=yf4IGypeG zn|i;W@=mJuw>QZdS3jT&UrC*4pYx$<~8=Hpa$6D_O=Bz%Z(SNZf0|&t+(lu+)*#1wfpVWgzL}

>By?{7cHlq;C(2EP5S z9EJ8J91?1&${G5(X<@uJ|A%>gZsxSgo)~dUotV?vX##bkx1DJ#iB*TgU9 z+?&5h9||HcMIhIS!5edV^CdJbRVb#g{ptA1fc0$<3J>RB#d_vzZ+Qk7%km38!btq$ zQ2c+N|FMPsUwnkfz|Jpr`Tt2miHs@e`yBplAPncN@Q+@gd8I5T?U_RceMB?x;{cKCutk8^UQ?2iPBDTh=K}k zjpOs#pUul-aCfH06`yB?oldS6{M8Qfwb>lm*jgj`JgLm+ZUYYTl&w0lG|C^gUF8WOHH&Rv0p}c zk~ZvCCeebR{fKRQST=*`DvCL7UD}V|LbO13?jr&BzE0T{!%3_93C-M0z@VL z+ddrehF!Bm&4Q_8ART$_SD0OK-z2Qc3q!GXV0OIPod^7m9O_Uj$g^c^A*ZANq-8n+ z@xHJ|7<(#vm0**>e7*<$vkk1=@o)rRKZH|m$Jvvv_aHISB4d_c%TnX&^Ffb_V6?JJ zW*#+~^a1eQjGVGCLw?^dAiJM+eWjf$_{7)omz%}~l&HGlo7dT@UFe3D(8|n}^-K~o zP4@~`@aF~oZ@+v^2cQ<4R-b)K6Q{IXkY8BD!X3}^w7%hX_AmK;@y9a8s*>l3!bqmA6^)nSFaPr!ayUzxZfSC)$ycGH2EsUc<45h2zq*-N(PT@A z8f~pchlNk$|B0cf1fhzMvS$dgX1BN`PD>Tgra$t+@Pcpfey|BN725Zx0kLv6h_R&B zNwdRn|IY2U+SGp$ci{zO*8iFo8dbLY4TOEPpjT3wvCO_Q9&g6AELx8X*L1nkMA@W^ z+k78?%+fvg1)O~>IPPewME8$?K8e2df&TWG{xNjwc4K1tyq#W7LHIF;MXFO;KsAv! z)*pBhQk{Lf{4gD4p-y-S6eU zT>kc@R*FE)PTXn^LNvOV_BSWrxkwyu?jAO{K{GOOw%(>7998f=!GDBv;{B@HvmgXE zwMkNl>z4l-(H$4X_WhP-=P;I4==N3*7&V8NLv_cRZ3knAGv{YJW9oNXKyu^7@e&m} z#6od{vgKxQT_iF6B@g$F9F(yYyKe{+cJqIW1<{{Y_oz(sf3_63VPnBCE5opoEtO~_ zaT=R(ffhu#KVb4_Np{q%nrgGA=VKdn`K-(2Q;SbQOkm_2bXOD8=zp?d0qeZXfpckW zAHbj1N2sH%mb@_8r{!C_tojQ&Z&)WwdnPg21<8$;ARO zFRe&SFoG?T@n_!dHco+;B;feJN$>&_{trv||B`^{g(SRqAqkh6+D7&+|2Gi+$Er&d zh!Ks!u*v_3T7CH2>{YbdKUoK-tgC6>)6)1n>k&4bN#?xk-7$#J<%W+_8=lBR+$O98 z$~(j=mmRfv(MJ)CCD9&Cpoy^oQ$!=tf=FpP24e+e&G8CvhC^}22p`2G!7~2=zz6s0 zSt77tnQ}YvIV!L0E>jXLm`!3g-uHuj(alXIzz@s8(-fa?)?+@ydXSX$J(==(nX>5{ zB3^1HiUWC%d=)V4saZ}D2AH(;bQ&_+3~<7m;vnQpvMe|}zG&Yhn!|TvI2_BmJt2yI z?~pV(zR58n&D%?~ulOi}s|Br?S;;1`KzBTg;0{?Zb}+wCiv>JofFOcp`z(xxB^u*RjSn z?&3pTtCK8x`~NqB3VBv zjo7TY zvHKKL$B~D_ILT;&*YE$modr>zT=P*){nY^x-n!b^Ox*^PE>YK_cANNut}JAFC0o|>^N8ZU zaG!=#8!#B{%uCL{&=^{%o+7DFH;|%oTd?4xQ;KY_9kFl z$uDqtAd~RuAsIhAC+lS()QV)a+@eOdz3m#FIqBHc*?4dBedd^jR`O|AI6QGPHEA#M zD&}{;#x7Vo&(&#o*cr@0fMBi8xhqha);k-!RJ^;P?{Yvrjydi8?MO74HL@u+9qLTS zYr@Nbkl5{XDR%#NLBP(L;xasV#Cl%zSoJG*a7En{BFVKy}wZ$ z_0E>h7>P=YZJqyW0G>t|-@V{P9YXT&@H7_+Tu%GF@@+ZUhnW5-8`~YFg8>8M&Y3$; zmgz^>dKx@$==kO5-@S4izi_Ct9lwDw$V==YHjd-VBKaT09epZ+qro%GHZKz|B$9sB zu{D+M@!PgKa{^4l9{q7dnlszZvvpS2GLu8cWy+aaY;BX}iP{(CXR)K*jop~Y4rAtx zz(5X{wTm5|)Rg*vzq&RTIqiD!%rt|bt;(KNZef_xPDPrZF;aKZXxq!<82t=- z6ei7>f&X$LfYIkYCgBanw3zL3|P41zi9Se+MxucU*vVLEL+}qq0ZqAqkwKN z)Qg$a+30eYxqoJM(EWXBtQ2DM!p`=0QIoZ5WKfT~Nb378HR+ZV;uU{yGve=Nd!4E)!ZRsFSA2aAvSl|^$OEO_+)=igh#K49 z>q0gAF`QsMGcTYDeXe3>ug|)?7j5mglBQmokq*7m$!7`+K3%lHZcUk#AXscA5|leF z{_!2m{E>r~-hOP9=MkqX#Dz2~YWQjHhBv;LH_-vN1UlGDFHID|Dv2je$i~?7L(s~U z8qe^K?sj)Nc7Vw_XX_DyuuQif$=8Z^`scW<=Hf)e=;t|TdTYH+a%TDIzLCG!_Vu6| zGfO{HhMElSIEU2+{-)q2fAh=*lIEb&aC6=Mpplk!-Iw3c#9?qOdzv~*D~tAmJ_1WY zn!~hAe82+pvk+j?sJ(3N6r;v$l6sc6|Nm*it?f$PO%&+-JOv@~*W6@B9KU6FDQ9aCNTwhTI8>ifsTMO@;j%UIA%>!hJw zMOUagq+-1M0^#qDPew^d|9weJqe#L`|NRQP)()L1lYCu)ym*9q@72Bx$FF z!I^p_6F5m-B8J45an7h=EvMqzFY-z}D!+bN@&lS#FEiNXVlgYPfP23b-p*?r+Cy#f zx3Sej>r8Z|*pYPqe6jxgz6AUS&=vlukNPkbg}hxrN_#te61DXl=cJ+;K9bm`J3SIR z$C0&HPrFW)pKoqFCWAicT9@8xRdC{CfhPM89k{}N=Q*7(H>KW zegu7oUsLE9pu{oWk^>7h0AI+*tfLl9)>i&r5aWUlx%W*3o4GxY9jOeX$6*IJ0>G;F z66*4v5PAS0{<3I| zYjtKw|74~|0=}KDAo?nbUy^R??0!||9BEJ+g4bcD9G@C{Rmue8qH_oF(hw7rK~jA` ziXT?U%d@|L>aZ=`No@GW8GhhQpnrdaqcEK6mon82jDIz$XDU|m!jB-EF#jj5n|iXYz21g;NV&(LlxavbW{}pytSEjil1p}Q(TUpNhBELpgV>^>|z=ee#FRM zdWcG| zpT>lg7E^~IDS+Jt)a?tRHA%Zw5`I>aT7eZ->BGnNo3LbvzPzw(qr&6k1#( zMyMO@H=ZgH_;=();4)TrFI^}-B;$a(U+T#?*w1!eOIstM$RJF%U>2zw*pD15u3ry} zJk+DY@d=If%@Oxsi1bTE3Ed_;0#dHJihYf~WNlCM47OF#ire<1Fy&Lm@U2q4f%D5^ zkRDhYo>DMe(kRG)rb&uNngdh@14{JFx>`jNV=nD3^Zi%y_Ky?O3G{aflJXdws=Ys` zHUu}BY%_$`$T&<|n$2Y5hfm(+kj{0WhayBbX7YV^KyEEGHn{q$IKNe#-8RU{14kmgn;Y9**MUKF2$p(XmfAU>)&LiL=L%6?7+Q073g*NO&rEcC$>=|v!KEqBz{p7%2qrpwV>H>ovw%gniMDF z@6pR$e#0iNBXePjrw>THwcQN`pq6+|Y-1zQ*tOYYB_$e5ER`%p;z>E$IxtSh9RLBD z3{Ejy5}HPF9!vCh-SDt{aqIT^p36*X1gn*;!#Qh4?8kTp8xAU9E%{$KXi6Oh(iD=u z%rehaWMc)LV`^;pBq0pH5rW(r`{^Z7?_di5W(t9DJklJrF653h-0z((?T)UtDwE9HvXvyXbv^D`eyeuG}@rxJjX8>ZV$5Tew=?0}mM{;dzQ1h*wN2W3w&CDe+!g0^v?=7>b}a=2Nd7+-*a7|^Ab)GIGsP}?*cWBt$$Jm{l_KRN%DZ;GlM0+V4BZEk4B=!2*dqv$a{yju@_ab zc2qlH^)60~HrbHyGFD?tV65>q0wmecWdBLiW|eP7fBRqf*jxAgA7aI}`B2`Ay>`$T zrfF;7yHxVSNI$T;V2{f0_|Xm@DO0;RbXTU6VDXj4S6#>;kx=p|+o{Yl|N4|y{6cuF zGc;&L{!%t2eTf=})cPTr{Fka+BwDA%sWm5&Ku#%r_ z7uDyeF#g8CL+Jb?o#aEGjriz6m14qa_)fAR>D|30ZZyV(N1{c6g)0fWVX|J&g23a1 zu_42alrtB;y=$oCh7i3id~5TidxLku=Lju}=clkqV++sY66LIJiH;~7*=XHnQS6%| z0HrQD0`&$R0a~|?2uD8Qn{?B6M7-2$3_pgr3BjOW3@=_8zo9uam?I2WaBML-qBN z-LTD*M1jb!HEO7d#SAIFwS8-;!sW@tLvDPOk5)N?9HnCMKd@$CUC8q*+^k-!g)A8#=##N z<7oRZMl0+Qs?gk)*0j&Xl)^IT^D&={`UGK(riNANjkM{(-;jYCOj+8hC`xJU^0JM5 zl6B%YP?O?RT;AMFZKSWs!9lpq6-fy(UdQW&UP-+xlyTT*zD$)I0x-LM^4nS?wD1E;6C%YK zq^EPt9HN{k5x9*kTpVzUmfZmB;*pob@Q@BlJ5`r zw}|@m#T->^@f1NS$tN+|RU{M&Q-=tZhNf4&N4(PMzP9zH_PwZZW(GV1mEM|%u_|w= zJx(~l;Hxjjg((s5#p+;i%clum->?kM_>AW6G}AOZq`#TZvsCu1&H;;zq=TiClR(&A z>5sVmtz0IW^ZSYY_hj1%Pg`HEGX-P455}9Lw~z?6d=yTOz%{EqXI2%abjmW~2j9-Q zAU_j?Jc_Mi@8qafY^Rj4760ZJlZ4-`KNSG3V7ef%&bC&Z9r!9Bw%I*lO6hmU2ZWFy zWR`s~*apTjkwyO<7P>(B_Kjz3!x?<95349|B;Q7~NKrAL zIOwe&fcg~4YY7P((f-mbtrx~@Q=-Vk+Uir)y-HlCM#5~vW93*p>EVojlOubOGA$9g z?_XaJAlFmC8N}oeTx)w>9QH|-rb7b5)Ow4LLYv@sM?Af9=XqHh``?|@F^&tPZMAcn z`VwR<_BiTr9mg63#r9Blb;w=a-Tb{5m9Ma>I0-%$S+vF(=e=5@;5Jry>Wn8~s+hVw^6d#@XUZAVu&JRa z)4loHu_e?{0xROsFS0H8%sKr>Je+^QfmeG;o2~K~3&1AW`Dyr3onDN;T@uOjv_I3NCGCzI&GUJeg)Tz=_S~X7Nl^Y#c-lu@0~PFm zd{b;YPasjz>|@Deg9pgfH0_-LvS|2dgixCLR6S+hIcZC_$+;HlCTrE`t6?QH zJ*pxxBpSsr1(7JvlY^aBYf6bsfgxtFqDHcRbX9B}4qktn+AgLMf=ByhQ6lav4*%kE zlIbH^d?G z(Uyb3y@!}UP_kiQL(wwoh<25KN6IkV{pm^A?( zK3QtpG4j%vxVFU6yGU}DNYL&u2%rq;V`?8Fz}ijKbj5QUe_gpTt5dZfQ~~GA>|+-Jt>Q0 z1d8#Z)klQE-Jmg%dcIM?g#0mh zMWNeV{67HI6pTd_%Q{SNifXmN5{;Oms`JT1ph!_dLCme1^8uo<2SmYMPakSr-+}6{ zi%1Ghl^}5}VB--{4^uUyAs0t>Sv9}XJrQ)Vl)CN8q5Qob&3=efB2+C=he7g603&7< zo4occj@<67|GX+nqHk)-!Bncy^jxik1U$Pt)bY!%q@PrSe()1Q$W>K|$hU?9gQI8o z;}&7#sVSR|z@dVE_*jF(2dhF=nqyWYi&1uAg>%!9yT;&VDgkH*Rs9f% z+_T3de4%(QY$Qx$D9p`l3e;cf_-dQ#6W8@6MACo}u5w?z9^M z>B)x8#)m)8zx8U1>J}ZlpAj4V?lp#i{(XGBf(#ACvkse%YFhQ30`LN0hv=JWoSDXj zyDDXdqBc@RIp%S5gB1PJ_2a)3c)J<7zz_Xa{!M=NB?#X6If}l8uCQi0Je|#Bvew9> zF+@_BwpuWFHKI|rKQbh>hXj!KG3fL6ZC-ufcQx9U8dpqcwS#=m6~3W7!eU+9#*s7? zXe{049d2opxhPQd`!E_mi6fu|F|UaXvkX8=YFckayfdfEpo|;b3LaUZUr|u6mJh`m zn8kk#Pebs&s-jk3DH_y*8xSzXiSmD}r3M;of4z)TDTV0!C2O0ZU6wko*lM)+e!9Q~ zr-@2C=}Ft|u9@N#`Q!2Q6-0~M$=xI!6)`W2(44b*4de9>7Y>MBLW}i6DD8b9>ea)$Rqk6dvsLH^F5<;*SUQ^{V>RHTOUSS zVM{Ry{P-8kHlQV!nJk^{Gmd-?E+#l-{w~iTo;t}5Z(GTkq|W^)K|IcDzaoQC)K;%K z&Xl-Zm7DEL6oZFupF8|AoARWDHSvweOi|3sw?(j93ChxZctOZ0mDm6vs z3Jh(&1Rg}UrPaNA_8a=ZxRHl8rJ%I+<-I*?gMnP+vtUK=_0P*}^8|@0GZra4lLWiR z-NI$Gjmf#9QD1?X*_NcZc6+sMIL^Bsq~hvjdfE|!59L?&5u;l>f6KqvVR!K|xTS-# z(s%lvmp#N>{+t$0@Ld+5$Q=d0-%xkuM+IiF=*_`1(h&{`sy_At}bk}kWL5Z)8_ zok5ri^_-Yfz>Kx^oDA70RDbD*v3raS8m<0p8-UyyqM~@ep=TQLqw*KyDk#=<4Z$KQ zY^S|JIpDbYcf8#Ncgi8zYY6(?ZMpp(%i79`SK;XM@44aIRk zo-^kibX&E2cYk!}n?z<- ziR-tuc%*VQe7(!l=CxUsvT?P z3U9g&%qB|}l)-kd#@#g#XmoYh$22f}YvNMScORGus8&6~;KE24XXE4$vVtJDiB_gw zs!#rIb2aavrYIf^UViv>fs{h`*DV#g&R=LQGF9f)XGTNY=Lf&jQ=vS zJ{# zsR+>3vv73meL7>l1Wu=cqG>dgj?zN_8s!FLVtGl)^$FXl8UW|DuJJ~`xAVCKwXgs* z@a48J>Yk!6x-BpQ=6$cso)Y*9$A5rIWfk8fH_XNx`{)iz7Ls0rB#n^mwG-176ml~y z^Cb$1OZQNQRw$a|#W5_2!9=rM{n-Ib;>SeAgTE#dW1Ha4Yg}&96OEOD*M1F!)1o~A zHlcEpvc0bk2t2PsY0wVEV8Uk=Um3I#>`YwpT^uYHbraXakA0a9fX~Q9ZVnB9Ujl*%J zry?Hq%_i!ZA%woi$LRl*tO z-p-ZOyKR2g*EY6#c|)P+S*X_fE$10RihTuQ#A?&OYNx2ifb%Tab0eBfCUbF4f6oC1 zgmQzj`+0y$Qmd`L29c2-9)hf0THoejFQjE8yvGAr<{wV+Fc)jl>~G-t`^px!)I2^) zzfz(i^?jyQxkG@6-um)c0Xyp&wr`(oBPsp`r#Jc{r`ju2D54GsyiA)W$S9#4Q}j&* zybVbd|GQ0s;=u*hlbqMj{bL`?#T(Q3L&;y(4(&H+MOff;mi%MmmJhseI|QTkCnyN4 z!giVD&rA9#=@`f)h2*j>hEt+-Q1gX{G`gbFp})BkrTdsnNidyEaKRqctXRUU-Gel| zlP<5qsqdOn2>tuiGoD7oJWGH&ml}&-8|eIW9O{Hw^)xGM&@7~~dV^?7v(uD*KTJ=v z^DmA-Iz5WY86ZllVLPkDy6AM1!14N~!R33DCC@v3_5{5-8#q5o8B^_p9fV1l?=1qO z_JQK9xA58bwao{P-Sm)xjCHh{t)|vq$K9g+{chC zF=i7luKm2^K02C*hOkk0J8b9vF&281iMv6+EX-V~-Vdf!s|GGqdwyMajpT1c-!PUK zj9ye0Z0B~ijeh_%!1lYA2!$pl9`!+K8?oRdWq|Y)_d830b=>et=gv#NsVq;a5fiw9 zRr8jpRqSH^)55FL*8c!2a3$jk$$>qrLz^RU=ut(g|(fFG7%S>o^|Jx5A$fYPtd|x+wTr`2(Mkd8iYQ0wkR0xbb?pxw` z_3=MnIP1KA^E)%71ILr?s$qzc+E+owsf>Iytgz~s`ctP}t3e1tqFK(qvG({SoAE%sz|cM9`Z}((qX+Orl@F*U>z)F<08=j z#3yFNiJi#+*Wx}!TtmgO{Kfb}8PTSH-0j>YtG^u0epZ%`B)?|U4{rVskW!o~;Z>0F zc_}6=kXCNP>4Ty4-ID`)cudKDED#R(G752!_&9ZpZ7gXDp8@?W!$g^GGCzyioLu$G zB334==kiCxoHe;ZGTLnq=k^q>?*awQ2O=ivzvIWR644R&^_LO&dU6T8^@;Z6gf}?2 zkBbX_wyVIZ%|tM<*~0sG5SI%zzA+$@b;z$m$0NBFmV|FFQR@QIyn~GFg3J|2H<8%y z*D=U`joqU7N7kn+dWmPM2u`E?p~E((ns)=UYown!6q>$zTS^_Ca&F-}eeyu<{ zvx(YE%Uj!NM2W43L@-wo(3&MT^h-@S)NQR$EL#x`G1D2L^r1iX-0~TR_(!9OMOa@K zJa7PK@0oU$tUfh<3nY3hvFGsn`O*#RpVlZrWO503>}WX z1lVg>=VH#G{y5x}O#*kY96K08a}7#J=p*XWsNAYF7t!ENDi+{b@ZeF}1KIhK|C0lFCC2NaU`ypaTn6(P|0}$f)8gg3MwGWwG_HE`r$CwEZtT;0 zN`qBHrkjBarXQo-?$W7~bzh1AA1B_$X4=x1XRhL?Sk{z`C2hvp{uw5*LxU@J6gd>p zxPN}YMD?h)+orDhnjT#7rt9C41P{u~=8=JS&r~v1|H;%Tnz)mLOA>tD>f575Hd3uT zlwh0-evDQ8_Onlt*lw)&Hos;A2@pG~cL*QS1#*GeFLjc;$MlFvk}VY|DPbrc$d#zE zf7rV|!d}vHVGOkz-+n3c^-EC%jdQX0X9$u1{uv`_@X7q++pED#dI_C#v$|NKp7gWH z0=I#ArB8wyilU(4=2o2e_*B)=HAE{`6X|=xI|?>~5uwD(gOLx7Uw-VZyPTq=Y_a^) z&P(ztkCIGC9FD3jNwZoLbSQ>_`su#P+?ooGN!Jg zc3q1iuJG8pN;TrRvF~VTZ$6pL4y+;}#AruH)GscL2>YBvb@taa_W(j97sx3FS}=E0 zO!0dUZl#@(f}-yma*F=@DImM?G5v}l&LLSxWC`=Us1IFo9U_W~MMI1- z6GZ38<@P(Dr~$2^LYT^KUmK`XP!QXy!+|j%iU(pdK_fa4(YH8>d{G|IF&UW4I`7Ld zXEeE}(W9e!yAg7h;7W3MxoHJ*BltQeMIm9=jScBcxw?dhlhdi# zvzot_e@>}TAB0?Hs@Bsa(IP#$-hEO6$(0+dZzlLhDU2QSdYOKh1JthBwk zX7iaT!1v57q5b!z4xZAXLSS55j5WM16z0T=sB@F+ilsqk56AP zYS#jN{f`wB%)GLd)eswi3-E6K>Nl4#vRWxy<*hoQr|?xfP)HXz^~y`BRaGhubt}@L zhv}ct5&9pN%tk3Xj=wMdyfd_9b{i_Tz?zFc>^p0wDk(O1M@%0wP_YEX`eb`XPl z*9g2OHt8~csUj(XT%S>SBj z=l)y|1Rx*oOVw97C)XmK!Lw1w=1$g+aMu&T5mr;_pdV`~U)A6VFNm5I49*1cYlxaU zPC_QHA>=%EHDe_#4gG%{XSpc6B=sg~4%vUy6dt%D6+gT0nd_53l%*a~?)uj(UD&|= zd5qkjFJLsd=XBrJwc1!9DxJEmN-8J$Kg0*>kHxekQIFdG?Cna~MNC?C(TAuJ9K#(@o3`~`2 zWLS~qEHL<4h?hHg0!=*;@E}Ah+>(t|)+Mk_1zTvAFhrf^7`uu0OhLh}bldx3)D0l} zyeIWe$$MM#KR{3{8P5rg_&IxZnC#yEcdxs>)W)S}uTl;%7Jfkr`e2Czshs zu@X1I7l=o0;={I{!h48**n{{po}VWQyz_N<^?lFGYwlrlY}G$<{*GKHW=$=ylIz~M z408R%nf8D3b_uRT>>r zH#{%EH)n73v2gUzFX;Q<2`?ODhVef+RNoJ@j(5yO+?v`U^i{Lx z`wl0ap4Tv{C6x1cDpX^K9n^c@4CSn!cbO_=R*y*p44Usk1{umtM@mf`P9mnHQ{_BR&e6OHLbXtmg zgoxJ+3N^K*Gy4_2lWymNWgS^`OX_C1u*Bj_BN9PwvfS4Z=*o}y^?S>kk z$K>u%q1%pBw$h>o=~@V>lxn)4=Rwhrv0;1`-!wN~uC z>+iLHt=4Kdb(Y~h&IS0o(cDW|OC-_$O2HsHoPfR^aa?6uKZj(6{LHkuS+|k-Spz)ftL7 zuUr;|qjr8YiR4LYWYHlV%(@2&Th~0OERQriItI{H9Bajomh_2v1d$X}8cT;0e3^Ov z%l4rW9L0PC;M4s>$uO-5$XB{ePHHrXw{%s^a9`7yoGrqhM>pFH0Y_5;G|+M# zW+v_u&%Uu-VCE7r+>e$~#&YKkSO4qf(s-3+_UAhH<+jeL*7oui&6339ow*+gFh0~L zuC-q}ro^5}xFHsE`Iw|D-xzE)v<%T*?t20y@SKF~`QGydFp{_gVP}E%J)!>A;&DI4{ZY_$Vp&%c=S&Xs3jnrGGN`s%NA6 zh`EaOE^akTBZAZ>VU!1L{~d|Qp-^mBqg_qxeQ*t`uLg54$C^GKo7?Ny~7b=e-CIPWXHJD#z&qd*@b&+)DlY}B+j*r=Y=d70pmR3Y<(GzKUvM?Tr#$EUR3zMLrS z+MRIrbrik_pHH^>Wbohi8>J>fRSuK`PPs=}ay|%hP}qqBLP=TxcH6JWAdI-fAe#Pd zdH*@je$#<&pM1t}tOfH3%>h=Szw zqIw6kCzxnR`*aVX2_L|)E_x{O3wW4fx6B`%R+am4OfS~8zoULf$2p}*QoKv7Ni}!_ z5Yxa+OJpPaK!L-l2%Mm&9^6&=BNHuOqThxc74-L6NOSnN`ANj9KS(JsWzLF>T^~S* zqXy%P#%xLAJQqIMr=E9DvCxXwrxvU~0%E9Dri+@S$RQ4nW2XX(gZ-0 z-*ct3Y@fMVr06GESj|+GW%$NNW~W00M5?#v66cA+kn|OwNdIS|n}v(ka2v8{VQHW< zoBO6O1kmeV=caY`AAppD9`Wp3lqHGScsg9q*y=73^Awd0iZksEQL<~#@{A~OCXgEC zjq~zwPAZK))B7MoM#dNsWj`|1#gBN;dZ10jMEL=p%%2f5=ewRlpX2C9;P+Z~zDzfh zM)E%ZUd-zj2H)of0KO$hZq`Mh+(kV(#+X`*#)^qMS9`54~RSnsTtmR=8mepm>lGSV5t$En{%O*FeDC9UCsiA(qkCRKxIpN+0q_ye{+C6Th za?TnMRqKoNuWy46M@<7c%Tce+cMBf1-sV~R)^@!48dtSn@i5x$y{CvDxwcLFCRu~c zeWWSexo^d_I2v2|;7EoWC!>7cD59X4#>lqepT)amZtqWhQT9X^grLCD;C%QlQ_2x8 zFb&yKLdKHKGJ#okDnnaf6fq%LntsE${X&D`ZlFDE{TpFMCm~4Z0ay979aDTK6H<0l z2wEJAT>@)p$9+v}{)DaX7w+^y!NXQ5WD10=G-VefR*vHBKq#noO zwvY~uWw~t&Rp6wN=+cLk z)A}zfiK233|3Dg%q#FeLGdTF!XLidkhVCb)%Y&2}RqxU#cw$U%msT~cB6q>+F(55# z#VLX=nSVko6A4X$ zzE01X#G#osDsdqnK6SwYX8Ue|F{`IAAIBI^`Huu>eFkW`?nG*)$lQdyJyVPnnI z@HGo#yx zH^p!0o+n_cp^yhJ6FkWq{Hb;7f}}WUg|&uUqL0exV|cxqg7>*pxQEJSywtrm0mpQv zpT7`{VKD)K+Z5ndgUPxWpH-75w9kL87$ap}xQWmVN5jJg1r5QN)sk}VF;xE8iOEi~ z2{sZmvs6syG)3EYjo9ekSlD~2j;}tZkBp}()KrfxKWh1hqyQ5){ALS|`7)J9l-5~|gCPCO0JDYb}_pA@5FZ9|d7w=vaMbbL#4W>gxIk6cTrkK9$g678s*dkj|#J(G&;+>{5k2!ocw1cl2@%Mqg1j>MJOp; zEaIK-xi(NLdAMZ)PygOelQeY7(YDp^3TzLk;@2vkP-!dT0StG0QmL)@yO{uiQ z)$nfPZ_Dp0G_B37bOw)j;@p9ZDy1XwabF;i<{)q6!)!-bcVApE64)im)CTH&76W3< zs$(h0lYj$^d^Dh%F1?+dJ2i{2NKcJqNDSUfv}knrF|H2|`0!vnw#swQ8Orejo(#T( zYCdrt_86_;J@}Jqt}28SH%h*jY~?VIRT3i4&;q@fB%4;TYMRyC=bS-DPrGWn*gW0y zf`GISVuks}Jlhp?fRakLl>*>O*+9@?1H=b6y{Ypde$jsMev`)5+MR`;ID*?r4#K48 zLrxpK18QE#By&O|A)#@0iB_!~H@O*}x9yNe2-;>#b2zDJlez%Im0H?|1o>zF?9wd}OW^xq>fN9GXzoh5r_7@l;Ru1H3H=Y&L5-h%A<~2jJic*afF)`}Z_9r; zIXJn<5|7{WhQP%~v&Kk-f+9I=fG0?=hZ&1NH;T|uvF`Q!<(w@RSc;C*eZ7O0kLM8$ z@HmfIG=ZB<0%HZwCnhfxIo>29iYTL{lkd(7U=@-eeV?pydaTMd6@&o*MHRSf2hb3R zfRzBkDtnkvO06n{5*;fGe%e+Kb>%58pd1pvyKUupAxB!G3_W8nPP)(g;Y}iYX@&3#hITvZJll|q|kVB;qs8I$*920~JQ9;w(bo^pi zDauo{_I70G9vgtrS5)frm!u;HOSk8DCzKF772dqT!qTtAMMLi>`M?+j6*pHNluDPg zd9{HzElMJcaHF_>@Ln>l%XX)o?|3K*4&d{>O@98cl%xetE`+t$-VIm{q9e%}^!)kC zhS9p)?AG=LzIB5}bBZkr0znE@#ktm=P(=x8XP1eM#x~$DGj)9!MId$uD&0T}6xI`1AUwxft-o5l;j}Jl4KJ1v=US7F~lpcF$SxgjFPH@sj$plf{yyf57@}o~@e^^h* zI5h^H8KoM$VLjC<`t8Qo2wn37e{(8T6HnIh0?p?Dr}>4I%`ju`R)?~3mtl`ldCLUN)7;<8LBRIvCL!9NBQ zt+H%KPce<|9&vU_(5e9|fAOZ`i3W4U63Y|Ct(igg-uTU`8YzLyOK4xE_aDqF0sA0K=k0t&80C>WyWsAO4V==51f^ygJy?Eec(R|AS-0} zfcn5Ovv5d!03W<}Gq!;&);$S(iR3YZfy#vWxVr^30m@-4XzT7qsW|b z#sC;KsyrK%^VTgXWOM^fDc-ViLINQq@gKii^Nb|~bTQ7aY~1fU9;|mH2vG)wMRJfy z1c=({^|OWJDX60;L4JWM&b@Pwbp{1gt!th+4~!y_A}uxAHLo*XamlbCMOR1N@i8hq z)`2T6j==5XpNgodKvKHrM~OFf^@Zyr)Kff#j>yj#nb;GukrQB^NqCsDkwR2bdR~8= zX-$jninPNag$Uc5@sA?H=TL}K} zow`Z&j^VV2BBEc1CChDPFOO|~+$WnVvy)G_$0uNxCo^;I;us69?GN)I#K`#^nRSz5 zZn(a^{bz-_w>ijIdBs&2GtX`hWTSNUbfeZ#rGgPaLseK9s{T@rfuwDV+%CrQk0l)_e3pyv9W|D+XWY^~8nhnt;3G800b3uji zMMucf>m5-$;fu;`NL?1X9GhtbQYmQ;)+wR@V}QsMs8O^g*3j4?o$3V+my!h!h3^Kb z1xpa>leZ1w5H8g}`;JF)oVO3WvR6RV1lM|9Oq7<16L?W}C!R7@P#QsWlob46Egcw~ zL*n)L!^uLH$RK!CTAn5ulqUx%UHl(;J_p*OtmEq@7%Fy&zR)M5CK3ok^0@RT$kF9- zi%D40_P)Qv8|RUVDsI<}`@^VGu&{F1k679*BLi)NkL`lk#Z@K&;W$UxjwZ;CVN#k& zP}r0cLAv#O2vXHyxkW^duoMn*1F7*5UNx+bG(u>wA3?p>7%W{wqKJrw_u~jPR>Flx z!`Fny7$7eMCFkbhuzhHY?8!7bCYh5tU;tmA8K{FiAnbi5GC@hMc$GMg37{$mZcTvvKXRYzpD-Z7B9Ou>{{ zq9 zO~L}JRb)6f=PVIXfC)-~9!jAx$}I39Br367>;OHyMh2Q6&jZBVom`w{a5-loWbrXw zAwr8gnHxqkSp`}VI!76U%za@urrXvWLpguUCv^p0d>?qi>j>jUYQ2Uc4d`aQv0w8q zocc$b`5bE?inmBScyK7EWnm>4DS+Nlxk>)gBT?GgU7L`YpgKwM$&;ckNRq_~$64T!n zL*>V)YqIKgoh&DZC0fNG`Z@pr=*38ZQ{mn{#Kj^gPC8_Maj$ANinD;gZBPYrUD!JY zgmT$Vo#bf~QD61(jF_M}ZE59QzCF2je?=n2UG!iDnM=F8HpyN<#{ow`JUYsRsqT*4 zet7qs=s;B45B1I7gaPHPXVk)2fwYFin>R9$h5{%u)sVQLVV0k$c7!grGnLY;0(t?>~py8qgtpKq~Q?oei1QL=f z*r1{&7Ym3K0;Et#>C#-Wj0HzQ9fEbMg~=rwUc^rh4bTKCBbW}Ghq3JL%)Tc;l4Udo`A7hpipSmO`I z1!|*05D`tV?IdbCN(g8G2>^IR1Ym;HAVf9^vLFMrF|i^ndW8TtWmH#XnD*gB01F{5 zo71}M5>N&}+*Cky?)QaSQXMY`m%`7CR3stGT1OD@)x)jq`8mUh-R}uRf_HkvC7{|I zG1flHs0Viv5Pipc4gB&LRn6tYlB$@_QBDv#BzwXn5dq>q`>F0dX3#G9uF-b~R^M#s_TG=6X^^|#T6%-*nj5a9DE z!=kkkElSiT)s<{G4|T?Zj)JLE;5%@D&{JnT?LvJR*GATC(h2KWV31PyulQo1LR$3`GRd5cLZEWvVb#$cp{<;|ZxO!$2%QL6;-}S6gRatk59Q0C%}L(asxCT%*x- z*FRWXl-r9cp58N4PY8k?uaN8B@-f3}A8Cx)z9^c4odjcgNRfG-c15{z%rPOfsiaaAj-qAEq^m&@d_jyZ3OL39 zY3-qT2oCc2B(bF|0j)0lM9FX#j@xmZA<^-BafL`#w0uwR0APcJ4HI6@a5BWy3Amh( zA2VEIIw@L{L;-K!_l;1T3aARC=4z975uT`)RpFtYR*-SRA_ZfST(m=-^kQITVA>dn zjo9|mlLCsMpn}zLBN<7B_VxuvqNad4x1$dA^V60j5 zh+q&WQmb~=6HTWG;}panh^fPOba0c#7YU;!kW-}7DZX$}BLlS>v36Zhw|60Is6lK_ zRB*f*xG~a5*M9KdC_yY_{o_UegnHj6tY}pilf7aDCWnsj*ifa${L=-|AM+#eGWjgX zgftkD6qw05H06{WLUM@1@q&886-1B-93>%a^b)8!U;i6er*F znsASf@yfz*-C&_3O`dV9A>Ddv{gVd}q7X=@RAQT&Cfq84(#2h`DXDaD1yxF24u~C3 z#v0eO3edd>CbzuWLJAEG2M|Y%;=M_scGX=R75!ld=p4yhbOG)TC}E*N4qXG4{8bDP zpwd8EQPFH32yI+}i3NZN*gE7N`r#HRpefh!f@h`O1F~oXe>vmzvwPNCxESC2S!9nU zy2BnvtLjs4Ni~o_|7u`uc2Si?lv;7ZkikI1_auJ&sjTr;%UG}#TPwnLq(R+2*m5I{{23t}c9A!)FP z%C!TnKn5z{bjZ{ium~kmi!SwriZO+Xl-iK(y5qb7umu{AQ1HKH$2Kq#WxJ4CuN&_T zm>L8Ob!01h#KY{vTjBhZH9%N5urSmU3Cj)rW{#M9VKu0%(>!LR5jfKC0954OQBEuz z3Q2~xUf($Qb}iuxU%|(@<0J4T5ks`{^5d1)uTMAYSpg9Zoe4qpQ|l(FTSJ}q@sS8AD^B`fuJAs2Y*c!bk`>LpsK4Gl?)()+(wfnrMpJTxz;#1u0WosRL>^Nw0#y zK|z4cH>@(Rp=lJ|5eAl$>~!K6R$l<=5vc)Tdz-@R3Q7PF2q1(QgKIJB_zi6k0@Jt` z;_o+J(G(ZExR=SSEP_Zcj+~tub6FQBhSHBtH999A@QKwbc5MCS6(XmGf94M>b!}0< z9Az-ddaeF2O)wNTsgHn&zc*J5mz0J5*0B0y+vCk8v0b-4WZ)oFHm~=O1`}h+LHfbw*aMK@^UgHA z44^kFLa!Ugp<1f15&Z|=9DoiW2Cf5gbJiZm13haTZnu|z81@DiSV?5GQvxJqSL1k5 zfDY_q5Z33;I!I3W9AH+dJY)qo_;~c;aB!>;$tvORY(J0I6k|y?;n^Xb(g1!R z-didU7fslHM+KlD-6PNQk^l-Dvd#UUj1%w?%I|-?F4P9JrYGQVxQ2zOb}JUl;Mbx$ z8)QoG{I#E(gy_?o6fFKfSOz1tdwBc85f~PA^56u}TJTR88BAeFRR>-<^NvU?%7IvF zLcMX7;97YKenq~621#H%ZxiJ}qMMVw7>Qx+HVF|JM(Os_hA@k(0D1)HndV@>x+ow4 z-UQKLRmg{14A312Q8pBI5$s6llN8b{wG#-e~iIo7*K!(AnMXo=O5G@@^_$E9A zaDlD|V1v=}2hd7jUPI3G1mgrd;u5&8Z_9^EVr}Phqw%b2N>D!9FZ{U`8yG~_3-7FP zXweGt=r-5i>lRQTK?7bxbz#KZml2n$VL5{KP3=0vJlJjW?Wnnr*UvyWJIqjJF~I|vZke>VyUh_4fVgnmiuE%uN+`YZL9yTUI%KJog7 z3*Q6z#ZV#1+3Ofsb-r*F5r*%R6~GLMtz2Qk9S$`A0JuX4QZ-h7IK%*r-9zY|V;cqp zJok)VwTKWw<#4;T0QZBOk_AzAgfwXH3?_wD?x*vQ8YoAE-G6%TMk(8(V2_1(>jhEI zQg_Sa7(f(3AL3%7!$>mt+rOMjYB;%ST4@d84&g5(8t2iPcN~VQ1wHM-?C1=YKm}EL z*ElsqsME5G?6170H-E+|PN*L|3{?6xedxvINWUV>n(%+a9$8g1Yfd&u1V)Z4Tz6zZ zu85YeS5VuG=_h4Tk~f!Fx&(Bt5h}nGtLVo#u0uc(djRtrtCmnYs3q;?+nN_=D)o_a zZ%A%<{bE7_LaSV1o%uLSEvXVNjRXDS7CaR@U2?xzENcLW_(w>&X3abVy@57ITI&IW z@m)?7JcKBymLTJ4g*h1#YW6xkmSjz`BnBji!B(t_AmZ&@Wyqo25v3g#xZAi?1yqf; zpMKnRNv0K82ZN3dJ1{TFA3^fjjf~$zgzWLMLzjU|f=v8(w(j#y}{+0WgFW zwP}{qsm9vZJx+DotOAis%`Wvycg_^G#;OcQeFyW9qNLJ_d~-E0Bgh3|O$pZDj3%X4 zY)uQah&?*%4@Qrwsby-r+iY!^hw2C@K)jUbPB_*!?K}ZJH8no>hQ3yv2Waw5>S6ce zNJWG<<8Hj*>%;1P@qi9dwvVio8jsglCIa5NLB^v{m;U&`U>*1?+w*YtnM{E9%lB}t zjN(AZ4SZrnKx*RT$U#OB?GM;=;gKXNAe7-lb@z%um4*`9y%^4^18{EDzBh(iE}6IO z+m=x0O5#+!@8br7kI>}}A(yZFSelmLv?mTCq6*i_c%%BsDxsL1ww_eD@yO@Y3&WuG zGgh#c=m0-U_letZH8I<%x_=mv@X~r2#ZH`64m%@6FgfRrZz16F z_i~z+8dsM#=qD&fZ_ncu%Nj#E;}{Vj)pnjf_llEpE!|f}3;^(k8x^_dy8i%NZk`t| zi0b;dXaQCRh1;*rIB2jPL=0ZI5!6dw=)2&nUm*HxwuGi|NivNPvT+ zK7oGBC(RIfhb~D)OkP}pc>`E{Q1E2Av9T2q;RY9A9&5tU^DEK{o0_lljKwHkxc)K$(pR0x@xA=yvqcHFT;Fr@d&`0@9UlrkYm z>x_{l4OUam_xO0$B`q5ZDBU&3%e*v@9U9qtH@#YSCL@}pZk5om={V~3#twjR3Zexa zK^gbq##kt!5xj2jb42+uzb9z#sHiB6(piZ>1ld5;g2CGBYrLmO4-WV=Uk4A3*RR{IYEHTf;v2sIC6+W z_XTg-pMP0ZK!ALo?g8hlEXIR>tZ7Up^?7hz5QtIkzPF1>Y!DUFp{<}~ct~tUKG;MZc&7y8SVQg(sHTL&}EtvP?93!X)oOO${czi_y9F*4e z;|-jRJxt-}iixk&toXeV3(BLi>&G}v;xDctP1p&@ZO&?ZJY_%+r}L7@VYdnGw}(r|boqRyL0Lvc8{$f{^i4gs85z0-*?3Lxn~ZKPL?^0QCQ8iIgGLu#Q3 z(C>S+)*%2jNC+l;;KY}~>Emn&^P zaUzA)x1D2!Rsqf4C}VH5bQ!+oB6$w5aZxlPotQ!r+K4&{wSD0r>CjGb%!I43Ct=&; ztSY12)H*Mhm**G~&BnvG;Qp`xq#AFc%k^KpqzzO&ZO6RSn7kj}K>eRsic%)T-_9^Q zS$!CZU0r+!`sXP$4+!^#p)opXC*?4H(m^7v;J<4GKsQf9VlfZ{WJJEIxP#`O6zKjBtZEg!9T`xKYvTzu z)?SogEeLq5_1hw>v3vd?{bDpZF*pSP0?NNQBB2n`@IB#%P|!aKdics%jjlE0E!;{P zCOWzcRGrM8ASm*bbbF_oaW&;SqD51EY(!hx!lj~Q_>Rj_9tfBAx_rL>-Ql-R4==f)MGT`EFyqc1$0 z>BUB?V5zgVamP7OYY2jN&9cZvG`hF|AdmrD!N7ELHQM8{gQApy6_T6t&loaD97PbZ zSCmdPBk_e&0=A{16M_&D<9{!vkOUI4o$M8GQIn!|?}erJOMok=1L z?tJ4lMdi={1UspZlU18WD0f>Qlg3DjtblcbMh3|^_Wp9ng$*7rHS)b>v_qwO{{Z(8 z3RtfO5{8X?z-$9UfrMev&alT}z1R|O5vZ%!D_^3%QhCU#(AuC=;|`vsAn&6cK0Zgr zN(d$c`8_!b#7d>y*L5r73U#$!L6-P8f*Bf~LF4ZX;>1bzJNYnl@#UgmAp?{b7sghU zXd`~!Z1vK-%99V49J0vG;k?VT*h*88U^6l75O&k6)6ah%H)BXkd!Bp!Ys>hJh zAQ3!wF`WTyQB!t17W2aMj-Xi8v0&GpI;Og@(kcv~0j&&Pj`geS8iY4$c)K4_*?H>> z7!?lG>gw#P^)4UFY3dfmH}knQi}FcM+XOan@>Q*Hh#C_^tJoI z$5j#iGdaYUt3Ql$YVbQUL?Mt-01wXayDkSv^mgQoBnZQ@7~grdjmfY8PNg@)k~dhz z{&27@QJtN>vD=7CN9H~ zuZ#P^OF$>8m{>^lq`GHJo5l$wG1)YU=XWDfWoGikK-7^C75FubSioS5XJRKE;>j$u z5&^BM>mZGtq92}D=MGazx0B8I|0$j)|saYaI%B z!md;hQD2|dHz=KMq0r>^KO&fg!hCjsFTwoGvK+UR1W&{J#-b=jk=_pnNCjaBy#c{? zbQGP8a=FA6pag#7fr;fqq3QkQ$OhkM`gUgs!W=X`{Na!Qj8>+^-N~dI3axeeMc?oRpF$2cm06+6}&Vy>%a#uAV%VwULm!~>nkR+sZ!en3)Ho1e}Jg8>ndH_u;q zvWPi|{{TSf?>IIfobl%p4JjgU9bem&;jlo&s?lmLxWFobp?Bf@{;|WR%J&C2q?fk32ZWQC8@JEB0d`z*OSyZ{@jaPz4J{ zA0qz%*Dn;PP1{u#uG^3~h_mtw2OU@dQ ztx5XHRMl?H84x0#IJj*Jysl`SlzrS1nuxFQjshA_?*T1%I^*|{5C)Lq;K;W`4zaBO z?WO^Mij{Y*c3w;&YAA`fDfCc2Fa?T2g|MUSkI0x%K~Xem+2CNM~#ie`Dk~W&*L@INDMjL^IUY` zI73b)Qdt49IQzm9@-N0TvA{2Q==3zW(3xQJ;-G;6eUne#LXcYR9}7rFa+tlP2&5t7 znSY-dBPeO=EFV!adIVwK_FNjcqB>R=;u$O?Dm0>FJzBu<+IhY`Wz?ur?j%R{e0*Uw zN(5JKea`&ncR*8A@gEN+5n!ig@qTjC{KJ6Dg>?Mum)@K@njtoiDl_S`yon@Rvo_%s z^}TxU80p*!J@0g?#h*LJm=4^I;ymyx+n3EIx@nZ##_n7s=qy$QM(=Cac=Mt#eSq<~ zhcbjfFPj!um|n5Ldm=}{wVs@D71(wc-WpUpOV+-yO9CkEj>@1OToP6)1(F~)#~02s z@|&Cu{=#CM`{puVel{&TWh)sBQFTB7gw9obS&( z=Hcwa(9x~;nvr#fOxuJYZf_e-sF-A^E8hFb>pU<<7g%n>ZmaxZ0(BvT`xjcspb!;Z zhrkv3#~Tq#5Z~`FfRxmV2))Jm;`q9NWFSHSa(g`E#$-|nr}+$ST7{%u-xC9xst=Ms ztd0OgkT`@$##)t*cEB z*@VcXLsNbAjYv%rsD*FeSZY;9?p1mGOmK+w1=w`B4vE@2?Y@-PquS*0(q1RQ(UE+n zu@&aJf4rH-iPCt+X-JwjgU=i?|(OY1QAx zv4XrGycty`f$tn6tFMgSD!azBU0o?v_#tzB4OP=Nm!~xlpiw{(AG{)AtE03O@|Yxt znYQOzsQ?^3V-}EkR`7e{k2p$@8Z?FyfIJ-@NBY8O zqoRDx4ZN&|FkX&LwY<>LmIlJa^to5eZU6YR?s zL2NOymrn$ADfya&F*s2UA4|C2;BE>Mb;tct~HWfwIzJJUu+c&Kb-#Fqe;XvnamBy1H1tm^H z%e*~+5k0)P>w1C<4Qm2IOgaTNUi8d>kO3fF9sS|e73yd_88$WMUb2$NIKr__d|*xt zDT5mI?-zX95<+u^0J|-_e(}iDd?T^IfGLggVDB*pi+jKI%hB=y8_@HFEb3MluyWvm z*g^U@!hGoyV9bSM0o^{WRKC{U=!zCzy(-ix|s5IzJ z%fEPS0yj^9{1wI}4J*dn7D6{0xz3^4)&(dVWdX}O*8Z`T)CwpL3h(ph48cWIO$%TKs> zj9s&h2k`6ngHVc~q#5DE#M1Ii({y$_#R8LBImUpX>67>?j^n>EU(2@-D z1%88^Tsjms4DIip3^A(eK=?30li|)VI;X??-f7quuv>+>SBHR;_PKbt4Y=Do4ln}) z(6#}a19gC=DINoIIm!b*65ny+qeCi32cheja?Qv+0C5W>ATb1v@!xV3q_PyOu61Og*R%wId!AxLNt z4MjgZVFE)9rFoqhbVU%n`267q4$vq!pPY2rHk%i`vecR`BDA-dzD(hB8p8EFR)_zpOw#hLb~rC=}uB#zO%V2^YMF4EA5amY-Vwuu~wK z*e(Jt9g>Hk#uN#rX~!YMcwz?*QD2Aa2y?Zr7!HqD4K(W;grJi88U&p#Q3{yJmD+?kxibklV=kzLGKNZon;HF)We5H zu=X5k`Nb50pmskw-$-Du(X%x;@LKjfKh7Xjxe9!lBwK@&JUV_b*{k8kX(<)i@t332 zjs4=O9}{R}6`C7+#0smbTsD(o$7~C^WW)$lba^vK^oacBP`Wt74;%R~h@JJ7O6Lq- z12-C8PdU$rhc^K(t}sXdaeyoUpE)w4VO#+Mv=?f=F(RUd%HDY3>o$;qwtpCI1ZRwk zgvou!tN^hP8kK$Yh8(lvTuT z4)DE!#>_+kIWUwWc+1caiGcwTq8FKpXhx_j@q@1=nyw65DZ4eC$xbadiW`-V9kTaK zay30T<=;06aOp$QhlGEeE4>d+6M+2Wei7U2FOWB2bBAbIfu@1Wss<>IGa6`d;30Wa zj3HJY4)Rb6X`N-A^>M|*`O5>zFf%(l%49PfuA>Y4!bp#m59!D3+1vCwak#0lrTaC3 zWxEjjnH6Z7-Q`o9zBFiChG0X(glrsV3i`&|V8n1Ez#hKw+C+jmKtpYKI>QAJ+{H`2 zyx|deE57lz+L*vzu?Tw2X5#9;i%o=u>Bn-s@t|=AcHaExhi9)9Gjkj(GCh$NF_QEx=Tk(QG zjl>js#`$qut}<=QG@HUbu`sc4+Ab~%OeBkdcTM8#oJd?O7Z}A{{ti8!vSCtUdt<$_ z1vAD3ujq03%Aurl( - [ - 'path' => '/default-image.jpg', - - // It means first resize the image to 400x300 and then rotate 90 degrees - 'transformation' => [ - [ - 'width' => '400', - 'height' => '300', - ], - [ - 'rotation' => '90' - ] - ], - ] -); - -echo "\n\n"; -echo "1. Resized then rotated Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Rotate then Resize - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - - // It means first rotate the image to 90 degress and then resize it to 400x300 - 'transformation' => [ - [ - 'rotation' => '90' - ], - [ - 'width' => '400', - 'height' => '300', - ], - ], - ] -); - -echo "\n\n"; -echo "2. Retotated then resized Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - diff --git a/sample/url_generation/image_enhancement_and_color_manipulation.php b/sample/url_generation/image_enhancement_and_color_manipulation.php deleted file mode 100644 index dc83b116..00000000 --- a/sample/url_generation/image_enhancement_and_color_manipulation.php +++ /dev/null @@ -1,105 +0,0 @@ -url( - [ - 'src' => 'https://ik.imagekit.io/demo/sample_image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'effectContrast' => '', - ] - ], - ] -); - -echo "\n\n"; -echo "1. Contrast stretch Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Sharpen (e-sharpen) -// https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#sharpen-e-sharpen - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/sample_image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'effectSharpen' => '10', - ] - ], - ] -); - -echo "\n\n"; -echo "2. Sharpen Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Unsharp mask (e-usm) -// https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#unsharp-mask-e-usm - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/sample_image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'effectUSM' => '2-2-0.8-0.024', // radius=2, sigma=2, amount=0.8, threshold=0.024 - ] - ], - ] -); - -echo "\n\n"; -echo "3. Unsharp mask Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Shadow (e-shadow) -// https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#shadow-e-shadow - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/sample_image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'effectShadow' => 'bl-15_st-40_x-10_y-N5' - ] - ], - ] -); - -echo "\n\n"; -echo "4. Shadow image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Gradient (e-gradient) -// https://docs.imagekit.io/features/image-transformations/image-enhancement-and-color-manipulation#gradient-e-gradient - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/sample_image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'effectGradient' => 'from-red_to-white', - ] - ], - ] -); - -echo "\n\n"; -echo "5. Gradient image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; \ No newline at end of file diff --git a/sample/url_generation/index.php b/sample/url_generation/index.php deleted file mode 100644 index bf586543..00000000 --- a/sample/url_generation/index.php +++ /dev/null @@ -1,11 +0,0 @@ -url( - [ - 'path' => '/default-image.jpg', - ] -); - -echo "\n\n"; -echo "1. URL for Image with relative path: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// URL for Image with relative path and custom URL Endpoint - -$imageURL = $imageKit->url( - [ - 'urlEndpoint' => $url_end_point . '/sample-folder', - 'path' => '/default-image.jpg', - ] -); - - -echo "\n\n"; -echo "2. URL for Image with relative path and Custom URL Endpoint: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// URL for Image with absolute url - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/test/default-image.jpg' - ] -); - -echo "\n\n"; -echo "3. URL for Image with Absolute URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Resizing Images - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - ], - ], - ] -); - -echo "\n\n"; -echo "4. Resized Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Pad resize crop strategy (cm-pad_resize) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#pad-resize-crop-strategy-cm-pad_resize - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'cropMode' => 'pad_resize', - 'background' => 'F3F3F3' - ], - ], - ] -); - -echo "\n\n"; -echo "5. Pad Resize Crop Strategy Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Pad resize crop strategy with Focus (fo) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#pad-resize-crop-strategy-cm-pad_resize -// More on 'fo' - https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#focus-fo - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'cropMode' => 'pad_resize', - 'background' => 'D3D3D3', - 'focus' => 'left', - ], - ], - ] -); - -echo "\n\n"; -echo "6. Pad Resize Crop Strategy with Focus-Left Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Forced crop strategy (c-force) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#forced-crop-strategy-c-force - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'crop' => 'force', - 'background' => 'F3F3F3', - ], - ], - ] -); - -echo "\n\n"; -echo "7. Forced Crop Strategy Strategy Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Max-size cropping strategy (c-at_max) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#max-size-cropping-strategy-c-at_max - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'crop' => 'at_max', - ], - ], - ] -); - -echo "\n\n"; -echo "8. Max-size cropping strategy Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Min-size cropping strategy (c-at_least) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#min-size-cropping-strategy-c-at_least - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'crop' => 'at_least', - ], - ], - ] -); - -echo "\n\n"; -echo "9. Min-size cropping strategy Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Maintain ratio crop strategy c-maintain_ratio (center-top) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#maintain-ratio-crop-strategy-c-maintain_ratio - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'crop' => 'maintain_ratio', - ], - ], - ] -); - -echo "\n\n"; -echo "10. Maintain ratio cropping strategy (center-top) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Maintain ratio crop strategy with fo-custom -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#maintain-ratio-crop-strategy-c-maintain_ratio - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/img/bike-image.jpeg', - 'transformation' => [ - [ - 'height' => '300', - 'width' => '400', - 'focus' => 'custom', - ], - ], - ] -); - -echo "\n\n"; -echo "11. Maintain ratio cropping strategy with fo-custom Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Extract crop strategy cm-extract (default center extract) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#extract-crop-strategy-cm-extract - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'extract', - ], - ], - ] -); - -echo "\n\n"; -echo "12. Extract crop strategy (default center extract) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Extract crop strategy cm-extract (relative focus) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#extract-crop-strategy-cm-extract - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'extract', - 'focus' => 'bottom_right', - ], - ], - ] -); - -echo "\n\n"; -echo "13. Extract crop strategy (relative focus) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Extract crop strategy cm-extract (focus with x,y coordinates) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#examples-focus-using-cropped-image-coordinates - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'extract', - 'x' => '100', - 'y' => '300', - ], - ], - ] -); - -echo "\n\n"; -echo "14. Extract crop strategy (Focus with X,Y Coordinates) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Extract crop strategy cm-extract (focus using xc,yc center coordinates) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#examples-focus-using-cropped-image-coordinates - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'extract', - 'xc' => '100', - 'yc' => '300', - ], - ], - ] -); - -echo "\n\n"; -echo "15. Extract crop strategy (Focus using center Coordinates XC, YC) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Extract crop strategy cm-extract (focus with custom coordinates) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#example-focus-using-custom-coordinates - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/img/bike-image.jpeg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'extract', - 'focus' => 'custom' - ], - ], - ] -); - -echo "\n\n"; -echo "16. Extract crop strategy (Focus using custom coordinates) Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Pad extract crop strategy (cm-pad_extract) -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#pad-extract-crop-strategy-cm-pad_extract - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '200', - 'height' => '200', - 'cropMode' => 'pad_extract', - 'background' => 'F3F3F3', - ], - ], - ] -); - -echo "\n\n"; -echo "17. Pad extract crop strategy Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Quality manipulation - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'quality' => '40', - ], - ], - ] -); - -echo "\n\n"; -echo "18. Quality Manipulated Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Blur Image - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'blur' => '40', // 1-100 - ], - ], - ] -); - -echo "\n\n"; -echo "19. Blur Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Grayscale Image (e-grayscale) - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'effectGray' => '', - ], - ], - ] -); - -echo "\n\n"; -echo "20. Grayscale Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Trim edges - -$imageURL = $imageKit->url( - [ - 'src' => 'https://ik.imagekit.io/demo/img/trim_example_BkgQVu7oX.png', - 'transformation' => [ - [ - 'trim' => 'true', // true|Number - ], - ], - ] -); - -echo "\n\n"; -echo "21. Trim edges Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - - -// Bordered Image -// https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations#border-b - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'border' => '10_FF0000', // width_hexcolor - ], - ], - ] -); - -echo "\n\n"; -echo "22. Bordered Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Rotate Image - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'rotate' => '180', // degrees - ], - ], - ] -); - -echo "\n\n"; -echo "23. Rotated Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Radius - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - // 'radius' => '100', - 'radius' => 'max', - ], - ], - ] -); - -echo "\n\n"; -echo "24. Radius Applied Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Background color - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '1200', - 'height' => '1200', - 'cropMode' => 'pad_extract', - 'background' => '272B38', - ], - ], - ] -); - -echo "\n\n"; -echo "25. Background color Applied Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; - -// Download Image - -$imageURL = $imageKit->url( - [ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'width' => '1200', - 'height' => '1200', - 'cropMode' => 'pad_extract', - 'background' => '272B38', - ], - ], - 'queryParameters' => [ - 'ik-attachment' => 'true' - ] - ] -); - -echo "\n\n"; -echo "26. Download Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; diff --git a/sample/url_generation/signed_url.php b/sample/url_generation/signed_url.php deleted file mode 100644 index 896ebf45..00000000 --- a/sample/url_generation/signed_url.php +++ /dev/null @@ -1,27 +0,0 @@ -url([ - "path" => "/default-image.jpg", - "queryParameters" => - [ - "v" => "123" - ], - "transformation" => [ - [ - "height" => "300", - "width" => "400" - ] - ], - "signed" => true, - "expireSeconds" => 300, // 300 seconds -]); - -echo "\n\n"; -echo "Singed Image URL: \n"; -echo "\033[01;32m$imageURL\033[0m"; -echo "\n"; diff --git a/sample/utility/index.php b/sample/utility/index.php deleted file mode 100644 index bbd8cea6..00000000 --- a/sample/utility/index.php +++ /dev/null @@ -1,26 +0,0 @@ -getAuthenticationParameters($token = "", $expire = 0); - -echo "\n\n"; -echo "1. Authentication parameter generation: \n"; -echo "\033[01;32m".print_r($authenticationParameters,true)."\033[0m"; -echo "\n"; - -// Distance calculation between two pHash values -$firstHash='f06830ca9f1e3e90'; -$secondHash='f06830ca9f1e3e90'; -$pHashDistance = $imageKit->pHashDistance($firstHash ,$secondHash); - -echo "\n\n"; -echo "2. Distance calculation between two pHash values: \n"; -echo "\033[01;32m".print_r($pHashDistance,true)."\033[0m"; -echo "\n"; - diff --git a/scripts/bootstrap b/scripts/bootstrap new file mode 100755 index 00000000..0010226e --- /dev/null +++ b/scripts/bootstrap @@ -0,0 +1,8 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Running composer install" +exec -- composer install --no-interaction diff --git a/scripts/clean b/scripts/clean new file mode 100755 index 00000000..5d9a765b --- /dev/null +++ b/scripts/clean @@ -0,0 +1,8 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Cleaning up..." +exec -- rm -fr -- ./vendor/ ./.php-cs-fixer.cache diff --git a/scripts/format b/scripts/format new file mode 100755 index 00000000..8e633516 --- /dev/null +++ b/scripts/format @@ -0,0 +1,8 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Running php-cs-fixer" +exec -- ./vendor/bin/php-cs-fixer fix diff --git a/scripts/lint b/scripts/lint new file mode 100755 index 00000000..6d629c28 --- /dev/null +++ b/scripts/lint @@ -0,0 +1,8 @@ +#!/usr/bin/env bash + +set -e + +cd -- "$(dirname -- "$0")/.." + +echo "==> Running PHPStan" +exec -- ./vendor/bin/phpstan analyse --memory-limit=1G diff --git a/scripts/mock b/scripts/mock new file mode 100755 index 00000000..0b28f6ea --- /dev/null +++ b/scripts/mock @@ -0,0 +1,41 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +if [[ -n "$1" && "$1" != '--'* ]]; then + URL="$1" + shift +else + URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)" +fi + +# Check if the URL is empty +if [ -z "$URL" ]; then + echo "Error: No OpenAPI spec path/url provided or found in .stats.yml" + exit 1 +fi + +echo "==> Starting mock server with URL ${URL}" + +# Run prism mock on the given spec +if [ "$1" == "--daemon" ]; then + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log & + + # Wait for server to come online + echo -n "Waiting for server" + while ! grep -q "✖ fatal\|Prism is listening" ".prism.log" ; do + echo -n "." + sleep 0.1 + done + + if grep -q "✖ fatal" ".prism.log"; then + cat .prism.log + exit 1 + fi + + echo +else + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" +fi diff --git a/scripts/test b/scripts/test new file mode 100755 index 00000000..a8dc7cd3 --- /dev/null +++ b/scripts/test @@ -0,0 +1,55 @@ +#!/usr/bin/env bash + +set -e + +cd "$(dirname "$0")/.." + +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[0;33m' +NC='\033[0m' # No Color + +function prism_is_running() { + curl --silent "http://localhost:4010" > /dev/null 2>&1 +} + +kill_server_on_port() { + pids=$(lsof -t -i tcp:"$1" || echo "") + if [ "$pids" != "" ]; then + kill "$pids" + echo "Stopped $pids." + fi +} + +function is_overriding_api_base_url() { + [ -n "$TEST_API_BASE_URL" ] +} + +if ! is_overriding_api_base_url && ! prism_is_running; then + # When we exit this script, make sure to kill the background mock server process + trap 'kill_server_on_port 4010' EXIT + + # Start the dev server + ./scripts/mock --daemon +fi + +if is_overriding_api_base_url; then + echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}" + echo +elif ! prism_is_running; then + echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server" + echo -e "running against your OpenAPI spec." + echo + echo -e "To run the server, pass in the path or url of your OpenAPI" + echo -e "spec to the prism command:" + echo + echo -e " \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}" + echo + + exit 1 +else + echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}" + echo +fi + +exec -- ./vendor/bin/pest --colors=always diff --git a/src/Accounts/Origins/OriginCreateParams.php b/src/Accounts/Origins/OriginCreateParams.php new file mode 100644 index 00000000..1ba42b68 --- /dev/null +++ b/src/Accounts/Origins/OriginCreateParams.php @@ -0,0 +1,87 @@ +create + * + * @phpstan-type origin_create_params = array{ + * origin: S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim, + * } + */ +final class OriginCreateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Schema for origin request resources. + */ + #[Api(union: OriginRequest::class)] + public S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin; + + /** + * `new OriginCreateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * OriginCreateParams::with(origin: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new OriginCreateParams)->withOrigin(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + ): self { + $obj = new self; + + $obj->origin = $origin; + + return $obj; + } + + /** + * Schema for origin request resources. + */ + public function withOrigin( + S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + ): self { + $obj = clone $this; + $obj->origin = $origin; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest.php b/src/Accounts/Origins/OriginRequest.php new file mode 100644 index 00000000..93fcf986 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest.php @@ -0,0 +1,48 @@ +|array + */ + public static function variants(): array + { + return [ + 'S3' => S3::class, + 'S3_COMPATIBLE' => S3Compatible::class, + 'CLOUDINARY_BACKUP' => CloudinaryBackup::class, + 'WEB_FOLDER' => WebFolder::class, + 'WEB_PROXY' => WebProxy::class, + 'GCS' => Gcs::class, + 'AZURE_BLOB' => AzureBlob::class, + 'AKENEO_PIM' => AkeneoPim::class, + ]; + } +} diff --git a/src/Accounts/Origins/OriginRequest/AkeneoPim.php b/src/Accounts/Origins/OriginRequest/AkeneoPim.php new file mode 100644 index 00000000..9e48f720 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/AkeneoPim.php @@ -0,0 +1,231 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKENEO_PIM'; + + /** + * Akeneo instance base URL. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Akeneo API client ID. + */ + #[Api('clientId')] + public string $clientID; + + /** + * Akeneo API client secret. + */ + #[Api] + public string $clientSecret; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Akeneo API password. + */ + #[Api] + public string $password; + + /** + * Akeneo API username. + */ + #[Api] + public string $username; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * `new AkeneoPim()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AkeneoPim::with( + * baseURL: ..., + * clientID: ..., + * clientSecret: ..., + * name: ..., + * password: ..., + * username: ..., + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AkeneoPim) + * ->withBaseURL(...) + * ->withClientID(...) + * ->withClientSecret(...) + * ->withName(...) + * ->withPassword(...) + * ->withUsername(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $baseURL, + string $clientID, + string $clientSecret, + string $name, + string $password, + string $username, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->baseURL = $baseURL; + $obj->clientID = $clientID; + $obj->clientSecret = $clientSecret; + $obj->name = $name; + $obj->password = $password; + $obj->username = $username; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Akeneo instance base URL. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Akeneo API client ID. + */ + public function withClientID(string $clientID): self + { + $obj = clone $this; + $obj->clientID = $clientID; + + return $obj; + } + + /** + * Akeneo API client secret. + */ + public function withClientSecret(string $clientSecret): self + { + $obj = clone $this; + $obj->clientSecret = $clientSecret; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Akeneo API password. + */ + public function withPassword(string $password): self + { + $obj = clone $this; + $obj->password = $password; + + return $obj; + } + + /** + * Akeneo API username. + */ + public function withUsername(string $username): self + { + $obj = clone $this; + $obj->username = $username; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/AzureBlob.php b/src/Accounts/Origins/OriginRequest/AzureBlob.php new file mode 100644 index 00000000..822f1d72 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/AzureBlob.php @@ -0,0 +1,178 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AZURE_BLOB'; + + #[Api] + public string $accountName; + + #[Api] + public string $container; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + #[Api] + public string $sasToken; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + #[Api(optional: true)] + public ?string $prefix; + + /** + * `new AzureBlob()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AzureBlob::with(accountName: ..., container: ..., name: ..., sasToken: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AzureBlob) + * ->withAccountName(...) + * ->withContainer(...) + * ->withName(...) + * ->withSasToken(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $accountName, + string $container, + string $name, + string $sasToken, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ): self { + $obj = new self; + + $obj->accountName = $accountName; + $obj->container = $container; + $obj->name = $name; + $obj->sasToken = $sasToken; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + + return $obj; + } + + public function withAccountName(string $accountName): self + { + $obj = clone $this; + $obj->accountName = $accountName; + + return $obj; + } + + public function withContainer(string $container): self + { + $obj = clone $this; + $obj->container = $container; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + public function withSasToken(string $sasToken): self + { + $obj = clone $this; + $obj->sasToken = $sasToken; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php b/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php new file mode 100644 index 00000000..b7c0652e --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php @@ -0,0 +1,202 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY_BACKUP'; + + /** + * Access key for the bucket. + */ + #[Api] + public string $accessKey; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Secret key for the bucket. + */ + #[Api] + public string $secretKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * Path prefix inside the bucket. + */ + #[Api(optional: true)] + public ?string $prefix; + + /** + * `new CloudinaryBackup()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * CloudinaryBackup::with(accessKey: ..., bucket: ..., name: ..., secretKey: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new CloudinaryBackup) + * ->withAccessKey(...) + * ->withBucket(...) + * ->withName(...) + * ->withSecretKey(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $accessKey, + string $bucket, + string $name, + string $secretKey, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ): self { + $obj = new self; + + $obj->accessKey = $accessKey; + $obj->bucket = $bucket; + $obj->name = $name; + $obj->secretKey = $secretKey; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + + return $obj; + } + + /** + * Access key for the bucket. + */ + public function withAccessKey(string $accessKey): self + { + $obj = clone $this; + $obj->accessKey = $accessKey; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Secret key for the bucket. + */ + public function withSecretKey(string $secretKey): self + { + $obj = clone $this; + $obj->secretKey = $secretKey; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/Gcs.php b/src/Accounts/Origins/OriginRequest/Gcs.php new file mode 100644 index 00000000..7ce89f65 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/Gcs.php @@ -0,0 +1,178 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'GCS'; + + #[Api] + public string $bucket; + + #[Api] + public string $clientEmail; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + #[Api] + public string $privateKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + #[Api(optional: true)] + public ?string $prefix; + + /** + * `new Gcs()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Gcs::with(bucket: ..., clientEmail: ..., name: ..., privateKey: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Gcs) + * ->withBucket(...) + * ->withClientEmail(...) + * ->withName(...) + * ->withPrivateKey(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $bucket, + string $clientEmail, + string $name, + string $privateKey, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ): self { + $obj = new self; + + $obj->bucket = $bucket; + $obj->clientEmail = $clientEmail; + $obj->name = $name; + $obj->privateKey = $privateKey; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + + return $obj; + } + + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + public function withClientEmail(string $clientEmail): self + { + $obj = clone $this; + $obj->clientEmail = $clientEmail; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + public function withPrivateKey(string $privateKey): self + { + $obj = clone $this; + $obj->privateKey = $privateKey; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/S3.php b/src/Accounts/Origins/OriginRequest/S3.php new file mode 100644 index 00000000..4f2b45ac --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/S3.php @@ -0,0 +1,198 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'S3'; + + /** + * Access key for the bucket. + */ + #[Api] + public string $accessKey; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Secret key for the bucket. + */ + #[Api] + public string $secretKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * Path prefix inside the bucket. + */ + #[Api(optional: true)] + public ?string $prefix; + + /** + * `new S3()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * S3::with(accessKey: ..., bucket: ..., name: ..., secretKey: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new S3)->withAccessKey(...)->withBucket(...)->withName(...)->withSecretKey(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $accessKey, + string $bucket, + string $name, + string $secretKey, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ): self { + $obj = new self; + + $obj->accessKey = $accessKey; + $obj->bucket = $bucket; + $obj->name = $name; + $obj->secretKey = $secretKey; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + + return $obj; + } + + /** + * Access key for the bucket. + */ + public function withAccessKey(string $accessKey): self + { + $obj = clone $this; + $obj->accessKey = $accessKey; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Secret key for the bucket. + */ + public function withSecretKey(string $secretKey): self + { + $obj = clone $this; + $obj->secretKey = $secretKey; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/S3Compatible.php b/src/Accounts/Origins/OriginRequest/S3Compatible.php new file mode 100644 index 00000000..d0b9966e --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/S3Compatible.php @@ -0,0 +1,245 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'S3_COMPATIBLE'; + + /** + * Access key for the bucket. + */ + #[Api] + public string $accessKey; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Custom S3-compatible endpoint. + */ + #[Api] + public string $endpoint; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Secret key for the bucket. + */ + #[Api] + public string $secretKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * Path prefix inside the bucket. + */ + #[Api(optional: true)] + public ?string $prefix; + + /** + * Use path-style S3 URLs? + */ + #[Api(optional: true)] + public ?bool $s3ForcePathStyle; + + /** + * `new S3Compatible()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * S3Compatible::with( + * accessKey: ..., bucket: ..., endpoint: ..., name: ..., secretKey: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new S3Compatible) + * ->withAccessKey(...) + * ->withBucket(...) + * ->withEndpoint(...) + * ->withName(...) + * ->withSecretKey(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $accessKey, + string $bucket, + string $endpoint, + string $name, + string $secretKey, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ?bool $s3ForcePathStyle = null, + ): self { + $obj = new self; + + $obj->accessKey = $accessKey; + $obj->bucket = $bucket; + $obj->endpoint = $endpoint; + $obj->name = $name; + $obj->secretKey = $secretKey; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + null !== $s3ForcePathStyle && $obj->s3ForcePathStyle = $s3ForcePathStyle; + + return $obj; + } + + /** + * Access key for the bucket. + */ + public function withAccessKey(string $accessKey): self + { + $obj = clone $this; + $obj->accessKey = $accessKey; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Custom S3-compatible endpoint. + */ + public function withEndpoint(string $endpoint): self + { + $obj = clone $this; + $obj->endpoint = $endpoint; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Secret key for the bucket. + */ + public function withSecretKey(string $secretKey): self + { + $obj = clone $this; + $obj->secretKey = $secretKey; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * Use path-style S3 URLs? + */ + public function withS3ForcePathStyle(bool $s3ForcePathStyle): self + { + $obj = clone $this; + $obj->s3ForcePathStyle = $s3ForcePathStyle; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/WebFolder.php b/src/Accounts/Origins/OriginRequest/WebFolder.php new file mode 100644 index 00000000..4c634e60 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/WebFolder.php @@ -0,0 +1,159 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'WEB_FOLDER'; + + /** + * Root URL for the web folder origin. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Forward the Host header to origin? + */ + #[Api(optional: true)] + public ?bool $forwardHostHeaderToOrigin; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * `new WebFolder()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * WebFolder::with(baseURL: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new WebFolder)->withBaseURL(...)->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $baseURL, + string $name, + ?string $baseURLForCanonicalHeader = null, + ?bool $forwardHostHeaderToOrigin = null, + ?bool $includeCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->baseURL = $baseURL; + $obj->name = $name; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $forwardHostHeaderToOrigin && $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Root URL for the web folder origin. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Forward the Host header to origin? + */ + public function withForwardHostHeaderToOrigin( + bool $forwardHostHeaderToOrigin + ): self { + $obj = clone $this; + $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginRequest/WebProxy.php b/src/Accounts/Origins/OriginRequest/WebProxy.php new file mode 100644 index 00000000..2b6404b7 --- /dev/null +++ b/src/Accounts/Origins/OriginRequest/WebProxy.php @@ -0,0 +1,118 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'WEB_PROXY'; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + /** + * `new WebProxy()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * WebProxy::with(name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new WebProxy)->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $name, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->name = $name; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse.php b/src/Accounts/Origins/OriginResponse.php new file mode 100644 index 00000000..7c9f0050 --- /dev/null +++ b/src/Accounts/Origins/OriginResponse.php @@ -0,0 +1,48 @@ +|array + */ + public static function variants(): array + { + return [ + 'S3' => S3::class, + 'S3_COMPATIBLE' => S3Compatible::class, + 'CLOUDINARY_BACKUP' => CloudinaryBackup::class, + 'WEB_FOLDER' => WebFolder::class, + 'WEB_PROXY' => WebProxy::class, + 'GCS' => Gcs::class, + 'AZURE_BLOB' => AzureBlob::class, + 'AKENEO_PIM' => AkeneoPim::class, + ]; + } +} diff --git a/src/Accounts/Origins/OriginResponse/AkeneoPim.php b/src/Accounts/Origins/OriginResponse/AkeneoPim.php new file mode 100644 index 00000000..2459a81d --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/AkeneoPim.php @@ -0,0 +1,162 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKENEO_PIM'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * Akeneo instance base URL. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new AkeneoPim()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AkeneoPim::with(id: ..., baseURL: ..., includeCanonicalHeader: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AkeneoPim) + * ->withID(...) + * ->withBaseURL(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $baseURL, + string $name, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->baseURL = $baseURL; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Akeneo instance base URL. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/AzureBlob.php b/src/Accounts/Origins/OriginResponse/AzureBlob.php new file mode 100644 index 00000000..63c2a2db --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/AzureBlob.php @@ -0,0 +1,193 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AZURE_BLOB'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + #[Api] + public string $accountName; + + #[Api] + public string $container; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + #[Api] + public string $prefix; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new AzureBlob()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AzureBlob::with( + * id: ..., + * accountName: ..., + * container: ..., + * includeCanonicalHeader: ..., + * name: ..., + * prefix: ..., + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AzureBlob) + * ->withID(...) + * ->withAccountName(...) + * ->withContainer(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ->withPrefix(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $accountName, + string $container, + string $name, + string $prefix, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->accountName = $accountName; + $obj->container = $container; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + $obj->prefix = $prefix; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + public function withAccountName(string $accountName): self + { + $obj = clone $this; + $obj->accountName = $accountName; + + return $obj; + } + + public function withContainer(string $container): self + { + $obj = clone $this; + $obj->container = $container; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php b/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php new file mode 100644 index 00000000..e721eb2a --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php @@ -0,0 +1,185 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY_BACKUP'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Path prefix inside the bucket. + */ + #[Api] + public string $prefix; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new CloudinaryBackup()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * CloudinaryBackup::with( + * id: ..., bucket: ..., includeCanonicalHeader: ..., name: ..., prefix: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new CloudinaryBackup) + * ->withID(...) + * ->withBucket(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ->withPrefix(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $bucket, + string $name, + string $prefix, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->bucket = $bucket; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + $obj->prefix = $prefix; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/Gcs.php b/src/Accounts/Origins/OriginResponse/Gcs.php new file mode 100644 index 00000000..bd7bc41e --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/Gcs.php @@ -0,0 +1,193 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'GCS'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + #[Api] + public string $bucket; + + #[Api] + public string $clientEmail; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + #[Api] + public string $prefix; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new Gcs()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Gcs::with( + * id: ..., + * bucket: ..., + * clientEmail: ..., + * includeCanonicalHeader: ..., + * name: ..., + * prefix: ..., + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Gcs) + * ->withID(...) + * ->withBucket(...) + * ->withClientEmail(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ->withPrefix(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $bucket, + string $clientEmail, + string $name, + string $prefix, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->bucket = $bucket; + $obj->clientEmail = $clientEmail; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + $obj->prefix = $prefix; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + public function withClientEmail(string $clientEmail): self + { + $obj = clone $this; + $obj->clientEmail = $clientEmail; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/S3.php b/src/Accounts/Origins/OriginResponse/S3.php new file mode 100644 index 00000000..48050fed --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/S3.php @@ -0,0 +1,185 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'S3'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Path prefix inside the bucket. + */ + #[Api] + public string $prefix; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new S3()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * S3::with( + * id: ..., bucket: ..., includeCanonicalHeader: ..., name: ..., prefix: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new S3) + * ->withID(...) + * ->withBucket(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ->withPrefix(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $bucket, + string $name, + string $prefix, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->bucket = $bucket; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + $obj->prefix = $prefix; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/S3Compatible.php b/src/Accounts/Origins/OriginResponse/S3Compatible.php new file mode 100644 index 00000000..74d8e0d6 --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/S3Compatible.php @@ -0,0 +1,233 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'S3_COMPATIBLE'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * S3 bucket name. + */ + #[Api] + public string $bucket; + + /** + * Custom S3-compatible endpoint. + */ + #[Api] + public string $endpoint; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Path prefix inside the bucket. + */ + #[Api] + public string $prefix; + + /** + * Use path-style S3 URLs? + */ + #[Api] + public bool $s3ForcePathStyle; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new S3Compatible()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * S3Compatible::with( + * id: ..., + * bucket: ..., + * endpoint: ..., + * includeCanonicalHeader: ..., + * name: ..., + * prefix: ..., + * s3ForcePathStyle: ..., + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new S3Compatible) + * ->withID(...) + * ->withBucket(...) + * ->withEndpoint(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ->withPrefix(...) + * ->withS3ForcePathStyle(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $bucket, + string $endpoint, + string $name, + string $prefix, + bool $includeCanonicalHeader = false, + bool $s3ForcePathStyle = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->bucket = $bucket; + $obj->endpoint = $endpoint; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + $obj->prefix = $prefix; + $obj->s3ForcePathStyle = $s3ForcePathStyle; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * S3 bucket name. + */ + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Custom S3-compatible endpoint. + */ + public function withEndpoint(string $endpoint): self + { + $obj = clone $this; + $obj->endpoint = $endpoint; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Path prefix inside the bucket. + */ + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * Use path-style S3 URLs? + */ + public function withS3ForcePathStyle(bool $s3ForcePathStyle): self + { + $obj = clone $this; + $obj->s3ForcePathStyle = $s3ForcePathStyle; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/WebFolder.php b/src/Accounts/Origins/OriginResponse/WebFolder.php new file mode 100644 index 00000000..97d22763 --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/WebFolder.php @@ -0,0 +1,190 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'WEB_FOLDER'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * Root URL for the web folder origin. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Forward the Host header to origin? + */ + #[Api] + public bool $forwardHostHeaderToOrigin; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new WebFolder()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * WebFolder::with( + * id: ..., + * baseURL: ..., + * forwardHostHeaderToOrigin: ..., + * includeCanonicalHeader: ..., + * name: ..., + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new WebFolder) + * ->withID(...) + * ->withBaseURL(...) + * ->withForwardHostHeaderToOrigin(...) + * ->withIncludeCanonicalHeader(...) + * ->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $baseURL, + string $name, + bool $forwardHostHeaderToOrigin = false, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->baseURL = $baseURL; + $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Root URL for the web folder origin. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Forward the Host header to origin? + */ + public function withForwardHostHeaderToOrigin( + bool $forwardHostHeaderToOrigin + ): self { + $obj = clone $this; + $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginResponse/WebProxy.php b/src/Accounts/Origins/OriginResponse/WebProxy.php new file mode 100644 index 00000000..3a302c3b --- /dev/null +++ b/src/Accounts/Origins/OriginResponse/WebProxy.php @@ -0,0 +1,138 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'WEB_PROXY'; + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + #[Api] + public string $id; + + /** + * Whether to send a Canonical header. + */ + #[Api] + public bool $includeCanonicalHeader; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * `new WebProxy()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * WebProxy::with(id: ..., includeCanonicalHeader: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new WebProxy)->withID(...)->withIncludeCanonicalHeader(...)->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $name, + bool $includeCanonicalHeader = false, + ?string $baseURLForCanonicalHeader = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + $obj->name = $name; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Unique identifier for the origin. This is generated by ImageKit when you create a new origin. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL used in the Canonical header (if enabled). + */ + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader + ): self { + $obj = clone $this; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } +} diff --git a/src/Accounts/Origins/OriginUpdateParams.php b/src/Accounts/Origins/OriginUpdateParams.php new file mode 100644 index 00000000..bbcec186 --- /dev/null +++ b/src/Accounts/Origins/OriginUpdateParams.php @@ -0,0 +1,87 @@ +update + * + * @phpstan-type origin_update_params = array{ + * origin: S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim, + * } + */ +final class OriginUpdateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Schema for origin request resources. + */ + #[Api(union: OriginRequest::class)] + public S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin; + + /** + * `new OriginUpdateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * OriginUpdateParams::with(origin: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new OriginUpdateParams)->withOrigin(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + ): self { + $obj = new self; + + $obj->origin = $origin; + + return $obj; + } + + /** + * Schema for origin request resources. + */ + public function withOrigin( + S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + ): self { + $obj = clone $this; + $obj->origin = $origin; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams.php new file mode 100644 index 00000000..9afd5302 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams.php @@ -0,0 +1,149 @@ +create + * + * @phpstan-type url_endpoint_create_params = array{ + * description: string, + * origins?: list, + * urlPrefix?: string, + * urlRewriter?: Cloudinary|Imgix|Akamai, + * } + */ +final class URLEndpointCreateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Description of the URL endpoint. + */ + #[Api] + public string $description; + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @var list|null $origins + */ + #[Api(list: 'string', optional: true)] + public ?array $origins; + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + #[Api(optional: true)] + public ?string $urlPrefix; + + /** + * Configuration for third-party URL rewriting. + */ + #[Api(union: URLRewriter::class, optional: true)] + public Cloudinary|Imgix|Akamai|null $urlRewriter; + + /** + * `new URLEndpointCreateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * URLEndpointCreateParams::with(description: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new URLEndpointCreateParams)->withDescription(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $origins + */ + public static function with( + string $description, + ?array $origins = null, + ?string $urlPrefix = null, + Cloudinary|Imgix|Akamai|null $urlRewriter = null, + ): self { + $obj = new self; + + $obj->description = $description; + + null !== $origins && $obj->origins = $origins; + null !== $urlPrefix && $obj->urlPrefix = $urlPrefix; + null !== $urlRewriter && $obj->urlRewriter = $urlRewriter; + + return $obj; + } + + /** + * Description of the URL endpoint. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @param list $origins + */ + public function withOrigins(array $origins): self + { + $obj = clone $this; + $obj->origins = $origins; + + return $obj; + } + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + public function withURLPrefix(string $urlPrefix): self + { + $obj = clone $this; + $obj->urlPrefix = $urlPrefix; + + return $obj; + } + + /** + * Configuration for third-party URL rewriting. + */ + public function withURLRewriter(Cloudinary|Imgix|Akamai $urlRewriter): self + { + $obj = clone $this; + $obj->urlRewriter = $urlRewriter; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter.php new file mode 100644 index 00000000..22264f1e --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter.php @@ -0,0 +1,38 @@ +|array + */ + public static function variants(): array + { + return [ + 'CLOUDINARY' => Cloudinary::class, + 'IMGIX' => Imgix::class, + 'AKAMAI' => Akamai::class, + ]; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Akamai.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Akamai.php new file mode 100644 index 00000000..ea43417a --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Akamai.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKAMAI'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php new file mode 100644 index 00000000..48561fe6 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php @@ -0,0 +1,60 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY'; + + /** + * Whether to preserve `/` in the rewritten URL. + */ + #[Api(optional: true)] + public ?bool $preserveAssetDeliveryTypes; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?bool $preserveAssetDeliveryTypes = null): self + { + $obj = new self; + + null !== $preserveAssetDeliveryTypes && $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } + + /** + * Whether to preserve `/` in the rewritten URL. + */ + public function withPreserveAssetDeliveryTypes( + bool $preserveAssetDeliveryTypes + ): self { + $obj = clone $this; + $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Imgix.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Imgix.php new file mode 100644 index 00000000..8ad00879 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Imgix.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'IMGIX'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest.php b/src/Accounts/URLEndpoints/URLEndpointRequest.php new file mode 100644 index 00000000..dd4177a6 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointRequest.php @@ -0,0 +1,144 @@ +|null, + * urlPrefix?: string|null, + * urlRewriter?: null|Cloudinary|Imgix|Akamai, + * } + */ +final class URLEndpointRequest implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Description of the URL endpoint. + */ + #[Api] + public string $description; + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @var list|null $origins + */ + #[Api(list: 'string', optional: true)] + public ?array $origins; + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + #[Api(optional: true)] + public ?string $urlPrefix; + + /** + * Configuration for third-party URL rewriting. + */ + #[Api(union: URLRewriter::class, optional: true)] + public Cloudinary|Imgix|Akamai|null $urlRewriter; + + /** + * `new URLEndpointRequest()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * URLEndpointRequest::with(description: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new URLEndpointRequest)->withDescription(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $origins + */ + public static function with( + string $description, + ?array $origins = null, + ?string $urlPrefix = null, + Cloudinary|Imgix|Akamai|null $urlRewriter = null, + ): self { + $obj = new self; + + $obj->description = $description; + + null !== $origins && $obj->origins = $origins; + null !== $urlPrefix && $obj->urlPrefix = $urlPrefix; + null !== $urlRewriter && $obj->urlRewriter = $urlRewriter; + + return $obj; + } + + /** + * Description of the URL endpoint. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @param list $origins + */ + public function withOrigins(array $origins): self + { + $obj = clone $this; + $obj->origins = $origins; + + return $obj; + } + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + public function withURLPrefix(string $urlPrefix): self + { + $obj = clone $this; + $obj->urlPrefix = $urlPrefix; + + return $obj; + } + + /** + * Configuration for third-party URL rewriting. + */ + public function withURLRewriter(Cloudinary|Imgix|Akamai $urlRewriter): self + { + $obj = clone $this; + $obj->urlRewriter = $urlRewriter; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter.php b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter.php new file mode 100644 index 00000000..61bbc068 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter.php @@ -0,0 +1,38 @@ +|array + */ + public static function variants(): array + { + return [ + 'CLOUDINARY' => Cloudinary::class, + 'IMGIX' => Imgix::class, + 'AKAMAI' => Akamai::class, + ]; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Akamai.php b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Akamai.php new file mode 100644 index 00000000..dbf4c8d9 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Akamai.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKAMAI'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php new file mode 100644 index 00000000..17f95e0f --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php @@ -0,0 +1,60 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY'; + + /** + * Whether to preserve `/` in the rewritten URL. + */ + #[Api(optional: true)] + public ?bool $preserveAssetDeliveryTypes; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?bool $preserveAssetDeliveryTypes = null): self + { + $obj = new self; + + null !== $preserveAssetDeliveryTypes && $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } + + /** + * Whether to preserve `/` in the rewritten URL. + */ + public function withPreserveAssetDeliveryTypes( + bool $preserveAssetDeliveryTypes + ): self { + $obj = clone $this; + $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Imgix.php b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Imgix.php new file mode 100644 index 00000000..cf77cd8f --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Imgix.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'IMGIX'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse.php b/src/Accounts/URLEndpoints/URLEndpointResponse.php new file mode 100644 index 00000000..6dcecef8 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointResponse.php @@ -0,0 +1,170 @@ +, + * urlPrefix: string, + * urlRewriter?: null|Cloudinary|Imgix|Akamai, + * } + */ +final class URLEndpointResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Unique identifier for the URL-endpoint. This is generated by ImageKit when you create a new URL-endpoint. For the default URL-endpoint, this is always `default`. + */ + #[Api] + public string $id; + + /** + * Description of the URL endpoint. + */ + #[Api] + public string $description; + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @var list $origins + */ + #[Api(list: 'string')] + public array $origins; + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + #[Api] + public string $urlPrefix; + + /** + * Configuration for third-party URL rewriting. + */ + #[Api(union: URLRewriter::class, optional: true)] + public Cloudinary|Imgix|Akamai|null $urlRewriter; + + /** + * `new URLEndpointResponse()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * URLEndpointResponse::with( + * id: ..., description: ..., origins: ..., urlPrefix: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new URLEndpointResponse) + * ->withID(...) + * ->withDescription(...) + * ->withOrigins(...) + * ->withURLPrefix(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $origins + */ + public static function with( + string $id, + string $description, + array $origins = [], + string $urlPrefix = '', + Cloudinary|Imgix|Akamai|null $urlRewriter = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->description = $description; + $obj->origins = $origins; + $obj->urlPrefix = $urlPrefix; + + null !== $urlRewriter && $obj->urlRewriter = $urlRewriter; + + return $obj; + } + + /** + * Unique identifier for the URL-endpoint. This is generated by ImageKit when you create a new URL-endpoint. For the default URL-endpoint, this is always `default`. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Description of the URL endpoint. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @param list $origins + */ + public function withOrigins(array $origins): self + { + $obj = clone $this; + $obj->origins = $origins; + + return $obj; + } + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + public function withURLPrefix(string $urlPrefix): self + { + $obj = clone $this; + $obj->urlPrefix = $urlPrefix; + + return $obj; + } + + /** + * Configuration for third-party URL rewriting. + */ + public function withURLRewriter(Cloudinary|Imgix|Akamai $urlRewriter): self + { + $obj = clone $this; + $obj->urlRewriter = $urlRewriter; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter.php b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter.php new file mode 100644 index 00000000..d91d8404 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter.php @@ -0,0 +1,38 @@ +|array + */ + public static function variants(): array + { + return [ + 'CLOUDINARY' => Cloudinary::class, + 'IMGIX' => Imgix::class, + 'AKAMAI' => Akamai::class, + ]; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Akamai.php b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Akamai.php new file mode 100644 index 00000000..0c4052c4 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Akamai.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKAMAI'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Cloudinary.php new file mode 100644 index 00000000..137c04c0 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Cloudinary.php @@ -0,0 +1,74 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY'; + + /** + * Whether to preserve `/` in the rewritten URL. + */ + #[Api] + public bool $preserveAssetDeliveryTypes; + + /** + * `new Cloudinary()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Cloudinary::with(preserveAssetDeliveryTypes: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Cloudinary)->withPreserveAssetDeliveryTypes(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(bool $preserveAssetDeliveryTypes = false): self + { + $obj = new self; + + $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } + + /** + * Whether to preserve `/` in the rewritten URL. + */ + public function withPreserveAssetDeliveryTypes( + bool $preserveAssetDeliveryTypes + ): self { + $obj = clone $this; + $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Imgix.php b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Imgix.php new file mode 100644 index 00000000..f873ae66 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointResponse/URLRewriter/Imgix.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'IMGIX'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php new file mode 100644 index 00000000..ff6de86b --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php @@ -0,0 +1,149 @@ +update + * + * @phpstan-type url_endpoint_update_params = array{ + * description: string, + * origins?: list, + * urlPrefix?: string, + * urlRewriter?: Cloudinary|Imgix|Akamai, + * } + */ +final class URLEndpointUpdateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Description of the URL endpoint. + */ + #[Api] + public string $description; + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @var list|null $origins + */ + #[Api(list: 'string', optional: true)] + public ?array $origins; + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + #[Api(optional: true)] + public ?string $urlPrefix; + + /** + * Configuration for third-party URL rewriting. + */ + #[Api(union: URLRewriter::class, optional: true)] + public Cloudinary|Imgix|Akamai|null $urlRewriter; + + /** + * `new URLEndpointUpdateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * URLEndpointUpdateParams::with(description: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new URLEndpointUpdateParams)->withDescription(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $origins + */ + public static function with( + string $description, + ?array $origins = null, + ?string $urlPrefix = null, + Cloudinary|Imgix|Akamai|null $urlRewriter = null, + ): self { + $obj = new self; + + $obj->description = $description; + + null !== $origins && $obj->origins = $origins; + null !== $urlPrefix && $obj->urlPrefix = $urlPrefix; + null !== $urlRewriter && $obj->urlRewriter = $urlRewriter; + + return $obj; + } + + /** + * Description of the URL endpoint. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * + * @param list $origins + */ + public function withOrigins(array $origins): self + { + $obj = clone $this; + $obj->origins = $origins; + + return $obj; + } + + /** + * Path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint). + */ + public function withURLPrefix(string $urlPrefix): self + { + $obj = clone $this; + $obj->urlPrefix = $urlPrefix; + + return $obj; + } + + /** + * Configuration for third-party URL rewriting. + */ + public function withURLRewriter(Cloudinary|Imgix|Akamai $urlRewriter): self + { + $obj = clone $this; + $obj->urlRewriter = $urlRewriter; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter.php new file mode 100644 index 00000000..869e9ad8 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter.php @@ -0,0 +1,38 @@ +|array + */ + public static function variants(): array + { + return [ + 'CLOUDINARY' => Cloudinary::class, + 'IMGIX' => Imgix::class, + 'AKAMAI' => Akamai::class, + ]; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Akamai.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Akamai.php new file mode 100644 index 00000000..ade81c92 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Akamai.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'AKAMAI'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php new file mode 100644 index 00000000..74a44ba4 --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php @@ -0,0 +1,60 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'CLOUDINARY'; + + /** + * Whether to preserve `/` in the rewritten URL. + */ + #[Api(optional: true)] + public ?bool $preserveAssetDeliveryTypes; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?bool $preserveAssetDeliveryTypes = null): self + { + $obj = new self; + + null !== $preserveAssetDeliveryTypes && $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } + + /** + * Whether to preserve `/` in the rewritten URL. + */ + public function withPreserveAssetDeliveryTypes( + bool $preserveAssetDeliveryTypes + ): self { + $obj = clone $this; + $obj->preserveAssetDeliveryTypes = $preserveAssetDeliveryTypes; + + return $obj; + } +} diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Imgix.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Imgix.php new file mode 100644 index 00000000..13c3e71f --- /dev/null +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Imgix.php @@ -0,0 +1,36 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'IMGIX'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Accounts/Usage/UsageGetParams.php b/src/Accounts/Usage/UsageGetParams.php new file mode 100644 index 00000000..b2a3c202 --- /dev/null +++ b/src/Accounts/Usage/UsageGetParams.php @@ -0,0 +1,96 @@ +get + * + * @phpstan-type usage_get_params = array{ + * endDate: \DateTimeInterface, startDate: \DateTimeInterface + * } + */ +final class UsageGetParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. The difference between `startDate` and `endDate` should be less than 90 days. + */ + #[Api] + public \DateTimeInterface $endDate; + + /** + * Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. + */ + #[Api] + public \DateTimeInterface $startDate; + + /** + * `new UsageGetParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * UsageGetParams::with(endDate: ..., startDate: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new UsageGetParams)->withEndDate(...)->withStartDate(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + \DateTimeInterface $endDate, + \DateTimeInterface $startDate + ): self { + $obj = new self; + + $obj->endDate = $endDate; + $obj->startDate = $startDate; + + return $obj; + } + + /** + * Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. The difference between `startDate` and `endDate` should be less than 90 days. + */ + public function withEndDate(\DateTimeInterface $endDate): self + { + $obj = clone $this; + $obj->endDate = $endDate; + + return $obj; + } + + /** + * Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. + */ + public function withStartDate(\DateTimeInterface $startDate): self + { + $obj = clone $this; + $obj->startDate = $startDate; + + return $obj; + } +} diff --git a/src/Accounts/Usage/UsageGetResponse.php b/src/Accounts/Usage/UsageGetResponse.php new file mode 100644 index 00000000..02fc093d --- /dev/null +++ b/src/Accounts/Usage/UsageGetResponse.php @@ -0,0 +1,140 @@ + */ + use SdkModel; + + /** + * Amount of bandwidth used in bytes. + */ + #[Api(optional: true)] + public ?int $bandwidthBytes; + + /** + * Number of extension units used. + */ + #[Api(optional: true)] + public ?int $extensionUnitsCount; + + /** + * Storage used by media library in bytes. + */ + #[Api(optional: true)] + public ?int $mediaLibraryStorageBytes; + + /** + * Storage used by the original cache in bytes. + */ + #[Api(optional: true)] + public ?int $originalCacheStorageBytes; + + /** + * Number of video processing units used. + */ + #[Api(optional: true)] + public ?int $videoProcessingUnitsCount; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?int $bandwidthBytes = null, + ?int $extensionUnitsCount = null, + ?int $mediaLibraryStorageBytes = null, + ?int $originalCacheStorageBytes = null, + ?int $videoProcessingUnitsCount = null, + ): self { + $obj = new self; + + null !== $bandwidthBytes && $obj->bandwidthBytes = $bandwidthBytes; + null !== $extensionUnitsCount && $obj->extensionUnitsCount = $extensionUnitsCount; + null !== $mediaLibraryStorageBytes && $obj->mediaLibraryStorageBytes = $mediaLibraryStorageBytes; + null !== $originalCacheStorageBytes && $obj->originalCacheStorageBytes = $originalCacheStorageBytes; + null !== $videoProcessingUnitsCount && $obj->videoProcessingUnitsCount = $videoProcessingUnitsCount; + + return $obj; + } + + /** + * Amount of bandwidth used in bytes. + */ + public function withBandwidthBytes(int $bandwidthBytes): self + { + $obj = clone $this; + $obj->bandwidthBytes = $bandwidthBytes; + + return $obj; + } + + /** + * Number of extension units used. + */ + public function withExtensionUnitsCount(int $extensionUnitsCount): self + { + $obj = clone $this; + $obj->extensionUnitsCount = $extensionUnitsCount; + + return $obj; + } + + /** + * Storage used by media library in bytes. + */ + public function withMediaLibraryStorageBytes( + int $mediaLibraryStorageBytes + ): self { + $obj = clone $this; + $obj->mediaLibraryStorageBytes = $mediaLibraryStorageBytes; + + return $obj; + } + + /** + * Storage used by the original cache in bytes. + */ + public function withOriginalCacheStorageBytes( + int $originalCacheStorageBytes + ): self { + $obj = clone $this; + $obj->originalCacheStorageBytes = $originalCacheStorageBytes; + + return $obj; + } + + /** + * Number of video processing units used. + */ + public function withVideoProcessingUnitsCount( + int $videoProcessingUnitsCount + ): self { + $obj = clone $this; + $obj->videoProcessingUnitsCount = $videoProcessingUnitsCount; + + return $obj; + } +} diff --git a/src/Assets/AssetListParams.php b/src/Assets/AssetListParams.php new file mode 100644 index 00000000..b24fabb4 --- /dev/null +++ b/src/Assets/AssetListParams.php @@ -0,0 +1,242 @@ +list + * + * @phpstan-type asset_list_params = array{ + * fileType?: FileType::*, + * limit?: int, + * path?: string, + * searchQuery?: string, + * skip?: int, + * sort?: Sort::*, + * type?: Type::*, + * } + */ +final class AssetListParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Filter results by file type. + * + * - `all` — include all file types + * - `image` — include only image files + * - `non-image` — include only non-image files (e.g., JS, CSS, video) + * + * @var FileType::*|null $fileType + */ + #[Api(enum: FileType::class, optional: true)] + public ?string $fileType; + + /** + * The maximum number of results to return in response. + */ + #[Api(optional: true)] + public ?int $limit; + + /** + * Folder path if you want to limit the search within a specific folder. For example, `/sales-banner/` will only search in folder sales-banner. + * + * Note : If your use case involves searching within a folder as well as its subfolders, you can use `path` parameter in `searchQuery` with appropriate operator. + * Checkout [Supported parameters](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters) for more information. + */ + #[Api(optional: true)] + public ?string $path; + + /** + * Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + * + * Note : When the searchQuery parameter is present, the following query parameters will have no effect on the result: + * + * 1. `tags` + * 2. `type` + * 3. `name` + * + * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. + */ + #[Api(optional: true)] + public ?string $searchQuery; + + /** + * The number of results to skip before returning results. + */ + #[Api(optional: true)] + public ?int $skip; + + /** + * Sort the results by one of the supported fields in ascending or descending order. + * + * @var Sort::*|null $sort + */ + #[Api(enum: Sort::class, optional: true)] + public ?string $sort; + + /** + * Filter results by asset type. + * + * - `file` — returns only files + * - `file-version` — returns specific file versions + * - `folder` — returns only folders + * - `all` — returns both files and folders (excludes `file-version`) + * + * @var Type::*|null $type + */ + #[Api(enum: Type::class, optional: true)] + public ?string $type; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param FileType::* $fileType + * @param Sort::* $sort + * @param Type::* $type + */ + public static function with( + ?string $fileType = null, + ?int $limit = null, + ?string $path = null, + ?string $searchQuery = null, + ?int $skip = null, + ?string $sort = null, + ?string $type = null, + ): self { + $obj = new self; + + null !== $fileType && $obj->fileType = $fileType; + null !== $limit && $obj->limit = $limit; + null !== $path && $obj->path = $path; + null !== $searchQuery && $obj->searchQuery = $searchQuery; + null !== $skip && $obj->skip = $skip; + null !== $sort && $obj->sort = $sort; + null !== $type && $obj->type = $type; + + return $obj; + } + + /** + * Filter results by file type. + * + * - `all` — include all file types + * - `image` — include only image files + * - `non-image` — include only non-image files (e.g., JS, CSS, video) + * + * @param FileType::* $fileType + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * The maximum number of results to return in response. + */ + public function withLimit(int $limit): self + { + $obj = clone $this; + $obj->limit = $limit; + + return $obj; + } + + /** + * Folder path if you want to limit the search within a specific folder. For example, `/sales-banner/` will only search in folder sales-banner. + * + * Note : If your use case involves searching within a folder as well as its subfolders, you can use `path` parameter in `searchQuery` with appropriate operator. + * Checkout [Supported parameters](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters) for more information. + */ + public function withPath(string $path): self + { + $obj = clone $this; + $obj->path = $path; + + return $obj; + } + + /** + * Query string in a Lucene-like query language e.g. `createdAt > "7d"`. + * + * Note : When the searchQuery parameter is present, the following query parameters will have no effect on the result: + * + * 1. `tags` + * 2. `type` + * 3. `name` + * + * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. + */ + public function withSearchQuery(string $searchQuery): self + { + $obj = clone $this; + $obj->searchQuery = $searchQuery; + + return $obj; + } + + /** + * The number of results to skip before returning results. + */ + public function withSkip(int $skip): self + { + $obj = clone $this; + $obj->skip = $skip; + + return $obj; + } + + /** + * Sort the results by one of the supported fields in ascending or descending order. + * + * @param Sort::* $sort + */ + public function withSort(string $sort): self + { + $obj = clone $this; + $obj->sort = $sort; + + return $obj; + } + + /** + * Filter results by asset type. + * + * - `file` — returns only files + * - `file-version` — returns specific file versions + * - `folder` — returns only folders + * - `all` — returns both files and folders (excludes `file-version`) + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } +} diff --git a/src/Assets/AssetListParams/FileType.php b/src/Assets/AssetListParams/FileType.php new file mode 100644 index 00000000..65c88ef3 --- /dev/null +++ b/src/Assets/AssetListParams/FileType.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return [File::class, 'folder' => Folder::class]; + } +} diff --git a/src/BaseOverlay.php b/src/BaseOverlay.php new file mode 100644 index 00000000..3dd79187 --- /dev/null +++ b/src/BaseOverlay.php @@ -0,0 +1,64 @@ + */ + use SdkModel; + + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null + ): self { + $obj = new self; + + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; + + return $obj; + } + + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams.php b/src/Beta/V2/Files/FileUploadParams.php new file mode 100644 index 00000000..cd83a4c0 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams.php @@ -0,0 +1,571 @@ +upload + * + * @phpstan-type file_upload_params = array{ + * file: string, + * fileName: string, + * token?: string, + * checks?: string, + * customCoordinates?: string, + * customMetadata?: array, + * description?: string, + * extensions?: list, + * folder?: string, + * isPrivateFile?: bool, + * isPublished?: bool, + * overwriteAITags?: bool, + * overwriteCustomMetadata?: bool, + * overwriteFile?: bool, + * overwriteTags?: bool, + * responseFields?: list, + * tags?: list, + * transformation?: Transformation, + * useUniqueFileName?: bool, + * webhookURL?: string, + * } + */ +final class FileUploadParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + */ + #[Api] + public string $file; + + /** + * The name with which the file has to be uploaded. + */ + #[Api] + public string $fileName; + + /** + * This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses it to authenticate and check that the upload request parameters have not been tampered with after the token has been generated. Learn how to create the token on the page below. This field is only required for authentication when uploading a file from the client side. + * + * **Note**: Sending a JWT that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new token. + * + * + * **⚠️Warning**: JWT must be generated on the server-side because it is generated using your account's private API key. This field is required for authentication when uploading a file from the client-side. + */ + #[Api(optional: true)] + public ?string $token; + + /** + * Server-side checks to run on the asset. + * Read more about [Upload API checks](/docs/api-reference/upload-file/upload-file-v2#upload-api-checks). + */ + #[Api(optional: true)] + public ?string $checks; + + /** + * Define an important area in the image. This is only relevant for image type files. + * + * - To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format `x,y,width,height`. For example - `10,10,100,100` + * - Can be used with fo-customtransformation. + * - If this field is not specified and the file is overwritten, then customCoordinates will be removed. + */ + #[Api(optional: true)] + public ?string $customCoordinates; + + /** + * JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * + * @var list|null $extensions + */ + #[Api(list: Extension::class, optional: true)] + public ?array $extensions; + + /** + * The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. + */ + #[Api(optional: true)] + public ?string $folder; + + /** + * Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + */ + #[Api(optional: true)] + public ?bool $overwriteAITags; + + /** + * If the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed. + */ + #[Api(optional: true)] + public ?bool $overwriteCustomMetadata; + + /** + * If `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately. + */ + #[Api(optional: true)] + public ?bool $overwriteFile; + + /** + * If the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed. + */ + #[Api(optional: true)] + public ?bool $overwriteTags; + + /** + * Array of response field keys to include in the API response body. + * + * @var list|null $responseFields + */ + #[Api(list: ResponseField::class, optional: true)] + public ?array $responseFields; + + /** + * Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * + * @var list|null $tags + */ + #[Api(list: 'string', optional: true)] + public ?array $tags; + + /** + * Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + */ + #[Api(optional: true)] + public ?Transformation $transformation; + + /** + * Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + */ + #[Api(optional: true)] + public ?bool $useUniqueFileName; + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + #[Api('webhookUrl', optional: true)] + public ?string $webhookURL; + + /** + * `new FileUploadParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileUploadParams::with(file: ..., fileName: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileUploadParams)->withFile(...)->withFileName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $customMetadata + * @param list $extensions + * @param list $responseFields + * @param list $tags + */ + public static function with( + string $file, + string $fileName, + ?string $token = null, + ?string $checks = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?array $extensions = null, + ?string $folder = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?bool $overwriteAITags = null, + ?bool $overwriteCustomMetadata = null, + ?bool $overwriteFile = null, + ?bool $overwriteTags = null, + ?array $responseFields = null, + ?array $tags = null, + ?Transformation $transformation = null, + ?bool $useUniqueFileName = null, + ?string $webhookURL = null, + ): self { + $obj = new self; + + $obj->file = $file; + $obj->fileName = $fileName; + + null !== $token && $obj->token = $token; + null !== $checks && $obj->checks = $checks; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $extensions && $obj->extensions = $extensions; + null !== $folder && $obj->folder = $folder; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $overwriteAITags && $obj->overwriteAITags = $overwriteAITags; + null !== $overwriteCustomMetadata && $obj->overwriteCustomMetadata = $overwriteCustomMetadata; + null !== $overwriteFile && $obj->overwriteFile = $overwriteFile; + null !== $overwriteTags && $obj->overwriteTags = $overwriteTags; + null !== $responseFields && $obj->responseFields = $responseFields; + null !== $tags && $obj->tags = $tags; + null !== $transformation && $obj->transformation = $transformation; + null !== $useUniqueFileName && $obj->useUniqueFileName = $useUniqueFileName; + null !== $webhookURL && $obj->webhookURL = $webhookURL; + + return $obj; + } + + /** + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + */ + public function withFile(string $file): self + { + $obj = clone $this; + $obj->file = $file; + + return $obj; + } + + /** + * The name with which the file has to be uploaded. + */ + public function withFileName(string $fileName): self + { + $obj = clone $this; + $obj->fileName = $fileName; + + return $obj; + } + + /** + * This is the client-generated JSON Web Token (JWT). The ImageKit.io server uses it to authenticate and check that the upload request parameters have not been tampered with after the token has been generated. Learn how to create the token on the page below. This field is only required for authentication when uploading a file from the client side. + * + * **Note**: Sending a JWT that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new token. + * + * + * **⚠️Warning**: JWT must be generated on the server-side because it is generated using your account's private API key. This field is required for authentication when uploading a file from the client-side. + */ + public function withToken(string $token): self + { + $obj = clone $this; + $obj->token = $token; + + return $obj; + } + + /** + * Server-side checks to run on the asset. + * Read more about [Upload API checks](/docs/api-reference/upload-file/upload-file-v2#upload-api-checks). + */ + public function withChecks(string $checks): self + { + $obj = clone $this; + $obj->checks = $checks; + + return $obj; + } + + /** + * Define an important area in the image. This is only relevant for image type files. + * + * - To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format `x,y,width,height`. For example - `10,10,100,100` + * - Can be used with fo-customtransformation. + * - If this field is not specified and the file is overwritten, then customCoordinates will be removed. + */ + public function withCustomCoordinates(string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * + * @param list $extensions + */ + public function withExtensions(array $extensions): self + { + $obj = clone $this; + $obj->extensions = $extensions; + + return $obj; + } + + /** + * The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. + */ + public function withFolder(string $folder): self + { + $obj = clone $this; + $obj->folder = $folder; + + return $obj; + } + + /** + * Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + */ + public function withOverwriteAITags(bool $overwriteAITags): self + { + $obj = clone $this; + $obj->overwriteAITags = $overwriteAITags; + + return $obj; + } + + /** + * If the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed. + */ + public function withOverwriteCustomMetadata( + bool $overwriteCustomMetadata + ): self { + $obj = clone $this; + $obj->overwriteCustomMetadata = $overwriteCustomMetadata; + + return $obj; + } + + /** + * If `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately. + */ + public function withOverwriteFile(bool $overwriteFile): self + { + $obj = clone $this; + $obj->overwriteFile = $overwriteFile; + + return $obj; + } + + /** + * If the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed. + */ + public function withOverwriteTags(bool $overwriteTags): self + { + $obj = clone $this; + $obj->overwriteTags = $overwriteTags; + + return $obj; + } + + /** + * Array of response field keys to include in the API response body. + * + * @param list $responseFields + */ + public function withResponseFields(array $responseFields): self + { + $obj = clone $this; + $obj->responseFields = $responseFields; + + return $obj; + } + + /** + * Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * + * @param list $tags + */ + public function withTags(array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + */ + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + */ + public function withUseUniqueFileName(bool $useUniqueFileName): self + { + $obj = clone $this; + $obj->useUniqueFileName = $useUniqueFileName; + + return $obj; + } + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function withWebhookURL(string $webhookURL): self + { + $obj = clone $this; + $obj->webhookURL = $webhookURL; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension.php b/src/Beta/V2/Files/FileUploadParams/Extension.php new file mode 100644 index 00000000..fa3874f8 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Extension.php @@ -0,0 +1,35 @@ +|array + */ + public static function variants(): array + { + return [ + AutoTaggingExtension::class, + 'remove-bg' => RemoveBg::class, + 'ai-auto-description' => AIAutoDescription::class, + ]; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php b/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php new file mode 100644 index 00000000..0f4d8b65 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php @@ -0,0 +1,39 @@ + */ + use SdkModel; + + /** + * Specifies the auto description extension. + */ + #[Api] + public string $name = 'ai-auto-description'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php new file mode 100644 index 00000000..2d9ba10c --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php @@ -0,0 +1,119 @@ + */ + use SdkModel; + + /** + * Maximum number of tags to attach to the asset. + */ + #[Api] + public int $maxTags; + + /** + * Minimum confidence level for tags to be considered valid. + */ + #[Api] + public int $minConfidence; + + /** + * Specifies the auto-tagging extension used. + * + * @var Name::* $name + */ + #[Api(enum: Name::class)] + public string $name; + + /** + * `new AutoTaggingExtension()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AutoTaggingExtension::with(maxTags: ..., minConfidence: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AutoTaggingExtension) + * ->withMaxTags(...) + * ->withMinConfidence(...) + * ->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Name::* $name + */ + public static function with( + int $maxTags, + int $minConfidence, + string $name + ): self { + $obj = new self; + + $obj->maxTags = $maxTags; + $obj->minConfidence = $minConfidence; + $obj->name = $name; + + return $obj; + } + + /** + * Maximum number of tags to attach to the asset. + */ + public function withMaxTags(int $maxTags): self + { + $obj = clone $this; + $obj->maxTags = $maxTags; + + return $obj; + } + + /** + * Minimum confidence level for tags to be considered valid. + */ + public function withMinConfidence(int $minConfidence): self + { + $obj = clone $this; + $obj->minConfidence = $minConfidence; + + return $obj; + } + + /** + * Specifies the auto-tagging extension used. + * + * @param Name::* $name + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php new file mode 100644 index 00000000..7ad64d68 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Specifies the background removal extension. + */ + #[Api] + public string $name = 'remove-bg'; + + #[Api(optional: true)] + public ?Options $options; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Options $options = null): self + { + $obj = new self; + + null !== $options && $obj->options = $options; + + return $obj; + } + + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php b/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php new file mode 100644 index 00000000..94bf0352 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php @@ -0,0 +1,117 @@ + */ + use SdkModel; + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + #[Api('add_shadow', optional: true)] + public ?bool $addShadow; + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + #[Api('bg_color', optional: true)] + public ?string $bgColor; + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + #[Api('bg_image_url', optional: true)] + public ?string $bgImageURL; + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + #[Api(optional: true)] + public ?bool $semitransparency; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?bool $addShadow = null, + ?string $bgColor = null, + ?string $bgImageURL = null, + ?bool $semitransparency = null, + ): self { + $obj = new self; + + null !== $addShadow && $obj->addShadow = $addShadow; + null !== $bgColor && $obj->bgColor = $bgColor; + null !== $bgImageURL && $obj->bgImageURL = $bgImageURL; + null !== $semitransparency && $obj->semitransparency = $semitransparency; + + return $obj; + } + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + public function withAddShadow(bool $addShadow): self + { + $obj = clone $this; + $obj->addShadow = $addShadow; + + return $obj; + } + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + public function withBgColor(string $bgColor): self + { + $obj = clone $this; + $obj->bgColor = $bgColor; + + return $obj; + } + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + public function withBgImageURL(string $bgImageURL): self + { + $obj = clone $this; + $obj->bgImageURL = $bgImageURL; + + return $obj; + } + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + public function withSemitransparency(bool $semitransparency): self + { + $obj = clone $this; + $obj->semitransparency = $semitransparency; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/ResponseField.php b/src/Beta/V2/Files/FileUploadParams/ResponseField.php new file mode 100644 index 00000000..19cd2bcd --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/ResponseField.php @@ -0,0 +1,27 @@ +|null, pre?: string|null + * } + */ +final class Transformation implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * List of transformations to apply *after* the file is uploaded. + * Each item must match one of the following types: + * `transformation`, `gif-to-video`, `thumbnail`, `abs`. + * + * @var list|null $post + */ + #[Api(list: Post::class, optional: true)] + public ?array $post; + + /** + * Transformation string to apply before uploading the file to the Media Library. Useful for optimizing files at ingestion. + */ + #[Api(optional: true)] + public ?string $pre; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $post + */ + public static function with(?array $post = null, ?string $pre = null): self + { + $obj = new self; + + null !== $post && $obj->post = $post; + null !== $pre && $obj->pre = $pre; + + return $obj; + } + + /** + * List of transformations to apply *after* the file is uploaded. + * Each item must match one of the following types: + * `transformation`, `gif-to-video`, `thumbnail`, `abs`. + * + * @param list $post + */ + public function withPost(array $post): self + { + $obj = clone $this; + $obj->post = $post; + + return $obj; + } + + /** + * Transformation string to apply before uploading the file to the Media Library. Useful for optimizing files at ingestion. + */ + public function withPre(string $pre): self + { + $obj = clone $this; + $obj->pre = $pre; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post.php new file mode 100644 index 00000000..41763187 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post.php @@ -0,0 +1,37 @@ +|array + */ + public static function variants(): array + { + return [ + 'transformation' => Transformation::class, + 'gif-to-video' => GifToVideo::class, + 'thumbnail' => Thumbnail::class, + 'abs' => Abs::class, + ]; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php new file mode 100644 index 00000000..5e1747c1 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php @@ -0,0 +1,101 @@ + */ + use SdkModel; + + /** + * Adaptive Bitrate Streaming (ABS) setup. + */ + #[Api] + public string $type = 'abs'; + + /** + * Streaming protocol to use (`hls` or `dash`). + * + * @var Protocol::* $protocol + */ + #[Api(enum: Protocol::class)] + public string $protocol; + + /** + * List of different representations you want to create separated by an underscore. + */ + #[Api] + public string $value; + + /** + * `new Abs()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Abs::with(protocol: ..., value: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Abs)->withProtocol(...)->withValue(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Protocol::* $protocol + */ + public static function with(string $protocol, string $value): self + { + $obj = new self; + + $obj->protocol = $protocol; + $obj->value = $value; + + return $obj; + } + + /** + * Streaming protocol to use (`hls` or `dash`). + * + * @param Protocol::* $protocol + */ + public function withProtocol(string $protocol): self + { + $obj = clone $this; + $obj->protocol = $protocol; + + return $obj; + } + + /** + * List of different representations you want to create separated by an underscore. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php new file mode 100644 index 00000000..2220d490 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Converts an animated GIF into an MP4. + */ + #[Api] + public string $type = 'gif-to-video'; + + /** + * Optional transformation string to apply to the output video. + * **Example**: `q-80`. + */ + #[Api(optional: true)] + public ?string $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $value = null): self + { + $obj = new self; + + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Optional transformation string to apply to the output video. + * **Example**: `q-80`. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php new file mode 100644 index 00000000..ca978f5f --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php @@ -0,0 +1,62 @@ + */ + use SdkModel; + + /** + * Generates a thumbnail image. + */ + #[Api] + public string $type = 'thumbnail'; + + /** + * Optional transformation string. + * **Example**: `w-150,h-150`. + */ + #[Api(optional: true)] + public ?string $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $value = null): self + { + $obj = new self; + + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Optional transformation string. + * **Example**: `w-150,h-150`. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Transformation.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Transformation.php new file mode 100644 index 00000000..498c6597 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Transformation.php @@ -0,0 +1,76 @@ + */ + use SdkModel; + + /** + * Transformation type. + */ + #[Api] + public string $type = 'transformation'; + + /** + * Transformation string (e.g. `w-200,h-200`). + * Same syntax as ImageKit URL-based transformations. + */ + #[Api] + public string $value; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(value: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withValue(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $value): self + { + $obj = new self; + + $obj->value = $value; + + return $obj; + } + + /** + * Transformation string (e.g. `w-200,h-200`). + * Same syntax as ImageKit URL-based transformations. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadResponse.php b/src/Beta/V2/Files/FileUploadResponse.php new file mode 100644 index 00000000..7ae8aedc --- /dev/null +++ b/src/Beta/V2/Files/FileUploadResponse.php @@ -0,0 +1,556 @@ +|null, + * audioCodec?: string|null, + * bitRate?: int|null, + * customCoordinates?: string|null, + * customMetadata?: array|null, + * description?: string|null, + * duration?: int|null, + * embeddedMetadata?: array|null, + * extensionStatus?: ExtensionStatus|null, + * fileID?: string|null, + * filePath?: string|null, + * fileType?: string|null, + * height?: float|null, + * isPrivateFile?: bool|null, + * isPublished?: bool|null, + * metadata?: Metadata|null, + * name?: string|null, + * size?: float|null, + * tags?: list|null, + * thumbnailURL?: string|null, + * url?: string|null, + * versionInfo?: VersionInfo|null, + * videoCodec?: string|null, + * width?: float|null, + * } + */ +final class FileUploadResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @var list|null $aiTags + */ + #[Api('AITags', list: AITag::class, nullable: true, optional: true)] + public ?array $aiTags; + + /** + * The audio codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $audioCodec; + + /** + * The bit rate of the video in kbps (only for video). + */ + #[Api(optional: true)] + public ?int $bitRate; + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * The duration of the video in seconds (only for video). + */ + #[Api(optional: true)] + public ?int $duration; + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @var array|null $embeddedMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $embeddedMetadata; + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + #[Api(optional: true)] + public ?ExtensionStatus $extensionStatus; + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + #[Api('fileId', optional: true)] + public ?string $fileID; + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + #[Api(optional: true)] + public ?string $filePath; + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + #[Api(optional: true)] + public ?string $fileType; + + /** + * Height of the image in pixels (Only for images). + */ + #[Api(optional: true)] + public ?float $height; + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + #[Api(optional: true)] + public ?Metadata $metadata; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Size of the image file in Bytes. + */ + #[Api(optional: true)] + public ?float $size; + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * In the case of an image, a small thumbnail URL. + */ + #[Api('thumbnailUrl', optional: true)] + public ?string $thumbnailURL; + + /** + * A publicly accessible URL of the file. + */ + #[Api(optional: true)] + public ?string $url; + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + #[Api(optional: true)] + public ?VersionInfo $versionInfo; + + /** + * The video codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $videoCodec; + + /** + * Width of the image in pixels (Only for Images). + */ + #[Api(optional: true)] + public ?float $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $aiTags + * @param array $customMetadata + * @param array $embeddedMetadata + * @param list|null $tags + */ + public static function with( + ?array $aiTags = null, + ?string $audioCodec = null, + ?int $bitRate = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?int $duration = null, + ?array $embeddedMetadata = null, + ?ExtensionStatus $extensionStatus = null, + ?string $fileID = null, + ?string $filePath = null, + ?string $fileType = null, + ?float $height = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?Metadata $metadata = null, + ?string $name = null, + ?float $size = null, + ?array $tags = null, + ?string $thumbnailURL = null, + ?string $url = null, + ?VersionInfo $versionInfo = null, + ?string $videoCodec = null, + ?float $width = null, + ): self { + $obj = new self; + + null !== $aiTags && $obj->aiTags = $aiTags; + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $bitRate && $obj->bitRate = $bitRate; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $duration && $obj->duration = $duration; + null !== $embeddedMetadata && $obj->embeddedMetadata = $embeddedMetadata; + null !== $extensionStatus && $obj->extensionStatus = $extensionStatus; + null !== $fileID && $obj->fileID = $fileID; + null !== $filePath && $obj->filePath = $filePath; + null !== $fileType && $obj->fileType = $fileType; + null !== $height && $obj->height = $height; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $metadata && $obj->metadata = $metadata; + null !== $name && $obj->name = $name; + null !== $size && $obj->size = $size; + null !== $tags && $obj->tags = $tags; + null !== $thumbnailURL && $obj->thumbnailURL = $thumbnailURL; + null !== $url && $obj->url = $url; + null !== $versionInfo && $obj->versionInfo = $versionInfo; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @param list|null $aiTags + */ + public function withAITags(?array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * The audio codec used in the video (only for video). + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * The bit rate of the video in kbps (only for video). + */ + public function withBitRate(int $bitRate): self + { + $obj = clone $this; + $obj->bitRate = $bitRate; + + return $obj; + } + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * The duration of the video in seconds (only for video). + */ + public function withDuration(int $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @param array $embeddedMetadata + */ + public function withEmbeddedMetadata(array $embeddedMetadata): self + { + $obj = clone $this; + $obj->embeddedMetadata = $embeddedMetadata; + + return $obj; + } + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + public function withExtensionStatus(ExtensionStatus $extensionStatus): self + { + $obj = clone $this; + $obj->extensionStatus = $extensionStatus; + + return $obj; + } + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * Height of the image in pixels (Only for images). + */ + public function withHeight(float $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + public function withMetadata(Metadata $metadata): self + { + $obj = clone $this; + $obj->metadata = $metadata; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Size of the image file in Bytes. + */ + public function withSize(float $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * In the case of an image, a small thumbnail URL. + */ + public function withThumbnailURL(string $thumbnailURL): self + { + $obj = clone $this; + $obj->thumbnailURL = $thumbnailURL; + + return $obj; + } + + /** + * A publicly accessible URL of the file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + public function withVersionInfo(VersionInfo $versionInfo): self + { + $obj = clone $this; + $obj->versionInfo = $versionInfo; + + return $obj; + } + + /** + * The video codec used in the video (only for video). + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Width of the image in pixels (Only for Images). + */ + public function withWidth(float $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadResponse/AITag.php b/src/Beta/V2/Files/FileUploadResponse/AITag.php new file mode 100644 index 00000000..0c2c4782 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadResponse/AITag.php @@ -0,0 +1,95 @@ + */ + use SdkModel; + + /** + * Confidence score of the tag. + */ + #[Api(optional: true)] + public ?float $confidence; + + /** + * Name of the tag. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + #[Api(optional: true)] + public ?string $source; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $confidence = null, + ?string $name = null, + ?string $source = null + ): self { + $obj = new self; + + null !== $confidence && $obj->confidence = $confidence; + null !== $name && $obj->name = $name; + null !== $source && $obj->source = $source; + + return $obj; + } + + /** + * Confidence score of the tag. + */ + public function withConfidence(float $confidence): self + { + $obj = clone $this; + $obj->confidence = $confidence; + + return $obj; + } + + /** + * Name of the tag. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + public function withSource(string $source): self + { + $obj = clone $this; + $obj->source = $source; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php new file mode 100644 index 00000000..84aa7475 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php @@ -0,0 +1,126 @@ + */ + use SdkModel; + + /** @var AIAutoDescription::*|null $aiAutoDescription */ + #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] + public ?string $aiAutoDescription; + + /** @var AwsAutoTagging::*|null $awsAutoTagging */ + #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] + public ?string $awsAutoTagging; + + /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] + public ?string $googleAutoTagging; + + /** @var RemoveBg::*|null $removeBg */ + #[Api('remove-bg', enum: RemoveBg::class, optional: true)] + public ?string $removeBg; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AIAutoDescription::* $aiAutoDescription + * @param AwsAutoTagging::* $awsAutoTagging + * @param GoogleAutoTagging::* $googleAutoTagging + * @param RemoveBg::* $removeBg + */ + public static function with( + ?string $aiAutoDescription = null, + ?string $awsAutoTagging = null, + ?string $googleAutoTagging = null, + ?string $removeBg = null, + ): self { + $obj = new self; + + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg; + + return $obj; + } + + /** + * @param AIAutoDescription::* $aiAutoDescription + */ + public function withAIAutoDescription(string $aiAutoDescription): self + { + $obj = clone $this; + $obj->aiAutoDescription = $aiAutoDescription; + + return $obj; + } + + /** + * @param AwsAutoTagging::* $awsAutoTagging + */ + public function withAwsAutoTagging(string $awsAutoTagging): self + { + $obj = clone $this; + $obj->awsAutoTagging = $awsAutoTagging; + + return $obj; + } + + /** + * @param GoogleAutoTagging::* $googleAutoTagging + */ + public function withGoogleAutoTagging(string $googleAutoTagging): self + { + $obj = clone $this; + $obj->googleAutoTagging = $googleAutoTagging; + + return $obj; + } + + /** + * @param RemoveBg::* $removeBg + */ + public function withRemoveBg(string $removeBg): self + { + $obj = clone $this; + $obj->removeBg = $removeBg; + + return $obj; + } +} diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php new file mode 100644 index 00000000..c1579539 --- /dev/null +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php @@ -0,0 +1,19 @@ + */ + use SdkModel; + + /** + * Unique identifier of the file version. + */ + #[Api(optional: true)] + public ?string $id; + + /** + * Name of the file version. + */ + #[Api(optional: true)] + public ?string $name; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $id = null, ?string $name = null): self + { + $obj = new self; + + null !== $id && $obj->id = $id; + null !== $name && $obj->name = $name; + + return $obj; + } + + /** + * Unique identifier of the file version. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Name of the file version. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Cache/Invalidation/InvalidationCreateParams.php b/src/Cache/Invalidation/InvalidationCreateParams.php new file mode 100644 index 00000000..ca1f5eeb --- /dev/null +++ b/src/Cache/Invalidation/InvalidationCreateParams.php @@ -0,0 +1,74 @@ +create + * + * @phpstan-type invalidation_create_params = array{url: string} + */ +final class InvalidationCreateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The full URL of the file to be purged. + */ + #[Api] + public string $url; + + /** + * `new InvalidationCreateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * InvalidationCreateParams::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new InvalidationCreateParams)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $url): self + { + $obj = new self; + + $obj->url = $url; + + return $obj; + } + + /** + * The full URL of the file to be purged. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Cache/Invalidation/InvalidationGetResponse.php b/src/Cache/Invalidation/InvalidationGetResponse.php new file mode 100644 index 00000000..8a114e35 --- /dev/null +++ b/src/Cache/Invalidation/InvalidationGetResponse.php @@ -0,0 +1,61 @@ + */ + use SdkModel; + + /** + * Status of the purge request. + * + * @var Status::*|null $status + */ + #[Api(enum: Status::class, optional: true)] + public ?string $status; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Status::* $status + */ + public static function with(?string $status = null): self + { + $obj = new self; + + null !== $status && $obj->status = $status; + + return $obj; + } + + /** + * Status of the purge request. + * + * @param Status::* $status + */ + public function withStatus(string $status): self + { + $obj = clone $this; + $obj->status = $status; + + return $obj; + } +} diff --git a/src/Cache/Invalidation/InvalidationGetResponse/Status.php b/src/Cache/Invalidation/InvalidationGetResponse/Status.php new file mode 100644 index 00000000..d446c2de --- /dev/null +++ b/src/Cache/Invalidation/InvalidationGetResponse/Status.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Unique identifier of the purge request. This can be used to check the status of the purge request. + */ + #[Api('requestId', optional: true)] + public ?string $requestID; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $requestID = null): self + { + $obj = new self; + + null !== $requestID && $obj->requestID = $requestID; + + return $obj; + } + + /** + * Unique identifier of the purge request. This can be used to check the status of the purge request. + */ + public function withRequestID(string $requestID): self + { + $obj = clone $this; + $obj->requestID = $requestID; + + return $obj; + } +} diff --git a/src/Client.php b/src/Client.php new file mode 100644 index 00000000..a7dabcc9 --- /dev/null +++ b/src/Client.php @@ -0,0 +1,123 @@ +privateAPIKey = (string) ( + $privateAPIKey ?? getenv('IMAGEKIT_PRIVATE_API_KEY') + ); + $this->password = (string) ( + $password ?? getenv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?: 'do_not_set' + ); + + $this->baseUrlOverridden = !is_null($baseUrl); + + $base = $baseUrl ?? getenv( + 'IMAGE_KIT_BASE_URL' + ) ?: 'https://api.imagekit.io'; + + $options = RequestOptions::with( + uriFactory: Psr17FactoryDiscovery::findUriFactory(), + streamFactory: Psr17FactoryDiscovery::findStreamFactory(), + requestFactory: Psr17FactoryDiscovery::findRequestFactory(), + transporter: Psr18ClientDiscovery::find(), + ); + + parent::__construct( + headers: [ + 'Content-Type' => 'application/json', 'Accept' => 'application/json', + ], + baseUrl: $base, + options: $options, + ); + + $this->customMetadataFields = new CustomMetadataFieldsService($this); + $this->files = new FilesService($this); + $this->assets = new AssetsService($this); + $this->cache = new CacheService($this); + $this->folders = new FoldersService($this); + $this->accounts = new AccountsService($this); + $this->beta = new BetaService($this); + $this->webhooks = new WebhooksService($this); + } + + /** @return array */ + protected function authHeaders(): array + { + if (!$this->privateAPIKey && !$this->password) { + return []; + } + + $base64_credentials = base64_encode( + "{$this->privateAPIKey}:{$this->password}" + ); + + return ['Authorization' => "Basic {$base64_credentials}"]; + } +} diff --git a/src/Core.php b/src/Core.php new file mode 100644 index 00000000..46b56ff5 --- /dev/null +++ b/src/Core.php @@ -0,0 +1,9 @@ +|Converter|string|null + */ + public readonly Converter|string|null $type; + + /** + * @param class-string|Converter|string|null $type + * @param class-string|Converter|null $enum + * @param class-string|Converter|null $union + * @param class-string|Converter|string|null $list + * @param class-string|Converter|string|null $map + */ + public function __construct( + public readonly ?string $apiName = null, + Converter|string|null $type = null, + Converter|string|null $enum = null, + Converter|string|null $union = null, + Converter|string|null $list = null, + Converter|string|null $map = null, + public readonly bool $nullable = false, + public readonly bool $optional = false, + ) { + $this->type = $type ?? $enum ?? $union ?? ($list ? new ListOf($list) : ($map ? new MapOf($map) : null)); + } +} diff --git a/src/Core/BaseClient.php b/src/Core/BaseClient.php new file mode 100644 index 00000000..d0a5c00a --- /dev/null +++ b/src/Core/BaseClient.php @@ -0,0 +1,222 @@ +, + * headers: array>, + * body: mixed, + * } + */ +class BaseClient +{ + protected UriInterface $baseUrl; + + /** + * @internal + * + * @param array|null> $headers + */ + public function __construct( + protected array $headers, + string $baseUrl, + protected RequestOptions $options = new RequestOptions, + ) { + assert(null !== $this->options->uriFactory); + $this->baseUrl = $this->options->uriFactory->createUri($baseUrl); + } + + /** + * @param string|list $path + * @param array $query + * @param array $headers + * @param class-string> $page + * @param class-string> $stream + * @param RequestOptions|array|null $options + */ + public function request( + string $method, + string|array $path, + array $query = [], + array $headers = [], + mixed $body = null, + string|Converter|ConverterSource|null $convert = null, + ?string $page = null, + ?string $stream = null, + RequestOptions|array|null $options = [], + ): mixed { + // @phpstan-ignore-next-line + [$req, $opts] = $this->buildRequest(method: $method, path: $path, query: $query, headers: $headers, body: $body, opts: $options); + ['method' => $method, 'path' => $uri, 'headers' => $headers] = $req; + assert(null !== $opts->requestFactory); + + $request = $opts->requestFactory->createRequest($method, uri: $uri); + $request = Util::withSetHeaders($request, headers: $headers); + + // @phpstan-ignore-next-line + $rsp = $this->sendRequest($opts, req: $request, data: $body, redirectCount: 0, retryCount: 0); + + $decoded = Util::decodeContent($rsp); + + if (!is_null($stream)) { + return new $stream( + convert: $convert, + request: $request, + response: $rsp, + stream: $decoded + ); + } + + if (!is_null($page)) { + return new $page( + convert: $convert, + client: $this, + request: $req, + options: $opts, + data: $decoded, + ); + } + + if (!is_null($convert)) { + return Conversion::coerce($convert, value: $decoded); + } + + return $decoded; + } + + /** @return array */ + protected function authHeaders(): array + { + return []; + } + + /** + * @internal + * + * @param string|list $path + * @param array $query + * @param array|null> $headers + * @param array{ + * timeout?: float|null, + * maxRetries?: int|null, + * initialRetryDelay?: float|null, + * maxRetryDelay?: float|null, + * extraHeaders?: array|null>|null, + * extraQueryParams?: array|null, + * extraBodyParams?: mixed, + * transporter?: ClientInterface|null, + * uriFactory?: UriFactoryInterface|null, + * streamFactory?: StreamFactoryInterface|null, + * requestFactory?: RequestFactoryInterface|null, + * }|null $opts + * + * @return array{normalized_request, RequestOptions} + */ + protected function buildRequest( + string $method, + string|array $path, + array $query, + array $headers, + mixed $body, + RequestOptions|array|null $opts, + ): array { + $options = RequestOptions::parse($this->options, $opts); + + $parsedPath = Util::parsePath($path); + + /** @var array $mergedQuery */ + $mergedQuery = array_merge_recursive( + $query, + $options->extraQueryParams ?? [], + ); + $uri = Util::joinUri($this->baseUrl, path: $parsedPath, query: $mergedQuery)->__toString(); + + /** @var array|null> $mergedHeaders */ + $mergedHeaders = [...$this->headers, + ...$this->authHeaders(), + ...$headers, + ...($options->extraHeaders ?? []), ]; + + $req = ['method' => strtoupper($method), 'path' => $uri, 'query' => $mergedQuery, 'headers' => $mergedHeaders, 'body' => $body]; + + return [$req, $options]; + } + + /** + * @internal + */ + protected function followRedirect( + ResponseInterface $rsp, + RequestInterface $req + ): RequestInterface { + $location = $rsp->getHeaderLine('Location'); + if (!$location) { + throw new \RuntimeException('Redirection without Location header'); + } + + $uri = Util::joinUri($req->getUri(), path: $location); + + return $req->withUri($uri); + } + + /** + * @internal + * + * @param bool|int|float|string|resource|\Traversable|array|null $data + */ + protected function sendRequest( + RequestOptions $opts, + RequestInterface $req, + mixed $data, + int $retryCount, + int $redirectCount, + ): ResponseInterface { + assert(null !== $opts->streamFactory && null !== $opts->transporter); + + $req = Util::withSetBody($opts->streamFactory, req: $req, body: $data); + $rsp = $opts->transporter->sendRequest($req); + $code = $rsp->getStatusCode(); + + if ($code >= 300 && $code < 400) { + if ($redirectCount >= 20) { + throw new \RuntimeException('Maximum redirects exceeded'); + } + + $req = $this->followRedirect($rsp, req: $req); + + return $this->sendRequest($opts, req: $req, data: $data, retryCount: $retryCount, redirectCount: ++$redirectCount); + } + + if ($code >= 400 && $code < 500) { + throw APIStatusException::from(request: $req, response: $rsp); + } + + if ($code >= 500 && $retryCount < $opts->maxRetries) { + usleep((int) $opts->initialRetryDelay); + + return $this->sendRequest($opts, req: $req, data: $data, retryCount: ++$retryCount, redirectCount: $redirectCount); + } + + return $rsp; + } +} diff --git a/src/Core/Concerns/SdkEnum.php b/src/Core/Concerns/SdkEnum.php new file mode 100644 index 00000000..cf3651aa --- /dev/null +++ b/src/Core/Concerns/SdkEnum.php @@ -0,0 +1,33 @@ +getReflectionConstants() as $constant) { + if ($constant->isPublic()) { + array_push($acc, $constant->getValue()); + } + } + + return static::$converter = new EnumOf($acc); // @phpstan-ignore-line + } +} diff --git a/src/Core/Concerns/SdkModel.php b/src/Core/Concerns/SdkModel.php new file mode 100644 index 00000000..da86c0ad --- /dev/null +++ b/src/Core/Concerns/SdkModel.php @@ -0,0 +1,269 @@ + + */ +trait SdkModel +{ + private static ModelOf $converter; + + /** + * @var array keeps track of undocumented data + */ + private array $_data = []; + + /** + * @internal + * + * @return array + */ + public function __serialize(): array + { + $rows = [...Util::get_object_vars($this), ...$this->_data]; // @phpstan-ignore-line + + return array_map(static fn ($v) => self::serialize($v), array: $rows); + } + + /** + * @internal + * + * @param array $data + */ + public function __unserialize(array $data): void + { + foreach ($data as $key => $value) { + $this->offsetSet($key, value: $value); // @phpstan-ignore-line + } + } + + /** + * @internal + * + * @return array + */ + public function __debugInfo(): array + { + return $this->__serialize(); + } + + /** + * @internal + */ + public function __toString(): string + { + return Util::prettyEncodeJson($this->__debugInfo()); + } + + /** + * @internal + * + * Magic get is intended to occur when we have manually unset + * a native class property, indicating an omitted value, + * or a property overridden with an incongruent type + * + * @return value-of + * + * @throws \Exception + */ + public function __get(string $key): mixed + { + if (!array_key_exists($key, array: self::$converter->properties)) { + throw new \RuntimeException("Property '{$key}' does not exist in {$this}::class"); + } + + // The unset property was overridden by a value with an incongruent type. + // It's forbidden for an optional value to be `null` in the payload. + if (array_key_exists($key, array: $this->_data)) { + throw new \Exception( + "The {$key} property is overridden, use the array access ['{$key}'] syntax to the raw payload property.", + ); + } + + // An optional property which was unset to be omitted from serialized is being accessed. + // Return null to match user's expectations. + return null; // @phpstan-ignore-line + } + + /** + * @return Shape + */ + public function toArray(): array + { + return $this->__serialize(); // @phpstan-ignore-line + } + + /** + * @internal + * + * @param key-of $offset + */ + public function offsetExists(mixed $offset): bool + { + if (!is_string($offset)) { // @phpstan-ignore-line + throw new \InvalidArgumentException; + } + + if (array_key_exists($offset, array: $this->_data)) { + return true; + } + + if (array_key_exists($offset, array: self::$converter->properties)) { + if (isset($this->{$offset})) { + return true; + } + + $property = self::$converter->properties[$offset]->property ?? new \ReflectionProperty($this, property: $offset); + + return $property->isInitialized($this); + } + + return false; + } + + /** + * @internal + * + * @param key-of $offset + */ + public function &offsetGet(mixed $offset): mixed + { + if (!is_string($offset)) { // @phpstan-ignore-line + throw new \InvalidArgumentException; + } + + if (!$this->offsetExists($offset)) { // @phpstan-ignore-line + return null; // @phpstan-ignore-line + } + + if (array_key_exists($offset, array: $this->_data)) { + return $this->_data[$offset]; // @phpstan-ignore-line + } + + return $this->{$offset}; // @phpstan-ignore-line + } + + /** + * @internal + * + * @param key-of $offset + */ + public function offsetSet(mixed $offset, mixed $value): void + { + if (!is_string($offset)) { // @phpstan-ignore-line + throw new \InvalidArgumentException; + } + + $type = array_key_exists($offset, array: self::$converter->properties) + ? self::$converter->properties[$offset]->type + : 'mixed'; + + $coerced = Conversion::coerce($type, value: $value, state: new CoerceState(translateNames: false)); + + if (property_exists($this, property: $offset)) { // @phpstan-ignore-line + try { + $this->{$offset} = $coerced; // @phpstan-ignore-line + unset($this->_data[$offset]); + + return; + } catch (\TypeError) { // @phpstan-ignore-line + unset($this->{$offset}); + } + } + + $this->_data[$offset] = $coerced; + } + + /** + * @internal + * + * @param key-of $offset + */ + public function offsetUnset(mixed $offset): void + { + if (!is_string($offset)) { // @phpstan-ignore-line + throw new \InvalidArgumentException; + } + + if (property_exists($this, property: $offset)) { // @phpstan-ignore-line + unset($this->{$offset}); + } + + unset($this->_data[$offset]); + } + + /** + * @internal + * + * @return array + */ + public function jsonSerialize(): array + { + // @phpstan-ignore-next-line + return Conversion::dump(self::converter(), value: $this->__serialize()); + } + + /** + * @param array $data + */ + public static function fromArray(array $data): static + { + return self::converter()->from($data); // @phpstan-ignore-line + } + + /** + * @internal + */ + public static function converter(): Converter + { + if (isset(self::$converter)) { + return self::$converter; + } + + $class = new \ReflectionClass(static::class); + + return self::$converter = new ModelOf($class); + } + + /** + * @internal + */ + private function initialize(): void + { + static::converter(); + + foreach (self::$converter->properties as $name => $info) { + if ($info->optional) { + unset($this->{$name}); + } + } + } + + /** + * @internal + */ + private static function serialize(mixed $value): mixed + { + if ($value instanceof BaseModel) { + return $value->toArray(); + } + + if (is_array($value)) { + return array_map(static fn ($v) => self::serialize($v), array: $value); + } + + return $value; + } +} diff --git a/src/Core/Concerns/SdkPage.php b/src/Core/Concerns/SdkPage.php new file mode 100644 index 00000000..25f2e976 --- /dev/null +++ b/src/Core/Concerns/SdkPage.php @@ -0,0 +1,118 @@ + + */ + abstract public function getItems(): array; + + public function hasNextPage(): bool + { + $items = $this->getItems(); + if (empty($items)) { + return false; + } + + return null != $this->nextRequest(); + } + + /** + * Get the next page of results. + * Before calling this method, you must check if there is a next page + * using {@link hasNextPage()}. + * + * @return static of static + * + * @throws APIStatusException + */ + public function getNextPage(): static + { + $next = $this->nextRequest(); + if (!$next) { + throw new \RuntimeException( + 'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.' + ); + } + + [$req, $opts] = $next; + + // @phpstan-ignore-next-line + return $this->client->request(...$req, convert: $this->convert, page: $this::class, options: $opts); + } + + /** + * Iterator yielding each page (instance of static). + * + * @return \Generator + */ + public function getIterator(): \Generator + { + $page = $this; + + yield $page; + while ($page->hasNextPage()) { + $page = $page->getNextPage(); + + yield $page; + } + } + + /** + * Iterator yielding each item across all pages. + * + * @return \Generator + */ + public function pagingEachItem(): \Generator + { + foreach ($this as $page) { + foreach ($page->getItems() as $item) { + yield $item; + } + } + } + + /** + * @internal + * + * @param array $data + * + * @return static + */ + abstract public static function fromArray(array $data): static; + + /** + * @internal + * + * @return array{normalized_request, RequestOptions} + */ + abstract protected function nextRequest(): ?array; +} diff --git a/src/Core/Concerns/SdkParams.php b/src/Core/Concerns/SdkParams.php new file mode 100644 index 00000000..2797d525 --- /dev/null +++ b/src/Core/Concerns/SdkParams.php @@ -0,0 +1,37 @@ +|self|null $params + * @param array|RequestOptions|null $options + * + * @return array{array, RequestOptions} + */ + public static function parseRequest(array|self|null $params, array|RequestOptions|null $options): array + { + $value = is_array($params) ? Util::array_filter_omit($params) : $params; + $converter = self::converter(); + $state = new DumpState; + $dumped = (array) Conversion::dump($converter, value: $value, state: $state); + $opts = RequestOptions::parse($options); // @phpstan-ignore-line + + if (!$state->canRetry) { + $opts->maxRetries = 0; + } + + return [$dumped, $opts]; // @phpstan-ignore-line + } +} diff --git a/src/Core/Concerns/SdkUnion.php b/src/Core/Concerns/SdkUnion.php new file mode 100644 index 00000000..87356601 --- /dev/null +++ b/src/Core/Concerns/SdkUnion.php @@ -0,0 +1,40 @@ +|list + */ + public static function variants(): array + { + return []; + } + + public static function converter(): Converter + { + if (isset(static::$converter)) { + return static::$converter; + } + + // @phpstan-ignore-next-line + return static::$converter = new UnionOf(discriminator: static::discriminator(), variants: static::variants()); + } +} diff --git a/src/Core/Contracts/BaseModel.php b/src/Core/Contracts/BaseModel.php new file mode 100644 index 00000000..68d47446 --- /dev/null +++ b/src/Core/Contracts/BaseModel.php @@ -0,0 +1,18 @@ + + */ +interface BaseModel extends \ArrayAccess, \JsonSerializable, \Stringable, ConverterSource +{ + /** @return array */ + public function toArray(): array; +} diff --git a/src/Core/Contracts/BasePage.php b/src/Core/Contracts/BasePage.php new file mode 100644 index 00000000..143f5b66 --- /dev/null +++ b/src/Core/Contracts/BasePage.php @@ -0,0 +1,52 @@ + + */ +interface BasePage extends \IteratorAggregate +{ + /** + * @internal + * + * @param normalized_request $request + */ + public function __construct( + Converter|ConverterSource|string $convert, + Client $client, + array $request, + RequestOptions $options, + mixed $data, + ); + + public function hasNextPage(): bool; + + /** + * @return list + */ + public function getItems(): array; + + /** + * @return static + */ + public function getNextPage(): static; + + /** + * @return \Generator + */ + public function pagingEachItem(): \Generator; +} diff --git a/src/Core/Contracts/BaseStream.php b/src/Core/Contracts/BaseStream.php new file mode 100644 index 00000000..77555bbe --- /dev/null +++ b/src/Core/Contracts/BaseStream.php @@ -0,0 +1,36 @@ + + */ +interface BaseStream extends \IteratorAggregate +{ + /** + * @param \Generator $stream + */ + public function __construct( + Converter|ConverterSource|string $convert, + RequestInterface $request, + ResponseInterface $response, + \Generator $stream, + ); + + /** + * Manually force the stream to close early. + * Iterating through will automatically close as well. + */ + public function close(): void; +} diff --git a/src/Core/Conversion.php b/src/Core/Conversion.php new file mode 100644 index 00000000..6f27a71a --- /dev/null +++ b/src/Core/Conversion.php @@ -0,0 +1,165 @@ + self::dump_unknown($v, state: $state), array: $value); + } + + if (is_object($value)) { + if (is_a($value, class: ConverterSource::class)) { + return $value::converter()->dump($value, state: $state); + } + + if (is_a($value, class: \DateTimeInterface::class)) { + return $value->format(format: \DateTimeInterface::RFC3339); + } + + if (is_a($value, class: \JsonSerializable::class)) { + return $value->jsonSerialize(); + } + + $acc = get_object_vars($value); + + return empty($acc) ? (object) $acc : self::dump_unknown($acc, state: $state); + } + + return $value; + } + + public static function coerce(Converter|ConverterSource|string $target, mixed $value, CoerceState $state = new CoerceState): mixed + { + if ($value instanceof $target) { + ++$state->yes; + + return $value; + } + + if (is_a($target, class: ConverterSource::class, allow_string: true)) { + $target = $target::converter(); + } + + if ($target instanceof Converter) { + return $target->coerce($value, state: $state); + } + + switch ($target) { + case 'mixed': + ++$state->yes; + + return $value; + + case 'null': + if (is_null($value)) { + ++$state->yes; + + return null; + } + + ++$state->maybe; + + return null; + + case 'bool': + if (is_bool($value)) { + ++$state->yes; + + return $value; + } + + ++$state->no; + + return $value; + + case 'int': + if (is_int($value)) { + ++$state->yes; + + return $value; + } + + if (is_float($value)) { + ++$state->maybe; + + return (int) $value; + } + + if (is_string($value) && ctype_digit($value)) { + ++$state->maybe; + + return (int) $value; + } + + ++$state->no; + + return $value; + + case 'float': + if (is_numeric($value)) { + ++$state->yes; + + return (float) $value; + } + + if (is_string($value) && is_numeric($value)) { + ++$state->maybe; + + return (float) $value; + } + + ++$state->no; + + return $value; + + case 'string': + if (is_string($value)) { + ++$state->yes; + + return $value; + } + + if (is_numeric($value)) { + ++$state->maybe; + + return (string) $value; + } + + if ($value instanceof \Generator) { + return implode('', iterator_to_array($value)); + } + + ++$state->no; + + return $value; + + default: + ++$state->no; + + return $value; + } + } + + public static function dump(Converter|ConverterSource|string $target, mixed $value, DumpState $state = new DumpState): mixed + { + if ($target instanceof Converter) { + return $target->dump($value, state: $state); + } + + if (is_a($target, class: ConverterSource::class, allow_string: true)) { + return $target::converter()->dump($value, state: $state); + } + + return self::dump_unknown($value, state: $state); + } +} diff --git a/src/Core/Conversion/CoerceState.php b/src/Core/Conversion/CoerceState.php new file mode 100644 index 00000000..b1de64d7 --- /dev/null +++ b/src/Core/Conversion/CoerceState.php @@ -0,0 +1,19 @@ +type = $type ?? $enum ?? $union; + assert(!is_null($this->type)); + } + + public function coerce(mixed $value, CoerceState $state): mixed + { + if (!is_array($value)) { + return $value; + } + + $acc = []; + foreach ($value as $k => $v) { + if ($this->nullable && null === $v) { + ++$state->yes; + $acc[$k] = null; + } else { + $acc[$k] = Conversion::coerce($this->type, value: $v, state: $state); + } + } + + return $acc; + } + + public function dump(mixed $value, DumpState $state): mixed + { + if (!is_array($value)) { + return Conversion::dump_unknown($value, state: $state); + } + + if (empty($value)) { + return $this->empty(); + } + + return array_map(fn ($v) => Conversion::dump($this->type, value: $v, state: $state), array: $value); + } + + private function empty(): array|object // @phpstan-ignore-line + { + return (object) []; + } +} diff --git a/src/Core/Conversion/Contracts/Converter.php b/src/Core/Conversion/Contracts/Converter.php new file mode 100644 index 00000000..dadf46de --- /dev/null +++ b/src/Core/Conversion/Contracts/Converter.php @@ -0,0 +1,24 @@ + $members + */ + public function __construct(private readonly array $members) + { + $type = 'NULL'; + foreach ($this->members as $member) { + $type = gettype($member); + } + $this->type = $type; + } + + public function coerce(mixed $value, CoerceState $state): mixed + { + if (in_array($value, haystack: $this->members, strict: true)) { + ++$state->yes; + } elseif ($this->type === gettype($value)) { + ++$state->maybe; + } else { + ++$state->no; + } + + return $value; + } + + public function dump(mixed $value, DumpState $state): mixed + { + return Conversion::dump_unknown($value, state: $state); + } +} diff --git a/src/Core/Conversion/ListOf.php b/src/Core/Conversion/ListOf.php new file mode 100644 index 00000000..9bbe8482 --- /dev/null +++ b/src/Core/Conversion/ListOf.php @@ -0,0 +1,21 @@ + + */ + public readonly array $properties; + + /** + * @param \ReflectionClass $class + */ + public function __construct(public readonly \ReflectionClass $class) + { + $properties = []; + + foreach ($this->class->getProperties() as $property) { + if (!empty($property->getAttributes(Api::class))) { + $name = $property->getName(); + $properties[$name] = new PropertyInfo($property); + } + } + $this->properties = $properties; + } + + public function coerce(mixed $value, CoerceState $state): mixed + { + if ($value instanceof $this->class->name) { + ++$state->yes; + + return $value; + } + + if (!is_array($value) || (!empty($value) && array_is_list($value))) { + ++$state->no; + + return $value; + } + + ++$state->yes; + + $val = [...$value]; + $acc = []; + + foreach ($this->properties as $name => $info) { + $srcName = $state->translateNames ? $info->apiName : $name; + if (!array_key_exists($srcName, array: $val)) { + if ($info->optional) { + ++$state->yes; + } elseif ($info->nullable) { + ++$state->maybe; + } else { + ++$state->no; + } + + continue; + } + + $item = $val[$srcName]; + unset($val[$srcName]); + + if (is_null($item) && ($info->nullable || $info->optional)) { + if ($info->nullable) { + ++$state->yes; + } elseif ($info->optional) { + ++$state->maybe; + } + $acc[$name] = null; + } else { + $coerced = Conversion::coerce($info->type, value: $item, state: $state); + $acc[$name] = $coerced; + } + } + + foreach ($val as $name => $item) { + $acc[$name] = $item; + } + + return $this->from($acc); // @phpstan-ignore-line + } + + /** + * @param array $data + */ + public function from(array $data): BaseModel + { + $instance = $this->class->newInstanceWithoutConstructor(); + $instance->__unserialize($data); // @phpstan-ignore-line + + return $instance; + } + + public function dump(mixed $value, DumpState $state): mixed + { + if ($value instanceof BaseModel) { + $value = $value->toArray(); + } + + if (is_array($value)) { + $acc = []; + + foreach ($value as $name => $item) { + if (array_key_exists($name, array: $this->properties)) { + $info = $this->properties[$name]; + $acc[$info->apiName] = Conversion::dump($info->type, value: $item, state: $state); + } else { + $acc[$name] = Conversion::dump_unknown($item, state: $state); + } + } + + return empty($acc) ? ((object) []) : $acc; + } + + return Conversion::dump_unknown($value, state: $state); + } +} diff --git a/src/Core/Conversion/PropertyInfo.php b/src/Core/Conversion/PropertyInfo.php new file mode 100644 index 00000000..0cfd7c72 --- /dev/null +++ b/src/Core/Conversion/PropertyInfo.php @@ -0,0 +1,76 @@ +getType()?->allowsNull() ?? false; + + $apiName = $property->getName(); + $type = $property->getType(); + $optional = false; + + foreach ($property->getAttributes(Api::class) as $attr) { + /** @var Api $attribute */ + $attribute = $attr->newInstance(); + + $apiName = $attribute->apiName ?? $apiName; + $optional = $attribute->optional; + $nullable |= $attribute->nullable; + $type = $attribute->type ?? $type; + } + + $this->apiName = $apiName; + $this->type = self::parse($type); + $this->nullable = (bool) $nullable; + $this->optional = $optional; + } + + /** + * @param array|Converter|ConverterSource|\ReflectionType|string|null $type + */ + private static function parse(array|Converter|ConverterSource|\ReflectionType|string|null $type): Converter|ConverterSource|string + { + if (is_string($type) || $type instanceof Converter) { + return $type; + } + + if (is_array($type)) { + return new UnionOf($type); // @phpstan-ignore-line + } + + if ($type instanceof \ReflectionUnionType) { + // @phpstan-ignore-next-line + return new UnionOf(array_map(static fn ($t) => self::parse($t), array: $type->getTypes())); + } + + if ($type instanceof \ReflectionNamedType) { + return $type->getName(); + } + + if ($type instanceof \ReflectionIntersectionType) { + throw new \ValueError; + } + + return 'mixed'; + } +} diff --git a/src/Core/Conversion/UnionOf.php b/src/Core/Conversion/UnionOf.php new file mode 100644 index 00000000..1502f9bb --- /dev/null +++ b/src/Core/Conversion/UnionOf.php @@ -0,0 +1,96 @@ +|list $variants + */ + public function __construct( + private readonly array $variants, + private readonly ?string $discriminator = null, + ) {} + + public function coerce(mixed $value, CoerceState $state): mixed + { + if (!is_null($target = $this->resolveVariant(value: $value))) { + return Conversion::coerce($target, value: $value, state: $state); + } + + $alternatives = []; + foreach ($this->variants as $_ => $variant) { + ++$state->branched; + $newState = new CoerceState; + + $coerced = Conversion::coerce($variant, value: $value, state: $newState); + if (($newState->no + $newState->maybe) === 0) { + $state->yes += $newState->yes; + + return $coerced; + } + if ($newState->maybe > 0) { + $alternatives[] = [[-$newState->yes, -$newState->maybe, $newState->no], $newState, $coerced]; + } + } + + usort( + $alternatives, + static fn (array $a, array $b): int => $a[0][0] <=> $b[0][0] ?: $a[0][1] <=> $b[0][1] ?: $a[0][2] <=> $b[0][2] + ); + + if (empty($alternatives)) { + ++$state->no; + + return $value; + } + + [[,$newState, $best]] = $alternatives; + $state->yes += $newState->yes; + $state->maybe += $newState->maybe; + $state->no += $newState->no; + + return $best; + } + + public function dump(mixed $value, DumpState $state): mixed + { + if (!is_null($target = $this->resolveVariant(value: $value))) { + return Conversion::dump($target, value: $value, state: $state); + } + + foreach ($this->variants as $variant) { + if ($value instanceof $variant) { + return Conversion::dump($variant, value: $value, state: $state); + } + } + + return Conversion::dump_unknown($value, state: $state); + } + + private function resolveVariant( + mixed $value, + ): Converter|ConverterSource|string|null { + if ($value instanceof BaseModel) { + return $value::class; + } + + if (!is_null($this->discriminator) && is_array($value) && array_key_exists($this->discriminator, array: $value)) { + $discriminator = $value[$this->discriminator]; + + return $this->variants[$discriminator] ?? null; + } + + return null; + } +} diff --git a/src/Core/Exceptions/APIConnectionException.php b/src/Core/Exceptions/APIConnectionException.php new file mode 100644 index 00000000..c897edb5 --- /dev/null +++ b/src/Core/Exceptions/APIConnectionException.php @@ -0,0 +1,9 @@ +response = $response; + $this->status = $response->getStatusCode(); + + $summary = Util::prettyEncodeJson(['status' => $this->status, 'body' => Util::decodeJson($response->getBody())]); + + if ('' != $message) { + $summary .= $message.PHP_EOL.$summary; + } + + parent::__construct(request: $request, message: $summary, previous: $previous); + } + + public static function from( + RequestInterface $request, + ResponseInterface $response, + string $message = '' + ): self { + $status = $response->getStatusCode(); + + $cls = match (true) { + 400 === $status => BadRequestException::class, + 401 === $status => AuthenticationException::class, + 403 === $status => PermissionDeniedException::class, + 404 === $status => NotFoundException::class, + 409 === $status => ConflictException::class, + 422 === $status => UnprocessableEntityException::class, + 429 === $status => RateLimitException::class, + $status >= 500 => InternalServerException::class, + default => APIStatusException::class + }; + + return new $cls(request: $request, response: $response, message: $message); + } +} diff --git a/src/Core/Exceptions/APITimeoutException.php b/src/Core/Exceptions/APITimeoutException.php new file mode 100644 index 00000000..e3397769 --- /dev/null +++ b/src/Core/Exceptions/APITimeoutException.php @@ -0,0 +1,19 @@ + + */ + public function list( + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): mixed; + + /** + * @api + */ + public function get( + string $id, + ?RequestOptions $requestOptions = null + ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1; +} diff --git a/src/Core/ServiceContracts/Accounts/URLEndpointsContract.php b/src/Core/ServiceContracts/Accounts/URLEndpointsContract.php new file mode 100644 index 00000000..765c3efd --- /dev/null +++ b/src/Core/ServiceContracts/Accounts/URLEndpointsContract.php @@ -0,0 +1,77 @@ + $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) + * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting + */ + public function create( + $description, + $origins = omit, + $urlPrefix = omit, + $urlRewriter = omit, + ?RequestOptions $requestOptions = null, + ): URLEndpointResponse; + + /** + * @api + * + * @param string $description description of the URL endpoint + * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) + * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting + */ + public function update( + string $id, + $description, + $origins = omit, + $urlPrefix = omit, + $urlRewriter = omit, + ?RequestOptions $requestOptions = null, + ): URLEndpointResponse; + + /** + * @api + * + * @return list + */ + public function list( + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): mixed; + + /** + * @api + */ + public function get( + string $id, + ?RequestOptions $requestOptions = null + ): URLEndpointResponse; +} diff --git a/src/Core/ServiceContracts/Accounts/UsageContract.php b/src/Core/ServiceContracts/Accounts/UsageContract.php new file mode 100644 index 00000000..eeb5fac6 --- /dev/null +++ b/src/Core/ServiceContracts/Accounts/UsageContract.php @@ -0,0 +1,23 @@ + "7d"`. + * + * Note : When the searchQuery parameter is present, the following query parameters will have no effect on the result: + * + * 1. `tags` + * 2. `type` + * 3. `name` + * + * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. + * @param int $skip the number of results to skip before returning results + * @param Sort::* $sort sort the results by one of the supported fields in ascending or descending order + * @param Type::* $type Filter results by asset type. + * + * - `file` — returns only files + * - `file-version` — returns specific file versions + * - `folder` — returns only folders + * - `all` — returns both files and folders (excludes `file-version`) + * + * @return list + */ + public function list( + $fileType = omit, + $limit = omit, + $path = omit, + $searchQuery = omit, + $skip = omit, + $sort = omit, + $type = omit, + ?RequestOptions $requestOptions = null, + ): array; +} diff --git a/src/Core/ServiceContracts/Beta/V2/FilesContract.php b/src/Core/ServiceContracts/Beta/V2/FilesContract.php new file mode 100644 index 00000000..cf4f4f19 --- /dev/null +++ b/src/Core/ServiceContracts/Beta/V2/FilesContract.php @@ -0,0 +1,98 @@ + $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * @param string $description optional text to describe the contents of the file + * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. + * @param bool $isPrivateFile Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + * @param bool $isPublished Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + * @param bool $overwriteAITags If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed + * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately + * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed + * @param list $responseFields array of response field keys to include in the API response body + * @param list $tags Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * @param Transformation $transformation Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + * @param bool $useUniqueFileName Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function upload( + $file, + $fileName, + $token = omit, + $checks = omit, + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $extensions = omit, + $folder = omit, + $isPrivateFile = omit, + $isPublished = omit, + $overwriteAITags = omit, + $overwriteCustomMetadata = omit, + $overwriteFile = omit, + $overwriteTags = omit, + $responseFields = omit, + $tags = omit, + $transformation = omit, + $useUniqueFileName = omit, + $webhookURL = omit, + ?RequestOptions $requestOptions = null, + ): FileUploadResponse; +} diff --git a/src/Core/ServiceContracts/Beta/V2Contract.php b/src/Core/ServiceContracts/Beta/V2Contract.php new file mode 100644 index 00000000..a76de06f --- /dev/null +++ b/src/Core/ServiceContracts/Beta/V2Contract.php @@ -0,0 +1,7 @@ + + */ + public function list( + $includeDeleted = omit, + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): CustomMetadataFieldDeleteResponse; +} diff --git a/src/Core/ServiceContracts/Files/BulkContract.php b/src/Core/ServiceContracts/Files/BulkContract.php new file mode 100644 index 00000000..b8c4fb2d --- /dev/null +++ b/src/Core/ServiceContracts/Files/BulkContract.php @@ -0,0 +1,60 @@ + $fileIDs an array of fileIds which you want to delete + */ + public function delete( + $fileIDs, + ?RequestOptions $requestOptions = null + ): BulkDeleteResponse; + + /** + * @api + * + * @param list $fileIDs an array of fileIds to which you want to add tags + * @param list $tags an array of tags that you want to add to the files + */ + public function addTags( + $fileIDs, + $tags, + ?RequestOptions $requestOptions = null + ): BulkAddTagsResponse; + + /** + * @api + * + * @param list $aiTags an array of AITags that you want to remove from the files + * @param list $fileIDs an array of fileIds from which you want to remove AITags + */ + public function removeAITags( + $aiTags, + $fileIDs, + ?RequestOptions $requestOptions = null + ): BulkRemoveAITagsResponse; + + /** + * @api + * + * @param list $fileIDs an array of fileIds from which you want to remove tags + * @param list $tags an array of tags that you want to remove from the files + */ + public function removeTags( + $fileIDs, + $tags, + ?RequestOptions $requestOptions = null + ): BulkRemoveTagsResponse; +} diff --git a/src/Core/ServiceContracts/Files/MetadataContract.php b/src/Core/ServiceContracts/Files/MetadataContract.php new file mode 100644 index 00000000..3c3d3a23 --- /dev/null +++ b/src/Core/ServiceContracts/Files/MetadataContract.php @@ -0,0 +1,29 @@ + + */ + public function list( + string $fileID, + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + * + * @param string $fileID + */ + public function delete( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): VersionDeleteResponse; + + /** + * @api + * + * @param string $fileID + */ + public function get( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): File; + + /** + * @api + * + * @param string $fileID + */ + public function restore( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): File; +} diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php new file mode 100644 index 00000000..c698af13 --- /dev/null +++ b/src/Core/ServiceContracts/FilesContract.php @@ -0,0 +1,206 @@ + $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * @param string $description optional text to describe the contents of the file + * @param int $expire The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. + * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. + * + * The folder name can contain: + * + * - Alphanumeric Characters: `a-z` , `A-Z` , `0-9` + * - Special Characters: `/` , `_` , `-` + * + * Using multiple `/` creates a nested folder. + * @param bool $isPrivateFile Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + * @param bool $isPublished Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + * @param bool $overwriteAITags If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed + * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately + * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed + * @param string $publicKey Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. + * @param list $responseFields array of response field keys to include in the API response body + * @param string $signature HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. + * + * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. + * @param list $tags Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * @param Transformation $transformation Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + * @param bool $useUniqueFileName Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function upload( + $file, + $fileName, + $token = omit, + $checks = omit, + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $expire = omit, + $extensions = omit, + $folder = omit, + $isPrivateFile = omit, + $isPublished = omit, + $overwriteAITags = omit, + $overwriteCustomMetadata = omit, + $overwriteFile = omit, + $overwriteTags = omit, + $publicKey = omit, + $responseFields = omit, + $signature = omit, + $tags = omit, + $transformation = omit, + $useUniqueFileName = omit, + $webhookURL = omit, + ?RequestOptions $requestOptions = null, + ): FileUploadResponse; +} diff --git a/src/Core/ServiceContracts/Folders/JobContract.php b/src/Core/ServiceContracts/Folders/JobContract.php new file mode 100644 index 00000000..85a41014 --- /dev/null +++ b/src/Core/ServiceContracts/Folders/JobContract.php @@ -0,0 +1,19 @@ + $origin], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/accounts/origins', + body: (object) $parsed['origin'], + options: $options, + convert: OriginResponse::class, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Updates the origin identified by `id` and returns the updated origin object. + * + * @param S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin schema for origin request resources + */ + public function update( + string $id, + $origin, + ?RequestOptions $requestOptions = null + ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1 { + [$parsed, $options] = OriginUpdateParams::parseRequest( + ['origin' => $origin], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'put', + path: ['v1/accounts/origins/%1$s', $id], + body: (object) $parsed['origin'], + options: $options, + convert: OriginResponse::class, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Returns an array of all configured origins for the current account. + * + * @return list + */ + public function list(?RequestOptions $requestOptions = null): array + { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/accounts/origins', + options: $requestOptions, + convert: new ListOf(OriginResponse::class), + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Permanently removes the origin identified by `id`. If the origin is in use by any URL‑endpoints, the API will return an error. + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): mixed { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: ['v1/accounts/origins/%1$s', $id], + options: $requestOptions, + convert: null, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Retrieves the origin identified by `id`. + */ + public function get( + string $id, + ?RequestOptions $requestOptions = null + ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1 { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/accounts/origins/%1$s', $id], + options: $requestOptions, + convert: OriginResponse::class, + ); + } +} diff --git a/src/Core/Services/Accounts/URLEndpointsService.php b/src/Core/Services/Accounts/URLEndpointsService.php new file mode 100644 index 00000000..a571f965 --- /dev/null +++ b/src/Core/Services/Accounts/URLEndpointsService.php @@ -0,0 +1,163 @@ + $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) + * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting + */ + public function create( + $description, + $origins = omit, + $urlPrefix = omit, + $urlRewriter = omit, + ?RequestOptions $requestOptions = null, + ): URLEndpointResponse { + [$parsed, $options] = URLEndpointCreateParams::parseRequest( + [ + 'description' => $description, + 'origins' => $origins, + 'urlPrefix' => $urlPrefix, + 'urlRewriter' => $urlRewriter, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/accounts/url-endpoints', + body: (object) $parsed, + options: $options, + convert: URLEndpointResponse::class, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Updates the URL‑endpoint identified by `id` and returns the updated object. + * + * @param string $description description of the URL endpoint + * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. + * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) + * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting + */ + public function update( + string $id, + $description, + $origins = omit, + $urlPrefix = omit, + $urlRewriter = omit, + ?RequestOptions $requestOptions = null, + ): URLEndpointResponse { + [$parsed, $options] = URLEndpointUpdateParams::parseRequest( + [ + 'description' => $description, + 'origins' => $origins, + 'urlPrefix' => $urlPrefix, + 'urlRewriter' => $urlRewriter, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'put', + path: ['v1/accounts/url-endpoints/%1$s', $id], + body: (object) $parsed, + options: $options, + convert: URLEndpointResponse::class, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Returns an array of all URL‑endpoints configured including the default URL-endpoint generated by ImageKit during account creation. + * + * @return list + */ + public function list(?RequestOptions $requestOptions = null): array + { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/accounts/url-endpoints', + options: $requestOptions, + convert: new ListOf(URLEndpointResponse::class), + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Deletes the URL‑endpoint identified by `id`. You cannot delete the default URL‑endpoint created by ImageKit during account creation. + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): mixed { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: ['v1/accounts/url-endpoints/%1$s', $id], + options: $requestOptions, + convert: null, + ); + } + + /** + * @api + * + * **Note:** This API is currently in beta. + * Retrieves the URL‑endpoint identified by `id`. + */ + public function get( + string $id, + ?RequestOptions $requestOptions = null + ): URLEndpointResponse { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/accounts/url-endpoints/%1$s', $id], + options: $requestOptions, + convert: URLEndpointResponse::class, + ); + } +} diff --git a/src/Core/Services/Accounts/UsageService.php b/src/Core/Services/Accounts/UsageService.php new file mode 100644 index 00000000..ffba52fa --- /dev/null +++ b/src/Core/Services/Accounts/UsageService.php @@ -0,0 +1,47 @@ + $endDate, 'startDate' => $startDate], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/accounts/usage', + query: $parsed, + options: $options, + convert: UsageGetResponse::class, + ); + } +} diff --git a/src/Core/Services/AccountsService.php b/src/Core/Services/AccountsService.php new file mode 100644 index 00000000..c65638a4 --- /dev/null +++ b/src/Core/Services/AccountsService.php @@ -0,0 +1,39 @@ +usage = new UsageService($this->client); + $this->origins = new OriginsService($this->client); + $this->urlEndpoints = new URLEndpointsService($this->client); + } +} diff --git a/src/Core/Services/AssetsService.php b/src/Core/Services/AssetsService.php new file mode 100644 index 00000000..cd4a536f --- /dev/null +++ b/src/Core/Services/AssetsService.php @@ -0,0 +1,95 @@ + "7d"`. + * + * Note : When the searchQuery parameter is present, the following query parameters will have no effect on the result: + * + * 1. `tags` + * 2. `type` + * 3. `name` + * + * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. + * @param int $skip the number of results to skip before returning results + * @param Sort::* $sort sort the results by one of the supported fields in ascending or descending order + * @param Type::* $type Filter results by asset type. + * + * - `file` — returns only files + * - `file-version` — returns specific file versions + * - `folder` — returns only folders + * - `all` — returns both files and folders (excludes `file-version`) + * + * @return list + */ + public function list( + $fileType = omit, + $limit = omit, + $path = omit, + $searchQuery = omit, + $skip = omit, + $sort = omit, + $type = omit, + ?RequestOptions $requestOptions = null, + ): array { + [$parsed, $options] = AssetListParams::parseRequest( + [ + 'fileType' => $fileType, + 'limit' => $limit, + 'path' => $path, + 'searchQuery' => $searchQuery, + 'skip' => $skip, + 'sort' => $sort, + 'type' => $type, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/files', + query: $parsed, + options: $options, + convert: new ListOf(AssetListResponseItem::class), + ); + } +} diff --git a/src/Core/Services/Beta/V2/FilesService.php b/src/Core/Services/Beta/V2/FilesService.php new file mode 100644 index 00000000..9cb9ef2f --- /dev/null +++ b/src/Core/Services/Beta/V2/FilesService.php @@ -0,0 +1,160 @@ + $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * @param string $description optional text to describe the contents of the file + * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. + * @param bool $isPrivateFile Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + * @param bool $isPublished Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + * @param bool $overwriteAITags If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed + * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately + * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed + * @param list $responseFields array of response field keys to include in the API response body + * @param list $tags Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * @param Transformation $transformation Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + * @param bool $useUniqueFileName Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function upload( + $file, + $fileName, + $token = omit, + $checks = omit, + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $extensions = omit, + $folder = omit, + $isPrivateFile = omit, + $isPublished = omit, + $overwriteAITags = omit, + $overwriteCustomMetadata = omit, + $overwriteFile = omit, + $overwriteTags = omit, + $responseFields = omit, + $tags = omit, + $transformation = omit, + $useUniqueFileName = omit, + $webhookURL = omit, + ?RequestOptions $requestOptions = null, + ): FileUploadResponse { + [$parsed, $options] = FileUploadParams::parseRequest( + [ + 'file' => $file, + 'fileName' => $fileName, + 'token' => $token, + 'checks' => $checks, + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'extensions' => $extensions, + 'folder' => $folder, + 'isPrivateFile' => $isPrivateFile, + 'isPublished' => $isPublished, + 'overwriteAITags' => $overwriteAITags, + 'overwriteCustomMetadata' => $overwriteCustomMetadata, + 'overwriteFile' => $overwriteFile, + 'overwriteTags' => $overwriteTags, + 'responseFields' => $responseFields, + 'tags' => $tags, + 'transformation' => $transformation, + 'useUniqueFileName' => $useUniqueFileName, + 'webhookURL' => $webhookURL, + ], + $requestOptions, + ); + $path = $this + ->client + ->baseUrlOverridden ? 'api/v2/files/upload' : 'https://upload.imagekit.io/api/v2/files/upload'; + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: $path, + headers: ['Content-Type' => 'multipart/form-data'], + body: (object) $parsed, + options: $options, + convert: FileUploadResponse::class, + ); + } +} diff --git a/src/Core/Services/Beta/V2Service.php b/src/Core/Services/Beta/V2Service.php new file mode 100644 index 00000000..425c2750 --- /dev/null +++ b/src/Core/Services/Beta/V2Service.php @@ -0,0 +1,25 @@ +files = new FilesService($this->client); + } +} diff --git a/src/Core/Services/BetaService.php b/src/Core/Services/BetaService.php new file mode 100644 index 00000000..82b57a59 --- /dev/null +++ b/src/Core/Services/BetaService.php @@ -0,0 +1,25 @@ +v2 = new V2Service($this->client); + } +} diff --git a/src/Core/Services/Cache/InvalidationService.php b/src/Core/Services/Cache/InvalidationService.php new file mode 100644 index 00000000..4d66728b --- /dev/null +++ b/src/Core/Services/Cache/InvalidationService.php @@ -0,0 +1,64 @@ + $url], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/purge', + body: (object) $parsed, + options: $options, + convert: InvalidationNewResponse::class, + ); + } + + /** + * @api + * + * This API returns the status of a purge cache request. + */ + public function get( + string $requestID, + ?RequestOptions $requestOptions = null + ): InvalidationGetResponse { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/files/purge/%1$s', $requestID], + options: $requestOptions, + convert: InvalidationGetResponse::class, + ); + } +} diff --git a/src/Core/Services/CacheService.php b/src/Core/Services/CacheService.php new file mode 100644 index 00000000..1fd48de0 --- /dev/null +++ b/src/Core/Services/CacheService.php @@ -0,0 +1,25 @@ +invalidation = new InvalidationService($this->client); + } +} diff --git a/src/Core/Services/CustomMetadataFieldsService.php b/src/Core/Services/CustomMetadataFieldsService.php new file mode 100644 index 00000000..1c8a67bd --- /dev/null +++ b/src/Core/Services/CustomMetadataFieldsService.php @@ -0,0 +1,132 @@ + $label, 'name' => $name, 'schema' => $schema], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/customMetadataFields', + body: (object) $parsed, + options: $options, + convert: CustomMetadataField::class, + ); + } + + /** + * @api + * + * This API updates the label or schema of an existing custom metadata field. + * + * @param string $label Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if `schema` is not provided. + * @param Schema1 $schema An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. + */ + public function update( + string $id, + $label = omit, + $schema = omit, + ?RequestOptions $requestOptions = null, + ): CustomMetadataField { + [$parsed, $options] = CustomMetadataFieldUpdateParams::parseRequest( + ['label' => $label, 'schema' => $schema], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'patch', + path: ['v1/customMetadataFields/%1$s', $id], + body: (object) $parsed, + options: $options, + convert: CustomMetadataField::class, + ); + } + + /** + * @api + * + * This API returns the array of created custom metadata field objects. By default the API returns only non deleted field objects, but you can include deleted fields in the API response. + * + * @param bool $includeDeleted set it to `true` to include deleted field objects in the API response + * + * @return list + */ + public function list( + $includeDeleted = omit, + ?RequestOptions $requestOptions = null + ): array { + [$parsed, $options] = CustomMetadataFieldListParams::parseRequest( + ['includeDeleted' => $includeDeleted], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/customMetadataFields', + query: $parsed, + options: $options, + convert: new ListOf(CustomMetadataField::class), + ); + } + + /** + * @api + * + * This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name. + */ + public function delete( + string $id, + ?RequestOptions $requestOptions = null + ): CustomMetadataFieldDeleteResponse { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: ['v1/customMetadataFields/%1$s', $id], + options: $requestOptions, + convert: CustomMetadataFieldDeleteResponse::class, + ); + } +} diff --git a/src/Core/Services/Files/BulkService.php b/src/Core/Services/Files/BulkService.php new file mode 100644 index 00000000..23fc95dd --- /dev/null +++ b/src/Core/Services/Files/BulkService.php @@ -0,0 +1,139 @@ + $fileIDs an array of fileIds which you want to delete + */ + public function delete( + $fileIDs, + ?RequestOptions $requestOptions = null + ): BulkDeleteResponse { + [$parsed, $options] = BulkDeleteParams::parseRequest( + ['fileIDs' => $fileIDs], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/batch/deleteByFileIds', + body: (object) $parsed, + options: $options, + convert: BulkDeleteResponse::class, + ); + } + + /** + * @api + * + * This API adds tags to multiple files in bulk. A maximum of 50 files can be specified at a time. + * + * @param list $fileIDs an array of fileIds to which you want to add tags + * @param list $tags an array of tags that you want to add to the files + */ + public function addTags( + $fileIDs, + $tags, + ?RequestOptions $requestOptions = null + ): BulkAddTagsResponse { + [$parsed, $options] = BulkAddTagsParams::parseRequest( + ['fileIDs' => $fileIDs, 'tags' => $tags], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/addTags', + body: (object) $parsed, + options: $options, + convert: BulkAddTagsResponse::class, + ); + } + + /** + * @api + * + * This API removes AITags from multiple files in bulk. A maximum of 50 files can be specified at a time. + * + * @param list $aiTags an array of AITags that you want to remove from the files + * @param list $fileIDs an array of fileIds from which you want to remove AITags + */ + public function removeAITags( + $aiTags, + $fileIDs, + ?RequestOptions $requestOptions = null + ): BulkRemoveAITagsResponse { + [$parsed, $options] = BulkRemoveAITagsParams::parseRequest( + ['aiTags' => $aiTags, 'fileIDs' => $fileIDs], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/removeAITags', + body: (object) $parsed, + options: $options, + convert: BulkRemoveAITagsResponse::class, + ); + } + + /** + * @api + * + * This API removes tags from multiple files in bulk. A maximum of 50 files can be specified at a time. + * + * @param list $fileIDs an array of fileIds from which you want to remove tags + * @param list $tags an array of tags that you want to remove from the files + */ + public function removeTags( + $fileIDs, + $tags, + ?RequestOptions $requestOptions = null + ): BulkRemoveTagsResponse { + [$parsed, $options] = BulkRemoveTagsParams::parseRequest( + ['fileIDs' => $fileIDs, 'tags' => $tags], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/removeTags', + body: (object) $parsed, + options: $options, + convert: BulkRemoveTagsResponse::class, + ); + } +} diff --git a/src/Core/Services/Files/MetadataService.php b/src/Core/Services/Files/MetadataService.php new file mode 100644 index 00000000..4c47b2ec --- /dev/null +++ b/src/Core/Services/Files/MetadataService.php @@ -0,0 +1,65 @@ +client->request( + method: 'get', + path: ['v1/files/%1$s/metadata', $fileID], + options: $requestOptions, + convert: Metadata::class, + ); + } + + /** + * @api + * + * Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL using this API. + * + * @param string $url Should be a valid file URL. It should be accessible using your ImageKit.io account. + */ + public function getFromURL( + $url, + ?RequestOptions $requestOptions = null + ): Metadata { + [$parsed, $options] = MetadataGetFromURLParams::parseRequest( + ['url' => $url], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: 'v1/files/metadata', + query: $parsed, + options: $options, + convert: Metadata::class, + ); + } +} diff --git a/src/Core/Services/Files/VersionsService.php b/src/Core/Services/Files/VersionsService.php new file mode 100644 index 00000000..0c62d1e2 --- /dev/null +++ b/src/Core/Services/Files/VersionsService.php @@ -0,0 +1,129 @@ + + */ + public function list( + string $fileID, + ?RequestOptions $requestOptions = null + ): array { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/files/%1$s/versions', $fileID], + options: $requestOptions, + convert: new ListOf(File::class), + ); + } + + /** + * @api + * + * This API deletes a non-current file version permanently. The API returns an empty response. + * + * Note: If you want to delete all versions of a file, use the delete file API. + * + * @param string $fileID + */ + public function delete( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): VersionDeleteResponse { + [$parsed, $options] = VersionDeleteParams::parseRequest( + ['fileID' => $fileID], + $requestOptions + ); + $fileID = $parsed['fileID']; + unset($parsed['fileID']); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: ['v1/files/%1$s/versions/%2$s', $fileID, $versionID], + options: $options, + convert: VersionDeleteResponse::class, + ); + } + + /** + * @api + * + * This API returns an object with details or attributes of a file version. + * + * @param string $fileID + */ + public function get( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): File { + [$parsed, $options] = VersionGetParams::parseRequest( + ['fileID' => $fileID], + $requestOptions + ); + $fileID = $parsed['fileID']; + unset($parsed['fileID']); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/files/%1$s/versions/%2$s', $fileID, $versionID], + options: $options, + convert: File::class, + ); + } + + /** + * @api + * + * This API restores a file version as the current file version. + * + * @param string $fileID + */ + public function restore( + string $versionID, + $fileID, + ?RequestOptions $requestOptions = null + ): File { + [$parsed, $options] = VersionRestoreParams::parseRequest( + ['fileID' => $fileID], + $requestOptions + ); + $fileID = $parsed['fileID']; + unset($parsed['fileID']); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'put', + path: ['v1/files/%1$s/versions/%2$s/restore', $fileID, $versionID], + options: $options, + convert: File::class, + ); + } +} diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php new file mode 100644 index 00000000..5eb5ecbf --- /dev/null +++ b/src/Core/Services/FilesService.php @@ -0,0 +1,401 @@ +bulk = new BulkService($this->client); + $this->versions = new VersionsService($this->client); + $this->metadata = new MetadataService($this->client); + } + + /** + * @api + * + * This API updates the details or attributes of the current version of the file. You can update `tags`, `customCoordinates`, `customMetadata`, publication status, remove existing `AITags` and apply extensions using this API. + * + * @param UpdateFileDetails|ChangePublicationStatus $update + */ + public function update( + string $fileID, + $update = omit, + ?RequestOptions $requestOptions = null + ): FileUpdateResponse { + [$parsed, $options] = FileUpdateParams::parseRequest( + ['update' => $update], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'patch', + path: ['v1/files/%1$s/details', $fileID], + body: (object) $parsed['update'], + options: $options, + convert: FileUpdateResponse::class, + ); + } + + /** + * @api + * + * This API deletes the file and all its file versions permanently. + * + * Note: If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. You can purge the cache using purge cache API. + */ + public function delete( + string $fileID, + ?RequestOptions $requestOptions = null + ): mixed { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: ['v1/files/%1$s', $fileID], + options: $requestOptions, + convert: null, + ); + } + + /** + * @api + * + * This will copy a file from one folder to another. + * + * Note: If any file at the destination has the same name as the source file, then the source file and its versions (if `includeFileVersions` is set to true) will be appended to the destination file version history. + * + * @param string $destinationPath full path to the folder you want to copy the above file into + * @param string $sourceFilePath the full path of the file you want to copy + * @param bool $includeFileVersions Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. + */ + public function copy( + $destinationPath, + $sourceFilePath, + $includeFileVersions = omit, + ?RequestOptions $requestOptions = null, + ): FileCopyResponse { + [$parsed, $options] = FileCopyParams::parseRequest( + [ + 'destinationPath' => $destinationPath, + 'sourceFilePath' => $sourceFilePath, + 'includeFileVersions' => $includeFileVersions, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/copy', + body: (object) $parsed, + options: $options, + convert: FileCopyResponse::class, + ); + } + + /** + * @api + * + * This API returns an object with details or attributes about the current version of the file. + */ + public function get( + string $fileID, + ?RequestOptions $requestOptions = null + ): File { + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'get', + path: ['v1/files/%1$s/details', $fileID], + options: $requestOptions, + convert: File::class, + ); + } + + /** + * @api + * + * This will move a file and all its versions from one folder to another. + * + * Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file. + * + * @param string $destinationPath full path to the folder you want to move the above file into + * @param string $sourceFilePath the full path of the file you want to move + */ + public function move( + $destinationPath, + $sourceFilePath, + ?RequestOptions $requestOptions = null + ): FileMoveResponse { + [$parsed, $options] = FileMoveParams::parseRequest( + [ + 'destinationPath' => $destinationPath, + 'sourceFilePath' => $sourceFilePath, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/files/move', + body: (object) $parsed, + options: $options, + convert: FileMoveResponse::class, + ); + } + + /** + * @api + * + * You can rename an already existing file in the media library using rename file API. This operation would rename all file versions of the file. + * + * Note: The old URLs will stop working. The file/file version URLs cached on CDN will continue to work unless a purge is requested. + * + * @param string $filePath the full path of the file you want to rename + * @param string $newFileName The new name of the file. A filename can contain: + * + * Alphanumeric Characters: `a-z`, `A-Z`, `0-9` (including Unicode letters, marks, and numerals in other languages). + * Special Characters: `.`, `_`, and `-`. + * + * Any other character, including space, will be replaced by `_`. + * @param bool $purgeCache Option to purge cache for the old file and its versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove cached content of old file and its versions. This purge request is counted against your monthly purge quota. + * + * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * Default value - `false` + */ + public function rename( + $filePath, + $newFileName, + $purgeCache = omit, + ?RequestOptions $requestOptions = null, + ): FileRenameResponse { + [$parsed, $options] = FileRenameParams::parseRequest( + [ + 'filePath' => $filePath, + 'newFileName' => $newFileName, + 'purgeCache' => $purgeCache, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'put', + path: 'v1/files/rename', + body: (object) $parsed, + options: $options, + convert: FileRenameResponse::class, + ); + } + + /** + * @api + * + * ImageKit.io allows you to upload files directly from both the server and client sides. For server-side uploads, private API key authentication is used. For client-side uploads, generate a one-time `token`, `signature`, and `expire` from your secure backend using private API. [Learn more](/docs/api-reference/upload-file/upload-file#how-to-implement-client-side-file-upload) about how to implement client-side file upload. + * + * The [V2 API](/docs/api-reference/upload-file/upload-file-v2) enhances security by verifying the entire payload using JWT. + * + * **File size limit** \ + * On the free plan, the maximum upload file sizes are 20MB for images, audio, and raw files and 100MB for videos. On the paid plan, these limits increase to 40MB for images, audio, and raw files and 2GB for videos. These limits can be further increased with higher-tier plans. + * + * **Version limit** \ + * A file can have a maximum of 100 versions. + * + * **Demo applications** + * + * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. + * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. + * + * @param string $file The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $fileName The name with which the file has to be uploaded. + * The file name can contain: + * + * - Alphanumeric Characters: `a-z`, `A-Z`, `0-9`. + * - Special Characters: `.`, `-` + * + * Any other character including space will be replaced by `_` + * @param string $token A unique value that the ImageKit.io server will use to recognize and prevent subsequent retries for the same request. We suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. This field is only required for authentication when uploading a file from the client side. + * + * **Note**: Sending a value that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new value for this field. + * @param string $checks Server-side checks to run on the asset. + * Read more about [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + * @param string $customCoordinates Define an important area in the image. This is only relevant for image type files. + * + * - To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format `x,y,width,height`. For example - `10,10,100,100` + * - Can be used with fo-customtransformation. + * - If this field is not specified and the file is overwritten, then customCoordinates will be removed. + * @param array $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * @param string $description optional text to describe the contents of the file + * @param int $expire The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. + * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. + * + * The folder name can contain: + * + * - Alphanumeric Characters: `a-z` , `A-Z` , `0-9` + * - Special Characters: `/` , `_` , `-` + * + * Using multiple `/` creates a nested folder. + * @param bool $isPrivateFile Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + * @param bool $isPublished Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + * @param bool $overwriteAITags If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed + * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately + * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed + * @param string $publicKey Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. + * @param list $responseFields array of response field keys to include in the API response body + * @param string $signature HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. + * + * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. + * @param list $tags Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * @param Transformation $transformation Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + * @param bool $useUniqueFileName Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function upload( + $file, + $fileName, + $token = omit, + $checks = omit, + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $expire = omit, + $extensions = omit, + $folder = omit, + $isPrivateFile = omit, + $isPublished = omit, + $overwriteAITags = omit, + $overwriteCustomMetadata = omit, + $overwriteFile = omit, + $overwriteTags = omit, + $publicKey = omit, + $responseFields = omit, + $signature = omit, + $tags = omit, + $transformation = omit, + $useUniqueFileName = omit, + $webhookURL = omit, + ?RequestOptions $requestOptions = null, + ): FileUploadResponse { + [$parsed, $options] = FileUploadParams::parseRequest( + [ + 'file' => $file, + 'fileName' => $fileName, + 'token' => $token, + 'checks' => $checks, + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'expire' => $expire, + 'extensions' => $extensions, + 'folder' => $folder, + 'isPrivateFile' => $isPrivateFile, + 'isPublished' => $isPublished, + 'overwriteAITags' => $overwriteAITags, + 'overwriteCustomMetadata' => $overwriteCustomMetadata, + 'overwriteFile' => $overwriteFile, + 'overwriteTags' => $overwriteTags, + 'publicKey' => $publicKey, + 'responseFields' => $responseFields, + 'signature' => $signature, + 'tags' => $tags, + 'transformation' => $transformation, + 'useUniqueFileName' => $useUniqueFileName, + 'webhookURL' => $webhookURL, + ], + $requestOptions, + ); + $path = $this + ->client + ->baseUrlOverridden ? 'api/v1/files/upload' : 'https://upload.imagekit.io/api/v1/files/upload'; + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: $path, + headers: ['Content-Type' => 'multipart/form-data'], + body: (object) $parsed, + options: $options, + convert: FileUploadResponse::class, + ); + } +} diff --git a/src/Core/Services/Folders/JobService.php b/src/Core/Services/Folders/JobService.php new file mode 100644 index 00000000..bb21f3bf --- /dev/null +++ b/src/Core/Services/Folders/JobService.php @@ -0,0 +1,36 @@ +client->request( + method: 'get', + path: ['v1/bulkJobs/%1$s', $jobID], + options: $requestOptions, + convert: JobGetResponse::class, + ); + } +} diff --git a/src/Core/Services/FoldersService.php b/src/Core/Services/FoldersService.php new file mode 100644 index 00000000..31fd4ac5 --- /dev/null +++ b/src/Core/Services/FoldersService.php @@ -0,0 +1,203 @@ +job = new JobService($this->client); + } + + /** + * @api + * + * This will create a new folder. You can specify the folder name and location of the parent folder where this new folder should be created. + * + * @param string $folderName The folder will be created with this name. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) will be replaced by an underscore i.e. `_`. + * @param string $parentFolderPath The folder where the new folder should be created, for root use `/` else the path e.g. `containing/folder/`. + * + * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. + */ + public function create( + $folderName, + $parentFolderPath, + ?RequestOptions $requestOptions = null + ): FolderNewResponse { + [$parsed, $options] = FolderCreateParams::parseRequest( + ['folderName' => $folderName, 'parentFolderPath' => $parentFolderPath], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/folder', + body: (object) $parsed, + options: $options, + convert: FolderNewResponse::class, + ); + } + + /** + * @api + * + * This will delete a folder and all its contents permanently. The API returns an empty response. + * + * @param string $folderPath Full path to the folder you want to delete. For example `/folder/to/delete/`. + */ + public function delete( + $folderPath, + ?RequestOptions $requestOptions = null + ): FolderDeleteResponse { + [$parsed, $options] = FolderDeleteParams::parseRequest( + ['folderPath' => $folderPath], + $requestOptions + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'delete', + path: 'v1/folder', + body: (object) $parsed, + options: $options, + convert: FolderDeleteResponse::class, + ); + } + + /** + * @api + * + * This will copy one folder into another. The selected folder, its nested folders, files, and their versions (in `includeVersions` is set to true) are copied in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history. + * + * @param string $destinationPath full path to the destination folder where you want to copy the source folder into + * @param string $sourceFolderPath the full path to the source folder you want to copy + * @param bool $includeVersions Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. + */ + public function copy( + $destinationPath, + $sourceFolderPath, + $includeVersions = omit, + ?RequestOptions $requestOptions = null, + ): FolderCopyResponse { + [$parsed, $options] = FolderCopyParams::parseRequest( + [ + 'destinationPath' => $destinationPath, + 'sourceFolderPath' => $sourceFolderPath, + 'includeVersions' => $includeVersions, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/bulkJobs/copyFolder', + body: (object) $parsed, + options: $options, + convert: FolderCopyResponse::class, + ); + } + + /** + * @api + * + * This will move one folder into another. The selected folder, its nested folders, files, and their versions are moved in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history. + * + * @param string $destinationPath full path to the destination folder where you want to move the source folder into + * @param string $sourceFolderPath the full path to the source folder you want to move + */ + public function move( + $destinationPath, + $sourceFolderPath, + ?RequestOptions $requestOptions = null + ): FolderMoveResponse { + [$parsed, $options] = FolderMoveParams::parseRequest( + [ + 'destinationPath' => $destinationPath, + 'sourceFolderPath' => $sourceFolderPath, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/bulkJobs/moveFolder', + body: (object) $parsed, + options: $options, + convert: FolderMoveResponse::class, + ); + } + + /** + * @api + * + * This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name. + * + * @param string $folderPath the full path to the folder you want to rename + * @param string $newFolderName The new name for the folder. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and `-` will be replaced by an underscore i.e. `_`. + * @param bool $purgeCache Option to purge cache for the old nested files and their versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota. + * + * Note: A purge cache request will be issued against `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * Default value - `false` + */ + public function rename( + $folderPath, + $newFolderName, + $purgeCache = omit, + ?RequestOptions $requestOptions = null, + ): FolderRenameResponse { + [$parsed, $options] = FolderRenameParams::parseRequest( + [ + 'folderPath' => $folderPath, + 'newFolderName' => $newFolderName, + 'purgeCache' => $purgeCache, + ], + $requestOptions, + ); + + // @phpstan-ignore-next-line; + return $this->client->request( + method: 'post', + path: 'v1/bulkJobs/renameFolder', + body: (object) $parsed, + options: $options, + convert: FolderRenameResponse::class, + ); + } +} diff --git a/src/Core/Services/WebhooksService.php b/src/Core/Services/WebhooksService.php new file mode 100644 index 00000000..bbcf1195 --- /dev/null +++ b/src/Core/Services/WebhooksService.php @@ -0,0 +1,16 @@ + + */ + public static function get_object_vars(object $object1): array + { + return get_object_vars($object1); + } + + /** + * @template T + * + * @param array $array + * @param array $map + * + * @return array + */ + public static function array_transform_keys(array $array, array $map): array + { + $acc = []; + foreach ($array as $key => $value) { + $acc[$map[$key] ?? $key] = $value; + } + + return $acc; + } + + /** + * @param array $arr + * + * @return array + */ + public static function array_filter_omit(array $arr): array + { + return array_filter($arr, fn ($v, $_) => OMIT !== $v, mode: ARRAY_FILTER_USE_BOTH); + } + + /** + * @param string|int|list|callable $key + */ + public static function dig( + mixed $array, + string|int|array|callable $key + ): mixed { + if (is_callable($key)) { + return $key($array); + } + + if (is_array($array)) { + if ((is_string($key) || is_int($key)) && array_key_exists($key, array: $array)) { + return $array[$key]; + } + + if (is_array($key) && !empty($key)) { + if (array_key_exists($fst = $key[0], array: $array)) { + return self::dig($array[$fst], key: array_slice($key, 1)); + } + } + } + + return null; + } + + /** + * @param string|list $path + */ + public static function parsePath(string|array $path): string + { + if (is_string($path)) { + return $path; + } + + if (empty($path)) { + return ''; + } + + [$template] = $path; + + return sprintf($template, ...array_map('rawurlencode', array: array_slice($path, 1))); + } + + /** + * @param array $query + */ + public static function joinUri( + UriInterface $base, + string $path, + array $query = [] + ): UriInterface { + $parsed = parse_url($path); + if ($scheme = $parsed['scheme'] ?? null) { + $base = $base->withScheme($scheme); + } + if ($host = $parsed['host'] ?? null) { + $base = $base->withHost($host); + } + if ($port = $parsed['port'] ?? null) { + $base = $base->withPort($port); + } + if (($user = $parsed['user'] ?? null) || ($pass = $parsed['pass'] ?? null)) { + $base = $base->withUserInfo($user ?? '', $pass ?? null); + } + if ($path = $parsed['path'] ?? null) { + $base = str_starts_with($path, '/') ? $base->withPath($path) : $base->withPath($base->getPath().'/'.$path); + } + + [$q1, $q2] = [[], []]; + parse_str($base->getQuery(), $q1); + parse_str($parsed['query'] ?? '', $q2); + + $merged_query = array_merge_recursive($q1, $q2, $query); + $qs = http_build_query($merged_query, encoding_type: PHP_QUERY_RFC3986); + + return $base->withQuery($qs); + } + + /** + * @param array|null> $headers + */ + public static function withSetHeaders( + RequestInterface $req, + array $headers + ): RequestInterface { + foreach ($headers as $name => $value) { + if (is_null($value)) { + $req = $req->withoutHeader($name); + } else { + $value = is_int($value) + ? (string) $value + : (is_array($value) + ? array_map(static fn ($v) => (string) $v, array: $value) + : $value); + $req = $req->withHeader($name, $value); + } + } + + return $req; + } + + /** + * @return \Iterator + */ + public static function streamIterator(StreamInterface $stream): \Iterator + { + if (!$stream->isReadable()) { + return; + } + + try { + while (!$stream->eof()) { + yield $stream->read(self::BUF_SIZE); + } + } finally { + $stream->close(); + } + } + + /** + * @param bool|int|float|string|resource|\Traversable|array|null $body + */ + public static function withSetBody( + StreamFactoryInterface $factory, + RequestInterface $req, + mixed $body + ): RequestInterface { + if ($body instanceof StreamInterface) { + return $req->withBody($body); + } + + $contentType = $req->getHeaderLine('Content-Type'); + if (preg_match(self::JSON_CONTENT_TYPE, $contentType)) { + if (is_array($body) || is_object($body)) { + $encoded = json_encode($body, flags: self::JSON_ENCODE_FLAGS); + $stream = $factory->createStream($encoded); + + return $req->withBody($stream); + } + } + + if (preg_match('/^multipart\/form-data/', $contentType)) { + [$boundary, $gen] = self::encodeMultipartStreaming($body); + $encoded = implode('', iterator_to_array($gen)); + $stream = $factory->createStream($encoded); + + return $req->withHeader('Content-Type', "{$contentType}; boundary={$boundary}")->withBody($stream); + } + + if (is_resource($body)) { + $stream = $factory->createStreamFromResource($body); + + return $req->withBody($stream); + } + + return $req; + } + + /** + * @param \Iterator $stream + * + * @return \Iterator + */ + public static function decodeLines(\Iterator $stream): \Iterator + { + $buf = ''; + foreach ($stream as $chunk) { + $buf .= $chunk; + while (($pos = strpos($buf, "\n")) !== false) { + yield substr($buf, 0, $pos); + $buf = substr($buf, $pos + 1); + } + } + if ('' !== $buf) { + yield $buf; + } + } + + /** + * @param \Iterator $lines + * + * @return \Generator< + * array{ + * event?: string|null, data?: string|null, id?: string|null, retry?: int|null + * }, + * > + */ + public static function decodeSSE(\Iterator $lines): \Generator + { + $blank = ['event' => null, 'data' => null, 'id' => null, 'retry' => null]; + $acc = []; + + foreach ($lines as $line) { + $line = rtrim($line); + if ('' === $line) { + if (empty($acc)) { + continue; + } + + yield [...$blank, ...$acc]; + $acc = []; + } + + if (str_starts_with($line, ':')) { + continue; + } + + $matches = []; + if (preg_match('/^([^:]+):\s?(.*)$/', $line, $matches)) { + [, $field, $value] = $matches; + + switch ($field) { + case 'event': + $acc['event'] = $value; + + break; + + case 'data': + if (isset($acc['data'])) { + $acc['data'] .= "\n".$value; + } else { + $acc['data'] = $value; + } + + break; + + case 'id': + $acc['id'] = $value; + + break; + + case 'retry': + $acc['retry'] = (int) $value; + + break; + } + } + } + + if (!empty($acc)) { + yield [...$blank, ...$acc]; + } + } + + public static function decodeJson(string $json): mixed + { + return json_decode($json, associative: true, flags: JSON_THROW_ON_ERROR); + } + + public static function decodeContent(ResponseInterface $rsp): mixed + { + if (204 == $rsp->getStatusCode()) { + return null; + } + + $content_type = $rsp->getHeaderLine('Content-Type'); + $body = $rsp->getBody(); + + if (preg_match(self::JSON_CONTENT_TYPE, subject: $content_type)) { + $json = $body->getContents(); + + return self::decodeJson($json); + } + + if (preg_match(self::JSONL_CONTENT_TYPE, subject: $content_type)) { + $it = self::streamIterator($body); + $lines = self::decodeLines($it); + + return (function () use ($lines) { + foreach ($lines as $line) { + yield static::decodeJson($line); + } + })(); + } + + if (str_contains($content_type, needle: 'text/event-stream')) { + $it = self::streamIterator($body); + $lines = self::decodeLines($it); + + return self::decodeSSE($lines); + } + + return self::streamIterator($body); + } + + public static function prettyEncodeJson(mixed $obj): string + { + return json_encode($obj, flags: JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT) ?: ''; + } + + /** + * @param list $closing + * + * @return \Generator + */ + private static function writeMultipartContent( + mixed $val, + array &$closing, + ?string $contentType = null + ): \Generator { + $contentLine = "Content-Type: %s\r\n\r\n"; + + if (is_resource($val)) { + yield sprintf($contentLine, $contentType ?? 'application/octet-stream'); + while (!feof($val)) { + if ($read = fread($val, length: self::BUF_SIZE)) { + yield $read; + } + } + } elseif (is_string($val) || is_numeric($val) || is_bool($val)) { + yield sprintf($contentLine, $contentType ?? 'text/plain'); + + yield (string) $val; + } else { + yield sprintf($contentLine, $contentType ?? 'application/json'); + + yield json_encode($val, flags: self::JSON_ENCODE_FLAGS); + } + + yield "\r\n"; + } + + /** + * @param list $closing + * + * @return \Generator + */ + private static function writeMultipartChunk( + string $boundary, + ?string $key, + mixed $val, + array &$closing + ): \Generator { + yield "--{$boundary}\r\n"; + + yield 'Content-Disposition: form-data'; + + if (!is_null($key)) { + $name = rawurlencode($key); + + yield "; name=\"{$name}\""; + } + + yield "\r\n"; + foreach (self::writeMultipartContent($val, closing: $closing) as $chunk) { + yield $chunk; + } + } + + /** + * @param bool|int|float|string|resource|\Traversable|array|null $body + * + * @return array{string, \Generator} + */ + private static function encodeMultipartStreaming(mixed $body): array + { + $boundary = rtrim(strtr(base64_encode(random_bytes(60)), '+/', '-_'), '='); + $gen = (function () use ($boundary, $body) { + $closing = []; + + try { + if (is_array($body) || is_object($body)) { + foreach ((array) $body as $key => $val) { + foreach (static::writeMultipartChunk(boundary: $boundary, key: $key, val: $val, closing: $closing) as $chunk) { + yield $chunk; + } + } + } else { + foreach (static::writeMultipartChunk(boundary: $boundary, key: null, val: $body, closing: $closing) as $chunk) { + yield $chunk; + } + } + + yield "--{$boundary}--\r\n"; + } finally { + foreach ($closing as $c) { + $c(); + } + } + })(); + + return [$boundary, $gen]; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField.php b/src/CustomMetadataFields/CustomMetadataField.php new file mode 100644 index 00000000..ddc9c662 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField.php @@ -0,0 +1,135 @@ + */ + use SdkModel; + + /** + * Unique identifier for the custom metadata field. Use this to update the field. + */ + #[Api] + public string $id; + + /** + * Human readable name of the custom metadata field. This name is displayed as form field label to the users while setting field value on the asset in the media library UI. + */ + #[Api] + public string $label; + + /** + * API name of the custom metadata field. This becomes the key while setting `customMetadata` (key-value object) for an asset using upload or update API. + */ + #[Api] + public string $name; + + /** + * An object that describes the rules for the custom metadata field value. + */ + #[Api] + public Schema $schema; + + /** + * `new CustomMetadataField()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * CustomMetadataField::with(id: ..., label: ..., name: ..., schema: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new CustomMetadataField) + * ->withID(...) + * ->withLabel(...) + * ->withName(...) + * ->withSchema(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + string $label, + string $name, + Schema $schema + ): self { + $obj = new self; + + $obj->id = $id; + $obj->label = $label; + $obj->name = $name; + $obj->schema = $schema; + + return $obj; + } + + /** + * Unique identifier for the custom metadata field. Use this to update the field. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Human readable name of the custom metadata field. This name is displayed as form field label to the users while setting field value on the asset in the media library UI. + */ + public function withLabel(string $label): self + { + $obj = clone $this; + $obj->label = $label; + + return $obj; + } + + /** + * API name of the custom metadata field. This becomes the key while setting `customMetadata` (key-value object) for an asset using upload or update API. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * An object that describes the rules for the custom metadata field value. + */ + public function withSchema(Schema $schema): self + { + $obj = clone $this; + $obj->schema = $schema; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema.php b/src/CustomMetadataFields/CustomMetadataField/Schema.php new file mode 100644 index 00000000..c1f7bead --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema.php @@ -0,0 +1,234 @@ +, + * isValueRequired?: bool|null, + * maxLength?: float|null, + * maxValue?: string|float|null, + * minLength?: float|null, + * minValue?: string|float|null, + * selectOptions?: list|null, + * } + */ +final class Schema implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Type of the custom metadata field. + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * The default value for this custom metadata field. Date type of default value depends on the field type. + * + * @var string|float|bool|list|null $defaultValue + */ + #[Api(union: DefaultValue::class, optional: true)] + public string|float|bool|array|null $defaultValue; + + /** + * Specifies if the this custom metadata field is required or not. + */ + #[Api(optional: true)] + public ?bool $isValueRequired; + + /** + * Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $maxLength; + + /** + * Maximum value of the field. Only set if field type is `Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value. + */ + #[Api(optional: true)] + public string|float|null $maxValue; + + /** + * Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $minLength; + + /** + * Minimum value of the field. Only set if field type is `Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value. + */ + #[Api(optional: true)] + public string|float|null $minValue; + + /** + * An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + * + * @var list|null $selectOptions + */ + #[Api(list: SelectOption::class, optional: true)] + public ?array $selectOptions; + + /** + * `new Schema()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Schema::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Schema)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + * @param string|float|bool|list $defaultValue + * @param list $selectOptions + */ + public static function with( + string $type, + string|float|bool|array|null $defaultValue = null, + ?bool $isValueRequired = null, + ?float $maxLength = null, + string|float|null $maxValue = null, + ?float $minLength = null, + string|float|null $minValue = null, + ?array $selectOptions = null, + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $defaultValue && $obj->defaultValue = $defaultValue; + null !== $isValueRequired && $obj->isValueRequired = $isValueRequired; + null !== $maxLength && $obj->maxLength = $maxLength; + null !== $maxValue && $obj->maxValue = $maxValue; + null !== $minLength && $obj->minLength = $minLength; + null !== $minValue && $obj->minValue = $minValue; + null !== $selectOptions && $obj->selectOptions = $selectOptions; + + return $obj; + } + + /** + * Type of the custom metadata field. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * The default value for this custom metadata field. Date type of default value depends on the field type. + * + * @param string|float|bool|list $defaultValue + */ + public function withDefaultValue( + string|float|bool|array $defaultValue + ): self { + $obj = clone $this; + $obj->defaultValue = $defaultValue; + + return $obj; + } + + /** + * Specifies if the this custom metadata field is required or not. + */ + public function withIsValueRequired(bool $isValueRequired): self + { + $obj = clone $this; + $obj->isValueRequired = $isValueRequired; + + return $obj; + } + + /** + * Maximum length of string. Only set if `type` is set to `Text` or `Textarea`. + */ + public function withMaxLength(float $maxLength): self + { + $obj = clone $this; + $obj->maxLength = $maxLength; + + return $obj; + } + + /** + * Maximum value of the field. Only set if field type is `Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value. + */ + public function withMaxValue(string|float $maxValue): self + { + $obj = clone $this; + $obj->maxValue = $maxValue; + + return $obj; + } + + /** + * Minimum length of string. Only set if `type` is set to `Text` or `Textarea`. + */ + public function withMinLength(float $minLength): self + { + $obj = clone $this; + $obj->minLength = $minLength; + + return $obj; + } + + /** + * Minimum value of the field. Only set if field type is `Date` or `Number`. For `Date` type field, the value will be in ISO8601 string format. For `Number` type field, it will be a numeric value. + */ + public function withMinValue(string|float $minValue): self + { + $obj = clone $this; + $obj->minValue = $minValue; + + return $obj; + } + + /** + * An array of allowed values when field type is `SingleSelect` or `MultiSelect`. + * + * @param list $selectOptions + */ + public function withSelectOptions(array $selectOptions): self + { + $obj = clone $this; + $obj->selectOptions = $selectOptions; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue.php b/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue.php new file mode 100644 index 00000000..6be6b638 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool', new ListOf(Mixed::class)]; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue/Mixed.php b/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue/Mixed.php new file mode 100644 index 00000000..eb17c055 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/DefaultValue/Mixed.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/MaxValue.php b/src/CustomMetadataFields/CustomMetadataField/Schema/MaxValue.php new file mode 100644 index 00000000..98596244 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/MaxValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/MinValue.php b/src/CustomMetadataFields/CustomMetadataField/Schema/MinValue.php new file mode 100644 index 00000000..0f866656 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/MinValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/SelectOption.php b/src/CustomMetadataFields/CustomMetadataField/Schema/SelectOption.php new file mode 100644 index 00000000..ab5d2a23 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/SelectOption.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php b/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php new file mode 100644 index 00000000..2e567bd1 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php @@ -0,0 +1,30 @@ +create + * + * @phpstan-type custom_metadata_field_create_params = array{ + * label: string, name: string, schema: Schema + * } + */ +final class CustomMetadataFieldCreateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. + */ + #[Api] + public string $label; + + /** + * API name of the custom metadata field. This should be unique across all (including deleted) custom metadata fields. + */ + #[Api] + public string $name; + + #[Api] + public Schema $schema; + + /** + * `new CustomMetadataFieldCreateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * CustomMetadataFieldCreateParams::with(label: ..., name: ..., schema: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new CustomMetadataFieldCreateParams) + * ->withLabel(...) + * ->withName(...) + * ->withSchema(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $label, + string $name, + Schema $schema + ): self { + $obj = new self; + + $obj->label = $label; + $obj->name = $name; + $obj->schema = $schema; + + return $obj; + } + + /** + * Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. + */ + public function withLabel(string $label): self + { + $obj = clone $this; + $obj->label = $label; + + return $obj; + } + + /** + * API name of the custom metadata field. This should be unique across all (including deleted) custom metadata fields. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + public function withSchema(Schema $schema): self + { + $obj = clone $this; + $obj->schema = $schema; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php new file mode 100644 index 00000000..397ec2bb --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php @@ -0,0 +1,232 @@ +, + * isValueRequired?: bool|null, + * maxLength?: float|null, + * maxValue?: string|float|null, + * minLength?: float|null, + * minValue?: string|float|null, + * selectOptions?: list|null, + * } + */ +final class Schema implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Type of the custom metadata field. + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * The default value for this custom metadata field. This property is only required if `isValueRequired` property is set to `true`. The value should match the `type` of custom metadata field. + * + * @var string|float|bool|list|null $defaultValue + */ + #[Api(union: DefaultValue::class, optional: true)] + public string|float|bool|array|null $defaultValue; + + /** + * Sets this custom metadata field as required. Setting custom metadata fields on an asset will throw error if the value for all required fields are not present in upload or update asset API request body. + */ + #[Api(optional: true)] + public ?bool $isValueRequired; + + /** + * Maximum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $maxLength; + + /** + * Maximum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + #[Api(optional: true)] + public string|float|null $maxValue; + + /** + * Minimum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $minLength; + + /** + * Minimum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + #[Api(optional: true)] + public string|float|null $minValue; + + /** + * An array of allowed values. This property is only required if `type` property is set to `SingleSelect` or `MultiSelect`. + * + * @var list|null $selectOptions + */ + #[Api(list: SelectOption::class, optional: true)] + public ?array $selectOptions; + + /** + * `new Schema()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Schema::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Schema)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + * @param string|float|bool|list $defaultValue + * @param list $selectOptions + */ + public static function with( + string $type, + string|float|bool|array|null $defaultValue = null, + ?bool $isValueRequired = null, + ?float $maxLength = null, + string|float|null $maxValue = null, + ?float $minLength = null, + string|float|null $minValue = null, + ?array $selectOptions = null, + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $defaultValue && $obj->defaultValue = $defaultValue; + null !== $isValueRequired && $obj->isValueRequired = $isValueRequired; + null !== $maxLength && $obj->maxLength = $maxLength; + null !== $maxValue && $obj->maxValue = $maxValue; + null !== $minLength && $obj->minLength = $minLength; + null !== $minValue && $obj->minValue = $minValue; + null !== $selectOptions && $obj->selectOptions = $selectOptions; + + return $obj; + } + + /** + * Type of the custom metadata field. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * The default value for this custom metadata field. This property is only required if `isValueRequired` property is set to `true`. The value should match the `type` of custom metadata field. + * + * @param string|float|bool|list $defaultValue + */ + public function withDefaultValue( + string|float|bool|array $defaultValue + ): self { + $obj = clone $this; + $obj->defaultValue = $defaultValue; + + return $obj; + } + + /** + * Sets this custom metadata field as required. Setting custom metadata fields on an asset will throw error if the value for all required fields are not present in upload or update asset API request body. + */ + public function withIsValueRequired(bool $isValueRequired): self + { + $obj = clone $this; + $obj->isValueRequired = $isValueRequired; + + return $obj; + } + + /** + * Maximum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + public function withMaxLength(float $maxLength): self + { + $obj = clone $this; + $obj->maxLength = $maxLength; + + return $obj; + } + + /** + * Maximum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + public function withMaxValue(string|float $maxValue): self + { + $obj = clone $this; + $obj->maxValue = $maxValue; + + return $obj; + } + + /** + * Minimum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + public function withMinLength(float $minLength): self + { + $obj = clone $this; + $obj->minLength = $minLength; + + return $obj; + } + + /** + * Minimum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + public function withMinValue(string|float $minValue): self + { + $obj = clone $this; + $obj->minValue = $minValue; + + return $obj; + } + + /** + * An array of allowed values. This property is only required if `type` property is set to `SingleSelect` or `MultiSelect`. + * + * @param list $selectOptions + */ + public function withSelectOptions(array $selectOptions): self + { + $obj = clone $this; + $obj->selectOptions = $selectOptions; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue.php new file mode 100644 index 00000000..1743cefa --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool', new ListOf(Mixed::class)]; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue/Mixed.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue/Mixed.php new file mode 100644 index 00000000..be50455d --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/DefaultValue/Mixed.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MaxValue.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MaxValue.php new file mode 100644 index 00000000..997c7234 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MaxValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MinValue.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MinValue.php new file mode 100644 index 00000000..14041062 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/MinValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/SelectOption.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/SelectOption.php new file mode 100644 index 00000000..57718552 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/SelectOption.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php new file mode 100644 index 00000000..048a6f6e --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php @@ -0,0 +1,30 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldListParams.php b/src/CustomMetadataFields/CustomMetadataFieldListParams.php new file mode 100644 index 00000000..9e0ed855 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldListParams.php @@ -0,0 +1,60 @@ +list + * + * @phpstan-type custom_metadata_field_list_params = array{includeDeleted?: bool} + */ +final class CustomMetadataFieldListParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Set it to `true` to include deleted field objects in the API response. + */ + #[Api(optional: true)] + public ?bool $includeDeleted; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?bool $includeDeleted = null): self + { + $obj = new self; + + null !== $includeDeleted && $obj->includeDeleted = $includeDeleted; + + return $obj; + } + + /** + * Set it to `true` to include deleted field objects in the API response. + */ + public function withIncludeDeleted(bool $includeDeleted): self + { + $obj = clone $this; + $obj->includeDeleted = $includeDeleted; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php new file mode 100644 index 00000000..54fb7c37 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php @@ -0,0 +1,83 @@ +update + * + * @phpstan-type custom_metadata_field_update_params = array{ + * label?: string, schema?: Schema + * } + */ +final class CustomMetadataFieldUpdateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if `schema` is not provided. + */ + #[Api(optional: true)] + public ?string $label; + + /** + * An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. + */ + #[Api(optional: true)] + public ?Schema $schema; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?string $label = null, + ?Schema $schema = null + ): self { + $obj = new self; + + null !== $label && $obj->label = $label; + null !== $schema && $obj->schema = $schema; + + return $obj; + } + + /** + * Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if `schema` is not provided. + */ + public function withLabel(string $label): self + { + $obj = clone $this; + $obj->label = $label; + + return $obj; + } + + /** + * An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. + */ + public function withSchema(Schema $schema): self + { + $obj = clone $this; + $obj->schema = $schema; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php new file mode 100644 index 00000000..0367e1f6 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php @@ -0,0 +1,193 @@ +, + * isValueRequired?: bool|null, + * maxLength?: float|null, + * maxValue?: string|float|null, + * minLength?: float|null, + * minValue?: string|float|null, + * selectOptions?: list|null, + * } + */ +final class Schema implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * The default value for this custom metadata field. This property is only required if `isValueRequired` property is set to `true`. The value should match the `type` of custom metadata field. + * + * @var string|float|bool|list|null $defaultValue + */ + #[Api(union: DefaultValue::class, optional: true)] + public string|float|bool|array|null $defaultValue; + + /** + * Sets this custom metadata field as required. Setting custom metadata fields on an asset will throw error if the value for all required fields are not present in upload or update asset API request body. + */ + #[Api(optional: true)] + public ?bool $isValueRequired; + + /** + * Maximum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $maxLength; + + /** + * Maximum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + #[Api(optional: true)] + public string|float|null $maxValue; + + /** + * Minimum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + #[Api(optional: true)] + public ?float $minLength; + + /** + * Minimum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + #[Api(optional: true)] + public string|float|null $minValue; + + /** + * An array of allowed values. This property is only required if `type` property is set to `SingleSelect` or `MultiSelect`. + * + * @var list|null $selectOptions + */ + #[Api(list: SelectOption::class, optional: true)] + public ?array $selectOptions; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param string|float|bool|list $defaultValue + * @param list $selectOptions + */ + public static function with( + string|float|bool|array|null $defaultValue = null, + ?bool $isValueRequired = null, + ?float $maxLength = null, + string|float|null $maxValue = null, + ?float $minLength = null, + string|float|null $minValue = null, + ?array $selectOptions = null, + ): self { + $obj = new self; + + null !== $defaultValue && $obj->defaultValue = $defaultValue; + null !== $isValueRequired && $obj->isValueRequired = $isValueRequired; + null !== $maxLength && $obj->maxLength = $maxLength; + null !== $maxValue && $obj->maxValue = $maxValue; + null !== $minLength && $obj->minLength = $minLength; + null !== $minValue && $obj->minValue = $minValue; + null !== $selectOptions && $obj->selectOptions = $selectOptions; + + return $obj; + } + + /** + * The default value for this custom metadata field. This property is only required if `isValueRequired` property is set to `true`. The value should match the `type` of custom metadata field. + * + * @param string|float|bool|list $defaultValue + */ + public function withDefaultValue( + string|float|bool|array $defaultValue + ): self { + $obj = clone $this; + $obj->defaultValue = $defaultValue; + + return $obj; + } + + /** + * Sets this custom metadata field as required. Setting custom metadata fields on an asset will throw error if the value for all required fields are not present in upload or update asset API request body. + */ + public function withIsValueRequired(bool $isValueRequired): self + { + $obj = clone $this; + $obj->isValueRequired = $isValueRequired; + + return $obj; + } + + /** + * Maximum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + public function withMaxLength(float $maxLength): self + { + $obj = clone $this; + $obj->maxLength = $maxLength; + + return $obj; + } + + /** + * Maximum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + public function withMaxValue(string|float $maxValue): self + { + $obj = clone $this; + $obj->maxValue = $maxValue; + + return $obj; + } + + /** + * Minimum length of string. Only set this property if `type` is set to `Text` or `Textarea`. + */ + public function withMinLength(float $minLength): self + { + $obj = clone $this; + $obj->minLength = $minLength; + + return $obj; + } + + /** + * Minimum value of the field. Only set this property if field type is `Date` or `Number`. For `Date` type field, set the minimum date in ISO8601 string format. For `Number` type field, set the minimum numeric value. + */ + public function withMinValue(string|float $minValue): self + { + $obj = clone $this; + $obj->minValue = $minValue; + + return $obj; + } + + /** + * An array of allowed values. This property is only required if `type` property is set to `SingleSelect` or `MultiSelect`. + * + * @param list $selectOptions + */ + public function withSelectOptions(array $selectOptions): self + { + $obj = clone $this; + $obj->selectOptions = $selectOptions; + + return $obj; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue.php new file mode 100644 index 00000000..6d79746b --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool', new ListOf(Mixed::class)]; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue/Mixed.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue/Mixed.php new file mode 100644 index 00000000..c8257310 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/DefaultValue/Mixed.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MaxValue.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MaxValue.php new file mode 100644 index 00000000..7c7f7ff8 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MaxValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MinValue.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MinValue.php new file mode 100644 index 00000000..fadf1963 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/MinValue.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float']; + } +} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/SelectOption.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/SelectOption.php new file mode 100644 index 00000000..292832b0 --- /dev/null +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema/SelectOption.php @@ -0,0 +1,23 @@ +|array + */ + public static function variants(): array + { + return ['string', 'float', 'bool']; + } +} diff --git a/src/Files/Bulk/BulkAddTagsParams.php b/src/Files/Bulk/BulkAddTagsParams.php new file mode 100644 index 00000000..53ffd749 --- /dev/null +++ b/src/Files/Bulk/BulkAddTagsParams.php @@ -0,0 +1,105 @@ +addTags + * + * @phpstan-type bulk_add_tags_params = array{ + * fileIDs: list, tags: list + * } + */ +final class BulkAddTagsParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * An array of fileIds to which you want to add tags. + * + * @var list $fileIDs + */ + #[Api('fileIds', list: 'string')] + public array $fileIDs; + + /** + * An array of tags that you want to add to the files. + * + * @var list $tags + */ + #[Api(list: 'string')] + public array $tags; + + /** + * `new BulkAddTagsParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * BulkAddTagsParams::with(fileIDs: ..., tags: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new BulkAddTagsParams)->withFileIDs(...)->withTags(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $fileIDs + * @param list $tags + */ + public static function with(array $fileIDs, array $tags): self + { + $obj = new self; + + $obj->fileIDs = $fileIDs; + $obj->tags = $tags; + + return $obj; + } + + /** + * An array of fileIds to which you want to add tags. + * + * @param list $fileIDs + */ + public function withFileIDs(array $fileIDs): self + { + $obj = clone $this; + $obj->fileIDs = $fileIDs; + + return $obj; + } + + /** + * An array of tags that you want to add to the files. + * + * @param list $tags + */ + public function withTags(array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkAddTagsResponse.php b/src/Files/Bulk/BulkAddTagsResponse.php new file mode 100644 index 00000000..45a93613 --- /dev/null +++ b/src/Files/Bulk/BulkAddTagsResponse.php @@ -0,0 +1,63 @@ +|null + * } + */ +final class BulkAddTagsResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of fileIds that in which tags were successfully added. + * + * @var list|null $successfullyUpdatedFileIDs + */ + #[Api('successfullyUpdatedFileIds', list: 'string', optional: true)] + public ?array $successfullyUpdatedFileIDs; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $successfullyUpdatedFileIDs + */ + public static function with(?array $successfullyUpdatedFileIDs = null): self + { + $obj = new self; + + null !== $successfullyUpdatedFileIDs && $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } + + /** + * An array of fileIds that in which tags were successfully added. + * + * @param list $successfullyUpdatedFileIDs + */ + public function withSuccessfullyUpdatedFileIDs( + array $successfullyUpdatedFileIDs + ): self { + $obj = clone $this; + $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkDeleteParams.php b/src/Files/Bulk/BulkDeleteParams.php new file mode 100644 index 00000000..c7b6e882 --- /dev/null +++ b/src/Files/Bulk/BulkDeleteParams.php @@ -0,0 +1,84 @@ +delete + * + * @phpstan-type bulk_delete_params = array{fileIDs: list} + */ +final class BulkDeleteParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * An array of fileIds which you want to delete. + * + * @var list $fileIDs + */ + #[Api('fileIds', list: 'string')] + public array $fileIDs; + + /** + * `new BulkDeleteParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * BulkDeleteParams::with(fileIDs: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new BulkDeleteParams)->withFileIDs(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $fileIDs + */ + public static function with(array $fileIDs): self + { + $obj = new self; + + $obj->fileIDs = $fileIDs; + + return $obj; + } + + /** + * An array of fileIds which you want to delete. + * + * @param list $fileIDs + */ + public function withFileIDs(array $fileIDs): self + { + $obj = clone $this; + $obj->fileIDs = $fileIDs; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkDeleteResponse.php b/src/Files/Bulk/BulkDeleteResponse.php new file mode 100644 index 00000000..42f62916 --- /dev/null +++ b/src/Files/Bulk/BulkDeleteResponse.php @@ -0,0 +1,63 @@ +|null + * } + */ +final class BulkDeleteResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of fileIds that were successfully deleted. + * + * @var list|null $successfullyDeletedFileIDs + */ + #[Api('successfullyDeletedFileIds', list: 'string', optional: true)] + public ?array $successfullyDeletedFileIDs; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $successfullyDeletedFileIDs + */ + public static function with(?array $successfullyDeletedFileIDs = null): self + { + $obj = new self; + + null !== $successfullyDeletedFileIDs && $obj->successfullyDeletedFileIDs = $successfullyDeletedFileIDs; + + return $obj; + } + + /** + * An array of fileIds that were successfully deleted. + * + * @param list $successfullyDeletedFileIDs + */ + public function withSuccessfullyDeletedFileIDs( + array $successfullyDeletedFileIDs + ): self { + $obj = clone $this; + $obj->successfullyDeletedFileIDs = $successfullyDeletedFileIDs; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkRemoveAITagsParams.php b/src/Files/Bulk/BulkRemoveAITagsParams.php new file mode 100644 index 00000000..2fe76ca5 --- /dev/null +++ b/src/Files/Bulk/BulkRemoveAITagsParams.php @@ -0,0 +1,105 @@ +removeAITags + * + * @phpstan-type bulk_remove_ai_tags_params = array{ + * aiTags: list, fileIDs: list + * } + */ +final class BulkRemoveAITagsParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * An array of AITags that you want to remove from the files. + * + * @var list $aiTags + */ + #[Api('AITags', list: 'string')] + public array $aiTags; + + /** + * An array of fileIds from which you want to remove AITags. + * + * @var list $fileIDs + */ + #[Api('fileIds', list: 'string')] + public array $fileIDs; + + /** + * `new BulkRemoveAITagsParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * BulkRemoveAITagsParams::with(aiTags: ..., fileIDs: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new BulkRemoveAITagsParams)->withAITags(...)->withFileIDs(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $aiTags + * @param list $fileIDs + */ + public static function with(array $aiTags, array $fileIDs): self + { + $obj = new self; + + $obj->aiTags = $aiTags; + $obj->fileIDs = $fileIDs; + + return $obj; + } + + /** + * An array of AITags that you want to remove from the files. + * + * @param list $aiTags + */ + public function withAITags(array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * An array of fileIds from which you want to remove AITags. + * + * @param list $fileIDs + */ + public function withFileIDs(array $fileIDs): self + { + $obj = clone $this; + $obj->fileIDs = $fileIDs; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkRemoveAITagsResponse.php b/src/Files/Bulk/BulkRemoveAITagsResponse.php new file mode 100644 index 00000000..ec996967 --- /dev/null +++ b/src/Files/Bulk/BulkRemoveAITagsResponse.php @@ -0,0 +1,63 @@ +|null + * } + */ +final class BulkRemoveAITagsResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of fileIds that in which AITags were successfully removed. + * + * @var list|null $successfullyUpdatedFileIDs + */ + #[Api('successfullyUpdatedFileIds', list: 'string', optional: true)] + public ?array $successfullyUpdatedFileIDs; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $successfullyUpdatedFileIDs + */ + public static function with(?array $successfullyUpdatedFileIDs = null): self + { + $obj = new self; + + null !== $successfullyUpdatedFileIDs && $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } + + /** + * An array of fileIds that in which AITags were successfully removed. + * + * @param list $successfullyUpdatedFileIDs + */ + public function withSuccessfullyUpdatedFileIDs( + array $successfullyUpdatedFileIDs + ): self { + $obj = clone $this; + $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkRemoveTagsParams.php b/src/Files/Bulk/BulkRemoveTagsParams.php new file mode 100644 index 00000000..678dc4ed --- /dev/null +++ b/src/Files/Bulk/BulkRemoveTagsParams.php @@ -0,0 +1,105 @@ +removeTags + * + * @phpstan-type bulk_remove_tags_params = array{ + * fileIDs: list, tags: list + * } + */ +final class BulkRemoveTagsParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * An array of fileIds from which you want to remove tags. + * + * @var list $fileIDs + */ + #[Api('fileIds', list: 'string')] + public array $fileIDs; + + /** + * An array of tags that you want to remove from the files. + * + * @var list $tags + */ + #[Api(list: 'string')] + public array $tags; + + /** + * `new BulkRemoveTagsParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * BulkRemoveTagsParams::with(fileIDs: ..., tags: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new BulkRemoveTagsParams)->withFileIDs(...)->withTags(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $fileIDs + * @param list $tags + */ + public static function with(array $fileIDs, array $tags): self + { + $obj = new self; + + $obj->fileIDs = $fileIDs; + $obj->tags = $tags; + + return $obj; + } + + /** + * An array of fileIds from which you want to remove tags. + * + * @param list $fileIDs + */ + public function withFileIDs(array $fileIDs): self + { + $obj = clone $this; + $obj->fileIDs = $fileIDs; + + return $obj; + } + + /** + * An array of tags that you want to remove from the files. + * + * @param list $tags + */ + public function withTags(array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } +} diff --git a/src/Files/Bulk/BulkRemoveTagsResponse.php b/src/Files/Bulk/BulkRemoveTagsResponse.php new file mode 100644 index 00000000..a2c5ff1a --- /dev/null +++ b/src/Files/Bulk/BulkRemoveTagsResponse.php @@ -0,0 +1,63 @@ +|null + * } + */ +final class BulkRemoveTagsResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of fileIds that in which tags were successfully removed. + * + * @var list|null $successfullyUpdatedFileIDs + */ + #[Api('successfullyUpdatedFileIds', list: 'string', optional: true)] + public ?array $successfullyUpdatedFileIDs; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $successfullyUpdatedFileIDs + */ + public static function with(?array $successfullyUpdatedFileIDs = null): self + { + $obj = new self; + + null !== $successfullyUpdatedFileIDs && $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } + + /** + * An array of fileIds that in which tags were successfully removed. + * + * @param list $successfullyUpdatedFileIDs + */ + public function withSuccessfullyUpdatedFileIDs( + array $successfullyUpdatedFileIDs + ): self { + $obj = clone $this; + $obj->successfullyUpdatedFileIDs = $successfullyUpdatedFileIDs; + + return $obj; + } +} diff --git a/src/Files/File.php b/src/Files/File.php new file mode 100644 index 00000000..b2b612a5 --- /dev/null +++ b/src/Files/File.php @@ -0,0 +1,503 @@ +|null, + * createdAt?: \DateTimeInterface|null, + * customCoordinates?: string|null, + * customMetadata?: array|null, + * description?: string|null, + * fileID?: string|null, + * filePath?: string|null, + * fileType?: string|null, + * hasAlpha?: bool|null, + * height?: float|null, + * isPrivateFile?: bool|null, + * isPublished?: bool|null, + * mime?: string|null, + * name?: string|null, + * size?: float|null, + * tags?: list|null, + * thumbnail?: string|null, + * type?: Type::*|null, + * updatedAt?: \DateTimeInterface|null, + * url?: string|null, + * versionInfo?: VersionInfo|null, + * width?: float|null, + * } + */ +final class File implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of tags assigned to the file by auto tagging. + * + * @var list|null $aiTags + */ + #[Api('AITags', list: AITag::class, nullable: true, optional: true)] + public ?array $aiTags; + + /** + * Date and time when the file was uploaded. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $createdAt; + + /** + * An string with custom coordinates of the file. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * An object with custom metadata for the file. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * Unique identifier of the asset. + */ + #[Api('fileId', optional: true)] + public ?string $fileID; + + /** + * Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be `/file.jpg`. If the file is inside a folder named `images`, the path will be `/images/file.jpg`. + */ + #[Api(optional: true)] + public ?string $filePath; + + /** + * Type of the file. Possible values are `image`, `non-image`. + */ + #[Api(optional: true)] + public ?string $fileType; + + /** + * Specifies if the image has an alpha channel. + */ + #[Api(optional: true)] + public ?bool $hasAlpha; + + /** + * Height of the file. + */ + #[Api(optional: true)] + public ?float $height; + + /** + * Specifies if the file is private or not. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Specifies if the file is published or not. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * MIME type of the file. + */ + #[Api(optional: true)] + public ?string $mime; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Size of the file in bytes. + */ + #[Api(optional: true)] + public ?float $size; + + /** + * An array of tags assigned to the file. Tags are used to search files in the media library. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library. + */ + #[Api(optional: true)] + public ?string $thumbnail; + + /** + * Type of the asset. + * + * @var Type::*|null $type + */ + #[Api(enum: Type::class, optional: true)] + public ?string $type; + + /** + * Date and time when the file was last updated. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $updatedAt; + + /** + * URL of the file. + */ + #[Api(optional: true)] + public ?string $url; + + /** + * An object with details of the file version. + */ + #[Api(optional: true)] + public ?VersionInfo $versionInfo; + + /** + * Width of the file. + */ + #[Api(optional: true)] + public ?float $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $aiTags + * @param array $customMetadata + * @param list|null $tags + * @param Type::* $type + */ + public static function with( + ?array $aiTags = null, + ?\DateTimeInterface $createdAt = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?string $fileID = null, + ?string $filePath = null, + ?string $fileType = null, + ?bool $hasAlpha = null, + ?float $height = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?string $mime = null, + ?string $name = null, + ?float $size = null, + ?array $tags = null, + ?string $thumbnail = null, + ?string $type = null, + ?\DateTimeInterface $updatedAt = null, + ?string $url = null, + ?VersionInfo $versionInfo = null, + ?float $width = null, + ): self { + $obj = new self; + + null !== $aiTags && $obj->aiTags = $aiTags; + null !== $createdAt && $obj->createdAt = $createdAt; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $fileID && $obj->fileID = $fileID; + null !== $filePath && $obj->filePath = $filePath; + null !== $fileType && $obj->fileType = $fileType; + null !== $hasAlpha && $obj->hasAlpha = $hasAlpha; + null !== $height && $obj->height = $height; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $mime && $obj->mime = $mime; + null !== $name && $obj->name = $name; + null !== $size && $obj->size = $size; + null !== $tags && $obj->tags = $tags; + null !== $thumbnail && $obj->thumbnail = $thumbnail; + null !== $type && $obj->type = $type; + null !== $updatedAt && $obj->updatedAt = $updatedAt; + null !== $url && $obj->url = $url; + null !== $versionInfo && $obj->versionInfo = $versionInfo; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * An array of tags assigned to the file by auto tagging. + * + * @param list|null $aiTags + */ + public function withAITags(?array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * Date and time when the file was uploaded. The date and time is in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + /** + * An string with custom coordinates of the file. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * An object with custom metadata for the file. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Unique identifier of the asset. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be `/file.jpg`. If the file is inside a folder named `images`, the path will be `/images/file.jpg`. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * Type of the file. Possible values are `image`, `non-image`. + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * Specifies if the image has an alpha channel. + */ + public function withHasAlpha(bool $hasAlpha): self + { + $obj = clone $this; + $obj->hasAlpha = $hasAlpha; + + return $obj; + } + + /** + * Height of the file. + */ + public function withHeight(float $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Specifies if the file is private or not. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Specifies if the file is published or not. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * MIME type of the file. + */ + public function withMime(string $mime): self + { + $obj = clone $this; + $obj->mime = $mime; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Size of the file in bytes. + */ + public function withSize(float $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * An array of tags assigned to the file. Tags are used to search files in the media library. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library. + */ + public function withThumbnail(string $thumbnail): self + { + $obj = clone $this; + $obj->thumbnail = $thumbnail; + + return $obj; + } + + /** + * Type of the asset. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Date and time when the file was last updated. The date and time is in ISO8601 format. + */ + public function withUpdatedAt(\DateTimeInterface $updatedAt): self + { + $obj = clone $this; + $obj->updatedAt = $updatedAt; + + return $obj; + } + + /** + * URL of the file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * An object with details of the file version. + */ + public function withVersionInfo(VersionInfo $versionInfo): self + { + $obj = clone $this; + $obj->versionInfo = $versionInfo; + + return $obj; + } + + /** + * Width of the file. + */ + public function withWidth(float $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Files/File/AITag.php b/src/Files/File/AITag.php new file mode 100644 index 00000000..1b692418 --- /dev/null +++ b/src/Files/File/AITag.php @@ -0,0 +1,95 @@ + */ + use SdkModel; + + /** + * Confidence score of the tag. + */ + #[Api(optional: true)] + public ?float $confidence; + + /** + * Name of the tag. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-tagging`. + */ + #[Api(optional: true)] + public ?string $source; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $confidence = null, + ?string $name = null, + ?string $source = null + ): self { + $obj = new self; + + null !== $confidence && $obj->confidence = $confidence; + null !== $name && $obj->name = $name; + null !== $source && $obj->source = $source; + + return $obj; + } + + /** + * Confidence score of the tag. + */ + public function withConfidence(float $confidence): self + { + $obj = clone $this; + $obj->confidence = $confidence; + + return $obj; + } + + /** + * Name of the tag. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Source of the tag. Possible values are `google-auto-tagging` and `aws-auto-tagging`. + */ + public function withSource(string $source): self + { + $obj = clone $this; + $obj->source = $source; + + return $obj; + } +} diff --git a/src/Files/File/Type.php b/src/Files/File/Type.php new file mode 100644 index 00000000..8d6f266a --- /dev/null +++ b/src/Files/File/Type.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Unique identifier of the file version. + */ + #[Api(optional: true)] + public ?string $id; + + /** + * Name of the file version. + */ + #[Api(optional: true)] + public ?string $name; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $id = null, ?string $name = null): self + { + $obj = new self; + + null !== $id && $obj->id = $id; + null !== $name && $obj->name = $name; + + return $obj; + } + + /** + * Unique identifier of the file version. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Name of the file version. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Files/FileCopyParams.php b/src/Files/FileCopyParams.php new file mode 100644 index 00000000..fce0e5d8 --- /dev/null +++ b/src/Files/FileCopyParams.php @@ -0,0 +1,118 @@ +copy + * + * @phpstan-type file_copy_params = array{ + * destinationPath: string, sourceFilePath: string, includeFileVersions?: bool + * } + */ +final class FileCopyParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Full path to the folder you want to copy the above file into. + */ + #[Api] + public string $destinationPath; + + /** + * The full path of the file you want to copy. + */ + #[Api] + public string $sourceFilePath; + + /** + * Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. + */ + #[Api(optional: true)] + public ?bool $includeFileVersions; + + /** + * `new FileCopyParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileCopyParams::with(destinationPath: ..., sourceFilePath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileCopyParams)->withDestinationPath(...)->withSourceFilePath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $destinationPath, + string $sourceFilePath, + ?bool $includeFileVersions = null, + ): self { + $obj = new self; + + $obj->destinationPath = $destinationPath; + $obj->sourceFilePath = $sourceFilePath; + + null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } + + /** + * Full path to the folder you want to copy the above file into. + */ + public function withDestinationPath(string $destinationPath): self + { + $obj = clone $this; + $obj->destinationPath = $destinationPath; + + return $obj; + } + + /** + * The full path of the file you want to copy. + */ + public function withSourceFilePath(string $sourceFilePath): self + { + $obj = clone $this; + $obj->sourceFilePath = $sourceFilePath; + + return $obj; + } + + /** + * Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. + */ + public function withIncludeFileVersions(bool $includeFileVersions): self + { + $obj = clone $this; + $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } +} diff --git a/src/Files/FileCopyResponse.php b/src/Files/FileCopyResponse.php new file mode 100644 index 00000000..ae593ba5 --- /dev/null +++ b/src/Files/FileCopyResponse.php @@ -0,0 +1,32 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Files/FileMoveParams.php b/src/Files/FileMoveParams.php new file mode 100644 index 00000000..68c5a7a4 --- /dev/null +++ b/src/Files/FileMoveParams.php @@ -0,0 +1,98 @@ +move + * + * @phpstan-type file_move_params = array{ + * destinationPath: string, sourceFilePath: string + * } + */ +final class FileMoveParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Full path to the folder you want to move the above file into. + */ + #[Api] + public string $destinationPath; + + /** + * The full path of the file you want to move. + */ + #[Api] + public string $sourceFilePath; + + /** + * `new FileMoveParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileMoveParams::with(destinationPath: ..., sourceFilePath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileMoveParams)->withDestinationPath(...)->withSourceFilePath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $destinationPath, + string $sourceFilePath + ): self { + $obj = new self; + + $obj->destinationPath = $destinationPath; + $obj->sourceFilePath = $sourceFilePath; + + return $obj; + } + + /** + * Full path to the folder you want to move the above file into. + */ + public function withDestinationPath(string $destinationPath): self + { + $obj = clone $this; + $obj->destinationPath = $destinationPath; + + return $obj; + } + + /** + * The full path of the file you want to move. + */ + public function withSourceFilePath(string $sourceFilePath): self + { + $obj = clone $this; + $obj->sourceFilePath = $sourceFilePath; + + return $obj; + } +} diff --git a/src/Files/FileMoveResponse.php b/src/Files/FileMoveResponse.php new file mode 100644 index 00000000..bcdaa4ce --- /dev/null +++ b/src/Files/FileMoveResponse.php @@ -0,0 +1,32 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Files/FileRenameParams.php b/src/Files/FileRenameParams.php new file mode 100644 index 00000000..b41454d5 --- /dev/null +++ b/src/Files/FileRenameParams.php @@ -0,0 +1,144 @@ +rename + * + * @phpstan-type file_rename_params = array{ + * filePath: string, newFileName: string, purgeCache?: bool + * } + */ +final class FileRenameParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The full path of the file you want to rename. + */ + #[Api] + public string $filePath; + + /** + * The new name of the file. A filename can contain: + * + * Alphanumeric Characters: `a-z`, `A-Z`, `0-9` (including Unicode letters, marks, and numerals in other languages). + * Special Characters: `.`, `_`, and `-`. + * + * Any other character, including space, will be replaced by `_`. + */ + #[Api] + public string $newFileName; + + /** + * Option to purge cache for the old file and its versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove cached content of old file and its versions. This purge request is counted against your monthly purge quota. + * + * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * + * + * Default value - `false` + */ + #[Api(optional: true)] + public ?bool $purgeCache; + + /** + * `new FileRenameParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileRenameParams::with(filePath: ..., newFileName: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileRenameParams)->withFilePath(...)->withNewFileName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $filePath, + string $newFileName, + ?bool $purgeCache = null + ): self { + $obj = new self; + + $obj->filePath = $filePath; + $obj->newFileName = $newFileName; + + null !== $purgeCache && $obj->purgeCache = $purgeCache; + + return $obj; + } + + /** + * The full path of the file you want to rename. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * The new name of the file. A filename can contain: + * + * Alphanumeric Characters: `a-z`, `A-Z`, `0-9` (including Unicode letters, marks, and numerals in other languages). + * Special Characters: `.`, `_`, and `-`. + * + * Any other character, including space, will be replaced by `_`. + */ + public function withNewFileName(string $newFileName): self + { + $obj = clone $this; + $obj->newFileName = $newFileName; + + return $obj; + } + + /** + * Option to purge cache for the old file and its versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove cached content of old file and its versions. This purge request is counted against your monthly purge quota. + * + * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * + * + * Default value - `false` + */ + public function withPurgeCache(bool $purgeCache): self + { + $obj = clone $this; + $obj->purgeCache = $purgeCache; + + return $obj; + } +} diff --git a/src/Files/FileRenameResponse.php b/src/Files/FileRenameResponse.php new file mode 100644 index 00000000..bea1adab --- /dev/null +++ b/src/Files/FileRenameResponse.php @@ -0,0 +1,54 @@ + */ + use SdkModel; + + /** + * Unique identifier of the purge request. This can be used to check the status of the purge request. + */ + #[Api('purgeRequestId', optional: true)] + public ?string $purgeRequestID; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $purgeRequestID = null): self + { + $obj = new self; + + null !== $purgeRequestID && $obj->purgeRequestID = $purgeRequestID; + + return $obj; + } + + /** + * Unique identifier of the purge request. This can be used to check the status of the purge request. + */ + public function withPurgeRequestID(string $purgeRequestID): self + { + $obj = clone $this; + $obj->purgeRequestID = $purgeRequestID; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams.php b/src/Files/FileUpdateParams.php new file mode 100644 index 00000000..6289a5c2 --- /dev/null +++ b/src/Files/FileUpdateParams.php @@ -0,0 +1,60 @@ +update + * + * @phpstan-type file_update_params = array{ + * update?: UpdateFileDetails|ChangePublicationStatus + * } + */ +final class FileUpdateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + #[Api(optional: true)] + public UpdateFileDetails|ChangePublicationStatus|null $update; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + UpdateFileDetails|ChangePublicationStatus|null $update = null + ): self { + $obj = new self; + + null !== $update && $obj->update = $update; + + return $obj; + } + + public function withUpdate( + UpdateFileDetails|ChangePublicationStatus $update + ): self { + $obj = clone $this; + $obj->update = $update; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update.php b/src/Files/FileUpdateParams/Update.php new file mode 100644 index 00000000..452427d7 --- /dev/null +++ b/src/Files/FileUpdateParams/Update.php @@ -0,0 +1,25 @@ +|array + */ + public static function variants(): array + { + return [UpdateFileDetails::class, ChangePublicationStatus::class]; + } +} diff --git a/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php b/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php new file mode 100644 index 00000000..876df8c0 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php @@ -0,0 +1,55 @@ + */ + use SdkModel; + + /** + * Configure the publication status of a file and its versions. + */ + #[Api(optional: true)] + public ?Publish $publish; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Publish $publish = null): self + { + $obj = new self; + + null !== $publish && $obj->publish = $publish; + + return $obj; + } + + /** + * Configure the publication status of a file and its versions. + */ + public function withPublish(Publish $publish): self + { + $obj = clone $this; + $obj->publish = $publish; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php b/src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php new file mode 100644 index 00000000..ffd75ef1 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php @@ -0,0 +1,93 @@ + */ + use SdkModel; + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + #[Api] + public bool $isPublished; + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + #[Api(optional: true)] + public ?bool $includeFileVersions; + + /** + * `new Publish()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Publish::with(isPublished: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Publish)->withIsPublished(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + bool $isPublished, + ?bool $includeFileVersions = null + ): self { + $obj = new self; + + $obj->isPublished = $isPublished; + + null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + public function withIncludeFileVersions(bool $includeFileVersions): self + { + $obj = clone $this; + $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails.php new file mode 100644 index 00000000..47747047 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails.php @@ -0,0 +1,211 @@ +|null, + * description?: string|null, + * extensions?: list|null, + * removeAITags?: string|null|list, + * tags?: list|null, + * webhookURL?: string|null, + * } + */ +final class UpdateFileDetails implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @var list|null $extensions + */ + #[Api(list: Extension::class, optional: true)] + public ?array $extensions; + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @var string|list|null $removeAITags + */ + #[Api(union: RemoveAITags::class, optional: true)] + public string|array|null $removeAITags; + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + #[Api('webhookUrl', optional: true)] + public ?string $webhookURL; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $customMetadata + * @param list $extensions + * @param string|list $removeAITags + * @param list|null $tags + */ + public static function with( + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?array $extensions = null, + string|array|null $removeAITags = null, + ?array $tags = null, + ?string $webhookURL = null, + ): self { + $obj = new self; + + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $extensions && $obj->extensions = $extensions; + null !== $removeAITags && $obj->removeAITags = $removeAITags; + null !== $tags && $obj->tags = $tags; + null !== $webhookURL && $obj->webhookURL = $webhookURL; + + return $obj; + } + + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @param list $extensions + */ + public function withExtensions(array $extensions): self + { + $obj = clone $this; + $obj->extensions = $extensions; + + return $obj; + } + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @param string|list $removeAITags + */ + public function withRemoveAITags(string|array $removeAITags): self + { + $obj = clone $this; + $obj->removeAITags = $removeAITags; + + return $obj; + } + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function withWebhookURL(string $webhookURL): self + { + $obj = clone $this; + $obj->webhookURL = $webhookURL; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php new file mode 100644 index 00000000..106a7ee7 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php @@ -0,0 +1,35 @@ +|array + */ + public static function variants(): array + { + return [ + AutoTaggingExtension::class, + 'remove-bg' => RemoveBg::class, + 'ai-auto-description' => AIAutoDescription::class, + ]; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php new file mode 100644 index 00000000..61040877 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php @@ -0,0 +1,39 @@ + */ + use SdkModel; + + /** + * Specifies the auto description extension. + */ + #[Api] + public string $name = 'ai-auto-description'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php new file mode 100644 index 00000000..95159c43 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php @@ -0,0 +1,119 @@ + */ + use SdkModel; + + /** + * Maximum number of tags to attach to the asset. + */ + #[Api] + public int $maxTags; + + /** + * Minimum confidence level for tags to be considered valid. + */ + #[Api] + public int $minConfidence; + + /** + * Specifies the auto-tagging extension used. + * + * @var Name::* $name + */ + #[Api(enum: Name::class)] + public string $name; + + /** + * `new AutoTaggingExtension()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AutoTaggingExtension::with(maxTags: ..., minConfidence: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AutoTaggingExtension) + * ->withMaxTags(...) + * ->withMinConfidence(...) + * ->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Name::* $name + */ + public static function with( + int $maxTags, + int $minConfidence, + string $name + ): self { + $obj = new self; + + $obj->maxTags = $maxTags; + $obj->minConfidence = $minConfidence; + $obj->name = $name; + + return $obj; + } + + /** + * Maximum number of tags to attach to the asset. + */ + public function withMaxTags(int $maxTags): self + { + $obj = clone $this; + $obj->maxTags = $maxTags; + + return $obj; + } + + /** + * Minimum confidence level for tags to be considered valid. + */ + public function withMinConfidence(int $minConfidence): self + { + $obj = clone $this; + $obj->minConfidence = $minConfidence; + + return $obj; + } + + /** + * Specifies the auto-tagging extension used. + * + * @param Name::* $name + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php new file mode 100644 index 00000000..1b209a58 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Specifies the background removal extension. + */ + #[Api] + public string $name = 'remove-bg'; + + #[Api(optional: true)] + public ?Options $options; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Options $options = null): self + { + $obj = new self; + + null !== $options && $obj->options = $options; + + return $obj; + } + + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php new file mode 100644 index 00000000..d6122438 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php @@ -0,0 +1,117 @@ + */ + use SdkModel; + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + #[Api('add_shadow', optional: true)] + public ?bool $addShadow; + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + #[Api('bg_color', optional: true)] + public ?string $bgColor; + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + #[Api('bg_image_url', optional: true)] + public ?string $bgImageURL; + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + #[Api(optional: true)] + public ?bool $semitransparency; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?bool $addShadow = null, + ?string $bgColor = null, + ?string $bgImageURL = null, + ?bool $semitransparency = null, + ): self { + $obj = new self; + + null !== $addShadow && $obj->addShadow = $addShadow; + null !== $bgColor && $obj->bgColor = $bgColor; + null !== $bgImageURL && $obj->bgImageURL = $bgImageURL; + null !== $semitransparency && $obj->semitransparency = $semitransparency; + + return $obj; + } + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + public function withAddShadow(bool $addShadow): self + { + $obj = clone $this; + $obj->addShadow = $addShadow; + + return $obj; + } + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + public function withBgColor(string $bgColor): self + { + $obj = clone $this; + $obj->bgColor = $bgColor; + + return $obj; + } + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + public function withBgImageURL(string $bgImageURL): self + { + $obj = clone $this; + $obj->bgImageURL = $bgImageURL; + + return $obj; + } + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + public function withSemitransparency(bool $semitransparency): self + { + $obj = clone $this; + $obj->semitransparency = $semitransparency; + + return $obj; + } +} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php new file mode 100644 index 00000000..e30a5980 --- /dev/null +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php @@ -0,0 +1,31 @@ +|array + */ + public static function variants(): array + { + return [new ListOf('string'), STAINLESS_FIXME_::class]; + } +} diff --git a/src/Files/FileUpdateResponse.php b/src/Files/FileUpdateResponse.php new file mode 100644 index 00000000..0a6596f9 --- /dev/null +++ b/src/Files/FileUpdateResponse.php @@ -0,0 +1,53 @@ + */ + use SdkModel; + + #[Api(optional: true)] + public ?ExtensionStatus $extensionStatus; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?ExtensionStatus $extensionStatus = null): self + { + $obj = new self; + + null !== $extensionStatus && $obj->extensionStatus = $extensionStatus; + + return $obj; + } + + public function withExtensionStatus(ExtensionStatus $extensionStatus): self + { + $obj = clone $this; + $obj->extensionStatus = $extensionStatus; + + return $obj; + } +} diff --git a/src/Files/FileUpdateResponse/ExtensionStatus.php b/src/Files/FileUpdateResponse/ExtensionStatus.php new file mode 100644 index 00000000..e9a8ebfb --- /dev/null +++ b/src/Files/FileUpdateResponse/ExtensionStatus.php @@ -0,0 +1,118 @@ + */ + use SdkModel; + + /** @var AIAutoDescription::*|null $aiAutoDescription */ + #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] + public ?string $aiAutoDescription; + + /** @var AwsAutoTagging::*|null $awsAutoTagging */ + #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] + public ?string $awsAutoTagging; + + /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] + public ?string $googleAutoTagging; + + /** @var RemoveBg::*|null $removeBg */ + #[Api('remove-bg', enum: RemoveBg::class, optional: true)] + public ?string $removeBg; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AIAutoDescription::* $aiAutoDescription + * @param AwsAutoTagging::* $awsAutoTagging + * @param GoogleAutoTagging::* $googleAutoTagging + * @param RemoveBg::* $removeBg + */ + public static function with( + ?string $aiAutoDescription = null, + ?string $awsAutoTagging = null, + ?string $googleAutoTagging = null, + ?string $removeBg = null, + ): self { + $obj = new self; + + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg; + + return $obj; + } + + /** + * @param AIAutoDescription::* $aiAutoDescription + */ + public function withAIAutoDescription(string $aiAutoDescription): self + { + $obj = clone $this; + $obj->aiAutoDescription = $aiAutoDescription; + + return $obj; + } + + /** + * @param AwsAutoTagging::* $awsAutoTagging + */ + public function withAwsAutoTagging(string $awsAutoTagging): self + { + $obj = clone $this; + $obj->awsAutoTagging = $awsAutoTagging; + + return $obj; + } + + /** + * @param GoogleAutoTagging::* $googleAutoTagging + */ + public function withGoogleAutoTagging(string $googleAutoTagging): self + { + $obj = clone $this; + $obj->googleAutoTagging = $googleAutoTagging; + + return $obj; + } + + /** + * @param RemoveBg::* $removeBg + */ + public function withRemoveBg(string $removeBg): self + { + $obj = clone $this; + $obj->removeBg = $removeBg; + + return $obj; + } +} diff --git a/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php b/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php new file mode 100644 index 00000000..984373de --- /dev/null +++ b/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php @@ -0,0 +1,19 @@ +upload + * + * @phpstan-type file_upload_params = array{ + * file: string, + * fileName: string, + * token?: string, + * checks?: string, + * customCoordinates?: string, + * customMetadata?: array, + * description?: string, + * expire?: int, + * extensions?: list, + * folder?: string, + * isPrivateFile?: bool, + * isPublished?: bool, + * overwriteAITags?: bool, + * overwriteCustomMetadata?: bool, + * overwriteFile?: bool, + * overwriteTags?: bool, + * publicKey?: string, + * responseFields?: list, + * signature?: string, + * tags?: list, + * transformation?: Transformation, + * useUniqueFileName?: bool, + * webhookURL?: string, + * } + */ +final class FileUploadParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + */ + #[Api] + public string $file; + + /** + * The name with which the file has to be uploaded. + * The file name can contain: + * + * - Alphanumeric Characters: `a-z`, `A-Z`, `0-9`. + * - Special Characters: `.`, `-` + * + * Any other character including space will be replaced by `_` + */ + #[Api] + public string $fileName; + + /** + * A unique value that the ImageKit.io server will use to recognize and prevent subsequent retries for the same request. We suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. This field is only required for authentication when uploading a file from the client side. + * + * **Note**: Sending a value that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new value for this field. + */ + #[Api(optional: true)] + public ?string $token; + + /** + * Server-side checks to run on the asset. + * Read more about [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + */ + #[Api(optional: true)] + public ?string $checks; + + /** + * Define an important area in the image. This is only relevant for image type files. + * + * - To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format `x,y,width,height`. For example - `10,10,100,100` + * - Can be used with fo-customtransformation. + * - If this field is not specified and the file is overwritten, then customCoordinates will be removed. + */ + #[Api(optional: true)] + public ?string $customCoordinates; + + /** + * JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. + */ + #[Api(optional: true)] + public ?int $expire; + + /** + * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * + * @var list|null $extensions + */ + #[Api(list: Extension::class, optional: true)] + public ?array $extensions; + + /** + * The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. + * + * The folder name can contain: + * + * - Alphanumeric Characters: `a-z` , `A-Z` , `0-9` + * - Special Characters: `/` , `_` , `-` + * + * Using multiple `/` creates a nested folder. + */ + #[Api(optional: true)] + public ?string $folder; + + /** + * Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + */ + #[Api(optional: true)] + public ?bool $overwriteAITags; + + /** + * If the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed. + */ + #[Api(optional: true)] + public ?bool $overwriteCustomMetadata; + + /** + * If `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately. + */ + #[Api(optional: true)] + public ?bool $overwriteFile; + + /** + * If the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed. + */ + #[Api(optional: true)] + public ?bool $overwriteTags; + + /** + * Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. + */ + #[Api(optional: true)] + public ?string $publicKey; + + /** + * Array of response field keys to include in the API response body. + * + * @var list|null $responseFields + */ + #[Api(list: ResponseField::class, optional: true)] + public ?array $responseFields; + + /** + * HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. + * + * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. + */ + #[Api(optional: true)] + public ?string $signature; + + /** + * Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * + * @var list|null $tags + */ + #[Api(list: 'string', optional: true)] + public ?array $tags; + + /** + * Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + */ + #[Api(optional: true)] + public ?Transformation $transformation; + + /** + * Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + */ + #[Api(optional: true)] + public ?bool $useUniqueFileName; + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + #[Api('webhookUrl', optional: true)] + public ?string $webhookURL; + + /** + * `new FileUploadParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileUploadParams::with(file: ..., fileName: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileUploadParams)->withFile(...)->withFileName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $customMetadata + * @param list $extensions + * @param list $responseFields + * @param list $tags + */ + public static function with( + string $file, + string $fileName, + ?string $token = null, + ?string $checks = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?int $expire = null, + ?array $extensions = null, + ?string $folder = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?bool $overwriteAITags = null, + ?bool $overwriteCustomMetadata = null, + ?bool $overwriteFile = null, + ?bool $overwriteTags = null, + ?string $publicKey = null, + ?array $responseFields = null, + ?string $signature = null, + ?array $tags = null, + ?Transformation $transformation = null, + ?bool $useUniqueFileName = null, + ?string $webhookURL = null, + ): self { + $obj = new self; + + $obj->file = $file; + $obj->fileName = $fileName; + + null !== $token && $obj->token = $token; + null !== $checks && $obj->checks = $checks; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $expire && $obj->expire = $expire; + null !== $extensions && $obj->extensions = $extensions; + null !== $folder && $obj->folder = $folder; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $overwriteAITags && $obj->overwriteAITags = $overwriteAITags; + null !== $overwriteCustomMetadata && $obj->overwriteCustomMetadata = $overwriteCustomMetadata; + null !== $overwriteFile && $obj->overwriteFile = $overwriteFile; + null !== $overwriteTags && $obj->overwriteTags = $overwriteTags; + null !== $publicKey && $obj->publicKey = $publicKey; + null !== $responseFields && $obj->responseFields = $responseFields; + null !== $signature && $obj->signature = $signature; + null !== $tags && $obj->tags = $tags; + null !== $transformation && $obj->transformation = $transformation; + null !== $useUniqueFileName && $obj->useUniqueFileName = $useUniqueFileName; + null !== $webhookURL && $obj->webhookURL = $webhookURL; + + return $obj; + } + + /** + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + */ + public function withFile(string $file): self + { + $obj = clone $this; + $obj->file = $file; + + return $obj; + } + + /** + * The name with which the file has to be uploaded. + * The file name can contain: + * + * - Alphanumeric Characters: `a-z`, `A-Z`, `0-9`. + * - Special Characters: `.`, `-` + * + * Any other character including space will be replaced by `_` + */ + public function withFileName(string $fileName): self + { + $obj = clone $this; + $obj->fileName = $fileName; + + return $obj; + } + + /** + * A unique value that the ImageKit.io server will use to recognize and prevent subsequent retries for the same request. We suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. This field is only required for authentication when uploading a file from the client side. + * + * **Note**: Sending a value that has been used in the past will result in a validation error. Even if your previous request resulted in an error, you should always send a new value for this field. + */ + public function withToken(string $token): self + { + $obj = clone $this; + $obj->token = $token; + + return $obj; + } + + /** + * Server-side checks to run on the asset. + * Read more about [Upload API checks](/docs/api-reference/upload-file/upload-file#upload-api-checks). + */ + public function withChecks(string $checks): self + { + $obj = clone $this; + $obj->checks = $checks; + + return $obj; + } + + /** + * Define an important area in the image. This is only relevant for image type files. + * + * - To be passed as a string with the x and y coordinates of the top-left corner, and width and height of the area of interest in the format `x,y,width,height`. For example - `10,10,100,100` + * - Can be used with fo-customtransformation. + * - If this field is not specified and the file is overwritten, then customCoordinates will be removed. + */ + public function withCustomCoordinates(string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. + */ + public function withExpire(int $expire): self + { + $obj = clone $this; + $obj->expire = $expire; + + return $obj; + } + + /** + * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * + * @param list $extensions + */ + public function withExtensions(array $extensions): self + { + $obj = clone $this; + $obj->extensions = $extensions; + + return $obj; + } + + /** + * The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. + * + * The folder name can contain: + * + * - Alphanumeric Characters: `a-z` , `A-Z` , `0-9` + * - Special Characters: `/` , `_` , `-` + * + * Using multiple `/` creates a nested folder. + */ + public function withFolder(string $folder): self + { + $obj = clone $this; + $obj->folder = $folder; + + return $obj; + } + + /** + * Whether to mark the file as private or not. + * + * If `true`, the file is marked as private and is accessible only using named transformation or signed URL. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Whether to upload file as published or not. + * + * If `false`, the file is marked as unpublished, which restricts access to the file only via the media library. Files in draft or unpublished state can only be publicly accessed after being published. + * + * The option to upload in draft state is only available in custom enterprise pricing plans. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * If set to `true` and a file already exists at the exact location, its AITags will be removed. Set `overwriteAITags` to `false` to preserve AITags. + */ + public function withOverwriteAITags(bool $overwriteAITags): self + { + $obj = clone $this; + $obj->overwriteAITags = $overwriteAITags; + + return $obj; + } + + /** + * If the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed. + */ + public function withOverwriteCustomMetadata( + bool $overwriteCustomMetadata + ): self { + $obj = clone $this; + $obj->overwriteCustomMetadata = $overwriteCustomMetadata; + + return $obj; + } + + /** + * If `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately. + */ + public function withOverwriteFile(bool $overwriteFile): self + { + $obj = clone $this; + $obj->overwriteFile = $overwriteFile; + + return $obj; + } + + /** + * If the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed. + */ + public function withOverwriteTags(bool $overwriteTags): self + { + $obj = clone $this; + $obj->overwriteTags = $overwriteTags; + + return $obj; + } + + /** + * Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. + */ + public function withPublicKey(string $publicKey): self + { + $obj = clone $this; + $obj->publicKey = $publicKey; + + return $obj; + } + + /** + * Array of response field keys to include in the API response body. + * + * @param list $responseFields + */ + public function withResponseFields(array $responseFields): self + { + $obj = clone $this; + $obj->responseFields = $responseFields; + + return $obj; + } + + /** + * HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. + * + * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. + */ + public function withSignature(string $signature): self + { + $obj = clone $this; + $obj->signature = $signature; + + return $obj; + } + + /** + * Set the tags while uploading the file. + * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. + * If this field is not specified and the file is overwritten, the existing tags will be removed. + * + * @param list $tags + */ + public function withTags(array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * Configure pre-processing (`pre`) and post-processing (`post`) transformations. + * + * - `pre` — applied before the file is uploaded to the Media Library. + * Useful for reducing file size or applying basic optimizations upfront (e.g., resize, compress). + * + * - `post` — applied immediately after upload. + * Ideal for generating transformed versions (like video encodes or thumbnails) in advance, so they're ready for delivery without delay. + * + * You can mix and match any combination of post-processing types. + */ + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Whether to use a unique filename for this file or not. + * + * If `true`, ImageKit.io will add a unique suffix to the filename parameter to get a unique filename. + * + * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. + */ + public function withUseUniqueFileName(bool $useUniqueFileName): self + { + $obj = clone $this; + $obj->useUniqueFileName = $useUniqueFileName; + + return $obj; + } + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function withWebhookURL(string $webhookURL): self + { + $obj = clone $this; + $obj->webhookURL = $webhookURL; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Extension.php b/src/Files/FileUploadParams/Extension.php new file mode 100644 index 00000000..ace12834 --- /dev/null +++ b/src/Files/FileUploadParams/Extension.php @@ -0,0 +1,35 @@ +|array + */ + public static function variants(): array + { + return [ + AutoTaggingExtension::class, + 'remove-bg' => RemoveBg::class, + 'ai-auto-description' => AIAutoDescription::class, + ]; + } +} diff --git a/src/Files/FileUploadParams/Extension/AIAutoDescription.php b/src/Files/FileUploadParams/Extension/AIAutoDescription.php new file mode 100644 index 00000000..4affc0d4 --- /dev/null +++ b/src/Files/FileUploadParams/Extension/AIAutoDescription.php @@ -0,0 +1,39 @@ + */ + use SdkModel; + + /** + * Specifies the auto description extension. + */ + #[Api] + public string $name = 'ai-auto-description'; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Files/FileUploadParams/Extension/AutoTaggingExtension.php b/src/Files/FileUploadParams/Extension/AutoTaggingExtension.php new file mode 100644 index 00000000..f1042d04 --- /dev/null +++ b/src/Files/FileUploadParams/Extension/AutoTaggingExtension.php @@ -0,0 +1,119 @@ + */ + use SdkModel; + + /** + * Maximum number of tags to attach to the asset. + */ + #[Api] + public int $maxTags; + + /** + * Minimum confidence level for tags to be considered valid. + */ + #[Api] + public int $minConfidence; + + /** + * Specifies the auto-tagging extension used. + * + * @var Name::* $name + */ + #[Api(enum: Name::class)] + public string $name; + + /** + * `new AutoTaggingExtension()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * AutoTaggingExtension::with(maxTags: ..., minConfidence: ..., name: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new AutoTaggingExtension) + * ->withMaxTags(...) + * ->withMinConfidence(...) + * ->withName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Name::* $name + */ + public static function with( + int $maxTags, + int $minConfidence, + string $name + ): self { + $obj = new self; + + $obj->maxTags = $maxTags; + $obj->minConfidence = $minConfidence; + $obj->name = $name; + + return $obj; + } + + /** + * Maximum number of tags to attach to the asset. + */ + public function withMaxTags(int $maxTags): self + { + $obj = clone $this; + $obj->maxTags = $maxTags; + + return $obj; + } + + /** + * Minimum confidence level for tags to be considered valid. + */ + public function withMinConfidence(int $minConfidence): self + { + $obj = clone $this; + $obj->minConfidence = $minConfidence; + + return $obj; + } + + /** + * Specifies the auto-tagging extension used. + * + * @param Name::* $name + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php b/src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php new file mode 100644 index 00000000..3e4be1ce --- /dev/null +++ b/src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Specifies the background removal extension. + */ + #[Api] + public string $name = 'remove-bg'; + + #[Api(optional: true)] + public ?Options $options; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Options $options = null): self + { + $obj = new self; + + null !== $options && $obj->options = $options; + + return $obj; + } + + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Extension/RemoveBg/Options.php b/src/Files/FileUploadParams/Extension/RemoveBg/Options.php new file mode 100644 index 00000000..dd170491 --- /dev/null +++ b/src/Files/FileUploadParams/Extension/RemoveBg/Options.php @@ -0,0 +1,117 @@ + */ + use SdkModel; + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + #[Api('add_shadow', optional: true)] + public ?bool $addShadow; + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + #[Api('bg_color', optional: true)] + public ?string $bgColor; + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + #[Api('bg_image_url', optional: true)] + public ?string $bgImageURL; + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + #[Api(optional: true)] + public ?bool $semitransparency; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?bool $addShadow = null, + ?string $bgColor = null, + ?string $bgImageURL = null, + ?bool $semitransparency = null, + ): self { + $obj = new self; + + null !== $addShadow && $obj->addShadow = $addShadow; + null !== $bgColor && $obj->bgColor = $bgColor; + null !== $bgImageURL && $obj->bgImageURL = $bgImageURL; + null !== $semitransparency && $obj->semitransparency = $semitransparency; + + return $obj; + } + + /** + * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. + */ + public function withAddShadow(bool $addShadow): self + { + $obj = clone $this; + $obj->addShadow = $addShadow; + + return $obj; + } + + /** + * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. + */ + public function withBgColor(string $bgColor): self + { + $obj = clone $this; + $obj->bgColor = $bgColor; + + return $obj; + } + + /** + * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. + */ + public function withBgImageURL(string $bgImageURL): self + { + $obj = clone $this; + $obj->bgImageURL = $bgImageURL; + + return $obj; + } + + /** + * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. + */ + public function withSemitransparency(bool $semitransparency): self + { + $obj = clone $this; + $obj->semitransparency = $semitransparency; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/ResponseField.php b/src/Files/FileUploadParams/ResponseField.php new file mode 100644 index 00000000..dc6a9aa7 --- /dev/null +++ b/src/Files/FileUploadParams/ResponseField.php @@ -0,0 +1,27 @@ +|null, pre?: string|null + * } + */ +final class Transformation implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * List of transformations to apply *after* the file is uploaded. + * Each item must match one of the following types: + * `transformation`, `gif-to-video`, `thumbnail`, `abs`. + * + * @var list|null $post + */ + #[Api(list: Post::class, optional: true)] + public ?array $post; + + /** + * Transformation string to apply before uploading the file to the Media Library. Useful for optimizing files at ingestion. + */ + #[Api(optional: true)] + public ?string $pre; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $post + */ + public static function with(?array $post = null, ?string $pre = null): self + { + $obj = new self; + + null !== $post && $obj->post = $post; + null !== $pre && $obj->pre = $pre; + + return $obj; + } + + /** + * List of transformations to apply *after* the file is uploaded. + * Each item must match one of the following types: + * `transformation`, `gif-to-video`, `thumbnail`, `abs`. + * + * @param list $post + */ + public function withPost(array $post): self + { + $obj = clone $this; + $obj->post = $post; + + return $obj; + } + + /** + * Transformation string to apply before uploading the file to the Media Library. Useful for optimizing files at ingestion. + */ + public function withPre(string $pre): self + { + $obj = clone $this; + $obj->pre = $pre; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Transformation/Post.php b/src/Files/FileUploadParams/Transformation/Post.php new file mode 100644 index 00000000..25adf16b --- /dev/null +++ b/src/Files/FileUploadParams/Transformation/Post.php @@ -0,0 +1,37 @@ +|array + */ + public static function variants(): array + { + return [ + 'transformation' => Transformation::class, + 'gif-to-video' => GifToVideo::class, + 'thumbnail' => Thumbnail::class, + 'abs' => Abs::class, + ]; + } +} diff --git a/src/Files/FileUploadParams/Transformation/Post/Abs.php b/src/Files/FileUploadParams/Transformation/Post/Abs.php new file mode 100644 index 00000000..0bdb263e --- /dev/null +++ b/src/Files/FileUploadParams/Transformation/Post/Abs.php @@ -0,0 +1,101 @@ + */ + use SdkModel; + + /** + * Adaptive Bitrate Streaming (ABS) setup. + */ + #[Api] + public string $type = 'abs'; + + /** + * Streaming protocol to use (`hls` or `dash`). + * + * @var Protocol::* $protocol + */ + #[Api(enum: Protocol::class)] + public string $protocol; + + /** + * List of different representations you want to create separated by an underscore. + */ + #[Api] + public string $value; + + /** + * `new Abs()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Abs::with(protocol: ..., value: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Abs)->withProtocol(...)->withValue(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Protocol::* $protocol + */ + public static function with(string $protocol, string $value): self + { + $obj = new self; + + $obj->protocol = $protocol; + $obj->value = $value; + + return $obj; + } + + /** + * Streaming protocol to use (`hls` or `dash`). + * + * @param Protocol::* $protocol + */ + public function withProtocol(string $protocol): self + { + $obj = clone $this; + $obj->protocol = $protocol; + + return $obj; + } + + /** + * List of different representations you want to create separated by an underscore. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php b/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php new file mode 100644 index 00000000..a31642c3 --- /dev/null +++ b/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Converts an animated GIF into an MP4. + */ + #[Api] + public string $type = 'gif-to-video'; + + /** + * Optional transformation string to apply to the output video. + * **Example**: `q-80`. + */ + #[Api(optional: true)] + public ?string $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $value = null): self + { + $obj = new self; + + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Optional transformation string to apply to the output video. + * **Example**: `q-80`. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php b/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php new file mode 100644 index 00000000..426e24d0 --- /dev/null +++ b/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php @@ -0,0 +1,62 @@ + */ + use SdkModel; + + /** + * Generates a thumbnail image. + */ + #[Api] + public string $type = 'thumbnail'; + + /** + * Optional transformation string. + * **Example**: `w-150,h-150`. + */ + #[Api(optional: true)] + public ?string $value; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $value = null): self + { + $obj = new self; + + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Optional transformation string. + * **Example**: `w-150,h-150`. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Files/FileUploadParams/Transformation/Post/Transformation.php b/src/Files/FileUploadParams/Transformation/Post/Transformation.php new file mode 100644 index 00000000..3f514695 --- /dev/null +++ b/src/Files/FileUploadParams/Transformation/Post/Transformation.php @@ -0,0 +1,76 @@ + */ + use SdkModel; + + /** + * Transformation type. + */ + #[Api] + public string $type = 'transformation'; + + /** + * Transformation string (e.g. `w-200,h-200`). + * Same syntax as ImageKit URL-based transformations. + */ + #[Api] + public string $value; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(value: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withValue(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $value): self + { + $obj = new self; + + $obj->value = $value; + + return $obj; + } + + /** + * Transformation string (e.g. `w-200,h-200`). + * Same syntax as ImageKit URL-based transformations. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Files/FileUploadResponse.php b/src/Files/FileUploadResponse.php new file mode 100644 index 00000000..96f41701 --- /dev/null +++ b/src/Files/FileUploadResponse.php @@ -0,0 +1,555 @@ +|null, + * audioCodec?: string|null, + * bitRate?: int|null, + * customCoordinates?: string|null, + * customMetadata?: array|null, + * description?: string|null, + * duration?: int|null, + * embeddedMetadata?: array|null, + * extensionStatus?: ExtensionStatus|null, + * fileID?: string|null, + * filePath?: string|null, + * fileType?: string|null, + * height?: float|null, + * isPrivateFile?: bool|null, + * isPublished?: bool|null, + * metadata?: Metadata|null, + * name?: string|null, + * size?: float|null, + * tags?: list|null, + * thumbnailURL?: string|null, + * url?: string|null, + * versionInfo?: VersionInfo|null, + * videoCodec?: string|null, + * width?: float|null, + * } + */ +final class FileUploadResponse implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @var list|null $aiTags + */ + #[Api('AITags', list: AITag::class, nullable: true, optional: true)] + public ?array $aiTags; + + /** + * The audio codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $audioCodec; + + /** + * The bit rate of the video in kbps (only for video). + */ + #[Api(optional: true)] + public ?int $bitRate; + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * The duration of the video in seconds (only for video). + */ + #[Api(optional: true)] + public ?int $duration; + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @var array|null $embeddedMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $embeddedMetadata; + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + #[Api(optional: true)] + public ?ExtensionStatus $extensionStatus; + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + #[Api('fileId', optional: true)] + public ?string $fileID; + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + #[Api(optional: true)] + public ?string $filePath; + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + #[Api(optional: true)] + public ?string $fileType; + + /** + * Height of the image in pixels (Only for images). + */ + #[Api(optional: true)] + public ?float $height; + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + #[Api(optional: true)] + public ?Metadata $metadata; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Size of the image file in Bytes. + */ + #[Api(optional: true)] + public ?float $size; + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * In the case of an image, a small thumbnail URL. + */ + #[Api('thumbnailUrl', optional: true)] + public ?string $thumbnailURL; + + /** + * A publicly accessible URL of the file. + */ + #[Api(optional: true)] + public ?string $url; + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + #[Api(optional: true)] + public ?VersionInfo $versionInfo; + + /** + * The video codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $videoCodec; + + /** + * Width of the image in pixels (Only for Images). + */ + #[Api(optional: true)] + public ?float $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $aiTags + * @param array $customMetadata + * @param array $embeddedMetadata + * @param list|null $tags + */ + public static function with( + ?array $aiTags = null, + ?string $audioCodec = null, + ?int $bitRate = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?int $duration = null, + ?array $embeddedMetadata = null, + ?ExtensionStatus $extensionStatus = null, + ?string $fileID = null, + ?string $filePath = null, + ?string $fileType = null, + ?float $height = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?Metadata $metadata = null, + ?string $name = null, + ?float $size = null, + ?array $tags = null, + ?string $thumbnailURL = null, + ?string $url = null, + ?VersionInfo $versionInfo = null, + ?string $videoCodec = null, + ?float $width = null, + ): self { + $obj = new self; + + null !== $aiTags && $obj->aiTags = $aiTags; + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $bitRate && $obj->bitRate = $bitRate; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $duration && $obj->duration = $duration; + null !== $embeddedMetadata && $obj->embeddedMetadata = $embeddedMetadata; + null !== $extensionStatus && $obj->extensionStatus = $extensionStatus; + null !== $fileID && $obj->fileID = $fileID; + null !== $filePath && $obj->filePath = $filePath; + null !== $fileType && $obj->fileType = $fileType; + null !== $height && $obj->height = $height; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $metadata && $obj->metadata = $metadata; + null !== $name && $obj->name = $name; + null !== $size && $obj->size = $size; + null !== $tags && $obj->tags = $tags; + null !== $thumbnailURL && $obj->thumbnailURL = $thumbnailURL; + null !== $url && $obj->url = $url; + null !== $versionInfo && $obj->versionInfo = $versionInfo; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @param list|null $aiTags + */ + public function withAITags(?array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * The audio codec used in the video (only for video). + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * The bit rate of the video in kbps (only for video). + */ + public function withBitRate(int $bitRate): self + { + $obj = clone $this; + $obj->bitRate = $bitRate; + + return $obj; + } + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * The duration of the video in seconds (only for video). + */ + public function withDuration(int $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @param array $embeddedMetadata + */ + public function withEmbeddedMetadata(array $embeddedMetadata): self + { + $obj = clone $this; + $obj->embeddedMetadata = $embeddedMetadata; + + return $obj; + } + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + public function withExtensionStatus(ExtensionStatus $extensionStatus): self + { + $obj = clone $this; + $obj->extensionStatus = $extensionStatus; + + return $obj; + } + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * Height of the image in pixels (Only for images). + */ + public function withHeight(float $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + public function withMetadata(Metadata $metadata): self + { + $obj = clone $this; + $obj->metadata = $metadata; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Size of the image file in Bytes. + */ + public function withSize(float $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * In the case of an image, a small thumbnail URL. + */ + public function withThumbnailURL(string $thumbnailURL): self + { + $obj = clone $this; + $obj->thumbnailURL = $thumbnailURL; + + return $obj; + } + + /** + * A publicly accessible URL of the file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + public function withVersionInfo(VersionInfo $versionInfo): self + { + $obj = clone $this; + $obj->versionInfo = $versionInfo; + + return $obj; + } + + /** + * The video codec used in the video (only for video). + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Width of the image in pixels (Only for Images). + */ + public function withWidth(float $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Files/FileUploadResponse/AITag.php b/src/Files/FileUploadResponse/AITag.php new file mode 100644 index 00000000..547bcb68 --- /dev/null +++ b/src/Files/FileUploadResponse/AITag.php @@ -0,0 +1,95 @@ + */ + use SdkModel; + + /** + * Confidence score of the tag. + */ + #[Api(optional: true)] + public ?float $confidence; + + /** + * Name of the tag. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + #[Api(optional: true)] + public ?string $source; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $confidence = null, + ?string $name = null, + ?string $source = null + ): self { + $obj = new self; + + null !== $confidence && $obj->confidence = $confidence; + null !== $name && $obj->name = $name; + null !== $source && $obj->source = $source; + + return $obj; + } + + /** + * Confidence score of the tag. + */ + public function withConfidence(float $confidence): self + { + $obj = clone $this; + $obj->confidence = $confidence; + + return $obj; + } + + /** + * Name of the tag. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + public function withSource(string $source): self + { + $obj = clone $this; + $obj->source = $source; + + return $obj; + } +} diff --git a/src/Files/FileUploadResponse/ExtensionStatus.php b/src/Files/FileUploadResponse/ExtensionStatus.php new file mode 100644 index 00000000..1b0abced --- /dev/null +++ b/src/Files/FileUploadResponse/ExtensionStatus.php @@ -0,0 +1,126 @@ + */ + use SdkModel; + + /** @var AIAutoDescription::*|null $aiAutoDescription */ + #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] + public ?string $aiAutoDescription; + + /** @var AwsAutoTagging::*|null $awsAutoTagging */ + #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] + public ?string $awsAutoTagging; + + /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] + public ?string $googleAutoTagging; + + /** @var RemoveBg::*|null $removeBg */ + #[Api('remove-bg', enum: RemoveBg::class, optional: true)] + public ?string $removeBg; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AIAutoDescription::* $aiAutoDescription + * @param AwsAutoTagging::* $awsAutoTagging + * @param GoogleAutoTagging::* $googleAutoTagging + * @param RemoveBg::* $removeBg + */ + public static function with( + ?string $aiAutoDescription = null, + ?string $awsAutoTagging = null, + ?string $googleAutoTagging = null, + ?string $removeBg = null, + ): self { + $obj = new self; + + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg; + + return $obj; + } + + /** + * @param AIAutoDescription::* $aiAutoDescription + */ + public function withAIAutoDescription(string $aiAutoDescription): self + { + $obj = clone $this; + $obj->aiAutoDescription = $aiAutoDescription; + + return $obj; + } + + /** + * @param AwsAutoTagging::* $awsAutoTagging + */ + public function withAwsAutoTagging(string $awsAutoTagging): self + { + $obj = clone $this; + $obj->awsAutoTagging = $awsAutoTagging; + + return $obj; + } + + /** + * @param GoogleAutoTagging::* $googleAutoTagging + */ + public function withGoogleAutoTagging(string $googleAutoTagging): self + { + $obj = clone $this; + $obj->googleAutoTagging = $googleAutoTagging; + + return $obj; + } + + /** + * @param RemoveBg::* $removeBg + */ + public function withRemoveBg(string $removeBg): self + { + $obj = clone $this; + $obj->removeBg = $removeBg; + + return $obj; + } +} diff --git a/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php b/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php new file mode 100644 index 00000000..ade7f05c --- /dev/null +++ b/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php @@ -0,0 +1,19 @@ + */ + use SdkModel; + + /** + * Unique identifier of the file version. + */ + #[Api(optional: true)] + public ?string $id; + + /** + * Name of the file version. + */ + #[Api(optional: true)] + public ?string $name; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $id = null, ?string $name = null): self + { + $obj = new self; + + null !== $id && $obj->id = $id; + null !== $name && $obj->name = $name; + + return $obj; + } + + /** + * Unique identifier of the file version. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Name of the file version. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Files/Folder.php b/src/Files/Folder.php new file mode 100644 index 00000000..5778cbeb --- /dev/null +++ b/src/Files/Folder.php @@ -0,0 +1,164 @@ + */ + use SdkModel; + + /** + * Date and time when the folder was created. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $createdAt; + + /** + * Unique identifier of the asset. + */ + #[Api('folderId', optional: true)] + public ?string $folderID; + + /** + * Path of the folder. This is the path you would use in the URL to access the folder. For example, if the folder is at the root of the media library, the path will be /folder. If the folder is inside another folder named images, the path will be /images/folder. + */ + #[Api(optional: true)] + public ?string $folderPath; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Type of the asset. + * + * @var Type::*|null $type + */ + #[Api(enum: Type::class, optional: true)] + public ?string $type; + + /** + * Date and time when the folder was last updated. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $updatedAt; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + */ + public static function with( + ?\DateTimeInterface $createdAt = null, + ?string $folderID = null, + ?string $folderPath = null, + ?string $name = null, + ?string $type = null, + ?\DateTimeInterface $updatedAt = null, + ): self { + $obj = new self; + + null !== $createdAt && $obj->createdAt = $createdAt; + null !== $folderID && $obj->folderID = $folderID; + null !== $folderPath && $obj->folderPath = $folderPath; + null !== $name && $obj->name = $name; + null !== $type && $obj->type = $type; + null !== $updatedAt && $obj->updatedAt = $updatedAt; + + return $obj; + } + + /** + * Date and time when the folder was created. The date and time is in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + /** + * Unique identifier of the asset. + */ + public function withFolderID(string $folderID): self + { + $obj = clone $this; + $obj->folderID = $folderID; + + return $obj; + } + + /** + * Path of the folder. This is the path you would use in the URL to access the folder. For example, if the folder is at the root of the media library, the path will be /folder. If the folder is inside another folder named images, the path will be /images/folder. + */ + public function withFolderPath(string $folderPath): self + { + $obj = clone $this; + $obj->folderPath = $folderPath; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Type of the asset. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Date and time when the folder was last updated. The date and time is in ISO8601 format. + */ + public function withUpdatedAt(\DateTimeInterface $updatedAt): self + { + $obj = clone $this; + $obj->updatedAt = $updatedAt; + + return $obj; + } +} diff --git a/src/Files/Folder/Type.php b/src/Files/Folder/Type.php new file mode 100644 index 00000000..42c52ca4 --- /dev/null +++ b/src/Files/Folder/Type.php @@ -0,0 +1,18 @@ + */ + use SdkModel; + + /** + * The audio codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $audioCodec; + + /** + * The bit rate of the video in kbps (only for video). + */ + #[Api(optional: true)] + public ?int $bitRate; + + /** + * The density of the image in DPI. + */ + #[Api(optional: true)] + public ?int $density; + + /** + * The duration of the video in seconds (only for video). + */ + #[Api(optional: true)] + public ?int $duration; + + #[Api(optional: true)] + public ?Exif $exif; + + /** + * The format of the file (e.g., 'jpg', 'mp4'). + */ + #[Api(optional: true)] + public ?string $format; + + /** + * Indicates if the image has a color profile. + */ + #[Api(optional: true)] + public ?bool $hasColorProfile; + + /** + * Indicates if the image contains transparent areas. + */ + #[Api(optional: true)] + public ?bool $hasTransparency; + + /** + * The height of the image or video in pixels. + */ + #[Api(optional: true)] + public ?int $height; + + /** + * Perceptual hash of the image. + */ + #[Api(optional: true)] + public ?string $pHash; + + /** + * The quality indicator of the image. + */ + #[Api(optional: true)] + public ?int $quality; + + /** + * The file size in bytes. + */ + #[Api(optional: true)] + public ?int $size; + + /** + * The video codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $videoCodec; + + /** + * The width of the image or video in pixels. + */ + #[Api(optional: true)] + public ?int $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?string $audioCodec = null, + ?int $bitRate = null, + ?int $density = null, + ?int $duration = null, + ?Exif $exif = null, + ?string $format = null, + ?bool $hasColorProfile = null, + ?bool $hasTransparency = null, + ?int $height = null, + ?string $pHash = null, + ?int $quality = null, + ?int $size = null, + ?string $videoCodec = null, + ?int $width = null, + ): self { + $obj = new self; + + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $bitRate && $obj->bitRate = $bitRate; + null !== $density && $obj->density = $density; + null !== $duration && $obj->duration = $duration; + null !== $exif && $obj->exif = $exif; + null !== $format && $obj->format = $format; + null !== $hasColorProfile && $obj->hasColorProfile = $hasColorProfile; + null !== $hasTransparency && $obj->hasTransparency = $hasTransparency; + null !== $height && $obj->height = $height; + null !== $pHash && $obj->pHash = $pHash; + null !== $quality && $obj->quality = $quality; + null !== $size && $obj->size = $size; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * The audio codec used in the video (only for video). + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * The bit rate of the video in kbps (only for video). + */ + public function withBitRate(int $bitRate): self + { + $obj = clone $this; + $obj->bitRate = $bitRate; + + return $obj; + } + + /** + * The density of the image in DPI. + */ + public function withDensity(int $density): self + { + $obj = clone $this; + $obj->density = $density; + + return $obj; + } + + /** + * The duration of the video in seconds (only for video). + */ + public function withDuration(int $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + public function withExif(Exif $exif): self + { + $obj = clone $this; + $obj->exif = $exif; + + return $obj; + } + + /** + * The format of the file (e.g., 'jpg', 'mp4'). + */ + public function withFormat(string $format): self + { + $obj = clone $this; + $obj->format = $format; + + return $obj; + } + + /** + * Indicates if the image has a color profile. + */ + public function withHasColorProfile(bool $hasColorProfile): self + { + $obj = clone $this; + $obj->hasColorProfile = $hasColorProfile; + + return $obj; + } + + /** + * Indicates if the image contains transparent areas. + */ + public function withHasTransparency(bool $hasTransparency): self + { + $obj = clone $this; + $obj->hasTransparency = $hasTransparency; + + return $obj; + } + + /** + * The height of the image or video in pixels. + */ + public function withHeight(int $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Perceptual hash of the image. + */ + public function withPHash(string $pHash): self + { + $obj = clone $this; + $obj->pHash = $pHash; + + return $obj; + } + + /** + * The quality indicator of the image. + */ + public function withQuality(int $quality): self + { + $obj = clone $this; + $obj->quality = $quality; + + return $obj; + } + + /** + * The file size in bytes. + */ + public function withSize(int $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * The video codec used in the video (only for video). + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * The width of the image or video in pixels. + */ + public function withWidth(int $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif.php b/src/Files/Metadata/Exif.php new file mode 100644 index 00000000..a1815e9d --- /dev/null +++ b/src/Files/Metadata/Exif.php @@ -0,0 +1,163 @@ +|null, + * thumbnail?: Thumbnail|null, + * } + */ +final class Exif implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Object containing Exif details. + */ + #[Api(optional: true)] + public ?Exif1 $exif; + + /** + * Object containing GPS information. + */ + #[Api(optional: true)] + public ?Gps $gps; + + /** + * Object containing EXIF image information. + */ + #[Api(optional: true)] + public ?Image $image; + + /** + * JSON object. + */ + #[Api(optional: true)] + public ?Interoperability $interoperability; + + /** @var array|null $makernote */ + #[Api(map: 'mixed', optional: true)] + public ?array $makernote; + + /** + * Object containing Thumbnail information. + */ + #[Api(optional: true)] + public ?Thumbnail $thumbnail; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $makernote + */ + public static function with( + ?Exif1 $exif = null, + ?Gps $gps = null, + ?Image $image = null, + ?Interoperability $interoperability = null, + ?array $makernote = null, + ?Thumbnail $thumbnail = null, + ): self { + $obj = new self; + + null !== $exif && $obj->exif = $exif; + null !== $gps && $obj->gps = $gps; + null !== $image && $obj->image = $image; + null !== $interoperability && $obj->interoperability = $interoperability; + null !== $makernote && $obj->makernote = $makernote; + null !== $thumbnail && $obj->thumbnail = $thumbnail; + + return $obj; + } + + /** + * Object containing Exif details. + */ + public function withExif(Exif1 $exif): self + { + $obj = clone $this; + $obj->exif = $exif; + + return $obj; + } + + /** + * Object containing GPS information. + */ + public function withGps(Gps $gps): self + { + $obj = clone $this; + $obj->gps = $gps; + + return $obj; + } + + /** + * Object containing EXIF image information. + */ + public function withImage(Image $image): self + { + $obj = clone $this; + $obj->image = $image; + + return $obj; + } + + /** + * JSON object. + */ + public function withInteroperability( + Interoperability $interoperability + ): self { + $obj = clone $this; + $obj->interoperability = $interoperability; + + return $obj; + } + + /** + * @param array $makernote + */ + public function withMakernote(array $makernote): self + { + $obj = clone $this; + $obj->makernote = $makernote; + + return $obj; + } + + /** + * Object containing Thumbnail information. + */ + public function withThumbnail(Thumbnail $thumbnail): self + { + $obj = clone $this; + $obj->thumbnail = $thumbnail; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif/Exif.php b/src/Files/Metadata/Exif/Exif.php new file mode 100644 index 00000000..1bd947ab --- /dev/null +++ b/src/Files/Metadata/Exif/Exif.php @@ -0,0 +1,406 @@ + */ + use SdkModel; + + #[Api('ApertureValue', optional: true)] + public ?float $apertureValue; + + #[Api('ColorSpace', optional: true)] + public ?int $colorSpace; + + #[Api('CreateDate', optional: true)] + public ?string $createDate; + + #[Api('CustomRendered', optional: true)] + public ?int $customRendered; + + #[Api('DateTimeOriginal', optional: true)] + public ?string $dateTimeOriginal; + + #[Api('ExifImageHeight', optional: true)] + public ?int $exifImageHeight; + + #[Api('ExifImageWidth', optional: true)] + public ?int $exifImageWidth; + + #[Api('ExifVersion', optional: true)] + public ?string $exifVersion; + + #[Api('ExposureCompensation', optional: true)] + public ?float $exposureCompensation; + + #[Api('ExposureMode', optional: true)] + public ?int $exposureMode; + + #[Api('ExposureProgram', optional: true)] + public ?int $exposureProgram; + + #[Api('ExposureTime', optional: true)] + public ?float $exposureTime; + + #[Api('Flash', optional: true)] + public ?int $flash; + + #[Api('FlashpixVersion', optional: true)] + public ?string $flashpixVersion; + + #[Api('FNumber', optional: true)] + public ?float $fNumber; + + #[Api('FocalLength', optional: true)] + public ?int $focalLength; + + #[Api('FocalPlaneResolutionUnit', optional: true)] + public ?int $focalPlaneResolutionUnit; + + #[Api('FocalPlaneXResolution', optional: true)] + public ?float $focalPlaneXResolution; + + #[Api('FocalPlaneYResolution', optional: true)] + public ?float $focalPlaneYResolution; + + #[Api('InteropOffset', optional: true)] + public ?int $interopOffset; + + #[Api('ISO', optional: true)] + public ?int $iso; + + #[Api('MeteringMode', optional: true)] + public ?int $meteringMode; + + #[Api('SceneCaptureType', optional: true)] + public ?int $sceneCaptureType; + + #[Api('ShutterSpeedValue', optional: true)] + public ?float $shutterSpeedValue; + + #[Api('SubSecTime', optional: true)] + public ?string $subSecTime; + + #[Api('WhiteBalance', optional: true)] + public ?int $whiteBalance; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $apertureValue = null, + ?int $colorSpace = null, + ?string $createDate = null, + ?int $customRendered = null, + ?string $dateTimeOriginal = null, + ?int $exifImageHeight = null, + ?int $exifImageWidth = null, + ?string $exifVersion = null, + ?float $exposureCompensation = null, + ?int $exposureMode = null, + ?int $exposureProgram = null, + ?float $exposureTime = null, + ?int $flash = null, + ?string $flashpixVersion = null, + ?float $fNumber = null, + ?int $focalLength = null, + ?int $focalPlaneResolutionUnit = null, + ?float $focalPlaneXResolution = null, + ?float $focalPlaneYResolution = null, + ?int $interopOffset = null, + ?int $iso = null, + ?int $meteringMode = null, + ?int $sceneCaptureType = null, + ?float $shutterSpeedValue = null, + ?string $subSecTime = null, + ?int $whiteBalance = null, + ): self { + $obj = new self; + + null !== $apertureValue && $obj->apertureValue = $apertureValue; + null !== $colorSpace && $obj->colorSpace = $colorSpace; + null !== $createDate && $obj->createDate = $createDate; + null !== $customRendered && $obj->customRendered = $customRendered; + null !== $dateTimeOriginal && $obj->dateTimeOriginal = $dateTimeOriginal; + null !== $exifImageHeight && $obj->exifImageHeight = $exifImageHeight; + null !== $exifImageWidth && $obj->exifImageWidth = $exifImageWidth; + null !== $exifVersion && $obj->exifVersion = $exifVersion; + null !== $exposureCompensation && $obj->exposureCompensation = $exposureCompensation; + null !== $exposureMode && $obj->exposureMode = $exposureMode; + null !== $exposureProgram && $obj->exposureProgram = $exposureProgram; + null !== $exposureTime && $obj->exposureTime = $exposureTime; + null !== $flash && $obj->flash = $flash; + null !== $flashpixVersion && $obj->flashpixVersion = $flashpixVersion; + null !== $fNumber && $obj->fNumber = $fNumber; + null !== $focalLength && $obj->focalLength = $focalLength; + null !== $focalPlaneResolutionUnit && $obj->focalPlaneResolutionUnit = $focalPlaneResolutionUnit; + null !== $focalPlaneXResolution && $obj->focalPlaneXResolution = $focalPlaneXResolution; + null !== $focalPlaneYResolution && $obj->focalPlaneYResolution = $focalPlaneYResolution; + null !== $interopOffset && $obj->interopOffset = $interopOffset; + null !== $iso && $obj->iso = $iso; + null !== $meteringMode && $obj->meteringMode = $meteringMode; + null !== $sceneCaptureType && $obj->sceneCaptureType = $sceneCaptureType; + null !== $shutterSpeedValue && $obj->shutterSpeedValue = $shutterSpeedValue; + null !== $subSecTime && $obj->subSecTime = $subSecTime; + null !== $whiteBalance && $obj->whiteBalance = $whiteBalance; + + return $obj; + } + + public function withApertureValue(float $apertureValue): self + { + $obj = clone $this; + $obj->apertureValue = $apertureValue; + + return $obj; + } + + public function withColorSpace(int $colorSpace): self + { + $obj = clone $this; + $obj->colorSpace = $colorSpace; + + return $obj; + } + + public function withCreateDate(string $createDate): self + { + $obj = clone $this; + $obj->createDate = $createDate; + + return $obj; + } + + public function withCustomRendered(int $customRendered): self + { + $obj = clone $this; + $obj->customRendered = $customRendered; + + return $obj; + } + + public function withDateTimeOriginal(string $dateTimeOriginal): self + { + $obj = clone $this; + $obj->dateTimeOriginal = $dateTimeOriginal; + + return $obj; + } + + public function withExifImageHeight(int $exifImageHeight): self + { + $obj = clone $this; + $obj->exifImageHeight = $exifImageHeight; + + return $obj; + } + + public function withExifImageWidth(int $exifImageWidth): self + { + $obj = clone $this; + $obj->exifImageWidth = $exifImageWidth; + + return $obj; + } + + public function withExifVersion(string $exifVersion): self + { + $obj = clone $this; + $obj->exifVersion = $exifVersion; + + return $obj; + } + + public function withExposureCompensation(float $exposureCompensation): self + { + $obj = clone $this; + $obj->exposureCompensation = $exposureCompensation; + + return $obj; + } + + public function withExposureMode(int $exposureMode): self + { + $obj = clone $this; + $obj->exposureMode = $exposureMode; + + return $obj; + } + + public function withExposureProgram(int $exposureProgram): self + { + $obj = clone $this; + $obj->exposureProgram = $exposureProgram; + + return $obj; + } + + public function withExposureTime(float $exposureTime): self + { + $obj = clone $this; + $obj->exposureTime = $exposureTime; + + return $obj; + } + + public function withFlash(int $flash): self + { + $obj = clone $this; + $obj->flash = $flash; + + return $obj; + } + + public function withFlashpixVersion(string $flashpixVersion): self + { + $obj = clone $this; + $obj->flashpixVersion = $flashpixVersion; + + return $obj; + } + + public function withFNumber(float $fNumber): self + { + $obj = clone $this; + $obj->fNumber = $fNumber; + + return $obj; + } + + public function withFocalLength(int $focalLength): self + { + $obj = clone $this; + $obj->focalLength = $focalLength; + + return $obj; + } + + public function withFocalPlaneResolutionUnit( + int $focalPlaneResolutionUnit + ): self { + $obj = clone $this; + $obj->focalPlaneResolutionUnit = $focalPlaneResolutionUnit; + + return $obj; + } + + public function withFocalPlaneXResolution( + float $focalPlaneXResolution + ): self { + $obj = clone $this; + $obj->focalPlaneXResolution = $focalPlaneXResolution; + + return $obj; + } + + public function withFocalPlaneYResolution( + float $focalPlaneYResolution + ): self { + $obj = clone $this; + $obj->focalPlaneYResolution = $focalPlaneYResolution; + + return $obj; + } + + public function withInteropOffset(int $interopOffset): self + { + $obj = clone $this; + $obj->interopOffset = $interopOffset; + + return $obj; + } + + public function withISO(int $iso): self + { + $obj = clone $this; + $obj->iso = $iso; + + return $obj; + } + + public function withMeteringMode(int $meteringMode): self + { + $obj = clone $this; + $obj->meteringMode = $meteringMode; + + return $obj; + } + + public function withSceneCaptureType(int $sceneCaptureType): self + { + $obj = clone $this; + $obj->sceneCaptureType = $sceneCaptureType; + + return $obj; + } + + public function withShutterSpeedValue(float $shutterSpeedValue): self + { + $obj = clone $this; + $obj->shutterSpeedValue = $shutterSpeedValue; + + return $obj; + } + + public function withSubSecTime(string $subSecTime): self + { + $obj = clone $this; + $obj->subSecTime = $subSecTime; + + return $obj; + } + + public function withWhiteBalance(int $whiteBalance): self + { + $obj = clone $this; + $obj->whiteBalance = $whiteBalance; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif/Gps.php b/src/Files/Metadata/Exif/Gps.php new file mode 100644 index 00000000..9f4d027f --- /dev/null +++ b/src/Files/Metadata/Exif/Gps.php @@ -0,0 +1,56 @@ +|null} + */ +final class Gps implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** @var list|null $gpsVersionID */ + #[Api('GPSVersionID', list: 'int', optional: true)] + public ?array $gpsVersionID; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $gpsVersionID + */ + public static function with(?array $gpsVersionID = null): self + { + $obj = new self; + + null !== $gpsVersionID && $obj->gpsVersionID = $gpsVersionID; + + return $obj; + } + + /** + * @param list $gpsVersionID + */ + public function withGpsVersionID(array $gpsVersionID): self + { + $obj = clone $this; + $obj->gpsVersionID = $gpsVersionID; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif/Image.php b/src/Files/Metadata/Exif/Image.php new file mode 100644 index 00000000..2d66f0d4 --- /dev/null +++ b/src/Files/Metadata/Exif/Image.php @@ -0,0 +1,193 @@ + */ + use SdkModel; + + #[Api('ExifOffset', optional: true)] + public ?int $exifOffset; + + #[Api('GPSInfo', optional: true)] + public ?int $gpsInfo; + + #[Api('Make', optional: true)] + public ?string $make; + + #[Api('Model', optional: true)] + public ?string $model; + + #[Api('ModifyDate', optional: true)] + public ?string $modifyDate; + + #[Api('Orientation', optional: true)] + public ?int $orientation; + + #[Api('ResolutionUnit', optional: true)] + public ?int $resolutionUnit; + + #[Api('Software', optional: true)] + public ?string $software; + + #[Api('XResolution', optional: true)] + public ?int $xResolution; + + #[Api('YCbCrPositioning', optional: true)] + public ?int $yCbCrPositioning; + + #[Api('YResolution', optional: true)] + public ?int $yResolution; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?int $exifOffset = null, + ?int $gpsInfo = null, + ?string $make = null, + ?string $model = null, + ?string $modifyDate = null, + ?int $orientation = null, + ?int $resolutionUnit = null, + ?string $software = null, + ?int $xResolution = null, + ?int $yCbCrPositioning = null, + ?int $yResolution = null, + ): self { + $obj = new self; + + null !== $exifOffset && $obj->exifOffset = $exifOffset; + null !== $gpsInfo && $obj->gpsInfo = $gpsInfo; + null !== $make && $obj->make = $make; + null !== $model && $obj->model = $model; + null !== $modifyDate && $obj->modifyDate = $modifyDate; + null !== $orientation && $obj->orientation = $orientation; + null !== $resolutionUnit && $obj->resolutionUnit = $resolutionUnit; + null !== $software && $obj->software = $software; + null !== $xResolution && $obj->xResolution = $xResolution; + null !== $yCbCrPositioning && $obj->yCbCrPositioning = $yCbCrPositioning; + null !== $yResolution && $obj->yResolution = $yResolution; + + return $obj; + } + + public function withExifOffset(int $exifOffset): self + { + $obj = clone $this; + $obj->exifOffset = $exifOffset; + + return $obj; + } + + public function withGpsInfo(int $gpsInfo): self + { + $obj = clone $this; + $obj->gpsInfo = $gpsInfo; + + return $obj; + } + + public function withMake(string $make): self + { + $obj = clone $this; + $obj->make = $make; + + return $obj; + } + + public function withModel(string $model): self + { + $obj = clone $this; + $obj->model = $model; + + return $obj; + } + + public function withModifyDate(string $modifyDate): self + { + $obj = clone $this; + $obj->modifyDate = $modifyDate; + + return $obj; + } + + public function withOrientation(int $orientation): self + { + $obj = clone $this; + $obj->orientation = $orientation; + + return $obj; + } + + public function withResolutionUnit(int $resolutionUnit): self + { + $obj = clone $this; + $obj->resolutionUnit = $resolutionUnit; + + return $obj; + } + + public function withSoftware(string $software): self + { + $obj = clone $this; + $obj->software = $software; + + return $obj; + } + + public function withXResolution(int $xResolution): self + { + $obj = clone $this; + $obj->xResolution = $xResolution; + + return $obj; + } + + public function withYCbCrPositioning(int $yCbCrPositioning): self + { + $obj = clone $this; + $obj->yCbCrPositioning = $yCbCrPositioning; + + return $obj; + } + + public function withYResolution(int $yResolution): self + { + $obj = clone $this; + $obj->yResolution = $yResolution; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif/Interoperability.php b/src/Files/Metadata/Exif/Interoperability.php new file mode 100644 index 00000000..80632026 --- /dev/null +++ b/src/Files/Metadata/Exif/Interoperability.php @@ -0,0 +1,66 @@ + */ + use SdkModel; + + #[Api('InteropIndex', optional: true)] + public ?string $interopIndex; + + #[Api('InteropVersion', optional: true)] + public ?string $interopVersion; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?string $interopIndex = null, + ?string $interopVersion = null + ): self { + $obj = new self; + + null !== $interopIndex && $obj->interopIndex = $interopIndex; + null !== $interopVersion && $obj->interopVersion = $interopVersion; + + return $obj; + } + + public function withInteropIndex(string $interopIndex): self + { + $obj = clone $this; + $obj->interopIndex = $interopIndex; + + return $obj; + } + + public function withInteropVersion(string $interopVersion): self + { + $obj = clone $this; + $obj->interopVersion = $interopVersion; + + return $obj; + } +} diff --git a/src/Files/Metadata/Exif/Thumbnail.php b/src/Files/Metadata/Exif/Thumbnail.php new file mode 100644 index 00000000..b1dd809c --- /dev/null +++ b/src/Files/Metadata/Exif/Thumbnail.php @@ -0,0 +1,123 @@ + */ + use SdkModel; + + #[Api('Compression', optional: true)] + public ?int $compression; + + #[Api('ResolutionUnit', optional: true)] + public ?int $resolutionUnit; + + #[Api('ThumbnailLength', optional: true)] + public ?int $thumbnailLength; + + #[Api('ThumbnailOffset', optional: true)] + public ?int $thumbnailOffset; + + #[Api('XResolution', optional: true)] + public ?int $xResolution; + + #[Api('YResolution', optional: true)] + public ?int $yResolution; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?int $compression = null, + ?int $resolutionUnit = null, + ?int $thumbnailLength = null, + ?int $thumbnailOffset = null, + ?int $xResolution = null, + ?int $yResolution = null, + ): self { + $obj = new self; + + null !== $compression && $obj->compression = $compression; + null !== $resolutionUnit && $obj->resolutionUnit = $resolutionUnit; + null !== $thumbnailLength && $obj->thumbnailLength = $thumbnailLength; + null !== $thumbnailOffset && $obj->thumbnailOffset = $thumbnailOffset; + null !== $xResolution && $obj->xResolution = $xResolution; + null !== $yResolution && $obj->yResolution = $yResolution; + + return $obj; + } + + public function withCompression(int $compression): self + { + $obj = clone $this; + $obj->compression = $compression; + + return $obj; + } + + public function withResolutionUnit(int $resolutionUnit): self + { + $obj = clone $this; + $obj->resolutionUnit = $resolutionUnit; + + return $obj; + } + + public function withThumbnailLength(int $thumbnailLength): self + { + $obj = clone $this; + $obj->thumbnailLength = $thumbnailLength; + + return $obj; + } + + public function withThumbnailOffset(int $thumbnailOffset): self + { + $obj = clone $this; + $obj->thumbnailOffset = $thumbnailOffset; + + return $obj; + } + + public function withXResolution(int $xResolution): self + { + $obj = clone $this; + $obj->xResolution = $xResolution; + + return $obj; + } + + public function withYResolution(int $yResolution): self + { + $obj = clone $this; + $obj->yResolution = $yResolution; + + return $obj; + } +} diff --git a/src/Files/Metadata/MetadataGetFromURLParams.php b/src/Files/Metadata/MetadataGetFromURLParams.php new file mode 100644 index 00000000..d56164d9 --- /dev/null +++ b/src/Files/Metadata/MetadataGetFromURLParams.php @@ -0,0 +1,74 @@ +getFromURL + * + * @phpstan-type metadata_get_from_url_params = array{url: string} + */ +final class MetadataGetFromURLParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Should be a valid file URL. It should be accessible using your ImageKit.io account. + */ + #[Api] + public string $url; + + /** + * `new MetadataGetFromURLParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * MetadataGetFromURLParams::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new MetadataGetFromURLParams)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $url): self + { + $obj = new self; + + $obj->url = $url; + + return $obj; + } + + /** + * Should be a valid file URL. It should be accessible using your ImageKit.io account. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Files/Versions/VersionDeleteParams.php b/src/Files/Versions/VersionDeleteParams.php new file mode 100644 index 00000000..a5c99a18 --- /dev/null +++ b/src/Files/Versions/VersionDeleteParams.php @@ -0,0 +1,70 @@ +delete + * + * @phpstan-type version_delete_params = array{fileID: string} + */ +final class VersionDeleteParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + #[Api] + public string $fileID; + + /** + * `new VersionDeleteParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VersionDeleteParams::with(fileID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VersionDeleteParams)->withFileID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $fileID): self + { + $obj = new self; + + $obj->fileID = $fileID; + + return $obj; + } + + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } +} diff --git a/src/Files/Versions/VersionDeleteResponse.php b/src/Files/Versions/VersionDeleteResponse.php new file mode 100644 index 00000000..39c07a2d --- /dev/null +++ b/src/Files/Versions/VersionDeleteResponse.php @@ -0,0 +1,32 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Files/Versions/VersionGetParams.php b/src/Files/Versions/VersionGetParams.php new file mode 100644 index 00000000..e6d9ac37 --- /dev/null +++ b/src/Files/Versions/VersionGetParams.php @@ -0,0 +1,68 @@ +get + * + * @phpstan-type version_get_params = array{fileID: string} + */ +final class VersionGetParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + #[Api] + public string $fileID; + + /** + * `new VersionGetParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VersionGetParams::with(fileID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VersionGetParams)->withFileID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $fileID): self + { + $obj = new self; + + $obj->fileID = $fileID; + + return $obj; + } + + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } +} diff --git a/src/Files/Versions/VersionRestoreParams.php b/src/Files/Versions/VersionRestoreParams.php new file mode 100644 index 00000000..e1deb729 --- /dev/null +++ b/src/Files/Versions/VersionRestoreParams.php @@ -0,0 +1,68 @@ +restore + * + * @phpstan-type version_restore_params = array{fileID: string} + */ +final class VersionRestoreParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + #[Api] + public string $fileID; + + /** + * `new VersionRestoreParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VersionRestoreParams::with(fileID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VersionRestoreParams)->withFileID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $fileID): self + { + $obj = new self; + + $obj->fileID = $fileID; + + return $obj; + } + + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } +} diff --git a/src/Folders/FolderCopyParams.php b/src/Folders/FolderCopyParams.php new file mode 100644 index 00000000..c70ebbac --- /dev/null +++ b/src/Folders/FolderCopyParams.php @@ -0,0 +1,116 @@ +copy + * + * @phpstan-type folder_copy_params = array{ + * destinationPath: string, sourceFolderPath: string, includeVersions?: bool + * } + */ +final class FolderCopyParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Full path to the destination folder where you want to copy the source folder into. + */ + #[Api] + public string $destinationPath; + + /** + * The full path to the source folder you want to copy. + */ + #[Api] + public string $sourceFolderPath; + + /** + * Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. + */ + #[Api(optional: true)] + public ?bool $includeVersions; + + /** + * `new FolderCopyParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderCopyParams::with(destinationPath: ..., sourceFolderPath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderCopyParams)->withDestinationPath(...)->withSourceFolderPath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $destinationPath, + string $sourceFolderPath, + ?bool $includeVersions = null, + ): self { + $obj = new self; + + $obj->destinationPath = $destinationPath; + $obj->sourceFolderPath = $sourceFolderPath; + + null !== $includeVersions && $obj->includeVersions = $includeVersions; + + return $obj; + } + + /** + * Full path to the destination folder where you want to copy the source folder into. + */ + public function withDestinationPath(string $destinationPath): self + { + $obj = clone $this; + $obj->destinationPath = $destinationPath; + + return $obj; + } + + /** + * The full path to the source folder you want to copy. + */ + public function withSourceFolderPath(string $sourceFolderPath): self + { + $obj = clone $this; + $obj->sourceFolderPath = $sourceFolderPath; + + return $obj; + } + + /** + * Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. + */ + public function withIncludeVersions(bool $includeVersions): self + { + $obj = clone $this; + $obj->includeVersions = $includeVersions; + + return $obj; + } +} diff --git a/src/Folders/FolderCopyResponse.php b/src/Folders/FolderCopyResponse.php new file mode 100644 index 00000000..81c8daa4 --- /dev/null +++ b/src/Folders/FolderCopyResponse.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + #[Api('jobId')] + public string $jobID; + + /** + * `new FolderCopyResponse()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderCopyResponse::with(jobID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderCopyResponse)->withJobID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $jobID): self + { + $obj = new self; + + $obj->jobID = $jobID; + + return $obj; + } + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + public function withJobID(string $jobID): self + { + $obj = clone $this; + $obj->jobID = $jobID; + + return $obj; + } +} diff --git a/src/Folders/FolderCreateParams.php b/src/Folders/FolderCreateParams.php new file mode 100644 index 00000000..7698adae --- /dev/null +++ b/src/Folders/FolderCreateParams.php @@ -0,0 +1,104 @@ +create + * + * @phpstan-type folder_create_params = array{ + * folderName: string, parentFolderPath: string + * } + */ +final class FolderCreateParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The folder will be created with this name. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) will be replaced by an underscore i.e. `_`. + */ + #[Api] + public string $folderName; + + /** + * The folder where the new folder should be created, for root use `/` else the path e.g. `containing/folder/`. + * + * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. + */ + #[Api] + public string $parentFolderPath; + + /** + * `new FolderCreateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderCreateParams::with(folderName: ..., parentFolderPath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderCreateParams)->withFolderName(...)->withParentFolderPath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $folderName, + string $parentFolderPath + ): self { + $obj = new self; + + $obj->folderName = $folderName; + $obj->parentFolderPath = $parentFolderPath; + + return $obj; + } + + /** + * The folder will be created with this name. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) will be replaced by an underscore i.e. `_`. + */ + public function withFolderName(string $folderName): self + { + $obj = clone $this; + $obj->folderName = $folderName; + + return $obj; + } + + /** + * The folder where the new folder should be created, for root use `/` else the path e.g. `containing/folder/`. + * + * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. + */ + public function withParentFolderPath(string $parentFolderPath): self + { + $obj = clone $this; + $obj->parentFolderPath = $parentFolderPath; + + return $obj; + } +} diff --git a/src/Folders/FolderDeleteParams.php b/src/Folders/FolderDeleteParams.php new file mode 100644 index 00000000..0af429b0 --- /dev/null +++ b/src/Folders/FolderDeleteParams.php @@ -0,0 +1,74 @@ +delete + * + * @phpstan-type folder_delete_params = array{folderPath: string} + */ +final class FolderDeleteParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Full path to the folder you want to delete. For example `/folder/to/delete/`. + */ + #[Api] + public string $folderPath; + + /** + * `new FolderDeleteParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderDeleteParams::with(folderPath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderDeleteParams)->withFolderPath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $folderPath): self + { + $obj = new self; + + $obj->folderPath = $folderPath; + + return $obj; + } + + /** + * Full path to the folder you want to delete. For example `/folder/to/delete/`. + */ + public function withFolderPath(string $folderPath): self + { + $obj = clone $this; + $obj->folderPath = $folderPath; + + return $obj; + } +} diff --git a/src/Folders/FolderDeleteResponse.php b/src/Folders/FolderDeleteResponse.php new file mode 100644 index 00000000..c7a62789 --- /dev/null +++ b/src/Folders/FolderDeleteResponse.php @@ -0,0 +1,32 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Folders/FolderMoveParams.php b/src/Folders/FolderMoveParams.php new file mode 100644 index 00000000..f04be7df --- /dev/null +++ b/src/Folders/FolderMoveParams.php @@ -0,0 +1,96 @@ +move + * + * @phpstan-type folder_move_params = array{ + * destinationPath: string, sourceFolderPath: string + * } + */ +final class FolderMoveParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * Full path to the destination folder where you want to move the source folder into. + */ + #[Api] + public string $destinationPath; + + /** + * The full path to the source folder you want to move. + */ + #[Api] + public string $sourceFolderPath; + + /** + * `new FolderMoveParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderMoveParams::with(destinationPath: ..., sourceFolderPath: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderMoveParams)->withDestinationPath(...)->withSourceFolderPath(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $destinationPath, + string $sourceFolderPath + ): self { + $obj = new self; + + $obj->destinationPath = $destinationPath; + $obj->sourceFolderPath = $sourceFolderPath; + + return $obj; + } + + /** + * Full path to the destination folder where you want to move the source folder into. + */ + public function withDestinationPath(string $destinationPath): self + { + $obj = clone $this; + $obj->destinationPath = $destinationPath; + + return $obj; + } + + /** + * The full path to the source folder you want to move. + */ + public function withSourceFolderPath(string $sourceFolderPath): self + { + $obj = clone $this; + $obj->sourceFolderPath = $sourceFolderPath; + + return $obj; + } +} diff --git a/src/Folders/FolderMoveResponse.php b/src/Folders/FolderMoveResponse.php new file mode 100644 index 00000000..5d767f7b --- /dev/null +++ b/src/Folders/FolderMoveResponse.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + #[Api('jobId')] + public string $jobID; + + /** + * `new FolderMoveResponse()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderMoveResponse::with(jobID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderMoveResponse)->withJobID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $jobID): self + { + $obj = new self; + + $obj->jobID = $jobID; + + return $obj; + } + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + public function withJobID(string $jobID): self + { + $obj = clone $this; + $obj->jobID = $jobID; + + return $obj; + } +} diff --git a/src/Folders/FolderNewResponse.php b/src/Folders/FolderNewResponse.php new file mode 100644 index 00000000..f8ce7b88 --- /dev/null +++ b/src/Folders/FolderNewResponse.php @@ -0,0 +1,32 @@ + */ + use SdkModel; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(): self + { + return new self; + } +} diff --git a/src/Folders/FolderRenameParams.php b/src/Folders/FolderRenameParams.php new file mode 100644 index 00000000..e7260993 --- /dev/null +++ b/src/Folders/FolderRenameParams.php @@ -0,0 +1,132 @@ +rename + * + * @phpstan-type folder_rename_params = array{ + * folderPath: string, newFolderName: string, purgeCache?: bool + * } + */ +final class FolderRenameParams implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + use SdkParams; + + /** + * The full path to the folder you want to rename. + */ + #[Api] + public string $folderPath; + + /** + * The new name for the folder. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and `-` will be replaced by an underscore i.e. `_`. + */ + #[Api] + public string $newFolderName; + + /** + * Option to purge cache for the old nested files and their versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota. + * + * Note: A purge cache request will be issued against `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * Default value - `false` + */ + #[Api(optional: true)] + public ?bool $purgeCache; + + /** + * `new FolderRenameParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderRenameParams::with(folderPath: ..., newFolderName: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderRenameParams)->withFolderPath(...)->withNewFolderName(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $folderPath, + string $newFolderName, + ?bool $purgeCache = null + ): self { + $obj = new self; + + $obj->folderPath = $folderPath; + $obj->newFolderName = $newFolderName; + + null !== $purgeCache && $obj->purgeCache = $purgeCache; + + return $obj; + } + + /** + * The full path to the folder you want to rename. + */ + public function withFolderPath(string $folderPath): self + { + $obj = clone $this; + $obj->folderPath = $folderPath; + + return $obj; + } + + /** + * The new name for the folder. + * + * All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and `-` will be replaced by an underscore i.e. `_`. + */ + public function withNewFolderName(string $newFolderName): self + { + $obj = clone $this; + $obj->newFolderName = $newFolderName; + + return $obj; + } + + /** + * Option to purge cache for the old nested files and their versions' URLs. + * + * When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota. + * + * Note: A purge cache request will be issued against `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. + * + * Default value - `false` + */ + public function withPurgeCache(bool $purgeCache): self + { + $obj = clone $this; + $obj->purgeCache = $purgeCache; + + return $obj; + } +} diff --git a/src/Folders/FolderRenameResponse.php b/src/Folders/FolderRenameResponse.php new file mode 100644 index 00000000..15f1cacb --- /dev/null +++ b/src/Folders/FolderRenameResponse.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + #[Api('jobId')] + public string $jobID; + + /** + * `new FolderRenameResponse()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FolderRenameResponse::with(jobID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FolderRenameResponse)->withJobID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $jobID): self + { + $obj = new self; + + $obj->jobID = $jobID; + + return $obj; + } + + /** + * Unique identifier of the bulk job. This can be used to check the status of the bulk job. + */ + public function withJobID(string $jobID): self + { + $obj = clone $this; + $obj->jobID = $jobID; + + return $obj; + } +} diff --git a/src/Folders/Job/JobGetResponse.php b/src/Folders/Job/JobGetResponse.php new file mode 100644 index 00000000..bf0953e6 --- /dev/null +++ b/src/Folders/Job/JobGetResponse.php @@ -0,0 +1,130 @@ + */ + use SdkModel; + + /** + * Unique identifier of the bulk job. + */ + #[Api('jobId', optional: true)] + public ?string $jobID; + + /** + * Unique identifier of the purge request. This will be present only if `purgeCache` is set to `true` in the rename folder API request. + */ + #[Api('purgeRequestId', optional: true)] + public ?string $purgeRequestID; + + /** + * Status of the bulk job. + * + * @var Status::*|null $status + */ + #[Api(enum: Status::class, optional: true)] + public ?string $status; + + /** + * Type of the bulk job. + * + * @var Type::*|null $type + */ + #[Api(enum: Type::class, optional: true)] + public ?string $type; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Status::* $status + * @param Type::* $type + */ + public static function with( + ?string $jobID = null, + ?string $purgeRequestID = null, + ?string $status = null, + ?string $type = null, + ): self { + $obj = new self; + + null !== $jobID && $obj->jobID = $jobID; + null !== $purgeRequestID && $obj->purgeRequestID = $purgeRequestID; + null !== $status && $obj->status = $status; + null !== $type && $obj->type = $type; + + return $obj; + } + + /** + * Unique identifier of the bulk job. + */ + public function withJobID(string $jobID): self + { + $obj = clone $this; + $obj->jobID = $jobID; + + return $obj; + } + + /** + * Unique identifier of the purge request. This will be present only if `purgeCache` is set to `true` in the rename folder API request. + */ + public function withPurgeRequestID(string $purgeRequestID): self + { + $obj = clone $this; + $obj->purgeRequestID = $purgeRequestID; + + return $obj; + } + + /** + * Status of the bulk job. + * + * @param Status::* $status + */ + public function withStatus(string $status): self + { + $obj = clone $this; + $obj->status = $status; + + return $obj; + } + + /** + * Type of the bulk job. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } +} diff --git a/src/Folders/Job/JobGetResponse/Status.php b/src/Folders/Job/JobGetResponse/Status.php new file mode 100644 index 00000000..99b4b5f7 --- /dev/null +++ b/src/Folders/Job/JobGetResponse/Status.php @@ -0,0 +1,20 @@ + 'Invalid Request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_UPLOAD_OPTIONS = ['message' => 'Invalid Upload Options ImageKit initialization', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_LIST_FILES_OPTIONS = ['message' => 'Invalid List Files Options ImageKit initialization', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MANDATORY_INITIALIZATION_MISSING = ['message' => 'Missing publicKey or privateKey or urlEndpoint during ImageKit initialization', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_TRANSFORMATION_POSITION = ['message' => 'Invalid transformationPosition parameter', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_FILE_OPTIONS = ['message' => 'Invalid File Options ImageKit initialization', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $LIST_FILES_OPTIONS_NON_ARRAY = ['message' => 'List File Options accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CACHE_PURGE_URL_MISSING = ['message' => 'Missing URL parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CACHE_PURGE_URL_INVALID = ['message' => 'Invalid URL provided for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CACHE_PURGE_STATUS_ID_MISSING = ['message' => 'Missing Request ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $fileId_MISSING = ['message' => 'Missing File ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $versionId_MISSING = ['message' => 'Missing Version ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $JOBID_MISSING = ['message' => 'Missing Job ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_DATA_MISSING = ['message' => 'Missing file update data for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $BULK_TAGS_DATA_MISSING = ['message' => 'Missing bulk tag update data for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $BULK_TAGS_FILEIDS_MISSING = ['message' => 'Missing FileIds for Bulk Tags API', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $BULK_TAGS_FILEIDS_NON_ARRAY = ['message' => 'Bulk Tags API accepts FileIds as an array, non array passed', 'help' => 'For support kindly contact us at support@imagekit.io .' ]; - public static $BULK_TAGS_FILEIDS_EMPTY_ARRAY = ['message' => 'Bulk Tags API accepts FileIds as an array of ids, empty array passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $BULK_TAGS_TAGS_MISSING = ['message' => 'Missing Tags for Bulk Tags API', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $BULK_TAGS_TAGS_NON_ARRAY = ['message' => 'Bulk Tags API accepts Tags as an array, non array passed', 'help' => 'For support kindly contact us at support@imagekit.io .' ]; - public static $BULK_TAGS_TAGS_EMPTY_ARRAY = ['message' => 'Bulk Tags API accepts Tags as an array of tags, empty array passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_DATA_TAGS_INVALID = ['message' => 'Invalid tags parameter for this request', 'help' => "tags should be passed as null or an array like ['tag1', 'tag2']"]; - public static $UPDATE_DATA_COORDS_INVALID = ['message' => 'Invalid customCoordinates parameter for this request', 'help' => "customCoordinates should be passed as null or a string like 'x,y,width,height'"]; - public static $LIST_FILES_INPUT_MISSING = ['message' => 'Missing options for list files', 'help' => 'if you do not want to pass any parameter for listing, pass an empty object']; - public static $UPLOAD_FILE_PARAMETER_MISSING = ['message' => 'Upload API accepts an array of parameters, null passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_NON_ARRAY = ['message' => 'Upload API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_EMPTY_ARRAY = ['message' => 'Upload API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_NON_ARRAY = ['message' => 'Upload API parameter "options" accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_USEUNIQUEFILENAME_INVALID = ['message' => 'useUniqueFileName must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_ISPRIVATEFILE_INVALID = ['message' => 'isPrivateFile must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITEFILE_INVALID = ['message' => 'overwriteFile must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITEAITAGS_INVALID = ['message' => 'overwriteAITags must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITETAGS_INVALID = ['message' => 'overwriteTags must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITECUSTOMMETADATA_INVALID = ['message' => 'overwriteCustomMetadata must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_EXTENSIONS_INVALID = ['message' => 'extensions must be an array', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_CUSTOMMETADATA_INVALID = ['message' => 'customMetadata must be an array', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_TRANSFORMATION = [ "message" => "Invalid transformation parameter. Please include at least pre, post, or both.", "help" => "For support kindly contact us at support@imagekit.io ."]; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_PRE_TRANSFORMATION = [ "message" => "Invalid pre transformation parameter.", "help" => "For support kindly contact us at support@imagekit.io ."]; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION = [ "message" => "Invalid post transformation parameter.", "help" => "For support kindly contact us at support@imagekit.io ."]; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_CHECKS = [ "message" => "The value provided for the checks parameter is invalid.", "help" => "For support kindly contact us at support@imagekit.io ."]; - public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_PUBLISH_STATUS = [ "message" => "isPublished must be boolean.", "help" => "For support kindly contact us at support@imagekit.io ."]; - public static $MISSING_UPLOAD_DATA = ['message' => 'Missing data for upload', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_UPLOAD_FILE_PARAMETER = ['message' => 'Missing file parameter for upload', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_UPLOAD_FILENAME_PARAMETER = ['message' => 'Missing fileName parameter for upload', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_PHASH_VALUE = ['message' => 'Invalid pHash value', 'help' => 'Both pHash strings must be valid hexadecimal numbers']; - public static $MISSING_PHASH_VALUE = ['message' => 'Missing pHash value', 'help' => 'Both pHash strings must be valid hexadecimal numbers']; - public static $UNEQUAL_STRING_LENGTH = ['message' => 'Unequal pHash string length', 'help' => 'For distance calucation, the two pHash strings must have equal length']; - public static $fileIdS_MISSING = ['message' => 'Missing Parameter FileIds', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $fileIdS_NON_ARRAY = ['message' => 'File ids should be passed in an array', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $fileIdS_EMPTY_ARRAY = ['message' => 'File ids should be passed as an array of file ids, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_URL_PARAMETER = ['message' => 'Your request is missing the url query paramater', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $INVALID_URL_PARAMETER = ['message' => 'Invalid URL provided for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_PARAMETER_MISSING = ['message' => 'URL Generation Method accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_PARAMETER_NON_ARRAY = ['message' => 'URL Generation API accepts an array of parameters, non array value passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_PARAMETER_EMPTY_ARRAY = ['message' => 'URL Generation API accepts an array of parameters, empty array passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_SRC_INVALID = ['message' => 'src is not a valid URL', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_URL_INVALID = ['message' => 'Invalid urlEndpoint value', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_TRANSFORMATION_PARAMETER_INVALID = ['message' => 'Transformation Parameter accepts an array, not array or null provided.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_CONDITION_MISSING = ['message' => 'Missing Parameter "condition" in if statement.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_CONDITION_NON_ARRAY = ['message' => 'Invalid Parameter. "condition" accepts an array of parameters, non array value passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_CONDITION_EMPTY_ARRAY = ['message' => '"condition" accepts an array of parameters, empty array passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_CONDITION_INVALID_PROPERTY = ['message' => 'Invalid property applied in the condition. Refer to SDK docs for allowed properties.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_CONDITION_INVALID_OPERAND = ['message' => 'Invalid operator applied. Allowed operators are "==","!=",">",">=","<","<="', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_TRUE_MISSING = ['message' => 'Missing Parameter "true" in if statement.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_TRUE_NON_ARRAY = ['message' => 'Invalid Parameter. "true" accepts an array of parameters, non array value passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_IF_TRUE_EMPTY_ARRAY = ['message' => '"true" accepts an array of parameters, empty array passed.', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_TRANSFORMATION_QUERY_INVALID = ['message' => 'Invalid value provided for "transformationPosition". Supported values are "path" and "query"', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FILE_PARAMETER_MISSING = ['message' => 'Copy File API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FILE_PARAMETER_NON_ARRAY = ['message' => 'Copy File API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FILE_PARAMETER_EMPTY_ARRAY = ['message' => 'Copy File API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FILE_DATA_INVALID = ['message' => 'Missing parameter sourceFilePath and/or destinationPath for Copy File API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FILE_PARAMETER_MISSING = ['message' => 'Move File API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FILE_PARAMETER_NON_ARRAY = ['message' => 'Move File API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FILE_PARAMETER_EMPTY_ARRAY = ['message' => 'Move File API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FILE_DATA_INVALID = ['message' => 'Missing parameter sourceFilePath and/or destinationPath for Move File API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $RENAME_FILE_PARAMETER_MISSING = ['message' => 'Rename File API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $RENAME_FILE_PARAMETER_NON_ARRAY = ['message' => 'Rename File API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RENAME_FILE_PARAMETER_EMPTY_ARRAY = ['message' => 'Rename File API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RENAME_FILE_DATA_INVALID = ['message' => 'Missing parameter filePath and/or newFileName for Rename File API', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RENAME_FILE_DATA_INVALID_PURGE_CACHE = ['message' => 'purgeCache parameter must be boolean', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RESTORE_FILE_VERSION_PARAMETER_MISSING = ['message' => 'Restore File Version API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $RESTORE_FILE_VERSION_PARAMETER_NON_ARRAY = ['message' => 'Restore File Version API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RESTORE_FILE_VERSION_PARAMETER_EMPTY_ARRAY = ['message' => 'Restore File Version API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $RESTORE_FILE_VERSION_DATA_INVALID = ['message' => 'Missing parameter fileId and/or versionId for Restore File Version API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_FOLDER_PARAMETER_MISSING = ['message' => 'Create Folder API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_FOLDER_PARAMETER_NON_ARRAY = ['message' => 'Create Folder API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_FOLDER_PARAMETER_EMPTY_ARRAY = ['message' => 'Create Folder API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_FOLDER_DATA_INVALID = ['message' => 'Missing parameter folderName and/or parentFolderPath for Create Folder API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $DELETE_FOLDER_PARAMETER_MISSING = ['message' => 'Missing folderPath for Delete Folder API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FOLDER_PARAMETER_MISSING = ['message' => 'Copy Folder API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FOLDER_PARAMETER_NON_ARRAY = ['message' => 'Copy Folder API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FOLDER_PARAMETER_EMPTY_ARRAY = ['message' => 'Copy Folder API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $COPY_FOLDER_DATA_INVALID = ['message' => 'Missing parameter sourceFolderPath and/or destinationPath for Copy Folder API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FOLDER_PARAMETER_MISSING = ['message' => 'Move Folder API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FOLDER_PARAMETER_NON_ARRAY = ['message' => 'Move Folder API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FOLDER_PARAMETER_EMPTY_ARRAY = ['message' => 'Move Folder API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MOVE_FOLDER_DATA_INVALID = ['message' => 'Missing parameter sourceFolderPath and/or destinationPath for Move Folder API', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_CREATE_FOLDER_OPTIONS = ['message' => 'Missing data for creation of folder', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_DELETE_FOLDER_OPTIONS = ['message' => 'Missing data for deletion of folder', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_COPY_FOLDER_OPTIONS = ['message' => 'Missing data for copying folder', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $MISSING_MOVE_FOLDER_OPTIONS = ['message' => 'Missing data for moving folder', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_CUSTOM_METADATA_PARAMETER_MISSING = ['message' => 'Create Custom Metadata API accepts an array, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_CUSTOM_METADATA_PARAMETER_NON_ARRAY = ['message' => 'Create Custom Metadata API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_CUSTOM_METADATA_PARAMETER_EMPTY_ARRAY = ['message' => 'Create Custom Metadata API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_CUSTOM_METADATA_DATA_INVALID = ['message' => 'Missing parameter name and/or label and/or schema for this request', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $CREATE_CUSTOM_METADATA_DATA_INVALID_SCHEMA_OBJECT = ['message' => 'Invalid parameter schema', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $GET_CUSTOM_METADATA_INVALID_PARAMETER = ['message' => 'Invalid parameter includeDeleted', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_PARAMETER_MISSING = ['message' => 'Update Custom Metadata API accepts an id and requestBody, null passed', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_PARAMETER_NON_ARRAY = ['message' => 'Update Custom Metadata API accepts requestBody as an array of parameters, non array value passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_PARAMETER_EMPTY_ARRAY = ['message' => 'Update Custom Metadata API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_DATA_INVALID = ['message' => 'Missing parameter label and/or schema for this request', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_DATA_INVALID_SCHEMA_OBJECT = ['message' => 'Invalid parameter schema', 'help' => - 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_ID_MISSING = ['message' => 'Missing Custom Metadata Field ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $UPDATE_CUSTOM_METADATA_BODY_MISSING = ['message' => 'Missing body parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $DELETE_CUSTOM_METADATA_ID_MISSING = ['message' => 'Missing Custom Metadata Field ID parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $PHASH_DISTANCE_FIRST_PHASH_MISSING = ['message' => 'Missing First pHash parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $PHASH_DISTANCE_SECOND_PHASH_MISSING = ['message' => 'Missing Second pHash parameter for this request', 'help' => 'For support kindly contact us at support@imagekit.io .']; - public static $URL_GENERATION_EXPIRESECONDS_PARAMETER_INVALID = ['message' => 'expireSeconds accepts an integer value, non integer value provided.', 'help' => 'For support kindly contact us at support@imagekit.io .']; -} diff --git a/src/ImageKit/Constants/SupportedTransforms.php b/src/ImageKit/Constants/SupportedTransforms.php deleted file mode 100644 index c31aa4de..00000000 --- a/src/ImageKit/Constants/SupportedTransforms.php +++ /dev/null @@ -1,51 +0,0 @@ - 'h', - 'width' => 'w', - 'aspectRatio' => 'ar', - 'quality' => 'q', - 'crop' => 'c', - 'cropMode' => 'cm', - 'x' => 'x', - 'y' => 'y', - 'focus' => 'fo', - 'format' => 'f', - 'radius' => 'r', - 'background' => 'bg', - 'border' => 'b', - 'rotation' => 'rt', - 'blur' => 'bl', - 'named' => 'n', - 'progressive' => 'pr', - 'lossless' => 'lo', - 'trim' => 't', - 'metadata' => 'md', - 'colorProfile' => 'cp', - 'defaultImage' => 'di', - 'dpr' => 'dpr', - 'effectSharpen' => 'e-sharpen', - 'effectUSM' => 'e-usm', - 'effectContrast' => 'e-contrast', - 'effectGray' => 'e-grayscale', - 'effectShadow' => 'e-shadow', - 'effectGradient' => 'e-gradient', - 'original' => 'orig', - 'rotate' => 'rt', - ]; - - /** - * @return array - */ - public static function get() - { - return self::$transforms; - } -} diff --git a/src/ImageKit/ImageKit.php b/src/ImageKit/ImageKit.php deleted file mode 100644 index 33089341..00000000 --- a/src/ImageKit/ImageKit.php +++ /dev/null @@ -1,1205 +0,0 @@ -configuration = new Configuration(); - if ($publicKey == null || empty($publicKey)) { - $msg = 'Missing publicKey during ImageKit initialization'; - throw new InvalidArgumentException($msg); - } - $this->configuration->publicKey = $publicKey; - - if ($privateKey == null || empty($privateKey)) { - $msg = 'Missing privateKey during ImageKit initialization'; - throw new InvalidArgumentException($msg); - } - $this->configuration->privateKey = $privateKey; - - if ($urlEndpoint == null || empty($urlEndpoint)) { - $msg = 'Missing urlEndpoint during ImageKit initialization'; - throw new InvalidArgumentException($msg); - } - - if (!filter_var($urlEndpoint, FILTER_VALIDATE_URL)) { - throw new InvalidArgumentException('urlEndpoint should be a valid URL'); - } - $this->configuration->urlEndpoint = $urlEndpoint; - - if ($transformationPosition !== 'path' && $transformationPosition !== 'query') { - $msg = 'Invalid transformationPosition during ImageKit initialization. Can be one of path or query'; - throw new InvalidArgumentException($msg); - } - $this->configuration->transformationPosition = $transformationPosition; - - $client = new Client(Authorization::addAuthorization($this->configuration,$handlerStack)); - $this->httpClient = new GuzzleHttpWrapper($client); - } - - /** - * You can add multiple origins in the same ImageKit.io account. - * URL endpoints allow you to configure which origins are accessible through your account and set their preference - * order as well. - * - * @link https://docs.imagekit.io/integration/url-endpoints Url Endpoint Documentation - * @link https://github.com/imagekit-developer/imagekit-php#url-generation Url Generation Documentation - * - * @param array $options - * @return string - */ - public function url($options=null) - { - if(!isset($options)){ - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_PARAMETER_MISSING))); - } - if(!is_array($options)){ - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_PARAMETER_NON_ARRAY))); - } - if(sizeof($options)==0){ - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_PARAMETER_EMPTY_ARRAY))); - } - if (isset($options['src']) && !filter_var($options['src'], FILTER_VALIDATE_URL)) { - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_SRC_INVALID))); - } - if (isset($options['urlEndpoint']) && !filter_var($options['urlEndpoint'], FILTER_VALIDATE_URL)) { - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_URL_INVALID))); - } - - if (isset($options['transformation']) && !is_array($options['transformation'])) { - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_TRANSFORMATION_PARAMETER_INVALID))); - } - - if (isset($options['signed']) && $options['signed'] === true){ - if(isset($options['expireSeconds']) && $options['expireSeconds'] !== '' && !is_numeric($options['expireSeconds'])){ - return json_encode(Response::respond(true, ((object)ErrorMessages::$URL_GENERATION_EXPIRESECONDS_PARAMETER_INVALID))); - } - } - - $urlInstance = new Url(); - return $urlInstance->buildURL(array_merge((array)$this->configuration, $options)); - } - - /** - * You can upload files to ImageKit.io media library from your server-side using private API key authentication. - * - * - * @link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload API Reference - * - * @param array $options - * @return object - * - */ - public function upload($options=null) - { - return $this->uploadFile($options); - } - - /** - * You can upload files to ImageKit.io media library from your server-side using private API key authentication. - * - * - * @link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload API Reference - * - * @param array $options - * @return Response - */ - public function uploadFile($options=null) - { - - if(!isset($options)){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_MISSING)); - } - if(!is_array($options)){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_NON_ARRAY)); - } - if(sizeof($options)==0){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_EMPTY_ARRAY)); - } - if (empty($options['file'])) { - return Response::respond(true, ((object)ErrorMessages::$MISSING_UPLOAD_FILE_PARAMETER)); - } - if (empty($options['fileName'])) { - return Response::respond(true, ((object)ErrorMessages::$MISSING_UPLOAD_FILENAME_PARAMETER)); - } - if(isset($options['useUniqueFileName']) && !is_bool($options['useUniqueFileName'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_USEUNIQUEFILENAME_INVALID)); - } - if(isset($options['isPrivateFile']) && !is_bool($options['isPrivateFile'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_ISPRIVATEFILE_INVALID)); - } - if(isset($options['overwriteFile']) && !is_bool($options['overwriteFile'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITEFILE_INVALID)); - } - if(isset($options['overwriteAITags']) && !is_bool($options['overwriteAITags'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITEAITAGS_INVALID)); - } - if(isset($options['overwriteTags']) && !is_bool($options['overwriteTags'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITETAGS_INVALID)); - } - if(isset($options['overwriteCustomMetadata']) && !is_bool($options['overwriteCustomMetadata'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_OVERWRITECUSTOMMETADATA_INVALID)); - } - if(isset($options['extensions']) && !is_array($options['extensions'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_EXTENSIONS_INVALID)); - } - if(isset($options['customMetadata']) && !is_array($options['customMetadata'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_CUSTOMMETADATA_INVALID)); - } - if (isset($options['transformation'])) { - if (!isset($options['transformation']['pre']) && !isset($options['transformation']['post'])) { - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_TRANSFORMATION)); - } - if (isset($options['transformation']['pre']) && empty($options['transformation']['pre'])) { - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_PRE_TRANSFORMATION)); - } - if (isset($options['transformation']['post'])) { - if (is_array($options['transformation']['post'])) { - foreach ($options['transformation']['post'] as $transformation) { - if ($transformation['type'] === "abs" && (!isset($transformation['protocol']) || !isset($transformation['value']))) { - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION)); - } else if ($transformation['type'] === "transformation" && empty($transformation['value'])) { - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION)); - } - } - } else { - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION)); - } - } - } - if(isset($options['checks']) && !is_string($options['checks'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_CHECKS)); - } - if(isset($options['isPublished']) && !is_bool($options['isPublished'])){ - return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_PUBLISH_STATUS)); - } - $this->httpClient->setUri(Endpoints::getUploadFileEndpoint()); - return Upload::upload($options, $this->httpClient); - } - - /** - * You can upload files to ImageKit.io media library from your server-side using private API key authentication. - * - * - * @link https://docs.imagekit.io/api-reference/upload-file-api/server-side-file-upload API Reference - * - * @param array $options - * @return Response - * - * @deprecated since 2.0.0, use uploadFile; uploadFiles was misleading as it supports only singular - * - * file upload - */ - public function uploadFiles($options=null) - { - return $this->uploadFile($options); - } - - /** - * This API can list all the uploaded files in your ImageKit.io media library. - * For searching and filtering, you can use query parameters as described below. - * - * @link https://docs.imagekit.io/api-reference/media-api/list-and-search-files API Reference - * - * @param array $parameters - * @return Response - */ - public function listFiles($parameters = null) - { - if($parameters){ - if(!is_array($parameters)){ - return Response::respond(true, ((object)ErrorMessages::$LIST_FILES_OPTIONS_NON_ARRAY)); - } - } - - $this->httpClient->setUri(Endpoints::getListFilesEndpoint()); - return Manage\File::listFile($this->httpClient, $parameters); - } - - /** - * Get the file details such as tags, customCoordinates, and isPrivate properties using get file detail API. - * - * @link https://docs.imagekit.io/api-reference/media-api/get-file-details API Reference - * - * @param string $fileId - * - * @return Response - * - * @deprecated since 2.0.0, use getFileDetails - */ - public function getDetails($fileId=null) - { - return $this->getFileDetails($fileId); - } - - /** - * Get the file details such as tags, customCoordinates, and isPrivate properties using get file detail API. - * - * @link https://docs.imagekit.io/api-reference/media-api/get-file-details API Reference - * - * @param string $fileId - * @return Response - * - */ - public function getFileDetails($fileId=null) - { - if (empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - $this->httpClient->setUri(Endpoints::getDetailsEndpoint($fileId)); - return Manage\File::getDetails($fileId, $this->httpClient); - } - - /** - * Get the file version details such as tags, customCoordinates, and isPrivate properties using get file version details API. - * - * @link https://docs.imagekit.io/api-reference/media-api/get-file-version-details API Reference - * - * @param string $fileId - * @param string $versionId - * @return Response - * - */ - public function getFileVersionDetails($fileId=null, $versionId=null) - { - if (empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - - if (empty($versionId)) { - return Response::respond(true, ((object)ErrorMessages::$versionId_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getVersionDetailsEndpoint($fileId, $versionId)); - return Manage\File::getVersionDetails($fileId, $versionId, $this->httpClient); - } - - /** - * Get all the versions of a file using get file versions API. - * - * @link https://docs.imagekit.io/api-reference/media-api/get-file-versions API Reference - * - * @param string $fileId - * @return Response - * - */ - public function getFileVersions($fileId=null) - { - if (empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getFileVersionsEndpoint($fileId)); - return Manage\File::getFileVersions($fileId, $this->httpClient); - } - - /** - * Get image exif, pHash and other metadata for uploaded files in ImageKit.io media library using this API. - * - * @link https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files - * - * @param string $fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API - * - * @return Response - * @deprecated since 2.0.0, use getFileMetaData - */ - public function getMetaData($fileId=null) - { - return $this->getFileMetaData($fileId); - } - - /** - * Get image exif, pHash and other metadata for uploaded files in ImageKit.io media library using this API. - * - * @link https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-for-uploaded-media-files - * - * @param string $fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API - * - * @return Response - */ - public function getFileMetaData($fileId=null) - { - if (empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - $this->httpClient->setUri(Endpoints::getListMetaDataFilesEndpoint($fileId)); - return Manage\CustomMetadataFields::get($fileId, $this->httpClient); - } - - /** - * Update file details such as tags and customCoordinates attribute using update file detail API. - * - * @link https://docs.imagekit.io/api-reference/media-api/update-file-details - * - * @param string $fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API - * @param array $updateData - * - * @return Response - * @deprecated since 2.0.0, use updateFileDetails - */ - public function updateDetails($fileId=null, $updateData=null) - { - return $this->updateFileDetails($fileId, $updateData); - } - - /** - * Update file details such as tags and customCoordinates attribute using update file detail API. - * - * @link https://docs.imagekit.io/api-reference/media-api/update-file-details - * - * @param string $fileId The unique fileId of the uploaded file. fileId is returned in list files API and upload API - * @param array $updateData - * @return Response - */ - public function updateFileDetails($fileId=null, $updateData=null) - { - if (empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - - if (!is_array($updateData) || sizeof($updateData)==0) { - return Response::respond(true, ((object)ErrorMessages::$UPDATE_DATA_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getUpdateFileDetailsEndpoint($fileId)); - return Manage\File::updateDetails($fileId, $updateData, $this->httpClient); - } - - /** - * Add tags to multiple files in a single request. The method accepts an array of fileIDs of the files and an - * array of tags that have to be added to those files. - * - * @link https://docs.imagekit.io/api-reference/media-api/add-tags-bulk - * - * @param array $fileIds - * @param array $tags - * - * @return Response - */ - public function bulkAddTags($fileIds=null, $tags=null) - { - if(!isset($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_MISSING)); - } - if(!is_array($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_NON_ARRAY)); - } - if(sizeof($fileIds)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_EMPTY_ARRAY)); - } - if(!isset($tags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_MISSING)); - } - if(!is_array($tags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_NON_ARRAY)); - } - if(sizeof($tags)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_EMPTY_ARRAY)); - } - - $this->httpClient->setUri(Endpoints::getBulkAddTagsEndpoint()); - return Manage\File::bulkAddTags($fileIds, $tags, $this->httpClient); - } - - /** - * Remove tags to multiple files in a single request. The method accepts an array of fileIDs of the files and an - * array of tags that have to be removed to those files. - * - * @link https://docs.imagekit.io/api-reference/media-api/remove-tags-bulk - * - * @param array $fileIds - * @param array $tags - * - * @return Response - */ - public function bulkRemoveTags($fileIds=null, $tags=null) - { - if(!isset($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_MISSING)); - } - if(!is_array($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_NON_ARRAY)); - } - if(sizeof($fileIds)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_EMPTY_ARRAY)); - } - if(!isset($tags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_MISSING)); - } - if(!is_array($tags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_NON_ARRAY)); - } - if(sizeof($tags)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_EMPTY_ARRAY)); - } - - $this->httpClient->setUri(Endpoints::getBulkRemoveTagsEndpoint()); - return Manage\File::bulkRemoveTags($fileIds, $tags, $this->httpClient); - } - - /** - * Remove AI tags from multiple files in a single request. The method accepts an array of fileIDs of the files and an array of tags that have to be removed to those files. - * - * @link https://docs.imagekit.io/api-reference/media-api/remove-aitags-bulk - * - * @param array $fileIds - * @param array $AITags - * - * @return Response - */ - public function bulkRemoveAITags($fileIds=null, $AITags=null) - { - if(!isset($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_MISSING)); - } - if(!is_array($fileIds)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_NON_ARRAY)); - } - if(sizeof($fileIds)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_FILEIDS_EMPTY_ARRAY)); - } - if(!isset($AITags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_MISSING)); - } - if(!is_array($AITags)){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_NON_ARRAY)); - } - if(sizeof($AITags)==0){ - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_TAGS_EMPTY_ARRAY)); - } - $this->httpClient->setUri(Endpoints::getBulkRemoveAITagsEndpoint()); - return Manage\File::bulkRemoveAITags($fileIds, $AITags, $this->httpClient); - } - - /** - * You can programmatically delete uploaded files in media library using delete file API. - * - * @link https://docs.imagekit.io/api-reference/media-api/delete-file - * - * @param $fileId - * @return Response - * - */ - public function deleteFile($fileId=null) - { - if (!isset($fileId) || empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getDeleteFilesEndpoint($fileId)); - return Manage\File::delete($fileId, $this->httpClient); - } - - - /** - * You can programmatically delete uploaded file version in media library using delete file version API. - * - * @link https://docs.imagekit.io/api-reference/media-api/delete-file-version - * - * @param $fileId - * @param $versionId - * @return Response - * - */ - public function deleteFileVersion($fileId=null, $versionId=null) - { - if (!isset($fileId) || empty($fileId)) { - return Response::respond(true, ((object)ErrorMessages::$fileId_MISSING)); - } - - if (!isset($versionId) || empty($versionId)) { - return Response::respond(true, ((object)ErrorMessages::$versionId_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getDeleteFileVersionEndpoint($fileId,$versionId)); - return Manage\File::deleteVersion($fileId, $versionId, $this->httpClient); - } - - /** - * This will purge CDN and ImageKit.io internal cache. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache - * - * @param $options - * @return Response - * - * @deprecated since 2.0.0, use purgeCache - */ - public function purgeFileCacheApi($options=null) - { - return $this->purgeCache($options); - } - - /** - * This will purge CDN and ImageKit.io internal cache. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache - * - * @param $options - * @return Response - * - * @deprecated since 2.0.0, use purgeCache - */ - public function purgeCacheApi($options=null) - { - return $this->purgeCache($options); - } - - /** - * This will purge CDN and ImageKit.io internal cache. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache - * - * @param $options - * @return Response - */ - public function purgeCache($options=null) - { - if (empty($options)) { - return Response::respond(true, ((object)ErrorMessages::$CACHE_PURGE_URL_MISSING)); - } - - if (!filter_var($options, FILTER_VALIDATE_URL)) { - return Response::respond(true, ((object)ErrorMessages::$CACHE_PURGE_URL_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getPurgeCacheEndpoint()); - return Manage\Cache::purgeFileCache($options, $this->httpClient); - } - - /** - * Get the status of submitted purge request. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache-status - * - * @param $requestId - * @return Response - * - * @deprecated since 2.0.0, use getPurgeCacheStatus - */ - public function purgeCacheStatus($requestId=null) - { - return $this->getPurgeCacheStatus($requestId); - } - - /** - * Get the status of submitted purge request. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache-status - * - * @param $requestId - * @return Response - * - * @deprecated since 2.0.0, use getPurgeCacheStatus - */ - public function purgeFileCacheApiStatus($requestId=null) - { - return $this->getPurgeCacheStatus($requestId); - } - - /** - * Get the status of submitted purge request. - * - * @link https://docs.imagekit.io/api-reference/media-api/purge-cache-status - * - * @param $requestId - * @return Response - */ - public function getPurgeCacheStatus($requestId=null) - { - if (empty($requestId)) { - return Response::respond(true, ((object)ErrorMessages::$CACHE_PURGE_STATUS_ID_MISSING)); - } - - $this->httpClient->setUri(Endpoints::getPurgeCacheApiStatusEndpoint($requestId)); - return Manage\Cache::purgeFileCacheStatus($requestId, $this->httpClient); - } - - /** - * Delete multiple files. The method accepts an array of file IDs of the files that have to be deleted. - * - * @link https://docs.imagekit.io/api-reference/media-api/delete-files-bulk - * - * @param $options - * @return Response - * - * @deprecated since 2.0.0, use bulkDeleteFiles - */ - public function bulkFileDeleteByIds($fileIds=null) - { - return $this->bulkDeleteFiles($fileIds); - } - - /** - * Delete multiple files. The method accepts an array of file IDs of the files that have to be deleted. - * - * @link https://docs.imagekit.io/api-reference/media-api/delete-files-bulk - * - * @param $fileIds - * @return Response - * - */ - public function bulkDeleteFiles($fileIds=null) - { - if (!isset($fileIds)) { - return Response::respond(true, ((object)ErrorMessages::$fileIdS_MISSING)); - } - if (!is_array($fileIds)) { - return Response::respond(true, ((object)ErrorMessages::$fileIdS_NON_ARRAY)); - } - if (sizeof($fileIds)==0) { - return Response::respond(true, ((object)ErrorMessages::$fileIdS_EMPTY_ARRAY)); - } - - $this->httpClient->setUri(Endpoints::getDeleteByFileIdsEndpoint()); - return Manage\File::bulkDeleteByFileIds($fileIds, $this->httpClient); - } - - /** - * This will copy a file from one location to another. This method accepts an array of source file's path, destination path and boolean to include versions or not - * folder path. - * - * @link https://docs.imagekit.io/api-reference/media-api/copy-file - * - * @param $parameter['sourceFilePath','destinationPath','includeFileVersions'] - * @return Response - * - */ - public function copy($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['sourceFilePath']) || empty($parameter['destinationPath'])) { - return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_DATA_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getCopyFileEndpoint()); - return Manage\File::copy($parameter['sourceFilePath'], $parameter['destinationPath'], isset($parameter['includeFileVersions']) ? $parameter['includeFileVersions'] : false, $this->httpClient); - } - - - /** - * This will copy a file from one location to another. This method accepts an array of source file's path, destination path and boolean to include versions or not - * folder path. - * - * @link https://docs.imagekit.io/api-reference/media-api/copy-file - * - * @param $sourceFilePath - * @param $destinationPath - * @param $includeFileVersions - * @return Response - * - * @deprecated since 3.0.0, use copy - * - */ - public function copyFile($sourceFilePath=null, $destinationPath=null, $includeFileVersions=null) - { - - if (empty($sourceFilePath) || empty($destinationPath)) { - return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_DATA_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getCopyFileEndpoint()); - return Manage\File::copy($sourceFilePath, $destinationPath, $includeFileVersions, $this->httpClient); - } - - /** - * This will move a file from one location to another. This method accepts an array containing source file's path and destination path - * folder path. - * - * @link https://docs.imagekit.io/api-reference/media-api/move-file - * - * @param $parameter['sourceFilePath','destinationPath'] - * @return Response - * - */ - public function move($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FILE_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FILE_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FILE_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['sourceFilePath']) || empty($parameter['destinationPath'])) { - return Response::respond(true, ((object)ErrorMessages::$MOVE_FILE_DATA_INVALID)); - } - $this->httpClient->setUri(Endpoints::getMoveFileEndpoint()); - return Manage\File::move($parameter['sourceFilePath'], $parameter['destinationPath'], $this->httpClient); - } - - /** - * This will move a file from one location to another. This method accepts an array containing source file's path and destination path - * folder path. - * - * @link https://docs.imagekit.io/api-reference/media-api/move-file - * - * @param $sourceFilePath - * @param $destinationPath - * @param $includeVersions - * @return Response - * - * @deprecated since 3.0.0, use move - */ - public function moveFile($sourceFilePath=null, $destinationPath=null) - { - if (empty($sourceFilePath) || empty($destinationPath)) { - return Response::respond(true, ((object)ErrorMessages::$MOVE_FILE_DATA_INVALID)); - } - $this->httpClient->setUri(Endpoints::getMoveFileEndpoint()); - return Manage\File::move($sourceFilePath, $destinationPath, $this->httpClient); - } - - /** - * This will rename a file. This method accepts the source file's path, new file name and an optional parameter - * boolean to purge cache - * - * - * @link https://docs.imagekit.io/api-reference/media-api/rename-file - * - * @param $parameter[$filePath, $newFileNamem, $purgeCache] - * - * @return Response - */ - public function rename($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['filePath']) || empty($parameter['newFileName'])) { - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_DATA_INVALID)); - } - $purgeCache= false; - if(isset($parameter['purgeCache'])){ - if(!is_bool($parameter['purgeCache'])){ - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_DATA_INVALID_PURGE_CACHE)); - } - else{ - $purgeCache = $parameter['purgeCache']; - } - } - - $this->httpClient->setUri(Endpoints::getRenameFileEndpoint()); - return Manage\File::rename($parameter['filePath'], $parameter['newFileName'], $purgeCache, $this->httpClient); - } - - /** - * This will rename a file. This method accepts the source file's path, new file name and an optional parameter - * boolean to purge cache - * - * - * @link https://docs.imagekit.io/api-reference/media-api/rename-file - * - * @param $filePath - * @param $newFileName - * @param $purgeCache - * @return Response - * - * @deprecated since 3.0.0, use rename - */ - public function renameFile($filePath, $newFileName, $purgeCache = false) - { - if (empty($filePath) || empty($newFileName)) { - return Response::respond(true, ((object)ErrorMessages::$RENAME_FILE_DATA_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getRenameFileEndpoint()); - return Manage\File::rename($filePath, $newFileName, $purgeCache, $this->httpClient); - } - - /** - * This will Restore file version to a different version of a file. This method accepts the fileId and versionId - * - * - * @link https://docs.imagekit.io/api-reference/media-api/restore-file-version - * - * @param $parameter[$fileId, $versionId] - * @return Response - */ - public function restoreFileVersion($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$RESTORE_FILE_VERSION_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$RESTORE_FILE_VERSION_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$RESTORE_FILE_VERSION_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['fileId']) || empty($parameter['versionId'])) { - return Response::respond(true, ((object)ErrorMessages::$RESTORE_FILE_VERSION_DATA_INVALID)); - } - $this->httpClient->setUri(Endpoints::getRestoreFileVersionEndpoint($parameter['fileId'], $parameter['versionId'])); - return Manage\File::restoreVersion($this->httpClient); - } - - - /** - * This will create a new folder. This method accepts folder name and parent folder path in an array. - * - * @link https://docs.imagekit.io/api-reference/media-api/create-folder - * - * @param $parameter[$folderName, $parentFolderPath] - * - * @return Response - */ - public function createFolder($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_FOLDER_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_FOLDER_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_FOLDER_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['folderName']) || empty($parameter['parentFolderPath'])) { - return Response::respond(true, ((object)ErrorMessages::$CREATE_FOLDER_DATA_INVALID)); - } - $this->httpClient->setUri(Endpoints::getCreateFolderEndpoint()); - return Manage\Folder::create($parameter['folderName'], $parameter['parentFolderPath'], $this->httpClient); - } - - /** - * This will delete the specified folder and all nested files & folders. - * This method accepts the full path of the folder that is to be deleted. - * - * @link https://docs.imagekit.io/api-reference/media-api/delete-folder - * - * @param $folderPath - * - * @return Response - */ - public function deleteFolder($folderPath=null) - { - if(!isset($folderPath) || empty($folderPath)){ - return Response::respond(true, ((object)ErrorMessages::$DELETE_FOLDER_PARAMETER_MISSING)); - } - $this->httpClient->setUri(Endpoints::getDeleteFolderEndpoint()); - return Manage\Folder::delete($folderPath, $this->httpClient); - } - - /** - * This will copy a folder from one location to another. This method accepts an array of source folder's path, destination path and boolean to include versions or not. - * - * @link https://docs.imagekit.io/api-reference/media-api/copy-folder - * - * @param $parameter[$sourceFolderPath, $destinationPath, includeFileVersions] - * - * @return Response - */ - public function copyFolder($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['sourceFolderPath']) || empty($parameter['destinationPath'])) { - return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_DATA_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getCopyFolderEndpoint()); - return Manage\Folder::copy($parameter['sourceFolderPath'], $parameter['destinationPath'], isset($parameter['includeFileVersions']) ? $parameter['includeFileVersions'] : false, $this->httpClient); - } - - /** - * This will move a folder from one location to another. This method accepts the source folder's path - * and destination folder path in an array. - * - * @link https://docs.imagekit.io/api-reference/media-api/move-folder - * - * @param $parameter[$sourceFolderPath, $destinationPath] - * - * @return Response - */ - public function moveFolder($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FOLDER_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FOLDER_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$MOVE_FOLDER_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['sourceFolderPath']) || empty($parameter['destinationPath'])) { - return Response::respond(true, ((object)ErrorMessages::$MOVE_FOLDER_DATA_INVALID)); - } - - $this->httpClient->setUri(Endpoints::getMoveFolderEndpoint()); - return Manage\Folder::move($parameter['sourceFolderPath'], $parameter['destinationPath'], $this->httpClient); - } - - /** - * @param string $token - * @param int $expire - * @return object { token: string, expire: int, signature: string} - */ - public function getAuthenticationParameters($token = '', $expire = 0) - { - return Signature::getAuthenticationParameters($token, $expire, $this->configuration); - } - - /** - * This endpoint allows you to get the status of a bulk operation e.g. copy or move folder API. - * - * @link https://docs.imagekit.io/api-reference/media-api/copy-move-folder-status - * - * @param $jobId - * @return Response - */ - public function getBulkJobStatus($jobId=null) - { - - if (empty($jobId)) { - return Response::respond(true, ((object)ErrorMessages::$JOBID_MISSING)); - } - $this->httpClient->setUri(Endpoints::getBulkJobStatusEndpoint($jobId)); - - try { - $res = $this->httpClient->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Get image exif, pHash and other metadata for uploaded files in ImageKit.io powered remote URL using this API. - * - * @link https://docs.imagekit.io/api-reference/metadata-api/get-image-metadata-from-remote-url - * - * @param $url - * @return Response - */ - public function getFileMetadataFromRemoteURL($url=null) - { - if (empty($url)) { - return Response::respond(true, ((object)ErrorMessages::$MISSING_URL_PARAMETER)); - } - - if (!filter_var($url, FILTER_VALIDATE_URL)) { - return Response::respond(true, ((object)ErrorMessages::$INVALID_URL_PARAMETER)); - } - - $this->httpClient->setUri(Endpoints::getFileMetadataFromRemoteURLEndpoint()); - return Manage\CustomMetadataFields::getFileMetadataFromRemoteURL($url, $this->httpClient); - } - /** - * Using pHash to find similar or duplicate images - * The hamming distance between two pHash values determines how similar or different the images are. - * - * The pHash value returned by ImageKit.io metadata API is a hexadecimal string of 64bit pHash. The distance - * between two hash can be between 0 and 64. A lower distance means similar images. If the distance is 0, - * that means two images are identical. - * - * @param string $firstPHash - * @param string $secondPHash - * @return int - */ - public function pHashDistance($firstPHash=null, $secondPHash=null) - { - if(!isset($firstPHash) || empty($firstPHash)){ - return Response::respond(true, ((object)ErrorMessages::$PHASH_DISTANCE_FIRST_PHASH_MISSING)); - } - if(!isset($secondPHash) || empty($secondPHash)){ - return Response::respond(true, ((object)ErrorMessages::$PHASH_DISTANCE_SECOND_PHASH_MISSING)); - } - return Phash::pHashDistance($firstPHash, $secondPHash); - } - - - /** - * Create custom metadata field using this API. - * - * @link https://docs.imagekit.io/api-reference/custom-metadata-fields-api/create-custom-metadata-field - * - * @param $parameter[$name,$label,$schema] - * @return Response - */ - public function createCustomMetadataField($parameter=null) - { - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_CUSTOM_METADATA_PARAMETER_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_CUSTOM_METADATA_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_CUSTOM_METADATA_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['name']) || empty($parameter['label']) || !isset($parameter['schema'])) { - return Response::respond(true, ((object)ErrorMessages::$CREATE_CUSTOM_METADATA_DATA_INVALID)); - } - if(!isset($parameter['schema']['type']) || empty($parameter['schema']['type'])){ - return Response::respond(true, ((object)ErrorMessages::$CREATE_CUSTOM_METADATA_DATA_INVALID_SCHEMA_OBJECT)); - } - - $this->httpClient->setUri(Endpoints::createCustomMetadataField()); - return Manage\CustomMetadataFields::createCustomMetadataField($parameter['name'], $parameter['label'], $parameter['schema'], $this->httpClient); - } - - /** - * Get custom metadata field using this API. - * - * @link https://docs.imagekit.io/api-reference/custom-metadata-fields-api/get-custom-metadata-field - * - * @param $includeDeleted - * @return Response - */ - public function getCustomMetadataFields($includeDeleted=false) - { - if(!is_bool($includeDeleted)){ - return Response::respond(true, ((object)ErrorMessages::$GET_CUSTOM_METADATA_INVALID_PARAMETER)); - } - $this->httpClient->setUri(Endpoints::getCustomMetadataField()); - return Manage\CustomMetadataFields::getCustomMetadataField($includeDeleted, $this->httpClient); - } - - /** - * Update custom metadata field using this API. - * - * @link https://docs.imagekit.io/api-reference/custom-metadata-fields-api/update-custom-metadata-field - * - * @param $id - * @param $parameter[$name,$label,$schema] - * @return Response - */ - public function updateCustomMetadataField($id=null,$parameter=null) - { - if(!isset($id) && !isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_PARAMETER_MISSING)); - } - if(!isset($id) || empty($id)){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_ID_MISSING)); - } - if(!isset($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_BODY_MISSING)); - } - if(!is_array($parameter)){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_PARAMETER_NON_ARRAY)); - } - if(sizeof($parameter)==0){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_PARAMETER_EMPTY_ARRAY)); - } - if (empty($parameter['label']) || !isset($parameter['schema'])) { - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_DATA_INVALID)); - } - if(!isset($parameter['schema']['type']) || empty($parameter['schema']['type'])){ - return Response::respond(true, ((object)ErrorMessages::$UPDATE_CUSTOM_METADATA_DATA_INVALID_SCHEMA_OBJECT)); - } - - $this->httpClient->setUri(Endpoints::updateCustomMetadataField($id)); - return Manage\CustomMetadataFields::updateCustomMetadataField($parameter['label'], $parameter['schema'], $this->httpClient); - } - - /** - * Delete custom metadata field using this API. - * - * @link https://docs.imagekit.io/api-reference/custom-metadata-fields-api/delete-custom-metadata-field - * - * @param $id - * @return Response - */ - public function deleteCustomMetadataField($id=null) - { - if(!isset($id) || empty($id)){ - return Response::respond(true, ((object)ErrorMessages::$DELETE_CUSTOM_METADATA_ID_MISSING)); - } - - $this->httpClient->setUri(Endpoints::deleteCustomMetadataField($id)); - return Manage\CustomMetadataFields::deleteCustomMetadataField($this->httpClient); - } - -} diff --git a/src/ImageKit/Manage/Cache.php b/src/ImageKit/Manage/Cache.php deleted file mode 100644 index 16c4f0db..00000000 --- a/src/ImageKit/Manage/Cache.php +++ /dev/null @@ -1,89 +0,0 @@ - $urlParam - ]; - - $resource->setDatas($urlParamArray); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * purgeCacheStatus File API - * - * @param $requestId - * @param GuzzleHttpWrapper $resource - * @return Response - */ - public static function purgeFileCacheStatus($requestId, GuzzleHttpWrapper $resource) - { - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - -} diff --git a/src/ImageKit/Manage/CustomMetadataFields.php b/src/ImageKit/Manage/CustomMetadataFields.php deleted file mode 100644 index 4770fd37..00000000 --- a/src/ImageKit/Manage/CustomMetadataFields.php +++ /dev/null @@ -1,242 +0,0 @@ -get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Get file metadata from remote URL - * - * @param $url - * @param $resource - * @return Response - */ - public static function getFileMetadataFromRemoteURL($url, $resource) - { - if (empty($url)) { - return Response::respond(true, ((object)ErrorMessages::$MISSING_URL_PARAMETER)); - } - - $resource->setDatas([ - 'url' => $url - ]); - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Create custom metadata field - * - * @param $name - * @param $label - * @param $schema - * @param $resource - * @return Response - */ - public static function createCustomMetadataField($name, $label, $schema, $resource) - { - $resource->setDatas([ - 'name' => $name, - 'label' => $label, - 'schema' => $schema - ]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Get custom metadata field - * - * @param $includeDeleted - * @param $resource - * @return Response - */ - public static function getCustomMetadataField($includeDeleted, $resource) - { - $resource->setDatas([ - 'includeDeleted' => $includeDeleted - ]); - - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, $content); - } - - return Response::respond(false, $content); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Update custom metadata field - * - * @param $label - * @param $schema - * @param $resource - * @return Response - */ - public static function updateCustomMetadataField($label, $schema, $resource) - { - $resource->setDatas([ - 'label' => $label, - 'schema' => $schema - ]); - try { - $res = $resource->patch(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Update custom metadata field - * - * @param $resource - * @return Response - */ - public static function deleteCustomMetadataField($resource) - { - try { - $res = $resource->delete(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } -} diff --git a/src/ImageKit/Manage/File.php b/src/ImageKit/Manage/File.php deleted file mode 100644 index 4995837d..00000000 --- a/src/ImageKit/Manage/File.php +++ /dev/null @@ -1,592 +0,0 @@ -setDatas($parameters); - } - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - - - } - - /** - * Get Details Of file - * - * @param string $fileId - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function getDetails($fileId, GuzzleHttpWrapper $resource) - { - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Get Version Details Of file - * - * @param string $fileId - * @param string $versionId - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function getVersionDetails($fileId, $versionId, GuzzleHttpWrapper $resource) - { - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Get All Versions Of file - * - * @param string $fileId - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function getFileVersions($fileId, GuzzleHttpWrapper $resource) - { - try { - $res = $resource->get(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Delete File API - * - * @param $fileId - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function delete($fileId, GuzzleHttpWrapper $resource) - { - - $resource->setDatas((array)$fileId); - try { - $res = $resource->delete(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Delete File Version API - * - * @param $fileId - * @param $versionId - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function deleteVersion($fileId, $versionId, GuzzleHttpWrapper $resource) - { - $resource->setDatas([$fileId,$versionId]); - try { - $res = $resource->delete(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Delete Bulk Files by File ID API - * - * @param $fileIds - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function bulkDeleteByFileIds($fileIds, GuzzleHttpWrapper $resource) - { - $resource->setDatas(['fileIds' => $fileIds]); - - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Copy File API - * - * @param $sourceFilePath - * @param $destinationPath - * @param $includeVersions - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function copy($sourceFilePath, $destinationPath, $includeFileVersions, GuzzleHttpWrapper $resource) - { - $resource->setDatas(['sourceFilePath' => $sourceFilePath, 'destinationPath' => $destinationPath, 'includeFileVersions' => $includeFileVersions]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Move File API - * - * @param $sourceFilePath - * @param $destinationPath - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function move($sourceFilePath, $destinationPath, GuzzleHttpWrapper $resource) - { - $resource->setDatas(['sourceFilePath' => $sourceFilePath, 'destinationPath' => $destinationPath]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Rename File API - * - * @param $filePath - * @param $newFileName - * @param $purgeCache - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function rename($filePath, $newFileName, $purgeCache, GuzzleHttpWrapper $resource) - { - $resource->setDatas(['filePath' => $filePath, 'newFileName' => $newFileName, 'purgeCache' => $purgeCache]); - try { - $res = $resource->put(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Restore File Version API - * - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function restoreVersion(GuzzleHttpWrapper $resource) - { - try { - $res = $resource->put(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Bulk Add Tags - * - * @param array $fileIds - * @param array $tags - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function bulkAddTags($fileIds, $tags, GuzzleHttpWrapper $resource) - { - - $resource->setDatas(['fileIds' => $fileIds, 'tags' => $tags]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * Bulk Remove Tags - * - * @param array $fileIds - * @param array $tags - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function bulkRemoveTags(array $fileIds, array $tags, GuzzleHttpWrapper $resource) - { - - - if (!is_array($fileIds) || empty($fileIds) || !is_array($tags) || empty($tags)) { - return Response::respond(true, ((object)ErrorMessages::$BULK_TAGS_DATA_MISSING)); - } - - $resource->setDatas(['fileIds' => $fileIds, 'tags' => $tags]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Bulk Remove AI Tags - * - * @param array $fileIds - * @param array $AITags - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function bulkRemoveAITags(array $fileIds, array $AITags, GuzzleHttpWrapper $resource) - { - $resource->setDatas(['fileIds' => $fileIds, 'AITags' => $AITags]); - try { - $res = $resource->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - - /** - * Update File Details - * - * @param $fileId - * @param $updateData - * @param GuzzleHttpWrapper $resource - * - * @return Response - */ - public static function updateDetails($fileId, $updateData, GuzzleHttpWrapper $resource) - { - $obj = (object)$updateData; - - if (isset($obj->tags) && ($obj->tags !== null) && ($obj->tags !== 'undefined') && !is_array($obj->tags)) { - return Response::respond(true, ((object)ErrorMessages::$UPDATE_DATA_TAGS_INVALID)); - } - - if (isset($obj->customCoordinates) && ($obj->customCoordinates !== 'undefined') && is_array($obj->customCoordinates)) { - return Response::respond(true, ((object)ErrorMessages::$UPDATE_DATA_COORDS_INVALID)); - } - - $resource->setDatas($updateData); - try { - $res = $resource->patch(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } -} diff --git a/src/ImageKit/Manage/Folder.php b/src/ImageKit/Manage/Folder.php deleted file mode 100644 index da840a81..00000000 --- a/src/ImageKit/Manage/Folder.php +++ /dev/null @@ -1,157 +0,0 @@ -setDatas(['parentFolderPath' => $parentFolderPath, 'folderName' => $folderName]); - try { - $res = $httpClient->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * @param $folderPath - * @param GuzzleHttpWrapper $httpClient - * - * @return Response - */ - public static function delete($folderPath, GuzzleHttpWrapper $httpClient) - { - if (empty($folderPath)) { - return Response::respond(true, ((object)ErrorMessages::$MISSING_DELETE_FOLDER_OPTIONS)); - } - - $httpClient->setDatas(['folderPath' => $folderPath]); - try { - $res = $httpClient->delete(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * @param $sourceFolderPath - * @param $destinationPath - * @param $includeVersions - * @param GuzzleHttpWrapper $httpClient - * - * @return Response - */ - public static function copy($sourceFolderPath, $destinationPath, $includeFileVersions, GuzzleHttpWrapper $httpClient) - { - $httpClient->setDatas(['sourceFolderPath' => $sourceFolderPath, 'destinationPath' => $destinationPath, 'includeFileVersions' => $includeFileVersions]); - try { - $res = $httpClient->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } - - /** - * @param $sourceFolderPath - * @param $destinationPath - * @param GuzzleHttpWrapper $httpClient - * - * @return Response - */ - public static function move($sourceFolderPath, $destinationPath, GuzzleHttpWrapper $httpClient) - { - $httpClient->setDatas(['sourceFolderPath' => $sourceFolderPath, 'destinationPath' => $destinationPath]); - try { - $res = $httpClient->post(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - } -} diff --git a/src/ImageKit/Phash/Phash.php b/src/ImageKit/Phash/Phash.php deleted file mode 100644 index 64052895..00000000 --- a/src/ImageKit/Phash/Phash.php +++ /dev/null @@ -1,52 +0,0 @@ -client = $client; - $this->serviceId = self::gen_uuid(); - } - - - - /** - * @return string - */ - public static function gen_uuid() - { - return sprintf( - '%04x%04x-%04x-%04x-%04x-%04x%04x%04x', - // 32 bits for "time_low" - mt_rand(0, 0xffff), - mt_rand(0, 0xffff), - - // 16 bits for "time_mid" - mt_rand(0, 0xffff), - - // 16 bits for "time_hi_and_version", - // four most significant bits holds version number 4 - mt_rand(0, 0x0fff) | 0x4000, - - // 16 bits, 8 bits for "clk_seq_hi_res", - // 8 bits for "clk_seq_low", - // two most significant bits holds zero and one for variant DCE1.1 - mt_rand(0, 0x3fff) | 0x8000, - - // 48 bits for "node" - mt_rand(0, 0xffff), - mt_rand(0, 0xffff), - mt_rand(0, 0xffff) - ); - } - - /** - * @return array - */ - public function getDatas() - { - return $this->datas; - } - - /** - * @param array $datas - * @return void - */ - public function setDatas(array $datas) - { - $this->datas = array_filter($datas, function ($var) { - if ($var === '' || $var === null || is_array($var) && count($var) === 0) { - return false; - } - - return true; - }); - } - /** - * @param array $headers - * @return void - */ - public function setHeaders(array $headers) - { - $this->headers = $headers; - } - /** - * @return Response - */ - public function get() - { - try { - return $this->client->request('GET', $this->getUri(), $this->getOptions('query')); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - /** - * @return mixed - */ - protected function getUri() - { - return $this->uri; - } - - - /** - * @param $uri - */ - public function setUri($uri) - { - $this->uri = $uri; - } - - /** - * @param $dataType - * @return array - */ - protected function getOptions($dataType) - { - return [ - $dataType => $this->datas, - 'headers' => $this->headers, - ]; - } - - /** - * @param RequestException $e - * @return Response - */ - protected function handleRequestException(RequestException $e) - { - $status = $e->getCode(); - $headers = []; - $body = ''; - if ($e->hasResponse()) { - $body = (string)$e->getResponse()->getBody(); - $headers = $e->getResponse()->getHeaders(); - $statusCode = $e->getResponse()->getStatusCode(); - } - - return new Response($status, $headers, $body); - } - - /** - * @param Exception $e - * @return Response - */ - protected function handleException(Exception $e) - { - if(!$sock = @fsockopen('api.imagekit.io', 443)) - { - throw new Exception('Network Error'); - } - else - { - throw $e; - } - } - - /** - * @return Response - */ - public function delete() - { - try { - return $this->client->request('DELETE', $this->getUri(), $this->getOptions('json')); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - /** - * @return Response - */ - public function postMultipart() - { - try { - $options = [ - 'headers' => $this->headers, - 'multipart' => self::getMultipartData($this->datas) - ]; - - return $this->client->request('POST', $this->getUri(), $options); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - - /** - * @param $data - * @return array - */ - public static function getMultipartData($data) - { - $multipartData = []; - - foreach ($data as $key => $value) { - if (is_bool($value)) { - $data[$key] = json_encode($value); - } - } - - foreach ($data as $key => $value) { - if (!is_array($value)) { - $multipartData[] = ['name' => $key, 'contents' => $value]; - continue; - } - - foreach ($value as $multiKey => $multiValue) { - $multiName = $key . '[' . $multiKey . ']' . (is_array($multiValue) ? '[' . key($multiValue) . ']' : '') . ''; - $multipartData[] = ['name' => $multiName, 'contents' => (is_array($multiValue) ? reset($multiValue) : $multiValue)]; - } - } - - return $multipartData; - } - - /** - * @return Response - */ - public function post() - { - try { - $options = [ - 'headers' => $this->headers, - 'json' => $this->datas - ]; - - return $this->client->request('POST', $this->getUri(), $options); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - /** - * @return Response - */ - public function rawPost() - { - try { - $options = [ - 'body' => json_encode($this->datas), - 'headers' => ['Content-Type' => 'application/json'] - ]; - - return $this->client->request('POST', $this->getUri(), $options); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - /** - * @return Response - */ - public function patch() - { - try { - $options = [ - 'headers' => $this->headers, - 'json' => $this->datas - ]; - return $this->client->request('PATCH', $this->getUri(), $options); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - /** - * @return Response - */ - public function put() - { - try { - $options = [ - 'headers' => $this->headers, - 'json' => $this->datas - ]; - return $this->client->request('PUT', $this->getUri(), $options); - } catch (RequestException $e) { - return $this->handleRequestException($e); - } catch (Exception $e) { - return $this->handleException($e); - } - } - - -} diff --git a/src/ImageKit/Resource/HttpRequest.php b/src/ImageKit/Resource/HttpRequest.php deleted file mode 100644 index 63c72000..00000000 --- a/src/ImageKit/Resource/HttpRequest.php +++ /dev/null @@ -1,41 +0,0 @@ - isset($token) ? $token : '', - 'expire' => isset($expire) ? $expire : 0, - 'signature' => '' - ]; - - $obj = (object)($configuration); - - if (!empty($obj->privateKey) and !empty($defaultExpire)) { - - $tok = isset($token) && strlen($token) > 0 ? $token : GuzzleHttpWrapper::gen_uuid(); - $exp = isset($expire) && $expire > 0 ? $expire : $defaultExpire; - $data = $tok . $exp; - $signature = hash_hmac('sha1', $data, $obj->privateKey); - - $authParameters['token'] = $tok; - $authParameters['expire'] = $exp; - $authParameters['signature'] = $signature; - - } - - return (object)$authParameters; - - } - -} diff --git a/src/ImageKit/Upload/Upload.php b/src/ImageKit/Upload/Upload.php deleted file mode 100644 index 4f397d0b..00000000 --- a/src/ImageKit/Upload/Upload.php +++ /dev/null @@ -1,87 +0,0 @@ -file; - $fileName = $opts->fileName; - - $payload = []; - if (isset($opts->options) && is_array($opts->options)) { - $payload = $opts->options; - } - else{ - $payload = (array)$opts; - } - $payload['file'] = $file; - $payload['fileName'] = $fileName; - - if (isset($payload['tags']) && is_array($payload['tags'])) { - $payload['tags'] = implode(',', $payload['tags']); - } - - if (isset($payload['customCoordinates']) && is_array($payload['customCoordinates'])) { - $payload['customCoordinates'] = implode(',', $payload['customCoordinates']); - } - - if (isset($payload['responseFields']) && is_array($payload['responseFields'])) { - $payload['responseFields'] = implode(',', $payload['responseFields']); - } - - if (isset($payload['extensions']) && is_array($payload['extensions'])) { - $payload['extensions'] = json_encode($payload['extensions']); - } - - if (isset($payload['customMetadata']) && is_array($payload['customMetadata'])) { - $payload['customMetadata'] = json_encode($payload['customMetadata']); - } - - if (isset($payload['transformation'])) { - $payload['transformation'] = json_encode($payload['transformation']); - } - - $resource->setDatas((array)$payload); - try { - $res = $resource->postMultipart(); - } catch (\Throwable $th) { - return Response::respond(true, $th->getMessage()); - } - if($res && $res->getBody() && $res->getHeaders() && $res->getStatusCode()){ - $stream = $res->getBody(); - $content = []; - $content['body'] = json_decode($stream->getContents()); - $headers = $res->getHeaders(); - $content['headers'] = $headers; - $content['statusCode'] = (int)$res->getStatusCode(); - - if ($res->getStatusCode() && ($res->getStatusCode() < 200 || $res->getStatusCode() > 300)) { - return Response::respond(true, ($content)); - } - - return Response::respond(false, ($content)); - } - else{ - $errorObject = (object) ErrorMessages::$INVALID_REQUEST; - return Response::respond(true, $errorObject->message); - } - - - } -} diff --git a/src/ImageKit/Url/Url.php b/src/ImageKit/Url/Url.php deleted file mode 100644 index 4bc8a70a..00000000 --- a/src/ImageKit/Url/Url.php +++ /dev/null @@ -1,420 +0,0 @@ -removeTrailingSlash($obj->urlEndpoint); - $transformation = null; - $signed = false; - $expireSeconds = null; - - if (isset($obj->signed)) { - $signed = $obj->signed; - } - - if (isset($obj->expireSeconds)) { - $expireSeconds = $obj->expireSeconds; - } - - if (isset($obj->path)) { - $path = ltrim($obj->path, '/'); - $path = $this->addLeadingSlash($path); - } - - if (isset($obj->src)) { - $src = $obj->src; - } - - if (isset($obj->transformation)) { - $transformation = $obj->transformation; - } - - if ($path == null && $src == null) { - return ''; - } - - // Create Correct query parameter - $parsedHost = ''; - - if (!empty($path)) { - $parsedURL = [parse_url($path)]; - $parsedHost = [parse_url($urlEndpoint)]; - $isSrcParameterUsedForURL = false; - } else { - $parsedURL = [parse_url($src)]; - $isSrcParameterUsedForURL = true; - } - - //Initial URL Construction Object - $urlArray = [ - 'host' => '', - 'pathname' => '', - 'search' => [], - 'queryParameters' => [], - ]; - $urlObject = (object)($urlArray); - if (!empty($path)) { - $urlObject->scheme = $parsedHost[0]['scheme']; - $urlObject->host = $parsedHost[0]['host']; - if (isset($parsedHost[0]['path'])) { - $urlObject->pathname = $parsedHost[0]['path']; - } - } else { - $urlObject->scheme = $parsedURL[0]['scheme']; - $urlObject->host = $parsedURL[0]['host']; - $urlObject->pathname = $parsedURL[0]['path']; - } - if (isset($parsedURL[0]['query'])) { - parse_str($parsedURL[0]['query'], $urlObject->search); - } - if(isset($obj->transformationPosition)){ - if($obj->transformationPosition=='query'){ - if (isset($obj->queryParameters)) { - $urlObject->search = array_merge($urlObject->search, $obj->queryParameters); - } - } - else if($obj->transformationPosition=='path'){ - if (isset($obj->queryParameters)) { - $urlObject->queryParameters = $obj->queryParameters; - } - } - else{ - throw new \InvalidArgumentException(ErrorMessages::$URL_GENERATION_TRANSFORMATION_QUERY_INVALID['message']); - } - - } - else{ - if (isset($obj->queryParameters)) { - $urlObject->queryParameters = $obj->queryParameters; - } - } - - - ksort($urlObject->search); - - // Create Transformation String - $transformationString = $this->constructTransformationString($transformation); - if ($transformationString) { - if (Transformation::addAsQueryParameter($urlOptions) || $isSrcParameterUsedForURL) { - $transformationQueryParam = [self::TRANSFORMATION_PARAMETER => $transformationString]; - $urlObject->search = array_merge($transformationQueryParam, $urlObject->search); - } else { - $originalPath = $this->removeTrailingSlash($urlObject->pathname); - $transformationQuery = self::TRANSFORMATION_PARAMETER; - $transformationQuery .= Transformation::getChainTransformDelimiter(); - $transformationQuery .= $transformationString; - if (!$this->startsWithSlash($originalPath)) { - $urlObject->pathname .= '/'; - } - $urlObject->pathname = $originalPath; - $urlObject->pathname .= '/'; - $urlObject->pathname .= $transformationQuery; - } - } - $urlObject->pathname .= $this->addLeadingSlash($path); - $urlObject->host = $this->removeTrailingSlash($urlObject->host); - $urlObject->pathname = $this->addLeadingSlash($urlObject->pathname); - - // Build Search Params here - $urlObject->search = urldecode(http_build_query($urlObject->search)); - - // Build queryParameters here - $urlObject->queryParameters = urldecode(http_build_query($urlObject->queryParameters)); - - // transformationPosition - $urlObject->transformationPosition = $obj->transformationPosition; - // Signature String and Timestamp - // We can do this only for URLs that are created using urlEndpoint and path parameter - // because we need to know the endpoint to be able to remove it from the URL to create a signature - // for the remaining. With the src parameter, we would not know the "pattern" in the URL - if ($signed === true) { - $expiryTimestamp = $this->getSignatureTimestamp($expireSeconds); - $myArray = json_decode(json_encode($urlObject), true); - $intermediateURL = $this->unparsed_url($myArray); - $urlSignatureArray = [ - 'privateKey' => $urlOptions['privateKey'], - 'url' => $intermediateURL, - 'urlEndpoint' => $urlOptions['urlEndpoint'], - 'expiryTimestamp' => $expiryTimestamp, - ]; - - $urlSignature = $this->getSignature($urlSignatureArray); - if ($expiryTimestamp && $expiryTimestamp != self::DEFAULT_TIMESTAMP) { - $timestampParameter = [ - self::TIMESTAMP_PARAMETER => $expiryTimestamp - ]; - $timestampParameterString = http_build_query($timestampParameter); - $urlObject->timestampParameterString = $timestampParameterString; - } - $signatureParameter = [ - self::SIGNATURE_PARAMETER => $urlSignature - ]; - $signatureParameterString = http_build_query($signatureParameter); - - $urlObject->signatureParameterString = $signatureParameterString; - } - $urlObjectArray = json_decode(json_encode($urlObject), true); - - return $this->unparsed_url($urlObjectArray); - } - - /** - * @param $str - * @return false|mixed|string - */ - private function removeTrailingSlash($str) - { - if (is_string($str) and strlen($str) > 0 and substr($str, -1) == '/') { - $str = substr($str, 0, -1); - } - return $str; - } - - /** - * @param $str - * @return mixed|string - */ - private function addLeadingSlash($str) - { - if (is_string($str) and strlen($str) > 0 and $str[0] != '/') { - $str = '/' . $str; - } - return $str; - } - - /** - * @param $transformation - * @return string - */ - private function constructTransformationString($transformation) - { - if (!is_array($transformation)) { - return ''; - } - $parsedTransforms = []; - for ($i = 0; $i < count($transformation); $i++) { - $parsedTransformStep = []; - foreach ($transformation[$i] as $key => $value) { - if($key=='raw'){ - array_push($parsedTransformStep, $value); - } - else if($key!=''){ - $transform_block = $this->buildingTransformationBlocks($key,$value); - array_push($parsedTransformStep, $transform_block); - } - - } - $delimiter = Transformation::getTransformDelimiter(); - $List = implode($delimiter, $parsedTransformStep); - array_push($parsedTransforms, $List); - } - $setChainDelimiter = Transformation::getChainTransformDelimiter(); - return implode($setChainDelimiter, $parsedTransforms); - } - - /** - * @param $key - * @param $value - * @return array - */ - private function buildingTransformationBlocks($key, $value){ - if (is_bool($value)) { - $value = $value ? 'true' : 'false'; - } - - $value = (string)$value; - $transformKey = Transformation::getTransformKey($key); - if (empty($transformKey)) { - return []; - } - if ((empty($value) && $value !== '0') || $value === '-') { - return $transformKey; - } else { - $transformationUtils = Transformation::getTransformKeyValueDelimiter(); - $finalTransformation = $transformKey . $transformationUtils; - if (strpos($value, '/') !== false) { - $finalTransformation .= str_replace('/', '@@', rtrim(ltrim($value, '/'), '/')); - } else { - $finalTransformation .= $value; - } - - return $finalTransformation; - } - } - - /** - * @param $string - * @return bool - */ - private function startsWithSlash($string) - { - $len = strlen('/'); - return (substr($string, 0, $len) === '/'); - } - - /** - * @param $expireSeconds - * @return string - */ - private function getSignatureTimestamp($expireSeconds) - { - if (empty($expireSeconds)) { - return self::DEFAULT_TIMESTAMP; - } - $sec = intval($expireSeconds); - if (empty($sec)) { - return self::DEFAULT_TIMESTAMP; - } - $currentTimestamp = time(); - return (string)($currentTimestamp + $sec); - } - - /** - * @param array $parsed - * @return string - */ - public function unparsed_url(array $parsed) - { - - $get = function ($key) use ($parsed) { - return isset($parsed[$key]) ? $parsed[$key] : null; - }; - $scheme = $get('scheme'); - $host = $get('host'); - - $pathname = $get('pathname'); - $last_slash_index = strripos($pathname,'/'); - $file_name = substr($pathname,$last_slash_index+1); - $pathname = str_replace('/'.$file_name,'',$pathname); - $pathname = $pathname.'/'; - $search = $get('search'); - $queryParameters = $get('queryParameters'); - $transformationPosition = $get('transformationPosition'); - - $signatureParameterString = $get('signatureParameterString'); - - $timestampParameterString = $get('timestampParameterString'); - - if($transformationPosition=='query'){ - return (strlen($scheme) > 0 ? "$scheme:" : '') . - (strlen($host) > 0 ? "//$host" : '') . - (strlen($pathname) > 0 ? "$pathname" : '') . - $file_name . - (strlen($search) > 0 ? '?' .$search : '') . - (strlen($timestampParameterString) > 0 ? ((strlen($search)?'&':'?') . $timestampParameterString): '') . - (strlen($signatureParameterString) > 0 ? ('&' . $signatureParameterString): ''); - } - else{ - - return (strlen($scheme) > 0 ? "$scheme:" : '') . - (strlen($host) > 0 ? "//$host" : '') . - (strlen($pathname) > 0 ? "$pathname" : '') . - (strlen($search) > 0 ? str_replace('=',':',$search).'/' : '') . - $file_name . - (strlen($queryParameters) > 0 ? ( '?' . $queryParameters): '') . - ((!empty($timestampParameterString) && strlen($timestampParameterString) > 0) ? (((!empty($queryParameters) && strlen($queryParameters)>0)?'&':'?') . $timestampParameterString): '') . - ((!empty($signatureParameterString) && strlen($signatureParameterString) > 0) ? (((!empty($queryParameters) && strlen($queryParameters)>0)?'&': - ((!empty($timestampParameterString) && strlen($timestampParameterString) > 0)?'&':'?') - ) . $signatureParameterString): ''); - - } - } - - /** - * @param $options - * @return false|string - */ - public function getSignature($options) - { - if (empty($options['privateKey']) or empty($options['url']) or empty($options['urlEndpoint'])) { - return ''; - } else { - $data = (str_replace($this->addTrailingSlash($options['urlEndpoint']), '', $options['url']) . $options['expiryTimestamp']); - $data = $this->encodeStringIfRequired($data); - return hash_hmac('sha1', $data, $options['privateKey']); - } - } - - /** - * @param $str - * @return string - */ - private function addTrailingSlash($str) - { - if (is_string($str) and strlen($str) > 0 and substr($str, -1) != '/') { - $str = $str . '/'; - } - return $str; - } - - // Used to check if special char is present in string (you'll need to encode it to utf-8 if it does) - private function hasMoreThanAscii($str) - { - $chars = str_split($str); - foreach ($chars as $char) { - if (ord($char) > 127) { - return true; - } - } - return false; - } - - function encodeURI($str) - { - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURI - $encoded_str = rawurlencode($str); - $encoded_str = - str_replace( - array('%21', '%2A', '%27', '%28', '%29', '%3B', '%2F', '%3F', '%3A', '%40', '%26', '%3D', '%2B', '%24', '%2C', '%23'), - array('!', '*', "'", '(', ')', ';', '/', '?', ':', '@', '&', '=', '+', '$', ',', '#'), - $encoded_str - ); - return $encoded_str; - } - - function custom_encodeURIComponent($url_str) { - $parsed_url = parse_url($url_str); - $encoded_url = ""; - if (isset($parsed_url['query'])) { - $encoded_url .= $this->encodeURI(explode("?", $url_str)[0]).'?' . $this->encodeURI($parsed_url['query']); - } - else - $encoded_url = $this->encodeURI($url_str); - return $encoded_url; - } - - /** - * @param $str - * @return string - */ - public function encodeStringIfRequired($str) - { - return $this->hasMoreThanAscii($str) ? $this->custom_encodeURIComponent($str) : $str; - } -} \ No newline at end of file diff --git a/src/ImageKit/Utils/Authorization.php b/src/ImageKit/Utils/Authorization.php deleted file mode 100644 index e3cfe832..00000000 --- a/src/ImageKit/Utils/Authorization.php +++ /dev/null @@ -1,26 +0,0 @@ - [ - $configuration->privateKey, '' - ], - 'handler'=>$handlerStack - ]; - } -} - diff --git a/src/ImageKit/Utils/Response.php b/src/ImageKit/Utils/Response.php deleted file mode 100644 index 1ecb73db..00000000 --- a/src/ImageKit/Utils/Response.php +++ /dev/null @@ -1,71 +0,0 @@ -null, - 'raw'=>null, - 'statusCode'=>null - ]; - - /** - * @param $isError - * @param $response - * @return Response - */ - public static function respond($isError, $response) - { - $responseObject = new Response(); - if($response && is_array($response)){ - if ($isError) { - $responseObject->error = $response['body']; - } else { - $responseObject->result = $response['body']; - } - $headers = []; - foreach ($response['headers'] as $key => $value) { - if(is_array($value)){ - $headers[$key] = implode(',',$value); - } - else{ - $headers[$key] = $value; - } - } - - $responseObject->responseMetadata['headers'] = $headers; - $responseObject->responseMetadata['raw'] = $response['body']; - $responseObject->responseMetadata['statusCode'] = $response['statusCode']; - - } - else{ - $responseObject->error = $response; - $responseObject->responseMetadata = null; - } - - return $responseObject; - } -} diff --git a/src/ImageKit/Utils/Transformation.php b/src/ImageKit/Utils/Transformation.php deleted file mode 100644 index 3d6a6c3e..00000000 --- a/src/ImageKit/Utils/Transformation.php +++ /dev/null @@ -1,72 +0,0 @@ -transformationPosition)) { - return $optionsObject->transformationPosition === self::QUERY_TRANSFORMATION_POSITION; - } - return false; - } - -} diff --git a/src/ImageOverlay.php b/src/ImageOverlay.php new file mode 100644 index 00000000..ead19e1b --- /dev/null +++ b/src/ImageOverlay.php @@ -0,0 +1,136 @@ +|null, + * } + */ +final class ImageOverlay implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Api] + public string $type = 'image'; + + /** + * Specifies the relative path to the image used as an overlay. + */ + #[Api] + public string $input; + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @var Encoding::*|null $encoding + */ + #[Api(enum: Encoding::class, optional: true)] + public ?string $encoding; + + /** + * Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. + * See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay). + * + * @var list|null $transformation + */ + #[Api(list: Transformation::class, optional: true)] + public ?array $transformation; + + /** + * `new ImageOverlay()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * ImageOverlay::with(input: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new ImageOverlay)->withInput(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Encoding::* $encoding + * @param list $transformation + */ + public static function with( + string $input, + ?string $encoding = null, + ?array $transformation = null + ): self { + $obj = new self; + + $obj->input = $input; + + null !== $encoding && $obj->encoding = $encoding; + null !== $transformation && $obj->transformation = $transformation; + + return $obj; + } + + /** + * Specifies the relative path to the image used as an overlay. + */ + public function withInput(string $input): self + { + $obj = clone $this; + $obj->input = $input; + + return $obj; + } + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @param Encoding::* $encoding + */ + public function withEncoding(string $encoding): self + { + $obj = clone $this; + $obj->encoding = $encoding; + + return $obj; + } + + /** + * Array of transformations to be applied to the overlay image. Supported transformations depends on the base/parent asset. + * See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#list-of-supported-image-transformations-in-image-layers) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#list-of-transformations-supported-on-image-overlay). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/ImageOverlay/Encoding.php b/src/ImageOverlay/Encoding.php new file mode 100644 index 00000000..aad5a95d --- /dev/null +++ b/src/ImageOverlay/Encoding.php @@ -0,0 +1,25 @@ +|array + */ + public static function variants(): array + { + return [ + 'text' => TextOverlay::class, + 'image' => ImageOverlay::class, + 'video' => VideoOverlay::class, + 'subtitle' => SubtitleOverlay::class, + 'solidColor' => SolidColorOverlay::class, + ]; + } +} diff --git a/src/OverlayPosition.php b/src/OverlayPosition.php new file mode 100644 index 00000000..41a18ad9 --- /dev/null +++ b/src/OverlayPosition.php @@ -0,0 +1,116 @@ + */ + use SdkModel; + + /** + * Specifies the position of the overlay relative to the parent image or video. + * Maps to `lfo` in the URL. + * + * @var Focus::*|null $focus + */ + #[Api(enum: Focus::class, optional: true)] + public ?string $focus; + + /** + * Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. + * It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. + * Maps to `lx` in the URL. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + #[Api(optional: true)] + public float|string|null $x; + + /** + * Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. + * It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. + * Maps to `ly` in the URL. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + #[Api(optional: true)] + public float|string|null $y; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Focus::* $focus + */ + public static function with( + ?string $focus = null, + float|string|null $x = null, + float|string|null $y = null + ): self { + $obj = new self; + + null !== $focus && $obj->focus = $focus; + null !== $x && $obj->x = $x; + null !== $y && $obj->y = $y; + + return $obj; + } + + /** + * Specifies the position of the overlay relative to the parent image or video. + * Maps to `lfo` in the URL. + * + * @param Focus::* $focus + */ + public function withFocus(string $focus): self + { + $obj = clone $this; + $obj->focus = $focus; + + return $obj; + } + + /** + * Specifies the x-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. + * It also accepts arithmetic expressions such as `bw_mul_0.4` or `bw_sub_cw`. + * Maps to `lx` in the URL. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + public function withX(float|string $x): self + { + $obj = clone $this; + $obj->x = $x; + + return $obj; + } + + /** + * Specifies the y-coordinate of the top-left corner of the base asset where the overlay's top-left corner will be positioned. + * It also accepts arithmetic expressions such as `bh_mul_0.4` or `bh_sub_ch`. + * Maps to `ly` in the URL. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + public function withY(float|string $y): self + { + $obj = clone $this; + $obj->y = $y; + + return $obj; + } +} diff --git a/src/OverlayPosition/Focus.php b/src/OverlayPosition/Focus.php new file mode 100644 index 00000000..120f5ce8 --- /dev/null +++ b/src/OverlayPosition/Focus.php @@ -0,0 +1,35 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/OverlayPosition/Y.php b/src/OverlayPosition/Y.php new file mode 100644 index 00000000..b5af671a --- /dev/null +++ b/src/OverlayPosition/Y.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/OverlayTiming.php b/src/OverlayTiming.php new file mode 100644 index 00000000..f7498c10 --- /dev/null +++ b/src/OverlayTiming.php @@ -0,0 +1,117 @@ + */ + use SdkModel; + + /** + * Specifies the duration (in seconds) during which the overlay should appear on the base video. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `ldu` in the URL. + */ + #[Api(optional: true)] + public float|string|null $duration; + + /** + * Specifies the end time (in seconds) for when the overlay should disappear from the base video. + * If both end and duration are provided, duration is ignored. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `leo` in the URL. + */ + #[Api(optional: true)] + public float|string|null $end; + + /** + * Specifies the start time (in seconds) for when the overlay should appear on the base video. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `lso` in the URL. + */ + #[Api(optional: true)] + public float|string|null $start; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + float|string|null $duration = null, + float|string|null $end = null, + float|string|null $start = null, + ): self { + $obj = new self; + + null !== $duration && $obj->duration = $duration; + null !== $end && $obj->end = $end; + null !== $start && $obj->start = $start; + + return $obj; + } + + /** + * Specifies the duration (in seconds) during which the overlay should appear on the base video. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `ldu` in the URL. + */ + public function withDuration(float|string $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Specifies the end time (in seconds) for when the overlay should disappear from the base video. + * If both end and duration are provided, duration is ignored. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `leo` in the URL. + */ + public function withEnd(float|string $end): self + { + $obj = clone $this; + $obj->end = $end; + + return $obj; + } + + /** + * Specifies the start time (in seconds) for when the overlay should appear on the base video. + * Accepts a positive number up to two decimal places (e.g., `20` or `20.50`) and arithmetic expressions such as `bdu_mul_0.4` or `bdu_sub_idu`. + * Applies only if the base asset is a video. + * Maps to `lso` in the URL. + */ + public function withStart(float|string $start): self + { + $obj = clone $this; + $obj->start = $start; + + return $obj; + } +} diff --git a/src/OverlayTiming/Duration.php b/src/OverlayTiming/Duration.php new file mode 100644 index 00000000..64ae7c3e --- /dev/null +++ b/src/OverlayTiming/Duration.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/OverlayTiming/End.php b/src/OverlayTiming/End.php new file mode 100644 index 00000000..afc953c5 --- /dev/null +++ b/src/OverlayTiming/End.php @@ -0,0 +1,30 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/OverlayTiming/Start.php b/src/OverlayTiming/Start.php new file mode 100644 index 00000000..28b73db9 --- /dev/null +++ b/src/OverlayTiming/Start.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/RequestOptions.php b/src/RequestOptions.php new file mode 100644 index 00000000..0881a16a --- /dev/null +++ b/src/RequestOptions.php @@ -0,0 +1,219 @@ +>|null, + * extraQueryParams?: array|null, + * extraBodyParams?: mixed, + * transporter?: ClientInterface|null, + * uriFactory?: UriFactoryInterface|null, + * streamFactory?: StreamFactoryInterface|null, + * requestFactory?: RequestFactoryInterface|null, + * } + * @phpstan-type request_opts = null|RequestOptions|request_options + */ +final class RequestOptions implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Property] + public float $timeout = 60; + + #[Property] + public int $maxRetries = 2; + + #[Property] + public float $initialRetryDelay = 0.5; + + #[Property] + public float $maxRetryDelay = 8.0; + + /** @var array|null>|null $extraHeaders */ + #[Property(optional: true)] + public ?array $extraHeaders; + + /** @var array|null $extraQueryParams */ + #[Property(optional: true)] + public ?array $extraQueryParams; + + #[Property(optional: true)] + public mixed $extraBodyParams; + + #[Property(optional: true)] + public ?ClientInterface $transporter; + + #[Property(optional: true)] + public ?UriFactoryInterface $uriFactory; + + #[Property(optional: true)] + public ?StreamFactoryInterface $streamFactory; + + #[Property(optional: true)] + public ?RequestFactoryInterface $requestFactory; + + public function __construct() + { + $this->initialize(); + } + + /** + * @param request_opts|null $options + */ + public static function parse(RequestOptions|array|null ...$options): self + { + $parsed = array_map(static fn ($o) => $o instanceof self ? $o->toArray() : $o ?? [], array: $options); + + return self::with(...array_merge(...$parsed)); // @phpstan-ignore-line + } + + /** + * @param array|null>|null $extraHeaders + * @param array|null $extraQueryParams + * @param mixed|Omit $extraBodyParams + */ + public static function with( + ?float $timeout = null, + ?int $maxRetries = null, + ?float $initialRetryDelay = null, + ?float $maxRetryDelay = null, + ?array $extraHeaders = null, + ?array $extraQueryParams = null, + mixed $extraBodyParams = omit, + ?ClientInterface $transporter = null, + ?UriFactoryInterface $uriFactory = null, + ?StreamFactoryInterface $streamFactory = null, + ?RequestFactoryInterface $requestFactory = null, + ): self { + $obj = new self; + + null !== $timeout && $obj->timeout = $timeout; + null !== $maxRetries && $obj->maxRetries = $maxRetries; + null !== $initialRetryDelay && $obj->initialRetryDelay = $initialRetryDelay; + null !== $maxRetryDelay && $obj->maxRetryDelay = $maxRetryDelay; + null !== $extraHeaders && $obj->extraHeaders = $extraHeaders; + null !== $extraQueryParams && $obj->extraQueryParams = $extraQueryParams; + omit !== $extraBodyParams && $obj->extraBodyParams = $extraBodyParams; + null !== $transporter && $obj->transporter = $transporter; + null !== $uriFactory && $obj->uriFactory = $uriFactory; + null !== $streamFactory && $obj->streamFactory = $streamFactory; + null !== $requestFactory && $obj->requestFactory = $requestFactory; + + return $obj; + } + + public function withTimeout(float $timeout): self + { + $obj = clone $this; + $obj->timeout = $timeout; + + return $obj; + } + + public function withMaxRetries(int $maxRetries): self + { + $obj = clone $this; + $obj->maxRetries = $maxRetries; + + return $obj; + } + + public function withInitialRetryDelay(float $initialRetryDelay): self + { + $obj = clone $this; + $obj->initialRetryDelay = $initialRetryDelay; + + return $obj; + } + + public function withMaxRetryDelay(float $maxRetryDelay): self + { + $obj = clone $this; + $obj->maxRetryDelay = $maxRetryDelay; + + return $obj; + } + + /** + * @param array|null> $extraHeaders + */ + public function withExtraHeaders(array $extraHeaders): self + { + $obj = clone $this; + $obj->extraHeaders = $extraHeaders; + + return $obj; + } + + /** + * @param array $extraQueryParams + */ + public function withExtraQueryParams(array $extraQueryParams): self + { + $obj = clone $this; + $obj->extraQueryParams = $extraQueryParams; + + return $obj; + } + + public function withExtraBodyParams(mixed $extraBodyParams): self + { + $obj = clone $this; + $obj->extraBodyParams = $extraBodyParams; + + return $obj; + } + + public function withTransporter(ClientInterface $transporter): self + { + $obj = clone $this; + $obj->transporter = $transporter; + + return $obj; + } + + public function withUriFactory(UriFactoryInterface $uriFactory): self + { + $obj = clone $this; + $obj->uriFactory = $uriFactory; + + return $obj; + } + + public function withStreamFactory( + StreamFactoryInterface $streamFactory + ): self { + $obj = clone $this; + $obj->streamFactory = $streamFactory; + + return $obj; + } + + public function withRequestFactory( + RequestFactoryInterface $requestFactory + ): self { + $obj = clone $this; + $obj->requestFactory = $requestFactory; + + return $obj; + } +} diff --git a/src/SolidColorOverlay.php b/src/SolidColorOverlay.php new file mode 100644 index 00000000..95867fb4 --- /dev/null +++ b/src/SolidColorOverlay.php @@ -0,0 +1,106 @@ +|null, + * } + */ +final class SolidColorOverlay implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Api] + public string $type = 'solidColor'; + + /** + * Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). + * If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99). + */ + #[Api] + public string $color; + + /** + * Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. + * See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay). + * + * @var list|null $transformation + */ + #[Api(list: SolidColorOverlayTransformation::class, optional: true)] + public ?array $transformation; + + /** + * `new SolidColorOverlay()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * SolidColorOverlay::with(color: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new SolidColorOverlay)->withColor(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list $transformation + */ + public static function with( + string $color, + ?array $transformation = null + ): self { + $obj = new self; + + $obj->color = $color; + + null !== $transformation && $obj->transformation = $transformation; + + return $obj; + } + + /** + * Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). + * If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99). + */ + public function withColor(string $color): self + { + $obj = clone $this; + $obj->color = $color; + + return $obj; + } + + /** + * Control width and height of the solid color overlay. Supported transformations depend on the base/parent asset. + * See overlays on [Images](https://imagekit.io/docs/add-overlays-on-images#apply-transformation-on-solid-color-overlay) and [Videos](https://imagekit.io/docs/add-overlays-on-videos#apply-transformations-on-solid-color-block-overlay). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/SolidColorOverlayTransformation.php b/src/SolidColorOverlayTransformation.php new file mode 100644 index 00000000..dccceb17 --- /dev/null +++ b/src/SolidColorOverlayTransformation.php @@ -0,0 +1,165 @@ + */ + use SdkModel; + + /** + * Specifies the transparency level of the solid color overlay. Accepts integers from `1` to `9`. + */ + #[Api(optional: true)] + public ?float $alpha; + + /** + * Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name. + */ + #[Api(optional: true)] + public ?string $background; + + /** + * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. + * Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). + */ + #[Api(optional: true)] + public bool|string|null $gradient; + + /** + * Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. + * Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + #[Api(optional: true)] + public float|string|null $height; + + /** + * Specifies the corner radius of the solid color overlay. Set to `max` for circular or oval shape. + * See [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + */ + #[Api(optional: true)] + public float|string|null $radius; + + /** + * Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). + * Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + #[Api(optional: true)] + public float|string|null $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $alpha = null, + ?string $background = null, + bool|string|null $gradient = null, + float|string|null $height = null, + float|string|null $radius = null, + float|string|null $width = null, + ): self { + $obj = new self; + + null !== $alpha && $obj->alpha = $alpha; + null !== $background && $obj->background = $background; + null !== $gradient && $obj->gradient = $gradient; + null !== $height && $obj->height = $height; + null !== $radius && $obj->radius = $radius; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * Specifies the transparency level of the solid color overlay. Accepts integers from `1` to `9`. + */ + public function withAlpha(float $alpha): self + { + $obj = clone $this; + $obj->alpha = $alpha; + + return $obj; + } + + /** + * Specifies the background color of the solid color overlay. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name. + */ + public function withBackground(string $background): self + { + $obj = clone $this; + $obj->background = $background; + + return $obj; + } + + /** + * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. + * Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). + */ + public function withGradient(bool|string $gradient): self + { + $obj = clone $this; + $obj->gradient = $gradient; + + return $obj; + } + + /** + * Controls the height of the solid color overlay. Accepts a numeric value or an arithmetic expression. + * Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + public function withHeight(float|string $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Specifies the corner radius of the solid color overlay. Set to `max` for circular or oval shape. + * See [radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + */ + public function withRadius(float|string $radius): self + { + $obj = clone $this; + $obj->radius = $radius; + + return $obj; + } + + /** + * Controls the width of the solid color overlay. Accepts a numeric value or an arithmetic expression (e.g., `bw_mul_0.2` or `bh_div_2`). + * Learn about [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + public function withWidth(float|string $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/SolidColorOverlayTransformation/Gradient.php b/src/SolidColorOverlayTransformation/Gradient.php new file mode 100644 index 00000000..eb408f77 --- /dev/null +++ b/src/SolidColorOverlayTransformation/Gradient.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'string']; + } +} diff --git a/src/SolidColorOverlayTransformation/Height.php b/src/SolidColorOverlayTransformation/Height.php new file mode 100644 index 00000000..1f458195 --- /dev/null +++ b/src/SolidColorOverlayTransformation/Height.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/SolidColorOverlayTransformation/Radius.php b/src/SolidColorOverlayTransformation/Radius.php new file mode 100644 index 00000000..273bf7ce --- /dev/null +++ b/src/SolidColorOverlayTransformation/Radius.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', STAINLESS_FIXME_::class]; + } +} diff --git a/src/SolidColorOverlayTransformation/Width.php b/src/SolidColorOverlayTransformation/Width.php new file mode 100644 index 00000000..9b727c04 --- /dev/null +++ b/src/SolidColorOverlayTransformation/Width.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/SrcOptions.php b/src/SrcOptions.php new file mode 100644 index 00000000..6513f4d1 --- /dev/null +++ b/src/SrcOptions.php @@ -0,0 +1,243 @@ +|null, + * signed?: bool|null, + * transformation?: list|null, + * transformationPosition?: TransformationPosition::*|null, + * } + */ +final class SrcOptions implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`. + * If an absolute path is provided, `urlEndpoint` is ignored. + */ + #[Api] + public string $src; + + /** + * Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). + */ + #[Api] + public string $urlEndpoint; + + /** + * When you want the signed URL to expire, specified in seconds. If `expiresIn` is anything above 0, + * the URL will always be signed even if `signed` is set to false. If not specified and `signed` is `true`, + * the signed URL will not expire (valid indefinitely). + * + * Example: Setting `expiresIn: 3600` will make the URL expire 1 hour from generation time. After the expiry time, the signed URL will no longer be valid and ImageKit will return + * a 401 Unauthorized status code. + * + * [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls). + */ + #[Api(optional: true)] + public ?float $expiresIn; + + /** + * These are additional query parameters that you want to add to the final URL. + * They can be any query parameters and not necessarily related to ImageKit. + * This is especially useful if you want to add a versioning parameter to your URLs. + * + * @var array|null $queryParameters + */ + #[Api(map: 'string', optional: true)] + public ?array $queryParameters; + + /** + * Whether to sign the URL or not. Set this to `true` if you want to generate a signed URL. + * If `signed` is `true` and `expiresIn` is not specified, the signed URL will not expire (valid indefinitely). + * Note: If `expiresIn` is set to any value above 0, the URL will always be signed regardless of this setting. + * [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls). + */ + #[Api(optional: true)] + public ?bool $signed; + + /** + * An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations. + * See [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). + * + * @var list|null $transformation + */ + #[Api(list: Transformation::class, optional: true)] + public ?array $transformation; + + /** + * By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`. + * If you want to add the transformation string in the path of the URL, set this to `path`. + * Learn more in the [Transformations guide](https://imagekit.io/docs/transformations). + * + * @var TransformationPosition::*|null $transformationPosition + */ + #[Api(enum: TransformationPosition::class, optional: true)] + public ?string $transformationPosition; + + /** + * `new SrcOptions()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * SrcOptions::with(src: ..., urlEndpoint: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new SrcOptions)->withSrc(...)->withURLEndpoint(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $queryParameters + * @param list $transformation + * @param TransformationPosition::* $transformationPosition + */ + public static function with( + string $src, + string $urlEndpoint, + ?float $expiresIn = null, + ?array $queryParameters = null, + ?bool $signed = null, + ?array $transformation = null, + ?string $transformationPosition = null, + ): self { + $obj = new self; + + $obj->src = $src; + $obj->urlEndpoint = $urlEndpoint; + + null !== $expiresIn && $obj->expiresIn = $expiresIn; + null !== $queryParameters && $obj->queryParameters = $queryParameters; + null !== $signed && $obj->signed = $signed; + null !== $transformation && $obj->transformation = $transformation; + null !== $transformationPosition && $obj->transformationPosition = $transformationPosition; + + return $obj; + } + + /** + * Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`. + * If an absolute path is provided, `urlEndpoint` is ignored. + */ + public function withSrc(string $src): self + { + $obj = clone $this; + $obj->src = $src; + + return $obj; + } + + /** + * Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints). + */ + public function withURLEndpoint(string $urlEndpoint): self + { + $obj = clone $this; + $obj->urlEndpoint = $urlEndpoint; + + return $obj; + } + + /** + * When you want the signed URL to expire, specified in seconds. If `expiresIn` is anything above 0, + * the URL will always be signed even if `signed` is set to false. If not specified and `signed` is `true`, + * the signed URL will not expire (valid indefinitely). + * + * Example: Setting `expiresIn: 3600` will make the URL expire 1 hour from generation time. After the expiry time, the signed URL will no longer be valid and ImageKit will return + * a 401 Unauthorized status code. + * + * [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls). + */ + public function withExpiresIn(float $expiresIn): self + { + $obj = clone $this; + $obj->expiresIn = $expiresIn; + + return $obj; + } + + /** + * These are additional query parameters that you want to add to the final URL. + * They can be any query parameters and not necessarily related to ImageKit. + * This is especially useful if you want to add a versioning parameter to your URLs. + * + * @param array $queryParameters + */ + public function withQueryParameters(array $queryParameters): self + { + $obj = clone $this; + $obj->queryParameters = $queryParameters; + + return $obj; + } + + /** + * Whether to sign the URL or not. Set this to `true` if you want to generate a signed URL. + * If `signed` is `true` and `expiresIn` is not specified, the signed URL will not expire (valid indefinitely). + * Note: If `expiresIn` is set to any value above 0, the URL will always be signed regardless of this setting. + * [Learn more](https://imagekit.io/docs/media-delivery-basic-security#how-to-generate-signed-urls). + */ + public function withSigned(bool $signed): self + { + $obj = clone $this; + $obj->signed = $signed; + + return $obj; + } + + /** + * An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations. + * See [Chained transformations](https://imagekit.io/docs/transformations#chained-transformations). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`. + * If you want to add the transformation string in the path of the URL, set this to `path`. + * Learn more in the [Transformations guide](https://imagekit.io/docs/transformations). + * + * @param TransformationPosition::* $transformationPosition + */ + public function withTransformationPosition( + string $transformationPosition + ): self { + $obj = clone $this; + $obj->transformationPosition = $transformationPosition; + + return $obj; + } +} diff --git a/src/StreamingResolution.php b/src/StreamingResolution.php new file mode 100644 index 00000000..2b494e8b --- /dev/null +++ b/src/StreamingResolution.php @@ -0,0 +1,30 @@ +|null, + * } + */ +final class SubtitleOverlay implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Api] + public string $type = 'subtitle'; + + /** + * Specifies the relative path to the subtitle file used as an overlay. + */ + #[Api] + public string $input; + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @var Encoding::*|null $encoding + */ + #[Api(enum: Encoding::class, optional: true)] + public ?string $encoding; + + /** + * Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). + * + * @var list|null $transformation + */ + #[Api(list: SubtitleOverlayTransformation::class, optional: true)] + public ?array $transformation; + + /** + * `new SubtitleOverlay()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * SubtitleOverlay::with(input: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new SubtitleOverlay)->withInput(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Encoding::* $encoding + * @param list $transformation + */ + public static function with( + string $input, + ?string $encoding = null, + ?array $transformation = null + ): self { + $obj = new self; + + $obj->input = $input; + + null !== $encoding && $obj->encoding = $encoding; + null !== $transformation && $obj->transformation = $transformation; + + return $obj; + } + + /** + * Specifies the relative path to the subtitle file used as an overlay. + */ + public function withInput(string $input): self + { + $obj = clone $this; + $obj->input = $input; + + return $obj; + } + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @param Encoding::* $encoding + */ + public function withEncoding(string $encoding): self + { + $obj = clone $this; + $obj->encoding = $encoding; + + return $obj; + } + + /** + * Control styling of the subtitle. See [Styling subtitles](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/SubtitleOverlay/Encoding.php b/src/SubtitleOverlay/Encoding.php new file mode 100644 index 00000000..fef7e323 --- /dev/null +++ b/src/SubtitleOverlay/Encoding.php @@ -0,0 +1,25 @@ + */ + use SdkModel; + + /** + * Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + #[Api(optional: true)] + public ?string $background; + + /** + * Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + #[Api(optional: true)] + public ?string $color; + + /** + * Font family for subtitles. Refer to the [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). + */ + #[Api(optional: true)] + public ?string $fontFamily; + + /** + * Sets the font outline of the subtitle text. + * Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. + * Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + #[Api(optional: true)] + public ?string $fontOutline; + + /** + * Sets the font shadow for the subtitle text. + * Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. + * Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + #[Api(optional: true)] + public ?string $fontShadow; + + /** + * Sets the font size of subtitle text. + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + #[Api(optional: true)] + public ?float $fontSize; + + /** + * Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + * + * @var Typography::*|null $typography + */ + #[Api(enum: Typography::class, optional: true)] + public ?string $typography; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Typography::* $typography + */ + public static function with( + ?string $background = null, + ?string $color = null, + ?string $fontFamily = null, + ?string $fontOutline = null, + ?string $fontShadow = null, + ?float $fontSize = null, + ?string $typography = null, + ): self { + $obj = new self; + + null !== $background && $obj->background = $background; + null !== $color && $obj->color = $color; + null !== $fontFamily && $obj->fontFamily = $fontFamily; + null !== $fontOutline && $obj->fontOutline = $fontOutline; + null !== $fontShadow && $obj->fontShadow = $fontShadow; + null !== $fontSize && $obj->fontSize = $fontSize; + null !== $typography && $obj->typography = $typography; + + return $obj; + } + + /** + * Specifies the subtitle background color using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + public function withBackground(string $background): self + { + $obj = clone $this; + $obj->background = $background; + + return $obj; + } + + /** + * Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., FF0000), or an RGBA color code (e.g., FFAABB50). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + public function withColor(string $color): self + { + $obj = clone $this; + $obj->color = $color; + + return $obj; + } + + /** + * Font family for subtitles. Refer to the [supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list). + */ + public function withFontFamily(string $fontFamily): self + { + $obj = clone $this; + $obj->fontFamily = $fontFamily; + + return $obj; + } + + /** + * Sets the font outline of the subtitle text. + * Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore. + * Example: `fol-2_blue` (outline width of 2px and outline color blue), `fol-2_A1CCDD` (outline width of 2px and outline color `#A1CCDD`) and `fol-2_A1CCDD50` (outline width of 2px and outline color `#A1CCDD` at 50% opacity). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + public function withFontOutline(string $fontOutline): self + { + $obj = clone $this; + $obj->fontOutline = $fontOutline; + + return $obj; + } + + /** + * Sets the font shadow for the subtitle text. + * Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and shadow indent (an integer) separated by an underscore. + * Example: `fsh-blue_2` (shadow color blue, indent of 2px), `fsh-A1CCDD_3` (shadow color `#A1CCDD`, indent of 3px), `fsh-A1CCDD50_3` (shadow color `#A1CCDD` at 50% opacity, indent of 3px). + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + public function withFontShadow(string $fontShadow): self + { + $obj = clone $this; + $obj->fontShadow = $fontShadow; + + return $obj; + } + + /** + * Sets the font size of subtitle text. + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + */ + public function withFontSize(float $fontSize): self + { + $obj = clone $this; + $obj->fontSize = $fontSize; + + return $obj; + } + + /** + * Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. + * + * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) + * + * @param Typography::* $typography + */ + public function withTypography(string $typography): self + { + $obj = clone $this; + $obj->typography = $typography; + + return $obj; + } +} diff --git a/src/SubtitleOverlayTransformation/Typography.php b/src/SubtitleOverlayTransformation/Typography.php new file mode 100644 index 00000000..e5a94c37 --- /dev/null +++ b/src/SubtitleOverlayTransformation/Typography.php @@ -0,0 +1,24 @@ +|null, + * } + */ +final class TextOverlay implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Api] + public string $type = 'text'; + + /** + * Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding. + */ + #[Api] + public string $text; + + /** + * Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). + * By default, the SDK selects the appropriate format based on the input text. + * To always use base64 (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @var Encoding::*|null $encoding + */ + #[Api(enum: Encoding::class, optional: true)] + public ?string $encoding; + + /** + * Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). + * + * @var list|null $transformation + */ + #[Api(list: TextOverlayTransformation::class, optional: true)] + public ?array $transformation; + + /** + * `new TextOverlay()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * TextOverlay::with(text: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new TextOverlay)->withText(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Encoding::* $encoding + * @param list $transformation + */ + public static function with( + string $text, + ?string $encoding = null, + ?array $transformation = null + ): self { + $obj = new self; + + $obj->text = $text; + + null !== $encoding && $obj->encoding = $encoding; + null !== $transformation && $obj->transformation = $transformation; + + return $obj; + } + + /** + * Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding. + */ + public function withText(string $text): self + { + $obj = clone $this; + $obj->text = $text; + + return $obj; + } + + /** + * Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). + * By default, the SDK selects the appropriate format based on the input text. + * To always use base64 (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @param Encoding::* $encoding + */ + public function withEncoding(string $encoding): self + { + $obj = clone $this; + $obj->encoding = $encoding; + + return $obj; + } + + /** + * Control styling of the text overlay. See [Text overlays](https://imagekit.io/docs/add-overlays-on-images#text-overlay). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/TextOverlay/Encoding.php b/src/TextOverlay/Encoding.php new file mode 100644 index 00000000..9b23bed7 --- /dev/null +++ b/src/TextOverlay/Encoding.php @@ -0,0 +1,25 @@ + */ + use SdkModel; + + /** + * Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`. + */ + #[Api(optional: true)] + public ?float $alpha; + + /** + * Specifies the background color of the text overlay. + * Accepts an RGB hex code, an RGBA code, or a color name. + */ + #[Api(optional: true)] + public ?string $background; + + /** + * Flip the text overlay horizontally, vertically, or both. + * + * @var Flip::*|null $flip + */ + #[Api(enum: Flip::class, optional: true)] + public ?string $flip; + + /** + * Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name. + */ + #[Api(optional: true)] + public ?string $fontColor; + + /** + * Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. + * See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay). + */ + #[Api(optional: true)] + public ?string $fontFamily; + + /** + * Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression. + */ + #[Api(optional: true)] + public float|string|null $fontSize; + + /** + * Specifies the inner alignment of the text when width is more than the text length. + * + * @var InnerAlignment::*|null $innerAlignment + */ + #[Api(enum: InnerAlignment::class, optional: true)] + public ?string $innerAlignment; + + /** + * Specifies the line height of the text overlay. + * Accepts integer values representing line height in points. It can also accept [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations) such as `bw_mul_0.2`, or `bh_div_20`. + */ + #[Api(optional: true)] + public float|string|null $lineHeight; + + /** + * Specifies the padding around the overlaid text. + * Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). + * Arithmetic expressions are also accepted. + */ + #[Api(optional: true)] + public float|string|null $padding; + + /** + * Specifies the corner radius of the text overlay. + * Set to `max` to achieve a circular or oval shape. + */ + #[Api(optional: true)] + public float|string|null $radius; + + /** + * Specifies the rotation angle of the text overlay. + * Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation. + */ + #[Api(optional: true)] + public float|string|null $rotation; + + /** + * Specifies the typography style of the text. + * Supported values: + * - Single styles: `b` (bold), `i` (italic), `strikethrough`. + * - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`. + */ + #[Api(optional: true)] + public ?string $typography; + + /** + * Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + #[Api(optional: true)] + public float|string|null $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Flip::* $flip + * @param InnerAlignment::* $innerAlignment + */ + public static function with( + ?float $alpha = null, + ?string $background = null, + ?string $flip = null, + ?string $fontColor = null, + ?string $fontFamily = null, + float|string|null $fontSize = null, + ?string $innerAlignment = null, + float|string|null $lineHeight = null, + float|string|null $padding = null, + float|string|null $radius = null, + float|string|null $rotation = null, + ?string $typography = null, + float|string|null $width = null, + ): self { + $obj = new self; + + null !== $alpha && $obj->alpha = $alpha; + null !== $background && $obj->background = $background; + null !== $flip && $obj->flip = $flip; + null !== $fontColor && $obj->fontColor = $fontColor; + null !== $fontFamily && $obj->fontFamily = $fontFamily; + null !== $fontSize && $obj->fontSize = $fontSize; + null !== $innerAlignment && $obj->innerAlignment = $innerAlignment; + null !== $lineHeight && $obj->lineHeight = $lineHeight; + null !== $padding && $obj->padding = $padding; + null !== $radius && $obj->radius = $radius; + null !== $rotation && $obj->rotation = $rotation; + null !== $typography && $obj->typography = $typography; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`. + */ + public function withAlpha(float $alpha): self + { + $obj = clone $this; + $obj->alpha = $alpha; + + return $obj; + } + + /** + * Specifies the background color of the text overlay. + * Accepts an RGB hex code, an RGBA code, or a color name. + */ + public function withBackground(string $background): self + { + $obj = clone $this; + $obj->background = $background; + + return $obj; + } + + /** + * Flip the text overlay horizontally, vertically, or both. + * + * @param Flip::* $flip + */ + public function withFlip(string $flip): self + { + $obj = clone $this; + $obj->flip = $flip; + + return $obj; + } + + /** + * Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name. + */ + public function withFontColor(string $fontColor): self + { + $obj = clone $this; + $obj->fontColor = $fontColor; + + return $obj; + } + + /** + * Specifies the font family of the overlaid text. Choose from the supported fonts list or use a custom font. + * See [Supported fonts](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) and [Custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay). + */ + public function withFontFamily(string $fontFamily): self + { + $obj = clone $this; + $obj->fontFamily = $fontFamily; + + return $obj; + } + + /** + * Specifies the font size of the overlaid text. Accepts a numeric value or an arithmetic expression. + */ + public function withFontSize(float|string $fontSize): self + { + $obj = clone $this; + $obj->fontSize = $fontSize; + + return $obj; + } + + /** + * Specifies the inner alignment of the text when width is more than the text length. + * + * @param InnerAlignment::* $innerAlignment + */ + public function withInnerAlignment(string $innerAlignment): self + { + $obj = clone $this; + $obj->innerAlignment = $innerAlignment; + + return $obj; + } + + /** + * Specifies the line height of the text overlay. + * Accepts integer values representing line height in points. It can also accept [arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations) such as `bw_mul_0.2`, or `bh_div_20`. + */ + public function withLineHeight(float|string $lineHeight): self + { + $obj = clone $this; + $obj->lineHeight = $lineHeight; + + return $obj; + } + + /** + * Specifies the padding around the overlaid text. + * Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order). + * Arithmetic expressions are also accepted. + */ + public function withPadding(float|string $padding): self + { + $obj = clone $this; + $obj->padding = $padding; + + return $obj; + } + + /** + * Specifies the corner radius of the text overlay. + * Set to `max` to achieve a circular or oval shape. + */ + public function withRadius(float|string $radius): self + { + $obj = clone $this; + $obj->radius = $radius; + + return $obj; + } + + /** + * Specifies the rotation angle of the text overlay. + * Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation. + */ + public function withRotation(float|string $rotation): self + { + $obj = clone $this; + $obj->rotation = $rotation; + + return $obj; + } + + /** + * Specifies the typography style of the text. + * Supported values: + * - Single styles: `b` (bold), `i` (italic), `strikethrough`. + * - Combinations: Any combination separated by underscores, e.g., `b_i`, `b_i_strikethrough`. + */ + public function withTypography(string $typography): self + { + $obj = clone $this; + $obj->typography = $typography; + + return $obj; + } + + /** + * Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `background`. + * Learn about [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations). + */ + public function withWidth(float|string $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/TextOverlayTransformation/Flip.php b/src/TextOverlayTransformation/Flip.php new file mode 100644 index 00000000..f51373b3 --- /dev/null +++ b/src/TextOverlayTransformation/Flip.php @@ -0,0 +1,24 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/TextOverlayTransformation/InnerAlignment.php b/src/TextOverlayTransformation/InnerAlignment.php new file mode 100644 index 00000000..885e71a4 --- /dev/null +++ b/src/TextOverlayTransformation/InnerAlignment.php @@ -0,0 +1,22 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/TextOverlayTransformation/Padding.php b/src/TextOverlayTransformation/Padding.php new file mode 100644 index 00000000..bbe361d2 --- /dev/null +++ b/src/TextOverlayTransformation/Padding.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/TextOverlayTransformation/Radius.php b/src/TextOverlayTransformation/Radius.php new file mode 100644 index 00000000..51754284 --- /dev/null +++ b/src/TextOverlayTransformation/Radius.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', STAINLESS_FIXME_::class]; + } +} diff --git a/src/TextOverlayTransformation/Rotation.php b/src/TextOverlayTransformation/Rotation.php new file mode 100644 index 00000000..98d464fe --- /dev/null +++ b/src/TextOverlayTransformation/Rotation.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/TextOverlayTransformation/Width.php b/src/TextOverlayTransformation/Width.php new file mode 100644 index 00000000..ea42449f --- /dev/null +++ b/src/TextOverlayTransformation/Width.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation.php b/src/Transformation.php new file mode 100644 index 00000000..86d77e87 --- /dev/null +++ b/src/Transformation.php @@ -0,0 +1,1334 @@ +|null, + * trim?: bool|float|null, + * unsharpMask?: bool|string|null, + * videoCodec?: VideoCodec::*|null, + * width?: float|string|null, + * x?: float|string|null, + * xCenter?: float|string|null, + * y?: float|string|null, + * yCenter?: float|string|null, + * zoom?: float|null, + * } + */ +final class Transformation implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, + * e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. + * Not supported inside overlay. + * See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg). + */ + #[Api(optional: true)] + public ?string $aiChangeBackground; + + /** + * Adds an AI-based drop shadow around a foreground object on a transparent or removed background. + * Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). + * Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. + * Supported inside overlay. + * See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). + */ + #[Api(optional: true)] + public bool|string|null $aiDropShadow; + + /** + * Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, + * e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. + * Not supported inside overlay. + * See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit). + */ + #[Api(optional: true)] + public ?string $aiEdit; + + /** + * Applies ImageKit's in-house background removal. + * Supported inside overlay. + * See [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). + * + * @var AIRemoveBackground::*|null $aiRemoveBackground + */ + #[Api(enum: AIRemoveBackground::class, optional: true)] + public ?bool $aiRemoveBackground; + + /** + * Uses third-party background removal. + * Note: It is recommended to use aiRemoveBackground, ImageKit's in-house solution, which is more cost-effective. + * Supported inside overlay. + * See [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). + * + * @var AIRemoveBackgroundExternal::*|null $aiRemoveBackgroundExternal + */ + #[Api(enum: AIRemoveBackgroundExternal::class, optional: true)] + public ?bool $aiRemoveBackgroundExternal; + + /** + * Performs AI-based retouching to improve faces or product shots. Not supported inside overlay. + * See [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). + * + * @var AIRetouch::*|null $aiRetouch + */ + #[Api(enum: AIRetouch::class, optional: true)] + public ?bool $aiRetouch; + + /** + * Upscales images beyond their original dimensions using AI. Not supported inside overlay. + * See [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). + * + * @var AIUpscale::*|null $aiUpscale + */ + #[Api(enum: AIUpscale::class, optional: true)] + public ?bool $aiUpscale; + + /** + * Generates a variation of an image using AI. This produces a new image with slight variations from the original, + * such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay. + * See [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). + * + * @var AIVariation::*|null $aiVariation + */ + #[Api(enum: AIVariation::class, optional: true)] + public ?bool $aiVariation; + + /** + * Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). + * For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. + * See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar). + */ + #[Api(optional: true)] + public float|string|null $aspectRatio; + + /** + * Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). + * + * @var AudioCodec::*|null $audioCodec + */ + #[Api(enum: AudioCodec::class, optional: true)] + public ?string $audioCodec; + + /** + * Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. + * - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). + * - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). + * - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: + * `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill). + */ + #[Api(optional: true)] + public ?string $background; + + /** + * Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. + * See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl). + */ + #[Api(optional: true)] + public ?float $blur; + + /** + * Adds a border to the output media. Accepts a string in the format `_` + * (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. + * See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b). + */ + #[Api(optional: true)] + public ?string $border; + + /** + * Indicates whether the output image should retain the original color profile. + * See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). + */ + #[Api(optional: true)] + public ?bool $colorProfile; + + /** + * Automatically enhances the contrast of an image (contrast stretch). + * See [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). + * + * @var ContrastStretch::*|null $contrastStretch + */ + #[Api(enum: ContrastStretch::class, optional: true)] + public ?bool $contrastStretch; + + /** + * Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). + * + * @var Crop::*|null $crop + */ + #[Api(enum: Crop::class, optional: true)] + public ?string $crop; + + /** + * Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). + * + * @var CropMode::*|null $cropMode + */ + #[Api(enum: CropMode::class, optional: true)] + public ?string $cropMode; + + /** + * Specifies a fallback image if the resource is not found, e.g., a URL or file path. + * See [Default image](https://imagekit.io/docs/image-transformation#default-image---di). + */ + #[Api(optional: true)] + public ?string $defaultImage; + + /** + * Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. + * See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). + */ + #[Api(optional: true)] + public ?float $dpr; + + /** + * Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. + * See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). + */ + #[Api(optional: true)] + public float|string|null $duration; + + /** + * Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Typically used with startOffset to define a time window. Arithmetic expressions are supported. + * See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). + */ + #[Api(optional: true)] + public float|string|null $endOffset; + + /** + * Flips or mirrors an image either horizontally, vertically, or both. + * Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. + * See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). + * + * @var Flip::*|null $flip + */ + #[Api(enum: Flip::class, optional: true)] + public ?string $flip; + + /** + * Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. + * Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically + * keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— + * while resizing. + * - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). + * - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name). + */ + #[Api(optional: true)] + public ?string $focus; + + /** + * Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. + * You can also pass `orig` for images to return the original format. + * ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. + * See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f). + * + * @var Format::*|null $format + */ + #[Api(enum: Format::class, optional: true)] + public ?string $format; + + /** + * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. + * See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). + */ + #[Api(optional: true)] + public bool|string|null $gradient; + + /** + * Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). + * + * @var Grayscale::*|null $grayscale + */ + #[Api(enum: Grayscale::class, optional: true)] + public ?bool $grayscale; + + /** + * Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). + * You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). + * Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h). + */ + #[Api(optional: true)] + public float|string|null $height; + + /** + * Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. + * See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). + */ + #[Api(optional: true)] + public ?bool $lossless; + + /** + * By default, ImageKit removes all metadata during automatic image compression. + * Set this to true to preserve metadata. + * See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). + */ + #[Api(optional: true)] + public ?bool $metadata; + + /** + * Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations). + */ + #[Api(optional: true)] + public ?string $named; + + /** + * Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o). + */ + #[Api(optional: true)] + public ?float $opacity; + + /** + * If set to true, serves the original file without applying any transformations. + * See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true). + */ + #[Api(optional: true)] + public ?bool $original; + + /** + * Specifies an overlay to be applied on the parent image or video. + * ImageKit supports overlays including images, text, videos, subtitles, and solid colors. + * See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers). + */ + #[Api(union: Overlay::class, optional: true)] + public TextOverlay|ImageOverlay|VideoOverlay|SubtitleOverlay|SolidColorOverlay|null $overlay; + + /** + * Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). + * For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), + * or by name (e.g., `name-layer-4` for a PSD layer). + * See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files). + */ + #[Api(optional: true)] + public float|string|null $page; + + /** + * Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, + * pixelated version of the full image, which gradually improves to provide a faster perceived load time. + * See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). + */ + #[Api(optional: true)] + public ?bool $progressive; + + /** + * Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. + * A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. + * See [Quality](https://imagekit.io/docs/image-optimization#quality---q). + */ + #[Api(optional: true)] + public ?float $quality; + + /** + * Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular or oval shape. + * See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + */ + #[Api(optional: true)] + public float|string|null $radius; + + /** + * Pass any transformation not directly supported by the SDK. + * This transformation string is appended to the URL as provided. + */ + #[Api(optional: true)] + public ?string $raw; + + /** + * Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation + * or `auto` to use the orientation specified in the image's EXIF data. + * For videos, only the following values are supported: 0, 90, 180, 270, or 360. + * See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). + */ + #[Api(optional: true)] + public float|string|null $rotation; + + /** + * Adds a shadow beneath solid objects in an image with a transparent background. + * For AI-based drop shadows, refer to aiDropShadow. + * Pass `true` for a default shadow, or provide a string for a custom shadow. + * See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). + */ + #[Api(optional: true)] + public bool|string|null $shadow; + + /** + * Sharpens the input image, highlighting edges and finer details. + * Pass `true` for default sharpening, or provide a numeric value for custom sharpening. + * See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). + */ + #[Api(optional: true)] + public bool|float|null $sharpen; + + /** + * Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Arithmetic expressions are also supported. + * See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). + */ + #[Api(optional: true)] + public float|string|null $startOffset; + + /** + * An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. + * See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). + * + * @var list|null $streamingResolutions + */ + #[Api(list: StreamingResolution::class, optional: true)] + public ?array $streamingResolutions; + + /** + * Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, + * leaving only the central object in the output image. + * See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). + */ + #[Api(optional: true)] + public bool|float|null $trim; + + /** + * Applies Unsharp Masking (USM), an image sharpening technique. + * Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. + * See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm). + */ + #[Api(optional: true)] + public bool|string|null $unsharpMask; + + /** + * Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). + * + * @var VideoCodec::*|null $videoCodec + */ + #[Api(enum: VideoCodec::class, optional: true)] + public ?string $videoCodec; + + /** + * Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). + * You can also supply arithmetic expressions (e.g., `iw_div_2`). + * Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w). + */ + #[Api(optional: true)] + public float|string|null $width; + + /** + * Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + #[Api(optional: true)] + public float|string|null $x; + + /** + * Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + #[Api(optional: true)] + public float|string|null $xCenter; + + /** + * Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + #[Api(optional: true)] + public float|string|null $y; + + /** + * Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + #[Api(optional: true)] + public float|string|null $yCenter; + + /** + * Accepts a numeric value that determines how much to zoom in or out of the cropped area. + * It should be used in conjunction with fo-face or fo-. + * See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z). + */ + #[Api(optional: true)] + public ?float $zoom; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AIRemoveBackground::* $aiRemoveBackground + * @param AIRemoveBackgroundExternal::* $aiRemoveBackgroundExternal + * @param AIRetouch::* $aiRetouch + * @param AIUpscale::* $aiUpscale + * @param AIVariation::* $aiVariation + * @param AudioCodec::* $audioCodec + * @param ContrastStretch::* $contrastStretch + * @param Crop::* $crop + * @param CropMode::* $cropMode + * @param Flip::* $flip + * @param Format::* $format + * @param Grayscale::* $grayscale + * @param list $streamingResolutions + * @param VideoCodec::* $videoCodec + */ + public static function with( + ?string $aiChangeBackground = null, + bool|string|null $aiDropShadow = null, + ?string $aiEdit = null, + ?bool $aiRemoveBackground = null, + ?bool $aiRemoveBackgroundExternal = null, + ?bool $aiRetouch = null, + ?bool $aiUpscale = null, + ?bool $aiVariation = null, + float|string|null $aspectRatio = null, + ?string $audioCodec = null, + ?string $background = null, + ?float $blur = null, + ?string $border = null, + ?bool $colorProfile = null, + ?bool $contrastStretch = null, + ?string $crop = null, + ?string $cropMode = null, + ?string $defaultImage = null, + ?float $dpr = null, + float|string|null $duration = null, + float|string|null $endOffset = null, + ?string $flip = null, + ?string $focus = null, + ?string $format = null, + bool|string|null $gradient = null, + ?bool $grayscale = null, + float|string|null $height = null, + ?bool $lossless = null, + ?bool $metadata = null, + ?string $named = null, + ?float $opacity = null, + ?bool $original = null, + TextOverlay|ImageOverlay|VideoOverlay|SubtitleOverlay|SolidColorOverlay|null $overlay = null, + float|string|null $page = null, + ?bool $progressive = null, + ?float $quality = null, + float|string|null $radius = null, + ?string $raw = null, + float|string|null $rotation = null, + bool|string|null $shadow = null, + bool|float|null $sharpen = null, + float|string|null $startOffset = null, + ?array $streamingResolutions = null, + bool|float|null $trim = null, + bool|string|null $unsharpMask = null, + ?string $videoCodec = null, + float|string|null $width = null, + float|string|null $x = null, + float|string|null $xCenter = null, + float|string|null $y = null, + float|string|null $yCenter = null, + ?float $zoom = null, + ): self { + $obj = new self; + + null !== $aiChangeBackground && $obj->aiChangeBackground = $aiChangeBackground; + null !== $aiDropShadow && $obj->aiDropShadow = $aiDropShadow; + null !== $aiEdit && $obj->aiEdit = $aiEdit; + null !== $aiRemoveBackground && $obj->aiRemoveBackground = $aiRemoveBackground; + null !== $aiRemoveBackgroundExternal && $obj->aiRemoveBackgroundExternal = $aiRemoveBackgroundExternal; + null !== $aiRetouch && $obj->aiRetouch = $aiRetouch; + null !== $aiUpscale && $obj->aiUpscale = $aiUpscale; + null !== $aiVariation && $obj->aiVariation = $aiVariation; + null !== $aspectRatio && $obj->aspectRatio = $aspectRatio; + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $background && $obj->background = $background; + null !== $blur && $obj->blur = $blur; + null !== $border && $obj->border = $border; + null !== $colorProfile && $obj->colorProfile = $colorProfile; + null !== $contrastStretch && $obj->contrastStretch = $contrastStretch; + null !== $crop && $obj->crop = $crop; + null !== $cropMode && $obj->cropMode = $cropMode; + null !== $defaultImage && $obj->defaultImage = $defaultImage; + null !== $dpr && $obj->dpr = $dpr; + null !== $duration && $obj->duration = $duration; + null !== $endOffset && $obj->endOffset = $endOffset; + null !== $flip && $obj->flip = $flip; + null !== $focus && $obj->focus = $focus; + null !== $format && $obj->format = $format; + null !== $gradient && $obj->gradient = $gradient; + null !== $grayscale && $obj->grayscale = $grayscale; + null !== $height && $obj->height = $height; + null !== $lossless && $obj->lossless = $lossless; + null !== $metadata && $obj->metadata = $metadata; + null !== $named && $obj->named = $named; + null !== $opacity && $obj->opacity = $opacity; + null !== $original && $obj->original = $original; + null !== $overlay && $obj->overlay = $overlay; + null !== $page && $obj->page = $page; + null !== $progressive && $obj->progressive = $progressive; + null !== $quality && $obj->quality = $quality; + null !== $radius && $obj->radius = $radius; + null !== $raw && $obj->raw = $raw; + null !== $rotation && $obj->rotation = $rotation; + null !== $shadow && $obj->shadow = $shadow; + null !== $sharpen && $obj->sharpen = $sharpen; + null !== $startOffset && $obj->startOffset = $startOffset; + null !== $streamingResolutions && $obj->streamingResolutions = $streamingResolutions; + null !== $trim && $obj->trim = $trim; + null !== $unsharpMask && $obj->unsharpMask = $unsharpMask; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $width && $obj->width = $width; + null !== $x && $obj->x = $x; + null !== $xCenter && $obj->xCenter = $xCenter; + null !== $y && $obj->y = $y; + null !== $yCenter && $obj->yCenter = $yCenter; + null !== $zoom && $obj->zoom = $zoom; + + return $obj; + } + + /** + * Uses AI to change the background. Provide a text prompt or a base64-encoded prompt, + * e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. + * Not supported inside overlay. + * See [AI Change Background](https://imagekit.io/docs/ai-transformations#change-background-e-changebg). + */ + public function withAIChangeBackground(string $aiChangeBackground): self + { + $obj = clone $this; + $obj->aiChangeBackground = $aiChangeBackground; + + return $obj; + } + + /** + * Adds an AI-based drop shadow around a foreground object on a transparent or removed background. + * Optionally, control the direction, elevation, and saturation of the light source (e.g., `az-45` to change light direction). + * Pass `true` for the default drop shadow, or provide a string for a custom drop shadow. + * Supported inside overlay. + * See [AI Drop Shadow](https://imagekit.io/docs/ai-transformations#ai-drop-shadow-e-dropshadow). + */ + public function withAIDropShadow(bool|string $aiDropShadow): self + { + $obj = clone $this; + $obj->aiDropShadow = $aiDropShadow; + + return $obj; + } + + /** + * Uses AI to edit images based on a text prompt. Provide a text prompt or a base64-encoded prompt, + * e.g., `prompt-snow road` or `prompte-[urlencoded_base64_encoded_text]`. + * Not supported inside overlay. + * See [AI Edit](https://imagekit.io/docs/ai-transformations#edit-image-e-edit). + */ + public function withAIEdit(string $aiEdit): self + { + $obj = clone $this; + $obj->aiEdit = $aiEdit; + + return $obj; + } + + /** + * Applies ImageKit's in-house background removal. + * Supported inside overlay. + * See [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). + * + * @param AIRemoveBackground::* $aiRemoveBackground + */ + public function withAIRemoveBackground(bool $aiRemoveBackground): self + { + $obj = clone $this; + $obj->aiRemoveBackground = $aiRemoveBackground; + + return $obj; + } + + /** + * Uses third-party background removal. + * Note: It is recommended to use aiRemoveBackground, ImageKit's in-house solution, which is more cost-effective. + * Supported inside overlay. + * See [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). + * + * @param AIRemoveBackgroundExternal::* $aiRemoveBackgroundExternal + */ + public function withAIRemoveBackgroundExternal( + bool $aiRemoveBackgroundExternal + ): self { + $obj = clone $this; + $obj->aiRemoveBackgroundExternal = $aiRemoveBackgroundExternal; + + return $obj; + } + + /** + * Performs AI-based retouching to improve faces or product shots. Not supported inside overlay. + * See [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). + * + * @param AIRetouch::* $aiRetouch + */ + public function withAIRetouch(bool $aiRetouch): self + { + $obj = clone $this; + $obj->aiRetouch = $aiRetouch; + + return $obj; + } + + /** + * Upscales images beyond their original dimensions using AI. Not supported inside overlay. + * See [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). + * + * @param AIUpscale::* $aiUpscale + */ + public function withAIUpscale(bool $aiUpscale): self + { + $obj = clone $this; + $obj->aiUpscale = $aiUpscale; + + return $obj; + } + + /** + * Generates a variation of an image using AI. This produces a new image with slight variations from the original, + * such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay. + * See [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). + * + * @param AIVariation::* $aiVariation + */ + public function withAIVariation(bool $aiVariation): self + { + $obj = clone $this; + $obj->aiVariation = $aiVariation; + + return $obj; + } + + /** + * Specifies the aspect ratio for the output, e.g., "ar-4-3". Typically used with either width or height (but not both). + * For example: aspectRatio = `4:3`, `4_3`, or an expression like `iar_div_2`. + * See [Image resize and crop – Aspect ratio](https://imagekit.io/docs/image-resize-and-crop#aspect-ratio---ar). + */ + public function withAspectRatio(float|string $aspectRatio): self + { + $obj = clone $this; + $obj->aspectRatio = $aspectRatio; + + return $obj; + } + + /** + * Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). + * + * @param AudioCodec::* $audioCodec + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * Specifies the background to be used in conjunction with certain cropping strategies when resizing an image. + * - A solid color: e.g., `red`, `F3F3F3`, `AAFF0010`. See [Solid color background](https://imagekit.io/docs/effects-and-enhancements#solid-color-background). + * - A blurred background: e.g., `blurred`, `blurred_25_N15`, etc. See [Blurred background](https://imagekit.io/docs/effects-and-enhancements#blurred-background). + * - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt: + * `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`. See [Generative fill background](https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill). + */ + public function withBackground(string $background): self + { + $obj = clone $this; + $obj->background = $background; + + return $obj; + } + + /** + * Specifies the Gaussian blur level. Accepts an integer value between 1 and 100, or an expression like `bl-10`. + * See [Blur](https://imagekit.io/docs/effects-and-enhancements#blur---bl). + */ + public function withBlur(float $blur): self + { + $obj = clone $this; + $obj->blur = $blur; + + return $obj; + } + + /** + * Adds a border to the output media. Accepts a string in the format `_` + * (e.g., `5_FFF000` for a 5px yellow border), or an expression like `ih_div_20_FF00FF`. + * See [Border](https://imagekit.io/docs/effects-and-enhancements#border---b). + */ + public function withBorder(string $border): self + { + $obj = clone $this; + $obj->border = $border; + + return $obj; + } + + /** + * Indicates whether the output image should retain the original color profile. + * See [Color profile](https://imagekit.io/docs/image-optimization#color-profile---cp). + */ + public function withColorProfile(bool $colorProfile): self + { + $obj = clone $this; + $obj->colorProfile = $colorProfile; + + return $obj; + } + + /** + * Automatically enhances the contrast of an image (contrast stretch). + * See [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). + * + * @param ContrastStretch::* $contrastStretch + */ + public function withContrastStretch(bool $contrastStretch): self + { + $obj = clone $this; + $obj->contrastStretch = $contrastStretch; + + return $obj; + } + + /** + * Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). + * + * @param Crop::* $crop + */ + public function withCrop(string $crop): self + { + $obj = clone $this; + $obj->crop = $crop; + + return $obj; + } + + /** + * Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). + * + * @param CropMode::* $cropMode + */ + public function withCropMode(string $cropMode): self + { + $obj = clone $this; + $obj->cropMode = $cropMode; + + return $obj; + } + + /** + * Specifies a fallback image if the resource is not found, e.g., a URL or file path. + * See [Default image](https://imagekit.io/docs/image-transformation#default-image---di). + */ + public function withDefaultImage(string $defaultImage): self + { + $obj = clone $this; + $obj->defaultImage = $defaultImage; + + return $obj; + } + + /** + * Accepts values between 0.1 and 5, or `auto` for automatic device pixel ratio (DPR) calculation. + * See [DPR](https://imagekit.io/docs/image-resize-and-crop#dpr---dpr). + */ + public function withDpr(float $dpr): self + { + $obj = clone $this; + $obj->dpr = $dpr; + + return $obj; + } + + /** + * Specifies the duration (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Typically used with startOffset to indicate the length from the start offset. Arithmetic expressions are supported. + * See [Trim videos – Duration](https://imagekit.io/docs/trim-videos#duration---du). + */ + public function withDuration(float|string $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Specifies the end offset (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Typically used with startOffset to define a time window. Arithmetic expressions are supported. + * See [Trim videos – End offset](https://imagekit.io/docs/trim-videos#end-offset---eo). + */ + public function withEndOffset(float|string $endOffset): self + { + $obj = clone $this; + $obj->endOffset = $endOffset; + + return $obj; + } + + /** + * Flips or mirrors an image either horizontally, vertically, or both. + * Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. + * See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). + * + * @param Flip::* $flip + */ + public function withFlip(string $flip): self + { + $obj = clone $this; + $obj->flip = $flip; + + return $obj; + } + + /** + * Refines padding and cropping behavior for pad resize, maintain ratio, and extract crop modes. + * Supports manual positions and coordinate-based focus. With AI-based cropping, you can automatically + * keep key subjects in frame—such as faces or detected objects (e.g., `fo-face`, `fo-person`, `fo-car`)— + * while resizing. + * - See [Focus](https://imagekit.io/docs/image-resize-and-crop#focus---fo). + * - [Object aware cropping](https://imagekit.io/docs/image-resize-and-crop#object-aware-cropping---fo-object-name). + */ + public function withFocus(string $focus): self + { + $obj = clone $this; + $obj->focus = $focus; + + return $obj; + } + + /** + * Specifies the output format for images or videos, e.g., `jpg`, `png`, `webp`, `mp4`, or `auto`. + * You can also pass `orig` for images to return the original format. + * ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. + * See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f). + * + * @param Format::* $format + */ + public function withFormat(string $format): self + { + $obj = clone $this; + $obj->format = $format; + + return $obj; + } + + /** + * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. + * See [Gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). + */ + public function withGradient(bool|string $gradient): self + { + $obj = clone $this; + $obj->gradient = $gradient; + + return $obj; + } + + /** + * Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). + * + * @param Grayscale::* $grayscale + */ + public function withGrayscale(bool $grayscale): self + { + $obj = clone $this; + $obj->grayscale = $grayscale; + + return $obj; + } + + /** + * Specifies the height of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.5` represents 50% of the original height). + * You can also supply arithmetic expressions (e.g., `ih_mul_0.5`). + * Height transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#height---h) · [Videos](https://imagekit.io/docs/video-resize-and-crop#height---h). + */ + public function withHeight(float|string $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Specifies whether the output image (in JPEG or PNG) should be compressed losslessly. + * See [Lossless compression](https://imagekit.io/docs/image-optimization#lossless-webp-and-png---lo). + */ + public function withLossless(bool $lossless): self + { + $obj = clone $this; + $obj->lossless = $lossless; + + return $obj; + } + + /** + * By default, ImageKit removes all metadata during automatic image compression. + * Set this to true to preserve metadata. + * See [Image metadata](https://imagekit.io/docs/image-optimization#image-metadata---md). + */ + public function withMetadata(bool $metadata): self + { + $obj = clone $this; + $obj->metadata = $metadata; + + return $obj; + } + + /** + * Named transformation reference. See [Named transformations](https://imagekit.io/docs/transformations#named-transformations). + */ + public function withNamed(string $named): self + { + $obj = clone $this; + $obj->named = $named; + + return $obj; + } + + /** + * Specifies the opacity level of the output image. See [Opacity](https://imagekit.io/docs/effects-and-enhancements#opacity---o). + */ + public function withOpacity(float $opacity): self + { + $obj = clone $this; + $obj->opacity = $opacity; + + return $obj; + } + + /** + * If set to true, serves the original file without applying any transformations. + * See [Deliver original file as-is](https://imagekit.io/docs/core-delivery-features#deliver-original-file-as-is---orig-true). + */ + public function withOriginal(bool $original): self + { + $obj = clone $this; + $obj->original = $original; + + return $obj; + } + + /** + * Specifies an overlay to be applied on the parent image or video. + * ImageKit supports overlays including images, text, videos, subtitles, and solid colors. + * See [Overlay using layers](https://imagekit.io/docs/transformations#overlay-using-layers). + */ + public function withOverlay( + TextOverlay|ImageOverlay|VideoOverlay|SubtitleOverlay|SolidColorOverlay $overlay, + ): self { + $obj = clone $this; + $obj->overlay = $overlay; + + return $obj; + } + + /** + * Extracts a specific page or frame from multi-page or layered files (PDF, PSD, AI). + * For example, specify by number (e.g., `2`), a range (e.g., `3-4` for the 2nd and 3rd layers), + * or by name (e.g., `name-layer-4` for a PSD layer). + * See [Thumbnail extraction](https://imagekit.io/docs/vector-and-animated-images#get-thumbnail-from-psd-pdf-ai-eps-and-animated-files). + */ + public function withPage(float|string $page): self + { + $obj = clone $this; + $obj->page = $page; + + return $obj; + } + + /** + * Specifies whether the output JPEG image should be rendered progressively. Progressive loading begins with a low-quality, + * pixelated version of the full image, which gradually improves to provide a faster perceived load time. + * See [Progressive images](https://imagekit.io/docs/image-optimization#progressive-image---pr). + */ + public function withProgressive(bool $progressive): self + { + $obj = clone $this; + $obj->progressive = $progressive; + + return $obj; + } + + /** + * Specifies the quality of the output image for lossy formats such as JPEG, WebP, and AVIF. + * A higher quality value results in a larger file size with better quality, while a lower value produces a smaller file size with reduced quality. + * See [Quality](https://imagekit.io/docs/image-optimization#quality---q). + */ + public function withQuality(float $quality): self + { + $obj = clone $this; + $obj->quality = $quality; + + return $obj; + } + + /** + * Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular or oval shape. + * See [Radius](https://imagekit.io/docs/effects-and-enhancements#radius---r). + */ + public function withRadius(float|string $radius): self + { + $obj = clone $this; + $obj->radius = $radius; + + return $obj; + } + + /** + * Pass any transformation not directly supported by the SDK. + * This transformation string is appended to the URL as provided. + */ + public function withRaw(string $raw): self + { + $obj = clone $this; + $obj->raw = $raw; + + return $obj; + } + + /** + * Specifies the rotation angle in degrees. Positive values rotate the image clockwise; you can also use, for example, `N40` for counterclockwise rotation + * or `auto` to use the orientation specified in the image's EXIF data. + * For videos, only the following values are supported: 0, 90, 180, 270, or 360. + * See [Rotate](https://imagekit.io/docs/effects-and-enhancements#rotate---rt). + */ + public function withRotation(float|string $rotation): self + { + $obj = clone $this; + $obj->rotation = $rotation; + + return $obj; + } + + /** + * Adds a shadow beneath solid objects in an image with a transparent background. + * For AI-based drop shadows, refer to aiDropShadow. + * Pass `true` for a default shadow, or provide a string for a custom shadow. + * See [Shadow](https://imagekit.io/docs/effects-and-enhancements#shadow---e-shadow). + */ + public function withShadow(bool|string $shadow): self + { + $obj = clone $this; + $obj->shadow = $shadow; + + return $obj; + } + + /** + * Sharpens the input image, highlighting edges and finer details. + * Pass `true` for default sharpening, or provide a numeric value for custom sharpening. + * See [Sharpen](https://imagekit.io/docs/effects-and-enhancements#sharpen---e-sharpen). + */ + public function withSharpen(bool|float $sharpen): self + { + $obj = clone $this; + $obj->sharpen = $sharpen; + + return $obj; + } + + /** + * Specifies the start offset (in seconds) for trimming videos, e.g., `5` or `10.5`. + * Arithmetic expressions are also supported. + * See [Trim videos – Start offset](https://imagekit.io/docs/trim-videos#start-offset---so). + */ + public function withStartOffset(float|string $startOffset): self + { + $obj = clone $this; + $obj->startOffset = $startOffset; + + return $obj; + } + + /** + * An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. + * See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). + * + * @param list $streamingResolutions + */ + public function withStreamingResolutions(array $streamingResolutions): self + { + $obj = clone $this; + $obj->streamingResolutions = $streamingResolutions; + + return $obj; + } + + /** + * Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, + * leaving only the central object in the output image. + * See [Trim edges](https://imagekit.io/docs/effects-and-enhancements#trim-edges---t). + */ + public function withTrim(bool|float $trim): self + { + $obj = clone $this; + $obj->trim = $trim; + + return $obj; + } + + /** + * Applies Unsharp Masking (USM), an image sharpening technique. + * Pass `true` for a default unsharp mask, or provide a string for a custom unsharp mask. + * See [Unsharp Mask](https://imagekit.io/docs/effects-and-enhancements#unsharp-mask---e-usm). + */ + public function withUnsharpMask(bool|string $unsharpMask): self + { + $obj = clone $this; + $obj->unsharpMask = $unsharpMask; + + return $obj; + } + + /** + * Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). + * + * @param VideoCodec::* $videoCodec + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Specifies the width of the output. If a value between 0 and 1 is provided, it is treated as a percentage (e.g., `0.4` represents 40% of the original width). + * You can also supply arithmetic expressions (e.g., `iw_div_2`). + * Width transformation – [Images](https://imagekit.io/docs/image-resize-and-crop#width---w) · [Videos](https://imagekit.io/docs/video-resize-and-crop#width---w). + */ + public function withWidth(float|string $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } + + /** + * Focus using cropped image coordinates - X coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + public function withX(float|string $x): self + { + $obj = clone $this; + $obj->x = $x; + + return $obj; + } + + /** + * Focus using cropped image coordinates - X center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + public function withXCenter(float|string $xCenter): self + { + $obj = clone $this; + $obj->xCenter = $xCenter; + + return $obj; + } + + /** + * Focus using cropped image coordinates - Y coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + public function withY(float|string $y): self + { + $obj = clone $this; + $obj->y = $y; + + return $obj; + } + + /** + * Focus using cropped image coordinates - Y center coordinate. See [Focus using cropped coordinates](https://imagekit.io/docs/image-resize-and-crop#example---focus-using-cropped-image-coordinates). + */ + public function withYCenter(float|string $yCenter): self + { + $obj = clone $this; + $obj->yCenter = $yCenter; + + return $obj; + } + + /** + * Accepts a numeric value that determines how much to zoom in or out of the cropped area. + * It should be used in conjunction with fo-face or fo-. + * See [Zoom](https://imagekit.io/docs/image-resize-and-crop#zoom---z). + */ + public function withZoom(float $zoom): self + { + $obj = clone $this; + $obj->zoom = $zoom; + + return $obj; + } +} diff --git a/src/Transformation/AIDropShadow.php b/src/Transformation/AIDropShadow.php new file mode 100644 index 00000000..0956b9dc --- /dev/null +++ b/src/Transformation/AIDropShadow.php @@ -0,0 +1,30 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'string']; + } +} diff --git a/src/Transformation/AIRemoveBackground.php b/src/Transformation/AIRemoveBackground.php new file mode 100644 index 00000000..d5375dd4 --- /dev/null +++ b/src/Transformation/AIRemoveBackground.php @@ -0,0 +1,20 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/AudioCodec.php b/src/Transformation/AudioCodec.php new file mode 100644 index 00000000..36649c03 --- /dev/null +++ b/src/Transformation/AudioCodec.php @@ -0,0 +1,22 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/EndOffset.php b/src/Transformation/EndOffset.php new file mode 100644 index 00000000..812867ba --- /dev/null +++ b/src/Transformation/EndOffset.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Flip.php b/src/Transformation/Flip.php new file mode 100644 index 00000000..8aa3c49c --- /dev/null +++ b/src/Transformation/Flip.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'string']; + } +} diff --git a/src/Transformation/Grayscale.php b/src/Transformation/Grayscale.php new file mode 100644 index 00000000..322a1e50 --- /dev/null +++ b/src/Transformation/Grayscale.php @@ -0,0 +1,18 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Page.php b/src/Transformation/Page.php new file mode 100644 index 00000000..71856748 --- /dev/null +++ b/src/Transformation/Page.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Radius.php b/src/Transformation/Radius.php new file mode 100644 index 00000000..e0db8a3c --- /dev/null +++ b/src/Transformation/Radius.php @@ -0,0 +1,27 @@ +|array + */ + public static function variants(): array + { + return ['float', STAINLESS_FIXME_::class]; + } +} diff --git a/src/Transformation/Rotation.php b/src/Transformation/Rotation.php new file mode 100644 index 00000000..3131b9ad --- /dev/null +++ b/src/Transformation/Rotation.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Shadow.php b/src/Transformation/Shadow.php new file mode 100644 index 00000000..be32ac24 --- /dev/null +++ b/src/Transformation/Shadow.php @@ -0,0 +1,29 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'string']; + } +} diff --git a/src/Transformation/Sharpen.php b/src/Transformation/Sharpen.php new file mode 100644 index 00000000..760f37d1 --- /dev/null +++ b/src/Transformation/Sharpen.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'float']; + } +} diff --git a/src/Transformation/StartOffset.php b/src/Transformation/StartOffset.php new file mode 100644 index 00000000..654c0e6f --- /dev/null +++ b/src/Transformation/StartOffset.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Trim.php b/src/Transformation/Trim.php new file mode 100644 index 00000000..650352e3 --- /dev/null +++ b/src/Transformation/Trim.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'float']; + } +} diff --git a/src/Transformation/UnsharpMask.php b/src/Transformation/UnsharpMask.php new file mode 100644 index 00000000..5bd59aef --- /dev/null +++ b/src/Transformation/UnsharpMask.php @@ -0,0 +1,28 @@ +|array + */ + public static function variants(): array + { + return [STAINLESS_FIXME_::class, 'string']; + } +} diff --git a/src/Transformation/VideoCodec.php b/src/Transformation/VideoCodec.php new file mode 100644 index 00000000..36b0a0f9 --- /dev/null +++ b/src/Transformation/VideoCodec.php @@ -0,0 +1,24 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/X.php b/src/Transformation/X.php new file mode 100644 index 00000000..0a5acbc2 --- /dev/null +++ b/src/Transformation/X.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/XCenter.php b/src/Transformation/XCenter.php new file mode 100644 index 00000000..91b329dc --- /dev/null +++ b/src/Transformation/XCenter.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/Y.php b/src/Transformation/Y.php new file mode 100644 index 00000000..5338015b --- /dev/null +++ b/src/Transformation/Y.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/Transformation/YCenter.php b/src/Transformation/YCenter.php new file mode 100644 index 00000000..2520968d --- /dev/null +++ b/src/Transformation/YCenter.php @@ -0,0 +1,26 @@ +|array + */ + public static function variants(): array + { + return ['float', 'string']; + } +} diff --git a/src/TransformationPosition.php b/src/TransformationPosition.php new file mode 100644 index 00000000..ca606f89 --- /dev/null +++ b/src/TransformationPosition.php @@ -0,0 +1,22 @@ +|null, + * } + */ +final class VideoOverlay implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + #[Api] + public string $type = 'video'; + + /** + * Specifies the relative path to the video used as an overlay. + */ + #[Api] + public string $input; + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @var Encoding::*|null $encoding + */ + #[Api(enum: Encoding::class, optional: true)] + public ?string $encoding; + + /** + * Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. + * See [Video transformations](https://imagekit.io/docs/video-transformation). + * + * @var list|null $transformation + */ + #[Api(list: Transformation::class, optional: true)] + public ?array $transformation; + + /** + * `new VideoOverlay()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VideoOverlay::with(input: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VideoOverlay)->withInput(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Encoding::* $encoding + * @param list $transformation + */ + public static function with( + string $input, + ?string $encoding = null, + ?array $transformation = null + ): self { + $obj = new self; + + $obj->input = $input; + + null !== $encoding && $obj->encoding = $encoding; + null !== $transformation && $obj->transformation = $transformation; + + return $obj; + } + + /** + * Specifies the relative path to the video used as an overlay. + */ + public function withInput(string $input): self + { + $obj = clone $this; + $obj->input = $input; + + return $obj; + } + + /** + * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. + * By default, the SDK determines the appropriate format automatically. + * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. + * To always use plain text (`i-{input}`), set it to `plain`. + * + * @param Encoding::* $encoding + */ + public function withEncoding(string $encoding): self + { + $obj = clone $this; + $obj->encoding = $encoding; + + return $obj; + } + + /** + * Array of transformation to be applied to the overlay video. Except `streamingResolutions`, all other video transformations are supported. + * See [Video transformations](https://imagekit.io/docs/video-transformation). + * + * @param list $transformation + */ + public function withTransformation(array $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/VideoOverlay/Encoding.php b/src/VideoOverlay/Encoding.php new file mode 100644 index 00000000..1a789570 --- /dev/null +++ b/src/VideoOverlay/Encoding.php @@ -0,0 +1,25 @@ +|array + */ + public static function variants(): array + { + return [ + VideoTransformationAcceptedEvent::class, + VideoTransformationReadyEvent::class, + VideoTransformationErrorEvent::class, + UploadPreTransformSuccessEvent::class, + UploadPreTransformErrorEvent::class, + UploadPostTransformSuccessEvent::class, + UploadPostTransformErrorEvent::class, + ]; + } +} diff --git a/src/Webhooks/UnwrapWebhookEvent.php b/src/Webhooks/UnwrapWebhookEvent.php new file mode 100644 index 00000000..98b83129 --- /dev/null +++ b/src/Webhooks/UnwrapWebhookEvent.php @@ -0,0 +1,34 @@ +|array + */ + public static function variants(): array + { + return [ + VideoTransformationAcceptedEvent::class, + VideoTransformationReadyEvent::class, + VideoTransformationErrorEvent::class, + UploadPreTransformSuccessEvent::class, + UploadPreTransformErrorEvent::class, + UploadPostTransformSuccessEvent::class, + UploadPostTransformErrorEvent::class, + ]; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent.php b/src/Webhooks/UploadPostTransformErrorEvent.php new file mode 100644 index 00000000..840b2dd5 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent.php @@ -0,0 +1,133 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'upload.post-transform.error'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + #[Api] + public Request $request; + + /** + * `new UploadPostTransformErrorEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * UploadPostTransformErrorEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new UploadPostTransformErrorEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Data.php b/src/Webhooks/UploadPostTransformErrorEvent/Data.php new file mode 100644 index 00000000..8c1dc160 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Data.php @@ -0,0 +1,151 @@ + */ + use SdkModel; + + /** + * Unique identifier of the originally uploaded file. + */ + #[Api('fileId')] + public string $fileID; + + /** + * Name of the file. + */ + #[Api] + public string $name; + + /** + * Path of the file. + */ + #[Api] + public string $path; + + #[Api] + public Transformation $transformation; + + /** + * URL of the attempted post-transformation. + */ + #[Api] + public string $url; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(fileID: ..., name: ..., path: ..., transformation: ..., url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data) + * ->withFileID(...) + * ->withName(...) + * ->withPath(...) + * ->withTransformation(...) + * ->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $fileID, + string $name, + string $path, + Transformation $transformation, + string $url, + ): self { + $obj = new self; + + $obj->fileID = $fileID; + $obj->name = $name; + $obj->path = $path; + $obj->transformation = $transformation; + $obj->url = $url; + + return $obj; + } + + /** + * Unique identifier of the originally uploaded file. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * Name of the file. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Path of the file. + */ + public function withPath(string $path): self + { + $obj = clone $this; + $obj->path = $path; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * URL of the attempted post-transformation. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation.php b/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation.php new file mode 100644 index 00000000..7c789a94 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation.php @@ -0,0 +1,63 @@ + */ + use SdkModel; + + #[Api] + public Error $error; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(error: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withError(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(Error $error): self + { + $obj = new self; + + $obj->error = $error; + + return $obj; + } + + public function withError(Error $error): self + { + $obj = clone $this; + $obj->error = $error; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation/Error.php b/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation/Error.php new file mode 100644 index 00000000..513fbcb2 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Data/Transformation/Error.php @@ -0,0 +1,68 @@ + */ + use SdkModel; + + /** + * Reason for the post-transformation failure. + */ + #[Api] + public string $reason; + + /** + * `new Error()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Error::with(reason: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Error)->withReason(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $reason): self + { + $obj = new self; + + $obj->reason = $reason; + + return $obj; + } + + /** + * Reason for the post-transformation failure. + */ + public function withReason(string $reason): self + { + $obj = clone $this; + $obj->reason = $reason; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request.php b/src/Webhooks/UploadPostTransformErrorEvent/Request.php new file mode 100644 index 00000000..77b43cf4 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request.php @@ -0,0 +1,85 @@ + */ + use SdkModel; + + #[Api] + public Transformation $transformation; + + /** + * Unique identifier for the originating request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(transformation: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withTransformation(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + Transformation $transformation, + string $xRequestID + ): self { + $obj = new self; + + $obj->transformation = $transformation; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Unique identifier for the originating request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php new file mode 100644 index 00000000..d527b693 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php @@ -0,0 +1,123 @@ + */ + use SdkModel; + + /** + * Type of the requested post-transformation. + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * Only applicable if transformation type is 'abs'. Streaming protocol used. + * + * @var Protocol::*|null $protocol + */ + #[Api(enum: Protocol::class, optional: true)] + public ?string $protocol; + + /** + * Value for the requested transformation type. + */ + #[Api(optional: true)] + public ?string $value; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + * @param Protocol::* $protocol + */ + public static function with( + string $type, + ?string $protocol = null, + ?string $value = null + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $protocol && $obj->protocol = $protocol; + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Type of the requested post-transformation. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Only applicable if transformation type is 'abs'. Streaming protocol used. + * + * @param Protocol::* $protocol + */ + public function withProtocol(string $protocol): self + { + $obj = clone $this; + $obj->protocol = $protocol; + + return $obj; + } + + /** + * Value for the requested transformation type. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php new file mode 100644 index 00000000..d33fb754 --- /dev/null +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'upload.post-transform.success'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + #[Api] + public Request $request; + + /** + * `new UploadPostTransformSuccessEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * UploadPostTransformSuccessEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new UploadPostTransformSuccessEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Data.php b/src/Webhooks/UploadPostTransformSuccessEvent/Data.php new file mode 100644 index 00000000..6b68558c --- /dev/null +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Data.php @@ -0,0 +1,104 @@ + */ + use SdkModel; + + /** + * Unique identifier of the originally uploaded file. + */ + #[Api('fileId')] + public string $fileID; + + /** + * Name of the file. + */ + #[Api] + public string $name; + + /** + * URL of the generated post-transformation. + */ + #[Api] + public string $url; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(fileID: ..., name: ..., url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data)->withFileID(...)->withName(...)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $fileID, string $name, string $url): self + { + $obj = new self; + + $obj->fileID = $fileID; + $obj->name = $name; + $obj->url = $url; + + return $obj; + } + + /** + * Unique identifier of the originally uploaded file. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * Name of the file. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * URL of the generated post-transformation. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request.php new file mode 100644 index 00000000..be526a86 --- /dev/null +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request.php @@ -0,0 +1,85 @@ + */ + use SdkModel; + + #[Api] + public Transformation $transformation; + + /** + * Unique identifier for the originating request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(transformation: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withTransformation(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + Transformation $transformation, + string $xRequestID + ): self { + $obj = new self; + + $obj->transformation = $transformation; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Unique identifier for the originating request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php new file mode 100644 index 00000000..ce16b5b9 --- /dev/null +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php @@ -0,0 +1,123 @@ + */ + use SdkModel; + + /** + * Type of the requested post-transformation. + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * Only applicable if transformation type is 'abs'. Streaming protocol used. + * + * @var Protocol::*|null $protocol + */ + #[Api(enum: Protocol::class, optional: true)] + public ?string $protocol; + + /** + * Value for the requested transformation type. + */ + #[Api(optional: true)] + public ?string $value; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + * @param Protocol::* $protocol + */ + public static function with( + string $type, + ?string $protocol = null, + ?string $value = null + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $protocol && $obj->protocol = $protocol; + null !== $value && $obj->value = $value; + + return $obj; + } + + /** + * Type of the requested post-transformation. + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Only applicable if transformation type is 'abs'. Streaming protocol used. + * + * @param Protocol::* $protocol + */ + public function withProtocol(string $protocol): self + { + $obj = clone $this; + $obj->protocol = $protocol; + + return $obj; + } + + /** + * Value for the requested transformation type. + */ + public function withValue(string $value): self + { + $obj = clone $this; + $obj->value = $value; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php new file mode 100644 index 00000000..35a3c151 --- /dev/null +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'upload.pre-transform.error'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + #[Api] + public Request $request; + + /** + * `new UploadPreTransformErrorEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * UploadPreTransformErrorEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new UploadPreTransformErrorEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformErrorEvent/Data.php b/src/Webhooks/UploadPreTransformErrorEvent/Data.php new file mode 100644 index 00000000..b502228e --- /dev/null +++ b/src/Webhooks/UploadPreTransformErrorEvent/Data.php @@ -0,0 +1,104 @@ + */ + use SdkModel; + + /** + * Name of the file. + */ + #[Api] + public string $name; + + /** + * Path of the file. + */ + #[Api] + public string $path; + + #[Api] + public Transformation $transformation; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(name: ..., path: ..., transformation: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data)->withName(...)->withPath(...)->withTransformation(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $name, + string $path, + Transformation $transformation + ): self { + $obj = new self; + + $obj->name = $name; + $obj->path = $path; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Name of the file. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Path of the file. + */ + public function withPath(string $path): self + { + $obj = clone $this; + $obj->path = $path; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation.php b/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation.php new file mode 100644 index 00000000..58bcc84a --- /dev/null +++ b/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation.php @@ -0,0 +1,63 @@ + */ + use SdkModel; + + #[Api] + public Error $error; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(error: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withError(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(Error $error): self + { + $obj = new self; + + $obj->error = $error; + + return $obj; + } + + public function withError(Error $error): self + { + $obj = clone $this; + $obj->error = $error; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation/Error.php b/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation/Error.php new file mode 100644 index 00000000..cd34d2a7 --- /dev/null +++ b/src/Webhooks/UploadPreTransformErrorEvent/Data/Transformation/Error.php @@ -0,0 +1,68 @@ + */ + use SdkModel; + + /** + * Reason for the pre-transformation failure. + */ + #[Api] + public string $reason; + + /** + * `new Error()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Error::with(reason: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Error)->withReason(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $reason): self + { + $obj = new self; + + $obj->reason = $reason; + + return $obj; + } + + /** + * Reason for the pre-transformation failure. + */ + public function withReason(string $reason): self + { + $obj = clone $this; + $obj->reason = $reason; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformErrorEvent/Request.php b/src/Webhooks/UploadPreTransformErrorEvent/Request.php new file mode 100644 index 00000000..30288322 --- /dev/null +++ b/src/Webhooks/UploadPreTransformErrorEvent/Request.php @@ -0,0 +1,88 @@ + */ + use SdkModel; + + /** + * The requested pre-transformation string. + */ + #[Api] + public string $transformation; + + /** + * Unique identifier for the originating request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(transformation: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withTransformation(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $transformation, + string $xRequestID + ): self { + $obj = new self; + + $obj->transformation = $transformation; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + /** + * The requested pre-transformation string. + */ + public function withTransformation(string $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Unique identifier for the originating request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent.php b/src/Webhooks/UploadPreTransformSuccessEvent.php new file mode 100644 index 00000000..77f3a5ce --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent.php @@ -0,0 +1,139 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'upload.pre-transform.success'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + /** + * Object containing details of a successful upload. + */ + #[Api] + public Data $data; + + #[Api] + public Request $request; + + /** + * `new UploadPreTransformSuccessEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * UploadPreTransformSuccessEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new UploadPreTransformSuccessEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp of when the event occurred in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + /** + * Object containing details of a successful upload. + */ + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data.php new file mode 100644 index 00000000..e4553404 --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data.php @@ -0,0 +1,556 @@ +|null, + * audioCodec?: string|null, + * bitRate?: int|null, + * customCoordinates?: string|null, + * customMetadata?: array|null, + * description?: string|null, + * duration?: int|null, + * embeddedMetadata?: array|null, + * extensionStatus?: ExtensionStatus|null, + * fileID?: string|null, + * filePath?: string|null, + * fileType?: string|null, + * height?: float|null, + * isPrivateFile?: bool|null, + * isPublished?: bool|null, + * metadata?: Metadata|null, + * name?: string|null, + * size?: float|null, + * tags?: list|null, + * thumbnailURL?: string|null, + * url?: string|null, + * versionInfo?: VersionInfo|null, + * videoCodec?: string|null, + * width?: float|null, + * } + */ +final class Data implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @var list|null $aiTags + */ + #[Api('AITags', list: AITag::class, nullable: true, optional: true)] + public ?array $aiTags; + + /** + * The audio codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $audioCodec; + + /** + * The bit rate of the video in kbps (only for video). + */ + #[Api(optional: true)] + public ?int $bitRate; + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * The duration of the video in seconds (only for video). + */ + #[Api(optional: true)] + public ?int $duration; + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @var array|null $embeddedMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $embeddedMetadata; + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + #[Api(optional: true)] + public ?ExtensionStatus $extensionStatus; + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + #[Api('fileId', optional: true)] + public ?string $fileID; + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + #[Api(optional: true)] + public ?string $filePath; + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + #[Api(optional: true)] + public ?string $fileType; + + /** + * Height of the image in pixels (Only for images). + */ + #[Api(optional: true)] + public ?float $height; + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + #[Api(optional: true)] + public ?Metadata $metadata; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Size of the image file in Bytes. + */ + #[Api(optional: true)] + public ?float $size; + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * In the case of an image, a small thumbnail URL. + */ + #[Api('thumbnailUrl', optional: true)] + public ?string $thumbnailURL; + + /** + * A publicly accessible URL of the file. + */ + #[Api(optional: true)] + public ?string $url; + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + #[Api(optional: true)] + public ?VersionInfo $versionInfo; + + /** + * The video codec used in the video (only for video). + */ + #[Api(optional: true)] + public ?string $videoCodec; + + /** + * Width of the image in pixels (Only for Images). + */ + #[Api(optional: true)] + public ?float $width; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $aiTags + * @param array $customMetadata + * @param array $embeddedMetadata + * @param list|null $tags + */ + public static function with( + ?array $aiTags = null, + ?string $audioCodec = null, + ?int $bitRate = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?int $duration = null, + ?array $embeddedMetadata = null, + ?ExtensionStatus $extensionStatus = null, + ?string $fileID = null, + ?string $filePath = null, + ?string $fileType = null, + ?float $height = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?Metadata $metadata = null, + ?string $name = null, + ?float $size = null, + ?array $tags = null, + ?string $thumbnailURL = null, + ?string $url = null, + ?VersionInfo $versionInfo = null, + ?string $videoCodec = null, + ?float $width = null, + ): self { + $obj = new self; + + null !== $aiTags && $obj->aiTags = $aiTags; + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $bitRate && $obj->bitRate = $bitRate; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $duration && $obj->duration = $duration; + null !== $embeddedMetadata && $obj->embeddedMetadata = $embeddedMetadata; + null !== $extensionStatus && $obj->extensionStatus = $extensionStatus; + null !== $fileID && $obj->fileID = $fileID; + null !== $filePath && $obj->filePath = $filePath; + null !== $fileType && $obj->fileType = $fileType; + null !== $height && $obj->height = $height; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $metadata && $obj->metadata = $metadata; + null !== $name && $obj->name = $name; + null !== $size && $obj->size = $size; + null !== $tags && $obj->tags = $tags; + null !== $thumbnailURL && $obj->thumbnailURL = $thumbnailURL; + null !== $url && $obj->url = $url; + null !== $versionInfo && $obj->versionInfo = $versionInfo; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $width && $obj->width = $width; + + return $obj; + } + + /** + * An array of tags assigned to the uploaded file by auto tagging. + * + * @param list|null $aiTags + */ + public function withAITags(?array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * The audio codec used in the video (only for video). + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * The bit rate of the video in kbps (only for video). + */ + public function withBitRate(int $bitRate): self + { + $obj = clone $this; + $obj->bitRate = $bitRate; + + return $obj; + } + + /** + * Value of custom coordinates associated with the image in the format `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`. Send `customCoordinates` in `responseFields` in API request to get the value of this field. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data associated with the asset. Use `responseField` in API request to get `customMetadata` in the upload API response. Before setting any custom metadata on an asset, you have to create the field using custom metadata fields API. Send `customMetadata` in `responseFields` in API request to get the value of this field. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * The duration of the video in seconds (only for video). + */ + public function withDuration(int $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Consolidated embedded metadata associated with the file. It includes exif, iptc, and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get embeddedMetadata in the upload API response. + * + * @param array $embeddedMetadata + */ + public function withEmbeddedMetadata(array $embeddedMetadata): self + { + $obj = clone $this; + $obj->embeddedMetadata = $embeddedMetadata; + + return $obj; + } + + /** + * Extension names with their processing status at the time of completion of the request. It could have one of the following status values: + * + * `success`: The extension has been successfully applied. + * `failed`: The extension has failed and will not be retried. + * `pending`: The extension will finish processing in some time. On completion, the final status (success / failed) will be sent to the `webhookUrl` provided. + * + * If no extension was requested, then this parameter is not returned. + */ + public function withExtensionStatus(ExtensionStatus $extensionStatus): self + { + $obj = clone $this; + $obj->extensionStatus = $extensionStatus; + + return $obj; + } + + /** + * Unique fileId. Store this fileld in your database, as this will be used to perform update action on this file. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * The relative path of the file in the media library e.g. `/marketing-assets/new-banner.jpg`. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * Type of the uploaded file. Possible values are `image`, `non-image`. + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * Height of the image in pixels (Only for images). + */ + public function withHeight(float $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Is the file marked as private. It can be either `true` or `false`. Send `isPrivateFile` in `responseFields` in API request to get the value of this field. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Is the file published or in draft state. It can be either `true` or `false`. Send `isPublished` in `responseFields` in API request to get the value of this field. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Legacy metadata. Send `metadata` in `responseFields` in API request to get metadata in the upload API response. + */ + public function withMetadata(Metadata $metadata): self + { + $obj = clone $this; + $obj->metadata = $metadata; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Size of the image file in Bytes. + */ + public function withSize(float $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * The array of tags associated with the asset. If no tags are set, it will be `null`. Send `tags` in `responseFields` in API request to get the value of this field. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * In the case of an image, a small thumbnail URL. + */ + public function withThumbnailURL(string $thumbnailURL): self + { + $obj = clone $this; + $obj->thumbnailURL = $thumbnailURL; + + return $obj; + } + + /** + * A publicly accessible URL of the file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * An object containing the file or file version's `id` (versionId) and `name`. + */ + public function withVersionInfo(VersionInfo $versionInfo): self + { + $obj = clone $this; + $obj->versionInfo = $versionInfo; + + return $obj; + } + + /** + * The video codec used in the video (only for video). + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Width of the image in pixels (Only for Images). + */ + public function withWidth(float $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php new file mode 100644 index 00000000..e749ce23 --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php @@ -0,0 +1,95 @@ + */ + use SdkModel; + + /** + * Confidence score of the tag. + */ + #[Api(optional: true)] + public ?float $confidence; + + /** + * Name of the tag. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + #[Api(optional: true)] + public ?string $source; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?float $confidence = null, + ?string $name = null, + ?string $source = null + ): self { + $obj = new self; + + null !== $confidence && $obj->confidence = $confidence; + null !== $name && $obj->name = $name; + null !== $source && $obj->source = $source; + + return $obj; + } + + /** + * Confidence score of the tag. + */ + public function withConfidence(float $confidence): self + { + $obj = clone $this; + $obj->confidence = $confidence; + + return $obj; + } + + /** + * Name of the tag. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Array of `AITags` associated with the image. If no `AITags` are set, it will be null. These tags can be added using the `google-auto-tagging` or `aws-auto-tagging` extensions. + */ + public function withSource(string $source): self + { + $obj = clone $this; + $obj->source = $source; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php new file mode 100644 index 00000000..66ec9040 --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php @@ -0,0 +1,126 @@ + */ + use SdkModel; + + /** @var AIAutoDescription::*|null $aiAutoDescription */ + #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] + public ?string $aiAutoDescription; + + /** @var AwsAutoTagging::*|null $awsAutoTagging */ + #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] + public ?string $awsAutoTagging; + + /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] + public ?string $googleAutoTagging; + + /** @var RemoveBg::*|null $removeBg */ + #[Api('remove-bg', enum: RemoveBg::class, optional: true)] + public ?string $removeBg; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AIAutoDescription::* $aiAutoDescription + * @param AwsAutoTagging::* $awsAutoTagging + * @param GoogleAutoTagging::* $googleAutoTagging + * @param RemoveBg::* $removeBg + */ + public static function with( + ?string $aiAutoDescription = null, + ?string $awsAutoTagging = null, + ?string $googleAutoTagging = null, + ?string $removeBg = null, + ): self { + $obj = new self; + + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg; + + return $obj; + } + + /** + * @param AIAutoDescription::* $aiAutoDescription + */ + public function withAIAutoDescription(string $aiAutoDescription): self + { + $obj = clone $this; + $obj->aiAutoDescription = $aiAutoDescription; + + return $obj; + } + + /** + * @param AwsAutoTagging::* $awsAutoTagging + */ + public function withAwsAutoTagging(string $awsAutoTagging): self + { + $obj = clone $this; + $obj->awsAutoTagging = $awsAutoTagging; + + return $obj; + } + + /** + * @param GoogleAutoTagging::* $googleAutoTagging + */ + public function withGoogleAutoTagging(string $googleAutoTagging): self + { + $obj = clone $this; + $obj->googleAutoTagging = $googleAutoTagging; + + return $obj; + } + + /** + * @param RemoveBg::* $removeBg + */ + public function withRemoveBg(string $removeBg): self + { + $obj = clone $this; + $obj->removeBg = $removeBg; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php new file mode 100644 index 00000000..ed95d763 --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php @@ -0,0 +1,19 @@ + */ + use SdkModel; + + /** + * Unique identifier of the file version. + */ + #[Api(optional: true)] + public ?string $id; + + /** + * Name of the file version. + */ + #[Api(optional: true)] + public ?string $name; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?string $id = null, ?string $name = null): self + { + $obj = new self; + + null !== $id && $obj->id = $id; + null !== $name && $obj->name = $name; + + return $obj; + } + + /** + * Unique identifier of the file version. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Name of the file version. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } +} diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Request.php b/src/Webhooks/UploadPreTransformSuccessEvent/Request.php new file mode 100644 index 00000000..8071e5bd --- /dev/null +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Request.php @@ -0,0 +1,88 @@ + */ + use SdkModel; + + /** + * The requested pre-transformation string. + */ + #[Api] + public string $transformation; + + /** + * Unique identifier for the originating request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(transformation: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withTransformation(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $transformation, + string $xRequestID + ): self { + $obj = new self; + + $obj->transformation = $transformation; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + /** + * The requested pre-transformation string. + */ + public function withTransformation(string $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Unique identifier for the originating request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent.php b/src/Webhooks/VideoTransformationAcceptedEvent.php new file mode 100644 index 00000000..7c868c67 --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent.php @@ -0,0 +1,139 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'video.transformation.accepted'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp when the event was created in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + /** + * Information about the original request that triggered the video transformation. + */ + #[Api] + public Request $request; + + /** + * `new VideoTransformationAcceptedEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VideoTransformationAcceptedEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VideoTransformationAcceptedEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp when the event was created in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + /** + * Information about the original request that triggered the video transformation. + */ + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data.php new file mode 100644 index 00000000..bc3d56ce --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data.php @@ -0,0 +1,90 @@ + */ + use SdkModel; + + /** + * Information about the source video asset being transformed. + */ + #[Api] + public Asset $asset; + + /** + * Base information about a video transformation request. + */ + #[Api] + public Transformation $transformation; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(asset: ..., transformation: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data)->withAsset(...)->withTransformation(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + Asset $asset, + Transformation $transformation + ): self { + $obj = new self; + + $obj->asset = $asset; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Information about the source video asset being transformed. + */ + public function withAsset(Asset $asset): self + { + $obj = clone $this; + $obj->asset = $asset; + + return $obj; + } + + /** + * Base information about a video transformation request. + */ + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Asset.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Asset.php new file mode 100644 index 00000000..8f471cdb --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Asset.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * URL to download or access the source video file. + */ + #[Api] + public string $url; + + /** + * `new Asset()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Asset::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Asset)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $url): self + { + $obj = new self; + + $obj->url = $url; + + return $obj; + } + + /** + * URL to download or access the source video file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php new file mode 100644 index 00000000..cf837b26 --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php @@ -0,0 +1,105 @@ + */ + use SdkModel; + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * Configuration options for video transformations. + */ + #[Api(optional: true)] + public ?Options $options; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + */ + public static function with(string $type, ?Options $options = null): self + { + $obj = new self; + + $obj->type = $type; + + null !== $options && $obj->options = $options; + + return $obj; + } + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Configuration options for video transformations. + */ + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php new file mode 100644 index 00000000..a0723d5b --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php @@ -0,0 +1,209 @@ +|null, + * videoCodec?: VideoCodec::*|null, + * } + */ +final class Options implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Audio codec used for encoding (aac or opus). + * + * @var AudioCodec::*|null $audioCodec + */ + #[Api('audio_codec', enum: AudioCodec::class, optional: true)] + public ?string $audioCodec; + + /** + * Whether to automatically rotate the video based on metadata. + */ + #[Api('auto_rotate', optional: true)] + public ?bool $autoRotate; + + /** + * Output format for the transformed video or thumbnail. + * + * @var Format::*|null $format + */ + #[Api(enum: Format::class, optional: true)] + public ?string $format; + + /** + * Quality setting for the output video. + */ + #[Api(optional: true)] + public ?int $quality; + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @var StreamProtocol::*|null $streamProtocol + */ + #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] + public ?string $streamProtocol; + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @var list|null $variants + */ + #[Api(list: 'string', optional: true)] + public ?array $variants; + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @var VideoCodec::*|null $videoCodec + */ + #[Api('video_codec', enum: VideoCodec::class, optional: true)] + public ?string $videoCodec; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AudioCodec::* $audioCodec + * @param Format::* $format + * @param StreamProtocol::* $streamProtocol + * @param list $variants + * @param VideoCodec::* $videoCodec + */ + public static function with( + ?string $audioCodec = null, + ?bool $autoRotate = null, + ?string $format = null, + ?int $quality = null, + ?string $streamProtocol = null, + ?array $variants = null, + ?string $videoCodec = null, + ): self { + $obj = new self; + + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $autoRotate && $obj->autoRotate = $autoRotate; + null !== $format && $obj->format = $format; + null !== $quality && $obj->quality = $quality; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $variants && $obj->variants = $variants; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Audio codec used for encoding (aac or opus). + * + * @param AudioCodec::* $audioCodec + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * Whether to automatically rotate the video based on metadata. + */ + public function withAutoRotate(bool $autoRotate): self + { + $obj = clone $this; + $obj->autoRotate = $autoRotate; + + return $obj; + } + + /** + * Output format for the transformed video or thumbnail. + * + * @param Format::* $format + */ + public function withFormat(string $format): self + { + $obj = clone $this; + $obj->format = $format; + + return $obj; + } + + /** + * Quality setting for the output video. + */ + public function withQuality(int $quality): self + { + $obj = clone $this; + $obj->quality = $quality; + + return $obj; + } + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @param StreamProtocol::* $streamProtocol + */ + public function withStreamProtocol(string $streamProtocol): self + { + $obj = clone $this; + $obj->streamProtocol = $streamProtocol; + + return $obj; + } + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @param list $variants + */ + public function withVariants(array $variants): self + { + $obj = clone $this; + $obj->variants = $variants; + + return $obj; + } + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @param VideoCodec::* $videoCodec + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php new file mode 100644 index 00000000..59206f99 --- /dev/null +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Full URL of the transformation request that was submitted. + */ + #[Api] + public string $url; + + /** + * Unique identifier for the originating transformation request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * User-Agent header from the original request that triggered the transformation. + */ + #[Api('user_agent', optional: true)] + public ?string $userAgent; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(url: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withURL(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $url, + string $xRequestID, + ?string $userAgent = null + ): self { + $obj = new self; + + $obj->url = $url; + $obj->xRequestID = $xRequestID; + + null !== $userAgent && $obj->userAgent = $userAgent; + + return $obj; + } + + /** + * Full URL of the transformation request that was submitted. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * Unique identifier for the originating transformation request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + /** + * User-Agent header from the original request that triggered the transformation. + */ + public function withUserAgent(string $userAgent): self + { + $obj = clone $this; + $obj->userAgent = $userAgent; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent.php b/src/Webhooks/VideoTransformationErrorEvent.php new file mode 100644 index 00000000..71938723 --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent.php @@ -0,0 +1,139 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'video.transformation.error'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp when the event was created in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + /** + * Information about the original request that triggered the video transformation. + */ + #[Api] + public Request $request; + + /** + * `new VideoTransformationErrorEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VideoTransformationErrorEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VideoTransformationErrorEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp when the event was created in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + /** + * Information about the original request that triggered the video transformation. + */ + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data.php b/src/Webhooks/VideoTransformationErrorEvent/Data.php new file mode 100644 index 00000000..20fabdc8 --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data.php @@ -0,0 +1,84 @@ + */ + use SdkModel; + + /** + * Information about the source video asset being transformed. + */ + #[Api] + public Asset $asset; + + #[Api] + public Transformation $transformation; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(asset: ..., transformation: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data)->withAsset(...)->withTransformation(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + Asset $asset, + Transformation $transformation + ): self { + $obj = new self; + + $obj->asset = $asset; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Information about the source video asset being transformed. + */ + public function withAsset(Asset $asset): self + { + $obj = clone $this; + $obj->asset = $asset; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Asset.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Asset.php new file mode 100644 index 00000000..7a282f1d --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Asset.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * URL to download or access the source video file. + */ + #[Api] + public string $url; + + /** + * `new Asset()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Asset::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Asset)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $url): self + { + $obj = new self; + + $obj->url = $url; + + return $obj; + } + + /** + * URL to download or access the source video file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php new file mode 100644 index 00000000..846bf6cf --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php @@ -0,0 +1,125 @@ + */ + use SdkModel; + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * Details about the transformation error. + */ + #[Api(optional: true)] + public ?Error $error; + + /** + * Configuration options for video transformations. + */ + #[Api(optional: true)] + public ?Options $options; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + */ + public static function with( + string $type, + ?Error $error = null, + ?Options $options = null + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $error && $obj->error = $error; + null !== $options && $obj->options = $options; + + return $obj; + } + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Details about the transformation error. + */ + public function withError(Error $error): self + { + $obj = clone $this; + $obj->error = $error; + + return $obj; + } + + /** + * Configuration options for video transformations. + */ + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php new file mode 100644 index 00000000..c6d6c648 --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php @@ -0,0 +1,83 @@ + */ + use SdkModel; + + /** + * Specific reason for the transformation failure: + * - `encoding_failed`: Error during video encoding process + * - `download_failed`: Could not download source video + * - `internal_server_error`: Unexpected server error + * + * @var Reason::* $reason + */ + #[Api(enum: Reason::class)] + public string $reason; + + /** + * `new Error()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Error::with(reason: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Error)->withReason(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Reason::* $reason + */ + public static function with(string $reason): self + { + $obj = new self; + + $obj->reason = $reason; + + return $obj; + } + + /** + * Specific reason for the transformation failure: + * - `encoding_failed`: Error during video encoding process + * - `download_failed`: Could not download source video + * - `internal_server_error`: Unexpected server error + * + * @param Reason::* $reason + */ + public function withReason(string $reason): self + { + $obj = clone $this; + $obj->reason = $reason; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php new file mode 100644 index 00000000..d5c1c151 --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php @@ -0,0 +1,25 @@ +|null, + * videoCodec?: VideoCodec::*|null, + * } + */ +final class Options implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Audio codec used for encoding (aac or opus). + * + * @var AudioCodec::*|null $audioCodec + */ + #[Api('audio_codec', enum: AudioCodec::class, optional: true)] + public ?string $audioCodec; + + /** + * Whether to automatically rotate the video based on metadata. + */ + #[Api('auto_rotate', optional: true)] + public ?bool $autoRotate; + + /** + * Output format for the transformed video or thumbnail. + * + * @var Format::*|null $format + */ + #[Api(enum: Format::class, optional: true)] + public ?string $format; + + /** + * Quality setting for the output video. + */ + #[Api(optional: true)] + public ?int $quality; + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @var StreamProtocol::*|null $streamProtocol + */ + #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] + public ?string $streamProtocol; + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @var list|null $variants + */ + #[Api(list: 'string', optional: true)] + public ?array $variants; + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @var VideoCodec::*|null $videoCodec + */ + #[Api('video_codec', enum: VideoCodec::class, optional: true)] + public ?string $videoCodec; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AudioCodec::* $audioCodec + * @param Format::* $format + * @param StreamProtocol::* $streamProtocol + * @param list $variants + * @param VideoCodec::* $videoCodec + */ + public static function with( + ?string $audioCodec = null, + ?bool $autoRotate = null, + ?string $format = null, + ?int $quality = null, + ?string $streamProtocol = null, + ?array $variants = null, + ?string $videoCodec = null, + ): self { + $obj = new self; + + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $autoRotate && $obj->autoRotate = $autoRotate; + null !== $format && $obj->format = $format; + null !== $quality && $obj->quality = $quality; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $variants && $obj->variants = $variants; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Audio codec used for encoding (aac or opus). + * + * @param AudioCodec::* $audioCodec + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * Whether to automatically rotate the video based on metadata. + */ + public function withAutoRotate(bool $autoRotate): self + { + $obj = clone $this; + $obj->autoRotate = $autoRotate; + + return $obj; + } + + /** + * Output format for the transformed video or thumbnail. + * + * @param Format::* $format + */ + public function withFormat(string $format): self + { + $obj = clone $this; + $obj->format = $format; + + return $obj; + } + + /** + * Quality setting for the output video. + */ + public function withQuality(int $quality): self + { + $obj = clone $this; + $obj->quality = $quality; + + return $obj; + } + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @param StreamProtocol::* $streamProtocol + */ + public function withStreamProtocol(string $streamProtocol): self + { + $obj = clone $this; + $obj->streamProtocol = $streamProtocol; + + return $obj; + } + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @param list $variants + */ + public function withVariants(array $variants): self + { + $obj = clone $this; + $obj->variants = $variants; + + return $obj; + } + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @param VideoCodec::* $videoCodec + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php new file mode 100644 index 00000000..796c5e40 --- /dev/null +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * Full URL of the transformation request that was submitted. + */ + #[Api] + public string $url; + + /** + * Unique identifier for the originating transformation request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * User-Agent header from the original request that triggered the transformation. + */ + #[Api('user_agent', optional: true)] + public ?string $userAgent; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(url: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withURL(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $url, + string $xRequestID, + ?string $userAgent = null + ): self { + $obj = new self; + + $obj->url = $url; + $obj->xRequestID = $xRequestID; + + null !== $userAgent && $obj->userAgent = $userAgent; + + return $obj; + } + + /** + * Full URL of the transformation request that was submitted. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * Unique identifier for the originating transformation request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + /** + * User-Agent header from the original request that triggered the transformation. + */ + public function withUserAgent(string $userAgent): self + { + $obj = clone $this; + $obj->userAgent = $userAgent; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent.php b/src/Webhooks/VideoTransformationReadyEvent.php new file mode 100644 index 00000000..691208d4 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent.php @@ -0,0 +1,161 @@ + */ + use SdkModel; + + #[Api] + public string $type = 'video.transformation.ready'; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * Timestamp when the event was created in ISO8601 format. + */ + #[Api('created_at')] + public \DateTimeInterface $createdAt; + + #[Api] + public Data $data; + + /** + * Information about the original request that triggered the video transformation. + */ + #[Api] + public Request $request; + + /** + * Performance metrics for the transformation process. + */ + #[Api(optional: true)] + public ?Timings $timings; + + /** + * `new VideoTransformationReadyEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VideoTransformationReadyEvent::with( + * id: ..., createdAt: ..., data: ..., request: ... + * ) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VideoTransformationReadyEvent) + * ->withID(...) + * ->withCreatedAt(...) + * ->withData(...) + * ->withRequest(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $id, + \DateTimeInterface $createdAt, + Data $data, + Request $request, + ?Timings $timings = null, + ): self { + $obj = new self; + + $obj->id = $id; + $obj->createdAt = $createdAt; + $obj->data = $data; + $obj->request = $request; + + null !== $timings && $obj->timings = $timings; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * Timestamp when the event was created in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + public function withData(Data $data): self + { + $obj = clone $this; + $obj->data = $data; + + return $obj; + } + + /** + * Information about the original request that triggered the video transformation. + */ + public function withRequest(Request $request): self + { + $obj = clone $this; + $obj->request = $request; + + return $obj; + } + + /** + * Performance metrics for the transformation process. + */ + public function withTimings(Timings $timings): self + { + $obj = clone $this; + $obj->timings = $timings; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data.php b/src/Webhooks/VideoTransformationReadyEvent/Data.php new file mode 100644 index 00000000..3950a1ab --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data.php @@ -0,0 +1,84 @@ + */ + use SdkModel; + + /** + * Information about the source video asset being transformed. + */ + #[Api] + public Asset $asset; + + #[Api] + public Transformation $transformation; + + /** + * `new Data()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Data::with(asset: ..., transformation: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Data)->withAsset(...)->withTransformation(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + Asset $asset, + Transformation $transformation + ): self { + $obj = new self; + + $obj->asset = $asset; + $obj->transformation = $transformation; + + return $obj; + } + + /** + * Information about the source video asset being transformed. + */ + public function withAsset(Asset $asset): self + { + $obj = clone $this; + $obj->asset = $asset; + + return $obj; + } + + public function withTransformation(Transformation $transformation): self + { + $obj = clone $this; + $obj->transformation = $transformation; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Asset.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Asset.php new file mode 100644 index 00000000..ae5d9570 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Asset.php @@ -0,0 +1,70 @@ + */ + use SdkModel; + + /** + * URL to download or access the source video file. + */ + #[Api] + public string $url; + + /** + * `new Asset()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Asset::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Asset)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $url): self + { + $obj = new self; + + $obj->url = $url; + + return $obj; + } + + /** + * URL to download or access the source video file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php new file mode 100644 index 00000000..b2fc39fa --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php @@ -0,0 +1,125 @@ + */ + use SdkModel; + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @var Type::* $type + */ + #[Api(enum: Type::class)] + public string $type; + + /** + * Configuration options for video transformations. + */ + #[Api(optional: true)] + public ?Options $options; + + /** + * Information about the transformed output video. + */ + #[Api(optional: true)] + public ?Output $output; + + /** + * `new Transformation()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Transformation::with(type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Transformation)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param Type::* $type + */ + public static function with( + string $type, + ?Options $options = null, + ?Output $output = null + ): self { + $obj = new self; + + $obj->type = $type; + + null !== $options && $obj->options = $options; + null !== $output && $obj->output = $output; + + return $obj; + } + + /** + * Type of video transformation: + * - `video-transformation`: Standard video processing (resize, format conversion, etc.) + * - `gif-to-video`: Convert animated GIF to video format + * - `video-thumbnail`: Generate thumbnail image from video + * + * @param Type::* $type + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + + /** + * Configuration options for video transformations. + */ + public function withOptions(Options $options): self + { + $obj = clone $this; + $obj->options = $options; + + return $obj; + } + + /** + * Information about the transformed output video. + */ + public function withOutput(Output $output): self + { + $obj = clone $this; + $obj->output = $output; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php new file mode 100644 index 00000000..352cec53 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php @@ -0,0 +1,209 @@ +|null, + * videoCodec?: VideoCodec::*|null, + * } + */ +final class Options implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Audio codec used for encoding (aac or opus). + * + * @var AudioCodec::*|null $audioCodec + */ + #[Api('audio_codec', enum: AudioCodec::class, optional: true)] + public ?string $audioCodec; + + /** + * Whether to automatically rotate the video based on metadata. + */ + #[Api('auto_rotate', optional: true)] + public ?bool $autoRotate; + + /** + * Output format for the transformed video or thumbnail. + * + * @var Format::*|null $format + */ + #[Api(enum: Format::class, optional: true)] + public ?string $format; + + /** + * Quality setting for the output video. + */ + #[Api(optional: true)] + public ?int $quality; + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @var StreamProtocol::*|null $streamProtocol + */ + #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] + public ?string $streamProtocol; + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @var list|null $variants + */ + #[Api(list: 'string', optional: true)] + public ?array $variants; + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @var VideoCodec::*|null $videoCodec + */ + #[Api('video_codec', enum: VideoCodec::class, optional: true)] + public ?string $videoCodec; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param AudioCodec::* $audioCodec + * @param Format::* $format + * @param StreamProtocol::* $streamProtocol + * @param list $variants + * @param VideoCodec::* $videoCodec + */ + public static function with( + ?string $audioCodec = null, + ?bool $autoRotate = null, + ?string $format = null, + ?int $quality = null, + ?string $streamProtocol = null, + ?array $variants = null, + ?string $videoCodec = null, + ): self { + $obj = new self; + + null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $autoRotate && $obj->autoRotate = $autoRotate; + null !== $format && $obj->format = $format; + null !== $quality && $obj->quality = $quality; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $variants && $obj->variants = $variants; + null !== $videoCodec && $obj->videoCodec = $videoCodec; + + return $obj; + } + + /** + * Audio codec used for encoding (aac or opus). + * + * @param AudioCodec::* $audioCodec + */ + public function withAudioCodec(string $audioCodec): self + { + $obj = clone $this; + $obj->audioCodec = $audioCodec; + + return $obj; + } + + /** + * Whether to automatically rotate the video based on metadata. + */ + public function withAutoRotate(bool $autoRotate): self + { + $obj = clone $this; + $obj->autoRotate = $autoRotate; + + return $obj; + } + + /** + * Output format for the transformed video or thumbnail. + * + * @param Format::* $format + */ + public function withFormat(string $format): self + { + $obj = clone $this; + $obj->format = $format; + + return $obj; + } + + /** + * Quality setting for the output video. + */ + public function withQuality(int $quality): self + { + $obj = clone $this; + $obj->quality = $quality; + + return $obj; + } + + /** + * Streaming protocol for adaptive bitrate streaming. + * + * @param StreamProtocol::* $streamProtocol + */ + public function withStreamProtocol(string $streamProtocol): self + { + $obj = clone $this; + $obj->streamProtocol = $streamProtocol; + + return $obj; + } + + /** + * Array of quality representations for adaptive bitrate streaming. + * + * @param list $variants + */ + public function withVariants(array $variants): self + { + $obj = clone $this; + $obj->variants = $variants; + + return $obj; + } + + /** + * Video codec used for encoding (h264, vp9, or av1). + * + * @param VideoCodec::* $videoCodec + */ + public function withVideoCodec(string $videoCodec): self + { + $obj = clone $this; + $obj->videoCodec = $videoCodec; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php new file mode 100644 index 00000000..779ccde7 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php @@ -0,0 +1,20 @@ + */ + use SdkModel; + + /** + * URL to access the transformed video. + */ + #[Api] + public string $url; + + /** + * Metadata of the output video file. + */ + #[Api('video_metadata', optional: true)] + public ?VideoMetadata $videoMetadata; + + /** + * `new Output()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Output::with(url: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Output)->withURL(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $url, + ?VideoMetadata $videoMetadata = null + ): self { + $obj = new self; + + $obj->url = $url; + + null !== $videoMetadata && $obj->videoMetadata = $videoMetadata; + + return $obj; + } + + /** + * URL to access the transformed video. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * Metadata of the output video file. + */ + public function withVideoMetadata(VideoMetadata $videoMetadata): self + { + $obj = clone $this; + $obj->videoMetadata = $videoMetadata; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output/VideoMetadata.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output/VideoMetadata.php new file mode 100644 index 00000000..7b8233e6 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output/VideoMetadata.php @@ -0,0 +1,134 @@ + */ + use SdkModel; + + /** + * Bitrate of the output video in bits per second. + */ + #[Api] + public int $bitrate; + + /** + * Duration of the output video in seconds. + */ + #[Api] + public float $duration; + + /** + * Height of the output video in pixels. + */ + #[Api] + public int $height; + + /** + * Width of the output video in pixels. + */ + #[Api] + public int $width; + + /** + * `new VideoMetadata()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * VideoMetadata::with(bitrate: ..., duration: ..., height: ..., width: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new VideoMetadata) + * ->withBitrate(...) + * ->withDuration(...) + * ->withHeight(...) + * ->withWidth(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + int $bitrate, + float $duration, + int $height, + int $width + ): self { + $obj = new self; + + $obj->bitrate = $bitrate; + $obj->duration = $duration; + $obj->height = $height; + $obj->width = $width; + + return $obj; + } + + /** + * Bitrate of the output video in bits per second. + */ + public function withBitrate(int $bitrate): self + { + $obj = clone $this; + $obj->bitrate = $bitrate; + + return $obj; + } + + /** + * Duration of the output video in seconds. + */ + public function withDuration(float $duration): self + { + $obj = clone $this; + $obj->duration = $duration; + + return $obj; + } + + /** + * Height of the output video in pixels. + */ + public function withHeight(int $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Width of the output video in pixels. + */ + public function withWidth(int $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php new file mode 100644 index 00000000..9b2b35d3 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php @@ -0,0 +1,25 @@ + */ + use SdkModel; + + /** + * Full URL of the transformation request that was submitted. + */ + #[Api] + public string $url; + + /** + * Unique identifier for the originating transformation request. + */ + #[Api('x_request_id')] + public string $xRequestID; + + /** + * User-Agent header from the original request that triggered the transformation. + */ + #[Api('user_agent', optional: true)] + public ?string $userAgent; + + /** + * `new Request()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Request::with(url: ..., xRequestID: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Request)->withURL(...)->withXRequestID(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + string $url, + string $xRequestID, + ?string $userAgent = null + ): self { + $obj = new self; + + $obj->url = $url; + $obj->xRequestID = $xRequestID; + + null !== $userAgent && $obj->userAgent = $userAgent; + + return $obj; + } + + /** + * Full URL of the transformation request that was submitted. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * Unique identifier for the originating transformation request. + */ + public function withXRequestID(string $xRequestID): self + { + $obj = clone $this; + $obj->xRequestID = $xRequestID; + + return $obj; + } + + /** + * User-Agent header from the original request that triggered the transformation. + */ + public function withUserAgent(string $userAgent): self + { + $obj = clone $this; + $obj->userAgent = $userAgent; + + return $obj; + } +} diff --git a/src/Webhooks/VideoTransformationReadyEvent/Timings.php b/src/Webhooks/VideoTransformationReadyEvent/Timings.php new file mode 100644 index 00000000..8ae42494 --- /dev/null +++ b/src/Webhooks/VideoTransformationReadyEvent/Timings.php @@ -0,0 +1,78 @@ + */ + use SdkModel; + + /** + * Time spent downloading the source video from your origin or media library, in milliseconds. + */ + #[Api('download_duration', optional: true)] + public ?int $downloadDuration; + + /** + * Time spent encoding the video, in milliseconds. + */ + #[Api('encoding_duration', optional: true)] + public ?int $encodingDuration; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + ?int $downloadDuration = null, + ?int $encodingDuration = null + ): self { + $obj = new self; + + null !== $downloadDuration && $obj->downloadDuration = $downloadDuration; + null !== $encodingDuration && $obj->encodingDuration = $encodingDuration; + + return $obj; + } + + /** + * Time spent downloading the source video from your origin or media library, in milliseconds. + */ + public function withDownloadDuration(int $downloadDuration): self + { + $obj = clone $this; + $obj->downloadDuration = $downloadDuration; + + return $obj; + } + + /** + * Time spent encoding the video, in milliseconds. + */ + public function withEncodingDuration(int $encodingDuration): self + { + $obj = clone $this; + $obj->encodingDuration = $encodingDuration; + + return $obj; + } +} diff --git a/tests/Core/TestModel.php b/tests/Core/TestModel.php new file mode 100644 index 00000000..06a5ebde --- /dev/null +++ b/tests/Core/TestModel.php @@ -0,0 +1,180 @@ +> */ + use SdkModel; + + #[Api] + public string $name; + + #[Api('age_years')] + public int $ageYears; + + /** @var list|null */ + #[Api(optional: true)] + public ?array $friends; + + #[Api] + public ?string $owner; + + /** + * @param list|null $friends + */ + public function __construct( + string $name, + int $ageYears, + ?string $owner, + ?array $friends = null, + ) { + $this->initialize(); + + $this->name = $name; + $this->ageYears = $ageYears; + $this->owner = $owner; + + null != $friends && $this->friends = $friends; + } +} + +/** + * @internal + * + * @coversNothing + */ +#[CoversNothing] +class TestModelTest extends TestCase +{ + #[Test] + public function testBasicGetAndSet(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $this->assertEquals(12, $model->ageYears); + + ++$model->ageYears; + $this->assertEquals(13, $model->ageYears); + } + + #[Test] + public function testNullAccess(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $this->assertNull($model->owner); + $this->assertNull($model->friends); + } + + #[Test] + public function testArrayGetAndSet(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $model->friends ??= []; + $this->assertEquals([], $model->friends); + $model->friends[] = 'Alice'; + $this->assertEquals(['Alice'], $model->friends); + } + + #[Test] + public function testDiscernsBetweenNullAndUnset(): void + { + $modelUnsetFriends = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $modelNullFriends = new TestModel( + name: 'bob', + ageYears: 12, + owner: null, + ); + $modelNullFriends->friends = null; + + $this->assertEquals(12, $modelUnsetFriends->ageYears); + $this->assertEquals(12, $modelNullFriends->ageYears); + + $this->assertTrue($modelUnsetFriends->offsetExists('ageYears')); + $this->assertTrue($modelNullFriends->offsetExists('ageYears')); + + $this->assertNull($modelUnsetFriends->friends); + $this->assertNull($modelNullFriends->friends); + + $this->assertFalse($modelUnsetFriends->offsetExists('friends')); + $this->assertTrue($modelNullFriends->offsetExists('friends')); + } + + #[Test] + public function testIssetOnOmittedProperties(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $this->assertFalse(isset($model->owner)); + $this->assertFalse(isset($model->friends)); + } + + #[Test] + public function testSerializeBasicModel(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: 'Eve', + friends: ['Alice', 'Charlie'], + ); + $this->assertEquals( + '{"name":"Bob","age_years":12,"friends":["Alice","Charlie"],"owner":"Eve"}', + json_encode($model) + ); + } + + #[Test] + public function testSerializeModelWithOmittedProperties(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $this->assertEquals( + '{"name":"Bob","age_years":12,"owner":null}', + json_encode($model) + ); + } + + #[Test] + public function testSerializeModelWithExplicitNull(): void + { + $model = new TestModel( + name: 'Bob', + ageYears: 12, + owner: null, + ); + $model->friends = null; + $this->assertEquals( + '{"name":"Bob","age_years":12,"friends":null,"owner":null}', + json_encode($model) + ); + } +} diff --git a/tests/ImageKit/ImageKitTest.php b/tests/ImageKit/ImageKitTest.php deleted file mode 100644 index 666330ac..00000000 --- a/tests/ImageKit/ImageKitTest.php +++ /dev/null @@ -1,337 +0,0 @@ -configuration, "\$configuration should be an instance of Configuration"); - Assert::assertEquals('testing_public_key', $this->configuration->publicKey, 'Public Key should be equal to testing_public_key'); - Assert::assertEquals('testing_private_key', $this->configuration->privateKey, 'Private Key should be equal to testing_private_key'); - Assert::assertEquals('https://ik.imagekit.io/testing', $this->configuration->urlEndpoint, 'Url Endpoint should be equal to https://ik.imagekit.io/testing'); - Assert::assertEquals('path', $this->configuration->transformationPosition, 'Transformation Position should be equal to path'); - }; - $doAssertClosure = $assertionClosure->bindTo($imagekit, ImageKit::class); - $doAssertClosure(); - } - - /** - * Successful initialization with TransformationPosition as Path - */ - public function test__constructSuccessfulWithTransformationPositionPath() - { - $imagekit = new ImageKit('testing_public_key', 'testing_private_key', 'https://ik.imagekit.io/testing', 'path'); - $assertionClosure = function () { - Assert::assertInstanceOf(Configuration::class, $this->configuration, "\$configuration should be an instance of Configuration"); - Assert::assertEquals('testing_public_key', $this->configuration->publicKey, 'Public Key should be equal to testing_public_key'); - Assert::assertEquals('testing_private_key', $this->configuration->privateKey, 'Private Key should be equal to testing_private_key'); - Assert::assertEquals('https://ik.imagekit.io/testing', $this->configuration->urlEndpoint, 'Url Endpoint should be equal to https://ik.imagekit.io/testing'); - Assert::assertEquals('path', $this->configuration->transformationPosition, 'Transformation Position should be equal to path'); - }; - $doAssertClosure = $assertionClosure->bindTo($imagekit, ImageKit::class); - $doAssertClosure(); - } - - /** - * Successful initialization with TransformationPosition as Query - */ - public function test__constructSuccessfulWithTransformationPositionQuery() - { - $imagekit = new ImageKit('testing_public_key', 'testing_private_key', 'https://ik.imagekit.io/testing', 'query'); - $assertionClosure = function () { - Assert::assertInstanceOf(Configuration::class, $this->configuration, "\$configuration should be an instance of Configuration"); - Assert::assertEquals('testing_public_key', $this->configuration->publicKey, 'Public Key should be equal to testing_public_key'); - Assert::assertEquals('testing_private_key', $this->configuration->privateKey, 'Private Key should be equal to testing_private_key'); - Assert::assertEquals('https://ik.imagekit.io/testing', $this->configuration->urlEndpoint, 'Url Endpoint should be equal to https://ik.imagekit.io/testing'); - Assert::assertEquals('query', $this->configuration->transformationPosition, 'Transformation Position should be equal to path'); - }; - $doAssertClosure = $assertionClosure->bindTo($imagekit, ImageKit::class); - $doAssertClosure(); - } - - /** - * Failed initialization Missing Public Key - */ - public function test__constructFailedEmptyPublicKey() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('Missing publicKey during ImageKit initialization'); - new ImageKit('', '', '', ''); - } - - /** - * Failed initialization Missing Private Key - */ - public function test__constructFailedEmptyPrivateKey() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('Missing privateKey during ImageKit initialization'); - new ImageKit('testing_public_key', '', '', ''); - } - - /** - * Failed initialization Missing Url Endpoint - */ - public function test__constructFailedEmptyUrlEndpoint() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('Missing urlEndpoint during ImageKit initialization'); - new ImageKit('testing_public_key', 'testing_private_key', '', ''); - } - - /** - * Failed initialization Missing Transformation Position - */ - public function test__constructFailedEmptyTransformationPosition() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('Invalid transformationPosition during ImageKit initialization. Can be one of path or query'); - new ImageKit('testing_public_key', 'testing_private_key', 'https://ik.imagekit.io/testing', ''); - } - - /** - * Failed initialization Invalid Transformation Position - */ - public function test__constructFailedInvalidTransformationPosition() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('Invalid transformationPosition during ImageKit initialization. Can be one of path or query'); - new ImageKit('testing_public_key', 'testing_private_key', 'https://ik.imagekit.io/testing', 'testing'); - } - - - /** - * Failed initialization Invalid URL Endpoint - */ - public function test__constructFailedInvalidURLEndpoint() - { - $this->expectException(InvalidArgumentException::class); - $this->expectExceptionMessage('urlEndpoint should be a valid URL'); - new ImageKit('testing_public_key', 'testing_private_key', 'wrong_url', 'path'); - } - - /** - * Generate Authentication Parameters With Token - */ - public function testGetAuthenticationParametersWithToken() - { - $token = 'your_token'; - $expire = 1582269249; - $signature = 'e71bcd6031016b060d349d212e23e85c791decdd'; - - $imagekit = new ImageKit('public_key_test', 'private_key_test', 'https://ik.imagekit.io/testing'); - $response = $imagekit->getAuthenticationParameters('your_token', 1582269249); - - - Assert::assertEquals(json_encode([ - 'token' => $token, - 'expire' => $expire, - 'signature' => $signature, - ]), json_encode($response)); - } - - /** - * Test Phash Distance - */ - public function testPHashDistance() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = '63433b3ccf8e1ebe'; - $phash2 = 'f5d2226cd9d32b16'; - - $distance = $imagekit->pHashDistance($phash1, $phash2); - - Assert::assertEquals(27, $distance); - } - - /** - * Test Phash Distance - */ - public function testPHashDistanceEmptyPhash1() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = ''; - $phash2 = 'f5d2226cd9d32b16'; - - $response = $imagekit->pHashDistance($phash1, $phash2); - - ImageKitTest::assertEquals('Missing First pHash parameter for this request',$response->error->message); - } - - /** - * Test Phash Distance - */ - public function testPHashDistanceEmptyPhash2() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = 'f5d2226cd9d32b16'; - $phash2 = ''; - - - $response = $imagekit->pHashDistance($phash1, $phash2); - - ImageKitTest::assertEquals('Missing Second pHash parameter for this request',$response->error->message); - } - - /** - * Test Phash Distance - */ - public function testPHashDistanceInvalidPhash1() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = 'asdadasda'; - $phash2 = 'f5d2226cd9d32b16'; - - $this->expectException(Exception::class); - $this->expectExceptionMessage('Invalid pHash value'); - - $imagekit->pHashDistance($phash1, $phash2); - } - - /** - * Test Phash Distance - */ - public function testPHashDistanceInvalidPhash2() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = 'f5d2226cd9d32b16'; - $phash2 = 'asjdkajlkda'; - - $this->expectException(Exception::class); - $this->expectExceptionMessage('Invalid pHash value'); - - $imagekit->pHashDistance($phash1, $phash2); - } - - /** - * Test Phash Distance - */ - public function testPHashDistancePhashesLengthNotEqual() - { - $imagekit = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - $phash1 = 'f5d2226cd9d32b16'; - $phash2 = 'f5d2226cd9d32b16f5d2226cd9d32b16'; - - $this->expectException(Exception::class); - $this->expectExceptionMessage('Invalid pHash value'); - - $imagekit->pHashDistance($phash1, $phash2); - } - - - /** - * - */ - public function testGetBulkJobStatus() - { - $jobId = '598821f949c0a938d57563bd'; - - $responseBody = [ - "jobId" => "598821f949c0a938d57563bd", - "type" => "COPY_FOLDER", - "status" => "Completed" - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $this->stubHttpClient('get', new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse)); - - $response = $this->client->getBulkJobStatus($jobId); - - ImageKitTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - } - - /** - * - */ - public function testGetBulkJobStatusMissingJobId() - { - $jobId = ''; - - $response = $this->client->getBulkJobStatus($jobId); - - ImageKitTest::assertEquals('Missing Job ID parameter for this request',$response->error->message); - } - - /** - * - */ - private function stubHttpClient($methodName, $response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method($methodName)->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - } - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Manage/CacheTest.php b/tests/ImageKit/Manage/CacheTest.php deleted file mode 100644 index cf3a5711..00000000 --- a/tests/ImageKit/Manage/CacheTest.php +++ /dev/null @@ -1,192 +0,0 @@ - "598821f949c0a938d57563bd" - ]; - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->purgeCache($image_url); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/files/purge",$requestPath); - CacheTest::assertEquals($stream['url'],$image_url); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testPurgeCacheWithMissingImageURL() - { - $image_url = ''; - - $response = $this->client->purgeCache($image_url); - - CacheTest::assertEquals('Missing URL parameter for this request', $response->error->message); - } - - /** - * - */ - public function testPurgeCacheWithInvalidImageURL() - { - $image_url = 'image_url'; - - $response = $this->client->purgeCache($image_url); - - CacheTest::assertEquals('Invalid URL provided for this request', $response->error->message); - } - - /** - * - */ - public function testPurgeCacheStatus() - { - $cacheRequestId = '598821f949c0a938d57563bd'; - - $responseBody = [ - "status" => "Pending" - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->purgeCacheStatus($cacheRequestId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/files/purge/{$cacheRequestId}",$requestPath); - CacheTest::assertEmpty($stream); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - /** - * - */ - public function testPurgeCacheStatusWithMissingCacheRequestId() - { - $cacheRequestId = ''; - - $response = $this->client->purgeCacheStatus($cacheRequestId); - - CacheTest::assertEquals('Missing Request ID parameter for this request', $response->error->message); - } - - - - private function stubHttpClient($methodName, $response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method($methodName)->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - } - - /** - * - */ - private function createMockClient($handler){ - $this->mockClient = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo', - Transformation::DEFAULT_TRANSFORMATION_POSITION, - $handler - ); - } - - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Manage/CustomMetadataTest.php b/tests/ImageKit/Manage/CustomMetadataTest.php deleted file mode 100644 index a3fb06ae..00000000 --- a/tests/ImageKit/Manage/CustomMetadataTest.php +++ /dev/null @@ -1,627 +0,0 @@ - "price", - "label" => "Unit Price", - "schema" => [ - "type" => 'Number', - "minValue" => 1000, - "maxValue" => 5000, - ], - ]; - - $responseBody = [ - "id" => "598821f949c0a938d57563dd", - "name" => "price", - "label" => "Unit Price", - "schema" => [ - "type" => "Number", - "minValue" => 1000, - "maxValue" => 5000 - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->createCustomMetadataField($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/customMetadataFields",$requestPath); - CacheTest::assertEquals($stream['name'],$requestBody['name']); - CacheTest::assertEquals($stream['label'],$requestBody['label']); - CacheTest::assertEquals($stream['schema'],$requestBody['schema']); - CacheTest::assertEquals($stream['schema']['type'],$requestBody['schema']['type']); - CacheTest::assertEquals($stream['schema']['minValue'],$requestBody['schema']['minValue']); - CacheTest::assertEquals($stream['schema']['maxValue'],$requestBody['schema']['maxValue']); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testCreateFieldsInvalidRequest() - { - - $response = $this->client->createCustomMetadataField(); - - CacheTest::assertEquals('Create Custom Metadata API accepts an array, null passed', $response->error->message); - - } - - /** - * - */ - public function testCreateFieldsWithNonArrayParameter() - { - $requestBody = 'field_name'; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Create Custom Metadata API accepts an array of parameters, non array value passed', $response->error->message); - - } - - /** - * - */ - public function testCreateFieldsWithEmptyArrayParameter() - { - $requestBody = []; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Create Custom Metadata API accepts an array of parameters, empty array passed', $response->error->message); - } - - /** - * - */ - public function testCreateFieldsWithMissingName() - { - $requestBody = [ - "name" => "", - "label" => "Unit Price", - "schema" => [ - "type" => 'Number', - "minValue" => 1000, - "maxValue" => 5000, - ], - ]; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Missing parameter name and/or label and/or schema for this request', $response->error->message); - } - - /** - * - */ - public function testCreateFieldsWithMissingLabel() - { - $requestBody = [ - "name" => "price", - "label" => "", - "schema" => [ - "type" => 'Number', - "minValue" => 1000, - "maxValue" => 5000, - ], - ]; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Missing parameter name and/or label and/or schema for this request', $response->error->message); - } - - /** - * - */ - public function testCreateFieldsWithMissingSchema() - { - $requestBody = [ - "name" => "price", - "label" => "Unit Price", - ]; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Missing parameter name and/or label and/or schema for this request', $response->error->message); - } - - - /** - * - */ - public function testCreateFieldsWithMissingSchemaType() - { - $requestBody = [ - "name" => "price", - "label" => "Unit Price", - "schema" => [ - ], - ]; - - $response = $this->client->createCustomMetadataField($requestBody); - - CacheTest::assertEquals('Invalid parameter schema', $response->error->message); - } - - - /** - * - */ - public function testGetFields() - { - $includeDeleted = false; - - $responseBody = [ - [ - "id" => "598821f949c0a938d57563dd", - "name" => "brand", - "label" => "brand", - "schema" => [ - "type" => "Text", - "defaultValue" => "Nike" - ] - ], - [ - "id" => "865421f949c0a835d57563dd", - "name" => "price", - "label" => "price", - "schema" => [ - "type" => "Number", - "minValue" => 1000, - "maxValue" => 3000 - ] - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getCustomMetadataFields($includeDeleted); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $queryString = $request->getUri()->getQuery(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/customMetadataFields",$requestPath); - CacheTest::assertEquals($queryString,http_build_query(['includeDeleted'=>$includeDeleted])); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - - /** - * - */ - public function testGetFieldsWithoutIncludeDeleted() - { - - $responseBody = [ - [ - "id" => "598821f949c0a938d57563dd", - "name" => "brand", - "label" => "brand", - "schema" => [ - "type" => "Text", - "defaultValue" => "Nike" - ] - ], - [ - "id" => "865421f949c0a835d57563dd", - "name" => "price", - "label" => "price", - "schema" => [ - "type" => "Number", - "minValue" => 1000, - "maxValue" => 3000 - ] - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getCustomMetadataFields(); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $queryString = $request->getUri()->getQuery(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/customMetadataFields",$requestPath); - CacheTest::assertEquals($queryString,http_build_query(['includeDeleted'=>false])); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - /** - * - */ - public function testGetFieldsWithInvalidIncludeDeleted() - { - $includeDeleted = 'includeDeleted'; - - $response = $this->client->getCustomMetadataFields($includeDeleted); - - CacheTest::assertEquals('Invalid parameter includeDeleted', $response->error->message); - } - - /** - * - */ - public function testUpdateFields() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = [ - "label" => "Net Price", - "schema" => [ - "type"=>'Number' - ], - ]; - - $responseBody = [ - "id" => "598821f949c0a938d57563dd", - "name" => "price", - "label" => "Net Price", - "schema" => [ - "type" => "Number" - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/customMetadataFields/" . $customMetadataFieldId,$requestPath); - CacheTest::assertEquals($stream['label'],$requestBody['label']); - CacheTest::assertEquals($stream['schema'],$requestBody['schema']);CacheTest::assertEquals($stream['schema']['type'],$requestBody['schema']['type']); - - // Response Check - CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PATCH'); - } - - /** - * - */ - public function testUpdateFieldsInvalidRequest() - { - - $response = $this->client->updateCustomMetadataField(); - - CacheTest::assertEquals('Update Custom Metadata API accepts an id and requestBody, null passed', $response->error->message); - - } - - - /** - * - */ - public function testUpdateFieldsWithMissingCustomMetadataFieldId() - { - $customMetadataFieldId = ''; - - $requestBody = [ - "label" => "Net Price", - "schema" => [ - "type"=>'Number' - ], - ]; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Missing Custom Metadata Field ID parameter for this request', $response->error->message); - - } - - - /** - * - */ - public function testUpdateFieldsWithMissingBody() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId); - - CacheTest::assertEquals('Missing body parameter for this request', $response->error->message); - - } - - /** - * - */ - public function testUpdateFieldsWithNonArrayBodyParameter() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = "Net Price"; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Update Custom Metadata API accepts requestBody as an array of parameters, non array value passed', $response->error->message); - - } - - /** - * - */ - public function testUpdateFieldsWithEmptyArrayBodyParameter() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = []; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Update Custom Metadata API accepts an array of parameters, empty array passed', $response->error->message); - - } - - /** - * - */ - public function testUpdateFieldsWithMissingLabel() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = [ - "label" => "", - "schema" => [ - "type"=>'Number' - ], - ]; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Missing parameter label and/or schema for this request', $response->error->message); - - } - - /** - * - */ - public function testUpdateFieldsWithMissingSchema() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = [ - "label" => "Net Price", - ]; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Missing parameter label and/or schema for this request', $response->error->message); - - } - - /** - * - */ - public function testUpdateFieldsWithMissingSchemaType() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $requestBody = [ - "label" => "Net Price", - "schema" => [ - "type"=>'' - ], - ]; - - $response = $this->client->updateCustomMetadataField($customMetadataFieldId, $requestBody); - - CacheTest::assertEquals('Invalid parameter schema', $response->error->message); - - } - - /** - * - */ - public function testDeleteFields() - { - $customMetadataFieldId = '598821f949c0a938d57563dd'; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->deleteCustomMetadataField($customMetadataFieldId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - CacheTest::assertEquals("/v1/customMetadataFields/" . $customMetadataFieldId,$requestPath); - CacheTest::assertEmpty($stream); - - // Response Check - CacheTest::assertNull($response->result); - CacheTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'DELETE'); - } - - /** - * - */ - public function testDeleteFieldsWithMissingCustomMetadataFieldId() - { - $customMetadataFieldId = ''; - - $response = $this->client->deleteCustomMetadataField($customMetadataFieldId); - - CacheTest::assertEquals('Missing Custom Metadata Field ID parameter for this request',$response->error->message); - } - - - private function stubHttpClient($methodName, $response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method($methodName)->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - } - - /** - * - */ - private function createMockClient($handler){ - $this->mockClient = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo', - Transformation::DEFAULT_TRANSFORMATION_POSITION, - $handler - ); - } - - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Manage/FileTest.php b/tests/ImageKit/Manage/FileTest.php deleted file mode 100644 index d53ecfd0..00000000 --- a/tests/ImageKit/Manage/FileTest.php +++ /dev/null @@ -1,2035 +0,0 @@ - "help", - "message" => "message" - ]; - - /** - * - */ - public function testListFiles() - { - $responseBody = [ - [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => ["tag1","tag2"], - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - ], - ]; - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $this->stubHttpClient('get', new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse)); - - $response = $this->client->listFiles(); - - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - } - - /** - * - */ - public function testListFilesWithOptions() - { - $listOptions = [ - "type" => "file", - "sort" => "ASC_CREATED", - "path" => "/sample-folder", - "fileType" => "all", - "limit" => 10, - "skip" => 0, - "tags" => ["tag3","tag4"], - ]; - - $responseBody = [ - [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->listFiles($listOptions); - - $request = $container[0]['request']; - $queryString = $request->getUri()->getQuery(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - FileTest::assertEmpty($stream); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - - - /** - * - */ - public function testListFilesWithEmptyOptions() - { - $listOptions = []; - - $responseBody = [ - [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->listFiles($listOptions); - - $request = $container[0]['request']; - $queryString = $request->getUri()->getQuery(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - FileTest::assertEmpty($queryString); - FileTest::assertEmpty($stream); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - /** - * - */ - public function testListFilesWithInvalidOptions() - { - $listOptions = 'invalid'; - - $response = $this->client->listFiles($listOptions); - - FileTest::assertEquals('List File Options accepts an array of parameters, non array value passed', $response->error->message); - } - - /** - * - */ - public function testGetFileDetails() - { - $fileId = '23902390239203923'; - - $responseBody = [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - ]; - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getFileDetails($fileId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/details",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - /** - * - */ - public function testGetFileDetailsWithMissingFileId() - { - $fileId = ''; - - $mockBodyResponse = Utils::streamFor(); - - $this->stubHttpClient('get', new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse)); - - $response = $this->client->getFileDetails($fileId); - - FileTest::assertEquals('Missing File ID parameter for this request',$response->error->message); - } - - /** - * - */ - public function testGetFileDetailsWithError() - { - $fileId = '23902390239203923'; - - $this->stubHttpClient('get', new Response(500, ['X-Foo' => 'Bar'], json_encode($this->dummyAPIErrorResponse))); - - $response = $this->client->getFileDetails($fileId); - - FileTest::assertEquals(json_encode($this->dummyAPIErrorResponse),json_encode($response->error)); - } - - /** - * - */ - public function testGetFileVersionDetails() - { - $fileId = '23902390239203923'; - $versionId = '23902390239203923'; - - $responseBody = [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - "versionInfo" => [ - "id" => "598821f949c0a938d57563bd", - "name" => "Version 1" - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getFileVersionDetails($fileId, $versionId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/versions/{$versionId}",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - /** - * - */ - public function testGetFileVersionDetailsWithMissingFileId() - { - $fileId = ''; - $versionId = '23902390239203923'; - - $response = $this->client->getFileVersionDetails($fileId, $versionId); - - FileTest::assertEquals('Missing File ID parameter for this request', $response->error->message); - } - - /** - * - */ - public function testGetFileVersionDetailsWithMissingVersionId() - { - $fileId = '23902390239203923'; - $versionId = ''; - - $response = $this->client->getFileVersionDetails($fileId, $versionId); - - FileTest::assertEquals('Missing Version ID parameter for this request', $response->error->message); - } - - /** - * - */ - public function testGetFileVersions() - { - $fileId = '23902390239203923'; - - $responseBody = [ - [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - "versionInfo" => [ - "id" => "598821f949c0a938d57563bd", - "name" => "Version 1" - ] - ], - [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - "versionInfo" => [ - "id" => "330a81i1f949c0a938d57563bd", - "name" => "Version 2" - ] - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getFileVersions($fileId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/versions",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - - /** - * - */ - public function testGetFileVersionsWithMissingFileId() - { - $fileId = ''; - - $response = $this->client->getFileVersions($fileId); - - FileTest::assertEquals('Missing File ID parameter for this request', $response->error->message); - } - - - /** - * - */ - public function testUpdateFileDetails() - { - $fileId = '5df36759adf3f523d81dd94f'; - - $updateData = [ - 'customCoordinates' => '10,10,100,100', - 'tags' => ['tag1', 'tag2'], - 'removeAITags'=>['car','vehicle','motorsports'], - 'extensions'=>[ - [ - "name" => "google-auto-tagging", - "maxTags" => 5, - "minConfidence" => 95 - ] - ], - "customMetadata" => [ - "SKU" => "VS882HJ2JD", - "price" => 599.99, - ] - ]; - - $responseBody = [ - 'fileId' => '598821f949c0a938d57563bd', - 'type' => 'file', - 'name' => 'file1.jpg', - 'filePath' => '/images/products/file1.jpg', - 'tags' => ['t-shirt', 'round-neck', 'sale2019'], - 'isPrivateFile' => false, - 'customCoordinates' => null, - 'url' => 'https://ik.imagekit.io/your_imagekit_id/images/products/file1.jpg', - 'thumbnail' => 'https://ik.imagekit.io/your_imagekit_id/tr:n-media_library_thumbnail/images/products/file1.jpg', - 'fileType' => 'image' - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->updateFileDetails($fileId, $updateData); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/details",$requestPath); - FileTest::assertEquals($stream,json_encode($updateData)); - - // Response Check - FileTest::assertNull($response->error); - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PATCH'); - } - - /** - * - */ - public function testUpdateFilePublishStatus() - { - $fileId = '5df36759adf3f523d81dd94f'; - - $updateData = [ - "publish" => [ - "isPublished" => true, - "includeFileVersions" => true - ] - ]; - - $responseBody = [ - 'fileId' => '598821f949c0a938d57563bd', - 'type' => 'file', - 'name' => 'file1.jpg', - 'filePath' => '/images/products/file1.jpg', - 'tags' => ['t-shirt', 'round-neck', 'sale2019'], - 'isPrivateFile' => false, - 'isPublished' => true, - 'customCoordinates' => null, - 'url' => 'https://ik.imagekit.io/your_imagekit_id/images/products/file1.jpg', - 'thumbnail' => 'https://ik.imagekit.io/your_imagekit_id/tr:n-media_library_thumbnail/images/products/file1.jpg', - 'fileType' => 'image' - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->updateFileDetails($fileId, $updateData); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/details",$requestPath); - FileTest::assertEquals($stream,json_encode($updateData)); - - // Response Check - FileTest::assertNull($response->error); - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PATCH'); - } - - public function testUpdateFileDetailsWithInvalidTags() - { - $fileId = '5df36759adf3f523d81dd94f'; - - $updateData = [ - 'customCoordinates' => '10,10,100,100', - 'tags' => 'tag1,tag2', - 'removeAITags'=>['car','vehicle','motorsports'], - 'extensions'=>[ - [ - "name" => "google-auto-tagging", - "maxTags" => 5, - "minConfidence" => 95 - ] - ], - "customMetadata" => [ - "SKU" => "VS882HJ2JD", - "price" => 599.99, - ] - ]; - - $response = $this->client->updateFileDetails($fileId, $updateData); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Invalid tags parameter for this request', $response->error->message); - } - - /** - * - */ - public function testUpdateFileDetailsWithMissingFileId() - { - $fileId = ''; - - $updateData = [ - 'customCoordinates' => '10,10,100,100', - 'tags' => ['tag1', 'tag2'] - ]; - - $response = $this->client->updateFileDetails($fileId, $updateData); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing File ID parameter for this request', $response->error->message); - } - - - /** - * - */ - public function testUpdateFileDetailsWithInvalidUpdateData() - { - $fileId = '5df36759adf3f523d81dd94f'; - - $updateData = []; - - $response = $this->client->updateFileDetails($fileId, $updateData); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing file update data for this request', $response->error->message); - } - - - /** - * - */ - public function testUpdateFileDetailsWithError() - { - $fileId = '5df36759adf3f523d81dd94f'; - - $updateData = [ - 'customCoordinates' => '10,10,100,100', - 'tags' => ['tag1', 'tag2'] - ]; - - $this->stubHttpClient('patch', new Response(500, ['X-Foo' => 'Bar'], json_encode($this->dummyAPIErrorResponse))); - - $response = $this->client->updateFileDetails($fileId, $updateData); - - FileTest::assertEquals(json_encode($this->dummyAPIErrorResponse),json_encode($response->error)); - } - - - /** - * - */ - public function testBulkAddTags() - { - $fileIds = ['5e21880d5efe355febd4bccd','5e1c13c1c55ec3437c451403']; - $tags = ['testing_tag1']; - - $responseBody = [ - "successfullyUpdatedFileIds" => [ - "5e21880d5efe355febd4bccd", - "5e1c13c1c55ec3437c451403" - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->bulkAddTags($fileIds, $tags); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals($stream['fileIds'],$fileIds); - FileTest::assertEquals($stream['tags'],$tags); - FileTest::assertEquals("/v1/files/addTags",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - /** - * - */ - public function testBulkAddTagsMissingFileIds() - { - $fileIds = []; - $tags = ['testing_tag1']; - - $response = $this->client->bulkAddTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array of ids, empty array passed', $response->error->message); - } - - - /** - * - */ - public function testBulkAddTagsMissingTags() - { - $fileIds = ['23902390239203923']; - $tags = []; - - $response = $this->client->bulkAddTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array of tags, empty array passed', $response->error->message); - } - - /** - * - */ - public function testBulkAddTagsNonArrayFileId() - { - $fileIds = '23902390239203923'; - $tags = ['testing_tag1']; - - $response = $this->client->bulkAddTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testBulkAddTagsNonArrayTags() - { - $fileIds = ['23902390239203923']; - $tags = 'testing_tag1'; - - $response = $this->client->bulkAddTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveTags() - { - $fileIds = ['23902390239203923']; - $tags = ['testing_tag1']; - - $responseBody = [ - "successfullyUpdatedFileIds" => [ - "23902390239203923", - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->bulkRemoveTags($fileIds, $tags); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals($stream['fileIds'],$fileIds); - FileTest::assertEquals($stream['tags'],$tags); - FileTest::assertEquals("/v1/files/removeTags",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testBulkRemoveTagsMissingFileIds() - { - $fileIds = []; - $tags = ['testing_tag1']; - - $response = $this->client->bulkRemoveTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array of ids, empty array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveTagsMissingTags() - { - $fileIds = ['23902390239203923']; - $tags = []; - - $response = $this->client->bulkRemoveTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array of tags, empty array passed', $response->error->message); - } - - - /** - * - */ - public function testBulkRemoveTagsNonArrayFileId() - { - $fileIds = '23902390239203923'; - $tags = ['testing_tag1']; - - $response = $this->client->bulkRemoveTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveTagsNonArrayTags() - { - $fileIds = ['23902390239203923']; - $tags = 'testing_tag1'; - - $response = $this->client->bulkRemoveTags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveAITags() - { - $fileIds = ['5e21880d5efe355febd4bccd','5e1c13c1c55ec3437c451403']; - $AItags = ['image_AITag_1','image_AITag_2']; - - $responseBody = [ - "successfullyUpdatedFileIds" => [ - "5e21880d5efe355febd4bccd", - "5e1c13c1c55ec3437c451403" - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->bulkRemoveAITags($fileIds, $AItags); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals($stream['fileIds'],$fileIds); - FileTest::assertEquals($stream['AITags'],$AItags); - FileTest::assertEquals("/v1/files/removeAITags",$requestPath); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testBulkRemoveAITagsMissingFileIds() - { - $fileIds = []; - $tags = ['image_AITag_1']; - - $response = $this->client->bulkRemoveAITags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array of ids, empty array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveAITagsMissingTags() - { - $fileIds = ['23902390239203923']; - $tags = []; - - $response = $this->client->bulkRemoveAITags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array of tags, empty array passed', $response->error->message); - } - - - /** - * - */ - public function testBulkRemoveAITagsNonArrayFileId() - { - $fileIds = '23902390239203923'; - $tags = ['testing_tag1']; - - $response = $this->client->bulkRemoveAITags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts FileIds as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testBulkRemoveAITagsNonArrayTags() - { - $fileIds = ['23902390239203923']; - $tags = 'testing_tag1'; - - $response = $this->client->bulkRemoveAITags($fileIds, $tags); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Bulk Tags API accepts Tags as an array, non array passed', $response->error->message); - } - - /** - * - */ - public function testDeleteSingleFile() - { - $fileId = "23902390239203923"; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->deleteFile($fileId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/".$fileId,$requestPath); - FileTest::assertEquals($stream[0],$fileId); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'DELETE'); - } - - /** - * - */ - public function testDeleteSingleFileMissingFileId() - { - $fileId = ""; - - $response = $this->client->deleteFile($fileId); - - FileTest::assertEquals('Missing File ID parameter for this request',$response->error->message); - } - - /** - * - */ - public function testDeleteFileVersion() - { - $fileId = '23902390239203923'; - $versionId = "123213239023902392"; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->deleteFileVersion($fileId, $versionId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/versions/{$versionId}",$requestPath); - FileTest::assertEquals($stream[0],$fileId); - FileTest::assertEquals($stream[1],$versionId); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'DELETE'); - } - - /** - * - */ - public function testDeleteFileVersionWithMissingFileId() - { - $fileId = ""; - $versionId = "version_id"; - - $response = $this->client->deleteFileVersion($fileId, $versionId); - - FileTest::assertEquals('Missing File ID parameter for this request',$response->error->message); - } - - /** - * - */ - public function testDeleteFileVersionWithMissingVisionId() - { - $fileId = "file_id"; - $versionId = ""; - - $response = $this->client->deleteFileVersion($fileId, $versionId); - - FileTest::assertEquals('Missing Version ID parameter for this request',$response->error->message); - } - - /** - * - */ - public function testBulkDeleteFiles() - { - $fileIds = ['file_id1','file_id2']; - - $responseBody = [ - "successfullyDeletedFileIds" => [ - "5e21880d5efe355febd4bccd", - "5e1c13c1c55ec3437c451403" - ] - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->bulkDeleteFiles($fileIds); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $requestBody = $request->getBody(); - $stream = Utils::streamFor($requestBody)->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/batch/deleteByFileIds",$requestPath); - FileTest::assertEquals($stream['fileIds'],$fileIds); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testBulkDeleteFilesInvalidRequest() - { - $response = $this->client->bulkDeleteFiles(); - - FileTest::assertEquals('Missing Parameter FileIds', $response->error->message); - } - - /** - * - */ - public function testBulkDeleteFilesMissingFileIds() - { - $fileIds = []; - $response = $this->client->bulkDeleteFiles($fileIds); - - FileTest::assertEquals('File ids should be passed as an array of file ids, empty array passed', $response->error->message); - } - - /** - * - */ - public function testBulkDeleteFilesNonArrayFileIds() - { - $fileIds = 'file_id'; - $response = $this->client->bulkDeleteFiles($fileIds); - - FileTest::assertEquals('File ids should be passed in an array', $response->error->message); - } - - /** - * - */ - public function testCopyFile() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - $includeFileVersions = true; - - $requestBody = [ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => $includeFileVersions - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->copy($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - // $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/copy",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - /** - * - */ - public function testCopyFileWithoutIncludeFileVersions() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - $includeFileVersions = true; - - $requestBody = [ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath, - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->copy($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - // $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/copy",$requestPath); - FileTest::assertEquals($stream,json_encode([ - 'sourceFilePath' => '/file.jpg', - 'destinationPath' => '/', - 'includeFileVersions' => false - ])); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testCopyFileInvalidParameter() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - $includeVersions = true; - - $requestBody = []; - - $response = $this->client->copy($requestBody); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Copy File API accepts an array of parameters, empty array passed',$response->error->message); - - } - - - /** - * - */ - public function testCopyFileMissingSourceFilePath() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - $includeVersions = true; - - $requestBody = [ - 'destinationPath' => $destinationPath, - 'includeVersions' => $includeVersions - ]; - - $response = $this->client->copy($requestBody); - - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing parameter sourceFilePath and/or destinationPath for Copy File API',$response->error->message); - } - - /** - * - */ - public function testCopyFileMissingDestinationPath() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - $includeVersions = true; - - $requestBody = [ - 'sourceFilePath' => $sourceFilePath, - 'includeVersions' => $includeVersions - ]; - - $response = $this->client->copy($requestBody); - - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing parameter sourceFilePath and/or destinationPath for Copy File API',$response->error->message); - - } - - /** - * - */ - public function testMoveFile() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - - $requestBody = [ - 'sourceFilePath' => $sourceFilePath, - 'destinationPath' => $destinationPath - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->move($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/move",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testMoveFileInvalidParameter() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - - $requestBody = []; - - $response = $this->client->move($requestBody); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Move File API accepts an array of parameters, empty array passed',$response->error->message); - } - - /** - * - */ - public function testMoveFileMissingSourceFilePath() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - - $requestBody = [ - 'destinationPath' => $destinationPath, - ]; - - $response = $this->client->move($requestBody); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing parameter sourceFilePath and/or destinationPath for Move File API',$response->error->message); - } - - /** - * - */ - public function testMoveFileMissingDestinationPath() - { - $sourceFilePath = '/file.jpg'; - $destinationPath = '/'; - - $requestBody = [ - 'sourceFilePath' => $sourceFilePath, - ]; - - $response = $this->client->move($requestBody); - - FileTest::assertNull($response->result); - FileTest::assertEquals('Missing parameter sourceFilePath and/or destinationPath for Move File API',$response->error->message); - - } - - /** - * - */ - public function testRenameFile() - { - $filePath = '/sample-folder/sample-file.jpg'; - $newFileName = 'sample-file2.jpg'; - - $requestBody = [ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - 'purgeCache' => true - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->rename($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/rename",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PUT'); - } - - - /** - * - */ - public function testRenameFileWithoutPurgeCache() - { - $filePath = '/sample-folder/sample-file.jpg'; - $newFileName = 'sample-file2.jpg'; - - $requestBody = [ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->rename($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/files/rename",$requestPath); - FileTest::assertEquals($stream,json_encode([ - 'filePath' => '/sample-folder/sample-file.jpg', - 'newFileName' => 'sample-file2.jpg', - 'purgeCache' => false - ])); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PUT'); - } - - /** - * - */ - public function testRenameFileWithInvalidRequest() - { - $response = $this->client->rename(); - - FileTest::assertEquals('Rename File API accepts an array, null passed',$response->error->message); - } - - /** - * - */ - public function testRenameFileWithNonArrayParameter() - { - $filePath = '/sample-folder/sample-file.jpg'; - $newFileName = 'sample-file2.jpg'; - - $requestBody = $filePath; - - $response = $this->client->rename($requestBody); - - FileTest::assertEquals('Rename File API accepts an array of parameters, non array value passed',$response->error->message); - } - - /** - * - */ - public function testRenameFileWithEmptyArrayParameter() - { - $requestBody = []; - - $response = $this->client->rename($requestBody); - - FileTest::assertEquals('Rename File API accepts an array of parameters, empty array passed',$response->error->message); - } - - /** - * - */ - public function testRenameFileWithMissingFilePath() - { - $filePath = ''; - $newFileName = 'sample-file2.jpg'; - - $requestBody = [ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - ]; - - $response = $this->client->rename($requestBody); - - FileTest::assertEquals('Missing parameter filePath and/or newFileName for Rename File API',$response->error->message); - } - - /** - * - */ - public function testRenameFileWithMissingNewFileName() - { - $filePath = '/sample-folder/sample-file.jpg'; - $newFileName = ''; - - $requestBody = [ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - ]; - - $response = $this->client->rename($requestBody); - - FileTest::assertEquals('Missing parameter filePath and/or newFileName for Rename File API',$response->error->message); - } - - /** - * - */ - public function testRestoreFileVersion() - { - $fileId = 'fileId'; - $versionId = 'versionId'; - - $requestBody = [ - 'fileId' => $fileId, - 'versionId' => $versionId, - ]; - - $responseBody = [ - 'type' => 'file', - 'name' => 'default-image.jpg', - 'fileId' => '5de4fb65c851e55df73abe8d', - 'tags' => null, - 'customCoordinates' => null, - 'isPrivateFile' => false, - 'url' => 'https://ik.imagekit.io/ot2cky3ujwa/default-image.jpg', - 'thumbnail' => 'https://ik.imagekit.io/ot2cky3ujwa/tr:n-media_library_thumbnail/default-image.jpg', - 'fileType' => 'image', - 'filePath' => '/default-image.jpg', - "versionInfo" => [ - "id" => "598821f949c0a938d57563bd", - "name" => "Version 1" - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->restoreFileVersion($requestBody); - - $request = $container[0]['request']; - $queryString = $request->getUri()->getQuery(); - $requestPath = $request->getUri()->getPath(); - - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/versions/{$versionId}/restore",$requestPath); - FileTest::assertEmpty($stream); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'PUT'); - } - - /** - * - */ - public function testRestoreFileVersionWithInvalidRequest() - { - $response = $this->client->restoreFileVersion(); - - FileTest::assertEquals('Restore File Version API accepts an array, null passed',$response->error->message); - } - - /** - * - */ - public function testRestoreFileVersionWithNonArrayParameter() - { - $fileId = 'fileId'; - $versionId = 'versionId'; - - $requestBody = $fileId; - - $response = $this->client->restoreFileVersion($requestBody); - - FileTest::assertEquals('Restore File Version API accepts an array of parameters, non array value passed',$response->error->message); - } - - /** - * - */ - public function testRestoreFileVersionWithEmptyArrayParameter() - { - $requestBody = []; - - $response = $this->client->restoreFileVersion($requestBody); - - FileTest::assertEquals('Restore File Version API accepts an array of parameters, empty array passed',$response->error->message); - } - - /** - * - */ - public function testRestoreFileVersionWithMissingFileId() - { - $fileId = ''; - $versionId = 'versionId'; - - $requestBody = [ - 'fileId' => $fileId, - 'versionId' => $versionId, - ]; - - $response = $this->client->restoreFileVersion($requestBody); - - FileTest::assertEquals('Missing parameter fileId and/or versionId for Restore File Version API',$response->error->message); - } - - /** - * - */ - public function testRestoreFileVersionWithMissingVersionId() - { - $fileId = 'fileId'; - $versionId = ''; - - $requestBody = [ - 'fileId' => $fileId, - 'versionId' => $versionId, - ]; - - $response = $this->client->restoreFileVersion($requestBody); - - FileTest::assertEquals('Missing parameter fileId and/or versionId for Restore File Version API',$response->error->message); - } - - - - /** - * - */ - public function testGetFileMetadataUsingFileId() - { - $fileId = '5de4fb65c851e55df73abe8d'; - - $responseBody = [ - 'height' => 3214, - 'width' => 3948, - 'size' => 207097, - 'format' => 'jpg', - 'hasColorProfile' => true, - 'quality' => 90, - 'density' => 300, - 'hasTransparency' => false, - 'exif' => [ - 'image' => [ - 'ImageWidth' => 4584, - 'ImageHeight' => 3334, - 'BitsPerSample' => [8, 8, 8], - 'PhotometricInterpretation' => 2, - 'ImageDescription' => 'Character illustration of people holding creative ideas icons', - 'Orientation' => 1, - 'SamplesPerPixel' => 3, - 'XResolution' => 300, - 'YResolution' => 300, - 'ResolutionUnit' => 2, - 'Software' => 'Adobe Photoshop CC 2019 (Windows)', - 'ModifyDate' => '2019=>05=>25 10=>16=>49', - 'Artist' => 'busbus', - 'Copyright' => 'Rawpixel Ltd.', - 'ExifOffset' => 356 - ], - 'thumbnail' => [ - 'Compression' => 6, - 'XResolution' => 72, - 'YResolution' => 72, - 'ResolutionUnit' => 2, - 'ThumbnailOffset' => 506, - 'ThumbnailLength' => 6230, - ], - 'exif' => [ - 'ExifVersion' => '0221', - 'ColorSpace' => 65535, - 'ExifImageWidth' => 3948, - 'ExifImageHeight' => 3214 - ], - 'gps' => [], - 'interoperability' => [], - 'makernote' => [], - ], - 'pHash' => 'd1813e2fc22c7b2f', - ]; - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getFileMetaData($fileId); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $queryString = $request->getUri()->getQuery(); - $stream = Utils::streamFor($request->getBody())->getContents(); - // $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/files/{$fileId}/metadata",$requestPath); - FileTest::assertEmpty($stream); - - // Response Check - FileTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - - /** - * - */ - public function testGetFileMetadataUsingFileIdWithMissingFileId() - { - $fileId = ''; - - $response = $this->client->getFileMetaData($fileId); - - FileTest::assertEquals('Missing File ID parameter for this request', $response->error->message); - } - - /** - * - */ - public function testGetFileMetadataUsingRemoteURL() - { - $remoteURL = 'https://ik.imagekit.io/demo/sample-folder/default-image.jpg'; - - $requestBody = [ - 'height' => 3214, - 'width' => 3948, - 'size' => 207097, - 'format' => 'jpg', - 'hasColorProfile' => true, - 'quality' => 90, - 'density' => 300, - 'hasTransparency' => false, - 'exif' => [ - 'image' => [ - 'ImageWidth' => 4584, - 'ImageHeight' => 3334, - 'BitsPerSample' => [8, 8, 8], - 'PhotometricInterpretation' => 2, - 'ImageDescription' => 'Character illustration of people holding creative ideas icons', - 'Orientation' => 1, - 'SamplesPerPixel' => 3, - 'XResolution' => 300, - 'YResolution' => 300, - 'ResolutionUnit' => 2, - 'Software' => 'Adobe Photoshop CC 2019 (Windows)', - 'ModifyDate' => '2019=>05=>25 10=>16=>49', - 'Artist' => 'busbus', - 'Copyright' => 'Rawpixel Ltd.', - 'ExifOffset' => 356 - ], - 'thumbnail' => [ - 'Compression' => 6, - 'XResolution' => 72, - 'YResolution' => 72, - 'ResolutionUnit' => 2, - 'ThumbnailOffset' => 506, - 'ThumbnailLength' => 6230, - ], - 'exif' => [ - 'ExifVersion' => '0221', - 'ColorSpace' => 65535, - 'ExifImageWidth' => 3948, - 'ExifImageHeight' => 3214 - ], - 'gps' => [], - 'interoperability' => [], - 'makernote' => [], - ], - 'pHash' => 'd1813e2fc22c7b2f', - ]; - $mockBodyResponse = Utils::streamFor(json_encode($requestBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->getFileMetadataFromRemoteURL($remoteURL); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $queryString = $request->getUri()->getQuery(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/metadata",$requestPath); - FileTest::assertEquals($queryString,http_build_query(['url'=>$remoteURL])); - - // Response Check - FileTest::assertEquals(json_encode($requestBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'GET'); - } - - - - /** - * - */ - public function testGetFileMetadataUsingRemoteURLMissingURL() - { - $remoteURL = ''; - - $response = $this->client->getFileMetadataFromRemoteURL($remoteURL); - - FileTest::assertEquals('Your request is missing the url query paramater', $response->error->message); - } - - /** - * - */ - public function testGetFileMetadataUsingRemoteURLInvalidURL() - { - $remoteURL = 'invalid_url'; - - $response = $this->client->getFileMetadataFromRemoteURL($remoteURL); - - FileTest::assertEquals('Invalid URL provided for this request', $response->error->message); - } - - /** - * - */ - private function stubHttpClient($methodName, $response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method($methodName)->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - /** - * - */ - private function createMockClient($handler){ - $this->mockClient = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo', - Transformation::DEFAULT_TRANSFORMATION_POSITION, - $handler - ); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - } - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Manage/FolderTest.php b/tests/ImageKit/Manage/FolderTest.php deleted file mode 100644 index e0fa83a2..00000000 --- a/tests/ImageKit/Manage/FolderTest.php +++ /dev/null @@ -1,565 +0,0 @@ - $parentFolderPath, - 'folderName' => $folderName, - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->createFolder($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/folder/",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testCreateFolderInvalidRequest() - { - $response = $this->client->createFolder(); - - FolderTest::assertEquals('Create Folder API accepts an array, null passed',$response->error->message); - } - - /** - * - */ - public function testCreateFolderWithNonArrayParameter() - { - $folderName = 'new-folder'; - $parentFolderPath = '/'; - - $requestBody = $folderName; - - $response = $this->client->createFolder($requestBody); - - FolderTest::assertEquals('Create Folder API accepts an array of parameters, non array value passed',$response->error->message); - } - - /** - * - */ - public function testCreateFolderWithEmptyArrayParameter() - { - $requestBody = []; - - $response = $this->client->createFolder($requestBody); - - FolderTest::assertEquals('Create Folder API accepts an array of parameters, empty array passed',$response->error->message); - } - - - public function testCreateFolderWithMissingFolderName() - { - $folderName = ''; - $parentFolderPath = '/'; - - $requestBody = [ - 'folderName' => $folderName, - 'parentFolderPath' => $parentFolderPath, - ]; - - $response = $this->client->createFolder($requestBody); - - FolderTest::assertEquals('Missing parameter folderName and/or parentFolderPath for Create Folder API', $response->error->message); - } - - public function testCreateFolderWithMissingParentFolderPath() - { - $folderName = 'new-folder'; - $parentFolderPath = ''; - - $requestBody = [ - 'folderName' => $folderName, - 'parentFolderPath' => $parentFolderPath, - ]; - - $response = $this->client->createFolder($requestBody); - - FolderTest::assertEquals('Missing parameter folderName and/or parentFolderPath for Create Folder API', $response->error->message); - } - - /** - * - */ - public function testDeleteFolder() - { - $folderPath = '/new-folder'; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->deleteFolder($folderPath); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - $stream = json_decode($stream,true); - - // Request Check - FileTest::assertEquals("/v1/folder/",$requestPath); - FileTest::assertEquals($stream['folderPath'],$folderPath); - - // Response Check - FolderTest::assertNull($response->result); - FolderTest::assertNull($response->error); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'DELETE'); - } - - /** - * - */ - public function testDeleteFolderMissingFolderPath() - { - $folderPath = ''; - - $response = $this->client->deleteFolder($folderPath); - - FolderTest::assertEquals('Missing folderPath for Delete Folder API',$response->error->message); - } - - public function testCopyFolder(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - $includeFileVersions = false; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeFileVersions' => $includeFileVersions - ]; - - $responseBody = [ - "jobId" => "598821f949c0a938d57563bd" - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->copyFolder($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/bulkJobs/copyFolder",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - public function testCopyFolderWithoutIncludeFileVersions(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - ]; - - $responseBody = [ - "jobId" => "598821f949c0a938d57563bd" - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->copyFolder($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/bulkJobs/copyFolder",$requestPath); - FileTest::assertEquals($stream,json_encode([ - 'sourceFolderPath' => '/source-folder/', - 'destinationPath' => '/destination-folder/', - 'includeFileVersions' => false - ])); - - // Response Check - FolderTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - public function testCopyFolderInvalidRequest(){ - - $response = $this->client->copyFolder(); - - FolderTest::assertEquals("Copy Folder API accepts an array, null passed", $response->error->message); - - } - - public function testCopyFolderNonArray(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - $includeVersions = false; - - $requestBody = $sourceFolderPath; - $response = $this->client->copyFolder($requestBody); - - FolderTest::assertEquals("Copy Folder API accepts an array of parameters, non array value passed", $response->error->message); - - } - - public function testCopyFolderEmptyArray(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - $includeVersions = false; - - $requestBody = []; - $response = $this->client->copyFolder($requestBody); - - FolderTest::assertEquals("Copy Folder API accepts an array of parameters, empty array passed", $response->error->message); - - } - - public function testCopyFolderWithMissingSourceFolderPath(){ - - $sourceFolderPath = ""; - $destinationPath = "/destination-folder/"; - $includeVersions = false; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeVersions' => $includeVersions - ]; - - $response = $this->client->copyFolder($requestBody); - - FolderTest::assertEquals("Missing parameter sourceFolderPath and/or destinationPath for Copy Folder API", $response->error->message); - - } - - public function testCopyFolderWithMissingDestinationPath(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = ""; - $includeVersions = false; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeVersions' => $includeVersions - ]; - - $response = $this->client->copyFolder($requestBody); - - FolderTest::assertEquals("Missing parameter sourceFolderPath and/or destinationPath for Copy Folder API", $response->error->message); - - } - - public function testCopyFolderWithNullIncludeVersions(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - $includeVersions = null; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - 'includeVersions' => $includeVersions - ]; - - $mockBodyResponse = Utils::streamFor(); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->copyFolder($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/bulkJobs/copyFolder",$requestPath); - FileTest::assertEquals($stream,json_encode([ - 'sourceFolderPath' => '/source-folder/', - 'destinationPath' => '/destination-folder/', - 'includeFileVersions' => false - ])); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - public function testMoveFolder(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - ]; - - $responseBody = [ - "jobId" => "598821f949c0a938d57563bd" - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($responseBody)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->moveFolder($requestBody); - - $request = $container[0]['request']; - $requestPath = $request->getUri()->getPath(); - $stream = Utils::streamFor($request->getBody())->getContents(); - - // Request Check - FileTest::assertEquals("/v1/bulkJobs/moveFolder",$requestPath); - FileTest::assertEquals($stream,json_encode($requestBody)); - - // Response Check - FolderTest::assertEquals(json_encode($responseBody), json_encode($response->result)); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - FileTest::assertEquals($requestMethod,'POST'); - } - - - public function testMoveFolderInvalidRequest(){ - - $response = $this->client->moveFolder(); - - FolderTest::assertEquals("Move Folder API accepts an array, null passed", $response->error->message); - - } - - public function testMoveFolderNonArray(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - - $requestBody = $sourceFolderPath; - $response = $this->client->moveFolder($requestBody); - - FolderTest::assertEquals("Move Folder API accepts an array of parameters, non array value passed", $response->error->message); - - } - - public function testMoveFolderEmptyArray(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = "/destination-folder/"; - - $requestBody = []; - $response = $this->client->moveFolder($requestBody); - - FolderTest::assertEquals("Move Folder API accepts an array of parameters, empty array passed", $response->error->message); - - } - - public function testMoveFolderWithMissingSourceFolderPath(){ - - $sourceFolderPath = ""; - $destinationPath = "/destination-folder/"; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - ]; - - $response = $this->client->moveFolder($requestBody); - - FolderTest::assertEquals("Missing parameter sourceFolderPath and/or destinationPath for Move Folder API", $response->error->message); - - } - - public function testMoveFolderWithMissingDestinationPath(){ - - $sourceFolderPath = "/source-folder/"; - $destinationPath = ""; - - $requestBody = [ - 'sourceFolderPath' => $sourceFolderPath, - 'destinationPath' => $destinationPath, - ]; - - $response = $this->client->moveFolder($requestBody); - - FolderTest::assertEquals("Missing parameter sourceFolderPath and/or destinationPath for Move Folder API", $response->error->message); - - } - - - private function stubHttpClient($methodName, $response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method($methodName)->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - } - - /** - * - */ - private function createMockClient($handler){ - $this->mockClient = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo', - Transformation::DEFAULT_TRANSFORMATION_POSITION, - $handler - ); - } - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Phash/PhashTest.php b/tests/ImageKit/Phash/PhashTest.php deleted file mode 100644 index 0578e0c3..00000000 --- a/tests/ImageKit/Phash/PhashTest.php +++ /dev/null @@ -1,55 +0,0 @@ -pHashDistance($firstHash, $secondHash); - PhashTest::assertEquals(0, $response); - } - - /** - * - */ - public function testPHashDistanceForSimilarImages() - { - $firstHash = '2d5ad3936d2e015b'; - $secondHash = '2d6ed293db36a4fb'; - - $pHash = new Phash(); - $response = $pHash->pHashDistance($firstHash, $secondHash); - PhashTest::assertEquals(17, $response); - } - - /** - * - */ - public function testPHashDistanceForDissimilarImages() - { - $firstHash = '33699c96619cc69e'; - $secondHash = '968e978414fe04ea'; - - $pHash = new Phash(); - $response = $pHash->pHashDistance($firstHash, $secondHash); - PhashTest::assertEquals(30, $response); - } -} diff --git a/tests/ImageKit/Resource/GuzzleHttpWrapperTest.php b/tests/ImageKit/Resource/GuzzleHttpWrapperTest.php deleted file mode 100644 index 72e29efb..00000000 --- a/tests/ImageKit/Resource/GuzzleHttpWrapperTest.php +++ /dev/null @@ -1,41 +0,0 @@ - 'Test', - 'param2' => '', - 'param3' => null, - 'param4' => [], - 'param5' => [], - 'param6' => true, - 'param7' => false, - 'param8' => 0 - ]; - - $stub = $this->createMock(Client::class); - - $resource = new GuzzleHttpWrapper($stub); - $resource->setDatas($data); - - GuzzleHttpWrapperTest::assertEquals(['param1' => 'Test', 'param6' => true, 'param7' => false, 'param8' => 0], $resource->getDatas()); - } -} diff --git a/tests/ImageKit/Upload/UploadTest.php b/tests/ImageKit/Upload/UploadTest.php deleted file mode 100644 index 8c8b1df9..00000000 --- a/tests/ImageKit/Upload/UploadTest.php +++ /dev/null @@ -1,856 +0,0 @@ - "598821f949c0a938d57563bd", - "name"=> "file1.jpg", - "url"=> "https://ik.imagekit.io/your_imagekit_id/images/products/file1.jpg", - "thumbnailUrl"=> "https://ik.imagekit.io/your_imagekit_id/tr:n-media_library_thumbnail/images/products/file1.jpg", - "height"=> 300, - "width"=> 200, - "size"=> 83622, - "filePath"=> "/images/products/file1.jpg", - "tags"=> ["t-shirt", "round-neck", "sale2019"], - "isPrivateFile"=> false, - "customCoordinates"=> null, - "fileType"=> "image", - "AITags"=>[["name"=>"Face","confidence"=>99.95,"source"=>"aws-auto-tagging"]], - "extensionStatus"=>["aws-auto-tagging"=>"success"] - ]; - - /** - * - */ - private function stubHttpClient($response) - { - $stub = $this->createMock(GuzzleHttpWrapper::class); - $stub->method('setDatas'); - $stub->method('postMultipart')->willReturn($response); - - $closure = function () use ($stub) { - $this->httpClient = $stub; - }; - $doClosure = $closure->bindTo($this->client, ImageKit::class); - $doClosure(); - } - - /** - * - */ - private function createMockClient($handler){ - $this->mockClient = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo', - Transformation::DEFAULT_TRANSFORMATION_POSITION, - $handler - ); - } - - private function checkFormData($requestBody, $boundary, $fieldName, $fieldValue) { - - $string = '--'.$boundary.' Content-Disposition: form-data; name="'.$fieldName.'" Content-Length: '.strlen($fieldValue).' '.$fieldValue; - $string = substr(json_encode($string),1,-1); - - UploadTest::assertContains($string,$requestBody); - } - - /** - * - */ - public function testFileUploadIfInvalidUploadParams() - { - - $mockBodyResponse = Utils::streamFor(); - - $response = $this->client->uploadFile(null); - - UploadTest::assertNull($response->result); - UploadTest::assertEquals('Upload API accepts an array of parameters, null passed', $response->error->message); - } - - /** - * - */ - public function testFileUploadIfMissingFileName() - { - - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - ]; - - $response = $this->client->uploadFile($fileOptions); - - UploadTest::assertNull($response->result); - UploadTest::assertEquals('Missing fileName parameter for upload', $response->error->message); - } - - /** - * - */ - public function testFileUploadIfMissingFile() - { - $fileOptions = [ - 'fileName' => 'default-image.png', - ]; - - $response = $this->client->uploadFile($fileOptions); - - UploadTest::assertNull($response->result); - UploadTest::assertEquals('Missing file parameter for upload', $response->error->message); - } - - - /** - * - */ - public function testFileUploadIfSuccessful() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => false, // true|false - "tags" => implode(',',["abd", "def"]), // Comma Separated, Max length: 500 chars - "folder" => "/sample-folder", // Using multiple forward slash (/) creates a nested folder - "isPrivateFile" => true, // true|false - "customCoordinates" => implode(",", ["10", "10", "100", "100"]), // Comma Separated, Max length: 500 chars - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - "extensions" => [ // An array of extensions, for more extensions refer to docs - [ - "name" => "remove-bg", - "options" => [ // all parameters inside this object are sent directly to the third-party service - "add_shadow" => true - ] - ] - ], - "webhookUrl" => "https://example.com/webhook", // Notification URL to receive the final status of pending extensions - "overwriteFile" => true, // true|false, in case of false useUniqueFileName should be true - "overwriteAITags" => false, // true|false, set to false in order to preserve overwriteAITags - "overwriteTags" => false, // true|false - "overwriteCustomMetadata" => true, // true|false - "customMetadata" => [ // An array of created custom fields, for more details refer to docs - "SKU" => "VS882HJ2JD", - "price" => 599.99, - ], - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], - 'checks' => "'request.folder' : '/sample-folder'", - 'isPublished' => true - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($this->uploadSuccessResponseObj)); - - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"tags",implode(',',["abd", "def"])); - $this->checkFormData($stream,$boundary,"isPrivateFile","true"); - $this->checkFormData($stream,$boundary,"useUniqueFileName","false"); - $this->checkFormData($stream,$boundary,"responseFields",implode(",", ["tags", "customMetadata"])); - $this->checkFormData($stream,$boundary,"extensions",json_encode($fileOptions['extensions'])); - $this->checkFormData($stream,$boundary,"webhookUrl","https://example.com/webhook"); - $this->checkFormData($stream,$boundary,"overwriteFile","true"); - $this->checkFormData($stream,$boundary,"overwriteAITags","false"); - $this->checkFormData($stream,$boundary,"overwriteCustomMetadata","true"); - $this->checkFormData($stream,$boundary,"customMetadata",json_encode($fileOptions['customMetadata'])); - $this->checkFormData($stream,$boundary,"transformation",json_encode($fileOptions['transformation'])); - $this->checkFormData($stream,$boundary,"checks",$fileOptions['checks']); - $this->checkFormData($stream,$boundary,"isPublished","true"); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - - // Response Check - UploadTest::assertEquals(json_encode($this->uploadSuccessResponseObj), json_encode($response->result)); - } - - /** - * - */ - public function testFileUploadWithOnlyPreTransformationIfSuccessful() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [ - 'pre' => 'l-text,i-Imagekit,fs-50,l-end', - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($this->uploadSuccessResponseObj)); - - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"useUniqueFileName","true"); - $this->checkFormData($stream,$boundary,"responseFields",implode(",", ["tags", "customMetadata"])); - $this->checkFormData($stream,$boundary,"transformation",json_encode($fileOptions['transformation'])); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - - // Response Check - UploadTest::assertEquals(json_encode($this->uploadSuccessResponseObj), json_encode($response->result)); - } - - /** - * - */ - public function testFileUploadWithOnlyPostTransformationIfSuccessful() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [ - 'post' => [ - [ - 'type' => 'transformation', - 'value' => 'h-100' - ] - ] - ], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($this->uploadSuccessResponseObj)); - - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"useUniqueFileName","true"); - $this->checkFormData($stream,$boundary,"responseFields",implode(",", ["tags", "customMetadata"])); - $this->checkFormData($stream,$boundary,"transformation",json_encode($fileOptions['transformation'])); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - - // Response Check - UploadTest::assertEquals(json_encode($this->uploadSuccessResponseObj), json_encode($response->result)); - } - - /** - * - */ - public function testFileUploadMissingUseUniqueFileName() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - 'isPrivateFile' => true - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"isPrivateFile","true"); - UploadTest::assertNotContains("useUniqueFileName",$stream); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testFileUploadMissingIsPrivateFileUseUniqueFileName() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "tags" => implode(",",["abd", "def"]), - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"tags","abd,def"); - UploadTest::assertNotContains("isPrivateFile",$stream); - UploadTest::assertNotContains("useUniqueFileName",$stream); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testFileUploadTagsAsArray() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "tags" => ["abd", "def"], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"tags","abd,def"); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testFileUploadCustomCoordinatesAsArray() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "customCoordinates" => ["10", "10", "100", "100"], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"customCoordinates","10,10,100,100"); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - - /** - * - */ - public function testFileUploadResponseFieldsAsArray() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "responseFields" => ["tags", "customMetadata"], - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - $this->checkFormData($stream,$boundary,"responseFields","tags,customMetadata"); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testFileUploadBareMinimumRequest() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $mock = new MockHandler([ - new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse) - ]); - - $handlerStack = HandlerStack::create($mock); - - $container = []; - $history = Middleware::history($container); - - $handlerStack->push($history); - - $this->createMockClient($handlerStack); - - $response = $this->mockClient->uploadFile($fileOptions); - - $requestBody = $container[0]['request']->getBody(); - $requestHeaders = $container[0]['request']->getHeaders(); - $boundary = str_replace("multipart/form-data; boundary=","",$requestHeaders["Content-Type"][0]); - - UploadTest::assertArrayHasKey("Content-Type",$requestHeaders); - UploadTest::assertStringStartsWith("multipart/form-data; boundary=",$requestHeaders['Content-Type'][0]); - - $stream = Utils::streamFor($requestBody); - $stream = str_replace('\r\n',' ',json_encode($stream->getContents())); - - $this->checkFormData($stream,$boundary,"file",$fileOptions['file']); - $this->checkFormData($stream,$boundary,"fileName",$fileOptions['fileName']); - UploadTest::assertNotContains("tags",$stream); - UploadTest::assertNotContains("isPrivateFile",$stream); - UploadTest::assertNotContains("useUniqueFileName",$stream); - UploadTest::assertNotContains("customCoordinates",$stream); - UploadTest::assertNotContains("responseFields",$stream); - - // Assert Method - $requestMethod = $container[0]['request']->getMethod(); - UploadTest::assertEquals($requestMethod,'POST'); - } - - /** - * - */ - public function testServerSideError() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - ]; - - $error = [ - "help" => "For support kindly contact us at support@imagekit.io .", - "message" => "Your account cannot be authenticated." - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - /** - * - */ - public function testFileUploadWithInvalidTransformation() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [], - ]; - - $error = [ - "message" => "Invalid transformation parameter. Please include at least pre, post, or both.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - /** - * - */ - public function testFileUploadWithInvalidPreTransformation() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [ - 'pre' => '', - ], - ]; - - $error = [ - "message" => "Invalid pre transformation parameter.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - /** - * - */ - public function testFileUploadWithInvalidAbsTypePostTransformation() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [ - 'post' => [ - [ - 'type' => 'abs', - 'value' => '' - ] - ] - ], - ]; - - $error = [ - "message" => "Invalid post transformation parameter.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - /** - * - */ - public function testFileUploadWithInvalidTransformationTypePostTransformation() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'transformation' => [ - 'post' => [ - [ - 'type' => 'transformation', - 'value' => '' - ] - ] - ], - ]; - - $error = [ - "message" => "Invalid post transformation parameter.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $mockBodyResponse = Utils::streamFor(json_encode($fileOptions)); - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - - /** - * - */ - public function testFileUploadWithInvalidChecks() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'checks' => true - ]; - - $error = [ - "message" => "The value provided for the checks parameter is invalid.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - public function testFileUploadWithInvalidPublishStatus() - { - $fileOptions = [ - 'file' => 'http://lorempixel.com/640/480/', - 'fileName' => 'test_file_name', - "useUniqueFileName" => true, // true|false - "responseFields" => implode(",", ["tags", "customMetadata"]), // Comma Separated, check docs for more responseFields - 'isPublished' => '' - ]; - - $error = [ - "message" => "isPublished must be boolean.", - "help" => "For support kindly contact us at support@imagekit.io ." - ]; - - $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error))); - - $response = $this->client->uploadFile($fileOptions); - - // Request Body Check - UploadTest::assertEquals(json_encode($error),json_encode($response->error)); - } - - protected function setUp() - { - $this->client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - - } - - protected function tearDown() - { - $this->client = null; - } -} diff --git a/tests/ImageKit/Url/UrlTest.php b/tests/ImageKit/Url/UrlTest.php deleted file mode 100644 index 29f87739..00000000 --- a/tests/ImageKit/Url/UrlTest.php +++ /dev/null @@ -1,1283 +0,0 @@ -client = new ImageKit( - 'testing_public_key', - 'testing_private_key', - 'https://ik.imagekit.io/demo' - ); - } - - /** - * - */ - public function testUrlNoPathNoSrc() - { - $url = $this->client->url(); - UrlTest::assertEquals('URL Generation Method accepts an array, null passed', json_decode($url)->error->message); - } - - /** - * - */ - public function testUrlNoTransformationPath() - { - $url = $this->client->url(['path' => '/default-image.jpg']); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlNoTransformationSrc() - { - $url = $this->client->url(['src' => 'https://ik.imagekit.io/demo/default-image.jpg']); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlNullParametersWithPath() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => null, - 'transformationPosition' => null, - 'src' => null - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrl() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'signed' => true - ]); - UrlTest::assertContains( - 'ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithEmptyExpiryString() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'signed' => true, - 'expireSeconds' => '' - ]); - - UrlTest::assertContains( - 'ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithInvalidExpiryString() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'signed' => true, - 'expireSeconds' => 'asdad' - ]); - UrlTest::assertEquals('expireSeconds accepts an integer value, non integer value provided.',json_decode($url)->error->message); - } - - /** - * - */ - public function testUrlSignedUrlWithoutExpiry() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'signed' => true - ]); - UrlTest::assertContains( - '?ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithExpiryWithTransformation() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - "transformation" => [ - [ - "height" => "300", - ] - ], - 'signed' => true, - 'expireSeconds' => 300 - ]); - UrlTest::assertContains( - '?ik-t=', - $url - ); - UrlTest::assertContains( - '&ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithExpiryWithQueryParameters() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - "queryParameters" => - [ - "key" => "value" - ], - 'signed' => true, - 'expireSeconds' => 300 - ]); - UrlTest::assertContains( - '&ik-t=', - $url - ); - UrlTest::assertContains( - '&ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithExpiryWithTransformationWithQueryParameters() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - "queryParameters" => - [ - "key" => "value" - ], - "transformation" => [ - [ - "height" => "300", - ] - ], - 'signed' => true, - 'expireSeconds' => 300 - ]); - UrlTest::assertContains( - '&ik-t=', - $url - ); - UrlTest::assertContains( - '&ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithoutExpiryWithTransformationWithQueryParameters() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - "queryParameters" => - [ - "key" => "value" - ], - "transformation" => [ - [ - "height" => "300", - ] - ], - 'signed' => true - ]); - UrlTest::assertNotContains( - '&ik-t=', - $url - ); - UrlTest::assertContains( - '&ik-s=', - $url - ); - } - - /** - * - */ - public function testUrlSignedUrlWithExpiry() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'signed' => true, - 'expireSeconds' => 100 - ]); - UrlTest::assertStringStartsWith( - 'https://ik.imagekit.io/demo/default-image.jpg', - $url - ); - UrlTest::assertContains( - 'ik-s=', - $url - ); - UrlTest::assertContains( - 'ik-t=', - $url - ); - } - - /** - * - */ - public function testUrlSignedWithDiacriticInFilename() - { - $url = 'https://ik.imagekit.io/demo/test_é_path_alt.jpg'; - $urlInstance = new Url(); - $encodedUrl = $urlInstance->encodeStringIfRequired($url); - UrlTest::assertEquals('https://ik.imagekit.io/demo/test_%C3%A9_path_alt.jpg', $encodedUrl); - - $opts = [ - 'privateKey' => 'testing_private_key', - 'url' => $url, - 'urlEndpoint' => 'https://ik.imagekit.io/demo', - 'expiryTimestamp' => '9999999999' - ]; - $signature = $urlInstance->getSignature($opts); - $url = $this->client->url([ - 'path' => '/test_é_path_alt.jpg', - 'signed' => true, - 'expireSeconds' => '' - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/test_é_path_alt.jpg?ik-s='. $signature, - $url - ); - } - - /** - * - */ - public function testUrlSignedWithDiacriticInFilenameAndPath() - { - $url = 'https://ik.imagekit.io/demo/aéb/test_é_path_alt.jpg'; - $urlInstance = new Url(); - $encodedUrl = $urlInstance->encodeStringIfRequired($url); - UrlTest::assertEquals('https://ik.imagekit.io/demo/a%C3%A9b/test_%C3%A9_path_alt.jpg', $encodedUrl); - - $opts = [ - 'privateKey' => 'testing_private_key', - 'url' => $url, - 'urlEndpoint' => 'https://ik.imagekit.io/demo', - 'expiryTimestamp' => '9999999999' - ]; - $signature = $urlInstance->getSignature($opts); - $url = $this->client->url([ - 'path' => '/aéb/test_é_path_alt.jpg', - 'signed' => true, - 'expireSeconds' => '' - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/aéb/test_é_path_alt.jpg?ik-s='. $signature, - $url - ); - } - - /** - * - */ - public function testUrlSignedWithDiacriticInFilenamePathTransforamtionInPath() - { - $url = 'https://ik.imagekit.io/demo/tr:l-text,i-Imagekité,fs-50,l-end/aéb/test_é_path_alt.jpg'; - $urlInstance = new Url(); - $encodedUrl = $urlInstance->encodeStringIfRequired($url); - UrlTest::assertEquals('https://ik.imagekit.io/demo/tr:l-text,i-Imagekit%C3%A9,fs-50,l-end/a%C3%A9b/test_%C3%A9_path_alt.jpg', $encodedUrl); - - $opts = [ - 'privateKey' => 'testing_private_key', - 'url' => $url, - 'urlEndpoint' => 'https://ik.imagekit.io/demo', - 'expiryTimestamp' => '9999999999' - ]; - $signature = $urlInstance->getSignature($opts); - $url = $this->client->url([ - 'path' => '/aéb/test_é_path_alt.jpg', - 'signed' => true, - "transformation" => [ - [ - "raw" => "l-text,i-Imagekité,fs-50,l-end" - ] - ], - "transformationPosition" => "path", - 'expireSeconds' => '' - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:l-text,i-Imagekité,fs-50,l-end/aéb/test_é_path_alt.jpg?ik-s='. $signature, - $url - ); - } - - /** - * - */ - public function testUrlSignedWithDiacriticInFilenamePathTransforamtionInQuery() - { - $url = 'https://ik.imagekit.io/demo/aéb/test_é_path_alt.jpg?tr=l-text,i-Imagekité,fs-50,l-end'; - $urlInstance = new Url(); - $encodedUrl = $urlInstance->encodeStringIfRequired($url); - UrlTest::assertEquals('https://ik.imagekit.io/demo/a%C3%A9b/test_%C3%A9_path_alt.jpg?tr=l-text,i-Imagekit%C3%A9,fs-50,l-end', $encodedUrl); - - $opts = [ - 'privateKey' => 'testing_private_key', - 'url' => $url, - 'urlEndpoint' => 'https://ik.imagekit.io/demo', - 'expiryTimestamp' => '9999999999' - ]; - $signature = $urlInstance->getSignature($opts); - $url = $this->client->url([ - 'path' => '/aéb/test_é_path_alt.jpg', - 'signed' => true, - "transformation" => [ - [ - "raw" => "l-text,i-Imagekité,fs-50,l-end" - ] - ], - "transformationPosition" => "query", - 'expireSeconds' => '' - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/aéb/test_é_path_alt.jpg?tr=l-text,i-Imagekité,fs-50,l-end&ik-s='. $signature, - $url - ); - } - - /** - * - */ - public function testUrlURLWithPath() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlURLWithPathNoLeadingSlash() - { - $url = $this->client->url([ - 'path' => 'default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - - /** - * - */ - public function testUrlURLWithPathMultipleLeadingSlash() - { - $url = $this->client->url([ - 'path' => '////default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlURLOverrideUrlEndpoint() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/test/', - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/test/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlPathTransformationQuery() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformationPosition' => 'query', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg?tr=h-300,w-400', - $url - ); - } - - /** - * - */ - public function testUrlSrcTransformation() - { - $url = $this->client->url([ - 'src' => 'https://ik.imagekit.io/demo/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlSrcTransformationQuery() - { - $url = $this->client->url([ - 'src' => 'https://ik.imagekit.io/demo/default-image.jpg', - 'transformationPosition' => 'query', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg?tr=h-300,w-400', - $url - ); - } - - /** - * - */ - public function testUrlSrcMergeQueryParams() - { - $url = $this->client->url([ - 'src' => 'https://ik.imagekit.io/demo/default-image.jpg?t1=v1&t3=v3', - 'queryParameters' => ['t2' => 'v2'], - 'transformationPosition' => 'query', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg?tr=h-300,w-400&t1=v1&t2=v2&t3=v3', - $url - ); - } - - /** - * - */ - public function testUrlPathMergeQueryParams() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'queryParameters' => ['t1' => 'v1', 't2' => 'v2', 't3' => 'v3'], - 'transformationPosition' => 'query', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/default-image.jpg?tr=h-300,w-400&t1=v1&t2=v2&t3=v3', - $url - ); - } - - /** - * - */ - public function testUrlChainedTransformation() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ], [ - 'rotate' => 90 - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400:rt-90/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlUndocumentedTransformation() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'undocumented' => 'param' - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:undocumented-param/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlChainedTransformationUndocumentedTransformation() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400 - ], [ - 'undocumented' => 'param' - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400:undocumented-param/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlOverLayImage() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400, - 'raw' => "l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end" - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400,l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlOverLayImageWithPath() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400, - 'raw' => "l-image,i-/path/to/overlay.jpg,w-100,b-10_CDDC39,l-end" - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400,l-image,i-/path/to/overlay.jpg,w-100,b-10_CDDC39,l-end/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlBorder() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400, - 'border' => '20_FF0000' - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400,b-20_FF0000/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlESharpen() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400, - 'e-sharpen' => '-', - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400,e-sharpen/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlRaw() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'raw' => 'h-300,w-400' - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400/default-image.jpg', - $url - ); - } - - - /** - * - */ - public function testUrlAllCombined() - { - $url = $this->client->url([ - 'path' => '/default-image.jpg', - 'transformation' => [ - [ - 'height' => 300, - 'width' => 400, - 'aspectRatio' => '4-3', - 'quality' => 40, - 'crop' => 'force', - 'cropMode' => 'extract', - 'focus' => 'left', - 'format' => 'jpeg', - 'radius' => 50, - 'bg' => 'A94D34', - 'border' => '5-A94D34', - 'rotation' => 90, - 'blur' => 10, - 'named' => 'some_name', - 'progressive' => true, - 'lossless' => true, - 'trim' => 5, - 'metadata' => true, - 'colorProfile' => true, - 'defaultImage' => 'folder/file.jpg/', //trailing slash case - 'dpr' => 3, - 'effectSharpen' => 10, - 'effectUSM' => '2-2-0.8-0.024', - 'effectContrast' => true, - 'effectGray' => true, - 'effectShadow' => 'bl-15_st-40_x-10_y-N5', - 'effectGradient' => 'from-red_to-white', - 'original' => true, - 'raw' => 'h-500,w-450' - ] - ] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/tr:h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,e-sharpen-10,e-usm-2-2-0.8-0.024,e-contrast-true,e-grayscale-true,e-shadow-bl-15_st-40_x-10_y-N5,e-gradient-from-red_to-white,orig-true,h-500,w-450/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfTransformationPositionIsPath() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'queryParameters' => ['v' => '123123'] - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationCustomDomain() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://images.example.com', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'queryParameters' => ['v' => '123123'] - ]); - - UrlTest::assertEquals( - 'https://images.example.com/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfTransformationPositionIsQuery() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300']], - 'queryParameters' => ['v' => '123123'], - 'transformationPosition' => 'query', - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/path/to/my/image.jpg?tr=w-200,h-300&v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfPathAndSrcEmpty() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => '', - 'src' => '', - 'transformationPosition' => 'path', - 'transformation' => [['width' => '200', 'height' => '300']], - 'queryParameters' => ['v' => '123123'], - 'signed' => true, - 'expireSeconds' => 300, - ]); - - UrlTest::assertEquals('src is not a valid URL', json_decode($url)->error->message); - - } - - /** - * - */ - public function testUrlGenerationIfUrlEmptyEmpty() - { - $url = $this->client->url([ - 'urlEndpoint' => '', - 'transformationPosition' => 'path', - 'transformation' => [['width' => '200', 'height' => '300']], - 'queryParameters' => ['v' => '123123'], - 'signed' => true, - 'expireSeconds' => 300, - ]); - - UrlTest::assertEquals('Invalid urlEndpoint value', json_decode($url)->error->message); - - } - - /** - * - */ - public function testUrlGenerationUsingFullImageUrlWhenPassedSrc() - { - $url = $this->client->url([ - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'src' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/your_imagekit_id/endpoint/tr:w-200,h-300:rt-90/default-image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationUsingFullImageUrlWhenPassedSrcWithQueryParameters() - { - - $url = $this->client->url([ - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'src' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - 'queryParameters' => ['test' => 'params', 'test2' => 'param2'], - 'expireSeconds' => 300, - ]); - - // UrlTest::assertNotRegExp('/??/', $url); - // UrlTest::assertNotRegExp('/&&/', $url); - UrlTest::assertEquals( - 'https://ik.imagekit.io/your_imagekit_id/endpoint/tr:w-200,h-300:rt-90/default-image.jpg?test=params&test2=param2', - $url - ); - } - - /** - * - */ - public function testUrlGenerationUsingFullImageUrlWhenPassedSrcWithQueryParametersAndTransforamtionPositionIsPath() - { - $url = $this->client->url([ - 'src' => 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - 'transformationPosition' => 'path', - 'expireSeconds' => 300, - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/your_imagekit_id/endpoint/default-image.jpg', - $url - ); - } - - /** - * - */ - public function testSignedUrlGeneration() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'signed' => true, - 'expireSeconds' => 300, - ]); - - $url_components = parse_url($url); - parse_str($url_components['query'], $params); - - UrlTest::assertNotEmpty($params['ik-s']); - UrlTest::assertNotEmpty($params['ik-t']); - } - - /** - * - */ - public function testUrlGenerationIfInitializationUrlEndpointIsOverriddenByNewUrlEndpoint() - { - - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfPresenceOfTrailingSlashInUrlEndpointWillGenerateValidUrl() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern/', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfPresenceOfLeadingSlashInPathWillGenerateValidUrl() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => '/path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationIfNewTransformationParameterIsPassedWillBePresentInGeneratedUrl() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90'], ['test' => 'param']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90:test-param/path/to/my/image.jpg?v=123123', - $url - ); - } - - // /** - // * - // */ - // public function testUrlGenerationIfGeneratedUrlContainsSDKVersion() - // { - // $url = $this->client->url([ - // 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - // 'transformation' => [['width' => '200', 'height' => '300']], - // 'path' => 'path/to/my/image.jpg', - // 'transformationPosition' => 'query', - // 'queryParameters' => ['v' => '123123'], - // 'expireSeconds' => 300, - // ]); - - // $url_components = parse_url($url); - // parse_str($url_components['query'], $params); - - // UrlTest::assertNotEmpty($params['ik-sdk-version']); - // UrlTest::assertEquals('php-', $params['ik-sdk-version']); - // } - - /** - * - */ - public function testUrlGenerationIfTransformationPositionIsQueryAndTransformationArePresentInUrlAsQueryParams() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'transformation' => [['width' => '200', 'height' => '300']], - 'path' => 'path/to/my/image.jpg', - 'transformationPosition' => 'query', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - - $url_components = parse_url($url); - parse_str($url_components['query'], $params); - - UrlTest::assertNotEmpty($params['tr']); - UrlTest::assertEquals('w-200,h-300', $params['tr']); - } - - /** - * - */ - public function testUrlGenerationWithChainedTransformationIfTransformationPositionIsPath() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationWithChainedTransformationIfTransformationPositionIsQuery() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'query', - 'queryParameters' => ['v' => '123123'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/path/to/my/image.jpg?tr=w-200,h-300:rt-90&v=123123', - $url - ); - } - - /** - * - */ - public function testUrlGenerationWithQueryParametersIfTransformationPositionIsPath() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'path', - 'queryParameters' => ['test' => 'param'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:w-200,h-300:rt-90/path/to/my/image.jpg?test=param', - $url - ); - } - - /** - * - */ - public function testUrlGenerationWithQueryParametersIfTransformationPositionIsQuery() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['width' => '200', 'height' => '300'], ['rotation' => '90']], - 'transformationPosition' => 'query', - 'queryParameters' => ['test' => 'param'], - 'expireSeconds' => 300, - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/path/to/my/image.jpg?tr=w-200,h-300:rt-90&test=param', - $url - ); - } - - // /** - // * - // */ - // public function testUrlGenerationWithDefaultExpiredSeconds() - // { - // $url = $this->client->url([ - // 'path' => '/test-signed-url.png', - // 'transformation' => [['width' => '100']], - // 'signed' => true, - // ]); - - // $url_components = parse_url($url); - // parse_str($url_components['query'], $params); - - // UrlTest::assertStringNotContainsString('?&', $url); - // UrlTest::assertNotEmpty($params['ik-s']); - // } - - /** - * - */ - public function testUrlGenerationWithCustomExpiredSeconds() - { - $url = $this->client->url([ - 'path' => '/test-signed-url.png', - 'transformation' => [['width' => '100']], - 'signed' => true, - 'expireSeconds' => 300 - ]); - - $url_components = parse_url($url); - parse_str($url_components['query'], $params); - - // UrlTest::assertNotRegExp('/?&/', $url); - UrlTest::assertNotEmpty($params['ik-t']); - } - - /** - * - */ - public function testTransformationWithoutValueShouldNotHaveHypen() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['orig' => '']], - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:orig/path/to/my/image.jpg', - $url - ); - } - - /** - * - */ - public function testTransformationValueShouldBeConvertedToString() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['rt' => 90, 'orig' => true]], - ]); - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:rt-90,orig-true/path/to/my/image.jpg', - $url - ); - } - - /** - * - */ - public function testTransformationNonMappedSupportedTransform() - { - $url = $this->client->url([ - 'urlEndpoint' => 'https://ik.imagekit.io/demo/pattern', - 'path' => 'path/to/my/image.jpg', - 'transformation' => [['not_mapped' => 'value', '' => '']], - ]); - - UrlTest::assertEquals( - 'https://ik.imagekit.io/demo/pattern/tr:not_mapped-value/path/to/my/image.jpg', - $url - ); - } - - /** - * - */ - public function testUnitTestGeneratedSignature() - { - $opts = [ - 'privateKey' => 'private_key_test', - 'url' => 'https://test-domain.com/test-endpoint/tr:w-100/test-signed-url.png', - 'urlEndpoint' => 'https://test-domain.com/test-endpoint', - 'expiryTimestamp' => '9999999999' - ]; - - $urlInstance = new Url(); - $signature = $urlInstance->getSignature($opts); - - UrlTest::assertEquals('41b3075c40bc84147eb71b8b49ae7fbf349d0f00', $signature); - } - -} diff --git a/tests/Services/Accounts/OriginsTest.php b/tests/Services/Accounts/OriginsTest.php new file mode 100644 index 00000000..eac91e2e --- /dev/null +++ b/tests/Services/Accounts/OriginsTest.php @@ -0,0 +1,153 @@ +client = $client; + } + + #[Test] + public function testCreate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->create( + S3::with( + accessKey: 'AKIATEST123', + bucket: 'test-bucket', + name: 'My S3 Origin', + secretKey: 'secrettest123', + ), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCreateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->create( + S3::with( + accessKey: 'AKIATEST123', + bucket: 'test-bucket', + name: 'My S3 Origin', + secretKey: 'secrettest123', + ) + ->withBaseURLForCanonicalHeader('https://cdn.example.com') + ->withIncludeCanonicalHeader(false) + ->withPrefix('images'), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpdate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->update( + 'id', + S3::with( + accessKey: 'AKIATEST123', + bucket: 'test-bucket', + name: 'My S3 Origin', + secretKey: 'secrettest123', + ), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpdateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->update( + 'id', + S3::with( + accessKey: 'AKIATEST123', + bucket: 'test-bucket', + name: 'My S3 Origin', + secretKey: 'secrettest123', + ) + ->withBaseURLForCanonicalHeader('https://cdn.example.com') + ->withIncludeCanonicalHeader(false) + ->withPrefix('images'), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testList(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->list(); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->delete('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->origins->get('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Accounts/URLEndpointsTest.php b/tests/Services/Accounts/URLEndpointsTest.php new file mode 100644 index 00000000..7c0bf515 --- /dev/null +++ b/tests/Services/Accounts/URLEndpointsTest.php @@ -0,0 +1,126 @@ +client = $client; + } + + #[Test] + public function testCreate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->create( + description: 'My custom URL endpoint' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCreateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->create( + description: 'My custom URL endpoint' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpdate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->update( + 'id', + description: 'My custom URL endpoint' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpdateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->update( + 'id', + description: 'My custom URL endpoint' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testList(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->list(); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->delete('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->urlEndpoints->get('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Accounts/UsageTest.php b/tests/Services/Accounts/UsageTest.php new file mode 100644 index 00000000..714169a6 --- /dev/null +++ b/tests/Services/Accounts/UsageTest.php @@ -0,0 +1,62 @@ +client = $client; + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->usage->get( + endDate: new \DateTimeImmutable('2019-12-27'), + startDate: new \DateTimeImmutable('2019-12-27'), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGetWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->accounts->usage->get( + endDate: new \DateTimeImmutable('2019-12-27'), + startDate: new \DateTimeImmutable('2019-12-27'), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/AssetsTest.php b/tests/Services/AssetsTest.php new file mode 100644 index 00000000..0b3ed342 --- /dev/null +++ b/tests/Services/AssetsTest.php @@ -0,0 +1,44 @@ +client = $client; + } + + #[Test] + public function testList(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->assets->list(); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Beta/V2/FilesTest.php b/tests/Services/Beta/V2/FilesTest.php new file mode 100644 index 00000000..ced4540e --- /dev/null +++ b/tests/Services/Beta/V2/FilesTest.php @@ -0,0 +1,62 @@ +client = $client; + } + + #[Test] + public function testUpload(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->beta->v2->files->upload( + file: 'file', + fileName: 'fileName' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUploadWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->beta->v2->files->upload( + file: 'file', + fileName: 'fileName' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Cache/InvalidationTest.php b/tests/Services/Cache/InvalidationTest.php new file mode 100644 index 00000000..276c6107 --- /dev/null +++ b/tests/Services/Cache/InvalidationTest.php @@ -0,0 +1,72 @@ +client = $client; + } + + #[Test] + public function testCreate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->cache->invalidation->create( + 'https://ik.imagekit.io/your_imagekit_id/default-image.jpg' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCreateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->cache->invalidation->create( + 'https://ik.imagekit.io/your_imagekit_id/default-image.jpg' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->cache->invalidation->get('requestId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/CustomMetadataFieldsTest.php b/tests/Services/CustomMetadataFieldsTest.php new file mode 100644 index 00000000..92459823 --- /dev/null +++ b/tests/Services/CustomMetadataFieldsTest.php @@ -0,0 +1,108 @@ +client = $client; + } + + #[Test] + public function testCreate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->customMetadataFields->create( + label: 'price', + name: 'price', + schema: Schema::with(type: 'Number') + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCreateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->customMetadataFields->create( + label: 'price', + name: 'price', + schema: Schema::with(type: 'Number') + ->withDefaultValue('string') + ->withIsValueRequired(true) + ->withMaxLength(0) + ->withMaxValue(3000) + ->withMinLength(0) + ->withMinValue(1000) + ->withSelectOptions(['small', 'medium', 'large', 30, 40, true]), + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpdate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->customMetadataFields->update('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testList(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->customMetadataFields->list(); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->customMetadataFields->delete('id'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Files/BulkTest.php b/tests/Services/Files/BulkTest.php new file mode 100644 index 00000000..dc17a9c6 --- /dev/null +++ b/tests/Services/Files/BulkTest.php @@ -0,0 +1,150 @@ +client = $client; + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->delete( + ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'] + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDeleteWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->delete( + ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'] + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testAddTags(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->addTags( + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + tags: ['t-shirt', 'round-neck', 'sale2019'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testAddTagsWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->addTags( + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + tags: ['t-shirt', 'round-neck', 'sale2019'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRemoveAITags(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->removeAITags( + aiTags: ['t-shirt', 'round-neck', 'sale2019'], + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRemoveAITagsWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->removeAITags( + aiTags: ['t-shirt', 'round-neck', 'sale2019'], + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRemoveTags(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->removeTags( + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + tags: ['t-shirt', 'round-neck', 'sale2019'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRemoveTagsWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->bulk->removeTags( + fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], + tags: ['t-shirt', 'round-neck', 'sale2019'], + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Files/MetadataTest.php b/tests/Services/Files/MetadataTest.php new file mode 100644 index 00000000..c0cd9366 --- /dev/null +++ b/tests/Services/Files/MetadataTest.php @@ -0,0 +1,68 @@ +client = $client; + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->metadata->get('fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGetFromURL(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->metadata->getFromURL('https://example.com'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGetFromURLWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->metadata->getFromURL('https://example.com'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Files/VersionsTest.php b/tests/Services/Files/VersionsTest.php new file mode 100644 index 00000000..c88bff80 --- /dev/null +++ b/tests/Services/Files/VersionsTest.php @@ -0,0 +1,116 @@ +client = $client; + } + + #[Test] + public function testList(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->list('fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->delete('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDeleteWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->delete('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->get('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGetWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->get('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRestore(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->restore('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRestoreWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->versions->restore('versionId', 'fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php new file mode 100644 index 00000000..457d84a4 --- /dev/null +++ b/tests/Services/FilesTest.php @@ -0,0 +1,182 @@ +client = $client; + } + + #[Test] + public function testUpdate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->update('fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->delete('fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCopy(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->copy( + destinationPath: '/folder/to/copy/into/', + sourceFilePath: '/path/to/file.jpg', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCopyWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->copy( + destinationPath: '/folder/to/copy/into/', + sourceFilePath: '/path/to/file.jpg', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->get('fileId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testMove(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->move( + destinationPath: '/folder/to/move/into/', + sourceFilePath: '/path/to/file.jpg', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testMoveWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->move( + destinationPath: '/folder/to/move/into/', + sourceFilePath: '/path/to/file.jpg', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRename(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->rename( + filePath: '/path/to/file.jpg', + newFileName: 'newFileName.jpg' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRenameWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->rename( + filePath: '/path/to/file.jpg', + newFileName: 'newFileName.jpg' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUpload(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testUploadWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/Folders/JobTest.php b/tests/Services/Folders/JobTest.php new file mode 100644 index 00000000..e4e4b467 --- /dev/null +++ b/tests/Services/Folders/JobTest.php @@ -0,0 +1,44 @@ +client = $client; + } + + #[Test] + public function testGet(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->job->get('jobId'); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/FoldersTest.php b/tests/Services/FoldersTest.php new file mode 100644 index 00000000..ab2bc197 --- /dev/null +++ b/tests/Services/FoldersTest.php @@ -0,0 +1,176 @@ +client = $client; + } + + #[Test] + public function testCreate(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->create( + folderName: 'summer', + parentFolderPath: '/product/images/' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCreateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->create( + folderName: 'summer', + parentFolderPath: '/product/images/' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDelete(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->delete('/folder/to/delete/'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testDeleteWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->delete('/folder/to/delete/'); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCopy(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->copy( + destinationPath: '/path/of/destination/folder', + sourceFolderPath: '/path/of/source/folder', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testCopyWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->copy( + destinationPath: '/path/of/destination/folder', + sourceFolderPath: '/path/of/source/folder', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testMove(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->move( + destinationPath: '/path/of/destination/folder', + sourceFolderPath: '/path/of/source/folder', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testMoveWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->move( + destinationPath: '/path/of/destination/folder', + sourceFolderPath: '/path/of/source/folder', + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRename(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->rename( + folderPath: '/path/of/folder', + newFolderName: 'new-folder-name' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } + + #[Test] + public function testRenameWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->folders->rename( + folderPath: '/path/of/folder', + newFolderName: 'new-folder-name' + ); + + $this->assertTrue(true); // @phpstan-ignore-line + } +} diff --git a/tests/Services/WebhooksTest.php b/tests/Services/WebhooksTest.php new file mode 100644 index 00000000..c94df4e3 --- /dev/null +++ b/tests/Services/WebhooksTest.php @@ -0,0 +1,30 @@ +client = $client; + } +} diff --git a/tests/UnsupportedMockTests.php b/tests/UnsupportedMockTests.php new file mode 100644 index 00000000..f57ac900 --- /dev/null +++ b/tests/UnsupportedMockTests.php @@ -0,0 +1,8 @@ + Date: Mon, 1 Sep 2025 13:51:13 +0000 Subject: [PATCH 02/40] chore: update SDK settings --- .github/workflows/create-releases.yml | 30 --------------------------- .github/workflows/release-doctor.yml | 6 ++---- .stats.yml | 2 +- README.md | 10 ++++++--- bin/check-release-environment | 4 ---- 5 files changed, 10 insertions(+), 42 deletions(-) delete mode 100644 .github/workflows/create-releases.yml diff --git a/.github/workflows/create-releases.yml b/.github/workflows/create-releases.yml deleted file mode 100644 index 8e723adf..00000000 --- a/.github/workflows/create-releases.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Create releases -on: - schedule: - - cron: '0 5 * * *' # every day at 5am UTC - push: - branches: - - main - -jobs: - release: - name: release - if: github.ref == 'refs/heads/main' && github.repository == 'stainless-sdks/imagekit-php' - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - - uses: stainless-api/trigger-release-please@v1 - id: release - with: - repo: ${{ github.event.repository.full_name }} - stainless-api-key: ${{ secrets.STAINLESS_API_KEY }} - - - name: Publish to Packagist - if: ${{ steps.release.outputs.releases_created }} - run: |- - curl --fail-with-body -X POST -H 'Content-Type: application/json' "https://packagist.org/api/update-package?username=${PACKAGIST_USERNAME}&apiToken=${PACKAGIST_SAFE_KEY}" -d '{"repository":"https://www.github.com/stainless-sdks/imagekit-php"}' - env: - PACKAGIST_USERNAME: ${{ secrets.IMAGE_KIT_PACKAGIST_USERNAME || secrets.PACKAGIST_USERNAME }} - PACKAGIST_SAFE_KEY: ${{ secrets.IMAGE_KIT_PACKAGIST_SAFE_KEY || secrets.PACKAGIST_SAFE_KEY }} diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index c789d348..6619e3f0 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -2,14 +2,14 @@ name: Release Doctor on: pull_request: branches: - - main + - master workflow_dispatch: jobs: release_doctor: name: release doctor runs-on: ubuntu-latest - if: github.repository == 'stainless-sdks/imagekit-php' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') + if: github.repository == 'imagekit-developer/imagekit-php' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - uses: actions/checkout@v4 @@ -17,5 +17,3 @@ jobs: - name: Check release environment run: | bash ./bin/check-release-environment - env: - STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }} diff --git a/.stats.yml b/.stats.yml index ad85869b..5d25590d 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886 -config_hash: cf9d50fe62973f4e91ef65c147aabcc1 +config_hash: 9f8a678d9d4d06daec522e8deb49e3ad diff --git a/README.md b/README.md index 4a52aaa4..0325e391 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ > > This library has not yet been exhaustively tested in production environments and may be missing some features you'd expect in a stable release. As we continue development, there may be breaking changes that require updates to your code. > -> **We'd love your feedback!** Please share any suggestions, bug reports, feature requests, or general thoughts by [filing an issue](https://www.github.com/stainless-sdks/imagekit-php/issues/new). +> **We'd love your feedback!** Please share any suggestions, bug reports, feature requests, or general thoughts by [filing an issue](https://www.github.com/imagekit-developer/imagekit-php/issues/new). The Image Kit PHP library provides convenient access to the Image Kit REST API from any PHP 8.1.0+ application. @@ -19,12 +19,14 @@ The REST API documentation can be found on [imagekit.io](https://imagekit.io/doc To use this package, install via Composer by adding the following to your application's `composer.json`: + + ```json { "repositories": [ { "type": "vcs", - "url": "git@github.com:stainless-sdks/imagekit-php.git" + "url": "git@github.com:imagekit-developer/imagekit-php.git" } ], "require": { @@ -33,6 +35,8 @@ To use this package, install via Composer by adding the following to your applic } ``` + + ## Usage This library uses named parameters to specify optional arguments. @@ -184,4 +188,4 @@ PHP 8.1.0 or higher. ## Contributing -See [the contributing documentation](https://github.com/stainless-sdks/imagekit-php/tree/main/CONTRIBUTING.md). +See [the contributing documentation](https://github.com/imagekit-developer/imagekit-php/tree/master/CONTRIBUTING.md). diff --git a/bin/check-release-environment b/bin/check-release-environment index 0d9c55da..cf571b62 100644 --- a/bin/check-release-environment +++ b/bin/check-release-environment @@ -2,10 +2,6 @@ errors=() -if [ -z "${STAINLESS_API_KEY}" ]; then - errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.") -fi - if [ -z "${PACKAGIST_USERNAME}" ]; then errors+=("The PACKAGIST_USERNAME secret has not been set. Please set it in either this repository's secrets or your organization secrets") fi From 84f5b7c65eb1b7b23fdda823aca71c51b73023e3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 07:19:41 +0000 Subject: [PATCH 03/40] feat(api): add BaseWebhookEvent --- .stats.yml | 6 +++--- src/Webhooks/UnsafeUnwrapWebhookEvent.php | 3 --- src/Webhooks/UnwrapWebhookEvent.php | 3 --- src/Webhooks/UploadPostTransformErrorEvent.php | 2 -- src/Webhooks/UploadPostTransformSuccessEvent.php | 2 -- src/Webhooks/UploadPreTransformErrorEvent.php | 2 -- src/Webhooks/UploadPreTransformSuccessEvent.php | 2 -- src/Webhooks/VideoTransformationAcceptedEvent.php | 2 -- src/Webhooks/VideoTransformationErrorEvent.php | 2 -- src/Webhooks/VideoTransformationReadyEvent.php | 2 -- 10 files changed, 3 insertions(+), 23 deletions(-) diff --git a/.stats.yml b/.stats.yml index 5d25590d..08185446 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml -openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886 -config_hash: 9f8a678d9d4d06daec522e8deb49e3ad +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml +openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a +config_hash: 4e73c7e12a531edcd1366dab7eccc360 diff --git a/src/Webhooks/UnsafeUnwrapWebhookEvent.php b/src/Webhooks/UnsafeUnwrapWebhookEvent.php index 508250a3..eb843b16 100644 --- a/src/Webhooks/UnsafeUnwrapWebhookEvent.php +++ b/src/Webhooks/UnsafeUnwrapWebhookEvent.php @@ -8,9 +8,6 @@ use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; -/** - * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. - */ final class UnsafeUnwrapWebhookEvent implements ConverterSource { use SdkUnion; diff --git a/src/Webhooks/UnwrapWebhookEvent.php b/src/Webhooks/UnwrapWebhookEvent.php index 98b83129..d1bf3871 100644 --- a/src/Webhooks/UnwrapWebhookEvent.php +++ b/src/Webhooks/UnwrapWebhookEvent.php @@ -8,9 +8,6 @@ use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; -/** - * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. - */ final class UnwrapWebhookEvent implements ConverterSource { use SdkUnion; diff --git a/src/Webhooks/UploadPostTransformErrorEvent.php b/src/Webhooks/UploadPostTransformErrorEvent.php index 840b2dd5..e1fbe36a 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent.php +++ b/src/Webhooks/UploadPostTransformErrorEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\UploadPostTransformErrorEvent\Request; /** - * Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. - * * @phpstan-type upload_post_transform_error_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/UploadPostTransformSuccessEvent.php b/src/Webhooks/UploadPostTransformSuccessEvent.php index 732eae27..670314c4 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\UploadPostTransformSuccessEvent\Request; /** - * Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event. - * * @phpstan-type upload_post_transform_success_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/UploadPreTransformErrorEvent.php b/src/Webhooks/UploadPreTransformErrorEvent.php index d8af26e0..5fb564db 100644 --- a/src/Webhooks/UploadPreTransformErrorEvent.php +++ b/src/Webhooks/UploadPreTransformErrorEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\UploadPreTransformErrorEvent\Request; /** - * Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. - * * @phpstan-type upload_pre_transform_error_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/UploadPreTransformSuccessEvent.php b/src/Webhooks/UploadPreTransformSuccessEvent.php index 77f3a5ce..5fd482bd 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\UploadPreTransformSuccessEvent\Request; /** - * Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. - * * @phpstan-type upload_pre_transform_success_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/VideoTransformationAcceptedEvent.php b/src/Webhooks/VideoTransformationAcceptedEvent.php index 7c868c67..c63eb4ea 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\VideoTransformationAcceptedEvent\Request; /** - * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. - * * @phpstan-type video_transformation_accepted_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/VideoTransformationErrorEvent.php b/src/Webhooks/VideoTransformationErrorEvent.php index 71938723..746d1d33 100644 --- a/src/Webhooks/VideoTransformationErrorEvent.php +++ b/src/Webhooks/VideoTransformationErrorEvent.php @@ -11,8 +11,6 @@ use ImageKit\Webhooks\VideoTransformationErrorEvent\Request; /** - * Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support. - * * @phpstan-type video_transformation_error_event = array{ * id: string, * createdAt: \DateTimeInterface, diff --git a/src/Webhooks/VideoTransformationReadyEvent.php b/src/Webhooks/VideoTransformationReadyEvent.php index 691208d4..449578b9 100644 --- a/src/Webhooks/VideoTransformationReadyEvent.php +++ b/src/Webhooks/VideoTransformationReadyEvent.php @@ -12,8 +12,6 @@ use ImageKit\Webhooks\VideoTransformationReadyEvent\Timings; /** - * Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users. - * * @phpstan-type video_transformation_ready_event = array{ * id: string, * createdAt: \DateTimeInterface, From 864a1aa121d394cbc89a9b305d03177777fe173e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 07:21:11 +0000 Subject: [PATCH 04/40] feat(api): manual updates --- .stats.yml | 2 +- src/Webhooks/BaseWebhookEvent.php | 86 +++++++++++++++++++ src/Webhooks/UnsafeUnwrapWebhookEvent.php | 3 + src/Webhooks/UnwrapWebhookEvent.php | 3 + .../UploadPostTransformErrorEvent.php | 32 +------ .../UploadPostTransformSuccessEvent.php | 32 +------ src/Webhooks/UploadPreTransformErrorEvent.php | 32 +------ .../UploadPreTransformSuccessEvent.php | 32 +------ .../VideoTransformationAcceptedEvent.php | 32 +------ .../VideoTransformationErrorEvent.php | 32 +------ .../VideoTransformationReadyEvent.php | 27 +----- 11 files changed, 120 insertions(+), 193 deletions(-) create mode 100644 src/Webhooks/BaseWebhookEvent.php diff --git a/.stats.yml b/.stats.yml index 08185446..52f982ba 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a -config_hash: 4e73c7e12a531edcd1366dab7eccc360 +config_hash: 08e12746cdca1c59c897cf2e50893c3c diff --git a/src/Webhooks/BaseWebhookEvent.php b/src/Webhooks/BaseWebhookEvent.php new file mode 100644 index 00000000..b5b8aa22 --- /dev/null +++ b/src/Webhooks/BaseWebhookEvent.php @@ -0,0 +1,86 @@ + */ + use SdkModel; + + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ + #[Api] + public string $type; + + /** + * `new BaseWebhookEvent()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * BaseWebhookEvent::with(id: ..., type: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new BaseWebhookEvent)->withID(...)->withType(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(string $id, string $type): self + { + $obj = new self; + + $obj->id = $id; + $obj->type = $type; + + return $obj; + } + + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } +} diff --git a/src/Webhooks/UnsafeUnwrapWebhookEvent.php b/src/Webhooks/UnsafeUnwrapWebhookEvent.php index eb843b16..508250a3 100644 --- a/src/Webhooks/UnsafeUnwrapWebhookEvent.php +++ b/src/Webhooks/UnsafeUnwrapWebhookEvent.php @@ -8,6 +8,9 @@ use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +/** + * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. + */ final class UnsafeUnwrapWebhookEvent implements ConverterSource { use SdkUnion; diff --git a/src/Webhooks/UnwrapWebhookEvent.php b/src/Webhooks/UnwrapWebhookEvent.php index d1bf3871..98b83129 100644 --- a/src/Webhooks/UnwrapWebhookEvent.php +++ b/src/Webhooks/UnwrapWebhookEvent.php @@ -8,6 +8,9 @@ use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +/** + * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. + */ final class UnwrapWebhookEvent implements ConverterSource { use SdkUnion; diff --git a/src/Webhooks/UploadPostTransformErrorEvent.php b/src/Webhooks/UploadPostTransformErrorEvent.php index e1fbe36a..22ad5804 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent.php +++ b/src/Webhooks/UploadPostTransformErrorEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\UploadPostTransformErrorEvent\Request; /** + * Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. + * * @phpstan-type upload_post_transform_error_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPostTransformErrorEvent implements BaseModel @@ -27,12 +25,6 @@ final class UploadPostTransformErrorEvent implements BaseModel #[Api] public string $type = 'upload.post-transform.error'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp of when the event occurred in ISO8601 format. */ @@ -50,16 +42,13 @@ final class UploadPostTransformErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPostTransformErrorEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * UploadPostTransformErrorEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPostTransformErrorEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -76,14 +65,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -91,17 +78,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPostTransformSuccessEvent.php b/src/Webhooks/UploadPostTransformSuccessEvent.php index 670314c4..f5cb4919 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\UploadPostTransformSuccessEvent\Request; /** + * Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event. + * * @phpstan-type upload_post_transform_success_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPostTransformSuccessEvent implements BaseModel @@ -27,12 +25,6 @@ final class UploadPostTransformSuccessEvent implements BaseModel #[Api] public string $type = 'upload.post-transform.success'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp of when the event occurred in ISO8601 format. */ @@ -50,16 +42,13 @@ final class UploadPostTransformSuccessEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPostTransformSuccessEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * UploadPostTransformSuccessEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPostTransformSuccessEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -76,14 +65,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -91,17 +78,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPreTransformErrorEvent.php b/src/Webhooks/UploadPreTransformErrorEvent.php index 5fb564db..03f76019 100644 --- a/src/Webhooks/UploadPreTransformErrorEvent.php +++ b/src/Webhooks/UploadPreTransformErrorEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\UploadPreTransformErrorEvent\Request; /** + * Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. + * * @phpstan-type upload_pre_transform_error_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPreTransformErrorEvent implements BaseModel @@ -27,12 +25,6 @@ final class UploadPreTransformErrorEvent implements BaseModel #[Api] public string $type = 'upload.pre-transform.error'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp of when the event occurred in ISO8601 format. */ @@ -50,16 +42,13 @@ final class UploadPreTransformErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPreTransformErrorEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * UploadPreTransformErrorEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPreTransformErrorEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -76,14 +65,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -91,17 +78,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPreTransformSuccessEvent.php b/src/Webhooks/UploadPreTransformSuccessEvent.php index 5fd482bd..ef1c0670 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\UploadPreTransformSuccessEvent\Request; /** + * Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. + * * @phpstan-type upload_pre_transform_success_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPreTransformSuccessEvent implements BaseModel @@ -27,12 +25,6 @@ final class UploadPreTransformSuccessEvent implements BaseModel #[Api] public string $type = 'upload.pre-transform.success'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp of when the event occurred in ISO8601 format. */ @@ -53,16 +45,13 @@ final class UploadPreTransformSuccessEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPreTransformSuccessEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * UploadPreTransformSuccessEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPreTransformSuccessEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -79,14 +68,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -94,17 +81,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationAcceptedEvent.php b/src/Webhooks/VideoTransformationAcceptedEvent.php index c63eb4ea..6957bcca 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\VideoTransformationAcceptedEvent\Request; /** + * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. + * * @phpstan-type video_transformation_accepted_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class VideoTransformationAcceptedEvent implements BaseModel @@ -27,12 +25,6 @@ final class VideoTransformationAcceptedEvent implements BaseModel #[Api] public string $type = 'video.transformation.accepted'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp when the event was created in ISO8601 format. */ @@ -53,16 +45,13 @@ final class VideoTransformationAcceptedEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationAcceptedEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * VideoTransformationAcceptedEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationAcceptedEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -79,14 +68,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -94,17 +81,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp when the event was created in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationErrorEvent.php b/src/Webhooks/VideoTransformationErrorEvent.php index 746d1d33..31aa4b8a 100644 --- a/src/Webhooks/VideoTransformationErrorEvent.php +++ b/src/Webhooks/VideoTransformationErrorEvent.php @@ -11,12 +11,10 @@ use ImageKit\Webhooks\VideoTransformationErrorEvent\Request; /** + * Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support. + * * @phpstan-type video_transformation_error_event = array{ - * id: string, - * createdAt: \DateTimeInterface, - * data: Data, - * request: Request, - * type: string, + * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class VideoTransformationErrorEvent implements BaseModel @@ -27,12 +25,6 @@ final class VideoTransformationErrorEvent implements BaseModel #[Api] public string $type = 'video.transformation.error'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp when the event was created in ISO8601 format. */ @@ -53,16 +45,13 @@ final class VideoTransformationErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationErrorEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * VideoTransformationErrorEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationErrorEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -79,14 +68,12 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -94,17 +81,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp when the event was created in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationReadyEvent.php b/src/Webhooks/VideoTransformationReadyEvent.php index 449578b9..688f66a9 100644 --- a/src/Webhooks/VideoTransformationReadyEvent.php +++ b/src/Webhooks/VideoTransformationReadyEvent.php @@ -12,8 +12,9 @@ use ImageKit\Webhooks\VideoTransformationReadyEvent\Timings; /** + * Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users. + * * @phpstan-type video_transformation_ready_event = array{ - * id: string, * createdAt: \DateTimeInterface, * data: Data, * request: Request, @@ -29,12 +30,6 @@ final class VideoTransformationReadyEvent implements BaseModel #[Api] public string $type = 'video.transformation.ready'; - /** - * Unique identifier for the event. - */ - #[Api] - public string $id; - /** * Timestamp when the event was created in ISO8601 format. */ @@ -61,16 +56,13 @@ final class VideoTransformationReadyEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationReadyEvent::with( - * id: ..., createdAt: ..., data: ..., request: ... - * ) + * VideoTransformationReadyEvent::with(createdAt: ..., data: ..., request: ...) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationReadyEvent) - * ->withID(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -87,7 +79,6 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - string $id, \DateTimeInterface $createdAt, Data $data, Request $request, @@ -95,7 +86,6 @@ public static function with( ): self { $obj = new self; - $obj->id = $id; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -105,17 +95,6 @@ public static function with( return $obj; } - /** - * Unique identifier for the event. - */ - public function withID(string $id): self - { - $obj = clone $this; - $obj->id = $id; - - return $obj; - } - /** * Timestamp when the event was created in ISO8601 format. */ From d47d5315bc6aac956a2e12ba539c7a07d1d95f83 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:16:06 +0000 Subject: [PATCH 05/40] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 52f982ba..cfcbd7f7 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a -config_hash: 08e12746cdca1c59c897cf2e50893c3c +config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c From 3ac5bb60ab1b828c27a17e8d499309c1ac077dd9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:18:51 +0000 Subject: [PATCH 06/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++++++---- tests/Services/FilesTest.php | 10 ++++++++-- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/.stats.yml b/.stats.yml index cfcbd7f7..282d18eb 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml -openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-eab9713fd85da68b41e881dfd9cd71f654e8620132da2023bab7dd01e5f7852e.yml +openapi_spec_hash: b5037b26fbe7360c6bfaf9947a65bb85 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 0325e391..1263fdc0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,9 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); +$response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" +); var_dump($response->videoCodec); ``` @@ -74,7 +76,9 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); + $response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" + ); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -122,7 +126,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -144,7 +148,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 457d84a4..e5d99bdf 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,7 +163,10 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://www.example.com/path/to-image.jpg', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } @@ -175,7 +178,10 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://www.example.com/path/to-image.jpg', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } From 8aecc6ee1d42589a554687c3a8138ff764ba223f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:21:48 +0000 Subject: [PATCH 07/40] feat(api): manual updates --- .stats.yml | 4 ++-- tests/Services/FilesTest.php | 10 ++-------- 2 files changed, 4 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 282d18eb..7698a81b 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-eab9713fd85da68b41e881dfd9cd71f654e8620132da2023bab7dd01e5f7852e.yml -openapi_spec_hash: b5037b26fbe7360c6bfaf9947a65bb85 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-911102f2eaf3be4b34381f6ba089330bed099bb72eb93667ce2f6e72b5934c8c.yml +openapi_spec_hash: 637ad417a580137914441bd790b04cc2 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index e5d99bdf..457d84a4 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,10 +163,7 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://www.example.com/path/to-image.jpg', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } @@ -178,10 +175,7 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://www.example.com/path/to-image.jpg', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } From 2ebe4bffb958f8cd8c923b285bdb79b4d93ea755 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:23:52 +0000 Subject: [PATCH 08/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++-------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7698a81b..d42605f1 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-911102f2eaf3be4b34381f6ba089330bed099bb72eb93667ce2f6e72b5934c8c.yml -openapi_spec_hash: 637ad417a580137914441bd790b04cc2 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0726d89b19f532c7fb92990d688a9bfb5aa4a9a871d64f49d4ba45bac6998e4a.yml +openapi_spec_hash: 9525bb02ab496b3459a1f93ac50968e3 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 1263fdc0..0325e391 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,7 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" -); +$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); var_dump($response->videoCodec); ``` @@ -76,9 +74,7 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" - ); + $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -126,7 +122,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -148,7 +144,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], From 5bce0a417f3c5dd63a13ccc28477977863ee9ed2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 08:33:06 +0000 Subject: [PATCH 09/40] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index d42605f1..cfcbd7f7 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0726d89b19f532c7fb92990d688a9bfb5aa4a9a871d64f49d4ba45bac6998e4a.yml -openapi_spec_hash: 9525bb02ab496b3459a1f93ac50968e3 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml +openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c From 6ec4a94508922f91f34d9b58226e047de6c40399 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 09:03:37 +0000 Subject: [PATCH 10/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++++++---- src/Core/ServiceContracts/FilesContract.php | 8 +------- src/Core/Services/FilesService.php | 8 +------- src/Files/FileUploadParams.php | 16 ++-------------- tests/Services/FilesTest.php | 10 ++++++++-- 6 files changed, 22 insertions(+), 36 deletions(-) diff --git a/.stats.yml b/.stats.yml index cfcbd7f7..d458a07c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml -openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-e7bc47a9221d7da9c8c9653d3fd1d4cfdf2408588e32c4aa62bd02a50ec93c36.yml +openapi_spec_hash: 8d061396a2fff9d1add4d5baf03ab939 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 0325e391..1263fdc0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,9 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); +$response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" +); var_dump($response->videoCodec); ``` @@ -74,7 +76,9 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); + $response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" + ); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -122,7 +126,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -144,7 +148,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index c698af13..b6dc0ac5 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -104,13 +104,7 @@ public function rename( /** * @api * - * @param string $file The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index 5eb5ecbf..ed58094f 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -257,13 +257,7 @@ public function rename( * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * - * @param string $file The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index f16f74cd..46cec26e 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -66,13 +66,7 @@ final class FileUploadParams implements BaseModel use SdkParams; /** - * The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ #[Api] public string $file; @@ -344,13 +338,7 @@ public static function with( } /** - * The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ public function withFile(string $file): self { diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 457d84a4..e5d99bdf 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,7 +163,10 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://www.example.com/path/to-image.jpg', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } @@ -175,7 +178,10 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://www.example.com/path/to-image.jpg', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } From 0daa17580a73ebd447e344f01fa36f1fb593dd4d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 2 Sep 2025 09:11:06 +0000 Subject: [PATCH 11/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++-------- src/Core/ServiceContracts/FilesContract.php | 8 +++++++- src/Core/Services/FilesService.php | 8 +++++++- src/Files/FileUploadParams.php | 16 ++++++++++++++-- tests/Services/FilesTest.php | 10 ++-------- 6 files changed, 36 insertions(+), 22 deletions(-) diff --git a/.stats.yml b/.stats.yml index d458a07c..cfcbd7f7 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-e7bc47a9221d7da9c8c9653d3fd1d4cfdf2408588e32c4aa62bd02a50ec93c36.yml -openapi_spec_hash: 8d061396a2fff9d1add4d5baf03ab939 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml +openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 1263fdc0..0325e391 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,7 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" -); +$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); var_dump($response->videoCodec); ``` @@ -76,9 +74,7 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" - ); + $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -126,7 +122,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -148,7 +144,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index b6dc0ac5..c698af13 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -104,7 +104,13 @@ public function rename( /** * @api * - * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index ed58094f..5eb5ecbf 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -257,7 +257,13 @@ public function rename( * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * - * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index 46cec26e..f16f74cd 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -66,7 +66,13 @@ final class FileUploadParams implements BaseModel use SdkParams; /** - * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ #[Api] public string $file; @@ -338,7 +344,13 @@ public static function with( } /** - * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ public function withFile(string $file): self { diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index e5d99bdf..457d84a4 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,10 +163,7 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://www.example.com/path/to-image.jpg', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } @@ -178,10 +175,7 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://www.example.com/path/to-image.jpg', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } From aba7242684bdef5c8926ef4f1e7b0909650cbf17 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 3 Sep 2025 02:30:13 +0000 Subject: [PATCH 12/40] chore(internal): refactor base client internals --- src/Core/BaseClient.php | 88 +++++++++++++++++++++++++++++----- src/Core/Concerns/SdkModel.php | 2 +- 2 files changed, 78 insertions(+), 12 deletions(-) diff --git a/src/Core/BaseClient.php b/src/Core/BaseClient.php index d0a5c00a..f3229494 100644 --- a/src/Core/BaseClient.php +++ b/src/Core/BaseClient.php @@ -8,8 +8,10 @@ use ImageKit\Core\Contracts\BaseStream; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Exceptions\APIConnectionException; use ImageKit\Core\Exceptions\APIStatusException; use ImageKit\RequestOptions; +use Psr\Http\Client\ClientExceptionInterface; use Psr\Http\Client\ClientInterface; use Psr\Http\Message\RequestFactoryInterface; use Psr\Http\Message\RequestInterface; @@ -41,7 +43,7 @@ public function __construct( string $baseUrl, protected RequestOptions $options = new RequestOptions, ) { - assert(null !== $this->options->uriFactory); + assert(!is_null($this->options->uriFactory)); $this->baseUrl = $this->options->uriFactory->createUri($baseUrl); } @@ -67,7 +69,7 @@ public function request( // @phpstan-ignore-next-line [$req, $opts] = $this->buildRequest(method: $method, path: $path, query: $query, headers: $headers, body: $body, opts: $options); ['method' => $method, 'path' => $uri, 'headers' => $headers] = $req; - assert(null !== $opts->requestFactory); + assert(!is_null($opts->requestFactory)); $request = $opts->requestFactory->createRequest($method, uri: $uri); $request = Util::withSetHeaders($request, headers: $headers); @@ -170,7 +172,7 @@ protected function followRedirect( ): RequestInterface { $location = $rsp->getHeaderLine('Location'); if (!$location) { - throw new \RuntimeException('Redirection without Location header'); + throw new APIConnectionException($req, message: 'Redirection without Location header'); } $uri = Util::joinUri($req->getUri(), path: $location); @@ -178,6 +180,55 @@ protected function followRedirect( return $req->withUri($uri); } + /** + * @internal + */ + protected function shouldRetry( + RequestOptions $opts, + int $retryCount, + ?ResponseInterface $rsp + ): bool { + if ($retryCount >= $opts->maxRetries) { + return false; + } + + $code = $rsp?->getStatusCode(); + if (408 == $code || 409 == $code || 429 == $code || $code >= 500) { + return true; + } + + return false; + } + + /** + * @internal + */ + protected function retryDelay( + RequestOptions $opts, + int $retryCount, + ?ResponseInterface $rsp + ): float { + if (!empty($header = $rsp?->getHeaderLine('retry-after'))) { + if (is_numeric($header)) { + return floatval($header); + } + + try { + $date = new \DateTimeImmutable($header); + $span = time() - $date->getTimestamp(); + + return max(0.0, $span); + } catch (\DateMalformedStringException) { + } + } + + $scale = $retryCount ** 2; + $jitter = 1 - (0.25 * mt_rand() / mt_getrandmax()); + $naive = $opts->initialRetryDelay * $scale * $jitter; + + return max(0.0, min($naive, $opts->maxRetryDelay)); + } + /** * @internal * @@ -194,12 +245,23 @@ protected function sendRequest( assert(null !== $opts->streamFactory && null !== $opts->transporter); $req = Util::withSetBody($opts->streamFactory, req: $req, body: $data); - $rsp = $opts->transporter->sendRequest($req); - $code = $rsp->getStatusCode(); + + $rsp = null; + $err = null; + + try { + $rsp = $opts->transporter->sendRequest($req); + } catch (ClientExceptionInterface $e) { + $err = $e; + } + + $code = $rsp?->getStatusCode(); if ($code >= 300 && $code < 400) { + assert(!is_null($rsp)); + if ($redirectCount >= 20) { - throw new \RuntimeException('Maximum redirects exceeded'); + throw new APIConnectionException($req, message: 'Maximum redirects exceeded'); } $req = $this->followRedirect($rsp, req: $req); @@ -207,12 +269,16 @@ protected function sendRequest( return $this->sendRequest($opts, req: $req, data: $data, retryCount: $retryCount, redirectCount: ++$redirectCount); } - if ($code >= 400 && $code < 500) { - throw APIStatusException::from(request: $req, response: $rsp); - } + if ($code >= 400 || is_null($rsp)) { + if ($this->shouldRetry($opts, retryCount: $retryCount, rsp: $rsp)) { + $exn = is_null($rsp) ? new APIConnectionException($req, previous: $err) : APIStatusException::from(request: $req, response: $rsp); + + throw $exn; + } - if ($code >= 500 && $retryCount < $opts->maxRetries) { - usleep((int) $opts->initialRetryDelay); + $seconds = $this->retryDelay($opts, retryCount: $redirectCount, rsp: $rsp); + $floor = floor($seconds); + time_nanosleep((int) $floor, nanoseconds: (int) ($seconds - $floor) * 10 ** 9); return $this->sendRequest($opts, req: $req, data: $data, retryCount: ++$retryCount, redirectCount: $redirectCount); } diff --git a/src/Core/Concerns/SdkModel.php b/src/Core/Concerns/SdkModel.php index da86c0ad..35f52cf4 100644 --- a/src/Core/Concerns/SdkModel.php +++ b/src/Core/Concerns/SdkModel.php @@ -125,7 +125,7 @@ public function offsetExists(mixed $offset): bool return true; } - $property = self::$converter->properties[$offset]->property ?? new \ReflectionProperty($this, property: $offset); + $property = self::$converter->properties[$offset]->property; return $property->isInitialized($this); } From 79f9906770fee9602f9b1ed6397b5b00f015bcd2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 3 Sep 2025 11:41:15 +0000 Subject: [PATCH 13/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++++++---- src/Core/ServiceContracts/FilesContract.php | 9 ++------- src/Core/Services/FilesService.php | 9 ++------- src/Files/FileUploadParams.php | 18 ++++-------------- tests/Services/FilesTest.php | 10 ++++++++-- 6 files changed, 26 insertions(+), 36 deletions(-) diff --git a/.stats.yml b/.stats.yml index cfcbd7f7..db7d8f1e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml -openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-9ae7b43dcfd6208ca37c32c887630ae186ec338bcdd36902b6fe5d1cc66459dc.yml +openapi_spec_hash: 25fb64c067e64bcff6eaaabda26de397 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 0325e391..1263fdc0 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,9 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); +$response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" +); var_dump($response->videoCodec); ``` @@ -74,7 +76,9 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); + $response = $client->files->upload( + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" + ); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -122,7 +126,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -144,7 +148,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: 'file', + file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index c698af13..918e01b4 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -104,13 +104,8 @@ public function rename( /** * @api * - * @param string $file The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. + * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index 5eb5ecbf..b6566ce5 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -257,13 +257,8 @@ public function rename( * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * - * @param string $file The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. + * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index f16f74cd..d955b8f1 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -66,13 +66,8 @@ final class FileUploadParams implements BaseModel use SdkParams; /** - * The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. + * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ #[Api] public string $file; @@ -344,13 +339,8 @@ public static function with( } /** - * The API accepts any of the following: - * - * - **Binary data** – send the raw bytes as `multipart/form-data`. - * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. - * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. - * - * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. + * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ public function withFile(string $file): self { diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 457d84a4..c3e46399 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,7 +163,10 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://example.com', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } @@ -175,7 +178,10 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); + $result = $this->client->files->upload( + file: 'https://example.com', + fileName: 'fileName' + ); $this->assertTrue(true); // @phpstan-ignore-line } From e5c508410d385f8eff5f39db8e973c34ea78ef0d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 3 Sep 2025 11:45:31 +0000 Subject: [PATCH 14/40] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index db7d8f1e..f8166f44 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-9ae7b43dcfd6208ca37c32c887630ae186ec338bcdd36902b6fe5d1cc66459dc.yml -openapi_spec_hash: 25fb64c067e64bcff6eaaabda26de397 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-5ce78cb448cc4520f5fbcc753452e0237b50a4bf64902e0548a8ad24bbdc82cf.yml +openapi_spec_hash: fd8ac4c2cdddc3d3a0b0c81be6a9edfe config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c From c959bcf6d18e0f078fbed9d50c05d6feb1d81a42 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 02:27:51 +0000 Subject: [PATCH 15/40] chore: document parameter object usage --- src/Accounts/Origins/OriginCreateParams.php | 11 +++++++++++ src/Accounts/Origins/OriginUpdateParams.php | 11 +++++++++++ src/Accounts/URLEndpoints/URLEndpointCreateParams.php | 11 +++++++++++ src/Accounts/URLEndpoints/URLEndpointUpdateParams.php | 11 +++++++++++ src/Accounts/Usage/UsageGetParams.php | 11 +++++++++++ src/Assets/AssetListParams.php | 11 +++++++++++ src/Beta/V2/Files/FileUploadParams.php | 11 +++++++++++ src/Cache/Invalidation/InvalidationCreateParams.php | 11 +++++++++++ .../CustomMetadataFieldCreateParams.php | 11 +++++++++++ .../CustomMetadataFieldListParams.php | 11 +++++++++++ .../CustomMetadataFieldUpdateParams.php | 11 +++++++++++ src/Files/Bulk/BulkAddTagsParams.php | 11 +++++++++++ src/Files/Bulk/BulkDeleteParams.php | 11 +++++++++++ src/Files/Bulk/BulkRemoveAITagsParams.php | 11 +++++++++++ src/Files/Bulk/BulkRemoveTagsParams.php | 11 +++++++++++ src/Files/FileCopyParams.php | 11 +++++++++++ src/Files/FileMoveParams.php | 11 +++++++++++ src/Files/FileRenameParams.php | 11 +++++++++++ src/Files/FileUpdateParams.php | 11 +++++++++++ src/Files/FileUploadParams.php | 11 +++++++++++ src/Files/Metadata/MetadataGetFromURLParams.php | 11 +++++++++++ src/Files/Versions/VersionDeleteParams.php | 11 +++++++++++ src/Files/Versions/VersionGetParams.php | 11 +++++++++++ src/Files/Versions/VersionRestoreParams.php | 11 +++++++++++ src/Folders/FolderCopyParams.php | 11 +++++++++++ src/Folders/FolderCreateParams.php | 11 +++++++++++ src/Folders/FolderDeleteParams.php | 11 +++++++++++ src/Folders/FolderMoveParams.php | 11 +++++++++++ src/Folders/FolderRenameParams.php | 11 +++++++++++ 29 files changed, 319 insertions(+) diff --git a/src/Accounts/Origins/OriginCreateParams.php b/src/Accounts/Origins/OriginCreateParams.php index 1ba42b68..9cd5822a 100644 --- a/src/Accounts/Origins/OriginCreateParams.php +++ b/src/Accounts/Origins/OriginCreateParams.php @@ -18,9 +18,20 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new OriginCreateParams); // set properties as needed + * $client->accounts.origins->create(...$params->toArray()); + * ``` * **Note:** This API is currently in beta. * Creates a new origin and returns the origin object. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->accounts.origins->create(...$params->toArray());` + * * @see ImageKit\Accounts\Origins->create * * @phpstan-type origin_create_params = array{ diff --git a/src/Accounts/Origins/OriginUpdateParams.php b/src/Accounts/Origins/OriginUpdateParams.php index bbcec186..e42e6c03 100644 --- a/src/Accounts/Origins/OriginUpdateParams.php +++ b/src/Accounts/Origins/OriginUpdateParams.php @@ -18,9 +18,20 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new OriginUpdateParams); // set properties as needed + * $client->accounts.origins->update(...$params->toArray()); + * ``` * **Note:** This API is currently in beta. * Updates the origin identified by `id` and returns the updated origin object. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->accounts.origins->update(...$params->toArray());` + * * @see ImageKit\Accounts\Origins->update * * @phpstan-type origin_update_params = array{ diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams.php index 9afd5302..050e4196 100644 --- a/src/Accounts/URLEndpoints/URLEndpointCreateParams.php +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams.php @@ -14,9 +14,20 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new URLEndpointCreateParams); // set properties as needed + * $client->accounts.urlEndpoints->create(...$params->toArray()); + * ``` * **Note:** This API is currently in beta. * Creates a new URL‑endpoint and returns the resulting object. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->accounts.urlEndpoints->create(...$params->toArray());` + * * @see ImageKit\Accounts\URLEndpoints->create * * @phpstan-type url_endpoint_create_params = array{ diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php index ff6de86b..7bcaea5c 100644 --- a/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams.php @@ -14,9 +14,20 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new URLEndpointUpdateParams); // set properties as needed + * $client->accounts.urlEndpoints->update(...$params->toArray()); + * ``` * **Note:** This API is currently in beta. * Updates the URL‑endpoint identified by `id` and returns the updated object. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->accounts.urlEndpoints->update(...$params->toArray());` + * * @see ImageKit\Accounts\URLEndpoints->update * * @phpstan-type url_endpoint_update_params = array{ diff --git a/src/Accounts/Usage/UsageGetParams.php b/src/Accounts/Usage/UsageGetParams.php index b2a3c202..ebd52bda 100644 --- a/src/Accounts/Usage/UsageGetParams.php +++ b/src/Accounts/Usage/UsageGetParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new UsageGetParams); // set properties as needed + * $client->accounts.usage->get(...$params->toArray()); + * ``` * Get the account usage information between two dates. Note that the API response includes data from the start date while excluding data from the end date. In other words, the data covers the period starting from the specified start date up to, but not including, the end date. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->accounts.usage->get(...$params->toArray());` + * * @see ImageKit\Accounts\Usage->get * * @phpstan-type usage_get_params = array{ diff --git a/src/Assets/AssetListParams.php b/src/Assets/AssetListParams.php index b24fabb4..f788cfbd 100644 --- a/src/Assets/AssetListParams.php +++ b/src/Assets/AssetListParams.php @@ -13,8 +13,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new AssetListParams); // set properties as needed + * $client->assets->list(...$params->toArray()); + * ``` * This API can list all the uploaded files and folders in your ImageKit.io media library. In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and provide this generated string as the value of the `searchQuery`. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->assets->list(...$params->toArray());` + * * @see ImageKit\Assets->list * * @phpstan-type asset_list_params = array{ diff --git a/src/Beta/V2/Files/FileUploadParams.php b/src/Beta/V2/Files/FileUploadParams.php index cd83a4c0..f5742282 100644 --- a/src/Beta/V2/Files/FileUploadParams.php +++ b/src/Beta/V2/Files/FileUploadParams.php @@ -16,6 +16,12 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileUploadParams); // set properties as needed + * $client->beta.v2.files->upload(...$params->toArray()); + * ``` * The V2 API enhances security by verifying the entire payload using JWT. This API is in beta. * * ImageKit.io allows you to upload files directly from both the server and client sides. For server-side uploads, private API key authentication is used. For client-side uploads, generate a one-time `token` from your secure backend using private API. [Learn more](/docs/api-reference/upload-file/upload-file-v2#how-to-implement-secure-client-side-file-upload) about how to implement secure client-side file upload. @@ -31,6 +37,11 @@ * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->beta.v2.files->upload(...$params->toArray());` + * * @see ImageKit\Beta\V2\Files->upload * * @phpstan-type file_upload_params = array{ diff --git a/src/Cache/Invalidation/InvalidationCreateParams.php b/src/Cache/Invalidation/InvalidationCreateParams.php index ca1f5eeb..881250e3 100644 --- a/src/Cache/Invalidation/InvalidationCreateParams.php +++ b/src/Cache/Invalidation/InvalidationCreateParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new InvalidationCreateParams); // set properties as needed + * $client->cache.invalidation->create(...$params->toArray()); + * ``` * This API will purge CDN cache and ImageKit.io's internal cache for a file. Note: Purge cache is an asynchronous process and it may take some time to reflect the changes. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->cache.invalidation->create(...$params->toArray());` + * * @see ImageKit\Cache\Invalidation->create * * @phpstan-type invalidation_create_params = array{url: string} diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams.php index 5b8bc5a3..055c3d90 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldCreateParams.php +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams.php @@ -11,8 +11,19 @@ use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new CustomMetadataFieldCreateParams); // set properties as needed + * $client->customMetadataFields->create(...$params->toArray()); + * ``` * This API creates a new custom metadata field. Once a custom metadata field is created either through this API or using the dashboard UI, its value can be set on the assets. The value of a field for an asset can be set using the media library UI or programmatically through upload or update assets API. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->customMetadataFields->create(...$params->toArray());` + * * @see ImageKit\CustomMetadataFields->create * * @phpstan-type custom_metadata_field_create_params = array{ diff --git a/src/CustomMetadataFields/CustomMetadataFieldListParams.php b/src/CustomMetadataFields/CustomMetadataFieldListParams.php index 9e0ed855..852c124a 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldListParams.php +++ b/src/CustomMetadataFields/CustomMetadataFieldListParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new CustomMetadataFieldListParams); // set properties as needed + * $client->customMetadataFields->list(...$params->toArray()); + * ``` * This API returns the array of created custom metadata field objects. By default the API returns only non deleted field objects, but you can include deleted fields in the API response. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->customMetadataFields->list(...$params->toArray());` + * * @see ImageKit\CustomMetadataFields->list * * @phpstan-type custom_metadata_field_list_params = array{includeDeleted?: bool} diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php index 54fb7c37..0d72504d 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams.php @@ -11,8 +11,19 @@ use ImageKit\CustomMetadataFields\CustomMetadataFieldUpdateParams\Schema; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new CustomMetadataFieldUpdateParams); // set properties as needed + * $client->customMetadataFields->update(...$params->toArray()); + * ``` * This API updates the label or schema of an existing custom metadata field. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->customMetadataFields->update(...$params->toArray());` + * * @see ImageKit\CustomMetadataFields->update * * @phpstan-type custom_metadata_field_update_params = array{ diff --git a/src/Files/Bulk/BulkAddTagsParams.php b/src/Files/Bulk/BulkAddTagsParams.php index 53ffd749..6ce38baa 100644 --- a/src/Files/Bulk/BulkAddTagsParams.php +++ b/src/Files/Bulk/BulkAddTagsParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new BulkAddTagsParams); // set properties as needed + * $client->files.bulk->addTags(...$params->toArray()); + * ``` * This API adds tags to multiple files in bulk. A maximum of 50 files can be specified at a time. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.bulk->addTags(...$params->toArray());` + * * @see ImageKit\Files\Bulk->addTags * * @phpstan-type bulk_add_tags_params = array{ diff --git a/src/Files/Bulk/BulkDeleteParams.php b/src/Files/Bulk/BulkDeleteParams.php index c7b6e882..7898f84d 100644 --- a/src/Files/Bulk/BulkDeleteParams.php +++ b/src/Files/Bulk/BulkDeleteParams.php @@ -10,12 +10,23 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new BulkDeleteParams); // set properties as needed + * $client->files.bulk->delete(...$params->toArray()); + * ``` * This API deletes multiple files and all their file versions permanently. * * Note: If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. You can purge the cache using purge cache API. * * A maximum of 100 files can be deleted at a time. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.bulk->delete(...$params->toArray());` + * * @see ImageKit\Files\Bulk->delete * * @phpstan-type bulk_delete_params = array{fileIDs: list} diff --git a/src/Files/Bulk/BulkRemoveAITagsParams.php b/src/Files/Bulk/BulkRemoveAITagsParams.php index 2fe76ca5..a5d9c1cb 100644 --- a/src/Files/Bulk/BulkRemoveAITagsParams.php +++ b/src/Files/Bulk/BulkRemoveAITagsParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new BulkRemoveAITagsParams); // set properties as needed + * $client->files.bulk->removeAITags(...$params->toArray()); + * ``` * This API removes AITags from multiple files in bulk. A maximum of 50 files can be specified at a time. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.bulk->removeAITags(...$params->toArray());` + * * @see ImageKit\Files\Bulk->removeAITags * * @phpstan-type bulk_remove_ai_tags_params = array{ diff --git a/src/Files/Bulk/BulkRemoveTagsParams.php b/src/Files/Bulk/BulkRemoveTagsParams.php index 678dc4ed..0f442e97 100644 --- a/src/Files/Bulk/BulkRemoveTagsParams.php +++ b/src/Files/Bulk/BulkRemoveTagsParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new BulkRemoveTagsParams); // set properties as needed + * $client->files.bulk->removeTags(...$params->toArray()); + * ``` * This API removes tags from multiple files in bulk. A maximum of 50 files can be specified at a time. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.bulk->removeTags(...$params->toArray());` + * * @see ImageKit\Files\Bulk->removeTags * * @phpstan-type bulk_remove_tags_params = array{ diff --git a/src/Files/FileCopyParams.php b/src/Files/FileCopyParams.php index fce0e5d8..2d2ae572 100644 --- a/src/Files/FileCopyParams.php +++ b/src/Files/FileCopyParams.php @@ -10,10 +10,21 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileCopyParams); // set properties as needed + * $client->files->copy(...$params->toArray()); + * ``` * This will copy a file from one folder to another. * * Note: If any file at the destination has the same name as the source file, then the source file and its versions (if `includeFileVersions` is set to true) will be appended to the destination file version history. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files->copy(...$params->toArray());` + * * @see ImageKit\Files->copy * * @phpstan-type file_copy_params = array{ diff --git a/src/Files/FileMoveParams.php b/src/Files/FileMoveParams.php index 68c5a7a4..d9061fe0 100644 --- a/src/Files/FileMoveParams.php +++ b/src/Files/FileMoveParams.php @@ -10,10 +10,21 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileMoveParams); // set properties as needed + * $client->files->move(...$params->toArray()); + * ``` * This will move a file and all its versions from one folder to another. * * Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files->move(...$params->toArray());` + * * @see ImageKit\Files->move * * @phpstan-type file_move_params = array{ diff --git a/src/Files/FileRenameParams.php b/src/Files/FileRenameParams.php index b41454d5..7ec02dea 100644 --- a/src/Files/FileRenameParams.php +++ b/src/Files/FileRenameParams.php @@ -10,10 +10,21 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileRenameParams); // set properties as needed + * $client->files->rename(...$params->toArray()); + * ``` * You can rename an already existing file in the media library using rename file API. This operation would rename all file versions of the file. * * Note: The old URLs will stop working. The file/file version URLs cached on CDN will continue to work unless a purge is requested. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files->rename(...$params->toArray());` + * * @see ImageKit\Files->rename * * @phpstan-type file_rename_params = array{ diff --git a/src/Files/FileUpdateParams.php b/src/Files/FileUpdateParams.php index 6289a5c2..195b76da 100644 --- a/src/Files/FileUpdateParams.php +++ b/src/Files/FileUpdateParams.php @@ -12,8 +12,19 @@ use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileUpdateParams); // set properties as needed + * $client->files->update(...$params->toArray()); + * ``` * This API updates the details or attributes of the current version of the file. You can update `tags`, `customCoordinates`, `customMetadata`, publication status, remove existing `AITags` and apply extensions using this API. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files->update(...$params->toArray());` + * * @see ImageKit\Files->update * * @phpstan-type file_update_params = array{ diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index d955b8f1..aa14493c 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -16,6 +16,12 @@ use ImageKit\Files\FileUploadParams\Transformation; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FileUploadParams); // set properties as needed + * $client->files->upload(...$params->toArray()); + * ``` * ImageKit.io allows you to upload files directly from both the server and client sides. For server-side uploads, private API key authentication is used. For client-side uploads, generate a one-time `token`, `signature`, and `expire` from your secure backend using private API. [Learn more](/docs/api-reference/upload-file/upload-file#how-to-implement-client-side-file-upload) about how to implement client-side file upload. * * The [V2 API](/docs/api-reference/upload-file/upload-file-v2) enhances security by verifying the entire payload using JWT. @@ -31,6 +37,11 @@ * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files->upload(...$params->toArray());` + * * @see ImageKit\Files->upload * * @phpstan-type file_upload_params = array{ diff --git a/src/Files/Metadata/MetadataGetFromURLParams.php b/src/Files/Metadata/MetadataGetFromURLParams.php index d56164d9..cc871ebf 100644 --- a/src/Files/Metadata/MetadataGetFromURLParams.php +++ b/src/Files/Metadata/MetadataGetFromURLParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new MetadataGetFromURLParams); // set properties as needed + * $client->files.metadata->getFromURL(...$params->toArray()); + * ``` * Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL using this API. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.metadata->getFromURL(...$params->toArray());` + * * @see ImageKit\Files\Metadata->getFromURL * * @phpstan-type metadata_get_from_url_params = array{url: string} diff --git a/src/Files/Versions/VersionDeleteParams.php b/src/Files/Versions/VersionDeleteParams.php index a5c99a18..cb70f500 100644 --- a/src/Files/Versions/VersionDeleteParams.php +++ b/src/Files/Versions/VersionDeleteParams.php @@ -10,10 +10,21 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new VersionDeleteParams); // set properties as needed + * $client->files.versions->delete(...$params->toArray()); + * ``` * This API deletes a non-current file version permanently. The API returns an empty response. * * Note: If you want to delete all versions of a file, use the delete file API. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.versions->delete(...$params->toArray());` + * * @see ImageKit\Files\Versions->delete * * @phpstan-type version_delete_params = array{fileID: string} diff --git a/src/Files/Versions/VersionGetParams.php b/src/Files/Versions/VersionGetParams.php index e6d9ac37..d1cc4eb0 100644 --- a/src/Files/Versions/VersionGetParams.php +++ b/src/Files/Versions/VersionGetParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new VersionGetParams); // set properties as needed + * $client->files.versions->get(...$params->toArray()); + * ``` * This API returns an object with details or attributes of a file version. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.versions->get(...$params->toArray());` + * * @see ImageKit\Files\Versions->get * * @phpstan-type version_get_params = array{fileID: string} diff --git a/src/Files/Versions/VersionRestoreParams.php b/src/Files/Versions/VersionRestoreParams.php index e1deb729..30e9d03f 100644 --- a/src/Files/Versions/VersionRestoreParams.php +++ b/src/Files/Versions/VersionRestoreParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new VersionRestoreParams); // set properties as needed + * $client->files.versions->restore(...$params->toArray()); + * ``` * This API restores a file version as the current file version. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->files.versions->restore(...$params->toArray());` + * * @see ImageKit\Files\Versions->restore * * @phpstan-type version_restore_params = array{fileID: string} diff --git a/src/Folders/FolderCopyParams.php b/src/Folders/FolderCopyParams.php index c70ebbac..d1b48d1d 100644 --- a/src/Folders/FolderCopyParams.php +++ b/src/Folders/FolderCopyParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FolderCopyParams); // set properties as needed + * $client->folders->copy(...$params->toArray()); + * ``` * This will copy one folder into another. The selected folder, its nested folders, files, and their versions (in `includeVersions` is set to true) are copied in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->folders->copy(...$params->toArray());` + * * @see ImageKit\Folders->copy * * @phpstan-type folder_copy_params = array{ diff --git a/src/Folders/FolderCreateParams.php b/src/Folders/FolderCreateParams.php index 7698adae..26230c90 100644 --- a/src/Folders/FolderCreateParams.php +++ b/src/Folders/FolderCreateParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FolderCreateParams); // set properties as needed + * $client->folders->create(...$params->toArray()); + * ``` * This will create a new folder. You can specify the folder name and location of the parent folder where this new folder should be created. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->folders->create(...$params->toArray());` + * * @see ImageKit\Folders->create * * @phpstan-type folder_create_params = array{ diff --git a/src/Folders/FolderDeleteParams.php b/src/Folders/FolderDeleteParams.php index 0af429b0..b22108f9 100644 --- a/src/Folders/FolderDeleteParams.php +++ b/src/Folders/FolderDeleteParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FolderDeleteParams); // set properties as needed + * $client->folders->delete(...$params->toArray()); + * ``` * This will delete a folder and all its contents permanently. The API returns an empty response. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->folders->delete(...$params->toArray());` + * * @see ImageKit\Folders->delete * * @phpstan-type folder_delete_params = array{folderPath: string} diff --git a/src/Folders/FolderMoveParams.php b/src/Folders/FolderMoveParams.php index f04be7df..d2819441 100644 --- a/src/Folders/FolderMoveParams.php +++ b/src/Folders/FolderMoveParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FolderMoveParams); // set properties as needed + * $client->folders->move(...$params->toArray()); + * ``` * This will move one folder into another. The selected folder, its nested folders, files, and their versions are moved in this operation. Note: If any file at the destination has the same name as the source file, then the source file and its versions will be appended to the destination file version history. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->folders->move(...$params->toArray());` + * * @see ImageKit\Folders->move * * @phpstan-type folder_move_params = array{ diff --git a/src/Folders/FolderRenameParams.php b/src/Folders/FolderRenameParams.php index e7260993..a6356be1 100644 --- a/src/Folders/FolderRenameParams.php +++ b/src/Folders/FolderRenameParams.php @@ -10,8 +10,19 @@ use ImageKit\Core\Contracts\BaseModel; /** + * An object containing the method's parameters. + * Example usage: + * ``` + * $params = (new FolderRenameParams); // set properties as needed + * $client->folders->rename(...$params->toArray()); + * ``` * This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name. * + * @method toArray() + * Returns the parameters as an associative array suitable for passing to the client method. + * + * `$client->folders->rename(...$params->toArray());` + * * @see ImageKit\Folders->rename * * @phpstan-type folder_rename_params = array{ From de13f687044f442b41ec1de7a72c2fd3ad27f1e1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 05:43:59 +0000 Subject: [PATCH 16/40] feat(api): manual updates --- .stats.yml | 4 ++-- README.md | 12 ++++-------- src/Core/ServiceContracts/FilesContract.php | 9 +++++++-- src/Core/Services/FilesService.php | 9 +++++++-- src/Files/FileUploadParams.php | 18 ++++++++++++++---- tests/Services/FilesTest.php | 10 ++-------- 6 files changed, 36 insertions(+), 26 deletions(-) diff --git a/.stats.yml b/.stats.yml index f8166f44..cfcbd7f7 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-5ce78cb448cc4520f5fbcc753452e0237b50a4bf64902e0548a8ad24bbdc82cf.yml -openapi_spec_hash: fd8ac4c2cdddc3d3a0b0c81be6a9edfe +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml +openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/README.md b/README.md index 1263fdc0..0325e391 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,7 @@ $client = new Client( password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); -$response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" -); +$response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); var_dump($response->videoCodec); ``` @@ -76,9 +74,7 @@ When the library is unable to connect to the API, or if the API returns a non-su use ImageKit\Core\Exceptions\APIConnectionException; try { - $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg" - ); + $response = $client->files->upload(file: 'file', fileName: "file-name.jpg"); } catch (APIConnectionException $e) { echo "The server could not be reached", PHP_EOL; var_dump($e->getPrevious()); @@ -126,7 +122,7 @@ $client = new Client(maxRetries: 0); // Or, configure per-request: $result = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with(maxRetries: 5), ); @@ -148,7 +144,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete use ImageKit\RequestOptions; $response = $client->files->upload( - file: "https://www.example.com/public-url.jpg", + file: 'file', fileName: "file-name.jpg", requestOptions: RequestOptions::with( extraQueryParams: ["my_query_parameter" => "value"], diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index 918e01b4..c698af13 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -104,8 +104,13 @@ public function rename( /** * @api * - * @param string $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. - * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index b6566ce5..5eb5ecbf 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -257,8 +257,13 @@ public function rename( * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more. * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies. * - * @param string $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. - * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * @param string $file The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. * @param string $fileName The name with which the file has to be uploaded. * The file name can contain: * diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index aa14493c..50ba7ed6 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -77,8 +77,13 @@ final class FileUploadParams implements BaseModel use SdkParams; /** - * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. - * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ #[Api] public string $file; @@ -350,8 +355,13 @@ public static function with( } /** - * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch. - * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. + * The API accepts any of the following: + * + * - **Binary data** – send the raw bytes as `multipart/form-data`. + * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch. + * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64. + * + * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request. */ public function withFile(string $file): self { diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index c3e46399..457d84a4 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -163,10 +163,7 @@ public function testUpload(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://example.com', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } @@ -178,10 +175,7 @@ public function testUploadWithOptionalParams(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->upload( - file: 'https://example.com', - fileName: 'fileName' - ); + $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); $this->assertTrue(true); // @phpstan-ignore-line } From 2361086b4a3578fc04ac20da138d1ebcf3f92852 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 06:00:13 +0000 Subject: [PATCH 17/40] feat(api): manual updates --- .stats.yml | 4 ++-- src/Beta/V2/Files/FileUploadParams.php | 4 ++-- src/Core/ServiceContracts/Beta/V2/FilesContract.php | 2 +- src/Core/ServiceContracts/FilesContract.php | 2 +- src/Core/Services/Beta/V2/FilesService.php | 2 +- src/Core/Services/FilesService.php | 2 +- src/Files/FileUploadParams.php | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index cfcbd7f7..5908457a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml -openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0470196862abd722b09f1af798d6f2bcbdeba0f82d1162f57c287b1a43233531.yml +openapi_spec_hash: 043dd7c67d741d0034b86f2fc0bce072 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c diff --git a/src/Beta/V2/Files/FileUploadParams.php b/src/Beta/V2/Files/FileUploadParams.php index f5742282..dde14059 100644 --- a/src/Beta/V2/Files/FileUploadParams.php +++ b/src/Beta/V2/Files/FileUploadParams.php @@ -134,7 +134,7 @@ final class FileUploadParams implements BaseModel public ?string $description; /** - * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * * @var list|null $extensions */ @@ -411,7 +411,7 @@ public function withDescription(string $description): self } /** - * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * * @param list $extensions */ diff --git a/src/Core/ServiceContracts/Beta/V2/FilesContract.php b/src/Core/ServiceContracts/Beta/V2/FilesContract.php index cf4f4f19..ae026055 100644 --- a/src/Core/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/Core/ServiceContracts/Beta/V2/FilesContract.php @@ -38,7 +38,7 @@ interface FilesContract * @param array $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. * @param string $description optional text to describe the contents of the file - * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. * @param bool $isPrivateFile Whether to mark the file as private or not. * diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index c698af13..00aca4d8 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -132,7 +132,7 @@ public function rename( * mixed,> $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. * @param string $description optional text to describe the contents of the file * @param int $expire The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. - * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. * * The folder name can contain: diff --git a/src/Core/Services/Beta/V2/FilesService.php b/src/Core/Services/Beta/V2/FilesService.php index 9cb9ef2f..305ac939 100644 --- a/src/Core/Services/Beta/V2/FilesService.php +++ b/src/Core/Services/Beta/V2/FilesService.php @@ -61,7 +61,7 @@ public function __construct(private Client $client) {} * @param array $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. * @param string $description optional text to describe the contents of the file - * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. Using multiple `/` creates a nested folder. * @param bool $isPrivateFile Whether to mark the file as private or not. * diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index 5eb5ecbf..c6010e84 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -285,7 +285,7 @@ public function rename( * mixed,> $customMetadata JSON key-value pairs to associate with the asset. Create the custom metadata fields before setting these values. * @param string $description optional text to describe the contents of the file * @param int $expire The time until your signature is valid. It must be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in less than 1 hour into the future. It should be in seconds. This field is only required for authentication when uploading a file from the client side. - * @param list $extensions Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * @param string $folder The folder path in which the image has to be uploaded. If the folder(s) didn't exist before, a new folder(s) is created. * * The folder name can contain: diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index 50ba7ed6..26c31c0c 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -146,7 +146,7 @@ final class FileUploadParams implements BaseModel public ?int $expire; /** - * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * * @var list|null $extensions */ @@ -464,7 +464,7 @@ public function withExpire(int $expire): self } /** - * Array of extensions to be applied to the image. Each extension can be configured with specific parameters based on the extension type. + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. * * @param list $extensions */ From e5c142868fae36f9f88f4142b98b47a1abbbaa1c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 06:03:21 +0000 Subject: [PATCH 18/40] feat(api): manual updates --- .stats.yml | 2 +- src/Beta/V2/Files/FileUploadParams.php | 10 +- .../V2/Files/FileUploadParams/Extension.php | 35 ------ .../Extension/AIAutoDescription.php | 39 ------ .../Extension/AutoTaggingExtension.php | 119 ------------------ .../Extension/AutoTaggingExtension/Name.php | 20 --- .../FileUploadParams/Extension/RemoveBg.php | 55 -------- .../Extension/RemoveBg/Options.php | 117 ----------------- .../Beta/V2/FilesContract.php | 6 +- src/Core/ServiceContracts/FilesContract.php | 6 +- src/Core/Services/Beta/V2/FilesService.php | 6 +- src/Core/Services/FilesService.php | 6 +- .../Extension.php => ExtensionItem.php} | 10 +- .../AIAutoDescription.php | 2 +- .../AutoTaggingExtension.php | 4 +- .../AutoTaggingExtension/Name.php | 2 +- .../Extension => ExtensionItem}/RemoveBg.php | 4 +- .../RemoveBg/Options.php | 2 +- .../Update/UpdateFileDetails.php | 10 +- .../Update/UpdateFileDetails/Extension.php | 35 ------ .../Extension/AIAutoDescription.php | 39 ------ .../Extension/AutoTaggingExtension.php | 119 ------------------ .../Extension/AutoTaggingExtension/Name.php | 20 --- .../UpdateFileDetails/Extension/RemoveBg.php | 55 -------- .../Extension/RemoveBg/Options.php | 117 ----------------- src/Files/FileUploadParams.php | 10 +- 26 files changed, 40 insertions(+), 810 deletions(-) delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension.php delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg.php delete mode 100644 src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php rename src/{Files/FileUploadParams/Extension.php => ExtensionItem.php} (69%) rename src/{Files/FileUploadParams/Extension => ExtensionItem}/AIAutoDescription.php (93%) rename src/{Files/FileUploadParams/Extension => ExtensionItem}/AutoTaggingExtension.php (95%) rename src/{Files/FileUploadParams/Extension => ExtensionItem}/AutoTaggingExtension/Name.php (83%) rename src/{Files/FileUploadParams/Extension => ExtensionItem}/RemoveBg.php (90%) rename src/{Files/FileUploadParams/Extension => ExtensionItem}/RemoveBg/Options.php (98%) delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php diff --git a/.stats.yml b/.stats.yml index 5908457a..2dc65d21 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0470196862abd722b09f1af798d6f2bcbdeba0f82d1162f57c287b1a43233531.yml openapi_spec_hash: 043dd7c67d741d0034b86f2fc0bce072 -config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c +config_hash: da949a1217f48ac01676eab81ca9d1b1 diff --git a/src/Beta/V2/Files/FileUploadParams.php b/src/Beta/V2/Files/FileUploadParams.php index dde14059..d9c0c919 100644 --- a/src/Beta/V2/Files/FileUploadParams.php +++ b/src/Beta/V2/Files/FileUploadParams.php @@ -4,16 +4,16 @@ namespace ImageKit\Beta\V2\Files; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\RemoveBg; use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Concerns\SdkParams; use ImageKit\Core\Contracts\BaseModel; +use ImageKit\ExtensionItem; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; /** * An object containing the method's parameters. @@ -138,7 +138,7 @@ final class FileUploadParams implements BaseModel * * @var list|null $extensions */ - #[Api(list: Extension::class, optional: true)] + #[Api(list: ExtensionItem::class, optional: true)] public ?array $extensions; /** diff --git a/src/Beta/V2/Files/FileUploadParams/Extension.php b/src/Beta/V2/Files/FileUploadParams/Extension.php deleted file mode 100644 index fa3874f8..00000000 --- a/src/Beta/V2/Files/FileUploadParams/Extension.php +++ /dev/null @@ -1,35 +0,0 @@ -|array - */ - public static function variants(): array - { - return [ - AutoTaggingExtension::class, - 'remove-bg' => RemoveBg::class, - 'ai-auto-description' => AIAutoDescription::class, - ]; - } -} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php b/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php deleted file mode 100644 index 0f4d8b65..00000000 --- a/src/Beta/V2/Files/FileUploadParams/Extension/AIAutoDescription.php +++ /dev/null @@ -1,39 +0,0 @@ - */ - use SdkModel; - - /** - * Specifies the auto description extension. - */ - #[Api] - public string $name = 'ai-auto-description'; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(): self - { - return new self; - } -} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php deleted file mode 100644 index 2d9ba10c..00000000 --- a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension.php +++ /dev/null @@ -1,119 +0,0 @@ - */ - use SdkModel; - - /** - * Maximum number of tags to attach to the asset. - */ - #[Api] - public int $maxTags; - - /** - * Minimum confidence level for tags to be considered valid. - */ - #[Api] - public int $minConfidence; - - /** - * Specifies the auto-tagging extension used. - * - * @var Name::* $name - */ - #[Api(enum: Name::class)] - public string $name; - - /** - * `new AutoTaggingExtension()` is missing required properties by the API. - * - * To enforce required parameters use - * ``` - * AutoTaggingExtension::with(maxTags: ..., minConfidence: ..., name: ...) - * ``` - * - * Otherwise ensure the following setters are called - * - * ``` - * (new AutoTaggingExtension) - * ->withMaxTags(...) - * ->withMinConfidence(...) - * ->withName(...) - * ``` - */ - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - * - * @param Name::* $name - */ - public static function with( - int $maxTags, - int $minConfidence, - string $name - ): self { - $obj = new self; - - $obj->maxTags = $maxTags; - $obj->minConfidence = $minConfidence; - $obj->name = $name; - - return $obj; - } - - /** - * Maximum number of tags to attach to the asset. - */ - public function withMaxTags(int $maxTags): self - { - $obj = clone $this; - $obj->maxTags = $maxTags; - - return $obj; - } - - /** - * Minimum confidence level for tags to be considered valid. - */ - public function withMinConfidence(int $minConfidence): self - { - $obj = clone $this; - $obj->minConfidence = $minConfidence; - - return $obj; - } - - /** - * Specifies the auto-tagging extension used. - * - * @param Name::* $name - */ - public function withName(string $name): self - { - $obj = clone $this; - $obj->name = $name; - - return $obj; - } -} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php b/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php deleted file mode 100644 index 7ad64d68..00000000 --- a/src/Beta/V2/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php +++ /dev/null @@ -1,20 +0,0 @@ - */ - use SdkModel; - - /** - * Specifies the background removal extension. - */ - #[Api] - public string $name = 'remove-bg'; - - #[Api(optional: true)] - public ?Options $options; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(?Options $options = null): self - { - $obj = new self; - - null !== $options && $obj->options = $options; - - return $obj; - } - - public function withOptions(Options $options): self - { - $obj = clone $this; - $obj->options = $options; - - return $obj; - } -} diff --git a/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php b/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php deleted file mode 100644 index 94bf0352..00000000 --- a/src/Beta/V2/Files/FileUploadParams/Extension/RemoveBg/Options.php +++ /dev/null @@ -1,117 +0,0 @@ - */ - use SdkModel; - - /** - * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. - */ - #[Api('add_shadow', optional: true)] - public ?bool $addShadow; - - /** - * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. - */ - #[Api('bg_color', optional: true)] - public ?string $bgColor; - - /** - * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. - */ - #[Api('bg_image_url', optional: true)] - public ?string $bgImageURL; - - /** - * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. - */ - #[Api(optional: true)] - public ?bool $semitransparency; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with( - ?bool $addShadow = null, - ?string $bgColor = null, - ?string $bgImageURL = null, - ?bool $semitransparency = null, - ): self { - $obj = new self; - - null !== $addShadow && $obj->addShadow = $addShadow; - null !== $bgColor && $obj->bgColor = $bgColor; - null !== $bgImageURL && $obj->bgImageURL = $bgImageURL; - null !== $semitransparency && $obj->semitransparency = $semitransparency; - - return $obj; - } - - /** - * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. - */ - public function withAddShadow(bool $addShadow): self - { - $obj = clone $this; - $obj->addShadow = $addShadow; - - return $obj; - } - - /** - * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. - */ - public function withBgColor(string $bgColor): self - { - $obj = clone $this; - $obj->bgColor = $bgColor; - - return $obj; - } - - /** - * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. - */ - public function withBgImageURL(string $bgImageURL): self - { - $obj = clone $this; - $obj->bgImageURL = $bgImageURL; - - return $obj; - } - - /** - * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. - */ - public function withSemitransparency(bool $semitransparency): self - { - $obj = clone $this; - $obj->semitransparency = $semitransparency; - - return $obj; - } -} diff --git a/src/Core/ServiceContracts/Beta/V2/FilesContract.php b/src/Core/ServiceContracts/Beta/V2/FilesContract.php index ae026055..885eb107 100644 --- a/src/Core/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/Core/ServiceContracts/Beta/V2/FilesContract.php @@ -4,12 +4,12 @@ namespace ImageKit\Core\ServiceContracts\Beta\V2; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\RemoveBg; use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\RequestOptions; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index 00aca4d8..20413c45 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -4,6 +4,9 @@ namespace ImageKit\Core\ServiceContracts; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\Files\File; use ImageKit\Files\FileCopyResponse; use ImageKit\Files\FileMoveResponse; @@ -11,9 +14,6 @@ use ImageKit\Files\FileUpdateParams\Update\ChangePublicationStatus; use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; use ImageKit\Files\FileUpdateResponse; -use ImageKit\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Files\FileUploadParams\Extension\RemoveBg; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; use ImageKit\Files\FileUploadResponse; diff --git a/src/Core/Services/Beta/V2/FilesService.php b/src/Core/Services/Beta/V2/FilesService.php index 305ac939..06ba4a58 100644 --- a/src/Core/Services/Beta/V2/FilesService.php +++ b/src/Core/Services/Beta/V2/FilesService.php @@ -5,14 +5,14 @@ namespace ImageKit\Core\Services\Beta\V2; use ImageKit\Beta\V2\Files\FileUploadParams; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Beta\V2\Files\FileUploadParams\Extension\RemoveBg; use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; use ImageKit\Client; use ImageKit\Core\ServiceContracts\Beta\V2\FilesContract; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\RequestOptions; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index c6010e84..2bdde777 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -9,6 +9,9 @@ use ImageKit\Core\Services\Files\BulkService; use ImageKit\Core\Services\Files\MetadataService; use ImageKit\Core\Services\Files\VersionsService; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\Files\File; use ImageKit\Files\FileCopyParams; use ImageKit\Files\FileCopyResponse; @@ -21,9 +24,6 @@ use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams; -use ImageKit\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Files\FileUploadParams\Extension\RemoveBg; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; use ImageKit\Files\FileUploadResponse; diff --git a/src/Files/FileUploadParams/Extension.php b/src/ExtensionItem.php similarity index 69% rename from src/Files/FileUploadParams/Extension.php rename to src/ExtensionItem.php index ace12834..3583b8d4 100644 --- a/src/Files/FileUploadParams/Extension.php +++ b/src/ExtensionItem.php @@ -2,16 +2,16 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams; +namespace ImageKit; use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; -use ImageKit\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Files\FileUploadParams\Extension\RemoveBg; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; -final class Extension implements ConverterSource +final class ExtensionItem implements ConverterSource { use SdkUnion; diff --git a/src/Files/FileUploadParams/Extension/AIAutoDescription.php b/src/ExtensionItem/AIAutoDescription.php similarity index 93% rename from src/Files/FileUploadParams/Extension/AIAutoDescription.php rename to src/ExtensionItem/AIAutoDescription.php index 4affc0d4..3cd6fa98 100644 --- a/src/Files/FileUploadParams/Extension/AIAutoDescription.php +++ b/src/ExtensionItem/AIAutoDescription.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams\Extension; +namespace ImageKit\ExtensionItem; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; diff --git a/src/Files/FileUploadParams/Extension/AutoTaggingExtension.php b/src/ExtensionItem/AutoTaggingExtension.php similarity index 95% rename from src/Files/FileUploadParams/Extension/AutoTaggingExtension.php rename to src/ExtensionItem/AutoTaggingExtension.php index f1042d04..262f220b 100644 --- a/src/Files/FileUploadParams/Extension/AutoTaggingExtension.php +++ b/src/ExtensionItem/AutoTaggingExtension.php @@ -2,12 +2,12 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams\Extension; +namespace ImageKit\ExtensionItem; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension\Name; +use ImageKit\ExtensionItem\AutoTaggingExtension\Name; /** * @phpstan-type auto_tagging_extension = array{ diff --git a/src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php b/src/ExtensionItem/AutoTaggingExtension/Name.php similarity index 83% rename from src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php rename to src/ExtensionItem/AutoTaggingExtension/Name.php index 3e4be1ce..7289da91 100644 --- a/src/Files/FileUploadParams/Extension/AutoTaggingExtension/Name.php +++ b/src/ExtensionItem/AutoTaggingExtension/Name.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension; +namespace ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\Core\Concerns\SdkEnum; use ImageKit\Core\Conversion\Contracts\ConverterSource; diff --git a/src/Files/FileUploadParams/Extension/RemoveBg.php b/src/ExtensionItem/RemoveBg.php similarity index 90% rename from src/Files/FileUploadParams/Extension/RemoveBg.php rename to src/ExtensionItem/RemoveBg.php index b87e7fa4..fee287d2 100644 --- a/src/Files/FileUploadParams/Extension/RemoveBg.php +++ b/src/ExtensionItem/RemoveBg.php @@ -2,12 +2,12 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams\Extension; +namespace ImageKit\ExtensionItem; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Files\FileUploadParams\Extension\RemoveBg\Options; +use ImageKit\ExtensionItem\RemoveBg\Options; /** * @phpstan-type remove_bg = array{name: string, options?: Options|null} diff --git a/src/Files/FileUploadParams/Extension/RemoveBg/Options.php b/src/ExtensionItem/RemoveBg/Options.php similarity index 98% rename from src/Files/FileUploadParams/Extension/RemoveBg/Options.php rename to src/ExtensionItem/RemoveBg/Options.php index dd170491..093cf8a6 100644 --- a/src/Files/FileUploadParams/Extension/RemoveBg/Options.php +++ b/src/ExtensionItem/RemoveBg/Options.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUploadParams\Extension\RemoveBg; +namespace ImageKit\ExtensionItem\RemoveBg; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails.php index 47747047..0372ca7b 100644 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails.php +++ b/src/Files/FileUpdateParams/Update/UpdateFileDetails.php @@ -7,10 +7,10 @@ use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails\Extension; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails\Extension\AIAutoDescription; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails\Extension\AutoTaggingExtension; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails\Extension\RemoveBg; +use ImageKit\ExtensionItem; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails\RemoveAITags; /** @@ -54,7 +54,7 @@ final class UpdateFileDetails implements BaseModel * * @var list|null $extensions */ - #[Api(list: Extension::class, optional: true)] + #[Api(list: ExtensionItem::class, optional: true)] public ?array $extensions; /** diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php deleted file mode 100644 index 106a7ee7..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension.php +++ /dev/null @@ -1,35 +0,0 @@ -|array - */ - public static function variants(): array - { - return [ - AutoTaggingExtension::class, - 'remove-bg' => RemoveBg::class, - 'ai-auto-description' => AIAutoDescription::class, - ]; - } -} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php deleted file mode 100644 index 61040877..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AIAutoDescription.php +++ /dev/null @@ -1,39 +0,0 @@ - */ - use SdkModel; - - /** - * Specifies the auto description extension. - */ - #[Api] - public string $name = 'ai-auto-description'; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(): self - { - return new self; - } -} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php deleted file mode 100644 index 95159c43..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension.php +++ /dev/null @@ -1,119 +0,0 @@ - */ - use SdkModel; - - /** - * Maximum number of tags to attach to the asset. - */ - #[Api] - public int $maxTags; - - /** - * Minimum confidence level for tags to be considered valid. - */ - #[Api] - public int $minConfidence; - - /** - * Specifies the auto-tagging extension used. - * - * @var Name::* $name - */ - #[Api(enum: Name::class)] - public string $name; - - /** - * `new AutoTaggingExtension()` is missing required properties by the API. - * - * To enforce required parameters use - * ``` - * AutoTaggingExtension::with(maxTags: ..., minConfidence: ..., name: ...) - * ``` - * - * Otherwise ensure the following setters are called - * - * ``` - * (new AutoTaggingExtension) - * ->withMaxTags(...) - * ->withMinConfidence(...) - * ->withName(...) - * ``` - */ - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - * - * @param Name::* $name - */ - public static function with( - int $maxTags, - int $minConfidence, - string $name - ): self { - $obj = new self; - - $obj->maxTags = $maxTags; - $obj->minConfidence = $minConfidence; - $obj->name = $name; - - return $obj; - } - - /** - * Maximum number of tags to attach to the asset. - */ - public function withMaxTags(int $maxTags): self - { - $obj = clone $this; - $obj->maxTags = $maxTags; - - return $obj; - } - - /** - * Minimum confidence level for tags to be considered valid. - */ - public function withMinConfidence(int $minConfidence): self - { - $obj = clone $this; - $obj->minConfidence = $minConfidence; - - return $obj; - } - - /** - * Specifies the auto-tagging extension used. - * - * @param Name::* $name - */ - public function withName(string $name): self - { - $obj = clone $this; - $obj->name = $name; - - return $obj; - } -} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php deleted file mode 100644 index 1b209a58..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/AutoTaggingExtension/Name.php +++ /dev/null @@ -1,20 +0,0 @@ - */ - use SdkModel; - - /** - * Specifies the background removal extension. - */ - #[Api] - public string $name = 'remove-bg'; - - #[Api(optional: true)] - public ?Options $options; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(?Options $options = null): self - { - $obj = new self; - - null !== $options && $obj->options = $options; - - return $obj; - } - - public function withOptions(Options $options): self - { - $obj = clone $this; - $obj->options = $options; - - return $obj; - } -} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php deleted file mode 100644 index d6122438..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/Extension/RemoveBg/Options.php +++ /dev/null @@ -1,117 +0,0 @@ - */ - use SdkModel; - - /** - * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. - */ - #[Api('add_shadow', optional: true)] - public ?bool $addShadow; - - /** - * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. - */ - #[Api('bg_color', optional: true)] - public ?string $bgColor; - - /** - * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. - */ - #[Api('bg_image_url', optional: true)] - public ?string $bgImageURL; - - /** - * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. - */ - #[Api(optional: true)] - public ?bool $semitransparency; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with( - ?bool $addShadow = null, - ?string $bgColor = null, - ?string $bgImageURL = null, - ?bool $semitransparency = null, - ): self { - $obj = new self; - - null !== $addShadow && $obj->addShadow = $addShadow; - null !== $bgColor && $obj->bgColor = $bgColor; - null !== $bgImageURL && $obj->bgImageURL = $bgImageURL; - null !== $semitransparency && $obj->semitransparency = $semitransparency; - - return $obj; - } - - /** - * Whether to add an artificial shadow to the result. Default is false. Note: Adding shadows is currently only supported for car photos. - */ - public function withAddShadow(bool $addShadow): self - { - $obj = clone $this; - $obj->addShadow = $addShadow; - - return $obj; - } - - /** - * Specifies a solid color background using hex code (e.g., "81d4fa", "fff") or color name (e.g., "green"). If this parameter is set, `bg_image_url` must be empty. - */ - public function withBgColor(string $bgColor): self - { - $obj = clone $this; - $obj->bgColor = $bgColor; - - return $obj; - } - - /** - * Sets a background image from a URL. If this parameter is set, `bg_color` must be empty. - */ - public function withBgImageURL(string $bgImageURL): self - { - $obj = clone $this; - $obj->bgImageURL = $bgImageURL; - - return $obj; - } - - /** - * Allows semi-transparent regions in the result. Default is true. Note: Semitransparency is currently only supported for car windows. - */ - public function withSemitransparency(bool $semitransparency): self - { - $obj = clone $this; - $obj->semitransparency = $semitransparency; - - return $obj; - } -} diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index 26c31c0c..ddbf55fe 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -8,10 +8,10 @@ use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Concerns\SdkParams; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Files\FileUploadParams\Extension; -use ImageKit\Files\FileUploadParams\Extension\AIAutoDescription; -use ImageKit\Files\FileUploadParams\Extension\AutoTaggingExtension; -use ImageKit\Files\FileUploadParams\Extension\RemoveBg; +use ImageKit\ExtensionItem; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; @@ -150,7 +150,7 @@ final class FileUploadParams implements BaseModel * * @var list|null $extensions */ - #[Api(list: Extension::class, optional: true)] + #[Api(list: ExtensionItem::class, optional: true)] public ?array $extensions; /** From 46dbc22461339a6be4f275f57b4f74a6fc2e4625 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 06:47:22 +0000 Subject: [PATCH 19/40] feat(api): manual updates --- .stats.yml | 2 +- src/Accounts/Origins/OriginCreateParams.php | 408 +++++++++++++++++- src/Accounts/Origins/OriginUpdateParams.php | 408 +++++++++++++++++- .../Accounts/OriginsContract.php | 126 ++++-- src/Core/ServiceContracts/FilesContract.php | 28 +- src/Core/Services/Accounts/OriginsService.php | 182 ++++++-- src/Core/Services/FilesService.php | 43 +- src/Files/FileUpdateParams.php | 198 ++++++++- .../ChangePublicationStatus => }/Publish.php | 2 +- .../UpdateFileDetails => }/RemoveAITags.php | 2 +- src/Files/FileUpdateParams/Update.php | 25 -- .../Update/ChangePublicationStatus.php | 55 --- .../Update/UpdateFileDetails.php | 211 --------- tests/Services/Accounts/OriginsTest.php | 95 ++-- 14 files changed, 1339 insertions(+), 446 deletions(-) rename src/Files/FileUpdateParams/{Update/ChangePublicationStatus => }/Publish.php (96%) rename src/Files/FileUpdateParams/{Update/UpdateFileDetails => }/RemoveAITags.php (92%) delete mode 100644 src/Files/FileUpdateParams/Update.php delete mode 100644 src/Files/FileUpdateParams/Update/ChangePublicationStatus.php delete mode 100644 src/Files/FileUpdateParams/Update/UpdateFileDetails.php diff --git a/.stats.yml b/.stats.yml index 2dc65d21..335e38ec 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0470196862abd722b09f1af798d6f2bcbdeba0f82d1162f57c287b1a43233531.yml openapi_spec_hash: 043dd7c67d741d0034b86f2fc0bce072 -config_hash: da949a1217f48ac01676eab81ca9d1b1 +config_hash: a652d68098d82eaf611a49507fb4b831 diff --git a/src/Accounts/Origins/OriginCreateParams.php b/src/Accounts/Origins/OriginCreateParams.php index 9cd5822a..ea0572c7 100644 --- a/src/Accounts/Origins/OriginCreateParams.php +++ b/src/Accounts/Origins/OriginCreateParams.php @@ -4,14 +4,6 @@ namespace ImageKit\Accounts\Origins; -use ImageKit\Accounts\Origins\OriginRequest\AkeneoPim; -use ImageKit\Accounts\Origins\OriginRequest\AzureBlob; -use ImageKit\Accounts\Origins\OriginRequest\CloudinaryBackup; -use ImageKit\Accounts\Origins\OriginRequest\Gcs; -use ImageKit\Accounts\Origins\OriginRequest\S3; -use ImageKit\Accounts\Origins\OriginRequest\S3Compatible; -use ImageKit\Accounts\Origins\OriginRequest\WebFolder; -use ImageKit\Accounts\Origins\OriginRequest\WebProxy; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Concerns\SdkParams; @@ -35,7 +27,27 @@ * @see ImageKit\Accounts\Origins->create * * @phpstan-type origin_create_params = array{ - * origin: S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim, + * accessKey: string, + * bucket: string, + * name: string, + * secretKey: string, + * type: string, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, + * endpoint: string, + * s3ForcePathStyle?: bool, + * baseURL: string, + * forwardHostHeaderToOrigin?: bool, + * clientEmail: string, + * privateKey: string, + * accountName: string, + * container: string, + * sasToken: string, + * clientID: string, + * clientSecret: string, + * password: string, + * username: string, * } */ final class OriginCreateParams implements BaseModel @@ -44,24 +56,151 @@ final class OriginCreateParams implements BaseModel use SdkModel; use SdkParams; + #[Api] + public string $type = 'AKENEO_PIM'; + + /** + * Access key for the bucket. + */ + #[Api] + public string $accessKey; + + #[Api] + public string $bucket; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Secret key for the bucket. + */ + #[Api] + public string $secretKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + #[Api(optional: true)] + public ?string $prefix; + + /** + * Custom S3-compatible endpoint. + */ + #[Api] + public string $endpoint; + + /** + * Use path-style S3 URLs? + */ + #[Api(optional: true)] + public ?bool $s3ForcePathStyle; + + /** + * Akeneo instance base URL. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Forward the Host header to origin? + */ + #[Api(optional: true)] + public ?bool $forwardHostHeaderToOrigin; + + #[Api] + public string $clientEmail; + + #[Api] + public string $privateKey; + + #[Api] + public string $accountName; + + #[Api] + public string $container; + + #[Api] + public string $sasToken; + /** - * Schema for origin request resources. + * Akeneo API client ID. */ - #[Api(union: OriginRequest::class)] - public S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin; + #[Api('clientId')] + public string $clientID; + + /** + * Akeneo API client secret. + */ + #[Api] + public string $clientSecret; + + /** + * Akeneo API password. + */ + #[Api] + public string $password; + + /** + * Akeneo API username. + */ + #[Api] + public string $username; /** * `new OriginCreateParams()` is missing required properties by the API. * * To enforce required parameters use * ``` - * OriginCreateParams::with(origin: ...) + * OriginCreateParams::with( + * accessKey: ..., + * bucket: ..., + * name: ..., + * secretKey: ..., + * endpoint: ..., + * baseURL: ..., + * clientEmail: ..., + * privateKey: ..., + * accountName: ..., + * container: ..., + * sasToken: ..., + * clientID: ..., + * clientSecret: ..., + * password: ..., + * username: ..., + * ) * ``` * * Otherwise ensure the following setters are called * * ``` - * (new OriginCreateParams)->withOrigin(...) + * (new OriginCreateParams) + * ->withAccessKey(...) + * ->withBucket(...) + * ->withName(...) + * ->withSecretKey(...) + * ->withEndpoint(...) + * ->withBaseURL(...) + * ->withClientEmail(...) + * ->withPrivateKey(...) + * ->withAccountName(...) + * ->withContainer(...) + * ->withSasToken(...) + * ->withClientID(...) + * ->withClientSecret(...) + * ->withPassword(...) + * ->withUsername(...) * ``` */ public function __construct() @@ -75,23 +214,252 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + string $accessKey, + string $bucket, + string $name, + string $secretKey, + string $endpoint, + string $baseURL, + string $clientEmail, + string $privateKey, + string $accountName, + string $container, + string $sasToken, + string $clientID, + string $clientSecret, + string $password, + string $username, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ?bool $s3ForcePathStyle = null, + ?bool $forwardHostHeaderToOrigin = null, ): self { $obj = new self; - $obj->origin = $origin; + $obj->accessKey = $accessKey; + $obj->bucket = $bucket; + $obj->name = $name; + $obj->secretKey = $secretKey; + $obj->endpoint = $endpoint; + $obj->baseURL = $baseURL; + $obj->clientEmail = $clientEmail; + $obj->privateKey = $privateKey; + $obj->accountName = $accountName; + $obj->container = $container; + $obj->sasToken = $sasToken; + $obj->clientID = $clientID; + $obj->clientSecret = $clientSecret; + $obj->password = $password; + $obj->username = $username; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + null !== $s3ForcePathStyle && $obj->s3ForcePathStyle = $s3ForcePathStyle; + null !== $forwardHostHeaderToOrigin && $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + /** + * Access key for the bucket. + */ + public function withAccessKey(string $accessKey): self + { + $obj = clone $this; + $obj->accessKey = $accessKey; + + return $obj; + } + + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Secret key for the bucket. + */ + public function withSecretKey(string $secretKey): self + { + $obj = clone $this; + $obj->secretKey = $secretKey; return $obj; } /** - * Schema for origin request resources. + * URL used in the Canonical header (if enabled). */ - public function withOrigin( - S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader ): self { $obj = clone $this; - $obj->origin = $origin; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * Custom S3-compatible endpoint. + */ + public function withEndpoint(string $endpoint): self + { + $obj = clone $this; + $obj->endpoint = $endpoint; + + return $obj; + } + + /** + * Use path-style S3 URLs? + */ + public function withS3ForcePathStyle(bool $s3ForcePathStyle): self + { + $obj = clone $this; + $obj->s3ForcePathStyle = $s3ForcePathStyle; + + return $obj; + } + + /** + * Akeneo instance base URL. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Forward the Host header to origin? + */ + public function withForwardHostHeaderToOrigin( + bool $forwardHostHeaderToOrigin + ): self { + $obj = clone $this; + $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + public function withClientEmail(string $clientEmail): self + { + $obj = clone $this; + $obj->clientEmail = $clientEmail; + + return $obj; + } + + public function withPrivateKey(string $privateKey): self + { + $obj = clone $this; + $obj->privateKey = $privateKey; + + return $obj; + } + + public function withAccountName(string $accountName): self + { + $obj = clone $this; + $obj->accountName = $accountName; + + return $obj; + } + + public function withContainer(string $container): self + { + $obj = clone $this; + $obj->container = $container; + + return $obj; + } + + public function withSasToken(string $sasToken): self + { + $obj = clone $this; + $obj->sasToken = $sasToken; + + return $obj; + } + + /** + * Akeneo API client ID. + */ + public function withClientID(string $clientID): self + { + $obj = clone $this; + $obj->clientID = $clientID; + + return $obj; + } + + /** + * Akeneo API client secret. + */ + public function withClientSecret(string $clientSecret): self + { + $obj = clone $this; + $obj->clientSecret = $clientSecret; + + return $obj; + } + + /** + * Akeneo API password. + */ + public function withPassword(string $password): self + { + $obj = clone $this; + $obj->password = $password; + + return $obj; + } + + /** + * Akeneo API username. + */ + public function withUsername(string $username): self + { + $obj = clone $this; + $obj->username = $username; return $obj; } diff --git a/src/Accounts/Origins/OriginUpdateParams.php b/src/Accounts/Origins/OriginUpdateParams.php index e42e6c03..2ce8e6c0 100644 --- a/src/Accounts/Origins/OriginUpdateParams.php +++ b/src/Accounts/Origins/OriginUpdateParams.php @@ -4,14 +4,6 @@ namespace ImageKit\Accounts\Origins; -use ImageKit\Accounts\Origins\OriginRequest\AkeneoPim; -use ImageKit\Accounts\Origins\OriginRequest\AzureBlob; -use ImageKit\Accounts\Origins\OriginRequest\CloudinaryBackup; -use ImageKit\Accounts\Origins\OriginRequest\Gcs; -use ImageKit\Accounts\Origins\OriginRequest\S3; -use ImageKit\Accounts\Origins\OriginRequest\S3Compatible; -use ImageKit\Accounts\Origins\OriginRequest\WebFolder; -use ImageKit\Accounts\Origins\OriginRequest\WebProxy; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Concerns\SdkParams; @@ -35,7 +27,27 @@ * @see ImageKit\Accounts\Origins->update * * @phpstan-type origin_update_params = array{ - * origin: S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim, + * accessKey: string, + * bucket: string, + * name: string, + * secretKey: string, + * type: string, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, + * endpoint: string, + * s3ForcePathStyle?: bool, + * baseURL: string, + * forwardHostHeaderToOrigin?: bool, + * clientEmail: string, + * privateKey: string, + * accountName: string, + * container: string, + * sasToken: string, + * clientID: string, + * clientSecret: string, + * password: string, + * username: string, * } */ final class OriginUpdateParams implements BaseModel @@ -44,24 +56,151 @@ final class OriginUpdateParams implements BaseModel use SdkModel; use SdkParams; + #[Api] + public string $type = 'AKENEO_PIM'; + + /** + * Access key for the bucket. + */ + #[Api] + public string $accessKey; + + #[Api] + public string $bucket; + + /** + * Display name of the origin. + */ + #[Api] + public string $name; + + /** + * Secret key for the bucket. + */ + #[Api] + public string $secretKey; + + /** + * URL used in the Canonical header (if enabled). + */ + #[Api('baseUrlForCanonicalHeader', optional: true)] + public ?string $baseURLForCanonicalHeader; + + /** + * Whether to send a Canonical header. + */ + #[Api(optional: true)] + public ?bool $includeCanonicalHeader; + + #[Api(optional: true)] + public ?string $prefix; + + /** + * Custom S3-compatible endpoint. + */ + #[Api] + public string $endpoint; + + /** + * Use path-style S3 URLs? + */ + #[Api(optional: true)] + public ?bool $s3ForcePathStyle; + + /** + * Akeneo instance base URL. + */ + #[Api('baseUrl')] + public string $baseURL; + + /** + * Forward the Host header to origin? + */ + #[Api(optional: true)] + public ?bool $forwardHostHeaderToOrigin; + + #[Api] + public string $clientEmail; + + #[Api] + public string $privateKey; + + #[Api] + public string $accountName; + + #[Api] + public string $container; + + #[Api] + public string $sasToken; + /** - * Schema for origin request resources. + * Akeneo API client ID. */ - #[Api(union: OriginRequest::class)] - public S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin; + #[Api('clientId')] + public string $clientID; + + /** + * Akeneo API client secret. + */ + #[Api] + public string $clientSecret; + + /** + * Akeneo API password. + */ + #[Api] + public string $password; + + /** + * Akeneo API username. + */ + #[Api] + public string $username; /** * `new OriginUpdateParams()` is missing required properties by the API. * * To enforce required parameters use * ``` - * OriginUpdateParams::with(origin: ...) + * OriginUpdateParams::with( + * accessKey: ..., + * bucket: ..., + * name: ..., + * secretKey: ..., + * endpoint: ..., + * baseURL: ..., + * clientEmail: ..., + * privateKey: ..., + * accountName: ..., + * container: ..., + * sasToken: ..., + * clientID: ..., + * clientSecret: ..., + * password: ..., + * username: ..., + * ) * ``` * * Otherwise ensure the following setters are called * * ``` - * (new OriginUpdateParams)->withOrigin(...) + * (new OriginUpdateParams) + * ->withAccessKey(...) + * ->withBucket(...) + * ->withName(...) + * ->withSecretKey(...) + * ->withEndpoint(...) + * ->withBaseURL(...) + * ->withClientEmail(...) + * ->withPrivateKey(...) + * ->withAccountName(...) + * ->withContainer(...) + * ->withSasToken(...) + * ->withClientID(...) + * ->withClientSecret(...) + * ->withPassword(...) + * ->withUsername(...) * ``` */ public function __construct() @@ -75,23 +214,252 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( - S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + string $accessKey, + string $bucket, + string $name, + string $secretKey, + string $endpoint, + string $baseURL, + string $clientEmail, + string $privateKey, + string $accountName, + string $container, + string $sasToken, + string $clientID, + string $clientSecret, + string $password, + string $username, + ?string $baseURLForCanonicalHeader = null, + ?bool $includeCanonicalHeader = null, + ?string $prefix = null, + ?bool $s3ForcePathStyle = null, + ?bool $forwardHostHeaderToOrigin = null, ): self { $obj = new self; - $obj->origin = $origin; + $obj->accessKey = $accessKey; + $obj->bucket = $bucket; + $obj->name = $name; + $obj->secretKey = $secretKey; + $obj->endpoint = $endpoint; + $obj->baseURL = $baseURL; + $obj->clientEmail = $clientEmail; + $obj->privateKey = $privateKey; + $obj->accountName = $accountName; + $obj->container = $container; + $obj->sasToken = $sasToken; + $obj->clientID = $clientID; + $obj->clientSecret = $clientSecret; + $obj->password = $password; + $obj->username = $username; + + null !== $baseURLForCanonicalHeader && $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + null !== $includeCanonicalHeader && $obj->includeCanonicalHeader = $includeCanonicalHeader; + null !== $prefix && $obj->prefix = $prefix; + null !== $s3ForcePathStyle && $obj->s3ForcePathStyle = $s3ForcePathStyle; + null !== $forwardHostHeaderToOrigin && $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + /** + * Access key for the bucket. + */ + public function withAccessKey(string $accessKey): self + { + $obj = clone $this; + $obj->accessKey = $accessKey; + + return $obj; + } + + public function withBucket(string $bucket): self + { + $obj = clone $this; + $obj->bucket = $bucket; + + return $obj; + } + + /** + * Display name of the origin. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Secret key for the bucket. + */ + public function withSecretKey(string $secretKey): self + { + $obj = clone $this; + $obj->secretKey = $secretKey; return $obj; } /** - * Schema for origin request resources. + * URL used in the Canonical header (if enabled). */ - public function withOrigin( - S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin, + public function withBaseURLForCanonicalHeader( + string $baseURLForCanonicalHeader ): self { $obj = clone $this; - $obj->origin = $origin; + $obj->baseURLForCanonicalHeader = $baseURLForCanonicalHeader; + + return $obj; + } + + /** + * Whether to send a Canonical header. + */ + public function withIncludeCanonicalHeader( + bool $includeCanonicalHeader + ): self { + $obj = clone $this; + $obj->includeCanonicalHeader = $includeCanonicalHeader; + + return $obj; + } + + public function withPrefix(string $prefix): self + { + $obj = clone $this; + $obj->prefix = $prefix; + + return $obj; + } + + /** + * Custom S3-compatible endpoint. + */ + public function withEndpoint(string $endpoint): self + { + $obj = clone $this; + $obj->endpoint = $endpoint; + + return $obj; + } + + /** + * Use path-style S3 URLs? + */ + public function withS3ForcePathStyle(bool $s3ForcePathStyle): self + { + $obj = clone $this; + $obj->s3ForcePathStyle = $s3ForcePathStyle; + + return $obj; + } + + /** + * Akeneo instance base URL. + */ + public function withBaseURL(string $baseURL): self + { + $obj = clone $this; + $obj->baseURL = $baseURL; + + return $obj; + } + + /** + * Forward the Host header to origin? + */ + public function withForwardHostHeaderToOrigin( + bool $forwardHostHeaderToOrigin + ): self { + $obj = clone $this; + $obj->forwardHostHeaderToOrigin = $forwardHostHeaderToOrigin; + + return $obj; + } + + public function withClientEmail(string $clientEmail): self + { + $obj = clone $this; + $obj->clientEmail = $clientEmail; + + return $obj; + } + + public function withPrivateKey(string $privateKey): self + { + $obj = clone $this; + $obj->privateKey = $privateKey; + + return $obj; + } + + public function withAccountName(string $accountName): self + { + $obj = clone $this; + $obj->accountName = $accountName; + + return $obj; + } + + public function withContainer(string $container): self + { + $obj = clone $this; + $obj->container = $container; + + return $obj; + } + + public function withSasToken(string $sasToken): self + { + $obj = clone $this; + $obj->sasToken = $sasToken; + + return $obj; + } + + /** + * Akeneo API client ID. + */ + public function withClientID(string $clientID): self + { + $obj = clone $this; + $obj->clientID = $clientID; + + return $obj; + } + + /** + * Akeneo API client secret. + */ + public function withClientSecret(string $clientSecret): self + { + $obj = clone $this; + $obj->clientSecret = $clientSecret; + + return $obj; + } + + /** + * Akeneo API password. + */ + public function withPassword(string $password): self + { + $obj = clone $this; + $obj->password = $password; + + return $obj; + } + + /** + * Akeneo API username. + */ + public function withUsername(string $username): self + { + $obj = clone $this; + $obj->username = $username; return $obj; } diff --git a/src/Core/ServiceContracts/Accounts/OriginsContract.php b/src/Core/ServiceContracts/Accounts/OriginsContract.php index e8873d10..9a560ffd 100644 --- a/src/Core/ServiceContracts/Accounts/OriginsContract.php +++ b/src/Core/ServiceContracts/Accounts/OriginsContract.php @@ -4,51 +4,125 @@ namespace ImageKit\Core\ServiceContracts\Accounts; -use ImageKit\Accounts\Origins\OriginRequest\AkeneoPim; -use ImageKit\Accounts\Origins\OriginRequest\AzureBlob; -use ImageKit\Accounts\Origins\OriginRequest\CloudinaryBackup; -use ImageKit\Accounts\Origins\OriginRequest\Gcs; -use ImageKit\Accounts\Origins\OriginRequest\S3; -use ImageKit\Accounts\Origins\OriginRequest\S3Compatible; -use ImageKit\Accounts\Origins\OriginRequest\WebFolder; -use ImageKit\Accounts\Origins\OriginRequest\WebProxy; -use ImageKit\Accounts\Origins\OriginResponse\AkeneoPim as AkeneoPim1; -use ImageKit\Accounts\Origins\OriginResponse\AzureBlob as AzureBlob1; -use ImageKit\Accounts\Origins\OriginResponse\CloudinaryBackup as CloudinaryBackup1; -use ImageKit\Accounts\Origins\OriginResponse\Gcs as Gcs1; -use ImageKit\Accounts\Origins\OriginResponse\S3 as S31; -use ImageKit\Accounts\Origins\OriginResponse\S3Compatible as S3Compatible1; -use ImageKit\Accounts\Origins\OriginResponse\WebFolder as WebFolder1; -use ImageKit\Accounts\Origins\OriginResponse\WebProxy as WebProxy1; +use ImageKit\Accounts\Origins\OriginResponse\AkeneoPim; +use ImageKit\Accounts\Origins\OriginResponse\AzureBlob; +use ImageKit\Accounts\Origins\OriginResponse\CloudinaryBackup; +use ImageKit\Accounts\Origins\OriginResponse\Gcs; +use ImageKit\Accounts\Origins\OriginResponse\S3; +use ImageKit\Accounts\Origins\OriginResponse\S3Compatible; +use ImageKit\Accounts\Origins\OriginResponse\WebFolder; +use ImageKit\Accounts\Origins\OriginResponse\WebProxy; use ImageKit\RequestOptions; +use const ImageKit\Core\OMIT as omit; + interface OriginsContract { /** * @api * - * @param S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin schema for origin request resources + * @param string $accessKey access key for the bucket + * @param string $bucket + * @param string $name display name of the origin + * @param string $secretKey secret key for the bucket + * @param string $type + * @param string $baseURLForCanonicalHeader URL used in the Canonical header (if enabled) + * @param bool $includeCanonicalHeader whether to send a Canonical header + * @param string $prefix + * @param string $endpoint custom S3-compatible endpoint + * @param bool $s3ForcePathStyle Use path-style S3 URLs? + * @param string $baseURL akeneo instance base URL + * @param bool $forwardHostHeaderToOrigin Forward the Host header to origin? + * @param string $clientEmail + * @param string $privateKey + * @param string $accountName + * @param string $container + * @param string $sasToken + * @param string $clientID akeneo API client ID + * @param string $clientSecret akeneo API client secret + * @param string $password akeneo API password + * @param string $username akeneo API username */ public function create( - $origin, - ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1; + $accessKey, + $bucket, + $name, + $secretKey, + $type, + $baseURLForCanonicalHeader = omit, + $includeCanonicalHeader = omit, + $prefix = omit, + $endpoint, + $s3ForcePathStyle = omit, + $baseURL, + $forwardHostHeaderToOrigin = omit, + $clientEmail, + $privateKey, + $accountName, + $container, + $sasToken, + $clientID, + $clientSecret, + $password, + $username, + ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; /** * @api * - * @param S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin schema for origin request resources + * @param string $accessKey access key for the bucket + * @param string $bucket + * @param string $name display name of the origin + * @param string $secretKey secret key for the bucket + * @param string $type + * @param string $baseURLForCanonicalHeader URL used in the Canonical header (if enabled) + * @param bool $includeCanonicalHeader whether to send a Canonical header + * @param string $prefix + * @param string $endpoint custom S3-compatible endpoint + * @param bool $s3ForcePathStyle Use path-style S3 URLs? + * @param string $baseURL akeneo instance base URL + * @param bool $forwardHostHeaderToOrigin Forward the Host header to origin? + * @param string $clientEmail + * @param string $privateKey + * @param string $accountName + * @param string $container + * @param string $sasToken + * @param string $clientID akeneo API client ID + * @param string $clientSecret akeneo API client secret + * @param string $password akeneo API password + * @param string $username akeneo API username */ public function update( string $id, - $origin, - ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1; + $accessKey, + $bucket, + $name, + $secretKey, + $type, + $baseURLForCanonicalHeader = omit, + $includeCanonicalHeader = omit, + $prefix = omit, + $endpoint, + $s3ForcePathStyle = omit, + $baseURL, + $forwardHostHeaderToOrigin = omit, + $clientEmail, + $privateKey, + $accountName, + $container, + $sasToken, + $clientID, + $clientSecret, + $password, + $username, + ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; /** * @api * - * @return list + * @return list */ public function list( ?RequestOptions $requestOptions = null @@ -68,5 +142,5 @@ public function delete( public function get( string $id, ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1; + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; } diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/Core/ServiceContracts/FilesContract.php index 20413c45..c5f265c5 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/Core/ServiceContracts/FilesContract.php @@ -11,8 +11,7 @@ use ImageKit\Files\FileCopyResponse; use ImageKit\Files\FileMoveResponse; use ImageKit\Files\FileRenameResponse; -use ImageKit\Files\FileUpdateParams\Update\ChangePublicationStatus; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; +use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; @@ -26,12 +25,31 @@ interface FilesContract /** * @api * - * @param UpdateFileDetails|ChangePublicationStatus $update + * @param string|null $customCoordinates Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + * @param array $customMetadata A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * @param string $description optional text to describe the contents of the file + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * @param string|list $removeAITags An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * @param Publish $publish configure the publication status of a file and its versions */ public function update( string $fileID, - $update = omit, - ?RequestOptions $requestOptions = null + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $extensions = omit, + $removeAITags = omit, + $tags = omit, + $webhookURL = omit, + $publish = omit, + ?RequestOptions $requestOptions = null, ): FileUpdateResponse; /** diff --git a/src/Core/Services/Accounts/OriginsService.php b/src/Core/Services/Accounts/OriginsService.php index 05a2f31a..d52dda85 100644 --- a/src/Core/Services/Accounts/OriginsService.php +++ b/src/Core/Services/Accounts/OriginsService.php @@ -5,29 +5,23 @@ namespace ImageKit\Core\Services\Accounts; use ImageKit\Accounts\Origins\OriginCreateParams; -use ImageKit\Accounts\Origins\OriginRequest\AkeneoPim; -use ImageKit\Accounts\Origins\OriginRequest\AzureBlob; -use ImageKit\Accounts\Origins\OriginRequest\CloudinaryBackup; -use ImageKit\Accounts\Origins\OriginRequest\Gcs; -use ImageKit\Accounts\Origins\OriginRequest\S3; -use ImageKit\Accounts\Origins\OriginRequest\S3Compatible; -use ImageKit\Accounts\Origins\OriginRequest\WebFolder; -use ImageKit\Accounts\Origins\OriginRequest\WebProxy; use ImageKit\Accounts\Origins\OriginResponse; -use ImageKit\Accounts\Origins\OriginResponse\AkeneoPim as AkeneoPim1; -use ImageKit\Accounts\Origins\OriginResponse\AzureBlob as AzureBlob1; -use ImageKit\Accounts\Origins\OriginResponse\CloudinaryBackup as CloudinaryBackup1; -use ImageKit\Accounts\Origins\OriginResponse\Gcs as Gcs1; -use ImageKit\Accounts\Origins\OriginResponse\S3 as S31; -use ImageKit\Accounts\Origins\OriginResponse\S3Compatible as S3Compatible1; -use ImageKit\Accounts\Origins\OriginResponse\WebFolder as WebFolder1; -use ImageKit\Accounts\Origins\OriginResponse\WebProxy as WebProxy1; +use ImageKit\Accounts\Origins\OriginResponse\AkeneoPim; +use ImageKit\Accounts\Origins\OriginResponse\AzureBlob; +use ImageKit\Accounts\Origins\OriginResponse\CloudinaryBackup; +use ImageKit\Accounts\Origins\OriginResponse\Gcs; +use ImageKit\Accounts\Origins\OriginResponse\S3; +use ImageKit\Accounts\Origins\OriginResponse\S3Compatible; +use ImageKit\Accounts\Origins\OriginResponse\WebFolder; +use ImageKit\Accounts\Origins\OriginResponse\WebProxy; use ImageKit\Accounts\Origins\OriginUpdateParams; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; use ImageKit\Core\ServiceContracts\Accounts\OriginsContract; use ImageKit\RequestOptions; +use const ImageKit\Core\OMIT as omit; + final class OriginsService implements OriginsContract { /** @@ -41,22 +35,84 @@ public function __construct(private Client $client) {} * **Note:** This API is currently in beta. * Creates a new origin and returns the origin object. * - * @param S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin schema for origin request resources + * @param string $accessKey access key for the bucket + * @param string $bucket + * @param string $name display name of the origin + * @param string $secretKey secret key for the bucket + * @param string $type + * @param string $baseURLForCanonicalHeader URL used in the Canonical header (if enabled) + * @param bool $includeCanonicalHeader whether to send a Canonical header + * @param string $prefix + * @param string $endpoint custom S3-compatible endpoint + * @param bool $s3ForcePathStyle Use path-style S3 URLs? + * @param string $baseURL akeneo instance base URL + * @param bool $forwardHostHeaderToOrigin Forward the Host header to origin? + * @param string $clientEmail + * @param string $privateKey + * @param string $accountName + * @param string $container + * @param string $sasToken + * @param string $clientID akeneo API client ID + * @param string $clientSecret akeneo API client secret + * @param string $password akeneo API password + * @param string $username akeneo API username */ public function create( - $origin, - ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1 { + $accessKey, + $bucket, + $name, + $secretKey, + $type, + $baseURLForCanonicalHeader = omit, + $includeCanonicalHeader = omit, + $prefix = omit, + $endpoint, + $s3ForcePathStyle = omit, + $baseURL, + $forwardHostHeaderToOrigin = omit, + $clientEmail, + $privateKey, + $accountName, + $container, + $sasToken, + $clientID, + $clientSecret, + $password, + $username, + ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { [$parsed, $options] = OriginCreateParams::parseRequest( - ['origin' => $origin], - $requestOptions + [ + 'accessKey' => $accessKey, + 'bucket' => $bucket, + 'name' => $name, + 'secretKey' => $secretKey, + 'type' => $type, + 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, + 'includeCanonicalHeader' => $includeCanonicalHeader, + 'prefix' => $prefix, + 'endpoint' => $endpoint, + 's3ForcePathStyle' => $s3ForcePathStyle, + 'baseURL' => $baseURL, + 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, + 'clientEmail' => $clientEmail, + 'privateKey' => $privateKey, + 'accountName' => $accountName, + 'container' => $container, + 'sasToken' => $sasToken, + 'clientID' => $clientID, + 'clientSecret' => $clientSecret, + 'password' => $password, + 'username' => $username, + ], + $requestOptions, ); // @phpstan-ignore-next-line; return $this->client->request( method: 'post', path: 'v1/accounts/origins', - body: (object) $parsed['origin'], + body: (object) $parsed, options: $options, convert: OriginResponse::class, ); @@ -68,23 +124,85 @@ public function create( * **Note:** This API is currently in beta. * Updates the origin identified by `id` and returns the updated origin object. * - * @param S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim $origin schema for origin request resources + * @param string $accessKey access key for the bucket + * @param string $bucket + * @param string $name display name of the origin + * @param string $secretKey secret key for the bucket + * @param string $type + * @param string $baseURLForCanonicalHeader URL used in the Canonical header (if enabled) + * @param bool $includeCanonicalHeader whether to send a Canonical header + * @param string $prefix + * @param string $endpoint custom S3-compatible endpoint + * @param bool $s3ForcePathStyle Use path-style S3 URLs? + * @param string $baseURL akeneo instance base URL + * @param bool $forwardHostHeaderToOrigin Forward the Host header to origin? + * @param string $clientEmail + * @param string $privateKey + * @param string $accountName + * @param string $container + * @param string $sasToken + * @param string $clientID akeneo API client ID + * @param string $clientSecret akeneo API client secret + * @param string $password akeneo API password + * @param string $username akeneo API username */ public function update( string $id, - $origin, - ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1 { + $accessKey, + $bucket, + $name, + $secretKey, + $type, + $baseURLForCanonicalHeader = omit, + $includeCanonicalHeader = omit, + $prefix = omit, + $endpoint, + $s3ForcePathStyle = omit, + $baseURL, + $forwardHostHeaderToOrigin = omit, + $clientEmail, + $privateKey, + $accountName, + $container, + $sasToken, + $clientID, + $clientSecret, + $password, + $username, + ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { [$parsed, $options] = OriginUpdateParams::parseRequest( - ['origin' => $origin], - $requestOptions + [ + 'accessKey' => $accessKey, + 'bucket' => $bucket, + 'name' => $name, + 'secretKey' => $secretKey, + 'type' => $type, + 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, + 'includeCanonicalHeader' => $includeCanonicalHeader, + 'prefix' => $prefix, + 'endpoint' => $endpoint, + 's3ForcePathStyle' => $s3ForcePathStyle, + 'baseURL' => $baseURL, + 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, + 'clientEmail' => $clientEmail, + 'privateKey' => $privateKey, + 'accountName' => $accountName, + 'container' => $container, + 'sasToken' => $sasToken, + 'clientID' => $clientID, + 'clientSecret' => $clientSecret, + 'password' => $password, + 'username' => $username, + ], + $requestOptions, ); // @phpstan-ignore-next-line; return $this->client->request( method: 'put', path: ['v1/accounts/origins/%1$s', $id], - body: (object) $parsed['origin'], + body: (object) $parsed, options: $options, convert: OriginResponse::class, ); @@ -96,7 +214,7 @@ public function update( * **Note:** This API is currently in beta. * Returns an array of all configured origins for the current account. * - * @return list + * @return list */ public function list(?RequestOptions $requestOptions = null): array { @@ -137,7 +255,7 @@ public function delete( public function get( string $id, ?RequestOptions $requestOptions = null - ): S31|S3Compatible1|CloudinaryBackup1|WebFolder1|WebProxy1|Gcs1|AzureBlob1|AkeneoPim1 { + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { // @phpstan-ignore-next-line; return $this->client->request( method: 'get', diff --git a/src/Core/Services/FilesService.php b/src/Core/Services/FilesService.php index 2bdde777..c421314f 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Core/Services/FilesService.php @@ -20,8 +20,7 @@ use ImageKit\Files\FileRenameParams; use ImageKit\Files\FileRenameResponse; use ImageKit\Files\FileUpdateParams; -use ImageKit\Files\FileUpdateParams\Update\ChangePublicationStatus; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; +use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams; use ImageKit\Files\FileUploadParams\ResponseField; @@ -63,23 +62,51 @@ public function __construct(private Client $client) * * This API updates the details or attributes of the current version of the file. You can update `tags`, `customCoordinates`, `customMetadata`, publication status, remove existing `AITags` and apply extensions using this API. * - * @param UpdateFileDetails|ChangePublicationStatus $update + * @param string|null $customCoordinates Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + * @param array $customMetadata A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * @param string $description optional text to describe the contents of the file + * @param list $extensions Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * @param string|list $removeAITags An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * @param Publish $publish configure the publication status of a file and its versions */ public function update( string $fileID, - $update = omit, - ?RequestOptions $requestOptions = null + $customCoordinates = omit, + $customMetadata = omit, + $description = omit, + $extensions = omit, + $removeAITags = omit, + $tags = omit, + $webhookURL = omit, + $publish = omit, + ?RequestOptions $requestOptions = null, ): FileUpdateResponse { [$parsed, $options] = FileUpdateParams::parseRequest( - ['update' => $update], - $requestOptions + [ + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'extensions' => $extensions, + 'removeAITags' => $removeAITags, + 'tags' => $tags, + 'webhookURL' => $webhookURL, + 'publish' => $publish, + ], + $requestOptions, ); // @phpstan-ignore-next-line; return $this->client->request( method: 'patch', path: ['v1/files/%1$s/details', $fileID], - body: (object) $parsed['update'], + body: (object) $parsed, options: $options, convert: FileUpdateResponse::class, ); diff --git a/src/Files/FileUpdateParams.php b/src/Files/FileUpdateParams.php index 195b76da..0fb8c92e 100644 --- a/src/Files/FileUpdateParams.php +++ b/src/Files/FileUpdateParams.php @@ -8,8 +8,12 @@ use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Concerns\SdkParams; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Files\FileUpdateParams\Update\ChangePublicationStatus; -use ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; +use ImageKit\ExtensionItem; +use ImageKit\ExtensionItem\AIAutoDescription; +use ImageKit\ExtensionItem\AutoTaggingExtension; +use ImageKit\ExtensionItem\RemoveBg; +use ImageKit\Files\FileUpdateParams\Publish; +use ImageKit\Files\FileUpdateParams\RemoveAITags; /** * An object containing the method's parameters. @@ -28,7 +32,14 @@ * @see ImageKit\Files->update * * @phpstan-type file_update_params = array{ - * update?: UpdateFileDetails|ChangePublicationStatus + * customCoordinates?: string|null, + * customMetadata?: array, + * description?: string, + * extensions?: list, + * removeAITags?: string|list, + * tags?: list|null, + * webhookURL?: string, + * publish?: Publish, * } */ final class FileUpdateParams implements BaseModel @@ -37,8 +48,65 @@ final class FileUpdateParams implements BaseModel use SdkModel; use SdkParams; + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. + */ #[Api(optional: true)] - public UpdateFileDetails|ChangePublicationStatus|null $update; + public ?string $description; + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @var list|null $extensions + */ + #[Api(list: ExtensionItem::class, optional: true)] + public ?array $extensions; + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @var string|list|null $removeAITags + */ + #[Api(union: RemoveAITags::class, optional: true)] + public string|array|null $removeAITags; + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + #[Api('webhookUrl', optional: true)] + public ?string $webhookURL; + + /** + * Configure the publication status of a file and its versions. + */ + #[Api(optional: true)] + public ?Publish $publish; public function __construct() { @@ -49,22 +117,132 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param array $customMetadata + * @param list $extensions + * @param string|list $removeAITags + * @param list|null $tags */ public static function with( - UpdateFileDetails|ChangePublicationStatus|null $update = null + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?array $extensions = null, + string|array|null $removeAITags = null, + ?array $tags = null, + ?string $webhookURL = null, + ?Publish $publish = null, ): self { $obj = new self; - null !== $update && $obj->update = $update; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $extensions && $obj->extensions = $extensions; + null !== $removeAITags && $obj->removeAITags = $removeAITags; + null !== $tags && $obj->tags = $tags; + null !== $webhookURL && $obj->webhookURL = $webhookURL; + null !== $publish && $obj->publish = $publish; return $obj; } - public function withUpdate( - UpdateFileDetails|ChangePublicationStatus $update - ): self { + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @param list $extensions + */ + public function withExtensions(array $extensions): self + { + $obj = clone $this; + $obj->extensions = $extensions; + + return $obj; + } + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @param string|list $removeAITags + */ + public function withRemoveAITags(string|array $removeAITags): self + { + $obj = clone $this; + $obj->removeAITags = $removeAITags; + + return $obj; + } + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function withWebhookURL(string $webhookURL): self + { + $obj = clone $this; + $obj->webhookURL = $webhookURL; + + return $obj; + } + + /** + * Configure the publication status of a file and its versions. + */ + public function withPublish(Publish $publish): self + { $obj = clone $this; - $obj->update = $update; + $obj->publish = $publish; return $obj; } diff --git a/src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php b/src/Files/FileUpdateParams/Publish.php similarity index 96% rename from src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php rename to src/Files/FileUpdateParams/Publish.php index ffd75ef1..37535e9f 100644 --- a/src/Files/FileUpdateParams/Update/ChangePublicationStatus/Publish.php +++ b/src/Files/FileUpdateParams/Publish.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUpdateParams\Update\ChangePublicationStatus; +namespace ImageKit\Files\FileUpdateParams; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php b/src/Files/FileUpdateParams/RemoveAITags.php similarity index 92% rename from src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php rename to src/Files/FileUpdateParams/RemoveAITags.php index e30a5980..46ffd4ad 100644 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails/RemoveAITags.php +++ b/src/Files/FileUpdateParams/RemoveAITags.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\FileUpdateParams\Update\UpdateFileDetails; +namespace ImageKit\Files\FileUpdateParams; use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; diff --git a/src/Files/FileUpdateParams/Update.php b/src/Files/FileUpdateParams/Update.php deleted file mode 100644 index 452427d7..00000000 --- a/src/Files/FileUpdateParams/Update.php +++ /dev/null @@ -1,25 +0,0 @@ -|array - */ - public static function variants(): array - { - return [UpdateFileDetails::class, ChangePublicationStatus::class]; - } -} diff --git a/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php b/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php deleted file mode 100644 index 876df8c0..00000000 --- a/src/Files/FileUpdateParams/Update/ChangePublicationStatus.php +++ /dev/null @@ -1,55 +0,0 @@ - */ - use SdkModel; - - /** - * Configure the publication status of a file and its versions. - */ - #[Api(optional: true)] - public ?Publish $publish; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(?Publish $publish = null): self - { - $obj = new self; - - null !== $publish && $obj->publish = $publish; - - return $obj; - } - - /** - * Configure the publication status of a file and its versions. - */ - public function withPublish(Publish $publish): self - { - $obj = clone $this; - $obj->publish = $publish; - - return $obj; - } -} diff --git a/src/Files/FileUpdateParams/Update/UpdateFileDetails.php b/src/Files/FileUpdateParams/Update/UpdateFileDetails.php deleted file mode 100644 index 0372ca7b..00000000 --- a/src/Files/FileUpdateParams/Update/UpdateFileDetails.php +++ /dev/null @@ -1,211 +0,0 @@ -|null, - * description?: string|null, - * extensions?: list|null, - * removeAITags?: string|null|list, - * tags?: list|null, - * webhookURL?: string|null, - * } - */ -final class UpdateFileDetails implements BaseModel -{ - /** @use SdkModel */ - use SdkModel; - - /** - * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. - */ - #[Api(nullable: true, optional: true)] - public ?string $customCoordinates; - - /** - * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. - * - * @var array|null $customMetadata - */ - #[Api(map: 'mixed', optional: true)] - public ?array $customMetadata; - - /** - * Optional text to describe the contents of the file. - */ - #[Api(optional: true)] - public ?string $description; - - /** - * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. - * - * @var list|null $extensions - */ - #[Api(list: ExtensionItem::class, optional: true)] - public ?array $extensions; - - /** - * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. - * - * If you want to remove all AITags associated with the file, send a string - "all". - * - * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. - * - * @var string|list|null $removeAITags - */ - #[Api(union: RemoveAITags::class, optional: true)] - public string|array|null $removeAITags; - - /** - * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. - * - * @var list|null $tags - */ - #[Api(list: 'string', nullable: true, optional: true)] - public ?array $tags; - - /** - * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - */ - #[Api('webhookUrl', optional: true)] - public ?string $webhookURL; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - * - * @param array $customMetadata - * @param list $extensions - * @param string|list $removeAITags - * @param list|null $tags - */ - public static function with( - ?string $customCoordinates = null, - ?array $customMetadata = null, - ?string $description = null, - ?array $extensions = null, - string|array|null $removeAITags = null, - ?array $tags = null, - ?string $webhookURL = null, - ): self { - $obj = new self; - - null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; - null !== $customMetadata && $obj->customMetadata = $customMetadata; - null !== $description && $obj->description = $description; - null !== $extensions && $obj->extensions = $extensions; - null !== $removeAITags && $obj->removeAITags = $removeAITags; - null !== $tags && $obj->tags = $tags; - null !== $webhookURL && $obj->webhookURL = $webhookURL; - - return $obj; - } - - /** - * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. - */ - public function withCustomCoordinates(?string $customCoordinates): self - { - $obj = clone $this; - $obj->customCoordinates = $customCoordinates; - - return $obj; - } - - /** - * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. - * - * @param array $customMetadata - */ - public function withCustomMetadata(array $customMetadata): self - { - $obj = clone $this; - $obj->customMetadata = $customMetadata; - - return $obj; - } - - /** - * Optional text to describe the contents of the file. - */ - public function withDescription(string $description): self - { - $obj = clone $this; - $obj->description = $description; - - return $obj; - } - - /** - * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. - * - * @param list $extensions - */ - public function withExtensions(array $extensions): self - { - $obj = clone $this; - $obj->extensions = $extensions; - - return $obj; - } - - /** - * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. - * - * If you want to remove all AITags associated with the file, send a string - "all". - * - * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. - * - * @param string|list $removeAITags - */ - public function withRemoveAITags(string|array $removeAITags): self - { - $obj = clone $this; - $obj->removeAITags = $removeAITags; - - return $obj; - } - - /** - * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. - * - * @param list|null $tags - */ - public function withTags(?array $tags): self - { - $obj = clone $this; - $obj->tags = $tags; - - return $obj; - } - - /** - * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - */ - public function withWebhookURL(string $webhookURL): self - { - $obj = clone $this; - $obj->webhookURL = $webhookURL; - - return $obj; - } -} diff --git a/tests/Services/Accounts/OriginsTest.php b/tests/Services/Accounts/OriginsTest.php index eac91e2e..8dbcbec7 100644 --- a/tests/Services/Accounts/OriginsTest.php +++ b/tests/Services/Accounts/OriginsTest.php @@ -2,7 +2,6 @@ namespace Tests\Services\Accounts; -use ImageKit\Accounts\Origins\OriginRequest\S3; use ImageKit\Client; use PHPUnit\Framework\Attributes\CoversNothing; use PHPUnit\Framework\Attributes\Test; @@ -39,12 +38,22 @@ public function testCreate(): void } $result = $this->client->accounts->origins->create( - S3::with( - accessKey: 'AKIATEST123', - bucket: 'test-bucket', - name: 'My S3 Origin', - secretKey: 'secrettest123', - ), + accessKey: 'AKIAIOSFODNN7EXAMPLE', + bucket: 'gcs-media', + name: 'US S3 Storage', + secretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY', + type: 'AKENEO_PIM', + endpoint: 'https://s3.eu-central-1.wasabisys.com', + baseURL: 'https://akeneo.company.com', + clientEmail: 'service-account@project.iam.gserviceaccount.com', + privateKey: '-----BEGIN PRIVATE KEY-----\\nMIIEv...', + accountName: 'account123', + container: 'images', + sasToken: '?sv=2023-01-03&sr=c&sig=abc123', + clientID: 'akeneo-client-id', + clientSecret: 'akeneo-client-secret', + password: 'strongpassword123', + username: 'integration-user', ); $this->assertTrue(true); // @phpstan-ignore-line @@ -58,15 +67,22 @@ public function testCreateWithOptionalParams(): void } $result = $this->client->accounts->origins->create( - S3::with( - accessKey: 'AKIATEST123', - bucket: 'test-bucket', - name: 'My S3 Origin', - secretKey: 'secrettest123', - ) - ->withBaseURLForCanonicalHeader('https://cdn.example.com') - ->withIncludeCanonicalHeader(false) - ->withPrefix('images'), + accessKey: 'AKIAIOSFODNN7EXAMPLE', + bucket: 'gcs-media', + name: 'US S3 Storage', + secretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY', + type: 'AKENEO_PIM', + endpoint: 'https://s3.eu-central-1.wasabisys.com', + baseURL: 'https://akeneo.company.com', + clientEmail: 'service-account@project.iam.gserviceaccount.com', + privateKey: '-----BEGIN PRIVATE KEY-----\\nMIIEv...', + accountName: 'account123', + container: 'images', + sasToken: '?sv=2023-01-03&sr=c&sig=abc123', + clientID: 'akeneo-client-id', + clientSecret: 'akeneo-client-secret', + password: 'strongpassword123', + username: 'integration-user', ); $this->assertTrue(true); // @phpstan-ignore-line @@ -81,12 +97,22 @@ public function testUpdate(): void $result = $this->client->accounts->origins->update( 'id', - S3::with( - accessKey: 'AKIATEST123', - bucket: 'test-bucket', - name: 'My S3 Origin', - secretKey: 'secrettest123', - ), + accessKey: 'AKIAIOSFODNN7EXAMPLE', + bucket: 'gcs-media', + name: 'US S3 Storage', + secretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY', + type: 'AKENEO_PIM', + endpoint: 'https://s3.eu-central-1.wasabisys.com', + baseURL: 'https://akeneo.company.com', + clientEmail: 'service-account@project.iam.gserviceaccount.com', + privateKey: '-----BEGIN PRIVATE KEY-----\\nMIIEv...', + accountName: 'account123', + container: 'images', + sasToken: '?sv=2023-01-03&sr=c&sig=abc123', + clientID: 'akeneo-client-id', + clientSecret: 'akeneo-client-secret', + password: 'strongpassword123', + username: 'integration-user', ); $this->assertTrue(true); // @phpstan-ignore-line @@ -101,15 +127,22 @@ public function testUpdateWithOptionalParams(): void $result = $this->client->accounts->origins->update( 'id', - S3::with( - accessKey: 'AKIATEST123', - bucket: 'test-bucket', - name: 'My S3 Origin', - secretKey: 'secrettest123', - ) - ->withBaseURLForCanonicalHeader('https://cdn.example.com') - ->withIncludeCanonicalHeader(false) - ->withPrefix('images'), + accessKey: 'AKIAIOSFODNN7EXAMPLE', + bucket: 'gcs-media', + name: 'US S3 Storage', + secretKey: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY', + type: 'AKENEO_PIM', + endpoint: 'https://s3.eu-central-1.wasabisys.com', + baseURL: 'https://akeneo.company.com', + clientEmail: 'service-account@project.iam.gserviceaccount.com', + privateKey: '-----BEGIN PRIVATE KEY-----\\nMIIEv...', + accountName: 'account123', + container: 'images', + sasToken: '?sv=2023-01-03&sr=c&sig=abc123', + clientID: 'akeneo-client-id', + clientSecret: 'akeneo-client-secret', + password: 'strongpassword123', + username: 'integration-user', ); $this->assertTrue(true); // @phpstan-ignore-line From 4008775b50e0674f77e0c3ad3d8ba1577ebb806d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 07:05:33 +0000 Subject: [PATCH 20/40] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 335e38ec..e13d3275 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-0470196862abd722b09f1af798d6f2bcbdeba0f82d1162f57c287b1a43233531.yml -openapi_spec_hash: 043dd7c67d741d0034b86f2fc0bce072 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-afb67c3a2098b1a2dca37d0995d183fa6cf59dd144ed47bcdb924f14e3cc90a3.yml +openapi_spec_hash: 55a2f38df85126a87d1be0b27b9b8470 config_hash: a652d68098d82eaf611a49507fb4b831 From a635441aafc3f0cfa5e686073fa9d5e55b273536 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 07:11:21 +0000 Subject: [PATCH 21/40] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index e13d3275..bbfdcb43 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-afb67c3a2098b1a2dca37d0995d183fa6cf59dd144ed47bcdb924f14e3cc90a3.yml -openapi_spec_hash: 55a2f38df85126a87d1be0b27b9b8470 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-bc7c0d27962b30c19c778656988e154b54696819389289f34420a5e5fdfbd3b8.yml +openapi_spec_hash: 1bfde02a63416c036e9545927f727459 config_hash: a652d68098d82eaf611a49507fb4b831 From c3ea060ee47054167b8db064d3b423065fb106c1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 5 Sep 2025 02:40:16 +0000 Subject: [PATCH 22/40] fix: decorate with enum label for all enum classes --- src/Files/FileUpdateParams/RemoveAITags.php | 3 ++- src/SolidColorOverlayTransformation/Gradient.php | 3 ++- src/SolidColorOverlayTransformation/Radius.php | 3 ++- src/TextOverlayTransformation/Radius.php | 3 ++- src/Transformation/AIDropShadow.php | 3 ++- src/Transformation/Gradient.php | 3 ++- src/Transformation/Radius.php | 3 ++- src/Transformation/Shadow.php | 3 ++- src/Transformation/Sharpen.php | 3 ++- src/Transformation/Trim.php | 3 ++- src/Transformation/UnsharpMask.php | 3 ++- 11 files changed, 22 insertions(+), 11 deletions(-) diff --git a/src/Files/FileUpdateParams/RemoveAITags.php b/src/Files/FileUpdateParams/RemoveAITags.php index 46ffd4ad..6ded3696 100644 --- a/src/Files/FileUpdateParams/RemoveAITags.php +++ b/src/Files/FileUpdateParams/RemoveAITags.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; use ImageKit\Core\Conversion\ListOf; /** @@ -26,6 +27,6 @@ final class RemoveAITags implements ConverterSource */ public static function variants(): array { - return [new ListOf('string'), STAINLESS_FIXME_::class]; + return [new ListOf('string'), new EnumOf(['all'])]; } } diff --git a/src/SolidColorOverlayTransformation/Gradient.php b/src/SolidColorOverlayTransformation/Gradient.php index eb408f77..04bc6598 100644 --- a/src/SolidColorOverlayTransformation/Gradient.php +++ b/src/SolidColorOverlayTransformation/Gradient.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. @@ -22,6 +23,6 @@ final class Gradient implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'string']; + return [new EnumOf([true]), 'string']; } } diff --git a/src/SolidColorOverlayTransformation/Radius.php b/src/SolidColorOverlayTransformation/Radius.php index 273bf7ce..eeaf5961 100644 --- a/src/SolidColorOverlayTransformation/Radius.php +++ b/src/SolidColorOverlayTransformation/Radius.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Specifies the corner radius of the solid color overlay. Set to `max` for circular or oval shape. @@ -22,6 +23,6 @@ final class Radius implements ConverterSource */ public static function variants(): array { - return ['float', STAINLESS_FIXME_::class]; + return ['float', new EnumOf(['max'])]; } } diff --git a/src/TextOverlayTransformation/Radius.php b/src/TextOverlayTransformation/Radius.php index 51754284..798d59cd 100644 --- a/src/TextOverlayTransformation/Radius.php +++ b/src/TextOverlayTransformation/Radius.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Specifies the corner radius of the text overlay. @@ -22,6 +23,6 @@ final class Radius implements ConverterSource */ public static function variants(): array { - return ['float', STAINLESS_FIXME_::class]; + return ['float', new EnumOf(['max'])]; } } diff --git a/src/Transformation/AIDropShadow.php b/src/Transformation/AIDropShadow.php index 0956b9dc..cc58b5d5 100644 --- a/src/Transformation/AIDropShadow.php +++ b/src/Transformation/AIDropShadow.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Adds an AI-based drop shadow around a foreground object on a transparent or removed background. @@ -25,6 +26,6 @@ final class AIDropShadow implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'string']; + return [new EnumOf([true]), 'string']; } } diff --git a/src/Transformation/Gradient.php b/src/Transformation/Gradient.php index e3092355..62d7045a 100644 --- a/src/Transformation/Gradient.php +++ b/src/Transformation/Gradient.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Creates a linear gradient with two colors. Pass `true` for a default gradient, or provide a string for a custom gradient. @@ -22,6 +23,6 @@ final class Gradient implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'string']; + return [new EnumOf([true]), 'string']; } } diff --git a/src/Transformation/Radius.php b/src/Transformation/Radius.php index e0db8a3c..755730dc 100644 --- a/src/Transformation/Radius.php +++ b/src/Transformation/Radius.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Specifies the corner radius for rounded corners (e.g., 20) or `max` for circular or oval shape. @@ -22,6 +23,6 @@ final class Radius implements ConverterSource */ public static function variants(): array { - return ['float', STAINLESS_FIXME_::class]; + return ['float', new EnumOf(['max'])]; } } diff --git a/src/Transformation/Shadow.php b/src/Transformation/Shadow.php index be32ac24..b07eae0c 100644 --- a/src/Transformation/Shadow.php +++ b/src/Transformation/Shadow.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Adds a shadow beneath solid objects in an image with a transparent background. @@ -24,6 +25,6 @@ final class Shadow implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'string']; + return [new EnumOf([true]), 'string']; } } diff --git a/src/Transformation/Sharpen.php b/src/Transformation/Sharpen.php index 760f37d1..f1f9b359 100644 --- a/src/Transformation/Sharpen.php +++ b/src/Transformation/Sharpen.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Sharpens the input image, highlighting edges and finer details. @@ -23,6 +24,6 @@ final class Sharpen implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'float']; + return [new EnumOf([true]), 'float']; } } diff --git a/src/Transformation/Trim.php b/src/Transformation/Trim.php index 650352e3..c0ebce32 100644 --- a/src/Transformation/Trim.php +++ b/src/Transformation/Trim.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Useful for images with a solid or nearly solid background and a central object. This parameter trims the background, @@ -23,6 +24,6 @@ final class Trim implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'float']; + return [new EnumOf([true]), 'float']; } } diff --git a/src/Transformation/UnsharpMask.php b/src/Transformation/UnsharpMask.php index 5bd59aef..687edf59 100644 --- a/src/Transformation/UnsharpMask.php +++ b/src/Transformation/UnsharpMask.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; /** * Applies Unsharp Masking (USM), an image sharpening technique. @@ -23,6 +24,6 @@ final class UnsharpMask implements ConverterSource */ public static function variants(): array { - return [STAINLESS_FIXME_::class, 'string']; + return [new EnumOf([true]), 'string']; } } From 76b7d1a3bec0ff36b996eceb7af07a54f4a8439a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 5 Sep 2025 14:56:02 +0000 Subject: [PATCH 23/40] chore(internal): codegen related update --- src/Core/Util.php | 11 +++++----- tests/Services/Accounts/OriginsTest.php | 14 ++++++------- tests/Services/Accounts/URLEndpointsTest.php | 14 ++++++------- tests/Services/Accounts/UsageTest.php | 4 ++-- tests/Services/AssetsTest.php | 2 +- tests/Services/Beta/V2/FilesTest.php | 4 ++-- tests/Services/Cache/InvalidationTest.php | 6 +++--- tests/Services/CustomMetadataFieldsTest.php | 10 ++++----- tests/Services/Files/BulkTest.php | 16 +++++++------- tests/Services/Files/MetadataTest.php | 6 +++--- tests/Services/Files/VersionsTest.php | 14 ++++++------- tests/Services/FilesTest.php | 22 ++++++++++---------- tests/Services/Folders/JobTest.php | 2 +- tests/Services/FoldersTest.php | 20 +++++++++--------- 14 files changed, 73 insertions(+), 72 deletions(-) diff --git a/src/Core/Util.php b/src/Core/Util.php index 9c18b892..84dc703e 100644 --- a/src/Core/Util.php +++ b/src/Core/Util.php @@ -10,6 +10,11 @@ use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; +/** + * @phpstan-type SSEvent = array{ + * event?: string|null, data?: string|null, id?: string|null, retry?: int|null + * } + */ final class Util { public const BUF_SIZE = 8192; @@ -239,11 +244,7 @@ public static function decodeLines(\Iterator $stream): \Iterator /** * @param \Iterator $lines * - * @return \Generator< - * array{ - * event?: string|null, data?: string|null, id?: string|null, retry?: int|null - * }, - * > + * @return \Generator */ public static function decodeSSE(\Iterator $lines): \Generator { diff --git a/tests/Services/Accounts/OriginsTest.php b/tests/Services/Accounts/OriginsTest.php index 8dbcbec7..eb26a0f1 100644 --- a/tests/Services/Accounts/OriginsTest.php +++ b/tests/Services/Accounts/OriginsTest.php @@ -56,7 +56,7 @@ public function testCreate(): void username: 'integration-user', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -85,7 +85,7 @@ public function testCreateWithOptionalParams(): void username: 'integration-user', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -115,7 +115,7 @@ public function testUpdate(): void username: 'integration-user', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -145,7 +145,7 @@ public function testUpdateWithOptionalParams(): void username: 'integration-user', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -157,7 +157,7 @@ public function testList(): void $result = $this->client->accounts->origins->list(); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -169,7 +169,7 @@ public function testDelete(): void $result = $this->client->accounts->origins->delete('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -181,6 +181,6 @@ public function testGet(): void $result = $this->client->accounts->origins->get('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Accounts/URLEndpointsTest.php b/tests/Services/Accounts/URLEndpointsTest.php index 7c0bf515..e8d90155 100644 --- a/tests/Services/Accounts/URLEndpointsTest.php +++ b/tests/Services/Accounts/URLEndpointsTest.php @@ -41,7 +41,7 @@ public function testCreate(): void description: 'My custom URL endpoint' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -55,7 +55,7 @@ public function testCreateWithOptionalParams(): void description: 'My custom URL endpoint' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -70,7 +70,7 @@ public function testUpdate(): void description: 'My custom URL endpoint' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -85,7 +85,7 @@ public function testUpdateWithOptionalParams(): void description: 'My custom URL endpoint' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -97,7 +97,7 @@ public function testList(): void $result = $this->client->accounts->urlEndpoints->list(); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -109,7 +109,7 @@ public function testDelete(): void $result = $this->client->accounts->urlEndpoints->delete('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -121,6 +121,6 @@ public function testGet(): void $result = $this->client->accounts->urlEndpoints->get('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Accounts/UsageTest.php b/tests/Services/Accounts/UsageTest.php index 714169a6..9bbfac6e 100644 --- a/tests/Services/Accounts/UsageTest.php +++ b/tests/Services/Accounts/UsageTest.php @@ -42,7 +42,7 @@ public function testGet(): void startDate: new \DateTimeImmutable('2019-12-27'), ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -57,6 +57,6 @@ public function testGetWithOptionalParams(): void startDate: new \DateTimeImmutable('2019-12-27'), ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/AssetsTest.php b/tests/Services/AssetsTest.php index 0b3ed342..3aae8c19 100644 --- a/tests/Services/AssetsTest.php +++ b/tests/Services/AssetsTest.php @@ -39,6 +39,6 @@ public function testList(): void $result = $this->client->assets->list(); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Beta/V2/FilesTest.php b/tests/Services/Beta/V2/FilesTest.php index ced4540e..345801e4 100644 --- a/tests/Services/Beta/V2/FilesTest.php +++ b/tests/Services/Beta/V2/FilesTest.php @@ -42,7 +42,7 @@ public function testUpload(): void fileName: 'fileName' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -57,6 +57,6 @@ public function testUploadWithOptionalParams(): void fileName: 'fileName' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Cache/InvalidationTest.php b/tests/Services/Cache/InvalidationTest.php index 276c6107..1575824f 100644 --- a/tests/Services/Cache/InvalidationTest.php +++ b/tests/Services/Cache/InvalidationTest.php @@ -41,7 +41,7 @@ public function testCreate(): void 'https://ik.imagekit.io/your_imagekit_id/default-image.jpg' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -55,7 +55,7 @@ public function testCreateWithOptionalParams(): void 'https://ik.imagekit.io/your_imagekit_id/default-image.jpg' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -67,6 +67,6 @@ public function testGet(): void $result = $this->client->cache->invalidation->get('requestId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/CustomMetadataFieldsTest.php b/tests/Services/CustomMetadataFieldsTest.php index 92459823..bccfc446 100644 --- a/tests/Services/CustomMetadataFieldsTest.php +++ b/tests/Services/CustomMetadataFieldsTest.php @@ -44,7 +44,7 @@ public function testCreate(): void schema: Schema::with(type: 'Number') ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -67,7 +67,7 @@ public function testCreateWithOptionalParams(): void ->withSelectOptions(['small', 'medium', 'large', 30, 40, true]), ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -79,7 +79,7 @@ public function testUpdate(): void $result = $this->client->customMetadataFields->update('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -91,7 +91,7 @@ public function testList(): void $result = $this->client->customMetadataFields->list(); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -103,6 +103,6 @@ public function testDelete(): void $result = $this->client->customMetadataFields->delete('id'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Files/BulkTest.php b/tests/Services/Files/BulkTest.php index dc17a9c6..73a5d80a 100644 --- a/tests/Services/Files/BulkTest.php +++ b/tests/Services/Files/BulkTest.php @@ -41,7 +41,7 @@ public function testDelete(): void ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'] ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -55,7 +55,7 @@ public function testDeleteWithOptionalParams(): void ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'] ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -70,7 +70,7 @@ public function testAddTags(): void tags: ['t-shirt', 'round-neck', 'sale2019'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -85,7 +85,7 @@ public function testAddTagsWithOptionalParams(): void tags: ['t-shirt', 'round-neck', 'sale2019'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -100,7 +100,7 @@ public function testRemoveAITags(): void fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -115,7 +115,7 @@ public function testRemoveAITagsWithOptionalParams(): void fileIDs: ['598821f949c0a938d57563bd', '598821f949c0a938d57563be'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -130,7 +130,7 @@ public function testRemoveTags(): void tags: ['t-shirt', 'round-neck', 'sale2019'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -145,6 +145,6 @@ public function testRemoveTagsWithOptionalParams(): void tags: ['t-shirt', 'round-neck', 'sale2019'], ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Files/MetadataTest.php b/tests/Services/Files/MetadataTest.php index c0cd9366..1e8517ff 100644 --- a/tests/Services/Files/MetadataTest.php +++ b/tests/Services/Files/MetadataTest.php @@ -39,7 +39,7 @@ public function testGet(): void $result = $this->client->files->metadata->get('fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -51,7 +51,7 @@ public function testGetFromURL(): void $result = $this->client->files->metadata->getFromURL('https://example.com'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -63,6 +63,6 @@ public function testGetFromURLWithOptionalParams(): void $result = $this->client->files->metadata->getFromURL('https://example.com'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Files/VersionsTest.php b/tests/Services/Files/VersionsTest.php index c88bff80..c92db397 100644 --- a/tests/Services/Files/VersionsTest.php +++ b/tests/Services/Files/VersionsTest.php @@ -39,7 +39,7 @@ public function testList(): void $result = $this->client->files->versions->list('fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -51,7 +51,7 @@ public function testDelete(): void $result = $this->client->files->versions->delete('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -63,7 +63,7 @@ public function testDeleteWithOptionalParams(): void $result = $this->client->files->versions->delete('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -75,7 +75,7 @@ public function testGet(): void $result = $this->client->files->versions->get('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -87,7 +87,7 @@ public function testGetWithOptionalParams(): void $result = $this->client->files->versions->get('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -99,7 +99,7 @@ public function testRestore(): void $result = $this->client->files->versions->restore('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -111,6 +111,6 @@ public function testRestoreWithOptionalParams(): void $result = $this->client->files->versions->restore('versionId', 'fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 457d84a4..665d0714 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -39,7 +39,7 @@ public function testUpdate(): void $result = $this->client->files->update('fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -51,7 +51,7 @@ public function testDelete(): void $result = $this->client->files->delete('fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -66,7 +66,7 @@ public function testCopy(): void sourceFilePath: '/path/to/file.jpg', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -81,7 +81,7 @@ public function testCopyWithOptionalParams(): void sourceFilePath: '/path/to/file.jpg', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -93,7 +93,7 @@ public function testGet(): void $result = $this->client->files->get('fileId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -108,7 +108,7 @@ public function testMove(): void sourceFilePath: '/path/to/file.jpg', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -123,7 +123,7 @@ public function testMoveWithOptionalParams(): void sourceFilePath: '/path/to/file.jpg', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -138,7 +138,7 @@ public function testRename(): void newFileName: 'newFileName.jpg' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -153,7 +153,7 @@ public function testRenameWithOptionalParams(): void newFileName: 'newFileName.jpg' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -165,7 +165,7 @@ public function testUpload(): void $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -177,6 +177,6 @@ public function testUploadWithOptionalParams(): void $result = $this->client->files->upload(file: 'file', fileName: 'fileName'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/Folders/JobTest.php b/tests/Services/Folders/JobTest.php index e4e4b467..ce51df1f 100644 --- a/tests/Services/Folders/JobTest.php +++ b/tests/Services/Folders/JobTest.php @@ -39,6 +39,6 @@ public function testGet(): void $result = $this->client->folders->job->get('jobId'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } diff --git a/tests/Services/FoldersTest.php b/tests/Services/FoldersTest.php index ab2bc197..5aacd840 100644 --- a/tests/Services/FoldersTest.php +++ b/tests/Services/FoldersTest.php @@ -42,7 +42,7 @@ public function testCreate(): void parentFolderPath: '/product/images/' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -57,7 +57,7 @@ public function testCreateWithOptionalParams(): void parentFolderPath: '/product/images/' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -69,7 +69,7 @@ public function testDelete(): void $result = $this->client->folders->delete('/folder/to/delete/'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -81,7 +81,7 @@ public function testDeleteWithOptionalParams(): void $result = $this->client->folders->delete('/folder/to/delete/'); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -96,7 +96,7 @@ public function testCopy(): void sourceFolderPath: '/path/of/source/folder', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -111,7 +111,7 @@ public function testCopyWithOptionalParams(): void sourceFolderPath: '/path/of/source/folder', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -126,7 +126,7 @@ public function testMove(): void sourceFolderPath: '/path/of/source/folder', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -141,7 +141,7 @@ public function testMoveWithOptionalParams(): void sourceFolderPath: '/path/of/source/folder', ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -156,7 +156,7 @@ public function testRename(): void newFolderName: 'new-folder-name' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } #[Test] @@ -171,6 +171,6 @@ public function testRenameWithOptionalParams(): void newFolderName: 'new-folder-name' ); - $this->assertTrue(true); // @phpstan-ignore-line + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } } From 8628e12e2bdb99f3755bb1ea960547876fcccf00 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 5 Sep 2025 20:07:56 +0000 Subject: [PATCH 24/40] feat(api): extract UpdateFileDetailsRequest to model --- .stats.yml | 2 +- src/Files/UpdateFileDetailsRequest.php | 25 +++ .../ChangePublicationStatus.php | 55 +++++ .../ChangePublicationStatus/Publish.php | 93 ++++++++ .../UpdateFileDetails.php | 211 ++++++++++++++++++ .../UpdateFileDetails/RemoveAITags.php | 32 +++ 6 files changed, 417 insertions(+), 1 deletion(-) create mode 100644 src/Files/UpdateFileDetailsRequest.php create mode 100644 src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php create mode 100644 src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php create mode 100644 src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php create mode 100644 src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php diff --git a/.stats.yml b/.stats.yml index bbfdcb43..b0086e96 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-bc7c0d27962b30c19c778656988e154b54696819389289f34420a5e5fdfbd3b8.yml openapi_spec_hash: 1bfde02a63416c036e9545927f727459 -config_hash: a652d68098d82eaf611a49507fb4b831 +config_hash: b415c06a3b29485af4601beb94ae1aeb diff --git a/src/Files/UpdateFileDetailsRequest.php b/src/Files/UpdateFileDetailsRequest.php new file mode 100644 index 00000000..ee60beb4 --- /dev/null +++ b/src/Files/UpdateFileDetailsRequest.php @@ -0,0 +1,25 @@ +|array + */ + public static function variants(): array + { + return [UpdateFileDetails::class, ChangePublicationStatus::class]; + } +} diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php new file mode 100644 index 00000000..77371818 --- /dev/null +++ b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php @@ -0,0 +1,55 @@ + */ + use SdkModel; + + /** + * Configure the publication status of a file and its versions. + */ + #[Api(optional: true)] + public ?Publish $publish; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Publish $publish = null): self + { + $obj = new self; + + null !== $publish && $obj->publish = $publish; + + return $obj; + } + + /** + * Configure the publication status of a file and its versions. + */ + public function withPublish(Publish $publish): self + { + $obj = clone $this; + $obj->publish = $publish; + + return $obj; + } +} diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php new file mode 100644 index 00000000..0569b9d2 --- /dev/null +++ b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php @@ -0,0 +1,93 @@ + */ + use SdkModel; + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + #[Api] + public bool $isPublished; + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + #[Api(optional: true)] + public ?bool $includeFileVersions; + + /** + * `new Publish()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Publish::with(isPublished: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Publish)->withIsPublished(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + bool $isPublished, + ?bool $includeFileVersions = null + ): self { + $obj = new self; + + $obj->isPublished = $isPublished; + + null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + public function withIncludeFileVersions(bool $includeFileVersions): self + { + $obj = clone $this; + $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } +} diff --git a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php new file mode 100644 index 00000000..7a5bb6ac --- /dev/null +++ b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php @@ -0,0 +1,211 @@ +|null, + * description?: string|null, + * extensions?: list|null, + * removeAITags?: string|null|list, + * tags?: list|null, + * webhookURL?: string|null, + * } + */ +final class UpdateFileDetails implements BaseModel +{ + /** @use SdkModel */ + use SdkModel; + + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @var list|null $extensions + */ + #[Api(list: ExtensionItem::class, optional: true)] + public ?array $extensions; + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @var string|list|null $removeAITags + */ + #[Api(union: RemoveAITags::class, optional: true)] + public string|array|null $removeAITags; + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + #[Api('webhookUrl', optional: true)] + public ?string $webhookURL; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + * + * @param array $customMetadata + * @param list $extensions + * @param string|list $removeAITags + * @param list|null $tags + */ + public static function with( + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?array $extensions = null, + string|array|null $removeAITags = null, + ?array $tags = null, + ?string $webhookURL = null, + ): self { + $obj = new self; + + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $extensions && $obj->extensions = $extensions; + null !== $removeAITags && $obj->removeAITags = $removeAITags; + null !== $tags && $obj->tags = $tags; + null !== $webhookURL && $obj->webhookURL = $webhookURL; + + return $obj; + } + + /** + * Define an important area in the image in the format `x,y,width,height` e.g. `10,10,100,100`. Send `null` to unset this value. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * A key-value data to be associated with the asset. To unset a key, send `null` value for that key. Before setting any custom metadata on an asset you have to create the field using custom metadata fields API. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Array of extensions to be applied to the asset. Each extension can be configured with specific parameters based on the extension type. + * + * @param list $extensions + */ + public function withExtensions(array $extensions): self + { + $obj = clone $this; + $obj->extensions = $extensions; + + return $obj; + } + + /** + * An array of AITags associated with the file that you want to remove, e.g. `["car", "vehicle", "motorsports"]`. + * + * If you want to remove all AITags associated with the file, send a string - "all". + * + * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. + * + * @param string|list $removeAITags + */ + public function withRemoveAITags(string|array $removeAITags): self + { + $obj = clone $this; + $obj->removeAITags = $removeAITags; + + return $obj; + } + + /** + * An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + */ + public function withWebhookURL(string $webhookURL): self + { + $obj = clone $this; + $obj->webhookURL = $webhookURL; + + return $obj; + } +} diff --git a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php new file mode 100644 index 00000000..f07ba68b --- /dev/null +++ b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php @@ -0,0 +1,32 @@ +|array + */ + public static function variants(): array + { + return [new ListOf('string'), new EnumOf(['all'])]; + } +} From 13291847d68a49a7468bf64dac797124ad8b2178 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 6 Sep 2025 02:44:31 +0000 Subject: [PATCH 25/40] feat!: expose services and service contracts --- src/Client.php | 16 ++++++++-------- .../Accounts/OriginsContract.php | 2 +- .../Accounts/URLEndpointsContract.php | 2 +- .../ServiceContracts/Accounts/UsageContract.php | 2 +- .../ServiceContracts/AccountsContract.php | 2 +- .../ServiceContracts/AssetsContract.php | 2 +- .../ServiceContracts/Beta/V2/FilesContract.php | 2 +- .../ServiceContracts/Beta/V2Contract.php | 2 +- src/{Core => }/ServiceContracts/BetaContract.php | 2 +- .../Cache/InvalidationContract.php | 2 +- .../ServiceContracts/CacheContract.php | 2 +- .../CustomMetadataFieldsContract.php | 2 +- .../ServiceContracts/Files/BulkContract.php | 2 +- .../ServiceContracts/Files/MetadataContract.php | 2 +- .../ServiceContracts/Files/VersionsContract.php | 2 +- .../ServiceContracts/FilesContract.php | 2 +- .../ServiceContracts/Folders/JobContract.php | 2 +- .../ServiceContracts/FoldersContract.php | 2 +- .../ServiceContracts/WebhooksContract.php | 2 +- .../Services/Accounts/OriginsService.php | 4 ++-- .../Services/Accounts/URLEndpointsService.php | 4 ++-- .../Services/Accounts/UsageService.php | 4 ++-- src/{Core => }/Services/AccountsService.php | 10 +++++----- src/{Core => }/Services/AssetsService.php | 4 ++-- src/{Core => }/Services/Beta/V2/FilesService.php | 4 ++-- src/{Core => }/Services/Beta/V2Service.php | 6 +++--- src/{Core => }/Services/BetaService.php | 6 +++--- .../Services/Cache/InvalidationService.php | 4 ++-- src/{Core => }/Services/CacheService.php | 6 +++--- .../Services/CustomMetadataFieldsService.php | 4 ++-- src/{Core => }/Services/Files/BulkService.php | 4 ++-- .../Services/Files/MetadataService.php | 4 ++-- .../Services/Files/VersionsService.php | 4 ++-- src/{Core => }/Services/FilesService.php | 10 +++++----- src/{Core => }/Services/Folders/JobService.php | 4 ++-- src/{Core => }/Services/FoldersService.php | 6 +++--- src/{Core => }/Services/WebhooksService.php | 4 ++-- 37 files changed, 72 insertions(+), 72 deletions(-) rename src/{Core => }/ServiceContracts/Accounts/OriginsContract.php (98%) rename src/{Core => }/ServiceContracts/Accounts/URLEndpointsContract.php (98%) rename src/{Core => }/ServiceContracts/Accounts/UsageContract.php (93%) rename src/{Core => }/ServiceContracts/AccountsContract.php (60%) rename src/{Core => }/ServiceContracts/AssetsContract.php (98%) rename src/{Core => }/ServiceContracts/Beta/V2/FilesContract.php (99%) rename src/{Core => }/ServiceContracts/Beta/V2Contract.php (55%) rename src/{Core => }/ServiceContracts/BetaContract.php (58%) rename src/{Core => }/ServiceContracts/Cache/InvalidationContract.php (92%) rename src/{Core => }/ServiceContracts/CacheContract.php (59%) rename src/{Core => }/ServiceContracts/CustomMetadataFieldsContract.php (98%) rename src/{Core => }/ServiceContracts/Files/BulkContract.php (97%) rename src/{Core => }/ServiceContracts/Files/MetadataContract.php (91%) rename src/{Core => }/ServiceContracts/Files/VersionsContract.php (95%) rename src/{Core => }/ServiceContracts/FilesContract.php (99%) rename src/{Core => }/ServiceContracts/Folders/JobContract.php (84%) rename src/{Core => }/ServiceContracts/FoldersContract.php (98%) rename src/{Core => }/ServiceContracts/WebhooksContract.php (60%) rename src/{Core => }/Services/Accounts/OriginsService.php (98%) rename src/{Core => }/Services/Accounts/URLEndpointsService.php (98%) rename src/{Core => }/Services/Accounts/UsageService.php (94%) rename src/{Core => }/Services/AccountsService.php (71%) rename src/{Core => }/Services/AssetsService.php (97%) rename src/{Core => }/Services/Beta/V2/FilesService.php (98%) rename src/{Core => }/Services/Beta/V2Service.php (69%) rename src/{Core => }/Services/BetaService.php (71%) rename src/{Core => }/Services/Cache/InvalidationService.php (94%) rename src/{Core => }/Services/CacheService.php (72%) rename src/{Core => }/Services/CustomMetadataFieldsService.php (98%) rename src/{Core => }/Services/Files/BulkService.php (97%) rename src/{Core => }/Services/Files/MetadataService.php (94%) rename src/{Core => }/Services/Files/VersionsService.php (97%) rename src/{Core => }/Services/FilesService.php (98%) rename src/{Core => }/Services/Folders/JobService.php (88%) rename src/{Core => }/Services/FoldersService.php (98%) rename src/{Core => }/Services/WebhooksService.php (70%) diff --git a/src/Client.php b/src/Client.php index a7dabcc9..9cdd9aa3 100644 --- a/src/Client.php +++ b/src/Client.php @@ -7,14 +7,14 @@ use Http\Discovery\Psr17FactoryDiscovery; use Http\Discovery\Psr18ClientDiscovery; use ImageKit\Core\BaseClient; -use ImageKit\Core\Services\AccountsService; -use ImageKit\Core\Services\AssetsService; -use ImageKit\Core\Services\BetaService; -use ImageKit\Core\Services\CacheService; -use ImageKit\Core\Services\CustomMetadataFieldsService; -use ImageKit\Core\Services\FilesService; -use ImageKit\Core\Services\FoldersService; -use ImageKit\Core\Services\WebhooksService; +use ImageKit\Services\AccountsService; +use ImageKit\Services\AssetsService; +use ImageKit\Services\BetaService; +use ImageKit\Services\CacheService; +use ImageKit\Services\CustomMetadataFieldsService; +use ImageKit\Services\FilesService; +use ImageKit\Services\FoldersService; +use ImageKit\Services\WebhooksService; class Client extends BaseClient { diff --git a/src/Core/ServiceContracts/Accounts/OriginsContract.php b/src/ServiceContracts/Accounts/OriginsContract.php similarity index 98% rename from src/Core/ServiceContracts/Accounts/OriginsContract.php rename to src/ServiceContracts/Accounts/OriginsContract.php index 9a560ffd..0662e5b0 100644 --- a/src/Core/ServiceContracts/Accounts/OriginsContract.php +++ b/src/ServiceContracts/Accounts/OriginsContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Accounts; +namespace ImageKit\ServiceContracts\Accounts; use ImageKit\Accounts\Origins\OriginResponse\AkeneoPim; use ImageKit\Accounts\Origins\OriginResponse\AzureBlob; diff --git a/src/Core/ServiceContracts/Accounts/URLEndpointsContract.php b/src/ServiceContracts/Accounts/URLEndpointsContract.php similarity index 98% rename from src/Core/ServiceContracts/Accounts/URLEndpointsContract.php rename to src/ServiceContracts/Accounts/URLEndpointsContract.php index 765c3efd..2f58ce7e 100644 --- a/src/Core/ServiceContracts/Accounts/URLEndpointsContract.php +++ b/src/ServiceContracts/Accounts/URLEndpointsContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Accounts; +namespace ImageKit\ServiceContracts\Accounts; use ImageKit\Accounts\URLEndpoints\URLEndpointCreateParams\URLRewriter\Akamai; use ImageKit\Accounts\URLEndpoints\URLEndpointCreateParams\URLRewriter\Cloudinary; diff --git a/src/Core/ServiceContracts/Accounts/UsageContract.php b/src/ServiceContracts/Accounts/UsageContract.php similarity index 93% rename from src/Core/ServiceContracts/Accounts/UsageContract.php rename to src/ServiceContracts/Accounts/UsageContract.php index eeb5fac6..d9db2280 100644 --- a/src/Core/ServiceContracts/Accounts/UsageContract.php +++ b/src/ServiceContracts/Accounts/UsageContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Accounts; +namespace ImageKit\ServiceContracts\Accounts; use ImageKit\Accounts\Usage\UsageGetResponse; use ImageKit\RequestOptions; diff --git a/src/Core/ServiceContracts/AccountsContract.php b/src/ServiceContracts/AccountsContract.php similarity index 60% rename from src/Core/ServiceContracts/AccountsContract.php rename to src/ServiceContracts/AccountsContract.php index a7722454..593d29a6 100644 --- a/src/Core/ServiceContracts/AccountsContract.php +++ b/src/ServiceContracts/AccountsContract.php @@ -2,6 +2,6 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; interface AccountsContract {} diff --git a/src/Core/ServiceContracts/AssetsContract.php b/src/ServiceContracts/AssetsContract.php similarity index 98% rename from src/Core/ServiceContracts/AssetsContract.php rename to src/ServiceContracts/AssetsContract.php index d7d795e1..413ad923 100644 --- a/src/Core/ServiceContracts/AssetsContract.php +++ b/src/ServiceContracts/AssetsContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; use ImageKit\Assets\AssetListParams\FileType; use ImageKit\Assets\AssetListParams\Sort; diff --git a/src/Core/ServiceContracts/Beta/V2/FilesContract.php b/src/ServiceContracts/Beta/V2/FilesContract.php similarity index 99% rename from src/Core/ServiceContracts/Beta/V2/FilesContract.php rename to src/ServiceContracts/Beta/V2/FilesContract.php index 885eb107..4365eb28 100644 --- a/src/Core/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/ServiceContracts/Beta/V2/FilesContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Beta\V2; +namespace ImageKit\ServiceContracts\Beta\V2; use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; diff --git a/src/Core/ServiceContracts/Beta/V2Contract.php b/src/ServiceContracts/Beta/V2Contract.php similarity index 55% rename from src/Core/ServiceContracts/Beta/V2Contract.php rename to src/ServiceContracts/Beta/V2Contract.php index a76de06f..c3c8cd8c 100644 --- a/src/Core/ServiceContracts/Beta/V2Contract.php +++ b/src/ServiceContracts/Beta/V2Contract.php @@ -2,6 +2,6 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Beta; +namespace ImageKit\ServiceContracts\Beta; interface V2Contract {} diff --git a/src/Core/ServiceContracts/BetaContract.php b/src/ServiceContracts/BetaContract.php similarity index 58% rename from src/Core/ServiceContracts/BetaContract.php rename to src/ServiceContracts/BetaContract.php index 1ee521b4..675430fc 100644 --- a/src/Core/ServiceContracts/BetaContract.php +++ b/src/ServiceContracts/BetaContract.php @@ -2,6 +2,6 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; interface BetaContract {} diff --git a/src/Core/ServiceContracts/Cache/InvalidationContract.php b/src/ServiceContracts/Cache/InvalidationContract.php similarity index 92% rename from src/Core/ServiceContracts/Cache/InvalidationContract.php rename to src/ServiceContracts/Cache/InvalidationContract.php index 640f628f..0578aba6 100644 --- a/src/Core/ServiceContracts/Cache/InvalidationContract.php +++ b/src/ServiceContracts/Cache/InvalidationContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Cache; +namespace ImageKit\ServiceContracts\Cache; use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; diff --git a/src/Core/ServiceContracts/CacheContract.php b/src/ServiceContracts/CacheContract.php similarity index 59% rename from src/Core/ServiceContracts/CacheContract.php rename to src/ServiceContracts/CacheContract.php index 26bcfb84..aa3c07b6 100644 --- a/src/Core/ServiceContracts/CacheContract.php +++ b/src/ServiceContracts/CacheContract.php @@ -2,6 +2,6 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; interface CacheContract {} diff --git a/src/Core/ServiceContracts/CustomMetadataFieldsContract.php b/src/ServiceContracts/CustomMetadataFieldsContract.php similarity index 98% rename from src/Core/ServiceContracts/CustomMetadataFieldsContract.php rename to src/ServiceContracts/CustomMetadataFieldsContract.php index bac42df4..64f8b62b 100644 --- a/src/Core/ServiceContracts/CustomMetadataFieldsContract.php +++ b/src/ServiceContracts/CustomMetadataFieldsContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; diff --git a/src/Core/ServiceContracts/Files/BulkContract.php b/src/ServiceContracts/Files/BulkContract.php similarity index 97% rename from src/Core/ServiceContracts/Files/BulkContract.php rename to src/ServiceContracts/Files/BulkContract.php index b8c4fb2d..c1c7de85 100644 --- a/src/Core/ServiceContracts/Files/BulkContract.php +++ b/src/ServiceContracts/Files/BulkContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Files; +namespace ImageKit\ServiceContracts\Files; use ImageKit\Files\Bulk\BulkAddTagsResponse; use ImageKit\Files\Bulk\BulkDeleteResponse; diff --git a/src/Core/ServiceContracts/Files/MetadataContract.php b/src/ServiceContracts/Files/MetadataContract.php similarity index 91% rename from src/Core/ServiceContracts/Files/MetadataContract.php rename to src/ServiceContracts/Files/MetadataContract.php index 3c3d3a23..615b5b4a 100644 --- a/src/Core/ServiceContracts/Files/MetadataContract.php +++ b/src/ServiceContracts/Files/MetadataContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Files; +namespace ImageKit\ServiceContracts\Files; use ImageKit\Files\Metadata; use ImageKit\RequestOptions; diff --git a/src/Core/ServiceContracts/Files/VersionsContract.php b/src/ServiceContracts/Files/VersionsContract.php similarity index 95% rename from src/Core/ServiceContracts/Files/VersionsContract.php rename to src/ServiceContracts/Files/VersionsContract.php index 0f60d856..ae4d43f6 100644 --- a/src/Core/ServiceContracts/Files/VersionsContract.php +++ b/src/ServiceContracts/Files/VersionsContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Files; +namespace ImageKit\ServiceContracts\Files; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteResponse; diff --git a/src/Core/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php similarity index 99% rename from src/Core/ServiceContracts/FilesContract.php rename to src/ServiceContracts/FilesContract.php index c5f265c5..b5d85db8 100644 --- a/src/Core/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; diff --git a/src/Core/ServiceContracts/Folders/JobContract.php b/src/ServiceContracts/Folders/JobContract.php similarity index 84% rename from src/Core/ServiceContracts/Folders/JobContract.php rename to src/ServiceContracts/Folders/JobContract.php index 85a41014..ba4dcfe0 100644 --- a/src/Core/ServiceContracts/Folders/JobContract.php +++ b/src/ServiceContracts/Folders/JobContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts\Folders; +namespace ImageKit\ServiceContracts\Folders; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; diff --git a/src/Core/ServiceContracts/FoldersContract.php b/src/ServiceContracts/FoldersContract.php similarity index 98% rename from src/Core/ServiceContracts/FoldersContract.php rename to src/ServiceContracts/FoldersContract.php index f1b59283..04943640 100644 --- a/src/Core/ServiceContracts/FoldersContract.php +++ b/src/ServiceContracts/FoldersContract.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; use ImageKit\Folders\FolderCopyResponse; use ImageKit\Folders\FolderDeleteResponse; diff --git a/src/Core/ServiceContracts/WebhooksContract.php b/src/ServiceContracts/WebhooksContract.php similarity index 60% rename from src/Core/ServiceContracts/WebhooksContract.php rename to src/ServiceContracts/WebhooksContract.php index 4a7c5a51..cefb28f3 100644 --- a/src/Core/ServiceContracts/WebhooksContract.php +++ b/src/ServiceContracts/WebhooksContract.php @@ -2,6 +2,6 @@ declare(strict_types=1); -namespace ImageKit\Core\ServiceContracts; +namespace ImageKit\ServiceContracts; interface WebhooksContract {} diff --git a/src/Core/Services/Accounts/OriginsService.php b/src/Services/Accounts/OriginsService.php similarity index 98% rename from src/Core/Services/Accounts/OriginsService.php rename to src/Services/Accounts/OriginsService.php index d52dda85..17d341d7 100644 --- a/src/Core/Services/Accounts/OriginsService.php +++ b/src/Services/Accounts/OriginsService.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Accounts; +namespace ImageKit\Services\Accounts; use ImageKit\Accounts\Origins\OriginCreateParams; use ImageKit\Accounts\Origins\OriginResponse; @@ -17,8 +17,8 @@ use ImageKit\Accounts\Origins\OriginUpdateParams; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; -use ImageKit\Core\ServiceContracts\Accounts\OriginsContract; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Accounts\OriginsContract; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Accounts/URLEndpointsService.php b/src/Services/Accounts/URLEndpointsService.php similarity index 98% rename from src/Core/Services/Accounts/URLEndpointsService.php rename to src/Services/Accounts/URLEndpointsService.php index a571f965..763e54d1 100644 --- a/src/Core/Services/Accounts/URLEndpointsService.php +++ b/src/Services/Accounts/URLEndpointsService.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Accounts; +namespace ImageKit\Services\Accounts; use ImageKit\Accounts\URLEndpoints\URLEndpointCreateParams; use ImageKit\Accounts\URLEndpoints\URLEndpointCreateParams\URLRewriter\Akamai; @@ -15,8 +15,8 @@ use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Imgix as Imgix1; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; -use ImageKit\Core\ServiceContracts\Accounts\URLEndpointsContract; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Accounts\URLEndpointsContract; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Accounts/UsageService.php b/src/Services/Accounts/UsageService.php similarity index 94% rename from src/Core/Services/Accounts/UsageService.php rename to src/Services/Accounts/UsageService.php index ffba52fa..b4fd1286 100644 --- a/src/Core/Services/Accounts/UsageService.php +++ b/src/Services/Accounts/UsageService.php @@ -2,13 +2,13 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Accounts; +namespace ImageKit\Services\Accounts; use ImageKit\Accounts\Usage\UsageGetParams; use ImageKit\Accounts\Usage\UsageGetResponse; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Accounts\UsageContract; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Accounts\UsageContract; final class UsageService implements UsageContract { diff --git a/src/Core/Services/AccountsService.php b/src/Services/AccountsService.php similarity index 71% rename from src/Core/Services/AccountsService.php rename to src/Services/AccountsService.php index c65638a4..52fd692d 100644 --- a/src/Core/Services/AccountsService.php +++ b/src/Services/AccountsService.php @@ -2,13 +2,13 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\AccountsContract; -use ImageKit\Core\Services\Accounts\OriginsService; -use ImageKit\Core\Services\Accounts\URLEndpointsService; -use ImageKit\Core\Services\Accounts\UsageService; +use ImageKit\ServiceContracts\AccountsContract; +use ImageKit\Services\Accounts\OriginsService; +use ImageKit\Services\Accounts\URLEndpointsService; +use ImageKit\Services\Accounts\UsageService; final class AccountsService implements AccountsContract { diff --git a/src/Core/Services/AssetsService.php b/src/Services/AssetsService.php similarity index 97% rename from src/Core/Services/AssetsService.php rename to src/Services/AssetsService.php index cd4a536f..8ae23f14 100644 --- a/src/Core/Services/AssetsService.php +++ b/src/Services/AssetsService.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Assets\AssetListParams; use ImageKit\Assets\AssetListParams\FileType; @@ -11,10 +11,10 @@ use ImageKit\Assets\AssetListResponseItem; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; -use ImageKit\Core\ServiceContracts\AssetsContract; use ImageKit\Files\File; use ImageKit\Files\Folder; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\AssetsContract; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Beta/V2/FilesService.php b/src/Services/Beta/V2/FilesService.php similarity index 98% rename from src/Core/Services/Beta/V2/FilesService.php rename to src/Services/Beta/V2/FilesService.php index 06ba4a58..df9541c3 100644 --- a/src/Core/Services/Beta/V2/FilesService.php +++ b/src/Services/Beta/V2/FilesService.php @@ -2,18 +2,18 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Beta\V2; +namespace ImageKit\Services\Beta\V2; use ImageKit\Beta\V2\Files\FileUploadParams; use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Beta\V2\FilesContract; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Beta\V2\FilesContract; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Beta/V2Service.php b/src/Services/Beta/V2Service.php similarity index 69% rename from src/Core/Services/Beta/V2Service.php rename to src/Services/Beta/V2Service.php index 425c2750..4cddd5bd 100644 --- a/src/Core/Services/Beta/V2Service.php +++ b/src/Services/Beta/V2Service.php @@ -2,11 +2,11 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Beta; +namespace ImageKit\Services\Beta; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Beta\V2Contract; -use ImageKit\Core\Services\Beta\V2\FilesService; +use ImageKit\ServiceContracts\Beta\V2Contract; +use ImageKit\Services\Beta\V2\FilesService; final class V2Service implements V2Contract { diff --git a/src/Core/Services/BetaService.php b/src/Services/BetaService.php similarity index 71% rename from src/Core/Services/BetaService.php rename to src/Services/BetaService.php index 82b57a59..d6cecb03 100644 --- a/src/Core/Services/BetaService.php +++ b/src/Services/BetaService.php @@ -2,11 +2,11 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\BetaContract; -use ImageKit\Core\Services\Beta\V2Service; +use ImageKit\ServiceContracts\BetaContract; +use ImageKit\Services\Beta\V2Service; final class BetaService implements BetaContract { diff --git a/src/Core/Services/Cache/InvalidationService.php b/src/Services/Cache/InvalidationService.php similarity index 94% rename from src/Core/Services/Cache/InvalidationService.php rename to src/Services/Cache/InvalidationService.php index 4d66728b..6cc46054 100644 --- a/src/Core/Services/Cache/InvalidationService.php +++ b/src/Services/Cache/InvalidationService.php @@ -2,14 +2,14 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Cache; +namespace ImageKit\Services\Cache; use ImageKit\Cache\Invalidation\InvalidationCreateParams; use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Cache\InvalidationContract; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Cache\InvalidationContract; final class InvalidationService implements InvalidationContract { diff --git a/src/Core/Services/CacheService.php b/src/Services/CacheService.php similarity index 72% rename from src/Core/Services/CacheService.php rename to src/Services/CacheService.php index 1fd48de0..89184440 100644 --- a/src/Core/Services/CacheService.php +++ b/src/Services/CacheService.php @@ -2,11 +2,11 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\CacheContract; -use ImageKit\Core\Services\Cache\InvalidationService; +use ImageKit\ServiceContracts\CacheContract; +use ImageKit\Services\Cache\InvalidationService; final class CacheService implements CacheContract { diff --git a/src/Core/Services/CustomMetadataFieldsService.php b/src/Services/CustomMetadataFieldsService.php similarity index 98% rename from src/Core/Services/CustomMetadataFieldsService.php rename to src/Services/CustomMetadataFieldsService.php index 1c8a67bd..928b43a8 100644 --- a/src/Core/Services/CustomMetadataFieldsService.php +++ b/src/Services/CustomMetadataFieldsService.php @@ -2,11 +2,10 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; -use ImageKit\Core\ServiceContracts\CustomMetadataFieldsContract; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; @@ -15,6 +14,7 @@ use ImageKit\CustomMetadataFields\CustomMetadataFieldUpdateParams; use ImageKit\CustomMetadataFields\CustomMetadataFieldUpdateParams\Schema as Schema1; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\CustomMetadataFieldsContract; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Files/BulkService.php b/src/Services/Files/BulkService.php similarity index 97% rename from src/Core/Services/Files/BulkService.php rename to src/Services/Files/BulkService.php index 23fc95dd..731db603 100644 --- a/src/Core/Services/Files/BulkService.php +++ b/src/Services/Files/BulkService.php @@ -2,10 +2,9 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Files; +namespace ImageKit\Services\Files; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Files\BulkContract; use ImageKit\Files\Bulk\BulkAddTagsParams; use ImageKit\Files\Bulk\BulkAddTagsResponse; use ImageKit\Files\Bulk\BulkDeleteParams; @@ -15,6 +14,7 @@ use ImageKit\Files\Bulk\BulkRemoveTagsParams; use ImageKit\Files\Bulk\BulkRemoveTagsResponse; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Files\BulkContract; final class BulkService implements BulkContract { diff --git a/src/Core/Services/Files/MetadataService.php b/src/Services/Files/MetadataService.php similarity index 94% rename from src/Core/Services/Files/MetadataService.php rename to src/Services/Files/MetadataService.php index 4c47b2ec..6d94f3f3 100644 --- a/src/Core/Services/Files/MetadataService.php +++ b/src/Services/Files/MetadataService.php @@ -2,13 +2,13 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Files; +namespace ImageKit\Services\Files; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Files\MetadataContract; use ImageKit\Files\Metadata; use ImageKit\Files\Metadata\MetadataGetFromURLParams; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Files\MetadataContract; final class MetadataService implements MetadataContract { diff --git a/src/Core/Services/Files/VersionsService.php b/src/Services/Files/VersionsService.php similarity index 97% rename from src/Core/Services/Files/VersionsService.php rename to src/Services/Files/VersionsService.php index 0c62d1e2..62bb23b0 100644 --- a/src/Core/Services/Files/VersionsService.php +++ b/src/Services/Files/VersionsService.php @@ -2,17 +2,17 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Files; +namespace ImageKit\Services\Files; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; -use ImageKit\Core\ServiceContracts\Files\VersionsContract; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteParams; use ImageKit\Files\Versions\VersionDeleteResponse; use ImageKit\Files\Versions\VersionGetParams; use ImageKit\Files\Versions\VersionRestoreParams; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Files\VersionsContract; final class VersionsService implements VersionsContract { diff --git a/src/Core/Services/FilesService.php b/src/Services/FilesService.php similarity index 98% rename from src/Core/Services/FilesService.php rename to src/Services/FilesService.php index c421314f..78da9fae 100644 --- a/src/Core/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -2,13 +2,9 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\FilesContract; -use ImageKit\Core\Services\Files\BulkService; -use ImageKit\Core\Services\Files\MetadataService; -use ImageKit\Core\Services\Files\VersionsService; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; @@ -27,6 +23,10 @@ use ImageKit\Files\FileUploadParams\Transformation; use ImageKit\Files\FileUploadResponse; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\FilesContract; +use ImageKit\Services\Files\BulkService; +use ImageKit\Services\Files\MetadataService; +use ImageKit\Services\Files\VersionsService; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/Folders/JobService.php b/src/Services/Folders/JobService.php similarity index 88% rename from src/Core/Services/Folders/JobService.php rename to src/Services/Folders/JobService.php index bb21f3bf..b7be4ac6 100644 --- a/src/Core/Services/Folders/JobService.php +++ b/src/Services/Folders/JobService.php @@ -2,12 +2,12 @@ declare(strict_types=1); -namespace ImageKit\Core\Services\Folders; +namespace ImageKit\Services\Folders; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\Folders\JobContract; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\Folders\JobContract; final class JobService implements JobContract { diff --git a/src/Core/Services/FoldersService.php b/src/Services/FoldersService.php similarity index 98% rename from src/Core/Services/FoldersService.php rename to src/Services/FoldersService.php index 31fd4ac5..4a6bd748 100644 --- a/src/Core/Services/FoldersService.php +++ b/src/Services/FoldersService.php @@ -2,11 +2,9 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\FoldersContract; -use ImageKit\Core\Services\Folders\JobService; use ImageKit\Folders\FolderCopyParams; use ImageKit\Folders\FolderCopyResponse; use ImageKit\Folders\FolderCreateParams; @@ -18,6 +16,8 @@ use ImageKit\Folders\FolderRenameParams; use ImageKit\Folders\FolderRenameResponse; use ImageKit\RequestOptions; +use ImageKit\ServiceContracts\FoldersContract; +use ImageKit\Services\Folders\JobService; use const ImageKit\Core\OMIT as omit; diff --git a/src/Core/Services/WebhooksService.php b/src/Services/WebhooksService.php similarity index 70% rename from src/Core/Services/WebhooksService.php rename to src/Services/WebhooksService.php index bbcf1195..4b4150a7 100644 --- a/src/Core/Services/WebhooksService.php +++ b/src/Services/WebhooksService.php @@ -2,10 +2,10 @@ declare(strict_types=1); -namespace ImageKit\Core\Services; +namespace ImageKit\Services; use ImageKit\Client; -use ImageKit\Core\ServiceContracts\WebhooksContract; +use ImageKit\ServiceContracts\WebhooksContract; final class WebhooksService implements WebhooksContract { From 0b65863c45d58bf52bca76cfa8f7560e381d7dc9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 9 Sep 2025 02:21:44 +0000 Subject: [PATCH 26/40] feat(client): use real enums --- src/Assets/AssetListParams.php | 48 ++--- src/Assets/AssetListParams/FileType.php | 13 +- src/Assets/AssetListParams/Sort.php | 35 ++-- src/Assets/AssetListParams/Type.php | 15 +- src/Beta/V2/Files/FileUploadParams.php | 12 +- .../Files/FileUploadParams/ResponseField.php | 21 +- .../Transformation/Post/Abs.php | 16 +- .../Transformation/Post/Abs/Protocol.php | 11 +- .../FileUploadResponse/ExtensionStatus.php | 73 +++---- .../ExtensionStatus/AIAutoDescription.php | 13 +- .../ExtensionStatus/AwsAutoTagging.php | 13 +- .../ExtensionStatus/GoogleAutoTagging.php | 13 +- .../ExtensionStatus/RemoveBg.php | 13 +- .../Invalidation/InvalidationGetResponse.php | 16 +- .../InvalidationGetResponse/Status.php | 11 +- src/Core/Attributes/Api.php | 34 +++- .../CustomMetadataField/Schema.php | 16 +- .../CustomMetadataField/Schema/Type.php | 21 +- .../Schema.php | 16 +- .../Schema/Type.php | 21 +- src/ExtensionItem/AutoTaggingExtension.php | 16 +- .../AutoTaggingExtension/Name.php | 11 +- src/Files/File.php | 16 +- src/Files/File/Type.php | 11 +- .../FileUpdateResponse/ExtensionStatus.php | 73 +++---- .../ExtensionStatus/AIAutoDescription.php | 13 +- .../ExtensionStatus/AwsAutoTagging.php | 13 +- .../ExtensionStatus/GoogleAutoTagging.php | 13 +- .../ExtensionStatus/RemoveBg.php | 13 +- src/Files/FileUploadParams.php | 12 +- src/Files/FileUploadParams/ResponseField.php | 21 +- .../Transformation/Post/Abs.php | 16 +- .../Transformation/Post/Abs/Protocol.php | 11 +- .../FileUploadResponse/ExtensionStatus.php | 73 +++---- .../ExtensionStatus/AIAutoDescription.php | 13 +- .../ExtensionStatus/AwsAutoTagging.php | 13 +- .../ExtensionStatus/GoogleAutoTagging.php | 13 +- .../ExtensionStatus/RemoveBg.php | 13 +- src/Files/Folder.php | 16 +- src/Files/Folder/Type.php | 9 +- src/Folders/Job/JobGetResponse.php | 32 ++-- src/Folders/Job/JobGetResponse/Status.php | 11 +- src/Folders/Job/JobGetResponse/Type.php | 13 +- src/ImageOverlay.php | 18 +- src/ImageOverlay/Encoding.php | 13 +- src/OverlayPosition.php | 16 +- src/OverlayPosition/Focus.php | 25 +-- src/ServiceContracts/AssetsContract.php | 6 +- .../Beta/V2/FilesContract.php | 2 +- src/ServiceContracts/FilesContract.php | 2 +- src/Services/AssetsService.php | 6 +- src/Services/Beta/V2/FilesService.php | 2 +- src/Services/FilesService.php | 2 +- src/SrcOptions.php | 16 +- src/StreamingResolution.php | 21 +- src/SubtitleOverlay.php | 18 +- src/SubtitleOverlay/Encoding.php | 13 +- src/SubtitleOverlayTransformation.php | 16 +- .../Typography.php | 13 +- src/TextOverlay.php | 16 +- src/TextOverlay/Encoding.php | 13 +- src/TextOverlayTransformation.php | 35 ++-- src/TextOverlayTransformation/Flip.php | 15 +- .../InnerAlignment.php | 13 +- src/Transformation.php | 181 +++++++----------- src/Transformation/AIRemoveBackground.php | 20 -- .../AIRemoveBackgroundExternal.php | 21 -- src/Transformation/AIRetouch.php | 19 -- src/Transformation/AIUpscale.php | 19 -- src/Transformation/AIVariation.php | 20 -- src/Transformation/AudioCodec.php | 13 +- src/Transformation/ContrastStretch.php | 19 -- src/Transformation/Crop.php | 17 +- src/Transformation/CropMode.php | 13 +- src/Transformation/Flip.php | 15 +- src/Transformation/Format.php | 29 ++- src/Transformation/Grayscale.php | 18 -- src/Transformation/VideoCodec.php | 15 +- src/TransformationPosition.php | 11 +- src/VideoOverlay.php | 18 +- src/VideoOverlay/Encoding.php | 13 +- .../Request/Transformation.php | 30 +-- .../Request/Transformation/Protocol.php | 11 +- .../Request/Transformation/Type.php | 15 +- .../Request/Transformation.php | 30 +-- .../Request/Transformation/Protocol.php | 11 +- .../Request/Transformation/Type.php | 15 +- .../Data/ExtensionStatus.php | 73 +++---- .../ExtensionStatus/AIAutoDescription.php | 13 +- .../Data/ExtensionStatus/AwsAutoTagging.php | 13 +- .../ExtensionStatus/GoogleAutoTagging.php | 13 +- .../Data/ExtensionStatus/RemoveBg.php | 13 +- .../Data/Transformation.php | 20 +- .../Data/Transformation/Options.php | 67 +++---- .../Transformation/Options/AudioCodec.php | 11 +- .../Data/Transformation/Options/Format.php | 17 +- .../Transformation/Options/StreamProtocol.php | 11 +- .../Transformation/Options/VideoCodec.php | 13 +- .../Data/Transformation/Type.php | 13 +- .../Data/Transformation.php | 16 +- .../Data/Transformation/Error.php | 16 +- .../Data/Transformation/Error/Reason.php | 13 +- .../Data/Transformation/Options.php | 67 +++---- .../Transformation/Options/AudioCodec.php | 11 +- .../Data/Transformation/Options/Format.php | 17 +- .../Transformation/Options/StreamProtocol.php | 11 +- .../Transformation/Options/VideoCodec.php | 13 +- .../Data/Transformation/Type.php | 13 +- .../Data/Transformation.php | 16 +- .../Data/Transformation/Options.php | 67 +++---- .../Transformation/Options/AudioCodec.php | 11 +- .../Data/Transformation/Options/Format.php | 17 +- .../Transformation/Options/StreamProtocol.php | 11 +- .../Transformation/Options/VideoCodec.php | 13 +- .../Data/Transformation/Type.php | 13 +- 115 files changed, 932 insertions(+), 1400 deletions(-) delete mode 100644 src/Transformation/AIRemoveBackground.php delete mode 100644 src/Transformation/AIRemoveBackgroundExternal.php delete mode 100644 src/Transformation/AIRetouch.php delete mode 100644 src/Transformation/AIUpscale.php delete mode 100644 src/Transformation/AIVariation.php delete mode 100644 src/Transformation/ContrastStretch.php delete mode 100644 src/Transformation/Grayscale.php diff --git a/src/Assets/AssetListParams.php b/src/Assets/AssetListParams.php index f788cfbd..1802e6a4 100644 --- a/src/Assets/AssetListParams.php +++ b/src/Assets/AssetListParams.php @@ -29,13 +29,13 @@ * @see ImageKit\Assets->list * * @phpstan-type asset_list_params = array{ - * fileType?: FileType::*, + * fileType?: FileType|value-of, * limit?: int, * path?: string, * searchQuery?: string, * skip?: int, - * sort?: Sort::*, - * type?: Type::*, + * sort?: Sort|value-of, + * type?: Type|value-of, * } */ final class AssetListParams implements BaseModel @@ -51,7 +51,7 @@ final class AssetListParams implements BaseModel * - `image` — include only image files * - `non-image` — include only non-image files (e.g., JS, CSS, video) * - * @var FileType::*|null $fileType + * @var value-of|null $fileType */ #[Api(enum: FileType::class, optional: true)] public ?string $fileType; @@ -94,7 +94,7 @@ final class AssetListParams implements BaseModel /** * Sort the results by one of the supported fields in ascending or descending order. * - * @var Sort::*|null $sort + * @var value-of|null $sort */ #[Api(enum: Sort::class, optional: true)] public ?string $sort; @@ -107,7 +107,7 @@ final class AssetListParams implements BaseModel * - `folder` — returns only folders * - `all` — returns both files and folders (excludes `file-version`) * - * @var Type::*|null $type + * @var value-of|null $type */ #[Api(enum: Type::class, optional: true)] public ?string $type; @@ -122,28 +122,28 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param FileType::* $fileType - * @param Sort::* $sort - * @param Type::* $type + * @param FileType|value-of $fileType + * @param Sort|value-of $sort + * @param Type|value-of $type */ public static function with( - ?string $fileType = null, + FileType|string|null $fileType = null, ?int $limit = null, ?string $path = null, ?string $searchQuery = null, ?int $skip = null, - ?string $sort = null, - ?string $type = null, + Sort|string|null $sort = null, + Type|string|null $type = null, ): self { $obj = new self; - null !== $fileType && $obj->fileType = $fileType; + null !== $fileType && $obj->fileType = $fileType instanceof FileType ? $fileType->value : $fileType; null !== $limit && $obj->limit = $limit; null !== $path && $obj->path = $path; null !== $searchQuery && $obj->searchQuery = $searchQuery; null !== $skip && $obj->skip = $skip; - null !== $sort && $obj->sort = $sort; - null !== $type && $obj->type = $type; + null !== $sort && $obj->sort = $sort instanceof Sort ? $sort->value : $sort; + null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } @@ -155,12 +155,12 @@ public static function with( * - `image` — include only image files * - `non-image` — include only non-image files (e.g., JS, CSS, video) * - * @param FileType::* $fileType + * @param FileType|value-of $fileType */ - public function withFileType(string $fileType): self + public function withFileType(FileType|string $fileType): self { $obj = clone $this; - $obj->fileType = $fileType; + $obj->fileType = $fileType instanceof FileType ? $fileType->value : $fileType; return $obj; } @@ -223,12 +223,12 @@ public function withSkip(int $skip): self /** * Sort the results by one of the supported fields in ascending or descending order. * - * @param Sort::* $sort + * @param Sort|value-of $sort */ - public function withSort(string $sort): self + public function withSort(Sort|string $sort): self { $obj = clone $this; - $obj->sort = $sort; + $obj->sort = $sort instanceof Sort ? $sort->value : $sort; return $obj; } @@ -241,12 +241,12 @@ public function withSort(string $sort): self * - `folder` — returns only folders * - `all` — returns both files and folders (excludes `file-version`) * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Assets/AssetListParams/FileType.php b/src/Assets/AssetListParams/FileType.php index 65c88ef3..8c812108 100644 --- a/src/Assets/AssetListParams/FileType.php +++ b/src/Assets/AssetListParams/FileType.php @@ -4,9 +4,6 @@ namespace ImageKit\Assets\AssetListParams; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Filter results by file type. * @@ -14,13 +11,11 @@ * - `image` — include only image files * - `non-image` — include only non-image files (e.g., JS, CSS, video) */ -final class FileType implements ConverterSource +enum FileType: string { - use SdkEnum; - - public const ALL = 'all'; + case ALL = 'all'; - public const IMAGE = 'image'; + case IMAGE = 'image'; - public const NON_IMAGE = 'non-image'; + case NON_IMAGE = 'non-image'; } diff --git a/src/Assets/AssetListParams/Sort.php b/src/Assets/AssetListParams/Sort.php index 1afe0e65..ff5a2378 100644 --- a/src/Assets/AssetListParams/Sort.php +++ b/src/Assets/AssetListParams/Sort.php @@ -4,41 +4,36 @@ namespace ImageKit\Assets\AssetListParams; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Sort the results by one of the supported fields in ascending or descending order. */ -final class Sort implements ConverterSource +enum Sort: string { - use SdkEnum; - - public const ASC_NAME = 'ASC_NAME'; + case ASC_NAME = 'ASC_NAME'; - public const DESC_NAME = 'DESC_NAME'; + case DESC_NAME = 'DESC_NAME'; - public const ASC_CREATED = 'ASC_CREATED'; + case ASC_CREATED = 'ASC_CREATED'; - public const DESC_CREATED = 'DESC_CREATED'; + case DESC_CREATED = 'DESC_CREATED'; - public const ASC_UPDATED = 'ASC_UPDATED'; + case ASC_UPDATED = 'ASC_UPDATED'; - public const DESC_UPDATED = 'DESC_UPDATED'; + case DESC_UPDATED = 'DESC_UPDATED'; - public const ASC_HEIGHT = 'ASC_HEIGHT'; + case ASC_HEIGHT = 'ASC_HEIGHT'; - public const DESC_HEIGHT = 'DESC_HEIGHT'; + case DESC_HEIGHT = 'DESC_HEIGHT'; - public const ASC_WIDTH = 'ASC_WIDTH'; + case ASC_WIDTH = 'ASC_WIDTH'; - public const DESC_WIDTH = 'DESC_WIDTH'; + case DESC_WIDTH = 'DESC_WIDTH'; - public const ASC_SIZE = 'ASC_SIZE'; + case ASC_SIZE = 'ASC_SIZE'; - public const DESC_SIZE = 'DESC_SIZE'; + case DESC_SIZE = 'DESC_SIZE'; - public const ASC_RELEVANCE = 'ASC_RELEVANCE'; + case ASC_RELEVANCE = 'ASC_RELEVANCE'; - public const DESC_RELEVANCE = 'DESC_RELEVANCE'; + case DESC_RELEVANCE = 'DESC_RELEVANCE'; } diff --git a/src/Assets/AssetListParams/Type.php b/src/Assets/AssetListParams/Type.php index 1fc3cce5..a4d41c10 100644 --- a/src/Assets/AssetListParams/Type.php +++ b/src/Assets/AssetListParams/Type.php @@ -4,9 +4,6 @@ namespace ImageKit\Assets\AssetListParams; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Filter results by asset type. * @@ -15,15 +12,13 @@ * - `folder` — returns only folders * - `all` — returns both files and folders (excludes `file-version`) */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const FILE = 'file'; + case FILE = 'file'; - public const FILE_VERSION = 'file-version'; + case FILE_VERSION = 'file-version'; - public const FOLDER = 'folder'; + case FOLDER = 'folder'; - public const ALL = 'all'; + case ALL = 'all'; } diff --git a/src/Beta/V2/Files/FileUploadParams.php b/src/Beta/V2/Files/FileUploadParams.php index d9c0c919..b59205d6 100644 --- a/src/Beta/V2/Files/FileUploadParams.php +++ b/src/Beta/V2/Files/FileUploadParams.php @@ -60,7 +60,7 @@ * overwriteCustomMetadata?: bool, * overwriteFile?: bool, * overwriteTags?: bool, - * responseFields?: list, + * responseFields?: list>, * tags?: list, * transformation?: Transformation, * useUniqueFileName?: bool, @@ -192,7 +192,7 @@ final class FileUploadParams implements BaseModel /** * Array of response field keys to include in the API response body. * - * @var list|null $responseFields + * @var list>|null $responseFields */ #[Api(list: ResponseField::class, optional: true)] public ?array $responseFields; @@ -263,7 +263,7 @@ public function __construct() * * @param array $customMetadata * @param list $extensions - * @param list $responseFields + * @param list> $responseFields * @param list $tags */ public static function with( @@ -306,7 +306,7 @@ public static function with( null !== $overwriteCustomMetadata && $obj->overwriteCustomMetadata = $overwriteCustomMetadata; null !== $overwriteFile && $obj->overwriteFile = $overwriteFile; null !== $overwriteTags && $obj->overwriteTags = $overwriteTags; - null !== $responseFields && $obj->responseFields = $responseFields; + null !== $responseFields && $obj->responseFields = array_map(fn ($v) => $v instanceof ResponseField ? $v->value : $v, $responseFields); null !== $tags && $obj->tags = $tags; null !== $transformation && $obj->transformation = $transformation; null !== $useUniqueFileName && $obj->useUniqueFileName = $useUniqueFileName; @@ -510,12 +510,12 @@ public function withOverwriteTags(bool $overwriteTags): self /** * Array of response field keys to include in the API response body. * - * @param list $responseFields + * @param list> $responseFields */ public function withResponseFields(array $responseFields): self { $obj = clone $this; - $obj->responseFields = $responseFields; + $obj->responseFields = array_map(fn ($v) => $v instanceof ResponseField ? $v->value : $v, $responseFields); return $obj; } diff --git a/src/Beta/V2/Files/FileUploadParams/ResponseField.php b/src/Beta/V2/Files/FileUploadParams/ResponseField.php index 19cd2bcd..acc888ab 100644 --- a/src/Beta/V2/Files/FileUploadParams/ResponseField.php +++ b/src/Beta/V2/Files/FileUploadParams/ResponseField.php @@ -4,24 +4,19 @@ namespace ImageKit\Beta\V2\Files\FileUploadParams; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class ResponseField implements ConverterSource +enum ResponseField: string { - use SdkEnum; - - public const TAGS = 'tags'; + case TAGS = 'tags'; - public const CUSTOM_COORDINATES = 'customCoordinates'; + case CUSTOM_COORDINATES = 'customCoordinates'; - public const IS_PRIVATE_FILE = 'isPrivateFile'; + case IS_PRIVATE_FILE = 'isPrivateFile'; - public const EMBEDDED_METADATA = 'embeddedMetadata'; + case EMBEDDED_METADATA = 'embeddedMetadata'; - public const IS_PUBLISHED = 'isPublished'; + case IS_PUBLISHED = 'isPublished'; - public const CUSTOM_METADATA = 'customMetadata'; + case CUSTOM_METADATA = 'customMetadata'; - public const METADATA = 'metadata'; + case METADATA = 'metadata'; } diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php index 5e1747c1..fe04123a 100644 --- a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs.php @@ -11,7 +11,7 @@ /** * @phpstan-type abs_alias = array{ - * protocol: Protocol::*, type: string, value: string + * protocol: value-of, type: string, value: string * } */ final class Abs implements BaseModel @@ -28,7 +28,7 @@ final class Abs implements BaseModel /** * Streaming protocol to use (`hls` or `dash`). * - * @var Protocol::* $protocol + * @var value-of $protocol */ #[Api(enum: Protocol::class)] public string $protocol; @@ -63,13 +63,13 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public static function with(string $protocol, string $value): self + public static function with(Protocol|string $protocol, string $value): self { $obj = new self; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; $obj->value = $value; return $obj; @@ -78,12 +78,12 @@ public static function with(string $protocol, string $value): self /** * Streaming protocol to use (`hls` or `dash`). * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public function withProtocol(string $protocol): self + public function withProtocol(Protocol|string $protocol): self { $obj = clone $this; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; return $obj; } diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php index 2220d490..a24c22af 100644 --- a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Beta\V2\Files\FileUploadParams\Transformation\Post\Abs; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Streaming protocol to use (`hls` or `dash`). */ -final class Protocol implements ConverterSource +enum Protocol: string { - use SdkEnum; - - public const HLS = 'hls'; + case HLS = 'hls'; - public const DASH = 'dash'; + case DASH = 'dash'; } diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php index 84aa7475..bad49098 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: AIAutoDescription::*|null, - * awsAutoTagging?: AwsAutoTagging::*|null, - * googleAutoTagging?: GoogleAutoTagging::*|null, - * removeBg?: RemoveBg::*|null, + * aiAutoDescription?: value-of|null, + * awsAutoTagging?: value-of|null, + * googleAutoTagging?: value-of|null, + * removeBg?: value-of|null, * } */ final class ExtensionStatus implements BaseModel @@ -33,19 +33,19 @@ final class ExtensionStatus implements BaseModel /** @use SdkModel */ use SdkModel; - /** @var AIAutoDescription::*|null $aiAutoDescription */ + /** @var value-of|null $aiAutoDescription */ #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] public ?string $aiAutoDescription; - /** @var AwsAutoTagging::*|null $awsAutoTagging */ + /** @var value-of|null $awsAutoTagging */ #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] public ?string $awsAutoTagging; - /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + /** @var value-of|null $googleAutoTagging */ #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] public ?string $googleAutoTagging; - /** @var RemoveBg::*|null $removeBg */ + /** @var value-of|null $removeBg */ #[Api('remove-bg', enum: RemoveBg::class, optional: true)] public ?string $removeBg; @@ -59,67 +59,70 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AIAutoDescription::* $aiAutoDescription - * @param AwsAutoTagging::* $awsAutoTagging - * @param GoogleAutoTagging::* $googleAutoTagging - * @param RemoveBg::* $removeBg + * @param AIAutoDescription|value-of $aiAutoDescription + * @param AwsAutoTagging|value-of $awsAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging + * @param RemoveBg|value-of $removeBg */ public static function with( - ?string $aiAutoDescription = null, - ?string $awsAutoTagging = null, - ?string $googleAutoTagging = null, - ?string $removeBg = null, + AIAutoDescription|string|null $aiAutoDescription = null, + AwsAutoTagging|string|null $awsAutoTagging = null, + GoogleAutoTagging|string|null $googleAutoTagging = null, + RemoveBg|string|null $removeBg = null, ): self { $obj = new self; - null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; - null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; - null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; - null !== $removeBg && $obj->removeBg = $removeBg; + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } /** - * @param AIAutoDescription::* $aiAutoDescription + * @param AIAutoDescription|value-of $aiAutoDescription */ - public function withAIAutoDescription(string $aiAutoDescription): self - { + public function withAIAutoDescription( + AIAutoDescription|string $aiAutoDescription + ): self { $obj = clone $this; - $obj->aiAutoDescription = $aiAutoDescription; + $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; return $obj; } /** - * @param AwsAutoTagging::* $awsAutoTagging + * @param AwsAutoTagging|value-of $awsAutoTagging */ - public function withAwsAutoTagging(string $awsAutoTagging): self - { + public function withAwsAutoTagging( + AwsAutoTagging|string $awsAutoTagging + ): self { $obj = clone $this; - $obj->awsAutoTagging = $awsAutoTagging; + $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; return $obj; } /** - * @param GoogleAutoTagging::* $googleAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging */ - public function withGoogleAutoTagging(string $googleAutoTagging): self - { + public function withGoogleAutoTagging( + GoogleAutoTagging|string $googleAutoTagging + ): self { $obj = clone $this; - $obj->googleAutoTagging = $googleAutoTagging; + $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; return $obj; } /** - * @param RemoveBg::* $removeBg + * @param RemoveBg|value-of $removeBg */ - public function withRemoveBg(string $removeBg): self + public function withRemoveBg(RemoveBg|string $removeBg): self { $obj = clone $this; - $obj->removeBg = $removeBg; + $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php index c1579539..c38a0dcf 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php @@ -4,16 +4,11 @@ namespace ImageKit\Beta\V2\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AIAutoDescription implements ConverterSource +enum AIAutoDescription: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php index f912c9d7..ac0ff91d 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Beta\V2\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AwsAutoTagging implements ConverterSource +enum AwsAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php index 7a2b9aa7..740091fe 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Beta\V2\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class GoogleAutoTagging implements ConverterSource +enum GoogleAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php index 5eda5fb5..5b1468d3 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php @@ -4,16 +4,11 @@ namespace ImageKit\Beta\V2\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class RemoveBg implements ConverterSource +enum RemoveBg: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Cache/Invalidation/InvalidationGetResponse.php b/src/Cache/Invalidation/InvalidationGetResponse.php index 8a114e35..7b60dad2 100644 --- a/src/Cache/Invalidation/InvalidationGetResponse.php +++ b/src/Cache/Invalidation/InvalidationGetResponse.php @@ -10,7 +10,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type invalidation_get_response = array{status?: Status::*|null} + * @phpstan-type invalidation_get_response = array{status?: value-of|null} */ final class InvalidationGetResponse implements BaseModel { @@ -20,7 +20,7 @@ final class InvalidationGetResponse implements BaseModel /** * Status of the purge request. * - * @var Status::*|null $status + * @var value-of|null $status */ #[Api(enum: Status::class, optional: true)] public ?string $status; @@ -35,13 +35,13 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Status::* $status + * @param Status|value-of $status */ - public static function with(?string $status = null): self + public static function with(Status|string|null $status = null): self { $obj = new self; - null !== $status && $obj->status = $status; + null !== $status && $obj->status = $status instanceof Status ? $status->value : $status; return $obj; } @@ -49,12 +49,12 @@ public static function with(?string $status = null): self /** * Status of the purge request. * - * @param Status::* $status + * @param Status|value-of $status */ - public function withStatus(string $status): self + public function withStatus(Status|string $status): self { $obj = clone $this; - $obj->status = $status; + $obj->status = $status instanceof Status ? $status->value : $status; return $obj; } diff --git a/src/Cache/Invalidation/InvalidationGetResponse/Status.php b/src/Cache/Invalidation/InvalidationGetResponse/Status.php index d446c2de..3b72a61a 100644 --- a/src/Cache/Invalidation/InvalidationGetResponse/Status.php +++ b/src/Cache/Invalidation/InvalidationGetResponse/Status.php @@ -4,17 +4,12 @@ namespace ImageKit\Cache\Invalidation\InvalidationGetResponse; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Status of the purge request. */ -final class Status implements ConverterSource +enum Status: string { - use SdkEnum; - - public const PENDING = 'Pending'; + case PENDING = 'Pending'; - public const COMPLETED = 'Completed'; + case COMPLETED = 'Completed'; } diff --git a/src/Core/Attributes/Api.php b/src/Core/Attributes/Api.php index b5a02264..8a1e3e0f 100644 --- a/src/Core/Attributes/Api.php +++ b/src/Core/Attributes/Api.php @@ -6,6 +6,7 @@ use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Core\Conversion\EnumOf; use ImageKit\Core\Conversion\ListOf; use ImageKit\Core\Conversion\MapOf; @@ -15,14 +16,15 @@ #[\Attribute(\Attribute::TARGET_PROPERTY)] final class Api { - /** - * @var class-string|Converter|string|null - */ + /** @var class-string|Converter|string|null */ public readonly Converter|string|null $type; + /** @var array */ + private static array $enumConverters = []; + /** * @param class-string|Converter|string|null $type - * @param class-string|Converter|null $enum + * @param class-string<\BackedEnum>|Converter|null $enum * @param class-string|Converter|null $union * @param class-string|Converter|string|null $list * @param class-string|Converter|string|null $map @@ -37,6 +39,28 @@ public function __construct( public readonly bool $nullable = false, public readonly bool $optional = false, ) { - $this->type = $type ?? $enum ?? $union ?? ($list ? new ListOf($list) : ($map ? new MapOf($map) : null)); + $type ??= $union; + if (null !== $list) { + $type ??= new ListOf($list); + } + if (null !== $map) { + $type ??= new MapOf($map); + } + if (null !== $enum) { + $type ??= $enum instanceof Converter ? $enum : $this->getEnumConverter($enum); + } + + $this->type = $type; + } + + /** @property class-string<\BackedEnum> $enum */ + private function getEnumConverter(string $enum): Converter + { + if (!isset(self::$enumConverters[$enum])) { + $converter = new EnumOf(array_column($enum::cases(), 'value')); // @phpstan-ignore-line + self::$enumConverters[$enum] = $converter; + } + + return self::$enumConverters[$enum]; } } diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema.php b/src/CustomMetadataFields/CustomMetadataField/Schema.php index c1f7bead..b3d6b0f4 100644 --- a/src/CustomMetadataFields/CustomMetadataField/Schema.php +++ b/src/CustomMetadataFields/CustomMetadataField/Schema.php @@ -15,7 +15,7 @@ * An object that describes the rules for the custom metadata field value. * * @phpstan-type schema_alias = array{ - * type: Type::*, + * type: value-of, * defaultValue?: string|float|bool|null|list, * isValueRequired?: bool|null, * maxLength?: float|null, @@ -33,7 +33,7 @@ final class Schema implements BaseModel /** * Type of the custom metadata field. * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -108,12 +108,12 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type * @param string|float|bool|list $defaultValue * @param list $selectOptions */ public static function with( - string $type, + Type|string $type, string|float|bool|array|null $defaultValue = null, ?bool $isValueRequired = null, ?float $maxLength = null, @@ -124,7 +124,7 @@ public static function with( ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; null !== $defaultValue && $obj->defaultValue = $defaultValue; null !== $isValueRequired && $obj->isValueRequired = $isValueRequired; @@ -140,12 +140,12 @@ public static function with( /** * Type of the custom metadata field. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php b/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php index 2e567bd1..3c5e1691 100644 --- a/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php +++ b/src/CustomMetadataFields/CustomMetadataField/Schema/Type.php @@ -4,27 +4,22 @@ namespace ImageKit\CustomMetadataFields\CustomMetadataField\Schema; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the custom metadata field. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const TEXT = 'Text'; + case TEXT = 'Text'; - public const TEXTAREA = 'Textarea'; + case TEXTAREA = 'Textarea'; - public const NUMBER = 'Number'; + case NUMBER = 'Number'; - public const DATE = 'Date'; + case DATE = 'Date'; - public const BOOLEAN = 'Boolean'; + case BOOLEAN = 'Boolean'; - public const SINGLE_SELECT = 'SingleSelect'; + case SINGLE_SELECT = 'SingleSelect'; - public const MULTI_SELECT = 'MultiSelect'; + case MULTI_SELECT = 'MultiSelect'; } diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php index 397ec2bb..1bd8911f 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php @@ -13,7 +13,7 @@ /** * @phpstan-type schema_alias = array{ - * type: Type::*, + * type: value-of, * defaultValue?: string|float|bool|null|list, * isValueRequired?: bool|null, * maxLength?: float|null, @@ -31,7 +31,7 @@ final class Schema implements BaseModel /** * Type of the custom metadata field. * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -106,12 +106,12 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type * @param string|float|bool|list $defaultValue * @param list $selectOptions */ public static function with( - string $type, + Type|string $type, string|float|bool|array|null $defaultValue = null, ?bool $isValueRequired = null, ?float $maxLength = null, @@ -122,7 +122,7 @@ public static function with( ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; null !== $defaultValue && $obj->defaultValue = $defaultValue; null !== $isValueRequired && $obj->isValueRequired = $isValueRequired; @@ -138,12 +138,12 @@ public static function with( /** * Type of the custom metadata field. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php index 048a6f6e..9918b486 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema/Type.php @@ -4,27 +4,22 @@ namespace ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the custom metadata field. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const TEXT = 'Text'; + case TEXT = 'Text'; - public const TEXTAREA = 'Textarea'; + case TEXTAREA = 'Textarea'; - public const NUMBER = 'Number'; + case NUMBER = 'Number'; - public const DATE = 'Date'; + case DATE = 'Date'; - public const BOOLEAN = 'Boolean'; + case BOOLEAN = 'Boolean'; - public const SINGLE_SELECT = 'SingleSelect'; + case SINGLE_SELECT = 'SingleSelect'; - public const MULTI_SELECT = 'MultiSelect'; + case MULTI_SELECT = 'MultiSelect'; } diff --git a/src/ExtensionItem/AutoTaggingExtension.php b/src/ExtensionItem/AutoTaggingExtension.php index 262f220b..d8547ca0 100644 --- a/src/ExtensionItem/AutoTaggingExtension.php +++ b/src/ExtensionItem/AutoTaggingExtension.php @@ -11,7 +11,7 @@ /** * @phpstan-type auto_tagging_extension = array{ - * maxTags: int, minConfidence: int, name: Name::* + * maxTags: int, minConfidence: int, name: value-of * } */ final class AutoTaggingExtension implements BaseModel @@ -34,7 +34,7 @@ final class AutoTaggingExtension implements BaseModel /** * Specifies the auto-tagging extension used. * - * @var Name::* $name + * @var value-of $name */ #[Api(enum: Name::class)] public string $name; @@ -66,18 +66,18 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Name::* $name + * @param Name|value-of $name */ public static function with( int $maxTags, int $minConfidence, - string $name + Name|string $name ): self { $obj = new self; $obj->maxTags = $maxTags; $obj->minConfidence = $minConfidence; - $obj->name = $name; + $obj->name = $name instanceof Name ? $name->value : $name; return $obj; } @@ -107,12 +107,12 @@ public function withMinConfidence(int $minConfidence): self /** * Specifies the auto-tagging extension used. * - * @param Name::* $name + * @param Name|value-of $name */ - public function withName(string $name): self + public function withName(Name|string $name): self { $obj = clone $this; - $obj->name = $name; + $obj->name = $name instanceof Name ? $name->value : $name; return $obj; } diff --git a/src/ExtensionItem/AutoTaggingExtension/Name.php b/src/ExtensionItem/AutoTaggingExtension/Name.php index 7289da91..853dc5ad 100644 --- a/src/ExtensionItem/AutoTaggingExtension/Name.php +++ b/src/ExtensionItem/AutoTaggingExtension/Name.php @@ -4,17 +4,12 @@ namespace ImageKit\ExtensionItem\AutoTaggingExtension; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Specifies the auto-tagging extension used. */ -final class Name implements ConverterSource +enum Name: string { - use SdkEnum; - - public const GOOGLE_AUTO_TAGGING = 'google-auto-tagging'; + case GOOGLE_AUTO_TAGGING = 'google-auto-tagging'; - public const AWS_AUTO_TAGGING = 'aws-auto-tagging'; + case AWS_AUTO_TAGGING = 'aws-auto-tagging'; } diff --git a/src/Files/File.php b/src/Files/File.php index b2b612a5..9acd3c95 100644 --- a/src/Files/File.php +++ b/src/Files/File.php @@ -32,7 +32,7 @@ * size?: float|null, * tags?: list|null, * thumbnail?: string|null, - * type?: Type::*|null, + * type?: value-of|null, * updatedAt?: \DateTimeInterface|null, * url?: string|null, * versionInfo?: VersionInfo|null, @@ -155,7 +155,7 @@ final class File implements BaseModel /** * Type of the asset. * - * @var Type::*|null $type + * @var value-of|null $type */ #[Api(enum: Type::class, optional: true)] public ?string $type; @@ -197,7 +197,7 @@ public function __construct() * @param list|null $aiTags * @param array $customMetadata * @param list|null $tags - * @param Type::* $type + * @param Type|value-of $type */ public static function with( ?array $aiTags = null, @@ -217,7 +217,7 @@ public static function with( ?float $size = null, ?array $tags = null, ?string $thumbnail = null, - ?string $type = null, + Type|string|null $type = null, ?\DateTimeInterface $updatedAt = null, ?string $url = null, ?VersionInfo $versionInfo = null, @@ -242,7 +242,7 @@ public static function with( null !== $size && $obj->size = $size; null !== $tags && $obj->tags = $tags; null !== $thumbnail && $obj->thumbnail = $thumbnail; - null !== $type && $obj->type = $type; + null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; null !== $updatedAt && $obj->updatedAt = $updatedAt; null !== $url && $obj->url = $url; null !== $versionInfo && $obj->versionInfo = $versionInfo; @@ -447,12 +447,12 @@ public function withThumbnail(string $thumbnail): self /** * Type of the asset. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Files/File/Type.php b/src/Files/File/Type.php index 8d6f266a..5c97f13f 100644 --- a/src/Files/File/Type.php +++ b/src/Files/File/Type.php @@ -4,17 +4,12 @@ namespace ImageKit\Files\File; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the asset. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const FILE = 'file'; + case FILE = 'file'; - public const FILE_VERSION = 'file-version'; + case FILE_VERSION = 'file-version'; } diff --git a/src/Files/FileUpdateResponse/ExtensionStatus.php b/src/Files/FileUpdateResponse/ExtensionStatus.php index e9a8ebfb..918ed884 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus.php @@ -14,10 +14,10 @@ /** * @phpstan-type extension_status = array{ - * aiAutoDescription?: AIAutoDescription::*|null, - * awsAutoTagging?: AwsAutoTagging::*|null, - * googleAutoTagging?: GoogleAutoTagging::*|null, - * removeBg?: RemoveBg::*|null, + * aiAutoDescription?: value-of|null, + * awsAutoTagging?: value-of|null, + * googleAutoTagging?: value-of|null, + * removeBg?: value-of|null, * } */ final class ExtensionStatus implements BaseModel @@ -25,19 +25,19 @@ final class ExtensionStatus implements BaseModel /** @use SdkModel */ use SdkModel; - /** @var AIAutoDescription::*|null $aiAutoDescription */ + /** @var value-of|null $aiAutoDescription */ #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] public ?string $aiAutoDescription; - /** @var AwsAutoTagging::*|null $awsAutoTagging */ + /** @var value-of|null $awsAutoTagging */ #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] public ?string $awsAutoTagging; - /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + /** @var value-of|null $googleAutoTagging */ #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] public ?string $googleAutoTagging; - /** @var RemoveBg::*|null $removeBg */ + /** @var value-of|null $removeBg */ #[Api('remove-bg', enum: RemoveBg::class, optional: true)] public ?string $removeBg; @@ -51,67 +51,70 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AIAutoDescription::* $aiAutoDescription - * @param AwsAutoTagging::* $awsAutoTagging - * @param GoogleAutoTagging::* $googleAutoTagging - * @param RemoveBg::* $removeBg + * @param AIAutoDescription|value-of $aiAutoDescription + * @param AwsAutoTagging|value-of $awsAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging + * @param RemoveBg|value-of $removeBg */ public static function with( - ?string $aiAutoDescription = null, - ?string $awsAutoTagging = null, - ?string $googleAutoTagging = null, - ?string $removeBg = null, + AIAutoDescription|string|null $aiAutoDescription = null, + AwsAutoTagging|string|null $awsAutoTagging = null, + GoogleAutoTagging|string|null $googleAutoTagging = null, + RemoveBg|string|null $removeBg = null, ): self { $obj = new self; - null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; - null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; - null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; - null !== $removeBg && $obj->removeBg = $removeBg; + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } /** - * @param AIAutoDescription::* $aiAutoDescription + * @param AIAutoDescription|value-of $aiAutoDescription */ - public function withAIAutoDescription(string $aiAutoDescription): self - { + public function withAIAutoDescription( + AIAutoDescription|string $aiAutoDescription + ): self { $obj = clone $this; - $obj->aiAutoDescription = $aiAutoDescription; + $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; return $obj; } /** - * @param AwsAutoTagging::* $awsAutoTagging + * @param AwsAutoTagging|value-of $awsAutoTagging */ - public function withAwsAutoTagging(string $awsAutoTagging): self - { + public function withAwsAutoTagging( + AwsAutoTagging|string $awsAutoTagging + ): self { $obj = clone $this; - $obj->awsAutoTagging = $awsAutoTagging; + $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; return $obj; } /** - * @param GoogleAutoTagging::* $googleAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging */ - public function withGoogleAutoTagging(string $googleAutoTagging): self - { + public function withGoogleAutoTagging( + GoogleAutoTagging|string $googleAutoTagging + ): self { $obj = clone $this; - $obj->googleAutoTagging = $googleAutoTagging; + $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; return $obj; } /** - * @param RemoveBg::* $removeBg + * @param RemoveBg|value-of $removeBg */ - public function withRemoveBg(string $removeBg): self + public function withRemoveBg(RemoveBg|string $removeBg): self { $obj = clone $this; - $obj->removeBg = $removeBg; + $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } diff --git a/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php b/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php index 984373de..ae67f332 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus/AIAutoDescription.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUpdateResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AIAutoDescription implements ConverterSource +enum AIAutoDescription: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUpdateResponse/ExtensionStatus/AwsAutoTagging.php b/src/Files/FileUpdateResponse/ExtensionStatus/AwsAutoTagging.php index 5e2975be..0dba4e7e 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus/AwsAutoTagging.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus/AwsAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUpdateResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AwsAutoTagging implements ConverterSource +enum AwsAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUpdateResponse/ExtensionStatus/GoogleAutoTagging.php b/src/Files/FileUpdateResponse/ExtensionStatus/GoogleAutoTagging.php index 4ac56446..8613623f 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus/GoogleAutoTagging.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus/GoogleAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUpdateResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class GoogleAutoTagging implements ConverterSource +enum GoogleAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUpdateResponse/ExtensionStatus/RemoveBg.php b/src/Files/FileUpdateResponse/ExtensionStatus/RemoveBg.php index 17a37c38..db5b4275 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus/RemoveBg.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus/RemoveBg.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUpdateResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class RemoveBg implements ConverterSource +enum RemoveBg: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUploadParams.php b/src/Files/FileUploadParams.php index ddbf55fe..cc8b80b1 100644 --- a/src/Files/FileUploadParams.php +++ b/src/Files/FileUploadParams.php @@ -62,7 +62,7 @@ * overwriteFile?: bool, * overwriteTags?: bool, * publicKey?: string, - * responseFields?: list, + * responseFields?: list>, * signature?: string, * tags?: list, * transformation?: Transformation, @@ -217,7 +217,7 @@ final class FileUploadParams implements BaseModel /** * Array of response field keys to include in the API response body. * - * @var list|null $responseFields + * @var list>|null $responseFields */ #[Api(list: ResponseField::class, optional: true)] public ?array $responseFields; @@ -296,7 +296,7 @@ public function __construct() * * @param array $customMetadata * @param list $extensions - * @param list $responseFields + * @param list> $responseFields * @param list $tags */ public static function with( @@ -344,7 +344,7 @@ public static function with( null !== $overwriteFile && $obj->overwriteFile = $overwriteFile; null !== $overwriteTags && $obj->overwriteTags = $overwriteTags; null !== $publicKey && $obj->publicKey = $publicKey; - null !== $responseFields && $obj->responseFields = $responseFields; + null !== $responseFields && $obj->responseFields = array_map(fn ($v) => $v instanceof ResponseField ? $v->value : $v, $responseFields); null !== $signature && $obj->signature = $signature; null !== $tags && $obj->tags = $tags; null !== $transformation && $obj->transformation = $transformation; @@ -581,12 +581,12 @@ public function withPublicKey(string $publicKey): self /** * Array of response field keys to include in the API response body. * - * @param list $responseFields + * @param list> $responseFields */ public function withResponseFields(array $responseFields): self { $obj = clone $this; - $obj->responseFields = $responseFields; + $obj->responseFields = array_map(fn ($v) => $v instanceof ResponseField ? $v->value : $v, $responseFields); return $obj; } diff --git a/src/Files/FileUploadParams/ResponseField.php b/src/Files/FileUploadParams/ResponseField.php index dc6a9aa7..60d5dda6 100644 --- a/src/Files/FileUploadParams/ResponseField.php +++ b/src/Files/FileUploadParams/ResponseField.php @@ -4,24 +4,19 @@ namespace ImageKit\Files\FileUploadParams; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class ResponseField implements ConverterSource +enum ResponseField: string { - use SdkEnum; - - public const TAGS = 'tags'; + case TAGS = 'tags'; - public const CUSTOM_COORDINATES = 'customCoordinates'; + case CUSTOM_COORDINATES = 'customCoordinates'; - public const IS_PRIVATE_FILE = 'isPrivateFile'; + case IS_PRIVATE_FILE = 'isPrivateFile'; - public const EMBEDDED_METADATA = 'embeddedMetadata'; + case EMBEDDED_METADATA = 'embeddedMetadata'; - public const IS_PUBLISHED = 'isPublished'; + case IS_PUBLISHED = 'isPublished'; - public const CUSTOM_METADATA = 'customMetadata'; + case CUSTOM_METADATA = 'customMetadata'; - public const METADATA = 'metadata'; + case METADATA = 'metadata'; } diff --git a/src/Files/FileUploadParams/Transformation/Post/Abs.php b/src/Files/FileUploadParams/Transformation/Post/Abs.php index 0bdb263e..21671f92 100644 --- a/src/Files/FileUploadParams/Transformation/Post/Abs.php +++ b/src/Files/FileUploadParams/Transformation/Post/Abs.php @@ -11,7 +11,7 @@ /** * @phpstan-type abs_alias = array{ - * protocol: Protocol::*, type: string, value: string + * protocol: value-of, type: string, value: string * } */ final class Abs implements BaseModel @@ -28,7 +28,7 @@ final class Abs implements BaseModel /** * Streaming protocol to use (`hls` or `dash`). * - * @var Protocol::* $protocol + * @var value-of $protocol */ #[Api(enum: Protocol::class)] public string $protocol; @@ -63,13 +63,13 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public static function with(string $protocol, string $value): self + public static function with(Protocol|string $protocol, string $value): self { $obj = new self; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; $obj->value = $value; return $obj; @@ -78,12 +78,12 @@ public static function with(string $protocol, string $value): self /** * Streaming protocol to use (`hls` or `dash`). * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public function withProtocol(string $protocol): self + public function withProtocol(Protocol|string $protocol): self { $obj = clone $this; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; return $obj; } diff --git a/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php b/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php index a31642c3..bbf2208f 100644 --- a/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php +++ b/src/Files/FileUploadParams/Transformation/Post/Abs/Protocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Files\FileUploadParams\Transformation\Post\Abs; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Streaming protocol to use (`hls` or `dash`). */ -final class Protocol implements ConverterSource +enum Protocol: string { - use SdkEnum; - - public const HLS = 'hls'; + case HLS = 'hls'; - public const DASH = 'dash'; + case DASH = 'dash'; } diff --git a/src/Files/FileUploadResponse/ExtensionStatus.php b/src/Files/FileUploadResponse/ExtensionStatus.php index 1b0abced..498b1b07 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus.php +++ b/src/Files/FileUploadResponse/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: AIAutoDescription::*|null, - * awsAutoTagging?: AwsAutoTagging::*|null, - * googleAutoTagging?: GoogleAutoTagging::*|null, - * removeBg?: RemoveBg::*|null, + * aiAutoDescription?: value-of|null, + * awsAutoTagging?: value-of|null, + * googleAutoTagging?: value-of|null, + * removeBg?: value-of|null, * } */ final class ExtensionStatus implements BaseModel @@ -33,19 +33,19 @@ final class ExtensionStatus implements BaseModel /** @use SdkModel */ use SdkModel; - /** @var AIAutoDescription::*|null $aiAutoDescription */ + /** @var value-of|null $aiAutoDescription */ #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] public ?string $aiAutoDescription; - /** @var AwsAutoTagging::*|null $awsAutoTagging */ + /** @var value-of|null $awsAutoTagging */ #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] public ?string $awsAutoTagging; - /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + /** @var value-of|null $googleAutoTagging */ #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] public ?string $googleAutoTagging; - /** @var RemoveBg::*|null $removeBg */ + /** @var value-of|null $removeBg */ #[Api('remove-bg', enum: RemoveBg::class, optional: true)] public ?string $removeBg; @@ -59,67 +59,70 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AIAutoDescription::* $aiAutoDescription - * @param AwsAutoTagging::* $awsAutoTagging - * @param GoogleAutoTagging::* $googleAutoTagging - * @param RemoveBg::* $removeBg + * @param AIAutoDescription|value-of $aiAutoDescription + * @param AwsAutoTagging|value-of $awsAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging + * @param RemoveBg|value-of $removeBg */ public static function with( - ?string $aiAutoDescription = null, - ?string $awsAutoTagging = null, - ?string $googleAutoTagging = null, - ?string $removeBg = null, + AIAutoDescription|string|null $aiAutoDescription = null, + AwsAutoTagging|string|null $awsAutoTagging = null, + GoogleAutoTagging|string|null $googleAutoTagging = null, + RemoveBg|string|null $removeBg = null, ): self { $obj = new self; - null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; - null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; - null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; - null !== $removeBg && $obj->removeBg = $removeBg; + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } /** - * @param AIAutoDescription::* $aiAutoDescription + * @param AIAutoDescription|value-of $aiAutoDescription */ - public function withAIAutoDescription(string $aiAutoDescription): self - { + public function withAIAutoDescription( + AIAutoDescription|string $aiAutoDescription + ): self { $obj = clone $this; - $obj->aiAutoDescription = $aiAutoDescription; + $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; return $obj; } /** - * @param AwsAutoTagging::* $awsAutoTagging + * @param AwsAutoTagging|value-of $awsAutoTagging */ - public function withAwsAutoTagging(string $awsAutoTagging): self - { + public function withAwsAutoTagging( + AwsAutoTagging|string $awsAutoTagging + ): self { $obj = clone $this; - $obj->awsAutoTagging = $awsAutoTagging; + $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; return $obj; } /** - * @param GoogleAutoTagging::* $googleAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging */ - public function withGoogleAutoTagging(string $googleAutoTagging): self - { + public function withGoogleAutoTagging( + GoogleAutoTagging|string $googleAutoTagging + ): self { $obj = clone $this; - $obj->googleAutoTagging = $googleAutoTagging; + $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; return $obj; } /** - * @param RemoveBg::* $removeBg + * @param RemoveBg|value-of $removeBg */ - public function withRemoveBg(string $removeBg): self + public function withRemoveBg(RemoveBg|string $removeBg): self { $obj = clone $this; - $obj->removeBg = $removeBg; + $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } diff --git a/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php b/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php index ade7f05c..a12ba5f1 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php +++ b/src/Files/FileUploadResponse/ExtensionStatus/AIAutoDescription.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AIAutoDescription implements ConverterSource +enum AIAutoDescription: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php b/src/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php index 07b7bca9..06158e8a 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php +++ b/src/Files/FileUploadResponse/ExtensionStatus/AwsAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AwsAutoTagging implements ConverterSource +enum AwsAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php b/src/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php index 0b4605fe..5289a3cf 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php +++ b/src/Files/FileUploadResponse/ExtensionStatus/GoogleAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class GoogleAutoTagging implements ConverterSource +enum GoogleAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php b/src/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php index 1df505ee..2321fd44 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php +++ b/src/Files/FileUploadResponse/ExtensionStatus/RemoveBg.php @@ -4,16 +4,11 @@ namespace ImageKit\Files\FileUploadResponse\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class RemoveBg implements ConverterSource +enum RemoveBg: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Files/Folder.php b/src/Files/Folder.php index 5778cbeb..bc8e3e74 100644 --- a/src/Files/Folder.php +++ b/src/Files/Folder.php @@ -15,7 +15,7 @@ * folderID?: string|null, * folderPath?: string|null, * name?: string|null, - * type?: Type::*|null, + * type?: value-of|null, * updatedAt?: \DateTimeInterface|null, * } */ @@ -51,7 +51,7 @@ final class Folder implements BaseModel /** * Type of the asset. * - * @var Type::*|null $type + * @var value-of|null $type */ #[Api(enum: Type::class, optional: true)] public ?string $type; @@ -72,14 +72,14 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type */ public static function with( ?\DateTimeInterface $createdAt = null, ?string $folderID = null, ?string $folderPath = null, ?string $name = null, - ?string $type = null, + Type|string|null $type = null, ?\DateTimeInterface $updatedAt = null, ): self { $obj = new self; @@ -88,7 +88,7 @@ public static function with( null !== $folderID && $obj->folderID = $folderID; null !== $folderPath && $obj->folderPath = $folderPath; null !== $name && $obj->name = $name; - null !== $type && $obj->type = $type; + null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; null !== $updatedAt && $obj->updatedAt = $updatedAt; return $obj; @@ -141,12 +141,12 @@ public function withName(string $name): self /** * Type of the asset. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Files/Folder/Type.php b/src/Files/Folder/Type.php index 42c52ca4..91836374 100644 --- a/src/Files/Folder/Type.php +++ b/src/Files/Folder/Type.php @@ -4,15 +4,10 @@ namespace ImageKit\Files\Folder; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the asset. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const FOLDER = 'folder'; + case FOLDER = 'folder'; } diff --git a/src/Folders/Job/JobGetResponse.php b/src/Folders/Job/JobGetResponse.php index bf0953e6..5b84581e 100644 --- a/src/Folders/Job/JobGetResponse.php +++ b/src/Folders/Job/JobGetResponse.php @@ -14,8 +14,8 @@ * @phpstan-type job_get_response = array{ * jobID?: string|null, * purgeRequestID?: string|null, - * status?: Status::*|null, - * type?: Type::*|null, + * status?: value-of|null, + * type?: value-of|null, * } */ final class JobGetResponse implements BaseModel @@ -38,7 +38,7 @@ final class JobGetResponse implements BaseModel /** * Status of the bulk job. * - * @var Status::*|null $status + * @var value-of|null $status */ #[Api(enum: Status::class, optional: true)] public ?string $status; @@ -46,7 +46,7 @@ final class JobGetResponse implements BaseModel /** * Type of the bulk job. * - * @var Type::*|null $type + * @var value-of|null $type */ #[Api(enum: Type::class, optional: true)] public ?string $type; @@ -61,21 +61,21 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Status::* $status - * @param Type::* $type + * @param Status|value-of $status + * @param Type|value-of $type */ public static function with( ?string $jobID = null, ?string $purgeRequestID = null, - ?string $status = null, - ?string $type = null, + Status|string|null $status = null, + Type|string|null $type = null, ): self { $obj = new self; null !== $jobID && $obj->jobID = $jobID; null !== $purgeRequestID && $obj->purgeRequestID = $purgeRequestID; - null !== $status && $obj->status = $status; - null !== $type && $obj->type = $type; + null !== $status && $obj->status = $status instanceof Status ? $status->value : $status; + null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } @@ -105,12 +105,12 @@ public function withPurgeRequestID(string $purgeRequestID): self /** * Status of the bulk job. * - * @param Status::* $status + * @param Status|value-of $status */ - public function withStatus(string $status): self + public function withStatus(Status|string $status): self { $obj = clone $this; - $obj->status = $status; + $obj->status = $status instanceof Status ? $status->value : $status; return $obj; } @@ -118,12 +118,12 @@ public function withStatus(string $status): self /** * Type of the bulk job. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Folders/Job/JobGetResponse/Status.php b/src/Folders/Job/JobGetResponse/Status.php index 99b4b5f7..0d3bad1f 100644 --- a/src/Folders/Job/JobGetResponse/Status.php +++ b/src/Folders/Job/JobGetResponse/Status.php @@ -4,17 +4,12 @@ namespace ImageKit\Folders\Job\JobGetResponse; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Status of the bulk job. */ -final class Status implements ConverterSource +enum Status: string { - use SdkEnum; - - public const PENDING = 'Pending'; + case PENDING = 'Pending'; - public const COMPLETED = 'Completed'; + case COMPLETED = 'Completed'; } diff --git a/src/Folders/Job/JobGetResponse/Type.php b/src/Folders/Job/JobGetResponse/Type.php index 6659899d..d4b1bfa0 100644 --- a/src/Folders/Job/JobGetResponse/Type.php +++ b/src/Folders/Job/JobGetResponse/Type.php @@ -4,19 +4,14 @@ namespace ImageKit\Folders\Job\JobGetResponse; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the bulk job. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const COPY_FOLDER = 'COPY_FOLDER'; + case COPY_FOLDER = 'COPY_FOLDER'; - public const MOVE_FOLDER = 'MOVE_FOLDER'; + case MOVE_FOLDER = 'MOVE_FOLDER'; - public const RENAME_FOLDER = 'RENAME_FOLDER'; + case RENAME_FOLDER = 'RENAME_FOLDER'; } diff --git a/src/ImageOverlay.php b/src/ImageOverlay.php index ead19e1b..4ccf310f 100644 --- a/src/ImageOverlay.php +++ b/src/ImageOverlay.php @@ -13,7 +13,7 @@ * @phpstan-type image_overlay = array{ * input: string, * type: string, - * encoding?: Encoding::*|null, + * encoding?: value-of|null, * transformation?: list|null, * } */ @@ -37,7 +37,7 @@ final class ImageOverlay implements BaseModel * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @var Encoding::*|null $encoding + * @var value-of|null $encoding */ #[Api(enum: Encoding::class, optional: true)] public ?string $encoding; @@ -75,19 +75,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding * @param list $transformation */ public static function with( string $input, - ?string $encoding = null, - ?array $transformation = null + Encoding|string|null $encoding = null, + ?array $transformation = null, ): self { $obj = new self; $obj->input = $input; - null !== $encoding && $obj->encoding = $encoding; + null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; @@ -110,12 +110,12 @@ public function withInput(string $input): self * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding */ - public function withEncoding(string $encoding): self + public function withEncoding(Encoding|string $encoding): self { $obj = clone $this; - $obj->encoding = $encoding; + $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; return $obj; } diff --git a/src/ImageOverlay/Encoding.php b/src/ImageOverlay/Encoding.php index aad5a95d..5cfb190b 100644 --- a/src/ImageOverlay/Encoding.php +++ b/src/ImageOverlay/Encoding.php @@ -4,22 +4,17 @@ namespace ImageKit\ImageOverlay; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. * By default, the SDK determines the appropriate format automatically. * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. */ -final class Encoding implements ConverterSource +enum Encoding: string { - use SdkEnum; - - public const AUTO = 'auto'; + case AUTO = 'auto'; - public const PLAIN = 'plain'; + case PLAIN = 'plain'; - public const BASE64 = 'base64'; + case BASE64 = 'base64'; } diff --git a/src/OverlayPosition.php b/src/OverlayPosition.php index 41a18ad9..f93d46d2 100644 --- a/src/OverlayPosition.php +++ b/src/OverlayPosition.php @@ -11,7 +11,7 @@ /** * @phpstan-type overlay_position = array{ - * focus?: Focus::*|null, x?: float|string|null, y?: float|string|null + * focus?: value-of|null, x?: float|string|null, y?: float|string|null * } */ final class OverlayPosition implements BaseModel @@ -23,7 +23,7 @@ final class OverlayPosition implements BaseModel * Specifies the position of the overlay relative to the parent image or video. * Maps to `lfo` in the URL. * - * @var Focus::*|null $focus + * @var value-of|null $focus */ #[Api(enum: Focus::class, optional: true)] public ?string $focus; @@ -56,16 +56,16 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Focus::* $focus + * @param Focus|value-of $focus */ public static function with( - ?string $focus = null, + Focus|string|null $focus = null, float|string|null $x = null, float|string|null $y = null ): self { $obj = new self; - null !== $focus && $obj->focus = $focus; + null !== $focus && $obj->focus = $focus instanceof Focus ? $focus->value : $focus; null !== $x && $obj->x = $x; null !== $y && $obj->y = $y; @@ -76,12 +76,12 @@ public static function with( * Specifies the position of the overlay relative to the parent image or video. * Maps to `lfo` in the URL. * - * @param Focus::* $focus + * @param Focus|value-of $focus */ - public function withFocus(string $focus): self + public function withFocus(Focus|string $focus): self { $obj = clone $this; - $obj->focus = $focus; + $obj->focus = $focus instanceof Focus ? $focus->value : $focus; return $obj; } diff --git a/src/OverlayPosition/Focus.php b/src/OverlayPosition/Focus.php index 120f5ce8..fc41d92b 100644 --- a/src/OverlayPosition/Focus.php +++ b/src/OverlayPosition/Focus.php @@ -4,32 +4,27 @@ namespace ImageKit\OverlayPosition; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Specifies the position of the overlay relative to the parent image or video. * Maps to `lfo` in the URL. */ -final class Focus implements ConverterSource +enum Focus: string { - use SdkEnum; - - public const CENTER = 'center'; + case CENTER = 'center'; - public const TOP = 'top'; + case TOP = 'top'; - public const LEFT = 'left'; + case LEFT = 'left'; - public const BOTTOM = 'bottom'; + case BOTTOM = 'bottom'; - public const RIGHT = 'right'; + case RIGHT = 'right'; - public const TOP_LEFT = 'top_left'; + case TOP_LEFT = 'top_left'; - public const TOP_RIGHT = 'top_right'; + case TOP_RIGHT = 'top_right'; - public const BOTTOM_LEFT = 'bottom_left'; + case BOTTOM_LEFT = 'bottom_left'; - public const BOTTOM_RIGHT = 'bottom_right'; + case BOTTOM_RIGHT = 'bottom_right'; } diff --git a/src/ServiceContracts/AssetsContract.php b/src/ServiceContracts/AssetsContract.php index 413ad923..46d6c7d8 100644 --- a/src/ServiceContracts/AssetsContract.php +++ b/src/ServiceContracts/AssetsContract.php @@ -18,7 +18,7 @@ interface AssetsContract /** * @api * - * @param FileType::* $fileType Filter results by file type. + * @param FileType|value-of $fileType Filter results by file type. * * - `all` — include all file types * - `image` — include only image files @@ -38,8 +38,8 @@ interface AssetsContract * * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. * @param int $skip the number of results to skip before returning results - * @param Sort::* $sort sort the results by one of the supported fields in ascending or descending order - * @param Type::* $type Filter results by asset type. + * @param Sort|value-of $sort sort the results by one of the supported fields in ascending or descending order + * @param Type|value-of $type Filter results by asset type. * * - `file` — returns only files * - `file-version` — returns specific file versions diff --git a/src/ServiceContracts/Beta/V2/FilesContract.php b/src/ServiceContracts/Beta/V2/FilesContract.php index 4365eb28..ddb27113 100644 --- a/src/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/ServiceContracts/Beta/V2/FilesContract.php @@ -52,7 +52,7 @@ interface FilesContract * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed - * @param list $responseFields array of response field keys to include in the API response body + * @param list> $responseFields array of response field keys to include in the API response body * @param list $tags Set the tags while uploading the file. * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. * If this field is not specified and the file is overwritten, the existing tags will be removed. diff --git a/src/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php index b5d85db8..a63bca0e 100644 --- a/src/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -172,7 +172,7 @@ public function rename( * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed * @param string $publicKey Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. - * @param list $responseFields array of response field keys to include in the API response body + * @param list> $responseFields array of response field keys to include in the API response body * @param string $signature HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. * * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. diff --git a/src/Services/AssetsService.php b/src/Services/AssetsService.php index 8ae23f14..c065a8c9 100644 --- a/src/Services/AssetsService.php +++ b/src/Services/AssetsService.php @@ -30,7 +30,7 @@ public function __construct(private Client $client) {} * * This API can list all the uploaded files and folders in your ImageKit.io media library. In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and provide this generated string as the value of the `searchQuery`. * - * @param FileType::* $fileType Filter results by file type. + * @param FileType|value-of $fileType Filter results by file type. * * - `all` — include all file types * - `image` — include only image files @@ -50,8 +50,8 @@ public function __construct(private Client $client) {} * * [Learn more](/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries) from examples. * @param int $skip the number of results to skip before returning results - * @param Sort::* $sort sort the results by one of the supported fields in ascending or descending order - * @param Type::* $type Filter results by asset type. + * @param Sort|value-of $sort sort the results by one of the supported fields in ascending or descending order + * @param Type|value-of $type Filter results by asset type. * * - `file` — returns only files * - `file-version` — returns specific file versions diff --git a/src/Services/Beta/V2/FilesService.php b/src/Services/Beta/V2/FilesService.php index df9541c3..66e9c39a 100644 --- a/src/Services/Beta/V2/FilesService.php +++ b/src/Services/Beta/V2/FilesService.php @@ -75,7 +75,7 @@ public function __construct(private Client $client) {} * @param bool $overwriteCustomMetadata if the request does not have `customMetadata`, and a file already exists at the exact location, existing customMetadata will be removed * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed - * @param list $responseFields array of response field keys to include in the API response body + * @param list> $responseFields array of response field keys to include in the API response body * @param list $tags Set the tags while uploading the file. * Provide an array of tag strings (e.g. `["tag1", "tag2", "tag3"]`). The combined length of all tag characters must not exceed 500, and the `%` character is not allowed. * If this field is not specified and the file is overwritten, the existing tags will be removed. diff --git a/src/Services/FilesService.php b/src/Services/FilesService.php index 78da9fae..deaf7864 100644 --- a/src/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -334,7 +334,7 @@ public function rename( * @param bool $overwriteFile if `false` and `useUniqueFileName` is also `false`, and a file already exists at the exact location, upload API will return an error immediately * @param bool $overwriteTags if the request does not have `tags`, and a file already exists at the exact location, existing tags will be removed * @param string $publicKey Your ImageKit.io public key. This field is only required for authentication when uploading a file from the client side. - * @param list $responseFields array of response field keys to include in the API response body + * @param list> $responseFields array of response field keys to include in the API response body * @param string $signature HMAC-SHA1 digest of the token+expire using your ImageKit.io private API key as a key. Learn how to create a signature on the page below. This should be in lowercase. * * Signature must be calculated on the server-side. This field is only required for authentication when uploading a file from the client side. diff --git a/src/SrcOptions.php b/src/SrcOptions.php index 6513f4d1..8cc167f5 100644 --- a/src/SrcOptions.php +++ b/src/SrcOptions.php @@ -18,7 +18,7 @@ * queryParameters?: array|null, * signed?: bool|null, * transformation?: list|null, - * transformationPosition?: TransformationPosition::*|null, + * transformationPosition?: value-of|null, * } */ final class SrcOptions implements BaseModel @@ -85,7 +85,7 @@ final class SrcOptions implements BaseModel * If you want to add the transformation string in the path of the URL, set this to `path`. * Learn more in the [Transformations guide](https://imagekit.io/docs/transformations). * - * @var TransformationPosition::*|null $transformationPosition + * @var value-of|null $transformationPosition */ #[Api(enum: TransformationPosition::class, optional: true)] public ?string $transformationPosition; @@ -116,7 +116,7 @@ public function __construct() * * @param array $queryParameters * @param list $transformation - * @param TransformationPosition::* $transformationPosition + * @param TransformationPosition|value-of $transformationPosition */ public static function with( string $src, @@ -125,7 +125,7 @@ public static function with( ?array $queryParameters = null, ?bool $signed = null, ?array $transformation = null, - ?string $transformationPosition = null, + TransformationPosition|string|null $transformationPosition = null, ): self { $obj = new self; @@ -136,7 +136,7 @@ public static function with( null !== $queryParameters && $obj->queryParameters = $queryParameters; null !== $signed && $obj->signed = $signed; null !== $transformation && $obj->transformation = $transformation; - null !== $transformationPosition && $obj->transformationPosition = $transformationPosition; + null !== $transformationPosition && $obj->transformationPosition = $transformationPosition instanceof TransformationPosition ? $transformationPosition->value : $transformationPosition; return $obj; } @@ -230,13 +230,13 @@ public function withTransformation(array $transformation): self * If you want to add the transformation string in the path of the URL, set this to `path`. * Learn more in the [Transformations guide](https://imagekit.io/docs/transformations). * - * @param TransformationPosition::* $transformationPosition + * @param TransformationPosition|value-of $transformationPosition */ public function withTransformationPosition( - string $transformationPosition + TransformationPosition|string $transformationPosition ): self { $obj = clone $this; - $obj->transformationPosition = $transformationPosition; + $obj->transformationPosition = $transformationPosition instanceof TransformationPosition ? $transformationPosition->value : $transformationPosition; return $obj; } diff --git a/src/StreamingResolution.php b/src/StreamingResolution.php index 2b494e8b..bf501235 100644 --- a/src/StreamingResolution.php +++ b/src/StreamingResolution.php @@ -4,27 +4,22 @@ namespace ImageKit; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Available streaming resolutions for [adaptive bitrate streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). */ -final class StreamingResolution implements ConverterSource +enum StreamingResolution: string { - use SdkEnum; - - public const STREAMING_RESOLUTION_240 = '240'; + case STREAMING_RESOLUTION_240 = '240'; - public const STREAMING_RESOLUTION_360 = '360'; + case STREAMING_RESOLUTION_360 = '360'; - public const STREAMING_RESOLUTION_480 = '480'; + case STREAMING_RESOLUTION_480 = '480'; - public const STREAMING_RESOLUTION_720 = '720'; + case STREAMING_RESOLUTION_720 = '720'; - public const STREAMING_RESOLUTION_1080 = '1080'; + case STREAMING_RESOLUTION_1080 = '1080'; - public const STREAMING_RESOLUTION_1440 = '1440'; + case STREAMING_RESOLUTION_1440 = '1440'; - public const STREAMING_RESOLUTION_2160 = '2160'; + case STREAMING_RESOLUTION_2160 = '2160'; } diff --git a/src/SubtitleOverlay.php b/src/SubtitleOverlay.php index 18bcc1df..03537f39 100644 --- a/src/SubtitleOverlay.php +++ b/src/SubtitleOverlay.php @@ -13,7 +13,7 @@ * @phpstan-type subtitle_overlay = array{ * input: string, * type: string, - * encoding?: Encoding::*|null, + * encoding?: value-of|null, * transformation?: list|null, * } */ @@ -37,7 +37,7 @@ final class SubtitleOverlay implements BaseModel * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @var Encoding::*|null $encoding + * @var value-of|null $encoding */ #[Api(enum: Encoding::class, optional: true)] public ?string $encoding; @@ -74,19 +74,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding * @param list $transformation */ public static function with( string $input, - ?string $encoding = null, - ?array $transformation = null + Encoding|string|null $encoding = null, + ?array $transformation = null, ): self { $obj = new self; $obj->input = $input; - null !== $encoding && $obj->encoding = $encoding; + null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; @@ -109,12 +109,12 @@ public function withInput(string $input): self * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding */ - public function withEncoding(string $encoding): self + public function withEncoding(Encoding|string $encoding): self { $obj = clone $this; - $obj->encoding = $encoding; + $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; return $obj; } diff --git a/src/SubtitleOverlay/Encoding.php b/src/SubtitleOverlay/Encoding.php index fef7e323..fb012d60 100644 --- a/src/SubtitleOverlay/Encoding.php +++ b/src/SubtitleOverlay/Encoding.php @@ -4,22 +4,17 @@ namespace ImageKit\SubtitleOverlay; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. * By default, the SDK determines the appropriate format automatically. * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. */ -final class Encoding implements ConverterSource +enum Encoding: string { - use SdkEnum; - - public const AUTO = 'auto'; + case AUTO = 'auto'; - public const PLAIN = 'plain'; + case PLAIN = 'plain'; - public const BASE64 = 'base64'; + case BASE64 = 'base64'; } diff --git a/src/SubtitleOverlayTransformation.php b/src/SubtitleOverlayTransformation.php index 0a5e0cd9..94ed6c23 100644 --- a/src/SubtitleOverlayTransformation.php +++ b/src/SubtitleOverlayTransformation.php @@ -19,7 +19,7 @@ * fontOutline?: string|null, * fontShadow?: string|null, * fontSize?: float|null, - * typography?: Typography::*|null, + * typography?: value-of|null, * } */ final class SubtitleOverlayTransformation implements BaseModel @@ -82,7 +82,7 @@ final class SubtitleOverlayTransformation implements BaseModel * * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) * - * @var Typography::*|null $typography + * @var value-of|null $typography */ #[Api(enum: Typography::class, optional: true)] public ?string $typography; @@ -97,7 +97,7 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Typography::* $typography + * @param Typography|value-of $typography */ public static function with( ?string $background = null, @@ -106,7 +106,7 @@ public static function with( ?string $fontOutline = null, ?string $fontShadow = null, ?float $fontSize = null, - ?string $typography = null, + Typography|string|null $typography = null, ): self { $obj = new self; @@ -116,7 +116,7 @@ public static function with( null !== $fontOutline && $obj->fontOutline = $fontOutline; null !== $fontShadow && $obj->fontShadow = $fontShadow; null !== $fontSize && $obj->fontSize = $fontSize; - null !== $typography && $obj->typography = $typography; + null !== $typography && $obj->typography = $typography instanceof Typography ? $typography->value : $typography; return $obj; } @@ -206,12 +206,12 @@ public function withFontSize(float $fontSize): self * * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) * - * @param Typography::* $typography + * @param Typography|value-of $typography */ - public function withTypography(string $typography): self + public function withTypography(Typography|string $typography): self { $obj = clone $this; - $obj->typography = $typography; + $obj->typography = $typography instanceof Typography ? $typography->value : $typography; return $obj; } diff --git a/src/SubtitleOverlayTransformation/Typography.php b/src/SubtitleOverlayTransformation/Typography.php index e5a94c37..da7d956d 100644 --- a/src/SubtitleOverlayTransformation/Typography.php +++ b/src/SubtitleOverlayTransformation/Typography.php @@ -4,21 +4,16 @@ namespace ImageKit\SubtitleOverlayTransformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Sets the typography style of the subtitle text. Supports values are `b` for bold, `i` for italics, and `b_i` for bold with italics. * * [Subtitle styling options](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) */ -final class Typography implements ConverterSource +enum Typography: string { - use SdkEnum; - - public const B = 'b'; + case B = 'b'; - public const I = 'i'; + case I = 'i'; - public const B_I = 'b_i'; + case B_I = 'b_i'; } diff --git a/src/TextOverlay.php b/src/TextOverlay.php index da021bb1..24072937 100644 --- a/src/TextOverlay.php +++ b/src/TextOverlay.php @@ -13,7 +13,7 @@ * @phpstan-type text_overlay = array{ * text: string, * type: string, - * encoding?: Encoding::*|null, + * encoding?: value-of|null, * transformation?: list|null, * } */ @@ -37,7 +37,7 @@ final class TextOverlay implements BaseModel * To always use base64 (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @var Encoding::*|null $encoding + * @var value-of|null $encoding */ #[Api(enum: Encoding::class, optional: true)] public ?string $encoding; @@ -74,19 +74,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding * @param list $transformation */ public static function with( string $text, - ?string $encoding = null, + Encoding|string|null $encoding = null, ?array $transformation = null ): self { $obj = new self; $obj->text = $text; - null !== $encoding && $obj->encoding = $encoding; + null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; @@ -109,12 +109,12 @@ public function withText(string $text): self * To always use base64 (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding */ - public function withEncoding(string $encoding): self + public function withEncoding(Encoding|string $encoding): self { $obj = clone $this; - $obj->encoding = $encoding; + $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; return $obj; } diff --git a/src/TextOverlay/Encoding.php b/src/TextOverlay/Encoding.php index 9b23bed7..4daa16ef 100644 --- a/src/TextOverlay/Encoding.php +++ b/src/TextOverlay/Encoding.php @@ -4,22 +4,17 @@ namespace ImageKit\TextOverlay; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Text can be included in the layer as either `i-{input}` (plain text) or `ie-{base64_encoded_input}` (base64). * By default, the SDK selects the appropriate format based on the input text. * To always use base64 (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. */ -final class Encoding implements ConverterSource +enum Encoding: string { - use SdkEnum; - - public const AUTO = 'auto'; + case AUTO = 'auto'; - public const PLAIN = 'plain'; + case PLAIN = 'plain'; - public const BASE64 = 'base64'; + case BASE64 = 'base64'; } diff --git a/src/TextOverlayTransformation.php b/src/TextOverlayTransformation.php index 51b434dd..c38b2805 100644 --- a/src/TextOverlayTransformation.php +++ b/src/TextOverlayTransformation.php @@ -14,11 +14,11 @@ * @phpstan-type text_overlay_transformation = array{ * alpha?: float|null, * background?: string|null, - * flip?: Flip::*|null, + * flip?: value-of|null, * fontColor?: string|null, * fontFamily?: string|null, * fontSize?: float|string|null, - * innerAlignment?: InnerAlignment::*|null, + * innerAlignment?: value-of|null, * lineHeight?: float|string|null, * padding?: float|string|null, * radius?: float|string|null, @@ -48,7 +48,7 @@ final class TextOverlayTransformation implements BaseModel /** * Flip the text overlay horizontally, vertically, or both. * - * @var Flip::*|null $flip + * @var value-of|null $flip */ #[Api(enum: Flip::class, optional: true)] public ?string $flip; @@ -75,7 +75,7 @@ final class TextOverlayTransformation implements BaseModel /** * Specifies the inner alignment of the text when width is more than the text length. * - * @var InnerAlignment::*|null $innerAlignment + * @var value-of|null $innerAlignment */ #[Api(enum: InnerAlignment::class, optional: true)] public ?string $innerAlignment; @@ -135,17 +135,17 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Flip::* $flip - * @param InnerAlignment::* $innerAlignment + * @param Flip|value-of $flip + * @param InnerAlignment|value-of $innerAlignment */ public static function with( ?float $alpha = null, ?string $background = null, - ?string $flip = null, + Flip|string|null $flip = null, ?string $fontColor = null, ?string $fontFamily = null, float|string|null $fontSize = null, - ?string $innerAlignment = null, + InnerAlignment|string|null $innerAlignment = null, float|string|null $lineHeight = null, float|string|null $padding = null, float|string|null $radius = null, @@ -157,11 +157,11 @@ public static function with( null !== $alpha && $obj->alpha = $alpha; null !== $background && $obj->background = $background; - null !== $flip && $obj->flip = $flip; + null !== $flip && $obj->flip = $flip instanceof Flip ? $flip->value : $flip; null !== $fontColor && $obj->fontColor = $fontColor; null !== $fontFamily && $obj->fontFamily = $fontFamily; null !== $fontSize && $obj->fontSize = $fontSize; - null !== $innerAlignment && $obj->innerAlignment = $innerAlignment; + null !== $innerAlignment && $obj->innerAlignment = $innerAlignment instanceof InnerAlignment ? $innerAlignment->value : $innerAlignment; null !== $lineHeight && $obj->lineHeight = $lineHeight; null !== $padding && $obj->padding = $padding; null !== $radius && $obj->radius = $radius; @@ -198,12 +198,12 @@ public function withBackground(string $background): self /** * Flip the text overlay horizontally, vertically, or both. * - * @param Flip::* $flip + * @param Flip|value-of $flip */ - public function withFlip(string $flip): self + public function withFlip(Flip|string $flip): self { $obj = clone $this; - $obj->flip = $flip; + $obj->flip = $flip instanceof Flip ? $flip->value : $flip; return $obj; } @@ -245,12 +245,13 @@ public function withFontSize(float|string $fontSize): self /** * Specifies the inner alignment of the text when width is more than the text length. * - * @param InnerAlignment::* $innerAlignment + * @param InnerAlignment|value-of $innerAlignment */ - public function withInnerAlignment(string $innerAlignment): self - { + public function withInnerAlignment( + InnerAlignment|string $innerAlignment + ): self { $obj = clone $this; - $obj->innerAlignment = $innerAlignment; + $obj->innerAlignment = $innerAlignment instanceof InnerAlignment ? $innerAlignment->value : $innerAlignment; return $obj; } diff --git a/src/TextOverlayTransformation/Flip.php b/src/TextOverlayTransformation/Flip.php index f51373b3..45d99626 100644 --- a/src/TextOverlayTransformation/Flip.php +++ b/src/TextOverlayTransformation/Flip.php @@ -4,21 +4,16 @@ namespace ImageKit\TextOverlayTransformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Flip the text overlay horizontally, vertically, or both. */ -final class Flip implements ConverterSource +enum Flip: string { - use SdkEnum; - - public const H = 'h'; + case H = 'h'; - public const V = 'v'; + case V = 'v'; - public const H_V = 'h_v'; + case H_V = 'h_v'; - public const V_H = 'v_h'; + case V_H = 'v_h'; } diff --git a/src/TextOverlayTransformation/InnerAlignment.php b/src/TextOverlayTransformation/InnerAlignment.php index 885e71a4..e38cc502 100644 --- a/src/TextOverlayTransformation/InnerAlignment.php +++ b/src/TextOverlayTransformation/InnerAlignment.php @@ -4,19 +4,14 @@ namespace ImageKit\TextOverlayTransformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Specifies the inner alignment of the text when width is more than the text length. */ -final class InnerAlignment implements ConverterSource +enum InnerAlignment: string { - use SdkEnum; - - public const LEFT = 'left'; + case LEFT = 'left'; - public const RIGHT = 'right'; + case RIGHT = 'right'; - public const CENTER = 'center'; + case CENTER = 'center'; } diff --git a/src/Transformation.php b/src/Transformation.php index 86d77e87..cf555c31 100644 --- a/src/Transformation.php +++ b/src/Transformation.php @@ -7,18 +7,11 @@ use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Contracts\BaseModel; -use ImageKit\Transformation\AIRemoveBackground; -use ImageKit\Transformation\AIRemoveBackgroundExternal; -use ImageKit\Transformation\AIRetouch; -use ImageKit\Transformation\AIUpscale; -use ImageKit\Transformation\AIVariation; use ImageKit\Transformation\AudioCodec; -use ImageKit\Transformation\ContrastStretch; use ImageKit\Transformation\Crop; use ImageKit\Transformation\CropMode; use ImageKit\Transformation\Flip; use ImageKit\Transformation\Format; -use ImageKit\Transformation\Grayscale; use ImageKit\Transformation\VideoCodec; /** @@ -31,29 +24,29 @@ * aiChangeBackground?: string|null, * aiDropShadow?: bool|string|null, * aiEdit?: string|null, - * aiRemoveBackground?: AIRemoveBackground::*|null, - * aiRemoveBackgroundExternal?: AIRemoveBackgroundExternal::*|null, - * aiRetouch?: AIRetouch::*|null, - * aiUpscale?: AIUpscale::*|null, - * aiVariation?: AIVariation::*|null, + * aiRemoveBackground?: bool|null, + * aiRemoveBackgroundExternal?: bool|null, + * aiRetouch?: bool|null, + * aiUpscale?: bool|null, + * aiVariation?: bool|null, * aspectRatio?: float|string|null, - * audioCodec?: AudioCodec::*|null, + * audioCodec?: value-of|null, * background?: string|null, * blur?: float|null, * border?: string|null, * colorProfile?: bool|null, - * contrastStretch?: ContrastStretch::*|null, - * crop?: Crop::*|null, - * cropMode?: CropMode::*|null, + * contrastStretch?: bool|null, + * crop?: value-of|null, + * cropMode?: value-of|null, * defaultImage?: string|null, * dpr?: float|null, * duration?: float|string|null, * endOffset?: float|string|null, - * flip?: Flip::*|null, + * flip?: value-of|null, * focus?: string|null, - * format?: Format::*|null, + * format?: value-of|null, * gradient?: bool|string|null, - * grayscale?: Grayscale::*|null, + * grayscale?: bool|null, * height?: float|string|null, * lossless?: bool|null, * metadata?: bool|null, @@ -70,10 +63,10 @@ * shadow?: bool|string|null, * sharpen?: bool|float|null, * startOffset?: float|string|null, - * streamingResolutions?: list|null, + * streamingResolutions?: list>|null, * trim?: bool|float|null, * unsharpMask?: bool|string|null, - * videoCodec?: VideoCodec::*|null, + * videoCodec?: value-of|null, * width?: float|string|null, * x?: float|string|null, * xCenter?: float|string|null, @@ -119,10 +112,8 @@ final class Transformation implements BaseModel * Applies ImageKit's in-house background removal. * Supported inside overlay. * See [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). - * - * @var AIRemoveBackground::*|null $aiRemoveBackground */ - #[Api(enum: AIRemoveBackground::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_AIRemoveBackground::class, optional: true)] public ?bool $aiRemoveBackground; /** @@ -130,38 +121,33 @@ final class Transformation implements BaseModel * Note: It is recommended to use aiRemoveBackground, ImageKit's in-house solution, which is more cost-effective. * Supported inside overlay. * See [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). - * - * @var AIRemoveBackgroundExternal::*|null $aiRemoveBackgroundExternal */ - #[Api(enum: AIRemoveBackgroundExternal::class, optional: true)] + #[Api( + enum: STAINLESS_FIXME_AIRemoveBackgroundExternal::class, + optional: true + )] public ?bool $aiRemoveBackgroundExternal; /** * Performs AI-based retouching to improve faces or product shots. Not supported inside overlay. * See [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). - * - * @var AIRetouch::*|null $aiRetouch */ - #[Api(enum: AIRetouch::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_AIRetouch::class, optional: true)] public ?bool $aiRetouch; /** * Upscales images beyond their original dimensions using AI. Not supported inside overlay. * See [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). - * - * @var AIUpscale::*|null $aiUpscale */ - #[Api(enum: AIUpscale::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_AIUpscale::class, optional: true)] public ?bool $aiUpscale; /** * Generates a variation of an image using AI. This produces a new image with slight variations from the original, * such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay. * See [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). - * - * @var AIVariation::*|null $aiVariation */ - #[Api(enum: AIVariation::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_AIVariation::class, optional: true)] public ?bool $aiVariation; /** @@ -175,7 +161,7 @@ final class Transformation implements BaseModel /** * Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). * - * @var AudioCodec::*|null $audioCodec + * @var value-of|null $audioCodec */ #[Api(enum: AudioCodec::class, optional: true)] public ?string $audioCodec; @@ -215,16 +201,14 @@ final class Transformation implements BaseModel /** * Automatically enhances the contrast of an image (contrast stretch). * See [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). - * - * @var ContrastStretch::*|null $contrastStretch */ - #[Api(enum: ContrastStretch::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_ContrastStretch::class, optional: true)] public ?bool $contrastStretch; /** * Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). * - * @var Crop::*|null $crop + * @var value-of|null $crop */ #[Api(enum: Crop::class, optional: true)] public ?string $crop; @@ -232,7 +216,7 @@ final class Transformation implements BaseModel /** * Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). * - * @var CropMode::*|null $cropMode + * @var value-of|null $cropMode */ #[Api(enum: CropMode::class, optional: true)] public ?string $cropMode; @@ -272,7 +256,7 @@ final class Transformation implements BaseModel * Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. * See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). * - * @var Flip::*|null $flip + * @var value-of|null $flip */ #[Api(enum: Flip::class, optional: true)] public ?string $flip; @@ -294,7 +278,7 @@ final class Transformation implements BaseModel * ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. * See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f). * - * @var Format::*|null $format + * @var value-of|null $format */ #[Api(enum: Format::class, optional: true)] public ?string $format; @@ -308,10 +292,8 @@ final class Transformation implements BaseModel /** * Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). - * - * @var Grayscale::*|null $grayscale */ - #[Api(enum: Grayscale::class, optional: true)] + #[Api(enum: STAINLESS_FIXME_Grayscale::class, optional: true)] public ?bool $grayscale; /** @@ -441,7 +423,7 @@ final class Transformation implements BaseModel * An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. * See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). * - * @var list|null $streamingResolutions + * @var list>|null $streamingResolutions */ #[Api(list: StreamingResolution::class, optional: true)] public ?array $streamingResolutions; @@ -465,7 +447,7 @@ final class Transformation implements BaseModel /** * Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). * - * @var VideoCodec::*|null $videoCodec + * @var value-of|null $videoCodec */ #[Api(enum: VideoCodec::class, optional: true)] public ?string $videoCodec; @@ -520,20 +502,13 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AIRemoveBackground::* $aiRemoveBackground - * @param AIRemoveBackgroundExternal::* $aiRemoveBackgroundExternal - * @param AIRetouch::* $aiRetouch - * @param AIUpscale::* $aiUpscale - * @param AIVariation::* $aiVariation - * @param AudioCodec::* $audioCodec - * @param ContrastStretch::* $contrastStretch - * @param Crop::* $crop - * @param CropMode::* $cropMode - * @param Flip::* $flip - * @param Format::* $format - * @param Grayscale::* $grayscale - * @param list $streamingResolutions - * @param VideoCodec::* $videoCodec + * @param AudioCodec|value-of $audioCodec + * @param Crop|value-of $crop + * @param CropMode|value-of $cropMode + * @param Flip|value-of $flip + * @param Format|value-of $format + * @param list> $streamingResolutions + * @param VideoCodec|value-of $videoCodec */ public static function with( ?string $aiChangeBackground = null, @@ -545,21 +520,21 @@ public static function with( ?bool $aiUpscale = null, ?bool $aiVariation = null, float|string|null $aspectRatio = null, - ?string $audioCodec = null, + AudioCodec|string|null $audioCodec = null, ?string $background = null, ?float $blur = null, ?string $border = null, ?bool $colorProfile = null, ?bool $contrastStretch = null, - ?string $crop = null, - ?string $cropMode = null, + Crop|string|null $crop = null, + CropMode|string|null $cropMode = null, ?string $defaultImage = null, ?float $dpr = null, float|string|null $duration = null, float|string|null $endOffset = null, - ?string $flip = null, + Flip|string|null $flip = null, ?string $focus = null, - ?string $format = null, + Format|string|null $format = null, bool|string|null $gradient = null, ?bool $grayscale = null, float|string|null $height = null, @@ -581,7 +556,7 @@ public static function with( ?array $streamingResolutions = null, bool|float|null $trim = null, bool|string|null $unsharpMask = null, - ?string $videoCodec = null, + VideoCodec|string|null $videoCodec = null, float|string|null $width = null, float|string|null $x = null, float|string|null $xCenter = null, @@ -600,21 +575,21 @@ public static function with( null !== $aiUpscale && $obj->aiUpscale = $aiUpscale; null !== $aiVariation && $obj->aiVariation = $aiVariation; null !== $aspectRatio && $obj->aspectRatio = $aspectRatio; - null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $audioCodec && $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; null !== $background && $obj->background = $background; null !== $blur && $obj->blur = $blur; null !== $border && $obj->border = $border; null !== $colorProfile && $obj->colorProfile = $colorProfile; null !== $contrastStretch && $obj->contrastStretch = $contrastStretch; - null !== $crop && $obj->crop = $crop; - null !== $cropMode && $obj->cropMode = $cropMode; + null !== $crop && $obj->crop = $crop instanceof Crop ? $crop->value : $crop; + null !== $cropMode && $obj->cropMode = $cropMode instanceof CropMode ? $cropMode->value : $cropMode; null !== $defaultImage && $obj->defaultImage = $defaultImage; null !== $dpr && $obj->dpr = $dpr; null !== $duration && $obj->duration = $duration; null !== $endOffset && $obj->endOffset = $endOffset; - null !== $flip && $obj->flip = $flip; + null !== $flip && $obj->flip = $flip instanceof Flip ? $flip->value : $flip; null !== $focus && $obj->focus = $focus; - null !== $format && $obj->format = $format; + null !== $format && $obj->format = $format instanceof Format ? $format->value : $format; null !== $gradient && $obj->gradient = $gradient; null !== $grayscale && $obj->grayscale = $grayscale; null !== $height && $obj->height = $height; @@ -633,10 +608,10 @@ public static function with( null !== $shadow && $obj->shadow = $shadow; null !== $sharpen && $obj->sharpen = $sharpen; null !== $startOffset && $obj->startOffset = $startOffset; - null !== $streamingResolutions && $obj->streamingResolutions = $streamingResolutions; + null !== $streamingResolutions && $obj->streamingResolutions = array_map(fn ($v) => $v instanceof StreamingResolution ? $v->value : $v, $streamingResolutions); null !== $trim && $obj->trim = $trim; null !== $unsharpMask && $obj->unsharpMask = $unsharpMask; - null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $videoCodec && $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; null !== $width && $obj->width = $width; null !== $x && $obj->x = $x; null !== $xCenter && $obj->xCenter = $xCenter; @@ -694,8 +669,6 @@ public function withAIEdit(string $aiEdit): self * Applies ImageKit's in-house background removal. * Supported inside overlay. * See [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). - * - * @param AIRemoveBackground::* $aiRemoveBackground */ public function withAIRemoveBackground(bool $aiRemoveBackground): self { @@ -710,8 +683,6 @@ public function withAIRemoveBackground(bool $aiRemoveBackground): self * Note: It is recommended to use aiRemoveBackground, ImageKit's in-house solution, which is more cost-effective. * Supported inside overlay. * See [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). - * - * @param AIRemoveBackgroundExternal::* $aiRemoveBackgroundExternal */ public function withAIRemoveBackgroundExternal( bool $aiRemoveBackgroundExternal @@ -725,8 +696,6 @@ public function withAIRemoveBackgroundExternal( /** * Performs AI-based retouching to improve faces or product shots. Not supported inside overlay. * See [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). - * - * @param AIRetouch::* $aiRetouch */ public function withAIRetouch(bool $aiRetouch): self { @@ -739,8 +708,6 @@ public function withAIRetouch(bool $aiRetouch): self /** * Upscales images beyond their original dimensions using AI. Not supported inside overlay. * See [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). - * - * @param AIUpscale::* $aiUpscale */ public function withAIUpscale(bool $aiUpscale): self { @@ -754,8 +721,6 @@ public function withAIUpscale(bool $aiUpscale): self * Generates a variation of an image using AI. This produces a new image with slight variations from the original, * such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay. * See [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). - * - * @param AIVariation::* $aiVariation */ public function withAIVariation(bool $aiVariation): self { @@ -781,12 +746,12 @@ public function withAspectRatio(float|string $aspectRatio): self /** * Specifies the audio codec, e.g., `aac`, `opus`, or `none`. See [Audio codec](https://imagekit.io/docs/video-optimization#audio-codec---ac). * - * @param AudioCodec::* $audioCodec + * @param AudioCodec|value-of $audioCodec */ - public function withAudioCodec(string $audioCodec): self + public function withAudioCodec(AudioCodec|string $audioCodec): self { $obj = clone $this; - $obj->audioCodec = $audioCodec; + $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; return $obj; } @@ -846,8 +811,6 @@ public function withColorProfile(bool $colorProfile): self /** * Automatically enhances the contrast of an image (contrast stretch). * See [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). - * - * @param ContrastStretch::* $contrastStretch */ public function withContrastStretch(bool $contrastStretch): self { @@ -860,12 +823,12 @@ public function withContrastStretch(bool $contrastStretch): self /** * Crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). * - * @param Crop::* $crop + * @param Crop|value-of $crop */ - public function withCrop(string $crop): self + public function withCrop(Crop|string $crop): self { $obj = clone $this; - $obj->crop = $crop; + $obj->crop = $crop instanceof Crop ? $crop->value : $crop; return $obj; } @@ -873,12 +836,12 @@ public function withCrop(string $crop): self /** * Additional crop modes for image resizing. See [Crop modes & focus](https://imagekit.io/docs/image-resize-and-crop#crop-crop-modes--focus). * - * @param CropMode::* $cropMode + * @param CropMode|value-of $cropMode */ - public function withCropMode(string $cropMode): self + public function withCropMode(CropMode|string $cropMode): self { $obj = clone $this; - $obj->cropMode = $cropMode; + $obj->cropMode = $cropMode instanceof CropMode ? $cropMode->value : $cropMode; return $obj; } @@ -938,12 +901,12 @@ public function withEndOffset(float|string $endOffset): self * Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`. * See [Flip](https://imagekit.io/docs/effects-and-enhancements#flip---fl). * - * @param Flip::* $flip + * @param Flip|value-of $flip */ - public function withFlip(string $flip): self + public function withFlip(Flip|string $flip): self { $obj = clone $this; - $obj->flip = $flip; + $obj->flip = $flip instanceof Flip ? $flip->value : $flip; return $obj; } @@ -970,12 +933,12 @@ public function withFocus(string $focus): self * ImageKit automatically delivers images and videos in the optimal format based on device support unless overridden by the dashboard settings or the format parameter. * See [Image format](https://imagekit.io/docs/image-optimization#format---f) and [Video format](https://imagekit.io/docs/video-optimization#format---f). * - * @param Format::* $format + * @param Format|value-of $format */ - public function withFormat(string $format): self + public function withFormat(Format|string $format): self { $obj = clone $this; - $obj->format = $format; + $obj->format = $format instanceof Format ? $format->value : $format; return $obj; } @@ -994,8 +957,6 @@ public function withGradient(bool|string $gradient): self /** * Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). - * - * @param Grayscale::* $grayscale */ public function withGrayscale(bool $grayscale): self { @@ -1213,12 +1174,12 @@ public function withStartOffset(float|string $startOffset): self * An array of resolutions for adaptive bitrate streaming, e.g., [`240`, `360`, `480`, `720`, `1080`]. * See [Adaptive Bitrate Streaming](https://imagekit.io/docs/adaptive-bitrate-streaming). * - * @param list $streamingResolutions + * @param list> $streamingResolutions */ public function withStreamingResolutions(array $streamingResolutions): self { $obj = clone $this; - $obj->streamingResolutions = $streamingResolutions; + $obj->streamingResolutions = array_map(fn ($v) => $v instanceof StreamingResolution ? $v->value : $v, $streamingResolutions); return $obj; } @@ -1252,12 +1213,12 @@ public function withUnsharpMask(bool|string $unsharpMask): self /** * Specifies the video codec, e.g., `h264`, `vp9`, `av1`, or `none`. See [Video codec](https://imagekit.io/docs/video-optimization#video-codec---vc). * - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ - public function withVideoCodec(string $videoCodec): self + public function withVideoCodec(VideoCodec|string $videoCodec): self { $obj = clone $this; - $obj->videoCodec = $videoCodec; + $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } diff --git a/src/Transformation/AIRemoveBackground.php b/src/Transformation/AIRemoveBackground.php deleted file mode 100644 index d5375dd4..00000000 --- a/src/Transformation/AIRemoveBackground.php +++ /dev/null @@ -1,20 +0,0 @@ -|null, * transformation?: list|null, * } */ @@ -37,7 +37,7 @@ final class VideoOverlay implements BaseModel * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @var Encoding::*|null $encoding + * @var value-of|null $encoding */ #[Api(enum: Encoding::class, optional: true)] public ?string $encoding; @@ -75,19 +75,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding * @param list $transformation */ public static function with( string $input, - ?string $encoding = null, - ?array $transformation = null + Encoding|string|null $encoding = null, + ?array $transformation = null, ): self { $obj = new self; $obj->input = $input; - null !== $encoding && $obj->encoding = $encoding; + null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; @@ -110,12 +110,12 @@ public function withInput(string $input): self * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. * - * @param Encoding::* $encoding + * @param Encoding|value-of $encoding */ - public function withEncoding(string $encoding): self + public function withEncoding(Encoding|string $encoding): self { $obj = clone $this; - $obj->encoding = $encoding; + $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; return $obj; } diff --git a/src/VideoOverlay/Encoding.php b/src/VideoOverlay/Encoding.php index 1a789570..ab03972f 100644 --- a/src/VideoOverlay/Encoding.php +++ b/src/VideoOverlay/Encoding.php @@ -4,22 +4,17 @@ namespace ImageKit\VideoOverlay; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * The input path can be included in the layer as either `i-{input}` or `ie-{base64_encoded_input}`. * By default, the SDK determines the appropriate format automatically. * To always use base64 encoding (`ie-{base64}`), set this parameter to `base64`. * To always use plain text (`i-{input}`), set it to `plain`. */ -final class Encoding implements ConverterSource +enum Encoding: string { - use SdkEnum; - - public const AUTO = 'auto'; + case AUTO = 'auto'; - public const PLAIN = 'plain'; + case PLAIN = 'plain'; - public const BASE64 = 'base64'; + case BASE64 = 'base64'; } diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php index d527b693..ae9c6c78 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php @@ -12,7 +12,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: Type::*, protocol?: Protocol::*|null, value?: string|null + * type: value-of, protocol?: value-of|null, value?: string|null * } */ final class Transformation implements BaseModel @@ -23,7 +23,7 @@ final class Transformation implements BaseModel /** * Type of the requested post-transformation. * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -31,7 +31,7 @@ final class Transformation implements BaseModel /** * Only applicable if transformation type is 'abs'. Streaming protocol used. * - * @var Protocol::*|null $protocol + * @var value-of|null $protocol */ #[Api(enum: Protocol::class, optional: true)] public ?string $protocol; @@ -66,19 +66,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type - * @param Protocol::* $protocol + * @param Type|value-of $type + * @param Protocol|value-of $protocol */ public static function with( - string $type, - ?string $protocol = null, + Type|string $type, + Protocol|string|null $protocol = null, ?string $value = null ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; - null !== $protocol && $obj->protocol = $protocol; + null !== $protocol && $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; null !== $value && $obj->value = $value; return $obj; @@ -87,12 +87,12 @@ public static function with( /** * Type of the requested post-transformation. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } @@ -100,12 +100,12 @@ public function withType(string $type): self /** * Only applicable if transformation type is 'abs'. Streaming protocol used. * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public function withProtocol(string $protocol): self + public function withProtocol(Protocol|string $protocol): self { $obj = clone $this; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; return $obj; } diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php index d33fb754..f6f399cc 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Protocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\UploadPostTransformErrorEvent\Request\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Only applicable if transformation type is 'abs'. Streaming protocol used. */ -final class Protocol implements ConverterSource +enum Protocol: string { - use SdkEnum; - - public const HLS = 'hls'; + case HLS = 'hls'; - public const DASH = 'dash'; + case DASH = 'dash'; } diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Type.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Type.php index 6a8c8264..5a9dbbf8 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Type.php +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation/Type.php @@ -4,21 +4,16 @@ namespace ImageKit\Webhooks\UploadPostTransformErrorEvent\Request\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the requested post-transformation. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const TRANSFORMATION = 'transformation'; + case TRANSFORMATION = 'transformation'; - public const ABS = 'abs'; + case ABS = 'abs'; - public const GIF_TO_VIDEO = 'gif-to-video'; + case GIF_TO_VIDEO = 'gif-to-video'; - public const THUMBNAIL = 'thumbnail'; + case THUMBNAIL = 'thumbnail'; } diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php index ce16b5b9..f57cb838 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php @@ -12,7 +12,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: Type::*, protocol?: Protocol::*|null, value?: string|null + * type: value-of, protocol?: value-of|null, value?: string|null * } */ final class Transformation implements BaseModel @@ -23,7 +23,7 @@ final class Transformation implements BaseModel /** * Type of the requested post-transformation. * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -31,7 +31,7 @@ final class Transformation implements BaseModel /** * Only applicable if transformation type is 'abs'. Streaming protocol used. * - * @var Protocol::*|null $protocol + * @var value-of|null $protocol */ #[Api(enum: Protocol::class, optional: true)] public ?string $protocol; @@ -66,19 +66,19 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type - * @param Protocol::* $protocol + * @param Type|value-of $type + * @param Protocol|value-of $protocol */ public static function with( - string $type, - ?string $protocol = null, + Type|string $type, + Protocol|string|null $protocol = null, ?string $value = null ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; - null !== $protocol && $obj->protocol = $protocol; + null !== $protocol && $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; null !== $value && $obj->value = $value; return $obj; @@ -87,12 +87,12 @@ public static function with( /** * Type of the requested post-transformation. * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } @@ -100,12 +100,12 @@ public function withType(string $type): self /** * Only applicable if transformation type is 'abs'. Streaming protocol used. * - * @param Protocol::* $protocol + * @param Protocol|value-of $protocol */ - public function withProtocol(string $protocol): self + public function withProtocol(Protocol|string $protocol): self { $obj = clone $this; - $obj->protocol = $protocol; + $obj->protocol = $protocol instanceof Protocol ? $protocol->value : $protocol; return $obj; } diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php index 35a3c151..e9a8d491 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Protocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\UploadPostTransformSuccessEvent\Request\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Only applicable if transformation type is 'abs'. Streaming protocol used. */ -final class Protocol implements ConverterSource +enum Protocol: string { - use SdkEnum; - - public const HLS = 'hls'; + case HLS = 'hls'; - public const DASH = 'dash'; + case DASH = 'dash'; } diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Type.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Type.php index 91f2951b..9b9fa624 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Type.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation/Type.php @@ -4,21 +4,16 @@ namespace ImageKit\Webhooks\UploadPostTransformSuccessEvent\Request\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of the requested post-transformation. */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const TRANSFORMATION = 'transformation'; + case TRANSFORMATION = 'transformation'; - public const ABS = 'abs'; + case ABS = 'abs'; - public const GIF_TO_VIDEO = 'gif-to-video'; + case GIF_TO_VIDEO = 'gif-to-video'; - public const THUMBNAIL = 'thumbnail'; + case THUMBNAIL = 'thumbnail'; } diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php index 66ec9040..8cd45604 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: AIAutoDescription::*|null, - * awsAutoTagging?: AwsAutoTagging::*|null, - * googleAutoTagging?: GoogleAutoTagging::*|null, - * removeBg?: RemoveBg::*|null, + * aiAutoDescription?: value-of|null, + * awsAutoTagging?: value-of|null, + * googleAutoTagging?: value-of|null, + * removeBg?: value-of|null, * } */ final class ExtensionStatus implements BaseModel @@ -33,19 +33,19 @@ final class ExtensionStatus implements BaseModel /** @use SdkModel */ use SdkModel; - /** @var AIAutoDescription::*|null $aiAutoDescription */ + /** @var value-of|null $aiAutoDescription */ #[Api('ai-auto-description', enum: AIAutoDescription::class, optional: true)] public ?string $aiAutoDescription; - /** @var AwsAutoTagging::*|null $awsAutoTagging */ + /** @var value-of|null $awsAutoTagging */ #[Api('aws-auto-tagging', enum: AwsAutoTagging::class, optional: true)] public ?string $awsAutoTagging; - /** @var GoogleAutoTagging::*|null $googleAutoTagging */ + /** @var value-of|null $googleAutoTagging */ #[Api('google-auto-tagging', enum: GoogleAutoTagging::class, optional: true)] public ?string $googleAutoTagging; - /** @var RemoveBg::*|null $removeBg */ + /** @var value-of|null $removeBg */ #[Api('remove-bg', enum: RemoveBg::class, optional: true)] public ?string $removeBg; @@ -59,67 +59,70 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AIAutoDescription::* $aiAutoDescription - * @param AwsAutoTagging::* $awsAutoTagging - * @param GoogleAutoTagging::* $googleAutoTagging - * @param RemoveBg::* $removeBg + * @param AIAutoDescription|value-of $aiAutoDescription + * @param AwsAutoTagging|value-of $awsAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging + * @param RemoveBg|value-of $removeBg */ public static function with( - ?string $aiAutoDescription = null, - ?string $awsAutoTagging = null, - ?string $googleAutoTagging = null, - ?string $removeBg = null, + AIAutoDescription|string|null $aiAutoDescription = null, + AwsAutoTagging|string|null $awsAutoTagging = null, + GoogleAutoTagging|string|null $googleAutoTagging = null, + RemoveBg|string|null $removeBg = null, ): self { $obj = new self; - null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription; - null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging; - null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging; - null !== $removeBg && $obj->removeBg = $removeBg; + null !== $aiAutoDescription && $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; + null !== $awsAutoTagging && $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; + null !== $googleAutoTagging && $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; + null !== $removeBg && $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } /** - * @param AIAutoDescription::* $aiAutoDescription + * @param AIAutoDescription|value-of $aiAutoDescription */ - public function withAIAutoDescription(string $aiAutoDescription): self - { + public function withAIAutoDescription( + AIAutoDescription|string $aiAutoDescription + ): self { $obj = clone $this; - $obj->aiAutoDescription = $aiAutoDescription; + $obj->aiAutoDescription = $aiAutoDescription instanceof AIAutoDescription ? $aiAutoDescription->value : $aiAutoDescription; return $obj; } /** - * @param AwsAutoTagging::* $awsAutoTagging + * @param AwsAutoTagging|value-of $awsAutoTagging */ - public function withAwsAutoTagging(string $awsAutoTagging): self - { + public function withAwsAutoTagging( + AwsAutoTagging|string $awsAutoTagging + ): self { $obj = clone $this; - $obj->awsAutoTagging = $awsAutoTagging; + $obj->awsAutoTagging = $awsAutoTagging instanceof AwsAutoTagging ? $awsAutoTagging->value : $awsAutoTagging; return $obj; } /** - * @param GoogleAutoTagging::* $googleAutoTagging + * @param GoogleAutoTagging|value-of $googleAutoTagging */ - public function withGoogleAutoTagging(string $googleAutoTagging): self - { + public function withGoogleAutoTagging( + GoogleAutoTagging|string $googleAutoTagging + ): self { $obj = clone $this; - $obj->googleAutoTagging = $googleAutoTagging; + $obj->googleAutoTagging = $googleAutoTagging instanceof GoogleAutoTagging ? $googleAutoTagging->value : $googleAutoTagging; return $obj; } /** - * @param RemoveBg::* $removeBg + * @param RemoveBg|value-of $removeBg */ - public function withRemoveBg(string $removeBg): self + public function withRemoveBg(RemoveBg|string $removeBg): self { $obj = clone $this; - $obj->removeBg = $removeBg; + $obj->removeBg = $removeBg instanceof RemoveBg ? $removeBg->value : $removeBg; return $obj; } diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php index ed95d763..a9cc5f07 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AIAutoDescription.php @@ -4,16 +4,11 @@ namespace ImageKit\Webhooks\UploadPreTransformSuccessEvent\Data\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AIAutoDescription implements ConverterSource +enum AIAutoDescription: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AwsAutoTagging.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AwsAutoTagging.php index 7b12b235..6ff57cec 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AwsAutoTagging.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/AwsAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Webhooks\UploadPreTransformSuccessEvent\Data\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class AwsAutoTagging implements ConverterSource +enum AwsAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/GoogleAutoTagging.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/GoogleAutoTagging.php index 9e210a3e..31f9d58b 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/GoogleAutoTagging.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/GoogleAutoTagging.php @@ -4,16 +4,11 @@ namespace ImageKit\Webhooks\UploadPreTransformSuccessEvent\Data\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class GoogleAutoTagging implements ConverterSource +enum GoogleAutoTagging: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/RemoveBg.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/RemoveBg.php index 7f184fd2..6e389314 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/RemoveBg.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus/RemoveBg.php @@ -4,16 +4,11 @@ namespace ImageKit\Webhooks\UploadPreTransformSuccessEvent\Data\ExtensionStatus; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - -final class RemoveBg implements ConverterSource +enum RemoveBg: string { - use SdkEnum; - - public const SUCCESS = 'success'; + case SUCCESS = 'success'; - public const PENDING = 'pending'; + case PENDING = 'pending'; - public const FAILED = 'failed'; + case FAILED = 'failed'; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php index cf837b26..3e0c84d3 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php @@ -14,7 +14,7 @@ * Base information about a video transformation request. * * @phpstan-type transformation_alias = array{ - * type: Type::*, options?: Options|null + * type: value-of, options?: Options|null * } */ final class Transformation implements BaseModel @@ -28,7 +28,7 @@ final class Transformation implements BaseModel * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -63,13 +63,15 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type */ - public static function with(string $type, ?Options $options = null): self - { + public static function with( + Type|string $type, + ?Options $options = null + ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; null !== $options && $obj->options = $options; @@ -82,12 +84,12 @@ public static function with(string $type, ?Options $options = null): self * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php index a0723d5b..fb68a78c 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: AudioCodec::*|null, + * audioCodec?: value-of|null, * autoRotate?: bool|null, - * format?: Format::*|null, + * format?: value-of|null, * quality?: int|null, - * streamProtocol?: StreamProtocol::*|null, + * streamProtocol?: value-of|null, * variants?: list|null, - * videoCodec?: VideoCodec::*|null, + * videoCodec?: value-of|null, * } */ final class Options implements BaseModel @@ -33,7 +33,7 @@ final class Options implements BaseModel /** * Audio codec used for encoding (aac or opus). * - * @var AudioCodec::*|null $audioCodec + * @var value-of|null $audioCodec */ #[Api('audio_codec', enum: AudioCodec::class, optional: true)] public ?string $audioCodec; @@ -47,7 +47,7 @@ final class Options implements BaseModel /** * Output format for the transformed video or thumbnail. * - * @var Format::*|null $format + * @var value-of|null $format */ #[Api(enum: Format::class, optional: true)] public ?string $format; @@ -61,7 +61,7 @@ final class Options implements BaseModel /** * Streaming protocol for adaptive bitrate streaming. * - * @var StreamProtocol::*|null $streamProtocol + * @var value-of|null $streamProtocol */ #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] public ?string $streamProtocol; @@ -77,7 +77,7 @@ final class Options implements BaseModel /** * Video codec used for encoding (h264, vp9, or av1). * - * @var VideoCodec::*|null $videoCodec + * @var value-of|null $videoCodec */ #[Api('video_codec', enum: VideoCodec::class, optional: true)] public ?string $videoCodec; @@ -92,30 +92,30 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AudioCodec::* $audioCodec - * @param Format::* $format - * @param StreamProtocol::* $streamProtocol + * @param AudioCodec|value-of $audioCodec + * @param Format|value-of $format + * @param StreamProtocol|value-of $streamProtocol * @param list $variants - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ public static function with( - ?string $audioCodec = null, + AudioCodec|string|null $audioCodec = null, ?bool $autoRotate = null, - ?string $format = null, + Format|string|null $format = null, ?int $quality = null, - ?string $streamProtocol = null, + StreamProtocol|string|null $streamProtocol = null, ?array $variants = null, - ?string $videoCodec = null, + VideoCodec|string|null $videoCodec = null, ): self { $obj = new self; - null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $audioCodec && $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; null !== $autoRotate && $obj->autoRotate = $autoRotate; - null !== $format && $obj->format = $format; + null !== $format && $obj->format = $format instanceof Format ? $format->value : $format; null !== $quality && $obj->quality = $quality; - null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; null !== $variants && $obj->variants = $variants; - null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $videoCodec && $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } @@ -123,12 +123,12 @@ public static function with( /** * Audio codec used for encoding (aac or opus). * - * @param AudioCodec::* $audioCodec + * @param AudioCodec|value-of $audioCodec */ - public function withAudioCodec(string $audioCodec): self + public function withAudioCodec(AudioCodec|string $audioCodec): self { $obj = clone $this; - $obj->audioCodec = $audioCodec; + $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; return $obj; } @@ -147,12 +147,12 @@ public function withAutoRotate(bool $autoRotate): self /** * Output format for the transformed video or thumbnail. * - * @param Format::* $format + * @param Format|value-of $format */ - public function withFormat(string $format): self + public function withFormat(Format|string $format): self { $obj = clone $this; - $obj->format = $format; + $obj->format = $format instanceof Format ? $format->value : $format; return $obj; } @@ -171,12 +171,13 @@ public function withQuality(int $quality): self /** * Streaming protocol for adaptive bitrate streaming. * - * @param StreamProtocol::* $streamProtocol + * @param StreamProtocol|value-of $streamProtocol */ - public function withStreamProtocol(string $streamProtocol): self - { + public function withStreamProtocol( + StreamProtocol|string $streamProtocol + ): self { $obj = clone $this; - $obj->streamProtocol = $streamProtocol; + $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; return $obj; } @@ -197,12 +198,12 @@ public function withVariants(array $variants): self /** * Video codec used for encoding (h264, vp9, or av1). * - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ - public function withVideoCodec(string $videoCodec): self + public function withVideoCodec(VideoCodec|string $videoCodec): self { $obj = clone $this; - $obj->videoCodec = $videoCodec; + $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php index 59206f99..e9034932 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/AudioCodec.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationAcceptedEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Audio codec used for encoding (aac or opus). */ -final class AudioCodec implements ConverterSource +enum AudioCodec: string { - use SdkEnum; - - public const AAC = 'aac'; + case AAC = 'aac'; - public const OPUS = 'opus'; + case OPUS = 'opus'; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/Format.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/Format.php index e240fe6d..46b26e0e 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/Format.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/Format.php @@ -4,23 +4,18 @@ namespace ImageKit\Webhooks\VideoTransformationAcceptedEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Output format for the transformed video or thumbnail. */ -final class Format implements ConverterSource +enum Format: string { - use SdkEnum; - - public const MP4 = 'mp4'; + case MP4 = 'mp4'; - public const WEBM = 'webm'; + case WEBM = 'webm'; - public const JPG = 'jpg'; + case JPG = 'jpg'; - public const PNG = 'png'; + case PNG = 'png'; - public const WEBP = 'webp'; + case WEBP = 'webp'; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/StreamProtocol.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/StreamProtocol.php index 52c3096d..c8b11edd 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/StreamProtocol.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/StreamProtocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationAcceptedEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Streaming protocol for adaptive bitrate streaming. */ -final class StreamProtocol implements ConverterSource +enum StreamProtocol: string { - use SdkEnum; - - public const HLS = 'HLS'; + case HLS = 'HLS'; - public const DASH = 'DASH'; + case DASH = 'DASH'; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/VideoCodec.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/VideoCodec.php index 637812d1..f2afe7bf 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/VideoCodec.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options/VideoCodec.php @@ -4,19 +4,14 @@ namespace ImageKit\Webhooks\VideoTransformationAcceptedEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Video codec used for encoding (h264, vp9, or av1). */ -final class VideoCodec implements ConverterSource +enum VideoCodec: string { - use SdkEnum; - - public const H264 = 'h264'; + case H264 = 'h264'; - public const VP9 = 'vp9'; + case VP9 = 'vp9'; - public const AV1 = 'av1'; + case AV1 = 'av1'; } diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Type.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Type.php index 79c11dfd..75f61460 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Type.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Type.php @@ -4,22 +4,17 @@ namespace ImageKit\Webhooks\VideoTransformationAcceptedEvent\Data\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of video transformation: * - `video-transformation`: Standard video processing (resize, format conversion, etc.) * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const VIDEO_TRANSFORMATION = 'video-transformation'; + case VIDEO_TRANSFORMATION = 'video-transformation'; - public const GIF_TO_VIDEO = 'gif-to-video'; + case GIF_TO_VIDEO = 'gif-to-video'; - public const VIDEO_THUMBNAIL = 'video-thumbnail'; + case VIDEO_THUMBNAIL = 'video-thumbnail'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php index 846bf6cf..f7b4c774 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php @@ -13,7 +13,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: Type::*, error?: Error|null, options?: Options|null + * type: value-of, error?: Error|null, options?: Options|null * } */ final class Transformation implements BaseModel @@ -27,7 +27,7 @@ final class Transformation implements BaseModel * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -68,16 +68,16 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type */ public static function with( - string $type, + Type|string $type, ?Error $error = null, ?Options $options = null ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; null !== $error && $obj->error = $error; null !== $options && $obj->options = $options; @@ -91,12 +91,12 @@ public static function with( * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php index c6d6c648..bbb07048 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error.php @@ -12,7 +12,7 @@ /** * Details about the transformation error. * - * @phpstan-type error_alias = array{reason: Reason::*} + * @phpstan-type error_alias = array{reason: value-of} */ final class Error implements BaseModel { @@ -25,7 +25,7 @@ final class Error implements BaseModel * - `download_failed`: Could not download source video * - `internal_server_error`: Unexpected server error * - * @var Reason::* $reason + * @var value-of $reason */ #[Api(enum: Reason::class)] public string $reason; @@ -54,13 +54,13 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Reason::* $reason + * @param Reason|value-of $reason */ - public static function with(string $reason): self + public static function with(Reason|string $reason): self { $obj = new self; - $obj->reason = $reason; + $obj->reason = $reason instanceof Reason ? $reason->value : $reason; return $obj; } @@ -71,12 +71,12 @@ public static function with(string $reason): self * - `download_failed`: Could not download source video * - `internal_server_error`: Unexpected server error * - * @param Reason::* $reason + * @param Reason|value-of $reason */ - public function withReason(string $reason): self + public function withReason(Reason|string $reason): self { $obj = clone $this; - $obj->reason = $reason; + $obj->reason = $reason instanceof Reason ? $reason->value : $reason; return $obj; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php index d5c1c151..751baa9f 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Error/Reason.php @@ -4,22 +4,17 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation\Error; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Specific reason for the transformation failure: * - `encoding_failed`: Error during video encoding process * - `download_failed`: Could not download source video * - `internal_server_error`: Unexpected server error */ -final class Reason implements ConverterSource +enum Reason: string { - use SdkEnum; - - public const ENCODING_FAILED = 'encoding_failed'; + case ENCODING_FAILED = 'encoding_failed'; - public const DOWNLOAD_FAILED = 'download_failed'; + case DOWNLOAD_FAILED = 'download_failed'; - public const INTERNAL_SERVER_ERROR = 'internal_server_error'; + case INTERNAL_SERVER_ERROR = 'internal_server_error'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php index 8804185d..f5a618ed 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: AudioCodec::*|null, + * audioCodec?: value-of|null, * autoRotate?: bool|null, - * format?: Format::*|null, + * format?: value-of|null, * quality?: int|null, - * streamProtocol?: StreamProtocol::*|null, + * streamProtocol?: value-of|null, * variants?: list|null, - * videoCodec?: VideoCodec::*|null, + * videoCodec?: value-of|null, * } */ final class Options implements BaseModel @@ -33,7 +33,7 @@ final class Options implements BaseModel /** * Audio codec used for encoding (aac or opus). * - * @var AudioCodec::*|null $audioCodec + * @var value-of|null $audioCodec */ #[Api('audio_codec', enum: AudioCodec::class, optional: true)] public ?string $audioCodec; @@ -47,7 +47,7 @@ final class Options implements BaseModel /** * Output format for the transformed video or thumbnail. * - * @var Format::*|null $format + * @var value-of|null $format */ #[Api(enum: Format::class, optional: true)] public ?string $format; @@ -61,7 +61,7 @@ final class Options implements BaseModel /** * Streaming protocol for adaptive bitrate streaming. * - * @var StreamProtocol::*|null $streamProtocol + * @var value-of|null $streamProtocol */ #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] public ?string $streamProtocol; @@ -77,7 +77,7 @@ final class Options implements BaseModel /** * Video codec used for encoding (h264, vp9, or av1). * - * @var VideoCodec::*|null $videoCodec + * @var value-of|null $videoCodec */ #[Api('video_codec', enum: VideoCodec::class, optional: true)] public ?string $videoCodec; @@ -92,30 +92,30 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AudioCodec::* $audioCodec - * @param Format::* $format - * @param StreamProtocol::* $streamProtocol + * @param AudioCodec|value-of $audioCodec + * @param Format|value-of $format + * @param StreamProtocol|value-of $streamProtocol * @param list $variants - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ public static function with( - ?string $audioCodec = null, + AudioCodec|string|null $audioCodec = null, ?bool $autoRotate = null, - ?string $format = null, + Format|string|null $format = null, ?int $quality = null, - ?string $streamProtocol = null, + StreamProtocol|string|null $streamProtocol = null, ?array $variants = null, - ?string $videoCodec = null, + VideoCodec|string|null $videoCodec = null, ): self { $obj = new self; - null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $audioCodec && $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; null !== $autoRotate && $obj->autoRotate = $autoRotate; - null !== $format && $obj->format = $format; + null !== $format && $obj->format = $format instanceof Format ? $format->value : $format; null !== $quality && $obj->quality = $quality; - null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; null !== $variants && $obj->variants = $variants; - null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $videoCodec && $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } @@ -123,12 +123,12 @@ public static function with( /** * Audio codec used for encoding (aac or opus). * - * @param AudioCodec::* $audioCodec + * @param AudioCodec|value-of $audioCodec */ - public function withAudioCodec(string $audioCodec): self + public function withAudioCodec(AudioCodec|string $audioCodec): self { $obj = clone $this; - $obj->audioCodec = $audioCodec; + $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; return $obj; } @@ -147,12 +147,12 @@ public function withAutoRotate(bool $autoRotate): self /** * Output format for the transformed video or thumbnail. * - * @param Format::* $format + * @param Format|value-of $format */ - public function withFormat(string $format): self + public function withFormat(Format|string $format): self { $obj = clone $this; - $obj->format = $format; + $obj->format = $format instanceof Format ? $format->value : $format; return $obj; } @@ -171,12 +171,13 @@ public function withQuality(int $quality): self /** * Streaming protocol for adaptive bitrate streaming. * - * @param StreamProtocol::* $streamProtocol + * @param StreamProtocol|value-of $streamProtocol */ - public function withStreamProtocol(string $streamProtocol): self - { + public function withStreamProtocol( + StreamProtocol|string $streamProtocol + ): self { $obj = clone $this; - $obj->streamProtocol = $streamProtocol; + $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; return $obj; } @@ -197,12 +198,12 @@ public function withVariants(array $variants): self /** * Video codec used for encoding (h264, vp9, or av1). * - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ - public function withVideoCodec(string $videoCodec): self + public function withVideoCodec(VideoCodec|string $videoCodec): self { $obj = clone $this; - $obj->videoCodec = $videoCodec; + $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php index 796c5e40..c33c2fef 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/AudioCodec.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Audio codec used for encoding (aac or opus). */ -final class AudioCodec implements ConverterSource +enum AudioCodec: string { - use SdkEnum; - - public const AAC = 'aac'; + case AAC = 'aac'; - public const OPUS = 'opus'; + case OPUS = 'opus'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/Format.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/Format.php index c6699414..c37d8135 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/Format.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/Format.php @@ -4,23 +4,18 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Output format for the transformed video or thumbnail. */ -final class Format implements ConverterSource +enum Format: string { - use SdkEnum; - - public const MP4 = 'mp4'; + case MP4 = 'mp4'; - public const WEBM = 'webm'; + case WEBM = 'webm'; - public const JPG = 'jpg'; + case JPG = 'jpg'; - public const PNG = 'png'; + case PNG = 'png'; - public const WEBP = 'webp'; + case WEBP = 'webp'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/StreamProtocol.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/StreamProtocol.php index 9a67e9d8..73d64235 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/StreamProtocol.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/StreamProtocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Streaming protocol for adaptive bitrate streaming. */ -final class StreamProtocol implements ConverterSource +enum StreamProtocol: string { - use SdkEnum; - - public const HLS = 'HLS'; + case HLS = 'HLS'; - public const DASH = 'DASH'; + case DASH = 'DASH'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/VideoCodec.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/VideoCodec.php index d5e2da30..7540a5fb 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/VideoCodec.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options/VideoCodec.php @@ -4,19 +4,14 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Video codec used for encoding (h264, vp9, or av1). */ -final class VideoCodec implements ConverterSource +enum VideoCodec: string { - use SdkEnum; - - public const H264 = 'h264'; + case H264 = 'h264'; - public const VP9 = 'vp9'; + case VP9 = 'vp9'; - public const AV1 = 'av1'; + case AV1 = 'av1'; } diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Type.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Type.php index fb6b20a9..38869bb0 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Type.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Type.php @@ -4,22 +4,17 @@ namespace ImageKit\Webhooks\VideoTransformationErrorEvent\Data\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of video transformation: * - `video-transformation`: Standard video processing (resize, format conversion, etc.) * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const VIDEO_TRANSFORMATION = 'video-transformation'; + case VIDEO_TRANSFORMATION = 'video-transformation'; - public const GIF_TO_VIDEO = 'gif-to-video'; + case GIF_TO_VIDEO = 'gif-to-video'; - public const VIDEO_THUMBNAIL = 'video-thumbnail'; + case VIDEO_THUMBNAIL = 'video-thumbnail'; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php index b2fc39fa..794423d6 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php @@ -13,7 +13,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: Type::*, options?: Options|null, output?: Output|null + * type: value-of, options?: Options|null, output?: Output|null * } */ final class Transformation implements BaseModel @@ -27,7 +27,7 @@ final class Transformation implements BaseModel * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @var Type::* $type + * @var value-of $type */ #[Api(enum: Type::class)] public string $type; @@ -68,16 +68,16 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param Type::* $type + * @param Type|value-of $type */ public static function with( - string $type, + Type|string $type, ?Options $options = null, ?Output $output = null ): self { $obj = new self; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; null !== $options && $obj->options = $options; null !== $output && $obj->output = $output; @@ -91,12 +91,12 @@ public static function with( * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video * - * @param Type::* $type + * @param Type|value-of $type */ - public function withType(string $type): self + public function withType(Type|string $type): self { $obj = clone $this; - $obj->type = $type; + $obj->type = $type instanceof Type ? $type->value : $type; return $obj; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php index 352cec53..d1524f17 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: AudioCodec::*|null, + * audioCodec?: value-of|null, * autoRotate?: bool|null, - * format?: Format::*|null, + * format?: value-of|null, * quality?: int|null, - * streamProtocol?: StreamProtocol::*|null, + * streamProtocol?: value-of|null, * variants?: list|null, - * videoCodec?: VideoCodec::*|null, + * videoCodec?: value-of|null, * } */ final class Options implements BaseModel @@ -33,7 +33,7 @@ final class Options implements BaseModel /** * Audio codec used for encoding (aac or opus). * - * @var AudioCodec::*|null $audioCodec + * @var value-of|null $audioCodec */ #[Api('audio_codec', enum: AudioCodec::class, optional: true)] public ?string $audioCodec; @@ -47,7 +47,7 @@ final class Options implements BaseModel /** * Output format for the transformed video or thumbnail. * - * @var Format::*|null $format + * @var value-of|null $format */ #[Api(enum: Format::class, optional: true)] public ?string $format; @@ -61,7 +61,7 @@ final class Options implements BaseModel /** * Streaming protocol for adaptive bitrate streaming. * - * @var StreamProtocol::*|null $streamProtocol + * @var value-of|null $streamProtocol */ #[Api('stream_protocol', enum: StreamProtocol::class, optional: true)] public ?string $streamProtocol; @@ -77,7 +77,7 @@ final class Options implements BaseModel /** * Video codec used for encoding (h264, vp9, or av1). * - * @var VideoCodec::*|null $videoCodec + * @var value-of|null $videoCodec */ #[Api('video_codec', enum: VideoCodec::class, optional: true)] public ?string $videoCodec; @@ -92,30 +92,30 @@ public function __construct() * * You must use named parameters to construct any parameters with a default value. * - * @param AudioCodec::* $audioCodec - * @param Format::* $format - * @param StreamProtocol::* $streamProtocol + * @param AudioCodec|value-of $audioCodec + * @param Format|value-of $format + * @param StreamProtocol|value-of $streamProtocol * @param list $variants - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ public static function with( - ?string $audioCodec = null, + AudioCodec|string|null $audioCodec = null, ?bool $autoRotate = null, - ?string $format = null, + Format|string|null $format = null, ?int $quality = null, - ?string $streamProtocol = null, + StreamProtocol|string|null $streamProtocol = null, ?array $variants = null, - ?string $videoCodec = null, + VideoCodec|string|null $videoCodec = null, ): self { $obj = new self; - null !== $audioCodec && $obj->audioCodec = $audioCodec; + null !== $audioCodec && $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; null !== $autoRotate && $obj->autoRotate = $autoRotate; - null !== $format && $obj->format = $format; + null !== $format && $obj->format = $format instanceof Format ? $format->value : $format; null !== $quality && $obj->quality = $quality; - null !== $streamProtocol && $obj->streamProtocol = $streamProtocol; + null !== $streamProtocol && $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; null !== $variants && $obj->variants = $variants; - null !== $videoCodec && $obj->videoCodec = $videoCodec; + null !== $videoCodec && $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } @@ -123,12 +123,12 @@ public static function with( /** * Audio codec used for encoding (aac or opus). * - * @param AudioCodec::* $audioCodec + * @param AudioCodec|value-of $audioCodec */ - public function withAudioCodec(string $audioCodec): self + public function withAudioCodec(AudioCodec|string $audioCodec): self { $obj = clone $this; - $obj->audioCodec = $audioCodec; + $obj->audioCodec = $audioCodec instanceof AudioCodec ? $audioCodec->value : $audioCodec; return $obj; } @@ -147,12 +147,12 @@ public function withAutoRotate(bool $autoRotate): self /** * Output format for the transformed video or thumbnail. * - * @param Format::* $format + * @param Format|value-of $format */ - public function withFormat(string $format): self + public function withFormat(Format|string $format): self { $obj = clone $this; - $obj->format = $format; + $obj->format = $format instanceof Format ? $format->value : $format; return $obj; } @@ -171,12 +171,13 @@ public function withQuality(int $quality): self /** * Streaming protocol for adaptive bitrate streaming. * - * @param StreamProtocol::* $streamProtocol + * @param StreamProtocol|value-of $streamProtocol */ - public function withStreamProtocol(string $streamProtocol): self - { + public function withStreamProtocol( + StreamProtocol|string $streamProtocol + ): self { $obj = clone $this; - $obj->streamProtocol = $streamProtocol; + $obj->streamProtocol = $streamProtocol instanceof StreamProtocol ? $streamProtocol->value : $streamProtocol; return $obj; } @@ -197,12 +198,12 @@ public function withVariants(array $variants): self /** * Video codec used for encoding (h264, vp9, or av1). * - * @param VideoCodec::* $videoCodec + * @param VideoCodec|value-of $videoCodec */ - public function withVideoCodec(string $videoCodec): self + public function withVideoCodec(VideoCodec|string $videoCodec): self { $obj = clone $this; - $obj->videoCodec = $videoCodec; + $obj->videoCodec = $videoCodec instanceof VideoCodec ? $videoCodec->value : $videoCodec; return $obj; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php index 779ccde7..28919565 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/AudioCodec.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationReadyEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Audio codec used for encoding (aac or opus). */ -final class AudioCodec implements ConverterSource +enum AudioCodec: string { - use SdkEnum; - - public const AAC = 'aac'; + case AAC = 'aac'; - public const OPUS = 'opus'; + case OPUS = 'opus'; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/Format.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/Format.php index 5af7c679..8c7dfc76 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/Format.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/Format.php @@ -4,23 +4,18 @@ namespace ImageKit\Webhooks\VideoTransformationReadyEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Output format for the transformed video or thumbnail. */ -final class Format implements ConverterSource +enum Format: string { - use SdkEnum; - - public const MP4 = 'mp4'; + case MP4 = 'mp4'; - public const WEBM = 'webm'; + case WEBM = 'webm'; - public const JPG = 'jpg'; + case JPG = 'jpg'; - public const PNG = 'png'; + case PNG = 'png'; - public const WEBP = 'webp'; + case WEBP = 'webp'; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/StreamProtocol.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/StreamProtocol.php index 41dca438..604fb5cd 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/StreamProtocol.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/StreamProtocol.php @@ -4,17 +4,12 @@ namespace ImageKit\Webhooks\VideoTransformationReadyEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Streaming protocol for adaptive bitrate streaming. */ -final class StreamProtocol implements ConverterSource +enum StreamProtocol: string { - use SdkEnum; - - public const HLS = 'HLS'; + case HLS = 'HLS'; - public const DASH = 'DASH'; + case DASH = 'DASH'; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/VideoCodec.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/VideoCodec.php index e734c3c0..f8061f64 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/VideoCodec.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options/VideoCodec.php @@ -4,19 +4,14 @@ namespace ImageKit\Webhooks\VideoTransformationReadyEvent\Data\Transformation\Options; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Video codec used for encoding (h264, vp9, or av1). */ -final class VideoCodec implements ConverterSource +enum VideoCodec: string { - use SdkEnum; - - public const H264 = 'h264'; + case H264 = 'h264'; - public const VP9 = 'vp9'; + case VP9 = 'vp9'; - public const AV1 = 'av1'; + case AV1 = 'av1'; } diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php index 9b2b35d3..0dfcbeae 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Type.php @@ -4,22 +4,17 @@ namespace ImageKit\Webhooks\VideoTransformationReadyEvent\Data\Transformation; -use ImageKit\Core\Concerns\SdkEnum; -use ImageKit\Core\Conversion\Contracts\ConverterSource; - /** * Type of video transformation: * - `video-transformation`: Standard video processing (resize, format conversion, etc.) * - `gif-to-video`: Convert animated GIF to video format * - `video-thumbnail`: Generate thumbnail image from video */ -final class Type implements ConverterSource +enum Type: string { - use SdkEnum; - - public const VIDEO_TRANSFORMATION = 'video-transformation'; + case VIDEO_TRANSFORMATION = 'video-transformation'; - public const GIF_TO_VIDEO = 'gif-to-video'; + case GIF_TO_VIDEO = 'gif-to-video'; - public const VIDEO_THUMBNAIL = 'video-thumbnail'; + case VIDEO_THUMBNAIL = 'video-thumbnail'; } From a57c7cc9f5131daea2a45d261b414a3deed3adba Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 11 Sep 2025 02:25:08 +0000 Subject: [PATCH 27/40] chore: fix lints in UnionOf --- src/Core/Conversion/UnionOf.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/Core/Conversion/UnionOf.php b/src/Core/Conversion/UnionOf.php index 1502f9bb..ba0beb1f 100644 --- a/src/Core/Conversion/UnionOf.php +++ b/src/Core/Conversion/UnionOf.php @@ -65,7 +65,7 @@ public function coerce(mixed $value, CoerceState $state): mixed public function dump(mixed $value, DumpState $state): mixed { - if (!is_null($target = $this->resolveVariant(value: $value))) { + if (null !== ($target = $this->resolveVariant(value: $value))) { return Conversion::dump($target, value: $value, state: $state); } @@ -85,8 +85,15 @@ private function resolveVariant( return $value::class; } - if (!is_null($this->discriminator) && is_array($value) && array_key_exists($this->discriminator, array: $value)) { + if ( + null !== $this->discriminator + && is_array($value) + && array_key_exists($this->discriminator, array: $value) + ) { $discriminator = $value[$this->discriminator]; + if (!is_string($discriminator)) { + return null; + } return $this->variants[$discriminator] ?? null; } From cc5397ddbb7a5a58b22f25037a76cc502a972692 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 13 Sep 2025 02:35:50 +0000 Subject: [PATCH 28/40] feat(client): support raw responses --- .../Origins/OriginRequest/AkeneoPim.php | 4 +- .../Origins/OriginRequest/AzureBlob.php | 6 +- .../OriginRequest/CloudinaryBackup.php | 6 +- src/Accounts/Origins/OriginRequest/Gcs.php | 6 +- src/Accounts/Origins/OriginRequest/S3.php | 6 +- .../Origins/OriginRequest/S3Compatible.php | 8 +- .../Origins/OriginRequest/WebFolder.php | 6 +- .../Origins/OriginRequest/WebProxy.php | 4 +- .../Origins/OriginResponse/AkeneoPim.php | 2 +- .../Origins/OriginResponse/AzureBlob.php | 2 +- .../OriginResponse/CloudinaryBackup.php | 2 +- src/Accounts/Origins/OriginResponse/Gcs.php | 2 +- src/Accounts/Origins/OriginResponse/S3.php | 2 +- .../Origins/OriginResponse/S3Compatible.php | 2 +- .../Origins/OriginResponse/WebFolder.php | 2 +- .../Origins/OriginResponse/WebProxy.php | 2 +- .../URLRewriter/Cloudinary.php | 2 +- .../URLEndpoints/URLEndpointRequest.php | 6 +- .../URLRewriter/Cloudinary.php | 2 +- .../URLEndpoints/URLEndpointResponse.php | 6 +- .../URLRewriter/Cloudinary.php | 2 +- src/Accounts/Usage/UsageGetResponse.php | 14 ++- src/BaseOverlay.php | 2 +- .../Files/FileUploadParams/Transformation.php | 2 +- .../Transformation/Post/GifToVideo.php | 2 +- .../Transformation/Post/Thumbnail.php | 2 +- src/Beta/V2/Files/FileUploadResponse.php | 46 ++++---- .../V2/Files/FileUploadResponse/AITag.php | 4 +- .../FileUploadResponse/ExtensionStatus.php | 8 +- .../Files/FileUploadResponse/VersionInfo.php | 2 +- .../Invalidation/InvalidationGetResponse.php | 6 +- .../Invalidation/InvalidationNewResponse.php | 6 +- src/Core/Implementation/HasRawResponse.php | 10 ++ .../CustomMetadataField.php | 4 + .../CustomMetadataField/Schema.php | 14 +-- .../Schema.php | 14 +-- .../CustomMetadataFieldDeleteResponse.php | 4 + .../Schema.php | 14 +-- src/ExtensionItem/RemoveBg.php | 2 +- src/ExtensionItem/RemoveBg/Options.php | 8 +- src/Files/Bulk/BulkAddTagsResponse.php | 6 +- src/Files/Bulk/BulkDeleteResponse.php | 6 +- src/Files/Bulk/BulkRemoveAITagsResponse.php | 6 +- src/Files/Bulk/BulkRemoveTagsResponse.php | 6 +- src/Files/File.php | 42 +++---- src/Files/File/AITag.php | 4 +- src/Files/File/VersionInfo.php | 2 +- src/Files/FileCopyResponse.php | 4 + src/Files/FileMoveResponse.php | 4 + src/Files/FileRenameResponse.php | 6 +- src/Files/FileUpdateParams/Publish.php | 2 +- src/Files/FileUpdateResponse.php | 10 +- .../FileUpdateResponse/ExtensionStatus.php | 8 +- src/Files/FileUploadParams/Transformation.php | 2 +- .../Transformation/Post/GifToVideo.php | 2 +- .../Transformation/Post/Thumbnail.php | 2 +- src/Files/FileUploadResponse.php | 46 ++++---- src/Files/FileUploadResponse/AITag.php | 4 +- .../FileUploadResponse/ExtensionStatus.php | 8 +- src/Files/FileUploadResponse/VersionInfo.php | 2 +- src/Files/Folder.php | 12 +- src/Files/Metadata.php | 28 ++--- src/Files/Metadata/Exif.php | 12 +- src/Files/Metadata/Exif/Exif.php | 52 ++++----- src/Files/Metadata/Exif/Gps.php | 2 +- src/Files/Metadata/Exif/Image.php | 22 ++-- src/Files/Metadata/Exif/Interoperability.php | 2 +- src/Files/Metadata/Exif/Thumbnail.php | 12 +- .../ChangePublicationStatus.php | 2 +- .../ChangePublicationStatus/Publish.php | 2 +- .../UpdateFileDetails.php | 10 +- src/Files/Versions/VersionDeleteResponse.php | 4 + src/Folders/FolderCopyResponse.php | 4 + src/Folders/FolderDeleteResponse.php | 4 + src/Folders/FolderMoveResponse.php | 4 + src/Folders/FolderNewResponse.php | 4 + src/Folders/FolderRenameResponse.php | 4 + src/Folders/Job/JobGetResponse.php | 12 +- src/ImageOverlay.php | 8 +- src/OverlayPosition.php | 2 +- src/OverlayTiming.php | 4 +- .../Accounts/URLEndpointsContract.php | 7 ++ .../Accounts/UsageContract.php | 3 + .../Beta/V2/FilesContract.php | 3 + .../Cache/InvalidationContract.php | 5 + .../CustomMetadataFieldsContract.php | 7 ++ src/ServiceContracts/Files/BulkContract.php | 9 ++ .../Files/VersionsContract.php | 7 ++ src/ServiceContracts/FilesContract.php | 13 ++- src/ServiceContracts/Folders/JobContract.php | 3 + src/ServiceContracts/FoldersContract.php | 11 ++ src/Services/Accounts/URLEndpointsService.php | 7 ++ src/Services/Accounts/UsageService.php | 3 + src/Services/AccountsService.php | 6 +- src/Services/Beta/V2/FilesService.php | 3 + src/Services/Beta/V2Service.php | 2 +- src/Services/BetaService.php | 2 +- src/Services/Cache/InvalidationService.php | 5 + src/Services/CacheService.php | 2 +- src/Services/CustomMetadataFieldsService.php | 7 ++ src/Services/Files/BulkService.php | 9 ++ src/Services/Files/VersionsService.php | 7 ++ src/Services/FilesService.php | 19 +++- src/Services/Folders/JobService.php | 3 + src/Services/FoldersService.php | 13 ++- src/SolidColorOverlay.php | 6 +- src/SolidColorOverlayTransformation.php | 12 +- src/SrcOptions.php | 10 +- src/SubtitleOverlay.php | 8 +- src/SubtitleOverlayTransformation.php | 14 +-- src/TextOverlay.php | 8 +- src/TextOverlayTransformation.php | 26 ++--- src/Transformation.php | 104 +++++++++--------- src/VideoOverlay.php | 8 +- .../UploadPostTransformErrorEvent.php | 4 +- .../Request/Transformation.php | 2 +- .../UploadPostTransformSuccessEvent.php | 4 +- .../Request/Transformation.php | 2 +- src/Webhooks/UploadPreTransformErrorEvent.php | 4 +- .../UploadPreTransformSuccessEvent.php | 4 +- .../UploadPreTransformSuccessEvent/Data.php | 42 +++---- .../Data/AITag.php | 4 +- .../Data/ExtensionStatus.php | 8 +- .../Data/VersionInfo.php | 2 +- .../VideoTransformationAcceptedEvent.php | 4 +- .../Data/Transformation.php | 2 +- .../Data/Transformation/Options.php | 14 +-- .../Request.php | 2 +- .../VideoTransformationErrorEvent.php | 4 +- .../Data/Transformation.php | 2 +- .../Data/Transformation/Options.php | 14 +-- .../VideoTransformationErrorEvent/Request.php | 2 +- .../VideoTransformationReadyEvent.php | 6 +- .../Data/Transformation.php | 2 +- .../Data/Transformation/Options.php | 14 +-- .../Data/Transformation/Output.php | 4 +- .../VideoTransformationReadyEvent/Request.php | 2 +- .../VideoTransformationReadyEvent/Timings.php | 2 +- 138 files changed, 675 insertions(+), 449 deletions(-) create mode 100644 src/Core/Implementation/HasRawResponse.php diff --git a/src/Accounts/Origins/OriginRequest/AkeneoPim.php b/src/Accounts/Origins/OriginRequest/AkeneoPim.php index 9e48f720..600e8225 100644 --- a/src/Accounts/Origins/OriginRequest/AkeneoPim.php +++ b/src/Accounts/Origins/OriginRequest/AkeneoPim.php @@ -17,8 +17,8 @@ * password: string, * type: string, * username: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, * } */ final class AkeneoPim implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/AzureBlob.php b/src/Accounts/Origins/OriginRequest/AzureBlob.php index 822f1d72..7151a017 100644 --- a/src/Accounts/Origins/OriginRequest/AzureBlob.php +++ b/src/Accounts/Origins/OriginRequest/AzureBlob.php @@ -15,9 +15,9 @@ * name: string, * sasToken: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, - * prefix?: string|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, * } */ final class AzureBlob implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php b/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php index b7c0652e..21405d2b 100644 --- a/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php +++ b/src/Accounts/Origins/OriginRequest/CloudinaryBackup.php @@ -15,9 +15,9 @@ * name: string, * secretKey: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, - * prefix?: string|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, * } */ final class CloudinaryBackup implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/Gcs.php b/src/Accounts/Origins/OriginRequest/Gcs.php index 7ce89f65..10a9646e 100644 --- a/src/Accounts/Origins/OriginRequest/Gcs.php +++ b/src/Accounts/Origins/OriginRequest/Gcs.php @@ -15,9 +15,9 @@ * name: string, * privateKey: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, - * prefix?: string|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, * } */ final class Gcs implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/S3.php b/src/Accounts/Origins/OriginRequest/S3.php index 4f2b45ac..7e54eff2 100644 --- a/src/Accounts/Origins/OriginRequest/S3.php +++ b/src/Accounts/Origins/OriginRequest/S3.php @@ -15,9 +15,9 @@ * name: string, * secretKey: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, - * prefix?: string|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, * } */ final class S3 implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/S3Compatible.php b/src/Accounts/Origins/OriginRequest/S3Compatible.php index d0b9966e..157c882d 100644 --- a/src/Accounts/Origins/OriginRequest/S3Compatible.php +++ b/src/Accounts/Origins/OriginRequest/S3Compatible.php @@ -16,10 +16,10 @@ * name: string, * secretKey: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, - * prefix?: string|null, - * s3ForcePathStyle?: bool|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, + * prefix?: string, + * s3ForcePathStyle?: bool, * } */ final class S3Compatible implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/WebFolder.php b/src/Accounts/Origins/OriginRequest/WebFolder.php index 4c634e60..f5e03aed 100644 --- a/src/Accounts/Origins/OriginRequest/WebFolder.php +++ b/src/Accounts/Origins/OriginRequest/WebFolder.php @@ -13,9 +13,9 @@ * baseURL: string, * name: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * forwardHostHeaderToOrigin?: bool|null, - * includeCanonicalHeader?: bool|null, + * baseURLForCanonicalHeader?: string, + * forwardHostHeaderToOrigin?: bool, + * includeCanonicalHeader?: bool, * } */ final class WebFolder implements BaseModel diff --git a/src/Accounts/Origins/OriginRequest/WebProxy.php b/src/Accounts/Origins/OriginRequest/WebProxy.php index 2b6404b7..e6bde50b 100644 --- a/src/Accounts/Origins/OriginRequest/WebProxy.php +++ b/src/Accounts/Origins/OriginRequest/WebProxy.php @@ -12,8 +12,8 @@ * @phpstan-type web_proxy = array{ * name: string, * type: string, - * baseURLForCanonicalHeader?: string|null, - * includeCanonicalHeader?: bool|null, + * baseURLForCanonicalHeader?: string, + * includeCanonicalHeader?: bool, * } */ final class WebProxy implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/AkeneoPim.php b/src/Accounts/Origins/OriginResponse/AkeneoPim.php index 2459a81d..d42bf0e8 100644 --- a/src/Accounts/Origins/OriginResponse/AkeneoPim.php +++ b/src/Accounts/Origins/OriginResponse/AkeneoPim.php @@ -15,7 +15,7 @@ * includeCanonicalHeader: bool, * name: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class AkeneoPim implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/AzureBlob.php b/src/Accounts/Origins/OriginResponse/AzureBlob.php index 63c2a2db..83d2dc7c 100644 --- a/src/Accounts/Origins/OriginResponse/AzureBlob.php +++ b/src/Accounts/Origins/OriginResponse/AzureBlob.php @@ -17,7 +17,7 @@ * name: string, * prefix: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class AzureBlob implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php b/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php index e721eb2a..c58af4db 100644 --- a/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php +++ b/src/Accounts/Origins/OriginResponse/CloudinaryBackup.php @@ -16,7 +16,7 @@ * name: string, * prefix: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class CloudinaryBackup implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/Gcs.php b/src/Accounts/Origins/OriginResponse/Gcs.php index bd7bc41e..fba85c13 100644 --- a/src/Accounts/Origins/OriginResponse/Gcs.php +++ b/src/Accounts/Origins/OriginResponse/Gcs.php @@ -17,7 +17,7 @@ * name: string, * prefix: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class Gcs implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/S3.php b/src/Accounts/Origins/OriginResponse/S3.php index 48050fed..abeac628 100644 --- a/src/Accounts/Origins/OriginResponse/S3.php +++ b/src/Accounts/Origins/OriginResponse/S3.php @@ -16,7 +16,7 @@ * name: string, * prefix: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class S3 implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/S3Compatible.php b/src/Accounts/Origins/OriginResponse/S3Compatible.php index 74d8e0d6..3016348f 100644 --- a/src/Accounts/Origins/OriginResponse/S3Compatible.php +++ b/src/Accounts/Origins/OriginResponse/S3Compatible.php @@ -18,7 +18,7 @@ * prefix: string, * s3ForcePathStyle: bool, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class S3Compatible implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/WebFolder.php b/src/Accounts/Origins/OriginResponse/WebFolder.php index 97d22763..9f56573a 100644 --- a/src/Accounts/Origins/OriginResponse/WebFolder.php +++ b/src/Accounts/Origins/OriginResponse/WebFolder.php @@ -16,7 +16,7 @@ * includeCanonicalHeader: bool, * name: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class WebFolder implements BaseModel diff --git a/src/Accounts/Origins/OriginResponse/WebProxy.php b/src/Accounts/Origins/OriginResponse/WebProxy.php index 3a302c3b..b1c61e6c 100644 --- a/src/Accounts/Origins/OriginResponse/WebProxy.php +++ b/src/Accounts/Origins/OriginResponse/WebProxy.php @@ -14,7 +14,7 @@ * includeCanonicalHeader: bool, * name: string, * type: string, - * baseURLForCanonicalHeader?: string|null, + * baseURLForCanonicalHeader?: string, * } */ final class WebProxy implements BaseModel diff --git a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php index 48561fe6..b35d6c2f 100644 --- a/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php +++ b/src/Accounts/URLEndpoints/URLEndpointCreateParams/URLRewriter/Cloudinary.php @@ -10,7 +10,7 @@ /** * @phpstan-type cloudinary_alias = array{ - * type: string, preserveAssetDeliveryTypes?: bool|null + * type: string, preserveAssetDeliveryTypes?: bool * } */ final class Cloudinary implements BaseModel diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest.php b/src/Accounts/URLEndpoints/URLEndpointRequest.php index dd4177a6..f74ca34a 100644 --- a/src/Accounts/URLEndpoints/URLEndpointRequest.php +++ b/src/Accounts/URLEndpoints/URLEndpointRequest.php @@ -17,9 +17,9 @@ * * @phpstan-type url_endpoint_request = array{ * description: string, - * origins?: list|null, - * urlPrefix?: string|null, - * urlRewriter?: null|Cloudinary|Imgix|Akamai, + * origins?: list, + * urlPrefix?: string, + * urlRewriter?: Cloudinary|Imgix|Akamai, * } */ final class URLEndpointRequest implements BaseModel diff --git a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php index 17f95e0f..25a15b2f 100644 --- a/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php +++ b/src/Accounts/URLEndpoints/URLEndpointRequest/URLRewriter/Cloudinary.php @@ -10,7 +10,7 @@ /** * @phpstan-type cloudinary_alias = array{ - * type: string, preserveAssetDeliveryTypes?: bool|null + * type: string, preserveAssetDeliveryTypes?: bool * } */ final class Cloudinary implements BaseModel diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse.php b/src/Accounts/URLEndpoints/URLEndpointResponse.php index 6dcecef8..7199516a 100644 --- a/src/Accounts/URLEndpoints/URLEndpointResponse.php +++ b/src/Accounts/URLEndpoints/URLEndpointResponse.php @@ -20,8 +20,12 @@ * description: string, * origins: list, * urlPrefix: string, - * urlRewriter?: null|Cloudinary|Imgix|Akamai, + * urlRewriter?: Cloudinary|Imgix|Akamai, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class URLEndpointResponse implements BaseModel { diff --git a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php index 74a44ba4..29ae7c45 100644 --- a/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php +++ b/src/Accounts/URLEndpoints/URLEndpointUpdateParams/URLRewriter/Cloudinary.php @@ -10,7 +10,7 @@ /** * @phpstan-type cloudinary_alias = array{ - * type: string, preserveAssetDeliveryTypes?: bool|null + * type: string, preserveAssetDeliveryTypes?: bool * } */ final class Cloudinary implements BaseModel diff --git a/src/Accounts/Usage/UsageGetResponse.php b/src/Accounts/Usage/UsageGetResponse.php index 02fc093d..0ec69d79 100644 --- a/src/Accounts/Usage/UsageGetResponse.php +++ b/src/Accounts/Usage/UsageGetResponse.php @@ -10,12 +10,16 @@ /** * @phpstan-type usage_get_response = array{ - * bandwidthBytes?: int|null, - * extensionUnitsCount?: int|null, - * mediaLibraryStorageBytes?: int|null, - * originalCacheStorageBytes?: int|null, - * videoProcessingUnitsCount?: int|null, + * bandwidthBytes?: int, + * extensionUnitsCount?: int, + * mediaLibraryStorageBytes?: int, + * originalCacheStorageBytes?: int, + * videoProcessingUnitsCount?: int, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class UsageGetResponse implements BaseModel { diff --git a/src/BaseOverlay.php b/src/BaseOverlay.php index 3dd79187..66c1fb87 100644 --- a/src/BaseOverlay.php +++ b/src/BaseOverlay.php @@ -10,7 +10,7 @@ /** * @phpstan-type base_overlay = array{ - * position?: OverlayPosition|null, timing?: OverlayTiming|null + * position?: OverlayPosition, timing?: OverlayTiming * } */ final class BaseOverlay implements BaseModel diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation.php b/src/Beta/V2/Files/FileUploadParams/Transformation.php index 5d8888b2..5a1da85d 100644 --- a/src/Beta/V2/Files/FileUploadParams/Transformation.php +++ b/src/Beta/V2/Files/FileUploadParams/Transformation.php @@ -25,7 +25,7 @@ * You can mix and match any combination of post-processing types. * * @phpstan-type transformation_alias = array{ - * post?: list|null, pre?: string|null + * post?: list, pre?: string * } */ final class Transformation implements BaseModel diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/GifToVideo.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/GifToVideo.php index 629a3390..483f357e 100644 --- a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/GifToVideo.php +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/GifToVideo.php @@ -9,7 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type gif_to_video = array{type: string, value?: string|null} + * @phpstan-type gif_to_video = array{type: string, value?: string} */ final class GifToVideo implements BaseModel { diff --git a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php index ca978f5f..e3e032c1 100644 --- a/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php +++ b/src/Beta/V2/Files/FileUploadParams/Transformation/Post/Thumbnail.php @@ -9,7 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type thumbnail_alias = array{type: string, value?: string|null} + * @phpstan-type thumbnail_alias = array{type: string, value?: string} */ final class Thumbnail implements BaseModel { diff --git a/src/Beta/V2/Files/FileUploadResponse.php b/src/Beta/V2/Files/FileUploadResponse.php index 7ae8aedc..74ab2e43 100644 --- a/src/Beta/V2/Files/FileUploadResponse.php +++ b/src/Beta/V2/Files/FileUploadResponse.php @@ -17,30 +17,34 @@ * * @phpstan-type file_upload_response = array{ * aiTags?: list|null, - * audioCodec?: string|null, - * bitRate?: int|null, + * audioCodec?: string, + * bitRate?: int, * customCoordinates?: string|null, - * customMetadata?: array|null, - * description?: string|null, - * duration?: int|null, - * embeddedMetadata?: array|null, - * extensionStatus?: ExtensionStatus|null, - * fileID?: string|null, - * filePath?: string|null, - * fileType?: string|null, - * height?: float|null, - * isPrivateFile?: bool|null, - * isPublished?: bool|null, - * metadata?: Metadata|null, - * name?: string|null, - * size?: float|null, + * customMetadata?: array, + * description?: string, + * duration?: int, + * embeddedMetadata?: array, + * extensionStatus?: ExtensionStatus, + * fileID?: string, + * filePath?: string, + * fileType?: string, + * height?: float, + * isPrivateFile?: bool, + * isPublished?: bool, + * metadata?: Metadata, + * name?: string, + * size?: float, * tags?: list|null, - * thumbnailURL?: string|null, - * url?: string|null, - * versionInfo?: VersionInfo|null, - * videoCodec?: string|null, - * width?: float|null, + * thumbnailURL?: string, + * url?: string, + * versionInfo?: VersionInfo, + * videoCodec?: string, + * width?: float, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileUploadResponse implements BaseModel { diff --git a/src/Beta/V2/Files/FileUploadResponse/AITag.php b/src/Beta/V2/Files/FileUploadResponse/AITag.php index 0c2c4782..d54b479f 100644 --- a/src/Beta/V2/Files/FileUploadResponse/AITag.php +++ b/src/Beta/V2/Files/FileUploadResponse/AITag.php @@ -9,9 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type ai_tag = array{ - * confidence?: float|null, name?: string|null, source?: string|null - * } + * @phpstan-type ai_tag = array{confidence?: float, name?: string, source?: string} */ final class AITag implements BaseModel { diff --git a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php index bad49098..ff9ad751 100644 --- a/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php +++ b/src/Beta/V2/Files/FileUploadResponse/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: value-of|null, - * awsAutoTagging?: value-of|null, - * googleAutoTagging?: value-of|null, - * removeBg?: value-of|null, + * aiAutoDescription?: value-of, + * awsAutoTagging?: value-of, + * googleAutoTagging?: value-of, + * removeBg?: value-of, * } */ final class ExtensionStatus implements BaseModel diff --git a/src/Beta/V2/Files/FileUploadResponse/VersionInfo.php b/src/Beta/V2/Files/FileUploadResponse/VersionInfo.php index 4fe4faec..7c4c0048 100644 --- a/src/Beta/V2/Files/FileUploadResponse/VersionInfo.php +++ b/src/Beta/V2/Files/FileUploadResponse/VersionInfo.php @@ -11,7 +11,7 @@ /** * An object containing the file or file version's `id` (versionId) and `name`. * - * @phpstan-type version_info = array{id?: string|null, name?: string|null} + * @phpstan-type version_info = array{id?: string, name?: string} */ final class VersionInfo implements BaseModel { diff --git a/src/Cache/Invalidation/InvalidationGetResponse.php b/src/Cache/Invalidation/InvalidationGetResponse.php index 7b60dad2..4a853e75 100644 --- a/src/Cache/Invalidation/InvalidationGetResponse.php +++ b/src/Cache/Invalidation/InvalidationGetResponse.php @@ -10,7 +10,11 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type invalidation_get_response = array{status?: value-of|null} + * @phpstan-type invalidation_get_response = array{status?: value-of} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class InvalidationGetResponse implements BaseModel { diff --git a/src/Cache/Invalidation/InvalidationNewResponse.php b/src/Cache/Invalidation/InvalidationNewResponse.php index 839cdb18..4597a296 100644 --- a/src/Cache/Invalidation/InvalidationNewResponse.php +++ b/src/Cache/Invalidation/InvalidationNewResponse.php @@ -9,7 +9,11 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type invalidation_new_response = array{requestID?: string|null} + * @phpstan-type invalidation_new_response = array{requestID?: string} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class InvalidationNewResponse implements BaseModel { diff --git a/src/Core/Implementation/HasRawResponse.php b/src/Core/Implementation/HasRawResponse.php new file mode 100644 index 00000000..5d9b26c3 --- /dev/null +++ b/src/Core/Implementation/HasRawResponse.php @@ -0,0 +1,10 @@ +, - * defaultValue?: string|float|bool|null|list, - * isValueRequired?: bool|null, - * maxLength?: float|null, - * maxValue?: string|float|null, - * minLength?: float|null, - * minValue?: string|float|null, - * selectOptions?: list|null, + * defaultValue?: string|float|bool|list, + * isValueRequired?: bool, + * maxLength?: float, + * maxValue?: string|float, + * minLength?: float, + * minValue?: string|float, + * selectOptions?: list, * } */ final class Schema implements BaseModel diff --git a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php index 1bd8911f..bc027136 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php +++ b/src/CustomMetadataFields/CustomMetadataFieldCreateParams/Schema.php @@ -14,13 +14,13 @@ /** * @phpstan-type schema_alias = array{ * type: value-of, - * defaultValue?: string|float|bool|null|list, - * isValueRequired?: bool|null, - * maxLength?: float|null, - * maxValue?: string|float|null, - * minLength?: float|null, - * minValue?: string|float|null, - * selectOptions?: list|null, + * defaultValue?: string|float|bool|list, + * isValueRequired?: bool, + * maxLength?: float, + * maxValue?: string|float, + * minLength?: float, + * minValue?: string|float, + * selectOptions?: list, * } */ final class Schema implements BaseModel diff --git a/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php b/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php index 954555c1..6bb1113d 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php +++ b/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type custom_metadata_field_delete_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class CustomMetadataFieldDeleteResponse implements BaseModel { diff --git a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php index 0367e1f6..d08fc33d 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php +++ b/src/CustomMetadataFields/CustomMetadataFieldUpdateParams/Schema.php @@ -14,13 +14,13 @@ * An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. * * @phpstan-type schema_alias = array{ - * defaultValue?: string|float|bool|null|list, - * isValueRequired?: bool|null, - * maxLength?: float|null, - * maxValue?: string|float|null, - * minLength?: float|null, - * minValue?: string|float|null, - * selectOptions?: list|null, + * defaultValue?: string|float|bool|list, + * isValueRequired?: bool, + * maxLength?: float, + * maxValue?: string|float, + * minLength?: float, + * minValue?: string|float, + * selectOptions?: list, * } */ final class Schema implements BaseModel diff --git a/src/ExtensionItem/RemoveBg.php b/src/ExtensionItem/RemoveBg.php index fee287d2..1fedf875 100644 --- a/src/ExtensionItem/RemoveBg.php +++ b/src/ExtensionItem/RemoveBg.php @@ -10,7 +10,7 @@ use ImageKit\ExtensionItem\RemoveBg\Options; /** - * @phpstan-type remove_bg = array{name: string, options?: Options|null} + * @phpstan-type remove_bg = array{name: string, options?: Options} */ final class RemoveBg implements BaseModel { diff --git a/src/ExtensionItem/RemoveBg/Options.php b/src/ExtensionItem/RemoveBg/Options.php index 093cf8a6..f55764da 100644 --- a/src/ExtensionItem/RemoveBg/Options.php +++ b/src/ExtensionItem/RemoveBg/Options.php @@ -10,10 +10,10 @@ /** * @phpstan-type options_alias = array{ - * addShadow?: bool|null, - * bgColor?: string|null, - * bgImageURL?: string|null, - * semitransparency?: bool|null, + * addShadow?: bool, + * bgColor?: string, + * bgImageURL?: string, + * semitransparency?: bool, * } */ final class Options implements BaseModel diff --git a/src/Files/Bulk/BulkAddTagsResponse.php b/src/Files/Bulk/BulkAddTagsResponse.php index 45a93613..54a2b004 100644 --- a/src/Files/Bulk/BulkAddTagsResponse.php +++ b/src/Files/Bulk/BulkAddTagsResponse.php @@ -10,8 +10,12 @@ /** * @phpstan-type bulk_add_tags_response = array{ - * successfullyUpdatedFileIDs?: list|null + * successfullyUpdatedFileIDs?: list * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class BulkAddTagsResponse implements BaseModel { diff --git a/src/Files/Bulk/BulkDeleteResponse.php b/src/Files/Bulk/BulkDeleteResponse.php index 42f62916..b0da1da0 100644 --- a/src/Files/Bulk/BulkDeleteResponse.php +++ b/src/Files/Bulk/BulkDeleteResponse.php @@ -10,8 +10,12 @@ /** * @phpstan-type bulk_delete_response = array{ - * successfullyDeletedFileIDs?: list|null + * successfullyDeletedFileIDs?: list * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class BulkDeleteResponse implements BaseModel { diff --git a/src/Files/Bulk/BulkRemoveAITagsResponse.php b/src/Files/Bulk/BulkRemoveAITagsResponse.php index ec996967..2946c9de 100644 --- a/src/Files/Bulk/BulkRemoveAITagsResponse.php +++ b/src/Files/Bulk/BulkRemoveAITagsResponse.php @@ -10,8 +10,12 @@ /** * @phpstan-type bulk_remove_ai_tags_response = array{ - * successfullyUpdatedFileIDs?: list|null + * successfullyUpdatedFileIDs?: list * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class BulkRemoveAITagsResponse implements BaseModel { diff --git a/src/Files/Bulk/BulkRemoveTagsResponse.php b/src/Files/Bulk/BulkRemoveTagsResponse.php index a2c5ff1a..a82a0a8d 100644 --- a/src/Files/Bulk/BulkRemoveTagsResponse.php +++ b/src/Files/Bulk/BulkRemoveTagsResponse.php @@ -10,8 +10,12 @@ /** * @phpstan-type bulk_remove_tags_response = array{ - * successfullyUpdatedFileIDs?: list|null + * successfullyUpdatedFileIDs?: list * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class BulkRemoveTagsResponse implements BaseModel { diff --git a/src/Files/File.php b/src/Files/File.php index 9acd3c95..662ed6bd 100644 --- a/src/Files/File.php +++ b/src/Files/File.php @@ -16,28 +16,32 @@ * * @phpstan-type file_alias = array{ * aiTags?: list|null, - * createdAt?: \DateTimeInterface|null, + * createdAt?: \DateTimeInterface, * customCoordinates?: string|null, - * customMetadata?: array|null, - * description?: string|null, - * fileID?: string|null, - * filePath?: string|null, - * fileType?: string|null, - * hasAlpha?: bool|null, - * height?: float|null, - * isPrivateFile?: bool|null, - * isPublished?: bool|null, - * mime?: string|null, - * name?: string|null, - * size?: float|null, + * customMetadata?: array, + * description?: string, + * fileID?: string, + * filePath?: string, + * fileType?: string, + * hasAlpha?: bool, + * height?: float, + * isPrivateFile?: bool, + * isPublished?: bool, + * mime?: string, + * name?: string, + * size?: float, * tags?: list|null, - * thumbnail?: string|null, - * type?: value-of|null, - * updatedAt?: \DateTimeInterface|null, - * url?: string|null, - * versionInfo?: VersionInfo|null, - * width?: float|null, + * thumbnail?: string, + * type?: value-of, + * updatedAt?: \DateTimeInterface, + * url?: string, + * versionInfo?: VersionInfo, + * width?: float, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class File implements BaseModel { diff --git a/src/Files/File/AITag.php b/src/Files/File/AITag.php index 1b692418..cdb68bd6 100644 --- a/src/Files/File/AITag.php +++ b/src/Files/File/AITag.php @@ -9,9 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type ai_tag = array{ - * confidence?: float|null, name?: string|null, source?: string|null - * } + * @phpstan-type ai_tag = array{confidence?: float, name?: string, source?: string} */ final class AITag implements BaseModel { diff --git a/src/Files/File/VersionInfo.php b/src/Files/File/VersionInfo.php index 554d7038..4026a2df 100644 --- a/src/Files/File/VersionInfo.php +++ b/src/Files/File/VersionInfo.php @@ -11,7 +11,7 @@ /** * An object with details of the file version. * - * @phpstan-type version_info = array{id?: string|null, name?: string|null} + * @phpstan-type version_info = array{id?: string, name?: string} */ final class VersionInfo implements BaseModel { diff --git a/src/Files/FileCopyResponse.php b/src/Files/FileCopyResponse.php index ae593ba5..418bd983 100644 --- a/src/Files/FileCopyResponse.php +++ b/src/Files/FileCopyResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type file_copy_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileCopyResponse implements BaseModel { diff --git a/src/Files/FileMoveResponse.php b/src/Files/FileMoveResponse.php index bcdaa4ce..78520bc8 100644 --- a/src/Files/FileMoveResponse.php +++ b/src/Files/FileMoveResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type file_move_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileMoveResponse implements BaseModel { diff --git a/src/Files/FileRenameResponse.php b/src/Files/FileRenameResponse.php index bea1adab..91c59847 100644 --- a/src/Files/FileRenameResponse.php +++ b/src/Files/FileRenameResponse.php @@ -9,7 +9,11 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type file_rename_response = array{purgeRequestID?: string|null} + * @phpstan-type file_rename_response = array{purgeRequestID?: string} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileRenameResponse implements BaseModel { diff --git a/src/Files/FileUpdateParams/Publish.php b/src/Files/FileUpdateParams/Publish.php index 37535e9f..b49cd390 100644 --- a/src/Files/FileUpdateParams/Publish.php +++ b/src/Files/FileUpdateParams/Publish.php @@ -12,7 +12,7 @@ * Configure the publication status of a file and its versions. * * @phpstan-type publish_alias = array{ - * isPublished: bool, includeFileVersions?: bool|null + * isPublished: bool, includeFileVersions?: bool * } */ final class Publish implements BaseModel diff --git a/src/Files/FileUpdateResponse.php b/src/Files/FileUpdateResponse.php index 0a6596f9..7857e300 100644 --- a/src/Files/FileUpdateResponse.php +++ b/src/Files/FileUpdateResponse.php @@ -12,13 +12,17 @@ /** * Object containing details of a file or file version. * - * @phpstan-type file_update_response = array{ - * extensionStatus?: ExtensionStatus|null + * @phpstan-type unnamed_type_with_intersection_parent12 = array{ + * extensionStatus?: ExtensionStatus * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileUpdateResponse implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api(optional: true)] diff --git a/src/Files/FileUpdateResponse/ExtensionStatus.php b/src/Files/FileUpdateResponse/ExtensionStatus.php index 918ed884..c99928f4 100644 --- a/src/Files/FileUpdateResponse/ExtensionStatus.php +++ b/src/Files/FileUpdateResponse/ExtensionStatus.php @@ -14,10 +14,10 @@ /** * @phpstan-type extension_status = array{ - * aiAutoDescription?: value-of|null, - * awsAutoTagging?: value-of|null, - * googleAutoTagging?: value-of|null, - * removeBg?: value-of|null, + * aiAutoDescription?: value-of, + * awsAutoTagging?: value-of, + * googleAutoTagging?: value-of, + * removeBg?: value-of, * } */ final class ExtensionStatus implements BaseModel diff --git a/src/Files/FileUploadParams/Transformation.php b/src/Files/FileUploadParams/Transformation.php index b063104c..015f2267 100644 --- a/src/Files/FileUploadParams/Transformation.php +++ b/src/Files/FileUploadParams/Transformation.php @@ -25,7 +25,7 @@ * You can mix and match any combination of post-processing types. * * @phpstan-type transformation_alias = array{ - * post?: list|null, pre?: string|null + * post?: list, pre?: string * } */ final class Transformation implements BaseModel diff --git a/src/Files/FileUploadParams/Transformation/Post/GifToVideo.php b/src/Files/FileUploadParams/Transformation/Post/GifToVideo.php index 49785758..aec3eafc 100644 --- a/src/Files/FileUploadParams/Transformation/Post/GifToVideo.php +++ b/src/Files/FileUploadParams/Transformation/Post/GifToVideo.php @@ -9,7 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type gif_to_video = array{type: string, value?: string|null} + * @phpstan-type gif_to_video = array{type: string, value?: string} */ final class GifToVideo implements BaseModel { diff --git a/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php b/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php index 426e24d0..7d10b9e6 100644 --- a/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php +++ b/src/Files/FileUploadParams/Transformation/Post/Thumbnail.php @@ -9,7 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type thumbnail_alias = array{type: string, value?: string|null} + * @phpstan-type thumbnail_alias = array{type: string, value?: string} */ final class Thumbnail implements BaseModel { diff --git a/src/Files/FileUploadResponse.php b/src/Files/FileUploadResponse.php index 96f41701..d92d5898 100644 --- a/src/Files/FileUploadResponse.php +++ b/src/Files/FileUploadResponse.php @@ -16,30 +16,34 @@ * * @phpstan-type file_upload_response = array{ * aiTags?: list|null, - * audioCodec?: string|null, - * bitRate?: int|null, + * audioCodec?: string, + * bitRate?: int, * customCoordinates?: string|null, - * customMetadata?: array|null, - * description?: string|null, - * duration?: int|null, - * embeddedMetadata?: array|null, - * extensionStatus?: ExtensionStatus|null, - * fileID?: string|null, - * filePath?: string|null, - * fileType?: string|null, - * height?: float|null, - * isPrivateFile?: bool|null, - * isPublished?: bool|null, - * metadata?: Metadata|null, - * name?: string|null, - * size?: float|null, + * customMetadata?: array, + * description?: string, + * duration?: int, + * embeddedMetadata?: array, + * extensionStatus?: ExtensionStatus, + * fileID?: string, + * filePath?: string, + * fileType?: string, + * height?: float, + * isPrivateFile?: bool, + * isPublished?: bool, + * metadata?: Metadata, + * name?: string, + * size?: float, * tags?: list|null, - * thumbnailURL?: string|null, - * url?: string|null, - * versionInfo?: VersionInfo|null, - * videoCodec?: string|null, - * width?: float|null, + * thumbnailURL?: string, + * url?: string, + * versionInfo?: VersionInfo, + * videoCodec?: string, + * width?: float, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FileUploadResponse implements BaseModel { diff --git a/src/Files/FileUploadResponse/AITag.php b/src/Files/FileUploadResponse/AITag.php index 547bcb68..1b0ed295 100644 --- a/src/Files/FileUploadResponse/AITag.php +++ b/src/Files/FileUploadResponse/AITag.php @@ -9,9 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type ai_tag = array{ - * confidence?: float|null, name?: string|null, source?: string|null - * } + * @phpstan-type ai_tag = array{confidence?: float, name?: string, source?: string} */ final class AITag implements BaseModel { diff --git a/src/Files/FileUploadResponse/ExtensionStatus.php b/src/Files/FileUploadResponse/ExtensionStatus.php index 498b1b07..1223d021 100644 --- a/src/Files/FileUploadResponse/ExtensionStatus.php +++ b/src/Files/FileUploadResponse/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: value-of|null, - * awsAutoTagging?: value-of|null, - * googleAutoTagging?: value-of|null, - * removeBg?: value-of|null, + * aiAutoDescription?: value-of, + * awsAutoTagging?: value-of, + * googleAutoTagging?: value-of, + * removeBg?: value-of, * } */ final class ExtensionStatus implements BaseModel diff --git a/src/Files/FileUploadResponse/VersionInfo.php b/src/Files/FileUploadResponse/VersionInfo.php index 3aa4fdcb..2cac6409 100644 --- a/src/Files/FileUploadResponse/VersionInfo.php +++ b/src/Files/FileUploadResponse/VersionInfo.php @@ -11,7 +11,7 @@ /** * An object containing the file or file version's `id` (versionId) and `name`. * - * @phpstan-type version_info = array{id?: string|null, name?: string|null} + * @phpstan-type version_info = array{id?: string, name?: string} */ final class VersionInfo implements BaseModel { diff --git a/src/Files/Folder.php b/src/Files/Folder.php index bc8e3e74..c3941041 100644 --- a/src/Files/Folder.php +++ b/src/Files/Folder.php @@ -11,12 +11,12 @@ /** * @phpstan-type folder_alias = array{ - * createdAt?: \DateTimeInterface|null, - * folderID?: string|null, - * folderPath?: string|null, - * name?: string|null, - * type?: value-of|null, - * updatedAt?: \DateTimeInterface|null, + * createdAt?: \DateTimeInterface, + * folderID?: string, + * folderPath?: string, + * name?: string, + * type?: value-of, + * updatedAt?: \DateTimeInterface, * } */ final class Folder implements BaseModel diff --git a/src/Files/Metadata.php b/src/Files/Metadata.php index 9350cf83..b8e41f1b 100644 --- a/src/Files/Metadata.php +++ b/src/Files/Metadata.php @@ -13,20 +13,20 @@ * JSON object containing metadata. * * @phpstan-type metadata_alias = array{ - * audioCodec?: string|null, - * bitRate?: int|null, - * density?: int|null, - * duration?: int|null, - * exif?: Exif|null, - * format?: string|null, - * hasColorProfile?: bool|null, - * hasTransparency?: bool|null, - * height?: int|null, - * pHash?: string|null, - * quality?: int|null, - * size?: int|null, - * videoCodec?: string|null, - * width?: int|null, + * audioCodec?: string, + * bitRate?: int, + * density?: int, + * duration?: int, + * exif?: Exif, + * format?: string, + * hasColorProfile?: bool, + * hasTransparency?: bool, + * height?: int, + * pHash?: string, + * quality?: int, + * size?: int, + * videoCodec?: string, + * width?: int, * } */ final class Metadata implements BaseModel diff --git a/src/Files/Metadata/Exif.php b/src/Files/Metadata/Exif.php index a1815e9d..d30c8329 100644 --- a/src/Files/Metadata/Exif.php +++ b/src/Files/Metadata/Exif.php @@ -15,12 +15,12 @@ /** * @phpstan-type exif_alias = array{ - * exif?: Exif1|null, - * gps?: Gps|null, - * image?: Image|null, - * interoperability?: Interoperability|null, - * makernote?: array|null, - * thumbnail?: Thumbnail|null, + * exif?: Exif1, + * gps?: Gps, + * image?: Image, + * interoperability?: Interoperability, + * makernote?: array, + * thumbnail?: Thumbnail, * } */ final class Exif implements BaseModel diff --git a/src/Files/Metadata/Exif/Exif.php b/src/Files/Metadata/Exif/Exif.php index 1bd947ab..a722094e 100644 --- a/src/Files/Metadata/Exif/Exif.php +++ b/src/Files/Metadata/Exif/Exif.php @@ -12,32 +12,32 @@ * Object containing Exif details. * * @phpstan-type exif_alias = array{ - * apertureValue?: float|null, - * colorSpace?: int|null, - * createDate?: string|null, - * customRendered?: int|null, - * dateTimeOriginal?: string|null, - * exifImageHeight?: int|null, - * exifImageWidth?: int|null, - * exifVersion?: string|null, - * exposureCompensation?: float|null, - * exposureMode?: int|null, - * exposureProgram?: int|null, - * exposureTime?: float|null, - * flash?: int|null, - * flashpixVersion?: string|null, - * fNumber?: float|null, - * focalLength?: int|null, - * focalPlaneResolutionUnit?: int|null, - * focalPlaneXResolution?: float|null, - * focalPlaneYResolution?: float|null, - * interopOffset?: int|null, - * iso?: int|null, - * meteringMode?: int|null, - * sceneCaptureType?: int|null, - * shutterSpeedValue?: float|null, - * subSecTime?: string|null, - * whiteBalance?: int|null, + * apertureValue?: float, + * colorSpace?: int, + * createDate?: string, + * customRendered?: int, + * dateTimeOriginal?: string, + * exifImageHeight?: int, + * exifImageWidth?: int, + * exifVersion?: string, + * exposureCompensation?: float, + * exposureMode?: int, + * exposureProgram?: int, + * exposureTime?: float, + * flash?: int, + * flashpixVersion?: string, + * fNumber?: float, + * focalLength?: int, + * focalPlaneResolutionUnit?: int, + * focalPlaneXResolution?: float, + * focalPlaneYResolution?: float, + * interopOffset?: int, + * iso?: int, + * meteringMode?: int, + * sceneCaptureType?: int, + * shutterSpeedValue?: float, + * subSecTime?: string, + * whiteBalance?: int, * } */ final class Exif implements BaseModel diff --git a/src/Files/Metadata/Exif/Gps.php b/src/Files/Metadata/Exif/Gps.php index 9f4d027f..b7504be0 100644 --- a/src/Files/Metadata/Exif/Gps.php +++ b/src/Files/Metadata/Exif/Gps.php @@ -11,7 +11,7 @@ /** * Object containing GPS information. * - * @phpstan-type gps_alias = array{gpsVersionID?: list|null} + * @phpstan-type gps_alias = array{gpsVersionID?: list} */ final class Gps implements BaseModel { diff --git a/src/Files/Metadata/Exif/Image.php b/src/Files/Metadata/Exif/Image.php index 2d66f0d4..08c520ff 100644 --- a/src/Files/Metadata/Exif/Image.php +++ b/src/Files/Metadata/Exif/Image.php @@ -12,17 +12,17 @@ * Object containing EXIF image information. * * @phpstan-type image_alias = array{ - * exifOffset?: int|null, - * gpsInfo?: int|null, - * make?: string|null, - * model?: string|null, - * modifyDate?: string|null, - * orientation?: int|null, - * resolutionUnit?: int|null, - * software?: string|null, - * xResolution?: int|null, - * yCbCrPositioning?: int|null, - * yResolution?: int|null, + * exifOffset?: int, + * gpsInfo?: int, + * make?: string, + * model?: string, + * modifyDate?: string, + * orientation?: int, + * resolutionUnit?: int, + * software?: string, + * xResolution?: int, + * yCbCrPositioning?: int, + * yResolution?: int, * } */ final class Image implements BaseModel diff --git a/src/Files/Metadata/Exif/Interoperability.php b/src/Files/Metadata/Exif/Interoperability.php index 80632026..bc7b65f2 100644 --- a/src/Files/Metadata/Exif/Interoperability.php +++ b/src/Files/Metadata/Exif/Interoperability.php @@ -12,7 +12,7 @@ * JSON object. * * @phpstan-type interoperability_alias = array{ - * interopIndex?: string|null, interopVersion?: string|null + * interopIndex?: string, interopVersion?: string * } */ final class Interoperability implements BaseModel diff --git a/src/Files/Metadata/Exif/Thumbnail.php b/src/Files/Metadata/Exif/Thumbnail.php index b1dd809c..886948fd 100644 --- a/src/Files/Metadata/Exif/Thumbnail.php +++ b/src/Files/Metadata/Exif/Thumbnail.php @@ -12,12 +12,12 @@ * Object containing Thumbnail information. * * @phpstan-type thumbnail_alias = array{ - * compression?: int|null, - * resolutionUnit?: int|null, - * thumbnailLength?: int|null, - * thumbnailOffset?: int|null, - * xResolution?: int|null, - * yResolution?: int|null, + * compression?: int, + * resolutionUnit?: int, + * thumbnailLength?: int, + * thumbnailOffset?: int, + * xResolution?: int, + * yResolution?: int, * } */ final class Thumbnail implements BaseModel diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php index 77371818..4b005ce2 100644 --- a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php +++ b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php @@ -10,7 +10,7 @@ use ImageKit\Files\UpdateFileDetailsRequest\ChangePublicationStatus\Publish; /** - * @phpstan-type change_publication_status = array{publish?: Publish|null} + * @phpstan-type change_publication_status = array{publish?: Publish} */ final class ChangePublicationStatus implements BaseModel { diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php index 0569b9d2..8fddee82 100644 --- a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php +++ b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php @@ -12,7 +12,7 @@ * Configure the publication status of a file and its versions. * * @phpstan-type publish_alias = array{ - * isPublished: bool, includeFileVersions?: bool|null + * isPublished: bool, includeFileVersions?: bool * } */ final class Publish implements BaseModel diff --git a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php index 7a5bb6ac..5b6149f1 100644 --- a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php +++ b/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php @@ -16,12 +16,12 @@ /** * @phpstan-type update_file_details = array{ * customCoordinates?: string|null, - * customMetadata?: array|null, - * description?: string|null, - * extensions?: list|null, - * removeAITags?: string|null|list, + * customMetadata?: array, + * description?: string, + * extensions?: list, + * removeAITags?: string|list, * tags?: list|null, - * webhookURL?: string|null, + * webhookURL?: string, * } */ final class UpdateFileDetails implements BaseModel diff --git a/src/Files/Versions/VersionDeleteResponse.php b/src/Files/Versions/VersionDeleteResponse.php index 39c07a2d..2ea1e5db 100644 --- a/src/Files/Versions/VersionDeleteResponse.php +++ b/src/Files/Versions/VersionDeleteResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type version_delete_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class VersionDeleteResponse implements BaseModel { diff --git a/src/Folders/FolderCopyResponse.php b/src/Folders/FolderCopyResponse.php index 81c8daa4..d5a6e512 100644 --- a/src/Folders/FolderCopyResponse.php +++ b/src/Folders/FolderCopyResponse.php @@ -12,6 +12,10 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_copy_response = array{jobID: string} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FolderCopyResponse implements BaseModel { diff --git a/src/Folders/FolderDeleteResponse.php b/src/Folders/FolderDeleteResponse.php index c7a62789..76a91706 100644 --- a/src/Folders/FolderDeleteResponse.php +++ b/src/Folders/FolderDeleteResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type folder_delete_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FolderDeleteResponse implements BaseModel { diff --git a/src/Folders/FolderMoveResponse.php b/src/Folders/FolderMoveResponse.php index 5d767f7b..4c02d487 100644 --- a/src/Folders/FolderMoveResponse.php +++ b/src/Folders/FolderMoveResponse.php @@ -12,6 +12,10 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_move_response = array{jobID: string} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FolderMoveResponse implements BaseModel { diff --git a/src/Folders/FolderNewResponse.php b/src/Folders/FolderNewResponse.php index f8ce7b88..40b0344b 100644 --- a/src/Folders/FolderNewResponse.php +++ b/src/Folders/FolderNewResponse.php @@ -9,6 +9,10 @@ /** * @phpstan-type folder_new_response = array{} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FolderNewResponse implements BaseModel { diff --git a/src/Folders/FolderRenameResponse.php b/src/Folders/FolderRenameResponse.php index 15f1cacb..e8913e95 100644 --- a/src/Folders/FolderRenameResponse.php +++ b/src/Folders/FolderRenameResponse.php @@ -12,6 +12,10 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_rename_response = array{jobID: string} + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class FolderRenameResponse implements BaseModel { diff --git a/src/Folders/Job/JobGetResponse.php b/src/Folders/Job/JobGetResponse.php index 5b84581e..b7c91030 100644 --- a/src/Folders/Job/JobGetResponse.php +++ b/src/Folders/Job/JobGetResponse.php @@ -12,11 +12,15 @@ /** * @phpstan-type job_get_response = array{ - * jobID?: string|null, - * purgeRequestID?: string|null, - * status?: value-of|null, - * type?: value-of|null, + * jobID?: string, + * purgeRequestID?: string, + * status?: value-of, + * type?: value-of, * } + * When used in a response, this type parameter can be used to define a $rawResponse property. + * @template TRawResponse of object = object{} + * + * @mixin TRawResponse */ final class JobGetResponse implements BaseModel { diff --git a/src/ImageOverlay.php b/src/ImageOverlay.php index 4ccf310f..beae7150 100644 --- a/src/ImageOverlay.php +++ b/src/ImageOverlay.php @@ -10,16 +10,16 @@ use ImageKit\ImageOverlay\Encoding; /** - * @phpstan-type image_overlay = array{ + * @phpstan-type unnamed_type_with_intersection_parent0 = array{ * input: string, * type: string, - * encoding?: value-of|null, - * transformation?: list|null, + * encoding?: value-of, + * transformation?: list, * } */ final class ImageOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/OverlayPosition.php b/src/OverlayPosition.php index f93d46d2..8d2fab24 100644 --- a/src/OverlayPosition.php +++ b/src/OverlayPosition.php @@ -11,7 +11,7 @@ /** * @phpstan-type overlay_position = array{ - * focus?: value-of|null, x?: float|string|null, y?: float|string|null + * focus?: value-of, x?: float|string, y?: float|string * } */ final class OverlayPosition implements BaseModel diff --git a/src/OverlayTiming.php b/src/OverlayTiming.php index f7498c10..3a0bc5d4 100644 --- a/src/OverlayTiming.php +++ b/src/OverlayTiming.php @@ -10,9 +10,7 @@ /** * @phpstan-type overlay_timing = array{ - * duration?: float|string|null, - * end?: float|string|null, - * start?: float|string|null, + * duration?: float|string, end?: float|string, start?: float|string * } */ final class OverlayTiming implements BaseModel diff --git a/src/ServiceContracts/Accounts/URLEndpointsContract.php b/src/ServiceContracts/Accounts/URLEndpointsContract.php index 2f58ce7e..fa3c4c39 100644 --- a/src/ServiceContracts/Accounts/URLEndpointsContract.php +++ b/src/ServiceContracts/Accounts/URLEndpointsContract.php @@ -11,6 +11,7 @@ use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Akamai as Akamai1; use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Cloudinary as Cloudinary1; use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Imgix as Imgix1; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use const ImageKit\Core\OMIT as omit; @@ -24,6 +25,8 @@ interface URLEndpointsContract * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting + * + * @return URLEndpointResponse */ public function create( $description, @@ -40,6 +43,8 @@ public function create( * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting + * + * @return URLEndpointResponse */ public function update( string $id, @@ -69,6 +74,8 @@ public function delete( /** * @api + * + * @return URLEndpointResponse */ public function get( string $id, diff --git a/src/ServiceContracts/Accounts/UsageContract.php b/src/ServiceContracts/Accounts/UsageContract.php index d9db2280..e5394019 100644 --- a/src/ServiceContracts/Accounts/UsageContract.php +++ b/src/ServiceContracts/Accounts/UsageContract.php @@ -5,6 +5,7 @@ namespace ImageKit\ServiceContracts\Accounts; use ImageKit\Accounts\Usage\UsageGetResponse; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; interface UsageContract @@ -14,6 +15,8 @@ interface UsageContract * * @param \DateTimeInterface $endDate Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. The difference between `startDate` and `endDate` should be less than 90 days. * @param \DateTimeInterface $startDate Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. + * + * @return UsageGetResponse */ public function get( $endDate, diff --git a/src/ServiceContracts/Beta/V2/FilesContract.php b/src/ServiceContracts/Beta/V2/FilesContract.php index ddb27113..1c3d78cc 100644 --- a/src/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/ServiceContracts/Beta/V2/FilesContract.php @@ -7,6 +7,7 @@ use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; @@ -71,6 +72,8 @@ interface FilesContract * * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * + * @return FileUploadResponse */ public function upload( $file, diff --git a/src/ServiceContracts/Cache/InvalidationContract.php b/src/ServiceContracts/Cache/InvalidationContract.php index 0578aba6..0af6ded2 100644 --- a/src/ServiceContracts/Cache/InvalidationContract.php +++ b/src/ServiceContracts/Cache/InvalidationContract.php @@ -6,6 +6,7 @@ use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; interface InvalidationContract @@ -14,6 +15,8 @@ interface InvalidationContract * @api * * @param string $url the full URL of the file to be purged + * + * @return InvalidationNewResponse */ public function create( $url, @@ -22,6 +25,8 @@ public function create( /** * @api + * + * @return InvalidationGetResponse */ public function get( string $requestID, diff --git a/src/ServiceContracts/CustomMetadataFieldsContract.php b/src/ServiceContracts/CustomMetadataFieldsContract.php index 64f8b62b..a2df4699 100644 --- a/src/ServiceContracts/CustomMetadataFieldsContract.php +++ b/src/ServiceContracts/CustomMetadataFieldsContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; use ImageKit\CustomMetadataFields\CustomMetadataFieldDeleteResponse; @@ -20,6 +21,8 @@ interface CustomMetadataFieldsContract * @param string $label Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. * @param string $name API name of the custom metadata field. This should be unique across all (including deleted) custom metadata fields. * @param Schema $schema + * + * @return CustomMetadataField */ public function create( $label, @@ -33,6 +36,8 @@ public function create( * * @param string $label Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if `schema` is not provided. * @param Schema1 $schema An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. + * + * @return CustomMetadataField */ public function update( string $id, @@ -55,6 +60,8 @@ public function list( /** * @api + * + * @return CustomMetadataFieldDeleteResponse */ public function delete( string $id, diff --git a/src/ServiceContracts/Files/BulkContract.php b/src/ServiceContracts/Files/BulkContract.php index c1c7de85..67447c41 100644 --- a/src/ServiceContracts/Files/BulkContract.php +++ b/src/ServiceContracts/Files/BulkContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Files; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\Bulk\BulkAddTagsResponse; use ImageKit\Files\Bulk\BulkDeleteResponse; use ImageKit\Files\Bulk\BulkRemoveAITagsResponse; @@ -16,6 +17,8 @@ interface BulkContract * @api * * @param list $fileIDs an array of fileIds which you want to delete + * + * @return BulkDeleteResponse */ public function delete( $fileIDs, @@ -27,6 +30,8 @@ public function delete( * * @param list $fileIDs an array of fileIds to which you want to add tags * @param list $tags an array of tags that you want to add to the files + * + * @return BulkAddTagsResponse */ public function addTags( $fileIDs, @@ -39,6 +44,8 @@ public function addTags( * * @param list $aiTags an array of AITags that you want to remove from the files * @param list $fileIDs an array of fileIds from which you want to remove AITags + * + * @return BulkRemoveAITagsResponse */ public function removeAITags( $aiTags, @@ -51,6 +58,8 @@ public function removeAITags( * * @param list $fileIDs an array of fileIds from which you want to remove tags * @param list $tags an array of tags that you want to remove from the files + * + * @return BulkRemoveTagsResponse */ public function removeTags( $fileIDs, diff --git a/src/ServiceContracts/Files/VersionsContract.php b/src/ServiceContracts/Files/VersionsContract.php index ae4d43f6..2b95b688 100644 --- a/src/ServiceContracts/Files/VersionsContract.php +++ b/src/ServiceContracts/Files/VersionsContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Files; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteResponse; use ImageKit\RequestOptions; @@ -24,6 +25,8 @@ public function list( * @api * * @param string $fileID + * + * @return VersionDeleteResponse */ public function delete( string $versionID, @@ -35,6 +38,8 @@ public function delete( * @api * * @param string $fileID + * + * @return File */ public function get( string $versionID, @@ -46,6 +51,8 @@ public function get( * @api * * @param string $fileID + * + * @return File */ public function restore( string $versionID, diff --git a/src/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php index a63bca0e..5f2c79ea 100644 --- a/src/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; @@ -38,6 +39,8 @@ interface FilesContract * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * @param Publish $publish configure the publication status of a file and its versions + * + * @return FileUpdateResponse */ public function update( string $fileID, @@ -66,6 +69,8 @@ public function delete( * @param string $destinationPath full path to the folder you want to copy the above file into * @param string $sourceFilePath the full path of the file you want to copy * @param bool $includeFileVersions Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. + * + * @return FileCopyResponse */ public function copy( $destinationPath, @@ -76,6 +81,8 @@ public function copy( /** * @api + * + * @return File */ public function get( string $fileID, @@ -87,6 +94,8 @@ public function get( * * @param string $destinationPath full path to the folder you want to move the above file into * @param string $sourceFilePath the full path of the file you want to move + * + * @return FileMoveResponse */ public function move( $destinationPath, @@ -110,7 +119,7 @@ public function move( * * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * - * Default value - `false` + * @return FileRenameResponse */ public function rename( $filePath, @@ -194,6 +203,8 @@ public function rename( * * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * + * @return FileUploadResponse */ public function upload( $file, diff --git a/src/ServiceContracts/Folders/JobContract.php b/src/ServiceContracts/Folders/JobContract.php index ba4dcfe0..8e59f85a 100644 --- a/src/ServiceContracts/Folders/JobContract.php +++ b/src/ServiceContracts/Folders/JobContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Folders; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; @@ -11,6 +12,8 @@ interface JobContract { /** * @api + * + * @return JobGetResponse */ public function get( string $jobID, diff --git a/src/ServiceContracts/FoldersContract.php b/src/ServiceContracts/FoldersContract.php index 04943640..e0cf7964 100644 --- a/src/ServiceContracts/FoldersContract.php +++ b/src/ServiceContracts/FoldersContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\FolderCopyResponse; use ImageKit\Folders\FolderDeleteResponse; use ImageKit\Folders\FolderMoveResponse; @@ -24,6 +25,8 @@ interface FoldersContract * @param string $parentFolderPath The folder where the new folder should be created, for root use `/` else the path e.g. `containing/folder/`. * * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. + * + * @return FolderNewResponse */ public function create( $folderName, @@ -35,6 +38,8 @@ public function create( * @api * * @param string $folderPath Full path to the folder you want to delete. For example `/folder/to/delete/`. + * + * @return FolderDeleteResponse */ public function delete( $folderPath, @@ -47,6 +52,8 @@ public function delete( * @param string $destinationPath full path to the destination folder where you want to copy the source folder into * @param string $sourceFolderPath the full path to the source folder you want to copy * @param bool $includeVersions Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. + * + * @return FolderCopyResponse */ public function copy( $destinationPath, @@ -60,6 +67,8 @@ public function copy( * * @param string $destinationPath full path to the destination folder where you want to move the source folder into * @param string $sourceFolderPath the full path to the source folder you want to move + * + * @return FolderMoveResponse */ public function move( $destinationPath, @@ -81,6 +90,8 @@ public function move( * Note: A purge cache request will be issued against `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * * Default value - `false` + * + * @return FolderRenameResponse */ public function rename( $folderPath, diff --git a/src/Services/Accounts/URLEndpointsService.php b/src/Services/Accounts/URLEndpointsService.php index 763e54d1..dc598951 100644 --- a/src/Services/Accounts/URLEndpointsService.php +++ b/src/Services/Accounts/URLEndpointsService.php @@ -15,6 +15,7 @@ use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Imgix as Imgix1; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Accounts\URLEndpointsContract; @@ -37,6 +38,8 @@ public function __construct(private Client $client) {} * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting + * + * @return URLEndpointResponse */ public function create( $description, @@ -75,6 +78,8 @@ public function create( * @param list $origins Ordered list of origin IDs to try when the file isn’t in the Media Library; ImageKit checks them in the sequence provided. Origin must be created before it can be used in a URL endpoint. * @param string $urlPrefix path segment appended to your base URL to form the endpoint (letters, digits, and hyphens only — or empty for the default endpoint) * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting + * + * @return URLEndpointResponse */ public function update( string $id, @@ -147,6 +152,8 @@ public function delete( * * **Note:** This API is currently in beta. * Retrieves the URL‑endpoint identified by `id`. + * + * @return URLEndpointResponse */ public function get( string $id, diff --git a/src/Services/Accounts/UsageService.php b/src/Services/Accounts/UsageService.php index b4fd1286..73f0843a 100644 --- a/src/Services/Accounts/UsageService.php +++ b/src/Services/Accounts/UsageService.php @@ -7,6 +7,7 @@ use ImageKit\Accounts\Usage\UsageGetParams; use ImageKit\Accounts\Usage\UsageGetResponse; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Accounts\UsageContract; @@ -24,6 +25,8 @@ public function __construct(private Client $client) {} * * @param \DateTimeInterface $endDate Specify a `endDate` in `YYYY-MM-DD` format. It should be after the `startDate`. The difference between `startDate` and `endDate` should be less than 90 days. * @param \DateTimeInterface $startDate Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. + * + * @return UsageGetResponse */ public function get( $endDate, diff --git a/src/Services/AccountsService.php b/src/Services/AccountsService.php index 52fd692d..7c650ecd 100644 --- a/src/Services/AccountsService.php +++ b/src/Services/AccountsService.php @@ -32,8 +32,8 @@ final class AccountsService implements AccountsContract */ public function __construct(private Client $client) { - $this->usage = new UsageService($this->client); - $this->origins = new OriginsService($this->client); - $this->urlEndpoints = new URLEndpointsService($this->client); + $this->usage = new UsageService($client); + $this->origins = new OriginsService($client); + $this->urlEndpoints = new URLEndpointsService($client); } } diff --git a/src/Services/Beta/V2/FilesService.php b/src/Services/Beta/V2/FilesService.php index 66e9c39a..e9c3732f 100644 --- a/src/Services/Beta/V2/FilesService.php +++ b/src/Services/Beta/V2/FilesService.php @@ -9,6 +9,7 @@ use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; @@ -94,6 +95,8 @@ public function __construct(private Client $client) {} * * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * + * @return FileUploadResponse */ public function upload( $file, diff --git a/src/Services/Beta/V2Service.php b/src/Services/Beta/V2Service.php index 4cddd5bd..0208080d 100644 --- a/src/Services/Beta/V2Service.php +++ b/src/Services/Beta/V2Service.php @@ -20,6 +20,6 @@ final class V2Service implements V2Contract */ public function __construct(private Client $client) { - $this->files = new FilesService($this->client); + $this->files = new FilesService($client); } } diff --git a/src/Services/BetaService.php b/src/Services/BetaService.php index d6cecb03..b7d9ee63 100644 --- a/src/Services/BetaService.php +++ b/src/Services/BetaService.php @@ -20,6 +20,6 @@ final class BetaService implements BetaContract */ public function __construct(private Client $client) { - $this->v2 = new V2Service($this->client); + $this->v2 = new V2Service($client); } } diff --git a/src/Services/Cache/InvalidationService.php b/src/Services/Cache/InvalidationService.php index 6cc46054..e4038f16 100644 --- a/src/Services/Cache/InvalidationService.php +++ b/src/Services/Cache/InvalidationService.php @@ -8,6 +8,7 @@ use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Cache\InvalidationContract; @@ -24,6 +25,8 @@ public function __construct(private Client $client) {} * This API will purge CDN cache and ImageKit.io's internal cache for a file. Note: Purge cache is an asynchronous process and it may take some time to reflect the changes. * * @param string $url the full URL of the file to be purged + * + * @return InvalidationNewResponse */ public function create( $url, @@ -48,6 +51,8 @@ public function create( * @api * * This API returns the status of a purge cache request. + * + * @return InvalidationGetResponse */ public function get( string $requestID, diff --git a/src/Services/CacheService.php b/src/Services/CacheService.php index 89184440..ec45da51 100644 --- a/src/Services/CacheService.php +++ b/src/Services/CacheService.php @@ -20,6 +20,6 @@ final class CacheService implements CacheContract */ public function __construct(private Client $client) { - $this->invalidation = new InvalidationService($this->client); + $this->invalidation = new InvalidationService($client); } } diff --git a/src/Services/CustomMetadataFieldsService.php b/src/Services/CustomMetadataFieldsService.php index 928b43a8..1bc4a815 100644 --- a/src/Services/CustomMetadataFieldsService.php +++ b/src/Services/CustomMetadataFieldsService.php @@ -6,6 +6,7 @@ use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; @@ -33,6 +34,8 @@ public function __construct(private Client $client) {} * @param string $label Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. * @param string $name API name of the custom metadata field. This should be unique across all (including deleted) custom metadata fields. * @param Schema $schema + * + * @return CustomMetadataField */ public function create( $label, @@ -62,6 +65,8 @@ public function create( * * @param string $label Human readable name of the custom metadata field. This should be unique across all non deleted custom metadata fields. This name is displayed as form field label to the users while setting field value on an asset in the media library UI. This parameter is required if `schema` is not provided. * @param Schema1 $schema An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. + * + * @return CustomMetadataField */ public function update( string $id, @@ -116,6 +121,8 @@ public function list( * @api * * This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name. + * + * @return CustomMetadataFieldDeleteResponse */ public function delete( string $id, diff --git a/src/Services/Files/BulkService.php b/src/Services/Files/BulkService.php index 731db603..de2b2073 100644 --- a/src/Services/Files/BulkService.php +++ b/src/Services/Files/BulkService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services\Files; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\Bulk\BulkAddTagsParams; use ImageKit\Files\Bulk\BulkAddTagsResponse; use ImageKit\Files\Bulk\BulkDeleteParams; @@ -33,6 +34,8 @@ public function __construct(private Client $client) {} * A maximum of 100 files can be deleted at a time. * * @param list $fileIDs an array of fileIds which you want to delete + * + * @return BulkDeleteResponse */ public function delete( $fileIDs, @@ -60,6 +63,8 @@ public function delete( * * @param list $fileIDs an array of fileIds to which you want to add tags * @param list $tags an array of tags that you want to add to the files + * + * @return BulkAddTagsResponse */ public function addTags( $fileIDs, @@ -88,6 +93,8 @@ public function addTags( * * @param list $aiTags an array of AITags that you want to remove from the files * @param list $fileIDs an array of fileIds from which you want to remove AITags + * + * @return BulkRemoveAITagsResponse */ public function removeAITags( $aiTags, @@ -116,6 +123,8 @@ public function removeAITags( * * @param list $fileIDs an array of fileIds from which you want to remove tags * @param list $tags an array of tags that you want to remove from the files + * + * @return BulkRemoveTagsResponse */ public function removeTags( $fileIDs, diff --git a/src/Services/Files/VersionsService.php b/src/Services/Files/VersionsService.php index 62bb23b0..efaed2f4 100644 --- a/src/Services/Files/VersionsService.php +++ b/src/Services/Files/VersionsService.php @@ -6,6 +6,7 @@ use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteParams; use ImageKit\Files\Versions\VersionDeleteResponse; @@ -49,6 +50,8 @@ public function list( * Note: If you want to delete all versions of a file, use the delete file API. * * @param string $fileID + * + * @return VersionDeleteResponse */ public function delete( string $versionID, @@ -77,6 +80,8 @@ public function delete( * This API returns an object with details or attributes of a file version. * * @param string $fileID + * + * @return File */ public function get( string $versionID, @@ -105,6 +110,8 @@ public function get( * This API restores a file version as the current file version. * * @param string $fileID + * + * @return File */ public function restore( string $versionID, diff --git a/src/Services/FilesService.php b/src/Services/FilesService.php index deaf7864..3e5f6af1 100644 --- a/src/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; @@ -52,9 +53,9 @@ final class FilesService implements FilesContract */ public function __construct(private Client $client) { - $this->bulk = new BulkService($this->client); - $this->versions = new VersionsService($this->client); - $this->metadata = new MetadataService($this->client); + $this->bulk = new BulkService($client); + $this->versions = new VersionsService($client); + $this->metadata = new MetadataService($client); } /** @@ -75,6 +76,8 @@ public function __construct(private Client $client) * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * @param Publish $publish configure the publication status of a file and its versions + * + * @return FileUpdateResponse */ public function update( string $fileID, @@ -142,6 +145,8 @@ public function delete( * @param string $destinationPath full path to the folder you want to copy the above file into * @param string $sourceFilePath the full path of the file you want to copy * @param bool $includeFileVersions Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. + * + * @return FileCopyResponse */ public function copy( $destinationPath, @@ -172,6 +177,8 @@ public function copy( * @api * * This API returns an object with details or attributes about the current version of the file. + * + * @return File */ public function get( string $fileID, @@ -195,6 +202,8 @@ public function get( * * @param string $destinationPath full path to the folder you want to move the above file into * @param string $sourceFilePath the full path of the file you want to move + * + * @return FileMoveResponse */ public function move( $destinationPath, @@ -239,7 +248,7 @@ public function move( * * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * - * Default value - `false` + * @return FileRenameResponse */ public function rename( $filePath, @@ -356,6 +365,8 @@ public function rename( * * If `false`, then the image is uploaded with the provided filename parameter, and any existing file with the same name is replaced. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. + * + * @return FileUploadResponse */ public function upload( $file, diff --git a/src/Services/Folders/JobService.php b/src/Services/Folders/JobService.php index b7be4ac6..b525dda7 100644 --- a/src/Services/Folders/JobService.php +++ b/src/Services/Folders/JobService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services\Folders; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Folders\JobContract; @@ -20,6 +21,8 @@ public function __construct(private Client $client) {} * @api * * This API returns the status of a bulk job like copy and move folder operations. + * + * @return JobGetResponse */ public function get( string $jobID, diff --git a/src/Services/FoldersService.php b/src/Services/FoldersService.php index 4a6bd748..d4f5d8e9 100644 --- a/src/Services/FoldersService.php +++ b/src/Services/FoldersService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services; use ImageKit\Client; +use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\FolderCopyParams; use ImageKit\Folders\FolderCopyResponse; use ImageKit\Folders\FolderCreateParams; @@ -33,7 +34,7 @@ final class FoldersService implements FoldersContract */ public function __construct(private Client $client) { - $this->job = new JobService($this->client); + $this->job = new JobService($client); } /** @@ -47,6 +48,8 @@ public function __construct(private Client $client) * @param string $parentFolderPath The folder where the new folder should be created, for root use `/` else the path e.g. `containing/folder/`. * * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. + * + * @return FolderNewResponse */ public function create( $folderName, @@ -74,6 +77,8 @@ public function create( * This will delete a folder and all its contents permanently. The API returns an empty response. * * @param string $folderPath Full path to the folder you want to delete. For example `/folder/to/delete/`. + * + * @return FolderDeleteResponse */ public function delete( $folderPath, @@ -102,6 +107,8 @@ public function delete( * @param string $destinationPath full path to the destination folder where you want to copy the source folder into * @param string $sourceFolderPath the full path to the source folder you want to copy * @param bool $includeVersions Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. + * + * @return FolderCopyResponse */ public function copy( $destinationPath, @@ -135,6 +142,8 @@ public function copy( * * @param string $destinationPath full path to the destination folder where you want to move the source folder into * @param string $sourceFolderPath the full path to the source folder you want to move + * + * @return FolderMoveResponse */ public function move( $destinationPath, @@ -175,6 +184,8 @@ public function move( * Note: A purge cache request will be issued against `https://ik.imagekit.io/old/folder/path*` (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * * Default value - `false` + * + * @return FolderRenameResponse */ public function rename( $folderPath, diff --git a/src/SolidColorOverlay.php b/src/SolidColorOverlay.php index 95867fb4..a979ac98 100644 --- a/src/SolidColorOverlay.php +++ b/src/SolidColorOverlay.php @@ -9,15 +9,15 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type solid_color_overlay = array{ + * @phpstan-type unnamed_type_with_intersection_parent1 = array{ * color: string, * type: string, - * transformation?: list|null, + * transformation?: list, * } */ final class SolidColorOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/SolidColorOverlayTransformation.php b/src/SolidColorOverlayTransformation.php index dccceb17..98bd2814 100644 --- a/src/SolidColorOverlayTransformation.php +++ b/src/SolidColorOverlayTransformation.php @@ -10,12 +10,12 @@ /** * @phpstan-type solid_color_overlay_transformation = array{ - * alpha?: float|null, - * background?: string|null, - * gradient?: bool|string|null, - * height?: float|string|null, - * radius?: float|string|null, - * width?: float|string|null, + * alpha?: float, + * background?: string, + * gradient?: bool|string, + * height?: float|string, + * radius?: float|string, + * width?: float|string, * } */ final class SolidColorOverlayTransformation implements BaseModel diff --git a/src/SrcOptions.php b/src/SrcOptions.php index 8cc167f5..317d3e76 100644 --- a/src/SrcOptions.php +++ b/src/SrcOptions.php @@ -14,11 +14,11 @@ * @phpstan-type src_options = array{ * src: string, * urlEndpoint: string, - * expiresIn?: float|null, - * queryParameters?: array|null, - * signed?: bool|null, - * transformation?: list|null, - * transformationPosition?: value-of|null, + * expiresIn?: float, + * queryParameters?: array, + * signed?: bool, + * transformation?: list, + * transformationPosition?: value-of, * } */ final class SrcOptions implements BaseModel diff --git a/src/SubtitleOverlay.php b/src/SubtitleOverlay.php index 03537f39..79c765b4 100644 --- a/src/SubtitleOverlay.php +++ b/src/SubtitleOverlay.php @@ -10,16 +10,16 @@ use ImageKit\SubtitleOverlay\Encoding; /** - * @phpstan-type subtitle_overlay = array{ + * @phpstan-type unnamed_type_with_intersection_parent2 = array{ * input: string, * type: string, - * encoding?: value-of|null, - * transformation?: list|null, + * encoding?: value-of, + * transformation?: list, * } */ final class SubtitleOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/SubtitleOverlayTransformation.php b/src/SubtitleOverlayTransformation.php index 94ed6c23..69ca7e07 100644 --- a/src/SubtitleOverlayTransformation.php +++ b/src/SubtitleOverlayTransformation.php @@ -13,13 +13,13 @@ * Subtitle styling options. [Learn more](https://imagekit.io/docs/add-overlays-on-videos#styling-controls-for-subtitles-layer) from the docs. * * @phpstan-type subtitle_overlay_transformation = array{ - * background?: string|null, - * color?: string|null, - * fontFamily?: string|null, - * fontOutline?: string|null, - * fontShadow?: string|null, - * fontSize?: float|null, - * typography?: value-of|null, + * background?: string, + * color?: string, + * fontFamily?: string, + * fontOutline?: string, + * fontShadow?: string, + * fontSize?: float, + * typography?: value-of, * } */ final class SubtitleOverlayTransformation implements BaseModel diff --git a/src/TextOverlay.php b/src/TextOverlay.php index 24072937..b5747018 100644 --- a/src/TextOverlay.php +++ b/src/TextOverlay.php @@ -10,16 +10,16 @@ use ImageKit\TextOverlay\Encoding; /** - * @phpstan-type text_overlay = array{ + * @phpstan-type unnamed_type_with_intersection_parent3 = array{ * text: string, * type: string, - * encoding?: value-of|null, - * transformation?: list|null, + * encoding?: value-of, + * transformation?: list, * } */ final class TextOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/TextOverlayTransformation.php b/src/TextOverlayTransformation.php index c38b2805..6852822a 100644 --- a/src/TextOverlayTransformation.php +++ b/src/TextOverlayTransformation.php @@ -12,19 +12,19 @@ /** * @phpstan-type text_overlay_transformation = array{ - * alpha?: float|null, - * background?: string|null, - * flip?: value-of|null, - * fontColor?: string|null, - * fontFamily?: string|null, - * fontSize?: float|string|null, - * innerAlignment?: value-of|null, - * lineHeight?: float|string|null, - * padding?: float|string|null, - * radius?: float|string|null, - * rotation?: float|string|null, - * typography?: string|null, - * width?: float|string|null, + * alpha?: float, + * background?: string, + * flip?: value-of, + * fontColor?: string, + * fontFamily?: string, + * fontSize?: float|string, + * innerAlignment?: value-of, + * lineHeight?: float|string, + * padding?: float|string, + * radius?: float|string, + * rotation?: float|string, + * typography?: string, + * width?: float|string, * } */ final class TextOverlayTransformation implements BaseModel diff --git a/src/Transformation.php b/src/Transformation.php index cf555c31..6ac49613 100644 --- a/src/Transformation.php +++ b/src/Transformation.php @@ -21,58 +21,58 @@ * See the [Transformations documentation](https://imagekit.io/docs/transformations). * * @phpstan-type transformation_alias = array{ - * aiChangeBackground?: string|null, - * aiDropShadow?: bool|string|null, - * aiEdit?: string|null, - * aiRemoveBackground?: bool|null, - * aiRemoveBackgroundExternal?: bool|null, - * aiRetouch?: bool|null, - * aiUpscale?: bool|null, - * aiVariation?: bool|null, - * aspectRatio?: float|string|null, - * audioCodec?: value-of|null, - * background?: string|null, - * blur?: float|null, - * border?: string|null, - * colorProfile?: bool|null, - * contrastStretch?: bool|null, - * crop?: value-of|null, - * cropMode?: value-of|null, - * defaultImage?: string|null, - * dpr?: float|null, - * duration?: float|string|null, - * endOffset?: float|string|null, - * flip?: value-of|null, - * focus?: string|null, - * format?: value-of|null, - * gradient?: bool|string|null, - * grayscale?: bool|null, - * height?: float|string|null, - * lossless?: bool|null, - * metadata?: bool|null, - * named?: string|null, - * opacity?: float|null, - * original?: bool|null, - * overlay?: null|TextOverlay|ImageOverlay|VideoOverlay|SubtitleOverlay|SolidColorOverlay, - * page?: float|string|null, - * progressive?: bool|null, - * quality?: float|null, - * radius?: float|string|null, - * raw?: string|null, - * rotation?: float|string|null, - * shadow?: bool|string|null, - * sharpen?: bool|float|null, - * startOffset?: float|string|null, - * streamingResolutions?: list>|null, - * trim?: bool|float|null, - * unsharpMask?: bool|string|null, - * videoCodec?: value-of|null, - * width?: float|string|null, - * x?: float|string|null, - * xCenter?: float|string|null, - * y?: float|string|null, - * yCenter?: float|string|null, - * zoom?: float|null, + * aiChangeBackground?: string, + * aiDropShadow?: bool|string, + * aiEdit?: string, + * aiRemoveBackground?: bool, + * aiRemoveBackgroundExternal?: bool, + * aiRetouch?: bool, + * aiUpscale?: bool, + * aiVariation?: bool, + * aspectRatio?: float|string, + * audioCodec?: value-of, + * background?: string, + * blur?: float, + * border?: string, + * colorProfile?: bool, + * contrastStretch?: bool, + * crop?: value-of, + * cropMode?: value-of, + * defaultImage?: string, + * dpr?: float, + * duration?: float|string, + * endOffset?: float|string, + * flip?: value-of, + * focus?: string, + * format?: value-of, + * gradient?: bool|string, + * grayscale?: bool, + * height?: float|string, + * lossless?: bool, + * metadata?: bool, + * named?: string, + * opacity?: float, + * original?: bool, + * overlay?: Overlay, + * page?: float|string, + * progressive?: bool, + * quality?: float, + * radius?: float|string, + * raw?: string, + * rotation?: float|string, + * shadow?: bool|string, + * sharpen?: bool|float, + * startOffset?: float|string, + * streamingResolutions?: list>, + * trim?: bool|float, + * unsharpMask?: bool|string, + * videoCodec?: value-of, + * width?: float|string, + * x?: float|string, + * xCenter?: float|string, + * y?: float|string, + * yCenter?: float|string, + * zoom?: float, * } */ final class Transformation implements BaseModel diff --git a/src/VideoOverlay.php b/src/VideoOverlay.php index b754fd13..3135b391 100644 --- a/src/VideoOverlay.php +++ b/src/VideoOverlay.php @@ -10,16 +10,16 @@ use ImageKit\VideoOverlay\Encoding; /** - * @phpstan-type video_overlay = array{ + * @phpstan-type unnamed_type_with_intersection_parent4 = array{ * input: string, * type: string, - * encoding?: value-of|null, - * transformation?: list|null, + * encoding?: value-of, + * transformation?: list, * } */ final class VideoOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/UploadPostTransformErrorEvent.php b/src/Webhooks/UploadPostTransformErrorEvent.php index 22ad5804..97b13e0b 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent.php +++ b/src/Webhooks/UploadPostTransformErrorEvent.php @@ -13,13 +13,13 @@ /** * Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. * - * @phpstan-type upload_post_transform_error_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent5 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPostTransformErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php index ae9c6c78..19628e2c 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php +++ b/src/Webhooks/UploadPostTransformErrorEvent/Request/Transformation.php @@ -12,7 +12,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: value-of, protocol?: value-of|null, value?: string|null + * type: value-of, protocol?: value-of, value?: string * } */ final class Transformation implements BaseModel diff --git a/src/Webhooks/UploadPostTransformSuccessEvent.php b/src/Webhooks/UploadPostTransformSuccessEvent.php index f5cb4919..d1cfd485 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent.php @@ -13,13 +13,13 @@ /** * Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event. * - * @phpstan-type upload_post_transform_success_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent6 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPostTransformSuccessEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php index f57cb838..c0d9359f 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent/Request/Transformation.php @@ -12,7 +12,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: value-of, protocol?: value-of|null, value?: string|null + * type: value-of, protocol?: value-of, value?: string * } */ final class Transformation implements BaseModel diff --git a/src/Webhooks/UploadPreTransformErrorEvent.php b/src/Webhooks/UploadPreTransformErrorEvent.php index 03f76019..50f990ef 100644 --- a/src/Webhooks/UploadPreTransformErrorEvent.php +++ b/src/Webhooks/UploadPreTransformErrorEvent.php @@ -13,13 +13,13 @@ /** * Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. * - * @phpstan-type upload_pre_transform_error_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent7 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPreTransformErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/UploadPreTransformSuccessEvent.php b/src/Webhooks/UploadPreTransformSuccessEvent.php index ef1c0670..adf2b8e8 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent.php @@ -13,13 +13,13 @@ /** * Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. * - * @phpstan-type upload_pre_transform_success_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent8 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class UploadPreTransformSuccessEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data.php index e4553404..92f3dfa2 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data.php @@ -17,29 +17,29 @@ * * @phpstan-type data_alias = array{ * aiTags?: list|null, - * audioCodec?: string|null, - * bitRate?: int|null, + * audioCodec?: string, + * bitRate?: int, * customCoordinates?: string|null, - * customMetadata?: array|null, - * description?: string|null, - * duration?: int|null, - * embeddedMetadata?: array|null, - * extensionStatus?: ExtensionStatus|null, - * fileID?: string|null, - * filePath?: string|null, - * fileType?: string|null, - * height?: float|null, - * isPrivateFile?: bool|null, - * isPublished?: bool|null, - * metadata?: Metadata|null, - * name?: string|null, - * size?: float|null, + * customMetadata?: array, + * description?: string, + * duration?: int, + * embeddedMetadata?: array, + * extensionStatus?: ExtensionStatus, + * fileID?: string, + * filePath?: string, + * fileType?: string, + * height?: float, + * isPrivateFile?: bool, + * isPublished?: bool, + * metadata?: Metadata, + * name?: string, + * size?: float, * tags?: list|null, - * thumbnailURL?: string|null, - * url?: string|null, - * versionInfo?: VersionInfo|null, - * videoCodec?: string|null, - * width?: float|null, + * thumbnailURL?: string, + * url?: string, + * versionInfo?: VersionInfo, + * videoCodec?: string, + * width?: float, * } */ final class Data implements BaseModel diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php index e749ce23..502fbddc 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/AITag.php @@ -9,9 +9,7 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type ai_tag = array{ - * confidence?: float|null, name?: string|null, source?: string|null - * } + * @phpstan-type ai_tag = array{confidence?: float, name?: string, source?: string} */ final class AITag implements BaseModel { diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php index 8cd45604..e6e8f269 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/ExtensionStatus.php @@ -22,10 +22,10 @@ * If no extension was requested, then this parameter is not returned. * * @phpstan-type extension_status = array{ - * aiAutoDescription?: value-of|null, - * awsAutoTagging?: value-of|null, - * googleAutoTagging?: value-of|null, - * removeBg?: value-of|null, + * aiAutoDescription?: value-of, + * awsAutoTagging?: value-of, + * googleAutoTagging?: value-of, + * removeBg?: value-of, * } */ final class ExtensionStatus implements BaseModel diff --git a/src/Webhooks/UploadPreTransformSuccessEvent/Data/VersionInfo.php b/src/Webhooks/UploadPreTransformSuccessEvent/Data/VersionInfo.php index 4fd4ef83..eef154fc 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent/Data/VersionInfo.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent/Data/VersionInfo.php @@ -11,7 +11,7 @@ /** * An object containing the file or file version's `id` (versionId) and `name`. * - * @phpstan-type version_info = array{id?: string|null, name?: string|null} + * @phpstan-type version_info = array{id?: string, name?: string} */ final class VersionInfo implements BaseModel { diff --git a/src/Webhooks/VideoTransformationAcceptedEvent.php b/src/Webhooks/VideoTransformationAcceptedEvent.php index 6957bcca..931d780d 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent.php @@ -13,13 +13,13 @@ /** * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. * - * @phpstan-type video_transformation_accepted_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent9 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class VideoTransformationAcceptedEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php index 3e0c84d3..80b43edd 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation.php @@ -14,7 +14,7 @@ * Base information about a video transformation request. * * @phpstan-type transformation_alias = array{ - * type: value-of, options?: Options|null + * type: value-of, options?: Options * } */ final class Transformation implements BaseModel diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php index fb68a78c..34dfdffc 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: value-of|null, - * autoRotate?: bool|null, - * format?: value-of|null, - * quality?: int|null, - * streamProtocol?: value-of|null, - * variants?: list|null, - * videoCodec?: value-of|null, + * audioCodec?: value-of, + * autoRotate?: bool, + * format?: value-of, + * quality?: int, + * streamProtocol?: value-of, + * variants?: list, + * videoCodec?: value-of, * } */ final class Options implements BaseModel diff --git a/src/Webhooks/VideoTransformationAcceptedEvent/Request.php b/src/Webhooks/VideoTransformationAcceptedEvent/Request.php index 7b65fed1..122bc3fe 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent/Request.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent/Request.php @@ -12,7 +12,7 @@ * Information about the original request that triggered the video transformation. * * @phpstan-type request_alias = array{ - * url: string, xRequestID: string, userAgent?: string|null + * url: string, xRequestID: string, userAgent?: string * } */ final class Request implements BaseModel diff --git a/src/Webhooks/VideoTransformationErrorEvent.php b/src/Webhooks/VideoTransformationErrorEvent.php index 31aa4b8a..6b264bb8 100644 --- a/src/Webhooks/VideoTransformationErrorEvent.php +++ b/src/Webhooks/VideoTransformationErrorEvent.php @@ -13,13 +13,13 @@ /** * Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support. * - * @phpstan-type video_transformation_error_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent10 = array{ * createdAt: \DateTimeInterface, data: Data, request: Request, type: string * } */ final class VideoTransformationErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php index f7b4c774..df13aca2 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation.php @@ -13,7 +13,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: value-of, error?: Error|null, options?: Options|null + * type: value-of, error?: Error, options?: Options * } */ final class Transformation implements BaseModel diff --git a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php index f5a618ed..e8dacd9a 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: value-of|null, - * autoRotate?: bool|null, - * format?: value-of|null, - * quality?: int|null, - * streamProtocol?: value-of|null, - * variants?: list|null, - * videoCodec?: value-of|null, + * audioCodec?: value-of, + * autoRotate?: bool, + * format?: value-of, + * quality?: int, + * streamProtocol?: value-of, + * variants?: list, + * videoCodec?: value-of, * } */ final class Options implements BaseModel diff --git a/src/Webhooks/VideoTransformationErrorEvent/Request.php b/src/Webhooks/VideoTransformationErrorEvent/Request.php index d92cde1a..39fa8314 100644 --- a/src/Webhooks/VideoTransformationErrorEvent/Request.php +++ b/src/Webhooks/VideoTransformationErrorEvent/Request.php @@ -12,7 +12,7 @@ * Information about the original request that triggered the video transformation. * * @phpstan-type request_alias = array{ - * url: string, xRequestID: string, userAgent?: string|null + * url: string, xRequestID: string, userAgent?: string * } */ final class Request implements BaseModel diff --git a/src/Webhooks/VideoTransformationReadyEvent.php b/src/Webhooks/VideoTransformationReadyEvent.php index 688f66a9..ecbda8e3 100644 --- a/src/Webhooks/VideoTransformationReadyEvent.php +++ b/src/Webhooks/VideoTransformationReadyEvent.php @@ -14,17 +14,17 @@ /** * Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users. * - * @phpstan-type video_transformation_ready_event = array{ + * @phpstan-type unnamed_type_with_intersection_parent11 = array{ * createdAt: \DateTimeInterface, * data: Data, * request: Request, * type: string, - * timings?: Timings|null, + * timings?: Timings, * } */ final class VideoTransformationReadyEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php index 794423d6..9685a24e 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation.php @@ -13,7 +13,7 @@ /** * @phpstan-type transformation_alias = array{ - * type: value-of, options?: Options|null, output?: Output|null + * type: value-of, options?: Options, output?: Output * } */ final class Transformation implements BaseModel diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php index d1524f17..e44973ea 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Options.php @@ -16,13 +16,13 @@ * Configuration options for video transformations. * * @phpstan-type options_alias = array{ - * audioCodec?: value-of|null, - * autoRotate?: bool|null, - * format?: value-of|null, - * quality?: int|null, - * streamProtocol?: value-of|null, - * variants?: list|null, - * videoCodec?: value-of|null, + * audioCodec?: value-of, + * autoRotate?: bool, + * format?: value-of, + * quality?: int, + * streamProtocol?: value-of, + * variants?: list, + * videoCodec?: value-of, * } */ final class Options implements BaseModel diff --git a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output.php b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output.php index e620017b..83a5d424 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Data/Transformation/Output.php @@ -12,9 +12,7 @@ /** * Information about the transformed output video. * - * @phpstan-type output_alias = array{ - * url: string, videoMetadata?: VideoMetadata|null - * } + * @phpstan-type output_alias = array{url: string, videoMetadata?: VideoMetadata} */ final class Output implements BaseModel { diff --git a/src/Webhooks/VideoTransformationReadyEvent/Request.php b/src/Webhooks/VideoTransformationReadyEvent/Request.php index 2c97f621..e457dbc0 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Request.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Request.php @@ -12,7 +12,7 @@ * Information about the original request that triggered the video transformation. * * @phpstan-type request_alias = array{ - * url: string, xRequestID: string, userAgent?: string|null + * url: string, xRequestID: string, userAgent?: string * } */ final class Request implements BaseModel diff --git a/src/Webhooks/VideoTransformationReadyEvent/Timings.php b/src/Webhooks/VideoTransformationReadyEvent/Timings.php index 8ae42494..09655f08 100644 --- a/src/Webhooks/VideoTransformationReadyEvent/Timings.php +++ b/src/Webhooks/VideoTransformationReadyEvent/Timings.php @@ -12,7 +12,7 @@ * Performance metrics for the transformation process. * * @phpstan-type timings_alias = array{ - * downloadDuration?: int|null, encodingDuration?: int|null + * downloadDuration?: int, encodingDuration?: int * } */ final class Timings implements BaseModel From 049e837e2827e68c6cada81e7e35e3ddef23beb9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 13 Sep 2025 02:37:00 +0000 Subject: [PATCH 29/40] feat(client): add raw methods --- .../URLEndpoints/URLEndpointResponse.php | 2 +- src/Accounts/Usage/UsageGetResponse.php | 2 +- src/Beta/V2/Files/FileUploadResponse.php | 2 +- .../Invalidation/InvalidationGetResponse.php | 2 +- .../Invalidation/InvalidationNewResponse.php | 2 +- .../CustomMetadataField.php | 2 +- .../CustomMetadataFieldDeleteResponse.php | 2 +- src/Files/Bulk/BulkAddTagsResponse.php | 2 +- src/Files/Bulk/BulkDeleteResponse.php | 2 +- src/Files/Bulk/BulkRemoveAITagsResponse.php | 2 +- src/Files/Bulk/BulkRemoveTagsResponse.php | 2 +- src/Files/File.php | 2 +- src/Files/FileCopyResponse.php | 2 +- src/Files/FileMoveResponse.php | 2 +- src/Files/FileRenameResponse.php | 2 +- src/Files/FileUpdateResponse.php | 477 +++++++++++++++++- src/Files/FileUploadResponse.php | 2 +- src/Files/Versions/VersionDeleteResponse.php | 2 +- src/Folders/FolderCopyResponse.php | 2 +- src/Folders/FolderDeleteResponse.php | 2 +- src/Folders/FolderMoveResponse.php | 2 +- src/Folders/FolderNewResponse.php | 2 +- src/Folders/FolderRenameResponse.php | 2 +- src/Folders/Job/JobGetResponse.php | 2 +- src/ImageOverlay.php | 32 +- .../Accounts/OriginsContract.php | 70 +++ .../Accounts/URLEndpointsContract.php | 76 +++ .../Accounts/UsageContract.php | 17 + src/ServiceContracts/AssetsContract.php | 17 + .../Beta/V2/FilesContract.php | 17 + .../Cache/InvalidationContract.php | 32 ++ .../CustomMetadataFieldsContract.php | 65 +++ src/ServiceContracts/Files/BulkContract.php | 65 +++ .../Files/MetadataContract.php | 28 + .../Files/VersionsContract.php | 67 +++ src/ServiceContracts/FilesContract.php | 110 ++++ src/ServiceContracts/Folders/JobContract.php | 16 + src/ServiceContracts/FoldersContract.php | 81 +++ src/Services/Accounts/OriginsService.php | 186 +++++-- src/Services/Accounts/URLEndpointsService.php | 124 ++++- src/Services/Accounts/UsageService.php | 23 +- src/Services/AssetsService.php | 41 +- src/Services/Beta/V2/FilesService.php | 67 ++- src/Services/Cache/InvalidationService.php | 42 +- src/Services/CustomMetadataFieldsService.php | 87 +++- src/Services/Files/BulkService.php | 89 +++- src/Services/Files/MetadataService.php | 38 +- src/Services/Files/VersionsService.php | 89 +++- src/Services/FilesService.php | 245 +++++++-- src/Services/Folders/JobService.php | 20 + src/Services/FoldersService.php | 143 +++++- src/SolidColorOverlay.php | 34 +- src/SubtitleOverlay.php | 32 +- src/TextOverlay.php | 34 +- src/VideoOverlay.php | 32 +- .../UploadPostTransformErrorEvent.php | 55 +- .../UploadPostTransformSuccessEvent.php | 55 +- src/Webhooks/UploadPreTransformErrorEvent.php | 55 +- .../UploadPreTransformSuccessEvent.php | 55 +- .../VideoTransformationAcceptedEvent.php | 55 +- .../VideoTransformationErrorEvent.php | 55 +- .../VideoTransformationReadyEvent.php | 50 +- 62 files changed, 2658 insertions(+), 264 deletions(-) diff --git a/src/Accounts/URLEndpoints/URLEndpointResponse.php b/src/Accounts/URLEndpoints/URLEndpointResponse.php index 7199516a..f5aa9bd0 100644 --- a/src/Accounts/URLEndpoints/URLEndpointResponse.php +++ b/src/Accounts/URLEndpoints/URLEndpointResponse.php @@ -22,7 +22,7 @@ * urlPrefix: string, * urlRewriter?: Cloudinary|Imgix|Akamai, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Accounts/Usage/UsageGetResponse.php b/src/Accounts/Usage/UsageGetResponse.php index 0ec69d79..820b3a13 100644 --- a/src/Accounts/Usage/UsageGetResponse.php +++ b/src/Accounts/Usage/UsageGetResponse.php @@ -16,7 +16,7 @@ * originalCacheStorageBytes?: int, * videoProcessingUnitsCount?: int, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Beta/V2/Files/FileUploadResponse.php b/src/Beta/V2/Files/FileUploadResponse.php index 74ab2e43..aa068676 100644 --- a/src/Beta/V2/Files/FileUploadResponse.php +++ b/src/Beta/V2/Files/FileUploadResponse.php @@ -41,7 +41,7 @@ * videoCodec?: string, * width?: float, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Cache/Invalidation/InvalidationGetResponse.php b/src/Cache/Invalidation/InvalidationGetResponse.php index 4a853e75..789db9ba 100644 --- a/src/Cache/Invalidation/InvalidationGetResponse.php +++ b/src/Cache/Invalidation/InvalidationGetResponse.php @@ -11,7 +11,7 @@ /** * @phpstan-type invalidation_get_response = array{status?: value-of} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Cache/Invalidation/InvalidationNewResponse.php b/src/Cache/Invalidation/InvalidationNewResponse.php index 4597a296..93a2eadb 100644 --- a/src/Cache/Invalidation/InvalidationNewResponse.php +++ b/src/Cache/Invalidation/InvalidationNewResponse.php @@ -10,7 +10,7 @@ /** * @phpstan-type invalidation_new_response = array{requestID?: string} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/CustomMetadataFields/CustomMetadataField.php b/src/CustomMetadataFields/CustomMetadataField.php index c0a1045f..422a23e2 100644 --- a/src/CustomMetadataFields/CustomMetadataField.php +++ b/src/CustomMetadataFields/CustomMetadataField.php @@ -15,7 +15,7 @@ * @phpstan-type custom_metadata_field = array{ * id: string, label: string, name: string, schema: Schema * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php b/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php index 6bb1113d..0f11add0 100644 --- a/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php +++ b/src/CustomMetadataFields/CustomMetadataFieldDeleteResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type custom_metadata_field_delete_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/Bulk/BulkAddTagsResponse.php b/src/Files/Bulk/BulkAddTagsResponse.php index 54a2b004..70887d2e 100644 --- a/src/Files/Bulk/BulkAddTagsResponse.php +++ b/src/Files/Bulk/BulkAddTagsResponse.php @@ -12,7 +12,7 @@ * @phpstan-type bulk_add_tags_response = array{ * successfullyUpdatedFileIDs?: list * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/Bulk/BulkDeleteResponse.php b/src/Files/Bulk/BulkDeleteResponse.php index b0da1da0..895b2d29 100644 --- a/src/Files/Bulk/BulkDeleteResponse.php +++ b/src/Files/Bulk/BulkDeleteResponse.php @@ -12,7 +12,7 @@ * @phpstan-type bulk_delete_response = array{ * successfullyDeletedFileIDs?: list * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/Bulk/BulkRemoveAITagsResponse.php b/src/Files/Bulk/BulkRemoveAITagsResponse.php index 2946c9de..5c0820e2 100644 --- a/src/Files/Bulk/BulkRemoveAITagsResponse.php +++ b/src/Files/Bulk/BulkRemoveAITagsResponse.php @@ -12,7 +12,7 @@ * @phpstan-type bulk_remove_ai_tags_response = array{ * successfullyUpdatedFileIDs?: list * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/Bulk/BulkRemoveTagsResponse.php b/src/Files/Bulk/BulkRemoveTagsResponse.php index a82a0a8d..8a477675 100644 --- a/src/Files/Bulk/BulkRemoveTagsResponse.php +++ b/src/Files/Bulk/BulkRemoveTagsResponse.php @@ -12,7 +12,7 @@ * @phpstan-type bulk_remove_tags_response = array{ * successfullyUpdatedFileIDs?: list * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/File.php b/src/Files/File.php index 662ed6bd..cabba9f0 100644 --- a/src/Files/File.php +++ b/src/Files/File.php @@ -38,7 +38,7 @@ * versionInfo?: VersionInfo, * width?: float, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/FileCopyResponse.php b/src/Files/FileCopyResponse.php index 418bd983..f6f2abd5 100644 --- a/src/Files/FileCopyResponse.php +++ b/src/Files/FileCopyResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type file_copy_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/FileMoveResponse.php b/src/Files/FileMoveResponse.php index 78520bc8..f5c06a51 100644 --- a/src/Files/FileMoveResponse.php +++ b/src/Files/FileMoveResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type file_move_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/FileRenameResponse.php b/src/Files/FileRenameResponse.php index 91c59847..e18ed3fc 100644 --- a/src/Files/FileRenameResponse.php +++ b/src/Files/FileRenameResponse.php @@ -10,7 +10,7 @@ /** * @phpstan-type file_rename_response = array{purgeRequestID?: string} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/FileUpdateResponse.php b/src/Files/FileUpdateResponse.php index 7857e300..42fdf499 100644 --- a/src/Files/FileUpdateResponse.php +++ b/src/Files/FileUpdateResponse.php @@ -7,24 +7,189 @@ use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; use ImageKit\Core\Contracts\BaseModel; +use ImageKit\Files\File\AITag; +use ImageKit\Files\File\Type; +use ImageKit\Files\File\VersionInfo; use ImageKit\Files\FileUpdateResponse\ExtensionStatus; /** * Object containing details of a file or file version. * - * @phpstan-type unnamed_type_with_intersection_parent12 = array{ - * extensionStatus?: ExtensionStatus + * @phpstan-type file_update_response = array{ + * aiTags?: list|null, + * createdAt?: \DateTimeInterface, + * customCoordinates?: string|null, + * customMetadata?: array, + * description?: string, + * fileID?: string, + * filePath?: string, + * fileType?: string, + * hasAlpha?: bool, + * height?: float, + * isPrivateFile?: bool, + * isPublished?: bool, + * mime?: string, + * name?: string, + * size?: float, + * tags?: list|null, + * thumbnail?: string, + * type?: value-of, + * updatedAt?: \DateTimeInterface, + * url?: string, + * versionInfo?: VersionInfo, + * width?: float, + * extensionStatus?: ExtensionStatus, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse */ final class FileUpdateResponse implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * An array of tags assigned to the file by auto tagging. + * + * @var list|null $aiTags + */ + #[Api('AITags', list: AITag::class, nullable: true, optional: true)] + public ?array $aiTags; + + /** + * Date and time when the file was uploaded. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $createdAt; + + /** + * An string with custom coordinates of the file. + */ + #[Api(nullable: true, optional: true)] + public ?string $customCoordinates; + + /** + * An object with custom metadata for the file. + * + * @var array|null $customMetadata + */ + #[Api(map: 'mixed', optional: true)] + public ?array $customMetadata; + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + #[Api(optional: true)] + public ?string $description; + + /** + * Unique identifier of the asset. + */ + #[Api('fileId', optional: true)] + public ?string $fileID; + + /** + * Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be `/file.jpg`. If the file is inside a folder named `images`, the path will be `/images/file.jpg`. + */ + #[Api(optional: true)] + public ?string $filePath; + + /** + * Type of the file. Possible values are `image`, `non-image`. + */ + #[Api(optional: true)] + public ?string $fileType; + + /** + * Specifies if the image has an alpha channel. + */ + #[Api(optional: true)] + public ?bool $hasAlpha; + + /** + * Height of the file. + */ + #[Api(optional: true)] + public ?float $height; + + /** + * Specifies if the file is private or not. + */ + #[Api(optional: true)] + public ?bool $isPrivateFile; + + /** + * Specifies if the file is published or not. + */ + #[Api(optional: true)] + public ?bool $isPublished; + + /** + * MIME type of the file. + */ + #[Api(optional: true)] + public ?string $mime; + + /** + * Name of the asset. + */ + #[Api(optional: true)] + public ?string $name; + + /** + * Size of the file in bytes. + */ + #[Api(optional: true)] + public ?float $size; + + /** + * An array of tags assigned to the file. Tags are used to search files in the media library. + * + * @var list|null $tags + */ + #[Api(list: 'string', nullable: true, optional: true)] + public ?array $tags; + + /** + * URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library. + */ + #[Api(optional: true)] + public ?string $thumbnail; + + /** + * Type of the asset. + * + * @var value-of|null $type + */ + #[Api(enum: Type::class, optional: true)] + public ?string $type; + + /** + * Date and time when the file was last updated. The date and time is in ISO8601 format. + */ + #[Api(optional: true)] + public ?\DateTimeInterface $updatedAt; + + /** + * URL of the file. + */ + #[Api(optional: true)] + public ?string $url; + + /** + * An object with details of the file version. + */ + #[Api(optional: true)] + public ?VersionInfo $versionInfo; + + /** + * Width of the file. + */ + #[Api(optional: true)] + public ?float $width; + #[Api(optional: true)] public ?ExtensionStatus $extensionStatus; @@ -37,16 +202,316 @@ public function __construct() * Construct an instance from the required parameters. * * You must use named parameters to construct any parameters with a default value. + * + * @param list|null $aiTags + * @param array $customMetadata + * @param list|null $tags + * @param Type|value-of $type */ - public static function with(?ExtensionStatus $extensionStatus = null): self - { + public static function with( + ?array $aiTags = null, + ?\DateTimeInterface $createdAt = null, + ?string $customCoordinates = null, + ?array $customMetadata = null, + ?string $description = null, + ?string $fileID = null, + ?string $filePath = null, + ?string $fileType = null, + ?bool $hasAlpha = null, + ?float $height = null, + ?bool $isPrivateFile = null, + ?bool $isPublished = null, + ?string $mime = null, + ?string $name = null, + ?float $size = null, + ?array $tags = null, + ?string $thumbnail = null, + Type|string|null $type = null, + ?\DateTimeInterface $updatedAt = null, + ?string $url = null, + ?VersionInfo $versionInfo = null, + ?float $width = null, + ?ExtensionStatus $extensionStatus = null, + ): self { $obj = new self; + null !== $aiTags && $obj->aiTags = $aiTags; + null !== $createdAt && $obj->createdAt = $createdAt; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; + null !== $customMetadata && $obj->customMetadata = $customMetadata; + null !== $description && $obj->description = $description; + null !== $fileID && $obj->fileID = $fileID; + null !== $filePath && $obj->filePath = $filePath; + null !== $fileType && $obj->fileType = $fileType; + null !== $hasAlpha && $obj->hasAlpha = $hasAlpha; + null !== $height && $obj->height = $height; + null !== $isPrivateFile && $obj->isPrivateFile = $isPrivateFile; + null !== $isPublished && $obj->isPublished = $isPublished; + null !== $mime && $obj->mime = $mime; + null !== $name && $obj->name = $name; + null !== $size && $obj->size = $size; + null !== $tags && $obj->tags = $tags; + null !== $thumbnail && $obj->thumbnail = $thumbnail; + null !== $type && $obj->type = $type instanceof Type ? $type->value : $type; + null !== $updatedAt && $obj->updatedAt = $updatedAt; + null !== $url && $obj->url = $url; + null !== $versionInfo && $obj->versionInfo = $versionInfo; + null !== $width && $obj->width = $width; null !== $extensionStatus && $obj->extensionStatus = $extensionStatus; return $obj; } + /** + * An array of tags assigned to the file by auto tagging. + * + * @param list|null $aiTags + */ + public function withAITags(?array $aiTags): self + { + $obj = clone $this; + $obj->aiTags = $aiTags; + + return $obj; + } + + /** + * Date and time when the file was uploaded. The date and time is in ISO8601 format. + */ + public function withCreatedAt(\DateTimeInterface $createdAt): self + { + $obj = clone $this; + $obj->createdAt = $createdAt; + + return $obj; + } + + /** + * An string with custom coordinates of the file. + */ + public function withCustomCoordinates(?string $customCoordinates): self + { + $obj = clone $this; + $obj->customCoordinates = $customCoordinates; + + return $obj; + } + + /** + * An object with custom metadata for the file. + * + * @param array $customMetadata + */ + public function withCustomMetadata(array $customMetadata): self + { + $obj = clone $this; + $obj->customMetadata = $customMetadata; + + return $obj; + } + + /** + * Optional text to describe the contents of the file. Can be set by the user or the ai-auto-description extension. + */ + public function withDescription(string $description): self + { + $obj = clone $this; + $obj->description = $description; + + return $obj; + } + + /** + * Unique identifier of the asset. + */ + public function withFileID(string $fileID): self + { + $obj = clone $this; + $obj->fileID = $fileID; + + return $obj; + } + + /** + * Path of the file. This is the path you would use in the URL to access the file. For example, if the file is at the root of the media library, the path will be `/file.jpg`. If the file is inside a folder named `images`, the path will be `/images/file.jpg`. + */ + public function withFilePath(string $filePath): self + { + $obj = clone $this; + $obj->filePath = $filePath; + + return $obj; + } + + /** + * Type of the file. Possible values are `image`, `non-image`. + */ + public function withFileType(string $fileType): self + { + $obj = clone $this; + $obj->fileType = $fileType; + + return $obj; + } + + /** + * Specifies if the image has an alpha channel. + */ + public function withHasAlpha(bool $hasAlpha): self + { + $obj = clone $this; + $obj->hasAlpha = $hasAlpha; + + return $obj; + } + + /** + * Height of the file. + */ + public function withHeight(float $height): self + { + $obj = clone $this; + $obj->height = $height; + + return $obj; + } + + /** + * Specifies if the file is private or not. + */ + public function withIsPrivateFile(bool $isPrivateFile): self + { + $obj = clone $this; + $obj->isPrivateFile = $isPrivateFile; + + return $obj; + } + + /** + * Specifies if the file is published or not. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * MIME type of the file. + */ + public function withMime(string $mime): self + { + $obj = clone $this; + $obj->mime = $mime; + + return $obj; + } + + /** + * Name of the asset. + */ + public function withName(string $name): self + { + $obj = clone $this; + $obj->name = $name; + + return $obj; + } + + /** + * Size of the file in bytes. + */ + public function withSize(float $size): self + { + $obj = clone $this; + $obj->size = $size; + + return $obj; + } + + /** + * An array of tags assigned to the file. Tags are used to search files in the media library. + * + * @param list|null $tags + */ + public function withTags(?array $tags): self + { + $obj = clone $this; + $obj->tags = $tags; + + return $obj; + } + + /** + * URL of the thumbnail image. This URL is used to access the thumbnail image of the file in the media library. + */ + public function withThumbnail(string $thumbnail): self + { + $obj = clone $this; + $obj->thumbnail = $thumbnail; + + return $obj; + } + + /** + * Type of the asset. + * + * @param Type|value-of $type + */ + public function withType(Type|string $type): self + { + $obj = clone $this; + $obj->type = $type instanceof Type ? $type->value : $type; + + return $obj; + } + + /** + * Date and time when the file was last updated. The date and time is in ISO8601 format. + */ + public function withUpdatedAt(\DateTimeInterface $updatedAt): self + { + $obj = clone $this; + $obj->updatedAt = $updatedAt; + + return $obj; + } + + /** + * URL of the file. + */ + public function withURL(string $url): self + { + $obj = clone $this; + $obj->url = $url; + + return $obj; + } + + /** + * An object with details of the file version. + */ + public function withVersionInfo(VersionInfo $versionInfo): self + { + $obj = clone $this; + $obj->versionInfo = $versionInfo; + + return $obj; + } + + /** + * Width of the file. + */ + public function withWidth(float $width): self + { + $obj = clone $this; + $obj->width = $width; + + return $obj; + } + public function withExtensionStatus(ExtensionStatus $extensionStatus): self { $obj = clone $this; diff --git a/src/Files/FileUploadResponse.php b/src/Files/FileUploadResponse.php index d92d5898..af945619 100644 --- a/src/Files/FileUploadResponse.php +++ b/src/Files/FileUploadResponse.php @@ -40,7 +40,7 @@ * videoCodec?: string, * width?: float, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Files/Versions/VersionDeleteResponse.php b/src/Files/Versions/VersionDeleteResponse.php index 2ea1e5db..242e8ea6 100644 --- a/src/Files/Versions/VersionDeleteResponse.php +++ b/src/Files/Versions/VersionDeleteResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type version_delete_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/FolderCopyResponse.php b/src/Folders/FolderCopyResponse.php index d5a6e512..65246169 100644 --- a/src/Folders/FolderCopyResponse.php +++ b/src/Folders/FolderCopyResponse.php @@ -12,7 +12,7 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_copy_response = array{jobID: string} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/FolderDeleteResponse.php b/src/Folders/FolderDeleteResponse.php index 76a91706..ccd5d372 100644 --- a/src/Folders/FolderDeleteResponse.php +++ b/src/Folders/FolderDeleteResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type folder_delete_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/FolderMoveResponse.php b/src/Folders/FolderMoveResponse.php index 4c02d487..842abe0c 100644 --- a/src/Folders/FolderMoveResponse.php +++ b/src/Folders/FolderMoveResponse.php @@ -12,7 +12,7 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_move_response = array{jobID: string} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/FolderNewResponse.php b/src/Folders/FolderNewResponse.php index 40b0344b..2312ed56 100644 --- a/src/Folders/FolderNewResponse.php +++ b/src/Folders/FolderNewResponse.php @@ -9,7 +9,7 @@ /** * @phpstan-type folder_new_response = array{} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/FolderRenameResponse.php b/src/Folders/FolderRenameResponse.php index e8913e95..13d18be4 100644 --- a/src/Folders/FolderRenameResponse.php +++ b/src/Folders/FolderRenameResponse.php @@ -12,7 +12,7 @@ * Job submitted successfully. A `jobId` will be returned. * * @phpstan-type folder_rename_response = array{jobID: string} - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/Folders/Job/JobGetResponse.php b/src/Folders/Job/JobGetResponse.php index b7c91030..18520710 100644 --- a/src/Folders/Job/JobGetResponse.php +++ b/src/Folders/Job/JobGetResponse.php @@ -17,7 +17,7 @@ * status?: value-of, * type?: value-of, * } - * When used in a response, this type parameter can be used to define a $rawResponse property. + * When used in a response, this type parameter can define a $rawResponse property. * @template TRawResponse of object = object{} * * @mixin TRawResponse diff --git a/src/ImageOverlay.php b/src/ImageOverlay.php index beae7150..e0e0cf3c 100644 --- a/src/ImageOverlay.php +++ b/src/ImageOverlay.php @@ -10,7 +10,9 @@ use ImageKit\ImageOverlay\Encoding; /** - * @phpstan-type unnamed_type_with_intersection_parent0 = array{ + * @phpstan-type image_overlay = array{ + * position?: OverlayPosition, + * timing?: OverlayTiming, * input: string, * type: string, * encoding?: value-of, @@ -19,12 +21,18 @@ */ final class ImageOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] public string $type = 'image'; + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + /** * Specifies the relative path to the image used as an overlay. */ @@ -80,6 +88,8 @@ public function __construct() */ public static function with( string $input, + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null, Encoding|string|null $encoding = null, ?array $transformation = null, ): self { @@ -87,12 +97,30 @@ public static function with( $obj->input = $input; + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; } + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } + /** * Specifies the relative path to the image used as an overlay. */ diff --git a/src/ServiceContracts/Accounts/OriginsContract.php b/src/ServiceContracts/Accounts/OriginsContract.php index 0662e5b0..f066c33a 100644 --- a/src/ServiceContracts/Accounts/OriginsContract.php +++ b/src/ServiceContracts/Accounts/OriginsContract.php @@ -12,6 +12,7 @@ use ImageKit\Accounts\Origins\OriginResponse\S3Compatible; use ImageKit\Accounts\Origins\OriginResponse\WebFolder; use ImageKit\Accounts\Origins\OriginResponse\WebProxy; +use ImageKit\Core\Exceptions\APIException; use ImageKit\RequestOptions; use const ImageKit\Core\OMIT as omit; @@ -42,6 +43,8 @@ interface OriginsContract * @param string $clientSecret akeneo API client secret * @param string $password akeneo API password * @param string $username akeneo API username + * + * @throws APIException */ public function create( $accessKey, @@ -68,6 +71,18 @@ public function create( ?RequestOptions $requestOptions = null, ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; + /** * @api * @@ -92,6 +107,8 @@ public function create( * @param string $clientSecret akeneo API client secret * @param string $password akeneo API password * @param string $username akeneo API username + * + * @throws APIException */ public function update( string $id, @@ -119,10 +136,25 @@ public function update( ?RequestOptions $requestOptions = null, ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; + /** * @api * * @return list + * + * @throws APIException */ public function list( ?RequestOptions $requestOptions = null @@ -130,6 +162,20 @@ public function list( /** * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + mixed $params, + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + * + * @throws APIException */ public function delete( string $id, @@ -138,9 +184,33 @@ public function delete( /** * @api + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null + ): mixed; + + /** + * @api + * + * @throws APIException */ public function get( string $id, ?RequestOptions $requestOptions = null ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; + + /** + * @api + * + * @throws APIException + */ + public function getRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim; } diff --git a/src/ServiceContracts/Accounts/URLEndpointsContract.php b/src/ServiceContracts/Accounts/URLEndpointsContract.php index fa3c4c39..c3fa2a5d 100644 --- a/src/ServiceContracts/Accounts/URLEndpointsContract.php +++ b/src/ServiceContracts/Accounts/URLEndpointsContract.php @@ -11,6 +11,7 @@ use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Akamai as Akamai1; use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Cloudinary as Cloudinary1; use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Imgix as Imgix1; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; @@ -27,6 +28,8 @@ interface URLEndpointsContract * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting * * @return URLEndpointResponse + * + * @throws APIException */ public function create( $description, @@ -36,6 +39,20 @@ public function create( ?RequestOptions $requestOptions = null, ): URLEndpointResponse; + /** + * @api + * + * @param array $params + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null + ): URLEndpointResponse; + /** * @api * @@ -45,6 +62,8 @@ public function create( * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting * * @return URLEndpointResponse + * + * @throws APIException */ public function update( string $id, @@ -55,10 +74,27 @@ public function update( ?RequestOptions $requestOptions = null, ): URLEndpointResponse; + /** + * @api + * + * @param array $params + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null + ): URLEndpointResponse; + /** * @api * * @return list + * + * @throws APIException */ public function list( ?RequestOptions $requestOptions = null @@ -66,19 +102,59 @@ public function list( /** * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + mixed $params, + ?RequestOptions $requestOptions = null + ): array; + + /** + * @api + * + * @throws APIException */ public function delete( string $id, ?RequestOptions $requestOptions = null ): mixed; + /** + * @api + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null + ): mixed; + /** * @api * * @return URLEndpointResponse + * + * @throws APIException */ public function get( string $id, ?RequestOptions $requestOptions = null ): URLEndpointResponse; + + /** + * @api + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function getRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null + ): URLEndpointResponse; } diff --git a/src/ServiceContracts/Accounts/UsageContract.php b/src/ServiceContracts/Accounts/UsageContract.php index e5394019..11aa8aaf 100644 --- a/src/ServiceContracts/Accounts/UsageContract.php +++ b/src/ServiceContracts/Accounts/UsageContract.php @@ -5,6 +5,7 @@ namespace ImageKit\ServiceContracts\Accounts; use ImageKit\Accounts\Usage\UsageGetResponse; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; @@ -17,10 +18,26 @@ interface UsageContract * @param \DateTimeInterface $startDate Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. * * @return UsageGetResponse + * + * @throws APIException */ public function get( $endDate, $startDate, ?RequestOptions $requestOptions = null ): UsageGetResponse; + + /** + * @api + * + * @param array $params + * + * @return UsageGetResponse + * + * @throws APIException + */ + public function getRaw( + array $params, + ?RequestOptions $requestOptions = null + ): UsageGetResponse; } diff --git a/src/ServiceContracts/AssetsContract.php b/src/ServiceContracts/AssetsContract.php index 46d6c7d8..7d770c12 100644 --- a/src/ServiceContracts/AssetsContract.php +++ b/src/ServiceContracts/AssetsContract.php @@ -7,6 +7,7 @@ use ImageKit\Assets\AssetListParams\FileType; use ImageKit\Assets\AssetListParams\Sort; use ImageKit\Assets\AssetListParams\Type; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Files\File; use ImageKit\Files\Folder; use ImageKit\RequestOptions; @@ -47,6 +48,8 @@ interface AssetsContract * - `all` — returns both files and folders (excludes `file-version`) * * @return list + * + * @throws APIException */ public function list( $fileType = omit, @@ -58,4 +61,18 @@ public function list( $type = omit, ?RequestOptions $requestOptions = null, ): array; + + /** + * @api + * + * @param array $params + * + * @return list + * + * @throws APIException + */ + public function listRaw( + array $params, + ?RequestOptions $requestOptions = null + ): array; } diff --git a/src/ServiceContracts/Beta/V2/FilesContract.php b/src/ServiceContracts/Beta/V2/FilesContract.php index 1c3d78cc..aa657f02 100644 --- a/src/ServiceContracts/Beta/V2/FilesContract.php +++ b/src/ServiceContracts/Beta/V2/FilesContract.php @@ -7,6 +7,7 @@ use ImageKit\Beta\V2\Files\FileUploadParams\ResponseField; use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; @@ -74,6 +75,8 @@ interface FilesContract * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * * @return FileUploadResponse + * + * @throws APIException */ public function upload( $file, @@ -98,4 +101,18 @@ public function upload( $webhookURL = omit, ?RequestOptions $requestOptions = null, ): FileUploadResponse; + + /** + * @api + * + * @param array $params + * + * @return FileUploadResponse + * + * @throws APIException + */ + public function uploadRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FileUploadResponse; } diff --git a/src/ServiceContracts/Cache/InvalidationContract.php b/src/ServiceContracts/Cache/InvalidationContract.php index 0af6ded2..647d9144 100644 --- a/src/ServiceContracts/Cache/InvalidationContract.php +++ b/src/ServiceContracts/Cache/InvalidationContract.php @@ -6,6 +6,7 @@ use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; @@ -17,19 +18,50 @@ interface InvalidationContract * @param string $url the full URL of the file to be purged * * @return InvalidationNewResponse + * + * @throws APIException */ public function create( $url, ?RequestOptions $requestOptions = null ): InvalidationNewResponse; + /** + * @api + * + * @param array $params + * + * @return InvalidationNewResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null + ): InvalidationNewResponse; + /** * @api * * @return InvalidationGetResponse + * + * @throws APIException */ public function get( string $requestID, ?RequestOptions $requestOptions = null ): InvalidationGetResponse; + + /** + * @api + * + * @return InvalidationGetResponse + * + * @throws APIException + */ + public function getRaw( + string $requestID, + mixed $params, + ?RequestOptions $requestOptions = null + ): InvalidationGetResponse; } diff --git a/src/ServiceContracts/CustomMetadataFieldsContract.php b/src/ServiceContracts/CustomMetadataFieldsContract.php index a2df4699..edc8c5f6 100644 --- a/src/ServiceContracts/CustomMetadataFieldsContract.php +++ b/src/ServiceContracts/CustomMetadataFieldsContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams\Schema; @@ -23,6 +24,8 @@ interface CustomMetadataFieldsContract * @param Schema $schema * * @return CustomMetadataField + * + * @throws APIException */ public function create( $label, @@ -31,6 +34,20 @@ public function create( ?RequestOptions $requestOptions = null ): CustomMetadataField; + /** + * @api + * + * @param array $params + * + * @return CustomMetadataField + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null + ): CustomMetadataField; + /** * @api * @@ -38,6 +55,8 @@ public function create( * @param Schema1 $schema An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. * * @return CustomMetadataField + * + * @throws APIException */ public function update( string $id, @@ -46,25 +65,71 @@ public function update( ?RequestOptions $requestOptions = null, ): CustomMetadataField; + /** + * @api + * + * @param array $params + * + * @return CustomMetadataField + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null + ): CustomMetadataField; + /** * @api * * @param bool $includeDeleted set it to `true` to include deleted field objects in the API response * * @return list + * + * @throws APIException */ public function list( $includeDeleted = omit, ?RequestOptions $requestOptions = null ): array; + /** + * @api + * + * @param array $params + * + * @return list + * + * @throws APIException + */ + public function listRaw( + array $params, + ?RequestOptions $requestOptions = null + ): array; + /** * @api * * @return CustomMetadataFieldDeleteResponse + * + * @throws APIException */ public function delete( string $id, ?RequestOptions $requestOptions = null ): CustomMetadataFieldDeleteResponse; + + /** + * @api + * + * @return CustomMetadataFieldDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null + ): CustomMetadataFieldDeleteResponse; } diff --git a/src/ServiceContracts/Files/BulkContract.php b/src/ServiceContracts/Files/BulkContract.php index 67447c41..47ca015b 100644 --- a/src/ServiceContracts/Files/BulkContract.php +++ b/src/ServiceContracts/Files/BulkContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Files; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\Bulk\BulkAddTagsResponse; use ImageKit\Files\Bulk\BulkDeleteResponse; @@ -19,12 +20,28 @@ interface BulkContract * @param list $fileIDs an array of fileIds which you want to delete * * @return BulkDeleteResponse + * + * @throws APIException */ public function delete( $fileIDs, ?RequestOptions $requestOptions = null ): BulkDeleteResponse; + /** + * @api + * + * @param array $params + * + * @return BulkDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + array $params, + ?RequestOptions $requestOptions = null + ): BulkDeleteResponse; + /** * @api * @@ -32,6 +49,8 @@ public function delete( * @param list $tags an array of tags that you want to add to the files * * @return BulkAddTagsResponse + * + * @throws APIException */ public function addTags( $fileIDs, @@ -39,6 +58,20 @@ public function addTags( ?RequestOptions $requestOptions = null ): BulkAddTagsResponse; + /** + * @api + * + * @param array $params + * + * @return BulkAddTagsResponse + * + * @throws APIException + */ + public function addTagsRaw( + array $params, + ?RequestOptions $requestOptions = null + ): BulkAddTagsResponse; + /** * @api * @@ -46,6 +79,8 @@ public function addTags( * @param list $fileIDs an array of fileIds from which you want to remove AITags * * @return BulkRemoveAITagsResponse + * + * @throws APIException */ public function removeAITags( $aiTags, @@ -53,6 +88,20 @@ public function removeAITags( ?RequestOptions $requestOptions = null ): BulkRemoveAITagsResponse; + /** + * @api + * + * @param array $params + * + * @return BulkRemoveAITagsResponse + * + * @throws APIException + */ + public function removeAITagsRaw( + array $params, + ?RequestOptions $requestOptions = null + ): BulkRemoveAITagsResponse; + /** * @api * @@ -60,10 +109,26 @@ public function removeAITags( * @param list $tags an array of tags that you want to remove from the files * * @return BulkRemoveTagsResponse + * + * @throws APIException */ public function removeTags( $fileIDs, $tags, ?RequestOptions $requestOptions = null ): BulkRemoveTagsResponse; + + /** + * @api + * + * @param array $params + * + * @return BulkRemoveTagsResponse + * + * @throws APIException + */ + public function removeTagsRaw( + array $params, + ?RequestOptions $requestOptions = null + ): BulkRemoveTagsResponse; } diff --git a/src/ServiceContracts/Files/MetadataContract.php b/src/ServiceContracts/Files/MetadataContract.php index 615b5b4a..aef7fd6e 100644 --- a/src/ServiceContracts/Files/MetadataContract.php +++ b/src/ServiceContracts/Files/MetadataContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Files; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Files\Metadata; use ImageKit\RequestOptions; @@ -11,19 +12,46 @@ interface MetadataContract { /** * @api + * + * @throws APIException */ public function get( string $fileID, ?RequestOptions $requestOptions = null ): Metadata; + /** + * @api + * + * @throws APIException + */ + public function getRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null + ): Metadata; + /** * @api * * @param string $url Should be a valid file URL. It should be accessible using your ImageKit.io account. + * + * @throws APIException */ public function getFromURL( $url, ?RequestOptions $requestOptions = null ): Metadata; + + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function getFromURLRaw( + array $params, + ?RequestOptions $requestOptions = null + ): Metadata; } diff --git a/src/ServiceContracts/Files/VersionsContract.php b/src/ServiceContracts/Files/VersionsContract.php index 2b95b688..58fd9d1c 100644 --- a/src/ServiceContracts/Files/VersionsContract.php +++ b/src/ServiceContracts/Files/VersionsContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Files; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteResponse; @@ -15,18 +16,35 @@ interface VersionsContract * @api * * @return list + * + * @throws APIException */ public function list( string $fileID, ?RequestOptions $requestOptions = null ): array; + /** + * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null + ): array; + /** * @api * * @param string $fileID * * @return VersionDeleteResponse + * + * @throws APIException */ public function delete( string $versionID, @@ -34,12 +52,29 @@ public function delete( ?RequestOptions $requestOptions = null ): VersionDeleteResponse; + /** + * @api + * + * @param array $params + * + * @return VersionDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null + ): VersionDeleteResponse; + /** * @api * * @param string $fileID * * @return File + * + * @throws APIException */ public function get( string $versionID, @@ -47,16 +82,48 @@ public function get( ?RequestOptions $requestOptions = null ): File; + /** + * @api + * + * @param array $params + * + * @return File + * + * @throws APIException + */ + public function getRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null + ): File; + /** * @api * * @param string $fileID * * @return File + * + * @throws APIException */ public function restore( string $versionID, $fileID, ?RequestOptions $requestOptions = null ): File; + + /** + * @api + * + * @param array $params + * + * @return File + * + * @throws APIException + */ + public function restoreRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null + ): File; } diff --git a/src/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php index 5f2c79ea..8d06b2f5 100644 --- a/src/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; @@ -41,6 +42,8 @@ interface FilesContract * @param Publish $publish configure the publication status of a file and its versions * * @return FileUpdateResponse + * + * @throws APIException */ public function update( string $fileID, @@ -57,12 +60,40 @@ public function update( /** * @api + * + * @param array $params + * + * @return FileUpdateResponse + * + * @throws APIException + */ + public function updateRaw( + string $fileID, + array $params, + ?RequestOptions $requestOptions = null + ): FileUpdateResponse; + + /** + * @api + * + * @throws APIException */ public function delete( string $fileID, ?RequestOptions $requestOptions = null ): mixed; + /** + * @api + * + * @throws APIException + */ + public function deleteRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null + ): mixed; + /** * @api * @@ -71,6 +102,8 @@ public function delete( * @param bool $includeFileVersions Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. * * @return FileCopyResponse + * + * @throws APIException */ public function copy( $destinationPath, @@ -79,16 +112,45 @@ public function copy( ?RequestOptions $requestOptions = null, ): FileCopyResponse; + /** + * @api + * + * @param array $params + * + * @return FileCopyResponse + * + * @throws APIException + */ + public function copyRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FileCopyResponse; + /** * @api * * @return File + * + * @throws APIException */ public function get( string $fileID, ?RequestOptions $requestOptions = null ): File; + /** + * @api + * + * @return File + * + * @throws APIException + */ + public function getRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null + ): File; + /** * @api * @@ -96,6 +158,8 @@ public function get( * @param string $sourceFilePath the full path of the file you want to move * * @return FileMoveResponse + * + * @throws APIException */ public function move( $destinationPath, @@ -103,6 +167,20 @@ public function move( ?RequestOptions $requestOptions = null, ): FileMoveResponse; + /** + * @api + * + * @param array $params + * + * @return FileMoveResponse + * + * @throws APIException + */ + public function moveRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FileMoveResponse; + /** * @api * @@ -120,6 +198,8 @@ public function move( * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * * @return FileRenameResponse + * + * @throws APIException */ public function rename( $filePath, @@ -128,6 +208,20 @@ public function rename( ?RequestOptions $requestOptions = null, ): FileRenameResponse; + /** + * @api + * + * @param array $params + * + * @return FileRenameResponse + * + * @throws APIException + */ + public function renameRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FileRenameResponse; + /** * @api * @@ -205,6 +299,8 @@ public function rename( * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * * @return FileUploadResponse + * + * @throws APIException */ public function upload( $file, @@ -232,4 +328,18 @@ public function upload( $webhookURL = omit, ?RequestOptions $requestOptions = null, ): FileUploadResponse; + + /** + * @api + * + * @param array $params + * + * @return FileUploadResponse + * + * @throws APIException + */ + public function uploadRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FileUploadResponse; } diff --git a/src/ServiceContracts/Folders/JobContract.php b/src/ServiceContracts/Folders/JobContract.php index 8e59f85a..9f654bc3 100644 --- a/src/ServiceContracts/Folders/JobContract.php +++ b/src/ServiceContracts/Folders/JobContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts\Folders; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; @@ -14,9 +15,24 @@ interface JobContract * @api * * @return JobGetResponse + * + * @throws APIException */ public function get( string $jobID, ?RequestOptions $requestOptions = null ): JobGetResponse; + + /** + * @api + * + * @return JobGetResponse + * + * @throws APIException + */ + public function getRaw( + string $jobID, + mixed $params, + ?RequestOptions $requestOptions = null + ): JobGetResponse; } diff --git a/src/ServiceContracts/FoldersContract.php b/src/ServiceContracts/FoldersContract.php index e0cf7964..92279fa9 100644 --- a/src/ServiceContracts/FoldersContract.php +++ b/src/ServiceContracts/FoldersContract.php @@ -4,6 +4,7 @@ namespace ImageKit\ServiceContracts; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\FolderCopyResponse; use ImageKit\Folders\FolderDeleteResponse; @@ -27,6 +28,8 @@ interface FoldersContract * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. * * @return FolderNewResponse + * + * @throws APIException */ public function create( $folderName, @@ -34,18 +37,48 @@ public function create( ?RequestOptions $requestOptions = null ): FolderNewResponse; + /** + * @api + * + * @param array $params + * + * @return FolderNewResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FolderNewResponse; + /** * @api * * @param string $folderPath Full path to the folder you want to delete. For example `/folder/to/delete/`. * * @return FolderDeleteResponse + * + * @throws APIException */ public function delete( $folderPath, ?RequestOptions $requestOptions = null ): FolderDeleteResponse; + /** + * @api + * + * @param array $params + * + * @return FolderDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FolderDeleteResponse; + /** * @api * @@ -54,6 +87,8 @@ public function delete( * @param bool $includeVersions Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. * * @return FolderCopyResponse + * + * @throws APIException */ public function copy( $destinationPath, @@ -62,6 +97,20 @@ public function copy( ?RequestOptions $requestOptions = null, ): FolderCopyResponse; + /** + * @api + * + * @param array $params + * + * @return FolderCopyResponse + * + * @throws APIException + */ + public function copyRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FolderCopyResponse; + /** * @api * @@ -69,6 +118,8 @@ public function copy( * @param string $sourceFolderPath the full path to the source folder you want to move * * @return FolderMoveResponse + * + * @throws APIException */ public function move( $destinationPath, @@ -76,6 +127,20 @@ public function move( ?RequestOptions $requestOptions = null, ): FolderMoveResponse; + /** + * @api + * + * @param array $params + * + * @return FolderMoveResponse + * + * @throws APIException + */ + public function moveRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FolderMoveResponse; + /** * @api * @@ -92,6 +157,8 @@ public function move( * Default value - `false` * * @return FolderRenameResponse + * + * @throws APIException */ public function rename( $folderPath, @@ -99,4 +166,18 @@ public function rename( $purgeCache = omit, ?RequestOptions $requestOptions = null, ): FolderRenameResponse; + + /** + * @api + * + * @param array $params + * + * @return FolderRenameResponse + * + * @throws APIException + */ + public function renameRaw( + array $params, + ?RequestOptions $requestOptions = null + ): FolderRenameResponse; } diff --git a/src/Services/Accounts/OriginsService.php b/src/Services/Accounts/OriginsService.php index 17d341d7..da280a76 100644 --- a/src/Services/Accounts/OriginsService.php +++ b/src/Services/Accounts/OriginsService.php @@ -17,6 +17,7 @@ use ImageKit\Accounts\Origins\OriginUpdateParams; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Exceptions\APIException; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Accounts\OriginsContract; @@ -56,6 +57,8 @@ public function __construct(private Client $client) {} * @param string $clientSecret akeneo API client secret * @param string $password akeneo API password * @param string $username akeneo API username + * + * @throws APIException */ public function create( $accessKey, @@ -80,32 +83,48 @@ public function create( $password, $username, ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { + $params = [ + 'accessKey' => $accessKey, + 'bucket' => $bucket, + 'name' => $name, + 'secretKey' => $secretKey, + 'type' => $type, + 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, + 'includeCanonicalHeader' => $includeCanonicalHeader, + 'prefix' => $prefix, + 'endpoint' => $endpoint, + 's3ForcePathStyle' => $s3ForcePathStyle, + 'baseURL' => $baseURL, + 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, + 'clientEmail' => $clientEmail, + 'privateKey' => $privateKey, + 'accountName' => $accountName, + 'container' => $container, + 'sasToken' => $sasToken, + 'clientID' => $clientID, + 'clientSecret' => $clientSecret, + 'password' => $password, + 'username' => $username, + ]; + + return $this->createRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { [$parsed, $options] = OriginCreateParams::parseRequest( - [ - 'accessKey' => $accessKey, - 'bucket' => $bucket, - 'name' => $name, - 'secretKey' => $secretKey, - 'type' => $type, - 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, - 'includeCanonicalHeader' => $includeCanonicalHeader, - 'prefix' => $prefix, - 'endpoint' => $endpoint, - 's3ForcePathStyle' => $s3ForcePathStyle, - 'baseURL' => $baseURL, - 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, - 'clientEmail' => $clientEmail, - 'privateKey' => $privateKey, - 'accountName' => $accountName, - 'container' => $container, - 'sasToken' => $sasToken, - 'clientID' => $clientID, - 'clientSecret' => $clientSecret, - 'password' => $password, - 'username' => $username, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -145,6 +164,8 @@ public function create( * @param string $clientSecret akeneo API client secret * @param string $password akeneo API password * @param string $username akeneo API username + * + * @throws APIException */ public function update( string $id, @@ -170,32 +191,49 @@ public function update( $password, $username, ?RequestOptions $requestOptions = null, + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { + $params = [ + 'accessKey' => $accessKey, + 'bucket' => $bucket, + 'name' => $name, + 'secretKey' => $secretKey, + 'type' => $type, + 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, + 'includeCanonicalHeader' => $includeCanonicalHeader, + 'prefix' => $prefix, + 'endpoint' => $endpoint, + 's3ForcePathStyle' => $s3ForcePathStyle, + 'baseURL' => $baseURL, + 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, + 'clientEmail' => $clientEmail, + 'privateKey' => $privateKey, + 'accountName' => $accountName, + 'container' => $container, + 'sasToken' => $sasToken, + 'clientID' => $clientID, + 'clientSecret' => $clientSecret, + 'password' => $password, + 'username' => $username, + ]; + + return $this->updateRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { [$parsed, $options] = OriginUpdateParams::parseRequest( - [ - 'accessKey' => $accessKey, - 'bucket' => $bucket, - 'name' => $name, - 'secretKey' => $secretKey, - 'type' => $type, - 'baseURLForCanonicalHeader' => $baseURLForCanonicalHeader, - 'includeCanonicalHeader' => $includeCanonicalHeader, - 'prefix' => $prefix, - 'endpoint' => $endpoint, - 's3ForcePathStyle' => $s3ForcePathStyle, - 'baseURL' => $baseURL, - 'forwardHostHeaderToOrigin' => $forwardHostHeaderToOrigin, - 'clientEmail' => $clientEmail, - 'privateKey' => $privateKey, - 'accountName' => $accountName, - 'container' => $container, - 'sasToken' => $sasToken, - 'clientID' => $clientID, - 'clientSecret' => $clientSecret, - 'password' => $password, - 'username' => $username, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -215,9 +253,27 @@ public function update( * Returns an array of all configured origins for the current account. * * @return list + * + * @throws APIException */ public function list(?RequestOptions $requestOptions = null): array { + $params = []; + + return $this->listRaw($params, $requestOptions); + } + + /** + * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + mixed $params, + ?RequestOptions $requestOptions = null + ): array { // @phpstan-ignore-next-line; return $this->client->request( method: 'get', @@ -232,10 +288,27 @@ public function list(?RequestOptions $requestOptions = null): array * * **Note:** This API is currently in beta. * Permanently removes the origin identified by `id`. If the origin is in use by any URL‑endpoints, the API will return an error. + * + * @throws APIException */ public function delete( string $id, ?RequestOptions $requestOptions = null + ): mixed { + $params = []; + + return $this->deleteRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null ): mixed { // @phpstan-ignore-next-line; return $this->client->request( @@ -251,10 +324,27 @@ public function delete( * * **Note:** This API is currently in beta. * Retrieves the origin identified by `id`. + * + * @throws APIException */ public function get( string $id, ?RequestOptions $requestOptions = null + ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { + $params = []; + + return $this->getRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @throws APIException + */ + public function getRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null ): S3|S3Compatible|CloudinaryBackup|WebFolder|WebProxy|Gcs|AzureBlob|AkeneoPim { // @phpstan-ignore-next-line; return $this->client->request( diff --git a/src/Services/Accounts/URLEndpointsService.php b/src/Services/Accounts/URLEndpointsService.php index dc598951..c024dfac 100644 --- a/src/Services/Accounts/URLEndpointsService.php +++ b/src/Services/Accounts/URLEndpointsService.php @@ -15,6 +15,7 @@ use ImageKit\Accounts\URLEndpoints\URLEndpointUpdateParams\URLRewriter\Imgix as Imgix1; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Accounts\URLEndpointsContract; @@ -40,6 +41,8 @@ public function __construct(private Client $client) {} * @param Cloudinary|Imgix|Akamai $urlRewriter configuration for third-party URL rewriting * * @return URLEndpointResponse + * + * @throws APIException */ public function create( $description, @@ -47,15 +50,33 @@ public function create( $urlPrefix = omit, $urlRewriter = omit, ?RequestOptions $requestOptions = null, + ): URLEndpointResponse { + $params = [ + 'description' => $description, + 'origins' => $origins, + 'urlPrefix' => $urlPrefix, + 'urlRewriter' => $urlRewriter, + ]; + + return $this->createRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null ): URLEndpointResponse { [$parsed, $options] = URLEndpointCreateParams::parseRequest( - [ - 'description' => $description, - 'origins' => $origins, - 'urlPrefix' => $urlPrefix, - 'urlRewriter' => $urlRewriter, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -80,6 +101,8 @@ public function create( * @param Cloudinary1|Imgix1|Akamai1 $urlRewriter configuration for third-party URL rewriting * * @return URLEndpointResponse + * + * @throws APIException */ public function update( string $id, @@ -88,15 +111,34 @@ public function update( $urlPrefix = omit, $urlRewriter = omit, ?RequestOptions $requestOptions = null, + ): URLEndpointResponse { + $params = [ + 'description' => $description, + 'origins' => $origins, + 'urlPrefix' => $urlPrefix, + 'urlRewriter' => $urlRewriter, + ]; + + return $this->updateRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null ): URLEndpointResponse { [$parsed, $options] = URLEndpointUpdateParams::parseRequest( - [ - 'description' => $description, - 'origins' => $origins, - 'urlPrefix' => $urlPrefix, - 'urlRewriter' => $urlRewriter, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -116,9 +158,27 @@ public function update( * Returns an array of all URL‑endpoints configured including the default URL-endpoint generated by ImageKit during account creation. * * @return list + * + * @throws APIException */ public function list(?RequestOptions $requestOptions = null): array { + $params = []; + + return $this->listRaw($params, $requestOptions); + } + + /** + * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + mixed $params, + ?RequestOptions $requestOptions = null + ): array { // @phpstan-ignore-next-line; return $this->client->request( method: 'get', @@ -133,10 +193,27 @@ public function list(?RequestOptions $requestOptions = null): array * * **Note:** This API is currently in beta. * Deletes the URL‑endpoint identified by `id`. You cannot delete the default URL‑endpoint created by ImageKit during account creation. + * + * @throws APIException */ public function delete( string $id, ?RequestOptions $requestOptions = null + ): mixed { + $params = []; + + return $this->deleteRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null ): mixed { // @phpstan-ignore-next-line; return $this->client->request( @@ -154,10 +231,29 @@ public function delete( * Retrieves the URL‑endpoint identified by `id`. * * @return URLEndpointResponse + * + * @throws APIException */ public function get( string $id, ?RequestOptions $requestOptions = null + ): URLEndpointResponse { + $params = []; + + return $this->getRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @return URLEndpointResponse + * + * @throws APIException + */ + public function getRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null ): URLEndpointResponse { // @phpstan-ignore-next-line; return $this->client->request( diff --git a/src/Services/Accounts/UsageService.php b/src/Services/Accounts/UsageService.php index 73f0843a..ffa44f7f 100644 --- a/src/Services/Accounts/UsageService.php +++ b/src/Services/Accounts/UsageService.php @@ -7,6 +7,7 @@ use ImageKit\Accounts\Usage\UsageGetParams; use ImageKit\Accounts\Usage\UsageGetResponse; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Accounts\UsageContract; @@ -27,14 +28,34 @@ public function __construct(private Client $client) {} * @param \DateTimeInterface $startDate Specify a `startDate` in `YYYY-MM-DD` format. It should be before the `endDate`. The difference between `startDate` and `endDate` should be less than 90 days. * * @return UsageGetResponse + * + * @throws APIException */ public function get( $endDate, $startDate, ?RequestOptions $requestOptions = null + ): UsageGetResponse { + $params = ['endDate' => $endDate, 'startDate' => $startDate]; + + return $this->getRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return UsageGetResponse + * + * @throws APIException + */ + public function getRaw( + array $params, + ?RequestOptions $requestOptions = null ): UsageGetResponse { [$parsed, $options] = UsageGetParams::parseRequest( - ['endDate' => $endDate, 'startDate' => $startDate], + $params, $requestOptions ); diff --git a/src/Services/AssetsService.php b/src/Services/AssetsService.php index c065a8c9..a164b1ae 100644 --- a/src/Services/AssetsService.php +++ b/src/Services/AssetsService.php @@ -11,6 +11,7 @@ use ImageKit\Assets\AssetListResponseItem; use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Files\File; use ImageKit\Files\Folder; use ImageKit\RequestOptions; @@ -59,6 +60,8 @@ public function __construct(private Client $client) {} * - `all` — returns both files and folders (excludes `file-version`) * * @return list + * + * @throws APIException */ public function list( $fileType = omit, @@ -69,18 +72,36 @@ public function list( $sort = omit, $type = omit, ?RequestOptions $requestOptions = null, + ): array { + $params = [ + 'fileType' => $fileType, + 'limit' => $limit, + 'path' => $path, + 'searchQuery' => $searchQuery, + 'skip' => $skip, + 'sort' => $sort, + 'type' => $type, + ]; + + return $this->listRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return list + * + * @throws APIException + */ + public function listRaw( + array $params, + ?RequestOptions $requestOptions = null ): array { [$parsed, $options] = AssetListParams::parseRequest( - [ - 'fileType' => $fileType, - 'limit' => $limit, - 'path' => $path, - 'searchQuery' => $searchQuery, - 'skip' => $skip, - 'sort' => $sort, - 'type' => $type, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; diff --git a/src/Services/Beta/V2/FilesService.php b/src/Services/Beta/V2/FilesService.php index e9c3732f..118d9abd 100644 --- a/src/Services/Beta/V2/FilesService.php +++ b/src/Services/Beta/V2/FilesService.php @@ -9,6 +9,7 @@ use ImageKit\Beta\V2\Files\FileUploadParams\Transformation; use ImageKit\Beta\V2\Files\FileUploadResponse; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; @@ -97,6 +98,8 @@ public function __construct(private Client $client) {} * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * * @return FileUploadResponse + * + * @throws APIException */ public function upload( $file, @@ -120,31 +123,49 @@ public function upload( $useUniqueFileName = omit, $webhookURL = omit, ?RequestOptions $requestOptions = null, + ): FileUploadResponse { + $params = [ + 'file' => $file, + 'fileName' => $fileName, + 'token' => $token, + 'checks' => $checks, + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'extensions' => $extensions, + 'folder' => $folder, + 'isPrivateFile' => $isPrivateFile, + 'isPublished' => $isPublished, + 'overwriteAITags' => $overwriteAITags, + 'overwriteCustomMetadata' => $overwriteCustomMetadata, + 'overwriteFile' => $overwriteFile, + 'overwriteTags' => $overwriteTags, + 'responseFields' => $responseFields, + 'tags' => $tags, + 'transformation' => $transformation, + 'useUniqueFileName' => $useUniqueFileName, + 'webhookURL' => $webhookURL, + ]; + + return $this->uploadRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileUploadResponse + * + * @throws APIException + */ + public function uploadRaw( + array $params, + ?RequestOptions $requestOptions = null ): FileUploadResponse { [$parsed, $options] = FileUploadParams::parseRequest( - [ - 'file' => $file, - 'fileName' => $fileName, - 'token' => $token, - 'checks' => $checks, - 'customCoordinates' => $customCoordinates, - 'customMetadata' => $customMetadata, - 'description' => $description, - 'extensions' => $extensions, - 'folder' => $folder, - 'isPrivateFile' => $isPrivateFile, - 'isPublished' => $isPublished, - 'overwriteAITags' => $overwriteAITags, - 'overwriteCustomMetadata' => $overwriteCustomMetadata, - 'overwriteFile' => $overwriteFile, - 'overwriteTags' => $overwriteTags, - 'responseFields' => $responseFields, - 'tags' => $tags, - 'transformation' => $transformation, - 'useUniqueFileName' => $useUniqueFileName, - 'webhookURL' => $webhookURL, - ], - $requestOptions, + $params, + $requestOptions ); $path = $this ->client diff --git a/src/Services/Cache/InvalidationService.php b/src/Services/Cache/InvalidationService.php index e4038f16..201b1066 100644 --- a/src/Services/Cache/InvalidationService.php +++ b/src/Services/Cache/InvalidationService.php @@ -8,6 +8,7 @@ use ImageKit\Cache\Invalidation\InvalidationGetResponse; use ImageKit\Cache\Invalidation\InvalidationNewResponse; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\RequestOptions; use ImageKit\ServiceContracts\Cache\InvalidationContract; @@ -27,13 +28,33 @@ public function __construct(private Client $client) {} * @param string $url the full URL of the file to be purged * * @return InvalidationNewResponse + * + * @throws APIException */ public function create( $url, ?RequestOptions $requestOptions = null + ): InvalidationNewResponse { + $params = ['url' => $url]; + + return $this->createRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return InvalidationNewResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null ): InvalidationNewResponse { [$parsed, $options] = InvalidationCreateParams::parseRequest( - ['url' => $url], + $params, $requestOptions ); @@ -53,10 +74,29 @@ public function create( * This API returns the status of a purge cache request. * * @return InvalidationGetResponse + * + * @throws APIException */ public function get( string $requestID, ?RequestOptions $requestOptions = null + ): InvalidationGetResponse { + $params = []; + + return $this->getRaw($requestID, $params, $requestOptions); + } + + /** + * @api + * + * @return InvalidationGetResponse + * + * @throws APIException + */ + public function getRaw( + string $requestID, + mixed $params, + ?RequestOptions $requestOptions = null ): InvalidationGetResponse { // @phpstan-ignore-next-line; return $this->client->request( diff --git a/src/Services/CustomMetadataFieldsService.php b/src/Services/CustomMetadataFieldsService.php index 1bc4a815..486ddc62 100644 --- a/src/Services/CustomMetadataFieldsService.php +++ b/src/Services/CustomMetadataFieldsService.php @@ -6,6 +6,7 @@ use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\CustomMetadataFields\CustomMetadataField; use ImageKit\CustomMetadataFields\CustomMetadataFieldCreateParams; @@ -36,15 +37,35 @@ public function __construct(private Client $client) {} * @param Schema $schema * * @return CustomMetadataField + * + * @throws APIException */ public function create( $label, $name, $schema, ?RequestOptions $requestOptions = null + ): CustomMetadataField { + $params = ['label' => $label, 'name' => $name, 'schema' => $schema]; + + return $this->createRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return CustomMetadataField + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null ): CustomMetadataField { [$parsed, $options] = CustomMetadataFieldCreateParams::parseRequest( - ['label' => $label, 'name' => $name, 'schema' => $schema], + $params, $requestOptions ); @@ -67,15 +88,36 @@ public function create( * @param Schema1 $schema An object that describes the rules for the custom metadata key. This parameter is required if `label` is not provided. Note: `type` cannot be updated and will be ignored if sent with the `schema`. The schema will be validated as per the existing `type`. * * @return CustomMetadataField + * + * @throws APIException */ public function update( string $id, $label = omit, $schema = omit, ?RequestOptions $requestOptions = null, + ): CustomMetadataField { + $params = ['label' => $label, 'schema' => $schema]; + + return $this->updateRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return CustomMetadataField + * + * @throws APIException + */ + public function updateRaw( + string $id, + array $params, + ?RequestOptions $requestOptions = null ): CustomMetadataField { [$parsed, $options] = CustomMetadataFieldUpdateParams::parseRequest( - ['label' => $label, 'schema' => $schema], + $params, $requestOptions ); @@ -97,13 +139,33 @@ public function update( * @param bool $includeDeleted set it to `true` to include deleted field objects in the API response * * @return list + * + * @throws APIException */ public function list( $includeDeleted = omit, ?RequestOptions $requestOptions = null + ): array { + $params = ['includeDeleted' => $includeDeleted]; + + return $this->listRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return list + * + * @throws APIException + */ + public function listRaw( + array $params, + ?RequestOptions $requestOptions = null ): array { [$parsed, $options] = CustomMetadataFieldListParams::parseRequest( - ['includeDeleted' => $includeDeleted], + $params, $requestOptions ); @@ -123,10 +185,29 @@ public function list( * This API deletes a custom metadata field. Even after deleting a custom metadata field, you cannot create any new custom metadata field with the same name. * * @return CustomMetadataFieldDeleteResponse + * + * @throws APIException */ public function delete( string $id, ?RequestOptions $requestOptions = null + ): CustomMetadataFieldDeleteResponse { + $params = []; + + return $this->deleteRaw($id, $params, $requestOptions); + } + + /** + * @api + * + * @return CustomMetadataFieldDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + string $id, + mixed $params, + ?RequestOptions $requestOptions = null ): CustomMetadataFieldDeleteResponse { // @phpstan-ignore-next-line; return $this->client->request( diff --git a/src/Services/Files/BulkService.php b/src/Services/Files/BulkService.php index de2b2073..875acc36 100644 --- a/src/Services/Files/BulkService.php +++ b/src/Services/Files/BulkService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services\Files; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\Bulk\BulkAddTagsParams; use ImageKit\Files\Bulk\BulkAddTagsResponse; @@ -36,13 +37,33 @@ public function __construct(private Client $client) {} * @param list $fileIDs an array of fileIds which you want to delete * * @return BulkDeleteResponse + * + * @throws APIException */ public function delete( $fileIDs, ?RequestOptions $requestOptions = null + ): BulkDeleteResponse { + $params = ['fileIDs' => $fileIDs]; + + return $this->deleteRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return BulkDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + array $params, + ?RequestOptions $requestOptions = null ): BulkDeleteResponse { [$parsed, $options] = BulkDeleteParams::parseRequest( - ['fileIDs' => $fileIDs], + $params, $requestOptions ); @@ -65,14 +86,34 @@ public function delete( * @param list $tags an array of tags that you want to add to the files * * @return BulkAddTagsResponse + * + * @throws APIException */ public function addTags( $fileIDs, $tags, ?RequestOptions $requestOptions = null + ): BulkAddTagsResponse { + $params = ['fileIDs' => $fileIDs, 'tags' => $tags]; + + return $this->addTagsRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return BulkAddTagsResponse + * + * @throws APIException + */ + public function addTagsRaw( + array $params, + ?RequestOptions $requestOptions = null ): BulkAddTagsResponse { [$parsed, $options] = BulkAddTagsParams::parseRequest( - ['fileIDs' => $fileIDs, 'tags' => $tags], + $params, $requestOptions ); @@ -95,14 +136,34 @@ public function addTags( * @param list $fileIDs an array of fileIds from which you want to remove AITags * * @return BulkRemoveAITagsResponse + * + * @throws APIException */ public function removeAITags( $aiTags, $fileIDs, ?RequestOptions $requestOptions = null + ): BulkRemoveAITagsResponse { + $params = ['aiTags' => $aiTags, 'fileIDs' => $fileIDs]; + + return $this->removeAITagsRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return BulkRemoveAITagsResponse + * + * @throws APIException + */ + public function removeAITagsRaw( + array $params, + ?RequestOptions $requestOptions = null ): BulkRemoveAITagsResponse { [$parsed, $options] = BulkRemoveAITagsParams::parseRequest( - ['aiTags' => $aiTags, 'fileIDs' => $fileIDs], + $params, $requestOptions ); @@ -125,14 +186,34 @@ public function removeAITags( * @param list $tags an array of tags that you want to remove from the files * * @return BulkRemoveTagsResponse + * + * @throws APIException */ public function removeTags( $fileIDs, $tags, ?RequestOptions $requestOptions = null + ): BulkRemoveTagsResponse { + $params = ['fileIDs' => $fileIDs, 'tags' => $tags]; + + return $this->removeTagsRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return BulkRemoveTagsResponse + * + * @throws APIException + */ + public function removeTagsRaw( + array $params, + ?RequestOptions $requestOptions = null ): BulkRemoveTagsResponse { [$parsed, $options] = BulkRemoveTagsParams::parseRequest( - ['fileIDs' => $fileIDs, 'tags' => $tags], + $params, $requestOptions ); diff --git a/src/Services/Files/MetadataService.php b/src/Services/Files/MetadataService.php index 6d94f3f3..89fe3392 100644 --- a/src/Services/Files/MetadataService.php +++ b/src/Services/Files/MetadataService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services\Files; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Files\Metadata; use ImageKit\Files\Metadata\MetadataGetFromURLParams; use ImageKit\RequestOptions; @@ -23,10 +24,27 @@ public function __construct(private Client $client) {} * You can programmatically get image EXIF, pHash, and other metadata for uploaded files in the ImageKit.io media library using this API. * * You can also get the metadata in upload API response by passing `metadata` in `responseFields` parameter. + * + * @throws APIException */ public function get( string $fileID, ?RequestOptions $requestOptions = null + ): Metadata { + $params = []; + + return $this->getRaw($fileID, $params, $requestOptions); + } + + /** + * @api + * + * @throws APIException + */ + public function getRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null ): Metadata { // @phpstan-ignore-next-line; return $this->client->request( @@ -43,13 +61,31 @@ public function get( * Get image EXIF, pHash, and other metadata from ImageKit.io powered remote URL using this API. * * @param string $url Should be a valid file URL. It should be accessible using your ImageKit.io account. + * + * @throws APIException */ public function getFromURL( $url, ?RequestOptions $requestOptions = null + ): Metadata { + $params = ['url' => $url]; + + return $this->getFromURLRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @throws APIException + */ + public function getFromURLRaw( + array $params, + ?RequestOptions $requestOptions = null ): Metadata { [$parsed, $options] = MetadataGetFromURLParams::parseRequest( - ['url' => $url], + $params, $requestOptions ); diff --git a/src/Services/Files/VersionsService.php b/src/Services/Files/VersionsService.php index efaed2f4..93fe964f 100644 --- a/src/Services/Files/VersionsService.php +++ b/src/Services/Files/VersionsService.php @@ -6,6 +6,7 @@ use ImageKit\Client; use ImageKit\Core\Conversion\ListOf; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Files\File; use ImageKit\Files\Versions\VersionDeleteParams; @@ -28,10 +29,29 @@ public function __construct(private Client $client) {} * This API returns details of all versions of a file. * * @return list + * + * @throws APIException */ public function list( string $fileID, ?RequestOptions $requestOptions = null + ): array { + $params = []; + + return $this->listRaw($fileID, $params, $requestOptions); + } + + /** + * @api + * + * @return list + * + * @throws APIException + */ + public function listRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null ): array { // @phpstan-ignore-next-line; return $this->client->request( @@ -52,14 +72,35 @@ public function list( * @param string $fileID * * @return VersionDeleteResponse + * + * @throws APIException */ public function delete( string $versionID, $fileID, ?RequestOptions $requestOptions = null + ): VersionDeleteResponse { + $params = ['fileID' => $fileID]; + + return $this->deleteRaw($versionID, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return VersionDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null ): VersionDeleteResponse { [$parsed, $options] = VersionDeleteParams::parseRequest( - ['fileID' => $fileID], + $params, $requestOptions ); $fileID = $parsed['fileID']; @@ -82,14 +123,35 @@ public function delete( * @param string $fileID * * @return File + * + * @throws APIException */ public function get( string $versionID, $fileID, ?RequestOptions $requestOptions = null + ): File { + $params = ['fileID' => $fileID]; + + return $this->getRaw($versionID, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return File + * + * @throws APIException + */ + public function getRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null ): File { [$parsed, $options] = VersionGetParams::parseRequest( - ['fileID' => $fileID], + $params, $requestOptions ); $fileID = $parsed['fileID']; @@ -112,14 +174,35 @@ public function get( * @param string $fileID * * @return File + * + * @throws APIException */ public function restore( string $versionID, $fileID, ?RequestOptions $requestOptions = null + ): File { + $params = ['fileID' => $fileID]; + + return $this->restoreRaw($versionID, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return File + * + * @throws APIException + */ + public function restoreRaw( + string $versionID, + array $params, + ?RequestOptions $requestOptions = null ): File { [$parsed, $options] = VersionRestoreParams::parseRequest( - ['fileID' => $fileID], + $params, $requestOptions ); $fileID = $parsed['fileID']; diff --git a/src/Services/FilesService.php b/src/Services/FilesService.php index 3e5f6af1..6d9a729e 100644 --- a/src/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; @@ -78,6 +79,8 @@ public function __construct(private Client $client) * @param Publish $publish configure the publication status of a file and its versions * * @return FileUpdateResponse + * + * @throws APIException */ public function update( string $fileID, @@ -90,19 +93,38 @@ public function update( $webhookURL = omit, $publish = omit, ?RequestOptions $requestOptions = null, + ): FileUpdateResponse { + $params = [ + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'extensions' => $extensions, + 'removeAITags' => $removeAITags, + 'tags' => $tags, + 'webhookURL' => $webhookURL, + 'publish' => $publish, + ]; + + return $this->updateRaw($fileID, $params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileUpdateResponse + * + * @throws APIException + */ + public function updateRaw( + string $fileID, + array $params, + ?RequestOptions $requestOptions = null ): FileUpdateResponse { [$parsed, $options] = FileUpdateParams::parseRequest( - [ - 'customCoordinates' => $customCoordinates, - 'customMetadata' => $customMetadata, - 'description' => $description, - 'extensions' => $extensions, - 'removeAITags' => $removeAITags, - 'tags' => $tags, - 'webhookURL' => $webhookURL, - 'publish' => $publish, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -121,10 +143,27 @@ public function update( * This API deletes the file and all its file versions permanently. * * Note: If a file or specific transformation has been requested in the past, then the response is cached. Deleting a file does not purge the cache. You can purge the cache using purge cache API. + * + * @throws APIException */ public function delete( string $fileID, ?RequestOptions $requestOptions = null + ): mixed { + $params = []; + + return $this->deleteRaw($fileID, $params, $requestOptions); + } + + /** + * @api + * + * @throws APIException + */ + public function deleteRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null ): mixed { // @phpstan-ignore-next-line; return $this->client->request( @@ -147,20 +186,40 @@ public function delete( * @param bool $includeFileVersions Option to copy all versions of a file. By default, only the current version of the file is copied. When set to true, all versions of the file will be copied. Default value - `false`. * * @return FileCopyResponse + * + * @throws APIException */ public function copy( $destinationPath, $sourceFilePath, $includeFileVersions = omit, ?RequestOptions $requestOptions = null, + ): FileCopyResponse { + $params = [ + 'destinationPath' => $destinationPath, + 'sourceFilePath' => $sourceFilePath, + 'includeFileVersions' => $includeFileVersions, + ]; + + return $this->copyRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileCopyResponse + * + * @throws APIException + */ + public function copyRaw( + array $params, + ?RequestOptions $requestOptions = null ): FileCopyResponse { [$parsed, $options] = FileCopyParams::parseRequest( - [ - 'destinationPath' => $destinationPath, - 'sourceFilePath' => $sourceFilePath, - 'includeFileVersions' => $includeFileVersions, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -179,10 +238,29 @@ public function copy( * This API returns an object with details or attributes about the current version of the file. * * @return File + * + * @throws APIException */ public function get( string $fileID, ?RequestOptions $requestOptions = null + ): File { + $params = []; + + return $this->getRaw($fileID, $params, $requestOptions); + } + + /** + * @api + * + * @return File + * + * @throws APIException + */ + public function getRaw( + string $fileID, + mixed $params, + ?RequestOptions $requestOptions = null ): File { // @phpstan-ignore-next-line; return $this->client->request( @@ -204,18 +282,37 @@ public function get( * @param string $sourceFilePath the full path of the file you want to move * * @return FileMoveResponse + * + * @throws APIException */ public function move( $destinationPath, $sourceFilePath, ?RequestOptions $requestOptions = null + ): FileMoveResponse { + $params = [ + 'destinationPath' => $destinationPath, 'sourceFilePath' => $sourceFilePath, + ]; + + return $this->moveRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileMoveResponse + * + * @throws APIException + */ + public function moveRaw( + array $params, + ?RequestOptions $requestOptions = null ): FileMoveResponse { [$parsed, $options] = FileMoveParams::parseRequest( - [ - 'destinationPath' => $destinationPath, - 'sourceFilePath' => $sourceFilePath, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -249,20 +346,40 @@ public function move( * Note: If the old file were accessible at `https://ik.imagekit.io/demo/old-filename.jpg`, a purge cache request would be issued against `https://ik.imagekit.io/demo/old-filename.jpg*` (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation. * * @return FileRenameResponse + * + * @throws APIException */ public function rename( $filePath, $newFileName, $purgeCache = omit, ?RequestOptions $requestOptions = null, + ): FileRenameResponse { + $params = [ + 'filePath' => $filePath, + 'newFileName' => $newFileName, + 'purgeCache' => $purgeCache, + ]; + + return $this->renameRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileRenameResponse + * + * @throws APIException + */ + public function renameRaw( + array $params, + ?RequestOptions $requestOptions = null ): FileRenameResponse { [$parsed, $options] = FileRenameParams::parseRequest( - [ - 'filePath' => $filePath, - 'newFileName' => $newFileName, - 'purgeCache' => $purgeCache, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -367,6 +484,8 @@ public function rename( * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. * * @return FileUploadResponse + * + * @throws APIException */ public function upload( $file, @@ -393,34 +512,52 @@ public function upload( $useUniqueFileName = omit, $webhookURL = omit, ?RequestOptions $requestOptions = null, + ): FileUploadResponse { + $params = [ + 'file' => $file, + 'fileName' => $fileName, + 'token' => $token, + 'checks' => $checks, + 'customCoordinates' => $customCoordinates, + 'customMetadata' => $customMetadata, + 'description' => $description, + 'expire' => $expire, + 'extensions' => $extensions, + 'folder' => $folder, + 'isPrivateFile' => $isPrivateFile, + 'isPublished' => $isPublished, + 'overwriteAITags' => $overwriteAITags, + 'overwriteCustomMetadata' => $overwriteCustomMetadata, + 'overwriteFile' => $overwriteFile, + 'overwriteTags' => $overwriteTags, + 'publicKey' => $publicKey, + 'responseFields' => $responseFields, + 'signature' => $signature, + 'tags' => $tags, + 'transformation' => $transformation, + 'useUniqueFileName' => $useUniqueFileName, + 'webhookURL' => $webhookURL, + ]; + + return $this->uploadRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FileUploadResponse + * + * @throws APIException + */ + public function uploadRaw( + array $params, + ?RequestOptions $requestOptions = null ): FileUploadResponse { [$parsed, $options] = FileUploadParams::parseRequest( - [ - 'file' => $file, - 'fileName' => $fileName, - 'token' => $token, - 'checks' => $checks, - 'customCoordinates' => $customCoordinates, - 'customMetadata' => $customMetadata, - 'description' => $description, - 'expire' => $expire, - 'extensions' => $extensions, - 'folder' => $folder, - 'isPrivateFile' => $isPrivateFile, - 'isPublished' => $isPublished, - 'overwriteAITags' => $overwriteAITags, - 'overwriteCustomMetadata' => $overwriteCustomMetadata, - 'overwriteFile' => $overwriteFile, - 'overwriteTags' => $overwriteTags, - 'publicKey' => $publicKey, - 'responseFields' => $responseFields, - 'signature' => $signature, - 'tags' => $tags, - 'transformation' => $transformation, - 'useUniqueFileName' => $useUniqueFileName, - 'webhookURL' => $webhookURL, - ], - $requestOptions, + $params, + $requestOptions ); $path = $this ->client diff --git a/src/Services/Folders/JobService.php b/src/Services/Folders/JobService.php index b525dda7..d62b1c6f 100644 --- a/src/Services/Folders/JobService.php +++ b/src/Services/Folders/JobService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services\Folders; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\Job\JobGetResponse; use ImageKit\RequestOptions; @@ -23,10 +24,29 @@ public function __construct(private Client $client) {} * This API returns the status of a bulk job like copy and move folder operations. * * @return JobGetResponse + * + * @throws APIException */ public function get( string $jobID, ?RequestOptions $requestOptions = null + ): JobGetResponse { + $params = []; + + return $this->getRaw($jobID, $params, $requestOptions); + } + + /** + * @api + * + * @return JobGetResponse + * + * @throws APIException + */ + public function getRaw( + string $jobID, + mixed $params, + ?RequestOptions $requestOptions = null ): JobGetResponse { // @phpstan-ignore-next-line; return $this->client->request( diff --git a/src/Services/FoldersService.php b/src/Services/FoldersService.php index d4f5d8e9..cbb81c96 100644 --- a/src/Services/FoldersService.php +++ b/src/Services/FoldersService.php @@ -5,6 +5,7 @@ namespace ImageKit\Services; use ImageKit\Client; +use ImageKit\Core\Exceptions\APIException; use ImageKit\Core\Implementation\HasRawResponse; use ImageKit\Folders\FolderCopyParams; use ImageKit\Folders\FolderCopyResponse; @@ -50,15 +51,37 @@ public function __construct(private Client $client) * Note: If any folder(s) is not present in the parentFolderPath parameter, it will be automatically created. For example, if you pass `/product/images/summer`, then `product`, `images`, and `summer` folders will be created if they don't already exist. * * @return FolderNewResponse + * + * @throws APIException */ public function create( $folderName, $parentFolderPath, ?RequestOptions $requestOptions = null + ): FolderNewResponse { + $params = [ + 'folderName' => $folderName, 'parentFolderPath' => $parentFolderPath, + ]; + + return $this->createRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FolderNewResponse + * + * @throws APIException + */ + public function createRaw( + array $params, + ?RequestOptions $requestOptions = null ): FolderNewResponse { [$parsed, $options] = FolderCreateParams::parseRequest( - ['folderName' => $folderName, 'parentFolderPath' => $parentFolderPath], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -79,13 +102,33 @@ public function create( * @param string $folderPath Full path to the folder you want to delete. For example `/folder/to/delete/`. * * @return FolderDeleteResponse + * + * @throws APIException */ public function delete( $folderPath, ?RequestOptions $requestOptions = null + ): FolderDeleteResponse { + $params = ['folderPath' => $folderPath]; + + return $this->deleteRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FolderDeleteResponse + * + * @throws APIException + */ + public function deleteRaw( + array $params, + ?RequestOptions $requestOptions = null ): FolderDeleteResponse { [$parsed, $options] = FolderDeleteParams::parseRequest( - ['folderPath' => $folderPath], + $params, $requestOptions ); @@ -109,20 +152,40 @@ public function delete( * @param bool $includeVersions Option to copy all versions of files that are nested inside the selected folder. By default, only the current version of each file will be copied. When set to true, all versions of each file will be copied. Default value - `false`. * * @return FolderCopyResponse + * + * @throws APIException */ public function copy( $destinationPath, $sourceFolderPath, $includeVersions = omit, ?RequestOptions $requestOptions = null, + ): FolderCopyResponse { + $params = [ + 'destinationPath' => $destinationPath, + 'sourceFolderPath' => $sourceFolderPath, + 'includeVersions' => $includeVersions, + ]; + + return $this->copyRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FolderCopyResponse + * + * @throws APIException + */ + public function copyRaw( + array $params, + ?RequestOptions $requestOptions = null ): FolderCopyResponse { [$parsed, $options] = FolderCopyParams::parseRequest( - [ - 'destinationPath' => $destinationPath, - 'sourceFolderPath' => $sourceFolderPath, - 'includeVersions' => $includeVersions, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -144,18 +207,38 @@ public function copy( * @param string $sourceFolderPath the full path to the source folder you want to move * * @return FolderMoveResponse + * + * @throws APIException */ public function move( $destinationPath, $sourceFolderPath, ?RequestOptions $requestOptions = null + ): FolderMoveResponse { + $params = [ + 'destinationPath' => $destinationPath, + 'sourceFolderPath' => $sourceFolderPath, + ]; + + return $this->moveRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FolderMoveResponse + * + * @throws APIException + */ + public function moveRaw( + array $params, + ?RequestOptions $requestOptions = null ): FolderMoveResponse { [$parsed, $options] = FolderMoveParams::parseRequest( - [ - 'destinationPath' => $destinationPath, - 'sourceFolderPath' => $sourceFolderPath, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; @@ -186,20 +269,40 @@ public function move( * Default value - `false` * * @return FolderRenameResponse + * + * @throws APIException */ public function rename( $folderPath, $newFolderName, $purgeCache = omit, ?RequestOptions $requestOptions = null, + ): FolderRenameResponse { + $params = [ + 'folderPath' => $folderPath, + 'newFolderName' => $newFolderName, + 'purgeCache' => $purgeCache, + ]; + + return $this->renameRaw($params, $requestOptions); + } + + /** + * @api + * + * @param array $params + * + * @return FolderRenameResponse + * + * @throws APIException + */ + public function renameRaw( + array $params, + ?RequestOptions $requestOptions = null ): FolderRenameResponse { [$parsed, $options] = FolderRenameParams::parseRequest( - [ - 'folderPath' => $folderPath, - 'newFolderName' => $newFolderName, - 'purgeCache' => $purgeCache, - ], - $requestOptions, + $params, + $requestOptions ); // @phpstan-ignore-next-line; diff --git a/src/SolidColorOverlay.php b/src/SolidColorOverlay.php index a979ac98..4d70d94b 100644 --- a/src/SolidColorOverlay.php +++ b/src/SolidColorOverlay.php @@ -9,7 +9,9 @@ use ImageKit\Core\Contracts\BaseModel; /** - * @phpstan-type unnamed_type_with_intersection_parent1 = array{ + * @phpstan-type solid_color_overlay = array{ + * position?: OverlayPosition, + * timing?: OverlayTiming, * color: string, * type: string, * transformation?: list, @@ -17,12 +19,18 @@ */ final class SolidColorOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] public string $type = 'solidColor'; + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + /** * Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). * If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99). @@ -67,17 +75,37 @@ public function __construct() */ public static function with( string $color, - ?array $transformation = null + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null, + ?array $transformation = null, ): self { $obj = new self; $obj->color = $color; + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; null !== $transformation && $obj->transformation = $transformation; return $obj; } + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } + /** * Specifies the color of the block using an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name (e.g., `red`). * If an 8-character value is provided, the last two characters represent the opacity level (from `00` for 0.00 to `99` for 0.99). diff --git a/src/SubtitleOverlay.php b/src/SubtitleOverlay.php index 79c765b4..95623fb8 100644 --- a/src/SubtitleOverlay.php +++ b/src/SubtitleOverlay.php @@ -10,7 +10,9 @@ use ImageKit\SubtitleOverlay\Encoding; /** - * @phpstan-type unnamed_type_with_intersection_parent2 = array{ + * @phpstan-type subtitle_overlay = array{ + * position?: OverlayPosition, + * timing?: OverlayTiming, * input: string, * type: string, * encoding?: value-of, @@ -19,12 +21,18 @@ */ final class SubtitleOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] public string $type = 'subtitle'; + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + /** * Specifies the relative path to the subtitle file used as an overlay. */ @@ -79,6 +87,8 @@ public function __construct() */ public static function with( string $input, + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null, Encoding|string|null $encoding = null, ?array $transformation = null, ): self { @@ -86,12 +96,30 @@ public static function with( $obj->input = $input; + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; } + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } + /** * Specifies the relative path to the subtitle file used as an overlay. */ diff --git a/src/TextOverlay.php b/src/TextOverlay.php index b5747018..85e12507 100644 --- a/src/TextOverlay.php +++ b/src/TextOverlay.php @@ -10,7 +10,9 @@ use ImageKit\TextOverlay\Encoding; /** - * @phpstan-type unnamed_type_with_intersection_parent3 = array{ + * @phpstan-type text_overlay = array{ + * position?: OverlayPosition, + * timing?: OverlayTiming, * text: string, * type: string, * encoding?: value-of, @@ -19,12 +21,18 @@ */ final class TextOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] public string $type = 'text'; + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + /** * Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding. */ @@ -79,19 +87,39 @@ public function __construct() */ public static function with( string $text, + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null, Encoding|string|null $encoding = null, - ?array $transformation = null + ?array $transformation = null, ): self { $obj = new self; $obj->text = $text; + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; } + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } + /** * Specifies the text to be displayed in the overlay. The SDK automatically handles special characters and encoding. */ diff --git a/src/VideoOverlay.php b/src/VideoOverlay.php index 3135b391..3967ff0b 100644 --- a/src/VideoOverlay.php +++ b/src/VideoOverlay.php @@ -10,7 +10,9 @@ use ImageKit\VideoOverlay\Encoding; /** - * @phpstan-type unnamed_type_with_intersection_parent4 = array{ + * @phpstan-type video_overlay = array{ + * position?: OverlayPosition, + * timing?: OverlayTiming, * input: string, * type: string, * encoding?: value-of, @@ -19,12 +21,18 @@ */ final class VideoOverlay implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; #[Api] public string $type = 'video'; + #[Api(optional: true)] + public ?OverlayPosition $position; + + #[Api(optional: true)] + public ?OverlayTiming $timing; + /** * Specifies the relative path to the video used as an overlay. */ @@ -80,6 +88,8 @@ public function __construct() */ public static function with( string $input, + ?OverlayPosition $position = null, + ?OverlayTiming $timing = null, Encoding|string|null $encoding = null, ?array $transformation = null, ): self { @@ -87,12 +97,30 @@ public static function with( $obj->input = $input; + null !== $position && $obj->position = $position; + null !== $timing && $obj->timing = $timing; null !== $encoding && $obj->encoding = $encoding instanceof Encoding ? $encoding->value : $encoding; null !== $transformation && $obj->transformation = $transformation; return $obj; } + public function withPosition(OverlayPosition $position): self + { + $obj = clone $this; + $obj->position = $position; + + return $obj; + } + + public function withTiming(OverlayTiming $timing): self + { + $obj = clone $this; + $obj->timing = $timing; + + return $obj; + } + /** * Specifies the relative path to the video used as an overlay. */ diff --git a/src/Webhooks/UploadPostTransformErrorEvent.php b/src/Webhooks/UploadPostTransformErrorEvent.php index 97b13e0b..8dfee4f0 100644 --- a/src/Webhooks/UploadPostTransformErrorEvent.php +++ b/src/Webhooks/UploadPostTransformErrorEvent.php @@ -13,17 +13,30 @@ /** * Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated. * - * @phpstan-type unnamed_type_with_intersection_parent5 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type upload_post_transform_error_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class UploadPostTransformErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'upload.post-transform.error'; + public string $type; /** * Timestamp of when the event occurred in ISO8601 format. @@ -42,13 +55,17 @@ final class UploadPostTransformErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPostTransformErrorEvent::with(createdAt: ..., data: ..., request: ...) + * UploadPostTransformErrorEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPostTransformErrorEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -65,12 +82,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -78,6 +99,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPostTransformSuccessEvent.php b/src/Webhooks/UploadPostTransformSuccessEvent.php index d1cfd485..fdbcb0ae 100644 --- a/src/Webhooks/UploadPostTransformSuccessEvent.php +++ b/src/Webhooks/UploadPostTransformSuccessEvent.php @@ -13,17 +13,30 @@ /** * Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event. * - * @phpstan-type unnamed_type_with_intersection_parent6 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type upload_post_transform_success_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class UploadPostTransformSuccessEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'upload.post-transform.success'; + public string $type; /** * Timestamp of when the event occurred in ISO8601 format. @@ -42,13 +55,17 @@ final class UploadPostTransformSuccessEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPostTransformSuccessEvent::with(createdAt: ..., data: ..., request: ...) + * UploadPostTransformSuccessEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPostTransformSuccessEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -65,12 +82,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -78,6 +99,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPreTransformErrorEvent.php b/src/Webhooks/UploadPreTransformErrorEvent.php index 50f990ef..b509717b 100644 --- a/src/Webhooks/UploadPreTransformErrorEvent.php +++ b/src/Webhooks/UploadPreTransformErrorEvent.php @@ -13,17 +13,30 @@ /** * Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied. * - * @phpstan-type unnamed_type_with_intersection_parent7 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type upload_pre_transform_error_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class UploadPreTransformErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'upload.pre-transform.error'; + public string $type; /** * Timestamp of when the event occurred in ISO8601 format. @@ -42,13 +55,17 @@ final class UploadPreTransformErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPreTransformErrorEvent::with(createdAt: ..., data: ..., request: ...) + * UploadPreTransformErrorEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPreTransformErrorEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -65,12 +82,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -78,6 +99,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/UploadPreTransformSuccessEvent.php b/src/Webhooks/UploadPreTransformSuccessEvent.php index adf2b8e8..3838957b 100644 --- a/src/Webhooks/UploadPreTransformSuccessEvent.php +++ b/src/Webhooks/UploadPreTransformSuccessEvent.php @@ -13,17 +13,30 @@ /** * Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library. * - * @phpstan-type unnamed_type_with_intersection_parent8 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type upload_pre_transform_success_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class UploadPreTransformSuccessEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'upload.pre-transform.success'; + public string $type; /** * Timestamp of when the event occurred in ISO8601 format. @@ -45,13 +58,17 @@ final class UploadPreTransformSuccessEvent implements BaseModel * * To enforce required parameters use * ``` - * UploadPreTransformSuccessEvent::with(createdAt: ..., data: ..., request: ...) + * UploadPreTransformSuccessEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new UploadPreTransformSuccessEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -68,12 +85,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -81,6 +102,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp of when the event occurred in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationAcceptedEvent.php b/src/Webhooks/VideoTransformationAcceptedEvent.php index 931d780d..c0c92749 100644 --- a/src/Webhooks/VideoTransformationAcceptedEvent.php +++ b/src/Webhooks/VideoTransformationAcceptedEvent.php @@ -13,17 +13,30 @@ /** * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle. * - * @phpstan-type unnamed_type_with_intersection_parent9 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type video_transformation_accepted_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class VideoTransformationAcceptedEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'video.transformation.accepted'; + public string $type; /** * Timestamp when the event was created in ISO8601 format. @@ -45,13 +58,17 @@ final class VideoTransformationAcceptedEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationAcceptedEvent::with(createdAt: ..., data: ..., request: ...) + * VideoTransformationAcceptedEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationAcceptedEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -68,12 +85,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -81,6 +102,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp when the event was created in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationErrorEvent.php b/src/Webhooks/VideoTransformationErrorEvent.php index 6b264bb8..4bc6a3ae 100644 --- a/src/Webhooks/VideoTransformationErrorEvent.php +++ b/src/Webhooks/VideoTransformationErrorEvent.php @@ -13,17 +13,30 @@ /** * Triggered when an error occurs during video encoding. Listen to this webhook to log error reasons and debug issues. Check your origin and URL endpoint settings if the reason is related to download failure. For other errors, contact ImageKit support. * - * @phpstan-type unnamed_type_with_intersection_parent10 = array{ - * createdAt: \DateTimeInterface, data: Data, request: Request, type: string + * @phpstan-type video_transformation_error_event = array{ + * id: string, + * type: string, + * createdAt: \DateTimeInterface, + * data: Data, + * request: Request, * } */ final class VideoTransformationErrorEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'video.transformation.error'; + public string $type; /** * Timestamp when the event was created in ISO8601 format. @@ -45,13 +58,17 @@ final class VideoTransformationErrorEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationErrorEvent::with(createdAt: ..., data: ..., request: ...) + * VideoTransformationErrorEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationErrorEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -68,12 +85,16 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, - Request $request + Request $request, ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -81,6 +102,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp when the event was created in ISO8601 format. */ diff --git a/src/Webhooks/VideoTransformationReadyEvent.php b/src/Webhooks/VideoTransformationReadyEvent.php index ecbda8e3..25a0dc12 100644 --- a/src/Webhooks/VideoTransformationReadyEvent.php +++ b/src/Webhooks/VideoTransformationReadyEvent.php @@ -14,21 +14,31 @@ /** * Triggered when video encoding is finished and the transformed resource is ready to be served. This is the key event to listen for - update your database or CMS flags when you receive this so your application can start showing the transformed video to users. * - * @phpstan-type unnamed_type_with_intersection_parent11 = array{ + * @phpstan-type video_transformation_ready_event = array{ + * id: string, + * type: string, * createdAt: \DateTimeInterface, * data: Data, * request: Request, - * type: string, * timings?: Timings, * } */ final class VideoTransformationReadyEvent implements BaseModel { - /** @use SdkModel */ + /** @use SdkModel */ use SdkModel; + /** + * Unique identifier for the event. + */ + #[Api] + public string $id; + + /** + * The type of webhook event. + */ #[Api] - public string $type = 'video.transformation.ready'; + public string $type; /** * Timestamp when the event was created in ISO8601 format. @@ -56,13 +66,17 @@ final class VideoTransformationReadyEvent implements BaseModel * * To enforce required parameters use * ``` - * VideoTransformationReadyEvent::with(createdAt: ..., data: ..., request: ...) + * VideoTransformationReadyEvent::with( + * id: ..., type: ..., createdAt: ..., data: ..., request: ... + * ) * ``` * * Otherwise ensure the following setters are called * * ``` * (new VideoTransformationReadyEvent) + * ->withID(...) + * ->withType(...) * ->withCreatedAt(...) * ->withData(...) * ->withRequest(...) @@ -79,6 +93,8 @@ public function __construct() * You must use named parameters to construct any parameters with a default value. */ public static function with( + string $id, + string $type, \DateTimeInterface $createdAt, Data $data, Request $request, @@ -86,6 +102,8 @@ public static function with( ): self { $obj = new self; + $obj->id = $id; + $obj->type = $type; $obj->createdAt = $createdAt; $obj->data = $data; $obj->request = $request; @@ -95,6 +113,28 @@ public static function with( return $obj; } + /** + * Unique identifier for the event. + */ + public function withID(string $id): self + { + $obj = clone $this; + $obj->id = $id; + + return $obj; + } + + /** + * The type of webhook event. + */ + public function withType(string $type): self + { + $obj = clone $this; + $obj->type = $type; + + return $obj; + } + /** * Timestamp when the event was created in ISO8601 format. */ From d3e94af126fa9bf00a0a704aa9fbc8e37125447a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 14 Sep 2025 02:04:17 +0000 Subject: [PATCH 30/40] fix(client): elide client methods in docs --- src/Transformation.php | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/src/Transformation.php b/src/Transformation.php index 6ac49613..fd3973d1 100644 --- a/src/Transformation.php +++ b/src/Transformation.php @@ -113,7 +113,7 @@ final class Transformation implements BaseModel * Supported inside overlay. * See [AI Background Removal](https://imagekit.io/docs/ai-transformations#imagekit-background-removal-e-bgremove). */ - #[Api(enum: STAINLESS_FIXME_AIRemoveBackground::class, optional: true)] + #[Api(optional: true)] public ?bool $aiRemoveBackground; /** @@ -122,24 +122,21 @@ final class Transformation implements BaseModel * Supported inside overlay. * See [External Background Removal](https://imagekit.io/docs/ai-transformations#background-removal-e-removedotbg). */ - #[Api( - enum: STAINLESS_FIXME_AIRemoveBackgroundExternal::class, - optional: true - )] + #[Api(optional: true)] public ?bool $aiRemoveBackgroundExternal; /** * Performs AI-based retouching to improve faces or product shots. Not supported inside overlay. * See [AI Retouch](https://imagekit.io/docs/ai-transformations#retouch-e-retouch). */ - #[Api(enum: STAINLESS_FIXME_AIRetouch::class, optional: true)] + #[Api(optional: true)] public ?bool $aiRetouch; /** * Upscales images beyond their original dimensions using AI. Not supported inside overlay. * See [AI Upscale](https://imagekit.io/docs/ai-transformations#upscale-e-upscale). */ - #[Api(enum: STAINLESS_FIXME_AIUpscale::class, optional: true)] + #[Api(optional: true)] public ?bool $aiUpscale; /** @@ -147,7 +144,7 @@ enum: STAINLESS_FIXME_AIRemoveBackgroundExternal::class, * such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay. * See [AI Generate Variations](https://imagekit.io/docs/ai-transformations#generate-variations-of-an-image-e-genvar). */ - #[Api(enum: STAINLESS_FIXME_AIVariation::class, optional: true)] + #[Api(optional: true)] public ?bool $aiVariation; /** @@ -202,7 +199,7 @@ enum: STAINLESS_FIXME_AIRemoveBackgroundExternal::class, * Automatically enhances the contrast of an image (contrast stretch). * See [Contrast Stretch](https://imagekit.io/docs/effects-and-enhancements#contrast-stretch---e-contrast). */ - #[Api(enum: STAINLESS_FIXME_ContrastStretch::class, optional: true)] + #[Api(optional: true)] public ?bool $contrastStretch; /** @@ -293,7 +290,7 @@ enum: STAINLESS_FIXME_AIRemoveBackgroundExternal::class, /** * Enables a grayscale effect for images. See [Grayscale](https://imagekit.io/docs/effects-and-enhancements#grayscale---e-grayscale). */ - #[Api(enum: STAINLESS_FIXME_Grayscale::class, optional: true)] + #[Api(optional: true)] public ?bool $grayscale; /** From bfc46add70562512b60928554638368443b6e38c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 12:58:07 +0000 Subject: [PATCH 31/40] feat(api): manual updates --- .stats.yml | 6 +- src/Files/FileUpdateParams.php | 34 ++++--- src/Files/FileUpdateParams/Publish.php | 93 ------------------- .../ChangePublicationStatus.php | 55 ----------- .../ChangePublicationStatus/Publish.php | 93 ------------------- ...tailsRequest.php => UpdateFileRequest.php} | 10 +- .../UpdateFileDetails.php | 4 +- .../UpdateFileDetails/RemoveAITags.php | 2 +- src/ServiceContracts/FilesContract.php | 5 +- src/Services/FilesService.php | 7 +- tests/Services/FilesTest.php | 14 ++- 11 files changed, 51 insertions(+), 272 deletions(-) delete mode 100644 src/Files/FileUpdateParams/Publish.php delete mode 100644 src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php delete mode 100644 src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php rename src/Files/{UpdateFileDetailsRequest.php => UpdateFileRequest.php} (60%) rename src/Files/{UpdateFileDetailsRequest => UpdateFileRequest}/UpdateFileDetails.php (98%) rename src/Files/{UpdateFileDetailsRequest => UpdateFileRequest}/UpdateFileDetails/RemoveAITags.php (92%) diff --git a/.stats.yml b/.stats.yml index b0086e96..bb4a090c 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-bc7c0d27962b30c19c778656988e154b54696819389289f34420a5e5fdfbd3b8.yml -openapi_spec_hash: 1bfde02a63416c036e9545927f727459 -config_hash: b415c06a3b29485af4601beb94ae1aeb +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-dd864816d7f4316ae89f57394da2fd1926166d4704db5a0bb5d23461d2d75e49.yml +openapi_spec_hash: 7f7c416563a15bbaea98804ecdc1a8f9 +config_hash: 54c05a157f2cc730fac9e1df5dc3ca29 diff --git a/src/Files/FileUpdateParams.php b/src/Files/FileUpdateParams.php index 0fb8c92e..3b10e7ee 100644 --- a/src/Files/FileUpdateParams.php +++ b/src/Files/FileUpdateParams.php @@ -12,7 +12,6 @@ use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; -use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateParams\RemoveAITags; /** @@ -39,7 +38,7 @@ * removeAITags?: string|list, * tags?: list|null, * webhookURL?: string, - * publish?: Publish, + * body: mixed, * } */ final class FileUpdateParams implements BaseModel @@ -102,12 +101,23 @@ final class FileUpdateParams implements BaseModel #[Api('webhookUrl', optional: true)] public ?string $webhookURL; + #[Api] + public mixed $body; + /** - * Configure the publication status of a file and its versions. + * `new FileUpdateParams()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * FileUpdateParams::with(body: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new FileUpdateParams)->withBody(...) + * ``` */ - #[Api(optional: true)] - public ?Publish $publish; - public function __construct() { $this->initialize(); @@ -124,6 +134,7 @@ public function __construct() * @param list|null $tags */ public static function with( + mixed $body, ?string $customCoordinates = null, ?array $customMetadata = null, ?string $description = null, @@ -131,10 +142,11 @@ public static function with( string|array|null $removeAITags = null, ?array $tags = null, ?string $webhookURL = null, - ?Publish $publish = null, ): self { $obj = new self; + $obj->body = $body; + null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; null !== $customMetadata && $obj->customMetadata = $customMetadata; null !== $description && $obj->description = $description; @@ -142,7 +154,6 @@ public static function with( null !== $removeAITags && $obj->removeAITags = $removeAITags; null !== $tags && $obj->tags = $tags; null !== $webhookURL && $obj->webhookURL = $webhookURL; - null !== $publish && $obj->publish = $publish; return $obj; } @@ -236,13 +247,10 @@ public function withWebhookURL(string $webhookURL): self return $obj; } - /** - * Configure the publication status of a file and its versions. - */ - public function withPublish(Publish $publish): self + public function withBody(mixed $body): self { $obj = clone $this; - $obj->publish = $publish; + $obj->body = $body; return $obj; } diff --git a/src/Files/FileUpdateParams/Publish.php b/src/Files/FileUpdateParams/Publish.php deleted file mode 100644 index b49cd390..00000000 --- a/src/Files/FileUpdateParams/Publish.php +++ /dev/null @@ -1,93 +0,0 @@ - */ - use SdkModel; - - /** - * Set to `true` to publish the file. Set to `false` to unpublish the file. - */ - #[Api] - public bool $isPublished; - - /** - * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. - */ - #[Api(optional: true)] - public ?bool $includeFileVersions; - - /** - * `new Publish()` is missing required properties by the API. - * - * To enforce required parameters use - * ``` - * Publish::with(isPublished: ...) - * ``` - * - * Otherwise ensure the following setters are called - * - * ``` - * (new Publish)->withIsPublished(...) - * ``` - */ - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with( - bool $isPublished, - ?bool $includeFileVersions = null - ): self { - $obj = new self; - - $obj->isPublished = $isPublished; - - null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; - - return $obj; - } - - /** - * Set to `true` to publish the file. Set to `false` to unpublish the file. - */ - public function withIsPublished(bool $isPublished): self - { - $obj = clone $this; - $obj->isPublished = $isPublished; - - return $obj; - } - - /** - * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. - */ - public function withIncludeFileVersions(bool $includeFileVersions): self - { - $obj = clone $this; - $obj->includeFileVersions = $includeFileVersions; - - return $obj; - } -} diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php deleted file mode 100644 index 4b005ce2..00000000 --- a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus.php +++ /dev/null @@ -1,55 +0,0 @@ - */ - use SdkModel; - - /** - * Configure the publication status of a file and its versions. - */ - #[Api(optional: true)] - public ?Publish $publish; - - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with(?Publish $publish = null): self - { - $obj = new self; - - null !== $publish && $obj->publish = $publish; - - return $obj; - } - - /** - * Configure the publication status of a file and its versions. - */ - public function withPublish(Publish $publish): self - { - $obj = clone $this; - $obj->publish = $publish; - - return $obj; - } -} diff --git a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php b/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php deleted file mode 100644 index 8fddee82..00000000 --- a/src/Files/UpdateFileDetailsRequest/ChangePublicationStatus/Publish.php +++ /dev/null @@ -1,93 +0,0 @@ - */ - use SdkModel; - - /** - * Set to `true` to publish the file. Set to `false` to unpublish the file. - */ - #[Api] - public bool $isPublished; - - /** - * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. - */ - #[Api(optional: true)] - public ?bool $includeFileVersions; - - /** - * `new Publish()` is missing required properties by the API. - * - * To enforce required parameters use - * ``` - * Publish::with(isPublished: ...) - * ``` - * - * Otherwise ensure the following setters are called - * - * ``` - * (new Publish)->withIsPublished(...) - * ``` - */ - public function __construct() - { - $this->initialize(); - } - - /** - * Construct an instance from the required parameters. - * - * You must use named parameters to construct any parameters with a default value. - */ - public static function with( - bool $isPublished, - ?bool $includeFileVersions = null - ): self { - $obj = new self; - - $obj->isPublished = $isPublished; - - null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; - - return $obj; - } - - /** - * Set to `true` to publish the file. Set to `false` to unpublish the file. - */ - public function withIsPublished(bool $isPublished): self - { - $obj = clone $this; - $obj->isPublished = $isPublished; - - return $obj; - } - - /** - * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. - */ - public function withIncludeFileVersions(bool $includeFileVersions): self - { - $obj = clone $this; - $obj->includeFileVersions = $includeFileVersions; - - return $obj; - } -} diff --git a/src/Files/UpdateFileDetailsRequest.php b/src/Files/UpdateFileRequest.php similarity index 60% rename from src/Files/UpdateFileDetailsRequest.php rename to src/Files/UpdateFileRequest.php index ee60beb4..01945641 100644 --- a/src/Files/UpdateFileDetailsRequest.php +++ b/src/Files/UpdateFileRequest.php @@ -7,10 +7,12 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; -use ImageKit\Files\UpdateFileDetailsRequest\ChangePublicationStatus; -use ImageKit\Files\UpdateFileDetailsRequest\UpdateFileDetails; +use ImageKit\Files\UpdateFileRequest\UpdateFileDetails; -final class UpdateFileDetailsRequest implements ConverterSource +/** + * Schema for update file update request. + */ +final class UpdateFileRequest implements ConverterSource { use SdkUnion; @@ -20,6 +22,6 @@ final class UpdateFileDetailsRequest implements ConverterSource */ public static function variants(): array { - return [UpdateFileDetails::class, ChangePublicationStatus::class]; + return [UpdateFileDetails::class, 'mixed']; } } diff --git a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php b/src/Files/UpdateFileRequest/UpdateFileDetails.php similarity index 98% rename from src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php rename to src/Files/UpdateFileRequest/UpdateFileDetails.php index 5b6149f1..1e21fff2 100644 --- a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails.php +++ b/src/Files/UpdateFileRequest/UpdateFileDetails.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\UpdateFileDetailsRequest; +namespace ImageKit\Files\UpdateFileRequest; use ImageKit\Core\Attributes\Api; use ImageKit\Core\Concerns\SdkModel; @@ -11,7 +11,7 @@ use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; -use ImageKit\Files\UpdateFileDetailsRequest\UpdateFileDetails\RemoveAITags; +use ImageKit\Files\UpdateFileRequest\UpdateFileDetails\RemoveAITags; /** * @phpstan-type update_file_details = array{ diff --git a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php b/src/Files/UpdateFileRequest/UpdateFileDetails/RemoveAITags.php similarity index 92% rename from src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php rename to src/Files/UpdateFileRequest/UpdateFileDetails/RemoveAITags.php index f07ba68b..bffc8ccb 100644 --- a/src/Files/UpdateFileDetailsRequest/UpdateFileDetails/RemoveAITags.php +++ b/src/Files/UpdateFileRequest/UpdateFileDetails/RemoveAITags.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace ImageKit\Files\UpdateFileDetailsRequest\UpdateFileDetails; +namespace ImageKit\Files\UpdateFileRequest\UpdateFileDetails; use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; diff --git a/src/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php index 8d06b2f5..cf3aea2b 100644 --- a/src/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -13,7 +13,6 @@ use ImageKit\Files\FileCopyResponse; use ImageKit\Files\FileMoveResponse; use ImageKit\Files\FileRenameResponse; -use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; @@ -39,7 +38,7 @@ interface FilesContract * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - * @param Publish $publish configure the publication status of a file and its versions + * @param mixed $body * * @return FileUpdateResponse * @@ -54,7 +53,7 @@ public function update( $removeAITags = omit, $tags = omit, $webhookURL = omit, - $publish = omit, + $body, ?RequestOptions $requestOptions = null, ): FileUpdateResponse; diff --git a/src/Services/FilesService.php b/src/Services/FilesService.php index 6d9a729e..906cc358 100644 --- a/src/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -18,7 +18,6 @@ use ImageKit\Files\FileRenameParams; use ImageKit\Files\FileRenameResponse; use ImageKit\Files\FileUpdateParams; -use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams; use ImageKit\Files\FileUploadParams\ResponseField; @@ -76,7 +75,7 @@ public function __construct(private Client $client) * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - * @param Publish $publish configure the publication status of a file and its versions + * @param mixed $body * * @return FileUpdateResponse * @@ -91,7 +90,7 @@ public function update( $removeAITags = omit, $tags = omit, $webhookURL = omit, - $publish = omit, + $body, ?RequestOptions $requestOptions = null, ): FileUpdateResponse { $params = [ @@ -102,7 +101,7 @@ public function update( 'removeAITags' => $removeAITags, 'tags' => $tags, 'webhookURL' => $webhookURL, - 'publish' => $publish, + 'body' => $body, ]; return $this->updateRaw($fileID, $params, $requestOptions); diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 665d0714..8534cd1f 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -37,7 +37,19 @@ public function testUpdate(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->update('fileId'); + $result = $this->client->files->update('fileId', body: (object) []); + + $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType + } + + #[Test] + public function testUpdateWithOptionalParams(): void + { + if (UnsupportedMockTests::$skip) { + $this->markTestSkipped('Prism tests are disabled'); + } + + $result = $this->client->files->update('fileId', body: (object) []); $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } From 2d65a573684fed507cfb7397f73ef22b9d9e8f94 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:02:40 +0000 Subject: [PATCH 32/40] feat(api): manual updates --- .stats.yml | 4 +- src/Files/FileUpdateParams.php | 34 +++---- src/Files/FileUpdateParams/Publish.php | 93 +++++++++++++++++++ src/Files/UpdateFileRequest.php | 3 +- .../ChangePublicationStatus.php | 55 +++++++++++ .../ChangePublicationStatus/Publish.php | 93 +++++++++++++++++++ src/ServiceContracts/FilesContract.php | 5 +- src/Services/FilesService.php | 7 +- tests/Services/FilesTest.php | 14 +-- 9 files changed, 266 insertions(+), 42 deletions(-) create mode 100644 src/Files/FileUpdateParams/Publish.php create mode 100644 src/Files/UpdateFileRequest/ChangePublicationStatus.php create mode 100644 src/Files/UpdateFileRequest/ChangePublicationStatus/Publish.php diff --git a/.stats.yml b/.stats.yml index bb4a090c..c9c84db9 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-dd864816d7f4316ae89f57394da2fd1926166d4704db5a0bb5d23461d2d75e49.yml -openapi_spec_hash: 7f7c416563a15bbaea98804ecdc1a8f9 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml +openapi_spec_hash: 1d382866fce3284f26d341f112988d9d config_hash: 54c05a157f2cc730fac9e1df5dc3ca29 diff --git a/src/Files/FileUpdateParams.php b/src/Files/FileUpdateParams.php index 3b10e7ee..0fb8c92e 100644 --- a/src/Files/FileUpdateParams.php +++ b/src/Files/FileUpdateParams.php @@ -12,6 +12,7 @@ use ImageKit\ExtensionItem\AIAutoDescription; use ImageKit\ExtensionItem\AutoTaggingExtension; use ImageKit\ExtensionItem\RemoveBg; +use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateParams\RemoveAITags; /** @@ -38,7 +39,7 @@ * removeAITags?: string|list, * tags?: list|null, * webhookURL?: string, - * body: mixed, + * publish?: Publish, * } */ final class FileUpdateParams implements BaseModel @@ -101,23 +102,12 @@ final class FileUpdateParams implements BaseModel #[Api('webhookUrl', optional: true)] public ?string $webhookURL; - #[Api] - public mixed $body; - /** - * `new FileUpdateParams()` is missing required properties by the API. - * - * To enforce required parameters use - * ``` - * FileUpdateParams::with(body: ...) - * ``` - * - * Otherwise ensure the following setters are called - * - * ``` - * (new FileUpdateParams)->withBody(...) - * ``` + * Configure the publication status of a file and its versions. */ + #[Api(optional: true)] + public ?Publish $publish; + public function __construct() { $this->initialize(); @@ -134,7 +124,6 @@ public function __construct() * @param list|null $tags */ public static function with( - mixed $body, ?string $customCoordinates = null, ?array $customMetadata = null, ?string $description = null, @@ -142,11 +131,10 @@ public static function with( string|array|null $removeAITags = null, ?array $tags = null, ?string $webhookURL = null, + ?Publish $publish = null, ): self { $obj = new self; - $obj->body = $body; - null !== $customCoordinates && $obj->customCoordinates = $customCoordinates; null !== $customMetadata && $obj->customMetadata = $customMetadata; null !== $description && $obj->description = $description; @@ -154,6 +142,7 @@ public static function with( null !== $removeAITags && $obj->removeAITags = $removeAITags; null !== $tags && $obj->tags = $tags; null !== $webhookURL && $obj->webhookURL = $webhookURL; + null !== $publish && $obj->publish = $publish; return $obj; } @@ -247,10 +236,13 @@ public function withWebhookURL(string $webhookURL): self return $obj; } - public function withBody(mixed $body): self + /** + * Configure the publication status of a file and its versions. + */ + public function withPublish(Publish $publish): self { $obj = clone $this; - $obj->body = $body; + $obj->publish = $publish; return $obj; } diff --git a/src/Files/FileUpdateParams/Publish.php b/src/Files/FileUpdateParams/Publish.php new file mode 100644 index 00000000..b49cd390 --- /dev/null +++ b/src/Files/FileUpdateParams/Publish.php @@ -0,0 +1,93 @@ + */ + use SdkModel; + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + #[Api] + public bool $isPublished; + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + #[Api(optional: true)] + public ?bool $includeFileVersions; + + /** + * `new Publish()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Publish::with(isPublished: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Publish)->withIsPublished(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + bool $isPublished, + ?bool $includeFileVersions = null + ): self { + $obj = new self; + + $obj->isPublished = $isPublished; + + null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + public function withIncludeFileVersions(bool $includeFileVersions): self + { + $obj = clone $this; + $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } +} diff --git a/src/Files/UpdateFileRequest.php b/src/Files/UpdateFileRequest.php index 01945641..f6bde78a 100644 --- a/src/Files/UpdateFileRequest.php +++ b/src/Files/UpdateFileRequest.php @@ -7,6 +7,7 @@ use ImageKit\Core\Concerns\SdkUnion; use ImageKit\Core\Conversion\Contracts\Converter; use ImageKit\Core\Conversion\Contracts\ConverterSource; +use ImageKit\Files\UpdateFileRequest\ChangePublicationStatus; use ImageKit\Files\UpdateFileRequest\UpdateFileDetails; /** @@ -22,6 +23,6 @@ final class UpdateFileRequest implements ConverterSource */ public static function variants(): array { - return [UpdateFileDetails::class, 'mixed']; + return [UpdateFileDetails::class, ChangePublicationStatus::class]; } } diff --git a/src/Files/UpdateFileRequest/ChangePublicationStatus.php b/src/Files/UpdateFileRequest/ChangePublicationStatus.php new file mode 100644 index 00000000..b111e254 --- /dev/null +++ b/src/Files/UpdateFileRequest/ChangePublicationStatus.php @@ -0,0 +1,55 @@ + */ + use SdkModel; + + /** + * Configure the publication status of a file and its versions. + */ + #[Api(optional: true)] + public ?Publish $publish; + + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with(?Publish $publish = null): self + { + $obj = new self; + + null !== $publish && $obj->publish = $publish; + + return $obj; + } + + /** + * Configure the publication status of a file and its versions. + */ + public function withPublish(Publish $publish): self + { + $obj = clone $this; + $obj->publish = $publish; + + return $obj; + } +} diff --git a/src/Files/UpdateFileRequest/ChangePublicationStatus/Publish.php b/src/Files/UpdateFileRequest/ChangePublicationStatus/Publish.php new file mode 100644 index 00000000..d7800eab --- /dev/null +++ b/src/Files/UpdateFileRequest/ChangePublicationStatus/Publish.php @@ -0,0 +1,93 @@ + */ + use SdkModel; + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + #[Api] + public bool $isPublished; + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + #[Api(optional: true)] + public ?bool $includeFileVersions; + + /** + * `new Publish()` is missing required properties by the API. + * + * To enforce required parameters use + * ``` + * Publish::with(isPublished: ...) + * ``` + * + * Otherwise ensure the following setters are called + * + * ``` + * (new Publish)->withIsPublished(...) + * ``` + */ + public function __construct() + { + $this->initialize(); + } + + /** + * Construct an instance from the required parameters. + * + * You must use named parameters to construct any parameters with a default value. + */ + public static function with( + bool $isPublished, + ?bool $includeFileVersions = null + ): self { + $obj = new self; + + $obj->isPublished = $isPublished; + + null !== $includeFileVersions && $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } + + /** + * Set to `true` to publish the file. Set to `false` to unpublish the file. + */ + public function withIsPublished(bool $isPublished): self + { + $obj = clone $this; + $obj->isPublished = $isPublished; + + return $obj; + } + + /** + * Set to `true` to publish/unpublish all versions of the file. Set to `false` to publish/unpublish only the current version of the file. + */ + public function withIncludeFileVersions(bool $includeFileVersions): self + { + $obj = clone $this; + $obj->includeFileVersions = $includeFileVersions; + + return $obj; + } +} diff --git a/src/ServiceContracts/FilesContract.php b/src/ServiceContracts/FilesContract.php index cf3aea2b..8d06b2f5 100644 --- a/src/ServiceContracts/FilesContract.php +++ b/src/ServiceContracts/FilesContract.php @@ -13,6 +13,7 @@ use ImageKit\Files\FileCopyResponse; use ImageKit\Files\FileMoveResponse; use ImageKit\Files\FileRenameResponse; +use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams\ResponseField; use ImageKit\Files\FileUploadParams\Transformation; @@ -38,7 +39,7 @@ interface FilesContract * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - * @param mixed $body + * @param Publish $publish configure the publication status of a file and its versions * * @return FileUpdateResponse * @@ -53,7 +54,7 @@ public function update( $removeAITags = omit, $tags = omit, $webhookURL = omit, - $body, + $publish = omit, ?RequestOptions $requestOptions = null, ): FileUpdateResponse; diff --git a/src/Services/FilesService.php b/src/Services/FilesService.php index 906cc358..6d9a729e 100644 --- a/src/Services/FilesService.php +++ b/src/Services/FilesService.php @@ -18,6 +18,7 @@ use ImageKit\Files\FileRenameParams; use ImageKit\Files\FileRenameResponse; use ImageKit\Files\FileUpdateParams; +use ImageKit\Files\FileUpdateParams\Publish; use ImageKit\Files\FileUpdateResponse; use ImageKit\Files\FileUploadParams; use ImageKit\Files\FileUploadParams\ResponseField; @@ -75,7 +76,7 @@ public function __construct(private Client $client) * Note: The remove operation for `AITags` executes before any of the `extensions` are processed. * @param list|null $tags An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `null` to unset all tags associated with the file. * @param string $webhookURL The final status of extensions after they have completed execution will be delivered to this endpoint as a POST request. [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure) about the webhook payload structure. - * @param mixed $body + * @param Publish $publish configure the publication status of a file and its versions * * @return FileUpdateResponse * @@ -90,7 +91,7 @@ public function update( $removeAITags = omit, $tags = omit, $webhookURL = omit, - $body, + $publish = omit, ?RequestOptions $requestOptions = null, ): FileUpdateResponse { $params = [ @@ -101,7 +102,7 @@ public function update( 'removeAITags' => $removeAITags, 'tags' => $tags, 'webhookURL' => $webhookURL, - 'body' => $body, + 'publish' => $publish, ]; return $this->updateRaw($fileID, $params, $requestOptions); diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 8534cd1f..665d0714 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -37,19 +37,7 @@ public function testUpdate(): void $this->markTestSkipped('Prism tests are disabled'); } - $result = $this->client->files->update('fileId', body: (object) []); - - $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType - } - - #[Test] - public function testUpdateWithOptionalParams(): void - { - if (UnsupportedMockTests::$skip) { - $this->markTestSkipped('Prism tests are disabled'); - } - - $result = $this->client->files->update('fileId', body: (object) []); + $result = $this->client->files->update('fileId'); $this->assertTrue(true); // @phpstan-ignore method.alreadyNarrowedType } From 333c06bedfbe8d5a91d1549ad5d67f05e794d159 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:38:35 +0000 Subject: [PATCH 33/40] feat(api): manual updates --- .stats.yml | 2 +- README.md | 2 +- src/Client.php | 12 ++++++------ tests/Services/Accounts/OriginsTest.php | 4 ++-- tests/Services/Accounts/URLEndpointsTest.php | 4 ++-- tests/Services/Accounts/UsageTest.php | 4 ++-- tests/Services/AssetsTest.php | 4 ++-- tests/Services/Beta/V2/FilesTest.php | 4 ++-- tests/Services/Cache/InvalidationTest.php | 4 ++-- tests/Services/CustomMetadataFieldsTest.php | 4 ++-- tests/Services/Files/BulkTest.php | 4 ++-- tests/Services/Files/MetadataTest.php | 4 ++-- tests/Services/Files/VersionsTest.php | 4 ++-- tests/Services/FilesTest.php | 4 ++-- tests/Services/Folders/JobTest.php | 4 ++-- tests/Services/FoldersTest.php | 4 ++-- tests/Services/WebhooksTest.php | 4 ++-- 17 files changed, 36 insertions(+), 36 deletions(-) diff --git a/.stats.yml b/.stats.yml index c9c84db9..00fd95da 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: 54c05a157f2cc730fac9e1df5dc3ca29 +config_hash: 29a2351fe2be89392b15719be8bc964f diff --git a/README.md b/README.md index 0325e391..6d3f2c11 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Parameters with a default value must be set by name. use ImageKit\Client; $client = new Client( - privateAPIKey: getenv("IMAGEKIT_PRIVATE_API_KEY") ?: "My Private API Key", + privateKey: getenv("IMAGEKIT_PRIVATE_API_KEY") ?: "My Private Key", password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); diff --git a/src/Client.php b/src/Client.php index 9cdd9aa3..9d35b86e 100644 --- a/src/Client.php +++ b/src/Client.php @@ -18,7 +18,7 @@ class Client extends BaseClient { - public string $privateAPIKey; + public string $privateKey; public string $password; @@ -65,12 +65,12 @@ class Client extends BaseClient public WebhooksService $webhooks; public function __construct( - ?string $privateAPIKey = null, + ?string $privateKey = null, ?string $password = null, ?string $baseUrl = null, ) { - $this->privateAPIKey = (string) ( - $privateAPIKey ?? getenv('IMAGEKIT_PRIVATE_API_KEY') + $this->privateKey = (string) ( + $privateKey ?? getenv('IMAGEKIT_PRIVATE_API_KEY') ); $this->password = (string) ( $password ?? getenv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?: 'do_not_set' @@ -110,12 +110,12 @@ public function __construct( /** @return array */ protected function authHeaders(): array { - if (!$this->privateAPIKey && !$this->password) { + if (!$this->privateKey && !$this->password) { return []; } $base64_credentials = base64_encode( - "{$this->privateAPIKey}:{$this->password}" + "{$this->privateKey}:{$this->password}" ); return ['Authorization' => "Basic {$base64_credentials}"]; diff --git a/tests/Services/Accounts/OriginsTest.php b/tests/Services/Accounts/OriginsTest.php index eb26a0f1..c4730cc6 100644 --- a/tests/Services/Accounts/OriginsTest.php +++ b/tests/Services/Accounts/OriginsTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Accounts/URLEndpointsTest.php b/tests/Services/Accounts/URLEndpointsTest.php index e8d90155..ceaa0d5a 100644 --- a/tests/Services/Accounts/URLEndpointsTest.php +++ b/tests/Services/Accounts/URLEndpointsTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Accounts/UsageTest.php b/tests/Services/Accounts/UsageTest.php index 9bbfac6e..2c7e46fa 100644 --- a/tests/Services/Accounts/UsageTest.php +++ b/tests/Services/Accounts/UsageTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/AssetsTest.php b/tests/Services/AssetsTest.php index 3aae8c19..ade121a3 100644 --- a/tests/Services/AssetsTest.php +++ b/tests/Services/AssetsTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Beta/V2/FilesTest.php b/tests/Services/Beta/V2/FilesTest.php index 345801e4..2107b0bb 100644 --- a/tests/Services/Beta/V2/FilesTest.php +++ b/tests/Services/Beta/V2/FilesTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Cache/InvalidationTest.php b/tests/Services/Cache/InvalidationTest.php index 1575824f..3fd2c71d 100644 --- a/tests/Services/Cache/InvalidationTest.php +++ b/tests/Services/Cache/InvalidationTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/CustomMetadataFieldsTest.php b/tests/Services/CustomMetadataFieldsTest.php index bccfc446..ce448a18 100644 --- a/tests/Services/CustomMetadataFieldsTest.php +++ b/tests/Services/CustomMetadataFieldsTest.php @@ -23,9 +23,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Files/BulkTest.php b/tests/Services/Files/BulkTest.php index 73a5d80a..f4a05468 100644 --- a/tests/Services/Files/BulkTest.php +++ b/tests/Services/Files/BulkTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Files/MetadataTest.php b/tests/Services/Files/MetadataTest.php index 1e8517ff..e1db6e85 100644 --- a/tests/Services/Files/MetadataTest.php +++ b/tests/Services/Files/MetadataTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Files/VersionsTest.php b/tests/Services/Files/VersionsTest.php index c92db397..78dc7741 100644 --- a/tests/Services/Files/VersionsTest.php +++ b/tests/Services/Files/VersionsTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/FilesTest.php b/tests/Services/FilesTest.php index 665d0714..187cc16f 100644 --- a/tests/Services/FilesTest.php +++ b/tests/Services/FilesTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/Folders/JobTest.php b/tests/Services/Folders/JobTest.php index ce51df1f..fb36aa5a 100644 --- a/tests/Services/Folders/JobTest.php +++ b/tests/Services/Folders/JobTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/FoldersTest.php b/tests/Services/FoldersTest.php index 5aacd840..6ea1479c 100644 --- a/tests/Services/FoldersTest.php +++ b/tests/Services/FoldersTest.php @@ -22,9 +22,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; diff --git a/tests/Services/WebhooksTest.php b/tests/Services/WebhooksTest.php index c94df4e3..b0aac71d 100644 --- a/tests/Services/WebhooksTest.php +++ b/tests/Services/WebhooksTest.php @@ -20,9 +20,9 @@ protected function setUp(): void $testUrl = getenv('TEST_API_BASE_URL') ?: 'http://127.0.0.1:4010'; $client = new Client( - privateAPIKey: 'My Private API Key', + privateKey: 'My Private Key', password: 'My Password', - baseUrl: $testUrl, + baseUrl: $testUrl ); $this->client = $client; From 279ba5f3490c93368b1f01461ab470e34b1e5e44 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:45:59 +0000 Subject: [PATCH 34/40] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 00fd95da..d3fcabb4 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: 29a2351fe2be89392b15719be8bc964f +config_hash: c9c7bed2a4341f915a2dc85958ce7f0e From 3042a5062c2df21e230d90a17909af025650a958 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:52:28 +0000 Subject: [PATCH 35/40] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index d3fcabb4..ee45f3d5 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: c9c7bed2a4341f915a2dc85958ce7f0e +config_hash: 51a9632be24fc533ad69a5bd56934651 From a3edfdd78c4a8aa37d18c74d0adade953a63d834 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 20 Sep 2025 08:05:43 +0000 Subject: [PATCH 36/40] feat(api): Update env var name --- .stats.yml | 2 +- README.md | 2 +- src/Client.php | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index ee45f3d5..0f9a4aa3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: 51a9632be24fc533ad69a5bd56934651 +config_hash: f1fafe5e607e996b58b67fd1dd3e74fa diff --git a/README.md b/README.md index 6d3f2c11..a2f2ef72 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Parameters with a default value must be set by name. use ImageKit\Client; $client = new Client( - privateKey: getenv("IMAGEKIT_PRIVATE_API_KEY") ?: "My Private Key", + privateKey: getenv("IMAGEKIT_PRIVATE_KEY") ?: "My Private Key", password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set", ); diff --git a/src/Client.php b/src/Client.php index 9d35b86e..4c254b08 100644 --- a/src/Client.php +++ b/src/Client.php @@ -70,7 +70,7 @@ public function __construct( ?string $baseUrl = null, ) { $this->privateKey = (string) ( - $privateKey ?? getenv('IMAGEKIT_PRIVATE_API_KEY') + $privateKey ?? getenv('IMAGEKIT_PRIVATE_KEY') ); $this->password = (string) ( $password ?? getenv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?: 'do_not_set' From aff2c753975007fed90c0400fef40c50a42d5587 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 20 Sep 2025 09:24:19 +0000 Subject: [PATCH 37/40] feat(api): update api docs link --- .stats.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0f9a4aa3..7dfc3c2a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: f1fafe5e607e996b58b67fd1dd3e74fa +config_hash: 5f7498f5ea66e8a544c6c37b10f77467 diff --git a/README.md b/README.md index a2f2ef72..e4ad28a4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ It is generated with [Stainless](https://www.stainless.com/). ## Documentation -The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs). +The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs/api-reference). ## Installation From a6f01f0756a28bb4deafc5f65480aad544c12947 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 20 Sep 2025 09:25:38 +0000 Subject: [PATCH 38/40] feat(api): remove Stainless attribution from readme --- .stats.yml | 2 +- README.md | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 7dfc3c2a..e1604c7a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: 5f7498f5ea66e8a544c6c37b10f77467 +config_hash: ff23f46fe08ef3f43c57c8cf13eff3a1 diff --git a/README.md b/README.md index e4ad28a4..6415f9ea 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ The Image Kit PHP library provides convenient access to the Image Kit REST API from any PHP 8.1.0+ application. -It is generated with [Stainless](https://www.stainless.com/). - ## Documentation The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs/api-reference). From 250d0154d4ae83e9e81e2e9002b1180faf8642c2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 21 Sep 2025 03:10:35 +0000 Subject: [PATCH 39/40] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index e1604c7a..031fed99 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 42 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml openapi_spec_hash: 1d382866fce3284f26d341f112988d9d -config_hash: ff23f46fe08ef3f43c57c8cf13eff3a1 +config_hash: d57f3c7c581048428b41398f30da8b9b From 72a4668c1207544425d7374ae18d6cc97abcae73 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 21 Sep 2025 03:12:22 +0000 Subject: [PATCH 40/40] release: 0.0.2 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 51 +++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 1332969b..c7159c1a 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.0.1" + ".": "0.0.2" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..9dac0d55 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,51 @@ +# Changelog + +## 0.0.2 (2025-09-21) + +Full Changelog: [v0.0.1...v0.0.2](https://github.com/imagekit-developer/imagekit-php/compare/v0.0.1...v0.0.2) + +### ⚠ BREAKING CHANGES + +* expose services and service contracts + +### Features + +* **api:** add BaseWebhookEvent ([84f5b7c](https://github.com/imagekit-developer/imagekit-php/commit/84f5b7c65eb1b7b23fdda823aca71c51b73023e3)) +* **api:** extract UpdateFileDetailsRequest to model ([8628e12](https://github.com/imagekit-developer/imagekit-php/commit/8628e12e2bdb99f3755bb1ea960547876fcccf00)) +* **api:** manual updates ([333c06b](https://github.com/imagekit-developer/imagekit-php/commit/333c06bedfbe8d5a91d1549ad5d67f05e794d159)) +* **api:** manual updates ([2d65a57](https://github.com/imagekit-developer/imagekit-php/commit/2d65a573684fed507cfb7397f73ef22b9d9e8f94)) +* **api:** manual updates ([bfc46ad](https://github.com/imagekit-developer/imagekit-php/commit/bfc46add70562512b60928554638368443b6e38c)) +* **api:** manual updates ([46dbc22](https://github.com/imagekit-developer/imagekit-php/commit/46dbc22461339a6be4f275f57b4f74a6fc2e4625)) +* **api:** manual updates ([e5c1428](https://github.com/imagekit-developer/imagekit-php/commit/e5c142868fae36f9f88f4142b98b47a1abbbaa1c)) +* **api:** manual updates ([2361086](https://github.com/imagekit-developer/imagekit-php/commit/2361086b4a3578fc04ac20da138d1ebcf3f92852)) +* **api:** manual updates ([de13f68](https://github.com/imagekit-developer/imagekit-php/commit/de13f687044f442b41ec1de7a72c2fd3ad27f1e1)) +* **api:** manual updates ([79f9906](https://github.com/imagekit-developer/imagekit-php/commit/79f9906770fee9602f9b1ed6397b5b00f015bcd2)) +* **api:** manual updates ([0daa175](https://github.com/imagekit-developer/imagekit-php/commit/0daa17580a73ebd447e344f01fa36f1fb593dd4d)) +* **api:** manual updates ([6ec4a94](https://github.com/imagekit-developer/imagekit-php/commit/6ec4a94508922f91f34d9b58226e047de6c40399)) +* **api:** manual updates ([2ebe4bf](https://github.com/imagekit-developer/imagekit-php/commit/2ebe4bffb958f8cd8c923b285bdb79b4d93ea755)) +* **api:** manual updates ([8aecc6e](https://github.com/imagekit-developer/imagekit-php/commit/8aecc6ee1d42589a554687c3a8138ff764ba223f)) +* **api:** manual updates ([3ac5bb6](https://github.com/imagekit-developer/imagekit-php/commit/3ac5bb60ab1b828c27a17e8d499309c1ac077dd9)) +* **api:** manual updates ([864a1aa](https://github.com/imagekit-developer/imagekit-php/commit/864a1aa121d394cbc89a9b305d03177777fe173e)) +* **api:** remove Stainless attribution from readme ([a6f01f0](https://github.com/imagekit-developer/imagekit-php/commit/a6f01f0756a28bb4deafc5f65480aad544c12947)) +* **api:** update api docs link ([aff2c75](https://github.com/imagekit-developer/imagekit-php/commit/aff2c753975007fed90c0400fef40c50a42d5587)) +* **api:** Update env var name ([a3edfdd](https://github.com/imagekit-developer/imagekit-php/commit/a3edfdd78c4a8aa37d18c74d0adade953a63d834)) +* **client:** add raw methods ([049e837](https://github.com/imagekit-developer/imagekit-php/commit/049e837e2827e68c6cada81e7e35e3ddef23beb9)) +* **client:** support raw responses ([cc5397d](https://github.com/imagekit-developer/imagekit-php/commit/cc5397ddbb7a5a58b22f25037a76cc502a972692)) +* **client:** use real enums ([0b65863](https://github.com/imagekit-developer/imagekit-php/commit/0b65863c45d58bf52bca76cfa8f7560e381d7dc9)) +* expose services and service contracts ([1329184](https://github.com/imagekit-developer/imagekit-php/commit/13291847d68a49a7468bf64dac797124ad8b2178)) + + +### Bug Fixes + +* **client:** elide client methods in docs ([d3e94af](https://github.com/imagekit-developer/imagekit-php/commit/d3e94af126fa9bf00a0a704aa9fbc8e37125447a)) +* decorate with enum label for all enum classes ([c3ea060](https://github.com/imagekit-developer/imagekit-php/commit/c3ea060ee47054167b8db064d3b423065fb106c1)) + + +### Chores + +* document parameter object usage ([c959bcf](https://github.com/imagekit-developer/imagekit-php/commit/c959bcf6d18e0f078fbed9d50c05d6feb1d81a42)) +* fix lints in UnionOf ([a57c7cc](https://github.com/imagekit-developer/imagekit-php/commit/a57c7cc9f5131daea2a45d261b414a3deed3adba)) +* **internal:** codegen related update ([76b7d1a](https://github.com/imagekit-developer/imagekit-php/commit/76b7d1a3bec0ff36b996eceb7af07a54f4a8439a)) +* **internal:** refactor base client internals ([aba7242](https://github.com/imagekit-developer/imagekit-php/commit/aba7242684bdef5c8926ef4f1e7b0909650cbf17)) +* sync repo ([bb14ef3](https://github.com/imagekit-developer/imagekit-php/commit/bb14ef396deb2b1bccc1e8d80da4bd47e3a04427)) +* update SDK settings ([6913a6d](https://github.com/imagekit-developer/imagekit-php/commit/6913a6de33f625b50dc0aa5881e1208e136c8b2a))