imagekitio 3.0.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +116 -0
- data/README.md +538 -679
- data/SECURITY.md +27 -0
- data/lib/imagekitio/client.rb +122 -195
- data/lib/imagekitio/errors.rb +226 -2
- data/lib/imagekitio/file_part.rb +58 -0
- data/lib/imagekitio/helpers/crypto_utils.rb +25 -0
- data/lib/imagekitio/helpers/helper.rb +689 -0
- data/lib/imagekitio/helpers/transformation_utils.rb +164 -0
- data/lib/imagekitio/helpers/uuid_utils.rb +18 -0
- data/lib/imagekitio/internal/transport/base_client.rb +567 -0
- data/lib/imagekitio/internal/transport/pooled_net_requester.rb +217 -0
- data/lib/imagekitio/internal/type/array_of.rb +168 -0
- data/lib/imagekitio/internal/type/base_model.rb +530 -0
- data/lib/imagekitio/internal/type/base_page.rb +55 -0
- data/lib/imagekitio/internal/type/boolean.rb +77 -0
- data/lib/imagekitio/internal/type/converter.rb +327 -0
- data/lib/imagekitio/internal/type/enum.rb +156 -0
- data/lib/imagekitio/internal/type/file_input.rb +111 -0
- data/lib/imagekitio/internal/type/hash_of.rb +188 -0
- data/lib/imagekitio/internal/type/request_parameters.rb +42 -0
- data/lib/imagekitio/internal/type/union.rb +250 -0
- data/lib/imagekitio/internal/type/unknown.rb +81 -0
- data/lib/imagekitio/internal/util.rb +915 -0
- data/lib/imagekitio/internal.rb +20 -0
- data/lib/imagekitio/models/accounts/origin_create_params.rb +24 -0
- data/lib/imagekitio/models/accounts/origin_delete_params.rb +16 -0
- data/lib/imagekitio/models/accounts/origin_get_params.rb +16 -0
- data/lib/imagekitio/models/accounts/origin_list_params.rb +16 -0
- data/lib/imagekitio/models/accounts/origin_list_response.rb +11 -0
- data/lib/imagekitio/models/accounts/origin_request.rb +547 -0
- data/lib/imagekitio/models/accounts/origin_response.rb +568 -0
- data/lib/imagekitio/models/accounts/origin_update_params.rb +24 -0
- data/lib/imagekitio/models/accounts/url_endpoint_create_params.rb +16 -0
- data/lib/imagekitio/models/accounts/url_endpoint_delete_params.rb +16 -0
- data/lib/imagekitio/models/accounts/url_endpoint_get_params.rb +16 -0
- data/lib/imagekitio/models/accounts/url_endpoint_list_params.rb +16 -0
- data/lib/imagekitio/models/accounts/url_endpoint_list_response.rb +11 -0
- data/lib/imagekitio/models/accounts/url_endpoint_request.rb +110 -0
- data/lib/imagekitio/models/accounts/url_endpoint_response.rb +123 -0
- data/lib/imagekitio/models/accounts/url_endpoint_update_params.rb +16 -0
- data/lib/imagekitio/models/accounts/usage_get_params.rb +37 -0
- data/lib/imagekitio/models/accounts/usage_get_response.rb +51 -0
- data/lib/imagekitio/models/asset_list_params.rb +158 -0
- data/lib/imagekitio/models/asset_list_response.rb +24 -0
- data/lib/imagekitio/models/base_overlay.rb +21 -0
- data/lib/imagekitio/models/base_webhook_event.rb +24 -0
- data/lib/imagekitio/models/beta/v2/file_upload_params.rb +510 -0
- data/lib/imagekitio/models/beta/v2/file_upload_response.rb +618 -0
- data/lib/imagekitio/models/cache/invalidation_create_params.rb +27 -0
- data/lib/imagekitio/models/cache/invalidation_create_response.rb +23 -0
- data/lib/imagekitio/models/cache/invalidation_get_params.rb +16 -0
- data/lib/imagekitio/models/cache/invalidation_get_response.rb +35 -0
- data/lib/imagekitio/models/custom_metadata_field.rb +243 -0
- data/lib/imagekitio/models/custom_metadata_field_create_params.rb +238 -0
- data/lib/imagekitio/models/custom_metadata_field_delete_params.rb +14 -0
- data/lib/imagekitio/models/custom_metadata_field_delete_response.rb +10 -0
- data/lib/imagekitio/models/custom_metadata_field_list_params.rb +36 -0
- data/lib/imagekitio/models/custom_metadata_field_list_response.rb +9 -0
- data/lib/imagekitio/models/custom_metadata_field_update_params.rb +212 -0
- data/lib/imagekitio/models/extensions.rb +136 -0
- data/lib/imagekitio/models/file.rb +497 -0
- data/lib/imagekitio/models/file_copy_params.rb +43 -0
- data/lib/imagekitio/models/file_copy_response.rb +10 -0
- data/lib/imagekitio/models/file_delete_params.rb +14 -0
- data/lib/imagekitio/models/file_get_params.rb +14 -0
- data/lib/imagekitio/models/file_move_params.rb +33 -0
- data/lib/imagekitio/models/file_move_response.rb +10 -0
- data/lib/imagekitio/models/file_rename_params.rb +61 -0
- data/lib/imagekitio/models/file_rename_response.rb +21 -0
- data/lib/imagekitio/models/file_update_params.rb +22 -0
- data/lib/imagekitio/models/file_update_response.rb +104 -0
- data/lib/imagekitio/models/file_upload_params.rb +540 -0
- data/lib/imagekitio/models/file_upload_response.rb +611 -0
- data/lib/imagekitio/models/files/bulk_add_tags_params.rb +35 -0
- data/lib/imagekitio/models/files/bulk_add_tags_response.rb +24 -0
- data/lib/imagekitio/models/files/bulk_delete_params.rb +27 -0
- data/lib/imagekitio/models/files/bulk_delete_response.rb +24 -0
- data/lib/imagekitio/models/files/bulk_remove_ai_tags_params.rb +35 -0
- data/lib/imagekitio/models/files/bulk_remove_ai_tags_response.rb +24 -0
- data/lib/imagekitio/models/files/bulk_remove_tags_params.rb +35 -0
- data/lib/imagekitio/models/files/bulk_remove_tags_response.rb +24 -0
- data/lib/imagekitio/models/files/metadata_get_from_url_params.rb +28 -0
- data/lib/imagekitio/models/files/metadata_get_params.rb +16 -0
- data/lib/imagekitio/models/files/version_delete_params.rb +22 -0
- data/lib/imagekitio/models/files/version_delete_response.rb +12 -0
- data/lib/imagekitio/models/files/version_get_params.rb +22 -0
- data/lib/imagekitio/models/files/version_list_params.rb +16 -0
- data/lib/imagekitio/models/files/version_list_response.rb +10 -0
- data/lib/imagekitio/models/files/version_restore_params.rb +22 -0
- data/lib/imagekitio/models/folder.rb +76 -0
- data/lib/imagekitio/models/folder_copy_params.rb +44 -0
- data/lib/imagekitio/models/folder_copy_response.rb +23 -0
- data/lib/imagekitio/models/folder_create_params.rb +43 -0
- data/lib/imagekitio/models/folder_create_response.rb +10 -0
- data/lib/imagekitio/models/folder_delete_params.rb +25 -0
- data/lib/imagekitio/models/folder_delete_response.rb +10 -0
- data/lib/imagekitio/models/folder_move_params.rb +34 -0
- data/lib/imagekitio/models/folder_move_response.rb +23 -0
- data/lib/imagekitio/models/folder_rename_params.rb +59 -0
- data/lib/imagekitio/models/folder_rename_response.rb +23 -0
- data/lib/imagekitio/models/folders/job_get_params.rb +16 -0
- data/lib/imagekitio/models/folders/job_get_response.rb +74 -0
- data/lib/imagekitio/models/get_image_attributes_options.rb +68 -0
- data/lib/imagekitio/models/image_overlay.rb +66 -0
- data/lib/imagekitio/models/metadata.rb +483 -0
- data/lib/imagekitio/models/overlay.rb +28 -0
- data/lib/imagekitio/models/overlay_position.rb +101 -0
- data/lib/imagekitio/models/overlay_timing.rb +97 -0
- data/lib/imagekitio/models/responsive_image_attributes.rb +48 -0
- data/lib/imagekitio/models/solid_color_overlay.rb +42 -0
- data/lib/imagekitio/models/solid_color_overlay_transformation.rb +135 -0
- data/lib/imagekitio/models/src_options.rb +96 -0
- data/lib/imagekitio/models/streaming_resolution.rb +22 -0
- data/lib/imagekitio/models/subtitle_overlay.rb +64 -0
- data/lib/imagekitio/models/subtitle_overlay_transformation.rb +113 -0
- data/lib/imagekitio/models/text_overlay.rb +65 -0
- data/lib/imagekitio/models/text_overlay_transformation.rb +267 -0
- data/lib/imagekitio/models/transformation.rb +1100 -0
- data/lib/imagekitio/models/transformation_position.rb +19 -0
- data/lib/imagekitio/models/unsafe_unwrap_webhook_event.rb +36 -0
- data/lib/imagekitio/models/unwrap_webhook_event.rb +36 -0
- data/lib/imagekitio/models/update_file_request.rb +164 -0
- data/lib/imagekitio/models/upload_post_transform_error_event.rb +180 -0
- data/lib/imagekitio/models/upload_post_transform_success_event.rb +143 -0
- data/lib/imagekitio/models/upload_pre_transform_error_event.rb +108 -0
- data/lib/imagekitio/models/upload_pre_transform_success_event.rb +690 -0
- data/lib/imagekitio/models/video_overlay.rb +64 -0
- data/lib/imagekitio/models/video_transformation_accepted_event.rb +279 -0
- data/lib/imagekitio/models/video_transformation_error_event.rb +326 -0
- data/lib/imagekitio/models/video_transformation_ready_event.rb +379 -0
- data/lib/imagekitio/models/webhook_unsafe_unwrap_params.rb +14 -0
- data/lib/imagekitio/models/webhook_unwrap_params.rb +14 -0
- data/lib/imagekitio/models.rb +160 -0
- data/lib/imagekitio/request_options.rb +77 -0
- data/lib/imagekitio/resources/accounts/origins.rb +145 -0
- data/lib/imagekitio/resources/accounts/url_endpoints.rb +151 -0
- data/lib/imagekitio/resources/accounts/usage.rb +46 -0
- data/lib/imagekitio/resources/accounts.rb +26 -0
- data/lib/imagekitio/resources/assets.rb +54 -0
- data/lib/imagekitio/resources/beta/v2/files.rb +110 -0
- data/lib/imagekitio/resources/beta/v2.rb +20 -0
- data/lib/imagekitio/resources/beta.rb +18 -0
- data/lib/imagekitio/resources/cache/invalidation.rb +66 -0
- data/lib/imagekitio/resources/cache.rb +18 -0
- data/lib/imagekitio/resources/custom_metadata_fields.rb +133 -0
- data/lib/imagekitio/resources/files/bulk.rb +131 -0
- data/lib/imagekitio/resources/files/metadata.rb +69 -0
- data/lib/imagekitio/resources/files/versions.rb +132 -0
- data/lib/imagekitio/resources/files.rb +305 -0
- data/lib/imagekitio/resources/folders/job.rb +39 -0
- data/lib/imagekitio/resources/folders.rb +166 -0
- data/lib/imagekitio/resources/webhooks.rb +30 -0
- data/lib/imagekitio/version.rb +5 -0
- data/lib/imagekitio.rb +181 -13
- data/manifest.yaml +15 -0
- data/rbi/imagekitio/client.rbi +92 -0
- data/rbi/imagekitio/errors.rbi +205 -0
- data/rbi/imagekitio/file_part.rbi +37 -0
- data/rbi/imagekitio/helpers/helper.rbi +41 -0
- data/rbi/imagekitio/internal/transport/base_client.rbi +295 -0
- data/rbi/imagekitio/internal/transport/pooled_net_requester.rbi +80 -0
- data/rbi/imagekitio/internal/type/array_of.rbi +104 -0
- data/rbi/imagekitio/internal/type/base_model.rbi +304 -0
- data/rbi/imagekitio/internal/type/base_page.rbi +42 -0
- data/rbi/imagekitio/internal/type/boolean.rbi +58 -0
- data/rbi/imagekitio/internal/type/converter.rbi +216 -0
- data/rbi/imagekitio/internal/type/enum.rbi +82 -0
- data/rbi/imagekitio/internal/type/file_input.rbi +59 -0
- data/rbi/imagekitio/internal/type/hash_of.rbi +104 -0
- data/rbi/imagekitio/internal/type/request_parameters.rbi +29 -0
- data/rbi/imagekitio/internal/type/union.rbi +128 -0
- data/rbi/imagekitio/internal/type/unknown.rbi +58 -0
- data/rbi/imagekitio/internal/util.rbi +487 -0
- data/rbi/imagekitio/internal.rbi +18 -0
- data/rbi/imagekitio/models/accounts/origin_create_params.rbi +81 -0
- data/rbi/imagekitio/models/accounts/origin_delete_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/origin_get_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/origin_list_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/origin_list_response.rbi +15 -0
- data/rbi/imagekitio/models/accounts/origin_request.rbi +775 -0
- data/rbi/imagekitio/models/accounts/origin_response.rbi +718 -0
- data/rbi/imagekitio/models/accounts/origin_update_params.rbi +81 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_create_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_delete_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_get_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_list_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_list_response.rbi +15 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_request.rbi +218 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_response.rbi +213 -0
- data/rbi/imagekitio/models/accounts/url_endpoint_update_params.rbi +34 -0
- data/rbi/imagekitio/models/accounts/usage_get_params.rbi +60 -0
- data/rbi/imagekitio/models/accounts/usage_get_response.rbi +89 -0
- data/rbi/imagekitio/models/asset_list_params.rbi +281 -0
- data/rbi/imagekitio/models/asset_list_response.rbi +28 -0
- data/rbi/imagekitio/models/base_overlay.rbi +44 -0
- data/rbi/imagekitio/models/base_webhook_event.rbi +33 -0
- data/rbi/imagekitio/models/beta/v2/file_upload_params.rbi +861 -0
- data/rbi/imagekitio/models/beta/v2/file_upload_response.rbi +1197 -0
- data/rbi/imagekitio/models/cache/invalidation_create_params.rbi +45 -0
- data/rbi/imagekitio/models/cache/invalidation_create_response.rbi +37 -0
- data/rbi/imagekitio/models/cache/invalidation_get_params.rbi +34 -0
- data/rbi/imagekitio/models/cache/invalidation_get_response.rbi +93 -0
- data/rbi/imagekitio/models/custom_metadata_field.rbi +422 -0
- data/rbi/imagekitio/models/custom_metadata_field_create_params.rbi +443 -0
- data/rbi/imagekitio/models/custom_metadata_field_delete_params.rbi +30 -0
- data/rbi/imagekitio/models/custom_metadata_field_delete_response.rbi +23 -0
- data/rbi/imagekitio/models/custom_metadata_field_list_params.rbi +66 -0
- data/rbi/imagekitio/models/custom_metadata_field_list_response.rbi +11 -0
- data/rbi/imagekitio/models/custom_metadata_field_update_params.rbi +376 -0
- data/rbi/imagekitio/models/extensions.rbi +274 -0
- data/rbi/imagekitio/models/file.rbi +789 -0
- data/rbi/imagekitio/models/file_copy_params.rbi +66 -0
- data/rbi/imagekitio/models/file_copy_response.rbi +23 -0
- data/rbi/imagekitio/models/file_delete_params.rbi +27 -0
- data/rbi/imagekitio/models/file_get_params.rbi +27 -0
- data/rbi/imagekitio/models/file_move_params.rbi +51 -0
- data/rbi/imagekitio/models/file_move_response.rbi +23 -0
- data/rbi/imagekitio/models/file_rename_params.rbi +102 -0
- data/rbi/imagekitio/models/file_rename_response.rbi +35 -0
- data/rbi/imagekitio/models/file_update_params.rbi +58 -0
- data/rbi/imagekitio/models/file_update_response.rbi +322 -0
- data/rbi/imagekitio/models/file_upload_params.rbi +897 -0
- data/rbi/imagekitio/models/file_upload_response.rbi +1176 -0
- data/rbi/imagekitio/models/files/bulk_add_tags_params.rbi +56 -0
- data/rbi/imagekitio/models/files/bulk_add_tags_response.rbi +41 -0
- data/rbi/imagekitio/models/files/bulk_delete_params.rbi +48 -0
- data/rbi/imagekitio/models/files/bulk_delete_response.rbi +41 -0
- data/rbi/imagekitio/models/files/bulk_remove_ai_tags_params.rbi +56 -0
- data/rbi/imagekitio/models/files/bulk_remove_ai_tags_response.rbi +41 -0
- data/rbi/imagekitio/models/files/bulk_remove_tags_params.rbi +56 -0
- data/rbi/imagekitio/models/files/bulk_remove_tags_response.rbi +41 -0
- data/rbi/imagekitio/models/files/metadata_get_from_url_params.rbi +47 -0
- data/rbi/imagekitio/models/files/metadata_get_params.rbi +34 -0
- data/rbi/imagekitio/models/files/version_delete_params.rbi +40 -0
- data/rbi/imagekitio/models/files/version_delete_response.rbi +25 -0
- data/rbi/imagekitio/models/files/version_get_params.rbi +40 -0
- data/rbi/imagekitio/models/files/version_list_params.rbi +34 -0
- data/rbi/imagekitio/models/files/version_list_response.rbi +13 -0
- data/rbi/imagekitio/models/files/version_restore_params.rbi +40 -0
- data/rbi/imagekitio/models/folder.rbi +121 -0
- data/rbi/imagekitio/models/folder_copy_params.rbi +68 -0
- data/rbi/imagekitio/models/folder_copy_response.rbi +33 -0
- data/rbi/imagekitio/models/folder_create_params.rbi +71 -0
- data/rbi/imagekitio/models/folder_create_response.rbi +23 -0
- data/rbi/imagekitio/models/folder_delete_params.rbi +40 -0
- data/rbi/imagekitio/models/folder_delete_response.rbi +23 -0
- data/rbi/imagekitio/models/folder_move_params.rbi +53 -0
- data/rbi/imagekitio/models/folder_move_response.rbi +33 -0
- data/rbi/imagekitio/models/folder_rename_params.rbi +98 -0
- data/rbi/imagekitio/models/folder_rename_response.rbi +33 -0
- data/rbi/imagekitio/models/folders/job_get_params.rbi +34 -0
- data/rbi/imagekitio/models/folders/job_get_response.rbi +173 -0
- data/rbi/imagekitio/models/get_image_attributes_options.rbi +121 -0
- data/rbi/imagekitio/models/image_overlay.rbi +109 -0
- data/rbi/imagekitio/models/metadata.rbi +813 -0
- data/rbi/imagekitio/models/overlay.rbi +28 -0
- data/rbi/imagekitio/models/overlay_position.rbi +148 -0
- data/rbi/imagekitio/models/overlay_timing.rbi +135 -0
- data/rbi/imagekitio/models/responsive_image_attributes.rbi +74 -0
- data/rbi/imagekitio/models/solid_color_overlay.rbi +79 -0
- data/rbi/imagekitio/models/solid_color_overlay_transformation.rbi +218 -0
- data/rbi/imagekitio/models/src_options.rbi +159 -0
- data/rbi/imagekitio/models/streaming_resolution.rbi +38 -0
- data/rbi/imagekitio/models/subtitle_overlay.rbi +114 -0
- data/rbi/imagekitio/models/subtitle_overlay_transformation.rbi +215 -0
- data/rbi/imagekitio/models/text_overlay.rbi +110 -0
- data/rbi/imagekitio/models/text_overlay_transformation.rbi +451 -0
- data/rbi/imagekitio/models/transformation.rbi +1646 -0
- data/rbi/imagekitio/models/transformation_position.rbi +28 -0
- data/rbi/imagekitio/models/unsafe_unwrap_webhook_event.rbi +33 -0
- data/rbi/imagekitio/models/unwrap_webhook_event.rbi +31 -0
- data/rbi/imagekitio/models/update_file_request.rbi +316 -0
- data/rbi/imagekitio/models/upload_post_transform_error_event.rbi +434 -0
- data/rbi/imagekitio/models/upload_post_transform_success_event.rbi +327 -0
- data/rbi/imagekitio/models/upload_pre_transform_error_event.rbi +244 -0
- data/rbi/imagekitio/models/upload_pre_transform_success_event.rbi +1300 -0
- data/rbi/imagekitio/models/video_overlay.rbi +105 -0
- data/rbi/imagekitio/models/video_transformation_accepted_event.rbi +659 -0
- data/rbi/imagekitio/models/video_transformation_error_event.rbi +772 -0
- data/rbi/imagekitio/models/video_transformation_ready_event.rbi +864 -0
- data/rbi/imagekitio/models/webhook_unsafe_unwrap_params.rbi +30 -0
- data/rbi/imagekitio/models/webhook_unwrap_params.rbi +27 -0
- data/rbi/imagekitio/models.rbi +135 -0
- data/rbi/imagekitio/request_options.rbi +59 -0
- data/rbi/imagekitio/resources/accounts/origins.rbi +91 -0
- data/rbi/imagekitio/resources/accounts/url_endpoints.rbi +129 -0
- data/rbi/imagekitio/resources/accounts/usage.rbi +36 -0
- data/rbi/imagekitio/resources/accounts.rbi +21 -0
- data/rbi/imagekitio/resources/assets.rbi +74 -0
- data/rbi/imagekitio/resources/beta/v2/files.rbi +193 -0
- data/rbi/imagekitio/resources/beta/v2.rbi +17 -0
- data/rbi/imagekitio/resources/beta.rbi +15 -0
- data/rbi/imagekitio/resources/cache/invalidation.rbi +44 -0
- data/rbi/imagekitio/resources/cache.rbi +15 -0
- data/rbi/imagekitio/resources/custom_metadata_fields.rbi +106 -0
- data/rbi/imagekitio/resources/files/bulk.rbi +88 -0
- data/rbi/imagekitio/resources/files/metadata.rbi +49 -0
- data/rbi/imagekitio/resources/files/versions.rbi +89 -0
- data/rbi/imagekitio/resources/files.rbi +364 -0
- data/rbi/imagekitio/resources/folders/job.rbi +29 -0
- data/rbi/imagekitio/resources/folders.rbi +146 -0
- data/rbi/imagekitio/resources/webhooks.rbi +50 -0
- data/rbi/imagekitio/version.rbi +5 -0
- data/sig/imagekitio/client.rbs +47 -0
- data/sig/imagekitio/errors.rbs +117 -0
- data/sig/imagekitio/file_part.rbs +21 -0
- data/sig/imagekitio/helpers/helper.rbs +24 -0
- data/sig/imagekitio/internal/transport/base_client.rbs +131 -0
- data/sig/imagekitio/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/imagekitio/internal/type/array_of.rbs +48 -0
- data/sig/imagekitio/internal/type/base_model.rbs +102 -0
- data/sig/imagekitio/internal/type/base_page.rbs +24 -0
- data/sig/imagekitio/internal/type/boolean.rbs +26 -0
- data/sig/imagekitio/internal/type/converter.rbs +79 -0
- data/sig/imagekitio/internal/type/enum.rbs +32 -0
- data/sig/imagekitio/internal/type/file_input.rbs +25 -0
- data/sig/imagekitio/internal/type/hash_of.rbs +48 -0
- data/sig/imagekitio/internal/type/request_parameters.rbs +19 -0
- data/sig/imagekitio/internal/type/union.rbs +52 -0
- data/sig/imagekitio/internal/type/unknown.rbs +26 -0
- data/sig/imagekitio/internal/util.rbs +185 -0
- data/sig/imagekitio/internal.rbs +9 -0
- data/sig/imagekitio/models/accounts/origin_create_params.rbs +30 -0
- data/sig/imagekitio/models/accounts/origin_delete_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/origin_get_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/origin_list_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/origin_list_response.rbs +10 -0
- data/sig/imagekitio/models/accounts/origin_request.rbs +468 -0
- data/sig/imagekitio/models/accounts/origin_response.rbs +418 -0
- data/sig/imagekitio/models/accounts/origin_update_params.rbs +30 -0
- data/sig/imagekitio/models/accounts/url_endpoint_create_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/url_endpoint_delete_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/url_endpoint_get_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/url_endpoint_list_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/url_endpoint_list_response.rbs +10 -0
- data/sig/imagekitio/models/accounts/url_endpoint_request.rbs +97 -0
- data/sig/imagekitio/models/accounts/url_endpoint_response.rbs +96 -0
- data/sig/imagekitio/models/accounts/url_endpoint_update_params.rbs +17 -0
- data/sig/imagekitio/models/accounts/usage_get_params.rbs +30 -0
- data/sig/imagekitio/models/accounts/usage_get_response.rbs +52 -0
- data/sig/imagekitio/models/asset_list_params.rbs +138 -0
- data/sig/imagekitio/models/asset_list_response.rbs +16 -0
- data/sig/imagekitio/models/base_overlay.rbs +31 -0
- data/sig/imagekitio/models/base_webhook_event.rbs +15 -0
- data/sig/imagekitio/models/beta/v2/file_upload_params.rbs +310 -0
- data/sig/imagekitio/models/beta/v2/file_upload_response.rbs +487 -0
- data/sig/imagekitio/models/cache/invalidation_create_params.rbs +25 -0
- data/sig/imagekitio/models/cache/invalidation_create_response.rbs +17 -0
- data/sig/imagekitio/models/cache/invalidation_get_params.rbs +17 -0
- data/sig/imagekitio/models/cache/invalidation_get_response.rbs +35 -0
- data/sig/imagekitio/models/custom_metadata_field.rbs +178 -0
- data/sig/imagekitio/models/custom_metadata_field_create_params.rbs +179 -0
- data/sig/imagekitio/models/custom_metadata_field_delete_params.rbs +15 -0
- data/sig/imagekitio/models/custom_metadata_field_delete_response.rbs +11 -0
- data/sig/imagekitio/models/custom_metadata_field_list_params.rbs +32 -0
- data/sig/imagekitio/models/custom_metadata_field_list_response.rbs +8 -0
- data/sig/imagekitio/models/custom_metadata_field_update_params.rbs +152 -0
- data/sig/imagekitio/models/extensions.rbs +132 -0
- data/sig/imagekitio/models/file.rbs +384 -0
- data/sig/imagekitio/models/file_copy_params.rbs +38 -0
- data/sig/imagekitio/models/file_copy_response.rbs +11 -0
- data/sig/imagekitio/models/file_delete_params.rbs +15 -0
- data/sig/imagekitio/models/file_get_params.rbs +14 -0
- data/sig/imagekitio/models/file_move_params.rbs +28 -0
- data/sig/imagekitio/models/file_move_response.rbs +11 -0
- data/sig/imagekitio/models/file_rename_params.rbs +34 -0
- data/sig/imagekitio/models/file_rename_response.rbs +15 -0
- data/sig/imagekitio/models/file_update_params.rbs +28 -0
- data/sig/imagekitio/models/file_update_response.rbs +120 -0
- data/sig/imagekitio/models/file_upload_params.rbs +327 -0
- data/sig/imagekitio/models/file_upload_response.rbs +483 -0
- data/sig/imagekitio/models/files/bulk_add_tags_params.rbs +30 -0
- data/sig/imagekitio/models/files/bulk_add_tags_response.rbs +20 -0
- data/sig/imagekitio/models/files/bulk_delete_params.rbs +26 -0
- data/sig/imagekitio/models/files/bulk_delete_response.rbs +20 -0
- data/sig/imagekitio/models/files/bulk_remove_ai_tags_params.rbs +30 -0
- data/sig/imagekitio/models/files/bulk_remove_ai_tags_response.rbs +20 -0
- data/sig/imagekitio/models/files/bulk_remove_tags_params.rbs +30 -0
- data/sig/imagekitio/models/files/bulk_remove_tags_response.rbs +20 -0
- data/sig/imagekitio/models/files/metadata_get_from_url_params.rbs +25 -0
- data/sig/imagekitio/models/files/metadata_get_params.rbs +17 -0
- data/sig/imagekitio/models/files/version_delete_params.rbs +25 -0
- data/sig/imagekitio/models/files/version_delete_response.rbs +13 -0
- data/sig/imagekitio/models/files/version_get_params.rbs +25 -0
- data/sig/imagekitio/models/files/version_list_params.rbs +17 -0
- data/sig/imagekitio/models/files/version_list_response.rbs +9 -0
- data/sig/imagekitio/models/files/version_restore_params.rbs +25 -0
- data/sig/imagekitio/models/folder.rbs +69 -0
- data/sig/imagekitio/models/folder_copy_params.rbs +38 -0
- data/sig/imagekitio/models/folder_copy_response.rbs +13 -0
- data/sig/imagekitio/models/folder_create_params.rbs +28 -0
- data/sig/imagekitio/models/folder_create_response.rbs +11 -0
- data/sig/imagekitio/models/folder_delete_params.rbs +23 -0
- data/sig/imagekitio/models/folder_delete_response.rbs +11 -0
- data/sig/imagekitio/models/folder_move_params.rbs +28 -0
- data/sig/imagekitio/models/folder_move_response.rbs +13 -0
- data/sig/imagekitio/models/folder_rename_params.rbs +34 -0
- data/sig/imagekitio/models/folder_rename_response.rbs +13 -0
- data/sig/imagekitio/models/folders/job_get_params.rbs +17 -0
- data/sig/imagekitio/models/folders/job_get_response.rbs +72 -0
- data/sig/imagekitio/models/get_image_attributes_options.rbs +43 -0
- data/sig/imagekitio/models/image_overlay.rbs +59 -0
- data/sig/imagekitio/models/metadata.rbs +546 -0
- data/sig/imagekitio/models/overlay.rbs +16 -0
- data/sig/imagekitio/models/overlay_position.rbs +85 -0
- data/sig/imagekitio/models/overlay_timing.rbs +66 -0
- data/sig/imagekitio/models/responsive_image_attributes.rbs +36 -0
- data/sig/imagekitio/models/solid_color_overlay.rbs +38 -0
- data/sig/imagekitio/models/solid_color_overlay_transformation.rbs +97 -0
- data/sig/imagekitio/models/src_options.rbs +64 -0
- data/sig/imagekitio/models/streaming_resolution.rbs +20 -0
- data/sig/imagekitio/models/subtitle_overlay.rbs +59 -0
- data/sig/imagekitio/models/subtitle_overlay_transformation.rbs +78 -0
- data/sig/imagekitio/models/text_overlay.rbs +59 -0
- data/sig/imagekitio/models/text_overlay_transformation.rbs +195 -0
- data/sig/imagekitio/models/transformation.rbs +763 -0
- data/sig/imagekitio/models/transformation_position.rbs +14 -0
- data/sig/imagekitio/models/unsafe_unwrap_webhook_event.rbs +18 -0
- data/sig/imagekitio/models/unwrap_webhook_event.rbs +18 -0
- data/sig/imagekitio/models/update_file_request.rbs +122 -0
- data/sig/imagekitio/models/upload_post_transform_error_event.rbs +192 -0
- data/sig/imagekitio/models/upload_post_transform_success_event.rbs +142 -0
- data/sig/imagekitio/models/upload_pre_transform_error_event.rbs +115 -0
- data/sig/imagekitio/models/upload_pre_transform_success_event.rbs +541 -0
- data/sig/imagekitio/models/video_overlay.rbs +59 -0
- data/sig/imagekitio/models/video_transformation_accepted_event.rbs +261 -0
- data/sig/imagekitio/models/video_transformation_error_event.rbs +300 -0
- data/sig/imagekitio/models/video_transformation_ready_event.rbs +359 -0
- data/sig/imagekitio/models/webhook_unsafe_unwrap_params.rbs +15 -0
- data/sig/imagekitio/models/webhook_unwrap_params.rbs +15 -0
- data/sig/imagekitio/models.rbs +119 -0
- data/sig/imagekitio/request_options.rbs +36 -0
- data/sig/imagekitio/resources/accounts/origins.rbs +34 -0
- data/sig/imagekitio/resources/accounts/url_endpoints.rbs +40 -0
- data/sig/imagekitio/resources/accounts/usage.rbs +15 -0
- data/sig/imagekitio/resources/accounts.rbs +13 -0
- data/sig/imagekitio/resources/assets.rbs +18 -0
- data/sig/imagekitio/resources/beta/v2/files.rbs +35 -0
- data/sig/imagekitio/resources/beta/v2.rbs +11 -0
- data/sig/imagekitio/resources/beta.rbs +9 -0
- data/sig/imagekitio/resources/cache/invalidation.rbs +19 -0
- data/sig/imagekitio/resources/cache.rbs +9 -0
- data/sig/imagekitio/resources/custom_metadata_fields.rbs +32 -0
- data/sig/imagekitio/resources/files/bulk.rbs +32 -0
- data/sig/imagekitio/resources/files/metadata.rbs +19 -0
- data/sig/imagekitio/resources/files/versions.rbs +32 -0
- data/sig/imagekitio/resources/files.rbs +76 -0
- data/sig/imagekitio/resources/folders/job.rbs +14 -0
- data/sig/imagekitio/resources/folders.rbs +40 -0
- data/sig/imagekitio/resources/webhooks.rbs +27 -0
- data/sig/imagekitio/version.rbs +3 -0
- metadata +470 -136
- data/Rakefile +0 -27
- data/lib/active_storage/active_storage.rb +0 -7
- data/lib/active_storage/service/ik_file.rb +0 -115
- data/lib/active_storage/service/image_kit_io_service.rb +0 -188
- data/lib/carrierwave/carrierwave.rb +0 -83
- data/lib/carrierwave/storage/ik_file.rb +0 -51
- data/lib/carrierwave/storage/imagekit_store.rb +0 -68
- data/lib/carrierwave/support/uri_filename.rb +0 -12
- data/lib/imagekitio/api_service/bulk.rb +0 -58
- data/lib/imagekitio/api_service/custom_metadata_field.rb +0 -52
- data/lib/imagekitio/api_service/file.rb +0 -221
- data/lib/imagekitio/api_service/folder.rb +0 -49
- data/lib/imagekitio/base.rb +0 -12
- data/lib/imagekitio/configurable.rb +0 -43
- data/lib/imagekitio/constant.rb +0 -36
- data/lib/imagekitio/constants/default.rb +0 -22
- data/lib/imagekitio/constants/error.rb +0 -69
- data/lib/imagekitio/constants/file.rb +0 -11
- data/lib/imagekitio/constants/supported_transformation.rb +0 -39
- data/lib/imagekitio/constants/url.rb +0 -14
- data/lib/imagekitio/railtie.rb +0 -4
- data/lib/imagekitio/request.rb +0 -98
- data/lib/imagekitio/sdk/version.rb +0 -5
- data/lib/imagekitio/url.rb +0 -216
- data/lib/imagekitio/utils/calculation.rb +0 -45
- data/lib/imagekitio/utils/formatter.rb +0 -48
- data/lib/imagekitio/utils/option_validator.rb +0 -36
- data/lib/tasks/imagekitio/imagekitio_tasks.rake +0 -4
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
# By default, the transformation string is added as a query parameter in the URL,
|
|
6
|
+
# e.g., `?tr=w-100,h-100`. If you want to add the transformation string in the
|
|
7
|
+
# path of the URL, set this to `path`. Learn more in the
|
|
8
|
+
# [Transformations guide](https://imagekit.io/docs/transformations).
|
|
9
|
+
module TransformationPosition
|
|
10
|
+
extend Imagekitio::Internal::Type::Enum
|
|
11
|
+
|
|
12
|
+
PATH = :path
|
|
13
|
+
QUERY = :query
|
|
14
|
+
|
|
15
|
+
# @!method self.values
|
|
16
|
+
# @return [Array<Symbol>]
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
# Triggered when a new video transformation request is accepted for processing.
|
|
6
|
+
# This event confirms that ImageKit has received and queued your transformation
|
|
7
|
+
# request. Use this for debugging and tracking transformation lifecycle.
|
|
8
|
+
module UnsafeUnwrapWebhookEvent
|
|
9
|
+
extend Imagekitio::Internal::Type::Union
|
|
10
|
+
|
|
11
|
+
# 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.
|
|
12
|
+
variant -> { Imagekitio::VideoTransformationAcceptedEvent }
|
|
13
|
+
|
|
14
|
+
# 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.
|
|
15
|
+
variant -> { Imagekitio::VideoTransformationReadyEvent }
|
|
16
|
+
|
|
17
|
+
# 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.
|
|
18
|
+
variant -> { Imagekitio::VideoTransformationErrorEvent }
|
|
19
|
+
|
|
20
|
+
# Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.
|
|
21
|
+
variant -> { Imagekitio::UploadPreTransformSuccessEvent }
|
|
22
|
+
|
|
23
|
+
# Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.
|
|
24
|
+
variant -> { Imagekitio::UploadPreTransformErrorEvent }
|
|
25
|
+
|
|
26
|
+
# 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.
|
|
27
|
+
variant -> { Imagekitio::UploadPostTransformSuccessEvent }
|
|
28
|
+
|
|
29
|
+
# Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.
|
|
30
|
+
variant -> { Imagekitio::UploadPostTransformErrorEvent }
|
|
31
|
+
|
|
32
|
+
# @!method self.variants
|
|
33
|
+
# @return [Array(Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent)]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
# Triggered when a new video transformation request is accepted for processing.
|
|
6
|
+
# This event confirms that ImageKit has received and queued your transformation
|
|
7
|
+
# request. Use this for debugging and tracking transformation lifecycle.
|
|
8
|
+
module UnwrapWebhookEvent
|
|
9
|
+
extend Imagekitio::Internal::Type::Union
|
|
10
|
+
|
|
11
|
+
# 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.
|
|
12
|
+
variant -> { Imagekitio::VideoTransformationAcceptedEvent }
|
|
13
|
+
|
|
14
|
+
# 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.
|
|
15
|
+
variant -> { Imagekitio::VideoTransformationReadyEvent }
|
|
16
|
+
|
|
17
|
+
# 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.
|
|
18
|
+
variant -> { Imagekitio::VideoTransformationErrorEvent }
|
|
19
|
+
|
|
20
|
+
# Triggered when a pre-transformation completes successfully. The file has been processed with the requested transformation and is now available in the Media Library.
|
|
21
|
+
variant -> { Imagekitio::UploadPreTransformSuccessEvent }
|
|
22
|
+
|
|
23
|
+
# Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.
|
|
24
|
+
variant -> { Imagekitio::UploadPreTransformErrorEvent }
|
|
25
|
+
|
|
26
|
+
# 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.
|
|
27
|
+
variant -> { Imagekitio::UploadPostTransformSuccessEvent }
|
|
28
|
+
|
|
29
|
+
# Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.
|
|
30
|
+
variant -> { Imagekitio::UploadPostTransformErrorEvent }
|
|
31
|
+
|
|
32
|
+
# @!method self.variants
|
|
33
|
+
# @return [Array(Imagekitio::Models::VideoTransformationAcceptedEvent, Imagekitio::Models::VideoTransformationReadyEvent, Imagekitio::Models::VideoTransformationErrorEvent, Imagekitio::Models::UploadPreTransformSuccessEvent, Imagekitio::Models::UploadPreTransformErrorEvent, Imagekitio::Models::UploadPostTransformSuccessEvent, Imagekitio::Models::UploadPostTransformErrorEvent)]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
# Schema for update file update request.
|
|
6
|
+
module UpdateFileRequest
|
|
7
|
+
extend Imagekitio::Internal::Type::Union
|
|
8
|
+
|
|
9
|
+
variant -> { Imagekitio::UpdateFileRequest::UpdateFileDetails }
|
|
10
|
+
|
|
11
|
+
variant -> { Imagekitio::UpdateFileRequest::ChangePublicationStatus }
|
|
12
|
+
|
|
13
|
+
class UpdateFileDetails < Imagekitio::Internal::Type::BaseModel
|
|
14
|
+
# @!attribute custom_coordinates
|
|
15
|
+
# Define an important area in the image in the format `x,y,width,height` e.g.
|
|
16
|
+
# `10,10,100,100`. Send `null` to unset this value.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :custom_coordinates, String, api_name: :customCoordinates, nil?: true
|
|
20
|
+
|
|
21
|
+
# @!attribute custom_metadata
|
|
22
|
+
# A key-value data to be associated with the asset. To unset a key, send `null`
|
|
23
|
+
# value for that key. Before setting any custom metadata on an asset you have to
|
|
24
|
+
# create the field using custom metadata fields API.
|
|
25
|
+
#
|
|
26
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
27
|
+
optional :custom_metadata,
|
|
28
|
+
Imagekitio::Internal::Type::HashOf[Imagekitio::Internal::Type::Unknown],
|
|
29
|
+
api_name: :customMetadata
|
|
30
|
+
|
|
31
|
+
# @!attribute description
|
|
32
|
+
# Optional text to describe the contents of the file.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :description, String
|
|
36
|
+
|
|
37
|
+
# @!attribute extensions
|
|
38
|
+
# Array of extensions to be applied to the asset. Each extension can be configured
|
|
39
|
+
# with specific parameters based on the extension type.
|
|
40
|
+
#
|
|
41
|
+
# @return [Array<Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension>, nil]
|
|
42
|
+
optional :extensions, -> { Imagekitio::Internal::Type::ArrayOf[union: Imagekitio::ExtensionItem] }
|
|
43
|
+
|
|
44
|
+
# @!attribute remove_ai_tags
|
|
45
|
+
# An array of AITags associated with the file that you want to remove, e.g.
|
|
46
|
+
# `["car", "vehicle", "motorsports"]`.
|
|
47
|
+
#
|
|
48
|
+
# If you want to remove all AITags associated with the file, send a string -
|
|
49
|
+
# "all".
|
|
50
|
+
#
|
|
51
|
+
# Note: The remove operation for `AITags` executes before any of the `extensions`
|
|
52
|
+
# are processed.
|
|
53
|
+
#
|
|
54
|
+
# @return [Array<String>, Symbol, :all, nil]
|
|
55
|
+
optional :remove_ai_tags,
|
|
56
|
+
union: -> { Imagekitio::UpdateFileRequest::UpdateFileDetails::RemoveAITags },
|
|
57
|
+
api_name: :removeAITags
|
|
58
|
+
|
|
59
|
+
# @!attribute tags
|
|
60
|
+
# An array of tags associated with the file, such as `["tag1", "tag2"]`. Send
|
|
61
|
+
# `null` to unset all tags associated with the file.
|
|
62
|
+
#
|
|
63
|
+
# @return [Array<String>, nil]
|
|
64
|
+
optional :tags, Imagekitio::Internal::Type::ArrayOf[String], nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute webhook_url
|
|
67
|
+
# The final status of extensions after they have completed execution will be
|
|
68
|
+
# delivered to this endpoint as a POST request.
|
|
69
|
+
# [Learn more](/docs/api-reference/digital-asset-management-dam/managing-assets/update-file-details#webhook-payload-structure)
|
|
70
|
+
# about the webhook payload structure.
|
|
71
|
+
#
|
|
72
|
+
# @return [String, nil]
|
|
73
|
+
optional :webhook_url, String, api_name: :webhookUrl
|
|
74
|
+
|
|
75
|
+
# @!method initialize(custom_coordinates: nil, custom_metadata: nil, description: nil, extensions: nil, remove_ai_tags: nil, tags: nil, webhook_url: nil)
|
|
76
|
+
# Some parameter documentations has been truncated, see
|
|
77
|
+
# {Imagekitio::Models::UpdateFileRequest::UpdateFileDetails} for more details.
|
|
78
|
+
#
|
|
79
|
+
# @param custom_coordinates [String, nil] Define an important area in the image in the format `x,y,width,height` e.g. `10,
|
|
80
|
+
#
|
|
81
|
+
# @param custom_metadata [Hash{Symbol=>Object}] A key-value data to be associated with the asset. To unset a key, send `null` va
|
|
82
|
+
#
|
|
83
|
+
# @param description [String] Optional text to describe the contents of the file.
|
|
84
|
+
#
|
|
85
|
+
# @param extensions [Array<Imagekitio::Models::ExtensionItem::RemoveBg, Imagekitio::Models::ExtensionItem::AIAutoDescription, Imagekitio::Models::ExtensionItem::AutoTaggingExtension>] Array of extensions to be applied to the asset. Each extension can be configured
|
|
86
|
+
#
|
|
87
|
+
# @param remove_ai_tags [Array<String>, Symbol, :all] An array of AITags associated with the file that you want to remove, e.g. `["car
|
|
88
|
+
#
|
|
89
|
+
# @param tags [Array<String>, nil] An array of tags associated with the file, such as `["tag1", "tag2"]`. Send `nul
|
|
90
|
+
#
|
|
91
|
+
# @param webhook_url [String] The final status of extensions after they have completed execution will be deliv
|
|
92
|
+
|
|
93
|
+
# An array of AITags associated with the file that you want to remove, e.g.
|
|
94
|
+
# `["car", "vehicle", "motorsports"]`.
|
|
95
|
+
#
|
|
96
|
+
# If you want to remove all AITags associated with the file, send a string -
|
|
97
|
+
# "all".
|
|
98
|
+
#
|
|
99
|
+
# Note: The remove operation for `AITags` executes before any of the `extensions`
|
|
100
|
+
# are processed.
|
|
101
|
+
#
|
|
102
|
+
# @see Imagekitio::Models::UpdateFileRequest::UpdateFileDetails#remove_ai_tags
|
|
103
|
+
module RemoveAITags
|
|
104
|
+
extend Imagekitio::Internal::Type::Union
|
|
105
|
+
|
|
106
|
+
variant -> { Imagekitio::Models::UpdateFileRequest::UpdateFileDetails::RemoveAITags::StringArray }
|
|
107
|
+
|
|
108
|
+
variant const: :all
|
|
109
|
+
|
|
110
|
+
# @!method self.variants
|
|
111
|
+
# @return [Array(Array<String>, Symbol, :all)]
|
|
112
|
+
|
|
113
|
+
# @type [Imagekitio::Internal::Type::Converter]
|
|
114
|
+
StringArray = Imagekitio::Internal::Type::ArrayOf[String]
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
class ChangePublicationStatus < Imagekitio::Internal::Type::BaseModel
|
|
119
|
+
# @!attribute publish
|
|
120
|
+
# Configure the publication status of a file and its versions.
|
|
121
|
+
#
|
|
122
|
+
# @return [Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish, nil]
|
|
123
|
+
optional :publish, -> { Imagekitio::UpdateFileRequest::ChangePublicationStatus::Publish }
|
|
124
|
+
|
|
125
|
+
# @!method initialize(publish: nil)
|
|
126
|
+
# Some parameter documentations has been truncated, see
|
|
127
|
+
# {Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus} for more
|
|
128
|
+
# details.
|
|
129
|
+
#
|
|
130
|
+
# @param publish [Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish] Configure the publication status of a file and its versions.
|
|
131
|
+
|
|
132
|
+
# @see Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus#publish
|
|
133
|
+
class Publish < Imagekitio::Internal::Type::BaseModel
|
|
134
|
+
# @!attribute is_published
|
|
135
|
+
# Set to `true` to publish the file. Set to `false` to unpublish the file.
|
|
136
|
+
#
|
|
137
|
+
# @return [Boolean]
|
|
138
|
+
required :is_published, Imagekitio::Internal::Type::Boolean, api_name: :isPublished
|
|
139
|
+
|
|
140
|
+
# @!attribute include_file_versions
|
|
141
|
+
# Set to `true` to publish/unpublish all versions of the file. Set to `false` to
|
|
142
|
+
# publish/unpublish only the current version of the file.
|
|
143
|
+
#
|
|
144
|
+
# @return [Boolean, nil]
|
|
145
|
+
optional :include_file_versions, Imagekitio::Internal::Type::Boolean, api_name: :includeFileVersions
|
|
146
|
+
|
|
147
|
+
# @!method initialize(is_published:, include_file_versions: nil)
|
|
148
|
+
# Some parameter documentations has been truncated, see
|
|
149
|
+
# {Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus::Publish} for
|
|
150
|
+
# more details.
|
|
151
|
+
#
|
|
152
|
+
# Configure the publication status of a file and its versions.
|
|
153
|
+
#
|
|
154
|
+
# @param is_published [Boolean] Set to `true` to publish the file. Set to `false` to unpublish the file.
|
|
155
|
+
#
|
|
156
|
+
# @param include_file_versions [Boolean] Set to `true` to publish/unpublish all versions of the file. Set to `false` to p
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @!method self.variants
|
|
161
|
+
# @return [Array(Imagekitio::Models::UpdateFileRequest::UpdateFileDetails, Imagekitio::Models::UpdateFileRequest::ChangePublicationStatus)]
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
end
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
class UploadPostTransformErrorEvent < Imagekitio::Models::BaseWebhookEvent
|
|
6
|
+
# @!attribute created_at
|
|
7
|
+
# Timestamp of when the event occurred in ISO8601 format.
|
|
8
|
+
#
|
|
9
|
+
# @return [Time]
|
|
10
|
+
required :created_at, Time
|
|
11
|
+
|
|
12
|
+
# @!attribute data
|
|
13
|
+
#
|
|
14
|
+
# @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data]
|
|
15
|
+
required :data, -> { Imagekitio::UploadPostTransformErrorEvent::Data }
|
|
16
|
+
|
|
17
|
+
# @!attribute request
|
|
18
|
+
#
|
|
19
|
+
# @return [Imagekitio::Models::UploadPostTransformErrorEvent::Request]
|
|
20
|
+
required :request, -> { Imagekitio::UploadPostTransformErrorEvent::Request }
|
|
21
|
+
|
|
22
|
+
# @!attribute type
|
|
23
|
+
#
|
|
24
|
+
# @return [Symbol, :"upload.post-transform.error"]
|
|
25
|
+
required :type, const: :"upload.post-transform.error"
|
|
26
|
+
|
|
27
|
+
# @!method initialize(created_at:, data:, request:, type: :"upload.post-transform.error")
|
|
28
|
+
# Triggered when a post-transformation fails. The original file remains available,
|
|
29
|
+
# but the requested transformation could not be generated.
|
|
30
|
+
#
|
|
31
|
+
# @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
|
|
32
|
+
#
|
|
33
|
+
# @param data [Imagekitio::Models::UploadPostTransformErrorEvent::Data]
|
|
34
|
+
#
|
|
35
|
+
# @param request [Imagekitio::Models::UploadPostTransformErrorEvent::Request]
|
|
36
|
+
#
|
|
37
|
+
# @param type [Symbol, :"upload.post-transform.error"]
|
|
38
|
+
|
|
39
|
+
class Data < Imagekitio::Internal::Type::BaseModel
|
|
40
|
+
# @!attribute file_id
|
|
41
|
+
# Unique identifier of the originally uploaded file.
|
|
42
|
+
#
|
|
43
|
+
# @return [String]
|
|
44
|
+
required :file_id, String, api_name: :fileId
|
|
45
|
+
|
|
46
|
+
# @!attribute name
|
|
47
|
+
# Name of the file.
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :name, String
|
|
51
|
+
|
|
52
|
+
# @!attribute path
|
|
53
|
+
# Path of the file.
|
|
54
|
+
#
|
|
55
|
+
# @return [String]
|
|
56
|
+
required :path, String
|
|
57
|
+
|
|
58
|
+
# @!attribute transformation
|
|
59
|
+
#
|
|
60
|
+
# @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation]
|
|
61
|
+
required :transformation, -> { Imagekitio::UploadPostTransformErrorEvent::Data::Transformation }
|
|
62
|
+
|
|
63
|
+
# @!attribute url
|
|
64
|
+
# URL of the attempted post-transformation.
|
|
65
|
+
#
|
|
66
|
+
# @return [String]
|
|
67
|
+
required :url, String
|
|
68
|
+
|
|
69
|
+
# @!method initialize(file_id:, name:, path:, transformation:, url:)
|
|
70
|
+
# @param file_id [String] Unique identifier of the originally uploaded file.
|
|
71
|
+
#
|
|
72
|
+
# @param name [String] Name of the file.
|
|
73
|
+
#
|
|
74
|
+
# @param path [String] Path of the file.
|
|
75
|
+
#
|
|
76
|
+
# @param transformation [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation]
|
|
77
|
+
#
|
|
78
|
+
# @param url [String] URL of the attempted post-transformation.
|
|
79
|
+
|
|
80
|
+
# @see Imagekitio::Models::UploadPostTransformErrorEvent::Data#transformation
|
|
81
|
+
class Transformation < Imagekitio::Internal::Type::BaseModel
|
|
82
|
+
# @!attribute error
|
|
83
|
+
#
|
|
84
|
+
# @return [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation::Error]
|
|
85
|
+
required :error, -> { Imagekitio::UploadPostTransformErrorEvent::Data::Transformation::Error }
|
|
86
|
+
|
|
87
|
+
# @!method initialize(error:)
|
|
88
|
+
# @param error [Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation::Error]
|
|
89
|
+
|
|
90
|
+
# @see Imagekitio::Models::UploadPostTransformErrorEvent::Data::Transformation#error
|
|
91
|
+
class Error < Imagekitio::Internal::Type::BaseModel
|
|
92
|
+
# @!attribute reason
|
|
93
|
+
# Reason for the post-transformation failure.
|
|
94
|
+
#
|
|
95
|
+
# @return [String]
|
|
96
|
+
required :reason, String
|
|
97
|
+
|
|
98
|
+
# @!method initialize(reason:)
|
|
99
|
+
# @param reason [String] Reason for the post-transformation failure.
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
class Request < Imagekitio::Internal::Type::BaseModel
|
|
105
|
+
# @!attribute transformation
|
|
106
|
+
#
|
|
107
|
+
# @return [Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation]
|
|
108
|
+
required :transformation, -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation }
|
|
109
|
+
|
|
110
|
+
# @!attribute x_request_id
|
|
111
|
+
# Unique identifier for the originating request.
|
|
112
|
+
#
|
|
113
|
+
# @return [String]
|
|
114
|
+
required :x_request_id, String
|
|
115
|
+
|
|
116
|
+
# @!method initialize(transformation:, x_request_id:)
|
|
117
|
+
# @param transformation [Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation]
|
|
118
|
+
#
|
|
119
|
+
# @param x_request_id [String] Unique identifier for the originating request.
|
|
120
|
+
|
|
121
|
+
# @see Imagekitio::Models::UploadPostTransformErrorEvent::Request#transformation
|
|
122
|
+
class Transformation < Imagekitio::Internal::Type::BaseModel
|
|
123
|
+
# @!attribute type
|
|
124
|
+
# Type of the requested post-transformation.
|
|
125
|
+
#
|
|
126
|
+
# @return [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Type]
|
|
127
|
+
required :type, enum: -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Type }
|
|
128
|
+
|
|
129
|
+
# @!attribute protocol
|
|
130
|
+
# Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
131
|
+
#
|
|
132
|
+
# @return [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol, nil]
|
|
133
|
+
optional :protocol,
|
|
134
|
+
enum: -> { Imagekitio::UploadPostTransformErrorEvent::Request::Transformation::Protocol }
|
|
135
|
+
|
|
136
|
+
# @!attribute value
|
|
137
|
+
# Value for the requested transformation type.
|
|
138
|
+
#
|
|
139
|
+
# @return [String, nil]
|
|
140
|
+
optional :value, String
|
|
141
|
+
|
|
142
|
+
# @!method initialize(type:, protocol: nil, value: nil)
|
|
143
|
+
# @param type [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Type] Type of the requested post-transformation.
|
|
144
|
+
#
|
|
145
|
+
# @param protocol [Symbol, Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
146
|
+
#
|
|
147
|
+
# @param value [String] Value for the requested transformation type.
|
|
148
|
+
|
|
149
|
+
# Type of the requested post-transformation.
|
|
150
|
+
#
|
|
151
|
+
# @see Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation#type
|
|
152
|
+
module Type
|
|
153
|
+
extend Imagekitio::Internal::Type::Enum
|
|
154
|
+
|
|
155
|
+
TRANSFORMATION = :transformation
|
|
156
|
+
ABS = :abs
|
|
157
|
+
GIF_TO_VIDEO = :"gif-to-video"
|
|
158
|
+
THUMBNAIL = :thumbnail
|
|
159
|
+
|
|
160
|
+
# @!method self.values
|
|
161
|
+
# @return [Array<Symbol>]
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
165
|
+
#
|
|
166
|
+
# @see Imagekitio::Models::UploadPostTransformErrorEvent::Request::Transformation#protocol
|
|
167
|
+
module Protocol
|
|
168
|
+
extend Imagekitio::Internal::Type::Enum
|
|
169
|
+
|
|
170
|
+
HLS = :hls
|
|
171
|
+
DASH = :dash
|
|
172
|
+
|
|
173
|
+
# @!method self.values
|
|
174
|
+
# @return [Array<Symbol>]
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
end
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Imagekitio
|
|
4
|
+
module Models
|
|
5
|
+
class UploadPostTransformSuccessEvent < Imagekitio::Models::BaseWebhookEvent
|
|
6
|
+
# @!attribute created_at
|
|
7
|
+
# Timestamp of when the event occurred in ISO8601 format.
|
|
8
|
+
#
|
|
9
|
+
# @return [Time]
|
|
10
|
+
required :created_at, Time
|
|
11
|
+
|
|
12
|
+
# @!attribute data
|
|
13
|
+
#
|
|
14
|
+
# @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Data]
|
|
15
|
+
required :data, -> { Imagekitio::UploadPostTransformSuccessEvent::Data }
|
|
16
|
+
|
|
17
|
+
# @!attribute request
|
|
18
|
+
#
|
|
19
|
+
# @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Request]
|
|
20
|
+
required :request, -> { Imagekitio::UploadPostTransformSuccessEvent::Request }
|
|
21
|
+
|
|
22
|
+
# @!attribute type
|
|
23
|
+
#
|
|
24
|
+
# @return [Symbol, :"upload.post-transform.success"]
|
|
25
|
+
required :type, const: :"upload.post-transform.success"
|
|
26
|
+
|
|
27
|
+
# @!method initialize(created_at:, data:, request:, type: :"upload.post-transform.success")
|
|
28
|
+
# Triggered when a post-transformation completes successfully. The transformed
|
|
29
|
+
# version of the file is now ready and can be accessed via the provided URL. Note
|
|
30
|
+
# that each post-transformation generates a separate webhook event.
|
|
31
|
+
#
|
|
32
|
+
# @param created_at [Time] Timestamp of when the event occurred in ISO8601 format.
|
|
33
|
+
#
|
|
34
|
+
# @param data [Imagekitio::Models::UploadPostTransformSuccessEvent::Data]
|
|
35
|
+
#
|
|
36
|
+
# @param request [Imagekitio::Models::UploadPostTransformSuccessEvent::Request]
|
|
37
|
+
#
|
|
38
|
+
# @param type [Symbol, :"upload.post-transform.success"]
|
|
39
|
+
|
|
40
|
+
class Data < Imagekitio::Internal::Type::BaseModel
|
|
41
|
+
# @!attribute file_id
|
|
42
|
+
# Unique identifier of the originally uploaded file.
|
|
43
|
+
#
|
|
44
|
+
# @return [String]
|
|
45
|
+
required :file_id, String, api_name: :fileId
|
|
46
|
+
|
|
47
|
+
# @!attribute name
|
|
48
|
+
# Name of the file.
|
|
49
|
+
#
|
|
50
|
+
# @return [String]
|
|
51
|
+
required :name, String
|
|
52
|
+
|
|
53
|
+
# @!attribute url
|
|
54
|
+
# URL of the generated post-transformation.
|
|
55
|
+
#
|
|
56
|
+
# @return [String]
|
|
57
|
+
required :url, String
|
|
58
|
+
|
|
59
|
+
# @!method initialize(file_id:, name:, url:)
|
|
60
|
+
# @param file_id [String] Unique identifier of the originally uploaded file.
|
|
61
|
+
#
|
|
62
|
+
# @param name [String] Name of the file.
|
|
63
|
+
#
|
|
64
|
+
# @param url [String] URL of the generated post-transformation.
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
class Request < Imagekitio::Internal::Type::BaseModel
|
|
68
|
+
# @!attribute transformation
|
|
69
|
+
#
|
|
70
|
+
# @return [Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation]
|
|
71
|
+
required :transformation, -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation }
|
|
72
|
+
|
|
73
|
+
# @!attribute x_request_id
|
|
74
|
+
# Unique identifier for the originating request.
|
|
75
|
+
#
|
|
76
|
+
# @return [String]
|
|
77
|
+
required :x_request_id, String
|
|
78
|
+
|
|
79
|
+
# @!method initialize(transformation:, x_request_id:)
|
|
80
|
+
# @param transformation [Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation]
|
|
81
|
+
#
|
|
82
|
+
# @param x_request_id [String] Unique identifier for the originating request.
|
|
83
|
+
|
|
84
|
+
# @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request#transformation
|
|
85
|
+
class Transformation < Imagekitio::Internal::Type::BaseModel
|
|
86
|
+
# @!attribute type
|
|
87
|
+
# Type of the requested post-transformation.
|
|
88
|
+
#
|
|
89
|
+
# @return [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type]
|
|
90
|
+
required :type, enum: -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Type }
|
|
91
|
+
|
|
92
|
+
# @!attribute protocol
|
|
93
|
+
# Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
94
|
+
#
|
|
95
|
+
# @return [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol, nil]
|
|
96
|
+
optional :protocol,
|
|
97
|
+
enum: -> { Imagekitio::UploadPostTransformSuccessEvent::Request::Transformation::Protocol }
|
|
98
|
+
|
|
99
|
+
# @!attribute value
|
|
100
|
+
# Value for the requested transformation type.
|
|
101
|
+
#
|
|
102
|
+
# @return [String, nil]
|
|
103
|
+
optional :value, String
|
|
104
|
+
|
|
105
|
+
# @!method initialize(type:, protocol: nil, value: nil)
|
|
106
|
+
# @param type [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Type] Type of the requested post-transformation.
|
|
107
|
+
#
|
|
108
|
+
# @param protocol [Symbol, Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation::Protocol] Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
109
|
+
#
|
|
110
|
+
# @param value [String] Value for the requested transformation type.
|
|
111
|
+
|
|
112
|
+
# Type of the requested post-transformation.
|
|
113
|
+
#
|
|
114
|
+
# @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation#type
|
|
115
|
+
module Type
|
|
116
|
+
extend Imagekitio::Internal::Type::Enum
|
|
117
|
+
|
|
118
|
+
TRANSFORMATION = :transformation
|
|
119
|
+
ABS = :abs
|
|
120
|
+
GIF_TO_VIDEO = :"gif-to-video"
|
|
121
|
+
THUMBNAIL = :thumbnail
|
|
122
|
+
|
|
123
|
+
# @!method self.values
|
|
124
|
+
# @return [Array<Symbol>]
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Only applicable if transformation type is 'abs'. Streaming protocol used.
|
|
128
|
+
#
|
|
129
|
+
# @see Imagekitio::Models::UploadPostTransformSuccessEvent::Request::Transformation#protocol
|
|
130
|
+
module Protocol
|
|
131
|
+
extend Imagekitio::Internal::Type::Enum
|
|
132
|
+
|
|
133
|
+
HLS = :hls
|
|
134
|
+
DASH = :dash
|
|
135
|
+
|
|
136
|
+
# @!method self.values
|
|
137
|
+
# @return [Array<Symbol>]
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|